Update to kotlinx.serialization 0.20.0 and Kotlin 1.3.72

Author: Sven Obser

README.md

@@ -15,10 +15,10 @@ open classes should be avoided.
 ## Gradle Dependencies
 ```kotlin
 // Kotlin Serialization CSV
-implementation("de.brudaswen.kotlinx.serialization:kotlinx-serialization-csv:0.1.0")
+implementation("de.brudaswen.kotlinx.serialization:kotlinx-serialization-csv:0.2.0")
 
 // Kotlin Serialization is added automatically, but can be added to force a specific version
-implementation("org.jetbrains.kotlinx:kotlinx-serialization-runtime:0.14.0")
+implementation("org.jetbrains.kotlinx:kotlinx-serialization-runtime:0.20.0")
 ```
 
 ## Usage
@@ -84,7 +84,6 @@ CSV serialization and parsing options can be changed by providing a custom `CsvC
 | `quoteMode`            | `MINIMAL`      | The quote mode used to decide if a column value should get quoted.<ul><li>`ALL`: Quotes *all* fields.</li><li>`ALL_NON_NULL`: Quotes all *non-null fields* and *fields which contain special characters*.</li><li>`ALL_NON_NUMERIC`: Quotes all *non-numeric fields* and *fields which contain special characters*.</li><li>`MINIMAL`: Quotes *fields which contain special characters*.</li><li>`NONE`: *Never* quotes fields (requires `CsvConfiguration.escapeChar` to be set).</li></ul> |
 | `escapeChar`           | `null` (`\\` for `QuoteMode.NONE`) | The escape character used to escape reserved characters in a column value. |
 | `nullString`           | *empty string* | The value to identify `null` values. |
-| `unitString`           | `Unit`         | The value to identify `Unit` values. |
 | `ignoreEmptyLines`     | `true`         | Ignore empty lines during parsing. |
 | `hasHeaderRecord`      | `false`        | First line is header record. |
 | `headerSeparator`      | `.`            | Character that is used to separate hierarchical header names. |
@@ -94,7 +93,7 @@ CSV serialization and parsing options can be changed by providing a custom `CsvC
 
 | Dependency             | Versions |
 |---                     |---       |
-| *Kotlin Serialization* | 0.14.0   |
+| *Kotlin Serialization* | 0.20.0   |
 
 ## License
 

application/src/main/kotlin/de/brudaswen/kotlinx/serialization/example/Example.kt

@@ -3,7 +3,7 @@ package de.brudaswen.kotlinx.serialization.example
 import kotlinx.serialization.Serializable
 import kotlinx.serialization.csv.Csv
 import kotlinx.serialization.csv.CsvConfiguration
-import kotlinx.serialization.list
+import kotlinx.serialization.builtins.list
 
 @Serializable
 data class Person(val nickname: String, val name: String?, val appearance: Appearance)

build.gradle.kts

@@ -1,11 +1,11 @@
 plugins {
     base
-    kotlin("jvm") version "1.3.61" apply false
+    kotlin("jvm") version "1.3.72" apply false
     id("net.researchgate.release") version "2.6.0"
     id("io.codearte.nexus-staging") version "0.21.2"
 }
 
