Android Debug Drawer

Faster development with Debug Drawer

Features

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,OkHttp3Module - common information about http client (requires extra dependency)

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

GlideModule - 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)

TimberModule - log viewer with sharing feature (requires extra dependency). Thanks AntonyGolovin for contributing.

ActionsModule - any context dependent action (ButtonAction, SwitchAction, SpinnerAction)

FpsModule - measuring the FPS using Choreographer (requires extra dependency)

LogsModule - Logcat and OkHttp network calls interceptor (requires extra dependency). Credits Sloy

NetworkQualityModule - Error/delay rate managing for network calls (requires extra dependency). Credits Sloy

TODO

• Take screenshot feature

You are always welcome to suggest modules!

Getting Started

Add Gradle dependencies:

DebugDrawer

dependencies {
debugImplementation 'io.palaima.debugdrawer:debugdrawer:0.8.0'
releaseImplementation 'io.palaima.debugdrawer:debugdrawer-no-op:0.8.0'
}

DebugView

dependencies {
debugImplementation 'io.palaima.debugdrawer:debugdrawer-view:0.8.0'
releaseImplementation 'io.palaima.debugdrawer:debugdrawer-view-no-op:0.8.0'
}

BuildModule, DeviceModule, SettingsModule, NetworkModule

dependencies {
implementation 'io.palaima.debugdrawer:debugdrawer-commons:0.8.0'
}

ActionsModule - ButtonAction, SwitchAction, SpinnerAction

dependencies {
implementation 'io.palaima.debugdrawer:debugdrawer-actions:0.8.0'
}

OkHttpModule, OkHttp3ModuleOkHttp library required

dependencies {
implementation 'io.palaima.debugdrawer:debugdrawer-okhttp:0.8.0'
implementation 'io.palaima.debugdrawer:debugdrawer-okhttp3:0.8.0'
}

PicassoModulePicasso library required

dependencies {
implementation 'io.palaima.debugdrawer:debugdrawer-picasso:0.8.0'
}

GlideModuleGlide library required

dependencies {
implementation 'io.palaima.debugdrawer:debugdrawer-glide:0.8.0'
}

ScalpelModuleScalpel library required

dependencies {
implementation 'io.palaima.debugdrawer:debugdrawer-scalpel:0.8.0'
}

LocationModule

dependencies {
implementation 'io.palaima.debugdrawer:debugdrawer-location:0.8.0'
}

TimberModuleTimber library required

dependencies {
implementation 'io.palaima.debugdrawer:debugdrawer-timber:0.8.0'
}

FpsModuleTakt library required

dependencies {
implementation 'io.palaima.debugdrawer:debugdrawer-fps:0.8.0'
}

LogsModuleLynx & Chuck libraries required

dependencies {
implementation 'io.palaima.debugdrawer:debugdrawer-logs:0.8.0'
}

NetworkQualityModuleOkHttp library required

dependencies {
implementation 'io.palaima.debugdrawer:debugdrawer-network-quality:0.8.0'
}

Putting All Together

1. Initialization in Activity

You could use DebugDrawer or DebugView depending on your needs

Example using DebugDrawer (For DebugView initialization check DebugViewActivity)

privateDebugDrawerdebugDrawer;
@OverrideprotectedvoidonCreate(BundlesavedInstanceState) {
super.onCreate(savedInstanceState);
//...SwitchActionswitchAction = newSwitchAction("Test switch", newSwitchAction.Listener() {
@OverridepublicvoidonCheckedChanged(booleanvalue) {
Toast.makeText(MainActivity.this, "Switch checked", Toast.LENGTH_LONG).show();
}
});
ButtonActionbuttonAction = newButtonAction("Test button", newButtonAction.Listener() {
@OverridepublicvoidonClick() {
Toast.makeText(MainActivity.this, "Button clicked", Toast.LENGTH_LONG).show();
}
});
SpinnerAction<String> spinnerAction = newSpinnerAction<>(
Arrays.asList("First", "Second", "Third"),
newSpinnerAction.OnItemSelectedListener<String>() {
@OverridepublicvoidonItemSelected(Stringvalue) {
Toast.makeText(MainActivity.this, "Spinner item selected - " + value, Toast.LENGTH_LONG).show();
}
}
);
debugDrawer = newDebugDrawer.Builder(this)
.modules(
newActionsModule(switchAction, buttonAction, spinnerAction),
newFpsModule(Takt.stock(getApplication())),
newLocationModule(this),
newScalpelModule(this),
newTimberModule(),
newOkHttp3Module(okHttpClient),
newPicassoModule(picasso),
newGlideModule(Glide.get(getContext())),
newDeviceModule(this),
newBuildModule(this),
newNetworkModule(this),
newSettingsModule(this)
).build();
}

2. TimberModule

Don't forget to plant needed log trees in Application class. Tree that is used by TimberModule stored in LumberYard class.

Application class example:

publicclassDebugDrawerApplicationextendsApplication {
@OverridepublicvoidonCreate() {
super.onCreate();
LumberYardlumberYard = LumberYard.getInstance(this);
lumberYard.cleanUp();
Timber.plant(lumberYard.tree());
Timber.plant(newTimber.DebugTree());
}
}

Creating and Publishing Your Own Module

Add implementation 'io.palaima.debugdrawer:debugdrawer-base:0.8.0' to your dependencies

Module must implement DebugModule interface or extend DebugModuleAdapter if you do not need lifecycle hooks

publicinterfaceDebugModule {
/** * Creates module view */@NonNullViewonCreateView(@NonNullLayoutInflaterinflater, @NonNullViewGroupparent);
/** * Override this method if you need to refresh * some information when drawer is opened */voidonOpened();
/** * Override this method if you need to stop * some actions when drawer is closed */voidonClosed();
/** * Override this method if you need to start * some processes */voidonResume();
/** * Override this method if you need to do * some clean up */voidonPause();
/** * Override this method if you need to start * some processes that would be killed when * onStop() is called * E.g. register receivers */voidonStart();
/** * Override this method if you need to do * some clean up when activity goes to foreground. * E.g. unregister receivers */voidonStop();
}

Sample

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

MainActivity

DebugViewActivity

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

• Opening braces to appear on the same line as code
• All variables must be camelCase
• All resources must have dd_ prefix

Developed By

• Mantas Palaima - palaima.mantas@gmail.com

Credits

• Jake Wharton - U2020

• Mike Penz - MaterialDrawer

• LemonLabs - SlidingDebugMenu

License

Copyright 2016 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.