Add compatibility with Android 13 Tiramisu.

Bojan · Bojan · commit 5adf22ae7046 · 2022-08-23T15:28:16.000+02:00
Expose new manifest metadata to follow system locale.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,13 @@
 Changelog
 =========
 
+## Version 1.0.8
+
+_2022-08-23_
+
+* Add compatibility with Android 13 Tiramisu.
+* Expose new manifest metadata to follow system locale.
+
 ## Version 1.0.7
 
 _2022-08-18_
diff --git a/README.md b/README.md
@@ -28,11 +28,11 @@ Then add the following dependencies in your app `build.gradle` or `build.gradle.
 
 **Groovy**
 ```groovy
-implementation "com.infinum.localian:localian:1.0.7"
+implementation "com.infinum.localian:localian:1.0.8"
 ```
 **KotlinDSL**
 ```kotlin
-implementation("com.infinum.localian:localian:1.0.7")
+implementation("com.infinum.localian:localian:1.0.8")
 ```
 
 ## Setup
@@ -116,7 +116,23 @@ In you module Android manifest file, add following meta data code in your _appli
             
 </application>
  ```
-Please pay attention to correct and exact value of meta data _name_ attribute and the fact that _value_ attribute must be a language tag string that conforms to the IETF BCP 47 standard, so no underscores, but hyphens. 
+Please pay attention to correct and exact value of meta data _name_ attribute and the fact that _value_ attribute must be a language tag string that conforms to the IETF BCP 47 standard, so no underscores, but hyphens.
+
+### Android 13 Tiramisu compatibility
+
+_Localian_ can be used to observe system Locale managed per application on Android 13.   
+In you module Android manifest file, add following meta data code in your _application_ XML node:
+ ``` xml
+<application
+    
+    ...
+    
+    <meta-data
+        android:name="com.infinum.localian.follow_system_locale"
+        android:value="true" />
+            
+</application>
+ ```
 
 ## App Bundles
 
diff --git a/config.gradle b/config.gradle
@@ -1,13 +1,13 @@
 ext {
     def major = 1
     def minor = 0
-    def patch = 7
+    def patch = 8
 
     buildConfig = [
             "minSdk"    : 21,
-            "compileSdk": 32,
-            "targetSdk" : 32,
-            "buildTools": "32.0.0"
+            "compileSdk": 33,
+            "targetSdk" : 33,
+            "buildTools": "33.0.0"
     ]
     releaseConfig = [
             "group"      : "com.infinum.localian",
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -1,5 +1,5 @@
 [versions]
-localian = "1.0.6"
+localian = "1.0.8"
 gradle = "7.2.2"
 kotlin = "1.7.10"
 appcompat = "1.4.2"
@@ -44,7 +44,6 @@ json = { module = "org.json:json", version.ref = "json" }
 [bundles]
 androidx = [
     "androidx-annotation",
-    "androidx-startup",
     "androidx-preference"
 ]
 testing = [
diff --git a/localian/build.gradle b/localian/build.gradle
@@ -64,6 +64,7 @@ android {
 dependencies {
     implementation libs.kotlin.core
     implementation libs.bundles.androidx
+    api libs.androidx.startup
 
     testImplementation libs.bundles.testing
 }
diff --git a/localian/src/main/kotlin/com/infinum/localian/Localian.kt b/localian/src/main/kotlin/com/infinum/localian/Localian.kt
@@ -36,11 +36,16 @@ public object Localian {
     public fun run(
         application: Application,
         locale: Locale = Locale.getDefault(),
-        cache: Cache = PreferenceCache(application, locale)
+        cache: Cache = PreferenceCache(application, locale),
+        followSystemLocale: Boolean = false
     ) {
         this.locale = locale
         this.cache = cache
 
+        if (followSystemLocale) {
+            followSystemLocale(application)
+        }
+
         application.registerActivityLifecycleCallbacks(
             ActivityCallbacks {
                 applyForActivity(it)
diff --git a/localian/src/main/kotlin/com/infinum/localian/extensions/Activity.kt b/localian/src/main/kotlin/com/infinum/localian/extensions/Activity.kt
@@ -3,11 +3,23 @@ package com.infinum.localian.extensions
 import android.app.Activity
 import android.content.pm.PackageManager
 import android.content.pm.PackageManager.GET_META_DATA
+import android.os.Build
 
 @Suppress("PrintStackTrace")
 internal fun Activity.resetTitle() =
     try {
-        val info = packageManager.getActivityInfo(componentName, GET_META_DATA)
+        @Suppress("DEPRECATION")
+        val info = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
+            packageManager.getActivityInfo(
+                componentName,
+                PackageManager.ComponentInfoFlags.of(GET_META_DATA.toLong())
+            )
+        } else {
+            packageManager.getActivityInfo(
+                componentName,
+                GET_META_DATA
+            )
+        }
         @Suppress("RedundantUnitExpression")
         when {
             info.labelRes != 0 -> setTitle(info.labelRes)
diff --git a/localian/src/main/kotlin/com/infinum/localian/extensions/Context.kt b/localian/src/main/kotlin/com/infinum/localian/extensions/Context.kt
@@ -1,17 +1,38 @@
 package com.infinum.localian.extensions
 
 import android.content.Context
+import android.content.pm.ApplicationInfo
+import android.content.pm.PackageManager
 import android.content.pm.PackageManager.GET_META_DATA
+import android.os.Build
 
 private const val KEY_INITIAL_LANGUAGE_TAG: String =
     "com.infinum.localian.initial_locale_language_tag"
 
-internal fun Context.languageTag(): String? =
-    packageManager
-        .getApplicationInfo(
-            packageName,
-            GET_META_DATA
-        )
-        .metaData
+private const val KEY_FOLLOW_SYSTEM_LOCALE: String =
+    "com.infinum.localian.follow_system_locale"
+
+internal fun Context.languageTagMetadata(): String? =
+    info.metaData
         .getString(KEY_INITIAL_LANGUAGE_TAG, null)
         ?.takeIf { it.isNotBlank() }
+
+internal fun Context.followSystemLocaleMetadata(): Boolean =
+    info.metaData
+        .getBoolean(KEY_FOLLOW_SYSTEM_LOCALE, false)
+
+@Suppress("DEPRECATION")
+private val Context.info: ApplicationInfo
+    get() = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
+        packageManager
+            .getApplicationInfo(
+                packageName,
+                PackageManager.ApplicationInfoFlags.of(GET_META_DATA.toLong())
+            )
+    } else {
+        packageManager
+            .getApplicationInfo(
+                packageName,
+                GET_META_DATA
+            )
+    }
diff --git a/localian/src/main/kotlin/com/infinum/localian/patcher/WebViewPatcher.kt b/localian/src/main/kotlin/com/infinum/localian/patcher/WebViewPatcher.kt
@@ -2,16 +2,21 @@ package com.infinum.localian.patcher
 
 import android.content.Context
 import com.infinum.localian.Localian
-import com.infinum.localian.extensions.languageTag
+import com.infinum.localian.extensions.followSystemLocaleMetadata
+import com.infinum.localian.extensions.languageTagMetadata
 import java.util.Locale
 
 internal class WebViewPatcher(
     private val context: Context
 ) {
 
     operator fun invoke() =
-        context.languageTag()
-            ?.let {
-                Localian.setLocale(context, Locale.forLanguageTag(it))
-            } ?: Localian.setLocale(context, Localian.getLocale(context))
+        if (context.followSystemLocaleMetadata().not()) {
+            context.languageTagMetadata()
+                ?.let {
+                    Localian.setLocale(context, Locale.forLanguageTag(it))
+                } ?: Localian.setLocale(context, Localian.getLocale(context))
+        } else {
+            Unit
+        }
 }
diff --git a/sample/src/main/AndroidManifest.xml b/sample/src/main/AndroidManifest.xml
@@ -1,4 +1,5 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:tools="http://schemas.android.com/tools"
     package="com.infinum.localian.sample">
 
     <uses-permission android:name="android.permission.INTERNET" />
@@ -10,11 +11,16 @@
         android:label="@string/app_name"
         android:roundIcon="@mipmap/ic_launcher_round"
         android:supportsRtl="true"
+        android:localeConfig="@xml/locales_config"
         android:theme="@style/AppTheme">
 
         <meta-data
             android:name="com.infinum.localian.initial_locale_language_tag"
-            android:value="hr-HR" />
+            android:value="en-US" />
+
+        <meta-data
+            android:name="com.infinum.localian.follow_system_locale"
+            android:value="true" />
 
         <activity
             android:name=".MainActivity"
diff --git a/sample/src/main/kotlin/com/infinum/localian/sample/SampleApp.kt b/sample/src/main/kotlin/com/infinum/localian/sample/SampleApp.kt
@@ -4,6 +4,7 @@ import android.app.Application
 import com.infinum.localian.Localian
 import java.util.Locale
 
+
 class SampleApp : Application() {
 
     companion object {
@@ -15,6 +16,6 @@ class SampleApp : Application() {
     override fun onCreate() {
         super.onCreate()
 
-        Localian.run(application = this, locale = ENGLISH)
+        Localian.run(application = this, locale = ENGLISH, followSystemLocale = true)
     }
 }
diff --git a/sample/src/main/res/xml/locales_config.xml b/sample/src/main/res/xml/locales_config.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8"?>
+<locale-config xmlns:android="http://schemas.android.com/apk/res/android">
+    <locale android:name="hr-HR"/>
+    <locale android:name="en-US"/>
+    <locale android:name="de-DE"/>
+</locale-config>

Original file line number	Diff line number	Diff line change
`@@ -64,6 +64,7 @@ android {`
`64`	`64`	`dependencies {`
`65`	`65`	`implementation libs.kotlin.core`
`66`	`66`	`implementation libs.bundles.androidx`
	`67`	`+ api libs.androidx.startup`
`67`	`68`
`68`	`69`	`testImplementation libs.bundles.testing`
`69`	`70`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@ import android.app.Application`
`4`	`4`	`import com.infinum.localian.Localian`
`5`	`5`	`import java.util.Locale`
`6`	`6`
	`7`	`+`
`7`	`8`	`class SampleApp : Application() {`
`8`	`9`
`9`	`10`	`companion object {`
`@@ -15,6 +16,6 @@ class SampleApp : Application() {`
`15`	`16`	`override fun onCreate() {`
`16`	`17`	`super.onCreate()`
`17`	`18`
`18`		`- Localian.run(application = this, locale = ENGLISH)`
	`19`	`+ Localian.run(application = this, locale = ENGLISH, followSystemLocale = true)`
`19`	`20`	`}`
`20`	`21`	`}`