[multi_module]: Project setup for multi-module

Author: deepakyml

.editorconfig

@@ -0,0 +1,28 @@
+# https://editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{java,kt,kts,scala,rs,xml,kt.spec,kts.spec}]
+indent_size = 4
+disabled_rules=no-wildcard-imports
+
+[*.{kt,kts}]
+ktlint_code_style = ktlint_official
+ktlint_ignore_back_ticked_identifier = true
+
+ktlint_standard = enabled
+
+# Experimental rules run by default run on the ktlint code base itself. Experimental rules should not be released if
+# we are not pleased ourselves with the results on the ktlint code base.
+ktlint_experimental = enabled
+
+[*.md]
+trim_trailing_whitespace = false

YTemplate.sh

@@ -1,19 +1,4 @@
 #!/bin/bash
-#
-# Copyright (C) 2022 The Android Open Source Project
-#
-# 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.
-#
 
 # Verify bash version. macOS comes with bash 3 preinstalled.
 if [[ ${BASH_VERSINFO[0]} -lt 4 ]]
@@ -25,34 +10,26 @@ fi
 # exit when any command fails
 set -e
 
-if [[ $# -lt 2 ]]; then
-   echo "Usage: bash customizer.sh my.new.package MyNewDataModel [ApplicationName]" >&2
+if [[ $# -lt 1 ]]; then
+   echo "Usage: bash YTemplate.sh my.new.package [ApplicationName]" >&1
    exit 2
 fi
 
 PACKAGE=$1
-DATAMODEL=$2
-APPNAME=$3
+APPNAME=$2
 SUBDIR=${PACKAGE//.//} # Replaces . with /
 
-for n in $(find . -type d \( -path '*/app/src/androidTest' -or -path '*/app/src/main' -or -path '*/app/src/test' \) )
+# Creating package name directory under java  folder
+for n in $(find . -type d \( -path '*/src/androidTest' -or -path '*/src/main' -or -path '*/src/test' \) )
 do
   echo "Creating $n/java/$SUBDIR"
   mkdir -p $n/java/$SUBDIR
   echo "Moving files to $n/java/$SUBDIR"
-  mv $n/java/ytemplate/android/* $n/java/$SUBDIR
-  echo "Removing old $n/java/ytemplate/android/"
+  mv $n/java/ytemplate/android/* $n/java/$SUBDIR || echo "No such file or directory found"
+  echo "Removing old $n/java/ytemplate/android/" || echo "File not found"
   rm -rf mv $n/java/ytemplate
 done
 
-# Jacoco Dependancies
-echo "Creating buildSrc/src/main/java/$SUBDIR/build"
-mkdir -p buildSrc/src/main/java/$SUBDIR/build
-echo "Moving files to buildSrc/src/main/java/$SUBDIR/build"
-mv buildSrc/src/main/java/ytemplate/android/build/* buildSrc/src/main/java/$SUBDIR/build
-echo "Removing old buildSrc/src/main/java/ytemplate/android"
-rm -rf mv buildSrc/src/main/java/ytemplate
-
 # Rename package and imports
 echo "Renaming packages to $PACKAGE"
 find ./ -type f -name "*.kt" -exec sed -i.bak "s/package ytemplate.android/package $PACKAGE/g" {} \;
@@ -64,28 +41,14 @@ find ./ -type f -name "*.kts" -exec sed -i.bak "s/ytemplate.android/$PACKAGE/g"
 # Manifest files
 find ./ -type f -name "*.xml" -exec sed -i.bak "s/ytemplate.android/$PACKAGE/g" {} \;
 
-# Rename model
-echo "Renaming model to $DATAMODEL"
-find ./ -type f -name "*.kt" -exec sed -i.bak "s/MyModel/${DATAMODEL^}/g" {} \; # First upper case
-find ./ -type f -name "*.kt" -exec sed -i.bak "s/myModel/${DATAMODEL,}/g" {} \; # First lower case
-find ./ -type f -name "*.kt*" -exec sed -i.bak "s/mymodel/${DATAMODEL,,}/g" {} \; # All lowercase
+# Rename ytemplate.android
+echo "Renaming ytemplate.android to $PACKAGE"
+find ./ -type f -name "*.kt" -exec sed -i.bak "s/ytemplate.android/$PACKAGE/g" {} \;
 
+#Cleaning Up .bak files
 echo "Cleaning up"
 find . -name "*.bak" -type f -delete
 
-# Rename files
-echo "Renaming files to $DATAMODEL"
-find ./ -name "*MyModel*.kt" | sed "p;s/MyModel/${DATAMODEL^}/" | tr '\n' '\0' | xargs -0 -n 2 mv
-# module names
-if [[ -n $(find ./ -name "*-mymodel") ]]
-then
-  echo "Renaming modules to $DATAMODEL"
-  find ./ -name "*-mymodel" -type d  | sed "p;s/mymodel/${DATAMODEL,,}/" |  tr '\n' '\0' | xargs -0 -n 2 mv
-fi
-# directories
-echo "Renaming directories to $DATAMODEL"
-find ./ -name "mymodel" -type d  | sed "p;s/mymodel/${DATAMODEL,,}/" |  tr '\n' '\0' | xargs -0 -n 2 mv
-
 # Renaming YTemplateTheme
 echo "Renaming YTemplateTheme to $APPNAME"
 find ./ -type f -name "*.kt" -exec sed -i.bak "s/YTemplateTheme/${APPNAME}Theme/g" {} \;
@@ -101,8 +64,5 @@ fi
 
 # Remove additional files
 echo "Removing additional files"
-rm -rf .google/
-# rm -rf .github/
-# rm -rf CONTRIBUTING.md LICENSE README.md customizer.sh
-# rm -rf .git/
+ rm -rf .git/
 echo "Done!"

app/build.gradle.kts

@@ -1,87 +1,33 @@
+@Suppress("DSL_SCOPE_VIOLATION") // scope violation issue: work around suggested from: https://github.com/gradle/gradle/issues/22797
 plugins {
-    id("com.android.application")
-    id("org.jetbrains.kotlin.android")
-    kotlin("kapt")
-    alias(versionCatalogLibs.plugins.hilt.plugin)
-    id("jacoco-reports")
-    id("org.jetbrains.kotlin.plugin.serialization")
+    id("ytemplate.android.application")
+    id("ytemplate.android.application.jacoco")
+    id("ytemplate.android.application.compose")
+    id("ytemplate.android.hilt")
 }
 
 android {
-    namespace ="ytemplate.android"
-    compileSdk =  versionCatalogLibs.versions.compile.sdk.get().toInt()
-
+    namespace = "ytemplate.android"
     defaultConfig {
-        applicationId="ytemplate.android"
-        minSdk = versionCatalogLibs.versions.min.sdk.get().toInt()
-        targetSdk = versionCatalogLibs.versions.target.sdk.get().toInt()
+        applicationId = "ytemplate.android"
         versionCode = 1
         versionName = "1.0"
-
-        testInstrumentationRunner = "ytemplate.android.HiltTestRunner"
-        vectorDrawables {
-            useSupportLibrary = true
-        }
-    }
-    buildTypes {
-        getByName("release"){
-            isMinifyEnabled = false
-            proguardFiles(getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro")
-        }
-        getByName("debug") {
-            isMinifyEnabled  = false
-            enableUnitTestCoverage = true
-            enableAndroidTestCoverage = true
-        }
-    }
-    compileOptions {
-        sourceCompatibility = JavaVersion.VERSION_11
-        targetCompatibility = JavaVersion.VERSION_11
-    }
-    kotlinOptions {
-        jvmTarget = versionCatalogLibs.versions.kotlin.jvm.target.get()
-    }
-    buildFeatures {
-        compose =  true
-    }
-    composeOptions {
-        kotlinCompilerExtensionVersion  = versionCatalogLibs.versions.compose.compiler.get()
-    }
-    packagingOptions {
-        resources {
-            excludes += "/META-INF/{AL2.0,LGPL2.1}"
-        }
     }
 }
 
 dependencies {
-    //Compose
-    implementation (versionCatalogLibs.bundles.compose)
-    androidTestImplementation(versionCatalogLibs.compose.nav.test)
-    //ktx
-    implementation (versionCatalogLibs.bundles.ktx)
-    //hilt
-    implementation(versionCatalogLibs.bundles.hilt)
-    kapt(versionCatalogLibs.hilt.compiler)
-    androidTestImplementation(versionCatalogLibs.hilt.test)
-    kaptAndroidTest(versionCatalogLibs.hilt.compiler)
-    //coroutine
-    implementation(versionCatalogLibs.coroutine)
-    testImplementation(versionCatalogLibs.bundles.coroutine.test)
-    //Room
-    implementation(versionCatalogLibs.bundles.room)
-    annotationProcessor(versionCatalogLibs.room.compiler)
-    kapt(versionCatalogLibs.room.compiler)
-    testImplementation(versionCatalogLibs.room.test)
-    //Ktor
-    implementation (versionCatalogLibs.bundles.ktor)
-    testImplementation(versionCatalogLibs.ktor.client.mock)
-    androidTestImplementation(versionCatalogLibs.ktor.client.mock)
-    //Android Testing
-    androidTestImplementation (versionCatalogLibs.bundles.android.test)
-    testImplementation (versionCatalogLibs.junit)
-    debugImplementation (versionCatalogLibs.bundles.android.debug.test)
+    implementation(versionCatalogLibs.hilt.nav.compose)
+    implementation(versionCatalogLibs.androidx.lifecycle.viewModelCompose)
 
-    androidTestImplementation(project(mapOf("path" to ":app")))
+    implementation(project(mapOf("path" to ":core:ui")))
+    implementation(project(mapOf("path" to ":feature:post")))
 
-}
+    androidTestImplementation(versionCatalogLibs.androidx.test.core)
+    androidTestImplementation(versionCatalogLibs.androidx.test.core.ktx)
+    androidTestImplementation(versionCatalogLibs.androidx.test.ext)
+    androidTestImplementation(versionCatalogLibs.androidx.test.runner)
+    androidTestImplementation(versionCatalogLibs.androidx.test.rules)
+
+    debugImplementation("androidx.compose.ui:ui-test-manifest:${versionCatalogLibs.versions.compose}")
+    androidTestImplementation(project(mapOf("path" to ":core:test")))
+}

app/proguard-rules.pro

@@ -1,21 +1,26 @@
-# 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
+# Keep `Companion` object fields of serializable classes.
+# This avoids serializer lookup through `getDeclaredClasses` as done for named companion objects.
+-if @kotlinx.serialization.Serializable class **
+-keepclassmembers class <1> {
+    static <1>$Companion Companion;
+}
 
-# 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 *;
-#}
+# Keep `serializer()` on companion objects (both default and named) of serializable classes.
+-if @kotlinx.serialization.Serializable class ** {
+    static **$* *;
+}
+-keepclassmembers class <2>$<3> {
+    kotlinx.serialization.KSerializer serializer(...);
+}
 
-# Uncomment this to preserve the line number information for
-# debugging stack traces.
-#-keepattributes SourceFile,LineNumberTable
+# Keep `INSTANCE.serializer()` of serializable objects.
+-if @kotlinx.serialization.Serializable class ** {
+    public static ** INSTANCE;
+}
+-keepclassmembers class <1> {
+    public static <1> INSTANCE;
+    kotlinx.serialization.KSerializer serializer(...);
+}
 
-# If you keep the line number information, uncomment this to
-# hide the original source file name.
-#-renamesourcefileattribute SourceFile
+# @Serializable and @Polymorphic are used at runtime for polymorphic serialization.
+-keepattributes RuntimeVisibleAnnotations,AnnotationDefault

app/src/androidTest/java/ytemplate/android/ApplicationTest.kt

@@ -0,0 +1,26 @@
+package ytemplate.android
+
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import androidx.test.platform.app.InstrumentationRegistry
+import org.junit.Assert.assertTrue
+import org.junit.Test
+import org.junit.runner.RunWith
+
+/**
+ * Application test
+ *
+ * @constructor Create empty Application test
+ */
+@RunWith(AndroidJUnit4::class)
+class ApplicationTest {
+    /**
+     * Test app context
+     *
+     */
+    @Test
+    fun testAppContext() {
+        // Context of the app under test.
+        val appContext = InstrumentationRegistry.getInstrumentation().targetContext
+        assertTrue(appContext.packageName.contains("ytemplate.android"))
+    }
+}

app/src/androidTest/java/ytemplate/android/MainActivityTest.kt

@@ -1,11 +1,56 @@
 package ytemplate.android
 
+import androidx.compose.ui.test.junit4.createAndroidComposeRule
+import androidx.lifecycle.Lifecycle
+import androidx.test.core.app.launchActivity
+import androidx.test.ext.junit.rules.activityScenarioRule
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import androidx.test.platform.app.InstrumentationRegistry
 import dagger.hilt.android.testing.HiltAndroidRule
 import dagger.hilt.android.testing.HiltAndroidTest
+import org.junit.Assert
 import org.junit.Rule
+import org.junit.Test
+import org.junit.runner.RunWith
 
+/**
+ * Main activity test
+ *
+ * @constructor Create empty Main activity test
+ */
 @HiltAndroidTest
+@RunWith(AndroidJUnit4::class)
 class MainActivityTest {
-    @get:Rule
+    @get:Rule(order = 0)
     var hiltRule = HiltAndroidRule(this)
-}
+
+    @get:Rule(order = 1)
+    var activityScenarioRule = activityScenarioRule<MainActivity>()
+
+    @get:Rule(order = 2)
+    val composeTestRule = createAndroidComposeRule<MainActivity>()
+
+    /**
+     * Use app context
+     *
+     */
+    @Test
+    fun useAppContext() {
+        // Context of the app under test.
+        val appContext = InstrumentationRegistry.getInstrumentation().targetContext
+        Assert.assertTrue(appContext.packageName.contains("ytemplate.android"))
+    }
+
+    /**
+     * Check launched
+     *
+     */
+    @Test
+    fun checkLaunched() {
+        launchActivity<MainActivity>().use { scenario ->
+            Assert.assertEquals(Lifecycle.State.RESUMED, scenario.state)
+            scenario.moveToState(Lifecycle.State.CREATED)
+            scenario.close()
+        }
+    }
+}