Merge pull request #251 from vigoo/zio-2

ZIO 2 support

Author: vigoo

build.sbt

@@ -96,6 +96,20 @@ lazy val zio = Project("clipp-zio", file("clipp-zio")).settings(commonSettings).
   testFrameworks += new TestFramework("zio.test.sbt.ZTestFramework")
 ).dependsOn(core)
 
+lazy val zio2 = Project("clipp-zio-2", file("clipp-zio-2")).settings(commonSettings).settings(
+  description := "Clipp ZIO 2 interface",
+
+  resolvers +=
+    "Sonatype OSS Snapshots" at "https://oss.sonatype.org/content/repositories/snapshots",
+  libraryDependencies ++= Seq(
+    "dev.zio" %% "zio" % "2.0.0-M2+72-616ee01d-SNAPSHOT",
+    "dev.zio" %% "zio-test" % "2.0.0-M2+72-616ee01d-SNAPSHOT" % Test,
+    "dev.zio" %% "zio-test-sbt" % "2.0.0-M2+72-616ee01d-SNAPSHOT" % Test
+  ),
+
+  testFrameworks += new TestFramework("zio.test.sbt.ZTestFramework")
+).dependsOn(core)
+
 lazy val catsEffect = Project("clipp-cats-effect", file("clipp-cats-effect")).settings(commonSettings).settings(
   description := "Clipp Cats-Effect interface",
 
@@ -131,8 +145,8 @@ lazy val docs = project
     description := "Functional command line argument parser and usage info generator for Scala",
     publishArtifact := false,
     siteSubdirName in ScalaUnidoc := "api",
-    addMappingsToSiteDir(mappings in (ScalaUnidoc, packageDoc), siteSubdirName in ScalaUnidoc),
-    unidocProjectFilter in ( ScalaUnidoc, unidoc ) := inProjects(
+    addMappingsToSiteDir(mappings in(ScalaUnidoc, packageDoc), siteSubdirName in ScalaUnidoc),
+    unidocProjectFilter in(ScalaUnidoc, unidoc) := inProjects(
       core,
       catsEffect,
       zio

clipp-zio-2/src/main/scala/io/github/vigoo/clipp/zioapi/package.scala

@@ -0,0 +1,92 @@
+package io.github.vigoo.clipp
+
+import cats.data.NonEmptyList
+import io.github.vigoo.clipp.errors.CustomParserError
+import zio.{CanFail, Console, Has, Runtime, Tag, URIO, ZIO, ZIOAppArgs, ZLayer}
+
+package object zioapi {
+  type ClippEnv = Has[Console]
+  type ClippZIO[+A] = ZIO[ClippEnv, ParserFailure, A]
+
+  implicit val clippZio: ClippIO[ClippZIO] = new ClippIO[ClippZIO] {
+    override def succeed[T](value: T): ClippZIO[T] =
+      ZIO.succeed(value)
+
+    override def failWith[T](parserFailure: ParserFailure): ClippZIO[T] =
+      ZIO.fail(parserFailure)
+
+    override def recoverWith[T](io: ClippZIO[T])(f: ParserFailure => ClippZIO[T]): ClippZIO[T] =
+      io.foldZIO(f, v => ZIO.succeed(v))
+
+    override def flatMap[T, U](io: ClippZIO[T])(f: T => ClippZIO[U]): ClippZIO[U] =
+      io.flatMap(f)
+
+    override def showErrors(errors: String): ClippZIO[Unit] =
+      Console.printLine(errors).orDie
+
+    override def showUsage(usageInfo: String): ClippZIO[Unit] =
+      Console.printLine(usageInfo).orDie
+  }
+
+  object Clipp extends ClippImpl[ClippZIO]
+
+  def liftZIO[R, E, T](description: String, examples: NonEmptyList[T])(f: ZIO[R, E, T])(implicit runtime: Runtime[R], ev: CanFail[E], customParserError: CustomParserError[E]): Parameter.Spec[T] =
+    syntax.liftEither(description, examples) {
+      runtime.unsafeRun(f.either)
+    }
+
+  def liftZIO[R, E, T](description: String, example: T)(f: ZIO[R, E, T])(implicit runtime: Runtime[R], ev: CanFail[E], customParserError: CustomParserError[E]): Parameter.Spec[T] =
+    syntax.liftEither(description, example) {
+      runtime.unsafeRun(f.either)
+    }
+
+  def liftURIO[R, T](description: String, examples: NonEmptyList[T])(f: URIO[R, T])(implicit runtime: Runtime[R]): Parameter.Spec[T] =
+    syntax.lift(description, examples) {
+      runtime.unsafeRun(f)
+    }
+
+  def liftURIO[R, T](description: String, example: T)(f: URIO[R, T])(implicit runtime: Runtime[R]): Parameter.Spec[T] =
+    syntax.lift(description, example) {
+      runtime.unsafeRun(f)
+    }
+
+  case class ZioDSL[R](runtime: Runtime[R]) extends syntax {
+    private implicit val r: Runtime[R] = runtime
+
+    def liftZIO[E, T](description: String, examples: NonEmptyList[T])(f: ZIO[R, E, T])(implicit ev: CanFail[E], customParserError: CustomParserError[E]): Parameter.Spec[T] =
+      zioapi.liftZIO[R, E, T](description, examples)(f)
+
+    def liftZIO[E, T](description: String, example: T)(f: ZIO[R, E, T])(implicit ev: CanFail[E], customParserError: CustomParserError[E]): Parameter.Spec[T] =
+      zioapi.liftZIO[R, E, T](description, example)(f)
+
+    def liftURIO[T](description: String, examples: NonEmptyList[T])(f: URIO[R, T]): Parameter.Spec[T] =
+      zioapi.liftURIO[R, T](description, examples)(f)
+
+    def liftURIO[T](description: String, example: T)(f: URIO[R, T]): Parameter.Spec[T] =
+      zioapi.liftURIO[R, T](description, example)(f)
+  }
+
+  def parametersFromArgs[T: Tag](spec: Parameter.Spec[T]): ZLayer[Has[Console] with Has[ZIOAppArgs], ParserFailure, Has[T]] =
+    (for {
+      args <- ZIO.service[ZIOAppArgs]
+      result <- Clipp.parseOrFail(args.args, spec)
+    } yield result).toLayer
+
+  def effectfulParametersFromArgs[R, T: Tag](createSpec: ZioDSL[R] => Parameter.Spec[T]): ZLayer[Has[Console] with Has[ZIOAppArgs] with R, ParserFailure, Has[T]] = {
+    for {
+      runtime <- ZIO.runtime[R]
+      args <- ZIO.service[ZIOAppArgs]
+      spec = createSpec(ZioDSL(runtime))
+      result <- Clipp.parseOrFail(args.args, spec)
+    } yield result
+  }.toLayer
+
+  implicit class ZLayerOps[R <: Has[Console], T](layer: ZLayer[R, ParserFailure, T]) {
+    def printUsageInfoOnFailure: ZLayer[R, ParserFailure, T] =
+      layer.tapError { (parserFailure: ParserFailure) =>
+        Clipp.displayErrorsAndUsageInfo(parserFailure)
+      }
+  }
+
+  def parameters[T: Tag]: URIO[Has[T], T] = ZIO.service[T]
+}

clipp-zio-2/src/test/scala/io/github/vigoo/clipp/ZioSpecs.scala

@@ -0,0 +1,74 @@
+package io.github.vigoo.clipp
+
+import io.github.vigoo.clipp.errors.{CustomError, ParserError}
+import io.github.vigoo.clipp.syntax._
+import io.github.vigoo.clipp.zioapi._
+import zio.{Console, _}
+import zio.test.Assertion._
+import zio.test._
+
+object ZioSpecs extends DefaultRunnableSpec {
+
+  def spec = suite("ZIO interface")(
+    test("successfully parse") {
+      val spec = flag("Test", 'x')
+      for {
+        result <- Clipp.parseOrFail[Boolean](List("-x"), spec)
+      } yield assert(result)(isTrue)
+    },
+
+    test("fail on bad spec") {
+      val spec = flag("Test", 'x')
+      for {
+        result <- Clipp.parseOrFail[Boolean](List("x"), spec).either
+      } yield assert(result)(isLeft(anything))
+    },
+
+    test("fail or print succeeds") {
+      val spec = flag("Test", 'x')
+      for {
+        result <- Clipp.parseOrDisplayErrors(List("x"), spec, ()) { _ => ZIO.unit }
+      } yield assert(result)(anything)
+    },
+
+    test("can be used with return values") {
+      val spec = flag("Test", 'x')
+      for {
+        result <- Clipp.parseOrDisplayErrors(List("-x"), spec, ExitCode.failure) { _ => ZIO.succeed(ExitCode.success) }
+      } yield assert(result)(equalTo(ExitCode.success))
+    },
+
+    test("can provide as layer") {
+      val spec = flag("Test", 'x')
+      val config: ZLayer[Has[Console] with Has[ZIOAppArgs], ParserFailure, Has[Boolean]] = parametersFromArgs(spec).printUsageInfoOnFailure
+      val test: ZIO[Has[Boolean], Nothing, TestResult] =
+        parameters[Boolean].map(p => assert(p)(isTrue))
+
+      test.injectCustom(ZLayer.succeed(ZIOAppArgs(Chunk("-x"))), config)
+    },
+
+    suite("liftEffect")(
+      test("success") {
+        val config = effectfulParametersFromArgs[Any, String] { p =>
+          p.liftURIO("test", "ex") {
+            ZIO.succeed("test")
+          }
+        }
+        val test: ZIO[Has[String], Nothing, TestResult] =
+          parameters[String].map(p => assert(p)(equalTo("test")))
+
+        test.provideSomeLayer(config)
+      },
+      test("failure") {
+        val config = effectfulParametersFromArgs[Any, String] { p =>
+          p.liftZIO("test", "ex") {
+            ZIO.fail("failure")
+          }
+        }
+
+        assertM(parameters[String].unit.provideSomeLayer(config).run)(fails(
+          hasField("errors", _.errors.toList, contains[ParserError](CustomError("failure")))))
+      }
+    )
+  )
+}

docs/docs/docs/catseffect.md

@@ -8,7 +8,7 @@ title: Cats Effect
 To use the Cats-Effect interface add the following dependency:
 
 ```scala
-libraryDependencies += "io.github.vigoo" %% "clipp-cats-effect" % "0.6.1"
+libraryDependencies += "io.github.vigoo" %% "clipp-cats-effect" % "0.6.2"
 ```
 
 Example:
@@ -39,7 +39,7 @@ object Test extends IOApp {
 To use the Cats-Effect interface add the following dependency:
 
 ```scala
-libraryDependencies += "io.github.vigoo" %% "clipp-cats-effect3" % "0.6.1"
+libraryDependencies += "io.github.vigoo" %% "clipp-cats-effect3" % "0.6.2"
 ```
 
 Example:

docs/docs/docs/zio.md

@@ -3,11 +3,11 @@ layout: docs
 title: ZIO
 ---
 
-# Using with ZIO
+# Using with ZIO 1.x
 To use the ZIO interface add the following dependency:
 
 ```scala
-libraryDependencies += "io.github.vigoo" %% "clipp-zio" % "0.6.1"
+libraryDependencies += "io.github.vigoo" %% "clipp-zio" % "0.6.2"
 ```
 
 It is possible to directly call the ZIO interface wrapper, for example:
@@ -75,4 +75,43 @@ effectfulParametersFromArgs[Clock, String](List.empty) { p =>
     instant.map(_.toString)
   }
 }
+```
+
+# Using with ZIO 2.x
+ZIO 2 support is currently published separately for snapshot versions of ZIO. Once ZIO 2 is released there will be only
+one clipp-zio artifact maintained.
+
+```scala
+libraryDependencies += "io.github.vigoo" %% "clipp-zio-2" % "0.6.2"
+```
+
+The only difference currently is that instead of providing the list of arguments as a parameter, Clipp takes it from the 
+`ZIOAppArgs` layer:
+
+```scala
+import io.github.vigoo.clipp._
+import io.github.vigoo.clipp.parsers._
+import io.github.vigoo.clipp.syntax._
+import io.github.vigoo.clipp.zioapi._
+
+import zio._
+
+object Test2 extends ZIOApp {
+  def run = {
+    val paramSpec = for {
+      _ <- metadata("zio-test")
+      x <- flag("test parameter", 'x')
+    } yield x
+
+    val clippConfig = parametersFromArgs(paramSpec).printUsageInfoOnFailure
+    val program = for {
+        x <- parameters[Boolean]
+        _ <- console.putStrLn(s"x was: $x").ignore
+    } yield ExitCode.success
+    
+    program
+      .injectCustom(clippConfig)
+      .catchAll { _: ParserFailure => ZIO.succeed(ExitCode.failure) }    
+  }
+} 
 ```