add json serialization support for 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.6-blue)
+![Current Version](https://img.shields.io/badge/Version-0.0.7-blue)
 
 
 ## A Kotlin implementation of [TypeID](https://github.com/jetpack-io/typeid).
@@ -23,14 +23,14 @@ To use with Maven:
 <dependency>
     <groupId>earth.adi</groupId>
     <artifactId>typeid-kotlin</artifactId>
-    <version>0.0.6</version>
+    <version>0.0.7</version>
 </dependency>
 ```
 
 To use via Gradle:
 
 ```kotlin
-implementation("earth.adi:typeid-kotlin:0.0.6")
+implementation("earth.adi:typeid-kotlin:0.0.7")
 ```
 
 

build.gradle.kts

@@ -14,7 +14,7 @@ plugins {
 
 group = "earth.adi"
 
-version = "0.0.6"
+version = "0.0.7"
 
 repositories { mavenCentral() }
 

src/main/java/earth/adi/typeid/JavaType.java

@@ -4,6 +4,9 @@
  * JavaType.
  */
 public class JavaType {
+  /**
+   * Create a new JavaType instance.
+   */
   public static JavaType of(Class<?> clazz) {
     return new JavaType(clazz);
   }
@@ -14,6 +17,9 @@ private JavaType(Class<?> clazz) {
     this.clazz = clazz;
   }
 
+  /**
+   * Get the clazz.
+   */
   public Class<?> getClazz() {
     return clazz;
   }

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

@@ -29,6 +29,9 @@ import java.util.*
  * }
  * ```
  *
+ * It is possible to create an `Id` directly, but it is recommended to use the `TypeId` factory
+ * methods.
+ *
  * @param TEntity the type of the associated entity with the identifier
  * @constructor Creates a new typed identifier with the specified [typedPrefix] and [uuid].
  * @property typedPrefix the typed prefix of the identifier

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

@@ -9,6 +9,12 @@ import earth.adi.typeid.Id
 import earth.adi.typeid.TypeId
 import java.io.IOException
 
+/**
+ * A Jackson deserializer for [Id] objects.
+ *
+ * @param typeId the type id instance to use for parsing the id
+ * @param valueType value type of the id
+ */
 class IdJsonDeserializer
 @JvmOverloads
 constructor(private val typeId: TypeId, valueType: JavaType? = null) :

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

@@ -7,10 +7,15 @@ import com.fasterxml.jackson.databind.ser.std.StdSerializer
 import earth.adi.typeid.Id
 import java.io.IOException
 
+/**
+ * A Jackson serializer for [Id] objects.
+ *
+ * @param t type of the id
+ */
 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())
+    jgen.writeString(value?.toString() ?: "")
   }
 }

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

@@ -0,0 +1,18 @@
+package earth.adi.typeid.jackson
+
+import com.fasterxml.jackson.core.JsonParser
+import com.fasterxml.jackson.core.JsonProcessingException
+import com.fasterxml.jackson.databind.*
+import com.fasterxml.jackson.databind.deser.std.StdDeserializer
+import earth.adi.typeid.RawId
+import earth.adi.typeid.TypeId
+import java.io.IOException
+
+/** A Jackson deserializer for [RawId] objects. */
+class RawIdJsonDeserializer : StdDeserializer<RawId?>(RawId::class.java) {
+  @Throws(IOException::class, JsonProcessingException::class)
+  override fun deserialize(jp: JsonParser, ctxt: DeserializationContext?): RawId {
+    val id = jp.codec.readValue(jp, String::class.java)
+    return TypeId.parse(id)
+  }
+}

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

@@ -0,0 +1,21 @@
+package earth.adi.typeid.jackson
+
+import com.fasterxml.jackson.core.JsonGenerator
+import com.fasterxml.jackson.core.JsonProcessingException
+import com.fasterxml.jackson.databind.SerializerProvider
+import com.fasterxml.jackson.databind.ser.std.StdSerializer
+import earth.adi.typeid.RawId
+import java.io.IOException
+
+/**
+ * A Jackson serializer for [RawId] objects.
+ *
+ * @param t type of the id
+ */
+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() ?: "")
+  }
+}

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

@@ -3,12 +3,26 @@ package earth.adi.typeid.jackson
 import com.fasterxml.jackson.core.Version
 import com.fasterxml.jackson.databind.module.SimpleModule
 import earth.adi.typeid.Id
+import earth.adi.typeid.RawId
 import earth.adi.typeid.TypeId
 
+/**
+ * Jackson module for serializing and deserializing [Id] and [RawId] objects.
+ *
+ * To use the module:
+ * ```
+ * private val objectMapper = jacksonObjectMapper().registerModule(typeId.jacksonModule())
+ * ```
+ *
+ * @param typeId the type id instance to use for parsing the id
+ */
 class TypeIdModule(typeId: TypeId) : SimpleModule() {
   init {
     addSerializer(Id::class.java, IdJsonSerializer())
     addDeserializer(Id::class.java, IdJsonDeserializer(typeId))
+
+    addSerializer(RawId::class.java, RawIdJsonSerializer())
+    addDeserializer(RawId::class.java, RawIdJsonDeserializer())
   }
 
   override fun version(): Version {

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

@@ -6,6 +6,9 @@ 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 java.io.ByteArrayOutputStream
 import org.assertj.core.api.Assertions.assertThat
 import org.junit.jupiter.api.Test
 
@@ -77,6 +80,29 @@ class JacksonJsonTest {
     assertThat(writtenJson).isEqualTo(JSON_IDS_ONLY)
   }
 
+  data class RawIds(
+      @JsonProperty("user_id") val userId: RawId,
+      @JsonProperty("org_id") val organizationId: RawId,
+  )
+
+  @Test
+  fun `deserialize raw ids from json`() {
+    val json = objectMapper.readValue<RawIds>(JSON_IDS_ONLY)
+    assertThat(json.userId).isEqualTo(typeId.parse("user_01hy0d96sgfx0rh975kqkspchh"))
+    assertThat(json.organizationId).isEqualTo(typeId.parse("org_01hy0sk45qfmdsdme1j703yjet"))
+  }
+
+  @Test
+  fun `serialize raw ids to json`() {
+    val json =
+        RawIds(
+            typeId.parse("user_01hy0d96sgfx0rh975kqkspchh"),
+            typeId.parse("org_01hy0sk45qfmdsdme1j703yjet"),
+        )
+    val writtenJson = objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(json)
+    assertThat(writtenJson).isEqualTo(JSON_IDS_ONLY)
+  }
+
   @Test
   fun `create IdJsonDeserializer null deserializerContext`() {
     val type = objectMapper.constructType(Id::class.java)
@@ -101,6 +127,22 @@ class JacksonJsonTest {
     assertThat(idJsonDeserializer.valueType).isNull()
   }
 
+  @Test
+  fun `IdJsonSerializer null id`() {
+    ByteArrayOutputStream().use { outputStream ->
+      IdJsonSerializer().serialize(null, objectMapper.createGenerator(outputStream), null)
+      assertThat(outputStream.toString()).isEqualTo("")
+    }
+  }
+
+  @Test
+  fun `RawIdJsonSerializer null id`() {
+    ByteArrayOutputStream().use { outputStream ->
+      RawIdJsonSerializer().serialize(null, objectMapper.createGenerator(outputStream), null)
+      assertThat(outputStream.toString()).isEqualTo("")
+    }
+  }
+
   companion object {
     private val JSON_USER =
         """