Merge pull request #89 from GeluOltean/master

Define ShortClassNameSnakeCase TypeTags

Author: julienrf

build.sbt

@@ -7,7 +7,7 @@ ThisBuild / scalaVersion := "2.13.3"
 
 ThisBuild / crossScalaVersions := Seq(scalaVersion.value, "2.12.8")
 
-ThisBuild / versionPolicyIntention := Compatibility.BinaryAndSourceCompatible
+ThisBuild / versionPolicyIntention := Compatibility.BinaryCompatible
 // Temporary, because version 10.0.0 was invalid
 ThisBuild / versionPolicyPreviousVersions := Seq("10.0.1")
 

library/src/main/scala/julienrf/json/derived/typetags.scala

@@ -1,6 +1,6 @@
 package julienrf.json.derived
 
-import play.api.libs.json.{JsObject, JsResult, JsValue, Json, OFormat, OWrites, Reads, Writes, __}
+import play.api.libs.json.{JsObject, JsValue, Json, OFormat, OWrites, Reads, Writes, __}
 import shapeless.Witness
 import shapeless.labelled.FieldType
 import scala.language.higherKinds
@@ -223,6 +223,16 @@ object TypeTag {
       }
   }
 
+  /** Use the class name converted to use snake_case as a type tag */
+  trait ShortClassNameSnakeCase[A] extends TypeTag[A]
+
+  object ShortClassNameSnakeCase {
+    implicit def fromWitness[K <: Symbol, A](implicit wt: Witness.Aux[K]): ShortClassNameSnakeCase[FieldType[K, A]] =
+      new ShortClassNameSnakeCase[FieldType[K, A]] {
+        def value: String = play.api.libs.json.JsonNaming.SnakeCase.apply(wt.value.name)
+      }
+  }
+
   /** Use the fully qualified JVM name of the class as a type tag */
   trait FullClassName[A] extends TypeTag[A]
 
@@ -258,6 +268,10 @@ object TypeTagSetting {
     type Value[A] = TypeTag.ShortClassName[A]
   }
 
+  object ShortClassNameSnakeCase extends TypeTagSetting {
+    type Value[A] = TypeTag.ShortClassNameSnakeCase[A]
+  }
+
   object FullClassName extends TypeTagSetting {
     type Value[A] = TypeTag.FullClassName[A]
   }

library/src/test/scala/julienrf/json/derived/DerivedOFormatSuite.scala

@@ -4,7 +4,7 @@ import org.scalacheck.{Arbitrary, Gen}
 import org.scalacheck.Arbitrary.arbitrary
 import org.scalatest.featurespec.AnyFeatureSpec
 import org.scalatestplus.scalacheck.Checkers
-import play.api.libs.json.{Format, JsNumber, Json, OFormat, OWrites, Reads, Writes, __}
+import play.api.libs.json.{Format, JsArray, JsNumber, JsObject, Json, OFormat, OWrites, Reads, Writes, __}
 
 class DerivedOFormatSuite extends AnyFeatureSpec with Checkers {
 
@@ -161,7 +161,10 @@ class DerivedOFormatSuite extends AnyFeatureSpec with Checkers {
     }
   }
 
-  Feature("user-defined type tags") {
+  Feature("type tags") {
+    import TestHelpers._
+    import julienrf.json.derived
+
     Scenario("user-defined type tags") {
       sealed trait Foo
       case class Bar(x: Int) extends Foo
@@ -177,6 +180,23 @@ class DerivedOFormatSuite extends AnyFeatureSpec with Checkers {
       assert(json == Json.obj("_bar_" -> Json.obj("x" -> 42)))
       assert(fooFormat.reads(json).asEither == Right(foo))
     }
+
+    Scenario("ShortClassNameSnakeCase should format tag names using snake casing") {
+      implicit lazy val demoClassFormat: OFormat[CompositeNameClass] = derived
+        .withTypeTag
+        .oformat[CompositeNameClass](TypeTagSetting.ShortClassNameSnakeCase)
+
+      val inner = Seq(FooBar(true), fooBarry(true), foo_barrier(true))
+      val barFoo: CompositeNameClass = BarFoo(inner)
+      val parsed = Json.toJsObject(barFoo)
+      val parsedInner = ((parsed \ "bar_foo") \ "inner")
+        .as[JsArray]
+        .value
+        .map(_.as[JsObject])
+
+      assert(validSnakeNames.contains(parsed.keys.head))
+      assert(parsedInner.map(_.keys.head).forall(validSnakeNames.contains))
+    }
   }
 
   Feature("user-defined implicits") {
@@ -326,4 +346,14 @@ object TestHelpers {
   case class X(a: Int) extends ADTBase
   case class Y(b: String) extends ADTBase
   case class Z(l: ADTBase, r: ADTBase) extends ADTBase
+
+  sealed trait CompositeNameClass
+
+  case class FooBar(inner: Boolean) extends CompositeNameClass
+  case class fooBarry(inner: Boolean) extends CompositeNameClass
+  case class foo_barrier(inner: Boolean) extends CompositeNameClass
+  case class BarFoo(inner: Seq[CompositeNameClass]) extends CompositeNameClass
+
+  lazy val validSnakeNames: Set[String] =
+    Set("foo_bar", "foo_barry", "foo_barrier", "bar_foo")
 }