scabbard

Dagger 2 scoped bindings (singletons) per Android lifecycles.

Why

Scoped bindings of Dagger 2, provides singletons per lifecycles, is awesome feature which is not in Dagger 1. However Dagger itself does not provide way to manage component instances per Android lifecycles, required to use this feature (as it is pure-java library).

This library automatically manages scoped components in Application, Activity, Fragment, Service. Only things you should do are:

Usage

One you have done first setup, you just call helper method from every onCreate().

public void onCreate(Bundle onSavedInstanceState) {
    ComponentHelper.createActivityComponent(this).inject(this);
    super.onCreate();
}

• See Step by Step Setup for details.
• See example directory for working Android application.
• Refer document of Dagger 2 for usage of scoped bindings.

Requirements / Limitations

• Designed for Dagger 2. Scoped bindings is not supported in Dagger 1.
• Android >= 4.0. Because ActivityLifecycleCallbacks is used to release component.
• One component per one Activity/Fragment/Service design is not supported.
• Support Library v4 is required for fragment scope. Native fragment is not supported for now (NOTE: AppCompatActivity is almost required for material design).

Installation

Gradle:

dependencies {
    compile 'net.ypresto.scabbard:scabbard:0.1.0'
}

Currently only available from jcenter repo, which is default of Android project. If your project does not use jcenter yet, please put below.

repositories {
    jcenter()
}

TODO

Please open issue if you want belows or other things to be implemented.

• Creating ComponentHelper to cast is not efficient way. Code generation maybe useful to automate it.
• Singleton scope kept during configuration change (i.e. orientation change) using retained fragment.

License

Copyright (C) 2015 Yuya Tanaka

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.