refactor locale handling to use AppCompatDelegate for application locales

Author: 314systems

app/src/main/kotlin/com/vrem/util/LocaleUtils.kt

@@ -29,9 +29,18 @@ private val countriesLocales: SortedMap<String, Locale> =
         .toSortedMap()
 
 val BULGARIAN: Locale = Locale.forLanguageTag("bg")
+
+val CHINESE_SIMPLIFIED: Locale = Locale.forLanguageTag("zh-Hans")
+
+val CHINESE_TRADITIONAL: Locale = Locale.forLanguageTag("zh-Hant")
 val DUTCH: Locale = Locale.forLanguageTag("nl")
+val ENGLISH: Locale = Locale.forLanguageTag("en")
+val FRENCH: Locale = Locale.forLanguageTag("fr")
+val GERMAN: Locale = Locale.forLanguageTag("de")
 val GREEK: Locale = Locale.forLanguageTag("el")
 val HUNGARIAN: Locale = Locale.forLanguageTag("hu")
+val ITALIAN: Locale = Locale.forLanguageTag("it")
+val JAPANESE: Locale = Locale.forLanguageTag("ja")
 val POLISH: Locale = Locale.forLanguageTag("pl")
 val PORTUGUESE_PORTUGAL: Locale = Locale.forLanguageTag("pt-PT")
 val PORTUGUESE_BRAZIL: Locale = Locale.forLanguageTag("pt-BR")
@@ -46,13 +55,13 @@ val baseSupportedLocales: List<Locale> =
         DUTCH,
         GREEK,
         HUNGARIAN,
-        Locale.SIMPLIFIED_CHINESE,
-        Locale.TRADITIONAL_CHINESE,
-        Locale.ENGLISH,
-        Locale.FRENCH,
-        Locale.GERMAN,
-        Locale.ITALIAN,
-        Locale.JAPANESE,
+        CHINESE_SIMPLIFIED,
+        CHINESE_TRADITIONAL,
+        ENGLISH,
+        FRENCH,
+        GERMAN,
+        ITALIAN,
+        JAPANESE,
         POLISH,
         PORTUGUESE_BRAZIL,
         PORTUGUESE_PORTUGAL,
@@ -76,14 +85,22 @@ fun supportedLanguageTags(): List<String> =
 
 fun findByLanguageTag(languageTag: String): Locale {
     if (languageTag.isEmpty()) return currentLocale
-    val locale = Locale.forLanguageTag(languageTag)
-    return baseSupportedLocales.firstOrNull {
-        it.language == locale.language && it.country == locale.country
-    } ?: currentLocale
+
+    val target = Locale.forLanguageTag(languageTag)
+    if (target.language.isEmpty()) return currentLocale
+
+    return baseSupportedLocales.find { it == target }
+        ?: baseSupportedLocales.find { it.language == target.language && it.script == target.script }
+        ?: baseSupportedLocales.find { it.language == target.language && it.country == target.country }
+        ?: baseSupportedLocales.find { it.language == target.language }
+        ?: currentLocale
 }
 
 fun currentCountryCode(): String = currentLocale.country
 
 fun currentLanguageTag(): String = currentLocale.toLanguageTag()
 
 fun toLanguageTag(locale: Locale): String = locale.toLanguageTag()
+
+fun Locale.toSupportedLocaleTag(): String =
+    findByLanguageTag(this.toLanguageTag()).toLanguageTag()

app/src/main/kotlin/com/vrem/wifianalyzer/MainActivity.kt

@@ -17,7 +17,6 @@
  */
 package com.vrem.wifianalyzer
 
-import android.content.Context
 import android.content.SharedPreferences
 import android.content.SharedPreferences.OnSharedPreferenceChangeListener
 import android.content.res.Configuration
@@ -26,18 +25,17 @@ import android.view.Menu
 import android.view.MenuItem
 import android.view.View
 import androidx.appcompat.app.AppCompatActivity
+import androidx.appcompat.app.AppCompatDelegate
+import androidx.core.os.LocaleListCompat
 import androidx.core.splashscreen.SplashScreen.Companion.installSplashScreen
 import androidx.core.view.GravityCompat
 import androidx.drawerlayout.widget.DrawerLayout
 import com.google.android.material.navigation.NavigationView
 import com.vrem.annotation.OpenClass
-import com.vrem.util.createContext
 import com.vrem.wifianalyzer.navigation.NavigationMenu
 import com.vrem.wifianalyzer.navigation.NavigationMenuControl
 import com.vrem.wifianalyzer.navigation.NavigationMenuController
 import com.vrem.wifianalyzer.navigation.options.OptionMenu
-import com.vrem.wifianalyzer.settings.Repository
-import com.vrem.wifianalyzer.settings.Settings
 import com.vrem.wifianalyzer.wifi.accesspoint.ConnectionView
 import com.vrem.wifianalyzer.wifi.scanner.ScannerService
 
