super_diff 0.3.0 → 0.4.0

data/spec/support/integration/matchers.rb

@@ -0,0 +1,143 @@
+module SuperDiff
+  module IntegrationTests
+    def fail_with_indented_multiline_failure_message
+      FailWithIndentedMultilineFailureMessageMatcher.new
+    end
+
+    def fail_with_paragraphed_failure_message
+      FailWithParagraphedFailureMessageMatcher.new
+    end
+
+    def fail_with_non_indented_multiline_failure_message
+      FailWithNonIndentedMultilineFailureMessageMatcher.new
+    end
+
+    def fail_with_singleline_failure_message
+      FailWithSinglelineFailureMessageMatcher.new
+    end
+
+    def pass_with_indented_multiline_failure_message
+      PassWithIndentedMultilineFailureMessageMatcher.new
+    end
+
+    def pass_with_paragraphed_failure_message
+      PassWithParagraphedFailureMessageMatcher.new
+    end
+
+    def pass_with_non_indented_multiline_failure_message
+      PassWithNonIndentedMultilineFailureMessageMatcher.new
+    end
+
+    def pass_with_singleline_failure_message
+      PassWithSinglelineFailureMessageMatcher.new
+    end
+
+    class FailWithIndentedMultilineFailureMessageMatcher
+      def matches?(_)
+        false
+      end
+
+      def failure_message
+        <<-MESSAGE
+This is a message that spans multiple lines.
+Here is the next line.
+  This part is indented, for whatever reason. It just kinda keeps
+  going until we finish saying whatever it is we want to say.
+        MESSAGE
+      end
+    end
+
+    class FailWithParagraphedFailureMessageMatcher
+      def matches?(_)
+        false
+      end
+
+      def failure_message
+        <<-MESSAGE
+This is a message that spans multiple paragraphs.
+
+Here is the next paragraph.
+        MESSAGE
+      end
+    end
+
+    class FailWithNonIndentedMultilineFailureMessageMatcher
+      def matches?(_)
+        false
+      end
+
+      def failure_message
+        <<-MESSAGE
+This is a message that spans multiple lines.
+Here is the next line.
+        MESSAGE
+      end
+    end
+
+    class FailWithSinglelineFailureMessageMatcher
+      def matches?(_)
+        false
+      end
+
+      def failure_message
+        <<-MESSAGE
+This is a message that spans only one line.
+        MESSAGE
+      end
+    end
+
+    class PassWithIndentedMultilineFailureMessageMatcher
+      def does_not_match?(_)
+        false
+      end
+
+      def failure_message_when_negated
+        <<-MESSAGE
+This is a message that spans multiple lines.
+Here is the next line.
+  This part is indented, for whatever reason. It just kinda keeps
+  going until we finish saying whatever it is we want to say.
+        MESSAGE
+      end
+    end
+
+    class PassWithParagraphedFailureMessageMatcher
+      def does_not_match?(_)
+        false
+      end
+
+      def failure_message_when_negated
+        <<-MESSAGE
+This is a message that spans multiple paragraphs.
+
+Here is the next paragraph.
+        MESSAGE
+      end
+    end
+
+    class PassWithNonIndentedMultilineFailureMessageMatcher
+      def does_not_match?(_)
+        false
+      end
+
+      def failure_message_when_negated
+        <<-MESSAGE
+This is a message that spans multiple lines.
+Here is the next line.
+        MESSAGE
+      end
+    end
+
+    class PassWithSinglelineFailureMessageMatcher
+      def does_not_match?(_)
+        false
+      end
+
+      def failure_message_when_negated
+        <<-MESSAGE
+This is a message that spans only one line.
+        MESSAGE
+      end
+    end
+  end
+end

data/spec/support/models/active_record/query.rb

@@ -0,0 +1,15 @@
+module SuperDiff
+  module Test
+    module Models
+      module ActiveRecord
+        class Query
+          attr_reader :results
+
+          def initialize(results:)
+            @results = results
+          end
+        end
+      end
+    end
+  end
+end

data/spec/support/object_id.rb

