Add an API for implicit selfies.

diffplug · Dec 19, 2023 · b05af47 · b05af47
1 parent 2567554
commit b05af47
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 0 deletions.
diff --git a/selfie-runner-junit5/src/main/kotlin/com/diffplug/selfie/Selfie.kt b/selfie-runner-junit5/src/main/kotlin/com/diffplug/selfie/Selfie.kt
@@ -48,6 +48,8 @@ object Selfie {
   fun <T> expectSelfie(actual: T, snapshotter: Snapshotter<T>) =
       DiskSelfie(snapshotter.snapshot(actual))
 
+  @JvmStatic fun expectSelfie(actual: Any) = expectSelfie(actual, Router.snapshotImplicit(actual))
+
   class StringSelfie(private val actual: String) : DiskSelfie(Snapshot.of(actual)) {
     fun toBe(expected: String): String = TODO()
     fun toBe_TODO(): String = TODO()

diff --git a/selfie-runner-junit5/src/main/kotlin/com/diffplug/selfie/junit5/SelfieSettingsAPI.kt b/selfie-runner-junit5/src/main/kotlin/com/diffplug/selfie/junit5/SelfieSettingsAPI.kt
@@ -15,11 +15,16 @@
  */
 package com.diffplug.selfie.junit5
 
+import com.diffplug.selfie.Snapshotter
 import java.nio.file.Files
 import java.nio.file.Path
 import java.nio.file.Paths
 
 interface SelfieSettingsAPI {
+  /** API function which allows user to specify a custom snapshotter. */
+  fun implictSnapshotterFor(underTest: Any): Snapshotter<*> =
+      throw AssertionError("Implicit snapshots have not been setup, see TODO.")
+
   /**
    * Defaults to `__snapshot__`, null means that snapshots are stored at the same folder location as
    * the test that created them.

diff --git a/...e-runner-junit5/src/main/kotlin/com/diffplug/selfie/junit5/SelfieTestExecutionListener.kt b/...e-runner-junit5/src/main/kotlin/com/diffplug/selfie/junit5/SelfieTestExecutionListener.kt
@@ -50,6 +50,10 @@ internal object Router {
       ExpectedActual(cm.clazz.read(cm.method, suffix), actual)
     }
   }
+  fun snapshotImplicit(actual: Any): Snapshotter<Any> {
+    val cm = classAndMethod()
+    return cm.clazz.parent.settings.implictSnapshotterFor(actual) as Snapshotter<Any>
+  }
   fun keep(subOrKeepAll: String?) {
     val cm = classAndMethod()
     if (subOrKeepAll == null) {