commonMain.com.episode6.mxo2.reflect.DependencyKey.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api-jvm Show documentation

Public api of Mockspresso2, a testing tool designed to reduce friction, boiler-plate and brittleness in unit tests.

There is a newer version: 2.0.1

package com.episode6.mxo2.reflect

import kotlin.reflect.KType
import kotlin.reflect.typeOf

/**
 * A representation of the type [T]. Keeping this object generically typed enables us to ensure type-safety at the api
 * level. Under the hood, the generic aspect of [TypeToken] is irrelevant, only the provided [KType] matters.
 *
 * NOTE: In practice it's best to avoid using the primary constructor to create TypeTokens. Prefer the
 * [typeToken] method which uses a reified type to ensure type data is captured completely.
 */
data class TypeToken(val type: KType)

/**
 * A representation of a binding "key" for Mockspresso's dependency Map. Every dependency in mockspresso is bound
 * by a [TypeToken] and an optional qualifier [Annotation].
 *
 * NOTE: In practice it's best to avoid using the primary constructor to create DependencyKeys. Prefer the
 * [dependencyKey] method which uses a reified type to ensure type data is captured completely.
 */
data class DependencyKey(val token: TypeToken, val qualifier: Annotation? = null)

/**
 * Creates a [TypeToken] which captures type [T]
 */
@OptIn(ExperimentalStdlibApi::class)
inline fun  typeToken(): TypeToken = TypeToken(typeOf())

/**
 * Creates a [DependencyKey] of type [T] + [qualifier]
 */
inline fun  dependencyKey(qualifier: Annotation? = null) = DependencyKey(typeToken(), qualifier)