Backport #3126 Remove Order constraint from Hash instance for Sor…

…tedSet (#3339) * backported #3126 removed `Order` constraint from `Hash` instance for `SortedSet`
typelevel · Mar 10, 2020 · 8227961 · 8227961
1 parent 29efba5
commit 8227961
Show file tree

Hide file tree

Showing 7 changed files with 39 additions and 12 deletions.
diff --git a/core/src/main/scala/cats/instances/all.scala b/core/src/main/scala/cats/instances/all.scala
@@ -69,3 +69,4 @@ trait AllInstancesBinCompat7
     with VectorInstancesBinCompat1
     with EitherInstancesBinCompat0
     with StreamInstancesBinCompat1
+    with SortedSetInstancesBinCompat2
diff --git a/core/src/main/scala/cats/instances/package.scala b/core/src/main/scala/cats/instances/package.scala
@@ -36,7 +36,11 @@ package object instances {
       with SortedMapInstancesBinCompat0
       with SortedMapInstancesBinCompat1
       with SortedMapInstancesBinCompat2
-  object sortedSet extends SortedSetInstances with SortedSetInstancesBinCompat0 with SortedSetInstancesBinCompat1
+  object sortedSet
+      extends SortedSetInstances
+      with SortedSetInstancesBinCompat0
+      with SortedSetInstancesBinCompat1
+      with SortedSetInstancesBinCompat2
   object stream extends StreamInstances with StreamInstancesBinCompat0 with StreamInstancesBinCompat1
   object string extends StringInstances
   object try_ extends TryInstances

diff --git a/core/src/main/scala/cats/instances/sortedSet.scala b/core/src/main/scala/cats/instances/sortedSet.scala
@@ -2,8 +2,9 @@ package cats
 package instances
 
 import cats.kernel.{BoundedSemilattice, Hash, Order}
-import scala.collection.immutable.SortedSet
+
 import scala.annotation.tailrec
+import scala.collection.immutable.SortedSet
 
 trait SortedSetInstances extends SortedSetInstances1 {
 
@@ -73,7 +74,7 @@ trait SortedSetInstances extends SortedSetInstances1 {
 private[instances] trait SortedSetInstances1 {
   @deprecated("Use cats.kernel.instances.sortedSet.catsKernelStdHashForSortedSet", "2.0.0-RC2")
   private[instances] def catsKernelStdHashForSortedSet[A: Order: Hash]: Hash[SortedSet[A]] =
-    cats.kernel.instances.sortedSet.catsKernelStdHashForSortedSet[A]
+    cats.kernel.instances.sortedSet.catsKernelStdHashForSortedSet[A](Hash[A])
 
   @deprecated("Use cats.kernel.instances.sortedSet.catsKernelStdSemilatticeForSortedSet", "2.0.0-RC2")
   def catsKernelStdSemilatticeForSortedSet[A: Order]: BoundedSemilattice[SortedSet[A]] =
@@ -93,8 +94,9 @@ private[instances] trait SortedSetInstancesBinCompat0 {
 
 private[instances] trait SortedSetInstancesBinCompat1 extends LowPrioritySortedSetInstancesBinCompat1 {
   // TODO: Remove when this is no longer necessary for binary compatibility.
-  implicit override def catsKernelStdHashForSortedSet[A: Order: Hash]: Hash[SortedSet[A]] =
-    cats.kernel.instances.sortedSet.catsKernelStdHashForSortedSet[A]
+  @deprecated("Use cats.kernel.instances.sortedSet.catsKernelStdHashForSortedSet", "2.0.0-RC2")
+  override def catsKernelStdHashForSortedSet[A: Order: Hash]: Hash[SortedSet[A]] =
+    cats.kernel.instances.sortedSet.catsKernelStdHashForSortedSet(Hash[A])
 }
 
 private[instances] trait LowPrioritySortedSetInstancesBinCompat1
@@ -103,8 +105,14 @@ private[instances] trait LowPrioritySortedSetInstancesBinCompat1
   implicit override def catsKernelStdOrderForSortedSet[A: Order]: Order[SortedSet[A]] =
     cats.kernel.instances.sortedSet.catsKernelStdOrderForSortedSet[A]
 
+  @deprecated("Use cats.kernel.instances.sortedSet.catsKernelStdHashForSortedSet", "2.0.0-RC2")
   override def catsKernelStdHashForSortedSet[A: Order: Hash]: Hash[SortedSet[A]] =
-    cats.kernel.instances.sortedSet.catsKernelStdHashForSortedSet[A]
+    cats.kernel.instances.sortedSet.catsKernelStdHashForSortedSet(Hash[A])
+}
+
+private[instances] trait SortedSetInstancesBinCompat2 extends SortedSetInstancesBinCompat1 {
+  implicit def catsKernelStdHashForSortedSet[A: Hash]: Hash[SortedSet[A]] =
+    cats.kernel.instances.sortedSet.catsKernelStdHashForSortedSet[A](Hash[A])
 }
 
 @deprecated("Use cats.kernel.instances.SortedSetHash", "2.0.0-RC2")

diff --git a/kernel/src/main/scala/cats/kernel/instances/AllInstances.scala b/kernel/src/main/scala/cats/kernel/instances/AllInstances.scala
@@ -36,3 +36,5 @@ trait AllInstances
 private[instances] trait AllInstancesBinCompat0 extends FiniteDurationInstances
 
 private[instances] trait AllInstancesBinCompat1 extends SortedMapInstances with SortedSetInstances
+
+private[instances] trait AllInstancesBinCompat2 extends SortedSetInstances2
diff --git a/kernel/src/main/scala/cats/kernel/instances/SortedSetInstances.scala b/kernel/src/main/scala/cats/kernel/instances/SortedSetInstances.scala
@@ -1,11 +1,11 @@
 package cats.kernel
 package instances
 
-import cats.kernel.{BoundedSemilattice, Hash, Order}
 import scala.collection.immutable.SortedSet
 
 trait SortedSetInstances extends SortedSetInstances1 {
-  implicit def catsKernelStdHashForSortedSet[A: Order: Hash]: Hash[SortedSet[A]] =
+  @deprecated("Use catsKernelStdHashForSortedSet without Order", "2.1.0")
+  def catsKernelStdHashForSortedSet[A: Order: Hash]: Hash[SortedSet[A]] =
     new SortedSetHash[A]
 }
 
@@ -17,6 +17,11 @@ private[instances] trait SortedSetInstances1 {
     new SortedSetSemilattice[A]
 }
 
+private[instances] trait SortedSetInstances2 extends SortedSetInstances1 {
+  implicit def catsKernelStdHashForSortedSet[A: Hash]: Hash[SortedSet[A]] =
+    new SortedSetHash[A]
+}
+
 class SortedSetOrder[A: Order] extends Order[SortedSet[A]] {
   def compare(a1: SortedSet[A], a2: SortedSet[A]): Int =
     cats.kernel.instances.int.catsKernelStdOrderForInt.compare(a1.size, a2.size) match {
@@ -28,9 +33,12 @@ class SortedSetOrder[A: Order] extends Order[SortedSet[A]] {
     StaticMethods.iteratorEq(s1.iterator, s2.iterator)
 }
 
-class SortedSetHash[A: Order: Hash] extends Hash[SortedSet[A]] {
+class SortedSetHash[A](implicit hashA: Hash[A]) extends Hash[SortedSet[A]] {
   import scala.util.hashing.MurmurHash3._
 
+  @deprecated("Use the constructor _without_ Order instead, since Order is not required", "2.1.0")
+  private[instances] def this(o: Order[A], h: Hash[A]) = this()(h)
+
   // adapted from [[scala.util.hashing.MurmurHash3]],
   // but modified standard `Any#hashCode` to `ev.hash`.
   def hash(xs: SortedSet[A]): Int = {
@@ -50,7 +58,7 @@ class SortedSetHash[A: Order: Hash] extends Hash[SortedSet[A]] {
     finalizeHash(h, n)
   }
   override def eqv(s1: SortedSet[A], s2: SortedSet[A]): Boolean =
-    StaticMethods.iteratorEq(s1.iterator, s2.iterator)(Order[A])
+    StaticMethods.iteratorEq(s1.iterator, s2.iterator)(Eq[A])
 }
 
 class SortedSetSemilattice[A: Order] extends BoundedSemilattice[SortedSet[A]] {

diff --git a/kernel/src/main/scala/cats/kernel/instances/all/package.scala b/kernel/src/main/scala/cats/kernel/instances/all/package.scala
@@ -1,4 +1,8 @@
 package cats.kernel
 package instances
 
-package object all extends AllInstances with AllInstancesBinCompat0 with AllInstancesBinCompat1
+package object all
+    extends AllInstances
+    with AllInstancesBinCompat0
+    with AllInstancesBinCompat1
+    with AllInstancesBinCompat2
diff --git a/kernel/src/main/scala/cats/kernel/instances/sortedSet/package.scala b/kernel/src/main/scala/cats/kernel/instances/sortedSet/package.scala
@@ -1,4 +1,4 @@
 package cats.kernel
 package instances
 
-package object sortedSet extends SortedSetInstances
+package object sortedSet extends SortedSetInstances with SortedSetInstances2