Deprecate Possible (#992)

optics-dev · Dec 17, 2020 · 71cb474 · 71cb474
1 parent 6613da3
commit 71cb474
Show file tree

Hide file tree

Showing 8 changed files with 17 additions and 5 deletions.
diff --git a/build.sbt b/build.sbt
@@ -73,6 +73,7 @@ lazy val buildSettings = Seq(
       "-Wconf:msg=class Field4 in package function is deprecated:i",
       "-Wconf:msg=class Field5 in package function is deprecated:i",
       "-Wconf:msg=class Field6 in package function is deprecated:i",
+      "-Wconf:msg=class Possible in package function is deprecated:i",
       "-Wconf:msg=class Reverse in package function is deprecated:i",
       "-Wconf:msg=class Snoc in package function is deprecated:i",
       "-Wconf:msg=class Snoc1 in package function is deprecated:i",

diff --git a/core/shared/src/main/scala/monocle/function/Possible.scala b/core/shared/src/main/scala/monocle/function/Possible.scala
@@ -10,11 +10,13 @@ import cats.data.Validated
   * @tparam S source of the [[Optional]]
   * @tparam A target of the [[Optional]], `A` is supposed to be unique for a given `S`
   */
+@deprecated("no replacement", since = "3.0.0-M1")
 abstract class Possible[S, A] extends Serializable {
   def possible: Optional[S, A]
 }
 
 trait PossibleFunctions {
+  @deprecated("no replacement", since = "3.0.0-M1")
   def possible[S, A](implicit ev: Possible[S, A]): Optional[S, A] = ev.possible
 }
 

diff --git a/law/src/main/scala/monocle/law/discipline/function/PossibleTests.scala b/law/src/main/scala/monocle/law/discipline/function/PossibleTests.scala
@@ -8,6 +8,7 @@ import org.typelevel.discipline.Laws
 
 import cats.Eq
 
+@deprecated("no replacement", since = "3.0.0-M1")
 object PossibleTests extends Laws {
   def apply[S: Eq: Arbitrary, A: Eq: Arbitrary](implicit
     evPossible: Possible[S, A],

diff --git a/test/shared/src/test/scala/monocle/function/PossibleSpec.scala b/test/shared/src/test/scala/monocle/function/PossibleSpec.scala
@@ -5,6 +5,9 @@ import monocle.MonocleSuite
 import monocle.law.discipline.function.PossibleTests
 import Possible.optionPossible
 
+import scala.annotation.nowarn
+
+@nowarn
 class PossibleSpec extends MonocleSuite {
   implicit def optionEitherPossible[A]: Possible[Either[Unit, A], A] =
     Possible.fromIso(Iso[Either[Unit, A], Option[A]] {

diff --git a/test/shared/src/test/scala/monocle/std/EitherSpec.scala b/test/shared/src/test/scala/monocle/std/EitherSpec.scala
@@ -4,9 +4,11 @@ import monocle.MonocleSuite
 import monocle.law.discipline.PrismTests
 import monocle.law.discipline.function.{EachTests, PossibleTests}
 
+import scala.annotation.nowarn
+
 class EitherSpec extends MonocleSuite {
   checkAll("either left", PrismTests(stdLeft[String, Int]))
   checkAll("either right", PrismTests(stdRight[String, String]))
   checkAll("each Either", EachTests[Either[Unit, Int], Int])
-  checkAll("possible Either", PossibleTests[Either[Unit, Int], Int])
+  checkAll("possible Either", PossibleTests[Either[Unit, Int], Int]): @nowarn
 }
diff --git a/test/shared/src/test/scala/monocle/std/OptionSpec.scala b/test/shared/src/test/scala/monocle/std/OptionSpec.scala
@@ -15,7 +15,7 @@ class OptionSpec extends MonocleSuite {
   checkAll("pOptionToDisjunction", IsoTests(pOptionToDisjunction[Int, Int]))
 
   checkAll("each Option", EachTests[Option[Int], Int])
-  checkAll("possible Option", PossibleTests[Option[Int], Int])
+  checkAll("possible Option", PossibleTests[Option[Int], Int]): @nowarn
   checkAll("empty Option", EmptyTests[Option[Int]]): @nowarn
 
   case class IntNoZero(value: Int)

diff --git a/test/shared/src/test/scala/monocle/std/TrySpec.scala b/test/shared/src/test/scala/monocle/std/TrySpec.scala
@@ -5,9 +5,10 @@ import monocle.law.discipline.PrismTests
 import monocle.law.discipline.function.{EachTests, PossibleTests}
 
 import scala.util.Try
-
 import cats.Eq
 
+import scala.annotation.nowarn
+
 class TrySpec extends MonocleSuite {
   implicit private def tryEqual[A]: Eq[Try[A]] =
     Eq.fromUniversalEquals[Try[A]]
@@ -18,5 +19,5 @@ class TrySpec extends MonocleSuite {
   checkAll("trySuccess", PrismTests(monocle.std.utilTry.trySuccess[Int]))
   checkAll("tryFailure", PrismTests(monocle.std.utilTry.tryFailure[Int]))
   checkAll("each Try", EachTests[Try[Int], Int])
-  checkAll("possible Try", PossibleTests[Try[Int], Int])
+  checkAll("possible Try", PossibleTests[Try[Int], Int]): @nowarn
 }
diff --git a/test/shared/src/test/scala/monocle/std/ValidatedSpec.scala b/test/shared/src/test/scala/monocle/std/ValidatedSpec.scala
@@ -5,6 +5,8 @@ import monocle.law.discipline.{IsoTests, PrismTests}
 import monocle.law.discipline.function.{EachTests, PossibleTests}
 import cats.data.Validated
 
+import scala.annotation.nowarn
+
 class ValidatedSpec extends MonocleSuite {
   import cats.laws.discipline.arbitrary._
 
@@ -15,5 +17,5 @@ class ValidatedSpec extends MonocleSuite {
   checkAll("success", PrismTests(monocle.std.validated.success[String, Int]))
   checkAll("failure", PrismTests(monocle.std.validated.failure[String, Int]))
   checkAll("each Validated", EachTests[Validated[Unit, Int], Int])
-  checkAll("possible Validated", PossibleTests[Validated[Unit, Int], Int])
+  checkAll("possible Validated", PossibleTests[Validated[Unit, Int], Int]): @nowarn
 }