super_diff 0.11.0 → 0.13.0

data/spec/spec_helper.rb

@@ -68,6 +68,7 @@ RSpec.configure do |config|
   unless defined?(ActiveSupport)
     config.filter_run_excluding active_support: true
   end
+  config.filter_run_excluding with_superdiff_rspec: false
 
   config.order = :random
   Kernel.srand config.seed

data/spec/support/integration/helpers.rb

@@ -115,7 +115,10 @@ module SuperDiff
     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/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/models/point.rb

@@ -0,0 +1,7 @@
+if defined?(Data)
+  module SuperDiff
+    module Test
+      Point = Data.define(:x, :y)
+    end
+  end
+end

data/spec/support/shared_examples/active_record.rb

@@ -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
@@ -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 "+   }>"
@@ -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/unit/helpers.rb

@@ -1,5 +1,7 @@
 module SuperDiff
   module UnitTests
+    extend self
+
     def with_configuration(configuration)
       old_configuration = SuperDiff.configuration.dup
       SuperDiff.configuration.merge!(configuration)
@@ -7,7 +9,16 @@ module SuperDiff
     end
 
     def colored(*args, **opts, &block)
-      SuperDiff::Helpers.style(*args, **opts, &block).to_s.chomp
+      SuperDiff::Core::Helpers.style(*args, **opts, &block).to_s.chomp
+    end
+
+    def capture_warnings
+      fake_stderr = StringIO.new
+      original_stderr = $stderr
+      $stderr = fake_stderr
+      yield
+      $stderr = original_stderr
+      fake_stderr.string
     end
   end
 end

data/spec/support/unit/matchers/be_deprecated_in_favor_of.rb

@@ -0,0 +1,39 @@
+module SuperDiff
+  module UnitTests
+    def be_deprecated_in_favor_of(new_constant_name)
+      BeDeprecatedInFavorOfMatcher.new(new_constant_name)
+    end
+
+    class BeDeprecatedInFavorOfMatcher
+      extend AttrExtras.mixin
+
+      pattr_initialize :new_constant_name
+      attr_private :actual_output, :old_constant_name
+
+      def matches?(old_constant_name)
+        @old_constant_name = old_constant_name
+        @actual_output =
+          SuperDiff::UnitTests.capture_warnings do
+            Object.const_get(old_constant_name)
+          end
+        @actual_output.start_with?(expected_prefix)
+      end
+
+      def failure_message
+        "Expected stderr to start with:\n\n" +
+          SuperDiff::Test::OutputHelpers.bookended(expected_prefix) + "\n" +
+          "Actual output:\n\n" +
+          SuperDiff::Test::OutputHelpers.bookended(actual_output)
+      end
+
+      private
+
+      def expected_prefix
+        <<~EOT.rstrip
+          WARNING: #{old_constant_name} is deprecated and will be removed in the next major release.
+          Please use #{new_constant_name} instead.
+        EOT
+      end
+    end
+  end
+end

data/spec/unit/active_record/object_inspection_spec.rb

