Adding missing helper methods, improved docs (#256)

* Adding missing helper methods. Improved docs. * Improving naming in sbt. Uncommenting test. * ci.yml update
theiterators · Oct 17, 2024 · 3bec52b · 3bec52b
1 parent a48f701
commit 3bec52b
Show file tree

Hide file tree

Showing 8 changed files with 596 additions and 113 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -30,11 +30,11 @@ jobs:
         os: [ubuntu-latest]
         scala: [2.13, 3]
         java: [temurin@11, temurin@17]
-        project: [rootJS, rootJVM, rootNative]
+        project: [sealedMonadNative, sealedMonadJS, sealedMonadJVM]
         exclude:
-          - project: rootJS
+          - project: sealedMonadNative
             java: temurin@17
-          - project: rootNative
+          - project: sealedMonadJS
             java: temurin@17
     runs-on: ${{ matrix.os }}
     timeout-minutes: 60
@@ -76,14 +76,14 @@ jobs:
       - name: Check that workflows are up to date
         run: sbt githubWorkflowCheck
 
-      - name: scalaJSLink
-        if: matrix.project == 'rootJS'
-        run: sbt 'project ${{ matrix.project }}' '++ ${{ matrix.scala }}' Test/scalaJSLinkerResult
-
       - name: nativeLink
-        if: matrix.project == 'rootNative'
+        if: matrix.project == 'sealedMonadNative'
         run: sbt 'project ${{ matrix.project }}' '++ ${{ matrix.scala }}' Test/nativeLink
 
+      - name: scalaJSLink
+        if: matrix.project == 'sealedMonadJS'
+        run: sbt 'project ${{ matrix.project }}' '++ ${{ matrix.scala }}' Test/scalaJSLinkerResult
+
       - name: Test
         run: sbt 'project ${{ matrix.project }}' '++ ${{ matrix.scala }}' test
 
@@ -97,11 +97,11 @@ jobs:
 
       - name: Make target directories
         if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/master')
-        run: mkdir -p sealedmonad/.native/target sealedmonad/.jvm/target sealedmonad/.js/target project/target
+        run: mkdir -p sealedmonad/.native/target sealedmonad/.js/target sealedmonad/.jvm/target project/target
 
       - name: Compress target directories
         if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/master')
-        run: tar cf targets.tar sealedmonad/.native/target sealedmonad/.jvm/target sealedmonad/.js/target project/target
+        run: tar cf targets.tar sealedmonad/.native/target sealedmonad/.js/target sealedmonad/.jvm/target project/target
 
       - name: Upload target directories
         if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/master')
@@ -154,62 +154,62 @@ jobs:
         if: matrix.java == 'temurin@17' && steps.setup-java-temurin-17.outputs.cache-hit == 'false'
         run: sbt +update
 
-      - name: Download target directories (2.13, rootJS)
+      - name: Download target directories (2.13, sealedMonadNative)
         uses: actions/download-artifact@v4
         with:
-          name: target-${{ matrix.os }}-${{ matrix.java }}-2.13-rootJS
+          name: target-${{ matrix.os }}-${{ matrix.java }}-2.13-sealedMonadNative
 
-      - name: Inflate target directories (2.13, rootJS)
+      - name: Inflate target directories (2.13, sealedMonadNative)
         run: |
           tar xf targets.tar
           rm targets.tar
 
-      - name: Download target directories (2.13, rootJVM)
+      - name: Download target directories (2.13, sealedMonadJS)
         uses: actions/download-artifact@v4
         with:
-          name: target-${{ matrix.os }}-${{ matrix.java }}-2.13-rootJVM
+          name: target-${{ matrix.os }}-${{ matrix.java }}-2.13-sealedMonadJS
 
-      - name: Inflate target directories (2.13, rootJVM)
+      - name: Inflate target directories (2.13, sealedMonadJS)
         run: |
           tar xf targets.tar
           rm targets.tar
 
-      - name: Download target directories (2.13, rootNative)
+      - name: Download target directories (2.13, sealedMonadJVM)
         uses: actions/download-artifact@v4
         with:
-          name: target-${{ matrix.os }}-${{ matrix.java }}-2.13-rootNative
+          name: target-${{ matrix.os }}-${{ matrix.java }}-2.13-sealedMonadJVM
 
-      - name: Inflate target directories (2.13, rootNative)
+      - name: Inflate target directories (2.13, sealedMonadJVM)
         run: |
           tar xf targets.tar
           rm targets.tar
 
-      - name: Download target directories (3, rootJS)
+      - name: Download target directories (3, sealedMonadNative)
         uses: actions/download-artifact@v4
         with:
-          name: target-${{ matrix.os }}-${{ matrix.java }}-3-rootJS
+          name: target-${{ matrix.os }}-${{ matrix.java }}-3-sealedMonadNative
 
-      - name: Inflate target directories (3, rootJS)
+      - name: Inflate target directories (3, sealedMonadNative)
         run: |
           tar xf targets.tar
           rm targets.tar
 
-      - name: Download target directories (3, rootJVM)
+      - name: Download target directories (3, sealedMonadJS)
         uses: actions/download-artifact@v4
         with:
-          name: target-${{ matrix.os }}-${{ matrix.java }}-3-rootJVM
+          name: target-${{ matrix.os }}-${{ matrix.java }}-3-sealedMonadJS
 
-      - name: Inflate target directories (3, rootJVM)
+      - name: Inflate target directories (3, sealedMonadJS)
         run: |
           tar xf targets.tar
           rm targets.tar
 
-      - name: Download target directories (3, rootNative)
+      - name: Download target directories (3, sealedMonadJVM)
         uses: actions/download-artifact@v4
         with:
-          name: target-${{ matrix.os }}-${{ matrix.java }}-3-rootNative
+          name: target-${{ matrix.os }}-${{ matrix.java }}-3-sealedMonadJVM
 
-      - name: Inflate target directories (3, rootNative)
+      - name: Inflate target directories (3, sealedMonadJVM)
         run: |
           tar xf targets.tar
           rm targets.tar
@@ -284,5 +284,5 @@ jobs:
       - name: Submit Dependencies
         uses: scalacenter/sbt-dependency-submission@v2
         with:
-          modules-ignore: root_2.13 root_3 rootjs_2.13 rootjs_3 rootjvm_2.13 rootjvm_3 rootnative_2.13 rootnative_3
+          modules-ignore: sealedmonadnative_2.13 sealedmonadnative_3 sealedmonad_2.13 sealedmonad_3 sealedmonadjs_2.13 sealedmonadjs_3 sealedmonadjvm_2.13 sealedmonadjvm_3
           configs-ignore: test scala-tool scala-doc-tool test-internal
diff --git a/benchmarks/src/main/scala/pl/iterators/sealedmonad/benchmarks/SealedPrograms.scala b/benchmarks/src/main/scala/pl/iterators/sealedmonad/benchmarks/SealedPrograms.scala
@@ -87,7 +87,7 @@ class SealedPrograms {
   def benchmark2 = {
     val s = for {
       m <- returnOption.valueOr(SomeCase)
-      _ <- doSomeOtherWork(m).valueOr(SomeOtherCase) >>! (s => M.pure(m + s.toInt))
+      _ <- doSomeOtherWork(m).valueOr(SomeOtherCase).flatTap(s => M.pure(m + s.toInt))
     } yield Result(m)
 
     s.run

diff --git a/build.sbt b/build.sbt
@@ -93,7 +93,7 @@ lazy val noPublishSettings =
 
 lazy val examples = project
   .in(file("examples"))
-  .dependsOn(sealedMonad.jvm % "test->test;compile->compile")
+  .dependsOn(core.jvm % "test->test;compile->compile")
   .settings(baseSettings *)
   .settings(noPublishSettings *)
   .settings(
@@ -104,7 +104,7 @@ lazy val examples = project
 
 lazy val docs = project
   .in(file("sealed-docs"))
-  .dependsOn(sealedMonad.jvm % "test->test;compile->compile")
+  .dependsOn(core.jvm % "test->test;compile->compile")
   .enablePlugins(MdocPlugin, DocusaurusPlugin)
   .settings(baseSettings *)
   .settings(noPublishSettings *)
@@ -121,7 +121,7 @@ lazy val docs = project
 
 lazy val benchmarks = project
   .in(file("benchmarks"))
-  .dependsOn(sealedMonad.jvm % "test->test;compile->compile")
+  .dependsOn(core.jvm % "test->test;compile->compile")
   .enablePlugins(JmhPlugin)
   .settings(baseSettings *)
   .settings(noPublishSettings *)
@@ -133,7 +133,7 @@ lazy val benchmarks = project
 
 addCommandAlias("flame", "benchmarks/jmh:run -p tokens=64 -prof jmh.extras.Async:dir=target/flamegraphs;flameGraphOpts=--width,1900")
 
-lazy val sealedMonad = crossProject(JSPlatform, JVMPlatform, NativePlatform)
+lazy val core = crossProject(JSPlatform, JVMPlatform, NativePlatform)
   .withoutSuffixFor(JVMPlatform)
   .crossType(CrossType.Pure)
   .in(file("sealedmonad"))
@@ -144,5 +144,6 @@ lazy val sealedMonad = crossProject(JSPlatform, JVMPlatform, NativePlatform)
     description := "Scala library for nice for-comprehension-style error handling"
   )
 
-lazy val root = tlCrossRootProject.aggregate(sealedMonad, benchmarks, docs, examples)
-  .settings(baseSettings *)
+lazy val sealedMonad = tlCrossRootProject
+  .aggregate(core, benchmarks, docs, examples)
+  .settings(baseSettings *)
diff --git a/examples/src/main/scala/pl/iterators/sealedmonad/examples/Options.scala b/examples/src/main/scala/pl/iterators/sealedmonad/examples/Options.scala
@@ -93,7 +93,9 @@ object Options {
     ): M[ConfirmResponse] = {
       val s = for {
         method <- findAuthMethod(token).valueOr[ConfirmResponse](ConfirmResponse.MethodNotFound)
-        user   <- findUser(method.userId).valueOr[ConfirmResponse](ConfirmResponse.UserNotFound) ! upsertAuthMethod(confirmMethod(method))
+        user <- findUser(method.userId)
+          .valueOr[ConfirmResponse](ConfirmResponse.UserNotFound)
+          .flatTap(_ => upsertAuthMethod(confirmMethod(method)))
       } yield ConfirmResponse.Confirmed(issueTokenFor(user))
 
       s.run