Rename Set#{sub,super}set? to {sub,super}set_of? (#10187)

crystal-lang · Jan 15, 2021 · 9d7e162 · 9d7e162
1 parent 7305fa8
commit 9d7e162
Show file tree

Hide file tree

Showing 2 changed files with 82 additions and 6 deletions.
diff --git a/spec/std/set_spec.cr b/spec/std/set_spec.cr
@@ -354,6 +354,20 @@ describe "Set" do
     empty_set.subset?(empty_set).should be_true
   end
 
+  it "#subset_of?" do
+    set = Set{1, 2, 3}
+    empty_set = Set(Int32).new
+
+    set.subset_of?(Set{1, 2, 3, 4}).should be_true
+    set.subset_of?(Set{1, 2, 3, "4"}).should be_true
+    set.subset_of?(Set{1, 2, 3}).should be_true
+    set.subset_of?(Set{1, 2}).should be_false
+    set.subset_of?(empty_set).should be_false
+
+    empty_set.subset_of?(Set{1}).should be_true
+    empty_set.subset_of?(empty_set).should be_true
+  end
+
   it "check proper_subset" do
     set = Set{1, 2, 3}
     empty_set = Set(Int32).new
@@ -368,6 +382,20 @@ describe "Set" do
     empty_set.proper_subset?(empty_set).should be_false
   end
 
+  it "#proper_subset_of?" do
+    set = Set{1, 2, 3}
+    empty_set = Set(Int32).new
+
+    set.proper_subset_of?(Set{1, 2, 3, 4}).should be_true
+    set.proper_subset_of?(Set{1, 2, 3, "4"}).should be_true
+    set.proper_subset_of?(Set{1, 2, 3}).should be_false
+    set.proper_subset_of?(Set{1, 2}).should be_false
+    set.proper_subset_of?(empty_set).should be_false
+
+    empty_set.proper_subset_of?(Set{1}).should be_true
+    empty_set.proper_subset_of?(empty_set).should be_false
+  end
+
   it "check superset" do
     set = Set{1, 2, "3"}
     empty_set = Set(Int32).new
@@ -382,6 +410,20 @@ describe "Set" do
     empty_set.superset?(empty_set).should be_true
   end
 
+  it "#superset_of?" do
+    set = Set{1, 2, "3"}
+    empty_set = Set(Int32).new
+
+    set.superset_of?(empty_set).should be_true
+    set.superset_of?(Set{1, 2}).should be_true
+    set.superset_of?(Set{1, 2, "3"}).should be_true
+    set.superset_of?(Set{1, 2, 3}).should be_false
+    set.superset_of?(Set{1, 2, 3, 4}).should be_false
+    set.superset_of?(Set{1, 4}).should be_false
+
+    empty_set.superset_of?(empty_set).should be_true
+  end
+
   it "check proper_superset" do
     set = Set{1, 2, "3"}
     empty_set = Set(Int32).new
@@ -396,6 +438,20 @@ describe "Set" do
     empty_set.proper_superset?(empty_set).should be_false
   end
 
+  it "#proper_superset_of?" do
+    set = Set{1, 2, "3"}
+    empty_set = Set(Int32).new
+
+    set.proper_superset_of?(empty_set).should be_true
+    set.proper_superset_of?(Set{1, 2}).should be_true
+    set.proper_superset_of?(Set{1, 2, "3"}).should be_false
+    set.proper_superset_of?(Set{1, 2, 3}).should be_false
+    set.proper_superset_of?(Set{1, 2, 3, 4}).should be_false
+    set.proper_superset_of?(Set{1, 4}).should be_false
+
+    empty_set.proper_superset_of?(empty_set).should be_false
+  end
+
   it "has object_id" do
     Set(Int32).new.object_id.should be > 0
   end

diff --git a/src/set.cr b/src/set.cr
@@ -17,8 +17,8 @@
 # s1 == s3 # => true
 # s1.add(2)
 # s1.concat([6, 8])
-# s1.subset? s2 # => false
-# s2.subset? s1 # => true
+# s1.subset_of? s2 # => false
+# s2.subset_of? s1 # => true
 # ```
 struct Set(T)
   include Enumerable(T)
@@ -418,11 +418,16 @@ struct Set(T)
   # Set{1, 5}.subset? Set{1, 3, 5}    # => true
   # Set{1, 3, 5}.subset? Set{1, 3, 5} # => true
   # ```
-  def subset?(other : Set)
+  def subset_of?(other : Set)
     return false if other.size < size
     all? { |value| other.includes?(value) }
   end
 
+  @[Deprecated("Use #subset_of? instead.")]
+  def subset?(other : Set)
+    subset_of?(other)
+  end
+
   # Returns `true` if the set is a proper subset of the *other* set.
   #
   # This set must have fewer elements than the *other* set, and all
@@ -432,11 +437,16 @@ struct Set(T)
   # Set{1, 5}.proper_subset? Set{1, 3, 5}    # => true
   # Set{1, 3, 5}.proper_subset? Set{1, 3, 5} # => false
   # ```
-  def proper_subset?(other : Set)
+  def proper_subset_of?(other : Set)
     return false if other.size <= size
     all? { |value| other.includes?(value) }
   end
 
+  @[Deprecated("Use #proper_subset_of? instead.")]
+  def proper_subset?(other : Set)
+    proper_subset_of?(other)
+  end
+
   # Returns `true` if the set is a superset of the *other* set.
   #
   # The *other* must have the same or fewer elements than this set, and all of
@@ -446,8 +456,13 @@ struct Set(T)
   # Set{1, 3, 5}.superset? Set{1, 5}    # => true
   # Set{1, 3, 5}.superset? Set{1, 3, 5} # => true
   # ```
+  def superset_of?(other : Set)
+    other.subset_of?(self)
+  end
+
+  @[Deprecated("Use #superset_of? instead.")]
   def superset?(other : Set)
-    other.subset?(self)
+    superset_of?(other)
   end
 
   # Returns `true` if the set is a superset of the *other* set.
@@ -459,8 +474,13 @@ struct Set(T)
   # Set{1, 3, 5}.proper_superset? Set{1, 5}    # => true
   # Set{1, 3, 5}.proper_superset? Set{1, 3, 5} # => false
   # ```
+  def proper_superset_of?(other : Set)
+    other.proper_subset_of?(self)
+  end
+
+  @[Deprecated("Use #proper_superset_of? instead.")]
   def proper_superset?(other : Set)
-    other.proper_subset?(self)
+    proper_superset_of?(other)
   end
 
   # :nodoc: