feat: plurals support Sprintf format + plurals params fixes

Author: Anty0

compose/src/androidMain/kotlin/io/tolgee/ComposeTolgee.android.kt

@@ -103,16 +103,16 @@ fun pluralStringResource(tolgee: Tolgee, @PluralsRes id: Int, quantity: Int): St
     val translationFlow = (tolgee as? TolgeeAndroid)?.tPluralFlow(context.resources, id, quantity)
         ?: (key ?: TolgeeAndroid.getKeyFromResources(context, id))?.let {
             tolgee.tFlow(key = it, parameters = TolgeeMessageParams.Indexed(quantity))
-        } ?: flowOf(androidx.compose.ui.res.pluralStringResource(id, quantity))
+        } ?: flowOf(androidx.compose.ui.res.pluralStringResource(id, quantity, quantity))
 
     return translationFlow.collectAsState(
-        initial = androidx.compose.ui.res.pluralStringResource(id, quantity)
+        initial = androidx.compose.ui.res.pluralStringResource(id, quantity, quantity)
     ).value
 }
 
 @Composable
 fun pluralStringResource(@PluralsRes id: Int, quantity: Int): String {
-    val instance = Tolgee.instanceOrNull ?: return androidx.compose.ui.res.pluralStringResource(id, quantity)
+    val instance = Tolgee.instanceOrNull ?: return androidx.compose.ui.res.pluralStringResource(id, quantity, quantity)
 
     return pluralStringResource(instance, id, quantity)
 }
@@ -127,16 +127,16 @@ fun pluralStringResource(tolgee: Tolgee, @PluralsRes id: Int, quantity: Int, var
     val translationFlow = (tolgee as? TolgeeAndroid)?.tPluralFlow(context.resources, id, quantity, *formatArgs)
         ?: (key ?: TolgeeAndroid.getKeyFromResources(context, id))?.let {
             tolgee.tFlow(key = it, parameters = TolgeeMessageParams.Indexed(quantity, *formatArgs))
-        } ?: flowOf(androidx.compose.ui.res.pluralStringResource(id, quantity, *formatArgs))
+        } ?: flowOf(androidx.compose.ui.res.pluralStringResource(id, quantity, quantity, *formatArgs))
 
     return translationFlow.collectAsState(
-        initial = androidx.compose.ui.res.pluralStringResource(id, quantity, *formatArgs)
+        initial = androidx.compose.ui.res.pluralStringResource(id, quantity, quantity, *formatArgs)
     ).value
 }
 
 @Composable
 fun pluralStringResource(@PluralsRes id: Int, quantity: Int, vararg formatArgs: Any): String {
-    val instance = Tolgee.instanceOrNull ?: return androidx.compose.ui.res.pluralStringResource(id, quantity, *formatArgs)
+    val instance = Tolgee.instanceOrNull ?: return androidx.compose.ui.res.pluralStringResource(id, quantity, quantity, *formatArgs)
 
     return pluralStringResource(instance, id, quantity, *formatArgs)
 }

compose/src/commonMain/kotlin/io/tolgee/ComposeTolgee.kt

@@ -96,13 +96,13 @@ fun pluralStringResource(tolgee: Tolgee, resource: PluralStringResource, quantit
         key = resource.key,
         parameters = TolgeeMessageParams.Indexed(quantity, *formatArgs)
     ).collectAsState(
-        initial = org.jetbrains.compose.resources.pluralStringResource(resource, quantity, *formatArgs)
+        initial = org.jetbrains.compose.resources.pluralStringResource(resource, quantity, quantity, *formatArgs)
     ).value
 }
 
 @Composable
 fun pluralStringResource(resource: PluralStringResource, quantity: Int, vararg formatArgs: Any): String {
-    val tolgee = Tolgee.instanceOrNull ?: return org.jetbrains.compose.resources.pluralStringResource(resource, quantity, *formatArgs)
+    val tolgee = Tolgee.instanceOrNull ?: return org.jetbrains.compose.resources.pluralStringResource(resource, quantity, quantity, *formatArgs)
     return pluralStringResource(tolgee, resource, quantity, *formatArgs)
 }
 

core/src/androidMain/kotlin/io/tolgee/TolgeeAndroid.kt

