Merge pull request #11 from amardeshbd/feature/6_setup_dagger_di

Feature/6 setup dagger di

Author: hossain-khan

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2018 Hossain Khan
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

app/build.gradle

@@ -4,12 +4,15 @@ apply plugin: 'kotlin-android'
 
 apply plugin: 'kotlin-android-extensions'
 
+// https://kotlinlang.org/docs/reference/kapt.html
+apply plugin: 'kotlin-kapt'
+
 android {
-    compileSdkVersion rootProject.ext.targetSdkVersion
+    compileSdkVersion rootProject.ext.androidCompileSdkVersion
     defaultConfig {
         applicationId "com.hossainkhan.android.demo"
-        minSdkVersion rootProject.ext.minSdkVersion
-        targetSdkVersion rootProject.ext.targetSdkVersion
+        minSdkVersion rootProject.ext.androidMinSdkVersion
+        targetSdkVersion rootProject.ext.androidTargetSdkVersion
         versionCode 1
         versionName "1.0-constraint-layout-demo"
         versionNameSuffix "-${gitSha()}"
@@ -30,6 +33,10 @@ android {
         sourceCompatibility rootProject.ext.javaSourceCompatibilityVersion
         targetCompatibility rootProject.ext.javaTargetCompatibilityVersion
     }
+
+    testOptions {
+        unitTests.returnDefaultValues = true
+    }
 }
 
 dependencies {
@@ -47,12 +54,24 @@ dependencies {
     // https://developer.android.com/topic/libraries/architecture/adding-components
     implementation "android.arch.lifecycle:extensions:$rootProject.archComponentVersion"
 
+    // ========================================================
     // 3rd party libraries
+    // ========================================================
     debugImplementation "com.squareup.leakcanary:leakcanary-android:$rootProject.leakcanaryLibraryVersion"
     releaseImplementation "com.squareup.leakcanary:leakcanary-android-no-op:$rootProject.leakcanaryLibraryVersion"
 
     implementation "com.jakewharton.timber:timber:$rootProject.timberLibraryVersion"
 
+    // Dagger
+    // https://google.github.io/dagger/
+    implementation "com.google.dagger:dagger:$rootProject.daggerVersion"
+    kapt "com.google.dagger:dagger-compiler:$rootProject.daggerVersion"
+    implementation "com.google.dagger:dagger-android:$rootProject.daggerVersion"
+    // Include if you use the support libraries (eg. Support Activity, Fragment)
+    //implementation "com.google.dagger:dagger-android-support:$rootProject.daggerVersion"
+    kapt "com.google.dagger:dagger-android-processor:$rootProject.daggerVersion"
+
+
     // ----------------------------------------------------------------
     // Android Unit and Instrumentation test
     // ----------------------------------------------------------------

app/src/main/java/com/hossainkhan/android/demo/MainActivity.kt

@@ -2,11 +2,21 @@ package com.hossainkhan.android.demo
 
 import android.support.v7.app.AppCompatActivity
 import android.os.Bundle
+import com.hossainkhan.android.demo.data.AppDataStore
+import dagger.android.AndroidInjection
+import timber.log.Timber
+import javax.inject.Inject
 
 class MainActivity : AppCompatActivity() {
+    @Inject
+    lateinit var appDataStore: AppDataStore
 
     override fun onCreate(savedInstanceState: Bundle?) {
+        AndroidInjection.inject(this)
         super.onCreate(savedInstanceState)
         setContentView(R.layout.activity_main)
+
+        Timber.d("Got data: ${appDataStore.isFirstTime()}")
+        appDataStore.updateFirstTimeUser(false)
     }
 }

app/src/main/java/com/hossainkhan/android/demo/base/DemoApplication.kt

@@ -1,12 +1,36 @@
+/*
+ * Copyright (c) 2018 Hossain Khan
+ *
+ * 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.
+ */
+
 package com.hossainkhan.android.demo.base
 
+import android.app.Activity
 import android.app.Application
 import com.hossainkhan.android.demo.BuildConfig
+import com.hossainkhan.android.demo.dagger.DaggerDemoApplicationComponent
 import com.squareup.leakcanary.LeakCanary
+import dagger.android.AndroidInjector
+import dagger.android.DispatchingAndroidInjector
+import dagger.android.HasActivityInjector
 import timber.log.Timber
+import javax.inject.Inject
 
 
-class DemoApplication : Application() {
+class DemoApplication : Application(), HasActivityInjector {
+    @Inject
+    lateinit var dispatchingAndroidInjector: DispatchingAndroidInjector<Activity>
 
     override fun onCreate() {
         super.onCreate()
@@ -17,8 +41,19 @@ class DemoApplication : Application() {
         }
         LeakCanary.install(this)
 
+        // Prepares dagger
+        DaggerDemoApplicationComponent.builder()
+                .application(this)
+                .build()
+                .inject(this)
+
         if (BuildConfig.DEBUG) {
             Timber.plant(Timber.DebugTree())
         }
     }
+
+    override fun activityInjector(): AndroidInjector<Activity> {
+        return dispatchingAndroidInjector
+    }
+
 }

app/src/main/java/com/hossainkhan/android/demo/dagger/ActivityBindingModule.kt

@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) 2018 Hossain Khan
+ *
+ * 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.
+ */
+
+package com.hossainkhan.android.demo.dagger
+
+import dagger.Module
+
+/**
+ * We want Dagger.Android to create a Subcomponent which has a parent Component of whichever 
+ * module ActivityBindingModule is on, in our case that will be [DemoApplicationComponent]. 
+ * 
+ * The beautiful part about this setup is that you never need to tell [DemoApplicationComponent]
+ * that it is going to have all these subcomponents nor do you need to tell these subcomponents
+ * that [DemoApplicationComponent] exists.
+ *
+ * We are also telling Dagger.Android that this generated SubComponent needs to include
+ * the specified modules and be aware of a scope annotation @ActivityScoped
+ * When Dagger.Android annotation processor runs it will create subcomponents for us.
+ */
+@Module
+public abstract class ActivityBindingModule {
+    /*
+     * https://google.github.io/dagger/android.html
+     * Pro-tip: If your subcomponent and its builder have no other methods or supertypes than
+     * the ones mentioned in step #2, you can use @ContributesAndroidInjector to generate them for you.
+     *
+     * Instead of steps 2 and 3, add an abstract module method that returns your activity,
+     * annotate it with @ContributesAndroidInjector, and specify the modules you want to install
+     * into the subcomponent. If the subcomponent needs scopes, apply the scope annotations to
+     * the method as well.
+     */
+    // Example
+    //@ActivityScoped
+    //@ContributesAndroidInjector(modules = arrayOf(ModuleNameWhichHasActivityInjection::class))
+    //abstract fun someActivity(): SomeActivity
+}

app/src/main/java/com/hossainkhan/android/demo/dagger/ApplicationModule.kt

@@ -0,0 +1,39 @@
+/*
+ * Copyright (c) 2018 Hossain Khan
+ *
+ * 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.
+ */
+
+package com.hossainkhan.android.demo.dagger
+
+import android.app.Application
+import android.content.Context
+import dagger.Binds
+import dagger.Module
+
+/**
+ * This is a Dagger module. We use this to bind our Application class as a Context in
+ * the [DemoApplicationComponent] By using Dagger Android we do not need to pass
+ * our Application instance to any module, we simply need to expose our Application as Context.
+ * One of the advantages of Dagger.Android is that your
+ * Application & Activities are provided into your graph for you.
+ *
+ * @see DemoApplicationComponent
+ */
+@Module
+abstract class ApplicationModule {
+    //expose Application as an injectable context
+    @Binds
+    internal abstract fun bindContext(application: Application): Context
+
+}

app/src/main/java/com/hossainkhan/android/demo/dagger/DataStoreModule.kt

@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) 2018 Hossain Khan
+ *
+ * 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.
+ */
+
+package com.hossainkhan.android.demo.dagger
+
+import android.content.Context
+import android.content.SharedPreferences
+import dagger.Module
+import dagger.Provides
+
+@Module
+class DataStoreModule {
+    @Provides
+    internal fun provideSharedPreferences(context: Context): SharedPreferences {
+        return context.getSharedPreferences("app_preferences", Context.MODE_PRIVATE)
+    }
+}

app/src/main/java/com/hossainkhan/android/demo/dagger/DemoApplicationComponent.kt

@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2018 Hossain Khan
+ *
+ * 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.
+ */
+
+package com.hossainkhan.android.demo.dagger
+
+import android.app.Application
+import com.hossainkhan.android.demo.base.DemoApplication
+import dagger.BindsInstance
+import dagger.Component
+
+@Component(modules = arrayOf(
+        ApplicationModule::class,
+        DataStoreModule::class,
+        MainActivityModule::class))
+interface DemoApplicationComponent {
+    fun inject(app: DemoApplication)
+
+    // Gives us syntactic sugar. we can then do DaggerAppComponent.builder().application(this).build().inject(this);
+    // never having to instantiate any modules or say which module we are passing the application to.
+    // Application will just be provided into our app graph now.
+    @Component.Builder
+    interface Builder {
+        @BindsInstance
+        fun application(application: Application): DemoApplicationComponent.Builder
+
+        fun build(): DemoApplicationComponent
+    }
+}

app/src/main/java/com/hossainkhan/android/demo/dagger/MainActivityModule.kt

@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) 2018 Hossain Khan
+ *
+ * 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.
+ */
+
+package com.hossainkhan.android.demo.dagger
+
+import android.app.Activity
+import com.hossainkhan.android.demo.MainActivity
+import dagger.Binds
+import dagger.Module
+import dagger.android.ActivityKey
+import dagger.android.AndroidInjector
+import dagger.multibindings.IntoMap
+
+@Module(subcomponents = arrayOf(MainActivitySubcomponent::class))
+abstract class MainActivityModule {
+
+    @Binds
+    @IntoMap
+    @ActivityKey(MainActivity::class)
+    abstract fun bindMainActivityInjectorFactory(
+            builder: MainActivitySubcomponent.Builder): AndroidInjector.Factory<out Activity>
+
+}

app/src/main/java/com/hossainkhan/android/demo/dagger/MainActivitySubcomponent.kt

@@ -0,0 +1,27 @@
+/*
+ * Copyright (c) 2018 Hossain Khan
+ *
+ * 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.
+ */
+
+package com.hossainkhan.android.demo.dagger
+
+import com.hossainkhan.android.demo.MainActivity
+import dagger.Subcomponent
+import dagger.android.AndroidInjector
+
+@Subcomponent
+interface MainActivitySubcomponent : AndroidInjector<MainActivity> {
+    @Subcomponent.Builder
+    abstract class Builder : AndroidInjector.Builder<MainActivity>()
+}