Merge pull request #23 from arrow-kt/all-ensure

Name all methods ensure
arrow-kt · Jun 5, 2023 · fd27cc9 · fd27cc9
2 parents cc9f2f8 + 916200c
commit fd27cc9
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -74,7 +74,6 @@ import arrow.core.raise.Raise
 import arrow.exact.Exact
 import arrow.exact.ExactError
 import arrow.exact.ensure
-import arrow.exact.ensureExact
 
 @JvmInline
 value class NotBlankString private constructor(val value: String) {
@@ -92,7 +91,7 @@ value class NotBlankString private constructor(val value: String) {
 value class NotBlankTrimmedString private constructor(val value: String) { 
   companion object : Exact<String, NotBlankTrimmedString> { 
     override fun Raise<ExactError>.spec(raw: String): NotBlankTrimmedString { 
-      ensureExact(raw, NotBlankString)
+      ensure(raw, NotBlankString)
       return NotBlankTrimmedString(raw.trim())
     }
   }

diff --git a/guide/src/commonMain/kotlin/examples/example-exact-03.kt b/guide/src/commonMain/kotlin/examples/example-exact-03.kt
@@ -5,7 +5,6 @@ import arrow.core.raise.Raise
 import arrow.exact.Exact
 import arrow.exact.ExactError
 import arrow.exact.ensure
-import arrow.exact.ensureExact
 
 class NotBlankString private constructor(val value: String) {
   companion object : Exact<String, NotBlankString> {
@@ -20,7 +19,7 @@ class NotBlankString private constructor(val value: String) {
 value class NotBlankTrimmedString private constructor(val value: String) {
   companion object : Exact<String, NotBlankTrimmedString> {
     override fun Raise<ExactError>.spec(raw: String): NotBlankTrimmedString {
-      ensureExact(raw, NotBlankString)
+      ensure(raw, NotBlankString)
       return NotBlankTrimmedString(raw.trim())
     }
   }

diff --git a/guide/src/commonMain/kotlin/examples/example-exact-04.kt b/guide/src/commonMain/kotlin/examples/example-exact-04.kt
@@ -7,7 +7,6 @@ import arrow.exact.Exact
 import arrow.exact.ExactEither
 import arrow.exact.ExactError
 import arrow.exact.ensure
-import arrow.exact.ensureExact
 
 @JvmInline
 value class NotBlankTrimmedString private constructor(val value: String) {
@@ -29,7 +28,7 @@ value class Username private constructor(val value: String) {
   companion object : ExactEither<UsernameError, String, Username> {
     override fun Raise<UsernameError>.spec(raw: String): Username {
       val username =
-        ensureExact(raw, NotBlankTrimmedString) {
+        ensure(raw, NotBlankTrimmedString) {
           UsernameError.Invalid
         }.value
       ensure(username.length < 100) { UsernameError.Invalid }

diff --git a/guide/src/commonMain/kotlin/examples/example-readme-03.kt b/guide/src/commonMain/kotlin/examples/example-readme-03.kt
@@ -5,7 +5,6 @@ import arrow.core.raise.Raise
 import arrow.exact.Exact
 import arrow.exact.ExactError
 import arrow.exact.ensure
-import arrow.exact.ensureExact
 
 @JvmInline
 value class NotBlankString private constructor(val value: String) {
@@ -21,7 +20,7 @@ value class NotBlankString private constructor(val value: String) {
 value class NotBlankTrimmedString private constructor(val value: String) { 
   companion object : Exact<String, NotBlankTrimmedString> { 
     override fun Raise<ExactError>.spec(raw: String): NotBlankTrimmedString { 
-      ensureExact(raw, NotBlankString)
+      ensure(raw, NotBlankString)
       return NotBlankTrimmedString(raw.trim())
     }
   }

diff --git a/src/commonMain/kotlin/arrow/exact/Exact.kt b/src/commonMain/kotlin/arrow/exact/Exact.kt
@@ -67,14 +67,13 @@ import arrow.core.raise.ensure
  * <!--- KNIT example-exact-02.kt -->
  *
  * You can define a second type `NotBlankTrimmedString` that is a `NotBlankString` that is also
- * trimmed. [ensureExact] allows us to compose [Exact] instances and easily
+ * trimmed. [ensure] allows us to compose [Exact] instances and easily
  * reuse the `NotBlankString` type.
  * <!--- INCLUDE
  * import arrow.core.raise.Raise
  * import arrow.exact.Exact
  * import arrow.exact.ExactError
  * import arrow.exact.ensure
- * import arrow.exact.ensureExact
  *
  * class NotBlankString private constructor(val value: String) {
  *   companion object : Exact<String, NotBlankString> {
@@ -90,7 +89,7 @@ import arrow.core.raise.ensure
  * value class NotBlankTrimmedString private constructor(val value: String) {
  *   companion object : Exact<String, NotBlankTrimmedString> {
  *     override fun Raise<ExactError>.spec(raw: String): NotBlankTrimmedString {
- *       ensureExact(raw, NotBlankString)
+ *       ensure(raw, NotBlankString)
  *       return NotBlankTrimmedString(raw.trim())
  *     }
  *   }
@@ -117,7 +116,6 @@ public data class ExactError(val message: String)
  * import arrow.exact.ExactEither
  * import arrow.exact.ExactError
  * import arrow.exact.ensure
- * import arrow.exact.ensureExact
  *
  * @JvmInline
  * value class NotBlankTrimmedString private constructor(val value: String) {
@@ -140,7 +138,7 @@ public data class ExactError(val message: String)
  *   companion object : ExactEither<UsernameError, String, Username> {
  *     override fun Raise<UsernameError>.spec(raw: String): Username {
  *       val username =
- *         ensureExact(raw, NotBlankTrimmedString) {
+ *         ensure(raw, NotBlankTrimmedString) {
  *           UsernameError.Invalid
  *         }.value
  *       ensure(username.length < 100) { UsernameError.Invalid }

diff --git a/src/commonMain/kotlin/arrow/exact/ExactDsl.kt b/src/commonMain/kotlin/arrow/exact/ExactDsl.kt
@@ -10,16 +10,18 @@ public inline fun Raise<ExactError>.ensure(condition: Boolean) {
 }
 
 @RaiseDSL
-public inline fun <A, B> Raise<ExactError>.ensureExact(raw: A, exact: Exact<A, B>): B = ensureExact(raw, exact as ExactEither<*, A, B>)
+public inline fun <A, B> Raise<ExactError>.ensure(raw: A, exact: Exact<A, B>): B = ensure(raw, exact as ExactEither<*, A, B>)
 
 @RaiseDSL
-public inline fun <A, B> Raise<ExactError>.ensureExact(raw: A, exact: ExactEither<*, A, B>): B = ensureExact(raw, exact) { ExactError("Failed to match Exact.") }
+public inline fun <A, B> Raise<ExactError>.ensure(raw: A, exact: ExactEither<*, A, B>): B =
+  ensure(raw, exact) { ExactError("Failed to match Exact.") }
 
 @RaiseDSL
-public inline fun <A, B, Error : Any> Raise<Error>.ensureExact(raw: A, exact: Exact<A, B>, error: (ExactError) -> Error): B = ensureExact(raw, exact as ExactEither<ExactError, A, B>, error)
+public inline fun <A, B, Error : Any> Raise<Error>.ensure(raw: A, exact: Exact<A, B>, error: (ExactError) -> Error): B =
+  ensure(raw, exact as ExactEither<ExactError, A, B>, error)
 
 @RaiseDSL
-public inline fun <A, B, Error : Any, E : Any> Raise<E>.ensureExact(raw: A, exact: ExactEither<Error, A, B>, error: (Error) -> E): B {
+public inline fun <A, B, Error : Any, E : Any> Raise<E>.ensure(raw: A, exact: ExactEither<Error, A, B>, error: (Error) -> E): B {
   return when (val result = exact.from(raw)) {
     is Either.Left -> raise(error(result.value))
     is Either.Right -> result.value