super_diff 0.10.0 → 0.12.0

data/spec/spec_helper.rb

@@ -65,6 +65,9 @@ RSpec.configure do |config|
   config.default_formatter = "documentation" if !%w[true 1].include?(ENV["CI"])
 
   config.filter_run_excluding active_record: true unless active_record_available
+  unless defined?(ActiveSupport)
+    config.filter_run_excluding active_support: true
+  end
 
   config.order = :random
   Kernel.srand config.seed

data/spec/support/integration/helpers.rb

@@ -9,13 +9,13 @@ module SuperDiff
     def make_plain_test_program(
       test,
       color_enabled:,
-      configuration: {},
+      super_diff_configuration: {},
       preserve_as_whole_file: false
     )
       TestPrograms::Plain.new(
         test,
         color_enabled: color_enabled,
-        configuration: configuration,
+        super_diff_configuration: super_diff_configuration,
         preserve_as_whole_file: preserve_as_whole_file
       )
     end
@@ -32,15 +32,13 @@ module SuperDiff
       TestPrograms::RSpecRails.new(test, color_enabled: color_enabled)
     end
 
-    def make_rspec_rails_engine_program(
+    def make_rspec_rails_engine_with_action_controller_program(
       test,
-      color_enabled:,
-      combustion_initialize:
+      color_enabled:
     )
-      TestPrograms::RspecRailsEngine.new(
+      TestPrograms::RspecRailsEngineWithActionController.new(
         test,
-        color_enabled: color_enabled,
-        combustion_initialize: combustion_initialize
+        color_enabled: color_enabled
       )
     end
 
@@ -48,15 +46,17 @@ module SuperDiff
       color_enabled:,
       snippet:,
       expectation:,
+      test_name: "test passes",
       key_enabled: true,
       newline_before_expectation: false,
       indentation: 7,
-      diff: nil
+      diff: nil,
+      extra_failure_lines: nil
     )
       colored(color_enabled: color_enabled) do
         line "Failures:\n"
 
-        line "1) test passes", indent_by: 2
+        line "1) #{test_name}", indent_by: 2
 
         line indent_by: 5 do
           bold "Failure/Error: "
@@ -106,11 +106,19 @@ module SuperDiff
             newline
           end
         end
+
+        if extra_failure_lines
+          newline
+          evaluate_block(&extra_failure_lines)
+        end
       end
     end
 
     def colored(color_enabled: true, &block)
-      SuperDiff::Helpers.style(color_enabled: color_enabled, &block).to_s.chomp
+      SuperDiff::Core::Helpers
+        .style(color_enabled: color_enabled, &block)
+        .to_s
+        .chomp
     end
   end
 end

data/spec/support/integration/matchers/produce_output_when_run_matcher.rb

@@ -12,7 +12,7 @@ module SuperDiff
       end
 
       def removing_object_ids
-        first_replacing(/#<([\w:]+):0x[a-f0-9]+/, '#<\1')
+        first_replacing(/#<([\w_:]+):0x[a-f0-9]+/, '#<\1')
         self
       end
 

data/spec/support/integration/matchers.rb

@@ -32,6 +32,40 @@ module SuperDiff
       PassWithSinglelineFailureMessageMatcher.new
     end
 
+    RSpec::Matchers.define :failing_custom_matcher_from_dsl do |value|
+      match { false }
+
+      description do
+        "custom matcher defined via the DSL with value #{value.inspect}"
+      end
+    end
+
+    def failing_custom_matcher_from_scratch(value)
+      FailingCustomMatcherFromScratch.new(value)
+    end
+
+    class FailingCustomMatcherFromScratch
+      def initialize(value)
+        @value = value
+      end
+
+      def matches?(_)
+        false
+      end
+
+      def description
+        "custom matcher defined from scratch with value #{value.inspect}"
+      end
+
+      def failure_message
+        "Expected custom matcher not to fail, but did"
+      end
+
+      private
+
+      attr_reader :value
+    end
+
     class FailWithIndentedMultilineFailureMessageMatcher
       def matches?(_)
         false

data/spec/support/integration/test_programs/base.rb

@@ -13,12 +13,12 @@ module SuperDiff
         def initialize(
           code,
           color_enabled:,
-          configuration: {},
+          super_diff_configuration: {},
           preserve_as_whole_file: false
         )
           @code = code.strip
           @color_enabled = color_enabled
-          @configuration = configuration
+          @super_diff_configuration = super_diff_configuration
           @preserve_as_whole_file = preserve_as_whole_file
         end
 
@@ -38,7 +38,7 @@ module SuperDiff
 
         private
 
-        attr_reader :code, :configuration
+        attr_reader :code, :super_diff_configuration
 
         def color_enabled?
           @color_enabled
@@ -74,8 +74,8 @@ module SuperDiff
               color_option,
               "--no-pry",
               tempfile.to_s,
-              "--configuration",
-              JSON.generate(configuration)
+              "--super-diff-configuration",
+              JSON.generate(super_diff_configuration)
             ]
           else
             ["rspec", "--options", "/tmp/dummy-rspec-config", tempfile.to_s]
@@ -110,7 +110,7 @@ module SuperDiff
               test_plan = TestPlan.new(
                 using_outside_of_zeus: true,
                 color_enabled: #{color_enabled?.inspect},
-                configuration: #{configuration.inspect}
+                super_diff_configuration: #{super_diff_configuration.inspect}
               )
               #{test_plan_prelude}
               test_plan.#{test_plan_command}

data/spec/support/integration/test_programs/rspec_rails_engine.rb

@@ -1,29 +1,19 @@
 module SuperDiff
   module IntegrationTests
     module TestPrograms
-      class RspecRailsEngine < Base
-        def initialize(*args, combustion_initialize:, **options)
-          super(*args, **options)
-          @combustion_initialize = combustion_initialize
-        end
-
+      class RspecRailsEngineWithActionController < Base
         protected
 
         def test_plan_prelude
           <<~PRELUDE.strip
-            test_plan.boot_rails_engine(
-              combustion_initialize: #{combustion_initialize.inspect}
-            )
+            test_plan.boot
+            test_plan.boot_rails_engine_with_action_controller
           PRELUDE
         end
 
         def test_plan_command
           "run_rspec_rails_test"
         end
-
-        private
-
-        attr_reader :combustion_initialize
       end
     end
   end

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

@@ -3,6 +3,7 @@ module SuperDiff
     module Models
       module ActiveRecord
         class Person < ::ActiveRecord::Base
+          self.primary_key = "person_id"
         end
       end
     end
@@ -13,7 +14,13 @@ RSpec.configure do |config|
   config.before do
     ActiveRecord::Base
       .connection
-      .create_table(:people, force: true) do |t|
+      .create_table(
+        :people,
+        id: false,
+        primary_key: "person_id",
+        force: true
+      ) do |t|
+        t.primary_key :person_id, null: false
         t.string :name, null: false
         t.integer :age, null: false
       end

data/spec/support/shared_examples/active_record.rb

@@ -4,18 +4,18 @@ shared_examples_for "integration with ActiveRecord" do
       it "produces the correct output" do
         as_both_colored_and_uncolored do |color_enabled|
           snippet = <<~TEST.strip
-            expected = SuperDiff::Test::Models::ActiveRecord::ShippingAddress.new(
-              line_1: "123 Main St.",
-              city: "Hill Valley",
-              state: "CA",
-              zip: "90382",
-            )
             actual = SuperDiff::Test::Models::ActiveRecord::ShippingAddress.new(
               line_1: "456 Ponderosa Ct.",
               city: "Oakland",
               state: "CA",
               zip: "91234",
             )
+            expected = SuperDiff::Test::Models::ActiveRecord::ShippingAddress.new(
+              line_1: "123 Main St.",
+              city: "Hill Valley",
+              state: "CA",
+              zip: "90382",
+            )
             expect(actual).to eq(expected)
           TEST
           program = make_program(snippet, color_enabled: color_enabled)
@@ -63,16 +63,16 @@ shared_examples_for "integration with ActiveRecord" do
       it "produces the correct output" do
         as_both_colored_and_uncolored do |color_enabled|
           snippet = <<~TEST.strip
+            actual = SuperDiff::Test::Models::ActiveRecord::Person.new(
+              name: "Elliot",
+              age: 31,
+            )
             expected = SuperDiff::Test::Models::ActiveRecord::ShippingAddress.new(
               line_1: "123 Main St.",
               city: "Hill Valley",
               state: "CA",
               zip: "90382",
             )
-            actual = SuperDiff::Test::Models::ActiveRecord::Person.new(
-              name: "Elliot",
-              age: 31,
-            )
             expect(actual).to eq(expected)
           TEST
           program = make_program(snippet, color_enabled: color_enabled)
@@ -86,7 +86,7 @@ shared_examples_for "integration with ActiveRecord" do
                 proc do
                   line do
                     plain "Expected "
-                    actual %|#<SuperDiff::Test::Models::ActiveRecord::Person id: nil, age: 31, name: "Elliot">|
+                    actual %|#<SuperDiff::Test::Models::ActiveRecord::Person person_id: nil, age: 31, name: "Elliot">|
                   end
 
                   line do
@@ -107,13 +107,13 @@ shared_examples_for "integration with ActiveRecord" do
       it "produces the correct output" do
         as_both_colored_and_uncolored do |color_enabled|
           snippet = <<~TEST.strip
+            actual = nil
             expected = SuperDiff::Test::Models::ActiveRecord::ShippingAddress.new(
               line_1: "123 Main St.",
               city: "Hill Valley",
               state: "CA",
               zip: "90382"
             )
-            actual = nil
             expect(actual).to eq(expected)
           TEST
           program = make_program(snippet, color_enabled: color_enabled)
@@ -148,22 +148,22 @@ shared_examples_for "integration with ActiveRecord" do
       it "produces the correct output" do
         as_both_colored_and_uncolored do |color_enabled|
           snippet = <<~TEST.strip
-            expected = {
+            actual = {
               name: "Marty McFly",
               shipping_address: SuperDiff::Test::Models::ActiveRecord::ShippingAddress.new(
-                line_1: "123 Main St.",
-                city: "Hill Valley",
+                line_1: "456 Ponderosa Ct.",
+                city: "Oakland",
                 state: "CA",
-                zip: "90382",
+                zip: "91234",
               )
             }
-            actual = {
+            expected = {
               name: "Marty McFly",
               shipping_address: SuperDiff::Test::Models::ActiveRecord::ShippingAddress.new(
-                line_1: "456 Ponderosa Ct.",
-                city: "Oakland",
+                line_1: "123 Main St.",
+                city: "Hill Valley",
                 state: "CA",
-                zip: "91234",
+                zip: "90382",
               )
             }
             expect(actual).to eq(expected)
@@ -216,6 +216,13 @@ shared_examples_for "integration with ActiveRecord" do
       it "produces the correct output" do
         as_both_colored_and_uncolored do |color_enabled|
           snippet = <<~TEST.strip
+            actual = {
+              name: "Marty McFly",
+              shipping_address: SuperDiff::Test::Models::ActiveRecord::Person.new(
+                name: "Elliot",
+                age: 31,
+              )
+            }
             expected = {
               name: "Marty McFly",
               shipping_address: SuperDiff::Test::Models::ActiveRecord::ShippingAddress.new(
@@ -225,13 +232,6 @@ shared_examples_for "integration with ActiveRecord" do
                 zip: "90382",
               )
             }
-            actual = {
-              name: "Marty McFly",
-              shipping_address: SuperDiff::Test::Models::ActiveRecord::Person.new(
-                name: "Elliot",
-                age: 31,
-              )
-            }
             expect(actual).to eq(expected)
           TEST
           program = make_program(snippet, color_enabled: color_enabled)
@@ -244,7 +244,7 @@ shared_examples_for "integration with ActiveRecord" do
                 proc do
                   line do
                     plain "Expected "
-                    actual %|{ name: "Marty McFly", shipping_address: #<SuperDiff::Test::Models::ActiveRecord::Person id: nil, age: 31, name: "Elliot"> }|
+                    actual %|{ name: "Marty McFly", shipping_address: #<SuperDiff::Test::Models::ActiveRecord::Person person_id: nil, age: 31, name: "Elliot"> }|
                   end
 
                   line do
@@ -265,7 +265,7 @@ shared_examples_for "integration with ActiveRecord" do
                   expected_line %|-     zip: "90382"|
                   expected_line "-   }>"
                   actual_line "+   shipping_address: #<SuperDiff::Test::Models::ActiveRecord::Person {"
-                  actual_line "+     id: nil,"
+                  actual_line "+     person_id: nil,"
                   actual_line "+     age: 31,"
                   actual_line %|+     name: "Elliot"|
                   actual_line "+   }>"
@@ -299,8 +299,8 @@ shared_examples_for "integration with ActiveRecord" do
                 zip: "91234",
               )
             ]
-            expected = [shipping_addresses.first]
             actual = SuperDiff::Test::Models::ActiveRecord::ShippingAddress.all
+            expected = [shipping_addresses.first]
             expect(actual).to eq(expected)
           TEST
           program = make_program(snippet, color_enabled: color_enabled)
@@ -362,6 +362,12 @@ shared_examples_for "integration with ActiveRecord" do
               age: 20
             )
 
+            actual = [
+              SuperDiff::Test::Models::ActiveRecord::Query.new(
+                results: SuperDiff::Test::Models::ActiveRecord::Person.all
+              )
+            ]
+
             expected = [
               an_object_having_attributes(
                 results: [
@@ -370,12 +376,6 @@ shared_examples_for "integration with ActiveRecord" do
               )
             ]
 
-            actual = [
-              SuperDiff::Test::Models::ActiveRecord::Query.new(
-                results: SuperDiff::Test::Models::ActiveRecord::Person.all
-              )
-            ]
-
             expect(actual).to match(expected)
           TEST
 
@@ -390,7 +390,7 @@ shared_examples_for "integration with ActiveRecord" do
                 proc do
                   line do
                     plain "Expected "
-                    actual %|[#<SuperDiff::Test::Models::ActiveRecord::Query @results=#<ActiveRecord::Relation [#<SuperDiff::Test::Models::ActiveRecord::Person id: 1, age: 20, name: "Murphy">]>>]|
+                    actual %|[#<SuperDiff::Test::Models::ActiveRecord::Query @results=#<ActiveRecord::Relation [#<SuperDiff::Test::Models::ActiveRecord::Person person_id: 1, age: 20, name: "Murphy">]>>]|
                   end
 
                   line do
@@ -404,7 +404,7 @@ shared_examples_for "integration with ActiveRecord" do
                   plain_line "    #<SuperDiff::Test::Models::ActiveRecord::Query {"
                   plain_line "      @results=#<ActiveRecord::Relation ["
                   plain_line "        #<SuperDiff::Test::Models::ActiveRecord::Person {"
-                  plain_line "          id: 1,"
+                  plain_line "          person_id: 1,"
                   # expected_line %|-         age: 19,|  # TODO
                   expected_line "-         age: 19"
                   actual_line "+         age: 20,"

data/spec/support/shared_examples/active_support.rb

@@ -4,9 +4,9 @@ shared_examples_for "integration with ActiveSupport" 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, 15, 15, 16).in_time_zone("Europe/Stockholm")
-          expect(expected).to eq(actual)
+          actual = Time.utc(2011, 12, 13, 14, 15, 16)
+          expected = Time.utc(2011, 12, 13, 15, 15, 16).in_time_zone("Europe/Stockholm")
+          expect(actual).to eq(expected)
         RUBY
         program =
           make_rspec_rails_test_program(snippet, color_enabled: color_enabled)
@@ -14,7 +14,7 @@ shared_examples_for "integration with ActiveSupport" do
         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
@@ -64,4 +64,125 @@ shared_examples_for "integration with ActiveSupport" do
       end
     end
   end
+
+  context "when comparing OrderedOptions and Hash instances",
+          active_record: true do
+    it "produces the correct failure message when used in the positive" do
+      as_both_colored_and_uncolored do |color_enabled|
+        snippet = <<~RUBY
+          actual = {beep: :bip}
+          expected = ::ActiveSupport::OrderedOptions[beep: :boop]
+          expect(actual).to eq(expected)
+        RUBY
+        program =
+          make_rspec_rails_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 "{ beep: :bip }"
+                  plain " to eq "
+                  expected "#<OrderedOptions { beep: :boop }>"
+                  plain "."
+                end
+              end,
+            diff:
+              proc do
+                plain_line "  {"
+                expected_line "-   beep: :boop"
+                actual_line "+   beep: :bip"
+                plain_line "  }"
+              end
+          )
+
+        expect(program).to produce_output_when_run(expected_output).in_color(
+          color_enabled
+        )
+      end
+    end
+  end
+
+  context "when comparing Date instance and date-like DateTime instance for same day",
+          active_record: true 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 = DateTime.new(2023, 10, 14, 18, 22, 26)
+          expect(actual).to eq(expected)
+        RUBY
+        program =
+          make_rspec_rails_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 "#<DateTime 2023-10-14 18:22:26 +00:00 (+00:00)>"
+                  plain "."
+                end
+              end
+          )
+
+        expect(program).to produce_output_when_run(expected_output).in_color(
+          color_enabled
+        )
+      end
+    end
+  end
+
+  context "when comparing Date instance and date-like DateTime instance for another day",
+          active_record: true do
+    it "produces the diff for date like objects comparison" do
+      as_both_colored_and_uncolored do |color_enabled|
+        snippet = <<~RUBY
+          actual = Date.new(2023, 10, 14)
+          expected = DateTime.new(2023, 10, 31, 18, 22, 26)
+          expect(actual).to eq(expected)
+        RUBY
+        program =
+          make_rspec_rails_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 "#<DateTime 2023-10-31 18:22:26 +00:00 (+00:00)>"
+                  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
+  end
 end