kmp-impl: Room basic setup (#2284)

Author: Darkeye14

Diff for: build-logic/convention/src/main/kotlin/AndroidRoomConventionPlugin.kt

@@ -1,4 +1,5 @@
 import androidx.room.gradle.RoomExtension
+import com.google.devtools.ksp.gradle.KspExtension
 import org.gradle.api.Plugin
 import org.gradle.api.Project
 import org.gradle.kotlin.dsl.configure
@@ -12,17 +13,21 @@ class AndroidRoomConventionPlugin : Plugin<Project> {
             pluginManager.apply("androidx.room")
             pluginManager.apply("com.google.devtools.ksp")
 
+            extensions.configure<KspExtension> {
+                arg("room.generateKotlin", "true")
+            }
             extensions.configure<RoomExtension> {
                 // The schemas directory contains a schema file for each version of the Room database.
                 // This is required to enable Room auto migrations.
                 // See https://developer.android.com/reference/kotlin/androidx/room/AutoMigration.
                 schemaDirectory("$projectDir/schemas")
             }
 
+
             dependencies {
-                add("implementation", libs.findLibrary("room.runtime").get())
-                add("implementation", libs.findLibrary("room.ktx").get())
-                add("ksp", libs.findLibrary("room.compiler").get())
+                "implementation"(libs.findLibrary("androidx.room.runtime").get())
+                "implementation"(libs.findLibrary("androidx.room.ktx").get())
+                "ksp"(libs.findLibrary("androidx.room.compiler").get())
             }
         }
     }

Diff for: build.gradle.kts