@@ -0,0 +1,26 @@
+require_relative 'ruby_versions'
+
+if !SuperDiff::Test.jruby? && SuperDiff::Test.version_match?('>= 2.7.0')
+  require 'objspace'
+end
+
+module SuperDiff
+  module Test
+    if jruby?
+      def self.object_id_hex(object)
+        # Source: <https://github.com/jruby/jruby/blob/master/core/src/main/java/org/jruby/RubyBasicObject.java>
+        "0x%x" % object.hash
+      end
+    elsif version_match?('>= 2.7.0')
+      def self.object_id_hex(object)
+        # Sources: <https://bugs.ruby-lang.org/issues/15408> and <https://bugs.ruby-lang.org/issues/15626#Object-ID>
+        address = JSON.parse(ObjectSpace.dump(object))['address']
+        "0x%016x" % Integer(address, 16)
+      end
+    else
+      def self.object_id_hex(object)
+        "0x%016x" % (object.object_id * 2)
+      end
+    end
+  end
+end

data/spec/support/ruby_versions.rb

@@ -3,5 +3,9 @@ module SuperDiff
     def self.jruby?
       defined?(JRUBY_VERSION)
     end
+
+    def self.version_match?(version_string)
+      Gem::Requirement.new(version_string).satisfied_by?(Gem::Version.new(RUBY_VERSION))
+    end
   end
 end

data/spec/support/shared_examples/active_record.rb

@@ -335,4 +335,75 @@ shared_examples_for "integration with ActiveRecord" do
       end
     end
   end
+
+  describe "and RSpec's #match matcher" do
+    context "when the expected value includes an ActiveRecord object" do
+      it "produces the correct output" do
+        as_both_colored_and_uncolored do |color_enabled|
+          snippet = <<~TEST.strip
+            SuperDiff::Test::Models::ActiveRecord::Person.create!(
+              name: "Murphy",
+              age: 20
+            )
+
+            expected = [
+              an_object_having_attributes(
+                results: [
+                  an_object_having_attributes(name: "John", age: 19)
+                ]
+              )
+            ]
+
+            actual = [
+              SuperDiff::Test::Models::ActiveRecord::Query.new(
+                results: SuperDiff::Test::Models::ActiveRecord::Person.all
+              )
+            ]
+
+            expect(actual).to match(expected)
+          TEST
+
+          program = make_program(snippet, color_enabled: color_enabled)
+
+          expected_output = build_expected_output(
+            color_enabled: color_enabled,
+            snippet: %|expect(actual).to match(expected)|,
+            newline_before_expectation: true,
+            expectation: proc {
+              line do
+                plain "Expected "
+                beta %|[#<SuperDiff::Test::Models::ActiveRecord::Query @results=#<ActiveRecord::Relation [#<SuperDiff::Test::Models::ActiveRecord::Person id: 1, name: "Murphy", age: 20>]>>]|
+              end
+
+              line do
+                plain "to match "
+                alpha %|[#<an object having attributes (results: [#<an object having attributes (name: "John", age: 19)>])>]|
+              end
+            },
+            diff: proc {
+              plain_line %|  [|
+              plain_line %|    #<SuperDiff::Test::Models::ActiveRecord::Query {|
+              plain_line %|      @results=#<ActiveRecord::Relation [|
+              plain_line %|        #<SuperDiff::Test::Models::ActiveRecord::Person {|
+              plain_line %|          id: 1,|
+              # alpha_line %|-         age: 19,|  # TODO
+              alpha_line %|-         age: 19|
+              beta_line  %|+         age: 20,|
+              alpha_line %|-         name: "John"|
+              beta_line  %|+         name: "Murphy"|
+              plain_line %|        }>|
+              plain_line %|      ]>|
+              plain_line %|    }>|
+              plain_line %|  ]|
+            },
+          )
+
+          expect(program).
+            to produce_output_when_run(expected_output).
+            in_color(color_enabled).
+            removing_object_ids
+        end
+      end
+    end
+  end
 end

data/spec/unit/equality_matcher_spec.rb

@@ -1375,13 +1375,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 +1466,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

@@ -608,9 +608,9 @@ RSpec.describe SuperDiff::ObjectInspection do
       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,
@@ -737,7 +737,7 @@ RSpec.describe SuperDiff::ObjectInspection do
     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 +748,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 +760,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 +798,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 +855,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