No more make (#9)

Cleans up the API, you no longer need to type `make`. For example:

 - `SomeCompressor.make().compress` --> `SomeCompressor.compress`
 - `SomeCompressor.make(parameter = value).compress` --> `SomeCompressor(parameter = value).compress`

README.md

@@ -15,7 +15,7 @@ Please [open an issue](https://github.com/zio/zio-streams-compress/issues/new) o
 on [Discord](https://discord.com/channels/629491597070827530/630498701860929559) if you have suggestions. The API will
 stabilize in Jan 2025, followed by a 1.0.0 release.
 
-## Usage
+## Installation
 
 In order to use this library, we need to add one of the following line in our `build.sbt` file:
 
@@ -46,49 +46,49 @@ Currently only jvm is supported. PRs for scala-js and scala-native are welcome.
 // Example.sc
 // Run with: scala-cli Example.sc
 //> using dep dev.zio:zio-streams-compress-gzip:0.0.1
-//> using dep dev.zio:zio-streams-compress-zip:0.0.1
 //> using dep dev.zio:zio-streams-compress-tar:0.0.1
+//> using dep dev.zio:zio-streams-compress-zip4j:0.0.1
 
 import zio._
-import zio.compress.{ArchiveEntry, GzipCompressor, GzipDecompressor, TarUnarchiver, ZipArchiver}
+import zio.compress.{ArchiveEntry, GzipCompressor, GzipDecompressor, TarUnarchiver, Zip4JArchiver}
 import zio.stream._
 
 import java.nio.charset.StandardCharsets.UTF_8
 
 object ExampleApp extends ZIOAppDefault {
-  override def run =
+  override def run: ZIO[Any, Any, Any] =
     for {
       // Compress a file with GZIP
       _ <- ZStream
-        .fromFileName("file")
-        .via(GzipCompressor.make().compress)
-        .run(ZSink.fromFileName("file.gz"))
+             .fromFileName("file")
+             .via(GzipCompressor.compress)
+             .run(ZSink.fromFileName("file.gz"))
 
       // List all items in a gzip tar archive:
       _ <- ZStream
-        .fromFileName("file.tgz")
-        .via(GzipDecompressor.make().decompress)
-        .via(TarUnarchiver.make().unarchive)
-        .mapZIO { case (archiveEntry, contentStream) =>
-          for {
-            content <- contentStream.runCollect
-            _ <- Console.printLine(s"${archiveEntry.name} ${content.length}")
-          } yield ()
-        }
-        .runDrain
-
-      // Create a ZIP archive (use the zip4j version for password support)
+             .fromFileName("file.tgz")
+             .via(GzipDecompressor.decompress)
+             .via(TarUnarchiver.unarchive)
+             .mapZIO { case (archiveEntry, contentStream) =>
+               for {
+                 content <- contentStream.runCollect
+                 _ <- Console.printLine(s"${archiveEntry.name} ${content.length}")
+               } yield ()
+             }
+             .runDrain
+
+      // Create an encrypted ZIP archive
       _ <- ZStream(archiveEntry("file1.txt", "Hello world!".getBytes(UTF_8)))
-        .via(ZipArchiver.make().archive)
-        .run(ZSink.fromFileName("file.zip"))
+             .via(Zip4JArchiver(password = Some("it is a secret")).archive)
+             .run(ZSink.fromFileName("file.zip"))
     } yield ()
 
   private def archiveEntry(
-                            name: String,
-                            content: Array[Byte]
-                          ): (ArchiveEntry[Some, Any], ZStream[Any, Throwable, Byte]) = {
-    (ArchiveEntry(name, Some(content.length)), ZStream.fromIterable(content))
-  }
+    name: String,
+    content: Array[Byte],
+  ): (ArchiveEntry[Some, Any], ZStream[Any, Throwable, Byte]) =
+    (ArchiveEntry(name, Some(content.length.toLong)), ZStream.fromIterable(content))
+
 }
 ```
 

brotli/src/main/scala/zio/compress/Brotli.scala

@@ -8,22 +8,26 @@ import zio.Trace
 //noinspection ScalaFileName
 object BrotliDecompressor {
 
-  /** Makes a pipeline that accepts a Brotli compressed byte stream and produces a decompressed byte stream.
+  /** A [[Decompressor]] for Brotli, based on the official Brotli library.
     *
     * @param customDictionary
     *   a custom dictionary, or `None` for no custom dictionary
     * @param chunkSize
     *   The maximum chunk size of the outgoing ZStream. Defaults to `ZStream.DefaultChunkSize` (4KiB).
     */
-  def make(
+  def apply(
     customDictionary: Option[Array[Byte]] = None,
     chunkSize: Int = ZStream.DefaultChunkSize,
   ): BrotliDecompressor =
     new BrotliDecompressor(customDictionary, chunkSize)
+
+  /** See [[apply]] and [[Decompressor.decompress]]. */
+  def decompress: ZPipeline[Any, Throwable, Byte, Byte] = apply().decompress
 }
 
 //noinspection ScalaFileName
 final class BrotliDecompressor private (customDictionary: Option[Array[Byte]], chunkSize: Int) extends Decompressor {
+
   override def decompress(implicit trace: Trace): ZPipeline[Any, Throwable, Byte, Byte] =
     // BrotliInputStream.read does its best to read as many bytes as requested; no buffering needed.
     viaInputStreamByte(chunkSize) { inputStream =>

brotli/src/test/scala/zio/compress/BrotliSpec.scala

@@ -18,7 +18,7 @@ object BrotliSpec extends ZIOSpecDefault {
         for {
           obtained <- ZStream
                         .fromChunk(compressed)
-                        .via(BrotliDecompressor.make().decompress)
+                        .via(BrotliDecompressor.decompress)
                         .runCollect
         } yield assertTrue(clear == obtained)
       }

brotli4j/src/main/scala/zio/compress/Brotli4J.scala

@@ -10,7 +10,7 @@ import zio.stream._
 
 object Brotli4JCompressor {
 
-  /** Make a pipeline that accepts a stream of bytes and produces a stream with Brotli compressed bytes.
+  /** A [[Compressor]] for Brotli, based on the Brotli4J library.
     *
     * @param quality
     *   The compression quality to use, or `None` for the default.
@@ -19,19 +19,23 @@ object Brotli4JCompressor {
     * @param mode
     *   type of encoding to use, or `None` for the default.
     */
-  def make(
+  def apply(
     quality: Option[BrotliQuality] = None,
     lgwin: Option[BrotliLogWindow] = None,
     mode: Option[BrotliMode] = None,
   ): Brotli4JCompressor =
     new Brotli4JCompressor(quality, lgwin, mode)
+
+  /** See [[apply]] and [[Compressor.compress]]. */
+  def compress: ZPipeline[Any, Throwable, Byte, Byte] = apply().compress
 }
 
 final class Brotli4JCompressor private (
   quality: Option[BrotliQuality],
   lgwin: Option[BrotliLogWindow],
   mode: Option[BrotliMode],
 ) extends Compressor {
+
   override def compress(implicit trace: Trace): ZPipeline[Any, Throwable, Byte, Byte] =
     BrotliLoader.ensureAvailability() >>>
       viaOutputStreamByte { outputStream =>
@@ -50,18 +54,22 @@ final class Brotli4JCompressor private (
 
 object Brotli4JDecompressor {
 
-  /** Makes a pipeline that accepts a Brotli compressed byte stream and produces a decompressed byte stream.
+  /** A [[Decompressor]] for Brotli, based on the Brotli4J library.
     *
     * @param chunkSize
     *   The maximum chunk size of the outgoing ZStream. Defaults to `ZStream.DefaultChunkSize` (4KiB).
     */
-  def make(
+  def apply(
     chunkSize: Int = ZStream.DefaultChunkSize
   ): Brotli4JDecompressor =
     new Brotli4JDecompressor(chunkSize)
+
+  /** See [[apply]] and [[Decompressor.decompress]]. */
+  def decompress: ZPipeline[Any, Throwable, Byte, Byte] = apply().decompress
 }
 
 final class Brotli4JDecompressor private (chunkSize: Int) extends Decompressor {
+
   override def decompress(implicit trace: Trace): ZPipeline[Any, Throwable, Byte, Byte] =
     BrotliLoader.ensureAvailability() >>>
       viaInputStreamByte(chunkSize) { inputStream =>

brotli4j/src/test/scala/zio/compress/Brotli4JSpec.scala

@@ -17,7 +17,7 @@ object Brotli4JSpec extends ZIOSpecDefault {
         for {
           obtained <- ZStream
                         .fromChunk(compressed)
-                        .via(Brotli4JDecompressor.make().decompress)
+                        .via(Brotli4JDecompressor.decompress)
                         .runCollect
         } yield assertTrue(clear == obtained)
       },
@@ -27,8 +27,8 @@ object Brotli4JSpec extends ZIOSpecDefault {
             obtained <- ZStream
                           .fromChunk(genBytes)
                           .rechunk(chunkSize)
-                          .via(Brotli4JCompressor.make().compress)
-                          .via(Brotli4JDecompressor.make().decompress)
+                          .via(Brotli4JCompressor.compress)
+                          .via(Brotli4JDecompressor.decompress)
                           .runCollect
           } yield assertTrue(obtained == genBytes)
         }

build.sbt

@@ -49,15 +49,6 @@ inThisBuild(
 
 def commonSettings(projectName: String) = Seq(
   name := s"zio-streams-compress-$projectName",
-//    Compile / compile / scalacOptions ++=
-//      optionsOn("2.13")("-Wconf:cat=unused-nowarn:s").value,
-  // scalacOptions -= "-Xlint:infer-any",
-  // workaround for bad constant pool issue
-  //  (Compile / doc) := Def.taskDyn {
-  //    val default = (Compile / doc).taskValue
-  //    Def.task(default.value)
-  //  }.value,
-  //  Test / scalaJSLinkerConfig ~= (_.withModuleKind(ModuleKind.CommonJSModule)),
   libraryDependencies ++= Seq(
     "dev.zio" %%% "zio-test" % V.zio % Test,
     "dev.zio" %%% "zio-test-sbt" % V.zio % Test,
@@ -198,7 +189,7 @@ lazy val zstd = projectMatrix
 
 lazy val example = projectMatrix
   .in(file("example"))
-  .dependsOn(gzip, tar, zip)
+  .dependsOn(gzip, tar, zip4j)
   .settings(commonSettings("example"))
   .settings(
     publishArtifact := false,

bzip2/src/main/scala/zio/compress/Bzip2.scala

@@ -7,7 +7,7 @@ import zio.Trace
 
 object Bzip2Compressor {
 
-  /** Make a pipeline that accepts a stream of bytes and produces a stream with Bzip2 compressed bytes.
+  /** A [[Compressor]] for Bzip2, based on the Apache Commons Compress library.
     *
     * Note: Bzip2 uses a lot of memory. See
     * [[org.apache.commons.compress.compressors.bzip2.BZip2CompressorOutputStream]] for an overview of the required heap
@@ -16,11 +16,15 @@ object Bzip2Compressor {
     * @param blockSize
     *   the block size to use. Defaults to 900KB.
     */
-  def make(blockSize: Option[Bzip2BlockSize] = None): Bzip2Compressor =
+  def apply(blockSize: Option[Bzip2BlockSize] = None): Bzip2Compressor =
     new Bzip2Compressor(blockSize)
+
+  /** See [[apply]] and [[Compressor.compress]]. */
+  def compress: ZPipeline[Any, Throwable, Byte, Byte] = apply().compress
 }
 
 final class Bzip2Compressor private (blockSize: Option[Bzip2BlockSize]) extends Compressor {
+
   override def compress(implicit trace: Trace): ZPipeline[Any, Throwable, Byte, Byte] =
     viaOutputStreamByte { outputStream =>
       blockSize match {
@@ -32,16 +36,20 @@ final class Bzip2Compressor private (blockSize: Option[Bzip2BlockSize]) extends
 
 object Bzip2Decompressor {
 
-  /** Makes a pipeline that accepts a Bzip2 compressed byte stream and produces a decompressed byte stream.
+  /** A [[Decompressor]] for Bzip2, based on the Apache Commons Compress library.
     *
     * @param chunkSize
     *   The maximum chunk size of the outgoing ZStream. Defaults to `ZStream.DefaultChunkSize` (4KiB).
     */
-  def make(chunkSize: Int = ZStream.DefaultChunkSize): Bzip2Decompressor =
+  def apply(chunkSize: Int = ZStream.DefaultChunkSize): Bzip2Decompressor =
     new Bzip2Decompressor(chunkSize)
+
+  /** See [[apply]] and [[Decompressor.decompress]]. */
+  def decompress: ZPipeline[Any, Throwable, Byte, Byte] = apply().decompress
 }
 
 final class Bzip2Decompressor private (chunkSize: Int) extends Decompressor {
+
   override def decompress(implicit trace: Trace): ZPipeline[Any, Throwable, Byte, Byte] =
     // BrotliInputStream.read does its best to read as many bytes as requested; no buffering needed.
     viaInputStreamByte(chunkSize)(new BZip2CompressorInputStream(_))

bzip2/src/test/scala/zio/compress/Bzip2Spec.scala

@@ -20,15 +20,15 @@ object Bzip2Spec extends ZIOSpecDefault {
         for {
           obtained <- ZStream
                         .fromChunk(clear)
-                        .via(Bzip2Compressor.make().compress)
+                        .via(Bzip2Compressor.compress)
                         .runCollect
         } yield assertTrue(compressed == obtained)
       },
       test("bzip2 decompress") {
         for {
           obtained <- ZStream
                         .fromChunk(compressed)
-                        .via(Bzip2Decompressor.make().decompress)
+                        .via(Bzip2Decompressor.decompress)
                         .runCollect
         } yield assertTrue(clear == obtained)
       },
@@ -38,8 +38,8 @@ object Bzip2Spec extends ZIOSpecDefault {
             obtained <- ZStream
                           .fromChunk(genBytes)
                           .rechunk(chunkSize)
-                          .via(Bzip2Compressor.make().compress)
-                          .via(Bzip2Decompressor.make().decompress)
+                          .via(Bzip2Compressor.compress)
+                          .via(Bzip2Decompressor.decompress)
                           .runCollect
           } yield assertTrue(obtained == genBytes)
         }

core/src/main/scala/zio/compress/ArchiveSingleFile.scala

@@ -7,6 +7,7 @@ final class ArchiveSingleFileCompressor[Size[A] <: Option[A]] private (
   archiver: Archiver[Size],
   entry: ArchiveEntry[Size, Any],
 ) extends Compressor {
+
   override def compress(implicit trace: Trace): ZPipeline[Any, Throwable, Byte, Byte] =
     ZPipeline.fromFunction { stream =>
       ZStream((entry, stream)).via(archiver.archive)
@@ -30,6 +31,7 @@ object ArchiveSingleFileCompressor {
 final class ArchiveSingleFileDecompressor[Size[A] <: Option[A], Underlying] private (
   unarchiver: Unarchiver[Size, Underlying]
 ) extends Decompressor {
+
   override def decompress(implicit trace: Trace): ZPipeline[Any, Throwable, Byte, Byte] =
     ZPipeline.fromFunction { stream =>
       stream

core/src/main/scala/zio/compress/Archiver.scala

@@ -3,7 +3,15 @@ package zio.compress
 import zio._
 import zio.stream.{ZPipeline, ZStream}
 
+/** An archiver makes pipelines that accept a stream of archive entries, and produce a byte stream of an archive.
+  *
+  * @tparam Size
+  *   Either a `Some` when the archive entries require the uncompressed size, or `Option` when the archive entries do
+  *   not require the uncompressed size.
+  */
 trait Archiver[-Size[A] <: Option[A]] extends Serializable {
+
+  /** Makes a pipeline that accepts a stream of archive entries, and produces a byte stream of an archive. */
   def archive(implicit
     trace: Trace
   ): ZPipeline[Any, Throwable, (ArchiveEntry[Size, Any], ZStream[Any, Throwable, Byte]), Byte]

core/src/main/scala/zio/compress/Compressor.scala

@@ -4,11 +4,17 @@ import zio.stream._
 import zio.Trace
 
 trait Compressor extends Serializable {
+
+  /** A pipeline that takes a raw byte stream and produces a compressed byte stream. */
   def compress(implicit trace: Trace): ZPipeline[Any, Throwable, Byte, Byte]
 }
 
-object Compressor {
+object Compressor extends Serializable {
+
+  /** A compressor that does nothing; it passes all bytes through unchanged. */
   def empty: Compressor = new Compressor {
-    override def compress(implicit trace: Trace): ZPipeline[Any, Nothing, Byte, Byte] = ZPipeline.identity
+
+    override def compress(implicit trace: Trace): ZPipeline[Any, Nothing, Byte, Byte] =
+      ZPipeline.identity
   }
 }

core/src/main/scala/zio/compress/Decompressor.scala

@@ -4,11 +4,17 @@ import zio.Trace
 import zio.stream._
 
 trait Decompressor extends Serializable {
+
+  /** A pipeline that decompresses a byte stream to an uncompressed byte stream. */
   def decompress(implicit trace: Trace): ZPipeline[Any, Throwable, Byte, Byte]
 }
 
 object Decompressor {
+
+  /** A decompressor that does nothing; it passes all bytes through unchanged. */
   def empty: Decompressor = new Decompressor {
-    override def decompress(implicit trace: Trace): ZPipeline[Any, Nothing, Byte, Byte] = ZPipeline.identity
+
+    override def decompress(implicit trace: Trace): ZPipeline[Any, Nothing, Byte, Byte] =
+      ZPipeline.identity
   }
 }

core/src/main/scala/zio/compress/Unarchiver.scala

@@ -3,7 +3,17 @@ package zio.compress
 import zio.Trace
 import zio.stream._
 
+/** An unarchiver makes pipelines that accept the byte stream of an archive, and produce a stream of archive entries.
+  *
+  * @tparam Size
+  *   Either a `Some` when the archive entries have a known uncompressed size, `None` when the archive entries _do not_
+  *   have the uncompressed size, or `Option` when the archive entries _might_ have the uncompressed size.
+  * @tparam Underlying
+  *   The archive entries from the underlying archiving library.
+  */
 trait Unarchiver[Size[A] <: Option[A], Underlying] extends Serializable {
+
+  /** Make a pipelines that accepts the byte stream of an archive, and produces a stream of archive entries. */
   def unarchive(implicit
     trace: Trace
   ): ZPipeline[Any, Throwable, Byte, (ArchiveEntry[Size, Underlying], ZStream[Any, Throwable, Byte])]