[12] Integrate Moko Resources to share project resources between platforms

.gitmodules

@@ -4,4 +4,4 @@
 [submodule "android"]
 	path = android
 	url = [email protected]:nimblehq/android-templates.git
-	branch = feature/replace-hilt-with-koin
+	branch = feature/moko-resources

buildSrc/src/main/java/Dependencies.kt

@@ -52,6 +52,13 @@ object Dependencies {
         const val COMMON_KTX = "com.github.nimblehq:android-common-ktx:${Versions.COMMON_KTX}"
     }
 
+    object Moko {
+        const val RESOURCES_GENERATOR = "dev.icerock.moko:resources-generator:${Versions.MOKO_RESOURCES}"
+        const val RESOURCES = "dev.icerock.moko:resources:${Versions.MOKO_RESOURCES}"
+        const val RESOURCES_COMPOSE = "dev.icerock.moko:resources-compose:${Versions.MOKO_RESOURCES}"
+        const val GRAPHICS = "dev.icerock.moko:graphics:${Versions.MOKO_GRAPHICS}"
+    }
+
     object Test {
         const val COMPOSE_UI_TEST_JUNIT = "androidx.compose.ui:ui-test-junit4"
         const val COROUTINES = "org.jetbrains.kotlinx:kotlinx-coroutines-test:${Versions.KOTLIN_COROUTINES}"
@@ -66,6 +73,8 @@ object Dependencies {
         const val MOCKK = "io.mockk:mockk:${Versions.MOCKK}"
         const val MOCKK_ANDROID = "io.mockk:mockk-android:${Versions.MOCKK}"
 
+        const val MOKO_RESOURCES_TEST = "dev.icerock.moko:resources-test:${Versions.MOKO_RESOURCES}"
+
         const val ROBOLECTRIC = "org.robolectric:robolectric:${Versions.ROBOLECTRIC}"
 
         const val TURBINE = "app.cash.turbine:turbine:${Versions.TURBINE}"

buildSrc/src/main/java/Plugins.kt

@@ -16,5 +16,7 @@ object Plugins {
     const val KOVER = "org.jetbrains.kotlinx.kover"
     const val KSP = "com.google.devtools.ksp"
 
+    const val MOKO = "dev.icerock.mobile.multiplatform-resources"
+
     const val MULTIPLATFORM = "multiplatform"
 }

buildSrc/src/main/java/Versions.kt

@@ -38,6 +38,9 @@ object Versions {
     const val MOCKATIVE = "1.3.0"
     const val MOCKK = "1.13.3"
 
+    const val MOKO_RESOURCES = "0.23.0"
+    const val MOKO_GRAPHICS = "0.9.0"
+
     const val NAPIER = "2.6.1"
 
     const val ROBOLECTRIC = "4.9.1"

sample/android/src/main/java/co/nimblehq/kmm/template/MainApplication.kt

@@ -1,6 +1,7 @@
 package co.nimblehq.kmm.template
 
 import android.app.Application
+import co.nimblehq.common.extensions.BuildConfig
 import co.nimblehq.kmm.template.di.initKoin
 import co.nimblehq.kmm.template.di.modules.appModule
 import co.nimblehq.kmm.template.di.modules.viewModelModule

sample/android/src/main/java/co/nimblehq/kmm/template/ui/screens/home/HomeScreen.kt

@@ -11,7 +11,10 @@ import androidx.compose.ui.text.style.TextAlign
 import androidx.compose.ui.tooling.preview.Preview
 import androidx.lifecycle.compose.collectAsStateWithLifecycle
 import co.nimblehq.kmm.template.R
+import co.nimblehq.kmm.template.Strings
 import co.nimblehq.kmm.template.extensions.collectAsEffect
+import co.nimblehq.kmm.template.getPlatform
+import co.nimblehq.kmm.template.sharedres.SharedRes
 import co.nimblehq.kmm.template.ui.AppDestination
 import co.nimblehq.kmm.template.ui.models.UiModel
 import co.nimblehq.kmm.template.ui.showToast
@@ -32,15 +35,18 @@ fun HomeScreen(
     val uiModels: List<UiModel> by viewModel.uiModels.collectAsStateWithLifecycle()
 
     HomeScreenContent(
-        title = stringResource(id = R.string.app_name),
+        title = Strings(LocalContext.current).get(
+            id = SharedRes.strings.greeting,
+            args = listOf(getPlatform().name)
+        ),
         uiModels = uiModels
     )
 }
 
 @Composable
 private fun HomeScreenContent(
     title: String,
-    uiModels: List<UiModel>
+    uiModels: List<UiModel>,
 ) {
     Column(
         modifier = Modifier.fillMaxSize(),

sample/build.gradle.kts

@@ -11,6 +11,12 @@ plugins {
     kotlin(Plugins.KOTLIN_SERIALIZATION) version Versions.KOTLIN
 }
 
+buildscript {
+    dependencies {
+        classpath(Dependencies.Moko.RESOURCES_GENERATOR)
+    }
+}
+
 detekt {
     toolVersion = Versions.DETEKT
     config.setFrom("detekt.yml")

sample/buildSrc/src/main/java/Dependencies.kt

@@ -52,6 +52,13 @@ object Dependencies {
         const val COMMON_KTX = "com.github.nimblehq:android-common-ktx:${Versions.COMMON_KTX}"
     }
 
+    object Moko {
+        const val RESOURCES_GENERATOR = "dev.icerock.moko:resources-generator:${Versions.MOKO_RESOURCES}"
+        const val RESOURCES = "dev.icerock.moko:resources:${Versions.MOKO_RESOURCES}"
+        const val RESOURCES_COMPOSE = "dev.icerock.moko:resources-compose:${Versions.MOKO_RESOURCES}"
+        const val GRAPHICS = "dev.icerock.moko:graphics:${Versions.MOKO_GRAPHICS}"
+    }
+
     object Test {
         const val COMPOSE_UI_TEST_JUNIT = "androidx.compose.ui:ui-test-junit4"
         const val COROUTINES = "org.jetbrains.kotlinx:kotlinx-coroutines-test:${Versions.KOTLIN_COROUTINES}"
@@ -66,6 +73,8 @@ object Dependencies {
         const val MOCKK = "io.mockk:mockk:${Versions.MOCKK}"
         const val MOCKK_ANDROID = "io.mockk:mockk-android:${Versions.MOCKK}"
 
+        const val MOKO_RESOURCES_TEST = "dev.icerock.moko:resources-test:${Versions.MOKO_RESOURCES}"
+
         const val ROBOLECTRIC = "org.robolectric:robolectric:${Versions.ROBOLECTRIC}"
 
         const val TURBINE = "app.cash.turbine:turbine:${Versions.TURBINE}"

sample/buildSrc/src/main/java/Plugins.kt

@@ -16,5 +16,7 @@ object Plugins {
     const val KOVER = "org.jetbrains.kotlinx.kover"
     const val KSP = "com.google.devtools.ksp"
 
+    const val MOKO = "dev.icerock.mobile.multiplatform-resources"
+
     const val MULTIPLATFORM = "multiplatform"
 }

sample/buildSrc/src/main/java/Versions.kt

@@ -38,6 +38,9 @@ object Versions {
     const val MOCKATIVE = "1.3.0"
     const val MOCKK = "1.13.3"
 
+    const val MOKO_RESOURCES = "0.23.0"
+    const val MOKO_GRAPHICS = "0.9.0"
+
     const val NAPIER = "2.6.1"
 
     const val ROBOLECTRIC = "4.9.1"

sample/shared/build.gradle.kts

@@ -11,6 +11,7 @@ plugins {
     id(Plugins.KOVER)
     id(Plugins.KSP)
     id(Plugins.BUILD_KONFIG)
+    id(Plugins.MOKO)
 }
 
 @OptIn(org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi::class)
@@ -36,6 +37,8 @@ kotlin {
         podfile = project.file("../ios/Podfile")
         framework {
             baseName = "shared"
+            export(Dependencies.Moko.RESOURCES)
+            export(Dependencies.Moko.GRAPHICS)
         }
 
         xcodeConfigurationToNativeBuildType["Debug Staging"] = NativeBuildType.DEBUG
@@ -60,6 +63,11 @@ kotlin {
                 }
 
                 implementation(Dependencies.Log.NAPIER)
+
+                with(Dependencies.Moko) {
+                    api(RESOURCES)
+                    api(RESOURCES_COMPOSE) FIXME: Cannot build the shared module with this dependency
+                }
             }
         }
         val commonTest by getting {
@@ -145,3 +153,8 @@ buildkonfig {
         )
     }
 }
+
+multiplatformResources {
+    multiplatformResourcesPackage = "co.nimblehq.kmm.template.sharedres"
+    multiplatformResourcesClassName = "SharedRes"
+}

sample/shared/src/androidMain/kotlin/co/nimblehq/kmm/template/Strings.kt

@@ -0,0 +1,20 @@
+package co.nimblehq.kmm.template
+
+import android.content.Context
+import dev.icerock.moko.resources.StringResource
+import dev.icerock.moko.resources.desc.Resource
+import dev.icerock.moko.resources.desc.StringDesc
+import dev.icerock.moko.resources.format
+
+actual class Strings(private val context: Context) {
+    actual fun get(
+        id: StringResource,
+        args: List<Any>,
+    ): String {
+        return if (args.isEmpty()) {
+            StringDesc.Resource(id).toString(context = context)
+        } else {
+            id.format(*args.toTypedArray()).toString(context)
+        }
+    }
+}

sample/shared/src/commonMain/kotlin/co/nimblehq/kmm/template/Strings.kt

@@ -0,0 +1,7 @@
+package co.nimblehq.kmm.template
+
+import dev.icerock.moko.resources.StringResource
+
+expect class Strings {
+    fun get(id: StringResource, args: List<Any> = emptyList()): String
+}

sample/shared/src/commonMain/resources/MR/base/strings.xml

@@ -0,0 +1,3 @@
+<resources>
+    <string name="greeting">Hello, %s!</string>
+</resources>

sample/shared/src/iosMain/kotlin/co/nimblehq/kmm/template/Strings.kt

@@ -0,0 +1,19 @@
+package co.nimblehq.kmm.template
+
+import dev.icerock.moko.resources.StringResource
+import dev.icerock.moko.resources.desc.Resource
+import dev.icerock.moko.resources.desc.StringDesc
+import dev.icerock.moko.resources.format
+
+actual class Strings {
+    actual fun get(
+        id: StringResource,
+        args: List<Any>,
+    ): String {
+        return if (args.isEmpty()) {
+            StringDesc.Resource(id).localized()
+        } else {
+            id.format(*args.toTypedArray()).localized()
+        }
+    }
+}

shared/build.gradle.kts

@@ -11,6 +11,7 @@ plugins {
     id(Plugins.KOVER)
     id(Plugins.KSP)
     id(Plugins.BUILD_KONFIG)
+    id(Plugins.MOKO)
 }
 
 @OptIn(org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi::class)
@@ -36,6 +37,8 @@ kotlin {
         podfile = project.file("../ios/Podfile")
         framework {
             baseName = "shared"
+            export(Dependencies.Moko.RESOURCES)
+            export(Dependencies.Moko.GRAPHICS)
         }
 
         xcodeConfigurationToNativeBuildType["Debug Staging"] = NativeBuildType.DEBUG
@@ -60,6 +63,11 @@ kotlin {
                 }
 
                 implementation(Dependencies.Log.NAPIER)
+
+                with(Dependencies.Moko) {
+                    api(RESOURCES)
+                    api(RESOURCES_COMPOSE)
+                }
             }
         }
         val commonTest by getting {
@@ -145,3 +153,8 @@ buildkonfig {
         )
     }
 }
+
+multiplatformResources {
+    multiplatformResourcesPackage = "co.nimblehq.kmm.template.sharedres"
+    multiplatformResourcesClassName = "SharedRes"
+}

shared/src/androidMain/kotlin/co/nimblehq/kmm/template/Strings.kt

@@ -0,0 +1,20 @@
+package co.nimblehq.kmm.template
+
+import android.content.Context
+import dev.icerock.moko.resources.StringResource
+import dev.icerock.moko.resources.desc.Resource
+import dev.icerock.moko.resources.desc.StringDesc
+import dev.icerock.moko.resources.format
+
+actual class Strings(private val context: Context) {
+    actual fun get(
+        id: StringResource,
+        args: List<Any>,
+    ): String {
+        return if (args.isEmpty()) {
+            StringDesc.Resource(id).toString(context = context)
+        } else {
+            id.format(*args.toTypedArray()).toString(context)
+        }
+    }
+}

shared/src/commonMain/kotlin/co/nimblehq/kmm/template/Strings.kt

@@ -0,0 +1,7 @@
+package co.nimblehq.kmm.template
+
+import dev.icerock.moko.resources.StringResource
+
+expect class Strings {
+    fun get(id: StringResource, args: List<Any> = emptyList()): String
+}

shared/src/commonMain/resources/MR/base/strings.xml

@@ -0,0 +1,3 @@
+<resources>
+    <string name="greeting">Hello, %s!</string>
+</resources>

shared/src/iosMain/kotlin/co/nimblehq/kmm/template/Strings.kt

@@ -0,0 +1,19 @@
+package co.nimblehq.kmm.template
+
+import dev.icerock.moko.resources.StringResource
+import dev.icerock.moko.resources.desc.Resource
+import dev.icerock.moko.resources.desc.StringDesc
+import dev.icerock.moko.resources.format
+
+actual class Strings {
+    actual fun get(
+        id: StringResource,
+        args: List<Any>,
+    ): String {
+        return if (args.isEmpty()) {
+            StringDesc.Resource(id).localized()
+        } else {
+            id.format(*args.toTypedArray()).localized()
+        }
+    }
+}