Rename to selfie (#7)

Author: nedtwigg

README.md

@@ -1,24 +1,22 @@
-# spotless-snapshot
+# Selfie
 
-- Precise snapshot testing for the JVM and Javascript (Native TODO)
+- Precise snapshot testing for the JVM and Javascript (others TBD)
 - Supports text and binary data.
 - Friendly to humans and version control.
 - In-place [literal snapshots](#literal-snapshots).
 - Allows [lenses](#lenses) to verify multiple aspects of an object under test.
   - e.g. pretty-printed JSON, or only the rendered plaintext of an HTML document, etc.
 
-The example below uses the JUnit 5 runner, but we also support TODO.
-
-Here is a very simple test which snapshots the HTML served at various URLs.
+ere is a very simple test which snapshots the HTML served at various URLs.
 
 ```java
-@Test public void gzipFavicon(Expect expect) {
-  expect.toMatchBinarySnapshot(get("localhost:8080/favicon.ico", ContentEncoding.GZIP));
+@Test public void gzipFavicon() {
+    expectSelfie(get("/favicon.ico", ContentEncoding.GZIP)).toMatchDisk();
 }
-@Test public void orderFlow(Expect expect) {
-  expect.scenario("initial").toMatchSnapshot(get("localhost:8080/orders"));
+@Test public void orderFlow() {
+  expectSelfie(get("/orders")).toMatchDisk("initial");
   postOrder();
-  expect.scenario("ordered").toMatchSnapshot(get("localhost:8080/orders"));
+  expectSelfie(get("/orders")).toMatchDisk("ordered");
 }
 ```
 
@@ -43,12 +41,12 @@ H4sIAAAAAAAA/8pIzcnJVyjPL8pJUQQAlQYXAAAA
 
 ### Literal snapshots
 
-A great thing about snapshots is that they are fast to write and update. A downside is that the asserted value is opaque. But it doesn't have to be! Just swap `toMatchSnapshot` for `toMatchLiteral`.
+A great thing about snapshots is that they are fast to write and update. A downside is that the asserted value is opaque. But it doesn't have to be! Just swap `toMatchDisk` for `toBe`.
 
 ```java
-@Test public void preventCssBloat(Expect expect) {
-  // spotless-snapshot can update this literal value for you ▼
-  int size = expect.toMatchLiteral(get("/index.css").length, 5_236);
+@Test public void preventCssBloat() {
+  //        selfie can update this literal value for you ▼
+  int size = expectSelfie(get("/index.css").length).toBe(5_236);
   if (size > 100_000) {
     Assert.fail("CSS has gotten too big!");
   }
@@ -62,7 +60,7 @@ Now we can see at a glance how a PR has affected the bundled size of our CSS. We
 When snapshotting HTML, you might want to look at only the rendered text, ignoring tags, classes, and all that.
 
 ```java
-public SnapshotConfig extends SpotlessSnapshotConfig {
+public SelfieConfig extends com.diffplug.selfie.SelfieConfig {
   @Override public @Nullable Snapshot intercept(Class<?> className, String testName, Snapshot snapshot) {
     if (!snapshot.getValue().isBinary()) {
       String content = snapshot.getValue().valueString();
@@ -92,9 +90,9 @@ Order information
 Tracking #ABC123
 ```
 
-Lenses can make PRs easier to review, by putting the focus on various aspects of the snapshot that are relevant to the change.
+Lenses can make PRs easier to review, by putting the focus on whichever aspect of the snapshot is relevant to the change.
 
 ### Acknowledgements
 
-- JUnit test runner heavily inspired by [origin-energy's java-snapshot-testing](https://github.com/origin-energy/java-snapshot-testing).
+- Heavily inspired by [origin-energy's java-snapshot-testing](https://github.com/origin-energy/java-snapshot-testing).
 - Which in turn is heavily inspired by [Facebook's jest-snapshot](https://jestjs.io/docs/snapshot-testing).

gradle/spotless.gradle

@@ -16,7 +16,7 @@ spotless {
             target 'src/**/*.kt'
             licenseHeaderFile 干.file("spotless/license-${license}.java")
             ktfmt()
-            for (modifier in ['', 'override ', 'public ', 'protected ', 'private ', 'internal ', 'expected ', 'actual ']) {
+            for (modifier in ['', 'override ', 'public ', 'protected ', 'private ', 'internal ', 'infix ', 'expected ', 'actual ']) {
                 for (key in ['inline', 'fun', 'val', 'override']) {
                     String toCheck = "$modifier$key"
                     replaceRegex("dense $toCheck", "\n\n(\\s*)$toCheck ", "\n\$1$toCheck ")

snapshot-lib/build.gradle renamed to selfie-lib/build.gradle

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.diffplug.snapshot
+package com.diffplug.selfie
 
 import kotlin.collections.binarySearch
 

snapshot-lib/src/commonMain/kotlin/com/diffplug/snapshot/ArrayMap.kt renamed to selfie-lib/src/commonMain/kotlin/com/diffplug/selfie/ArrayMap.kt

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.diffplug.snapshot
+package com.diffplug.selfie
 
 expect class PerCharacterEscaper {
   fun escape(input: String): String

snapshot-lib/src/commonMain/kotlin/com/diffplug/snapshot/PerCharacterEscaper.kt renamed to selfie-lib/src/commonMain/kotlin/com/diffplug/selfie/PerCharacterEscaper.kt

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.diffplug.snapshot
+package com.diffplug.selfie
 
 class ParseException(val line: Int, message: String) : IllegalArgumentException(message) {
   constructor(lineReader: LineReader, message: String) : this(lineReader.getLineNumber(), message)
@@ -47,11 +47,6 @@ internal data class SnapshotValueString(val value: String) : SnapshotValue {
   override fun valueString(): String = value
 }
 
-internal data class SnapshotValueEmptyString(val value: String) : SnapshotValue {
-  override fun valueBinary() = throw UnsupportedOperationException("This is an empty string value.")
-  override fun valueString() = value
-}
-
 data class Snapshot(
     val value: SnapshotValue,
     private val lensData: ArrayMap<String, SnapshotValue>
@@ -73,8 +68,31 @@ data class Snapshot(
 interface Snapshotter<T> {
   fun snapshot(value: T): Snapshot
 }
-fun parseSS(valueReader: SnapshotValueReader): ArrayMap<String, Snapshot> = TODO()
-fun serializeSS(valueWriter: StringWriter, snapshots: ArrayMap<String, Snapshot>): Unit = TODO()
+
+class SnapshotFile {
+  // this will probably become `<String, JsonObject>` we'll cross that bridge when we get to it
+  var metadata: Map.Entry<String, String>? = null
+  var snapshots = ArrayMap.empty<String, Snapshot>()
+  fun serialize(valueWriter: StringWriter): Unit = TODO()
+
+  companion object {
+    private val HEADER_PREFIX = """📷 """
+    fun parse(valueReader: SnapshotValueReader): SnapshotFile {
+      val result = SnapshotFile()
+      val reader = SnapshotReader(valueReader)
+      // only if the first value starts with 📷
+      if (reader.peekKey()?.startsWith(HEADER_PREFIX) == true) {
+        val metadataName = reader.peekKey()!!.substring(HEADER_PREFIX.length)
+        val metadataValue = reader.valueReader.nextValue().valueString()
+        result.metadata = entry(metadataName, metadataValue)
+      }
+      while (reader.peekKey() != null) {
+        result.snapshots = result.snapshots.plus(reader.peekKey()!!, reader.nextSnapshot())
+      }
+      return result
+    }
+  }
+}
 
 class SnapshotReader(val valueReader: SnapshotValueReader) {
   fun peekKey(): String? = TODO()
@@ -176,11 +194,11 @@ class SnapshotValueReader(val lineReader: LineReader) {
     private val headerEnd = " ═╗"
 
     /**
-     * https://github.com/diffplug/spotless-snapshot/blob/f63192a84390901a3d3543066d095ea23bf81d21/snapshot-lib/src/commonTest/resources/com/diffplug/snapshot/scenarios_and_lenses.ss#L11-L29
+     * https://github.com/diffplug/selfie/blob/f63192a84390901a3d3543066d095ea23bf81d21/snapshot-lib/src/commonTest/resources/com/diffplug/snapshot/scenarios_and_lenses.ss#L11-L29
      */
     private val nameEsc = PerCharacterEscaper.specifiedEscape("\\\\/∕[(])\nn\tt╔┌╗┐═─")
 
-    /** https://github.com/diffplug/spotless-snapshot/issues/2 */
+    /** https://github.com/diffplug/selfie/issues/2 */
     private val bodyEsc = PerCharacterEscaper.selfEscape("\uD801\uDF43\uD801\uDF41")
   }
 }

snapshot-lib/src/commonMain/kotlin/com/diffplug/snapshot/SpotlessFile.kt renamed to selfie-lib/src/commonMain/kotlin/com/diffplug/selfie/SnapshotFile.kt

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.diffplug.snapshot
+package com.diffplug.selfie
 
 import io.kotest.assertions.throwables.shouldThrow
 import io.kotest.matchers.shouldBe

snapshot-lib/src/commonTest/kotlin/com/diffplug/snapshot/ArrayMapTest.kt renamed to selfie-lib/src/commonTest/kotlin/com/diffplug/selfie/ArrayMapTest.kt

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.diffplug.snapshot
+package com.diffplug.selfie
 
 internal actual fun <K, V> entry(key: K, value: V): Map.Entry<K, V> = E(key, value)