Submodule i18n

.github/workflows/android_ci.yml

@@ -16,6 +16,8 @@ jobs:
         steps:
             - name: Checkout repository
               uses: actions/checkout@v4
+              with:
+                  submodules: true
 
             - name: Prepare App
               uses: ./.github/composite/prepareApp
@@ -32,6 +34,8 @@ jobs:
         steps:
             - name: Checkout Repository
               uses: actions/checkout@v4
+              with:
+                  submodules: true
 
             - name: Prepare App
               uses: ./.github/composite/prepareApp
@@ -44,6 +48,8 @@ jobs:
         steps:
             - name: Checkout Repository
               uses: actions/checkout@v4
+              with:
+                  submodules: true
 
             - name: Set up JDK
               uses: actions/setup-java@v1
@@ -65,6 +71,8 @@ jobs:
         steps:
             - name: Checkout Repository
               uses: actions/checkout@v4
+              with:
+                  submodules: true
 
             - name: Prepare App
               uses: ./.github/composite/prepareApp
@@ -86,6 +94,8 @@ jobs:
         steps:
             - name: Checkout Repository
               uses: actions/checkout@v4
+              with:
+                  submodules: true
 
             - name: Prepare App
               uses: ./.github/composite/prepareApp

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "app/src/main/assets/i18n"]
+	path = app/src/main/assets/i18n
+	url = https://github.com/scribe-org/Scribe-i18n.git

CONTRIBUTING.md

