From d43b37e0046751257cd5014e60dad4ba2ee34813 Mon Sep 17 00:00:00 2001 From: Robert Stoll Date: Mon, 5 Jul 2021 21:54:02 +0200 Subject: [PATCH] deprecate resultAssertions, use new ...Expectations in api-infix --- .../en_GB/kotlin_1_3/resultAssertions.kt | 13 ++++++++-- .../en_GB/kotlin_1_3/resultExpectations.kt | 2 -- .../kotlin_1_3/ResultExpectationsSpec.kt | 24 +++++++++---------- .../src/test/kotlin/custom/SmokeSpec.kt | 4 ++-- 4 files changed, 25 insertions(+), 18 deletions(-) diff --git a/apis/infix-en_GB/extensions/kotlin_1_3/atrium-api-infix-en_GB-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/kotlin_1_3/resultAssertions.kt b/apis/infix-en_GB/extensions/kotlin_1_3/atrium-api-infix-en_GB-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/kotlin_1_3/resultAssertions.kt index 37b818d6f..f755939ea 100644 --- a/apis/infix-en_GB/extensions/kotlin_1_3/atrium-api-infix-en_GB-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/kotlin_1_3/resultAssertions.kt +++ b/apis/infix-en_GB/extensions/kotlin_1_3/atrium-api-infix-en_GB-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/kotlin_1_3/resultAssertions.kt @@ -1,7 +1,6 @@ package ch.tutteli.atrium.api.infix.en_GB.kotlin_1_3 import ch.tutteli.atrium.api.infix.en_GB.creating.SuccessWithCreator -import ch.tutteli.atrium.api.infix.en_GB.success import ch.tutteli.atrium.creating.Expect import ch.tutteli.atrium.logic._logic import ch.tutteli.atrium.logic.kotlin_1_3.isFailureOfType @@ -15,7 +14,12 @@ import ch.tutteli.atrium.logic.kotlin_1_3.isSuccess * * @since 0.12.0 */ -infix fun > Expect.toBe(@Suppress("UNUSED_PARAMETER") success: success): Expect = +@Suppress("DEPRECATION") +@Deprecated( + "Use toBe ASuccess; will be removed with 1.0.0 at the latest", + ReplaceWith("this.toBe(aSuccess)", "ch.tutteli.atrium.api.infix.en_GB.aSuccess") +) +infix fun > Expect.toBe(@Suppress("UNUSED_PARAMETER") success: ch.tutteli.atrium.api.infix.en_GB.success): Expect = _logic.isSuccess().transform() //TODO move to resultExpectations with 0.18.0 @@ -40,6 +44,7 @@ infix fun > Expect.toBe(success: SuccessWithCreator): Exp * * @since 0.12.0 */ +@Deprecated("Use toBeAFailure; will be removed with 1.0.0 at the latest", ReplaceWith("this.toBeAFailure()")) inline fun Expect>.isFailure(): Expect = _logic.isFailureOfType(TExpected::class).transform() @@ -52,6 +57,10 @@ inline fun Expect>.isFailure(): Ex * * @since 0.12.0 */ +@Deprecated( + "Use toBeAFailure; will be removed with 1.0.0 at the latest", + ReplaceWith("this.toBeAFailure(assertionCreator)") +) inline infix fun Expect>.isFailure( noinline assertionCreator: Expect.() -> Unit ): Expect = _logic.isFailureOfType(TExpected::class).transformAndAppend(assertionCreator) diff --git a/apis/infix-en_GB/extensions/kotlin_1_3/atrium-api-infix-en_GB-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/kotlin_1_3/resultExpectations.kt b/apis/infix-en_GB/extensions/kotlin_1_3/atrium-api-infix-en_GB-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/kotlin_1_3/resultExpectations.kt index 162dfd400..5386d7c08 100644 --- a/apis/infix-en_GB/extensions/kotlin_1_3/atrium-api-infix-en_GB-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/kotlin_1_3/resultExpectations.kt +++ b/apis/infix-en_GB/extensions/kotlin_1_3/atrium-api-infix-en_GB-kotlin_1_3-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/kotlin_1_3/resultExpectations.kt @@ -1,8 +1,6 @@ package ch.tutteli.atrium.api.infix.en_GB.kotlin_1_3 import ch.tutteli.atrium.api.infix.en_GB.aSuccess -import ch.tutteli.atrium.api.infix.en_GB.creating.SuccessWithCreator -import ch.tutteli.atrium.api.infix.en_GB.success import ch.tutteli.atrium.creating.Expect import ch.tutteli.atrium.logic._logic import ch.tutteli.atrium.logic.kotlin_1_3.isFailureOfType diff --git a/apis/infix-en_GB/extensions/kotlin_1_3/atrium-api-infix-en_GB-kotlin_1_3-common/src/test/kotlin/ch/tutteli/atrium/api/infix/en_GB/kotlin_1_3/ResultExpectationsSpec.kt b/apis/infix-en_GB/extensions/kotlin_1_3/atrium-api-infix-en_GB-kotlin_1_3-common/src/test/kotlin/ch/tutteli/atrium/api/infix/en_GB/kotlin_1_3/ResultExpectationsSpec.kt index 99008eb60..9182e44e2 100644 --- a/apis/infix-en_GB/extensions/kotlin_1_3/atrium-api-infix-en_GB-kotlin_1_3-common/src/test/kotlin/ch/tutteli/atrium/api/infix/en_GB/kotlin_1_3/ResultExpectationsSpec.kt +++ b/apis/infix-en_GB/extensions/kotlin_1_3/atrium-api-infix-en_GB-kotlin_1_3-common/src/test/kotlin/ch/tutteli/atrium/api/infix/en_GB/kotlin_1_3/ResultExpectationsSpec.kt @@ -45,23 +45,23 @@ class ResultExpectationsSpec : ResultExpectationsSpec( var star: Expect> = notImplemented() - a1 toBe success - a1 = a1 toBe success { } + a1 toBe aSuccess + a1 = a1 toBe aSuccess { } - a1.isFailure() - val r1: Expect = a1.isFailure { } + a1.toBeAFailure() + val r1: Expect = a1.toBeAFailure { } - a1b toBe success - a1b = a1b toBe success { } + a1b toBe aSuccess + a1b = a1b toBe aSuccess { } - a1b.isFailure() - val r1b: Expect = a1b.isFailure { } + a1b.toBeAFailure() + val r1b: Expect = a1b.toBeAFailure { } - star toBe success - star = star toBe success { } + star toBe aSuccess + star = star toBe aSuccess { } - star.isFailure() - val r3: Expect = star.isFailure { } + star.toBeAFailure() + val r3: Expect = star.toBeAFailure { } } } } diff --git a/bundles/infix-en_GB/extensions/atrium-infix-en_GB-smoke-test-kotlin_1_3/src/test/kotlin/custom/SmokeSpec.kt b/bundles/infix-en_GB/extensions/atrium-infix-en_GB-smoke-test-kotlin_1_3/src/test/kotlin/custom/SmokeSpec.kt index 9ba076f08..b6a04caa3 100644 --- a/bundles/infix-en_GB/extensions/atrium-infix-en_GB-smoke-test-kotlin_1_3/src/test/kotlin/custom/SmokeSpec.kt +++ b/bundles/infix-en_GB/extensions/atrium-infix-en_GB-smoke-test-kotlin_1_3/src/test/kotlin/custom/SmokeSpec.kt @@ -6,7 +6,7 @@ package custom import ch.tutteli.atrium.api.infix.en_GB.kotlin_1_3.toBe -import ch.tutteli.atrium.api.infix.en_GB.success +import ch.tutteli.atrium.api.infix.en_GB.aSuccess import ch.tutteli.atrium.api.infix.en_GB.toEqual import ch.tutteli.atrium.api.verbs.expect import ch.tutteli.atrium.assertions.Assertion @@ -26,7 +26,7 @@ object SmokeSpec : Spek({ } test("see if `Result.isSuccess` can be used") { - expect(Result.success(1)) toBe success + expect(Result.success(1)) toBe aSuccess } test("see if own expectation function without i18n can be used") {