Merge branch 'develop' into release

Author: jonasrottmann

.travis.yml

@@ -1,16 +1,46 @@
 language: android
 
+# Use the Travis Container-Based Infrastructure
+sudo: false
+
+jdk:
+  - oraclejdk8
+
+env:
+  global:
+    - ANDROID_BUILD_TOOLS_VERSION=25.0.2
+    - ADB_INSTALL_TIMEOUT=20 # install timeout in minutes (2 minutes by default)
+  matrix:
+    - ANDROID_TARGET=android-22 ANDROID_ABI=armeabi-v7a
+
 android:
   components:
-    # Update Android SDK Tools
-    - tools
-
-    - build-tools-23.0.2
-    - android-23
+    - tools # to get the new `repository-11.xml`
+    - tools # to install new Android SDK tools
+    - platform-tools
+    - build-tools-$ANDROID_BUILD_TOOLS_VERSION
+    - $ANDROID_TARGET
+    - android-25
 
     # Support library
     - extra-android-support
     - extra-android-m2repository
 
+    # System images
+    - sys-img-${ANDROID_ABI}-${ANDROID_TARGET}
+
+before_script:
+  - chmod +x ./gradlew
+  # Emulator Management: Create, Start and Wait
+  - echo no | android create avd --force -n test -t $ANDROID_TARGET --abi $ANDROID_ABI
+  - emulator -avd test -no-audio -no-window &
+  - android-wait-for-emulator
+
 script:
