Skip to content

feat(common): implement collection interfaces for YamlList and YamlMap #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
WhiredPlanck wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(common): implement collection interfaces for YamlList and YamlMap #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/commonMain/kotlin/com/charleskorn/kaml/YamlInput.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ public sealed class YamlInput(

private fun YamlMap.getValue(desiredKey: String): YamlNode = this.get(desiredKey) ?: throw MissingRequiredPropertyException(desiredKey, this.path)

private fun YamlMap.withoutKey(key: String): YamlMap = this.copy(entries = entries.filterKeys { it.content != key })
private fun YamlMap.withoutKey(key: String): YamlMap = this.copy(pairs = this.filterKeys { it.content != key })

private val SerialDescriptor.isContentBasedPolymorphic get() = annotations.any { it is YamlContentPolymorphicSerializer.Marker }
}
Expand Down
6 changes: 3 additions & 3 deletions src/commonMain/kotlin/com/charleskorn/kaml/YamlListInput.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,16 @@ internal class YamlListInput(
private var nextElementIndex = 0
private lateinit var currentElementDecoder: YamlInput

override fun decodeCollectionSize(descriptor: SerialDescriptor): Int = list.items.size
override fun decodeCollectionSize(descriptor: SerialDescriptor): Int = list.size

override fun decodeElementIndex(descriptor: SerialDescriptor): Int {
if (nextElementIndex == list.items.size) {
if (nextElementIndex == list.size) {
return CompositeDecoder.DECODE_DONE
}

currentElementDecoder =
createFor(
list.items[nextElementIndex],
list[nextElementIndex],
yaml,
serializersModule,
configuration,
Expand Down
2 changes: 1 addition & 1 deletion src/commonMain/kotlin/com/charleskorn/kaml/YamlMapInput.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ internal class YamlMapInput(
context: SerializersModule,
configuration: YamlConfiguration,
) : YamlMapLikeInputBase(map, yaml, context, configuration) {
private val entriesList = map.entries.entries.toList()
private val entriesList = map.entries.toList()
private var nextIndex = 0
private lateinit var currentEntry: Map.Entry<YamlScalar, YamlNode>

Expand Down
32 changes: 16 additions & 16 deletions src/commonMain/kotlin/com/charleskorn/kaml/YamlNode.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,9 +182,10 @@ public data class YamlNull(

@Serializable(with = YamlListSerializer::class)
public data class YamlList(
val items: List<YamlNode>,
private val items: List<YamlNode>,
override val path: YamlPath,
) : YamlNode(path) {
) : YamlNode(path),
List<YamlNode> by items {
override fun equivalentContentTo(other: YamlNode): Boolean {
if (other !is YamlList) {
return false
Expand All @@ -197,8 +198,6 @@ public data class YamlList(
return this.items.zip(other.items).all { (mine, theirs) -> mine.equivalentContentTo(theirs) }
}

public operator fun get(index: Int): YamlNode = items[index]

override fun contentToString(): String = "[" + items.joinToString(", ") { it.contentToString() } + "]"

override fun withPath(newPath: YamlPath): YamlList {
Expand Down Expand Up @@ -227,12 +226,13 @@ public data class YamlList(

@Serializable(with = YamlMapSerializer::class)
public data class YamlMap(
val entries: Map<YamlScalar, YamlNode>,
private val pairs: Map<YamlScalar, YamlNode>,
override val path: YamlPath,
) : YamlNode(path) {
) : YamlNode(path),
Map<YamlScalar, YamlNode> by pairs {
init {
val keys =
entries.keys.sortedWith { a, b ->
pairs.keys.sortedWith { a, b ->
val lineComparison = a.location.line.compareTo(b.location.line)

if (lineComparison != 0) {
Expand All @@ -259,16 +259,16 @@ public data class YamlMap(
return false
}

if (this.entries.size != other.entries.size) {
if (this.pairs.size != other.pairs.size) {
return false
}

return this.entries.all { (thisKey, thisValue) ->
other.entries.any { it.key.equivalentContentTo(thisKey) && it.value.equivalentContentTo(thisValue) }
return this.pairs.all { (thisKey, thisValue) ->
other.pairs.any { it.key.equivalentContentTo(thisKey) && it.value.equivalentContentTo(thisValue) }
}
}

override fun contentToString(): String = "{" + entries.map { (key, value) -> "${key.contentToString()}: ${value.contentToString()}" }.joinToString(", ") + "}"
override fun contentToString(): String = "{" + pairs.map { (key, value) -> "${key.contentToString()}: ${value.contentToString()}" }.joinToString(", ") + "}"

/**
* Returns the value corresponding to the given key and the given type,
Expand All @@ -277,7 +277,7 @@ public data class YamlMap(
*/
public inline operator fun <reified T : YamlNode> get(key: String): T? {
val node =
entries.entries
entries
.firstOrNull { it.key.content == key }
?.value ?: return null // no such key in the map
// if the value is not the given type,
Expand All @@ -295,11 +295,11 @@ public data class YamlMap(
else -> throw IncorrectTypeException("Value for '$key' is not a scalar.", node.path)
}

public fun getKey(key: String): YamlScalar? = entries.keys.singleOrNull { it.content == key }
public fun getKey(key: String): YamlScalar? = pairs.keys.singleOrNull { it.content == key }

override fun withPath(newPath: YamlPath): YamlMap {
val updatedEntries =
entries
pairs
.mapKeys { (k, _) -> k.withPath(replacePathOnChild(k, newPath)) }
.mapValues { (_, v) -> v.withPath(replacePathOnChild(v, newPath)) }

Expand All @@ -309,9 +309,9 @@ public data class YamlMap(
override fun toString(): String {
val builder = StringBuilder()

builder.appendLine("map @ $path (size: ${entries.size})")
builder.appendLine("map @ $path (size: ${pairs.size})")

entries.forEach { (key, value) ->
pairs.forEach { (key, value) ->
builder.appendLine("- key:")

key.toString().lines().forEach { line ->
Expand Down
4 changes: 2 additions & 2 deletions src/commonMain/kotlin/com/charleskorn/kaml/YamlNodeReader.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ internal class YamlNodeReader(

1 -> {
when (val mappingsToMerge = mergeEntries.single().value) {
is YamlList -> return doMerges(items, mappingsToMerge.items)
is YamlList -> return doMerges(items, mappingsToMerge)
else -> return doMerges(items, listOf(mappingsToMerge))
}
}
Expand Down Expand Up @@ -230,7 +230,7 @@ internal class YamlNodeReader(
}

is YamlMap -> {
other.entries.forEach { (key, value) ->
other.forEach { (key, value) ->
val existingEntry = merged.entries.singleOrNull { it.key.equivalentContentTo(key) }

if (existingEntry == null) {
Expand Down
4 changes: 2 additions & 2 deletions src/commonMain/kotlin/com/charleskorn/kaml/YamlNodeSerializer.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ internal object YamlMapSerializer : KSerializer<YamlMap> {
value: YamlMap,
) {
encoder.asYamlOutput()
MapSerializer(YamlScalarSerializer, YamlNodeSerializer).serialize(encoder, value.entries)
MapSerializer(YamlScalarSerializer, YamlNodeSerializer).serialize(encoder, value)
}

override fun deserialize(decoder: Decoder): YamlMap {
Expand All @@ -151,7 +151,7 @@ internal object YamlListSerializer : KSerializer<YamlList> {
value: YamlList,
) {
encoder.asYamlOutput()
ListSerializer(YamlNodeSerializer).serialize(encoder, value.items)
ListSerializer(YamlNodeSerializer).serialize(encoder, value)
}

override fun deserialize(decoder: Decoder): YamlList {
Expand Down
2 changes: 1 addition & 1 deletion src/commonMain/kotlin/com/charleskorn/kaml/YamlObjectInput.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ internal class YamlObjectInput(
context: SerializersModule,
configuration: YamlConfiguration,
) : YamlMapLikeInputBase(map, yaml, context, configuration) {
private val entriesList = map.entries.entries.toList()
private val entriesList = map.entries.toList()
private var nextIndex = 0
private lateinit var pairedPropertyNames: Map<String, Int>

Expand Down
4 changes: 2 additions & 2 deletions src/commonTest/kotlin/com/charleskorn/kaml/YamlListTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@ class YamlListTest :
}

test("list equivalence with same items but different path") {
list.equivalentContentTo(YamlList(list.items, YamlPath.root.withMapElementValue(Location(5, 6)))) shouldBe true
list.equivalentContentTo(YamlList(list, YamlPath.root.withMapElementValue(Location(5, 6)))) shouldBe true
}

test("list equivalence with same items in different order") {
list.equivalentContentTo(YamlList(list.items.reversed(), list.path)) shouldBe false
list.equivalentContentTo(YamlList(list.reversed(), list.path)) shouldBe false
}

test("list equivalence with different items") {
Expand Down
2 changes: 1 addition & 1 deletion src/commonTest/kotlin/com/charleskorn/kaml/YamlMapTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ class YamlMapTest :

context("comparing it to another map with the same items in the same order with a different path") {
test("indicates that they are equivalent") {
map.equivalentContentTo(YamlMap(map.entries, YamlPath.root.withListEntry(0, Location(3, 4)))) shouldBe true
map.equivalentContentTo(YamlMap(map, YamlPath.root.withListEntry(0, Location(3, 4)))) shouldBe true
}
}

Expand Down
17 changes: 8 additions & 9 deletions src/commonTest/kotlin/com/charleskorn/kaml/YamlReadingTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,7 +320,7 @@ class YamlReadingTest :

context("parsing that input as a list node") {
val result = Yaml.default.decodeFromString(TestClassWithNestedList.serializer(), input)
val resultList = result.node.items.map { if (it is YamlNull) null else it.yamlScalar.toDouble() }
val resultList = result.node.map { if (it is YamlNull) null else it.yamlScalar.toDouble() }

test("deserializes list") {
resultList shouldBe listOf(1.2, 3.0, Double.POSITIVE_INFINITY, null)
Expand All @@ -336,7 +336,7 @@ class YamlReadingTest :

test("deserializes node to double list") {
val resultList =
result.node.yamlList.items
result.node.yamlList
.map { if (it is YamlNull) null else it.yamlScalar.toDouble() }
resultList shouldBe listOf(1.2, 3.0, Double.POSITIVE_INFINITY, null)
}
Expand Down Expand Up @@ -1046,13 +1046,12 @@ class YamlReadingTest :
val result = Yaml.default.decodeFromString(TestClassWithNestedMap.serializer(), input)

test("deserializes map") {
result.node.entries shouldHaveSize 5
result.node shouldHaveSize 5
result.node.get<YamlScalar>("foo1")!!.content shouldBe "bar"
result.node.get<YamlNull>("foo2").shouldBeInstanceOf<YamlNull>()
result.node.get<YamlScalar>("foo3")!!.toDouble() shouldBe 3.14
result.node
.get<YamlList>("foo4")!!
.items
.map { it.yamlScalar.toInt() } shouldBe listOf(1, 2, 3)
result.node
.get<YamlMap>("foo5")!!
Expand All @@ -1074,11 +1073,11 @@ class YamlReadingTest :

test("deserializes node to double list") {
val node = result.node.yamlMap
node.entries shouldHaveSize 5
node shouldHaveSize 5
node.get<YamlScalar>("foo1")!!.content shouldBe "bar"
node.get<YamlNull>("foo2").shouldBeInstanceOf<YamlNull>()
node.get<YamlScalar>("foo3")!!.toDouble() shouldBe 3.14
node.get<YamlList>("foo4")!!.items.map { it.yamlScalar.toInt() } shouldBe listOf(1, 2, 3)
node.get<YamlList>("foo4")!!.map { it.yamlScalar.toInt() } shouldBe listOf(1, 2, 3)
node.get<YamlMap>("foo5")!!.get<YamlScalar>("element1")!!.toInt() shouldBe 1
node.get<YamlMap>("foo5")!!.get<YamlScalar>("element2")!!.toInt() shouldBe 2
}
Expand Down Expand Up @@ -2422,7 +2421,7 @@ class YamlReadingTest :

override fun deserialize(decoder: Decoder): List<Database> {
check(decoder is YamlInput)
return decoder.node.yamlMap.entries.map { (_, value) ->
return decoder.node.yamlMap.map { (_, value) ->
decoder.yaml.decodeFromYamlNode(Database.serializer(), value)
}
}
Expand Down Expand Up @@ -2631,7 +2630,7 @@ private object DecodingFromYamlNodeSerializer : KSerializer<DatabaseListing> {
check(decoder is YamlInput)

val list =
decoder.node.yamlMap.entries.map { (_, value) ->
decoder.node.yamlMap.map { (_, value) ->
decoder.yaml.decodeFromYamlNode(Database.serializer(), value)
}

Expand Down Expand Up @@ -2672,7 +2671,7 @@ private object SerializerForObjectWithCustomSerializer : KSerializer<ObjectWithC

// Intentionally parse the values from the current yaml node
val values =
decoder.node.yamlList.items
decoder.node.yamlList
.map { it.yamlScalar.content }

return ObjectWithCustomSerializer(values.joinToString(VALUES_SEPARATOR))
Expand Down