From 589b7af498ea7e92ffbe1ffe249b2cae06fd3bb7 Mon Sep 17 00:00:00 2001
From: Shreyash Kore <kore.shreyash@gmail.com>
Date: Wed, 5 Mar 2025 22:57:57 +0530
Subject: [PATCH 1/3] implement InMemoryCodec

---
 .idea/gradle.xml                              |  1 +
 kstore-testing/.gitignore                     |  1 +
 kstore-testing/build.gradle.kts               | 57 +++++++++++++++++++
 .../xxfast/kstore/testing/InMemoryCodec.kt    | 36 ++++++++++++
 .../io/github/xxfast/kstore/testing/KStore.kt | 25 ++++++++
 settings.gradle.kts                           |  1 +
 6 files changed, 121 insertions(+)
 create mode 100644 kstore-testing/.gitignore
 create mode 100644 kstore-testing/build.gradle.kts
 create mode 100644 kstore-testing/src/commonMain/kotlin/io/github/xxfast/kstore/testing/InMemoryCodec.kt
 create mode 100644 kstore-testing/src/commonMain/kotlin/io/github/xxfast/kstore/testing/KStore.kt

diff --git a/.idea/gradle.xml b/.idea/gradle.xml
index 38fe278..a5ce611 100644
--- a/.idea/gradle.xml
+++ b/.idea/gradle.xml
@@ -12,6 +12,7 @@
             <option value="$PROJECT_DIR$/kstore" />
             <option value="$PROJECT_DIR$/kstore-file" />
             <option value="$PROJECT_DIR$/kstore-storage" />
+            <option value="$PROJECT_DIR$/kstore-testing" />
           </set>
         </option>
         <option name="resolveExternalAnnotations" value="false" />
