track a primary & parallel locale for each tool

Author: frett

library/db/room-schemas/org.cru.godtools.db.room.GodToolsRoomDatabase/24.json

@@ -35,6 +35,7 @@ interface ToolsRepository {
     suspend fun unpinTool(code: String)
 
     suspend fun storeToolOrder(tools: List<String>)
+    suspend fun updateToolLocales(code: String, primary: Locale?, parallel: Locale?)
     suspend fun updateToolViews(code: String, delta: Int)
 
     // region Initial Content Methods

library/db/src/main/kotlin/org/cru/godtools/db/repository/ToolsRepository.kt

@@ -45,7 +45,7 @@ import org.cru.godtools.db.room.repository.UserCountersRoomRepository
 import org.cru.godtools.db.room.repository.UserRoomRepository
 
 @Database(
-    version = 23,
+    version = 24,
     entities = [
         AttachmentEntity::class,
         LanguageEntity::class,
@@ -78,6 +78,7 @@ import org.cru.godtools.db.room.repository.UserRoomRepository
         AutoMigration(from = 20, to = 21),
         AutoMigration(from = 21, to = 22),
         AutoMigration(from = 22, to = 23),
+        AutoMigration(from = 23, to = 24),
     ],
 )
 @TypeConverters(Java8TimeConverters::class, LocaleConverter::class)
@@ -140,6 +141,7 @@ internal abstract class GodToolsRoomDatabase : RoomDatabase() {
  * 21: 2024-01-26
  * 22: 2024-04-30
  * 23: 2024-06-13
+ * 24: 2024-04-22
  */
 
 internal fun RoomDatabase.Builder<GodToolsRoomDatabase>.enableMigrations() = fallbackToDestructiveMigration()

library/db/src/main/kotlin/org/cru/godtools/db/room/GodToolsRoomDatabase.kt

@@ -64,6 +64,8 @@ internal interface ToolsDao {
     suspend fun resetToolOrder()
     @Query("UPDATE tools SET `order` = :order WHERE code = :code")
     suspend fun updateToolOrder(code: String, order: Int)
+    @Query("UPDATE tools SET primaryLocale = :primary, parallelLocale = :parallel WHERE code = :code")
+    suspend fun updateToolLocales(code: String, primary: Locale?, parallel: Locale?)
     @Query("UPDATE tools SET pendingShares = pendingShares + :views WHERE code = :code")
     suspend fun updateToolViews(code: String, views: Int)
     @Delete

library/db/src/main/kotlin/org/cru/godtools/db/room/dao/ToolsDao.kt

@@ -38,6 +38,8 @@ internal class ToolEntity(
     val isHidden: Boolean = false,
     @ColumnInfo(defaultValue = "false")
     val isSpotlight: Boolean = false,
+    val primaryLocale: Locale? = null,
+    val parallelLocale: Locale? = null,
     @ColumnInfo(defaultValue = "")
     val changedFields: String = "",
     val apiId: Long? = null,
@@ -63,6 +65,8 @@ internal class ToolEntity(
         isFavorite = tool.isFavorite,
         isHidden = tool.isHidden,
         isSpotlight = tool.isSpotlight,
+        primaryLocale = tool.primaryLocale,
+        parallelLocale = tool.parallelLocale,
         apiId = tool.apiId,
         changedFields = tool.changedFieldsStr,
     )
@@ -88,6 +92,8 @@ internal class ToolEntity(
         pendingShares = pendingShares,
         metatoolCode = metatoolCode,
         defaultVariantCode = defaultVariantCode,
+        primaryLocale = primaryLocale,
+        parallelLocale = parallelLocale,
         apiId = apiId,
         changedFieldsStr = changedFields,
     )

library/db/src/main/kotlin/org/cru/godtools/db/room/entity/ToolEntity.kt

@@ -56,6 +56,9 @@ internal abstract class ToolsRoomRepository(private val db: GodToolsRoomDatabase
         }
     }
 
+    override suspend fun updateToolLocales(code: String, primary: Locale?, parallel: Locale?) =
+        dao.updateToolLocales(code, primary, parallel)
+
     override suspend fun updateToolViews(code: String, delta: Int) = dao.updateToolViews(code, delta)
 
     override suspend fun storeInitialTools(tools: Collection<Tool>) =

library/db/src/main/kotlin/org/cru/godtools/db/room/repository/ToolsRoomRepository.kt

@@ -388,6 +388,24 @@ abstract class ToolsRepositoryIT {
     }
     // endregion storeToolOrder()
 
+    // region updateToolLocales()
+    @Test
+    fun `updateToolLocales()`() = testScope.runTest {
+        val tool = randomTool("tool")
+        repository.storeInitialTools(listOf(tool))
+
+        assertNotNull(repository.findTool("tool")) {
+            assertNull(it.primaryLocale)
+            assertNull(it.parallelLocale)
+        }
+        repository.updateToolLocales("tool", Locale.ENGLISH, Locale.FRENCH)
+        assertNotNull(repository.findTool("tool")) {
+            assertEquals(Locale.ENGLISH, it.primaryLocale)
+            assertEquals(Locale.FRENCH, it.parallelLocale)
+        }
+    }
+    // endregion updateToolLocales()
+
     // region updateToolShares()
     @Test
     fun `updateToolViews()`() = testScope.runTest {

library/db/src/test/kotlin/org/cru/godtools/db/repository/ToolsRepositoryIT.kt

@@ -376,6 +376,28 @@ class GodToolsRoomDatabaseMigrationIT {
         }
     }
 
+    @Test
+    fun testMigrate23To24() {
+        val localesQuery = "SELECT code, primaryLocale, parallelLocale FROM tools WHERE code = 'kgp'"
+
+        // create v23 database
+        helper.createDatabase(GodToolsRoomDatabase.DATABASE_NAME, 23).use { db ->
+            db.execSQL("INSERT INTO tools (code, type) VALUES (?, ?)", arrayOf("kgp", Tool.Type.TRACT))
+            assertFailsWith<SQLException> { db.query(localesQuery) }
+        }
+
+        // run migration
+        helper.runMigrationsAndValidate(GodToolsRoomDatabase.DATABASE_NAME, 24, true, *MIGRATIONS).use { db ->
+            db.query(localesQuery).use {
+                assertEquals(1, it.count)
+                it.moveToFirst()
+                assertEquals("kgp", it.getStringOrNull(0))
+                assertEquals(null, it.getStringOrNull(1))
+                assertEquals(null, it.getStringOrNull(2))
+            }
+        }
+    }
+
     private fun SupportSQLiteDatabase.dumpIndices(table: String) = query("PRAGMA index_list($table)").use { it ->
         it.map { it.getString(1) }.associateWith { name ->
             query("PRAGMA index_info($name)").use { it.map { it.getString(2) }.toSet() }

library/db/src/test/kotlin/org/cru/godtools/db/room/GodToolsRoomDatabaseMigrationIT.kt

@@ -75,6 +75,10 @@ class Tool(
     val shares: Int = 0,
     @JsonApiIgnore
     val pendingShares: Int = 0,
+    @JsonApiIgnore
+    val primaryLocale: Locale? = null,
+    @JsonApiIgnore
+    val parallelLocale: Locale? = null,
     metatoolCode: String? = null,
     defaultVariantCode: String? = null,
     @JsonApiId