@@ -90,16 +90,19 @@ Scribe-Android is developed using the [Kotlin](https://kotlinlang.org/) coding l
 >
 > To run git commands with SSH, remember then to substitute the HTTPS URL, `https://github.com/...`, with the SSH one, `git@github.com:...`.
 >
-> -   e.g. Cloning now becomes `git clone git@github.com:<your-username>/Scribe-Android.git`
+> -   e.g. Cloning (with submodules) now becomes `git clone --recurse-submodules git@github.com:<your-username>/Scribe-Android.git`
 >
 > GitHub also has their documentation on how to [Generate a new SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) 🔑
 >
 > </p>
 > </details>
 
+> [!NOTE]
+> Cloning this repository with `--recurse-submodules` also clones a copy of [Scribe-i18n](https://github.com/scribe-org/Scribe-i18n) where the texts for Scribe projects are localized. When pulling changes from `main`, you should also run the following command: `git submodule update --init --recursive`.
+
 ```bash
-# Clone your fork of the repo into the current directory.
-git clone https://github.com/<your-username>/Scribe-Android.git
+# Clone your fork of the repo into the current directory (including submodules).
+git clone --recurse-submodules https://github.com/<your-username>/Scribe-Android.git
 # Navigate to the newly cloned directory.
 cd Scribe-Android
 # Assign the original repo to a remote called "upstream".
@@ -337,7 +340,7 @@ Scribe does not accept direct edits to the grammar files as they are sourced fro
 
 Being an app that focusses on language learning, localization plays a big part in what Scribe will eventually be. Those interested are more than welcome to join the team at [scribe-org/Scribe-i18n](https://github.com/scribe-org/Scribe-i18n) where we work on localizing all Scribe applications via [Weblate](https://weblate.org/).
 
-Please run the [update_i18n_keys.sh](https://github.com/scribe-org/Scribe-Android/blob/main/update_i18n_keys.sh) script to load in the most recent version of the [Scribe-i18n](https://github.com/scribe-org/Scribe-i18n) app texts into Scribe-Android.
+Please run the [update_i18n_keys.sh](./update_i18n_keys.sh) script to load in the most recent version of the [Scribe-i18n](https://github.com/scribe-org/Scribe-i18n) app texts into Scribe-Android.
 
 ### Progress
 

README.md

@@ -137,16 +137,19 @@ Scribe-Android is developed using the [Kotlin](https://kotlinlang.org/) coding l
 >
 > To run git commands with SSH, remember then to substitute the HTTPS URL, `https://github.com/...`, with the SSH one, `git@github.com:...`.
 >
-> -   e.g. Cloning now becomes `git clone git@github.com:<your-username>/Scribe-Android.git`
+> -   e.g. Cloning (with submodules) now becomes `git clone --recurse-submodules git@github.com:<your-username>/Scribe-Android.git`
 >
 > GitHub also has their documentation on how to [Generate a new SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) 🔑
 >
 > </p>
 > </details>
 
+> [!NOTE]
+> Cloning this repository with `--recurse-submodules` also clones a copy of [Scribe-i18n](https://github.com/scribe-org/Scribe-i18n) where the texts for Scribe projects are localized. When pulling changes from `main`, you should also run the following command: `git submodule update --init --recursive`.
+
 ```bash
-# Clone your fork of the repo into the current directory.
-git clone https://github.com/<your-username>/Scribe-Android.git
+# Clone your fork of the repo into the current directory (including submodules).
+git clone --recurse-submodules https://github.com/<your-username>/Scribe-Android.git
 # Navigate to the newly cloned directory.
 cd Scribe-Android
 # Assign the original repo to a remote called "upstream".

app/build.gradle.kts

@@ -307,13 +307,13 @@ tasks.register<Copy>("moveFromi18n") {
     destinationDir = file("src/main/res")
 
     val locales =
-        file("src/main/assets/i18n/Scribe-i18n/values")
+        file("src/main/assets/i18n/i18n/values")
             .listFiles()
             ?.filter { it.isDirectory }
             ?.map { it.name }
             ?: emptyList()
     locales.forEach { locale ->
-        val fromDir = file("src/main/assets/i18n/Scribe-i18n/values/$locale/")
+        val fromDir = file("src/main/assets/i18n/i18n/values/$locale/")
         val targetDir =
             if (locale == "en-US") {
                 "values"

app/src/androidTest/kotlin/be/scri/ui/screens/about/AboutUtilInstrumentedTest.kt

@@ -152,15 +152,15 @@ class AboutUtilInstrumentedTest {
                 // Test specific items.
                 val githubItem = communityList.items[0] as ScribeItem.ExternalLinkItem
                 assertThat(githubItem.leadingIcon).isEqualTo(R.drawable.github_logo)
-                assertThat(githubItem.title).isEqualTo(R.string.app_about_community_github)
+                assertThat(githubItem.title).isEqualTo(R.string.i18n_app_about_community_github)
 
                 val shareItem = communityList.items[1] as ScribeItem.ExternalLinkItem
                 assertThat(shareItem.leadingIcon).isEqualTo(R.drawable.share_icon)
-                assertThat(shareItem.title).isEqualTo(R.string.app_about_community_share_scribe)
+                assertThat(shareItem.title).isEqualTo(R.string.i18n_app_about_community_share_scribe)
 
                 val wikimediaItem = communityList.items[2] as ScribeItem.ExternalLinkItem
                 assertThat(wikimediaItem.leadingIcon).isEqualTo(R.drawable.wikimedia_logo_black)
-                assertThat(wikimediaItem.title).isEqualTo(R.string.app_about_community_wikimedia)
+                assertThat(wikimediaItem.title).isEqualTo(R.string.i18n_app_about_community_wikimedia)
 
                 // Test onClick callbacks.
                 shareItem.onClick()
@@ -216,15 +216,15 @@ class AboutUtilInstrumentedTest {
                 // Test specific items.
                 val rateItem = feedbackList.items[0] as ScribeItem.ExternalLinkItem
                 assertThat(rateItem.leadingIcon).isEqualTo(R.drawable.star)
-                assertThat(rateItem.title).isEqualTo(R.string.app_about_feedback_rate_scribe)
+                assertThat(rateItem.title).isEqualTo(R.string.i18n_app_about_feedback_rate_scribe)
 
                 val mailItem = feedbackList.items[2] as ScribeItem.ExternalLinkItem
                 assertThat(mailItem.leadingIcon).isEqualTo(R.drawable.mail_icon)
-                assertThat(mailItem.title).isEqualTo(R.string.app_about_feedback_email)
+                assertThat(mailItem.title).isEqualTo(R.string.i18n_app_about_feedback_send_email)
 
                 val hintsItem = feedbackList.items[4] as ScribeItem.ExternalLinkItem
                 assertThat(hintsItem.leadingIcon).isEqualTo(R.drawable.light_bulb_icon)
-                assertThat(hintsItem.title).isEqualTo(R.string.app_about_feedback_app_hints)
+                assertThat(hintsItem.title).isEqualTo(R.string.i18n_app_about_feedback_reset_app_hints)
 
                 // Test onClick callbacks.
                 rateItem.onClick()
@@ -279,12 +279,12 @@ class AboutUtilInstrumentedTest {
                 // Test specific items.
                 val privacyItem = legalList.items[0] as ScribeItem.ExternalLinkItem
                 assertThat(privacyItem.leadingIcon).isEqualTo(R.drawable.shield_lock)
-                assertThat(privacyItem.title).isEqualTo(R.string.app_about_legal_privacy_policy)
+                assertThat(privacyItem.title).isEqualTo(R.string.i18n__global_privacy_policy)
                 assertThat(privacyItem.trailingIcon).isEqualTo(R.drawable.right_arrow)
 
                 val licenseItem = legalList.items[1] as ScribeItem.ExternalLinkItem
                 assertThat(licenseItem.leadingIcon).isEqualTo(R.drawable.license_icon)
-                assertThat(licenseItem.title).isEqualTo(R.string.app_about_legal_third_party)
+                assertThat(licenseItem.title).isEqualTo(R.string.i18n_app_about_legal_third_party)
                 assertThat(licenseItem.trailingIcon).isEqualTo(R.drawable.right_arrow)
 
                 // Test onClick callbacks.

app/src/androidTest/kotlin/be/scri/ui/screens/settings/ScribeItemListTest.kt

@@ -52,12 +52,12 @@ class ScribeItemListTest {
         val items =
             listOf(
                 ScribeItem.ClickableItem(
-                    title = R.string.app_settings_menu_app_language,
-                    desc = R.string.app_settings_menu_app_language_description,
+                    title = R.string.i18n_app_settings_menu_app_language,
+                    desc = R.string.i18n_app_settings_menu_app_language_description,
                     action = { },
                 ),
                 ScribeItem.ClickableItem(
-                    title = R.string.app_settings_keyboard_title,
+                    title = R.string.i18n_app_settings_keyboard_title,
                     desc = null,
                     action = { },
                 ),
@@ -76,13 +76,13 @@ class ScribeItemListTest {
         val items =
             listOf(
                 ScribeItem.SwitchItem(
-                    title = R.string.app_settings_menu_app_color_mode,
-                    desc = R.string.app_settings_menu_app_color_mode_description,
+                    title = R.string.i18n_app_settings_menu_app_color_mode,
+                    desc = R.string.i18n_app_settings_menu_app_color_mode_description,
                     state = false,
                     onToggle = { },
                 ),
                 ScribeItem.SwitchItem(
-                    title = R.string.app_settings_keyboard_title,
+                    title = R.string.i18n_app_settings_keyboard_title,
                     desc = 0,
                     state = true,
                     onToggle = { },
@@ -114,8 +114,8 @@ class ScribeItemListTest {
         val items =
             listOf(
                 ScribeItem.ClickableItem(
-                    title = R.string.app_settings_menu_app_language,
-                    desc = R.string.app_settings_menu_app_language_description,
+                    title = R.string.i18n_app_settings_menu_app_language,
+                    desc = R.string.i18n_app_settings_menu_app_language_description,
                     action = { clicked = true },
                 ),
             )
@@ -134,8 +134,8 @@ class ScribeItemListTest {
         val items =
             listOf(
                 ScribeItem.SwitchItem(
-                    title = R.string.app_settings_menu_app_color_mode,
-                    desc = R.string.app_settings_menu_app_color_mode_description,
+                    title = R.string.i18n_app_settings_menu_app_color_mode,
+                    desc = R.string.i18n_app_settings_menu_app_color_mode_description,
                     state = state,
                     onToggle = { state = it },
                 ),
@@ -154,8 +154,8 @@ class ScribeItemListTest {
         val items =
             (0..49).map { index ->
                 ScribeItem.ClickableItem(
-                    title = R.string.app_settings_menu_app_language,
-                    desc = R.string.app_settings_menu_app_language_description,
+                    title = R.string.i18n_app_settings_menu_app_language,
+                    desc = R.string.i18n_app_settings_menu_app_language_description,
                     action = { },
                 )
             }
@@ -190,8 +190,8 @@ class ScribeItemListTest {
         val items =
             listOf(
                 ScribeItem.ClickableItem(
-                    title = R.string.app_settings_menu_app_language,
-                    desc = R.string.app_settings_menu_app_language_description,
+                    title = R.string.i18n_app_settings_menu_app_language,
+                    desc = R.string.i18n_app_settings_menu_app_language_description,
                     action = { },
                 ),
             )

app/src/androidTest/kotlin/be/scri/ui/screens/settings/SettingsScreenInstallKeyboardButtonTest.kt

@@ -35,7 +35,7 @@ class SettingsScreenInstallKeyboardButtonTest {
     @Test
     fun installKeyboardButton_isDisplayed_whenKeyboardNotInstalled() {
         val context = InstrumentationRegistry.getInstrumentation().targetContext
-        val expectedText = context.getString(R.string.app_settings_button_install_keyboards)
+        val expectedText = context.getString(R.string.i18n_app_settings_button_install_keyboards)
         val mockViewModel = createMockViewModel(isKeyboardInstalled = false)
 
         composeTestRule.setContent {
@@ -58,7 +58,7 @@ class SettingsScreenInstallKeyboardButtonTest {
     @Test
     fun installKeyboardButton_isNotDisplayed_whenKeyboardInstalled() {
         val context = InstrumentationRegistry.getInstrumentation().targetContext
-        val expectedText = context.getString(R.string.app_settings_button_install_keyboards)
+        val expectedText = context.getString(R.string.i18n_app_settings_button_install_keyboards)
         val mockViewModel = createMockViewModel(isKeyboardInstalled = true)
 
         every { mockViewModel.languages } returns MutableStateFlow(listOf("English", "German"))
@@ -82,7 +82,7 @@ class SettingsScreenInstallKeyboardButtonTest {
     @Test
     fun installKeyboardButton_hasClickAction_whenDisplayed() {
         val context = InstrumentationRegistry.getInstrumentation().targetContext
-        val expectedText = context.getString(R.string.app_settings_button_install_keyboards)
+        val expectedText = context.getString(R.string.i18n_app_settings_button_install_keyboards)
         val mockViewModel = createMockViewModel(isKeyboardInstalled = false)
 
         composeTestRule.setContent {
@@ -105,7 +105,7 @@ class SettingsScreenInstallKeyboardButtonTest {
     @Test
     fun installKeyboardButton_performClick_buttonStillExists() {
         val context = InstrumentationRegistry.getInstrumentation().targetContext
-        val expectedText = context.getString(R.string.app_settings_button_install_keyboards)
+        val expectedText = context.getString(R.string.i18n_app_settings_button_install_keyboards)
         val mockViewModel = createMockViewModel(isKeyboardInstalled = false)
 
         composeTestRule.setContent {
@@ -129,7 +129,7 @@ class SettingsScreenInstallKeyboardButtonTest {
     @Test
     fun installKeyboardButton_displaysCorrectText() {
         val context = InstrumentationRegistry.getInstrumentation().targetContext
-        val expectedText = context.getString(R.string.app_settings_button_install_keyboards)
+        val expectedText = context.getString(R.string.i18n_app_settings_button_install_keyboards)
         val mockViewModel = createMockViewModel(isKeyboardInstalled = false)
 
         composeTestRule.setContent {
@@ -152,7 +152,7 @@ class SettingsScreenInstallKeyboardButtonTest {
     @Test
     fun installKeyboardButton_rendersCorrectly_inLightTheme() {
         val context = InstrumentationRegistry.getInstrumentation().targetContext
-        val expectedText = context.getString(R.string.app_settings_button_install_keyboards)
+        val expectedText = context.getString(R.string.i18n_app_settings_button_install_keyboards)
         val mockViewModel = createMockViewModel(isKeyboardInstalled = false)
 
         composeTestRule.setContent {
@@ -176,7 +176,7 @@ class SettingsScreenInstallKeyboardButtonTest {
     @Test
     fun installKeyboardButton_rendersCorrectly_inDarkTheme() {
         val context = InstrumentationRegistry.getInstrumentation().targetContext
-        val expectedText = context.getString(R.string.app_settings_button_install_keyboards)
+        val expectedText = context.getString(R.string.i18n_app_settings_button_install_keyboards)
         val mockViewModel = createMockViewModel(isKeyboardInstalled = false)
 
         every { mockViewModel.isUserDarkMode } returns MutableStateFlow(true)
@@ -202,7 +202,7 @@ class SettingsScreenInstallKeyboardButtonTest {
     @Test
     fun installKeyboardButton_hasProperStyling() {
         val context = InstrumentationRegistry.getInstrumentation().targetContext
-        val expectedText = context.getString(R.string.app_settings_button_install_keyboards)
+        val expectedText = context.getString(R.string.i18n_app_settings_button_install_keyboards)
         val mockViewModel = createMockViewModel(isKeyboardInstalled = false)
 
         composeTestRule.setContent {