Merge pull request #141 from what3words/task/add-serialization-w3wmarkercolor

Make W3WMarkerColor serializable

Author: phpduy

gradle/libs.versions.toml

@@ -9,6 +9,7 @@ androidGradlePlugin = "8.8.2"
 autonomousappsAnalysis = "1.20.0"
 gradleKtlint = "10.1.0"
 jreleaser = "1.17.0"
+kotlinxSerialization = "1.7.3"
 
 #Kotlin
 kotlin = "2.1.0"
@@ -57,6 +58,7 @@ kotlinx-collections-immutable = { module = "org.jetbrains.kotlinx:kotlinx-collec
 kotlinx-coroutines-android = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-android", version.ref = "kotlinxCoroutinesAndroid" }
 kotlinx-coroutines-core = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "kotlinxCoroutinesCore" }
 kotlinx-coroutines-test = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-test", version.ref = "kotlinxCoroutinesTest" }
+kotlinx-serialization-json = { module = "org.jetbrains.kotlinx:kotlinx-serialization-json", version.ref = "kotlinxSerialization" }
 ktlint-gradle = { module = "org.jlleitschuh.gradle:ktlint-gradle", version.ref = "gradleKtlint" }
 kotlin-gradle-plugin = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin" }
 
@@ -105,6 +107,7 @@ android-library = { id = "com.android.library", version.ref = "androidGradlePlug
 gradle-ktlint = { id = "org.jlleitschuh.gradle.ktlint", version.ref = "gradleKtlint" }
 autonomousapps-analysis = { id = "com.autonomousapps.dependency-analysis", version.ref = "autonomousappsAnalysis" }
 kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" }
+kotlin-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" }
 compose-compiler = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" }
 dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }
 maven-publish = { id = "maven-publish" }

lib-compose/build.gradle.kts

@@ -4,6 +4,7 @@ import java.util.Base64
 plugins {
     alias(libs.plugins.android.library)
     alias(libs.plugins.kotlin.android)
+    alias(libs.plugins.kotlin.serialization)
     id(libs.plugins.maven.publish.get().pluginId)
     id(libs.plugins.signing.get().pluginId)
     alias(libs.plugins.dokka)
@@ -152,6 +153,7 @@ dependencies {
     implementation(libs.kotlinx.coroutines.android)
     testImplementation(libs.kotlinx.coroutines.test)
     api(libs.kotlinx.collections.immutable)
+    api(libs.kotlinx.serialization.json)
 
     // Compose
     implementation(platform(libs.androidx.compose.bom))

lib-compose/src/main/java/com/what3words/components/compose/maps/models/W3WMarker.kt

@@ -7,6 +7,13 @@ import androidx.compose.ui.graphics.Color
 import androidx.compose.ui.graphics.toArgb
 import com.what3words.core.types.geometry.W3WCoordinates
 import com.what3words.core.types.geometry.W3WRectangle
+import kotlinx.serialization.KSerializer
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.descriptors.PrimitiveKind
+import kotlinx.serialization.descriptors.PrimitiveSerialDescriptor
+import kotlinx.serialization.descriptors.SerialDescriptor
+import kotlinx.serialization.encoding.Decoder
+import kotlinx.serialization.encoding.Encoder
 
 /**
  * Represents a marker on a map, associated with a what3words address.
@@ -89,9 +96,12 @@ data class W3WMarker(
  * @property slash The color of the slash in the marker.
  * @property id A unique identifier generated from the combination of background and slash colors.
  */
+@Serializable
 @Immutable
 data class W3WMarkerColor(
+    @Serializable(with = ColorSerializer::class)
     val background: Color,
+    @Serializable(with = ColorSerializer::class)
     val slash: Color
 ) {
     val id: Long
@@ -100,4 +110,16 @@ data class W3WMarkerColor(
             val slashLong = slash.toArgb().toLong() and 0xFFFFFFFFL
             return (backgroundLong shl 32) or slashLong
         }
+}
+
+object ColorSerializer : KSerializer<Color> {
+    override val descriptor: SerialDescriptor = PrimitiveSerialDescriptor("Color", PrimitiveKind.LONG)
+
+    override fun serialize(encoder: Encoder, value: Color) {
+        encoder.encodeLong(value.value.toLong())
+    }
+
+    override fun deserialize(decoder: Decoder): Color {
+        return Color(decoder.decodeLong().toULong())
+    }
 }