Android Debug Drawer

Faster development with Debug Drawer

Features

Currently exists 7 modules:

DeviceModule - common information about your device

BuildModule - app build information

SettingsModule - open Developer, Battery, Default settings, open app info and possibility to uninstall app directly from itself

NetworkModule - enable/disable Wifi, Mobile or Bluetooth

OkHttpModule - common information about http client (requires extra dependency)

PicassoModule - image downloading and caching statistics (requires extra dependency)

ScalpelModule - tool to uncover the layers under your app (requires extra dependency) Thanks ebabel for contributing.

LocationModule - common location information (requires extra dependency)

TODO Modules

LogsModule You are always welcome to suggest modules!

Getting Started

Add Gradle dependency:

dependencies {
   compile 'io.palaima.debugdrawer:debugdrawer:0.3.0'
}

If you are using popular OkHttp library. Probably you will be interesting in network statistics

dependencies {
   compile 'io.palaima.debugdrawer:debugdrawer-okhttp:0.3.0'
}

Or if you are using Picasso library, also from Square Inc.

dependencies {
   compile 'io.palaima.debugdrawer:debugdrawer-picasso:0.3.0'
}

ScalpelModule

dependencies {
   compile 'io.palaima.debugdrawer:debugdrawer-scalpel:0.3.0'
}

LocationModule

dependencies {
   compile 'io.palaima.debugdrawer:debugdrawer-location:0.3.0'
}

You can try the SNAPSHOT version:

dependencies {
   compile 'io.palaima.debugdrawer:debugdrawer:0.4.0-SNAPSHOT'
}

Make sure to add the snapshot repository:

repositories {
    maven {
        url "https://oss.sonatype.org/content/repositories/snapshots"
    }
}

Putting All Together

1. Initialization in Activity

private DebugDrawer mDebugDrawer;

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    if (BuildConfig.DEBUG) {
        mDebugDrawer = new DebugDrawer.Builder(this).modules(
                new LocationModule(this),
                new ScalpelModule(this),
                new OkHttpModule(mOkHttpClient),
                new PicassoModule(mPicasso),
                new DeviceModule(this),
                new BuildModule(this),
                new NetworkModule(this),
                new SettingsModule(this)
        ).build();
    }
}

2. onStart/onStop

If you use NetworkModule/LocationModule or your own which is hooked with BroadcastReceivers you must call onStart/onStop in your activity

@Override
protected void onStart() {
    super.onStart();
    if (mDebugDrawer != null) {
        mDebugDrawer.onStart();
    }
}

@Override
protected void onStop() {
    super.onStop();
    if (mDebugDrawer != null) {
        mDebugDrawer.onStop();
    }
}

Creating You Own Module

Module must implement DrawerModule interface

public interface DrawerModule {

    /**
     * Creates module view
     */
    View onCreateView(LayoutInflater inflater, ViewGroup parent);

    /**
     * Override this method if you need to refresh
     * some information  when drawer is opened
     */
    void onRefreshView();

    /**
     * Override this method if you need to start
     * some processes that would be killed when
     * onStop() is called
     * E.g. register receivers
     */
    void onStart();

    /**
     * Override this method if you need to do
     * some clean up when activity goes to foreground.
     * E.g. unregister receivers
     */
    void onStop();
}

Sample

You can clone the project and compile it yourself (it includes a sample). MainActivity

Contributing

Want to contribute? You are welcome!

Pull Requests

Fork the repo and create your branch from dev.
If you've changed APIs, update the documentation.
Make sure your code lints.
Change README.md if necessary

Coding Style

Use the m member variable prefix for private fields
Opening braces to appear on the same line as code
All variables must be CamelCase

Developed By

Mantas Palaima - palaima.mantas@gmail.com

Credits

Jake Wharton - U2020
Mike Penz - MaterialDrawer
LemonLabs - SlidingDebugMenu

License

Copyright 2015 Mantas Palaima.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

nopcoder/DebugDrawer