@@ -124,13 +124,13 @@ data class TolgeeAndroid internal constructor(
     fun tPlural(resources: Resources, @PluralsRes id: Int, quantity: Int): String {
         return getKeyFromResources(resources, id)?.let { key ->
             t(key, TolgeeMessageParams.Indexed(quantity))
-        } ?: resources.getQuantityString(id, quantity)
+        } ?: resources.getQuantityString(id, quantity, quantity)
     }
 
     fun tPlural(resources: Resources, @PluralsRes id: Int, quantity: Int, vararg formatArgs: Any): String {
         return getKeyFromResources(resources, id)?.let { key ->
             t(key, TolgeeMessageParams.Indexed(quantity, *formatArgs))
-        } ?: resources.getQuantityString(id, quantity, *formatArgs)
+        } ?: resources.getQuantityString(id, quantity, quantity, *formatArgs)
     }
 
     fun tArray(resources: Resources, @ArrayRes id: Int): List<String> {

core/src/commonMain/kotlin/io/tolgee/Tolgee.kt

@@ -512,7 +512,7 @@ open class Tolgee(
             val url: String? = null,
             val path: (language: String) -> String = { "$it.json" },
             val storage: TolgeeStorageProvider? = platformStorage,
-            val formatter: Formatter = Formatter.ICU,
+            val formatter: Formatter = Formatter.Sprintf,
         ) {
             /**
              * A builder class for constructing instances of `CDN` with configurable properties.
@@ -566,7 +566,7 @@ open class Tolgee(
                  * Typically used within the `CDN.Builder` class to configure translation formatting behavior
                  * for the resulting `CDN` instance.
                  */
-                var formatter: Formatter = Formatter.ICU
+                var formatter: Formatter = Formatter.Sprintf
 
                 /**
                  * Sets the URL for the CDN configuration.

core/src/commonMain/kotlin/io/tolgee/common/ExtendParser.kt

@@ -21,6 +21,7 @@ internal fun JsonElement.stringValue(): String = when (this) {
 
 internal fun JsonElement.keyData(): TolgeeKey.Data = when (this) {
     is JsonArray -> TolgeeKey.Data.Array(map { it.stringValue() })
+    is JsonObject -> TolgeeKey.Data.Plural(mapValues { it.value.stringValue() })
     else -> TolgeeKey.Data.Text(stringValue())
 }
 

core/src/commonMain/kotlin/io/tolgee/model/TolgeeKey.kt

@@ -21,6 +21,8 @@ internal data class TolgeeKey(
 ) {
 
     val isText = translations.values.all { it is Data.Text }
+    val isPlural = translations.values.any { it is Data.Plural }
+    val isArray = translations.values.any { it is Data.Array }
 
     /**
      * Retrieves a translation for a given language code or the first available non-null translation.
@@ -38,6 +40,9 @@ internal data class TolgeeKey(
         @Serializable
         data class Text(val text: String) : Data
 
+        @Serializable
+        data class Plural(val plurals: Map<String, String>) : Data
+
         @Serializable
         data class Array(val array: List<String>) : Data
     }

core/src/commonMain/kotlin/io/tolgee/model/translation/TranslationICU.kt

@@ -47,7 +47,7 @@ internal data class TranslationICU(
     }.groupBy({ it.first }, { it.second })
 
     @Transient
-    private val stringArrayKeys = keys.filter { !it.isText }
+    private val stringArrayKeys = keys.filter { it.isArray }
 
     /**
      * A collection of message providers grouped by locale. Each provider implements the [MessagesProvider] interface.

core/src/commonMain/kotlin/io/tolgee/model/translation/TranslationSprintf.kt

@@ -1,6 +1,10 @@
 package io.tolgee.model.translation
 
 import de.comahe.i18n4k.Locale
+import de.comahe.i18n4k.cldr.plurals.PluralCategory
+import de.comahe.i18n4k.cldr.plurals.PluralRule
+import de.comahe.i18n4k.cldr.plurals.PluralRuleType
+import de.comahe.i18n4k.createLocale
 import de.comahe.i18n4k.language
 import io.tolgee.common.sprintf
 import io.tolgee.model.TolgeeKey
@@ -24,7 +28,7 @@ internal data class TranslationSprintf(
     private var usedLocale: Locale?,
 ) : TolgeeTranslation {
 
-    private val stringArrayKeys = keys.filter { !it.isText }
+    private val stringArrayKeys = keys.filter { it.isArray }
 
     /**
      * Retrieves a localized string for the specified key and formatting parameters, considering a given locale.
@@ -52,10 +56,29 @@ internal data class TranslationSprintf(
                 ?: this.usedLocale?.language?.ifBlank { null }
         )) {
             is TolgeeKey.Data.Text -> return data.text.sprintf(*args)
+            is TolgeeKey.Data.Plural -> {
+                val selected = data.plurals[getPluralName(args.getOrNull(0))]
+                return selected?.sprintf(*args)
+            }
             else -> null
         }
     }
 
+    fun getPluralName(number: Any?): String {
+        if (number == null) return PluralCategory.OTHER.id
+        val locale = usedLocale ?: return PluralCategory.OTHER.id
+
+        val pluralRule = PluralRule.create(createLocale(locale.language), PluralRuleType.CARDINAL)
+
+        val pluralCategory = when (number) {
+            is Number -> pluralRule?.select(number)
+            is String -> pluralRule?.select(number)
+            else -> PluralCategory.OTHER
+        } ?: PluralCategory.OTHER
+
+        return pluralCategory.id
+    }
+
     /**
      * Checks if the specified locale matches the currently used locale or has the same language as the used locale.
      *
@@ -70,6 +93,7 @@ internal data class TranslationSprintf(
         val foundTolgeeKey = stringArrayKeys.firstOrNull { it.keyName == key } ?: return emptyList()
         return when (val data = foundTolgeeKey.translationForOrFirst(locale?.language)) {
             is TolgeeKey.Data.Array -> data.array
+            is TolgeeKey.Data.Plural -> data.plurals.map { it.value }
             is TolgeeKey.Data.Text -> listOf(data.text)
             else -> emptyList()
         }

demo/exampleandroid/src/main/java/io/tolgee/demo/exampleandroid/MainActivity.kt

@@ -49,7 +49,7 @@ class MainActivity : ComponentActivity() {
     name.text = getString(R.string.app_name)
     basic.text = getString(R.string.description)
     parameter.text = getString(R.string.percentage_placeholder, "87")
-    plural.text = resources.getQuantityString(R.plurals.plr_test_placeholder_2,3, 2, 3, "Plurals")
+    plural.text = resources.getQuantityString(R.plurals.plr_test_placeholder_2,2, 3, "Plurals")
     array.text = resources.getStringArray(R.array.array_test).joinToString()
 
     buttonEn.setOnClickListener {

demo/exampleandroid/src/main/res/values-cs/strings.xml

@@ -15,15 +15,15 @@
     <item quantity="other">Množné Ostatní</item>
   </plurals>
   <plurals name="plr_test_placeholder">
-    <item quantity="one">%2$s: %d test ok</item>
-    <item quantity="few">%2$s: %d testy ok</item>
-    <item quantity="many">%2$s: %d testů ok</item>
-    <item quantity="other">%2$s: %d testů ok</item>
+    <item quantity="one">%2$s: %1$d test ok</item>
+    <item quantity="few">%2$s: %1$d testy ok</item>
+    <item quantity="many">%2$s: %1$d testů ok</item>
+    <item quantity="other">%2$s: %1$d testů ok</item>
   </plurals>
   <plurals name="plr_test_placeholder_2">
-    <item quantity="one">%3$s: %d test z %2$d ok</item>
-    <item quantity="few">%3$s: %d testy z %2$d ok</item>
-    <item quantity="many">%3$s: %d testů z %2$d ok</item>
-    <item quantity="other">%3$s: %d testů z %2$d ok</item>
+    <item quantity="one">%3$s: %1$d test z %2$d ok</item>
+    <item quantity="few">%3$s: %1$d testy z %2$d ok</item>
+    <item quantity="many">%3$s: %1$d testů z %2$d ok</item>
+    <item quantity="other">%3$s: %1$d testů z %2$d ok</item>
   </plurals>
 </resources>