Skip to content

Commit

Permalink
Use zio code style guidelines (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
erikvanoosten authored Oct 22, 2024
1 parent 8464415 commit d234110
Show file tree
Hide file tree
Showing 36 changed files with 179 additions and 154 deletions.
3 changes: 2 additions & 1 deletion .scalafmt.conf
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ includeNoParensInSelectChains = true
newlines.avoidAfterYield = false
lineEndings = preserve

rewrite.rules = [SortImports, RedundantBraces]
rewrite.rules = [Imports, RedundantBraces]
rewrite.imports.sort = scalastyle
rewrite.trailingCommas.style = multiple

runner.dialect = "Scala213Source3"
Expand Down
7 changes: 4 additions & 3 deletions brotli/src/main/scala/zio/compress/Brotli.scala
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
package zio.compress

import zio.stream._
import org.brotli.dec.BrotliInputStream
import zio.compress.JavaIoInterop.viaInputStreamByte
import zio.stream._
import zio.Trace

//noinspection ScalaFileName
object BrotliDecompressor {
Expand All @@ -22,8 +23,8 @@ object BrotliDecompressor {
}

//noinspection ScalaFileName
class BrotliDecompressor private (customDictionary: Option[Array[Byte]], chunkSize: Int) extends Decompressor {
override def decompress: ZPipeline[Any, Throwable, Byte, Byte] =
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 =>
// We don't read byte-by-byte so we set the smallest byte-by-byte buffer size possible.
Expand Down
4 changes: 2 additions & 2 deletions brotli/src/test/scala/zio/compress/BrotliSpec.scala
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ import java.util.Base64

object BrotliSpec extends ZIOSpecDefault {

private val clear = Chunk.fromArray("hello world!".getBytes(UTF_8))
private val compressed = Chunk.fromArray(Base64.getDecoder.decode("iwWAaGVsbG8gd29ybGQhAw=="))
private final val clear = Chunk.fromArray("hello world!".getBytes(UTF_8))
private final val compressed = Chunk.fromArray(Base64.getDecoder.decode("iwWAaGVsbG8gd29ybGQhAw=="))

override def spec: Spec[TestEnvironment with Scope, Any] =
suite("Brotli")(
Expand Down
8 changes: 4 additions & 4 deletions brotli4j/src/main/scala/zio/compress/Brotli4J.scala
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ object Brotli4JCompressor {
new Brotli4JCompressor(quality, lgwin, mode)
}

class Brotli4JCompressor private (
final class Brotli4JCompressor private (
quality: Option[BrotliQuality],
lgwin: Option[BrotliLogWindow],
mode: Option[BrotliMode],
) extends Compressor {
override def compress: ZPipeline[Any, Throwable, Byte, Byte] =
override def compress(implicit trace: Trace): ZPipeline[Any, Throwable, Byte, Byte] =
BrotliLoader.ensureAvailability() >>>
viaOutputStreamByte { outputStream =>
val brotliMode = mode.map {
Expand Down Expand Up @@ -61,8 +61,8 @@ object Brotli4JDecompressor {
new Brotli4JDecompressor(chunkSize)
}

class Brotli4JDecompressor private (chunkSize: Int) extends Decompressor {
override def decompress: ZPipeline[Any, Throwable, Byte, Byte] =
final class Brotli4JDecompressor private (chunkSize: Int) extends Decompressor {
override def decompress(implicit trace: Trace): ZPipeline[Any, Throwable, Byte, Byte] =
BrotliLoader.ensureAvailability() >>>
viaInputStreamByte(chunkSize) { inputStream =>
new BrotliInputStream(inputStream)
Expand Down
2 changes: 1 addition & 1 deletion brotli4j/src/main/scala/zio/compress/BrotliLogWindow.scala
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ package zio.compress
* @param lgwin
* lgwin log2(LZ window size), valid values: 10 to 24
*/
final case class BrotliLogWindow private (lgwin: Int)
final case class BrotliLogWindow private (lgwin: Int) extends AnyVal

object BrotliLogWindow {

Expand Down
2 changes: 1 addition & 1 deletion brotli4j/src/main/scala/zio/compress/BrotliMode.scala
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package zio.compress

sealed trait BrotliMode
sealed trait BrotliMode extends Product with Serializable

object BrotliMode {

Expand Down
26 changes: 13 additions & 13 deletions brotli4j/src/main/scala/zio/compress/BrotliQuality.scala
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ package zio.compress
* @param level
* compression level, valid values: 0 to 11
*/
final case class BrotliQuality private (level: Int)
final case class BrotliQuality private (level: Int) extends AnyVal

object BrotliQuality {

Expand All @@ -19,16 +19,16 @@ object BrotliQuality {
def apply(level: Int): Option[BrotliQuality] =
if (0 <= level && level <= 11) Some(new BrotliQuality(level)) else None

val Quality0 = new BrotliQuality(0)
val Quality1 = new BrotliQuality(1)
val Quality2 = new BrotliQuality(2)
val Quality3 = new BrotliQuality(3)
val Quality4 = new BrotliQuality(4)
val Quality5 = new BrotliQuality(5)
val Quality6 = new BrotliQuality(6)
val Quality7 = new BrotliQuality(7)
val Quality8 = new BrotliQuality(8)
val Quality9 = new BrotliQuality(9)
val Quality10 = new BrotliQuality(10)
val Quality11 = new BrotliQuality(11)
final val Quality0 = new BrotliQuality(0)
final val Quality1 = new BrotliQuality(1)
final val Quality2 = new BrotliQuality(2)
final val Quality3 = new BrotliQuality(3)
final val Quality4 = new BrotliQuality(4)
final val Quality5 = new BrotliQuality(5)
final val Quality6 = new BrotliQuality(6)
final val Quality7 = new BrotliQuality(7)
final val Quality8 = new BrotliQuality(8)
final val Quality9 = new BrotliQuality(9)
final val Quality10 = new BrotliQuality(10)
final val Quality11 = new BrotliQuality(11)
}
4 changes: 2 additions & 2 deletions brotli4j/src/test/scala/zio/compress/Brotli4JSpec.scala
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ import java.nio.charset.StandardCharsets.UTF_8
import java.util.Base64

object Brotli4JSpec extends ZIOSpecDefault {
private val clear = Chunk.fromArray("hello world!".getBytes(UTF_8))
private val compressed = Chunk.fromArray(Base64.getDecoder.decode("iwWAaGVsbG8gd29ybGQhAw=="))
private final val clear = Chunk.fromArray("hello world!".getBytes(UTF_8))
private final val compressed = Chunk.fromArray(Base64.getDecoder.decode("iwWAaGVsbG8gd29ybGQhAw=="))

override def spec: Spec[TestEnvironment with Scope, Any] =
suite("Brotli4J")(
Expand Down
11 changes: 6 additions & 5 deletions bzip2/src/main/scala/zio/compress/Bzip2.scala
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
package zio.compress

import zio.stream._
import org.apache.commons.compress.compressors.bzip2.{BZip2CompressorInputStream, BZip2CompressorOutputStream}
import zio.compress.JavaIoInterop.{viaInputStreamByte, viaOutputStreamByte}
import zio.stream._
import zio.Trace

object Bzip2Compressor {

Expand All @@ -19,8 +20,8 @@ object Bzip2Compressor {
new Bzip2Compressor(blockSize)
}

class Bzip2Compressor private (blockSize: Option[Bzip2BlockSize]) extends Compressor {
override def compress: ZPipeline[Any, Throwable, Byte, Byte] =
final class Bzip2Compressor private (blockSize: Option[Bzip2BlockSize]) extends Compressor {
override def compress(implicit trace: Trace): ZPipeline[Any, Throwable, Byte, Byte] =
viaOutputStreamByte { outputStream =>
blockSize match {
case Some(bs) => new BZip2CompressorOutputStream(outputStream, bs.hundredKbIncrements)
Expand All @@ -40,8 +41,8 @@ object Bzip2Decompressor {
new Bzip2Decompressor(chunkSize)
}

class Bzip2Decompressor private (chunkSize: Int) extends Decompressor {
override def decompress: ZPipeline[Any, Throwable, Byte, Byte] =
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(_))
}
20 changes: 10 additions & 10 deletions bzip2/src/main/scala/zio/compress/Bzip2BlockSize.scala
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ package zio.compress
* @param hundredKbIncrements
* a bzip2 block size in 100KB increments, valid values: 1 to 9
*/
final case class Bzip2BlockSize private (hundredKbIncrements: Int)
final case class Bzip2BlockSize private (hundredKbIncrements: Int) extends AnyVal

object Bzip2BlockSize {

Expand All @@ -19,13 +19,13 @@ object Bzip2BlockSize {
def apply(hundredKbIncrements: Int): Option[Bzip2BlockSize] =
if (1 <= hundredKbIncrements && hundredKbIncrements <= 9) Some(new Bzip2BlockSize(hundredKbIncrements)) else None

val BlockSize100KB = new Bzip2BlockSize(1)
val BlockSize200KB = new Bzip2BlockSize(2)
val BlockSize300KB = new Bzip2BlockSize(3)
val BlockSize400KB = new Bzip2BlockSize(4)
val BlockSize500KB = new Bzip2BlockSize(5)
val BlockSize600KB = new Bzip2BlockSize(6)
val BlockSize700KB = new Bzip2BlockSize(7)
val BlockSize800KB = new Bzip2BlockSize(8)
val BlockSize900KB = new Bzip2BlockSize(9)
final val BlockSize100KB = new Bzip2BlockSize(1)
final val BlockSize200KB = new Bzip2BlockSize(2)
final val BlockSize300KB = new Bzip2BlockSize(3)
final val BlockSize400KB = new Bzip2BlockSize(4)
final val BlockSize500KB = new Bzip2BlockSize(5)
final val BlockSize600KB = new Bzip2BlockSize(6)
final val BlockSize700KB = new Bzip2BlockSize(7)
final val BlockSize800KB = new Bzip2BlockSize(8)
final val BlockSize900KB = new Bzip2BlockSize(9)
}
4 changes: 2 additions & 2 deletions bzip2/src/test/scala/zio/compress/Bzip2Spec.scala
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ import java.util.Base64

object Bzip2Spec extends ZIOSpecDefault {

private val clear = Chunk.fromArray("Hello world!".getBytes(UTF_8))
private val compressed = Chunk.fromArray(
private final val clear = Chunk.fromArray("Hello world!".getBytes(UTF_8))
private final val compressed = Chunk.fromArray(
Base64.getDecoder.decode("QlpoOTFBWSZTWQNY9XcAAAEVgGAAAEAGBJCAIAAxBkxBA0wi4Itio54u5IpwoSAGseru")
)

Expand Down
4 changes: 2 additions & 2 deletions core/src/main/scala/zio/compress/ArchiveEntry.scala
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,11 @@ object ArchiveEntry {
): ArchiveEntry[Option, U] =
U.archiveEntry(underlying)

trait ArchiveEntryToUnderlying[+Underlying] {
trait ArchiveEntryToUnderlying[+Underlying] extends Serializable {
def underlying[S[A] <: Option[A]](entry: ArchiveEntry[S, Any], underlying: Any): Underlying
}

trait ArchiveEntryFromUnderlying[+Size[A] <: Option[A], Underlying] {
trait ArchiveEntryFromUnderlying[+Size[A] <: Option[A], Underlying] extends Serializable {
def archiveEntry(underlying: Underlying): ArchiveEntry[Size, Underlying]
}
}
9 changes: 5 additions & 4 deletions core/src/main/scala/zio/compress/ArchiveSingleFile.scala
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
package zio.compress

import zio.Trace
import zio.stream._

class ArchiveSingleFileCompressor[Size[A] <: Option[A]] private (
final class ArchiveSingleFileCompressor[Size[A] <: Option[A]] private (
archiver: Archiver[Size],
entry: ArchiveEntry[Size, Any],
) extends Compressor {
override def compress: ZPipeline[Any, Throwable, Byte, Byte] =
override def compress(implicit trace: Trace): ZPipeline[Any, Throwable, Byte, Byte] =
ZPipeline.fromFunction { stream =>
ZStream((entry, stream)).via(archiver.archive)
}
Expand All @@ -26,10 +27,10 @@ object ArchiveSingleFileCompressor {
new ArchiveSingleFileCompressor(archiver, ArchiveEntry(name, Some(size)))
}

class ArchiveSingleFileDecompressor[Size[A] <: Option[A], Underlying] private (
final class ArchiveSingleFileDecompressor[Size[A] <: Option[A], Underlying] private (
unarchiver: Unarchiver[Size, Underlying]
) extends Decompressor {
override def decompress: ZPipeline[Any, Throwable, Byte, Byte] =
override def decompress(implicit trace: Trace): ZPipeline[Any, Throwable, Byte, Byte] =
ZPipeline.fromFunction { stream =>
stream
.via(unarchiver.unarchive)
Expand Down
6 changes: 4 additions & 2 deletions core/src/main/scala/zio/compress/Archiver.scala
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@ package zio.compress
import zio._
import zio.stream.{ZPipeline, ZStream}

trait Archiver[-Size[A] <: Option[A]] {
def archive: ZPipeline[Any, Throwable, (ArchiveEntry[Size, Any], ZStream[Any, Throwable, Byte]), Byte]
trait Archiver[-Size[A] <: Option[A]] extends Serializable {
def archive(implicit
trace: Trace
): ZPipeline[Any, Throwable, (ArchiveEntry[Size, Any], ZStream[Any, Throwable, Byte]), Byte]
}

object Archiver {
Expand Down
7 changes: 4 additions & 3 deletions core/src/main/scala/zio/compress/Compressor.scala
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
package zio.compress

import zio.stream._
import zio.Trace

trait Compressor {
def compress: ZPipeline[Any, Throwable, Byte, Byte]
trait Compressor extends Serializable {
def compress(implicit trace: Trace): ZPipeline[Any, Throwable, Byte, Byte]
}

object Compressor {
def empty: Compressor = new Compressor {
override def compress: ZPipeline[Any, Nothing, Byte, Byte] = ZPipeline.identity
override def compress(implicit trace: Trace): ZPipeline[Any, Nothing, Byte, Byte] = ZPipeline.identity
}
}
7 changes: 4 additions & 3 deletions core/src/main/scala/zio/compress/Decompressor.scala
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
package zio.compress

import zio.Trace
import zio.stream._

trait Decompressor {
def decompress: ZPipeline[Any, Throwable, Byte, Byte]
trait Decompressor extends Serializable {
def decompress(implicit trace: Trace): ZPipeline[Any, Throwable, Byte, Byte]
}

object Decompressor {
def empty: Decompressor = new Decompressor {
override def decompress: ZPipeline[Any, Nothing, Byte, Byte] = ZPipeline.identity
override def decompress(implicit trace: Trace): ZPipeline[Any, Nothing, Byte, Byte] = ZPipeline.identity
}
}
4 changes: 2 additions & 2 deletions core/src/main/scala/zio/compress/Defaults.scala
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package zio.compress

object Defaults {
val DefaultChunkSize: Int = 64 * 1024
val DefaultChunkedQueueSize: Int = 2
final val DefaultChunkSize: Int = 64 * 1024
final val DefaultChunkedQueueSize: Int = 2
}
30 changes: 15 additions & 15 deletions core/src/main/scala/zio/compress/DeflateCompressionLevel.scala
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ package zio.compress
* @param level
* compression level, valid values: 0 (no compression) to 9 (maximum compression)
*/
final case class DeflateCompressionLevel private (level: Int)
final case class DeflateCompressionLevel private (level: Int) extends AnyVal

object DeflateCompressionLevel {

Expand All @@ -19,19 +19,19 @@ object DeflateCompressionLevel {
def apply(level: Int): Option[DeflateCompressionLevel] =
if (0 <= level && level <= 9) Some(new DeflateCompressionLevel(level)) else None

val CompressionLevel0 = new DeflateCompressionLevel(0)
val CompressionLevel1 = new DeflateCompressionLevel(1)
val CompressionLevel2 = new DeflateCompressionLevel(2)
val CompressionLevel3 = new DeflateCompressionLevel(3)
val CompressionLevel4 = new DeflateCompressionLevel(4)
val CompressionLevel5 = new DeflateCompressionLevel(5)
val CompressionLevel6 = new DeflateCompressionLevel(6)
val CompressionLevel7 = new DeflateCompressionLevel(7)
val CompressionLevel8 = new DeflateCompressionLevel(8)
val CompressionLevel9 = new DeflateCompressionLevel(9)
final val CompressionLevel0 = new DeflateCompressionLevel(0)
final val CompressionLevel1 = new DeflateCompressionLevel(1)
final val CompressionLevel2 = new DeflateCompressionLevel(2)
final val CompressionLevel3 = new DeflateCompressionLevel(3)
final val CompressionLevel4 = new DeflateCompressionLevel(4)
final val CompressionLevel5 = new DeflateCompressionLevel(5)
final val CompressionLevel6 = new DeflateCompressionLevel(6)
final val CompressionLevel7 = new DeflateCompressionLevel(7)
final val CompressionLevel8 = new DeflateCompressionLevel(8)
final val CompressionLevel9 = new DeflateCompressionLevel(9)

val NoCompressionLevel: DeflateCompressionLevel = CompressionLevel0
val FastestCompressionLevel: DeflateCompressionLevel = CompressionLevel1
val DefaultCompressionLevel: DeflateCompressionLevel = CompressionLevel5
val BestCompressionLevel: DeflateCompressionLevel = CompressionLevel9
final val NoCompressionLevel: DeflateCompressionLevel = CompressionLevel0
final val FastestCompressionLevel: DeflateCompressionLevel = CompressionLevel1
final val DefaultCompressionLevel: DeflateCompressionLevel = CompressionLevel5
final val BestCompressionLevel: DeflateCompressionLevel = CompressionLevel9
}
3 changes: 2 additions & 1 deletion core/src/main/scala/zio/compress/JavaIoInterop.scala
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,8 @@ private[compress] object JavaIoInterop {
}
}

private[compress] class QueueOutputStream[E](runtime: Runtime[Any], queue: Queue[Take[E, Byte]]) extends OutputStream {
private[compress] final class QueueOutputStream[E](runtime: Runtime[Any], queue: Queue[Take[E, Byte]])
extends OutputStream {
override def write(b: Int): Unit =
offer(Take.single(b.toByte))

Expand Down
7 changes: 5 additions & 2 deletions core/src/main/scala/zio/compress/Unarchiver.scala
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
package zio.compress

import zio.Trace
import zio.stream._

trait Unarchiver[Size[A] <: Option[A], Underlying] {
def unarchive: ZPipeline[Any, Throwable, Byte, (ArchiveEntry[Size, Underlying], ZStream[Any, Throwable, Byte])]
trait Unarchiver[Size[A] <: Option[A], Underlying] extends Serializable {
def unarchive(implicit
trace: Trace
): ZPipeline[Any, Throwable, Byte, (ArchiveEntry[Size, Underlying], ZStream[Any, Throwable, Byte])]
}
2 changes: 1 addition & 1 deletion gzip/src/main/scala/zio/compress/DeflateStrategy.scala
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package zio.compress

sealed trait DeflateStrategy
sealed trait DeflateStrategy extends Product with Serializable

object DeflateStrategy {
case object Filtered extends DeflateStrategy
Expand Down
Loading

0 comments on commit d234110

Please sign in to comment.