diff --git a/kstore-testing/.gitignore b/kstore-testing/.gitignore
new file mode 100644
index 0000000..42afabf
--- /dev/null
+++ b/kstore-testing/.gitignore
@@ -0,0 +1 @@
+/build
\ No newline at end of file
diff --git a/kstore-testing/build.gradle.kts b/kstore-testing/build.gradle.kts
new file mode 100644
index 0000000..026b8bb
--- /dev/null
+++ b/kstore-testing/build.gradle.kts
@@ -0,0 +1,57 @@
+import org.jetbrains.kotlin.gradle.targets.js.nodejs.NodeJsRootExtension
+import org.jetbrains.kotlin.gradle.targets.js.npm.tasks.KotlinNpmInstallTask
+
+plugins {
+  kotlin("multiplatform")
+  id("org.jetbrains.kotlinx.binary-compatibility-validator") version "0.15.1"
+}
+
+kotlin {
+  explicitApi()
+
+  js(IR) {
+    browser()
+  }
+
+  wasmJs {
+    binaries.executable()
+    browser()
+  }
+
+  sourceSets {
+    val commonMain by getting {
+      dependencies {
+        implementation(project(":kstore"))
+        implementation(libs.kotlinx.serialization.json)
+      }
+    }
+
+    val commonTest by getting {
+      dependencies {
+        implementation(kotlin("test"))
+        implementation(libs.kotlinx.coroutines.test)
+      }
+    }
+  }
+}
+
+//
+// TODO: https://youtrack.jetbrains.com/issue/KT-63014/Running-tests-with-wasmJs-in-1.9.20-requires-Chrome-Canary#focus=Comments-27-8321383.0-0
+// The following is required to support the wasmJs target.
+//
+// Node.js Canary is set to 21.0.0-v8-canary20231019bd785be450
+// as that is the last version to ship Windows binaries too.
+//
+
+rootProject.extensions.configure<NodeJsRootExtension> {
+  nodeVersion = "21.0.0-v8-canary20231019bd785be450"
+  nodeDownloadBaseUrl = "https://nodejs.org/download/v8-canary"
+}
+
+rootProject.tasks.withType<KotlinNpmInstallTask>().configureEach {
+  val flag = "--ignore-engines"
+
+  if (!args.contains(flag)) {
+    args.add(flag)
+  }
+}
diff --git a/kstore-testing/src/commonMain/kotlin/io/github/xxfast/kstore/testing/InMemoryCodec.kt b/kstore-testing/src/commonMain/kotlin/io/github/xxfast/kstore/testing/InMemoryCodec.kt
new file mode 100644
index 0000000..c29d653
--- /dev/null
+++ b/kstore-testing/src/commonMain/kotlin/io/github/xxfast/kstore/testing/InMemoryCodec.kt
@@ -0,0 +1,36 @@
+package io.github.xxfast.kstore.testing
+
+import io.github.xxfast.kstore.Codec
+import io.github.xxfast.kstore.DefaultJson
+import kotlinx.serialization.KSerializer
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.StringFormat
+import kotlinx.serialization.serializer
+
+
+/**
+ * A codec that stores data in memory.
+ */
+public inline fun <reified T : @Serializable Any> InMemoryCodec(
+  format: StringFormat = DefaultJson,
+): InMemoryCodec<T> = InMemoryCodec(format, format.serializersModule.serializer())
+
+/**
+ * A codec that stores data in memory.
+ */
+public class InMemoryCodec<T : @Serializable Any>(
+  private val format: StringFormat,
+  private val serializer: KSerializer<T>
+) : Codec<T> {
+
+  private var storedData: String? = null
+
+  override suspend fun encode(value: T?) {
+    storedData = value?.let { format.encodeToString(serializer, it) }
+  }
+
+  override suspend fun decode(): T? = storedData?.let {
+    format.decodeFromString(serializer, it)
+  }
+
+}
diff --git a/kstore-testing/src/commonMain/kotlin/io/github/xxfast/kstore/testing/KStore.kt b/kstore-testing/src/commonMain/kotlin/io/github/xxfast/kstore/testing/KStore.kt
new file mode 100644
index 0000000..11dce77
--- /dev/null
+++ b/kstore-testing/src/commonMain/kotlin/io/github/xxfast/kstore/testing/KStore.kt
@@ -0,0 +1,25 @@
+package io.github.xxfast.kstore.testing
+
+import io.github.xxfast.kstore.DefaultJson
+import io.github.xxfast.kstore.KStore
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.StringFormat
+
+/**
+ * Creates a store with [InMemoryCodec]
+ *
+ * @param default returns this value if the record is not found. defaults to null
+ * @param enableCache maintain a cache. If set to false, it always reads from storage
+ * @param format Serializer to use. defaults to [DefaultJson]
+ *
+ * @return store that contains a value of type [T]
+ */
+public inline fun <reified T : @Serializable Any> testStoreOf(
+  default: T? = null,
+  enableCache: Boolean = true,
+  format: StringFormat = DefaultJson,
+): KStore<T> = KStore(
+  default = default,
+  enableCache = enableCache,
+  codec = InMemoryCodec(format)
+)
diff --git a/settings.gradle.kts b/settings.gradle.kts
index 92ffe25..eb39f2b 100644
--- a/settings.gradle.kts
+++ b/settings.gradle.kts
@@ -3,3 +3,4 @@ rootProject.name = "KStore"
 include(":kstore")
 include(":kstore-file")
 include(":kstore-storage")
+include(":kstore-testing")

From 1d16d070e277ebde05f36432f3089aa2d76d042b Mon Sep 17 00:00:00 2001
From: Shreyash Kore <kore.shreyash@gmail.com>
Date: Wed, 5 Mar 2025 23:08:31 +0530
Subject: [PATCH 2/3] add module in documentation and deployment script

---
 .github/workflows/build.yml | 2 +-
 README.md                   | 3 +++
 docs/topics/installation.md | 1 +
 kstore/build.gradle.kts     | 1 +
 4 files changed, 6 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index f1534ed..acbfd94 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -86,7 +86,7 @@ jobs:
     name: Release ${{ matrix.module }} to Sonatype
     strategy:
       matrix:
-        module: [kstore, kstore-file, kstore-storage]
+        module: [kstore, kstore-file, kstore-storage, kstore-testing]
     if: ${{ github.event_name != 'pull_request' }}
     runs-on: macos-latest
     needs:
