diff --git a/README.md b/README.md index d29c67e35..47bbbbd1d 100644 --- a/README.md +++ b/README.md @@ -1501,7 +1501,7 @@ then it will come in handy: ```kotlin expect(linkedMapOf("a" to 1, "b" to 2)).asEntries().toContain.inOrder.only.entries( - { isKeyValue("a", 1) }, + { toEqualKeyValue("a", 1) }, { key.toStartWith("a") value.toBeGreaterThan(2) @@ -1526,7 +1526,7 @@ expected that subject: {a=1, b=2} (java.util.LinkedHashMap <1234789>) ``` -`isKeyValue` as well as `key` and `value` are assertion functions defined for `Map.Entry`. +`toEqualKeyValue` as well as `key` and `value` are assertion functions defined for `Map.Entry`. There are more assertion functions, a full list can be found in [KDoc of atrium-api-fluent-en_GB](https://docs.atriumlib.org/latest#/doc/ch.tutteli.atrium.api.fluent.en_-g-b/index.html). 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 8d115b751..8c3f43aa2 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 @@ -15,6 +15,7 @@ import ch.tutteli.atrium.logic.* * * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.deprecated.MapEntryAssertionSamples.isKeyValue */ +@Deprecated("Use toEqualKeyValue; will be removed with 1.0.0 at the latest", ReplaceWith("toEqualKeyValue(key, value)")) fun > Expect.isKeyValue(key: K, value: V): Expect = _logicAppend { isKeyValue(key, value) } diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/test/kotlin/ch/tutteli/atrium/api/fluent/en_GB/MapEntryExpectationsSpec.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/test/kotlin/ch/tutteli/atrium/api/fluent/en_GB/MapEntryExpectationsSpec.kt index fb0aadde5..6c76216b5 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/test/kotlin/ch/tutteli/atrium/api/fluent/en_GB/MapEntryExpectationsSpec.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/test/kotlin/ch/tutteli/atrium/api/fluent/en_GB/MapEntryExpectationsSpec.kt @@ -24,16 +24,16 @@ object MapEntryExpectationsSpec : ch.tutteli.atrium.specs.integration.MapEntryEx var star: Expect> = notImplemented() - a1.isKeyValue("a", 1) - a2.isKeyValue("a", 1) - a3.isKeyValue("a", 1) - a4.isKeyValue("a", 1) - star.isKeyValue("a", 1) + a1.toEqualKeyValue("a", 1) + a2.toEqualKeyValue("a", 1) + a3.toEqualKeyValue("a", 1) + a4.toEqualKeyValue("a", 1) + star.toEqualKeyValue("a", 1) - a2.isKeyValue(null, 1) - a3.isKeyValue("a", null) - a4.isKeyValue(null, null) - star.isKeyValue(null, null) + a2.toEqualKeyValue(null, 1) + a3.toEqualKeyValue("a", null) + a4.toEqualKeyValue(null, null) + star.toEqualKeyValue(null, null) a1.key a2.key diff --git a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/test/kotlin/ch/tutteli/atrium/api/fluent/en_GB/samples/deprecated/MapEntryAssertionSamples.kt b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/test/kotlin/ch/tutteli/atrium/api/fluent/en_GB/samples/deprecated/MapEntryAssertionSamples.kt index 1224f8192..a13454512 100644 --- a/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/test/kotlin/ch/tutteli/atrium/api/fluent/en_GB/samples/deprecated/MapEntryAssertionSamples.kt +++ b/apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/test/kotlin/ch/tutteli/atrium/api/fluent/en_GB/samples/deprecated/MapEntryAssertionSamples.kt @@ -12,10 +12,10 @@ class MapEntryAssertionSamples { @Test fun isKeyValue() { - expect(mapOf(1 to "a").entries.first()).isKeyValue(1, "a") + expect(mapOf(1 to "a").entries.first()).toEqualKeyValue(1, "a") fails { - expect(mapOf(1 to "a").entries.first()).isKeyValue(1, "b") + expect(mapOf(1 to "a").entries.first()).toEqualKeyValue(1, "b") } } diff --git a/bundles/fluent-en_GB/atrium-fluent-en_GB-js/src/test/kotlin/ch/tutteli/atrium/fluent/en_GB/JsNameAmbiguityTest.kt b/bundles/fluent-en_GB/atrium-fluent-en_GB-js/src/test/kotlin/ch/tutteli/atrium/fluent/en_GB/JsNameAmbiguityTest.kt index 890d9ae54..70c41fc1a 100644 --- a/bundles/fluent-en_GB/atrium-fluent-en_GB-js/src/test/kotlin/ch/tutteli/atrium/fluent/en_GB/JsNameAmbiguityTest.kt +++ b/bundles/fluent-en_GB/atrium-fluent-en_GB-js/src/test/kotlin/ch/tutteli/atrium/fluent/en_GB/JsNameAmbiguityTest.kt @@ -19,7 +19,7 @@ class JsNameAmbiguityTest { @Test fun isKeyValueNullable() { expect(mapOf(1 to null as Int?)).asEntries().toContainExactly { - isKeyValue(1, null) + toEqualKeyValue(1, null) } } } diff --git a/misc/specs/atrium-specs-common/src/main/kotlin/ch/tutteli/atrium/specs/integration/MapAsEntriesExpectationsSpec.kt b/misc/specs/atrium-specs-common/src/main/kotlin/ch/tutteli/atrium/specs/integration/MapAsEntriesExpectationsSpec.kt index ca25bff38..1420ad7d0 100644 --- a/misc/specs/atrium-specs-common/src/main/kotlin/ch/tutteli/atrium/specs/integration/MapAsEntriesExpectationsSpec.kt +++ b/misc/specs/atrium-specs-common/src/main/kotlin/ch/tutteli/atrium/specs/integration/MapAsEntriesExpectationsSpec.kt @@ -29,7 +29,7 @@ abstract class MapAsEntriesExpectationsSpec( it("$name - transformation can be applied and an assertion made") { expect(mapOf("a" to 1, "b" to 2)).asEntriesFun { toContain.inAnyOrder.only.entries( - { isKeyValue("b", 2) }, + { toEqualKeyValue("b", 2) }, { key.toStartWith("a") value.toBeGreaterThanOrEqualTo(1) diff --git a/misc/tools/readme-examples/src/main/kotlin/readme/examples/MostExamplesSpec.kt b/misc/tools/readme-examples/src/main/kotlin/readme/examples/MostExamplesSpec.kt index 462e9aaad..663decdb5 100644 --- a/misc/tools/readme-examples/src/main/kotlin/readme/examples/MostExamplesSpec.kt +++ b/misc/tools/readme-examples/src/main/kotlin/readme/examples/MostExamplesSpec.kt @@ -219,7 +219,7 @@ class MostExamplesSpec : Spek({ } test("ex-map-5") { expect(linkedMapOf("a" to 1, "b" to 2)).asEntries().toContain.inOrder.only.entries( - { isKeyValue("a", 1) }, + { toEqualKeyValue("a", 1) }, { key.toStartWith("a") value.toBeGreaterThan(2)