Merge pull request #4

* implement maybe monad as maybe extension function for non nullable el…

* implement maybe monad as maybe extension function for nullable element

* implement either monad as right either extension function

* implement either monad as left either extension function

* remove shallow from dev test github action

Author: BenRomdhaneOmar

.github/workflows/dev-test.yaml

@@ -11,6 +11,8 @@ jobs:
     steps:
       - name: Check out repository code
         uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
       - name: List files in the repository
         run: |
           ls ${{ github.workspace }}

library/src/commonMain/kotlin/com/benromdhane/omar/offroadsoft/monad/Either.kt

@@ -162,4 +162,7 @@ fun <ELEMENT> Either<ELEMENT, ELEMENT>.toFilteredMaybe(condition: (ELEMENT) -> B
 
 fun <ELEMENT> Either<ELEMENT, ELEMENT>.toMaybe() =
     if (this.right()) this.toMaybeRight()
-    else this.toMaybeLeft()
+    else this.toMaybeLeft()
+
+fun <LEFT, ELEMENT> ELEMENT.asRightEither() = Either.Right.of<LEFT, _>(this)
+fun <ELEMENT, RIGHT> ELEMENT.asLeftEither() = Either.Left.of<_, RIGHT>(this)

library/src/commonMain/kotlin/com/benromdhane/omar/offroadsoft/monad/Maybe.kt

@@ -1,5 +1,7 @@
 package com.benromdhane.omar.offroadsoft.monad
 
+import kotlin.jvm.JvmName
+
 sealed interface Maybe<ELEMENT> {
 
     fun present(): Boolean
@@ -65,4 +67,13 @@ sealed interface Maybe<ELEMENT> {
     class EmptyMaybeException : Throwable()
 }
 
-fun <ELEMENT> Maybe<Maybe<ELEMENT>>.flatten() = this.flatMap { it }
+fun <ELEMENT> Maybe<Maybe<ELEMENT>>.flatten() = this.flatMap { it }
+
+@JvmName("nonNullableAsMaybe")
+fun <ELEMENT : Any> ELEMENT.asMaybe() = Maybe.NotEmpty.of(this)
+
+@JvmName("nullableAsMaybe")
+fun <ELEMENT : Any?> ELEMENT.asMaybe() =
+    this
+        ?.let { Maybe.NotEmpty.of<ELEMENT>(it) }
+        ?: Maybe.Empty.of()

library/src/commonTest/kotlin/com/benromdhane/omar/offroadsoft/monad/EitherTest.kt

@@ -1027,4 +1027,26 @@ class EitherTest {
 
         assertEquals(initialElement, result)
     }
+
+    @Test
+    fun `as right either must return right either with initial element`() {
+        val initialElement = Uuid.random().toString()
+        val result =
+            initialElement.asRightEither<Int, _>()
+                .toMaybeRight()
+                .orNull()!!
+
+        assertEquals(initialElement, result)
+    }
+
+    @Test
+    fun `as left either must return left either with initial element`() {
+        val initialElement: String = Uuid.random().toString()
+        val result =
+            initialElement.asLeftEither<_, Int>()
+                .toMaybeLeft()
+                .orNull()!!
+
+        assertEquals(initialElement, result)
+    }
 }

library/src/commonTest/kotlin/com/benromdhane/omar/offroadsoft/monad/MaybeTest.kt

@@ -340,4 +340,35 @@ class MaybeTest {
 
         assertTrue { result }
     }
+
+    @Test
+    fun `as maybe must return not empty maybe with the initial element for non nullable element`() {
+        val initialElement = Uuid.random().toString()
+        val result =
+            initialElement.asMaybe()
+                .orNull()!!
+
+        assertEquals(initialElement, result)
+    }
+
+    @Test
+    fun `as maybe must return not empty maybe with the initial element for nullable non null element`() {
+        @Suppress("RedundantNullableReturnType")
+        val initialElement: String? = Uuid.random().toString()
+        val result =
+            initialElement.asMaybe()
+                .orNull()!!
+
+        assertEquals(initialElement, result)
+    }
+
+    @Test
+    fun `as maybe must return empty maybe for nullable null element`() {
+        val initialElement: String? = null
+        val result =
+            initialElement.asMaybe()
+                .empty()
+
+        assertTrue { result }
+    }
 }