Merge pull request #8 from KryptKode/develop

Develop

Author: KryptKode

.cloc

@@ -0,0 +1,6 @@
+app/src
+common/androidShared/src
+common/testShared/src
+core/src
+libs/basemvi/src
+features/users/src

.codecov/config.yml

@@ -0,0 +1,33 @@
+codecov:
+  notify:
+    require_ci_to_pass: yes
+
+coverage:
+  precision: 2
+  round: down
+  range: 60..100
+  status:
+    project:
+      default:
+        enabled: yes
+        target: auto
+        threshold: 2
+    patch:
+      default:
+        enabled: yes
+        target: auto
+        threshold: 2
+    changes: no
+
+parsers:
+  gcov:
+    branch_detection:
+      conditional: yes
+      loop: yes
+      method: no
+      macro: no
+
+comment:
+  layout: "header,reach,diff,flags,files"
+  behavior: default
+  require_changes: no

.github/workflows/android.yml

@@ -22,6 +22,11 @@ jobs:
         with:
           java-version: 1.8
 
+      - name: Decode API app-id
+        env:
+          DUMMY_API_ID: ${{ secrets.DUMMY_API_ID }}
+        run: echo dummy.api.app.id="DUMMY_API_ID" >> ./local.properties
+
       - uses: actions/cache@v2
         with:
           path: ~/.gradle
@@ -41,6 +46,11 @@ jobs:
         with:
           java-version: 1.8
 
+      - name: Decode API app-id
+        env:
+          DUMMY_API_ID: ${{ secrets.DUMMY_API_ID }}
+        run: echo dummy.api.app.id="DUMMY_API_ID" >> ./local.properties
+
       - uses: actions/cache@v2
         with:
           path: ~/.gradle
@@ -61,6 +71,11 @@ jobs:
         with:
           java-version: 1.8
 
+      - name: Decode API app-id
+        env:
+          DUMMY_API_ID: ${{ secrets.DUMMY_API_ID }}
+        run: echo dummy.api.app.id="DUMMY_API_ID" >> ./local.properties
+
       - uses: actions/cache@v2
         with:
           path: ~/.gradle
@@ -81,6 +96,11 @@ jobs:
         with:
           java-version: 1.8
 
+      - name: Decode API app-id
+        env:
+          DUMMY_API_ID: ${{ secrets.DUMMY_API_ID }}
+        run: echo dummy.api.app.id="DUMMY_API_ID" >> ./local.properties
+
       - uses: actions/cache@v2
         with:
           path: ~/.gradle
@@ -91,11 +111,21 @@ jobs:
       - name: Run Unit Tests
         run: ./gradlew testDebugUnitTest
 
+      - name: Upload test reports
+        uses: actions/upload-artifact@v2
+        if: failure()
+        with:
+          name: core-unit-test-report
+          path: |
+            core/build/reports/tests/testDebugUnitTest
+            features/users/build/reports/tests/testDebugUnitTest
+            app/build/reports/tests/testDebugUnitTest
+
       - name: Generate Code Coverage
         run: ./gradlew jacocoTestReportDebug
 
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v1
         with:
           flags: unittests
-          fail_ci_if_error: true
+          fail_ci_if_error: true

README.md

