Allow to find languages by the lang of their locale

Author: 64ArthurAraujo

src/main/kotlin/cc/wordview/gengolex/Language.kt

@@ -13,11 +13,18 @@ import java.util.Locale
 enum class Language(val tag: String, val dictionaryName: String, val tokenizer: Tokenizer, @Suppress("unused") val locale: Locale) {
     ENGLISH("en", "english", EnglishTokenizer, Locale.ENGLISH),
     JAPANESE("ja", "kanji", JapaneseTokenizer, Locale.JAPANESE),
-
     // for some reason the portuguese locale is there but not as an enum value
     PORTUGUESE("pt", "portuguese", PortugueseTokenizer, Locale.forLanguageTag("pt"));
 
     companion object {
+
+        /**
+         * Returns the [Language] corresponding to the given language tag.
+         *
+         * @param tag The language tag (e.g., `"en"`, `"ja"`, `"pt"`).
+         * @return The [Language] instance matching the tag.
+         * @throws LanguageNotFoundException if no language matches the given tag.
+         */
         @Throws(LanguageNotFoundException::class)
         fun byTag(tag: String): Language {
             for (lang in Language.entries) {
@@ -27,13 +34,43 @@ enum class Language(val tag: String, val dictionaryName: String, val tokenizer:
             throw LanguageNotFoundException("Unable to find a language for the tag: $tag")
         }
 
+        /**
+         * Returns the [Language] corresponding to the given [Locale].
+         *
+         * This matches by exact [Locale] instance.
+         *
+         * @param locale The [Locale] to match.
+         * @return The [Language] instance matching the locale.
+         * @throws LanguageNotFoundException if no language matches the given locale.
+         */
         @Throws(LanguageNotFoundException::class)
         fun byLocale(locale: Locale): Language {
             for (lang in Language.entries) {
                 if (lang.locale == locale) return lang
             }
 
-            throw LanguageNotFoundException("Unable to find a language for the locale: ${locale.displayLanguage}")
+            throw LanguageNotFoundException("Unable to find a language for the locale: ${locale.displayName}")
+        }
+
+        /**
+         * Returns the [Language] corresponding to the language code of the given [Locale].
+         *
+         * This matches only the language component the locale.
+         *
+         * @param locale The [Locale] whose language code will be matched.
+         * @return The [Language] instance matching the language code.
+         * @throws LanguageNotFoundException if no language matches the locale's language code.
+         */
+        @Throws(LanguageNotFoundException::class)
+        fun byLocaleLanguage(locale: Locale): Language {
+            val localeLanguage = locale.language
+
+            for (lang in Language.entries) {
+                if (lang.locale.language.equals(localeLanguage))
+                    return lang
+            }
+
+            throw LanguageNotFoundException("Unable to find a language for the locale: ${locale.displayName}")
         }
     }
 }

src/test/kotlin/LanguageTest.kt

@@ -74,4 +74,101 @@ class LanguageTest {
             Language.byLocale(Locale.GERMAN)
         }
     }
+
+    @Test
+    fun getEnglish_byLocaleLanguage() {
+        assertDoesNotThrow {
+            val lang = Language.byLocaleLanguage(Locale.ENGLISH)
+            assertEquals(Language.ENGLISH, lang)
+            assertEquals("english", lang.dictionaryName)
+        }
+    }
+
+    @Test
+    fun getJapanese_byLocaleLanguage() {
+        assertDoesNotThrow {
+            val lang = Language.byLocaleLanguage(Locale.JAPANESE)
+            assertEquals(Language.JAPANESE, lang)
+            assertEquals("kanji", lang.dictionaryName)
+        }
+    }
+
+    @Test
+    fun getPortuguese_byLocaleLanguage() {
+        assertDoesNotThrow {
+            val lang = Language.byLocaleLanguage(Locale.forLanguageTag("pt"))
+            assertEquals(Language.PORTUGUESE, lang)
+            assertEquals("portuguese", lang.dictionaryName)
+        }
+    }
+
+    @Test
+    fun getInexistent_byLocaleLanguage() {
+        assertThrows<LanguageNotFoundException> {
+            Language.byLocaleLanguage(Locale.forLanguageTag("fr-FR"))
+        }
+    }
+
+    @Test
+    fun getEnglish_byLocaleLanguage_GreatBritain() {
+        assertDoesNotThrow {
+            val lang = Language.byLocaleLanguage(Locale.forLanguageTag("en-GB"))
+            assertEquals(Language.ENGLISH, lang)
+            assertEquals("english", lang.dictionaryName)
+        }
+    }
+
+    @Test
+    fun getEnglish_byLocaleLanguage_UnitedStates() {
+        assertDoesNotThrow {
+            val lang = Language.byLocaleLanguage(Locale.forLanguageTag("en-US"))
+            assertEquals(Language.ENGLISH, lang)
+            assertEquals("english", lang.dictionaryName)
+        }
+    }
+
+    @Test
+    fun getEnglish_byLocaleLanguage_Australia() {
+        assertDoesNotThrow {
+            val lang = Language.byLocaleLanguage(Locale.forLanguageTag("en-AU"))
+            assertEquals(Language.ENGLISH, lang)
+            assertEquals("english", lang.dictionaryName)
+        }
+    }
+
+    @Test
+    fun getPortuguese_byLocaleLanguage_Portugal() {
+        assertDoesNotThrow {
+            val lang = Language.byLocaleLanguage(Locale.forLanguageTag("pt-PT"))
+            assertEquals(Language.PORTUGUESE, lang)
+            assertEquals("portuguese", lang.dictionaryName)
+        }
+    }
+
+    @Test
+    fun getPortuguese_byLocaleLanguage_Brazil() {
+        assertDoesNotThrow {
+            val lang = Language.byLocaleLanguage(Locale.forLanguageTag("pt-BR"))
+            assertEquals(Language.PORTUGUESE, lang)
+            assertEquals("portuguese", lang.dictionaryName)
+        }
+    }
+
+    @Test
+    fun getPortuguese_byLocaleLanguage_Angola() {
+        assertDoesNotThrow {
+            val lang = Language.byLocaleLanguage(Locale.forLanguageTag("pt-AO"))
+            assertEquals(Language.PORTUGUESE, lang)
+            assertEquals("portuguese", lang.dictionaryName)
+        }
+    }
+
+    @Test
+    fun getPortuguese_byLocaleLanguage_Mozambique() {
+        assertDoesNotThrow {
+            val lang = Language.byLocaleLanguage(Locale.forLanguageTag("pt-MZ"))
+            assertEquals(Language.PORTUGUESE, lang)
+            assertEquals("portuguese", lang.dictionaryName)
+        }
+    }
 }