Fix surrogates, options, and version bumps (#10)

* bump gradle version

* version bumps
- bump Kotlin, Kotest, KxSerialization, Jacoco
- downgrade jvm to 8 (wider compatibility)

* fix options not being configured soon enough

* fixes

- make sure JsonLiterals are parsed correctly
- don't escape ' or " unless they're not the quote char
- handle & test invalid surrogates (credit to Synt4xErr0r4 Synt4xErr0r4@aff8a0f)

* update opt-in args

Author: aSemy

build.gradle.kts

@@ -1,7 +1,7 @@
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 plugins {
-  kotlin("jvm") version "1.6.10"
+  kotlin("jvm") version "1.7.10"
   jacoco
   `java-library`
   id("me.qoomon.git-versioning") version "5.1.1"
@@ -11,7 +11,7 @@ plugins {
 dependencies {
   implementation(platform("org.jetbrains.kotlin:kotlin-bom"))
 
-  val kotlinxSerializationVersion = "1.3.1"
+  val kotlinxSerializationVersion = "1.3.3"
   implementation(platform("org.jetbrains.kotlinx:kotlinx-serialization-bom:$kotlinxSerializationVersion"))
   api("org.jetbrains.kotlinx:kotlinx-serialization-core:$kotlinxSerializationVersion")
   api("org.jetbrains.kotlinx:kotlinx-serialization-json:$kotlinxSerializationVersion")
@@ -23,7 +23,7 @@ dependencies {
     because("Only needed to run tests in a version of IntelliJ IDEA that bundles older versions")
   }
 
-  val kotestVersion = "5.0.3"
+  val kotestVersion = "5.3.1"
   testImplementation(platform("io.kotest:kotest-bom:$kotestVersion"))
   testImplementation("io.kotest:kotest-runner-junit5:$kotestVersion")
   testImplementation("io.kotest:kotest-assertions-core:$kotestVersion")
@@ -51,23 +51,23 @@ java {
 
 kotlin {
   jvmToolchain {
-    (this as JavaToolchainSpec).languageVersion.set(JavaLanguageVersion.of(11))
+    languageVersion.set(JavaLanguageVersion.of(8))
   }
 }
 
 tasks.withType<KotlinCompile>().configureEach {
 
   kotlinOptions {
-    jvmTarget = "11"
-    apiVersion = "1.6"
-    languageVersion = "1.6"
+    jvmTarget = "1.8"
+    apiVersion = "1.7"
+    languageVersion = "1.7"
   }
 
   kotlinOptions.freeCompilerArgs += listOf(
-    "-Xopt-in=kotlin.RequiresOptIn",
-    "-Xopt-in=kotlin.ExperimentalStdlibApi",
-    "-Xopt-in=kotlin.time.ExperimentalTime",
-    "-Xopt-in=kotlinx.serialization.ExperimentalSerializationApi",
+    "-opt-in=kotlin.RequiresOptIn",
+    "-opt-in=kotlin.ExperimentalStdlibApi",
+    "-opt-in=kotlin.time.ExperimentalTime",
+    "-opt-in=kotlinx.serialization.ExperimentalSerializationApi",
   )
 }
 
@@ -78,7 +78,7 @@ tasks.withType<Test> {
 }
 
 jacoco {
-  toolVersion = "0.8.7"
+  toolVersion = "0.8.8"
 }
 
 tasks.withType<JacocoReport> {
@@ -103,7 +103,7 @@ tasks.withType<JavaCompile> {
 }
 
 tasks.wrapper {
-  gradleVersion = "7.3.3"
+  gradleVersion = "7.5"
   distributionType = Wrapper.DistributionType.ALL
 }
 tasks.assemble { dependsOn(tasks.wrapper) }

gradle/wrapper/gradle-wrapper.jar

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.3-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.5-all.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradle/wrapper/gradle-wrapper.properties

@@ -1,7 +1,7 @@
 #!/bin/sh
 
 #
-# Copyright © 2015-2021 the original authors.
+# Copyright © 2015-2021 the original authors.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -32,10 +32,10 @@
 #       Busybox and similar reduced shells will NOT work, because this script
 #       requires all of these POSIX shell features:
 #         * functions;
-#         * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
-#           «${var#prefix}», «${var%suffix}», and «$( cmd )»;
-#         * compound commands having a testable exit status, especially «case»;
-#         * various built-in commands including «command», «set», and «ulimit».
+#         * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
+#           «${var#prefix}», «${var%suffix}», and «$( cmd )»;
+#         * compound commands having a testable exit status, especially «case»;
+#         * various built-in commands including «command», «set», and «ulimit».
 #
 #   Important for patching:
 #
@@ -205,6 +205,12 @@ set -- \
         org.gradle.wrapper.GradleWrapperMain \
         "$@"
 
+# Stop when "xargs" is not available.
+if ! command -v xargs >/dev/null 2>&1
+then
+    die "xargs is not available"
+fi
+
 # Use "xargs" to parse quoted args.
 #
 # With -n1 it outputs one arg per line, with the quotes and backslashes removed.

gradlew

@@ -14,7 +14,7 @@
 @rem limitations under the License.
 @rem
 
-@if "%DEBUG%" == "" @echo off
+@if "%DEBUG%"=="" @echo off
 @rem ##########################################################################
 @rem
 @rem  Gradle startup script for Windows
@@ -25,7 +25,7 @@
 if "%OS%"=="Windows_NT" setlocal
 
 set DIRNAME=%~dp0
-if "%DIRNAME%" == "" set DIRNAME=.
+if "%DIRNAME%"=="" set DIRNAME=.
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
@@ -40,7 +40,7 @@ if defined JAVA_HOME goto findJavaFromJavaHome
 
 set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
-if "%ERRORLEVEL%" == "0" goto execute
+if %ERRORLEVEL% equ 0 goto execute
 
 echo.
 echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
@@ -75,13 +75,15 @@ set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
 
 :end
 @rem End local scope for the variables with windows NT shell
-if "%ERRORLEVEL%"=="0" goto mainEnd
+if %ERRORLEVEL% equ 0 goto mainEnd
 
 :fail
 rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
 rem the _cmd.exe /c_ return code!
-if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
-exit /b 1
+set EXIT_CODE=%ERRORLEVEL%
+if %EXIT_CODE% equ 0 set EXIT_CODE=1
+if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
+exit /b %EXIT_CODE%
 
 :mainEnd
 if "%OS%"=="Windows_NT" endlocal

gradlew.bat

@@ -64,5 +64,5 @@ data class JSONOptions(
    */
   var quoteSingle: Boolean = false,
 
-  var indentFactor: UInt = 2u
+  var indentFactor: UInt = 2u,
 )

src/main/kotlin/at/syntaxerror/json5/JSONOptions.kt

@@ -223,18 +223,20 @@ class JSONParser(
     return codepoint.toChar()
   }
 
-  private fun checkSurrogate(hi: Char, lo: Char) {
+  private fun checkSurrogate(high: Char, low: Char) {
     if (j5.options.allowInvalidSurrogates) {
       return
-    }
-    if (!Character.isHighSurrogate(hi) || !Character.isLowSurrogate(lo)) {
-      return
-    }
-    if (!Character.isSurrogatePair(hi, lo)) {
+    } else if (
+      (high.isHighSurrogate() && !low.isSurrogate())
+      ||
+      (!high.isSurrogate() && low.isLowSurrogate())
+      ||
+      !Character.isSurrogatePair(high, low)
+    ) {
       throw createSyntaxException(
         String.format(
           "Invalid surrogate pair: U+%04X and U+%04X",
-          hi, lo
+          high.code, low.code,
         )
       )
     }
@@ -254,6 +256,7 @@ class JSONParser(
       prev = n
       n = next()
       if (n == quote) {
+        checkSurrogate(prev, 0.toChar())
         break
       }
       if (isLineTerminator(n) && n.code != 0x2028 && n.code != 0x2029) {
@@ -383,6 +386,7 @@ class JSONParser(
         n = unicodeEscape(true, isNotEmpty)
       } else if (!isMemberNameChar(n, isNotEmpty)) {
         back()
+        checkSurrogate(prev, 0.toChar())
         break
       }
       checkSurrogate(prev, n)

src/main/kotlin/at/syntaxerror/json5/JSONParser.kt

@@ -25,6 +25,13 @@ package at.syntaxerror.json5
 
 import kotlinx.serialization.json.JsonArray
 import kotlinx.serialization.json.JsonObject
+import kotlinx.serialization.json.JsonPrimitive
+import kotlinx.serialization.json.booleanOrNull
+import kotlinx.serialization.json.contentOrNull
+import kotlinx.serialization.json.doubleOrNull
+import kotlinx.serialization.json.floatOrNull
+import kotlinx.serialization.json.intOrNull
+import kotlinx.serialization.json.longOrNull
 
 /**
  * A utility class for serializing [JSONObjects][DecodeJson5Object] and [JSONArrays][DecodeJson5Array]
@@ -36,9 +43,10 @@ class JSONStringify(
   private val options: JSONOptions
 ) {
 
-  private val quoteToken = if (options.quoteSingle) '\'' else '"'
-  private val emptyString = "$quoteToken$quoteToken"
-  private val indentFactor = options.indentFactor
+  private val quoteToken: Char get() = if (options.quoteSingle) '\'' else '"'
+  private val emptyString: String get() = "$quoteToken$quoteToken"
+  private val indentFactor: UInt get() = options.indentFactor
+  private val isIndented: Boolean get() = indentFactor > 0u
 
   /**
    * Converts a JSONObject into its string representation. The indentation factor enables
@@ -47,7 +55,8 @@ class JSONStringify(
    * characters.
    *
    * `indentFactor = 2`:
-   * ```
+   *
+   * ```json
    * {
    *   "key0": "value0",
    *   "key1": {
@@ -59,7 +68,7 @@ class JSONStringify(
    *
    * `indentFactor = 0`:
    *
-   * ```
+   * ```json
    * {"key0":"value0","key1":{"nested":123},"key2":false}
    * ```
    */
@@ -68,7 +77,6 @@ class JSONStringify(
     indent: String = "",
   ): String {
     val childIndent = indent + " ".repeat(indentFactor.toInt())
-    val isIndented = indentFactor > 0u
 
     val sb = StringBuilder()
     sb.append('{')
@@ -99,7 +107,8 @@ class JSONStringify(
    *
    *
    * `indentFactor = 2`:
-   * ```
+   *
+   * ```json
    * [
    *   "value",
    *   {
@@ -110,7 +119,8 @@ class JSONStringify(
    * ```
    *
    * `indentFactor = 0`:
-   * ```
+   *
+   * ```json
    * ["value",{"nested":123},false]
    * ```
    */
@@ -119,7 +129,6 @@ class JSONStringify(
     indent: String = "",
   ): String {
     val childIndent = indent + " ".repeat(indentFactor.toInt())
-    val isIndented = indentFactor > 0u
 
     val sb = StringBuilder()
     sb.append('[')
@@ -144,18 +153,21 @@ class JSONStringify(
     indent: String,
   ): String {
     return when (value) {
-      null          -> "null"
-      is JsonObject -> encodeObject(value, indent)
-      is JsonArray  -> encodeArray(value, indent)
-      is String     -> escapeString(value)
-      is Double     -> {
+      null             -> "null"
+
+      is JsonObject    -> encodeObject(value, indent)
+      is JsonArray     -> encodeArray(value, indent)
+      is JsonPrimitive -> encode(value.anyOrNull, indent)
+
+      is String        -> escapeString(value)
+      is Double        -> {
         when {
           !options.allowNaN && value.isNaN()           -> throw JSONException("Illegal NaN in JSON")
           !options.allowInfinity && value.isInfinite() -> throw JSONException("Illegal Infinity in JSON")
           else                                         -> value.toString()
         }
       }
-      else          -> value.toString()
+      else             -> value.toString()
     }
   }
 
@@ -172,6 +184,7 @@ class JSONStringify(
         ) { c: Char ->
 
           val formattedChar: String? = when (c) {
+            in listOf('\'', '\"')                 -> if (c == quoteToken) "\\$quoteToken" else "$c"
             quoteToken                            -> "\\$quoteToken"
             in Json5EscapeSequence.escapableChars -> Json5EscapeSequence.asEscapedString(c)
             else                                  -> when (c.category) {
@@ -181,12 +194,22 @@ class JSONStringify(
               CharCategory.CONTROL,
               CharCategory.PRIVATE_USE,
               CharCategory.SURROGATE,
-              CharCategory.UNASSIGNED -> String.format("\\u%04X", c)
+              CharCategory.UNASSIGNED -> String.format("\\u%04X", c.code)
               else                    -> null
             }
           }
           formattedChar ?: c.toString()
         }
     }
   }
+
+  companion object {
+    private val JsonPrimitive.anyOrNull: Any?
+      get() = intOrNull
+        ?: longOrNull
+        ?: doubleOrNull
+        ?: floatOrNull
+        ?: booleanOrNull
+        ?: contentOrNull
+  }
 }

src/main/kotlin/at/syntaxerror/json5/JSONStringify.kt

@@ -20,12 +20,13 @@ enum class Json5EscapeSequence(
   ;
 
   companion object {
-    private val mapCharToRepresentation = values().associate { it.char to it.escaped }
+    private val mapCharToRepresentation: Map<Char, String> =
+      values().associate { it.char to it.escaped }
 
-    val escapableChars = values().map { it.char }
+    val escapableChars: List<Char> = values().map { it.char }
 
     fun asEscapedString(char: Char): String? = mapCharToRepresentation[char]
 
-    fun isEscapable(char: Char) = mapCharToRepresentation.containsKey(char)
+    fun isEscapable(char: Char): Boolean = mapCharToRepresentation.containsKey(char)
   }
 }