@@ -52,15 +50,13 @@ class MainActivity :
     internal lateinit var optionMenu: OptionMenu
     internal lateinit var connectionView: ConnectionView
 
-    override fun attachBaseContext(newBase: Context) =
-        super.attachBaseContext(newBase.createContext(Settings(Repository(newBase)).languageLocale()))
-
     override fun onCreate(savedInstanceState: Bundle?) {
         val mainContext = MainContext.INSTANCE
         mainContext.initialize(this, largeScreen)
 
         val settings = mainContext.settings
         settings.initializeDefaultValues()
+        settings.syncLanguage()
         setTheme(settings.themeStyle().themeNoActionBar)
 
         mainReload = MainReload(settings)
@@ -120,6 +116,17 @@ class MainActivity :
         sharedPreferences: SharedPreferences,
         key: String?,
     ) {
+        val languageKey = getString(R.string.language_key)
+        if (key == languageKey) {
+            val languageTag = sharedPreferences.getString(languageKey, "")
+            val locales = languageTag
+                ?.takeIf { it.isNotEmpty() }
+                ?.let(LocaleListCompat::forLanguageTags)
+                ?: LocaleListCompat.getEmptyLocaleList()
+
+            AppCompatDelegate.setApplicationLocales(locales)
+        }
+
         val mainContext = MainContext.INSTANCE
         if (mainReload.shouldReload(mainContext.settings)) {
             MainContext.INSTANCE.scannerService.stop()

app/src/main/kotlin/com/vrem/wifianalyzer/MainReload.kt

@@ -20,7 +20,6 @@ package com.vrem.wifianalyzer
 import com.vrem.wifianalyzer.settings.Settings
 import com.vrem.wifianalyzer.settings.ThemeStyle
 import com.vrem.wifianalyzer.wifi.accesspoint.ConnectionViewType
-import java.util.Locale
 
 class MainReload(
     settings: Settings,
@@ -29,11 +28,9 @@ class MainReload(
         private set
     var connectionViewType: ConnectionViewType
         private set
-    var languageLocale: Locale
-        private set
 
     fun shouldReload(settings: Settings): Boolean =
-        themeChanged(settings) || connectionViewTypeChanged(settings) || languageChanged(settings)
+        themeChanged(settings) || connectionViewTypeChanged(settings)
 
     private fun connectionViewTypeChanged(settings: Settings): Boolean {
         val currentConnectionViewType = settings.connectionViewType()
@@ -53,18 +50,8 @@ class MainReload(
         return themeChanged
     }
 
-    private fun languageChanged(settings: Settings): Boolean {
-        val settingLanguageLocale = settings.languageLocale()
-        val languageLocaleChanged = languageLocale != settingLanguageLocale
-        if (languageLocaleChanged) {
-            languageLocale = settingLanguageLocale
-        }
-        return languageLocaleChanged
-    }
-
     init {
         themeStyle = settings.themeStyle()
         connectionViewType = settings.connectionViewType()
-        languageLocale = settings.languageLocale()
     }
 }

app/src/main/kotlin/com/vrem/wifianalyzer/settings/CountryPreference.kt

@@ -25,7 +25,7 @@ import com.vrem.wifianalyzer.wifi.band.WiFiChannelCountry
 import java.util.Locale
 
 private fun data(): List<Data> {
-    val currentLocale: Locale = MainContext.INSTANCE.settings.languageLocale()
+    val currentLocale: Locale = MainContext.INSTANCE.settings.appLocale()
     return WiFiChannelCountry
         .findAll()
         .map { Data(it.countryCode, it.countryName(currentLocale)) }

app/src/main/kotlin/com/vrem/wifianalyzer/settings/Settings.kt

@@ -18,14 +18,15 @@
 package com.vrem.wifianalyzer.settings
 
 import android.content.SharedPreferences.OnSharedPreferenceChangeListener
+import androidx.appcompat.app.AppCompatDelegate
 import com.vrem.annotation.OpenClass
 import com.vrem.util.buildMinVersionQ
 import com.vrem.util.currentCountryCode
-import com.vrem.util.currentLanguageTag
 import com.vrem.util.findByLanguageTag
 import com.vrem.util.findOne
 import com.vrem.util.findSet
 import com.vrem.util.ordinals
+import com.vrem.util.toSupportedLocaleTag
 import com.vrem.wifianalyzer.R
 import com.vrem.wifianalyzer.navigation.MAIN_NAVIGATION
 import com.vrem.wifianalyzer.navigation.NavigationMenu
@@ -69,10 +70,14 @@ class Settings(
 
     fun countryCode(): String = repository.string(R.string.country_code_key, currentCountryCode())
 
-    fun languageLocale(): Locale {
-        val currentLanguageTag = currentLanguageTag()
-        val languageTag = repository.string(R.string.language_key, currentLanguageTag)
-        return findByLanguageTag(languageTag)
+    fun appLocale(): Locale =
+        findByLanguageTag(AppCompatDelegate.getApplicationLocales().toLanguageTags())
+
+    fun syncLanguage() {
+        val appLocaleTag = appLocale().toSupportedLocaleTag()
+        if (appLocaleTag != repository.string(R.string.language_key, "")) {
+            repository.save(R.string.language_key, appLocaleTag)
+        }
     }
 
     fun sortBy(): SortBy = settingsFind(SortBy.entries, R.string.sort_by_key, SortBy.STRENGTH)

app/src/main/kotlin/com/vrem/wifianalyzer/wifi/channelavailable/ChannelAvailableFragment.kt

@@ -44,7 +44,7 @@ class ChannelAvailableFragment : Fragment() {
     private fun update() {
         val settings = MainContext.INSTANCE.settings
         val countryCode = settings.countryCode()
-        val languageLocale = settings.languageLocale()
+        val languageLocale = settings.appLocale()
         binding.apply {
             val textViews =
                 listOf(

app/src/test/kotlin/com/vrem/util/LocaleUtilsTest.kt

@@ -97,13 +97,13 @@ class LocaleUtilsTest {
                 DUTCH,
                 GREEK,
                 HUNGARIAN,
-                Locale.SIMPLIFIED_CHINESE,
-                Locale.TRADITIONAL_CHINESE,
-                Locale.ENGLISH,
-                Locale.FRENCH,
-                Locale.GERMAN,
-                Locale.ITALIAN,
-                Locale.JAPANESE,
+                CHINESE_SIMPLIFIED,
+                CHINESE_TRADITIONAL,
+                ENGLISH,
+                FRENCH,
+                GERMAN,
+                ITALIAN,
+                JAPANESE,
                 POLISH,
                 PORTUGUESE_BRAZIL,
                 PORTUGUESE_PORTUGAL,

app/src/test/kotlin/com/vrem/wifianalyzer/MainReloadTest.kt

@@ -27,7 +27,6 @@ import org.mockito.kotlin.atLeastOnce
 import org.mockito.kotlin.verify
 import org.mockito.kotlin.verifyNoMoreInteractions
 import org.mockito.kotlin.whenever
-import java.util.Locale
 
 class MainReloadTest {
     private val settings = MainContextHelper.INSTANCE.settings
@@ -37,15 +36,13 @@ class MainReloadTest {
     fun setUp() {
         whenever(settings.themeStyle()).thenReturn(ThemeStyle.DARK)
         whenever(settings.connectionViewType()).thenReturn(ConnectionViewType.COMPLETE)
-        whenever(settings.languageLocale()).thenReturn(Locale.UK)
         fixture = MainReload(settings)
     }
 
     @After
     fun tearDown() {
         verify(settings, atLeastOnce()).themeStyle()
         verify(settings, atLeastOnce()).connectionViewType()
-        verify(settings, atLeastOnce()).languageLocale()
         verifyNoMoreInteractions(settings)
         MainContextHelper.INSTANCE.restore()
     }
@@ -91,25 +88,4 @@ class MainReloadTest {
         assertThat(actual).isTrue
         assertThat(fixture.connectionViewType).isEqualTo(expected)
     }
-
-    @Test
-    fun shouldNotReloadWithNoLanguageLocaleChanges() {
-        // execute
-        val actual = fixture.shouldReload(settings)
-        // validate
-        assertThat(actual).isFalse
-        assertThat(fixture.languageLocale).isEqualTo(Locale.UK)
-    }
-
-    @Test
-    fun shouldReloadWithLanguageLocaleChange() {
-        // setup
-        val expected = Locale.US
-        whenever(settings.languageLocale()).thenReturn(expected)
-        // execute
-        val actual = fixture.shouldReload(settings)
-        // validate
-        assertThat(actual).isTrue
-        assertThat(fixture.languageLocale).isEqualTo(expected)
-    }
 }

app/src/test/kotlin/com/vrem/wifianalyzer/settings/SettingsTest.kt

@@ -370,7 +370,7 @@ class SettingsTest {
         val expected = Locale.FRENCH
         doReturn(toLanguageTag(expected)).whenever(repository).string(R.string.language_key, defaultValue)
         // execute
-        val actual = fixture.languageLocale()
+        val actual = fixture.appLocale()
         // validate
         assertThat(actual).isEqualTo(expected)
         verify(repository).string(R.string.language_key, defaultValue)

app/src/test/kotlin/com/vrem/wifianalyzer/wifi/channelavailable/ChannelAvailableFragmentTest.kt

@@ -62,13 +62,13 @@ class ChannelAvailableFragmentTest {
     @Before
     fun setUp() {
         whenever(settings.countryCode()).thenReturn(locale.country)
-        whenever(settings.languageLocale()).thenReturn(Locale.US)
+        whenever(settings.appLocale()).thenReturn(Locale.US)
     }
 
     @After
     fun tearDown() {
         verify(settings, atLeastOnce()).countryCode()
-        verify(settings, atLeastOnce()).languageLocale()
+        verify(settings, atLeastOnce()).appLocale()
         INSTANCE.restore()
     }