diff --git a/apis/fluent/atrium-api-fluent/src/commonMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/charSequenceToContainCreators.kt b/apis/fluent/atrium-api-fluent/src/commonMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/charSequenceToContainCreators.kt index aa673b8f6c..9ed153f4bf 100644 --- a/apis/fluent/atrium-api-fluent/src/commonMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/charSequenceToContainCreators.kt +++ b/apis/fluent/atrium-api-fluent/src/commonMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/charSequenceToContainCreators.kt @@ -18,7 +18,7 @@ import ch.tutteli.kbox.glue import kotlin.jvm.JvmName /** - * Finishes the specification of the sophisticated `contains` assertion where the [expected] object shall be searched, + * Finishes the specification of the sophisticated `to contain` expectation where the [expected] object shall be searched, * using a non-disjoint search. * * Delegates to [values]. @@ -41,7 +41,7 @@ fun CheckerStep.value(expected: CharS values(expected) /** - * Finishes the specification of the sophisticated `contains` assertion where the [expected] value as well as + * Finishes the specification of the sophisticated `to contain` expectation where the [expected] value as well as * the [otherExpected] values shall be searched, using a non-disjoint search. * * Notice that a runtime check applies which assures that only [CharSequence], [Number] and [Char] are passed. @@ -76,7 +76,7 @@ fun CheckerStep.values( /** - * Finishes the specification of the sophisticated `contains` assertion where the [expected] value shall be searched + * Finishes the specification of the sophisticated `to contain` expectation where the [expected] value shall be searched * (ignoring case), using a non-disjoint search. * * Delegates to `values(expected)`. @@ -101,7 +101,7 @@ fun CheckerStep.value( ): Expect = values(expected) /** - * Finishes the specification of the sophisticated `contains` assertion where the [expected] value as well as + * Finishes the specification of the sophisticated `to contain` expectation where the [expected] value as well as * the [otherExpected] values shall be searched (ignoring case), using a non-disjoint search. * * Notice that a runtime check applies which assures that only [CharSequence], [Number] and [Char] are passed. @@ -137,7 +137,7 @@ fun CheckerStep.values( /** - * Finishes the specification of the sophisticated `contains` assertion where the [expected] value shall be searched + * Finishes the specification of the sophisticated `to contain` expectation where the [expected] value shall be searched * (ignoring case), using a non-disjoint search where it needs to be contained at least once. * * Delegates to `atLeast(1).value(expected)`. @@ -161,7 +161,7 @@ fun EntryPointStep.value( ): Expect = atLeast(1).value(expected) /** - * Finishes the specification of the sophisticated `contains` assertion where the [expected] value as well as + * Finishes the specification of the sophisticated `to contain` expectation where the [expected] value as well as * the [otherExpected] values shall be searched (ignoring case), using a non-disjoint search * where each need to be contained at least once. * @@ -192,7 +192,7 @@ fun EntryPointStep.values( ): Expect = atLeast(1).values(expected, *otherExpected) /** - * Finishes the specification of the sophisticated `contains` assertion where the given regular expression [pattern] + * Finishes the specification of the sophisticated `to contain` expectation where the given regular expression [pattern] * as well as the [otherPatterns] are expected to have a match, using a non-disjoint search. * * By non-disjoint is meant that `"aa"` in `"aaaa"` is found three times and not only two times. @@ -220,7 +220,7 @@ fun CheckerStep.regex( ): Expect = _logicAppend { regex(pattern glue otherPatterns) } /** - * Finishes the specification of the sophisticated `contains` assertion where the given [Regex] [pattern] + * Finishes the specification of the sophisticated `to contain` expectation where the given [Regex] [pattern] * as well as the [otherPatterns] are expected to have a match, using a non-disjoint search. * * By non-disjoint is meant that `"aa"` in `"aaaa"` is found three times and not only two times. @@ -251,7 +251,7 @@ fun CheckerStep.regex( ): Expect = _logicAppend { regex(pattern glue otherPatterns) } /** - * Finishes the specification of the sophisticated `contains` assertion where the given [Regex] [pattern] + * Finishes the specification of the sophisticated `to contain` expectation where the given [Regex] [pattern] * as well as the [otherPatterns] are expected to have a match, using a non-disjoint search. * * By non-disjoint is meant that `"aa"` in `"aaaa"` is found three times and not only two times. @@ -281,7 +281,7 @@ fun CheckerStep.matchFor( ): Expect = _logicAppend { regex(pattern glue otherPatterns) } /** - * Finishes the specification of the sophisticated `contains` assertion where the given regular expression [pattern] + * Finishes the specification of the sophisticated `to contain` expectation where the given regular expression [pattern] * as well as the [otherPatterns] are expected to have a match (ignoring case), using a non-disjoint search. * * By non-disjoint is meant that `"aa"` in `"aaaa"` is found three times and not only two times. @@ -310,7 +310,7 @@ fun CheckerStep.regex( ): Expect = _logicAppend { regexIgnoringCase(pattern glue otherPatterns) } /** - * Finishes the specification of the sophisticated `contains` assertion where the given regular expression [pattern] + * Finishes the specification of the sophisticated `to contain` expectation where the given regular expression [pattern] * as well as the [otherPatterns] are expected to to have at least one match (ignoring case), * using a non-disjoint search. * @@ -341,7 +341,7 @@ fun EntryPointStep.regex( ): Expect = atLeast(1).regex(pattern, *otherPatterns) /** - * Finishes the specification of the sophisticated `contains` assertion where all elements of the [expectedIterableLike] + * Finishes the specification of the sophisticated `to contain` expectation where all elements of the [expectedIterableLike] * shall be searched, using a non-disjoint search. * * Delegates to `values(expectedIterable.first(), *expectedIterable.drop(1).toTypedArray())` @@ -371,7 +371,7 @@ fun CheckerStep.elementsOf( /** - * Finishes the specification of the sophisticated `contains` assertion where all elements of the [expectedIterableLike] + * Finishes the specification of the sophisticated `to contain` expectation where all elements of the [expectedIterableLike] * shall be searched (ignoring case), using a non-disjoint search. * * Delegates to `values(expectedIterable.first(), *expectedIterable.drop(1).toTypedArray())` @@ -400,7 +400,7 @@ fun CheckerStep.elementsOf( .let { (first, rest) -> values(first, *rest) } /** - * Finishes the specification of the sophisticated `contains` assertion where all elements of the [expectedIterableLike] + * Finishes the specification of the sophisticated `to contain` expectation where all elements of the [expectedIterableLike] * shall be searched (ignoring case), using a non-disjoint search. * * Delegates to `values(expectedIterable.first(), *expectedIterable.drop(1).toTypedArray())` diff --git a/apis/fluent/atrium-api-fluent/src/commonMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeToContainInAnyOrderCreators.kt b/apis/fluent/atrium-api-fluent/src/commonMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeToContainInAnyOrderCreators.kt index e9b704d966..87084cc98a 100644 --- a/apis/fluent/atrium-api-fluent/src/commonMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeToContainInAnyOrderCreators.kt +++ b/apis/fluent/atrium-api-fluent/src/commonMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeToContainInAnyOrderCreators.kt @@ -14,7 +14,7 @@ import ch.tutteli.atrium.logic.utils.toVarArg import ch.tutteli.kbox.glue /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain the [expected] value. * * Delegates to [values]. @@ -29,7 +29,7 @@ fun CheckerStep.value(expe values(expected) /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain the [expected] value as well as the [otherExpected] values where it does not matter * in which order they appear. * @@ -56,7 +56,7 @@ fun CheckerStep.values( ): Expect = _logicAppend { values(expected glue otherExpected, StaticNames.notToHaveElementsOrNone) } /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain an entry which either holds all assertions [assertionCreatorOrNull] creates or * needs to be `null` in case [assertionCreatorOrNull] is defined as `null`. * @@ -75,7 +75,7 @@ fun CheckerStep ): Expect = entries(assertionCreatorOrNull) /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain an entry for [assertionCreatorOrNull] as well as for the [otherAssertionCreatorsOrNulls] * where it does not matter in which order they appear -- an entry is contained if it either * holds all assertions [assertionCreatorOrNull] creates or @@ -97,7 +97,7 @@ fun CheckerStep ): Expect = _logicAppend { entries(assertionCreatorOrNull glue otherAssertionCreatorsOrNulls, StaticNames.notToHaveElementsOrNone) } /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain all elements of the [expectedIterableLike] where it does not matter in which order they appear. * * Delegates to [values] which also means that it does not search for unique matches diff --git a/apis/fluent/atrium-api-fluent/src/commonMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeToContainInAnyOrderOnlyCreators.kt b/apis/fluent/atrium-api-fluent/src/commonMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeToContainInAnyOrderOnlyCreators.kt index 7402bac9a4..fd76663475 100644 --- a/apis/fluent/atrium-api-fluent/src/commonMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeToContainInAnyOrderOnlyCreators.kt +++ b/apis/fluent/atrium-api-fluent/src/commonMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeToContainInAnyOrderOnlyCreators.kt @@ -16,7 +16,7 @@ import ch.tutteli.atrium.logic.utils.toVarArg import ch.tutteli.kbox.glue /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain only the [expected] value. * * Delegates to [values]. @@ -31,7 +31,7 @@ fun EntryPointStep.va values(expected) /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain only the [expected] value as well as the [otherExpected] values * where it does not matter in which order. * @@ -52,7 +52,7 @@ fun EntryPointStep.va ): Expect = _logicAppend { valuesInAnyOrderOnly(expected glue otherExpected, report) } /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain only one entry which holds all assertions created by the given [assertionCreatorOrNull] * or is `null` in case [assertionCreatorOrNull] is defined as `null`. * @@ -71,7 +71,7 @@ fun EntryPointStep = entries(assertionCreatorOrNull) /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain only an entry for [assertionCreatorOrNull] as well as for the [otherAssertionCreatorsOrNulls] * where it does not matter in which order they appear -- an entry is contained if it either * holds all assertions [assertionCreatorOrNull] creates or @@ -105,7 +105,7 @@ fun EntryPointStep = _logicAppend { entriesInAnyOrderOnly(assertionCreatorOrNull glue otherAssertionCreatorsOrNulls, report) } /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain only and all elements of [expectedIterableLike] where it does not matter in which order. * * Delegates to [values]. diff --git a/apis/fluent/atrium-api-fluent/src/commonMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeToContainInOrderOnlyCreators.kt b/apis/fluent/atrium-api-fluent/src/commonMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeToContainInOrderOnlyCreators.kt index 40562400c3..90e65c854d 100644 --- a/apis/fluent/atrium-api-fluent/src/commonMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeToContainInOrderOnlyCreators.kt +++ b/apis/fluent/atrium-api-fluent/src/commonMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeToContainInOrderOnlyCreators.kt @@ -14,7 +14,7 @@ import ch.tutteli.atrium.logic.utils.toVarArg import ch.tutteli.kbox.glue /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain only the [expected] value. * * Delegates to [values]. @@ -29,7 +29,7 @@ fun EntryPointStep.value values(expected) /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain only the [expected] value as well as the [otherExpected] values * in the specified order. * @@ -50,7 +50,7 @@ fun EntryPointStep.value ): Expect = _logicAppend { valuesInOrderOnly(expected glue otherExpected, report) } /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain only one entry which holds all assertions created by the given [assertionCreatorOrNull] * or is `null` in case [assertionCreatorOrNull] is defined as `null`. * @@ -69,7 +69,7 @@ fun EntryPointStep = entries(assertionCreatorOrNull) /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain only an entry for [assertionCreatorOrNull] as well as for the [otherAssertionCreatorsOrNulls] * in the specified order -- an entry is contained if it either * holds all assertions [assertionCreatorOrNull] creates or @@ -95,7 +95,7 @@ fun EntryPointStep = _logicAppend { entriesInOrderOnly(assertionCreatorOrNull glue otherAssertionCreatorsOrNulls, report) } /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain only and all elements of [expectedIterableLike] in the specified order. * * Delegates to [values]. diff --git a/apis/fluent/atrium-api-fluent/src/commonMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeToContainInOrderOnlyGroupedCreators.kt b/apis/fluent/atrium-api-fluent/src/commonMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeToContainInOrderOnlyGroupedCreators.kt index 540aba07fe..97e97df198 100644 --- a/apis/fluent/atrium-api-fluent/src/commonMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeToContainInOrderOnlyGroupedCreators.kt +++ b/apis/fluent/atrium-api-fluent/src/commonMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeToContainInOrderOnlyGroupedCreators.kt @@ -14,7 +14,7 @@ import ch.tutteli.atrium.logic.creating.iterablelike.contains.reporting.InOrderO import kotlin.jvm.JvmName /** - * Finishes the specification of the sophisticated `contains` assertion where the expected [firstGroup] as well as + * Finishes the specification of the sophisticated `to contain` expectation where the expected [firstGroup] as well as * the [secondGroup] and optionally [otherExpectedGroups] of values need to be contained in [IterableLike] * as only elements and in the specified order whereas the values within the groups can occur in any order. * @@ -45,7 +45,7 @@ fun EntryPointStep EntryPointStep.entry entries(keyValuePair) /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (a [MapLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (a [MapLike]) * needs to contain the given [keyValuePair] as well as the [otherPairs] where it does not matter * in which order they appear. * @@ -44,7 +44,7 @@ fun EntryPointStep.entri ): Expect = _logicAppend { keyValuePairsInAnyOrder(keyValuePair glue otherPairs) } /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (a [MapLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (a [MapLike]) * needs to contain an entry with a key as defined by [keyValue]'s [KeyValue.key] and * a corresponding value which either holds all assertions [keyValue]'s * [KeyValue.valueAssertionCreatorOrNull] creates or needs to be `null` in case @@ -61,7 +61,7 @@ inline fun EntryPointStep = entries(keyValue) /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (a [MapLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (a [MapLike]) * needs to contain the given [keyValue] as well as the [otherKeyValues] where it does not matter * in which order they appear -- an entry is contained if it has a key as defined by [keyValue]'s [KeyValue.key] and * a corresponding value which either holds all assertions [keyValue]'s @@ -91,7 +91,7 @@ internal fun EntryPointStep EntryPointStep.e entries(keyValuePair) /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (a [MapLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (a [MapLike]) * needs to contain only the given [keyValuePair] as well as the [otherPairs] where it does not matter * in which order they appear. * @@ -40,7 +40,7 @@ fun EntryPointStep.e ): Expect = _logicAppend { keyValuePairsInAnyOrderOnly(keyValuePair glue otherPairs) } /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (a [MapLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (a [MapLike]) * needs to contain exactly one entry with a key as defined by [keyValue]'s [KeyValue.key] and * a corresponding value which either holds all assertions [keyValue]'s * [KeyValue.valueAssertionCreatorOrNull] creates or needs to be `null` in case @@ -57,7 +57,7 @@ inline fun EntryPointStep = entries(keyValue) /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (a [MapLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (a [MapLike]) * needs to contain only the given [keyValue] as well as the [otherKeyValues] where it does not matter * in which order they appear -- an entry is contained if it has a key as defined by [keyValue]'s [KeyValue.key] and * a corresponding value which either holds all assertions [keyValue]'s @@ -82,7 +82,7 @@ internal fun EntryPointStep EntryPointStep.entr entries(keyValuePair) /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (a [MapLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (a [MapLike]) * needs to contain only the given [keyValuePair] as well as the [otherPairs] in the specified order. * * @param report The lambda configuring the [InOrderOnlyReportingOptions] -- it is optional where @@ -49,7 +49,7 @@ fun EntryPointStep.entr /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (a [MapLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (a [MapLike]) * needs to contain exactly one entry with a key as defined by [keyValue]'s [KeyValue.key] and * a corresponding value which either holds all assertions [keyValue]'s * [KeyValue.valueAssertionCreatorOrNull] creates or needs to be `null` in case @@ -66,7 +66,7 @@ inline fun EntryPointStep = entries(keyValue) /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (a [MapLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (a [MapLike]) * needs to contain only the given [keyValue] as well as the [otherKeyValues] in the specified order -- an entry * is contained if it has a key as defined by [keyValue]'s [KeyValue.key] and * a corresponding value which either holds all assertions [keyValue]'s @@ -97,7 +97,7 @@ internal fun EntryPointStep CheckerStep.value( ): Expect = this the values(expected) /** - * Finishes the specification of the sophisticated `contains` assertion where the given [values] + * Finishes the specification of the sophisticated `to contain` expectation where the given [values] * shall be searched, using a non-disjoint search. * * Notice that a runtime check applies which assures that only [CharSequence], [Number] and [Char] are passed. @@ -72,7 +72,7 @@ infix fun CheckerStep.the( /** - * Finishes the specification of the sophisticated `contains` assertion where the [expected] value shall be searched + * Finishes the specification of the sophisticated `to contain` expectation where the [expected] value shall be searched * (ignoring case), using a non-disjoint search. * * Delegates to `the values(expected)`. @@ -94,7 +94,7 @@ infix fun CheckerStep.value( ): Expect = this the values(expected) /** - * Finishes the specification of the sophisticated `contains` assertion where the [values] + * Finishes the specification of the sophisticated `to contain` expectation where the [values] * shall be searched (ignoring case), using a non-disjoint search. * * Notice that a runtime check applies which assures that only [CharSequence], [Number] and [Char] are passed. @@ -124,7 +124,7 @@ infix fun CheckerStep.the( ): Expect = _logicAppend { valuesIgnoringCase(values.toList()) } /** - * Finishes the specification of the sophisticated `contains` assertion where the [expected] value shall be searched + * Finishes the specification of the sophisticated `to contain` expectation where the [expected] value shall be searched * (ignoring case), using a non-disjoint search where it needs to be contained at least once. * * Delegates to `atLeast 1 value expected`. @@ -145,7 +145,7 @@ infix fun EntryPointStep.valu ): Expect = this atLeast 1 value expected /** - * Finishes the specification of the sophisticated `contains` assertion where the [values] + * Finishes the specification of the sophisticated `to contain` expectation where the [values] * shall be searched (ignoring case), using a non-disjoint search * where each need to be contained at least once. * @@ -177,7 +177,7 @@ infix fun EntryPointStep.the( ): Expect = this atLeast 1 the values /** - * Finishes the specification of the sophisticated `contains` assertion where the given regular expression [pattern] + * Finishes the specification of the sophisticated `to contain` expectation where the given regular expression [pattern] * is expected to have a match, using a non-disjoint search. * * Delegates to `the regexPatterns(pattern)`. @@ -190,7 +190,7 @@ infix fun CheckerStep.regex(pattern: this the regexPatterns(pattern) /** - * Finishes the specification of the sophisticated `contains` assertion where the given [Regex] [pattern] + * Finishes the specification of the sophisticated `to contain` expectation where the given [Regex] [pattern] * is expected to have a match. * * Delegates to `matchFor all(pattern)` @@ -206,7 +206,7 @@ infix fun CheckerStep.matchFor( ): Expect = this matchFor all(pattern) /** - * Finishes the specification of the sophisticated `contains` assertion where the given regular expression [patterns] + * Finishes the specification of the sophisticated `to contain` expectation where the given regular expression [patterns] * are expected to have a match, using a non-disjoint search. * * By non-disjoint is meant that `"aa"` in `"aaaa"` is found three times and not only two times. @@ -229,7 +229,7 @@ infix fun CheckerStep.the(patterns: R _logicAppend { regex(patterns.toList()) } /** - * Finishes the specification of the sophisticated `contains` assertion where the given [Regex] [patterns] + * Finishes the specification of the sophisticated `to contain` expectation where the given [Regex] [patterns] * are expected to have a match, using a non-disjoint search. * * By non-disjoint is meant that `"aa"` in `"aaaa"` is found three times and not only two times. @@ -254,7 +254,7 @@ infix fun CheckerStep.matchFor(patter _logicAppend { regex(patterns.toList()) } /** - * Finishes the specification of the sophisticated `contains` assertion where the given regular expression [pattern] + * Finishes the specification of the sophisticated `to contain` expectation where the given regular expression [pattern] * is expected to have a match (ignoring case), using a non-disjoint search. * * Delegates to `the regexPatterns(pattern)`. @@ -268,7 +268,7 @@ infix fun CheckerStep.regex(p this the regexPatterns(pattern) /** - * Finishes the specification of the sophisticated `contains` assertion where the given regular expression [patterns] + * Finishes the specification of the sophisticated `to contain` expectation where the given regular expression [patterns] * are expected to have a match (ignoring case), using a non-disjoint search. * * By non-disjoint is meant that `"aa"` in `"aaaa"` is found three times and not only two times. @@ -292,7 +292,7 @@ infix fun CheckerStep.the(pat _logicAppend { regexIgnoringCase(patterns.toList()) } /** - * Finishes the specification of the sophisticated `contains` assertion where the given regular expression [pattern] + * Finishes the specification of the sophisticated `to contain` expectation where the given regular expression [pattern] * is expected to have at least one match (ignoring case), using a non-disjoint search. * * Delegates to `atLeast 1 regex pattern`. @@ -305,7 +305,7 @@ infix fun EntryPointStep.rege this atLeast 1 regex pattern /** - * Finishes the specification of the sophisticated `contains` assertion where the given regular expression [patterns] + * Finishes the specification of the sophisticated `to contain` expectation where the given regular expression [patterns] * are expected to have at least one match (ignoring case), using a non-disjoint search. * * Delegates to `atLeast 1 the patterns`. @@ -330,7 +330,7 @@ infix fun EntryPointStep.the( this atLeast 1 the patterns /** - * Finishes the specification of the sophisticated `contains` assertion where all elements of the [expectedIterableLike] + * Finishes the specification of the sophisticated `to contain` expectation where all elements of the [expectedIterableLike] * shall be searched, using a non-disjoint search. * * Delegates to `the values(expectedIterable.first(), *expectedIterable.drop(1).toTypedArray())` @@ -356,7 +356,7 @@ infix fun CheckerStep.elementsOf( .let { (first, rest) -> this the Values(first, rest) } /** - * Finishes the specification of the sophisticated `contains` assertion where all elements of the [expectedIterableLike] + * Finishes the specification of the sophisticated `to contain` expectation where all elements of the [expectedIterableLike] * shall be searched (ignoring case), using a non-disjoint search. * * Delegates to `the values(expectedIterable.first(), *expectedIterable.drop(1).toTypedArray())` @@ -383,7 +383,7 @@ infix fun CheckerStep.element .let { (first, rest) -> this the Values(first, rest) } /** - * Finishes the specification of the sophisticated `contains` assertion where all elements of the [expectedIterableLike] + * Finishes the specification of the sophisticated `to contain` expectation where all elements of the [expectedIterableLike] * shall be searched (ignoring case), using a non-disjoint search. * * Delegates to `the values(expectedIterable.first(), *expectedIterable.drop(1).toTypedArray())` diff --git a/apis/infix/atrium-api-infix/src/commonMain/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableLikeToContainInAnyOrderCreators.kt b/apis/infix/atrium-api-infix/src/commonMain/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableLikeToContainInAnyOrderCreators.kt index 416b4f06d8..4c6f099e9c 100644 --- a/apis/infix/atrium-api-infix/src/commonMain/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableLikeToContainInAnyOrderCreators.kt +++ b/apis/infix/atrium-api-infix/src/commonMain/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableLikeToContainInAnyOrderCreators.kt @@ -15,7 +15,7 @@ import ch.tutteli.atrium.logic.creating.typeutils.IterableLikeToIterableTransfor import ch.tutteli.atrium.logic.utils.toVarArg /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain the [expected] value. * * Delegates to `the values(expected)`. @@ -30,7 +30,7 @@ infix fun CheckerStep.val this the values(expected) /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain the expected [values] where it does not matter * in which order they appear. * @@ -55,7 +55,7 @@ infix fun CheckerStep.the _logicAppend { values(values.toList(), StaticNames.notToHaveElementsOrNone) } /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain an entry which either holds all assertions [assertionCreatorOrNull] creates or * needs to be `null` in case [assertionCreatorOrNull] is defined as `null`. * @@ -74,7 +74,7 @@ infix fun CheckerStep = this the entries(assertionCreatorOrNull) /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain an entry for each in [entries] where it does not matter * in which order they appear -- an entry is contained if it either * holds all assertions [entries].[assertionCreatorOrNull][Entries.assertionCreatorOrNull] creates or @@ -93,7 +93,7 @@ infix fun CheckerStep = _logicAppend { entries(entries.toList(), StaticNames.notToHaveElementsOrNone) } /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain all elements of the [expectedIterableLike] where it does not matter in which order they appear. * * Delegates to [values] which also means that it does not search for unique matches diff --git a/apis/infix/atrium-api-infix/src/commonMain/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableLikeToContainInAnyOrderOnlyCreators.kt b/apis/infix/atrium-api-infix/src/commonMain/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableLikeToContainInAnyOrderOnlyCreators.kt index 7d4a1df94d..6f61c5f5ba 100644 --- a/apis/infix/atrium-api-infix/src/commonMain/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableLikeToContainInAnyOrderOnlyCreators.kt +++ b/apis/infix/atrium-api-infix/src/commonMain/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableLikeToContainInAnyOrderOnlyCreators.kt @@ -20,7 +20,7 @@ import ch.tutteli.atrium.logic.utils.toVarArg import kotlin.jvm.JvmName /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain only the [expected] value. * * Delegates to `the values(expected)`. @@ -33,7 +33,7 @@ infix fun EntryPointStep EntryPointStep EntryPointStep EntryPointStep = this the entries(assertionCreatorOrNull) /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain only the given [entries] where it does not matter in which order they appear -- an entry * is contained if it either holds all assertions * [entries].[assertionCreatorOrNull][Entries.assertionCreatorOrNull] creates or it needs to be `null` in case @@ -102,7 +102,7 @@ infix fun EntryPointStep = the(WithInAnyOrderOnlyReportingOptions({}, entries)) /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain only the given [entries] where it does not matter in which order they appear -- an entry * is contained if it either holds all assertions * [entries].[assertionCreatorOrNull][Entries.assertionCreatorOrNull] creates or it needs to be `null` in case @@ -129,7 +129,7 @@ infix fun EntryPointStep = _logicAppend { entriesInAnyOrderOnly(entries.t.toList(), entries.options) } /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain only and all elements of [expectedIterableLike] where it does not matter in which order. * * Delegates to [values]. @@ -152,7 +152,7 @@ inline infix fun EntryPointStep = _logic.toVarArg(expectedIterableLike).let { (first, rest) -> this the values(first, *rest) } /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain only and all elements of the given [IterableLike] in the specified order. * * Delegates to [values]. diff --git a/apis/infix/atrium-api-infix/src/commonMain/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableLikeToContainInOrderOnlyCreators.kt b/apis/infix/atrium-api-infix/src/commonMain/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableLikeToContainInOrderOnlyCreators.kt index 8b767e869f..dd4d48fc73 100644 --- a/apis/infix/atrium-api-infix/src/commonMain/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableLikeToContainInOrderOnlyCreators.kt +++ b/apis/infix/atrium-api-infix/src/commonMain/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableLikeToContainInOrderOnlyCreators.kt @@ -17,7 +17,7 @@ import ch.tutteli.atrium.logic.utils.toVarArg import kotlin.jvm.JvmName /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain only the [expected] value. * * Delegates to `the values(expected)`. @@ -32,7 +32,7 @@ infix fun EntryPointStep this the values(expected) /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain only the expected [values] in the specified order. * * @param values The values which are expected to be contained within the [IterableLike] @@ -46,7 +46,7 @@ infix fun EntryPointStep the(WithInOrderOnlyReportingOptions({}, values)) /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain only the expected [values] in the specified order. * * @param values The values which are expected to be contained within the [IterableLike] plus a lambda configuring @@ -65,7 +65,7 @@ infix fun EntryPointStep } /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain only one entry which holds all assertions created by the given [assertionCreatorOrNull] * or is `null` in case [assertionCreatorOrNull] is defined as `null`. * @@ -84,7 +84,7 @@ infix fun EntryPointStep = this the entries(assertionCreatorOrNull) /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain only the given [entries] in the specified order -- an entry * is contained if it either holds all assertions * [entries].[assertionCreatorOrNull][Entries.assertionCreatorOrNull] creates or it needs to be `null` in case @@ -103,7 +103,7 @@ infix fun EntryPointStep = the(WithInOrderOnlyReportingOptions({}, entries)) /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain only the given [entries] in the specified order -- an entry * is contained if it either holds all assertions * [entries].[assertionCreatorOrNull][Entries.assertionCreatorOrNull] creates or it needs to be `null` in case @@ -128,7 +128,7 @@ infix fun EntryPointStep EntryPointStep = _logic.toVarArg(expectedIterableLike).let { (first, rest) -> this the values(first, *rest) } /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (an [IterableLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (an [IterableLike]) * needs to contain only and all elements of the given [IterableLike] in the specified order. * * Delegates to [values]. diff --git a/apis/infix/atrium-api-infix/src/commonMain/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableLikeToContainInOrderOnlyGroupedCreators.kt b/apis/infix/atrium-api-infix/src/commonMain/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableLikeToContainInOrderOnlyGroupedCreators.kt index 584a16e268..730bf85f1a 100644 --- a/apis/infix/atrium-api-infix/src/commonMain/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableLikeToContainInOrderOnlyGroupedCreators.kt +++ b/apis/infix/atrium-api-infix/src/commonMain/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableLikeToContainInOrderOnlyGroupedCreators.kt @@ -16,7 +16,7 @@ import ch.tutteli.atrium.logic.utils.Group import kotlin.jvm.JvmName /** - * Finishes the specification of the sophisticated `contains` assertion where the expected [Order.firstGroup] as well as + * Finishes the specification of the sophisticated `to contain` expectation where the expected [Order.firstGroup] as well as * the [Order.secondGroup] and optionally [Order.otherExpectedGroups] of values need to be * contained in [IterableLike] in the specified order whereas the values within the groups can occur in any order. * @@ -37,7 +37,7 @@ private fun withoutReportingOptions(order: Order>) = WithInOrderOnlyReportingOptions({}, WithInAnyOrderOnlyReportingOptions({}, order)) /** - * Finishes the specification of the sophisticated `contains` assertion where the expected [Order.firstGroup] as well as + * Finishes the specification of the sophisticated `to contain` expectation where the expected [Order.firstGroup] as well as * the [Order.secondGroup] and optionally [Order.otherExpectedGroups] of values need to be * contained in [IterableLike] in the specified order whereas the values within the groups can occur in any order. * @@ -67,7 +67,7 @@ infix fun EntryPointStep EntryPointStep = inAny(withoutReportingOptions(order)) /** - * Finishes the specification of the sophisticated `contains` assertion where the expected [Order.firstGroup] as well as + * Finishes the specification of the sophisticated `to contain` expectation where the expected [Order.firstGroup] as well as * the [Order.secondGroup] and optionally [Order.otherExpectedGroups] of identification lambdas, identifying an entry, * need to be contained in [IterableLike] in the specified order whereas the identification lambdas within the groups * can occur in any order. diff --git a/apis/infix/atrium-api-infix/src/commonMain/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapLikeToCntainInAnyOrderOnlyCreators.kt b/apis/infix/atrium-api-infix/src/commonMain/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapLikeToCntainInAnyOrderOnlyCreators.kt index 3b1fc9ad4c..5f377ea7d6 100644 --- a/apis/infix/atrium-api-infix/src/commonMain/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapLikeToCntainInAnyOrderOnlyCreators.kt +++ b/apis/infix/atrium-api-infix/src/commonMain/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapLikeToCntainInAnyOrderOnlyCreators.kt @@ -15,7 +15,7 @@ import ch.tutteli.atrium.logic.utils.toVarArgPairs import kotlin.reflect.KClass /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (a [MapLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (a [MapLike]) * needs to contain exactly one entry where key and value have to equal the given [keyValuePair]. * * Delegates to `the pairs(keyValuePair)`. @@ -29,7 +29,7 @@ infix fun EntryPointStep = this the pairs(keyValuePair) /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (a [MapLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (a [MapLike]) * needs to contain only the given key-value [pairs] where it does not matter * in which order they appear. * @@ -45,7 +45,7 @@ infix fun EntryPointStep = _logicAppend { keyValuePairsInAnyOrderOnly(pairs.toList()) } /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (a [MapLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (a [MapLike]) * needs to contain exactly one entry with a key as defined by [keyValue]'s [KeyWithValueCreator.key] and * a corresponding value which either holds all assertions [keyValue]'s * [KeyWithValueCreator.valueAssertionCreatorOrNull] creates or needs to be `null` in case @@ -67,7 +67,7 @@ inline infix fun EntryPointStep = this the entries(keyValue) /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (a [MapLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (a [MapLike]) * needs to contain only the given [entries] where it does not matter * in which order they appear -- an entry is contained if it has * a key as defined by [keyValue]'s [KeyWithValueCreator.key] and @@ -95,7 +95,7 @@ internal fun EntryPointStep EntryPointStep this the pairs(keyValuePair) /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (a [MapLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (a [MapLike]) * needs to contain the given key-value [pairs] where it does not matter * in which order they appear. * @@ -48,7 +48,7 @@ infix fun EntryPointStep ): Expect = _logicAppend { keyValuePairsInAnyOrder(pairs.toList()) } /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (a [MapLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (a [MapLike]) * needs to contain an entry with a key as defined by [keyValue]'s [KeyWithValueCreator.key] and * a corresponding value which either holds all assertions [keyValue]'s * [KeyWithValueCreator.valueAssertionCreatorOrNull] creates or needs to be `null` in case @@ -70,7 +70,7 @@ inline infix fun EntryPointStep = this the entries(keyValue) /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (a [MapLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (a [MapLike]) * needs to contain the given [keyValues] where it does not matter * in which order they appear -- an entry is contained if it has * a key as defined by [keyValue]'s [KeyWithValueCreator.key] and @@ -102,7 +102,7 @@ internal fun EntryPointStep EntryPointStep EntryPointStep = the(WithInOrderOnlyReportingOptions({}, pairs)) /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (a [MapLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (a [MapLike]) * needs to contain only the given [pairs] in the specified order. * * @param pairs The key-value pairs which are expected to be contained within the [MapLike] @@ -69,7 +69,7 @@ infix fun EntryPointStep EntryPointStep = this the entries(keyValue) /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (a [MapLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (a [MapLike]) * needs to contain only the given [entries] in the specified order -- an entry * is contained if it has a key as defined by [keyValue]'s [KeyWithValueCreator.key] and * a corresponding value which either holds all assertions [keyValue]'s @@ -110,7 +110,7 @@ inline infix fun EntryPointStep = the(WithInOrderOnlyReportingOptions({}, entries)) /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (a [MapLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (a [MapLike]) * needs to contain only the given [entries] in the specified order -- an entry * is contained if it has a key as defined by [keyValue]'s [KeyWithValueCreator.key] and * a corresponding value which either holds all assertions [keyValue]'s @@ -143,7 +143,7 @@ internal fun EntryPointStep EntryPointStep = the(WithInOrderOnlyReportingOptions({}, expectedMapLike)) /** - * Finishes the specification of the sophisticated `contains` assertion where the subject (a [MapLike]) + * Finishes the specification of the sophisticated `to contain` expectation where the subject (a [MapLike]) * needs to contain only and all entries of the given [MapLike] in the specified order. * * Delegates to `the pairs` diff --git a/logic/atrium-logic/src/commonMain/kotlin/ch/tutteli/atrium/logic/creating/charsequence/contains/searchbehaviours/impl/NotSearchBehaviourImpl.kt b/logic/atrium-logic/src/commonMain/kotlin/ch/tutteli/atrium/logic/creating/charsequence/contains/searchbehaviours/impl/NotSearchBehaviourImpl.kt index 512b11d299..84261a7e63 100644 --- a/logic/atrium-logic/src/commonMain/kotlin/ch/tutteli/atrium/logic/creating/charsequence/contains/searchbehaviours/impl/NotSearchBehaviourImpl.kt +++ b/logic/atrium-logic/src/commonMain/kotlin/ch/tutteli/atrium/logic/creating/charsequence/contains/searchbehaviours/impl/NotSearchBehaviourImpl.kt @@ -11,8 +11,8 @@ import ch.tutteli.atrium.translations.DescriptionCharSequenceExpectation */ class NotSearchBehaviourImpl : NotSearchBehaviour { /** - * Returns [DescriptionCharSequenceExpectation.CONTAINS_NOT]. - * @return [DescriptionCharSequenceExpectation.CONTAINS_NOT] + * Returns [DescriptionCharSequenceExpectation.NOT_TO_CONTAIN]. + * @return [DescriptionCharSequenceExpectation.NOT_TO_CONTAIN] */ override fun decorateDescription(description: Translatable): Translatable = DescriptionCharSequenceExpectation.NOT_TO_CONTAIN