Stetho-Realm

Stetho-Realm is a Realm module for Stetho.

It displays Realm database content in Stetho instead of SQLite database content.

Set-up

Download

grab via Gradle:

repositories {
    maven {
        url 'https://github.com/eikaramba/stetho-realm/raw/master/maven-repo'
    }
}

dependencies {
    compile 'com.facebook.stetho:stetho:1.3.1'
    compile 'com.uphyca:stetho_realm:0.9.0'
}

Stetho-Realm supports Stetho 1.3.1 or newer and Realm 1.1.0 or newer.

Integration

In your Application class, please initialize Stetho with RealmInspectorModulesProvider.ProviderBuilder as follows.

RealmInspectorModulesProvider.ProviderBuilder replaces SQLite module with Realm module. You can use RealmInspectorModulesProvider.ProviderBuilder#baseProvider(InspectorModulesProvider) in order to customized InspectorModulesProvider instead of default provider.

public class MyApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();

        Stetho.initialize(
                Stetho.newInitializerBuilder(this)
                        .enableDumpapp(Stetho.defaultDumperPluginsProvider(this))
                        .enableWebKitInspector(RealmInspectorModulesProvider.builder(this).build())
                        .build());
                        
        //------ init the db afterwards (just an example) ----------------
        RealmConfiguration config = new RealmConfiguration.Builder(this).deleteRealmIfMigrationNeeded().name("yourDB.realm").build();
        Realm.setDefaultConfiguration(config);
    }
}

By calling some methods in RealmInspectorModulesProvider.ProviderBuilder, you can include metadata table in table list, and can provide database file name pattern. And also you can specify base folder for database files, encryption keys, limit, sort order.

    RealmInspectorModulesProvider.builder(this)
            .withFolder(getCacheDir()) //optional
            .withEncryptionKey("encrypted.realm", key) //optional
            .withMetaTables() //optional
            .withDescendingOrder()
            .withLimit(1000)
            .databaseNamePattern(Pattern.compile(".+\\.realm"))
            .build()

First try without optional methods

Usage with ProGuard

Add the following lines if you use proguard. You might already have the first line in your proguard file.

-keep class com.facebook.stetho.** { *; }
-keep class com.uphyca.** { *; }

use Stetho in debug build only

http://littlerobots.nl/blog/stetho-for-android-debug-builds-only/

License

Stetho-Realm is BSD-licensed.

TODO

coexistence with SQLite module.
implementation of update, delete, etc.

deployment memo

update version information
./gradlew clean assemble :stetho_realm:publishMavenPublicationToMavenRepository
git add, commit, push (on master branch)