-val serializationVersion = "0.14.0"
+val serializationVersion = "0.20.0"
 
 allprojects {
     group = "de.brudaswen.kotlinx.serialization"

gradle.properties

@@ -1,4 +1,4 @@
-version=0.1.1-SNAPSHOT
+version=0.2.0-SNAPSHOT
 kotlin.code.style=official
 
 # Disable generation of metadata sha256/sha512 checksum

library/src/main/kotlin/kotlinx/serialization/csv/Csv.kt

@@ -23,18 +23,18 @@ import kotlinx.serialization.modules.SerialModule
  */
 class Csv(
     internal val configuration: CsvConfiguration,
-    context: SerialModule = EmptyModule
-) : AbstractSerialFormat(context), StringFormat {
+    override val context: SerialModule = EmptyModule
+) : SerialFormat, StringFormat {
 
     /**
-     * Serialize [obj] into CSV record(s).
+     * Serialize [value] into CSV record(s).
      *
      * @param serializer The serializer used to serialize the given object.
-     * @param obj The [Serializable] object.
+     * @param value The [Serializable] object.
      */
-    override fun <T> stringify(serializer: SerializationStrategy<T>, obj: T): String {
+    override fun <T> stringify(serializer: SerializationStrategy<T>, value: T): String {
         val result = StringBuilder()
-        RootCsvEncoder(this, result).encode(serializer, obj)
+        RootCsvEncoder(this, result).encode(serializer, value)
         return result.toString()
     }
 
@@ -78,19 +78,18 @@ class Csv(
          */
         val rfc4180 = Csv(CsvConfiguration.rfc4180)
 
-        @UseExperimental(UnstableDefault::class)
         override val context: SerialModule
             get() = default.context
 
         /**
-         * Serialize [obj] into CSV record(s) using [CsvConfiguration.default].
+         * Serialize [value] into CSV record(s) using [CsvConfiguration.default].
          *
          * @param serializer The serializer used to serialize the given object.
-         * @param obj The [Serializable] object.
+         * @param value The [Serializable] object.
          */
         @UnstableDefault
-        override fun <T> stringify(serializer: SerializationStrategy<T>, obj: T): String =
-            default.stringify(serializer, obj)
+        override fun <T> stringify(serializer: SerializationStrategy<T>, value: T): String =
+            default.stringify(serializer, value)
 
         /**
          * Parse CSV [string] into [Serializable] object using [CsvConfiguration.default].

library/src/main/kotlin/kotlinx/serialization/csv/CsvConfiguration.kt

@@ -9,7 +9,6 @@ package kotlinx.serialization.csv
  * @param quoteMode The quote mode used to decide if a column value should get quoted (default: `MINIMAL`).
  * @param escapeChar The escape character used to escape reserved characters in a column value.
  * @param nullString The value to identify `null` values (default: empty string).
- * @param unitString The value to identify [Unit] values (default: `Unit`).
  * @param ignoreEmptyLines Ignore empty lines during parsing (default: `true`).
  * @param hasHeaderRecord First line is header record (default: `false`).
  * @param headerSeparator Character that is used to separate hierarchical header names (default: `.`).
@@ -22,7 +21,6 @@ data class CsvConfiguration(
     val quoteMode: QuoteMode = QuoteMode.MINIMAL,
     val escapeChar: Char? = if (quoteMode == QuoteMode.NONE) '\\' else null,
     val nullString: String = "",
-    val unitString: String = Unit.toString(),
     val ignoreEmptyLines: Boolean = true,
     val hasHeaderRecord: Boolean = false,
     val headerSeparator: Char = '.',
@@ -37,10 +35,6 @@ data class CsvConfiguration(
             "The escapeChar character and the delimiter cannot be the same ('$delimiter')."
         }
 
-        require(nullString != unitString) {
-            "The nullString and the unitString cannot be the same ('$nullString')."
-        }
-
         if (quoteMode == QuoteMode.NONE) {
             require(escapeChar != null) {
                 "The QuoteMode NONE requires an escapeChar."

library/src/main/kotlin/kotlinx/serialization/csv/decode/ClassCsvDecoder.kt

@@ -20,29 +20,29 @@ internal class ClassCsvDecoder(
 
     private var elementIndex = 0
 
-    override fun decodeElementIndex(desc: SerialDescriptor): Int = when {
-        reader.isDone || elementIndex >= desc.elementsCount -> CompositeDecoder.READ_DONE
+    override fun decodeElementIndex(descriptor: SerialDescriptor): Int = when {
+        reader.isDone || elementIndex >= descriptor.elementsCount -> CompositeDecoder.READ_DONE
         classHeaders != null -> classHeaders[elementIndex]
         else -> elementIndex
     }
 
-    override fun beginStructure(desc: SerialDescriptor, vararg typeParams: KSerializer<*>): CompositeDecoder {
-        return when (desc.kind) {
+    override fun beginStructure(descriptor: SerialDescriptor, vararg typeParams: KSerializer<*>): CompositeDecoder {
+        return when (descriptor.kind) {
             StructureKind.CLASS ->
                 ClassCsvDecoder(
                     csv,
                     reader,
                     this,
-                    classHeaders?.getSubHeaders(decodeElementIndex(desc))
+                    classHeaders?.getSubHeaders(decodeElementIndex(descriptor))
                 )
 
             else ->
-                super.beginStructure(desc, *typeParams)
+                super.beginStructure(descriptor, *typeParams)
         }
     }
 
-    override fun endChildStructure(desc: SerialDescriptor) {
-        super.endChildStructure(desc)
+    override fun endChildStructure(descriptor: SerialDescriptor) {
+        super.endChildStructure(descriptor)
         elementIndex++
     }
 

library/src/main/kotlin/kotlinx/serialization/csv/decode/CollectionCsvDecoder.kt

@@ -1,5 +1,6 @@
 package kotlinx.serialization.csv.decode
 
+import kotlinx.serialization.CompositeDecoder
 import kotlinx.serialization.SerialDescriptor
 import kotlinx.serialization.csv.Csv
 
@@ -14,5 +15,25 @@ internal class CollectionCsvDecoder(
     parent: CsvDecoder
 ) : CsvDecoder(csv, reader, parent) {
 
-    override fun decodeCollectionSize(desc: SerialDescriptor) = decodeInt()
+    private var elementIndex = 0
+
+    override fun decodeSequentially(): Boolean = true
+
+    override fun decodeElementIndex(descriptor: SerialDescriptor): Int = when {
+        reader.isDone || elementIndex >= descriptor.elementsCount -> CompositeDecoder.READ_DONE
+        else -> elementIndex
+    }
+
+    override fun decodeCollectionSize(descriptor: SerialDescriptor) = decodeInt()
+
+    override fun endChildStructure(descriptor: SerialDescriptor) {
+        super.endChildStructure(descriptor)
+        elementIndex++
+    }
+
+    override fun decodeColumn(): String {
+        val value = super.decodeColumn()
+        elementIndex++
+        return value
+    }
 }

library/src/main/kotlin/kotlinx/serialization/csv/decode/CollectionRecordCsvDecoder.kt

@@ -21,14 +21,14 @@ internal class CollectionRecordCsvDecoder(
 
     private val recordNo = reader.recordNo
 
-    override fun decodeElementIndex(desc: SerialDescriptor): Int = when {
+    override fun decodeElementIndex(descriptor: SerialDescriptor): Int = when {
         // TODO Check for END_OF_RECORD
         reader.isDone || reader.recordNo != recordNo -> CompositeDecoder.READ_DONE
         else -> elementIndex
     }
 
-    override fun endChildStructure(desc: SerialDescriptor) {
-        super.endChildStructure(desc)
+    override fun endChildStructure(descriptor: SerialDescriptor) {
+        super.endChildStructure(descriptor)
         elementIndex++
     }
 

library/src/main/kotlin/kotlinx/serialization/csv/decode/CsvDecoder.kt

@@ -1,6 +1,7 @@
 package kotlinx.serialization.csv.decode
 
 import kotlinx.serialization.*
+import kotlinx.serialization.builtins.AbstractDecoder
 import kotlinx.serialization.csv.Csv
 import kotlinx.serialization.csv.CsvConfiguration
 import kotlinx.serialization.modules.SerialModule
@@ -12,7 +13,7 @@ internal abstract class CsvDecoder(
     protected val csv: Csv,
     protected val reader: CsvReader,
     private val parent: CsvDecoder?
-) : ElementValueDecoder() {
+) : AbstractDecoder() {
 
     override val context: SerialModule
         get() = csv.context
@@ -22,34 +23,34 @@ internal abstract class CsvDecoder(
 
     protected var headers: Headers? = null
 
-    override fun beginStructure(desc: SerialDescriptor, vararg typeParams: KSerializer<*>): CompositeDecoder {
-        return when (desc.kind) {
+    override fun beginStructure(descriptor: SerialDescriptor, vararg typeParams: KSerializer<*>): CompositeDecoder {
+        return when (descriptor.kind) {
             StructureKind.LIST,
             StructureKind.MAP ->
                 CollectionCsvDecoder(csv, reader, this)
 
             StructureKind.CLASS ->
                 ClassCsvDecoder(csv, reader, this, headers)
 
-            UnionKind.OBJECT ->
+            StructureKind.OBJECT ->
                 ObjectCsvDecoder(csv, reader, this)
 
             PolymorphicKind.SEALED ->
-                SealedCsvDecoder(csv, reader, this, desc)
+                SealedCsvDecoder(csv, reader, this, descriptor)
 
             PolymorphicKind.OPEN ->
                 ClassCsvDecoder(csv, reader, this, headers)
 
             else ->
-                error("CSV does not support '${desc.kind}'.")
+                error("CSV does not support '${descriptor.kind}'.")
         }
     }
 
-    override fun endStructure(desc: SerialDescriptor) {
-        parent?.endChildStructure(desc)
+    override fun endStructure(descriptor: SerialDescriptor) {
+        parent?.endChildStructure(descriptor)
     }
 
-    protected open fun endChildStructure(desc: SerialDescriptor) {
+    protected open fun endChildStructure(descriptor: SerialDescriptor) {
     }
 
     override fun decodeByte(): Byte {
@@ -100,13 +101,8 @@ internal abstract class CsvDecoder(
         return null
     }
 
-    override fun decodeUnit() {
-        val value = decodeColumn()
-        require(value == configuration.unitString) { "Expected '${configuration.unitString}' but was '$value'." }
-    }
-
-    override fun decodeEnum(enumDescription: SerialDescriptor): Int {
-        return enumDescription.getElementIndex(decodeColumn())
+    override fun decodeEnum(enumDescriptor: SerialDescriptor): Int {
+        return enumDescriptor.getElementIndex(decodeColumn())
     }
 
     protected open fun decodeColumn() = reader.readColumn()