[raise-dsl-assertions] Documentation

Author: rcardin

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

@@ -88,6 +88,8 @@ abstract class AbstractEitherAssert<
      *
      * @param requirement the consumer that will accept the right-sided value for deep asserting.
      * @return this assertion object.
+     *
+     * @since 0.1.0
      */
     fun hasRightValueSatisfying(requirement: (RIGHT) -> Unit): SELF {
         assertIsRight()
@@ -142,6 +144,7 @@ abstract class AbstractEitherAssert<
      *
      * @param requirement the consumer that will accept the left-sided value for deep asserting.
      * @return this assertion object.
+     * @since 0.1.0
      */
     fun hasLeftValueSatisfying(requirement: (LEFT) -> Unit): SELF {
         assertIsLeft()

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

@@ -92,6 +92,7 @@ abstract class AbstractOptionAssert<
      *
      * @param requirement to further assert on the object contained inside the [Option].
      * @return this assertion object.
+     * @since 0.1.0
      */
     fun hasValueSatisfying(requirement: (VALUE) -> Unit): SELF {
         assertValueIsPresent()

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

@@ -10,6 +10,15 @@ import org.assertj.core.api.AbstractAssert
 import org.assertj.core.internal.ComparisonStrategy
 import org.assertj.core.internal.StandardComparisonStrategy
 
+/**
+ * Assertions for functions within a [Raise] context.
+ *
+ * @param VALUE type of the value returned by the function.
+ * @param ERROR type of the logical error raised by the function.
+ * @author Riccardo Cardin
+ *
+ * @since 0.2.0
+ */
 abstract class AbstractRaiseAssert<
         SELF : AbstractRaiseAssert<SELF, ERROR, VALUE>, ERROR : Any, VALUE : Any,
         >(lambda: context(Raise<ERROR>) () -> VALUE) :

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

@@ -10,18 +10,32 @@ import org.assertj.core.api.Assertions
 import org.assertj.core.internal.Failures
 import kotlin.experimental.ExperimentalTypeInference
 
+/**
+ * Assertions for functions within a [Raise] context.
+ *
+ * @param VALUE type of the value returned by the function.
+ * @param ERROR type of the logical error raised by the function.
+ * @author Riccardo Cardin
+ *
+ * @since 0.2.0
+ */
 class RaiseAssert<ERROR : Any, VALUE : Any> private constructor(lambda: Raise<ERROR>.() -> VALUE) :
     AbstractRaiseAssert<RaiseAssert<ERROR, VALUE>, ERROR, VALUE>(lambda) {
     companion object {
-        fun <ERROR : Any, VALUE : Any> assertThat(@BuilderInference lambda: Raise<ERROR>.() -> VALUE): RaiseAssert<ERROR, VALUE> =
+        fun <ERROR : Any, VALUE : Any> assertThat(
+            @BuilderInference lambda: Raise<ERROR>.() -> VALUE
+        ): RaiseAssert<ERROR, VALUE> =
             RaiseAssert(lambda)
 
-        fun <ERROR : Any, VALUE : Any> assertThatThrownBy(@BuilderInference shouldRaiseThrowable: Raise<ERROR>.() -> VALUE): AbstractThrowableAssert<*, out Throwable> {
+        fun <ERROR : Any, VALUE : Any> assertThatThrownBy(
+            @BuilderInference shouldRaiseThrowable: Raise<ERROR>.() -> VALUE
+        ): AbstractThrowableAssert<*, out Throwable> {
             val throwable: Throwable? = fold(block = shouldRaiseThrowable,
                 recover = { null },
                 transform = { null },
                 catch = { exception -> exception })
 
+            @Suppress("KotlinConstantConditions")
             return throwable?.let { return Assertions.assertThat(throwable) } ?: throw Failures.instance()
                 .failure(Assertions.assertThat(throwable).writableAssertionInfo, shouldThrowAnException())
         }