commonMain.com.diffplug.selfie.Selfie.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of selfie-lib-jvm Show documentation
Core logic and parsing for Selfie
There is a newer version: 2.4.0
/*
 * Copyright (C) 2023-2024 DiffPlug
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.diffplug.selfie

import com.diffplug.selfie.guts.CallStack
import com.diffplug.selfie.guts.DiskStorage
import com.diffplug.selfie.guts.SnapshotSystem
import com.diffplug.selfie.guts.initSnapshotSystem
import kotlin.jvm.JvmStatic

/** A getter which may or may not be run. */
fun interface Cacheable {
  @Throws(Throwable::class) fun get(): T
}

/** Static methods for creating snapshots. */
object Selfie {
  internal val system: SnapshotSystem = initSnapshotSystem()
  private val deferredDiskStorage =
      object : DiskStorage {
        override fun readDisk(sub: String, call: CallStack): Snapshot? =
            system.diskThreadLocal().readDisk(sub, call)
        override fun writeDisk(actual: Snapshot, sub: String, call: CallStack) =
            system.diskThreadLocal().writeDisk(actual, sub, call)
        override fun keep(subOrKeepAll: String?) = system.diskThreadLocal().keep(subOrKeepAll)
      }

  /**
   * Sometimes a selfie is environment-specific, but should not be deleted when run in a different
   * environment.
   */
  @JvmStatic
  fun preserveSelfiesOnDisk(vararg subsToKeep: String) {
    val disk = system.diskThreadLocal()
    if (subsToKeep.isEmpty()) {
      disk.keep(null)
    } else {
      subsToKeep.forEach { disk.keep(it) }
    }
  }

  @JvmStatic
  fun  expectSelfie(actual: T, camera: Camera) = expectSelfie(camera.snapshot(actual))

  @JvmStatic
  fun expectSelfie(actual: ByteArray) = BinarySelfie(Snapshot.of(actual), deferredDiskStorage, "")
  @JvmStatic fun expectSelfie(actual: String) = expectSelfie(Snapshot.of(actual))
  @JvmStatic fun expectSelfie(actual: Snapshot) = StringSelfie(actual, deferredDiskStorage)
  @JvmStatic fun expectSelfie(actual: Long) = LongSelfie(actual)
  @JvmStatic fun expectSelfie(actual: Int) = IntSelfie(actual)
  @JvmStatic fun expectSelfie(actual: Boolean) = BooleanSelfie(actual)

  @JvmStatic
  fun  expectSelfies(items: Iterable, toString: (T) -> String): StringSelfie =
      expectSelfie(items.joinToString("\n", transform = toString))

  @JvmStatic
  fun cacheSelfie(toCache: Cacheable) = cacheSelfie(Roundtrip.identity(), toCache)

  @JvmStatic
  fun  cacheSelfie(roundtrip: Roundtrip, toCache: Cacheable) =
      CacheSelfie(deferredDiskStorage, roundtrip, toCache)

  /**
   * Memoizes any type which is marked with `@kotlinx.serialization.Serializable` as pretty-printed
   * json.
   */
  inline fun  cacheSelfieJson(noinline toCache: () -> T) =
      cacheSelfie(RoundtripJson.of(), toCache)

  @JvmStatic
  fun cacheSelfieBinary(toCache: Cacheable) =
      cacheSelfieBinary(Roundtrip.identity(), toCache)

  @JvmStatic
  fun  cacheSelfieBinary(roundtrip: Roundtrip, toCache: Cacheable) =
      CacheSelfieBinary(deferredDiskStorage, roundtrip, toCache)
}