atrium-verbs

alltypes

abstract class ArgumentsSupportingTranslator : ITranslator

ArgumentsSupportingTranslator(primaryLocale: Locale)
protected val primaryLocale: Locale
fun translate(translatable: ITranslatable): String
protected abstract fun translateWithoutArgs(translatable: ITranslatable): String

enum class AssertionVerb : ISimpleTranslatable

ASSERT
ASSERT_THAT
ASSERT_THAT_THROWN
ASSERT_THROWN
EXPECT
EXPECT_THROWN
val value: String

object AtriumFactory : IAtriumFactory

fun <T : Any> newCheckImmediately(commonFields: CommonFields<T>): IAssertionPlant<T>
fun <T : Any> newCheckLazily(commonFields: CommonFields<T>): IAssertionPlant<T>
fun newDetailedObjectFormatter(translator: ITranslator): IObjectFormatter
fun <TSub : T, T : Any> newDownCastBuilder(description: ITranslatable, subType: KClass<TSub>, commonFields: CommonFields<T?>): IDownCastBuilder<T, TSub>
fun <T : Any> newFeatureAssertionChecker(subjectPlant: IAssertionPlant<T>): IAssertionChecker
fun newMethodCallFormatter(): IMethodCallFormatter
fun <T> newNullable(commonFields: CommonFields<T>): IAssertionPlantNullable<T>
fun newOnlyFailureReporter(assertionFormatter: IAssertionFormatter): IReporter
fun newSameLineAssertionFormatter(objectFormatter: IObjectFormatter, translator: ITranslator): IAssertionFormatter
fun newThrowableFluent(assertionVerb: ITranslatable, act: () -> Unit, reporter: IReporter): ThrowableFluent
fun newThrowableFluent(assertionVerb: ITranslatable, act: () -> Unit, assertionChecker: IAssertionChecker): ThrowableFluent
fun newThrowingAssertionChecker(reporter: IReporter): IAssertionChecker
fun newTranslator(translationSupplier: ITranslationSupplier, primaryLocale: Locale, vararg fallbackLocales: Locale): ITranslator

interface IAssertion

abstract fun holds(): Boolean

interface IAssertionChecker

abstract fun check(assertionVerb: ITranslatable, subject: Any, assertions: List<IAssertion>): Unit
abstract fun fail(assertionVerb: ITranslatable, subject: Any, assertion: IAssertion): Unit

interface IAssertionFormatter

abstract fun format(sb: StringBuilder, assertion: IAssertion, assertionFilter: (IAssertion) -> Boolean, messageFilter: (Message) -> Boolean): Unit

interface IAssertionGroup : IAssertion

abstract val assertions: List<IAssertion>
open fun holds(): Boolean
abstract val name: ITranslatable
abstract val subject: Any

interface IAssertionPlant<out T : Any> : IAssertionPlantWithCommonFields<T>

abstract fun addAssertion(assertion: IAssertion): IAssertionPlant<T>
open val and: IAssertionPlant<T>
abstract fun checkAssertions(): IAssertionPlant<T>
abstract fun createAndAddAssertion(description: ITranslatable, expected: Any, test: () -> Boolean): IAssertionPlant<T>

interface IAssertionPlantNullable<out T> : IAssertionPlantWithCommonFields<T>

object AssertionDescription : ISimpleTranslatable

val name: String
val value: String

abstract fun isNull(): Unit

interface IAssertionPlantWithCommonFields<out T>

data class CommonFields<out T>

CommonFields(assertionVerb: ITranslatable, subject: T, assertionChecker: IAssertionChecker)
val assertionChecker: IAssertionChecker
val assertionVerb: ITranslatable
fun check(assertions: List<IAssertion>): Unit
fun fail(assertion: IAssertion): Unit
val subject: T

abstract val commonFields: CommonFields<T>
open val subject: T

interface IAtriumFactory

