Fix Indonesian, Hebrew and Yiddish languages (#57)

Author: adriangl

.gitignore

@@ -13,6 +13,7 @@
 .idea/**/dictionaries
 .idea/**/shelf
 .idea/**/runConfigurations.xml
+.idea/kotlinc.xml
 
 # Generated files
 .idea/**/contentModel.xml

CHANGELOG.md

@@ -31,6 +31,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - No removed features!
 ### Fixed
 - Fix Chinese variants support
+- Fix Indonesian, Hebrew and Yiddish support
 ### Security
 - No security issues fixed!
 

src/main/kotlin/com/hyperdevs/poeditor/gradle/utils/LocaleUtils.kt

@@ -24,22 +24,27 @@ package com.hyperdevs.poeditor.gradle.utils
  * @return proper values file modifier (i.e. es-rMX)
  */
 fun createValuesModifierFromLangCode(langCode: String): String {
-    return if (!langCode.contains("-")) {
-        langCode
-    } else {
-        val langParts = langCode.split("-")
-        val language = langParts[0]
-        val region = langParts[1].toLowerCase()
+    val langParts = langCode.split("-")
+    val language = langParts[0]
+    val region = langParts.getOrNull(1)?.toLowerCase()
 
-        return when (language) {
-            "zh" -> {
-                // Chinese support
-                handleChineseVariants(language, region)
+    return when (language) {
+        "zh" -> {
+            // Chinese support
+            handleChineseVariants(language, region).apply {
+                logger.lifecycle("INFO: Converted $langCode to $this")
             }
-            else -> {
-                "$language-r${region.toUpperCase()}"
+        }
+
+        "he", "yi", "id" -> {
+            handleOldLocaleVariants(language, region).apply {
+                logger.lifecycle("INFO: Converted $langCode to $this")
             }
         }
+
+        else -> {
+            "$language${region?.let { "-r${it.toUpperCase()}" } ?: ""}"
+        }
     }
 }
 
@@ -60,14 +65,48 @@ fun createValuesModifierFromLangCode(langCode: String): String {
  * - Chinese (traditional) will be set as values-b+zh+Hant.
  * - Regional Chinese variants will be set as values-zh-r<REGION>
  */
-private fun handleChineseVariants(language: String, region: String) = when (region) {
+private fun handleChineseVariants(language: String, region: String?) = when (region) {
     "cn" -> {
         language
     }
+
     "hans", "hant" -> {
-        "b+$language+${region.toLowerCase().capitalize()}"
+        "b+$language${region.let { "+${it.toLowerCase().capitalize()}" }}"
     }
+
     else -> {
-        "$language-r${region.toUpperCase()}"
+        "$language${region?.let { "-r${it.toUpperCase()}" } ?: ""}"
+    }
+}
+
+/**
+ * Handle locales that need translation to ISO-639 old locales, so Android devices can pick them up properly.
+ *
+ * According to [java.util.Locale] constructor docs in Android documentation:
+ * ISO 639 is not a stable standard; some of the language codes it defines (specifically "iw", "ji", and "in")
+ * have changed. This constructor accepts both the old codes ("iw", "ji", and "in") and the new codes
+ * ("he", "yi", and "id"), but all other API on Locale will return only the OLD codes.
+ *
+ * We keep this in mind to convert new locale codes received from PoEditor to the old codes handled by Android.
+ *
+ * NOTE: this will most likely change if Android ever supports Java 17, where new codes are used for locales. There may
+ * be a way to user the "-Djava.locale.useOldISOCodes=true" system property, though.
+ *
+ * References:
+ * - Locale documentation: https://developer.android.com/reference/java/util/Locale.html#Locale(java.lang.String)
+ * - List of supported languages up to Android 5.1: https://stackoverflow.com/a/7989085/9288365
+ * - List of supported languages from Android 7 to Android 9: https://stackoverflow.com/a/52329560/9288365
+ * - Android Issue Tracker issue regarding Indonesian locale: https://issuetracker.google.com/issues/36911507
+ * - Android Issue Tracker issue regarding Hebrew locale: https://issuetracker.google.com/issues/36908826
+ * - Java 17 locale changes: https://bugs.openjdk.org/browse/JDK-8267069
+ */
+private fun handleOldLocaleVariants(language: String, region: String?): String {
+    val oldLanguageCode = when (language) {
+        "he" -> "iw"
+        "yi" -> "ji"
+        "id" -> "in"
+        else -> language
     }
+
+    return "$oldLanguageCode${region?.let { "-r${it.toUpperCase()}" } ?: ""}"
 }

src/test/kotlin/com/hyperdevs/poeditor/gradle/utils/LocaleUtilsTest.kt

@@ -18,17 +18,35 @@
 
 package com.hyperdevs.poeditor.gradle.utils
 
-import org.junit.Assert
+import org.junit.Assert.assertEquals
 import org.junit.Test
 
 class LocaleUtilsTest {
     @Test
     fun `Creating values modifier from standard lang code works`() {
-        Assert.assertEquals("es", createValuesModifierFromLangCode("es"))
+        assertEquals("es", createValuesModifierFromLangCode("es"))
     }
 
     @Test
     fun `Creating values modifier from specialized lang code works`() {
-        Assert.assertEquals("es-rMX", createValuesModifierFromLangCode("es-mx"))
+        assertEquals("es-rMX", createValuesModifierFromLangCode("es-mx"))
+    }
+
+    @Test
+    fun `Creating values modifier from Chinese lang codes work`() {
+        assertEquals("zh", createValuesModifierFromLangCode("zh-CN"))
+        assertEquals("zh-rHK", createValuesModifierFromLangCode("zh-hk"))
+        assertEquals("zh-rMO", createValuesModifierFromLangCode("zh-mo"))
+        assertEquals("zh-rSG", createValuesModifierFromLangCode("zh-sg"))
+        assertEquals("b+zh+Hans", createValuesModifierFromLangCode("zh-Hans"))
+        assertEquals("b+zh+Hant", createValuesModifierFromLangCode("zh-Hant"))
+    }
+
+    @Test
+    fun `Creating values modifier from old lang codes works`() {
+        assertEquals("in", createValuesModifierFromLangCode("id"))
+        assertEquals("iw", createValuesModifierFromLangCode("he"))
+        assertEquals("iw-rIL", createValuesModifierFromLangCode("he-IL"))
+        assertEquals("ji", createValuesModifierFromLangCode("yi"))
     }
 }