feat: circe module (#24)

* feat: circe module

* docs: information about how to use circe module

Author: augi

README.md

@@ -1,7 +1,13 @@
 # Scala Hashes [![Build](https://github.com/avast/scala-hashes/actions/workflows/build.yml/badge.svg)](https://github.com/avast/scala-hashes/actions/workflows/build.yml) [![Version](https://badgen.net/maven/v/maven-central/com.avast.hashes/scala-hashes_2.13)](https://repo1.maven.org/maven2/com/avast/hashes/scala-hashes_2.13/)
 
-Case-classes representing MD5, SHA1 and SHA256. It also contains converters/encoders for [circe](https://github.com/travisbrown/circe) and [json4s](https://github.com/json4s/json4s) JSON libraries. Dependencies on this libraries are just optional (you must add the dependency in your project).
+Case-classes representing MD5, SHA1, and SHA256 hashes.
 
 ```gradle
 compile "com.avast.hashes:scala-hashes_2.13:$versionHere"
 ```
+
+There is also a support for [circe](https://github.com/travisbrown/circe) JSON library:
+```gradle
+compile "com.avast.hashes:scala-hashes-circe_2.13:$versionHere"
+```
+Then you can import encoders and decoders using `import com.avast.scala.hashes.circe._`

build.gradle

@@ -1,94 +1,87 @@
-buildscript {
-    repositories {
-        jcenter()
-        dependencies {
-            classpath 'com.github.ben-manes:gradle-versions-plugin:0.39.0'
-        }
-    }
-}
-
 plugins {
     id 'signing'
-    id('io.github.gradle-nexus.publish-plugin') version '1.0.0'
+    id('io.github.gradle-nexus.publish-plugin') version '1.1.0'
 }
 
-apply plugin: 'idea'
-apply plugin: 'scala'
-apply plugin: 'java-library'
-apply plugin: 'maven-publish'
-apply plugin: 'com.github.ben-manes.versions'
-
-sourceCompatibility = JavaVersion.VERSION_1_8
+allprojects {
+    group 'com.avast.hashes'
+    version = version == 'unspecified' ? 'DEVELOPER-SNAPSHOT' : version
+}
 
 ext {
     circeVersion = '0.13.0'
 }
 
-group = 'com.avast.hashes'
-archivesBaseName = "scala-hashes_$scalaVersion"
-
-repositories {
-    mavenCentral()
+nexusPublishing {
+    repositories {
+        sonatype()
+    }
 }
 
-dependencies {
-    api "org.scala-lang:scala-library:${scalaLibraryVersion}"
-    compileOnly "org.json4s:json4s-core_${scalaVersion}:3.6.9"
-    compileOnly "io.circe:circe-core_${scalaVersion}:${circeVersion}"
+subprojects {
+    apply plugin: 'scala'
+    apply plugin: 'java-library'
+    apply plugin: 'maven-publish'
 
-    testImplementation "org.scalatest:scalatest_${scalaVersion}:3.2.0"
-    testImplementation "org.scalatestplus:junit-4-12_${scalaVersion}:3.1.3.0"
-    testImplementation "io.circe:circe-core_${scalaVersion}:${circeVersion}"
-    testImplementation "junit:junit:4.13.2"
-}
+    sourceCompatibility = JavaVersion.VERSION_1_8
 
-java {
-    withJavadocJar()
-    withSourcesJar()
-}
+    repositories {
+        mavenCentral()
+    }
 
-publishing {
-    publications {
-        mavenJava(MavenPublication) {
-            from(components.java)
-            artifactId = archivesBaseName
-            pom {
-                name = 'Scala Hashes'
-                description = 'Case-classes representing MD5, SHA1 and SHA256.'
-                url = 'https://github.com/avast/scala-hashes'
-                licenses {
-                    license {
-                        name = 'The MIT License'
-                        url = 'http://www.opensource.org/licenses/mit-license.php'
-                    }
-                }
-                developers {
-                    developer {
-                        id = 'augi'
-                        name = 'Michal Augustýn'
-                        email = '[email protected]'
+    dependencies {
+        api "org.scala-lang:scala-library:${scalaLibraryVersion}"
+
+        testImplementation "org.scalatest:scalatest_${scalaVersion}:3.2.0"
+        testImplementation "org.scalatestplus:junit-4-12_${scalaVersion}:3.1.3.0"
+        testImplementation "junit:junit:4.13.2"
+    }
+
+    java {
+        withJavadocJar()
+        withSourcesJar()
+    }
+
+    afterEvaluate {
+
+        publishing {
+            publications {
+                mavenJava(MavenPublication) {
+                    from(components.java)
+                    artifactId = archivesBaseName
+                    pom {
+                        name = 'Scala Hashes'
+                        description = 'Case-classes representing MD5, SHA1 and SHA256.'
+                        url = 'https://github.com/avast/scala-hashes'
+                        licenses {
+                            license {
+                                name = 'The MIT License'
+                                url = 'http://www.opensource.org/licenses/mit-license.php'
+                            }
+                        }
+                        developers {
+                            developer {
+                                id = 'augi'
+                                name = 'Michal Augustýn'
+                                email = '[email protected]'
+                            }
+                        }
+                        scm {
+                            connection = 'scm:git:git://github.com/avast/scala-hashes.git'
+                            developerConnection = 'scm:git:ssh://github.com/avast/scala-hashes.git'
+                            url = 'https://github.com/avast/scala-hashes'
+                        }
                     }
                 }
-                scm {
-                    connection = 'scm:git:git://github.com/avast/scala-hashes.git'
-                    developerConnection = 'scm:git:ssh://github.com/avast/scala-hashes.git'
-                    url = 'https://github.com/avast/scala-hashes'
-                }
             }
         }
     }
-}
-
-signing {
-    String base64Key = System.getenv('SIGNING_KEY')
-    if (base64Key) {
-        useInMemoryPgpKeys(new String(Base64.decoder.decode(base64Key)), System.getenv('SIGNING_PASSWORD'))
-        sign publishing.publications
-    }
-}
 
-nexusPublishing {
-    repositories {
-        sonatype()
+    signing {
+        String base64Key = System.getenv('SIGNING_KEY')
+        if (base64Key) {
+            useInMemoryPgpKeys(new String(Base64.decoder.decode(base64Key)), System.getenv('SIGNING_PASSWORD'))
+            sign publishing.publications
+        }
     }
 }

circe/build.gradle

@@ -0,0 +1,6 @@
+archivesBaseName = "scala-hashes-circe_$scalaVersion"
+
+dependencies {
+    api project(':core')
+    api "io.circe:circe-core_${scalaVersion}:${circeVersion}"
+}

circe/src/main/scala/com/avast/scala/hashes/circe/package.scala

@@ -0,0 +1,24 @@
+package com.avast.scala.hashes
+
+import cats.syntax.all._
+import io.circe._
+
+package object circe {
+  implicit val Sha256Decoder: Decoder[Sha256] = prepareDecoder(Sha256(_))
+  implicit val Sha256Encoder: Encoder[Sha256] = Encoder.encodeString.contramap((s: Sha256) => s.toString)
+  implicit val MD5Decoder: Decoder[MD5] = prepareDecoder(MD5(_))
+  implicit val MD5Encoder: Encoder[MD5] = Encoder.encodeString.contramap((h: MD5) => h.toString)
+  implicit val Sha1Decoder: Decoder[Sha1] = prepareDecoder(Sha1(_))
+  implicit val Sha1Encoder: Encoder[Sha1] = Encoder.encodeString.contramap((s: Sha1) => s.toString)
+
+  private def prepareDecoder[A](parse: String => A): Decoder[A] =
+    (c: HCursor) => {
+      c.value.as[String].flatMap { s =>
+        Either
+          .catchNonFatal(parse(s))
+          .leftMap { e =>
+            DecodingFailure(e.toString, c.history)
+          }
+      }
+    }
+}

src/test/scala/com/avast/scala/hashes/circe/MD5Sha1Decoder.scala renamed to circe/src/test/scala/com/avast/scala/hashes/circe/MD5Sha1Decoder.scala

@@ -0,0 +1 @@
+archivesBaseName = "scala-hashes_$scalaVersion"

src/test/scala/com/avast/scala/hashes/circe/Sha1DecoderTest.scala renamed to circe/src/test/scala/com/avast/scala/hashes/circe/Sha1DecoderTest.scala

@@ -1,7 +1,5 @@
 package com.avast.scala.hashes
 
-import io.circe.{Decoder, Encoder}
-
 import java.util
 
 case class MD5(bytes: Array[Byte]) {
@@ -21,7 +19,4 @@ case class MD5(bytes: Array[Byte]) {
 object MD5 {
   private val bytesLength = 16
   def apply(hexOrBase64: String): MD5 = MD5(tryHex2bytes(hexOrBase64, bytesLength).getOrElse(base642bytes(hexOrBase64)))
-
-  implicit lazy val MD5Decoder: Decoder[MD5] = circe.prepareDecoder(MD5(_))
-  implicit lazy val MD5Encoder: Encoder[MD5] = Encoder.encodeString.contramap((h: MD5) => h.toString)
 }

src/test/scala/com/avast/scala/hashes/circe/Sha256DecoderTest.scala renamed to circe/src/test/scala/com/avast/scala/hashes/circe/Sha256DecoderTest.scala

@@ -1,7 +1,5 @@
 package com.avast.scala.hashes
 
-import io.circe.{Decoder, Encoder}
-
 import java.util
 
 case class Sha1(bytes: Array[Byte]) {
@@ -21,7 +19,4 @@ case class Sha1(bytes: Array[Byte]) {
 object Sha1 {
   private val bytesLength = 20
   def apply(hexOrBase64: String): Sha1 = Sha1(tryHex2bytes(hexOrBase64, bytesLength).getOrElse(base642bytes(hexOrBase64)))
-
-  implicit lazy val Sha1Decoder: Decoder[Sha1] = circe.prepareDecoder(Sha1(_))
-  implicit lazy val Sha1Encoder: Encoder[Sha1] = Encoder.encodeString.contramap((s: Sha1) => s.toString)
 }

core/build.gradle

@@ -1,7 +1,5 @@
 package com.avast.scala.hashes
 
-import io.circe.{Decoder, Encoder}
-
 import java.util
 
 case class Sha256(bytes: Array[Byte]) {
@@ -21,7 +19,4 @@ case class Sha256(bytes: Array[Byte]) {
 object Sha256 {
   private val bytesLength = 32
   def apply(hexOrBase64: String): Sha256 = Sha256(tryHex2bytes(hexOrBase64, bytesLength).getOrElse(base642bytes(hexOrBase64)))
-
-  implicit lazy val Sha256Decoder: Decoder[Sha256] = circe.prepareDecoder(Sha256(_))
-  implicit lazy val Sha256Encoder: Encoder[Sha256] = Encoder.encodeString.contramap((s: Sha256) => s.toString)
 }

src/main/scala/com/avast/scala/hashes/HashesMother.scala renamed to core/src/main/scala/com/avast/scala/hashes/HashesMother.scala

@@ -1 +1,3 @@
 rootProject.name = 'scala-hashes'
+
+include 'core', 'circe'