Add {Write.Read}.generic back to help migrate from earlier versions

These methods are used by users to derive instances explicitly in previous versions. The implicit keywords are removed so they don't affect implicit search
typelevel · Sep 17, 2024 · 311a250 · 311a250
1 parent 03f944d
commit 311a250
Show file tree

Hide file tree

Showing 11 changed files with 39 additions and 36 deletions.
diff --git a/...ain/scala-2/doobie/util/GetPlatform.scala → ...n/scala-2/doobie/util/MkGetPlatform.scala b/...ain/scala-2/doobie/util/GetPlatform.scala → ...n/scala-2/doobie/util/MkGetPlatform.scala
@@ -7,7 +7,7 @@ package doobie.util
 import shapeless._
 import shapeless.ops.hlist.IsHCons
 
-trait GetPlatform {
+trait MkGetPlatform {
   import doobie.util.compat.=:=
 
   /** @group Instances */

diff --git a/...ain/scala-2/doobie/util/PutPlatform.scala → ...n/scala-2/doobie/util/MkPutPlatform.scala b/...ain/scala-2/doobie/util/PutPlatform.scala → ...n/scala-2/doobie/util/MkPutPlatform.scala
@@ -7,7 +7,7 @@ package doobie.util
 import shapeless._
 import shapeless.ops.hlist.IsHCons
 
-trait PutPlatform {
+trait MkPutPlatform {
   import doobie.util.compat.=:=
 
   /** @group Instances */

diff --git a/modules/core/src/main/scala-2/doobie/util/ReadPlatform.scala b/modules/core/src/main/scala-2/doobie/util/ReadPlatform.scala
@@ -29,4 +29,7 @@ trait ReadPlatform {
     MkRead.ogeneric[A, Repr]
   }
 
+  @deprecated("Use Read.derived instead to derive instances explicitly", "1.0.0-RC6")
+  def generic[T, Repr](implicit gen: Generic.Aux[T, Repr], G: Lazy[MkRead[Repr]]): MkRead[T] =
+    MkRead.generic[T, Repr]
 }
diff --git a/modules/core/src/main/scala-2/doobie/util/WritePlatform.scala b/modules/core/src/main/scala-2/doobie/util/WritePlatform.scala
@@ -27,4 +27,8 @@ trait WritePlatform {
     val _ = isTuple
     MkWrite.ogeneric[A, Repr]
   }
+
+  @deprecated("Use Write.derived instead to derive instances explicitly", "1.0.0-RC6")
+  def generic[T, Repr](implicit gen: Generic.Aux[T, Repr], A: Lazy[MkWrite[Repr]]): MkWrite[T] =
+    MkWrite.generic[T, Repr]
 }
diff --git a/...ain/scala-3/doobie/util/GetPlatform.scala → ...n/scala-3/doobie/util/MkGetPlatform.scala b/...ain/scala-3/doobie/util/GetPlatform.scala → ...n/scala-3/doobie/util/MkGetPlatform.scala
@@ -6,10 +6,10 @@ package doobie.util
 
 import scala.deriving.Mirror
 
-trait GetPlatform:
+trait MkGetPlatform:
 
   // Get is available for single-element products.
-  given x[P <: Product, A](
+  given unaryProductGet[P <: Product, A](
       using
       p: Mirror.ProductOf[P],
       i: p.MirroredElemTypes =:= (A *: EmptyTuple),

diff --git a/...ain/scala-3/doobie/util/PutPlatform.scala → ...n/scala-3/doobie/util/MkPutPlatform.scala b/...ain/scala-3/doobie/util/PutPlatform.scala → ...n/scala-3/doobie/util/MkPutPlatform.scala
@@ -6,10 +6,10 @@ package doobie.util
 
 import scala.deriving.Mirror
 
-trait PutPlatform:
+trait MkPutPlatform:
 
   // Put is available for single-element products.
-  given [P <: Product, A](
+  given unaryProductPut[P <: Product, A](
       using
       m: Mirror.ProductOf[P],
       i: m.MirroredElemTypes =:= (A *: EmptyTuple),

diff --git a/modules/core/src/main/scala/doobie/util/get.scala b/modules/core/src/main/scala/doobie/util/get.scala
@@ -80,7 +80,7 @@ sealed abstract class Get[A](
 
 }
 
-object Get extends GetInstances {
+object Get extends GetInstances with GetPlatform {
 
   def apply[A](implicit ev: Get[A]): ev.type = ev
 
@@ -221,7 +221,8 @@ sealed abstract class MkGet[A](
     override val vendorTypeNames: List[String],
     override val get: Coyoneda[(ResultSet, Int) => *, A]
 ) extends Get[A](typeStack, jdbcSources, jdbcSourceSecondary, vendorTypeNames, get)
-object MkGet extends GetPlatform {
+
+object MkGet extends MkGetPlatform {
 
   def lift[A](g: Get[A]): MkGet[A] =
     new MkGet[A](

diff --git a/modules/core/src/main/scala/doobie/util/put.scala b/modules/core/src/main/scala/doobie/util/put.scala
@@ -82,7 +82,7 @@ sealed abstract class Put[A](
 
 }
 
-object Put extends PutInstances {
+object Put extends PutInstances with PutPlatform {
 
   def apply[A](implicit ev: Put[A]): ev.type = ev
 
@@ -234,7 +234,8 @@ sealed abstract class MkPut[A](
     override val put: ContravariantCoyoneda[(PreparedStatement, Int, *) => Unit, A],
     override val update: ContravariantCoyoneda[(ResultSet, Int, *) => Unit, A]
 ) extends Put[A](typeStack, jdbcTargets, vendorTypeNames, put, update)
-object MkPut extends PutPlatform {
+
+object MkPut extends MkPutPlatform {
 
   def lift[A](g: Put[A]): MkPut[A] =
     new MkPut[A](

diff --git a/modules/core/src/test/scala-2/doobie/util/GetSuitePlatform.scala b/modules/core/src/test/scala-2/doobie/util/GetSuitePlatform.scala
@@ -3,26 +3,27 @@
 // For more information see LICENSE or https://opensource.org/licenses/MIT
 
 package doobie.util
-import doobie.testutils.VoidExtensions
-
-object GetSuitePlatform {
-  final case class Y(x: String) extends AnyVal
-  final case class P(x: Int) extends AnyVal
-}
+import doobie.testutils.{VoidExtensions, assertContains}
+import doobie.testutils.TestClasses.{CCIntString, PlainObj, CCAnyVal}
 
 trait GetSuitePlatform { self: munit.FunSuite =>
-  import GetSuitePlatform._
 
   test("Get can be auto derived for unary products (AnyVal)") {
-    import doobie.generic.auto._
+    import doobie.generic.auto.*
 
-    Get[Y].void
-    Get[P].void
+    Get[CCAnyVal].void
   }
 
   test("Get can be explicitly derived for unary products (AnyVal)") {
-    Get.derived[Y].void
-    Get.derived[P].void
+    Get.derived[CCAnyVal].void
+  }
+
+  test("Get should not be derived for non-unary products") {
+    import doobie.generic.auto.*
+
+    assertContains(compileErrors("Get[CCIntString]"), "implicit value")
+    assertContains(compileErrors("Get[(Int, Int)]"), "implicit value")
+    assertContains(compileErrors("Get[PlainObj.type]"), "implicit value")
   }
 
 }
diff --git a/modules/core/src/test/scala-2/doobie/util/PutSuitePlatform.scala b/modules/core/src/test/scala-2/doobie/util/PutSuitePlatform.scala
@@ -4,30 +4,21 @@
 
 package doobie.util
 import doobie.testutils.{VoidExtensions, assertContains}
-
-object PutSuitePlatform {
-  final case class Y(x: String) extends AnyVal
-  final case class P(x: Int) extends AnyVal
-}
+import doobie.testutils.TestClasses.{CCIntString, PlainObj, CCAnyVal}
 
 trait PutSuitePlatform { self: munit.FunSuite =>
-  import PutSuitePlatform._
-
   test("Put can be auto derived for unary products (AnyVal)") {
-    import doobie.generic.auto._
+    import doobie.generic.auto.*
 
-    Put[Y].void
-    Put[P].void
+    Put[CCAnyVal].void
   }
 
   test("Put can be explicitly derived for unary products (AnyVal)") {
-    Put.derived[Y].void
-    Put.derived[P].void
+    Put.derived[CCAnyVal].void
   }
 
   test("Put should not be derived for non-unary products") {
-    import doobie.generic.auto._
-    import doobie.testutils.TestClasses.{CCIntString, PlainObj}
+    import doobie.generic.auto.*
 
     assertContains(compileErrors("Put[CCIntString]"), "implicit value")
     assertContains(compileErrors("Put[(Int, Int)]"), "implicit value")

diff --git a/modules/testutils/src/test/scala/doobie/testutils/TestClasses.scala b/modules/testutils/src/test/scala/doobie/testutils/TestClasses.scala
@@ -16,5 +16,7 @@ object TestClasses {
 
   case class CCIntString(i: Int, s: String)
 
+  case class CCAnyVal(s: String) extends AnyVal
+
   object PlainObj
 }