@@ -14,7 +14,7 @@ RSpec.describe SuperDiff, type: :unit do
               as_lines: false
             )
           expect(string).to eq(
-            %(#<SuperDiff::Test::Models::ActiveRecord::Person id: nil, age: 31, name: "Elliot">)
+            %(#<SuperDiff::Test::Models::ActiveRecord::Person person_id: nil, age: 31, name: "Elliot">)
           )
         end
       end
@@ -42,7 +42,7 @@ RSpec.describe SuperDiff, type: :unit do
               an_object_having_attributes(
                 type: :delete,
                 indentation_level: 2,
-                prefix: "id: ",
+                prefix: "person_id: ",
                 value: "nil",
                 add_comma: true
               ),
@@ -91,7 +91,7 @@ RSpec.describe SuperDiff, type: :unit do
             )
 
           expect(string).to eq(
-            %(#<ActiveRecord::Relation [#<SuperDiff::Test::Models::ActiveRecord::Person id: 1, age: 19, name: "Marty">, #<SuperDiff::Test::Models::ActiveRecord::Person id: 2, age: 17, name: "Jennifer">]>)
+            %(#<ActiveRecord::Relation [#<SuperDiff::Test::Models::ActiveRecord::Person person_id: 1, age: 19, name: "Marty">, #<SuperDiff::Test::Models::ActiveRecord::Person person_id: 2, age: 17, name: "Jennifer">]>)
           )
         end
       end
@@ -132,7 +132,7 @@ RSpec.describe SuperDiff, type: :unit do
               an_object_having_attributes(
                 type: :delete,
                 indentation_level: 3,
-                prefix: "id: ",
+                prefix: "person_id: ",
                 value: "1",
                 add_comma: true
               ),
@@ -165,7 +165,7 @@ RSpec.describe SuperDiff, type: :unit do
               an_object_having_attributes(
                 type: :delete,
                 indentation_level: 3,
-                prefix: "id: ",
+                prefix: "person_id: ",
                 value: "2",
                 add_comma: true
               ),

data/spec/unit/basic/inspection_tree_builders/data_object_spec.rb

@@ -0,0 +1,146 @@
+require "spec_helper"
+
+if defined?(Data)
+  RSpec.describe SuperDiff, type: :unit do
+    describe ".inspect_object" do
+      context "given as_lines: false" do
+        subject(:output) do
+          described_class.inspect_object(object, as_lines: false)
+        end
+
+        context "given an anonymous Data object" do
+          let(:object) { Data.define(:x, :y).new(1, 2) }
+
+          it "shows the data" do
+            expect(output).to eq("#<data  x: 1, y: 2>")
+          end
+        end
+
+        context "given a named Data object" do
+          let(:object) { SuperDiff::Test::Point.new(1, 2) }
+
+          it "shows the data" do
+            expect(output).to eq("#<data SuperDiff::Test::Point x: 1, y: 2>")
+          end
+        end
+
+        context "given a Data object that defines #attributes_for_super_diff" do
+          let(:klass) do
+            Data.define(:x, :y) do
+              def attributes_for_super_diff
+                { beep: :boop }
+              end
+            end
+          end
+          let(:object) { klass.new(1, 2) }
+
+          it "uses the custom attributes" do
+            expect(output).to start_with("#<#<Class:0x").and end_with(
+                    "beep: :boop>"
+                  )
+          end
+        end
+      end
+
+      context "given as_lines: true" do
+        subject(:tiered_lines) do
+          described_class.inspect_object(
+            object,
+            as_lines: true,
+            type: :noop,
+            indentation_level: 1
+          )
+        end
+
+        context "given an anonymous Data object" do
+          let(:object) { Data.define(:x, :y).new(1, 2) }
+
+          it "shows the data" do
+            expect(tiered_lines).to match(
+              [
+                an_object_having_attributes(
+                  value: "#<data  {",
+                  collection_bookend: :open
+                ),
+                an_object_having_attributes(
+                  prefix: "x: ",
+                  value: "1",
+                  add_comma: true
+                ),
+                an_object_having_attributes(
+                  prefix: "y: ",
+                  value: "2",
+                  add_comma: false
+                ),
+                an_object_having_attributes(
+                  value: "}>",
+                  collection_bookend: :close
+                )
+              ]
+            )
+          end
+        end
+
+        context "given a named Data object" do
+          let(:object) { SuperDiff::Test::Point.new(1, 2) }
+
+          it "shows the data" do
+            expect(tiered_lines).to match(
+              [
+                an_object_having_attributes(
+                  value: "#<data SuperDiff::Test::Point {",
+                  collection_bookend: :open
+                ),
+                an_object_having_attributes(
+                  prefix: "x: ",
+                  value: "1",
+                  add_comma: true
+                ),
+                an_object_having_attributes(
+                  prefix: "y: ",
+                  value: "2",
+                  add_comma: false
+                ),
+                an_object_having_attributes(
+                  value: "}>",
+                  collection_bookend: :close
+                )
+              ]
+            )
+          end
+        end
+
+        context "given a Data object that defines #attributes_for_super_diff" do
+          let(:klass) do
+            Data.define(:x, :y) do
+              def attributes_for_super_diff
+                { beep: :boop }
+              end
+            end
+          end
+          let(:object) { klass.new(1, 2) }
+
+          it "uses the custom attributes" do
+            expect(tiered_lines).to match(
+              [
+                an_object_having_attributes(
+                  value: /\A#<#<Class:0x.*> {/,
+                  collection_bookend: :open
+                ),
+                an_object_having_attributes(
+                  prefix: "beep: ",
+                  value: ":boop",
+                  add_comma: false
+                ),
+                an_object_having_attributes(
+                  value: "}>",
+                  collection_bookend: :close
+                )
+              ]
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/spec/unit/basic/operation_tree_builders/data_object_spec.rb

@@ -0,0 +1,82 @@
+require "spec_helper"
+
+if defined?(Data)
+  RSpec.describe SuperDiff, type: :unit do
+    describe ".diff" do
+      subject(:diff) { described_class.diff(a, b) }
+
+      context "when given two Data objects of the same class" do
+        let(:a) { SuperDiff::Test::Point.new(1, 2) }
+        let(:b) { SuperDiff::Test::Point.new(1, 3) }
+
+        it "diffs their member attributes" do
+          expected_output =
+            SuperDiff::Core::Helpers
+              .style(color_enabled: true) do
+                plain_line "  #<SuperDiff::Test::Point {"
+                plain_line "    x: 1,"
+                expected_line "-   y: 2"
+                actual_line "+   y: 3"
+                plain_line "  }>"
+              end
+              .to_s
+              .chomp
+
+          expect(diff).to eq(expected_output)
+        end
+
+        context "when the Data class defines #attributes_for_super_diff" do
+          let(:klass) do
+            Class.new(Data.define(:attribute)) do
+              def self.to_s = "TestClass"
+
+              def attributes_for_super_diff
+                { attribute: :does_not_matter }
+              end
+            end
+          end
+
+          let(:a) { klass.new(1) }
+          let(:b) { klass.new(2) }
+
+          it "diffs their member attributes" do
+            expected_output =
+              SuperDiff::Core::Helpers
+                .style(color_enabled: true) do
+                  plain_line "  #<TestClass {"
+                  expected_line "-   attribute: 1"
+                  actual_line "+   attribute: 2"
+                  plain_line "  }>"
+                end
+                .to_s
+                .chomp
+
+            expect(diff).to eq(expected_output)
+          end
+        end
+      end
+
+      context "when given two Data objects of different classes" do
+        let(:a) { SuperDiff::Test::Point.new(1, 2) }
+        let(:b) { Data.define(:one, :two).new(1, 2) }
+
+        it "raises" do
+          expect { SuperDiff.diff(a, b) }.to raise_error(
+            SuperDiff::Core::NoDifferAvailableError
+          )
+        end
+      end
+
+      context "when given a Data object and a hash" do
+        let(:a) { Data.define(:one, :two).new(1, 2) }
+        let(:b) { { one: 1, two: 2 } }
+
+        it "raises" do
+          expect { SuperDiff.diff(a, b) }.to raise_error(
+            SuperDiff::Core::NoDifferAvailableError
+          )
+        end
+      end
+    end
+  end
+end

data/spec/unit/{operation_tree_flatteners → basic/operation_tree_flatteners}/array_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-RSpec.describe SuperDiff::OperationTreeFlatteners::Array do
+RSpec.describe SuperDiff::Basic::OperationTreeFlatteners::Array do
   context "given an empty tree" do
     it "returns a set of lines which are simply the open token and close token" do
       expect(described_class.call([])).to match(
@@ -30,7 +30,7 @@ RSpec.describe SuperDiff::OperationTreeFlatteners::Array do
     it "returns a series of lines from inspecting each value, creating multiple lines upon encountering inner data structures" do
       collection = Array.new(3) { :some_value }
       operation_tree =
-        SuperDiff::OperationTrees::Array.new(
+        SuperDiff::Basic::OperationTrees::Array.new(
           [
             double(
               :operation,
@@ -134,7 +134,7 @@ RSpec.describe SuperDiff::OperationTreeFlatteners::Array do
       expected = Array.new(3) { :some_value }
       actual = Array.new(4) { :some_value }
       operation_tree =
-        SuperDiff::OperationTrees::Array.new(
+        SuperDiff::Basic::OperationTrees::Array.new(
           [
             double(
               :operation,
@@ -266,7 +266,7 @@ RSpec.describe SuperDiff::OperationTreeFlatteners::Array do
       collection = Array.new(3) { :some_value }
       subcollection = Array.new(2) { :some_value }
       operation_tree =
-        SuperDiff::OperationTrees::Array.new(
+        SuperDiff::Basic::OperationTrees::Array.new(
           [
             double(
               :operation,
@@ -283,7 +283,7 @@ RSpec.describe SuperDiff::OperationTreeFlatteners::Array do
               right_collection: collection,
               right_index: 1,
               children:
-                SuperDiff::OperationTrees::Array.new(
+                SuperDiff::Basic::OperationTrees::Array.new(
                   [
                     double(
                       :operation,
@@ -406,7 +406,7 @@ RSpec.describe SuperDiff::OperationTreeFlatteners::Array do
       right_collection << right_collection
 
       operation_tree =
-        SuperDiff::OperationTrees::Array.new(
+        SuperDiff::Basic::OperationTrees::Array.new(
           [
             double(
               :operation,
@@ -502,7 +502,7 @@ RSpec.describe SuperDiff::OperationTreeFlatteners::Array do
       right_subcollection << right_subcollection
 
       operation_tree =
-        SuperDiff::OperationTrees::Array.new(
+        SuperDiff::Basic::OperationTrees::Array.new(
           [
             double(
               :operation,
@@ -519,7 +519,7 @@ RSpec.describe SuperDiff::OperationTreeFlatteners::Array do
               right_collection: collection,
               right_index: 1,
               children:
-                SuperDiff::OperationTrees::Array.new(
+                SuperDiff::Basic::OperationTrees::Array.new(
                   [
                     double(
                       :operation,

data/spec/unit/{operation_tree_flatteners → basic/operation_tree_flatteners}/custom_object_spec.rb

@@ -1,10 +1,10 @@
 require "spec_helper"
 
-RSpec.describe SuperDiff::OperationTreeFlatteners::CustomObject do
+RSpec.describe SuperDiff::Basic::OperationTreeFlatteners::CustomObject do
   context "given an empty tree" do
     it "returns a set of lines which are simply the open token and close token" do
       operation_tree =
-        SuperDiff::OperationTrees::CustomObject.new(
+        SuperDiff::Basic::OperationTrees::CustomObject.new(
           [],
           underlying_object: underlying_object
         )
@@ -38,7 +38,7 @@ RSpec.describe SuperDiff::OperationTreeFlatteners::CustomObject do
     it "returns a series of lines from inspecting each value, creating multiple lines upon encountering inner data structures" do
       collection = Array.new(3) { :some_value }
       operation_tree =
-        SuperDiff::OperationTrees::CustomObject.new(
+        SuperDiff::Basic::OperationTrees::CustomObject.new(
           [
             double(
               :operation,
@@ -146,7 +146,7 @@ RSpec.describe SuperDiff::OperationTreeFlatteners::CustomObject do
       expected = Array.new(3) { :some_value }
       actual = Array.new(4) { :some_value }
       operation_tree =
-        SuperDiff::OperationTrees::CustomObject.new(
+        SuperDiff::Basic::OperationTrees::CustomObject.new(
           [
             double(
               :operation,
@@ -284,7 +284,7 @@ RSpec.describe SuperDiff::OperationTreeFlatteners::CustomObject do
       collection = Array.new(3) { :some_value }
       subcollection = Array.new(2) { :some_value }
       operation_tree =
-        SuperDiff::OperationTrees::CustomObject.new(
+        SuperDiff::Basic::OperationTrees::CustomObject.new(
           [
             double(
               :operation,
@@ -304,7 +304,7 @@ RSpec.describe SuperDiff::OperationTreeFlatteners::CustomObject do
               right_key: :baz,
               right_index: 1,
               children:
-                SuperDiff::OperationTrees::CustomObject.new(
+                SuperDiff::Basic::OperationTrees::CustomObject.new(
                   [
                     double(
                       :operation,
@@ -435,7 +435,7 @@ RSpec.describe SuperDiff::OperationTreeFlatteners::CustomObject do
           .tap { |collection| collection << right_collection }
 
       operation_tree =
-        SuperDiff::OperationTrees::CustomObject.new(
+        SuperDiff::Basic::OperationTrees::CustomObject.new(
           [
             double(
               :operation,
@@ -536,7 +536,7 @@ RSpec.describe SuperDiff::OperationTreeFlatteners::CustomObject do
         Array.new(1) { :some_value }.tap { |coll| coll << right_subcollection }
 
       operation_tree =
-        SuperDiff::OperationTrees::CustomObject.new(
+        SuperDiff::Basic::OperationTrees::CustomObject.new(
           [
             double(
               :operation,
@@ -556,7 +556,7 @@ RSpec.describe SuperDiff::OperationTreeFlatteners::CustomObject do
               right_key: :baz,
               right_index: 1,
               children:
-                SuperDiff::OperationTrees::CustomObject.new(
+                SuperDiff::Basic::OperationTrees::CustomObject.new(
                   [
                     double(
                       :operation,

data/spec/unit/{operation_tree_flatteners → basic/operation_tree_flatteners}/default_object_spec.rb

@@ -1,10 +1,10 @@
 require "spec_helper"
 
-RSpec.describe SuperDiff::OperationTreeFlatteners::DefaultObject do
+RSpec.describe SuperDiff::Basic::OperationTreeFlatteners::DefaultObject do
   context "given an empty tree" do
     it "returns a set of lines which are simply the open token and close token" do
       operation_tree =
-        SuperDiff::OperationTrees::DefaultObject.new(
+        SuperDiff::Basic::OperationTrees::DefaultObject.new(
           [],
           underlying_object: underlying_object
         )
@@ -38,7 +38,7 @@ RSpec.describe SuperDiff::OperationTreeFlatteners::DefaultObject do
     it "returns a series of lines from inspecting each value, creating multiple lines upon encountering inner data structures" do
       collection = Array.new(3) { :some_value }
       operation_tree =
-        SuperDiff::OperationTrees::DefaultObject.new(
+        SuperDiff::Basic::OperationTrees::DefaultObject.new(
           [
             double(
               :operation,
@@ -146,7 +146,7 @@ RSpec.describe SuperDiff::OperationTreeFlatteners::DefaultObject do
       expected = Array.new(3) { :some_value }
       actual = Array.new(4) { :some_value }
       operation_tree =
-        SuperDiff::OperationTrees::DefaultObject.new(
+        SuperDiff::Basic::OperationTrees::DefaultObject.new(
           [
             double(
               :operation,
@@ -284,7 +284,7 @@ RSpec.describe SuperDiff::OperationTreeFlatteners::DefaultObject do
       collection = Array.new(3) { :some_value }
       subcollection = Array.new(2) { :some_value }
       operation_tree =
-        SuperDiff::OperationTrees::DefaultObject.new(
+        SuperDiff::Basic::OperationTrees::DefaultObject.new(
           [
             double(
               :operation,
@@ -304,7 +304,7 @@ RSpec.describe SuperDiff::OperationTreeFlatteners::DefaultObject do
               right_key: :baz,
               right_index: 1,
               children:
-                SuperDiff::OperationTrees::DefaultObject.new(
+                SuperDiff::Basic::OperationTrees::DefaultObject.new(
                   [
                     double(
                       :operation,
@@ -435,7 +435,7 @@ RSpec.describe SuperDiff::OperationTreeFlatteners::DefaultObject do
           .tap { |collection| collection << right_collection }
 
       operation_tree =
-        SuperDiff::OperationTrees::DefaultObject.new(
+        SuperDiff::Basic::OperationTrees::DefaultObject.new(
           [
             double(
               :operation,
@@ -536,7 +536,7 @@ RSpec.describe SuperDiff::OperationTreeFlatteners::DefaultObject do
         Array.new(1) { :some_value }.tap { |coll| coll << right_subcollection }
 
       operation_tree =
-        SuperDiff::OperationTrees::DefaultObject.new(
+        SuperDiff::Basic::OperationTrees::DefaultObject.new(
           [
             double(
               :operation,
@@ -556,7 +556,7 @@ RSpec.describe SuperDiff::OperationTreeFlatteners::DefaultObject do
               right_key: :baz,
               right_index: 1,
               children:
-                SuperDiff::OperationTrees::DefaultObject.new(
+                SuperDiff::Basic::OperationTrees::DefaultObject.new(
                   [
                     double(
                       :operation,