Initial version tracking setup

Author: eyedol

.gitignore

@@ -63,3 +63,6 @@ fastlane/Preview.html
 fastlane/screenshots
 fastlane/test_output
 fastlane/readme.md
+
+# Gradle reports
+reports/

README.md

@@ -0,0 +1,66 @@
+# POC Of a Modularized Architecture
+
+```
+                       +---------------------+
+                       |                     |
+                       |                     |
+       +--------------+|         app         +-----------+
+       |               |                     |           |
+       |               |                     |           |
+       |               |                     |           |
+       |               +----------+----------+           |
+       |                          |                      |
+       |                          |                      |
+       |                          |                      |
+       |                          |                      |
+       |                          |                      |
++------+------+           +-------+------+        +------+------+
+|             |           |              |        |             |
+|   :users    |           |   :user      |        |   :login    |
+|             +---+       |              |    +---+             |
+|             |   |       |              |    |   |             |
++------+------+   |       +-------+------+    |   +--------+----+
+       |          |               |           |            |
+       |          |               |           |            |
+       |          |               |           |            |
+       |          |               |           |            |
+       |          |    +----------+--------+  |            |
+       |          |    |                   |  |            |
+       |          +----+   :user-model     +--+            |
+       |               |                   |               |
+       |               +-------------------+               |
+       |                                                   |
+       |                                                   |
+       |                                                   |
+       |                                                   |
++------+---------------------------------------------------+-----+
+|                                                                |
+|                                                                |
+|                              :base                             |
+|                                                                |
+|                                                                |
++----------------------------------------------------------------+
+
+```
+
+
+**app:** The composed application that would be built and packaged as apk. It has all the feature related modules.
+
+**user-model:** A **shared** module to be used by `user` related feature. Essentially a `user` model class.
+
+**user:** A feature module for showing a particular user details. This module has the `base` and `user-model` modules.
+
+**users:** A feature module for showing a list of users. This module has the `base` and `user-model` modules as well.
+
+**login:** A feature module for allowing a user to login. This module has the `base` and `user-model` modules.
+
+**base:** A shared module to be used by all feature related modules.
+
+
+# Navigation
+
+[Deep link](https://developer.android.com/training/app-links/deep-linking) handles all the navigations
+
+There's an `AppNavigation` class in the base module navigating users to the different screens. This is solely using deep links for launching all `Activities`
+
+# Sample Demo

app/.gitignore

@@ -0,0 +1 @@
+/build

app/build.gradle.kts

@@ -0,0 +1,54 @@
+plugins {
+    id("com.android.application")
+    id("kotlin-android")
+    id("kotlin-kapt")
+}
+
+android {
+    compileSdkVersion(Versions.COMPILE_SDK)
+    dataBinding.isEnabled = true
+    defaultConfig {
+        applicationId = Versions.APPLICATION_ID
+        minSdkVersion(Versions.MIN_SDK)
+        targetSdkVersion(Versions.TARGET_SDK)
+        testApplicationId = "${Versions.APPLICATION_ID}.test"
+        vectorDrawables.useSupportLibrary = true
+        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+        versionCode = 1
+        versionName = "1.0"
+        val baseUrl = "https://api.github.com/"
+        buildConfigField("String", "BASE_URL", "\"${baseUrl}\"")
+    }
+
+    buildTypes {
+        getByName("release") {
+            isMinifyEnabled = false
+            isShrinkResources = false
+            proguardFile(getDefaultProguardFile("proguard-android.txt"))
+            proguardFile(file("proguard-rules.pro"))
+        }
+    }
+    compileOptions {
+        setSourceCompatibility(Versions.SOURCE_COMPATIBILITY)
+        setTargetCompatibility(Versions.SOURCE_COMPATIBILITY)
+    }
+    dexOptions {
+        preDexLibraries = "true" != System.getenv("CI")
+    }
+    lintOptions {
+        isCheckDependencies = true
+        isIgnoreTestSources = true
+    }
+}
+
+dependencies {
+    implementation(project(":base"))
+    implementation(project(":user"))
+    implementation(project(":users"))
+    implementation(project(":login"))
+    kapt(Dependencies.Databinding.compiler)
+    kapt(Dependencies.Dagger.compiler)
+    kapt(Dependencies.Dagger.processor)
+    kapt(Dependencies.Lifecycle.compiler)
+    kapt(Dependencies.Glide.compiler)
+}

app/proguard-rules.pro

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.kts.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

app/src/main/AndroidManifest.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+          xmlns:tools="http://schemas.android.com/tools" package="com.addhen.github">
+    <uses-permission android:name="android.permission.INTERNET"/>
+    <application
+        android:allowBackup="true"
+        android:icon="@mipmap/ic_launcher"
+        android:label="@string/app_name"
+        android:roundIcon="@mipmap/ic_launcher_round"
+        android:supportsRtl="true"
+        android:name=".App"
+        android:theme="@style/AppTheme.NoActionBar" tools:ignore="GoogleAppIndexingWarning">
+
+    </application>
+</manifest>

app/src/main/java/com/addhen/github/App.kt

@@ -0,0 +1,9 @@
+package com.addhen.github
+
+import com.addhen.github.di.DaggerAppComponent
+import dagger.android.DaggerApplication
+
+class App : DaggerApplication() {
+
+    override fun applicationInjector() = DaggerAppComponent.builder().create(this)
+}

app/src/main/java/com/addhen/github/di/ActivityBuilder.kt

@@ -0,0 +1,20 @@
+package com.addhen.github.di
+
+import com.addhen.github.login.LoginActivity
+import com.addhen.github.user.UserActivity
+import com.addhen.github.users.UsersActivity
+import dagger.Module
+import dagger.android.ContributesAndroidInjector
+
+@Module
+internal abstract class ActivityBuilder {
+
+    @ContributesAndroidInjector
+    internal abstract fun usersActivity(): UsersActivity
+
+    @ContributesAndroidInjector
+    internal abstract fun userActivity(): UserActivity
+
+    @ContributesAndroidInjector
+    internal abstract fun loginActivity(): LoginActivity
+}

app/src/main/java/com/addhen/github/di/AppComponent.kt

@@ -0,0 +1,23 @@
+package com.addhen.github.di
+
+import com.addhen.github.App
+import com.addhen.github.user.UserModule
+import com.addhen.github.users.UsersModule
+import dagger.Component
+import dagger.android.AndroidInjector
+import dagger.android.support.AndroidSupportInjectionModule
+import javax.inject.Singleton
+
+@Singleton
+@Component(modules = [
+    AndroidSupportInjectionModule::class,
+    ActivityBuilder::class,
+    AppModule::class,
+    UsersModule::class,
+    UserModule::class
+])
+interface AppComponent : AndroidInjector<App> {
+
+    @Component.Builder
+    abstract class Builder : AndroidInjector.Builder<App>()
+}

app/src/main/java/com/addhen/github/di/AppModule.kt

@@ -0,0 +1,107 @@
+package com.addhen.github.di
+
+import android.content.Context
+import com.addhen.github.App
+import com.addhen.github.AppRxSchedulers
+import com.addhen.github.BuildConfig
+import com.addhen.github.RxSchedulers
+import com.jakewharton.retrofit2.adapter.kotlin.coroutines.experimental.CoroutineCallAdapterFactory
+import com.squareup.moshi.Moshi
+import com.squareup.moshi.Rfc3339DateJsonAdapter
+import dagger.Module
+import dagger.Provides
+import okhttp3.Cache
+import okhttp3.OkHttpClient
+import okhttp3.logging.HttpLoggingInterceptor
+import retrofit2.Retrofit
+import retrofit2.converter.moshi.MoshiConverterFactory
+import timber.log.Timber
+import java.io.File
+import java.util.Date
+import java.util.concurrent.TimeUnit
+import javax.inject.Singleton
+
+@Module(includes = [
+    ViewModelBuilder::class]
+)
+object AppModule {
+
+    private val DISK_CACHE_SIZE: Long = 50 * 1024 * 1024 // 50MB
+
+    private val HTTP_TIMEOUT = 15L
+
+    @Singleton
+    @Provides
+    @JvmStatic
+    fun provideAppContext(app: App) = app.applicationContext
+
+    @Singleton
+    @Provides
+    @JvmStatic
+    fun provideLoggingInterceptor(): HttpLoggingInterceptor {
+        val loggingInterceptor = HttpLoggingInterceptor { message ->
+            Timber.tag("OkHttp").d(message)
+        }
+        loggingInterceptor.level = if (BuildConfig.DEBUG) {
+            HttpLoggingInterceptor.Level.BODY
+        } else {
+            HttpLoggingInterceptor.Level.BASIC
+        }
+        return loggingInterceptor
+    }
+
+    @Singleton
+    @Provides
+    @JvmStatic
+    fun provideOkHttpClient(
+        context: Context,
+        loggingInterceptor: HttpLoggingInterceptor
+    ): OkHttpClient {
+        val okHttpClientBuilder = OkHttpClient.Builder()
+        val cacheDir = File(context.applicationContext.cacheDir, "app-http-cache")
+        val cache = Cache(cacheDir, DISK_CACHE_SIZE)
+        okHttpClientBuilder.cache(cache)
+        initOkHttpBuilder(okHttpClientBuilder, loggingInterceptor)
+        return okHttpClientBuilder.build()
+    }
+
+
+    @Singleton
+    @Provides
+    @JvmStatic
+    fun provideMoshi(): Moshi {
+        return Moshi.Builder()
+            .add(Date::class.java, Rfc3339DateJsonAdapter())
+            .build()
+    }
+
+    @Singleton
+    @Provides
+    @JvmStatic
+    fun provideRetrofit(okHttpClient: OkHttpClient, moshi: Moshi): Retrofit {
+        return Retrofit.Builder()
+            .baseUrl(BuildConfig.BASE_URL)
+            .addConverterFactory(MoshiConverterFactory.create(moshi))
+            .addCallAdapterFactory(CoroutineCallAdapterFactory())
+            .client(okHttpClient)
+            .build()
+    }
+
+
+    @Singleton
+    @Provides
+    @JvmStatic
+    fun provideRxScheduler(): RxSchedulers {
+        return AppRxSchedulers()
+    }
+
+    private fun initOkHttpBuilder(
+        okHttpClientBuilder: OkHttpClient.Builder,
+        loggingInterceptor: HttpLoggingInterceptor
+    ) {
+        okHttpClientBuilder.connectTimeout(HTTP_TIMEOUT, TimeUnit.SECONDS)
+        okHttpClientBuilder.writeTimeout(HTTP_TIMEOUT, TimeUnit.SECONDS)
+        okHttpClientBuilder.readTimeout(HTTP_TIMEOUT, TimeUnit.SECONDS)
+        okHttpClientBuilder.addInterceptor(loggingInterceptor)
+    }
+}