State Bundle

A non-Android (albeit Parcelable) replacement for android.os.Bundle, that also implements equals(), hashCode() and toString().

What's it for?

Ever written any unit tests where you had to mock a Bundle?

You get:

Bundle.putString(String, String) is not mocked.

And it's pretty annoying, isn't it?

However, you can use StateBundle in place of Bundle to overcome this problem.

Instead of:

public Bundle toBundle() {
    Bundle bundle = BundleProvider.create();
    bundle.putString("hello", "world");
    return bundle;
}

savedInstanceState.putBundle("bundle", presenter.toBundle());
Bundle bundle = savedInstanceState.getBundle("bundle");

You can do:

public StateBundle toBundle() {
    StateBundle bundle = new StateBundle();
    bundle.putString("hello", "world");
    return bundle;
}

savedInstanceState.putParcelable("stateBundle", presenter.toBundle());
StateBundle bundle = savedInstanceState.getParcelable("stateBundle");

Notes

The following types are NOT supported:

• Size
• SizeF
• IBinder

All other Bundle types work. But as this is a non-Android Parcelable class, it can be used without mocking.

Also, because of how the AlarmManager works, custom parcelables (including StateBundle) shouldn't be used with PendingIntent.

Using State Bundle

In order to use State Bundle, you need to add jitpack to your project root gradle:

allprojects {
    repositories {
        // ...
        maven { url "https://jitpack.io" }
    }
    // ...
}

In newer projects, you need to also update the settings.gradle file's dependencyResolutionManagement block:

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven { url 'https://jitpack.io' }  // <--
        jcenter() // Warning: this repository is going to shut down soon
    }
}

and add the compile dependency to your module level gradle.

implementation 'com.github.Zhuinden:state-bundle:1.4.0'

License

Copyright 2017 Gabor Varadi

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.