open fun <T : Any> newCheckImmediately(assertionVerb: ITranslatable, subject: T, reporter: IReporter): IAssertionPlant<T>
open fun <T : Any> newCheckImmediately(assertionVerb: ITranslatable, subject: T, assertionChecker: IAssertionChecker): IAssertionPlant<T>
abstract fun <T : Any> newCheckImmediately(commonFields: CommonFields<T>): IAssertionPlant<T>
open fun <T : Any> newCheckLazily(assertionVerb: ITranslatable, subject: T, reporter: IReporter): IAssertionPlant<T>
open fun <T : Any> newCheckLazily(assertionVerb: ITranslatable, subject: T, assertionChecker: IAssertionChecker): IAssertionPlant<T>
abstract fun <T : Any> newCheckLazily(commonFields: CommonFields<T>): IAssertionPlant<T>
abstract fun newDetailedObjectFormatter(translator: ITranslator): IObjectFormatter
abstract fun <TSub : T, T : Any> newDownCastBuilder(description: ITranslatable, subType: KClass<TSub>, commonFields: CommonFields<T?>): IDownCastBuilder<T, TSub>
abstract fun <T : Any> newFeatureAssertionChecker(subjectPlant: IAssertionPlant<T>): IAssertionChecker
abstract fun newMethodCallFormatter(): IMethodCallFormatter
open fun <T> newNullable(assertionVerb: ITranslatable, subject: T, reporter: IReporter): IAssertionPlantNullable<T>
open fun <T> newNullable(assertionVerb: ITranslatable, subject: T, assertionChecker: IAssertionChecker): IAssertionPlantNullable<T>
abstract fun <T> newNullable(commonFields: CommonFields<T>): IAssertionPlantNullable<T>
abstract fun newOnlyFailureReporter(assertionFormatter: IAssertionFormatter): IReporter
abstract fun newSameLineAssertionFormatter(objectFormatter: IObjectFormatter, translator: ITranslator): IAssertionFormatter
abstract fun newThrowingAssertionChecker(reporter: IReporter): IAssertionChecker
abstract fun newTranslator(translationSupplier: ITranslationSupplier, primaryLocale: Locale, vararg fallbackLocales: Locale): ITranslator

interface IDownCastBuilder<T : Any, TSub : T>

abstract fun cast(): IAssertionPlant<TSub>
abstract fun withLazyAssertions(createAssertions: IAssertionPlant<TSub>.() -> Unit): IDownCastBuilder<T, TSub>
abstract fun withNullRepresentation(representation: String): IDownCastBuilder<T, TSub>
abstract fun withNullRepresentation(translatableRepresentation: ITranslatable): IDownCastBuilder<T, TSub>

interface IFeatureAssertionGroup : IAssertion

abstract val assertions: List<IAssertion>
abstract val feature: Any
abstract val featureName: ITranslatable
open fun holds(): Boolean

interface ILocaleOrderDecider

abstract fun determineOrder(primaryLocale: Locale, fallbackLocales: Array<out Locale>): Sequence<Locale>

interface IMethodCallFormatter

abstract fun format(method: KCallable<*>, arguments: Array<out Any?>): () -> String

interface IMultiMessageAssertion : IAssertion

open fun holds(): Boolean
abstract val messages: List<Message>

interface IObjectFormatter

abstract fun format(value: Any?): String

interface IOneMessageAssertion : IAssertion

open fun holds(): Boolean
abstract val message: Message

interface IRawString
interface IReporter

abstract fun format(sb: StringBuilder, assertion: IAssertion): Unit

interface ISimpleTranslatable : ITranslatable

open fun getDefault(): String
abstract val value: String

interface IThrowableFluent

enum class AssertionDescription : ISimpleTranslatable

IS_A
NO_EXCEPTION_OCCURRED
val value: String

abstract val commonFields: CommonFields<Throwable?>
abstract fun <TExpected : Throwable> toThrow(expectedType: KClass<TExpected>): IAssertionPlant<TExpected>
abstract fun <TExpected : Throwable> toThrow(expectedType: KClass<TExpected>, createAssertions: IAssertionPlant<TExpected>.() -> Unit): IAssertionPlant<TExpected>

interface ITranslatable

const val ID_SEPARATOR: String
abstract fun getDefault(): String
open val id: String
abstract val name: String

interface ITranslatableWithArgs : ITranslatable

abstract val arguments: Array<Any>
open fun getDefault(): String
open val id: String
open val name: String
abstract val translatable: ITranslatable

interface ITranslationSupplier

abstract fun get(translatable: ITranslatable, locale: Locale): String?

interface ITranslator

abstract fun translate(translatable: ITranslatable): String

data class Message

Message(description: ITranslatable, representation: Any, holds: Boolean)
val description: ITranslatable
val holds: Boolean
val representation: Any

data class RawString : IRawString

RawString(string: String)
val NULL: RawString
val string: String

class ThrowableFluent : IThrowableFluent