diff --git a/README.md b/README.md
index 014b4df..5f7b3d3 100644
--- a/README.md
+++ b/README.md
@@ -49,6 +49,9 @@ kstore-file = { module = "io.github.xxfast:kstore-file", version.ref = "kstore"
 
 # for jsBrowser and wasmJsBrowser
 kstore-storage = { module = "io.github.xxfast:kstore-storage", version.ref = "kstore" }
+
+# for testing
+kstore-testing = { module = "io.github.xxfast:kstore-testing", version.ref = "kstore" }
 ```
 
 Depending on your target platforms, you will need to add platform configurations [here](https://xxfast.github.io/KStore/installation.html)
diff --git a/docs/topics/installation.md b/docs/topics/installation.md
index d0a99a6..a37d82e 100644
--- a/docs/topics/installation.md
+++ b/docs/topics/installation.md
@@ -19,6 +19,7 @@ kstore = "x.x.x"
 kstore = { module = "io.github.xxfast:kstore", version.ref = "kstore" }
 kstore-file = { module = "io.github.xxfast:kstore-file", version.ref = "kstore" }
 kstore-storage = { module = "io.github.xxfast:kstore-storage", version.ref = "kstore" }
+kstore-testing = { module = "io.github.xxfast:kstore-testing", version.ref = "kstore" }
 ```
 
 ### Targeting Android, iOS and/or Desktop 
diff --git a/kstore/build.gradle.kts b/kstore/build.gradle.kts
index 65001e8..db7836c 100644
--- a/kstore/build.gradle.kts
+++ b/kstore/build.gradle.kts
@@ -170,4 +170,5 @@ rootProject.tasks.withType<KotlinNpmInstallTask>().configureEach {
 dependencies {
   kover(project(":kstore-file"))
   kover(project(":kstore-storage"))
+  kover(project(":kstore-testing"))
 }
\ No newline at end of file

From 478270b0de7a99e56b2ee3ee9b97d92bb4b6e5bc Mon Sep 17 00:00:00 2001
From: Shreyash Kore <kore.shreyash@gmail.com>
Date: Wed, 19 Mar 2025 00:18:29 +0530
Subject: [PATCH 3/3] rename `kstore-testing` module to `kstore-test`

---
 .github/workflows/build.yml                                     | 2 +-
 README.md                                                       | 2 +-
 docs/topics/installation.md                                     | 2 +-
 {kstore-testing => kstore-test}/.gitignore                      | 0
 {kstore-testing => kstore-test}/build.gradle.kts                | 0
 .../kotlin/io/github/xxfast/kstore/test}/InMemoryCodec.kt       | 2 +-
 .../commonMain/kotlin/io/github/xxfast/kstore/test}/KStore.kt   | 2 +-
 kstore/build.gradle.kts                                         | 2 +-
 settings.gradle.kts                                             | 2 +-
 9 files changed, 7 insertions(+), 7 deletions(-)
 rename {kstore-testing => kstore-test}/.gitignore (100%)
 rename {kstore-testing => kstore-test}/build.gradle.kts (100%)
 rename {kstore-testing/src/commonMain/kotlin/io/github/xxfast/kstore/testing => kstore-test/src/commonMain/kotlin/io/github/xxfast/kstore/test}/InMemoryCodec.kt (95%)
 rename {kstore-testing/src/commonMain/kotlin/io/github/xxfast/kstore/testing => kstore-test/src/commonMain/kotlin/io/github/xxfast/kstore/test}/KStore.kt (95%)

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index acbfd94..6219da7 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -86,7 +86,7 @@ jobs:
     name: Release ${{ matrix.module }} to Sonatype
     strategy:
       matrix:
-        module: [kstore, kstore-file, kstore-storage, kstore-testing]
+        module: [kstore, kstore-file, kstore-storage, kstore-test]
     if: ${{ github.event_name != 'pull_request' }}
     runs-on: macos-latest
     needs:
