super_diff 0.10.0 → 0.11.0

data/spec/integration/rails/engines_spec.rb

@@ -1,16 +1,21 @@
 require "spec_helper"
 
-RSpec.describe "Integration with Rails engines", type: :integration do
+RSpec.describe "Integration with Rails engines",
+               type: :integration,
+               active_support: true do
   context "when ActiveRecord is not loaded via Combustion" do
     it "does not fail to load" do
       as_both_colored_and_uncolored do |color_enabled|
         program =
-          make_rspec_rails_engine_program(
+          make_rspec_rails_engine_with_action_controller_program(
             "expect(true).to be(true)",
-            combustion_initialize: [:action_controller],
             color_enabled: color_enabled
           )
 
+        expect(program).to produce_output_when_run(
+          "1 example, 0 failures"
+        ).in_color(color_enabled)
+
         expect(program).not_to produce_output_when_run(
           "uninitialized constant ActiveRecord"
         ).in_color(color_enabled)

data/spec/integration/rspec/contain_exactly_matcher_spec.rb

@@ -6,8 +6,8 @@ RSpec.describe "Integration with RSpec's #contain_exactly matcher",
     it "produces the correct failure message when used in the positive" do
       as_both_colored_and_uncolored do |color_enabled|
         snippet = <<~TEST.strip
-          expected = ["Einie", "Marty"]
           actual = ["Marty", "Jennifer", "Doc"]
+          expected = ["Einie", "Marty"]
           expect(actual).to contain_exactly(*expected)
         TEST
         program = make_plain_test_program(snippet, color_enabled: color_enabled)
@@ -84,6 +84,12 @@ RSpec.describe "Integration with RSpec's #contain_exactly matcher",
       it "produces the correct failure message when used in the positive" do
         as_both_colored_and_uncolored do |color_enabled|
           snippet = <<~TEST.strip
+            actual = [
+              "Marty McFly",
+              "Doc Brown",
+              "Einie",
+              "Lorraine McFly"
+            ]
             expected = [
               "Doc Brown",
               "Marty McFly",
@@ -91,12 +97,6 @@ RSpec.describe "Integration with RSpec's #contain_exactly matcher",
               "George McFly",
               "Lorraine McFly"
             ]
-            actual = [
-              "Marty McFly",
-              "Doc Brown",
-              "Einie",
-              "Lorraine McFly"
-            ]
             expect(actual).to contain_exactly(*expected)
           TEST
           program =
@@ -196,6 +196,12 @@ RSpec.describe "Integration with RSpec's #contain_exactly matcher",
       it "produces the correct failure message when used in the positive" do
         as_both_colored_and_uncolored do |color_enabled|
           snippet = <<~TEST
+            actual = [
+              "Marty McFly",
+              "Doc Brown",
+              "Einie",
+              "Lorraine McFly"
+            ]
             expected = [
               / Brown$/,
               "Marty McFly",
@@ -203,12 +209,6 @@ RSpec.describe "Integration with RSpec's #contain_exactly matcher",
               /Georg McFly/,
               /Lorrain McFly/
             ]
-            actual = [
-              "Marty McFly",
-              "Doc Brown",
-              "Einie",
-              "Lorraine McFly"
-            ]
             expect(actual).to contain_exactly(*expected)
           TEST
           program =
@@ -308,20 +308,20 @@ RSpec.describe "Integration with RSpec's #contain_exactly matcher",
       end
     end
 
-    context "and some of them are fuzzy objects" do
+    context "and some of them are RSpec matchers" do
       it "produces the correct failure message" do
         as_both_colored_and_uncolored do |color_enabled|
           snippet = <<~TEST.strip
-            expected = [
-              a_hash_including(foo: "bar"),
-              a_collection_containing_exactly("zing"),
-              an_object_having_attributes(baz: "qux"),
-            ]
             actual = [
               { foo: "bar" },
               double(baz: "qux"),
               { blargh: "riddle" }
             ]
+            expected = [
+              a_hash_including(foo: "bar"),
+              a_collection_containing_exactly("zing"),
+              an_object_having_attributes(baz: "qux"),
+            ]
             expect(actual).to contain_exactly(*expected)
           TEST
           program =

data/spec/integration/rspec/eq_matcher_spec.rb

@@ -173,16 +173,16 @@ RSpec.describe "Integration with RSpec's #eq matcher", type: :integration do
     it "produces the correct failure message when used in the positive" do
       as_both_colored_and_uncolored do |color_enabled|
         snippet = <<~RUBY
-          expected = Time.utc(2011, 12, 13, 14, 15, 16)
-          actual = Time.utc(2011, 12, 13, 14, 15, 16, 500_000)
-          expect(expected).to eq(actual)
+          actual = Time.utc(2011, 12, 13, 14, 15, 16)
+          expected = Time.utc(2011, 12, 13, 14, 15, 16, 500_000)
+          expect(actual).to eq(expected)
         RUBY
         program = make_plain_test_program(snippet, color_enabled: color_enabled)
 
         expected_output =
           build_expected_output(
             color_enabled: color_enabled,
-            snippet: "expect(expected).to eq(actual)",
+            snippet: "expect(actual).to eq(expected)",
             expectation:
               proc do
                 line do
@@ -252,12 +252,84 @@ RSpec.describe "Integration with RSpec's #eq matcher", type: :integration do
     end
   end
 
+  context "when comparing two different Date instances" do
+    it "produces the correct failure message when used in the positive" do
+      as_both_colored_and_uncolored do |color_enabled|
+        snippet = <<~RUBY
+          actual = Date.new(2023, 10, 14)
+          expected = Date.new(2023, 10, 31)
+          expect(actual).to eq(expected)
+        RUBY
+        program = make_plain_test_program(snippet, color_enabled: color_enabled)
+
+        expected_output =
+          build_expected_output(
+            color_enabled: color_enabled,
+            snippet: "expect(actual).to eq(expected)",
+            expectation:
+              proc do
+                line do
+                  plain "Expected "
+                  actual "#<Date 2023-10-14>"
+                  plain " to eq "
+                  expected "#<Date 2023-10-31>"
+                  plain "."
+                end
+              end,
+            diff:
+              proc do
+                plain_line "  #<Date {"
+                plain_line "    year: 2023,"
+                plain_line "    month: 10,"
+                expected_line "-   day: 31"
+                actual_line "+   day: 14"
+                plain_line "  }>"
+              end
+          )
+
+        expect(program).to produce_output_when_run(expected_output).in_color(
+          color_enabled
+        )
+      end
+    end
+
+    it "produces the correct failure message when used in the negative" do
+      as_both_colored_and_uncolored do |color_enabled|
+        snippet = <<~RUBY
+          date = Date.new(2023, 10, 14)
+          expect(date).not_to eq(date)
+        RUBY
+        program = make_plain_test_program(snippet, color_enabled: color_enabled)
+
+        expected_output =
+          build_expected_output(
+            color_enabled: color_enabled,
+            snippet: "expect(date).not_to eq(date)",
+            expectation:
+              proc do
+                line do
+                  plain "Expected "
+                  actual "#<Date 2023-10-14>"
+                  plain " not to eq "
+                  expected "#<Date 2023-10-14>"
+                  plain "."
+                end
+              end
+          )
+
+        expect(program).to produce_output_when_run(expected_output).in_color(
+          color_enabled
+        )
+      end
+    end
+  end
+
   context "when comparing a single-line string with a multi-line string" do
     it "produces the correct failure message" do
       as_both_colored_and_uncolored do |color_enabled|
         snippet = <<~TEST.strip
-          expected = "Something entirely different"
           actual = "This is a line\\nAnd that's another line\\n"
+          expected = "Something entirely different"
           expect(actual).to eq(expected)
         TEST
         program = make_plain_test_program(snippet, color_enabled: color_enabled)
@@ -295,8 +367,8 @@ RSpec.describe "Integration with RSpec's #eq matcher", type: :integration do
     it "produces the correct failure message" do
       as_both_colored_and_uncolored do |color_enabled|
         snippet = <<~TEST.strip
-          expected = "This is a line\\nAnd that's another line\\n"
           actual = "Something entirely different"
+          expected = "This is a line\\nAnd that's another line\\n"
           expect(actual).to eq(expected)
         TEST
         program = make_plain_test_program(snippet, color_enabled: color_enabled)
@@ -334,8 +406,8 @@ RSpec.describe "Integration with RSpec's #eq matcher", type: :integration do
     it "produces the correct failure message when used in the positive" do
       as_both_colored_and_uncolored do |color_enabled|
         snippet = <<~TEST.strip
-          expected = "This is a line\\nAnd that's a line\\nAnd there's a line too\\n"
           actual = "This is a line\\nSomething completely different\\nAnd there's a line too\\n"
+          expected = "This is a line\\nAnd that's a line\\nAnd there's a line too\\n"
           expect(actual).to eq(expected)
         TEST
         program = make_plain_test_program(snippet, color_enabled: color_enabled)
@@ -409,19 +481,6 @@ RSpec.describe "Integration with RSpec's #eq matcher", type: :integration do
     it "produces the correct failure message when used in the positive" do
       as_both_colored_and_uncolored do |color_enabled|
         snippet = <<~TEST
-          expected = [
-            [
-              :h1,
-              [:span, [:text, "Hello world"]],
-              {
-                class: "header",
-                data: {
-                  "sticky" => true,
-                  person: SuperDiff::Test::Person.new(name: "Marty", age: 60)
-                }
-              }
-            ]
-          ]
           actual = [
             [
               :h2,
@@ -438,6 +497,19 @@ RSpec.describe "Integration with RSpec's #eq matcher", type: :integration do
             ],
             :br
           ]
+          expected = [
+            [
+              :h1,
+              [:span, [:text, "Hello world"]],
+              {
+                class: "header",
+                data: {
+                  "sticky" => true,
+                  person: SuperDiff::Test::Person.new(name: "Marty", age: 60)
+                }
+              }
+            ]
+          ]
           expect(actual).to eq(expected)
         TEST
         program = make_plain_test_program(snippet, color_enabled: color_enabled)
@@ -548,11 +620,11 @@ RSpec.describe "Integration with RSpec's #eq matcher", type: :integration do
     it "produces the correct failure message when used in the positive" do
       as_both_colored_and_uncolored do |color_enabled|
         snippet = <<~TEST.strip
-          expected = {
+          actual = {
             customer: {
-              person: SuperDiff::Test::Person.new(name: "Marty McFly", age: 17),
+              person: SuperDiff::Test::Person.new(name: "Marty McFly, Jr.", age: 17),
               shipping_address: {
-                line_1: "123 Main St.",
+                line_1: "456 Ponderosa Ct.",
                 city: "Hill Valley",
                 state: "CA",
                 zip: "90382"
@@ -564,14 +636,14 @@ RSpec.describe "Integration with RSpec's #eq matcher", type: :integration do
                 cost: 100_000,
                 options: ["red", "blue", "green"]
               },
-              { name: "Chevy 4x4" }
+              { name: "Mattel Hoverboard" }
             ]
           }
-          actual = {
+          expected = {
             customer: {
-              person: SuperDiff::Test::Person.new(name: "Marty McFly, Jr.", age: 17),
+              person: SuperDiff::Test::Person.new(name: "Marty McFly", age: 17),
               shipping_address: {
-                line_1: "456 Ponderosa Ct.",
+                line_1: "123 Main St.",
                 city: "Hill Valley",
                 state: "CA",
                 zip: "90382"
@@ -583,7 +655,7 @@ RSpec.describe "Integration with RSpec's #eq matcher", type: :integration do
                 cost: 100_000,
                 options: ["red", "blue", "green"]
               },
-              { name: "Mattel Hoverboard" }
+              { name: "Chevy 4x4" }
             ]
           }
           expect(actual).to eq(expected)
@@ -704,15 +776,15 @@ RSpec.describe "Integration with RSpec's #eq matcher", type: :integration do
     it "produces the correct failure message when used in the positive" do
       as_both_colored_and_uncolored do |color_enabled|
         snippet = <<~TEST.strip
-          expected = SuperDiff::Test::Person.new(
-            name: "Marty",
-            age: 31,
-          )
           actual = SuperDiff::Test::Customer.new(
             name: "Doc",
             shipping_address: :some_shipping_address,
             phone: "1234567890",
           )
+          expected = SuperDiff::Test::Person.new(
+            name: "Marty",
+            age: 31,
+          )
           expect(actual).to eq(expected)
         TEST
         program = make_plain_test_program(snippet, color_enabled: color_enabled)
@@ -783,10 +855,6 @@ RSpec.describe "Integration with RSpec's #eq matcher", type: :integration do
     it "produces the correct failure message when used in the positive" do
       as_both_colored_and_uncolored do |color_enabled|
         snippet = <<~TEST.strip
-          expected = SuperDiff::Test::Item.new(
-            name: "camera",
-            quantity: 3,
-          )
           actual = SuperDiff::Test::Player.new(
             handle: "mcmire",
             character: "Jon",
@@ -795,6 +863,10 @@ RSpec.describe "Integration with RSpec's #eq matcher", type: :integration do
             health: 4,
             ultimate: true,
           )
+          expected = SuperDiff::Test::Item.new(
+            name: "camera",
+            quantity: 3,
+          )
           expect(actual).to eq(expected)
         TEST
         program = make_plain_test_program(snippet, color_enabled: color_enabled)
@@ -865,8 +937,8 @@ RSpec.describe "Integration with RSpec's #eq matcher", type: :integration do
     it "formats the array correctly in the diff" do
       as_both_colored_and_uncolored do |color_enabled|
         snippet = <<~TEST.strip
-          expected = { foo: nil }
           actual = { foo: [] }
+          expected = { foo: nil }
           expect(actual).to eq(expected)
         TEST
         program = make_plain_test_program(snippet, color_enabled: color_enabled)
@@ -906,8 +978,8 @@ RSpec.describe "Integration with RSpec's #eq matcher", type: :integration do
     it "formats the hash correctly in the diff" do
       as_both_colored_and_uncolored do |color_enabled|
         snippet = <<~TEST.strip
-          expected = { foo: nil }
           actual = { foo: {} }
+          expected = { foo: nil }
           expect(actual).to eq(expected)
         TEST
         program = make_plain_test_program(snippet, color_enabled: color_enabled)
@@ -947,8 +1019,8 @@ RSpec.describe "Integration with RSpec's #eq matcher", type: :integration do
     it "formats the object correctly in the diff" do
       as_both_colored_and_uncolored do |color_enabled|
         snippet = <<~TEST.strip
-          expected = { foo: nil }
           actual = { foo: SuperDiff::Test::EmptyClass.new }
+          expected = { foo: nil }
           expect(actual).to eq(expected)
         TEST
         program = make_plain_test_program(snippet, color_enabled: color_enabled)

data/spec/integration/rspec/generic_describable_matchers_spec.rb

@@ -0,0 +1,177 @@
+require "spec_helper"
+
+RSpec.describe "Integration with describable matchers not handled specially",
+               type: :integration do
+  context "when the expected value contains a built-in matcher (not an aliased matcher)" do
+    it "produces the correct failure message when used in the positive" do
+      as_both_colored_and_uncolored do |color_enabled|
+        snippet = <<~TEST.strip
+            actual = {
+              number: "not a number"
+            }
+            expected = hash_including(
+              number: be_a(Numeric)
+            )
+            expect(actual).to match(expected)
+        TEST
+        program = make_plain_test_program(snippet, color_enabled: color_enabled)
+
+        expected_output =
+          build_expected_output(
+            color_enabled: color_enabled,
+            snippet: "expect(actual).to match(expected)",
+            expectation:
+              proc do
+                line do
+                  plain "Expected "
+                  actual %|{ number: "not a number" }|
+                  plain " to match "
+                  expected "#<a hash including (number: #<be a kind of Numeric>)>"
+                  plain "."
+                end
+              end,
+            diff:
+              proc do
+                plain_line "  {"
+                expected_line "-   number: #<be a kind of Numeric>"
+                actual_line %|+   number: "not a number"|
+                plain_line "  }"
+              end
+          )
+
+        expect(program).to produce_output_when_run(expected_output).in_color(
+          color_enabled
+        )
+      end
+    end
+
+    it "produces the correct failure message when used in the negative" do
+      as_both_colored_and_uncolored do |color_enabled|
+        snippet = <<~TEST.strip
+          actual = {
+            number: 4
+          }
+          expected = hash_including(
+            number: be_a(Numeric)
+          )
+          expect(actual).not_to match(expected)
+        TEST
+        program = make_plain_test_program(snippet, color_enabled: color_enabled)
+
+        expected_output =
+          build_expected_output(
+            color_enabled: color_enabled,
+            snippet: "expect(actual).not_to match(expected)",
+            expectation:
+              proc do
+                line do
+                  plain "Expected "
+                  actual "{ number: 4 }"
+                  plain " not to match "
+                  expected "#<a hash including (number: #<be a kind of Numeric>)>"
+                  plain "."
+                end
+              end
+          )
+
+        expect(program).to produce_output_when_run(expected_output).in_color(
+          color_enabled
+        )
+      end
+    end
+  end
+
+  context "when the expected value contains a custom matcher defined via RSpec::Matchers::DSL" do
+    it "produces the correct failure message" do
+      as_both_colored_and_uncolored do |color_enabled|
+        snippet = <<~TEST.strip
+          actual = {
+            number: "something else"
+          }
+          expected = hash_including(
+            number: failing_custom_matcher_from_dsl(42)
+          )
+          expect(actual).to match(expected)
+        TEST
+        program = make_plain_test_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 do
+                line do
+                  plain "Expected "
+                  actual %|{ number: "something else" }|
+                end
+
+                line do
+                  plain "to match "
+                  expected "#<a hash including (number: #<custom matcher defined via the DSL with value 42>)>"
+                end
+              end,
+            diff:
+              proc do
+                plain_line "  {"
+                expected_line "-   number: #<custom matcher defined via the DSL with value 42>"
+                actual_line %|+   number: "something else"|
+                plain_line "  }"
+              end
+          )
+
+        expect(program).to produce_output_when_run(expected_output).in_color(
+          color_enabled
+        )
+      end
+    end
+  end
+
+  context "when the expected value contains a custom matcher defined from scratch" do
+    it "produces the correct failure message" do
+      as_both_colored_and_uncolored do |color_enabled|
+        snippet = <<~TEST.strip
+          actual = {
+            number: "something else"
+          }
+          expected = hash_including(
+            number: failing_custom_matcher_from_scratch(42)
+          )
+          expect(actual).to match(expected)
+        TEST
+        program = make_plain_test_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 do
+                line do
+                  plain "Expected "
+                  actual %|{ number: "something else" }|
+                end
+
+                line do
+                  plain "to match "
+                  expected "#<a hash including (number: #<custom matcher defined from scratch with value 42>)>"
+                end
+              end,
+            diff:
+              proc do
+                plain_line "  {"
+                expected_line "-   number: #<custom matcher defined from scratch with value 42>"
+                actual_line %|+   number: "something else"|
+                plain_line "  }"
+              end
+          )
+
+        expect(program).to produce_output_when_run(expected_output).in_color(
+          color_enabled
+        )
+      end
+    end
+  end
+end