-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add
nestRootClasses configuration option
The default root class nesting behavior will eventually be removed due to it being problematic for a number of reasons. (See #29) But until then, this provides a way to opt out of that behavior entirely.
- Loading branch information
1 parent
ed86b22
commit 7fd010c
Showing
10 changed files
with
207 additions
and
8 deletions.
There are no files selected for viewing
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
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
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
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
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
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
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
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
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,124 @@ | ||
| package net.benwoodworth.knbt | ||
|
|
||
| import com.benwoodworth.parameterize.parameter | ||
| import com.benwoodworth.parameterize.parameterOf | ||
| import kotlinx.serialization.ExperimentalSerializationApi | ||
| import kotlinx.serialization.KSerializer | ||
| import kotlinx.serialization.PolymorphicSerializer | ||
| import kotlinx.serialization.Serializable | ||
| import kotlinx.serialization.modules.EmptySerializersModule | ||
| import kotlinx.serialization.modules.SerializersModule | ||
| import kotlin.test.Test | ||
| import kotlin.test.assertEquals | ||
|
|
||
| @OptIn(ExperimentalSerializationApi::class) | ||
| class NestRootClassesTest { | ||
| private class TestCase<T>( | ||
| val serializer: KSerializer<T>, | ||
| val value: T, | ||
| val serializersModule: SerializersModule = EmptySerializersModule() | ||
| ) { | ||
| override fun toString(): String = | ||
| serializer.descriptor.serialName | ||
|
|
||
| fun encodeToNbtTag(nbt: NbtFormat): NbtTag = | ||
| nbt.encodeToNbtTag(serializer, value) | ||
|
|
||
| fun decodeFromNbtTag(nbt: NbtFormat, tag: NbtTag): T = | ||
| nbt.decodeFromNbtTag(serializer, tag) | ||
| } | ||
|
|
||
| @Serializable | ||
| private data class Class(val element: String) | ||
|
|
||
| private abstract class AbstractClass { | ||
| @Serializable | ||
| data class Impl(val element: String) : AbstractClass() | ||
| } | ||
|
|
||
| private interface Interface { | ||
| @Serializable | ||
| data class Impl(val element: String) : Interface | ||
| } | ||
|
|
||
| @Serializable | ||
| private sealed class SealedClass { | ||
| @Serializable | ||
| data class Impl(val element: String) : SealedClass() | ||
| } | ||
|
|
||
| @Serializable | ||
| private sealed interface SealedInterface { | ||
| @Serializable | ||
| data class Impl(val element: String) : SealedInterface | ||
| } | ||
|
|
||
| private val testCases = listOf( | ||
| TestCase( | ||
| Class.serializer(), | ||
| Class("value") | ||
| ), | ||
| TestCase( | ||
| PolymorphicSerializer(AbstractClass::class), | ||
| AbstractClass.Impl("value"), | ||
| SerializersModule { | ||
| polymorphic(AbstractClass::class, AbstractClass.Impl::class, AbstractClass.Impl.serializer()) | ||
| } | ||
| ), | ||
| TestCase( | ||
| PolymorphicSerializer(Interface::class), | ||
| Interface.Impl("value"), | ||
| SerializersModule { | ||
| polymorphic(Interface::class, Interface.Impl::class, Interface.Impl.serializer()) | ||
| } | ||
| ), | ||
| TestCase( | ||
| SealedClass.serializer(), | ||
| SealedClass.Impl("value") | ||
| ), | ||
| TestCase( | ||
| SealedInterface.serializer(), | ||
| SealedInterface.Impl("value") | ||
| ) | ||
| ) | ||
|
|
||
| @Test | ||
| fun class_encoded_with_nesting_be_class_without_nesting_wrapped_in_serial_name() = parameterizeTest { | ||
| val testCase by parameter(testCases) | ||
|
|
||
| val nbtWithoutNesting = parameterizedNbtFormat { | ||
| nestRootClasses = false | ||
| serializersModule = testCase.serializersModule | ||
| } | ||
|
|
||
| val nbtWithNesting = NbtFormat(nbtWithoutNesting) { | ||
| nestRootClasses = true | ||
| } | ||
|
|
||
| val tagWithoutNesting = testCase.encodeToNbtTag(nbtWithoutNesting) | ||
| val tagWithNesting = testCase.encodeToNbtTag(nbtWithNesting) | ||
|
|
||
| val expectedTagWithNesting = buildNbtCompound { | ||
| put(testCase.serializer.descriptor.serialName, tagWithoutNesting) | ||
| } | ||
|
|
||
| assertEquals(expectedTagWithNesting, tagWithNesting) | ||
| } | ||
|
|
||
| @Test | ||
| fun should_correctly_serialize_class_with_nest_root_classes_configured() = parameterizeTest { | ||
| val testCase by parameter(testCases) | ||
|
|
||
| val nestRootClasses by parameterOf(true, false) | ||
|
|
||
| val nbt = parameterizedNbtFormat { | ||
| this.nestRootClasses = nestRootClasses | ||
| serializersModule = testCase.serializersModule | ||
| } | ||
|
|
||
| val encoded = testCase.encodeToNbtTag(nbt) | ||
| val decoded = testCase.decodeFromNbtTag(nbt, encoded) | ||
|
|
||
| assertEquals(testCase.value, decoded, "Decoded tag") | ||
| } | ||
| } |
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