Merge pull request #470 from colintheshots-meetup/develop

Fix #118: Fill in missing string translations with base translation

resources/src/appleMain/kotlin/dev/icerock/moko/resources/desc/PluralFormattedStringDesc.kt

@@ -5,6 +5,7 @@
 package dev.icerock.moko.resources.desc
 
 import dev.icerock.moko.resources.PluralsResource
+import dev.icerock.moko.resources.desc.Utils.BASE_LOCALIZATION
 import kotlinx.cinterop.BetaInteropApi
 import platform.Foundation.NSBundle
 import platform.Foundation.NSLocale
@@ -39,14 +40,18 @@ internal fun pluralizedString(
     resourceId: String,
     number: Int
 ): String {
+    val fallbackLocale = bundle.developmentLocalization ?: BASE_LOCALIZATION
     val localized = bundle
         .localizedStringForKey(resourceId, null, null)
         .takeUnless { it == resourceId }
         ?: baseBundle.localizedStringForKey(resourceId, null, null)
+            .takeUnless { it == resourceId } ?: StringDesc.LocaleType.Custom(fallbackLocale)
+            .getLocaleBundle(bundle).localizedStringForKey(resourceId, null, null)
     @Suppress("CAST_NEVER_SUCCEEDS")
     return NSString.create(
         format = localized,
         locale = locale,
         args = arrayOf(number)
     ) as String
 }
+

resources/src/appleMain/kotlin/dev/icerock/moko/resources/desc/Utils.kt

@@ -9,16 +9,43 @@ import platform.Foundation.NSString
 import platform.Foundation.stringWithFormat
 
 object Utils {
+    const val BASE_LOCALIZATION: String = "Base"
+
     fun processArgs(args: List<Any>): Array<out Any> {
         return args.map { (it as? StringDesc)?.localized() ?: it }.toTypedArray()
     }
 
     fun localizedString(stringRes: StringResource): String {
         val bundle = StringDesc.localeType.getLocaleBundle(stringRes.bundle)
-        val string = bundle.localizedStringForKey(stringRes.resourceId, null, null)
-        return if (string == stringRes.resourceId) {
-            stringRes.bundle.localizedStringForKey(stringRes.resourceId, null, null)
-        } else string
+        val stringInCurrentLocale = bundle.localizedStringForKey(
+            key = stringRes.resourceId,
+            value = null,
+            table = null
+        )
+
+        return if (stringInCurrentLocale == stringRes.resourceId) {
+            val stringInDefaultBundle = stringRes.bundle.localizedStringForKey(
+                key = stringRes.resourceId,
+                value = null,
+                table = null
+            )
+
+            if (stringInDefaultBundle == stringRes.resourceId) {
+                val fallbackLocale = stringRes.bundle.developmentLocalization ?: BASE_LOCALIZATION
+                val fallbackLocaleBundle = StringDesc.LocaleType
+                    .Custom(fallbackLocale)
+                    .getLocaleBundle(stringRes.bundle)
+                fallbackLocaleBundle.localizedStringForKey(
+                    key = stringRes.resourceId,
+                    value = null,
+                    table = null
+                )
+            } else {
+                stringInDefaultBundle
+            }
+        } else {
+            stringInCurrentLocale
+        }
     }
 
     fun stringWithFormat(format: String, args: Array<out Any>): String {

resources/src/iosTest/kotlin/dev/icerock/moko/resources/desc/AppleLocalizationBundleTests.kt

@@ -0,0 +1,47 @@
+/*
+ * Copyright 2024 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package dev.icerock.moko.resources.desc
+
+import dev.icerock.moko.resources.StringResource
+import platform.Foundation.NSBundle
+import kotlin.test.Test
+import kotlin.test.assertEquals
+
+class AppleLocalizationBundleTests {
+
+    @Test
+    fun localizedStringWithLocalizationCaseTest() {
+        val resource = StringResource(
+            resourceId = "noResultsFound",
+            bundle = NSBundle.bundleWithPath(NSBundle.mainBundle.bundlePath + "/tests.bundle")!!
+        )
+        StringDesc.localeType = StringDesc.LocaleType.Custom("es-US")
+        val stringDesc = ResourceStringDesc(
+            resource
+        )
+        assertEquals(
+            expected = "No se han encontrado resultados",
+            actual = stringDesc.localized()
+        )
+        StringDesc.localeType = StringDesc.LocaleType.System
+    }
+
+    @Test
+    fun localizedStringMissingLocalizationCaseTest() {
+        val resource = StringResource(
+            resourceId = "noInternetConnection",
+            bundle = NSBundle.bundleWithPath(NSBundle.mainBundle.bundlePath + "/tests.bundle")!!
+        )
+        StringDesc.localeType = StringDesc.LocaleType.Custom("es-US")
+        val stringDesc = ResourceStringDesc(
+            resource
+        )
+        assertEquals(
+            expected = "No internet connection",
+            actual = stringDesc.localized()
+        )
+        StringDesc.localeType = StringDesc.LocaleType.System
+    }
+}

resources/src/iosTest/kotlin/dev/icerock/moko/resources/desc/PluralFormattedStringDescStringTests.kt

@@ -50,6 +50,16 @@ class PluralFormattedStringDescStringTests {
         )
     }
 
+    @Test
+    fun testMissingLocalizationCase() {
+        StringDesc.localeType = StringDesc.LocaleType.Custom("es-US")
+        assertEquals(
+            expected = "6/10 items",
+            actual = createPluralFormatted(6).localized()
+        )
+        StringDesc.localeType = StringDesc.LocaleType.System
+    }
+
     private fun createPluralFormatted(number: Int): PluralFormattedStringDesc {
         val pluralResource = PluralsResource(
             resourceId = "stringFormatted",

resources/src/iosTest/resources/tests.bundle/Contents/Resources/Base.lproj/Localizable.strings

@@ -0,0 +1,2 @@
+"noResultsFound" = "No results found";
+"noInternetConnection" = "No internet connection";

resources/src/iosTest/resources/tests.bundle/Contents/Resources/es-US.lproj/Localizable.strings

@@ -0,0 +1 @@
+"noResultsFound" = "No se han encontrado resultados";

samples/resources-gallery/mpp-library/src/commonMain/kotlin/com/icerockdev/library/Testing.kt

@@ -28,6 +28,7 @@ import dev.icerock.moko.resources.getImageByFileName
 public object Testing {
     public fun getStrings(): List<StringDesc> {
         return listOf(
+            MR.strings.text_only_in_base.desc(),
             MR.strings.test_simple.desc(),
             MR.strings.test2.desc(),
             MR.strings.test3.desc(),

samples/resources-gallery/mpp-library/src/commonMain/moko-resources/base/strings.xml

@@ -7,4 +7,5 @@
     <string name="multilined">first line\nsecond line\nthird line.</string>
     <string name="quotes">Alex009 said "hello world" &amp; "write tests".</string>
     <string name="single_quotes">Alex009 said 'hello'</string>
+    <string name="text_only_in_base">Text from base locale</string>
 </resources>