Rename SnapshotValueReader.peekKey() to peekKeyRaw() since it is unescaped.

Author: nedtwigg

jvm/selfie-lib/src/commonMain/kotlin/com/diffplug/selfie/SnapshotFile.kt

@@ -242,7 +242,7 @@ class SnapshotFile {
 
 class SnapshotReader(val valueReader: SnapshotValueReader) {
   fun peekKey(): String? {
-    val next = valueReader.peekKey() ?: return null
+    val next = valueReader.peekKeyRaw() ?: return null
     if (next == SnapshotFile.END_OF_FILE) {
       return null
     }
@@ -255,7 +255,7 @@ class SnapshotReader(val valueReader: SnapshotValueReader) {
     val rootName = peekKey()
     var snapshot = Snapshot.of(valueReader.nextValue())
     while (true) {
-      val nextKey = valueReader.peekKey() ?: return snapshot
+      val nextKey = valueReader.peekKeyRaw() ?: return snapshot
       val facetIdx = nextKey.indexOf('[')
       if (facetIdx == -1 || (facetIdx == 0 && nextKey == SnapshotFile.END_OF_FILE)) {
         return snapshot
@@ -287,15 +287,15 @@ class SnapshotValueReader(val lineReader: LineReader) {
   val unixNewlines = lineReader.unixNewlines()
 
   /** The key of the next value, does not increment anything about the reader's state. */
-  fun peekKey(): String? {
-    return nextKey()
+  fun peekKeyRaw(): String? {
+    return nextKeyRaw()
   }
 
   /** Reads the next value. */
   @OptIn(ExperimentalEncodingApi::class)
   fun nextValue(): SnapshotValue {
     // validate key
-    nextKey()
+    nextKeyRaw()
     val isBase64 = nextLine()!!.contains(FLAG_BASE64)
     resetLine()
 
@@ -323,7 +323,7 @@ class SnapshotValueReader(val lineReader: LineReader) {
   /** Same as nextValue, but faster. */
   fun skipValue() {
     // Ignore key
-    nextKey()
+    nextKeyRaw()
     resetLine()
 
     scanValue {
@@ -342,7 +342,7 @@ class SnapshotValueReader(val lineReader: LineReader) {
       nextLine = nextLine()
     }
   }
-  private fun nextKey(): String? {
+  private fun nextKeyRaw(): String? {
     val line = nextLine() ?: return null
     val startIndex = line.indexOf(KEY_START)
     val endIndex = line.indexOf(KEY_END)

jvm/selfie-lib/src/commonTest/kotlin/com/diffplug/selfie/SnapshotValueReaderTest.kt

@@ -46,42 +46,42 @@ class SnapshotValueReaderTest {
             ╔═ 05_notSureHowKotlinMultilineWorks ═╗
             """
                 .trimIndent())
-    reader.peekKey() shouldBe "00_empty"
-    reader.peekKey() shouldBe "00_empty"
+    reader.peekKeyRaw() shouldBe "00_empty"
+    reader.peekKeyRaw() shouldBe "00_empty"
     reader.nextValue().valueString() shouldBe ""
-    reader.peekKey() shouldBe "01_singleLineString"
-    reader.peekKey() shouldBe "01_singleLineString"
+    reader.peekKeyRaw() shouldBe "01_singleLineString"
+    reader.peekKeyRaw() shouldBe "01_singleLineString"
     reader.nextValue().valueString() shouldBe "this is one line"
-    reader.peekKey() shouldBe "01a_singleLineLeadingSpace"
+    reader.peekKeyRaw() shouldBe "01a_singleLineLeadingSpace"
     reader.nextValue().valueString() shouldBe " the leading space is significant"
-    reader.peekKey() shouldBe "01b_singleLineTrailingSpace"
+    reader.peekKeyRaw() shouldBe "01b_singleLineTrailingSpace"
     reader.nextValue().valueString() shouldBe "the trailing space is significant "
-    reader.peekKey() shouldBe "02_multiLineStringTrimmed"
+    reader.peekKeyRaw() shouldBe "02_multiLineStringTrimmed"
     reader.nextValue().valueString() shouldBe "Line 1\nLine 2"
     // note that leading and trailing newlines in the snapshots are significant
     // this is critical so that snapshots can accurately capture the exact number of newlines
-    reader.peekKey() shouldBe "03_multiLineStringTrailingNewline"
+    reader.peekKeyRaw() shouldBe "03_multiLineStringTrailingNewline"
     reader.nextValue().valueString() shouldBe "Line 1\nLine 2\n"
-    reader.peekKey() shouldBe "04_multiLineStringLeadingNewline"
+    reader.peekKeyRaw() shouldBe "04_multiLineStringLeadingNewline"
     reader.nextValue().valueString() shouldBe "\nLine 1\nLine 2"
-    reader.peekKey() shouldBe "05_notSureHowKotlinMultilineWorks"
+    reader.peekKeyRaw() shouldBe "05_notSureHowKotlinMultilineWorks"
     reader.nextValue().valueString() shouldBe ""
   }
 
   @Test
   fun invalidNames() {
-    shouldThrow<ParseException> { SnapshotValueReader.of("╔═name ═╗").peekKey() }
+    shouldThrow<ParseException> { SnapshotValueReader.of("╔═name ═╗").peekKeyRaw() }
         .let { it.message shouldBe "L1:Expected to start with '╔═ '" }
-    shouldThrow<ParseException> { SnapshotValueReader.of("╔═ name═╗").peekKey() }
+    shouldThrow<ParseException> { SnapshotValueReader.of("╔═ name═╗").peekKeyRaw() }
         .let { it.message shouldBe "L1:Expected to contain ' ═╗'" }
-    shouldThrow<ParseException> { SnapshotValueReader.of("╔═  name ═╗").peekKey() }
+    shouldThrow<ParseException> { SnapshotValueReader.of("╔═  name ═╗").peekKeyRaw() }
         .let { it.message shouldBe "L1:Leading spaces are disallowed: ' name'" }
-    shouldThrow<ParseException> { SnapshotValueReader.of("╔═ name  ═╗").peekKey() }
+    shouldThrow<ParseException> { SnapshotValueReader.of("╔═ name  ═╗").peekKeyRaw() }
         .let { it.message shouldBe "L1:Trailing spaces are disallowed: 'name '" }
-    SnapshotValueReader.of("╔═ name ═╗ comment okay").peekKey() shouldBe "name"
-    SnapshotValueReader.of("╔═ name ═╗okay here too").peekKey() shouldBe "name"
+    SnapshotValueReader.of("╔═ name ═╗ comment okay").peekKeyRaw() shouldBe "name"
+    SnapshotValueReader.of("╔═ name ═╗okay here too").peekKeyRaw() shouldBe "name"
     SnapshotValueReader.of("╔═ name ═╗ okay  ╔═ ═╗ (it's the first ' ═╗' that counts)")
-        .peekKey() shouldBe "name"
+        .peekKeyRaw() shouldBe "name"
   }
 
   @Test
@@ -96,15 +96,15 @@ class SnapshotValueReaderTest {
             ╔═ test with \┌\─ ascii art \─\┐ in name ═╗
             """
                 .trimIndent())
-    reader.peekKey() shouldBe "test with \\(square brackets\\) in name"
+    reader.peekKeyRaw() shouldBe "test with \\(square brackets\\) in name"
     reader.nextValue().valueString() shouldBe ""
-    reader.peekKey() shouldBe """test with \\backslash\\ in name"""
+    reader.peekKeyRaw() shouldBe """test with \\backslash\\ in name"""
     reader.nextValue().valueString() shouldBe ""
-    reader.peekKey() shouldBe "test with\\nnewline\\nin name"
+    reader.peekKeyRaw() shouldBe "test with\\nnewline\\nin name"
     reader.nextValue().valueString() shouldBe ""
-    reader.peekKey() shouldBe "test with \\ttab\\t in name"
+    reader.peekKeyRaw() shouldBe "test with \\ttab\\t in name"
     reader.nextValue().valueString() shouldBe ""
-    reader.peekKey() shouldBe "test with \\┌\\─ ascii art \\─\\┐ in name"
+    reader.peekKeyRaw() shouldBe "test with \\┌\\─ ascii art \\─\\┐ in name"
     reader.nextValue().valueString() shouldBe ""
   }
 
@@ -121,11 +121,11 @@ class SnapshotValueReaderTest {
           𐝃𐝁𐝃𐝃 linear a is dead
         """
                 .trimIndent())
-    reader.peekKey() shouldBe "ascii art okay"
+    reader.peekKeyRaw() shouldBe "ascii art okay"
     reader.nextValue().valueString() shouldBe """ ╔══╗"""
-    reader.peekKey() shouldBe "escaped iff on first line"
+    reader.peekKeyRaw() shouldBe "escaped iff on first line"
     reader.nextValue().valueString() shouldBe """╔══╗"""
-    reader.peekKey() shouldBe "body escape characters"
+    reader.peekKeyRaw() shouldBe "body escape characters"
     reader.nextValue().valueString() shouldBe """𐝁𐝃 linear a is dead"""
   }
 
@@ -148,12 +148,12 @@ class SnapshotValueReaderTest {
   }
   private fun assertKeyValueWithSkip(input: String, key: String, value: String) {
     val reader = SnapshotValueReader.of(input)
-    while (reader.peekKey() != key) {
+    while (reader.peekKeyRaw() != key) {
       reader.skipValue()
     }
-    reader.peekKey() shouldBe key
+    reader.peekKeyRaw() shouldBe key
     reader.nextValue().valueString() shouldBe value
-    while (reader.peekKey() != null) {
+    while (reader.peekKeyRaw() != null) {
       reader.skipValue()
     }
   }
@@ -163,7 +163,7 @@ class SnapshotValueReaderTest {
     val reader = SnapshotValueReader.of("""╔═ Apple ═╗ base64 length 3 bytes
 c2Fk
 """)
-    reader.peekKey() shouldBe "Apple"
+    reader.peekKeyRaw() shouldBe "Apple"
     reader.nextValue().valueBinary() shouldBe "sad".encodeToByteArray()
   }
 }