Port and adjust #288 to scala-3 branch (#289)

- cleanup majority of the compilation warnings - cleanup unused warnings from macro-generated code (Scala 2 only)
scalalandio · Mar 17, 2023 · 64e1413 · 64e1413
1 parent d679766
commit 64e1413
Show file tree

Hide file tree

Showing 13 changed files with 43 additions and 32 deletions.
diff --git a/build.sbt b/build.sbt
@@ -56,7 +56,7 @@ val settings = Seq(
           "-feature",
           "-language:higherKinds",
           "-Wunused:patvars",
-          // "-Xfatal-warnings",
+          "-Xfatal-warnings",
           "-Xlint:adapted-args",
           "-Xlint:delayedinit-select",
           "-Xlint:doc-detached",
@@ -76,7 +76,8 @@ val settings = Seq(
           "-Ywarn-unused:imports",
           "-Ywarn-macros:after",
           "-Ytasty-reader",
-          "-Wconf:origin=scala.collection.compat.*:s"
+          "-Wconf:origin=scala.collection.compat.*:s",
+          "-Wconf:src=io/scalaland/chimney/cats/package.scala:s" // silence package object inheritance deprecation
         )
       case Some((2, 12)) =>
         Seq(
@@ -90,7 +91,6 @@ val settings = Seq(
           "-feature",
           "-language:higherKinds",
           "-Xexperimental",
-          // "-Xfatal-warnings",
           "-Xfuture",
           "-Xlint:adapted-args",
           "-Xlint:by-name-right-associative",

diff --git a/chimney/src/main/scala-2/io/scalaland/chimney/internal/macros/Model.scala b/chimney/src/main/scala-2/io/scalaland/chimney/internal/macros/Model.scala
@@ -30,8 +30,11 @@ trait Model extends TransformerConfigSupport {
   case class InstanceClause(matchName: Option[TermName], matchTpe: Type, body: DerivedTree) {
     def toPatMatClauseTree: Tree = {
       matchName match {
-        case Some(name) => cq"$name: $matchTpe => ${body.tree}"
-        case None       => cq"_: $matchTpe => ${body.tree}"
+        case Some(name) =>
+          // in general pat var name is not tracked whether it was used in body tree
+          // introducing synthetic val _ helps avoid reporting unused warnings in macro-generated code
+          cq"$name: $matchTpe => { val _ = $name; ${body.tree} }"
+        case None => cq"_: $matchTpe => ${body.tree}"
       }
     }
     def mapBody(f: DerivedTree => DerivedTree): InstanceClause = copy(body = f(body))

diff --git a/chimney/src/main/scala-2/io/scalaland/chimney/internal/macros/TransformerMacros.scala b/chimney/src/main/scala-2/io/scalaland/chimney/internal/macros/TransformerMacros.scala
@@ -62,7 +62,7 @@ trait TransformerMacros extends MappingMacros with TargetConstructorMacros with
       C: WeakTypeTag,
       InstanceFlags: WeakTypeTag,
       ScopeFlags: WeakTypeTag
-  ](derivationTarget: DerivationTarget)(callTransform: (Tree, Tree) => Tree): Tree = {
+  ](derivationTarget: DerivationTarget, tcTree: c.Tree)(callTransform: (Tree, Tree) => Tree): Tree = {
     val tiName = freshTermName("ti")
 
     val config = readConfig[C, InstanceFlags, ScopeFlags]
@@ -72,8 +72,11 @@ trait TransformerMacros extends MappingMacros with TargetConstructorMacros with
     val derivedTransformerTree = genTransformer[From, To](config)
 
     q"""
-       final val $tiName = ${c.prefix.tree}
+     {
+       val _ = $tcTree // hack to avoid unused warnings
+       val $tiName = ${c.prefix.tree}
        ${callTransform(derivedTransformerTree, q"$tiName.source")}
+     }
     """
   }
 

diff --git a/...src/main/scala-2/io/scalaland/chimney/internal/macros/dsl/TransformerBlackboxMacros.scala b/...src/main/scala-2/io/scalaland/chimney/internal/macros/dsl/TransformerBlackboxMacros.scala
@@ -40,9 +40,9 @@ class TransformerBlackboxMacros(val c: blackbox.Context) extends TransformerMacr
       C: WeakTypeTag,
       InstanceFlags: WeakTypeTag,
       ScopeFlags: WeakTypeTag
-  ](@unused tc: c.Tree): c.Expr[To] = {
+  ](tc: c.Tree): c.Expr[To] = {
     c.Expr[To](
-      expandTransform[From, To, C, InstanceFlags, ScopeFlags](DerivationTarget.TotalTransformer) {
+      expandTransform[From, To, C, InstanceFlags, ScopeFlags](DerivationTarget.TotalTransformer, tc) {
         (derivedTransformer, srcField) =>
           derivedTransformer.callTransform(srcField)
       }
@@ -55,9 +55,9 @@ class TransformerBlackboxMacros(val c: blackbox.Context) extends TransformerMacr
       C: WeakTypeTag,
       InstanceFlags: WeakTypeTag,
       ScopeFlags: WeakTypeTag
-  ](@unused tc: c.Tree): c.Expr[To] = {
+  ](tc: c.Tree): c.Expr[To] = {
     c.Expr[To](
-      expandTransform[From, To, C, InstanceFlags, ScopeFlags](DerivationTarget.PartialTransformer()) {
+      expandTransform[From, To, C, InstanceFlags, ScopeFlags](DerivationTarget.PartialTransformer(), tc) {
         (derivedTransformer, srcField) =>
           derivedTransformer.callPartialTransform(srcField, q"false")
       }
@@ -70,9 +70,9 @@ class TransformerBlackboxMacros(val c: blackbox.Context) extends TransformerMacr
       C: WeakTypeTag,
       InstanceFlags: WeakTypeTag,
       ScopeFlags: WeakTypeTag
-  ](@unused tc: c.Tree): c.Expr[To] = {
+  ](tc: c.Tree): c.Expr[To] = {
     c.Expr[To](
-      expandTransform[From, To, C, InstanceFlags, ScopeFlags](DerivationTarget.PartialTransformer()) {
+      expandTransform[From, To, C, InstanceFlags, ScopeFlags](DerivationTarget.PartialTransformer(), tc) {
         (derivedTransformer, srcField) =>
           derivedTransformer.callPartialTransform(srcField, q"true")
       }

diff --git a/chimney/src/test/scala-2/io/scalaland/chimney/PartialTransformerJavaBeanSpec.scala b/chimney/src/test/scala-2/io/scalaland/chimney/PartialTransformerJavaBeanSpec.scala
@@ -4,6 +4,8 @@ import utest.*
 import io.scalaland.chimney.dsl.*
 import io.scalaland.chimney.examples.javabeans.*
 
+import scala.annotation.unused
+
 object PartialTransformerJavaBeanSpec extends TestSuite {
 
   val tests = Tests {
@@ -84,7 +86,7 @@ object PartialTransformerJavaBeanSpec extends TestSuite {
           .check("", "Chimney can't derive transformation from MistypedSource to MistypedTarget")
 
         locally {
-          implicit val config = TransformerConfiguration.default.enableBeanGetters
+          @unused implicit val config = TransformerConfiguration.default.enableBeanGetters
 
           compileError("""
                case class MistypedTarget(flag: Int)
@@ -101,7 +103,7 @@ object PartialTransformerJavaBeanSpec extends TestSuite {
     test("""flag .disableBeanGetters""") {
 
       test("should disable globally enabled .enableBeanGetters") {
-        implicit val config = TransformerConfiguration.default.enableBeanGetters
+        @unused implicit val config = TransformerConfiguration.default.enableBeanGetters
 
         compileError(
           """
@@ -156,7 +158,7 @@ object PartialTransformerJavaBeanSpec extends TestSuite {
           )
 
         locally {
-          implicit val config = TransformerConfiguration.default.enableBeanSetters
+          @unused implicit val config = TransformerConfiguration.default.enableBeanSetters
 
           compileError("""
               CaseClassNoFlag("100", "name")
@@ -187,7 +189,7 @@ object PartialTransformerJavaBeanSpec extends TestSuite {
           )
 
         locally {
-          implicit val config = TransformerConfiguration.default.enableBeanSetters
+          @unused implicit val config = TransformerConfiguration.default.enableBeanSetters
 
           compileError("""
               CaseClassWithFlagMethod("100", "name")
@@ -229,7 +231,7 @@ object PartialTransformerJavaBeanSpec extends TestSuite {
     test("""flag .disableBeanSetters""") {
 
       test("should disable globally enabled .enableBeanSetters") {
-        implicit val config = TransformerConfiguration.default.enableBeanSetters
+        @unused implicit val config = TransformerConfiguration.default.enableBeanSetters
 
         compileError("""
             CaseClassWithFlag("100", "name", flag = true)
@@ -279,7 +281,7 @@ object PartialTransformerJavaBeanSpec extends TestSuite {
     test("""flag .enableMethodAccessors""") {
 
       test("should disable globally enabled .MethodAccessors") {
-        implicit val config = TransformerConfiguration.default.enableMethodAccessors
+        @unused implicit val config = TransformerConfiguration.default.enableMethodAccessors
 
         compileError("""
             CaseClassWithFlagMethod("100", "name")

diff --git a/chimney/src/test/scala-2/io/scalaland/chimney/PartialTransformerProductSpec.scala b/chimney/src/test/scala-2/io/scalaland/chimney/PartialTransformerProductSpec.scala
@@ -5,6 +5,8 @@ import io.scalaland.chimney.examples.*
 import io.scalaland.chimney.utils.OptionUtils.*
 import utest.*
 
+import scala.annotation.unused
+
 object PartialTransformerProductSpec extends TestSuite {
 
   val tests = Tests {
@@ -661,7 +663,7 @@ object PartialTransformerProductSpec extends TestSuite {
       test("should disable globally enabled .enableDefaultValues") {
         import products.Defaults.*
 
-        implicit val config = TransformerConfiguration.default.enableDefaultValues
+        @unused implicit val config = TransformerConfiguration.default.enableDefaultValues
 
         compileError("""Source(1, "yy", 1.0).intoPartial[Target].disableDefaultValues.transform""").check(
           "",

diff --git a/chimney/src/test/scala-2/io/scalaland/chimney/PartialTransformerStdLibTypesSpec.scala b/chimney/src/test/scala-2/io/scalaland/chimney/PartialTransformerStdLibTypesSpec.scala
@@ -4,7 +4,6 @@ import io.scalaland.chimney.dsl.*
 import io.scalaland.chimney.utils.OptionUtils.*
 import utest.*
 
-import scala.annotation.unused
 import scala.collection.immutable.Queue
 import scala.collection.mutable.ArrayBuffer
 

diff --git a/chimney/src/test/scala-2/io/scalaland/chimney/TotalTransformerJavaBeansSpec.scala b/chimney/src/test/scala-2/io/scalaland/chimney/TotalTransformerJavaBeansSpec.scala
@@ -4,6 +4,8 @@ import utest.*
 import io.scalaland.chimney.dsl.*
 import io.scalaland.chimney.examples.javabeans.*
 
+import scala.annotation.unused
+
 object TotalTransformerJavaBeansSpec extends TestSuite {
 
   val tests = Tests {
@@ -78,7 +80,7 @@ object TotalTransformerJavaBeansSpec extends TestSuite {
           .check("", "Chimney can't derive transformation from MistypedSource to MistypedTarget")
 
         locally {
-          implicit val config = TransformerConfiguration.default.enableBeanGetters
+          @unused implicit val config = TransformerConfiguration.default.enableBeanGetters
 
           compileError("""
                case class MistypedTarget(flag: Int)
@@ -95,7 +97,7 @@ object TotalTransformerJavaBeansSpec extends TestSuite {
     test("""flag .disableBeanGetters""") {
 
       test("should disable globally enabled .enableBeanGetters") {
-        implicit val config = TransformerConfiguration.default.enableBeanGetters
+        @unused implicit val config = TransformerConfiguration.default.enableBeanGetters
 
         compileError(
           """
@@ -148,7 +150,7 @@ object TotalTransformerJavaBeansSpec extends TestSuite {
           )
 
         locally {
-          implicit val config = TransformerConfiguration.default.enableBeanSetters
+          @unused implicit val config = TransformerConfiguration.default.enableBeanSetters
 
           compileError("""
               CaseClassNoFlag("100", "name")
@@ -179,7 +181,7 @@ object TotalTransformerJavaBeansSpec extends TestSuite {
           )
 
         locally {
-          implicit val config = TransformerConfiguration.default.enableBeanSetters
+          @unused implicit val config = TransformerConfiguration.default.enableBeanSetters
 
           compileError("""
               CaseClassWithFlagMethod("100", "name")
@@ -219,7 +221,7 @@ object TotalTransformerJavaBeansSpec extends TestSuite {
     test("""flag .disableBeanSetters""") {
 
       test("should disable globally enabled .enableBeanSetters") {
-        implicit val config = TransformerConfiguration.default.enableBeanSetters
+        @unused implicit val config = TransformerConfiguration.default.enableBeanSetters
 
         compileError("""
             CaseClassWithFlag("100", "name", flag = true)
@@ -267,7 +269,7 @@ object TotalTransformerJavaBeansSpec extends TestSuite {
     test("""flag .enableMethodAccessors""") {
 
       test("should disable globally enabled .MethodAccessors") {
-        implicit val config = TransformerConfiguration.default.enableMethodAccessors
+        @unused implicit val config = TransformerConfiguration.default.enableMethodAccessors
 
         compileError("""
             CaseClassWithFlagMethod("100", "name")

diff --git a/chimney/src/test/scala-2/io/scalaland/chimney/TotalTransformerProductSpec.scala b/chimney/src/test/scala-2/io/scalaland/chimney/TotalTransformerProductSpec.scala
@@ -4,6 +4,8 @@ import io.scalaland.chimney.dsl.*
 import io.scalaland.chimney.examples.*
 import utest.*
 
+import scala.annotation.unused
+
 object TotalTransformerProductSpec extends TestSuite {
 
   val tests = Tests {
@@ -327,7 +329,7 @@ object TotalTransformerProductSpec extends TestSuite {
       test("should disable globally enabled .enableDefaultValues") {
         import products.Defaults.*
 
-        implicit val config = TransformerConfiguration.default.enableDefaultValues
+        @unused implicit val config = TransformerConfiguration.default.enableDefaultValues
 
         compileError("""Source(1, "yy", 1.0).into[Target].disableDefaultValues.transform""").check(
           "",

diff --git a/chimneyCats/src/main/scala-2/io/scalaland/chimney/cats/CatsPartialTransformerImplicits.scala b/chimneyCats/src/main/scala-2/io/scalaland/chimney/cats/CatsPartialTransformerImplicits.scala
@@ -5,7 +5,6 @@ import _root_.cats.kernel.Semigroup
 import _root_.cats.Applicative
 import io.scalaland.chimney.partial
 
-import scala.collection.compat.*
 import language.implicitConversions
 
 /** @since 0.7.0 */

diff --git a/...c/test/scala-2/io/scalaland/chimney/cats/PartialTransformerResultErrorSemigroupSpec.scala b/...c/test/scala-2/io/scalaland/chimney/cats/PartialTransformerResultErrorSemigroupSpec.scala
@@ -1,7 +1,7 @@
 package io.scalaland.chimney.cats
 
 import _root_.cats.syntax.semigroup.*
-import io.scalaland.chimney.{partial, PartialTransformer}
+import io.scalaland.chimney.partial
 import utest.*
 
 object PartialTransformerResultErrorSemigroupSpec extends TestSuite {

diff --git a/.../src/test/scala-2/io/scalaland/chimney/cats/PartialTransformerResultSemigroupalSpec.scala b/.../src/test/scala-2/io/scalaland/chimney/cats/PartialTransformerResultSemigroupalSpec.scala
@@ -1,7 +1,7 @@
 package io.scalaland.chimney.cats
 
 import _root_.cats.syntax.semigroupal.*
-import io.scalaland.chimney.{partial, PartialTransformer}
+import io.scalaland.chimney.partial
 import utest.*
 
 object PartialTransformerResultSemigroupalSpec extends TestSuite {

diff --git a/...c/test/scala-2/io/scalaland/chimney/cats/PartialTransformerToCatsDataConversionSpec.scala b/...c/test/scala-2/io/scalaland/chimney/cats/PartialTransformerToCatsDataConversionSpec.scala
@@ -6,7 +6,6 @@ import _root_.cats.syntax.semigroup.*
 import _root_.cats.syntax.semigroupal.*
 import cats.Semigroupal
 import io.scalaland.chimney.partial
-import io.scalaland.chimney.PartialTransformer
 import io.scalaland.chimney.partial.{Error, PathElement}
 import io.scalaland.chimney.dsl.*
 import io.scalaland.chimney.examples.trip.*