commonMain.ch.tutteli.atrium.creating.CollectingExpect.kt Maven / Gradle / Ivy

Go to download

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

Core module of Atrium, containing all contracts/interfaces and default implementations

There is a newer version: 1.2.0

package ch.tutteli.atrium.creating

import ch.tutteli.atrium.assertions.Assertion
import ch.tutteli.atrium.core.ExperimentalNewExpectTypes
import ch.tutteli.atrium.core.Option
import ch.tutteli.atrium.creating.impl.CollectingExpectImpl

/**
 * Represents a container for [Assertion] which is intended to serve as receiver object for lambdas which create
 * [Assertion]s, in which this [Expect] collects the assertions created this way.
 *
 * @param T The type of the subject of this [Expect].
 */
interface CollectingExpect : Expect {

    /**
     * Returns the [Assertion]s which have been [appended][append] to this container.
     *
     * @return The [Assertion]s which have been [appended][append] to this container.
     */
    fun getAssertions(): List

    /**
     * Appends the [Assertion]s the given [assertionCreator] creates to this container and
     * returns an [Expect] which includes them.
     *
     * Whether the returned [Expect] is the same as the initial one is up to the implementation (i.e. if a mutable
     * structure is used or an immutable). Atrium strives for an immutable data structure in the long run and will
     * little by little refactor the code accordingly.
     *
     * @param assertionCreator The lambda which will create assertions.
     *
     * @return an [Expect] for the subject of `this` expectation.
     *
     * @throws AssertionError Might throw an [AssertionError] in case [Assertion]s are immediately evaluated.
    */
    fun appendAsGroup(assertionCreator: Expect.() -> Unit): CollectingExpect

    companion object {
        @OptIn(ExperimentalNewExpectTypes::class, ExperimentalComponentFactoryContainer::class)
        operator fun  invoke(
            maybeSubject: Option,
            componentFactoryContainer: ComponentFactoryContainer
        ): CollectingExpect =
            CollectingExpectImpl(maybeSubject, componentFactoryContainer)
    }
}