Merge pull request #1 from metalgold/satisfying

Author: sFreezer

src/main/kotlin/in/rcard/assertj/arrowcore/AbstractEitherAssert.kt

@@ -82,9 +82,14 @@ abstract class AbstractEitherAssert<
         return myself
     }
 
-    fun hasRightValueSatisfying(requirement: Consumer<RIGHT>): SELF {
+    /**
+     * Verifies that the actual [Either] contains a right-sided value and gives this value to the given
+     * consumer for further assertions. Should be used as a way of deeper asserting on the
+     * containing object, as further requirement(s) for the value.
+     */
+    fun hasRightValueSatisfying(requirement: (RIGHT) -> Unit): SELF {
         assertIsRight()
-        actual.onRight { requirement.accept(it) }
+        actual.onRight { requirement(it) }
         return myself
     }
 
@@ -121,9 +126,14 @@ abstract class AbstractEitherAssert<
         return myself
     }
 
-    fun hasLeftValueSatisfying(requirement: Consumer<LEFT>): SELF {
+    /**
+     * Verifies that the actual [Either] contains a left-sided value and gives this value to the given
+     * consumer for further assertions. Should be used as a way of deeper asserting on the
+     * containing object, as further requirement(s) for the value.
+     */
+    fun hasLeftValueSatisfying(requirement: (LEFT) -> Unit): SELF {
         assertIsLeft()
-        actual.onLeft { requirement.accept(it) }
+        actual.onLeft { requirement(it) }
         return myself
     }
 

src/main/kotlin/in/rcard/assertj/arrowcore/AbstractOptionAssert.kt

@@ -86,9 +86,17 @@ abstract class AbstractOptionAssert<
         return myself
     }
 
-    fun hasValueSatisfying(requirement: Consumer<VALUE>): SELF {
+    /**
+     * Verifies that the actual [Option] contains a value and gives this value to the given
+     * consumer for further assertions. Should be used as a way of deeper asserting on the
+     * containing object, as further requirement(s) for the value.
+     *
+     * @param requirement to further assert on the object contained inside the [Option].
+     * @return this assertion object.
+     */
+    fun hasValueSatisfying(requirement: (VALUE) -> Unit): SELF {
         assertValueIsPresent()
-        actual.onSome { requirement.accept(it) }
+        actual.onSome { requirement(it) }
         return myself
     }
 

src/test/kotlin/in/rcard/assertj/arrowcore/EitherAssert_hasLeftValueSatisfying_Test.kt

@@ -8,7 +8,7 @@ import org.assertj.core.util.FailureMessages.actualIsNull
 import org.junit.jupiter.api.Test
 
 
-class EitherAssert_hasLeftValueSatisfying_Test {
+internal class EitherAssert_hasLeftValueSatisfying_Test {
 
     @Test
     internal fun `should fail when either is null`() {
@@ -35,8 +35,8 @@ class EitherAssert_hasLeftValueSatisfying_Test {
     }
 
     @Test
-    fun should_pass_if_consumer_passes() {
+    internal fun `should pass if consumer passes`() {
         val actual: Either<Int, String> = Either.Left(42)
-        EitherAssert(actual).hasLeftValueSatisfying { assertThat(it).isEqualTo(42) }
+        EitherAssert.assertThat(actual).hasLeftValueSatisfying { assertThat(it).isEqualTo(42) }
     }
 }

src/test/kotlin/in/rcard/assertj/arrowcore/EitherAssert_hasRightValueSatisfying_Test.kt

@@ -8,7 +8,7 @@ import org.assertj.core.util.FailureMessages.actualIsNull
 import org.junit.jupiter.api.Test
 
 
-class EitherAssert_hasRightValueSatisfying_Test {
+internal class EitherAssert_hasRightValueSatisfying_Test {
 
     @Test
     internal fun `should fail when either is null`() {
@@ -37,6 +37,6 @@ class EitherAssert_hasRightValueSatisfying_Test {
     @Test
     internal fun `should pass if consumer passes`() {
         val actual: Either<Int, String> = Either.Right("something")
-        EitherAssert(actual).hasRightValueSatisfying { assertThat(it).isEqualTo("something") }
+        EitherAssert.assertThat(actual).hasRightValueSatisfying { assertThat(it).isEqualTo("something") }
     }
 }