super_diff 0.3.0 → 0.5.1

data/spec/unit/{equality_matcher_spec.rb → equality_matchers/main_spec.rb}

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-RSpec.describe SuperDiff::EqualityMatcher do
+RSpec.describe SuperDiff::EqualityMatchers::Main do
   describe "#call" do
     context "given the same integers" do
       it "returns an empty string" do
@@ -1056,6 +1056,162 @@ RSpec.describe SuperDiff::EqualityMatcher do
       end
     end
 
+    context "given two equal-size, one-dimensional hashes where there is a mixture of missing and extra keys in relatively the same order" do
+      context "and the actual value is in relatively the same order as the expected" do
+        it "preserves the order of the keys as they are defined" do
+          actual_output = described_class.call(
+            expected: {
+              listed_count: 37_009,
+              created_at: "Tue Jan 13 19:28:24 +0000 2009",
+              favourites_count: 38,
+              geo_enabled: false,
+              verified: true,
+              statuses_count: 273_860,
+              media_count: 51_044,
+              contributors_enabled: false,
+              profile_background_color: "FFF1E0",
+              profile_background_image_url_https: "https://abs.twimg.com/images/themes/theme1/bg.png",
+              profile_background_tile: false,
+              profile_image_url: "http://pbs.twimg.com/profile_images/931156393108885504/EqEMtLhM_normal.jpg",
+              profile_image_url_https: "https://pbs.twimg.com/profile_images/931156393108885504/EqEMtLhM_normal.jpg",
+              profile_banner_url: "https://pbs.twimg.com/profile_banners/18949452/1581526592",
+            },
+            actual: {
+              listed_count: 37_009,
+              created_at: "Tue Jan 13 19:28:24 +0000 2009",
+              favourites_count: 38,
+              utc_offset: nil,
+              time_zone: nil,
+              statuses_count: 273_860,
+              media_count: 51_044,
+              contributors_enabled: false,
+              is_translator: false,
+              is_translation_enabled: false,
+              profile_background_color: "FFF1E0",
+              profile_background_image_url_https: "https://abs.twimg.com/images/themes/theme1/bg.png",
+              profile_background_tile: false,
+              profile_banner_url: "https://pbs.twimg.com/profile_banners/18949452/1581526592",
+            }
+          )
+
+          expected_output = <<~STR.strip
+            Differing hashes.
+
+            #{
+              colored do
+                alpha_line %(Expected: { listed_count: 37009, created_at: "Tue Jan 13 19:28:24 +0000 2009", favourites_count: 38, geo_enabled: false, verified: true, statuses_count: 273860, media_count: 51044, contributors_enabled: false, profile_background_color: "FFF1E0", profile_background_image_url_https: "https://abs.twimg.com/images/themes/theme1/bg.png", profile_background_tile: false, profile_image_url: "http://pbs.twimg.com/profile_images/931156393108885504/EqEMtLhM_normal.jpg", profile_image_url_https: "https://pbs.twimg.com/profile_images/931156393108885504/EqEMtLhM_normal.jpg", profile_banner_url: "https://pbs.twimg.com/profile_banners/18949452/1581526592" })
+                beta_line  %(  Actual: { listed_count: 37009, created_at: "Tue Jan 13 19:28:24 +0000 2009", favourites_count: 38, utc_offset: nil, time_zone: nil, statuses_count: 273860, media_count: 51044, contributors_enabled: false, is_translator: false, is_translation_enabled: false, profile_background_color: "FFF1E0", profile_background_image_url_https: "https://abs.twimg.com/images/themes/theme1/bg.png", profile_background_tile: false, profile_banner_url: "https://pbs.twimg.com/profile_banners/18949452/1581526592" })
+              end
+            }
+
+            Diff:
+
+            #{
+              colored do
+                plain_line %(  {)
+                plain_line %(    listed_count: 37009,)
+                plain_line %(    created_at: "Tue Jan 13 19:28:24 +0000 2009",)
+                plain_line %(    favourites_count: 38,)
+                alpha_line %(-   geo_enabled: false,)
+                alpha_line %(-   verified: true,)
+                beta_line  %(+   utc_offset: nil,)
+                beta_line  %(+   time_zone: nil,)
+                plain_line %(    statuses_count: 273860,)
+                plain_line %(    media_count: 51044,)
+                plain_line %(    contributors_enabled: false,)
+                beta_line  %(+   is_translator: false,)
+                beta_line  %(+   is_translation_enabled: false,)
+                plain_line %(    profile_background_color: "FFF1E0",)
+                plain_line %(    profile_background_image_url_https: "https://abs.twimg.com/images/themes/theme1/bg.png",)
+                plain_line %(    profile_background_tile: false,)
+                alpha_line %(-   profile_image_url: "http://pbs.twimg.com/profile_images/931156393108885504/EqEMtLhM_normal.jpg",)
+                alpha_line %(-   profile_image_url_https: "https://pbs.twimg.com/profile_images/931156393108885504/EqEMtLhM_normal.jpg",)
+                plain_line %(    profile_banner_url: "https://pbs.twimg.com/profile_banners/18949452/1581526592")
+                plain_line %(  })
+              end
+            }
+          STR
+
+          expect(actual_output).to eq(expected_output)
+        end
+      end
+
+      context "and the actual value is in a different order than the expected" do
+        it "preserves the order of the keys as they are defined" do
+          actual_output = described_class.call(
+            expected: {
+              created_at: "Tue Jan 13 19:28:24 +0000 2009",
+              favourites_count: 38,
+              geo_enabled: false,
+              verified: true,
+              media_count: 51_044,
+              statuses_count: 273_860,
+              contributors_enabled: false,
+              profile_background_image_url_https: "https://abs.twimg.com/images/themes/theme1/bg.png",
+              profile_background_color: "FFF1E0",
+              profile_background_tile: false,
+              profile_image_url: "http://pbs.twimg.com/profile_images/931156393108885504/EqEMtLhM_normal.jpg",
+              listed_count: 37_009,
+              profile_banner_url: "https://pbs.twimg.com/profile_banners/18949452/1581526592",
+            },
+            actual: {
+              listed_count: 37_009,
+              created_at: "Tue Jan 13 19:28:24 +0000 2009",
+              favourites_count: 38,
+              utc_offset: nil,
+              statuses_count: 273_860,
+              media_count: 51_044,
+              contributors_enabled: false,
+              is_translator: false,
+              is_translation_enabled: false,
+              profile_background_color: "FFF1E0",
+              profile_background_image_url_https: "https://abs.twimg.com/images/themes/theme1/bg.png",
+              profile_background_tile: false,
+              profile_banner_url: "https://pbs.twimg.com/profile_banners/18949452/1581526592",
+            }
+          )
+
+          expected_output = <<~STR.strip
+            Differing hashes.
+
+            #{
+              colored do
+                alpha_line %(Expected: { created_at: "Tue Jan 13 19:28:24 +0000 2009", favourites_count: 38, geo_enabled: false, verified: true, media_count: 51044, statuses_count: 273860, contributors_enabled: false, profile_background_image_url_https: "https://abs.twimg.com/images/themes/theme1/bg.png", profile_background_color: "FFF1E0", profile_background_tile: false, profile_image_url: "http://pbs.twimg.com/profile_images/931156393108885504/EqEMtLhM_normal.jpg", listed_count: 37009, profile_banner_url: "https://pbs.twimg.com/profile_banners/18949452/1581526592" })
+                beta_line  %(  Actual: { listed_count: 37009, created_at: "Tue Jan 13 19:28:24 +0000 2009", favourites_count: 38, utc_offset: nil, statuses_count: 273860, media_count: 51044, contributors_enabled: false, is_translator: false, is_translation_enabled: false, profile_background_color: "FFF1E0", profile_background_image_url_https: "https://abs.twimg.com/images/themes/theme1/bg.png", profile_background_tile: false, profile_banner_url: "https://pbs.twimg.com/profile_banners/18949452/1581526592" })
+              end
+            }
+
+            Diff:
+
+            #{
+              colored do
+                plain_line %(  {)
+                plain_line %(    listed_count: 37009,)
+                plain_line %(    created_at: "Tue Jan 13 19:28:24 +0000 2009",)
+                plain_line %(    favourites_count: 38,)
+                alpha_line %(-   geo_enabled: false,)
+                alpha_line %(-   verified: true,)
+                beta_line  %(+   utc_offset: nil,)
+                plain_line %(    statuses_count: 273860,)
+                plain_line %(    media_count: 51044,)
+                plain_line %(    contributors_enabled: false,)
+                beta_line  %(+   is_translator: false,)
+                beta_line  %(+   is_translation_enabled: false,)
+                plain_line %(    profile_background_color: "FFF1E0",)
+                plain_line %(    profile_background_image_url_https: "https://abs.twimg.com/images/themes/theme1/bg.png",)
+                plain_line %(    profile_background_tile: false,)
+                alpha_line %(-   profile_image_url: "http://pbs.twimg.com/profile_images/931156393108885504/EqEMtLhM_normal.jpg",)
+                plain_line %(    profile_banner_url: "https://pbs.twimg.com/profile_banners/18949452/1581526592")
+                plain_line %(  })
+              end
+            }
+          STR
+
+          expect(actual_output).to eq(expected_output)
+        end
+      end
+    end
+
     context "given two hashes containing arrays with differing values" do
       it "returns a message along with the diff" do
         actual_output = described_class.call(
@@ -1375,13 +1531,13 @@ RSpec.describe SuperDiff::EqualityMatcher do
             if SuperDiff::Test.jruby?
               # Source: <https://github.com/jruby/jruby/blob/master/core/src/main/java/org/jruby/RubyBasicObject.java>
               colored do
-                alpha_line %(Expected: #<SuperDiff::Test::Player:#{"0x%x" % expected.hash} @inventory=["flatline", "purple body shield"], @character="mirage", @handle="martymcfly", @ultimate=0.8, @shields=0.6, @health=0.3>)
-                beta_line  %(  Actual: #<SuperDiff::Test::Player:#{"0x%x" % actual.hash} @inventory=["wingman", "mastiff"], @character="lifeline", @handle="docbrown", @ultimate=0.8, @shields=0.6, @health=0.3>)
+                alpha_line %(Expected: #<SuperDiff::Test::Player:#{SuperDiff::Test.object_id_hex(expected)} @inventory=["flatline", "purple body shield"], @character="mirage", @handle="martymcfly", @ultimate=0.8, @shields=0.6, @health=0.3>)
+                beta_line  %(  Actual: #<SuperDiff::Test::Player:#{SuperDiff::Test.object_id_hex(actual)} @inventory=["wingman", "mastiff"], @character="lifeline", @handle="docbrown", @ultimate=0.8, @shields=0.6, @health=0.3>)
               end
             else
               colored do
-                alpha_line %(Expected: #<SuperDiff::Test::Player:#{"0x%016x" % (expected.object_id * 2)} @handle="martymcfly", @character="mirage", @inventory=["flatline", "purple body shield"], @shields=0.6, @health=0.3, @ultimate=0.8>)
-                beta_line  %(  Actual: #<SuperDiff::Test::Player:#{"0x%016x" % (actual.object_id * 2)} @handle="docbrown", @character="lifeline", @inventory=["wingman", "mastiff"], @shields=0.6, @health=0.3, @ultimate=0.8>)
+                alpha_line %(Expected: #<SuperDiff::Test::Player:#{SuperDiff::Test.object_id_hex(expected)} @handle="martymcfly", @character="mirage", @inventory=["flatline", "purple body shield"], @shields=0.6, @health=0.3, @ultimate=0.8>)
+                beta_line  %(  Actual: #<SuperDiff::Test::Player:#{SuperDiff::Test.object_id_hex(actual)} @handle="docbrown", @character="lifeline", @inventory=["wingman", "mastiff"], @shields=0.6, @health=0.3, @ultimate=0.8>)
               end
             end
           }
@@ -1466,13 +1622,13 @@ RSpec.describe SuperDiff::EqualityMatcher do
             if SuperDiff::Test.jruby?
               # Source: <https://github.com/jruby/jruby/blob/master/core/src/main/java/org/jruby/RubyBasicObject.java>
               colored do
-                alpha_line %(Expected: #<SuperDiff::Test::Item:#{"0x%x" % expected.hash} @name="camera", @quantity=3>)
-                beta_line  %(  Actual: #<SuperDiff::Test::Player:#{"0x%x" % actual.hash} @inventory=["sword"], @character="Jon", @handle="mcmire", @ultimate=true, @shields=11.4, @health=4>)
+                alpha_line %(Expected: #<SuperDiff::Test::Item:#{SuperDiff::Test.object_id_hex(expected)} @name="camera", @quantity=3>)
+                beta_line  %(  Actual: #<SuperDiff::Test::Player:#{SuperDiff::Test.object_id_hex(actual)} @inventory=["sword"], @character="Jon", @handle="mcmire", @ultimate=true, @shields=11.4, @health=4>)
               end
             else
               colored do
-                alpha_line %(Expected: #<SuperDiff::Test::Item:#{"0x%016x" % (expected.object_id * 2)} @name="camera", @quantity=3>)
-                beta_line  %(  Actual: #<SuperDiff::Test::Player:#{"0x%016x" % (actual.object_id * 2)} @handle="mcmire", @character="Jon", @inventory=["sword"], @shields=11.4, @health=4, @ultimate=true>)
+                alpha_line %(Expected: #<SuperDiff::Test::Item:#{SuperDiff::Test.object_id_hex(expected)} @name="camera", @quantity=3>)
+                beta_line  %(  Actual: #<SuperDiff::Test::Player:#{SuperDiff::Test.object_id_hex(actual)} @handle="mcmire", @character="Jon", @inventory=["sword"], @shields=11.4, @health=4, @ultimate=true>)
               end
             end
           }

data/spec/unit/object_inspection_spec.rb

@@ -601,16 +601,16 @@ RSpec.describe SuperDiff::ObjectInspection do
               as_single_line: false,
             )
             expect(inspection).to match(
-              /#<SuperDiff::Test::EmptyClass:0x[a-z0-9]+>/
+              /#<SuperDiff::Test::EmptyClass:0x[a-z0-9]+>/,
             )
           end
         end
       end
     end
 
-    context "given a partial hash" do
+    context "given a hash-including-<something>" do
       context "given as_single_line: true" do
-        it "returns a representation of the partial hash on a single line" do
+        it "returns a representation of the object on a single line" do
           inspection = described_class.inspect(
             a_hash_including(foo: "bar", baz: "qux"),
             as_single_line: true,
@@ -623,7 +623,7 @@ RSpec.describe SuperDiff::ObjectInspection do
       end
 
       context "given as_single_line: false" do
-        it "returns a representation of the partial hash across multiple lines" do
+        it "returns a representation of the object across multiple lines" do
           inspection = described_class.inspect(
             a_hash_including(foo: "bar", baz: "qux"),
             as_single_line: false,
@@ -639,9 +639,9 @@ RSpec.describe SuperDiff::ObjectInspection do
       end
     end
 
-    context "given a partial array" do
+    context "given a collection-including-<something>" do
       context "given as_single_line: true" do
-        it "returns a representation of the partial hash on a single line" do
+        it "returns a representation of the object on a single line" do
           inspection = described_class.inspect(
             a_collection_including(1, 2, 3),
             as_single_line: true,
@@ -654,7 +654,7 @@ RSpec.describe SuperDiff::ObjectInspection do
       end
 
       context "given as_single_line: false" do
-        it "returns a representation of the partial hash across multiple lines" do
+        it "returns a representation of the object across multiple lines" do
           inspection = described_class.inspect(
             a_collection_including(1, 2, 3),
             as_single_line: false,
@@ -671,9 +671,9 @@ RSpec.describe SuperDiff::ObjectInspection do
       end
     end
 
-    context "given a partial object" do
+    context "given a fuzzy object" do
       context "given as_single_line: true" do
-        it "returns a representation of the partial object on a single line" do
+        it "returns a representation of the object on a single line" do
           inspection = described_class.inspect(
             an_object_having_attributes(foo: "bar", baz: "qux"),
             as_single_line: true,
@@ -686,7 +686,7 @@ RSpec.describe SuperDiff::ObjectInspection do
       end
 
       context "given as_single_line: false" do
-        it "returns a representation of the partial object across multiple lines" do
+        it "returns a representation of the object across multiple lines" do
           inspection = described_class.inspect(
             an_object_having_attributes(foo: "bar", baz: "qux"),
             as_single_line: false,
@@ -702,9 +702,9 @@ RSpec.describe SuperDiff::ObjectInspection do
       end
     end
 
-    context "given a fuzzy object matching a collection containing exactly <something>" do
+    context "given a collection-containing-exactly-<something>" do
       context "given as_single_line: true" do
-        it "returns a representation of the partial object on a single line" do
+        it "returns a representation of the object on a single line" do
           inspection = described_class.inspect(
             a_collection_containing_exactly("foo", "bar", "baz"),
             as_single_line: true,
@@ -717,7 +717,7 @@ RSpec.describe SuperDiff::ObjectInspection do
       end
 
       context "given as_single_line: false" do
-        it "returns a representation of the partial object across multiple lines" do
+        it "returns a representation of the object across multiple lines" do
           inspection = described_class.inspect(
             a_collection_containing_exactly("foo", "bar", "baz"),
             as_single_line: false,
@@ -734,10 +734,86 @@ RSpec.describe SuperDiff::ObjectInspection do
       end
     end
 
+    context "given a kind-of-<something>" do
+      context "given as_single_line: true" do
+        it "returns a representation of the object on a single line" do
+          inspection = described_class.inspect(
+            a_kind_of(Symbol),
+            as_single_line: true,
+          )
+
+          expect(inspection).to eq(%(#<a kind of Symbol>))
+        end
+      end
+
+      context "given as_single_line: false" do
+        it "returns a representation of the object on a single line" do
+          inspection = described_class.inspect(
+            a_kind_of(Symbol),
+            as_single_line: false,
+          )
+
+          expect(inspection).to eq(%(#<a kind of Symbol>))
+        end
+      end
+    end
+
+    context "given an-instance-of-<something>" do
+      context "given as_single_line: true" do
+        it "returns a representation of the object on a single line" do
+          inspection = described_class.inspect(
+            an_instance_of(Symbol),
+            as_single_line: true,
+          )
+
+          expect(inspection).to eq(%(#<an instance of Symbol>))
+        end
+      end
+
+      context "given as_single_line: false" do
+        it "returns a representation of the object on a single line" do
+          inspection = described_class.inspect(
+            an_instance_of(Symbol),
+            as_single_line: false,
+          )
+
+          expect(inspection).to eq(%(#<an instance of Symbol>))
+        end
+      end
+    end
+
+    context "given a-value-within-<something>" do
+      context "given as_single_line: true" do
+        it "returns a representation of the object on a single line" do
+          inspection = described_class.inspect(
+            a_value_within(1).of(Time.utc(2020, 4, 9)),
+            as_single_line: true,
+          )
+
+          expect(inspection).to eq(
+            %(#<a value within 1 of 2020-04-09 00:00:00.000 UTC +00:00 (Time)>),
+          )
+        end
+      end
+
+      context "given as_single_line: false" do
+        it "returns a representation of the object on a single line" do
+          inspection = described_class.inspect(
+            a_value_within(1).of(Time.utc(2020, 4, 9)),
+            as_single_line: false,
+          )
+
+          expect(inspection).to eq(
+            %(#<a value within 1 of 2020-04-09 00:00:00.000 UTC +00:00 (Time)>),
+          )
+        end
+      end
+    end
+
     context "given a Double" do
       context "that is anonymous" do
         context "given as_single_line: true" do
-          it "returns a representation of the partial object on a single line" do
+          it "returns a representation of the object on a single line" do
             inspection = described_class.inspect(
               double(foo: "bar", baz: "qux"),
               as_single_line: true,
@@ -748,7 +824,7 @@ RSpec.describe SuperDiff::ObjectInspection do
         end
 
         context "given as_single_line: false" do
-          it "returns a representation of the partial object across multiple lines" do
+          it "returns a representation of the object across multiple lines" do
             inspection = described_class.inspect(
               double(foo: "bar", baz: "qux"),
               as_single_line: false,
@@ -760,7 +836,7 @@ RSpec.describe SuperDiff::ObjectInspection do
       end
     end
 
-    context "given an ActiveRecord object" do
+    context "given an ActiveRecord object", active_record: true do
       context "given as_single_line: true" do
         it "returns a representation of the object on a single line" do
           inspection = described_class.inspect(
@@ -798,7 +874,7 @@ RSpec.describe SuperDiff::ObjectInspection do
       end
     end
 
-    context "given an ActiveRecord::Relation object" do
+    context "given an ActiveRecord::Relation object", active_record: true do
       context "given as_single_line: true" do
         it "returns a representation of the Relation on a single line" do
           SuperDiff::Test::Models::ActiveRecord::Person.create!(
@@ -855,7 +931,7 @@ RSpec.describe SuperDiff::ObjectInspection do
       end
     end
 
-    context "given a HashWithIndifferentAccess" do
+    context "given a HashWithIndifferentAccess", active_record: true do
       context "given as_single_line: true" do
         it "returns a representation of the object on a single line" do
           inspection = described_class.inspect(

data/spec/unit/rspec/matchers/have_predicate_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+RSpec.describe "RSpec's `have_<predicate>` matcher" do
+  describe "#description" do
+    context "given nothing" do
+      it "returns the correct output" do
+        expect(have_experience.description).to eq(
+          "return true for `has_experience?`",
+        )
+      end
+    end
+
+    context "given an argument" do
+      it "returns the correct output" do
+        expect(have_ingredients(:sugar).description).to eq(
+          "return true for `has_ingredients?(:sugar)`",
+        )
+      end
+    end
+  end
+end

data/spec/unit/rspec/matchers/match_array_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+RSpec.describe "RSpec's `match_array` matcher" do
+  describe "#description" do
+    it "returns the correct output" do
+      expect(match_array([:foo, :bar, :baz]).description).to eq(
+        "match array with :foo, :bar and :baz",
+      )
+    end
+  end
+end