val commonFields: CommonFields<Throwable?>
inline fun <reified TExpected : Throwable> toThrow(): IAssertionPlant<TExpected>
fun <TExpected : Throwable> toThrow(expectedType: KClass<TExpected>): IAssertionPlant<TExpected>
inline fun <reified TExpected : Throwable> toThrow(noinline createAssertions: IAssertionPlant<TExpected>.() -> Unit): IAssertionPlant<TExpected>
fun <TExpected : Throwable> toThrow(expectedType: KClass<TExpected>, createAssertions: IAssertionPlant<TExpected>.() -> Unit): IAssertionPlant<TExpected>

data class TranslatableRawString : IRawString

TranslatableRawString(translatable: ITranslatable)
val translatable: ITranslatable

class TranslatableWithArgs : ITranslatableWithArgs

TranslatableWithArgs(translatable: ITranslatable, argument: Any)
TranslatableWithArgs(translatable: ITranslatable, arg1: Any, vararg otherArguments: Any)
TranslatableWithArgs(translatable: ITranslatable, arguments: Array<Any>)
val arguments: Array<Any>
val translatable: ITranslatable

class UsingDefaultTranslator : ArgumentsSupportingTranslator

UsingDefaultTranslator(primaryLocale: Locale = Locale.getDefault())
protected fun translateWithoutArgs(translatable: ITranslatable): String

package ch.tutteli.atrium

object AtriumFactory : IAtriumFactory

fun <T : Any> newCheckImmediately(commonFields: CommonFields<T>): IAssertionPlant<T>
fun <T : Any> newCheckLazily(commonFields: CommonFields<T>): IAssertionPlant<T>
fun newDetailedObjectFormatter(translator: ITranslator): IObjectFormatter
fun <TSub : T, T : Any> newDownCastBuilder(description: ITranslatable, subType: KClass<TSub>, commonFields: CommonFields<T?>): IDownCastBuilder<T, TSub>
fun <T : Any> newFeatureAssertionChecker(subjectPlant: IAssertionPlant<T>): IAssertionChecker
fun newMethodCallFormatter(): IMethodCallFormatter
fun <T> newNullable(commonFields: CommonFields<T>): IAssertionPlantNullable<T>
fun newOnlyFailureReporter(assertionFormatter: IAssertionFormatter): IReporter
fun newSameLineAssertionFormatter(objectFormatter: IObjectFormatter, translator: ITranslator): IAssertionFormatter
fun newThrowableFluent(assertionVerb: ITranslatable, act: () -> Unit, reporter: IReporter): ThrowableFluent
fun newThrowableFluent(assertionVerb: ITranslatable, act: () -> Unit, assertionChecker: IAssertionChecker): ThrowableFluent
fun newThrowingAssertionChecker(reporter: IReporter): IAssertionChecker
fun newTranslator(translationSupplier: ITranslationSupplier, primaryLocale: Locale, vararg fallbackLocales: Locale): ITranslator

interface IAtriumFactory

open fun <T : Any> newCheckImmediately(assertionVerb: ITranslatable, subject: T, reporter: IReporter): IAssertionPlant<T>
open fun <T : Any> newCheckImmediately(assertionVerb: ITranslatable, subject: T, assertionChecker: IAssertionChecker): IAssertionPlant<T>
abstract fun <T : Any> newCheckImmediately(commonFields: CommonFields<T>): IAssertionPlant<T>
open fun <T : Any> newCheckLazily(assertionVerb: ITranslatable, subject: T, reporter: IReporter): IAssertionPlant<T>
open fun <T : Any> newCheckLazily(assertionVerb: ITranslatable, subject: T, assertionChecker: IAssertionChecker): IAssertionPlant<T>
abstract fun <T : Any> newCheckLazily(commonFields: CommonFields<T>): IAssertionPlant<T>
abstract fun newDetailedObjectFormatter(translator: ITranslator): IObjectFormatter
abstract fun <TSub : T, T : Any> newDownCastBuilder(description: ITranslatable, subType: KClass<TSub>, commonFields: CommonFields<T?>): IDownCastBuilder<T, TSub>
abstract fun <T : Any> newFeatureAssertionChecker(subjectPlant: IAssertionPlant<T>): IAssertionChecker
abstract fun newMethodCallFormatter(): IMethodCallFormatter
open fun <T> newNullable(assertionVerb: ITranslatable, subject: T, reporter: IReporter): IAssertionPlantNullable<T>
open fun <T> newNullable(assertionVerb: ITranslatable, subject: T, assertionChecker: IAssertionChecker): IAssertionPlantNullable<T>
abstract fun <T> newNullable(commonFields: CommonFields<T>): IAssertionPlantNullable<T>
abstract fun newOnlyFailureReporter(assertionFormatter: IAssertionFormatter): IReporter
abstract fun newSameLineAssertionFormatter(objectFormatter: IObjectFormatter, translator: ITranslator): IAssertionFormatter
abstract fun newThrowingAssertionChecker(reporter: IReporter): IAssertionChecker
abstract fun newTranslator(translationSupplier: ITranslationSupplier, primaryLocale: Locale, vararg fallbackLocales: Locale): ITranslator

