add kotlin serialization support for Id and RawId

Author: Adrian Tosca

README.md

@@ -1,6 +1,6 @@
 # typeid-kotlin
 ![Build Status](https://github.com/aleris/typeid-kotlin/actions/workflows/build-on-push.yml/badge.svg)
-![Current Version](https://img.shields.io/badge/Version-0.0.9-blue)
+![Current Version](https://img.shields.io/badge/Version--blue)
 
 
 ## A Kotlin implementation of [TypeID](https://github.com/jetpack-io/typeid).
@@ -25,14 +25,14 @@ To use with Maven:
 <dependency>
     <groupId>earth.adi</groupId>
     <artifactId>typeid-kotlin</artifactId>
-    <version>0.0.9</version>
+    <version></version>
 </dependency>
 ```
 
 To use via Gradle:
 
 ```kotlin
-implementation("earth.adi:typeid-kotlin:0.0.9")
+implementation("earth.adi:typeid-kotlin:")
 ```
 
 

build.gradle.kts

@@ -4,6 +4,7 @@ import org.gradle.api.tasks.testing.logging.TestLogEvent.*
 plugins {
   `java-library`
   alias(libs.plugins.kotlinJvm)
+  alias(libs.plugins.kotlinSerialization)
   alias(libs.plugins.spotless)
   jacoco
   alias(libs.plugins.jmh)
@@ -14,17 +15,19 @@ plugins {
 
 group = "earth.adi"
 
-version = "0.0.9"
+version = "0.0.10"
 
 repositories { mavenCentral() }
 
 dependencies {
   implementation(libs.javaUuidGenerator)
   implementation(platform(libs.jacksonBom))
   implementation(libs.bundles.jackson)
+  implementation(libs.kotlinxSerializationCore)
 
   testImplementation(platform(libs.junitBom))
   testImplementation(libs.bundles.test)
+  testImplementation(libs.kotlinxSerializationCbor)
 }
 
 kotlin { jvmToolchain(17) }
@@ -83,15 +86,43 @@ tasks.test {
 }
 
 tasks.withType<JacocoReport> {
+  afterEvaluate {
+    classDirectories.setFrom(
+        files(
+            classDirectories.files.map {
+              fileTree(it).apply {
+                exclude("**/**/*serializer*.*") // kotlinx.serialization
+              }
+            }))
+  }
+
   doLast { println("JaCoCo report: file://" + reports.html.entryPoint) }
 }
 
 tasks.jacocoTestReport { dependsOn(tasks.test) }
 
-tasks.jacocoTestCoverageVerification {
+tasks.withType<JacocoCoverageVerification> {
   dependsOn(tasks.jacocoTestReport)
 
-  violationRules { rule { limit { minimum = "1.00".toBigDecimal() } } }
+  violationRules {
+    rule { limit { minimum = "1.00".toBigDecimal() } }
+    rule {
+      limit {
+        counter = "BRANCH"
+        minimum = "1.00".toBigDecimal()
+      }
+    }
+  }
+
+  afterEvaluate {
+    classDirectories.setFrom(
+        files(
+            classDirectories.files.map {
+              fileTree(it).apply {
+                exclude("**/**/*serializer*.*") // kotlinx.serialization
+              }
+            }))
+  }
 }
 
 jmh {

gradle/libs.versions.toml

@@ -9,10 +9,12 @@ jmh = "0.7.2"
 jqwik = "1.8.4"
 jreleaser = "1.12.0"
 dokka = "1.9.20"
+kotlinxSerialization = "1.6.3"
 
 [plugins]
 jmh = { id = "me.champeau.jmh", version.ref = "jmh" }
 kotlinJvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }
+kotlinSerialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" }
 spotless = { id = "com.diffplug.spotless", version.ref = "spotless" }
 jreleaser = { id = "org.jreleaser", version.ref = "jreleaser" }
 dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }
@@ -22,6 +24,8 @@ javaUuidGenerator = { module = "com.fasterxml.uuid:java-uuid-generator", version
 jacksonBom = { module = "com.fasterxml.jackson:jackson-bom", version.ref = "jackson" }
 jacksonDatabind = { module = "com.fasterxml.jackson.core:jackson-databind" }
 jacksonModuleKotlin = { module = "com.fasterxml.jackson.module:jackson-module-kotlin" }
+kotlinxSerializationCore = { module = "org.jetbrains.kotlinx:kotlinx-serialization-core", version.ref = "kotlinxSerialization" }
+kotlinxSerializationCbor = { module = "org.jetbrains.kotlinx:kotlinx-serialization-cbor", version.ref = "kotlinxSerialization" }
 
 junitBom = { module = "org.junit:junit-bom", version.ref = "junit" }
 junitJupiterEngine = { module = "org.junit.jupiter:junit-jupiter-engine" }

src/main/java/module-info.java

@@ -5,6 +5,7 @@
   requires com.fasterxml.uuid;
   requires com.fasterxml.jackson.databind;
   requires kotlin.stdlib;
+  requires kotlinx.serialization.core;
 
   exports earth.adi.typeid;
 }

src/main/kotlin/earth/adi/typeid/Id.kt

@@ -1,6 +1,7 @@
 package earth.adi.typeid
 
 import earth.adi.typeid.codec.Codec
+import earth.adi.typeid.serialization.UUIDKSerializer
 import java.io.Serializable
 import java.util.*
 
@@ -37,7 +38,11 @@ import java.util.*
  * @property typedPrefix the typed prefix of the identifier
  * @property uuid the uuid of the identifier
  */
-data class Id<TEntity>(val typedPrefix: TypedPrefix<out TEntity>, val uuid: UUID) : Serializable {
+@kotlinx.serialization.Serializable
+data class Id<TEntity>(
+    val typedPrefix: TypedPrefix<out TEntity>,
+    @kotlinx.serialization.Serializable(with = UUIDKSerializer::class) val uuid: UUID,
+) : Serializable {
   init {
     Codec.requireValidPrefix(typedPrefix.prefix)
   }

src/main/kotlin/earth/adi/typeid/RawId.kt

@@ -1,6 +1,7 @@
 package earth.adi.typeid
 
 import earth.adi.typeid.codec.Codec
+import earth.adi.typeid.serialization.UUIDKSerializer
 import java.io.Serializable
 import java.util.UUID
 
@@ -11,7 +12,11 @@ import java.util.UUID
  * @property prefix the prefix of the identifier
  * @property uuid the uuid of the identifier
  */
-data class RawId(val prefix: String, val uuid: UUID) : Serializable {
+@kotlinx.serialization.Serializable
+data class RawId(
+    val prefix: String,
+    @kotlinx.serialization.Serializable(with = UUIDKSerializer::class) val uuid: UUID,
+) : Serializable {
   init {
     Codec.requireValidPrefix(prefix)
   }

src/main/kotlin/earth/adi/typeid/TypedPrefix.kt

@@ -3,4 +3,5 @@ package earth.adi.typeid
 import java.io.Serializable
 
 /** Typed prefix for a type id. */
+@kotlinx.serialization.Serializable
 data class TypedPrefix<TEntity>(val prefix: String) : Serializable

src/main/kotlin/earth/adi/typeid/jackson/IdJsonSerializer.kt

@@ -16,6 +16,10 @@ class IdJsonSerializer @JvmOverloads constructor(t: Class<Id<*>?>? = null) :
     StdSerializer<Id<*>?>(t) {
   @Throws(IOException::class, JsonProcessingException::class)
   override fun serialize(value: Id<*>?, jgen: JsonGenerator, provider: SerializerProvider?) {
-    jgen.writeString(value?.toString() ?: "")
+    if (value == null) {
+      jgen.writeNull()
+      return
+    }
+    jgen.writeString(value.toString())
   }
 }

src/main/kotlin/earth/adi/typeid/jackson/RawIdJsonSerializer.kt

@@ -16,6 +16,10 @@ class RawIdJsonSerializer @JvmOverloads constructor(t: Class<RawId?>? = null) :
     StdSerializer<RawId?>(t) {
   @Throws(IOException::class, JsonProcessingException::class)
   override fun serialize(value: RawId?, jgen: JsonGenerator, provider: SerializerProvider?) {
-    jgen.writeString(value?.toString() ?: "")
+    if (value == null) {
+      jgen.writeNull()
+      return
+    }
+    jgen.writeString(value.toString())
   }
 }

src/main/kotlin/earth/adi/typeid/serialization/UUIDKSerializer.kt

@@ -0,0 +1,20 @@
+package earth.adi.typeid.serialization
+
+import java.util.*
+import kotlinx.serialization.KSerializer
+import kotlinx.serialization.descriptors.PrimitiveKind
+import kotlinx.serialization.descriptors.PrimitiveSerialDescriptor
+import kotlinx.serialization.encoding.Decoder
+import kotlinx.serialization.encoding.Encoder
+
+object UUIDKSerializer : KSerializer<UUID> {
+  override val descriptor = PrimitiveSerialDescriptor("UUID", PrimitiveKind.STRING)
+
+  override fun deserialize(decoder: Decoder): UUID {
+    return UUID.fromString(decoder.decodeString())
+  }
+
+  override fun serialize(encoder: Encoder, value: UUID) {
+    encoder.encodeString(value.toString())
+  }
+}

src/test/kotlin/earth/adi/typeid/IdTest.kt

@@ -3,7 +3,11 @@ package earth.adi.typeid
 import java.io.ByteArrayOutputStream
 import java.io.ObjectInputStream
 import java.io.ObjectOutputStream
-import java.util.*
+import java.util.UUID
+import kotlinx.serialization.ExperimentalSerializationApi
+import kotlinx.serialization.cbor.Cbor
+import kotlinx.serialization.decodeFromByteArray
+import kotlinx.serialization.encodeToByteArray
 import org.assertj.core.api.Assertions.assertThat
 import org.assertj.core.api.Assertions.assertThatThrownBy
 import org.junit.jupiter.api.Test
@@ -35,7 +39,7 @@ class IdTest {
   }
 
   @Test
-  fun `test serialization deserialization`() {
+  fun `test java serialization deserialization`() {
     val uuid = UUID.fromString("00000000-0000-0000-0000-000000000000")
     val id = Id<String>(TypedPrefix("user"), uuid)
     ByteArrayOutputStream().use { outputStream ->
@@ -46,4 +50,14 @@ class IdTest {
       }
     }
   }
+
+  @OptIn(ExperimentalSerializationApi::class)
+  @Test
+  fun `test kotlin serialization deserialization`() {
+    val uuid = UUID.fromString("00000000-0000-0000-0000-000000000000")
+    val id = Id<String>(TypedPrefix("user"), uuid)
+    val bytes = Cbor.encodeToByteArray<Id<String>>(id)
+    val deserialized = Cbor.decodeFromByteArray<Id<String>>(bytes)
+    assertThat(deserialized).isEqualTo(id)
+  }
 }

src/test/kotlin/earth/adi/typeid/RawIdTest.kt

@@ -4,8 +4,11 @@ import java.io.ByteArrayOutputStream
 import java.io.ObjectInputStream
 import java.io.ObjectOutputStream
 import java.util.*
+import kotlinx.serialization.ExperimentalSerializationApi
+import kotlinx.serialization.cbor.Cbor
+import kotlinx.serialization.decodeFromByteArray
+import kotlinx.serialization.encodeToByteArray
 import org.assertj.core.api.Assertions.assertThat
-import org.junit.jupiter.api.Assertions.*
 import org.junit.jupiter.api.Test
 
 class RawIdTest {
@@ -33,4 +36,14 @@ class RawIdTest {
       }
     }
   }
+
+  @OptIn(ExperimentalSerializationApi::class)
+  @Test
+  fun `test kotlin serialization deserialization`() {
+    val uuid = UUID.fromString("00000000-0000-0000-0000-000000000000")
+    val id = RawId("user", uuid)
+    val bytes = Cbor.encodeToByteArray<RawId>(id)
+    val deserialized = Cbor.decodeFromByteArray<RawId>(bytes)
+    assertThat(deserialized).isEqualTo(id)
+  }
 }

src/test/kotlin/earth/adi/typeid/CodecPropertyTest.kt renamed to src/test/kotlin/earth/adi/typeid/codec/CodecPropertyTest.kt

@@ -1,7 +1,5 @@
-package earth.adi.typeid
+package earth.adi.typeid.codec
 
-import earth.adi.typeid.codec.Codec
-import earth.adi.typeid.codec.Decoded
 import java.util.*
 import net.jqwik.api.*
 import net.jqwik.api.constraints.LowerChars

src/test/kotlin/earth/adi/typeid/CodecSpecTest.kt renamed to src/test/kotlin/earth/adi/typeid/codec/CodecSpecTest.kt

@@ -1,10 +1,8 @@
-package earth.adi.typeid
+package earth.adi.typeid.codec
 
 import com.fasterxml.jackson.annotation.JsonAutoDetect
 import com.fasterxml.jackson.databind.ObjectMapper
 import com.fasterxml.jackson.dataformat.yaml.YAMLFactory
-import earth.adi.typeid.codec.Codec
-import earth.adi.typeid.codec.Decoded
 import java.util.*
 import java.util.stream.Stream
 import org.assertj.core.api.Assertions.assertThat

src/test/kotlin/earth/adi/typeid/CodecValidationsTest.kt renamed to src/test/kotlin/earth/adi/typeid/codec/CodecValidationsTest.kt

@@ -1,7 +1,7 @@
-package earth.adi.typeid
+package earth.adi.typeid.codec
 
-import earth.adi.typeid.codec.Codec
-import earth.adi.typeid.codec.Decoded
+import earth.adi.typeid.TypeId
+import earth.adi.typeid.Validated
 import java.util.*
 import java.util.stream.Stream
 import org.assertj.core.api.Assertions.*
@@ -71,6 +71,7 @@ class CodecValidationsTest {
               "sömeprefix_01h455vb4pex5vsknk084sn02q", // prefix with 'ö'
               "someprefix_01h455öb4pex5vsknk084sn02q", // suffix with 'ö'
               "someprefix_Ă01h455b4pex5vsknk084sn02q", // suffix with 'Ă' (> ascii 255) as first
+              "someprefix_/01h455b4pex5vsknk084sn02q", // suffix with '/' (< ascii '0') as first
               // char
               "sOmeprefix_01h455vb4pex5vsknk084sn02q", // prefix with 'O'
               "someprefix_01h455Vb4pex5vsknk084sn02q", // suffix with 'V'

src/test/kotlin/earth/adi/typeid/JacksonJsonTest.kt renamed to src/test/kotlin/earth/adi/typeid/jackson/JacksonJsonTest.kt

@@ -1,13 +1,11 @@
-package earth.adi.typeid
+package earth.adi.typeid.jackson
 
 import com.fasterxml.jackson.annotation.JsonProperty
 import com.fasterxml.jackson.databind.BeanProperty
 import com.fasterxml.jackson.databind.PropertyName
 import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
 import com.fasterxml.jackson.module.kotlin.readValue
-import earth.adi.typeid.jackson.IdJsonDeserializer
-import earth.adi.typeid.jackson.IdJsonSerializer
-import earth.adi.typeid.jackson.RawIdJsonSerializer
+import earth.adi.typeid.*
 import java.io.ByteArrayOutputStream
 import org.assertj.core.api.Assertions.assertThat
 import org.junit.jupiter.api.Test