-
Notifications
You must be signed in to change notification settings - Fork 50
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add YamlContentPolymorphicSerializer
- Loading branch information
Showing
3 changed files
with
248 additions
and
6 deletions.
There are no files selected for viewing
41 changes: 41 additions & 0 deletions
41
src/commonMain/kotlin/com/charleskorn/kaml/YamlContentPolymorphicSerializer.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| package com.charleskorn.kaml | ||
|
|
||
| import kotlinx.serialization.* | ||
| import kotlinx.serialization.descriptors.PolymorphicKind | ||
| import kotlinx.serialization.descriptors.SerialDescriptor | ||
| import kotlinx.serialization.descriptors.buildSerialDescriptor | ||
| import kotlinx.serialization.encoding.Decoder | ||
| import kotlinx.serialization.encoding.Encoder | ||
| import kotlin.reflect.KClass | ||
|
|
||
| @OptIn(ExperimentalSerializationApi::class) | ||
| public abstract class YamlContentPolymorphicSerializer<T : Any>(private val baseClass: KClass<T>) : KSerializer<T> { | ||
| @OptIn(InternalSerializationApi::class) | ||
| override val descriptor: SerialDescriptor = buildSerialDescriptor( | ||
| "${YamlContentPolymorphicSerializer::class.simpleName}<${baseClass.simpleName}>", | ||
| PolymorphicKind.SEALED | ||
| ) | ||
|
|
||
| @OptIn(InternalSerializationApi::class) | ||
| override fun serialize(encoder: Encoder, value: T) { | ||
| val actualSerializer = encoder.serializersModule.getPolymorphic(baseClass, value) | ||
| ?: value::class.serializerOrNull() | ||
| ?: throwSubtypeNotRegistered(value::class, baseClass) | ||
| @Suppress("UNCHECKED_CAST") | ||
| (actualSerializer as KSerializer<T>).serialize(encoder, value) | ||
| } | ||
|
|
||
| override fun deserialize(decoder: Decoder): T { | ||
| return decoder.decodeSerializableValue(selectDeserializer((decoder as YamlInput).node)) | ||
| } | ||
|
|
||
| public abstract fun selectDeserializer(node: YamlNode): DeserializationStrategy<T> | ||
|
|
||
| private fun throwSubtypeNotRegistered(subClass: KClass<*>, baseClass: KClass<*>): Nothing { | ||
| val subClassName = subClass.simpleName ?: "$subClass" | ||
| throw SerializationException(""" | ||
| Class '${subClassName}' is not registered for polymorphic serialization in the scope of '${baseClass.simpleName}'. | ||
| Mark the base class as 'sealed' or register the serializer explicitly. | ||
| """.trimIndent()) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
192 changes: 192 additions & 0 deletions
192
src/commonTest/kotlin/com/charleskorn/kaml/YamlContentPolymorphicSerializer.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,192 @@ | ||
| package com.charleskorn.kaml | ||
|
|
||
| import com.charleskorn.kaml.testobjects.TestSealedStructure | ||
| import com.charleskorn.kaml.testobjects.polymorphicModule | ||
| import io.kotest.assertions.asClue | ||
| import io.kotest.assertions.throwables.shouldThrow | ||
| import io.kotest.core.spec.style.FunSpec | ||
| import io.kotest.matchers.shouldBe | ||
| import kotlinx.serialization.DeserializationStrategy | ||
| import kotlinx.serialization.SerializationException | ||
| import kotlinx.serialization.builtins.ListSerializer | ||
| import kotlinx.serialization.builtins.nullable | ||
|
|
||
| class YamlContentPolymorphicSerializerTest : FunSpec({ | ||
| context("a YAML parser") { | ||
| context("parsing polymorphic values") { | ||
| context("given polymorphic inputs when PolymorphismStyle.None is used") { | ||
| val polymorphicYaml = Yaml( | ||
| serializersModule = polymorphicModule, | ||
| configuration = YamlConfiguration(polymorphismStyle = PolymorphismStyle.None) | ||
| ) | ||
|
|
||
| context("given some input where the value should be a sealed class") { | ||
| val input = """ | ||
| value: "asdfg" | ||
| """.trimIndent() | ||
|
|
||
| context("parsing that input") { | ||
| val result = polymorphicYaml.decodeFromString(TestSealedStructureBasedOnContentSerializer, input) | ||
|
|
||
| test("deserializes it to a Kotlin object") { | ||
| result shouldBe TestSealedStructure.SimpleSealedString("asdfg") | ||
| } | ||
| } | ||
| } | ||
|
|
||
| context("given some input where the value should be a sealed class (inline)") { | ||
| val input = """ | ||
| "abcdef" | ||
| """.trimIndent() | ||
|
|
||
| context("parsing that input") { | ||
| val result = polymorphicYaml.decodeFromString(TestSealedStructureBasedOnContentSerializer, input) | ||
|
|
||
| test("deserializes it to a Kotlin object") { | ||
| result shouldBe TestSealedStructure.InlineSealedString("abcdef") | ||
| } | ||
| } | ||
| } | ||
|
|
||
| context("given some input missing without the serializer") { | ||
| val input = """ | ||
| value: "asdfg" | ||
| """.trimIndent() | ||
|
|
||
| context("parsing that input") { | ||
| test("throws an exception with the correct location information") { | ||
| val exception = shouldThrow<IncorrectTypeException> { | ||
| polymorphicYaml.decodeFromString(TestSealedStructure.serializer(), input) | ||
| } | ||
|
|
||
| exception.asClue { | ||
| it.message shouldBe "Encountered a polymorphic map descriptor but PolymorphismStyle is 'None'" | ||
| it.line shouldBe 1 | ||
| it.column shouldBe 1 | ||
| it.path shouldBe YamlPath.root | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| context("given some input representing a list of polymorphic objects") { | ||
| val input = """ | ||
| - value: null | ||
| - value: -987 | ||
| - value: 654 | ||
| - "testing" | ||
| - value: "tests" | ||
| """.trimIndent() | ||
|
|
||
| context("parsing that input") { | ||
| val result = polymorphicYaml.decodeFromString( | ||
| ListSerializer(TestSealedStructureBasedOnContentSerializer), | ||
| input | ||
| ) | ||
|
|
||
| test("deserializes it to a Kotlin object") { | ||
| result shouldBe listOf( | ||
| TestSealedStructure.SimpleSealedString(null), | ||
| TestSealedStructure.SimpleSealedInt(-987), | ||
| TestSealedStructure.SimpleSealedInt(654), | ||
| TestSealedStructure.InlineSealedString("testing"), | ||
| TestSealedStructure.SimpleSealedString("tests"), | ||
| ) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| context("given some input with a tag and a type property") { | ||
| val input = """ | ||
| !<sealedInt> | ||
| kind: sealedString | ||
| value: "asdfg" | ||
| """.trimIndent() | ||
|
|
||
| context("parsing that input") { | ||
| test("throws an exception with the correct location information") { | ||
| val exception = shouldThrow<IncorrectTypeException> { | ||
| polymorphicYaml.decodeFromString(TestSealedStructureBasedOnContentSerializer, input) | ||
| } | ||
|
|
||
| exception.asClue { | ||
| it.message shouldBe "Encountered a tagged polymorphic descriptor but PolymorphismStyle is 'None'" | ||
| it.line shouldBe 1 | ||
| it.column shouldBe 1 | ||
| it.path shouldBe YamlPath.root | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| context("a YAML serializer") { | ||
| context("serializing polymorphic values") { | ||
| context("with custom serializer") { | ||
| val polymorphicYaml = Yaml( | ||
| serializersModule = polymorphicModule, | ||
| configuration = YamlConfiguration(polymorphismStyle = PolymorphismStyle.Tag) | ||
| ) | ||
|
|
||
| context("serializing a sealed type") { | ||
| val input = TestSealedStructure.SimpleSealedInt(5) | ||
| val output = polymorphicYaml.encodeToString(TestSealedStructureBasedOnContentSerializer, input) | ||
| val expectedYaml = """ | ||
| value: 5 | ||
| """.trimIndent() | ||
|
|
||
| test("returns the value serialized in the expected YAML form") { | ||
| output shouldBe expectedYaml | ||
| } | ||
| } | ||
|
|
||
| context("serializing a list of polymorphic values") { | ||
| val input = listOf( | ||
| TestSealedStructure.SimpleSealedInt(5), | ||
| TestSealedStructure.SimpleSealedString("some test"), | ||
| TestSealedStructure.SimpleSealedInt(-20), | ||
| TestSealedStructure.InlineSealedString("testing"), | ||
| TestSealedStructure.SimpleSealedString(null), | ||
| null, | ||
| ) | ||
|
|
||
| val output = polymorphicYaml.encodeToString( | ||
| ListSerializer(TestSealedStructureBasedOnContentSerializer.nullable), | ||
| input | ||
| ) | ||
|
|
||
| val expectedYaml = """ | ||
| - value: 5 | ||
| - value: "some test" | ||
| - value: -20 | ||
| - "testing" | ||
| - value: null | ||
| - null | ||
| """.trimIndent() | ||
|
|
||
| test("returns the value serialized in the expected YAML form") { | ||
| output shouldBe expectedYaml | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }) | ||
|
|
||
| object TestSealedStructureBasedOnContentSerializer : YamlContentPolymorphicSerializer<TestSealedStructure>( | ||
| TestSealedStructure::class | ||
| ) { | ||
| override fun selectDeserializer(node: YamlNode): DeserializationStrategy<TestSealedStructure> = when (node) { | ||
| is YamlScalar -> TestSealedStructure.InlineSealedString.serializer() | ||
| is YamlMap -> when (val value: YamlNode? = node["value"]) { | ||
| is YamlScalar -> when { | ||
| value.content.toIntOrNull() == null -> TestSealedStructure.SimpleSealedString.serializer() | ||
| else -> TestSealedStructure.SimpleSealedInt.serializer() | ||
| } | ||
| is YamlNull -> TestSealedStructure.SimpleSealedString.serializer() | ||
| else -> throw SerializationException("Unsupported property type for TestSealedStructure.value: ${value?.let { it::class.simpleName}}") | ||
| } | ||
| else -> throw SerializationException("Unsupported node type for TestSealedStructure: ${node::class.simpleName}") | ||
| } | ||
| } |