inline fun <T : Any> IAtriumFactory.newCheckLazilyAtTheEnd(assertionVerb: ITranslatable, subject: T, reporter: IReporter, createAssertions: IAssertionPlant<T>.() -> Unit): IAssertionPlant<T>
inline fun <reified TSub : T, T : Any> IAtriumFactory.newDownCastBuilder(description: ITranslatable, commonFields: CommonFields<T?>): IDownCastBuilder<T, TSub>

package ch.tutteli.atrium.assertions

interface IAssertion

abstract fun holds(): Boolean

interface IAssertionGroup : IAssertion

abstract val assertions: List<IAssertion>
open fun holds(): Boolean
abstract val name: ITranslatable
abstract val subject: Any

interface IFeatureAssertionGroup : IAssertion

abstract val assertions: List<IAssertion>
abstract val feature: Any
abstract val featureName: ITranslatable
open fun holds(): Boolean

interface IMultiMessageAssertion : IAssertion

open fun holds(): Boolean
abstract val messages: List<Message>

interface IOneMessageAssertion : IAssertion

open fun holds(): Boolean
abstract val message: Message

data class Message

Message(description: ITranslatable, representation: Any, holds: Boolean)
val description: ITranslatable
val holds: Boolean
val representation: Any

package ch.tutteli.atrium.checking

interface IAssertionChecker

abstract fun check(assertionVerb: ITranslatable, subject: Any, assertions: List<IAssertion>): Unit
abstract fun fail(assertionVerb: ITranslatable, subject: Any, assertion: IAssertion): Unit

package ch.tutteli.atrium.creating

interface IAssertionPlant<out T : Any> : IAssertionPlantWithCommonFields<T>

abstract fun addAssertion(assertion: IAssertion): IAssertionPlant<T>
open val and: IAssertionPlant<T>
abstract fun checkAssertions(): IAssertionPlant<T>
abstract fun createAndAddAssertion(description: ITranslatable, expected: Any, test: () -> Boolean): IAssertionPlant<T>

interface IAssertionPlantNullable<out T> : IAssertionPlantWithCommonFields<T>

object AssertionDescription : ISimpleTranslatable

val name: String
val value: String

abstract fun isNull(): Unit

interface IAssertionPlantWithCommonFields<out T>

data class CommonFields<out T>

CommonFields(assertionVerb: ITranslatable, subject: T, assertionChecker: IAssertionChecker)
val assertionChecker: IAssertionChecker
val assertionVerb: ITranslatable
fun check(assertions: List<IAssertion>): Unit
fun fail(assertion: IAssertion): Unit
val subject: T

abstract val commonFields: CommonFields<T>
open val subject: T

interface IDownCastBuilder<T : Any, TSub : T>

abstract fun cast(): IAssertionPlant<TSub>
abstract fun withLazyAssertions(createAssertions: IAssertionPlant<TSub>.() -> Unit): IDownCastBuilder<T, TSub>
abstract fun withNullRepresentation(representation: String): IDownCastBuilder<T, TSub>
abstract fun withNullRepresentation(translatableRepresentation: ITranslatable): IDownCastBuilder<T, TSub>

interface IThrowableFluent

enum class AssertionDescription : ISimpleTranslatable

IS_A
NO_EXCEPTION_OCCURRED
val value: String

abstract val commonFields: CommonFields<Throwable?>
abstract fun <TExpected : Throwable> toThrow(expectedType: KClass<TExpected>): IAssertionPlant<TExpected>
abstract fun <TExpected : Throwable> toThrow(expectedType: KClass<TExpected>, createAssertions: IAssertionPlant<TExpected>.() -> Unit): IAssertionPlant<TExpected>

class ThrowableFluent : IThrowableFluent

