Add a Kotlin Native implementation (#1)

Author: eygraber

.github/workflows/pr.yml

@@ -77,7 +77,10 @@ jobs:
         run: ./gradlew lintRelease
 
   test:
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        os: [ macos-latest, ubuntu-latest ]
+    runs-on: ${{matrix.os}}
     steps:
       - uses: actions/checkout@v4
 
@@ -93,6 +96,11 @@ jobs:
 
       - name: Run tests
         run: ./gradlew allTests
+        if: matrix.os == 'ubuntu-latest'
+
+      - name: Run Apple tests
+        run: ./gradlew iosX64Test macosX64Test
+        if: matrix.os == 'macos-latest'
 
 env:
   GRADLE_OPTS: -Dorg.gradle.daemon=false -Dkotlin.incremental=false -Dorg.gradle.jvmargs="-Xmx16g -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8 -XX:MaxMetaspaceSize=1024m"

README.md

@@ -5,8 +5,6 @@ libraries.
 
 It works with any of the available implementations of AndroidX SQLite; see their documentation for more information.
 
-Currently only Android and JVM are supported.
-
 ## Gradle
 
 ```kotlin

build.gradle.kts

@@ -40,6 +40,9 @@ gradleConventionsDefaults {
 gradleConventionsKmpDefaults {
   targets(
     KmpTarget.Android,
+    KmpTarget.Ios,
     KmpTarget.Jvm,
+    KmpTarget.Linux,
+    KmpTarget.Macos,
   )
 }

gradle/libs.versions.toml

@@ -21,6 +21,8 @@ kotlin = "2.1.0"
 
 ktlint = "1.5.0"
 
+okio = "3.10.2"
+
 publish = "0.30.0"
 
 [plugins]
@@ -45,6 +47,8 @@ cashapp-sqldelight-runtime = { module = "app.cash.sqldelight:runtime", version.r
 # not actually used; just here so renovate picks it up
 ktlint = { module = "com.pinterest.ktlint:ktlint-bom", version.ref = "ktlint" }
 
+okio = { module = "com.squareup.okio:okio", version.ref = "okio" }
+
 test-androidx-core = "androidx.test:core:1.6.1"
 test-junit = { module = "junit:junit", version = "4.13.2" }
 test-kotlin = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin" }

library/build.gradle.kts

@@ -39,5 +39,10 @@ kotlin {
       implementation(libs.androidx.sqliteBundled)
       implementation(libs.test.kotlin.junit)
     }
+
+    nativeTest.dependencies {
+      implementation(libs.androidx.sqliteBundled)
+      implementation(libs.okio)
+    }
   }
 }

library/src/androidUnitTest/kotlin/com/eygraber/sqldelight/androidx/driver/AndroidxSqliteCommonTests.android.kt

@@ -6,20 +6,25 @@ import app.cash.sqldelight.Transacter
 import org.junit.Assert
 import org.junit.runner.RunWith
 import org.robolectric.RobolectricTestRunner
+import java.io.File
 import java.util.concurrent.Semaphore
 
 @RunWith(RobolectricTestRunner::class)
 actual class CommonDriverTest : AndroidxSqliteDriverTest()
 
-@RunWith(RobolectricTestRunner::class)
-actual class CommonEphemeralTest : AndroidxSqliteEphemeralTest()
-
 @RunWith(RobolectricTestRunner::class)
 actual class CommonQueryTest : AndroidxSqliteQueryTest()
 
 @RunWith(RobolectricTestRunner::class)
 actual class CommonTransacterTest : AndroidxSqliteTransacterTest()
 
+@RunWith(RobolectricTestRunner::class)
+actual class CommonEphemeralTest : AndroidxSqliteEphemeralTest() {
+  override fun deleteDbFile(filename: String) {
+    File(filename).delete()
+  }
+}
+
 actual fun androidxSqliteTestDriver(): SQLiteDriver = AndroidSQLiteDriver()
 
 actual inline fun <T> assertChecksThreadConfinement(

library/src/commonMain/kotlin/com/eygraber/sqldelight/androidx/driver/AndroidxSqliteDriver.kt

@@ -13,6 +13,7 @@ import app.cash.sqldelight.db.SqlDriver
 import app.cash.sqldelight.db.SqlPreparedStatement
 import app.cash.sqldelight.db.SqlSchema
 import kotlinx.atomicfu.locks.SynchronizedObject
+import kotlinx.atomicfu.locks.synchronized
 
 internal expect class TransactionsThreadLocal() {
   internal fun get(): Transacter.Transaction?
@@ -22,7 +23,7 @@ internal expect class TransactionsThreadLocal() {
 internal const val DEFAULT_CACHE_SIZE = 20
 
 /**
- * @param name Name of the database file, an empty string for a temporary database, or null for an in-memory database
+ * @param databaseType Specifies the type of the database file
  * (see [Sqlite open documentation](https://www.sqlite.org/c3ref/open.html)).
  *
  * @see AndroidxSqliteDriver

library/src/commonTest/kotlin/com/eygraber/sqldelight/androidx/driver/AndroidxSqliteCommonTests.kt

@@ -4,10 +4,11 @@ import androidx.sqlite.SQLiteDriver
 import app.cash.sqldelight.Transacter
 
 expect class CommonDriverTest() : AndroidxSqliteDriverTest
-expect class CommonEphemeralTest() : AndroidxSqliteEphemeralTest
 expect class CommonQueryTest() : AndroidxSqliteQueryTest
 expect class CommonTransacterTest() : AndroidxSqliteTransacterTest
 
+expect class CommonEphemeralTest() : AndroidxSqliteEphemeralTest
+
 expect fun androidxSqliteTestDriver(): SQLiteDriver
 
 expect inline fun <T> assertChecksThreadConfinement(

library/src/commonTest/kotlin/com/eygraber/sqldelight/androidx/driver/AndroidxSqliteDriverTest.kt

@@ -66,7 +66,12 @@ abstract class AndroidxSqliteDriverTest {
   ): SqlDriver = AndroidxSqliteDriver(androidxSqliteTestDriver(), AndroidxSqliteDatabaseType.Memory, schema)
 
   private fun useSingleItemCacheDriver(block: (AndroidxSqliteDriver) -> Unit) {
-    AndroidxSqliteDriver(androidxSqliteTestDriver(), AndroidxSqliteDatabaseType.Memory, schema, cacheSize = 1).use(block)
+    AndroidxSqliteDriver(
+      androidxSqliteTestDriver(),
+      AndroidxSqliteDatabaseType.Memory,
+      schema,
+      cacheSize = 1,
+    ).use(block)
   }
 
   private fun changes(): Long? =

library/src/commonTest/kotlin/com/eygraber/sqldelight/androidx/driver/AndroidxSqliteEphemeralTest.kt

@@ -6,8 +6,7 @@ import app.cash.sqldelight.db.QueryResult
 import app.cash.sqldelight.db.SqlCursor
 import app.cash.sqldelight.db.SqlDriver
 import app.cash.sqldelight.db.SqlSchema
-import org.junit.After
-import java.io.File
+import kotlin.test.AfterTest
 import kotlin.test.BeforeTest
 import kotlin.test.Test
 import kotlin.test.assertEquals
@@ -57,6 +56,8 @@ abstract class AndroidxSqliteEphemeralTest {
 
   private val dbName = "com.eygraber.sqldelight.androidx.driver.test.db"
 
+  protected abstract fun deleteDbFile(filename: String)
+
   private fun setupDatabase(
     type: Type,
   ): SqlDriver = when(type) {
@@ -67,12 +68,12 @@ abstract class AndroidxSqliteEphemeralTest {
 
   @BeforeTest
   fun clearNamedDb() {
-    File(dbName).delete()
+    deleteDbFile(dbName)
   }
 
-  @After
+  @AfterTest
   fun clearNamedDbPostTests() {
-    File(dbName).delete()
+    deleteDbFile(dbName)
   }
 
   @Test