diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/anyAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/anyAssertions.kt index 02bf6492c..5436baa1f 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/anyAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/anyAssertions.kt @@ -8,7 +8,7 @@ import ch.tutteli.atrium.reporting.Reporter /** * Expects that the subject of the assertion is (equal to) [expected]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun Expect.toBe(expected: T) = addAssertion(ExpectImpl.any.toBe(this, expected)) @@ -16,7 +16,7 @@ fun Expect.toBe(expected: T) = addAssertion(ExpectImpl.any.toBe(this, exp /** * Expects that the subject of the assertion is not (equal to) [expected]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun Expect.notToBe(expected: T) = addAssertion(ExpectImpl.any.notToBe(this, expected)) @@ -24,7 +24,7 @@ fun Expect.notToBe(expected: T) = addAssertion(ExpectImpl.any.notToBe(thi /** * Expects that the subject of the assertion is the same instance as [expected]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun Expect.isSameAs(expected: T) = addAssertion(ExpectImpl.any.isSame(this, expected)) @@ -32,7 +32,7 @@ fun Expect.isSameAs(expected: T) = addAssertion(ExpectImpl.any.isSame(thi /** * Expects that the subject of the assertion is not the same instance as [expected]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun Expect.isNotSameAs(expected: T) = addAssertion(ExpectImpl.any.isNotSame(this, expected)) @@ -47,7 +47,7 @@ fun Expect.isNotSameAs(expected: T) = addAssertion(ExpectImpl.any.isNotSa * else notToBeNull(assertionCreatorOrNull) * ``` * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ inline fun Expect.toBeNullIfNullGivenElse( @@ -59,7 +59,7 @@ inline fun Expect.toBeNullIfNullGivenElse( * * It delegates to [isA] with [T] as type. * - * @return An assertion container with the non-nullable type [T] (was `T?` before). + * @return An [Expect] with the non-nullable type [T] (was `T?` before). * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ @Suppress(/* less magic */ "RemoveExplicitTypeArguments") @@ -71,7 +71,7 @@ inline fun Expect.notToBeNull(): Expect = isA() * * It delegates to [isA] with [T] as type. * - * @return An assertion container with the non-nullable type [T] (was `T?` before) + * @return An [Expect] with the non-nullable type [T] (was `T?` before) * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ @Suppress(/* less magic */ "RemoveExplicitTypeArguments") @@ -94,7 +94,7 @@ inline fun Expect.notToBeNull(noinline assertionCreator: E * the element type is actually `String`. Or in other words * `assert(listOf(1, 2)).isA>{}` holds, even though `List` is clearly not a `List`. * - * @return An assertion container with the new type [TSub]. + * @return An [Expect] with the new type [TSub]. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ inline fun Expect<*>.isA(): Expect = @@ -138,7 +138,7 @@ inline fun Expect<*>.isA(): Expect = * the element type is actually `String`. Or in other words * `assert(listOf(1, 2)).isA>{}` holds, even though `List` is clearly not a `List`. * - * @return An assertion container with the new type [TSub]. + * @return An [Expect] with the new type [TSub]. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ inline fun Expect<*>.isA(noinline assertionCreator: Expect.() -> Unit): Expect = @@ -152,7 +152,7 @@ inline fun Expect<*>.isA(noinline assertionCreator: Expect< * asserts that 1 is greater than 0. If the first assertion fails, then usually (depending on the configured * [AssertionChecker]) the second assertion is not evaluated. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. */ inline val Expect.and: Expect get() = this @@ -164,6 +164,6 @@ inline val Expect.and: Expect get() = this * second one is evaluated as a whole. Meaning, even though 1 is not even, it still evaluates that 1 is greater than 1. * Hence the reporting might (depending on the configured [Reporter]) contain both failing sub-assertions. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. */ infix fun Expect.and(assertionCreator: Expect.() -> Unit) = addAssertionsCreatedBy(assertionCreator) diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/charSequenceAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/charSequenceAssertions.kt index 85ce8f0a3..49ca8b16c 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/charSequenceAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/charSequenceAssertions.kt @@ -47,7 +47,7 @@ val Expect.containsNot: NotCheckerOption Expect.contains(expected: Any, vararg otherExpected: A * Notice that a runtime check applies which assures that only [CharSequence], [Number] and [Char] are passed (this * function expects `Any` for your convenience, so that you can mix [String] and [Int] for instance). * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun Expect.containsNot(expected: Any, vararg otherExpected: Any) = @@ -90,7 +90,7 @@ fun Expect.containsNot(expected: Any, vararg otherExpected * @param pattern The pattern which is expected to have a match against the input of the search. * @param otherPatterns Additional patterns which are expected to have a match against the input of the search. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun Expect.containsRegex(pattern: String, vararg otherPatterns: String): Expect = @@ -116,7 +116,7 @@ fun Expect.containsRegex(pattern: String, vararg otherPatt * @param pattern The pattern which is expected to have a match against the input of the search. * @param otherPatterns Additional patterns which are expected to have a match against the input of the search. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -127,7 +127,7 @@ fun Expect.containsRegex(pattern: Regex, vararg otherPatte /** * Expects that the subject of the assertion (a [CharSequence]) starts with [expected]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun Expect.startsWith(expected: CharSequence) = @@ -136,7 +136,7 @@ fun Expect.startsWith(expected: CharSequence) = /** * Expects that the subject of the assertion (a [CharSequence]) starts with [expected]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -146,7 +146,7 @@ fun Expect.startsWith(expected: Char) = startsWith(expecte /** * Expects that the subject of the assertion (a [CharSequence]) does not start with [expected]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun Expect.startsNotWith(expected: CharSequence) = @@ -155,7 +155,7 @@ fun Expect.startsNotWith(expected: CharSequence) = /** * Expects that the subject of the assertion (a [CharSequence]) does not start with [expected]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -166,7 +166,7 @@ fun Expect.startsNotWith(expected: Char) = startsNotWith(e /** * Expects that the subject of the assertion (a [CharSequence]) ends with [expected]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun Expect.endsWith(expected: CharSequence) = @@ -175,7 +175,7 @@ fun Expect.endsWith(expected: CharSequence) = /** * Expects that the subject of the assertion (a [CharSequence]) ends with [expected]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -185,7 +185,7 @@ fun Expect.endsWith(expected: Char) = endsWith(expected.to /** * Expects that the subject of the assertion (a [CharSequence]) does not end with [expected]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun Expect.endsNotWith(expected: CharSequence) = @@ -194,7 +194,7 @@ fun Expect.endsNotWith(expected: CharSequence) = /** * Expects that the subject of the assertion (a [CharSequence]) does not end with [expected]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -205,7 +205,7 @@ fun Expect.endsNotWith(expected: Char) = endsNotWith(expec /** * Expects that the subject of the assertion (a [CharSequence]) [CharSequence].[kotlin.text.isEmpty]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun Expect.isEmpty() = addAssertion(ExpectImpl.charSequence.isEmpty(this)) @@ -213,7 +213,7 @@ fun Expect.isEmpty() = addAssertion(ExpectImpl.charSequenc /** * Expects that the subject of the assertion (a [CharSequence]) [CharSequence].[kotlin.text.isNotEmpty]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun Expect.isNotEmpty() = addAssertion(ExpectImpl.charSequence.isNotEmpty(this)) @@ -221,7 +221,7 @@ fun Expect.isNotEmpty() = addAssertion(ExpectImpl.charSequ /** * Expects that the subject of the assertion (a [CharSequence]) [CharSequence].[kotlin.text.isNotBlank]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun Expect.isNotBlank() = addAssertion(ExpectImpl.charSequence.isNotBlank(this)) @@ -229,7 +229,7 @@ fun Expect.isNotBlank() = addAssertion(ExpectImpl.charSequ /** * Expects that the subject of the assertion (a [CharSequence]) matches the given [expected] [Regex]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -240,7 +240,7 @@ fun Expect.matches(expected: Regex) = /** * Expects that the subject of the assertion (a [CharSequence]) mismatches the given [expected] [Regex]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/collectionAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/collectionAssertions.kt index 3fc129558..46913253a 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/collectionAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/collectionAssertions.kt @@ -6,7 +6,7 @@ import ch.tutteli.atrium.domain.builders.ExpectImpl /** * Expects that the subject of the assertion (a [Collection]) is an empty [Collection]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.isEmpty() = addAssertion(ExpectImpl.collection.isEmpty(this)) @@ -14,7 +14,7 @@ fun > Expect.isEmpty() = addAssertion(ExpectImpl.collection /** * Expects that the subject of the assertion (a [Collection]) is not an empty [Collection]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.isNotEmpty() = addAssertion(ExpectImpl.collection.isNotEmpty(this)) @@ -22,9 +22,9 @@ fun > Expect.isNotEmpty() = addAssertion(ExpectImpl.collect /** * Expects that the subject of the assertion (a [Collection]) has the given [expected] size. * - * Shortcut for `expected.toBe(expectedSize)`. + * Shortcut for `size.toBe(expected)`. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.hasSize(expected: Int) = size { toBe(expected) } @@ -33,16 +33,16 @@ fun > Expect.hasSize(expected: Int) = size { toBe(expected) * Creates an [Expect] for the property [Collection.size] of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. */ val > Expect.size: Expect get() = ExpectImpl.collection.size(this).getExpectOfFeature() /** * Expects that the property [Collection.size] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.size(assertionCreator: Expect.() -> Unit): Expect = diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/comparableAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/comparableAssertions.kt index c96f93aad..7f1151866 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/comparableAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/comparableAssertions.kt @@ -7,7 +7,7 @@ import ch.tutteli.atrium.domain.builders.ExpectImpl * Expects that the subject of the assertion is less than [expected]. * The comparison is carried out with [Comparable.compareTo]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.isLessThan(expected: T) = @@ -17,7 +17,7 @@ fun > Expect.isLessThan(expected: T) = * Expects that the subject of the assertion is less than or equal [expected]. * The comparison is carried out with [Comparable.compareTo]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.isLessThanOrEqual(expected: T) = @@ -27,7 +27,7 @@ fun > Expect.isLessThanOrEqual(expected: T) = * Expects that the subject of the assertion is greater than [expected]. * The comparison is carried out with [Comparable.compareTo]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.isGreaterThan(expected: T) = @@ -37,7 +37,7 @@ fun > Expect.isGreaterThan(expected: T) = * Expects that the subject of the assertion is greater than or equal [expected]. * The comparison is carried out with [Comparable.compareTo]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.isGreaterThanOrEqual(expected: T) = diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/expectExtensions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/expectExtensions.kt index 5afdcfcf6..422e620ea 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/expectExtensions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/expectExtensions.kt @@ -20,6 +20,8 @@ annotation class ExperimentalWithOptions * instead of the representation that has been defined so far (which defaults to the subject itself). * * In case [Expect.maybeSubject] is not defined i.e. [None], then the previous representation is used. + * + * @return An [Expect] for the current subject of the assertion. */ @ExperimentalWithOptions fun RootExpect.withRepresentation(textRepresentation: String): Expect = @@ -36,6 +38,8 @@ fun RootExpect.withRepresentation(textRepresentation: String): Expect * a `String` and does the wrapping for you. * * In case [Expect.maybeSubject] is not defined i.e. [None], then the previous representation is used. + * + * @return An [Expect] for the current subject of the assertion. */ @ExperimentalWithOptions fun RootExpect.withRepresentation(representationProvider: (T) -> Any): Expect = @@ -44,6 +48,8 @@ fun RootExpect.withRepresentation(representationProvider: (T) -> Any): Ex /** * Uses the given [configuration]-lambda to create an [ExpectOptions] which in turn is used * to override (parts) of the existing configuration. + * + * @return An [Expect] for the current subject of the assertion. */ @ExperimentalWithOptions fun RootExpect.withOptions(configuration: ExpectBuilder.OptionsChooser.() -> Unit): Expect = @@ -53,6 +59,8 @@ fun RootExpect.withOptions(configuration: ExpectBuilder.OptionsChooser //in the same go we should get rid of ReportingAssertionContainer.AssertionCheckerDecorator, rename it respectively. /** * Uses the given [options] to override (parts) of the existing configuration. + * + * @return An [Expect] for the current subject of the assertion. */ @ExperimentalWithOptions @UseExperimental(ExperimentalExpectConfig::class) @@ -73,6 +81,8 @@ fun RootExpect.withOptions(options: ExpectOptions): Expect = coreFa * instead of the representation that has been defined so far (which defaults to the subject itself). * * In case [Expect.maybeSubject] is not defined i.e. [None], then the previous representation is used. + * + * @return An [Expect] for the current subject of the assertion. */ @ExperimentalWithOptions fun FeatureExpect.withRepresentation(textRepresentation: String): Expect = @@ -89,6 +99,8 @@ fun FeatureExpect.withRepresentation(textRepresentation: String): E * a `String` and does the wrapping for you. * * In case [Expect.maybeSubject] is not defined i.e. [None], then the previous representation is used. + * + * @return An [Expect] for the current subject of the assertion. */ @ExperimentalWithOptions fun FeatureExpect.withRepresentation(representationProvider: (R) -> Any): Expect = @@ -97,6 +109,8 @@ fun FeatureExpect.withRepresentation(representationProvider: (R) -> /** * Uses the given [configuration]-lambda to create an [ExpectOptions] which in turn is used * to override (parts) of the existing configuration. + * + * @return An [Expect] for the current subject of the assertion. */ @ExperimentalWithOptions fun FeatureExpect.withOptions(configuration: FeatureExtractorBuilder.OptionsChooser.() -> Unit): Expect = @@ -104,6 +118,8 @@ fun FeatureExpect.withOptions(configuration: FeatureExtractorBuilde /** * Uses the given [options] to override (parts) of the existing configuration. + * + * @return An [Expect] for the current subject of the assertion. */ @ExperimentalWithOptions @UseExperimental(ExperimentalExpectConfig::class) diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/featureAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/featureAssertions.kt index d18e87aa7..68142486d 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/featureAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/featureAssertions.kt @@ -13,7 +13,7 @@ import kotlin.reflect.* * creates a new [Expect] for it and * returns it so that subsequent calls are based on the feature. * - * @return An [Expect] for the given [property]. + * @return The newly created [Expect] for the given [property]. * * @since 0.9.0 */ @@ -26,7 +26,7 @@ fun Expect.feature(property: KProperty1): FeatureExpect * applies an assertion group based on the given [assertionCreator] for the feature and * returns the initial [Expect] with the current subject. * - * @return The current [Expect]. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] in case the created [AssertionGroup] does not hold. * * @since 0.9.0 @@ -42,7 +42,7 @@ fun Expect.feature( * creates a new [Expect] for it and * returns it so that subsequent calls are based on the feature. * - * @return An [Expect] for the return value of calling [f] on the current subject of the assertion. + * @return The newly created [Expect] for the return value of calling [f] on the current subject of the assertion. * * @since 0.9.0 */ @@ -55,7 +55,7 @@ fun Expect.feature(f: KFunction1): FeatureExpect = * applies an assertion group based on the given [assertionCreator] for the feature and * returns the initial [Expect] with the current subject. * - * @return The current [Expect]. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] in case the created [AssertionGroup] does not hold. * * @since 0.9.0 @@ -72,7 +72,7 @@ fun Expect.feature( * creates a new [Expect] for it and * returns it so that subsequent calls are based on the feature. * - * @return An [Expect] for the return value of calling [f] on the current subject of the assertion. + * @return The newly created [Expect] for the return value of calling [f] on the current subject of the assertion. * * @since 0.9.0 */ @@ -88,7 +88,7 @@ fun Expect.feature( * applies an assertion group based on the given [assertionCreator] for the feature and * returns the initial [Expect] with the current subject. * - * @return The current [Expect]. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] in case the created [AssertionGroup] does not hold. * * @since 0.9.0 @@ -106,7 +106,7 @@ fun Expect.feature( * creates a new [Expect] for it and * returns it so that subsequent calls are based on the feature. * - * @return An [Expect] for the return value of calling [f] on the current subject of the assertion. + * @return The newly created [Expect] for the return value of calling [f] on the current subject of the assertion. * * @since 0.9.0 */ @@ -122,7 +122,7 @@ fun Expect.feature( * applies an assertion group based on the given [assertionCreator] for the feature and * returns the initial [Expect] with the current subject. * - * @return The current [Expect]. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] in case the created [AssertionGroup] does not hold. * * @since 0.9.0 @@ -140,7 +140,7 @@ fun Expect.feature( * creates a new [Expect] for it and * returns it so that subsequent calls are based on the feature. * - * @return An [Expect] for the return value of calling [f] on the current subject of the assertion. + * @return The newly created [Expect] for the return value of calling [f] on the current subject of the assertion. * * @since 0.9.0 */ @@ -156,7 +156,7 @@ fun Expect.feature( * applies an assertion group based on the given [assertionCreator] for the feature and * returns the initial [Expect] with the current subject. * - * @return The current [Expect]. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] in case the created [AssertionGroup] does not hold. * * @since 0.9.0 @@ -174,7 +174,7 @@ fun Expect.feature( * creates a new [Expect] for it and * returns it so that subsequent calls are based on the feature. * - * @return An [Expect] for the return value of calling [f] on the current subject of the assertion. + * @return The newly created [Expect] for the return value of calling [f] on the current subject of the assertion. * * @since 0.9.0 */ @@ -190,7 +190,7 @@ fun Expect.feature( * applies an assertion group based on the given [assertionCreator] for the feature and * returns the initial [Expect] with the current subject. * - * @return The current [Expect]. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] in case the created [AssertionGroup] does not hold. * * @since 0.9.0 @@ -208,7 +208,7 @@ fun Expect.feature( * creates a new [Expect] for it and * returns it so that subsequent calls are based on the feature. * - * @return An [Expect] for the return value of calling [f] on the current subject of the assertion. + * @return The newly [Expect] for the return value of calling [f] on the current subject of the assertion. * * @since 0.9.0 */ @@ -224,7 +224,7 @@ fun Expect.feature( * applies an assertion group based on the given [assertionCreator] for the feature and * returns the initial [Expect] with the current subject. * - * @return The current [Expect]. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] in case the created [AssertionGroup] does not hold. * * @since 0.9.0 @@ -245,7 +245,7 @@ fun Expect.feature( * @param provider Extracts the feature where the subject of the assertion is available via * implicit parameter `it`. * - * @return An [Expect] for the extracted feature. + * @return The newly created [Expect] for the extracted feature. * * @since 0.9.0 */ @@ -262,7 +262,7 @@ fun Expect.feature(description: String, provider: T.() -> R): FeatureE * @param provider Extracts the feature where the subject of the assertion is available via * implicit parameter `it`. * - * @return The current [Expect]. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] in case the created [AssertionGroup] does not hold. * * @since 0.9.0 @@ -284,7 +284,7 @@ fun Expect.feature( * implicit parameter `it`. Usually you use [f][MetaFeatureOption.f] to create a [MetaFeature], * e.g. `feature { f(it::size) }` * - * @return An [Expect] for the extracted feature. + * @return The newly created [Expect] for the extracted feature. * * @since 0.9.0 */ @@ -301,7 +301,7 @@ fun Expect.feature(provider: MetaFeatureOption.(T) -> MetaFeature.toBeWithErrorTolerance(expected: Float, tolerance: Float) = @@ -34,7 +34,7 @@ fun Expect.toBeWithErrorTolerance(expected: Float, tolerance: Float) = * * | `subject of the assertion` - [expected] | ≤ [tolerance] * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun Expect.toBeWithErrorTolerance(expected: Double, tolerance: Double) = diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/fun0Assertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/fun0Assertions.kt index 800df45d8..c985389c4 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/fun0Assertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/fun0Assertions.kt @@ -10,7 +10,7 @@ import ch.tutteli.atrium.domain.builders.ExpectImpl * For instance `toThrow>` would only check if the subject is a `MyException` without checking if * the element type is actually `String`. * - * @return An assertion container with the new type [TExpected]. + * @return An [Expect] with the new type [TExpected]. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ inline fun Expect Any?>.toThrow(): Expect = @@ -46,7 +46,7 @@ inline fun Expect Any?>.toThrow(): Exp * For instance `toThrow>` would only check if the subject is a `MyException` without checking if * the element type is actually `String`. * - * @return An assertion container with the new type [TExpected]. + * @return An [Expect] with the new type [TExpected]. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ inline fun Expect Any?>.toThrow( @@ -58,6 +58,7 @@ inline fun Expect Any?>.toThrow( * Expects that no [Throwable] is thrown at all when calling the subject (a lambda with arity 0, i.e. without arguments) * and changes the subject of the assertion to the return value of type [R]. * + * @return An [Expect] with the new type [R]. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun R> Expect.notToThrow(): Expect = ExpectImpl.fun0.isNotThrowing(this).getExpectOfFeature() @@ -66,6 +67,7 @@ fun R> Expect.notToThrow(): Expect = ExpectImpl.fun0.isNotTh * Expects that no [Throwable] is thrown at all when calling the subject (a lambda with arity 0, i.e. without arguments) * and that the corresponding return value holds all assertions the given [assertionCreator] creates. * + * @return An [Expect] with the new type [R]. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun R> Expect.notToThrow( diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableAssertions.kt index 1537bc3ce..a28eb79df 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableAssertions.kt @@ -28,9 +28,9 @@ val > Expect.containsNot: NotCheckerOption, T : Iterable> Expect.min(assertionCreator: Expect< * Creates an [Expect] for the property min of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * @since 0.9.0 */ fun , T : Iterable> Expect.min(): Expect = ExpectImpl.iterable.min(this).getExpectOfFeature() /** * Expects that the property max of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * @since 0.9.0 */ @@ -61,7 +61,7 @@ fun , T : Iterable> Expect.max(assertionCreator: Expect< * Creates an [Expect] for the property max of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * @since 0.9.0 */ fun , T : Iterable> Expect.max(): Expect = ExpectImpl.iterable.max(this).getExpectOfFeature() @@ -81,7 +81,7 @@ fun , T : Iterable> Expect.max(): Expect = ExpectImpl * instead of: * `contains('a', 'a')` * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.contains(expected: E, vararg otherExpected: E): Expect = @@ -98,7 +98,7 @@ fun > Expect.contains(expected: E, vararg otherExpected: E * for has to hold; or in other words, the function which defines whether an entry is the one we are looking for * or not. In case it is defined as `null`, then an entry is identified if it is `null` as well. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.contains(assertionCreatorOrNull: (Expect.() -> Unit)?): Expect = @@ -118,7 +118,7 @@ fun > Expect.contains(assertionCreatorOrNull: (Expe * @param otherAssertionCreatorsOrNulls Additional identification lambdas which each identify (separately) an entry * which we are looking for (see [assertionCreatorOrNull] for more information). * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.contains( @@ -136,7 +136,7 @@ fun > Expect.contains( * which will cause a binary backward compatibility break (see * [#292](https://github.com/robstoll/atrium/issues/292) for more information) * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.containsExactly(expected: E, vararg otherExpected: E): Expect = @@ -157,7 +157,7 @@ fun > Expect.containsExactly(expected: E, vararg otherExpe * for has to hold; or in other words, the function which defines whether an entry is the one we are looking for * or not. In case it is defined as `null`, then an entry is identified if it is `null` as well. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.containsExactly(assertionCreatorOrNull: (Expect.() -> Unit)?): Expect = @@ -181,7 +181,7 @@ fun > Expect.containsExactly(assertionCreatorOrNull * @param otherAssertionCreatorsOrNulls Additional identification lambdas which each identify (separately) an entry * which we are looking for (see [assertionCreatorOrNull] for more information). * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.containsExactly( @@ -196,7 +196,7 @@ fun > Expect.containsExactly( * * It is a shortcut for `containsNot.values(expected, *otherExpected)` * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.containsNot(expected: E, vararg otherExpected: E) = @@ -209,7 +209,7 @@ fun > Expect.containsNot(expected: E, vararg otherExpected * * It is a shortcut for `contains.inAnyOrder.atLeast(1).entry(assertionCreatorOrNull)` * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.any(assertionCreatorOrNull: (Expect.() -> Unit)?): Expect = @@ -223,7 +223,7 @@ fun > Expect.any(assertionCreatorOrNull: (Expect * * It is a shortcut for `containsNot.entry(assertionCreatorOrNull)` * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.none(assertionCreatorOrNull: (Expect.() -> Unit)?) = @@ -235,7 +235,7 @@ fun > Expect.none(assertionCreatorOrNull: (Expect> Expect.all(assertionCreatorOrNull: (Expect.() -> Unit)?) = @@ -244,7 +244,7 @@ fun > Expect.all(assertionCreatorOrNull: (Expect /** * Expects that the subject of the assertion (an [Iterable]) has at least one element. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -254,7 +254,7 @@ fun > Expect.hasNext() = addAssertion(ExpectImpl.iterable. /** * Expects that the subject of the assertion (an [Iterable]) does not have next element. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/listAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/listAssertions.kt index 8280ea4bf..9b8d8a1ab 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/listAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/listAssertions.kt @@ -16,7 +16,7 @@ fun > Expect.get(index: Int): Expect = ExpectImpl.list.get( * Expects that the given [index] is within the bounds of the subject of the assertion (a [List]) and that * the element at that position holds all assertions the given [assertionCreator] creates for it. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the given [index] is out of bound. */ fun > Expect.get(index: Int, assertionCreator: Expect.() -> Unit): Expect = diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/mapAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/mapAssertions.kt index cc7bb8a57..ca97d4319 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/mapAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/mapAssertions.kt @@ -14,7 +14,7 @@ import ch.tutteli.kbox.glue * defined as `'a' to 1` and one of the [otherPairs] is defined as `'a' to 1` as well, then both match, * even though they match the same entry. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.contains( @@ -33,7 +33,7 @@ fun > Expect.contains( * defined as `Key('a') { isGreaterThan(0) }` and one of the [otherKeyValues] is defined as `Key('a') { isLessThan(2) }` * , then both match, even though they match the same entry. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ inline fun > Expect.contains( @@ -46,7 +46,7 @@ inline fun > Expect.contains( /** * Expects that the subject of the assertion (a [Map]) contains the given [key]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.containsKey(key: K) = addAssertion(ExpectImpl.map.containsKey(this, key)) @@ -54,7 +54,7 @@ fun > Expect.containsKey(key: K) = addAssertion(ExpectIm /** * Expects that the subject of the assertion (a [Map]) does not contain the given [key]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.containsNotKey(key: K) = addAssertion(ExpectImpl.map.containsNotKey(this, key)) @@ -63,7 +63,7 @@ fun > Expect.containsNotKey(key: K) = addAssertion(Expec /** * Expects that the subject of the assertion (a [Map]) is an empty [Map]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.isEmpty() = addAssertion(ExpectImpl.map.isEmpty(this)) @@ -71,7 +71,7 @@ fun > Expect.isEmpty() = addAssertion(ExpectImpl.map.isEmpty(th /** * Expects that the subject of the assertion (a [Map]) is not an empty [Map]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.isNotEmpty() = addAssertion(ExpectImpl.map.isNotEmpty(this)) @@ -82,7 +82,7 @@ fun > Expect.isNotEmpty() = addAssertion(ExpectImpl.map.isNotEm * creates an [Expect] for the corresponding value and returns the newly created assertion container, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect] for the feature. + * @return The newly created [Expect] for the extracted feature. * @throws AssertionError Might throw an [AssertionError] if the given [key] does not exist. */ fun > Expect.getExisting(key: K): Expect = @@ -92,7 +92,7 @@ fun > Expect.getExisting(key: K): Expect = * Expects that the subject of the assertion (a [Map]) contains the given [key] and that * the corresponding value holds all assertions the given [assertionCreator] creates for it. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if a created [Assertion]s (by calling [assertionCreator]) * does not hold. */ @@ -103,16 +103,16 @@ fun > Expect.getExisting(key: K, assertionCreator: Ex * Creates an [Expect] for the property [Map.keys] of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect] for the feature. + * @return The newly created [Expect] for the extracted feature. */ val > Expect.keys: Expect> get() = keys(this).getExpectOfFeature() /** * Expects that the property [Map.keys] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.keys(assertionCreator: Expect>.() -> Unit): Expect = @@ -124,16 +124,16 @@ private fun > keys(e: Expect) = ExpectImpl.feature.prope * Creates an [Expect] for the property [Map.values] of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect] for the feature. + * @return The newly created [Expect] for the extracted feature. */ val > Expect.values: Expect> get() = values().getExpectOfFeature() /** * Expects that the property [Map.keys] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.values(assertionCreator: Expect>.() -> Unit): Expect = diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/mapEntryAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/mapEntryAssertions.kt index 902723d42..e00f14bdb 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/mapEntryAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/mapEntryAssertions.kt @@ -11,7 +11,7 @@ import ch.tutteli.atrium.domain.builders.ExpectImpl * block. Yet, the actual behaviour depends on implementation - could also be fail fast for instance or augment * reporting etc. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.isKeyValue(key: K, value: V): Expect = @@ -21,16 +21,16 @@ fun > Expect.isKeyValue(key: K, value: V): Expect> Expect.key: Expect get() = ExpectImpl.map.entry.key(this).getExpectOfFeature() /** * Expects that the property [Map.Entry.key] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.key(assertionCreator: Expect.() -> Unit): Expect = @@ -40,16 +40,16 @@ fun > Expect.key(assertionCreator: Expect.() -> * Creates an [Expect] for the property [Map.Entry.value] of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. */ val > Expect.value: Expect get() = ExpectImpl.map.entry.value(this).getExpectOfFeature() /** * Expects that the property [Map.Entry.value] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.value(assertionCreator: Expect.() -> Unit): Expect = diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/pairAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/pairAssertions.kt index 0d4e73da3..1b2fa6bee 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/pairAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/pairAssertions.kt @@ -7,16 +7,16 @@ import ch.tutteli.atrium.domain.builders.ExpectImpl * Creates an [Expect] for the property [Pair.first] of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. */ val > Expect.first: Expect get() = ExpectImpl.pair.first(this).getExpectOfFeature() /** * Expects that the property [Pair.first] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.first(assertionCreator: Expect.() -> Unit): Expect = @@ -26,16 +26,16 @@ fun > Expect.first(assertionCreator: Expect.() -> Uni * Creates an [Expect] for the property [Pair.second] of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. */ val > Expect.second: Expect get() = ExpectImpl.pair.second(this).getExpectOfFeature() /** * Expects that the property [Pair.second] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun > Expect.second(assertionCreator: Expect.() -> Unit): Expect = diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/sequenceAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/sequenceAssertions.kt index 04378221d..6aeb691f2 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/sequenceAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/sequenceAssertions.kt @@ -21,7 +21,7 @@ fun > Expect.asIterable(): Expect> = * The transformation as such is not reflected in reporting. * Use `feature(Sequence::asIterable, assertionCreator)` if you want to show the transformation in reporting. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. */ fun > Expect.asIterable(assertionCreator: Expect>.() -> Unit): Expect = apply { asIterable().addAssertionsCreatedBy(assertionCreator) } diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/throwableAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/throwableAssertions.kt index 8bec46bac..98d3fe72b 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/throwableAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/throwableAssertions.kt @@ -6,7 +6,7 @@ import ch.tutteli.atrium.creating.Expect * Expects that the property [Throwable.message] of the subject of the assertion is not null, * creates an [Expect] for it and returns it. * - * @return The newly created [Expect] for the property [Throwable.message] of the subject of the assertion + * @return The newly created [Expect] for the property [Throwable.message] of the subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ val Expect.message: Expect @@ -14,9 +14,9 @@ val Expect.message: Expect /** * Expects that the property [Throwable.message] of the subject of the assertion is not null and - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun Expect.message(assertionCreator: Expect.() -> Unit): Expect = @@ -33,7 +33,7 @@ fun Expect.message(assertionCreator: Expect.() -> Uni * Notice that a runtime check applies which assures that only [CharSequence], [Number] and [Char] are passed * (this function expects `Any` for your convenience, so that you can mix [String] and [Int] for instance). * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun Expect.messageContains(expected: Any, vararg otherExpected: Any): Expect = diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/bigDecimalAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/bigDecimalAssertions.kt index b32793d84..25a253fc3 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/bigDecimalAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/bigDecimalAssertions.kt @@ -46,7 +46,7 @@ fun Expect.toBe(expected: T): Nothing = throw PleaseUseRepl /** * Expects that the subject of the assertion (a [BigDecimal]) is `null`. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ @JvmName("toBeNull") @@ -87,7 +87,7 @@ fun Expect.notToBe(expected: T): Nothing = throw PleaseUseRe * - `expect(BigDecimal("10")).isEqualIncludingScale(BigDecimal("10.0"))` does not hold. * - `expect(BigDecimal("10")).isNumericallyEqualTo(BigDecimal("10.0"))` holds. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun Expect.isNumericallyEqualTo(expected: T) = @@ -105,7 +105,7 @@ fun Expect.isNumericallyEqualTo(expected: T) = * - `expect(BigDecimal("10")).isNotEqualIncludingScale(BigDecimal("10.0"))` holds. * - `expect(BigDecimal("10")).isNotNumericallyEqualTo(BigDecimal("10.0"))` does not hold. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun Expect.isNotNumericallyEqualTo(expected: T) = @@ -121,7 +121,7 @@ fun Expect.isNotNumericallyEqualTo(expected: T) = * - `expect(BigDecimal("10")).isEqualIncludingScale(BigDecimal("10.0"))` does not hold. * - `expect(BigDecimal("10")).isNumericallyEqualTo(BigDecimal("10.0"))` holds. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun Expect.isEqualIncludingScale(expected: T) = @@ -136,7 +136,7 @@ fun Expect.isEqualIncludingScale(expected: T) = * - `expect(BigDecimal("10")).isNotEqualIncludingScale(BigDecimal("10.0"))` holds. * - `expect(BigDecimal("10")).isNotNumericallyEqualTo(BigDecimal("10.0"))` does not hold. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun Expect.isNotEqualIncludingScale(expected: T) = diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/floatingPointJvmAssertions.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/floatingPointJvmAssertions.kt index 971b5d5b5..eff41ce25 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/floatingPointJvmAssertions.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/floatingPointJvmAssertions.kt @@ -18,7 +18,7 @@ import java.math.BigDecimal * * | `subject of the assertion` - [expected] | ≤ [tolerance] * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun Expect.toBeWithErrorTolerance(expected: BigDecimal, tolerance: BigDecimal) = diff --git a/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/chronoLocalDateAssertions.kt b/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/chronoLocalDateAssertions.kt index 4c3d92a46..c289a9eee 100644 --- a/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/chronoLocalDateAssertions.kt +++ b/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/chronoLocalDateAssertions.kt @@ -11,7 +11,7 @@ import java.time.chrono.ChronoLocalDate * Expects that the subject of the assertion (a [ChronoLocalDate]) * is before the [expected] [ChronoLocalDate]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -23,7 +23,7 @@ fun Expect.isBefore(expected: ChronoLocalDate): Expect< * Expects that the subject of the assertion (a [ChronoLocalDate]) * is before or equal the [expected] [ChronoLocalDate]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -36,7 +36,7 @@ fun Expect.isBeforeOrEqual(expected: ChronoLocalDate): * Expects that the subject of the assertion (a [ChronoLocalDate]) * is after the [expected] [ChronoLocalDate]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -48,7 +48,7 @@ fun Expect.isAfter(expected: ChronoLocalDate): Expect Expect.isAfterOrEqual(expected: ChronoLocalDate): E * Expects that the subject of the assertion (a [ChronoLocalDate]) * is equal to the [expected] [ChronoLocalDate]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 diff --git a/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/chronoLocalDateTimeAssertions.kt b/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/chronoLocalDateTimeAssertions.kt index c8df5cf00..b966b8ff9 100644 --- a/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/chronoLocalDateTimeAssertions.kt +++ b/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/chronoLocalDateTimeAssertions.kt @@ -12,7 +12,7 @@ import java.time.chrono.ChronoLocalDateTime * Expects that the subject of the assertion (a [ChronoLocalDateTime]) * is before the [expected] [ChronoLocalDateTime]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -24,7 +24,7 @@ fun > Expect.isBefore(expected: * Expects that the subject of the assertion (a [ChronoLocalDateTime]) * is before or equal the [expected] [ChronoLocalDateTime]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -37,7 +37,7 @@ fun > Expect.isBeforeOrEqual( * Expects that the subject of the assertion (a [ChronoLocalDateTime]) * is after the [expected] [ChronoLocalDateTime]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -50,7 +50,7 @@ fun > Expect.isAfter( * Expects that the subject of the assertion (a [ChronoLocalDateTime]) * is after or equal the [expected] [ChronoLocalDateTime]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -63,7 +63,7 @@ fun > Expect.isAfterOrEqual( * Expects that the subject of the assertion (a [ChronoLocalDateTime]) * is equal to the [expected] [ChronoLocalDateTime]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 diff --git a/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/chronoZonedDateTimeAssertions.kt b/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/chronoZonedDateTimeAssertions.kt index 72ff95952..d234a5b61 100644 --- a/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/chronoZonedDateTimeAssertions.kt +++ b/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/chronoZonedDateTimeAssertions.kt @@ -12,7 +12,7 @@ import java.time.chrono.ChronoZonedDateTime * Expects that the subject of the assertion (a [ChronoZonedDateTime]) * is before the [expected] [ChronoZonedDateTime]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -25,7 +25,7 @@ fun > Expect.isBefore( * Expects that the subject of the assertion (a [ChronoZonedDateTime]) * is before or equals the [expected] [ChronoZonedDateTime]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -38,7 +38,7 @@ fun > Expect.isBeforeOrEqual( * Expects that the subject of the assertion (a [ChronoZonedDateTime]) * is after the [expected] [ChronoZonedDateTime]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -51,7 +51,7 @@ fun > Expect.isAfter( * Expects that the subject of the assertion (a [ChronoZonedDateTime]) * is after or equal the [expected] [ChronoZonedDateTime]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -64,7 +64,7 @@ fun > Expect.isAfterOrEqual( * Expects that the subject of the assertion (a [ChronoZonedDateTime]) * is equal to the [expected] [ChronoZonedDateTime]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 diff --git a/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/fileAssertions.kt b/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/fileAssertions.kt index fa1d7068f..cc47c6073 100644 --- a/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/fileAssertions.kt +++ b/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/fileAssertions.kt @@ -27,7 +27,7 @@ fun Expect.asPath(): Expect = * The transformation as such is not reflected in reporting. * Use `feature(File::toPath, assertionCreator)` if you want to show the transformation in reporting. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * * @since 0.9.0 */ diff --git a/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/localDateAssertions.kt b/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/localDateAssertions.kt index 759e51e04..adc5e74c8 100644 --- a/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/localDateAssertions.kt +++ b/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/localDateAssertions.kt @@ -15,7 +15,7 @@ import java.time.LocalDate * Creates an [Expect] for the property [LocalDate.year][LocalDate.getYear] of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * * @since 0.9.0 */ @@ -24,9 +24,9 @@ val Expect.year: Expect /** * Expects that the property [LocalDate.year][LocalDate.getYear]of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -38,7 +38,7 @@ fun Expect.year(assertionCreator: Expect.() -> Unit): Ex * Creates an [Expect] for the property [LocalDate.monthValue][LocalDate.getMonthValue] of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * * @since 0.9.0 */ @@ -47,9 +47,9 @@ val Expect.month: Expect /** * Expects that the property [LocalDate.monthValue][LocalDate.getMonthValue] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -61,7 +61,7 @@ fun Expect.month(assertionCreator: Expect.() -> Unit): E * Creates an [Expect] for the property [LocalDate.getDayOfWeek] of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * * @since 0.9.0 */ @@ -70,9 +70,9 @@ val Expect.dayOfWeek: Expect /** * Expects that the property [LocalDate.getDayOfWeek] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -85,7 +85,7 @@ fun Expect.dayOfWeek(assertionCreator: Expect.() - * Creates an [Expect] for the property [LocalDate.dayOfMonth][LocalDate.getDayOfMonth] of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * * @since 0.9.0 */ @@ -94,9 +94,9 @@ val Expect.day: Expect /** * Expects that the property [LocalDate.dayOfMonth][LocalDate.getDayOfMonth] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 diff --git a/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/localDateTimeAssertions.kt b/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/localDateTimeAssertions.kt index 3822dedee..7704555ec 100644 --- a/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/localDateTimeAssertions.kt +++ b/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/localDateTimeAssertions.kt @@ -15,7 +15,7 @@ import java.time.LocalDateTime * Creates an [Expect] for the property [LocalDateTime.year][[LocalDateTime.getYear] of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * * @since 0.9.0 */ @@ -24,9 +24,9 @@ val Expect.year: Expect /** * Expects that the property [LocalDateTime.year][LocalDateTime.getYear] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -38,7 +38,7 @@ fun Expect.year(assertionCreator: Expect.() -> Unit) * Creates an [Expect] for the property [LocalDateTime.monthValue][LocalDateTime.getMonthValue] * of the subject of the assertion, so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * * @since 0.9.0 */ @@ -47,9 +47,9 @@ val Expect.month: Expect /** * Expects that the property [LocalDateTime.monthValue][LocalDateTime.getMonthValue]of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -61,7 +61,7 @@ fun Expect.month(assertionCreator: Expect.() -> Unit * Creates an [Expect] for the property [LocalDateTime.dayOfWeek][LocalDateTime.getDayOfWeek] * of the subject of the assertion, so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * * @since 0.9.0 */ @@ -70,9 +70,9 @@ val Expect.dayOfWeek: Expect /** * Expects that the property [LocalDateTime.dayOfWeek][LocalDateTime.getDayOfWeek]of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -84,7 +84,7 @@ fun Expect.dayOfWeek(assertionCreator: Expect. * Creates an [Expect] for the property [LocalDateTime.dayOfMonth][LocalDateTime.getDayOfMonth] * of the subject of the assertion, so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * * @since 0.9.0 */ @@ -93,9 +93,9 @@ val Expect.day: Expect /** * Expects that the property [LocalDateTime.dayOfMonth][LocalDateTime.getDayOfMonth] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 diff --git a/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/optionalAssertions.kt b/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/optionalAssertions.kt index c9bb54ad5..8b711c4d0 100644 --- a/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/optionalAssertions.kt +++ b/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/optionalAssertions.kt @@ -13,7 +13,7 @@ import java.util.* * Shortcut for more or less something like `feature(Optional::isEmpty) { toBe(true) }` * depends on the underlying implementation though. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -27,7 +27,7 @@ fun > Expect.isEmpty(): Expect = addAssertion(ExpectImpl.o * Shortcut for more or less something like `feature(Optional::get)` but with error handling; yet it * depends on the underlying implementation though. * - * @return The newly created [Expect] if the given assertion is success + * @return The newly created [Expect] for the inner type [E]. * @throws AssertionError Might throw an [AssertionError] if the given assertion is not a success. * * @since 0.9.0 @@ -38,7 +38,7 @@ fun > Expect.isPresent(): Expect = ExpectImpl.optional. * Expects that the subject of the assertion (an [Optional]) is present and * that it holds all assertions the given [assertionCreator] creates. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the given assertions are not success. * * @since 0.9.0 diff --git a/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/pathAssertions.kt b/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/pathAssertions.kt index 489bdd81f..73fc6c2f9 100644 --- a/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/pathAssertions.kt +++ b/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/pathAssertions.kt @@ -10,7 +10,7 @@ import java.nio.file.Path /** * Expects that the subject of the assertion (a [Path]) starts with the [expected] [Path]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -21,7 +21,7 @@ fun Expect.startsWith(expected: Path): Expect = /** * Expects that the subject of the assertion (a [Path]) does not start with the [expected] [Path]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -32,7 +32,7 @@ fun Expect.startsNotWith(expected: Path): Expect = /** * Expects that the subject of the assertion (a [Path]) ends with the expected [Path]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -44,7 +44,7 @@ fun Expect.endsWith(expected: Path): Expect = * Expects that the subject of the assertion (a [Path]) does not end with the expected [Path]; * * @param expected The [Path] provided to the assertion - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -59,7 +59,7 @@ fun Expect.endsNotWith(expected: Path): Expect = * This matcher _resolves_ symbolic links. Therefore, if a symbolic link exists at the location the subject points to, * then the search will continue at that location. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -73,7 +73,7 @@ fun Expect.exists(): Expect = addAssertion(ExpectImpl.path.exis * This matcher _resolves_ symbolic links. Therefore, if a symbolic link exists at the location the subject points to, * then the search will continue at that location. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -85,7 +85,7 @@ fun Expect.existsNot(): Expect = addAssertion(ExpectImpl.path.e * (provided via [niok](https://github.com/robstoll/niok)) of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * * @since 0.9.0 */ @@ -95,9 +95,9 @@ val Expect.fileName: Expect /** * Expects that the property [Path.fileNameAsString][ch.tutteli.niok.fileNameAsString] * (provided via [niok](https://github.com/robstoll/niok)) of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -110,7 +110,7 @@ fun Expect.fileName(assertionCreator: Expect.() -> Unit): * (provided via [niok](https://github.com/robstoll/niok)) of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -122,9 +122,9 @@ val Expect.fileNameWithoutExtension: Expect * Expects that the property [Path.fileNameWithoutExtension][ch.tutteli.niok.fileNameWithoutExtension] * (provided via [niok](https://github.com/robstoll/niok)) * of the subject of the assertion holds all assertions the given [assertionCreator] creates for it - * and returns this assertion container. + * and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -136,7 +136,7 @@ fun Expect.fileNameWithoutExtension(assertionCreator: Expect Expect.parent: Expect /** * Expects that this [Path] has a [parent][Path.getParent] and that the parent holds all assertions the - * given [assertionCreator] creates for it and returns this assertion container. + * given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -160,7 +160,7 @@ fun Expect.parent(assertionCreator: Expect.() -> Unit): Expe * Expects that [other] resolves against this [Path] and creates an [Expect] for the resolved [Path] * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -170,9 +170,9 @@ fun Expect.resolve(other: String): Expect = /** * Expects that [other] resolves against this [Path] and that the resolved [Path] holds all assertions the - * given [assertionCreator] creates for it and returns this assertion container. + * given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -193,7 +193,7 @@ fun Expect.resolve(other: String, assertionCreator: Expect.( * Its result, in particular its extended explanations, may be wrong if such concurrent file system operations * take place. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -209,7 +209,7 @@ fun Expect.isReadable(): Expect = addAssertion(ExpectImpl.path. * Therefore, if a symbolic link exists at the location the subject points to, search will continue * at the location the link points at. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -228,7 +228,7 @@ fun Expect.isWritable(): Expect = addAssertion(ExpectImpl.path. * Its result, in particular its extended explanations, may be wrong if such concurrent file system operations * take place. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -247,7 +247,7 @@ fun Expect.isRegularFile(): Expect = addAssertion(ExpectImpl.pa * Its result, in particular its extended explanations, may be wrong if such concurrent file system operations * take place. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -259,7 +259,7 @@ fun Expect.isDirectory(): Expect = addAssertion(ExpectImpl.path * (provided via [niok](https://github.com/robstoll/niok)) of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * * @since 0.9.0 */ @@ -269,9 +269,9 @@ val Expect.extension: Expect /** * Expects that the property [Path.extension][ch.tutteli.niok.extension] * (provided via [niok](https://github.com/robstoll/niok)) of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 diff --git a/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/zonedDateTimeAssertions.kt b/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/zonedDateTimeAssertions.kt index 50ce004a6..88dab2dbd 100644 --- a/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/zonedDateTimeAssertions.kt +++ b/apis/fluent-en_GB/extensions/jdk8/atrium-api-fluent-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/jdk8/zonedDateTimeAssertions.kt @@ -15,7 +15,7 @@ import java.time.ZonedDateTime * Creates an [Expect] for the property [ZonedDateTime.year][ZonedDateTime.getYear] of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * * @since 0.9.0 */ @@ -24,9 +24,9 @@ val Expect.year: Expect /** * Expects that the property [ZonedDateTime.year][ZonedDateTime.getYear] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -38,7 +38,7 @@ fun Expect.year(assertionCreator: Expect.() -> Unit) * Creates an [Expect] for the property [ZonedDateTime.monthValue][ZonedDateTime.getMonthValue] * of the subject of the assertion, so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * * @since 0.9.0 */ @@ -47,9 +47,9 @@ val Expect.month: Expect /** * Expects that the property [ZonedDateTime.monthValue][ZonedDateTime.getMonthValue] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -61,7 +61,7 @@ fun Expect.month(assertionCreator: Expect.() -> Unit * Creates an [Expect] for the property [ZonedDatetime.dayOfWeek][ZonedDateTime.getDayOfWeek] * of the subject of the assertion, so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * * @since 0.9.0 */ @@ -70,9 +70,9 @@ val Expect.dayOfWeek: Expect /** * Expects that the property [ZonedDatetime.dayOfWeek][ZonedDateTime.getDayOfWeek] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -84,7 +84,7 @@ fun Expect.dayOfWeek(assertionCreator: Expect. * Creates an [Expect] for the property [ZonedDateTime.dayOfMonth][ZonedDateTime.getDayOfMonth] * of the subject of the assertion, so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * * @since 0.9.0 */ @@ -93,9 +93,9 @@ val Expect.day: Expect /** * Expects that the property [ZonedDateTime.dayOfMonth][ZonedDateTime.getDayOfMonth] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 diff --git a/apis/fluent-en_GB/extensions/kotlin_1_3/atrium-api-fluent-en_GB-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/kotlin_1_3/resultAssertions.kt b/apis/fluent-en_GB/extensions/kotlin_1_3/atrium-api-fluent-en_GB-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/kotlin_1_3/resultAssertions.kt index 85bf2569e..9f591f0aa 100644 --- a/apis/fluent-en_GB/extensions/kotlin_1_3/atrium-api-fluent-en_GB-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/kotlin_1_3/resultAssertions.kt +++ b/apis/fluent-en_GB/extensions/kotlin_1_3/atrium-api-fluent-en_GB-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/kotlin_1_3/resultAssertions.kt @@ -19,7 +19,7 @@ fun > Expect.isSuccess(): Expect = ExpectImpl.result.isSu * Expects that the subject of the assertion (a [Result]) is a Success and * that it holds all assertions the given [assertionCreator] creates. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the given assertions are not success. * * @since 0.9.0 @@ -31,7 +31,7 @@ fun > Expect.isSuccess(assertionCreator: Expect.() -> Uni * Expects that the subject of the assertion (a [Result]) is a Failure and * that it encapsulates an exception of type [TExpected]. * - * @return An assertion container with the new type [TExpected] + * @return An [Expect] with the new type [TExpected] * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 @@ -44,7 +44,7 @@ inline fun Expect>.isFailure(): Ex * it encapsulates an exception of type [TExpected] and that the exception * holds all assertions the given [assertionCreator] creates. * - * @return An assertion container with the new type [TExpected] + * @return An [Expect] with the new type [TExpected] * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.9.0 diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/anyAssertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/anyAssertions.kt index 17980a924..23b0b10c2 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/anyAssertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/anyAssertions.kt @@ -8,7 +8,7 @@ import ch.tutteli.atrium.reporting.Reporter /** * Expects that the subject of the assertion is (equal to) [expected]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun Expect.toBe(expected: T) = addAssertion(ExpectImpl.any.toBe(this, expected)) @@ -16,7 +16,7 @@ infix fun Expect.toBe(expected: T) = addAssertion(ExpectImpl.any.toBe(thi /** * Expects that the subject of the assertion is not (equal to) [expected]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun Expect.notToBe(expected: T) = addAssertion(ExpectImpl.any.notToBe(this, expected)) @@ -24,7 +24,7 @@ infix fun Expect.notToBe(expected: T) = addAssertion(ExpectImpl.any.notTo /** * Expects that the subject of the assertion is the same instance as [expected]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun Expect.isSameAs(expected: T) = addAssertion(ExpectImpl.any.isSame(this, expected)) @@ -32,7 +32,7 @@ infix fun Expect.isSameAs(expected: T) = addAssertion(ExpectImpl.any.isSa /** * Expects that the subject of the assertion is not the same instance as [expected]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun Expect.isNotSameAs(expected: T) = addAssertion(ExpectImpl.any.isNotSame(this, expected)) @@ -47,7 +47,7 @@ infix fun Expect.isNotSameAs(expected: T) = addAssertion(ExpectImpl.any.i * else notToBeNull(assertionCreatorOrNull) * ``` * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ inline infix fun Expect.toBeNullIfNullGivenElse( @@ -60,7 +60,7 @@ inline infix fun Expect.toBeNullIfNullGivenElse( * * It delegates to [isA] with [T] as type. * - * @return An assertion container with the non-nullable type [T] (was `T?` before). + * @return An [Expect] with the non-nullable type [T] (was `T?` before). * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ @Suppress(/* less magic */ "RemoveExplicitTypeArguments") @@ -72,7 +72,7 @@ inline infix fun Expect.notToBeNull(@Suppress("UNUSED_PARA * * It delegates to [isA] with [T] as type. * - * @return An assertion container with the non-nullable type [T] (was `T?` before) + * @return An [Expect] with the non-nullable type [T] (was `T?` before) * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ @Suppress(/* less magic */ "RemoveExplicitTypeArguments") @@ -95,7 +95,7 @@ inline infix fun Expect.notToBeNull(noinline assertionCrea * the element type is actually `String`. Or in other words * `assert(listOf(1, 2)).isA>{}` holds, even though `List` is clearly not a `List`. * - * @return An assertion container with the new type [TSub]. + * @return An [Expect] with the new type [TSub]. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ //TODO make infix and add `o` as parameter as soon as https://youtrack.jetbrains.com/issue/KT-21593 is fixed @@ -140,7 +140,7 @@ inline fun Expect<*>.isA(): Expect = * the element type is actually `String`. Or in other words * `assert(listOf(1, 2)).isA>{}` holds, even though `List` is clearly not a `List`. * - * @return An assertion container with the new type [TSub]. + * @return An [Expect] with the new type [TSub]. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ inline infix fun Expect<*>.isA(noinline assertionCreator: Expect.() -> Unit): Expect = @@ -154,7 +154,7 @@ inline infix fun Expect<*>.isA(noinline assertionCreator: E * asserts that 1 is greater than 0. If the first assertion fails, then usually (depending on the configured * [AssertionChecker]) the second assertion is not evaluated. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * * @since 0.10.0 */ @@ -169,7 +169,7 @@ inline infix fun Expect.and(@Suppress("UNUSED_PARAMETER") o: o): Expect Expect.and(assertionCreator: Expect.() -> Unit) = addAssertionsCreatedBy(assertionCreator) @@ -190,5 +190,7 @@ infix fun Expect.and(assertionCreator: Expect.() -> Unit) = addAsserti * o ends with "world" * } * ``` + * + * @return `this` */ inline val Expect.o get() : Expect = this diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/collectionAssertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/collectionAssertions.kt index 9819a0631..d200e747c 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/collectionAssertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/collectionAssertions.kt @@ -6,7 +6,7 @@ import ch.tutteli.atrium.domain.builders.ExpectImpl /** * Expects that the subject of the assertion (a [Collection]) is an empty [Collection]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.toBe(@Suppress("UNUSED_PARAMETER") Empty: Empty) = @@ -15,7 +15,7 @@ infix fun > Expect.toBe(@Suppress("UNUSED_PARAMETER") Empty /** * Expects that the subject of the assertion (a [Collection]) is not an empty [Collection]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.notToBe(@Suppress("UNUSED_PARAMETER") Empty: Empty) = @@ -25,15 +25,15 @@ infix fun > Expect.notToBe(@Suppress("UNUSED_PARAMETER") Em * Creates an [Expect] for the property [Collection.size] of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. */ val > Expect.size get(): Expect = ExpectImpl.collection.size(this).getExpectOfFeature() /** * Expects that the property [Collection.size] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.size(assertionCreator: Expect.() -> Unit): Expect = diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/comparableAssertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/comparableAssertions.kt index 80409b017..1e25a5d7d 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/comparableAssertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/comparableAssertions.kt @@ -7,7 +7,7 @@ import ch.tutteli.atrium.domain.builders.ExpectImpl * Expects that the subject of the assertion is less than [expected]. * The comparison is carried out with [Comparable.compareTo]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.isLessThan(expected: T) = @@ -17,7 +17,7 @@ infix fun > Expect.isLessThan(expected: T) = * Expects that the subject of the assertion is less than or equal [expected]. * The comparison is carried out with [Comparable.compareTo]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.isLessThanOrEqual(expected: T) = @@ -27,7 +27,7 @@ infix fun > Expect.isLessThanOrEqual(expected: T) = * Expects that the subject of the assertion is greater than [expected]. * The comparison is carried out with [Comparable.compareTo]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.isGreaterThan(expected: T) = @@ -37,7 +37,7 @@ infix fun > Expect.isGreaterThan(expected: T) = * Expects that the subject of the assertion is greater than or equal [expected]. * The comparison is carried out with [Comparable.compareTo]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.isGreaterThanOrEqual(expected: T) = diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/creating/list/get/builders/ListGetStep.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/creating/list/get/builders/ListGetStep.kt index 4c1787581..07cdea536 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/creating/list/get/builders/ListGetStep.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/creating/list/get/builders/ListGetStep.kt @@ -25,7 +25,7 @@ interface ListGetStep> { * Makes the assertion that the given [index] is within the bounds of [Expect.subject] and that * the corresponding entry holds all assertions the given [assertionCreator] might create for it. * - * @return This [Expect] to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if a created [Expect]s (by calling [assertionCreator]) * does not hold. * @throws IllegalArgumentException in case the given [assertionCreator] did not create a single assertion. diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/fun0Assertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/fun0Assertions.kt index e329265c1..ed972a79d 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/fun0Assertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/fun0Assertions.kt @@ -10,7 +10,7 @@ import ch.tutteli.atrium.domain.builders.ExpectImpl * For instance `toThrow>` would only check if the subject is a `MyException` without checking if * the element type is actually `String`. * - * @return An assertion container with the new type [TExpected]. + * @return An [Expect] with the new type [TExpected]. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ inline fun Expect Any?>.toThrow(): Expect = @@ -46,7 +46,7 @@ inline fun Expect Any?>.toThrow(): Exp * For instance `toThrow>` would only check if the subject is a `MyException` without checking if * the element type is actually `String`. * - * @return An assertion container with the new type [TExpected]. + * @return An [Expect] with the new type [TExpected]. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ inline infix fun Expect Any?>.toThrow( @@ -58,6 +58,7 @@ inline infix fun Expect Any?>.toThrow( * Expects that no [Throwable] is thrown at all when calling the subject (a lambda with arity 0, i.e. without arguments) * and changes the subject of the assertion to the return value of type [R]. * + * @return An [Expect] with the new type [R]. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ fun R> Expect.notToThrow(): Expect = ExpectImpl.fun0.isNotThrowing(this).getExpectOfFeature() @@ -66,6 +67,7 @@ fun R> Expect.notToThrow(): Expect = ExpectImpl.fun0.isNotTh * Expects that no [Throwable] is thrown at all when calling the subject (a lambda with arity 0, i.e. without arguments) * and that the corresponding return value holds all assertions the given [assertionCreator] creates. * + * @return An [Expect] with the new type [R]. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun R> Expect.notToThrow( diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableAssertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableAssertions.kt index 86a614c12..e37d1a5be 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableAssertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableAssertions.kt @@ -8,7 +8,7 @@ import ch.tutteli.atrium.domain.builders.ExpectImpl * that every element holds all assertions created by the [assertionCreatorOrNull] or that all elements are `null` * in case [assertionCreatorOrNull] is defined as `null`. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.all(assertionCreatorOrNull: (Expect.() -> Unit)?) = diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapAssertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapAssertions.kt index a51518408..48f30c173 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapAssertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapAssertions.kt @@ -10,7 +10,7 @@ import ch.tutteli.atrium.domain.builders.ExpectImpl * * Delegates to 'contains Pairs(keyValuePair)'. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.contains(keyValuePair: Pair) = @@ -24,7 +24,7 @@ infix fun > Expect.contains(keyValuePair: Pair) * in [keyValuePairs] is defined as `'a' to 1` and another one is defined as `'a' to 1` as well, then both match, * even though they match the same entry. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.contains(keyValuePairs: Pairs): Expect = @@ -36,7 +36,7 @@ infix fun > Expect.contains(keyValuePairs: Pairs> Expect.contains(keyValue: KeyValue): Expect = @@ -52,7 +52,7 @@ inline infix fun > Expect.contains(key * [keyValues] is defined as `Key('a') { isGreaterThan(0) }` and another one is defined as `Key('a') { isLessThan(2) }` * , then both match, even though they match the same entry. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ inline infix fun > Expect.contains(keyValues: All>) = @@ -61,7 +61,7 @@ inline infix fun > Expect.contains(key /** * Expects that the subject of the assertion (a [Map]) contains the given [key]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.containsKey(key: K) = addAssertion(ExpectImpl.map.containsKey(this, key)) @@ -69,7 +69,7 @@ infix fun > Expect.containsKey(key: K) = addAssertion(Ex /** * Expects that the subject of the assertion (a [Map]) does not contain the given [key]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.containsNotKey(key: K) = @@ -80,7 +80,7 @@ infix fun > Expect.containsNotKey(key: K) = * creates an [Expect] for the corresponding value and returns the newly created assertion container, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect] for the feature. + * @return The newly created [Expect] for the extracted feature. * @throws AssertionError Might throw an [AssertionError] if the given [key] does not exist. */ infix fun > Expect.getExisting(key: K): Expect = @@ -99,16 +99,16 @@ infix fun > Expect.getExisting(key: Key): MapGetOp * Creates an [Expect] for the property [Map.keys] of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect] for the feature. + * @return The newly created [Expect] for the extracted feature. */ val > Expect.keys: Expect> get() = keys(this).getExpectOfFeature() /** * Expects that the property [Map.keys] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.keys(assertionCreator: Expect>.() -> Unit): Expect = @@ -119,7 +119,7 @@ private fun > keys(e: Expect) = ExpectImpl.feature.prope /** * Expects that the subject of the assertion (a [Map]) is an empty [Map]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.toBe(@Suppress("UNUSED_PARAMETER") Empty: Empty) = @@ -128,7 +128,7 @@ infix fun > Expect.toBe(@Suppress("UNUSED_PARAMETER") Empty: Em /** * Expects that the subject of the assertion (a [Map]) is not an empty [Map]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.notToBe(@Suppress("UNUSED_PARAMETER") Empty: Empty) = @@ -138,16 +138,16 @@ infix fun > Expect.notToBe(@Suppress("UNUSED_PARAMETER") Empty: * Creates an [Expect] for the property [Map.values] of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect] for the feature. + * @return The newly created [Expect] for the extracted feature. */ val > Expect.values: Expect> get() = values().getExpectOfFeature() /** * Expects that the property [Map.keys] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.values(assertionCreator: Expect>.() -> Unit): Expect = diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapEntryAssertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapEntryAssertions.kt index 47ba49797..499d296b8 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapEntryAssertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapEntryAssertions.kt @@ -11,7 +11,7 @@ import ch.tutteli.atrium.domain.builders.ExpectImpl * block. Yet, the actual behaviour depends on implementation - could also be fail fast for instance or augment * reporting etc. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.isKeyValue(keyValuePair: Pair): Expect = @@ -21,16 +21,16 @@ infix fun > Expect.isKeyValue(keyValuePair: Pair> Expect.key: Expect get() = ExpectImpl.map.entry.key(this).getExpectOfFeature() /** * Expects that the property [Map.Entry.key] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.key(assertionCreator: Expect.() -> Unit): Expect = @@ -40,16 +40,16 @@ infix fun > Expect.key(assertionCreator: Expect. * Creates an [Expect] for the property [Map.Entry.value] of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. */ val > Expect.value: Expect get() = ExpectImpl.map.entry.value(this).getExpectOfFeature() /** * Expects that the property [Map.Entry.value] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.value(assertionCreator: Expect.() -> Unit): Expect = diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/pairAssertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/pairAssertions.kt index e9ee467b8..e19b5cef8 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/pairAssertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/pairAssertions.kt @@ -7,15 +7,15 @@ import ch.tutteli.atrium.domain.builders.ExpectImpl * Creates an [Expect] for the property [Pair.first] of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. */ val > Expect.first get() : Expect = ExpectImpl.pair.first(this).getExpectOfFeature() /** * Expects that the property [Pair.first] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.first(assertionCreator: Expect.() -> Unit): Expect = @@ -25,15 +25,15 @@ infix fun > Expect.first(assertionCreator: Expect.() * Creates an [Expect] for the property [Pair.second] of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. */ val > Expect.second get() : Expect = ExpectImpl.pair.second(this).getExpectOfFeature() /** * Expects that the property [Pair.second] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. */ infix fun > Expect.second(assertionCreator: Expect.() -> Unit): Expect = diff --git a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/sequenceAssertions.kt b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/sequenceAssertions.kt index 3275f15b5..73e955711 100644 --- a/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/sequenceAssertions.kt +++ b/apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/sequenceAssertions.kt @@ -1,4 +1,3 @@ -import ch.tutteli.atrium.creating.AssertionPlant import ch.tutteli.atrium.creating.Expect import ch.tutteli.atrium.domain.builders.ExpectImpl.changeSubject @@ -20,7 +19,7 @@ fun > Expect.asIterable(): Expect> * The transformation as such is not reflected in reporting. * Use `feature(Sequence::asIterable, assertionCreator)` if you want to show the transformation in reporting. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. */ infix fun > Expect.asIterable(assertionCreator: Expect>.() -> Unit): Expect = apply { asIterable().addAssertionsCreatedBy(assertionCreator) } diff --git a/apis/infix-en_GB/extensions/jdk8/atrium-api-infix-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/jdk8/chronoLocalDateAssertions.kt b/apis/infix-en_GB/extensions/jdk8/atrium-api-infix-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/jdk8/chronoLocalDateAssertions.kt index c7bd107d6..ab78421e0 100644 --- a/apis/infix-en_GB/extensions/jdk8/atrium-api-infix-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/jdk8/chronoLocalDateAssertions.kt +++ b/apis/infix-en_GB/extensions/jdk8/atrium-api-infix-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/jdk8/chronoLocalDateAssertions.kt @@ -11,7 +11,7 @@ import java.time.chrono.ChronoLocalDate * Expects that the subject of the assertion (a [ChronoLocalDate]) * is before the [expected] [ChronoLocalDate]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -23,7 +23,7 @@ infix fun Expect.isBefore(expected: ChronoLocalDate): E * Expects that the subject of the assertion (a [ChronoLocalDate]) * is before or equal the [expected] [ChronoLocalDate]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -36,7 +36,7 @@ infix fun Expect.isBeforeOrEqual(expected: ChronoLocalD * Expects that the subject of the assertion (a [ChronoLocalDate]) * is after the [expected] [ChronoLocalDate]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -48,7 +48,7 @@ infix fun Expect.isAfter(expected: ChronoLocalDate): Ex * Expects that the subject of the assertion (a [ChronoLocalDate]) * is after or equal the [expected] [ChronoLocalDate]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -60,7 +60,7 @@ infix fun Expect.isAfterOrEqual(expected: ChronoLocalDa * Expects that the subject of the assertion (a [ChronoLocalDate]) * is equal to the [expected] [ChronoLocalDate]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 diff --git a/apis/infix-en_GB/extensions/jdk8/atrium-api-infix-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/jdk8/chronoZonedDateTimeAssertions.kt b/apis/infix-en_GB/extensions/jdk8/atrium-api-infix-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/jdk8/chronoZonedDateTimeAssertions.kt index 0ae0b9b37..63871d9cd 100644 --- a/apis/infix-en_GB/extensions/jdk8/atrium-api-infix-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/jdk8/chronoZonedDateTimeAssertions.kt +++ b/apis/infix-en_GB/extensions/jdk8/atrium-api-infix-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/jdk8/chronoZonedDateTimeAssertions.kt @@ -12,7 +12,7 @@ import java.time.chrono.ChronoZonedDateTime * Expects that the subject of the assertion (a [ChronoZonedDateTime]) * is before the [expected] [ChronoZonedDateTime]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -25,7 +25,7 @@ infix fun > Expect.isBefore( * Expects that the subject of the assertion (a [ChronoZonedDateTime]) * is before or equals the [expected] [ChronoZonedDateTime]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -38,7 +38,7 @@ infix fun > Expect.isBeforeOrEqu * Expects that the subject of the assertion (a [ChronoZonedDateTime]) * is after the [expected] [ChronoZonedDateTime]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -51,7 +51,7 @@ infix fun > Expect.isAfter( * Expects that the subject of the assertion (a [ChronoZonedDateTime]) * is after or equal the [expected] [ChronoZonedDateTime]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -64,7 +64,7 @@ infix fun > Expect.isAfterOrEqua * Expects that the subject of the assertion (a [ChronoZonedDateTime]) * is equal to the [expected] [ChronoZonedDateTime]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 diff --git a/apis/infix-en_GB/extensions/jdk8/atrium-api-infix-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/jdk8/fileAssertions.kt b/apis/infix-en_GB/extensions/jdk8/atrium-api-infix-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/jdk8/fileAssertions.kt index 7c88de900..4c6e60129 100644 --- a/apis/infix-en_GB/extensions/jdk8/atrium-api-infix-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/jdk8/fileAssertions.kt +++ b/apis/infix-en_GB/extensions/jdk8/atrium-api-infix-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/jdk8/fileAssertions.kt @@ -27,7 +27,7 @@ fun Expect.asPath(): Expect = * The transformation as such is not reflected in reporting. * Use `feature(File::toPath, assertionCreator)` if you want to show the transformation in reporting. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * * @since 0.10.0 */ diff --git a/apis/infix-en_GB/extensions/jdk8/atrium-api-infix-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/jdk8/localDateAssertions.kt b/apis/infix-en_GB/extensions/jdk8/atrium-api-infix-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/jdk8/localDateAssertions.kt index f3d58a428..d43f73233 100644 --- a/apis/infix-en_GB/extensions/jdk8/atrium-api-infix-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/jdk8/localDateAssertions.kt +++ b/apis/infix-en_GB/extensions/jdk8/atrium-api-infix-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/jdk8/localDateAssertions.kt @@ -15,7 +15,7 @@ import java.time.LocalDate * Creates an [Expect] for the property [LocalDate.year][LocalDate.getYear] of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * * @since 0.10.0 */ @@ -24,9 +24,9 @@ val Expect.year: Expect /** * Expects that the property [LocalDate.year][LocalDate.getYear]of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -38,7 +38,7 @@ infix fun Expect.year(assertionCreator: Expect.() -> Uni * Creates an [Expect] for the property [LocalDate.monthValue][LocalDate.getMonthValue] of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * * @since 0.10.0 */ @@ -47,9 +47,9 @@ val Expect.month: Expect /** * Expects that the property [LocalDate.monthValue][LocalDate.getMonthValue] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -61,7 +61,7 @@ infix fun Expect.month(assertionCreator: Expect.() -> Un * Creates an [Expect] for the property [LocalDate.getDayOfWeek] of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * * @since 0.10.0 */ @@ -70,9 +70,9 @@ val Expect.dayOfWeek: Expect /** * Expects that the property [LocalDate.getDayOfWeek] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -85,7 +85,7 @@ infix fun Expect.dayOfWeek(assertionCreator: Expect Expect.day: Expect /** * Expects that the property [LocalDate.dayOfMonth][LocalDate.getDayOfMonth] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 diff --git a/apis/infix-en_GB/extensions/jdk8/atrium-api-infix-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/jdk8/localDateTimeAssertions.kt b/apis/infix-en_GB/extensions/jdk8/atrium-api-infix-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/jdk8/localDateTimeAssertions.kt index 0ef63dd7e..02149102e 100644 --- a/apis/infix-en_GB/extensions/jdk8/atrium-api-infix-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/jdk8/localDateTimeAssertions.kt +++ b/apis/infix-en_GB/extensions/jdk8/atrium-api-infix-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/jdk8/localDateTimeAssertions.kt @@ -15,7 +15,7 @@ import java.time.LocalDateTime * Creates an [Expect] for the property [LocalDateTime.year][[LocalDateTime.getYear] of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * * @since 0.10.0 */ @@ -24,9 +24,9 @@ val Expect.year: Expect /** * Expects that the property [LocalDateTime.year][LocalDateTime.getYear] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -38,7 +38,7 @@ infix fun Expect.year(assertionCreator: Expect.() -> * Creates an [Expect] for the property [LocalDateTime.monthValue][LocalDateTime.getMonthValue] * of the subject of the assertion, so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * * @since 0.10.0 */ @@ -47,9 +47,9 @@ val Expect.month: Expect /** * Expects that the property [LocalDateTime.monthValue][LocalDateTime.getMonthValue]of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -61,7 +61,7 @@ infix fun Expect.month(assertionCreator: Expect.() - * Creates an [Expect] for the property [LocalDateTime.dayOfWeek][LocalDateTime.getDayOfWeek] * of the subject of the assertion, so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * * @since 0.10.0 */ @@ -70,9 +70,9 @@ val Expect.dayOfWeek: Expect /** * Expects that the property [LocalDateTime.dayOfWeek][LocalDateTime.getDayOfWeek]of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -84,7 +84,7 @@ infix fun Expect.dayOfWeek(assertionCreator: Expect Expect.day: Expect /** * Expects that the property [LocalDateTime.dayOfMonth][LocalDateTime.getDayOfMonth] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 diff --git a/apis/infix-en_GB/extensions/jdk8/atrium-api-infix-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/jdk8/pathAssertions.kt b/apis/infix-en_GB/extensions/jdk8/atrium-api-infix-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/jdk8/pathAssertions.kt index 2313c1606..bddfed398 100644 --- a/apis/infix-en_GB/extensions/jdk8/atrium-api-infix-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/jdk8/pathAssertions.kt +++ b/apis/infix-en_GB/extensions/jdk8/atrium-api-infix-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/jdk8/pathAssertions.kt @@ -10,7 +10,7 @@ import java.nio.file.Path /** * Expects that the subject of the assertion (a [Path]) starts with the [expected] [Path]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -21,7 +21,7 @@ infix fun Expect.startsWith(expected: Path): Expect = /** * Expects that the subject of the assertion (a [Path]) does not start with the [expected] [Path]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -32,7 +32,7 @@ infix fun Expect.startsNotWith(expected: Path): Expect = /** * Expects that the subject of the assertion (a [Path]) ends with the expected [Path]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -44,7 +44,7 @@ infix fun Expect.endsWith(expected: Path): Expect = * Expects that the subject of the assertion (a [Path]) does not end with the expected [Path]; * * @param expected The [Path] provided to the assertion - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -59,7 +59,7 @@ infix fun Expect.endsNotWith(expected: Path): Expect = * This matcher _resolves_ symbolic links. Therefore, if a symbolic link exists at the location the subject points to, * then the search will continue at that location. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -74,7 +74,7 @@ infix fun Expect.to(@Suppress("UNUSED_PARAMETER") exist: exist): E * This matcher _resolves_ symbolic links. Therefore, if a symbolic link exists at the location the subject points to, * then the search will continue at that location. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -87,7 +87,7 @@ infix fun Expect.notTo(@Suppress("UNUSED_PARAMETER") exist: exist) * (provided via [niok](https://github.com/robstoll/niok)) of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * * @since 0.10.0 */ @@ -97,9 +97,9 @@ val Expect.fileName: Expect /** * Expects that the property [Path.fileNameAsString][ch.tutteli.niok.fileNameAsString] * (provided via [niok](https://github.com/robstoll/niok)) of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -112,7 +112,7 @@ infix fun Expect.fileName(assertionCreator: Expect.() -> U * (provided via [niok](https://github.com/robstoll/niok)) of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -124,9 +124,9 @@ val Expect.fileNameWithoutExtension: Expect * Expects that the property [Path.fileNameWithoutExtension][ch.tutteli.niok.fileNameWithoutExtension] * (provided via [niok](https://github.com/robstoll/niok)) * of the subject of the assertion holds all assertions the given [assertionCreator] creates for it - * and returns this assertion container. + * and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -138,7 +138,7 @@ infix fun Expect.fileNameWithoutExtension(assertionCreator: Expect * Expects that this [Path] has a [parent][Path.getParent] and creates an [Expect] for it, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -148,9 +148,9 @@ val Expect.parent: Expect /** * Expects that this [Path] has a [parent][Path.getParent] and that the parent holds all assertions the - * given [assertionCreator] creates for it and returns this assertion container. + * given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -162,7 +162,7 @@ infix fun Expect.parent(assertionCreator: Expect.() -> Unit) * Expects that [other] resolves against this [Path] and creates an [Expect] for the resolved [Path] * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -183,7 +183,7 @@ infix fun Expect.resolve(other: String): Expect = * Its result, in particular its extended explanations, may be wrong if such concurrent file system operations * take place. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -200,7 +200,7 @@ infix fun Expect.toBe(@Suppress("UNUSED_PARAMETER") readable: read * Therefore, if a symbolic link exists at the location the subject points to, search will continue * at the location the link points at. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -220,7 +220,7 @@ infix fun Expect.toBe(@Suppress("UNUSED_PARAMETER") writable: writ * Its result, in particular its extended explanations, may be wrong if such concurrent file system operations * take place. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -240,7 +240,7 @@ infix fun Expect.toBe(@Suppress("UNUSED_PARAMETER") aRegularFile: * Its result, in particular its extended explanations, may be wrong if such concurrent file system operations * take place. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -253,7 +253,7 @@ infix fun Expect.toBe(@Suppress("UNUSED_PARAMETER") aDirectory: aD * (provided via [niok](https://github.com/robstoll/niok)) of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * * @since 0.10.0 */ @@ -263,9 +263,9 @@ val Expect.extension: Expect /** * Expects that the property [Path.extension][ch.tutteli.niok.extension] * (provided via [niok](https://github.com/robstoll/niok)) of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 diff --git a/apis/infix-en_GB/extensions/jdk8/atrium-api-infix-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/jdk8/zonedDateTimeAssertions.kt b/apis/infix-en_GB/extensions/jdk8/atrium-api-infix-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/jdk8/zonedDateTimeAssertions.kt index ed8a39883..4714c3c69 100644 --- a/apis/infix-en_GB/extensions/jdk8/atrium-api-infix-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/jdk8/zonedDateTimeAssertions.kt +++ b/apis/infix-en_GB/extensions/jdk8/atrium-api-infix-en_GB-jdk8-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/jdk8/zonedDateTimeAssertions.kt @@ -15,7 +15,7 @@ import java.time.ZonedDateTime * Creates an [Expect] for the property [ZonedDateTime.year][ZonedDateTime.getYear] of the subject of the assertion, * so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * * @since 0.10.0 */ @@ -24,9 +24,9 @@ val Expect.year: Expect /** * Expects that the property [ZonedDateTime.year][ZonedDateTime.getYear] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -38,7 +38,7 @@ infix fun Expect.year(assertionCreator: Expect.() -> * Creates an [Expect] for the property [ZonedDateTime.monthValue][ZonedDateTime.getMonthValue] * of the subject of the assertion, so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * * @since 0.10.0 */ @@ -47,9 +47,9 @@ val Expect.month: Expect /** * Expects that the property [ZonedDateTime.monthValue][ZonedDateTime.getMonthValue] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -61,7 +61,7 @@ infix fun Expect.month(assertionCreator: Expect.() - * Creates an [Expect] for the property [ZonedDatetime.dayOfWeek][ZonedDateTime.getDayOfWeek] * of the subject of the assertion, so that further fluent calls are assertions about it. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. * * @since 0.10.0 */ @@ -70,9 +70,9 @@ val Expect.dayOfWeek: Expect /** * Expects that the property [ZonedDatetime.dayOfWeek][ZonedDateTime.getDayOfWeek] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 @@ -84,7 +84,7 @@ infix fun Expect.dayOfWeek(assertionCreator: Expect Expect.day: Expect /** * Expects that the property [ZonedDateTime.dayOfMonth][ZonedDateTime.getDayOfMonth] of the subject of the assertion - * holds all assertions the given [assertionCreator] creates for it and returns this assertion container. + * holds all assertions the given [assertionCreator] creates for it and returns this [Expect]. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] if the assertion made is not correct. * * @since 0.10.0 diff --git a/core/api/atrium-core-api-common/src/main/kotlin/ch/tutteli/atrium/creating/CollectingAssertionContainer.kt b/core/api/atrium-core-api-common/src/main/kotlin/ch/tutteli/atrium/creating/CollectingAssertionContainer.kt index 2fa00f288..d3cb2ecf7 100644 --- a/core/api/atrium-core-api-common/src/main/kotlin/ch/tutteli/atrium/creating/CollectingAssertionContainer.kt +++ b/core/api/atrium-core-api-common/src/main/kotlin/ch/tutteli/atrium/creating/CollectingAssertionContainer.kt @@ -4,12 +4,12 @@ import ch.tutteli.atrium.assertions.Assertion /** * Represents a container for [Assertion] which is intended to serve as receiver object for lambdas which create - * [Assertion]s, in which this assertion container collects the assertions created this ways. + * [Assertion]s, in which this [Expect] collects the assertions created this ways. * * This container does not offer reporting capabilities in contrast to [ReportingAssertionContainer]. * It merely offers a method to [getAssertions] (the collected ones). * - * @param T The type of the [subject] of this assertion container. + * @param T The type of the [subject] of this [Expect]. */ interface CollectingAssertionContainer : Expect { diff --git a/core/api/atrium-core-api-common/src/main/kotlin/ch/tutteli/atrium/creating/Expect.kt b/core/api/atrium-core-api-common/src/main/kotlin/ch/tutteli/atrium/creating/Expect.kt index 0852e3cfa..14e4e45a1 100644 --- a/core/api/atrium-core-api-common/src/main/kotlin/ch/tutteli/atrium/creating/Expect.kt +++ b/core/api/atrium-core-api-common/src/main/kotlin/ch/tutteli/atrium/creating/Expect.kt @@ -37,7 +37,7 @@ interface Expect : SubjectProvider { * * @param assertionCreator The receiver function which should create and add assertions to this container. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] depending on the concrete implementation. */ fun addAssertionsCreatedBy(assertionCreator: Expect.() -> Unit): Expect @@ -47,7 +47,7 @@ interface Expect : SubjectProvider { * * @param assertion The assertion which will be added to this container. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * * @throws AssertionError Might throw an [AssertionError] in case [Assertion]s are immediately * evaluated (see [ReportingAssertionContainer]). @@ -63,7 +63,7 @@ interface Expect : SubjectProvider { * @param expected The expected value, e.g., `5` * @param test Indicates whether the assertion holds or fails. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] in case [Assertion]s are immediately * evaluated (see [ReportingAssertionContainer]). */ @@ -78,7 +78,7 @@ interface Expect : SubjectProvider { * @param expected The expected value, e.g., `5` * @param test Indicates whether the assertion holds or fails. * - * @return This assertion container to support a fluent API. + * @return An [Expect] for the current subject of the assertion. * @throws AssertionError Might throw an [AssertionError] in case [Assertion]s are immediately * evaluated (see [ReportingAssertionContainer]). */ diff --git a/domain/api/atrium-domain-api-common/src/main/kotlin/ch/tutteli/atrium/domain/creating/changers/FeatureExtractor.kt b/domain/api/atrium-domain-api-common/src/main/kotlin/ch/tutteli/atrium/domain/creating/changers/FeatureExtractor.kt index ab6c987db..0c1027791 100644 --- a/domain/api/atrium-domain-api-common/src/main/kotlin/ch/tutteli/atrium/domain/creating/changers/FeatureExtractor.kt +++ b/domain/api/atrium-domain-api-common/src/main/kotlin/ch/tutteli/atrium/domain/creating/changers/FeatureExtractor.kt @@ -50,7 +50,7 @@ interface FeatureExtractor { * if you want a different representation, then use this parameter where passing `null` still means use the * feature. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. */ fun extract( originalAssertionContainer: Expect, diff --git a/domain/api/atrium-domain-api-common/src/main/kotlin/ch/tutteli/atrium/domain/creating/changers/SubjectChanger.kt b/domain/api/atrium-domain-api-common/src/main/kotlin/ch/tutteli/atrium/domain/creating/changers/SubjectChanger.kt index ebace1334..ca2753902 100644 --- a/domain/api/atrium-domain-api-common/src/main/kotlin/ch/tutteli/atrium/domain/creating/changers/SubjectChanger.kt +++ b/domain/api/atrium-domain-api-common/src/main/kotlin/ch/tutteli/atrium/domain/creating/changers/SubjectChanger.kt @@ -44,7 +44,7 @@ interface SubjectChanger { * [Expect]) then you usually pass `this` (so the instance of [Expect]) for this parameter. * @param transformation Provides the subject. * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. */ fun unreported( originalAssertionContainer: Expect, @@ -80,7 +80,7 @@ interface SubjectChanger { * change fails since we can then already show to you (in error reporting) what you wanted to assert about * the new subject (which gives you more context to the error). * - * @return The newly created [Expect]. + * @return The newly created [Expect] for the extracted feature. */ fun reported( originalAssertionContainer: Expect, diff --git a/domain/api/extensions/kotlin_1_3/atrium-domain-api-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/domain/kotlin_1_3/creating/ResultAssertions.kt b/domain/api/extensions/kotlin_1_3/atrium-domain-api-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/domain/kotlin_1_3/creating/ResultAssertions.kt index 31e719426..82c421cfa 100644 --- a/domain/api/extensions/kotlin_1_3/atrium-domain-api-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/domain/kotlin_1_3/creating/ResultAssertions.kt +++ b/domain/api/extensions/kotlin_1_3/atrium-domain-api-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/domain/kotlin_1_3/creating/ResultAssertions.kt @@ -18,10 +18,10 @@ val resultAssertions by lazy { loadSingleService(ResultAssertions::class) } * which an implementation of the domain of Atrium has to provide. */ interface ResultAssertions { - fun > isSuccess(assertionContainer: Expect): ExtractedFeaturePostStep + fun > isSuccess(expect: Expect): ExtractedFeaturePostStep fun isFailure( - assertionContainer: Expect>, + expect: Expect>, expectedType: KClass ): ChangedSubjectPostStep } diff --git a/domain/builders/atrium-domain-builders-common/src/main/kotlin/ch/tutteli/atrium/domain/builders/ExpectImpl.kt b/domain/builders/atrium-domain-builders-common/src/main/kotlin/ch/tutteli/atrium/domain/builders/ExpectImpl.kt index b94dce233..14529fba2 100644 --- a/domain/builders/atrium-domain-builders-common/src/main/kotlin/ch/tutteli/atrium/domain/builders/ExpectImpl.kt +++ b/domain/builders/atrium-domain-builders-common/src/main/kotlin/ch/tutteli/atrium/domain/builders/ExpectImpl.kt @@ -35,8 +35,8 @@ object ExpectImpl { * into another representation (e.g. down-cast `Person` to `Student`) then you should use * [feature.extractor][NewFeatureAssertionsBuilder.extractor] instead. */ - inline fun changeSubject(originalAssertionContainer: Expect) = - SubjectChangerBuilder.create(originalAssertionContainer) + inline fun changeSubject(originalExpect: Expect) = + SubjectChangerBuilder.create(originalExpect) @Deprecated("Do no longer use Assert, use Expect instead - this method was introduced in 0.9.0 to ease the migration from Assert to Expect; will be removed with 1.0.0") @Suppress("DEPRECATION", "DeprecatedCallableAddReplaceWith") diff --git a/domain/builders/atrium-domain-builders-common/src/main/kotlin/ch/tutteli/atrium/domain/builders/creating/changers/SubjectChangerBuilder.kt b/domain/builders/atrium-domain-builders-common/src/main/kotlin/ch/tutteli/atrium/domain/builders/creating/changers/SubjectChangerBuilder.kt index b16be204f..3d902db27 100644 --- a/domain/builders/atrium-domain-builders-common/src/main/kotlin/ch/tutteli/atrium/domain/builders/creating/changers/SubjectChangerBuilder.kt +++ b/domain/builders/atrium-domain-builders-common/src/main/kotlin/ch/tutteli/atrium/domain/builders/creating/changers/SubjectChangerBuilder.kt @@ -31,7 +31,7 @@ interface SubjectChangerBuilder { /** * Entry point to use the [SubjectChangerBuilder]. */ - fun create(originalAssertionContainer: Expect): KindStep = KindStepImpl(originalAssertionContainer) + fun create(expect: Expect): KindStep = KindStepImpl(expect) @Deprecated("Do no longer use Assert, use Expect instead - this method was introduced in 0.9.0 to ease the migration from Assert to Expect; will be removed with 1.0.0") @Suppress("DEPRECATION", "DeprecatedCallableAddReplaceWith") @@ -75,7 +75,7 @@ interface SubjectChangerBuilder { /** * The previously specified assertion container to which the new [Expect] will delegate assertion checking. */ - val originalAssertionContainer: Expect + val originalExpect: Expect /** @@ -85,7 +85,7 @@ interface SubjectChangerBuilder { * @return The newly created [Expect] for the new subject. */ fun unreported(transformation: (T) -> R): Expect = - subjectChanger.unreported(originalAssertionContainer, transformation) + subjectChanger.unreported(originalExpect, transformation) /** * Entry point of the building process to not only change the subject but also report the change in reporting. @@ -107,11 +107,11 @@ interface SubjectChangerBuilder { /** * The previously specified assertion container to which the new [Expect] will delegate assertion checking. */ - val originalAssertionContainer: Expect + val originalExpect: Expect /** * Uses [DescriptionAnyAssertion.IS_A] as description of the change, - * the given [subType] as representation and tries to perform a down-cast of [originalAssertionContainer]'s + * the given [subType] as representation and tries to perform a down-cast of [originalExpect]'s * [Expect.maybeSubject] to the given type [TSub] */ //TODO once kotlin supports to have type parameters as upper bounds of another type parameter next to `: Any` we should restrict TSub : T & Any @@ -161,7 +161,7 @@ interface SubjectChangerBuilder { /** * The previously specified assertion container to which the new [Expect] will delegate assertion checking. */ - val originalAssertionContainer: Expect + val originalExpect: Expect /** * The previously specified description which describes the kind of subject change. diff --git a/domain/builders/atrium-domain-builders-common/src/main/kotlin/ch/tutteli/atrium/domain/builders/creating/changers/impl/subjectchanger/defaultImpls.kt b/domain/builders/atrium-domain-builders-common/src/main/kotlin/ch/tutteli/atrium/domain/builders/creating/changers/impl/subjectchanger/defaultImpls.kt index 81697ef87..5e54bd780 100644 --- a/domain/builders/atrium-domain-builders-common/src/main/kotlin/ch/tutteli/atrium/domain/builders/creating/changers/impl/subjectchanger/defaultImpls.kt +++ b/domain/builders/atrium-domain-builders-common/src/main/kotlin/ch/tutteli/atrium/domain/builders/creating/changers/impl/subjectchanger/defaultImpls.kt @@ -13,11 +13,11 @@ import ch.tutteli.atrium.reporting.RawString import ch.tutteli.atrium.reporting.translating.Translatable class KindStepImpl( - override val originalAssertionContainer: Expect + override val originalExpect: Expect ) : SubjectChangerBuilder.KindStep { override fun reportBuilder(): SubjectChangerBuilder.DescriptionRepresentationStep = - SubjectChangerBuilder.DescriptionRepresentationStep.create(originalAssertionContainer) + SubjectChangerBuilder.DescriptionRepresentationStep.create(originalExpect) } @Suppress("DEPRECATION") @@ -26,21 +26,21 @@ class DeprecatedKindStepImpl( ) : SubjectChangerBuilder.DeprecatedKindStep class DescriptionRepresentationStepImpl( - override val originalAssertionContainer: Expect + override val originalExpect: Expect ) : SubjectChangerBuilder.DescriptionRepresentationStep { override fun withDescriptionAndRepresentation( description: Translatable, representation: Any? ): SubjectChangerBuilder.TransformationStep = SubjectChangerBuilder.TransformationStep.create( - originalAssertionContainer, + originalExpect, description, representation ?: RawString.NULL ) } class TransformationStepImpl( - override val originalAssertionContainer: Expect, + override val originalExpect: Expect, override val description: Translatable, override val representation: Any ) : SubjectChangerBuilder.TransformationStep { @@ -72,7 +72,7 @@ class FinalStepImpl( ) : SubjectChangerBuilder.FinalStep { override fun build(): ChangedSubjectPostStep = - ChangedSubjectPostStep(transformationStep.originalAssertionContainer, + ChangedSubjectPostStep(transformationStep.originalExpect, transform = { transformIt(this, None) }, transformAndApply = { assertionCreator -> transformIt(this, Some(assertionCreator)) } ) diff --git a/domain/builders/extensions/kotlin_1_3/atrium-domain-builders-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/domain/builders/kotlin_1_3/creating/ResultAssertionsBuilder.kt b/domain/builders/extensions/kotlin_1_3/atrium-domain-builders-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/domain/builders/kotlin_1_3/creating/ResultAssertionsBuilder.kt index 86deda1c8..11cc08716 100644 --- a/domain/builders/extensions/kotlin_1_3/atrium-domain-builders-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/domain/builders/kotlin_1_3/creating/ResultAssertionsBuilder.kt +++ b/domain/builders/extensions/kotlin_1_3/atrium-domain-builders-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/domain/builders/kotlin_1_3/creating/ResultAssertionsBuilder.kt @@ -16,12 +16,9 @@ import kotlin.reflect.KClass */ object ResultAssertionsBuilder : ResultAssertions { - override inline fun > isSuccess( - assertionContainer: Expect - ): ExtractedFeaturePostStep = resultAssertions.isSuccess(assertionContainer) + override inline fun > isSuccess(expect: Expect): ExtractedFeaturePostStep = + resultAssertions.isSuccess(expect) - override fun isFailure( - assertionContainer: Expect>, - expectedType: KClass - ) = resultAssertions.isFailure(assertionContainer, expectedType) + override fun isFailure(expect: Expect>, expectedType: KClass) = + resultAssertions.isFailure(expect, expectedType) } diff --git a/domain/robstoll-lib/extensions/kotlin_1_3/atrium-domain-robstoll-lib-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/domain.robstoll.lib.kotlin_1_3/creating/resultAssertions.kt b/domain/robstoll-lib/extensions/kotlin_1_3/atrium-domain-robstoll-lib-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/domain.robstoll.lib.kotlin_1_3/creating/resultAssertions.kt index a2845a55c..f86e534b0 100644 --- a/domain/robstoll-lib/extensions/kotlin_1_3/atrium-domain-robstoll-lib-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/domain.robstoll.lib.kotlin_1_3/creating/resultAssertions.kt +++ b/domain/robstoll-lib/extensions/kotlin_1_3/atrium-domain-robstoll-lib-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/domain.robstoll.lib.kotlin_1_3/creating/resultAssertions.kt @@ -26,12 +26,12 @@ fun > _isSuccess(expect: Expect): ExtractedFeaturePostStep _isFailure( - assertionContainer: Expect>, + expect: Expect>, expectedType: KClass ): ChangedSubjectPostStep { val throwableExpect = ExpectImpl.feature - .manualFeature(assertionContainer, EXCEPTION) { exceptionOrNull() } + .manualFeature(expect, EXCEPTION) { exceptionOrNull() } .getExpectOfFeature() .withRepresentation { it ?: RawString.create(IS_NOT_FAILURE) } diff --git a/domain/robstoll/extensions/kotlin_1_3/atrium-domain-robstoll-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/domain/robstoll.kotlin_1_3/creating/ResultAssertionsImpl.kt b/domain/robstoll/extensions/kotlin_1_3/atrium-domain-robstoll-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/domain/robstoll.kotlin_1_3/creating/ResultAssertionsImpl.kt index ad2892552..e1a79f578 100644 --- a/domain/robstoll/extensions/kotlin_1_3/atrium-domain-robstoll-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/domain/robstoll.kotlin_1_3/creating/ResultAssertionsImpl.kt +++ b/domain/robstoll/extensions/kotlin_1_3/atrium-domain-robstoll-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/domain/robstoll.kotlin_1_3/creating/ResultAssertionsImpl.kt @@ -1,17 +1,15 @@ package ch.tutteli.atrium.domain.robstoll.kotlin_1_3.creating import ch.tutteli.atrium.creating.Expect -import ch.tutteli.atrium.domain.creating.changers.ChangedSubjectPostStep import ch.tutteli.atrium.domain.kotlin_1_3.creating.ResultAssertions import ch.tutteli.atrium.domain.robstoll.lib.kotlin_1_3.creating._isFailure import ch.tutteli.atrium.domain.robstoll.lib.kotlin_1_3.creating._isSuccess import kotlin.reflect.KClass class ResultAssertionsImpl : ResultAssertions { - override fun > isSuccess(assertionContainer: Expect) = _isSuccess(assertionContainer) + override fun > isSuccess(expect: Expect) = + _isSuccess(expect) - override fun isFailure( - assertionContainer: Expect>, - expectedType: KClass - ) = _isFailure(assertionContainer, expectedType) + override fun isFailure(expect: Expect>, expectedType: KClass) = + _isFailure(expect, expectedType) }