use to contain instead of contains and expectation instead assertion

robstoll · Sep 26, 2023 · 288b3fe · 288b3fe
1 parent d4933f1
commit 288b3fe
Show file tree

Hide file tree

Showing 17 changed files with 108 additions and 108 deletions.
diff --git a/...src/commonMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/charSequenceToContainCreators.kt b/...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 <T : CharSequence> CheckerStep<T, NoOpSearchBehaviour>.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 <T : CharSequence> CheckerStep<T, NoOpSearchBehaviour>.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 <T : CharSequence> CheckerStep<T, IgnoringCaseSearchBehaviour>.value(
 ): Expect<T> = 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 <T : CharSequence> CheckerStep<T, IgnoringCaseSearchBehaviour>.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 <T : CharSequence> EntryPointStep<T, IgnoringCaseSearchBehaviour>.value(
 ): Expect<T> = 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 <T : CharSequence> EntryPointStep<T, IgnoringCaseSearchBehaviour>.values(
 ): Expect<T> = 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 <T : CharSequence> CheckerStep<T, NoOpSearchBehaviour>.regex(
 ): Expect<T> = _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 <T : CharSequence> CheckerStep<T, NoOpSearchBehaviour>.regex(
 ): Expect<T> = _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 <T : CharSequence> CheckerStep<T, NoOpSearchBehaviour>.matchFor(
 ): Expect<T> = _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 <T : CharSequence> CheckerStep<T, IgnoringCaseSearchBehaviour>.regex(
 ): Expect<T> = _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 <T : CharSequence> EntryPointStep<T, IgnoringCaseSearchBehaviour>.regex(
 ): Expect<T> = 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 <T : CharSequence> CheckerStep<T, NoOpSearchBehaviour>.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 <T : CharSequence> CheckerStep<T, IgnoringCaseSearchBehaviour>.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/...Main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeToContainInAnyOrderCreators.kt b/...Main/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 <E, T: IterableLike> CheckerStep<E, T, InAnyOrderSearchBehaviour>.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 <E, T: IterableLike> CheckerStep<E, T, InAnyOrderSearchBehaviour>.values(
 ): Expect<T> = _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 <E : Any, T: IterableLike> CheckerStep<out E?, T, InAnyOrderSearchBehaviour>
 ): Expect<T> = 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 <E : Any, T: IterableLike> CheckerStep<out E?, T, InAnyOrderSearchBehaviour>
 ): Expect<T> = _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/.../kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeToContainInAnyOrderOnlyCreators.kt b/.../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 <E, T : IterableLike> EntryPointStep<E, T, InAnyOrderOnlySearchBehaviour>.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 <E, T : IterableLike> EntryPointStep<E, T, InAnyOrderOnlySearchBehaviour>.va
 ): Expect<T> = _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 <E : Any, T : IterableLike> EntryPointStep<out E?, T, InAnyOrderOnlySearchBe
 ): Expect<T> = 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 <E : Any, T : IterableLike> EntryPointStep<out E?, T, InAnyOrderOnlySearchBe
 ): Expect<T> = _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/...ain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeToContainInOrderOnlyCreators.kt b/...ain/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 <E, T : IterableLike> EntryPointStep<E, T, InOrderOnlySearchBehaviour>.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 <E, T : IterableLike> EntryPointStep<E, T, InOrderOnlySearchBehaviour>.value
 ): Expect<T> = _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 <E : Any, T : IterableLike> EntryPointStep<out E?, T, InOrderOnlySearchBehav
 ): Expect<T> = 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 <E : Any, T : IterableLike> EntryPointStep<out E?, T, InOrderOnlySearchBehav
 ): Expect<T> = _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/...lin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeToContainInOrderOnlyGroupedCreators.kt b/...lin/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 <E, T : IterableLike> EntryPointStep<E, T, InOrderOnlyGroupedWithinSearchBeh
 }
 
 /**
- * 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 identification lambdas, identifying an entry,
  * need to be contained in [IterableLike] as only elements and in the specified order whereas
  * the identification lambdas within the groups can occur in any order.

diff --git a/...ommonMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/mapLikeToContainInAnyOrderCreators.kt b/...ommonMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/mapLikeToContainInAnyOrderCreators.kt
@@ -13,7 +13,7 @@ import ch.tutteli.kbox.glue
 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 the given [keyValuePair].
  *
  * Delegates to [entries].
@@ -26,7 +26,7 @@ fun <K, V, T : MapLike> EntryPointStep<K, V, T, InAnyOrderSearchBehaviour>.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 <K, V, T : MapLike> EntryPointStep<K, V, T, InAnyOrderSearchBehaviour>.entri
 ): Expect<T> = _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 <K, reified V : Any, T : MapLike> EntryPointStep<K, out V?, T, InAnyO
 ): Expect<T> = 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 <K, V : Any, T : MapLike> EntryPointStep<K, out V?, T, InAnyOrderSe
 
 
 /**
- * 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 all entries of the given [expectedMapLike] where it does not matter
  * in which order they appear.
  *