Android Library to inspect shared preferences.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
gradle/wrapper
sharedpreferenceinspector
.gitignore
ChangeLog.md
LICENSE.txt
README.md
build.gradle
settings.gradle

README.md

SharedPreferenceInspector

Provides a simple way to see shared preferences and edit them for test. No need to pull shared preferences. Just some simple clicks to see the values stored. Also with test mode to change the values and check the behavior of the app.

Android Arsenal

Maven Central

  • Note: 2.3 is last version distributed through Maven Central, new versions will be moved in JCenter. Additionally JitPack is also supported. You can grab latest versions from JitPack from here.

Usage

Gradle

Add this library as dependency to your project's build.gradle

debugCompile 'com.github.prashamtrivedi:sharedpreferenceinspector:{latestVersion}'

Where latest version can be found from above (Maven Central Badge)

Code

If you are using version 1.x.

Declare this activity in your debug menifest.

<activity android:name="com.ceelites.sharedpreferenceinspector.SharedPrefsBrowser"/>

Don't forget to Provide appropriate theme (Any Child of Theme.AppCompat is recommended) to that activity. It's needed to inflate menus.

If you are using version 2.0 and above

Just import the library. Library will take care of adding activity.

To launch the SharedPrefsBrowser activity you have two ways.

  1. From the menu.
  2. Launch the activity directly

To Launch the activity from menu

Initiate SharedPreferenceUtils with SharedPreferenceUtils.initWith() call.

In onCreateOptionsMenu() call

if (BuildConfig.DEBUG) {
	prefsUtils.inflateDebugMenu(getMenuInflater(), menu);
}

In onOptionsItemSelected() method check value of isDebugHandled method

prefsUtils.isDebugHandled(this, item)) 

If this method returns true activity will open itself. Otherwise you have to handle menu generation code yourselves.

To Launch the activity directly

Just Call.

if (BuildConfig.DEBUG) {
	SharedPreferenceUtils.startActivity(this);
}

Test Mode

SharedPreferenceInspector has a unique feature called test mode, where you can change your already stored shared preference value to any supported value and check how your app behaves with this change. While you are in the test mode your original value is kept safe and when you exit it, the original value will be restored. There are two ways to enter the test mode.

  1. From menu. Where you can enter the tests mode
  2. If you are not in test mode and try to click on the row, it will ask you to enter test mode to change the value.

The test mode values are stored in shared preference keys until you exit test mode.

Support

This library gives support from api level 10. And It has been tested in a GingerBread device.

Proguard Configuration

If you are using proguard, you should add this line in your proguard file. In case of version 2.0 this line should be added automatically. -keep class android.support.v7.widget.SearchView { *; }

ChangeLog

See Change Log

Credits

Credits to Android DbInspector Library for all the inspiration behind this library.

Known Issues And TODOs

  • Not implemented handling String Set.
  • Does not have UI to clear the key.
  • Upload in maven.
  • Change example to reflect read me instructions

License

   Copyright 2015 Prasham Trivedi
   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.