val commonFields: CommonFields<Throwable?>
inline fun <reified TExpected : Throwable> toThrow(): IAssertionPlant<TExpected>
fun <TExpected : Throwable> toThrow(expectedType: KClass<TExpected>): IAssertionPlant<TExpected>
inline fun <reified TExpected : Throwable> toThrow(noinline createAssertions: IAssertionPlant<TExpected>.() -> Unit): IAssertionPlant<TExpected>
fun <TExpected : Throwable> toThrow(expectedType: KClass<TExpected>, createAssertions: IAssertionPlant<TExpected>.() -> Unit): IAssertionPlant<TExpected>

inline fun <T : Any> IAssertionPlant<T>.createAssertionsAndCheckThem(createAssertions: IAssertionPlant<T>.() -> Unit): IAssertionPlant<T>

package ch.tutteli.atrium.reporting

interface IAssertionFormatter

abstract fun format(sb: StringBuilder, assertion: IAssertion, assertionFilter: (IAssertion) -> Boolean, messageFilter: (Message) -> Boolean): Unit

interface IMethodCallFormatter

abstract fun format(method: KCallable<*>, arguments: Array<out Any?>): () -> String

interface IObjectFormatter

abstract fun format(value: Any?): String

interface IRawString
interface IReporter

abstract fun format(sb: StringBuilder, assertion: IAssertion): Unit

data class RawString : IRawString

RawString(string: String)
val NULL: RawString
val string: String

package ch.tutteli.atrium.reporting.translating

abstract class ArgumentsSupportingTranslator : ITranslator

ArgumentsSupportingTranslator(primaryLocale: Locale)
protected val primaryLocale: Locale
fun translate(translatable: ITranslatable): String
protected abstract fun translateWithoutArgs(translatable: ITranslatable): String

interface ILocaleOrderDecider

abstract fun determineOrder(primaryLocale: Locale, fallbackLocales: Array<out Locale>): Sequence<Locale>

interface ISimpleTranslatable : ITranslatable

open fun getDefault(): String
abstract val value: String

interface ITranslatable

const val ID_SEPARATOR: String
abstract fun getDefault(): String
open val id: String
abstract val name: String

interface ITranslatableWithArgs : ITranslatable

abstract val arguments: Array<Any>
open fun getDefault(): String
open val id: String
open val name: String
abstract val translatable: ITranslatable

interface ITranslationSupplier

abstract fun get(translatable: ITranslatable, locale: Locale): String?

interface ITranslator

abstract fun translate(translatable: ITranslatable): String

data class TranslatableRawString : IRawString

TranslatableRawString(translatable: ITranslatable)
val translatable: ITranslatable

class TranslatableWithArgs : ITranslatableWithArgs

TranslatableWithArgs(translatable: ITranslatable, argument: Any)
TranslatableWithArgs(translatable: ITranslatable, arg1: Any, vararg otherArguments: Any)
TranslatableWithArgs(translatable: ITranslatable, arguments: Array<Any>)
val arguments: Array<Any>
val translatable: ITranslatable

class UsingDefaultTranslator : ArgumentsSupportingTranslator

UsingDefaultTranslator(primaryLocale: Locale = Locale.getDefault())
protected fun translateWithoutArgs(translatable: ITranslatable): String

package ch.tutteli.atrium.verbs

enum class AssertionVerb : ISimpleTranslatable

ASSERT
ASSERT_THAT
ASSERT_THAT_THROWN
ASSERT_THROWN
EXPECT
EXPECT_THROWN
val value: String

package ch.tutteli.atrium.verbs.assert

fun <T : Any> assert(subject: T): IAssertionPlant<T>
inline fun <T : Any> assert(subject: T, createAssertions: IAssertionPlant<T>.() -> Unit): IAssertionPlant<T>
fun assert(act: () -> Unit): ThrowableFluent

package ch.tutteli.atrium.verbs.assertthat

fun <T : Any> assertThat(subject: T): IAssertionPlant<T>
inline fun <T : Any> assertThat(subject: T, createAssertions: IAssertionPlant<T>.() -> Unit): IAssertionPlant<T>
fun assertThat(act: () -> Unit): ThrowableFluent

package ch.tutteli.atrium.verbs.expect

fun <T : Any> expect(subject: T): IAssertionPlant<T>
inline fun <T : Any> expect(subject: T, createAssertions: IAssertionPlant<T>.() -> Unit): IAssertionPlant<T>
fun expect(act: () -> Unit): ThrowableFluent