feat: serialization module

README.md

@@ -114,6 +114,27 @@ counter.isValid()
 counter.messages()
 ```
 
+### Serialization
+
+A value manager can be encoded or decoded using Kotlin Serialization and `serialization` module.
+It is a good use case whether you have model shared with serialization infrastructure as network requests
+
+```kotlin
+import dev.programadorthi.state.serialization.ValueManager // Not from core package
+
+@Serializable
+data class MyClass(
+    val count: ValueManager<Int>,
+)
+
+val data = MyClass(count = basicValueManager(1))
+val json = Json.encodeToString(data)
+println(json) // {"count": 1}
+
+val decoded = Json.decodeFromString<MyClass>(json)
+println(data == decoded) // true
+```
+
 ### State Restoration
 
 #### Compose

core/build.gradle.kts

@@ -1,6 +1,5 @@
 plugins {
     kotlin("multiplatform")
-    kotlin("plugin.serialization")
     id("com.android.library")
     id("com.vanniktech.maven.publish")
 }
@@ -15,18 +14,6 @@ kotlin {
     }
 
     sourceSets {
-        commonMain {
-            dependencies {
-                implementation("org.jetbrains.kotlinx:kotlinx-serialization-core:1.6.3")
-            }
-        }
-
-        commonTest {
-            dependencies {
-                implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.6.3")
-            }
-        }
-
         androidMain {
             dependencies {
                 implementation("androidx.activity:activity-ktx:1.8.2")

core/common/src/dev/programadorthi/state/core/ValueManager.kt

@@ -4,11 +4,8 @@ import dev.programadorthi.state.core.action.ChangeAction
 import dev.programadorthi.state.core.action.CollectAction
 import dev.programadorthi.state.core.action.ErrorAction
 import dev.programadorthi.state.core.action.UpdateAction
-import dev.programadorthi.state.core.serialization.ValueManagerSerializer
-import kotlinx.serialization.Serializable
 
 @OptIn(ExperimentalStdlibApi::class)
-@Serializable(with = ValueManagerSerializer::class)
 public interface ValueManager<T> : AutoCloseable {
     public val closed: Boolean
 

core/common/test/dev/programadorthi/state/core/ValueManagerTest.kt

@@ -4,8 +4,6 @@ import dev.programadorthi.state.core.extension.basicValueManager
 import dev.programadorthi.state.core.extension.getValue
 import dev.programadorthi.state.core.extension.setValue
 import dev.programadorthi.state.core.validation.Validator
-import kotlinx.serialization.encodeToString
-import kotlinx.serialization.json.Json
 import kotlin.random.Random
 import kotlin.test.Test
 import kotlin.test.assertContentEquals
@@ -191,25 +189,4 @@ internal class ValueManagerTest {
         assertEquals("Value -1 should be positive", manager.messages.first())
         assertEquals(0, manager.value, "Value should be equals to initial value")
     }
-
-    @Test
-    fun shouldSerializeAndDeserialize() {
-        val data = SerializableValueManager(
-            intValue = basicValueManager(1),
-            stringValue = basicValueManager("valueManager"),
-            color = basicValueManager(Color("red")),
-            composite = basicValueManager(
-                basicValueManager(listOf(Color("blue"), Color("green")))
-            )
-        )
-        val json = Json.encodeToString(data)
-        println(json)
-        val decoded = Json.decodeFromString<SerializableValueManager>(json)
-
-        assertEquals(
-            """{"intValue":1,"stringValue":"valueManager","color":{"name":"red"},"composite":[{"name":"blue"},{"name":"green"}]}""",
-            json
-        )
-        assertEquals(data, decoded)
-    }
 }

serialization/build.gradle.kts

@@ -0,0 +1,26 @@
+plugins {
+    kotlin("multiplatform")
+    kotlin("plugin.serialization")
+    id("com.vanniktech.maven.publish")
+}
+
+applyBasicSetup()
+
+darwinTargetsFramework()
+
+kotlin {
+    sourceSets {
+        commonMain {
+            dependencies {
+                api(project(":core"))
+                implementation("org.jetbrains.kotlinx:kotlinx-serialization-core:1.6.3")
+            }
+        }
+
+        commonTest {
+            dependencies {
+                implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.6.3")
+            }
+        }
+    }
+}

serialization/common/src/dev/programadorthi/state/serialization/ValueManagerSerializable.kt

@@ -0,0 +1,6 @@
+package dev.programadorthi.state.serialization
+
+import dev.programadorthi.state.core.ValueManager
+import kotlinx.serialization.Serializable
+
+public typealias ValueManager<T> = @Serializable(with = ValueManagerSerializer::class) ValueManager<T>

core/common/src/dev/programadorthi/state/core/serialization/ValueManagerSerializer.kt → serialization/common/src/dev/programadorthi/state/serialization/ValueManagerSerializer.kt

@@ -1,4 +1,4 @@
-package dev.programadorthi.state.core.serialization
+package dev.programadorthi.state.serialization
 
 import dev.programadorthi.state.core.ValueManager
 import dev.programadorthi.state.core.extension.basicValueManager

core/common/test/dev/programadorthi/state/core/SerializableValueManager.kt → serialization/common/test/dev/programadorthi/state/serialization/SerializableValueManager.kt

@@ -1,4 +1,4 @@
-package dev.programadorthi.state.core
+package dev.programadorthi.state.serialization
 
 import kotlinx.serialization.Serializable
 

serialization/common/test/dev/programadorthi/state/serialization/SerializableValueManagerTest.kt

@@ -0,0 +1,31 @@
+package dev.programadorthi.state.serialization
+
+import dev.programadorthi.state.core.extension.basicValueManager
+import kotlin.test.Test
+import kotlin.test.assertEquals
+import kotlinx.serialization.encodeToString
+import kotlinx.serialization.json.Json
+
+internal class SerializableValueManagerTest {
+
+    @Test
+    fun shouldSerializeAndDeserialize() {
+        val data = SerializableValueManager(
+            intValue = basicValueManager(1),
+            stringValue = basicValueManager("valueManager"),
+            color = basicValueManager(Color("red")),
+            composite = basicValueManager(
+                basicValueManager(listOf(Color("blue"), Color("green")))
+            )
+        )
+        val json = Json.encodeToString(data)
+        val decoded = Json.decodeFromString<SerializableValueManager>(json)
+
+        assertEquals(
+            """{"intValue":1,"stringValue":"valueManager","color":{"name":"red"},"composite":[{"name":"blue"},{"name":"green"}]}""",
+            json
+        )
+        assertEquals(data, decoded)
+    }
+
+}

serialization/gradle.properties

@@ -0,0 +1,2 @@
+POM_NAME=Serialization
+POM_ARTIFACT_ID=serialization

settings.gradle.kts

@@ -22,6 +22,7 @@ rootProject.name = "kotlin-state-manager"
 include("compose")
 include("core")
 include("coroutines")
+include("serialization")
 include("validators")
 
 include(":samples:compose:norris-facts:android")