diff --git a/README.md b/README.md
index 5f7b3d3..e584a74 100644
--- a/README.md
+++ b/README.md
@@ -51,7 +51,7 @@ kstore-file = { module = "io.github.xxfast:kstore-file", version.ref = "kstore"
 kstore-storage = { module = "io.github.xxfast:kstore-storage", version.ref = "kstore" }
 
 # for testing
-kstore-testing = { module = "io.github.xxfast:kstore-testing", version.ref = "kstore" }
+kstore-test = { module = "io.github.xxfast:kstore-test", version.ref = "kstore" }
 ```
 
 Depending on your target platforms, you will need to add platform configurations [here](https://xxfast.github.io/KStore/installation.html)
diff --git a/docs/topics/installation.md b/docs/topics/installation.md
index a37d82e..47a2821 100644
--- a/docs/topics/installation.md
+++ b/docs/topics/installation.md
@@ -19,7 +19,7 @@ kstore = "x.x.x"
 kstore = { module = "io.github.xxfast:kstore", version.ref = "kstore" }
 kstore-file = { module = "io.github.xxfast:kstore-file", version.ref = "kstore" }
 kstore-storage = { module = "io.github.xxfast:kstore-storage", version.ref = "kstore" }
-kstore-testing = { module = "io.github.xxfast:kstore-testing", version.ref = "kstore" }
+kstore-test = { module = "io.github.xxfast:kstore-test", version.ref = "kstore" }
 ```
 
 ### Targeting Android, iOS and/or Desktop 
diff --git a/kstore-testing/.gitignore b/kstore-test/.gitignore
similarity index 100%
rename from kstore-testing/.gitignore
rename to kstore-test/.gitignore
diff --git a/kstore-testing/build.gradle.kts b/kstore-test/build.gradle.kts
similarity index 100%
rename from kstore-testing/build.gradle.kts
rename to kstore-test/build.gradle.kts
diff --git a/kstore-testing/src/commonMain/kotlin/io/github/xxfast/kstore/testing/InMemoryCodec.kt b/kstore-test/src/commonMain/kotlin/io/github/xxfast/kstore/test/InMemoryCodec.kt
similarity index 95%
rename from kstore-testing/src/commonMain/kotlin/io/github/xxfast/kstore/testing/InMemoryCodec.kt
rename to kstore-test/src/commonMain/kotlin/io/github/xxfast/kstore/test/InMemoryCodec.kt
index c29d653..13e7401 100644
--- a/kstore-testing/src/commonMain/kotlin/io/github/xxfast/kstore/testing/InMemoryCodec.kt
+++ b/kstore-test/src/commonMain/kotlin/io/github/xxfast/kstore/test/InMemoryCodec.kt
@@ -1,4 +1,4 @@
-package io.github.xxfast.kstore.testing
+package io.github.xxfast.kstore.test
 
 import io.github.xxfast.kstore.Codec
 import io.github.xxfast.kstore.DefaultJson
diff --git a/kstore-testing/src/commonMain/kotlin/io/github/xxfast/kstore/testing/KStore.kt b/kstore-test/src/commonMain/kotlin/io/github/xxfast/kstore/test/KStore.kt
similarity index 95%
rename from kstore-testing/src/commonMain/kotlin/io/github/xxfast/kstore/testing/KStore.kt
rename to kstore-test/src/commonMain/kotlin/io/github/xxfast/kstore/test/KStore.kt
index 11dce77..293838b 100644
--- a/kstore-testing/src/commonMain/kotlin/io/github/xxfast/kstore/testing/KStore.kt
+++ b/kstore-test/src/commonMain/kotlin/io/github/xxfast/kstore/test/KStore.kt
@@ -1,4 +1,4 @@
-package io.github.xxfast.kstore.testing
+package io.github.xxfast.kstore.test
 
 import io.github.xxfast.kstore.DefaultJson
 import io.github.xxfast.kstore.KStore
diff --git a/kstore/build.gradle.kts b/kstore/build.gradle.kts
index db7836c..3595ac9 100644
--- a/kstore/build.gradle.kts
+++ b/kstore/build.gradle.kts
@@ -170,5 +170,5 @@ rootProject.tasks.withType<KotlinNpmInstallTask>().configureEach {
 dependencies {
   kover(project(":kstore-file"))
   kover(project(":kstore-storage"))
-  kover(project(":kstore-testing"))
+  kover(project(":kstore-test"))
 }
\ No newline at end of file
diff --git a/settings.gradle.kts b/settings.gradle.kts
index eb39f2b..860e28d 100644
--- a/settings.gradle.kts
+++ b/settings.gradle.kts
@@ -3,4 +3,4 @@ rootProject.name = "KStore"
 include(":kstore")
 include(":kstore-file")
 include(":kstore-storage")
-include(":kstore-testing")
+include(":kstore-test")