@@ -8,6 +8,7 @@ plugins {
     alias(libs.plugins.hilt) apply false
     alias(libs.plugins.kotlin.serialization) apply false
     alias(libs.plugins.androidx.navigation) apply false
+    alias(libs.plugins.room) apply false
     alias(libs.plugins.ksp) apply false
     alias(libs.plugins.secrets) apply false
     alias(libs.plugins.dependencyGuard) apply false

Diff for: core/database/build.gradle.kts

@@ -10,6 +10,8 @@
 plugins {
     alias(libs.plugins.mifos.android.library)
     alias(libs.plugins.mifos.android.hilt)
+    alias(libs.plugins.mifos.android.room)
+    alias(libs.plugins.kotlin.serialization)
     alias(libs.plugins.mifos.android.library.jacoco)
     id(libs.plugins.kotlin.parcelize.get().pluginId)
 }
@@ -29,6 +31,7 @@ dependencies {
 
     implementation(libs.converter.gson)
 
+    implementation(libs.kotlinx.serialization.json)
     //rxjava dependencies
     implementation(libs.rxandroid)
     implementation(libs.rxjava)
@@ -38,6 +41,12 @@ dependencies {
     implementation(libs.dbflow)
     kapt(libs.github.dbflow.processor)
 
+    //room dependencies
+//    implementation(libs.room.runtime)
+//    implementation(libs.room.ktx)
+//    ksp(libs.room.compiler)
+//    kspTest(libs.room.compiler)
+
     // Hilt dependency
     implementation(libs.hilt.android)
     kapt(libs.hilt.compiler)

Diff for: core/database/src/main/java/com/mifos/room/dao/ColumnValueDao.kt

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2025 Mifos Initiative
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * See https://github.com/openMF/android-client/blob/master/LICENSE.md
+ */
+package com.mifos.room.dao
+
+import androidx.room.Dao
+import androidx.room.Delete
+import androidx.room.Insert
+import androidx.room.OnConflictStrategy
+import androidx.room.Query
+import androidx.room.Update
+import com.mifos.room.entities.noncore.ColumnValue
+
+@Dao
+interface ColumnValueDao {
+    @Insert(onConflict = OnConflictStrategy.REPLACE)
+    suspend fun insert(columnValue: ColumnValue)
+
+    @Update
+    suspend fun update(columnValue: ColumnValue)
+
+    @Delete
+    suspend fun delete(columnValue: ColumnValue)
+
+    @Query("SELECT * FROM ColumnValue WHERE id = :id")
+    suspend fun getColumnValue(id: Int): ColumnValue?
+}

Diff for: core/database/src/main/java/com/mifos/room/db/MifosDatabase.kt

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2025 Mifos Initiative
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * See https://github.com/openMF/android-client/blob/master/LICENSE.md
+ */
+package com.mifos.room.db
+
+import androidx.room.Database
+import androidx.room.RoomDatabase
+import androidx.room.TypeConverters
+import com.mifos.room.dao.ColumnValueDao
+import com.mifos.room.entities.noncore.ColumnValue
+import com.mifos.room.utils.typeconverters.ListTypeConverters
+
+@Database(
+    // [TODO -> add other entities ]
+    entities = [ColumnValue::class],
+    version = MifosDatabase.VERSION,
+    exportSchema = true,
+    autoMigrations = [],
+)
+@TypeConverters(ListTypeConverters::class)
+// ( TODO -> add type converters here )
+
+abstract class MifosDatabase : RoomDatabase() {
+    abstract fun columnValueDao(): ColumnValueDao
+
+    companion object {
+        const val VERSION = 1
+    }
+}

Diff for: core/database/src/main/java/com/mifos/room/di/DaoModule.kt

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2025 Mifos Initiative
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * See https://github.com/openMF/android-client/blob/master/LICENSE.md
+ */
+package com.mifos.room.di
+
+import com.mifos.room.dao.ColumnValueDao
+import com.mifos.room.db.MifosDatabase
+import dagger.Module
+import dagger.Provides
+import dagger.hilt.InstallIn
+import dagger.hilt.components.SingletonComponent
+
+@Module
+@InstallIn(SingletonComponent::class)
+object DaoModule {
+    @Provides
+    fun providesColumnValueDao(database: MifosDatabase): ColumnValueDao {
+        return database.columnValueDao()
+    }
+}

Diff for: core/database/src/main/java/com/mifos/room/di/DatabaseModule.kt

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2025 Mifos Initiative
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * See https://github.com/openMF/android-client/blob/master/LICENSE.md
+ */
+package com.mifos.room.di
+
+import android.content.Context
+import androidx.room.Room
+import com.mifos.room.db.MifosDatabase
+import dagger.Module
+import dagger.Provides
+import dagger.hilt.InstallIn
+import dagger.hilt.android.qualifiers.ApplicationContext
+import dagger.hilt.components.SingletonComponent
+import javax.inject.Singleton
+
+@Module
+@InstallIn(SingletonComponent::class)
+object DatabaseModule {
+
+    @Provides
+    @Singleton
+    fun providesDatabase(@ApplicationContext context: Context): MifosDatabase {
+        return Room.databaseBuilder(
+            context = context,
+            klass = MifosDatabase::class.java,
+            name = "mifos-database",
+        ).build()
+    }
+}

Diff for: core/database/src/main/java/com/mifos/room/entities/noncore/ColumnValue.kt

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2025 Mifos Initiative
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * See https://github.com/openMF/android-client/blob/master/LICENSE.md
+ */
+package com.mifos.room.entities.noncore
+
+import android.os.Parcelable
+import androidx.room.ColumnInfo
+import androidx.room.Entity
+import androidx.room.PrimaryKey
+import kotlinx.parcelize.Parcelize
+
+@Parcelize
+@Entity(tableName = "ColumnValue")
+data class ColumnValue(
+    @PrimaryKey
+    @ColumnInfo(name = "id")
+    var id: Int? = null,
+
+    @ColumnInfo(name = "value")
+    var value: String? = null,
+
+    @ColumnInfo(name = "score")
+    var score: Int? = null,
+
+    @ColumnInfo(name = "registeredTableName")
+    var registeredTableName: String? = null,
+) : Parcelable

Diff for: core/database/src/main/java/com/mifos/room/utils/typeconverters/ListTypeConverters.kt

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2025 Mifos Initiative
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * See https://github.com/openMF/android-client/blob/master/LICENSE.md
+ */
+package com.mifos.room.utils.typeconverters
+
+import androidx.room.TypeConverter
+import kotlinx.serialization.encodeToString
+import kotlinx.serialization.json.Json
+
+class ListTypeConverters {
+
+    @TypeConverter
+    fun fromIntList(value: String): ArrayList<Int?> {
+        return Json.decodeFromString(value)
+    }
+
+    @TypeConverter
+    fun toIntList(list: ArrayList<Int?>): String {
+        return Json.encodeToString(list)
+    }
+}

Diff for: gradle/libs.versions.toml

@@ -102,7 +102,10 @@ playScanner = "16.1.0"
 playService = "18.5.0"
 realmVersion = "1.13.0"
 recyclerview = "1.3.2"
-room = "2.6.1"
+room = "2.7.0-alpha12"
+roomKtxVersion = "2.7.0-alpha12"
+roomRuntimeVersion = "2.7.0-alpha12"
+roomTestingVersion = "2.7.0-alpha12"
 retrofit = "2.11.0"
 rxandroidVersion = "1.1.0"
 rxjava = "1.3.8"
@@ -271,7 +274,13 @@ androidx-navigation-ui-ktx = { module = "androidx.navigation:navigation-ui-ktx",
 androidx-navigation-compose = { group = "androidx.navigation", name = "navigation-compose", version.ref = "androidxNavigation" }
 androidx-navigation-testing = { group = "androidx.navigation", name = "navigation-testing", version.ref = "androidxNavigation" }
 
+#room
+androidx-room-compiler = { group = "androidx.room", name = "room-compiler", version.ref = "room" }
+androidx-room-ktx = { group = "androidx.room", name = "room-ktx", version.ref = "roomKtxVersion" }
+androidx-room-runtime = { group = "androidx.room", name = "room-runtime", version.ref = "roomRuntimeVersion" }
+androidx-room-testing = { group = "androidx.room", name = "room-testing", version.ref = "roomTestingVersion" }
 androidx-core-testing = { module = "androidx.arch.core:core-testing", version.ref = "coreTesting" }
+room-paging = { group = "androidx.room", name = "room-paging", version.ref = "room" }
 
 androidx-profileinstaller = { group = "androidx.profileinstaller", name = "profileinstaller", version.ref = "androidxProfileinstaller" }
 androidx-test-core = { group = "androidx.test", name = "core", version.ref = "androidxTestCore" }
@@ -387,12 +396,6 @@ play-services-places = { module = "com.google.android.gms:play-services-places",
 protobuf-kotlin-lite = { group = "com.google.protobuf", name = "protobuf-kotlin-lite", version.ref = "protobuf" }
 protobuf-protoc = { group = "com.google.protobuf", name = "protoc", version.ref = "protobuf" }
 
-# Room Database
-room-compiler = { group = "androidx.room", name = "room-compiler", version.ref = "room" }
-room-ktx = { group = "androidx.room", name = "room-ktx", version.ref = "room" }
-room-runtime = { group = "androidx.room", name = "room-runtime", version.ref = "room" }
-room-paging = { group = "androidx.room", name = "room-paging", version.ref = "room" }
-
 # Realm
 realm-library-base = { group = "io.realm.kotlin", name = "library-base", version.ref = "realmVersion" }