@@ -1,3 +1,10 @@
+[![Actions Status](https://github.com/KryptKode/AndroidMultiModuleTemplate/workflows/android/badge.svg)](https://github.com/KryptKode/AndroidMultiModuleTemplate/actions)
+[![codecov](https://codecov.io/gh/KryptKode/AndroidMultiModuleTemplate/branch/master/graph/badge.svg?token=3L2WH4293M)](https://codecov.io/gh/KryptKode/AndroidMultiModuleTemplate)
+[![Kotlin Version](https://img.shields.io/badge/kotlin-1.4.21-blue.svg)](http://kotlinlang.org/)
+[![AGP](https://img.shields.io/badge/AGP-4.1.0-blue)](https://developer.android.com/studio/releases/gradle-plugin)
+[![Gradle](https://img.shields.io/badge/Gradle-6.5-blue)](https://gradle.org)
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)
+
 # Android Multi-Module Template
 
 [![Actions Status](https://github.com/KryptKode/AndroidMultiModuleTemplate/workflows/android/badge.svg)](https://github.com/KryptKode/AndroidMultiModuleTemplate/actions)
@@ -10,29 +17,42 @@ A template for bootstrapping a multi-module android project. It demonstrates cle
 
 ## Top things to learn here
 
-- Multi-module clean architecture
-- Kotlin coroutines with Flow
-- Dependency injection with Dagger-Hilt
-- Unit testing
-- View abstracted from Fragment
-- API request with Retrofit
-- CI/CD with Github actions
+- Multi-module [clean architecture](https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html)
+- Kotlin coroutines with [Flow]()
+- Dependency injection with [Dagger-Hilt](https://dagger.dev/hilt/)
+- View abstracted from Fragment like [componentizationArch](https://github.com/julianomoraes/componentizationArch)
+- API request with [Retrofit](http://square.github.io/retrofit) and [Moshi](https://github.com/square/moshi) for JSON serialisation and deserialization
+- Local persistence with [Room](https://developer.android.com/topic/libraries/architecture/room)
+- Paging with [Paging 3.0](https://developer.android.com/topic/libraries/architecture/paging/v3-overview)
+- CI  with [Github actions](https://github.com/features/actions)
+- Code coverage with [jacoco](https://github.com/vanniktech/gradle-android-junit-jacoco-plugin) with reports uploaded to [codecov](https://codecov.io/gh/KryptKode/DroidArch/)
 - Code lint check with [Ktlint](https://github.com/pinterest/ktlint) using a [gradle plugin](https://github.com/JLLeitschuh/ktlint-gradle)
 - Static code analysis with [detekt](https://github.com/detekt/detekt)
 - Dependency management with [buildSrc](https://gradle.org/kotlin/)  (Kotlin DSL)
 - Dependency updates with [buildSrcVersions](https://jmfayard.github.io/refreshVersions/)
+- [Git hooks](https://github.com/KryptKode/DroidArch/tree/master/scripts/git-hooks) to perform ktlint, detekt and lint checks before committing
 
 ## Libraries
 
 - [Material Components](https://github.com/material-components/material-components-android/)
 - [Constraint Layout](https://developer.android.com/reference/android/support/constraint/ConstraintLayout)
 - [Retrofit](http://square.github.io/retrofit) for REST api communication
+- [Moshi](https://github.com/square/moshi) for JSON serialisation and deserialization
 - [Mockk](https://github.com/mockk/mockk) for mocking in tests
-- [Dagger2](https://github.com/google/dagger) for dependency injection
+- [Dagger-Hilt](https://dagger.dev/hilt/) for dependency injection
 - [Kotlin Flow](https://kotlinlang.org/docs/reference/coroutines/flow.html) for concurrency
+- [Turbine](https://github.com/cashapp/turbine) for testing flow
 - [ViewModel](https://developer.android.com/topic/libraries/architecture/viewmodel) & [LiveData](https://developer.android.com/topic/libraries/architecture/livedata)
 - [Navigation Architecture Component](https://developer.android.com/guide/navigation/navigation-getting-started)
+- [Room](https://developer.android.com/topic/libraries/architecture/room) for database
+- [Glide](https://github.com/bumptech/glide) for image loading
 - [ViewBinding](https://developer.android.com/topic/libraries/view-binding)
 - [Kotlin Delegates](https://kotlinlang.org/docs/reference/delegated-properties.html)
 - [Ktlint gradle plugin](https://github.com/JLLeitschuh/ktlint-gradle) for code lint checks
 - [Detekt](https://github.com/detekt/detekt) for static code analysis
+- [LeakCanary](https://github.com/square/leakcanary) for detecting memory leaks in development
+
+
+### Extras
+
+The gradle script uses Kotlin Gradle DSL ([buildSrc](https://gradle.org/kotlin/) ) which brings Kotlin's rich language features to gradle configuration. The project also uses detekt to detect code smells and ktlint to enforce proper code style. Github actions handles continuous integration, and runs detekt, ktlint, lint and unit tests concurrently.  A pre-commit git hook  verifies the project's code style before committing code.  Test coverage reports are uploaded to [codecov]().

app/build.gradle.kts

@@ -31,6 +31,11 @@ android {
     kotlinOptions {
         jvmTarget = "1.8"
     }
+
+    compileOptions {
+        sourceCompatibility = JavaVersion.VERSION_1_8
+        targetCompatibility = JavaVersion.VERSION_1_8
+    }
 }
 
 dependencies {

build.gradle.kts

@@ -13,6 +13,7 @@ buildscript {
         classpath(Libs.com_android_tools_build_gradle)
         classpath(Libs.kotlin_gradle_plugin)
         classpath(Libs.hilt_android_gradle_plugin)
+        classpath(Libs.navigation_safe_args_gradle_plugin)
     }
 }
 
@@ -32,12 +33,16 @@ allprojects {
 
     tasks.withType<KotlinCompile>().configureEach {
         kotlinOptions.freeCompilerArgs +=
-            "-Xuse-experimental=" +
-            "kotlin.Experimental," +
-            "kotlinx.coroutines.ExperimentalCoroutinesApi," +
-            "kotlinx.coroutines.InternalCoroutinesApi," +
-            "kotlinx.coroutines.ObsoleteCoroutinesApi," +
-            "kotlinx.coroutines.FlowPreview"
+            listOf(
+                "-Xuse-experimental=kotlin.Experimental",
+                "-Xopt-in=kotlin.time.ExperimentalTime",
+                "-Xopt-in=kotlinx.coroutines.ExperimentalCoroutinesApi",
+                "-Xopt-in=kotlin.RequiresOptIn",
+                "-Xopt-in=kotlinx.coroutines.ObsoleteCoroutinesApi",
+                "-Xopt-in=kotlinx.coroutines.InternalCoroutinesApi",
+                "-Xopt-in=kotlinx.coroutines.FlowPreview",
+                "-Xopt-in=androidx.paging.ExperimentalPagingApi"
+            )
     }
 }
 

buildSrc/build.gradle.kts

@@ -19,6 +19,7 @@ object Dependencies {
     const val detektGradlePlugin = "io.gitlab.arturbosch.detekt:detekt-gradle-plugin:1.15.0"
     const val klintGradlePlugin = "org.jlleitschuh.gradle:ktlint-gradle:9.4.1"
     const val daggerHilt = "com.google.dagger:hilt-android-gradle-plugin:2.28.3-alpha"
+    const val navigationSafeArgs = "androidx.navigation:navigation-safe-args-gradle-plugin:2.3.2"
     const val jacoco = "com.vanniktech:gradle-android-junit-jacoco-plugin:0.16.0"
 }
 
@@ -28,5 +29,6 @@ dependencies {
     implementation(Dependencies.detektGradlePlugin)
     implementation(Dependencies.klintGradlePlugin)
     implementation(Dependencies.daggerHilt)
+    implementation(Dependencies.navigationSafeArgs)
     implementation(Dependencies.jacoco)
-}
+}

buildSrc/src/main/kotlin/BuildModules.kt

@@ -10,7 +10,7 @@ object BuildModules {
         const val home = ":features:home"
     }
 
-    object Commons {
+    object Common {
         const val testShared = ":common:testShared"
         const val androidShared = ":common:androidShared"
     }