Adding the formatting to the encoding of multiline strings

### What's done: - Added newline alignment for multiline strings
orchestr7 · May 7, 2023 · ef6e3d9 · ef6e3d9
1 parent c92b3e0
commit ef6e3d9
Show file tree

Hide file tree

Showing 6 changed files with 85 additions and 13 deletions.
diff --git a/ktoml-core/src/commonMain/kotlin/com/akuleshov7/ktoml/decoders/TomlMainDecoder.kt b/ktoml-core/src/commonMain/kotlin/com/akuleshov7/ktoml/decoders/TomlMainDecoder.kt
@@ -104,7 +104,7 @@ public class TomlMainDecoder(
             // branch, we should throw an exception as it is not expected at all, and we should catch this in tests
             else ->
                 throw InternalDecodingException(
-                    "Node of type [${node::class}] should not be processed in TomlDecoder.decodeValue(): <${node}>."
+                    "Node of type [${node::class}] should not be processed in TomlDecoder.decodeValue(): <$node>."
                 )
         }
     }

diff --git a/ktoml-core/src/commonMain/kotlin/com/akuleshov7/ktoml/tree/nodes/TomlNode.kt b/ktoml-core/src/commonMain/kotlin/com/akuleshov7/ktoml/tree/nodes/TomlNode.kt
@@ -182,6 +182,8 @@ public sealed class TomlNode(
      * print the structure of parsed AST tree
      * Important: as prettyPrint calls toString() of the node, and not just prints the value, but emits and reconstruct a source string,
      * so in some cases (for example in case of multiline strings) it can work incorrectly.
+     *
+     * @param emitLine - if true - will print line number in this debug print
      */
     @Suppress("DEBUG_PRINT")
     public fun prettyPrint(emitLine: Boolean = false) {
@@ -191,6 +193,7 @@ public sealed class TomlNode(
     }
 
     /**
+     * @param emitLine - if true - will print line number in this debug print
      * @return the string with AST tree visual representation
      */
     public fun prettyStr(emitLine: Boolean = false): String {
@@ -295,17 +298,17 @@ public sealed class TomlNode(
     internal fun print(emitLine: Boolean = false): String =
         "${this::class.simpleName} ($this)${if (emitLine) "[line:${this.lineNo}]" else ""}\n"
 
-
     public companion object {
         // number of spaces that is used to indent levels
         internal const val INDENTING_LEVEL = 4
 
         /**
          * recursive print the tree using the current node
          *
-         * @param node
-         * @param level
-         * @param result
+         * @param node that will be printed
+         * @param level depth of hierarchy for print
+         * @param result string builder where the result is stored
+         * @param emitLine if true - will print line number in this debug print
          */
         public fun prettyPrint(
             node: TomlNode,
@@ -317,7 +320,7 @@ public sealed class TomlNode(
             // we are using print() method here instead of toString()
             result.append("$spaces - ${node.print(emitLine)}")
             node.children.forEach { child ->
-                prettyPrint(child, result, emitLine, level + 1, )
+                prettyPrint(child, result, emitLine, level + 1)
             }
         }
     }

diff --git a/ktoml-core/src/commonMain/kotlin/com/akuleshov7/ktoml/writers/TomlEmitter.kt b/ktoml-core/src/commonMain/kotlin/com/akuleshov7/ktoml/writers/TomlEmitter.kt
@@ -180,7 +180,9 @@ public abstract class TomlEmitter(config: TomlOutputConfig) {
             val quotes = if (isLiteral) "'''" else "\"\"\""
 
             emit(quotes)
+                .emitNewLine()
                 .emit(string)
+                .emitNewLine()
                 .emit(quotes)
         } else {
             val quote = if (isLiteral) '\'' else '"'

diff --git a/ktoml-core/src/commonTest/kotlin/com/akuleshov7/ktoml/encoders/EncodingAnnotationTest.kt b/ktoml-core/src/commonTest/kotlin/com/akuleshov7/ktoml/encoders/EncodingAnnotationTest.kt
@@ -269,16 +269,22 @@ class EncodingAnnotationTest {
             value = File(),
             expectedToml = """
                 mlTextA = $tripleQuotes
+                
                 \tMultiline
                 text!
+                
                 $tripleQuotes
                 mlTextB = $tripleQuotes
+                
                 Text with escaped quotes ""\"\
                 and line break
+                
                 $tripleQuotes
                 mlTextC = '''
+                
                 "Multiline
                 text!"
+                
                 '''
             """.trimIndent()
         )

diff --git a/ktoml-core/src/commonTest/kotlin/com/akuleshov7/ktoml/encoders/PrimitiveEncoderTest.kt b/ktoml-core/src/commonTest/kotlin/com/akuleshov7/ktoml/encoders/PrimitiveEncoderTest.kt
@@ -1,6 +1,7 @@
 package com.akuleshov7.ktoml.encoders
 
 import com.akuleshov7.ktoml.annotations.TomlLiteral
+import com.akuleshov7.ktoml.annotations.TomlMultiline
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
 import kotlin.test.Test
@@ -81,6 +82,38 @@ class PrimitiveEncoderTest {
         )
     }
 
+    @Test
+    fun multilineStringsSpecifications() {
+        @Serializable
+        data class MultilineLiteralStr(
+            @TomlMultiline
+            @TomlLiteral
+            val a: String
+        )
+
+        @Serializable
+        data class MultilineBasicStr(
+            @TomlMultiline
+            val a: String
+        )
+
+        assertEncodedEquals(
+            value = MultilineLiteralStr("test \n test \n test \'\'\'"),
+            expectedToml = """
+                |a = '''
+                |test 
+                | test 
+                | test ''\'
+                |'''
+            """.trimMargin()
+        )
+
+        assertEncodedEquals(
+            value = MultilineBasicStr("test \n test \n test \'\'\'"),
+            expectedToml = "a = \"\"\"\ntest \n test \n test \'\'\'\n\"\"\""
+        )
+    }
+
     @Test
     fun jsWholeDoubleRegression() {
         @Serializable

diff --git a/ktoml-core/src/commonTest/kotlin/com/akuleshov7/ktoml/parsers/SetLineNoTest.kt b/ktoml-core/src/commonTest/kotlin/com/akuleshov7/ktoml/parsers/SetLineNoTest.kt
@@ -1,15 +1,14 @@
 package com.akuleshov7.ktoml.parsers
 
 import com.akuleshov7.ktoml.Toml
-import com.akuleshov7.ktoml.tree.nodes.TomlKeyValuePrimitive
 import kotlin.test.Test
-import kotlin.test.assertContentEquals
 import kotlin.test.assertEquals
 
 class SetLineNoTest {
     @Test
-    fun checkingLineNumbers() {
-        val string = """
+    fun checkingLineNumbersGeneral() {
+        val string =
+            """
             
             # comment 1
             
@@ -22,7 +21,7 @@ class SetLineNoTest {
              [[a.b]] # comment 5 
                 test = 1
                 
-             mls = '''
+             mlls = '''
                   1
                   2
                   3
@@ -45,14 +44,43 @@ class SetLineNoTest {
                  |         - TomlArrayOfTables ([[a.b]])[line:10]
                  |             - TomlArrayOfTablesElement (technical_node)[line:10]
                  |                 - TomlKeyValuePrimitive (test=1)[line:11]
-                 |                 - TomlKeyValuePrimitive (mls='''      1
+                 |                 - TomlKeyValuePrimitive (mlls='''
+                 |      1
                  |      2
                  |      3
-                 | ''')[line:13]
+                 | 
+                 |''')[line:13]
                  |                 - TomlKeyValueArray (mla=[ "a", "b", "c" ])[line:18]
                  |
             """.trimMargin(),
             parsedToml.prettyStr(true)
         )
     }
+
+    @Test
+    fun checkingLineNumbers() {
+        val string = "\n\n" +
+                "mlls = '''\n" +
+                "1\n" +
+                "\n" +
+                "2\n" +
+                "3" +
+                "'''"
+        val parsedToml = Toml.tomlParser.parseString(string)
+        parsedToml.prettyPrint(true)
+
+        assertEquals(
+            """
+                 | - TomlFile (rootNode)[line:0]
+                 |     - TomlKeyValuePrimitive (mlls='''
+                 |1
+                 |
+                 |2
+                 |3
+                 |''')[line:3]
+                 |
+            """.trimMargin(),
+            parsedToml.prettyStr(true)
+        )
+    }
 }