-    - chmod +x ./gradlew
+  - ./gradlew clean
+  - ./gradlew check # Local unit tests
+  - ./gradlew connectedCheck # Instrumented unit tests
+  - ./gradlew jacocoTestReport
+
+after_success:
+  - bash <(curl -s https://codecov.io/bash)

README.md

@@ -7,85 +7,96 @@ This is a fork of [dmytrodanylyk/realm-browser](https://github.com/dmytrodanylyk
 <img src="screenshots/sc_1.png" width="256"> | <img src="screenshots/sc_2.png" width="256"> | <img src="screenshots/sc_3.png" width="256">
 --- | --- | ---
 
-
-### Integration [![](https://jitpack.io/v/jonasrottmann/realm-browser.svg)](https://jitpack.io/#jonasrottmann/realm-browser) [![Build Status](https://travis-ci.org/jonasrottmann/realm-browser.svg?branch=release)](https://travis-ci.org/jonasrottmann/realm-browser)
+### Integration [![](https://jitpack.io/v/jonasrottmann/realm-browser.svg)](https://jitpack.io/#jonasrottmann/realm-browser) [![codecov](https://codecov.io/gh/jonasrottmann/realm-browser/branch/develop/graph/badge.svg)](https://codecov.io/gh/jonasrottmann/realm-browser)
+Releases: [![Build Status](https://travis-ci.org/jonasrottmann/realm-browser.svg?branch=release)](https://travis-ci.org/jonasrottmann/realm-browser) - Develop branch (Snapshots): [![Build Status](https://travis-ci.org/jonasrottmann/realm-browser.svg?branch=develop)](https://travis-ci.org/jonasrottmann/realm-browser)
 
 The project is available via [JitPack.io](https://jitpack.io/#jonasrottmann/realm-browser/).
 
-Step 1. Add the JitPack repository to your build file
+1. **Add the JitPack repository to your build file**
+  ```
+  allprojects {
+          repositories {
+          ...
+          maven { url "https://jitpack.io" }
+          }
+      }
+  }
+  ```
+
+2. **Add the dependency**
+  ```
+  dependencies {
+      debugCompile 'com.github.jonasrottmann.realm-browser:realm-browser:v0.0.9'
+      testCompile 'com.github.jonasrottmann.realm-browser:realm-browser-no-op:v0.0.9'
+      releaseCompile 'com.github.jonasrottmann.realm-browser:realm-browser-no-op:v0.0.9'
+  }
+  ```
+  The no-op version of Realm Browser has empty functions which do nothing. It is not necessary to include this, but you may if you do not want to access Realm Browser in release mode. If you want to use a build of the newest development use `compile "com.github.jonasrottmann.realm-browser:realm-browser:develop-SNAPSHOT"` instead.
+
+3. Exclude support libraries (maybe optional): Realm Browser depends on Android support libraries, so you might want to exclude them from your project if they conflict with the ones you include:
+  ```
+  depedencies {
+      debugCompile ('com.github.jonasrottmann.realm-browser:realm-browser:v0.0.9') {
+          exclude group: 'com.android.support';
+      }
+  }
+  ```
+
+4. Add ProGuard rules (optional): Use these if you enable minification for debug builds or want to use Realm Browser in release builds.
+  ```
+  # Realm Browser
+  -keep class de.jonasrottmann.realmbrowser.* { *; }
+  -keep class android.support.v7.widget.SearchView { *; }
+  -keep class android.support.v7.view.** { *; }
+  ```
 
-```
-allprojects {
-        repositories {
-        ...
-        maven { url "https://jitpack.io" }
-        }
-    }
-}
-```
+### Usage
 
-Step 2. Add the dependency
+If you want to see all your database files:
 
 ```
-dependencies {
-    debugCompile 'com.github.jonasrottmann.realm-browser:realm-browser:v0.0.8'
-    testCompile 'com.github.jonasrottmann.realm-browser:realm-browser-no-op:v0.0.8'
-    releaseCompile 'com.github.jonasrottmann.realm-browser:realm-browser-no-op:v0.0.8'
-}
+RealmBrowser.startRealmFilesActivity(context);
 ```
 
-The no-op version of Realm Browser has empty functions which do nothing. It is not necessary to include this,
-but you may if you do not want to access Realm Browser in release mode.
-
-> ‼️ v0.0.8 is not working with the newest realm release. Use the develop snapshot version `compile "com.github.jonasrottmann.realm-browser:realm-browser:develop-SNAPSHOT"` meanwhile.
-
-Realm Browser depends on Android support libraries, so you might want to exclude them from your project
-if they conflict with the ones you include:
+If you want to see all the tables in a database call:
 
 ```
-depedencies {
-    debugCompile ('com.github.jonasrottmann.realm-browser:realm-browser:v0.0.8') {
-        exclude group: 'com.android.support';
-    }
-}
+RealmBrowser.startRealmModelsActivity(context, realmConfiguration);
 ```
 
-Step 3. Add ProGuard rules (optional)
-
-Use these if you enable minification for debug builds or want to use Realm Browser in release builds.
+To display a notification from which the Realm Browser can be started:
 
 ```
-# Realm Browser
--keep class de.jonasrottmann.realmbrowser.helper.* { *; }
--keep class android.support.v7.widget.SearchView { *; }
--keep class android.support.v7.view.** { *; }
+RealmBrowser.showRealmFilesNotification(context);
 ```
-
-### Usage
-
-If you want to see all your databases call:
-
 ```
-RealmBrowser.startRealmFilesActivity(context);
+RealmBrowser.showRealmModelsNotification(context, realmConfiguration);
 ```
 
-If you want to see all the tables in a database call:
+There are also [App Shortcuts](https://developer.android.com/guide/topics/ui/shortcuts.html) available for devices running Android 7.1 or newer:
 
 ```
-RealmBrowser.startRealmModelsActivity(context, realmConfiguration);
+RealmBrowser.addFilesShortcut(context);
 ```
-
 ```
-RealmBrowser.startRealmModelsActivity(context, "<name of the database file>");
+RealmBrowser.addModelsShortcut(context, realmConfiguration)
 ```
 
-To display a notification from which the Realm Browser can be started:
+For a full working example check out the [sample app](https://github.com/jonasrottmann/realm-browser/blob/release/app/src/main/java/de/jonasrottmann/realmsample/MainActivity.java).
 
-```
-RealmBrowser.showRealmFilesNotification(context);
-```
+### TODO
+What's on the roadmap... 🚀
+- [ ] Tests
+- [ ] Be able to edit/create objects
+- [ ] Bidirectional scrolling in the browser window
+- [ ] Clean up
+- [ ] Nice architecture
+- [ ] Live reload the browser if updates happen in the background
+- [ ] Javadoc 📚
 
-For a full working example check out the [sample app](https://github.com/jonasrottmann/realm-browser/blob/release/app/src/main/java/de/jonasrottmann/realmsample/MainActivity.java).
+### Other browsers
+
+If you're looking for a Realm browser for your iOS Swift projects check out [bearjaw/RBSRealmBrowser](https://github.com/bearjaw/RBSRealmBrowser) 🎉
 
 ### License
 

app/build.gradle

@@ -6,31 +6,53 @@ repositories {
 }
 
 android {
-    compileSdkVersion 24
+    compileSdkVersion project.compileSdkVersion
     buildToolsVersion project.buildToolsVersion
+
     defaultConfig {
         applicationId "de.jonasrottmann.realmsample"
-        minSdkVersion 15
-        targetSdkVersion 24
+        minSdkVersion project.minSdkVersion
+        targetSdkVersion project.targetSdkVersion
         versionCode project.gitCommitCount
         versionName project.gitTag
+        testInstrumentationRunner 'android.support.test.runner.AndroidJUnitRunner'
     }
+
     buildTypes {
         release {
             minifyEnabled false
             proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
         }
     }
+
+    productFlavors {
+        normal {
+            applicationIdSuffix ".normal"
+        }
+        noop {
+            applicationIdSuffix ".noop"
+        }
+    }
+
+    lintOptions {
+        abortOnError false
+    }
 }
 
 dependencies {
     compile fileTree(include: ['*.jar'], dir: 'libs')
     compile "com.android.support:appcompat-v7:$project.supportLibVersion"
+    compile "com.jakewharton.timber:timber:$project.timberVersion"
+
+    androidTestCompile 'com.android.support.test.espresso:espresso-core:2.2.2', {
+        exclude group: 'com.android.support', module: 'support-annotations'
+    }
 
-    // Use local version of realm-browser
-    debugCompile project(':realm-browser')
-    releaseCompile project(':realm-browser-no-op')
+    // test local version of realm-browser
+    normalCompile project(':realm-browser')
+    noopCompile project(':realm-browser-no-op')
 
     // Use develop-snapshot version
-//    compile "com.github.jonasrottmann.realm-browser:realm-browser:develop-SNAPSHOT"
+//    normalCompile "com.github.jonasrottmann.realm-browser:realm-browser:develop-SNAPSHOT"
+//    noopCompile "com.github.jonasrottmann.realm-browser:realm-browser:develop-SNAPSHOT"
 }

app/src/main/java/de/jonasrottmann/realmsample/Application.java

@@ -1,5 +1,6 @@
 package de.jonasrottmann.realmsample;
 
+import de.jonasrottmann.realmbrowser.RealmBrowser;
 import io.realm.Realm;
 import io.realm.RealmConfiguration;
 import timber.log.Timber;
@@ -13,11 +14,18 @@ public void onCreate() {
         super.onCreate();
         Timber.plant(new Timber.DebugTree());
 
-        RealmConfiguration config = new RealmConfiguration.Builder(this)
+        Realm.init(this);
+        RealmConfiguration config = new RealmConfiguration.Builder()
                 .name(REALM_FILE_NAME)
                 .deleteRealmIfMigrationNeeded()
                 .build();
 
         Realm.setDefaultConfiguration(config);
+
+        RealmBrowser.showRealmModelsNotification(this, config);
+
+        RealmBrowser.addFilesShortcut(this);
+
+        RealmBrowser.addModelsShortcut(this, config);
     }
-}
+}

app/src/main/java/de/jonasrottmann/realmsample/MainActivity.java

@@ -4,25 +4,23 @@
 import android.os.Bundle;
 import android.view.View;
 import android.widget.TextView;
-
-import java.util.ArrayList;
-import java.util.Date;
-import java.util.List;
-import java.util.UUID;
-
 import de.jonasrottmann.realmbrowser.RealmBrowser;
 import de.jonasrottmann.realmsample.data.Address;
 import de.jonasrottmann.realmsample.data.Contact;
 import de.jonasrottmann.realmsample.data.RealmString;
 import de.jonasrottmann.realmsample.data.User;
 import io.realm.Realm;
+import io.realm.RealmConfiguration;
 import io.realm.RealmList;
+import java.util.ArrayList;
+import java.util.Date;
+import java.util.List;
+import java.util.UUID;
 
 public class MainActivity extends Activity implements View.OnClickListener {
 
     private TextView mTxtTitle;
 
-
     @Override
     protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
@@ -35,8 +33,6 @@ protected void onCreate(Bundle savedInstanceState) {
         findViewById(R.id.btnOpenModel).setOnClickListener(this);
 
         updateTitle();
-
-        RealmBrowser.showRealmFilesNotification(this);
     }
 
 
@@ -98,7 +94,7 @@ private void insertUsers(int count) {
             user.setAge(i);
             user.setAddress(address);
             user.setUuid(UUID.randomUUID().toString());
-            user.setByteArray(new byte[]{1, 2, 3});
+            user.setByteArray(new byte[] { 1, 2, 3 });
             user.setCreationDate(new Date(System.currentTimeMillis()));
 
             RealmList<RealmString> emailList = new RealmList<>();
@@ -136,6 +132,9 @@ private void startRealmFilesActivity() {
 
 
     private void startRealmModelsActivity() {
-        RealmBrowser.startRealmModelsActivity(this, Realm.getDefaultInstance().getConfiguration());
+        Realm realm = Realm.getDefaultInstance();
+        RealmConfiguration configuration = realm.getConfiguration();
+        realm.close();
+        RealmBrowser.startRealmModelsActivity(this, configuration);
     }
 }

build.gradle

@@ -2,16 +2,35 @@ buildscript {
     ext {
         gitTag = 'git describe --tags'.execute([], project.rootDir).text.trim()
         gitCommitCount = Integer.parseInt('git rev-list --count HEAD'.execute([], project.rootDir).text.trim())
-        realmVersion = '1.1.0'
-        supportLibVersion = '24.1.1'
-        buildToolsVersion = '23.0.3'
+
+        buildToolsVersion = '25.0.2'
+
+        compileSdkVersion = 25
+        targetSdkVersion = 25
+        minSdkVersion = 15
+
+        // plugins
+        androidGradlePluginVersion = '2.3.0'
+        realmVersion = '3.0.0'
+        dexcountVersion = '0.6.2'
+
+        // dependencies
+        timberVersion = '4.3.0'
+        supportLibVersion = '25.3.0'
+        lombokVersion = '1.12.6'
     }
+
     repositories {
         jcenter()
     }
+
     dependencies {
-        classpath 'com.android.tools.build:gradle:2.1.2'
-        classpath 'com.github.dcendents:android-maven-gradle-plugin:1.3'
+        classpath "com.android.tools.build:gradle:$androidGradlePluginVersion"
         classpath "io.realm:realm-gradle-plugin:$realmVersion"
+        classpath "com.getkeepsafe.dexcount:dexcount-gradle-plugin:$dexcountVersion"
     }
+}
+
+plugins {
+    id "com.github.dcendents.android-maven" version "1.5" apply false
 }