super_diff 0.4.0 → 0.5.2

data/lib/super_diff/{operational_sequencers → operation_tree_builders}/custom_object.rb

@@ -1,5 +1,5 @@
 module SuperDiff
-  module OperationalSequencers
+  module OperationTreeBuilders
     class CustomObject < DefaultObject
       def self.applies_to?(expected, actual)
         expected.class == actual.class &&
@@ -7,9 +7,9 @@ module SuperDiff
           actual.respond_to?(:attributes_for_super_diff)
       end
 
-      def build_operation_sequencer
+      def build_operation_tree
         # XXX This assumes that `expected` and `actual` are the same
-        OperationSequences::CustomObject.new([], value_class: expected.class)
+        OperationTrees::CustomObject.new([], value_class: expected.class)
       end
 
       def attribute_names

data/lib/super_diff/{operational_sequencers → operation_tree_builders}/default_object.rb

@@ -1,5 +1,5 @@
 module SuperDiff
-  module OperationalSequencers
+  module OperationTreeBuilders
     class DefaultObject < Base
       def self.applies_to?(_expected, _actual)
         true
@@ -22,9 +22,14 @@ module SuperDiff
         end
       end
 
-      def build_operation_sequencer
+      def build_operation_tree
         # XXX This assumes that `expected` and `actual` are the same
-        OperationSequences::DefaultObject.new([], value_class: expected.class)
+        # TODO: Does this need to be find_operation_tree_for?
+        OperationTrees::DefaultObject.new([], value_class: expected.class)
+      end
+
+      def find_operation_tree_for(value)
+        OperationTrees::Main.call(value)
       end
 
       def attribute_names

data/lib/super_diff/operation_tree_builders/defaults.rb

@@ -0,0 +1,5 @@
+module SuperDiff
+  module OperationTreeBuilders
+    DEFAULTS = [Array, Hash, CustomObject].freeze
+  end
+end

data/lib/super_diff/operation_tree_builders/hash.rb

@@ -0,0 +1,226 @@
+module SuperDiff
+  module OperationTreeBuilders
+    class Hash < Base
+      def self.applies_to?(expected, actual)
+        expected.is_a?(::Hash) && actual.is_a?(::Hash)
+      end
+
+      protected
+
+      def unary_operations
+        unary_operations_using_variant_of_patience_algorithm
+      end
+
+      def build_operation_tree
+        OperationTrees::Hash.new([])
+      end
+
+      private
+
+      def unary_operations_using_variant_of_patience_algorithm
+        operations = []
+        aks, eks = actual.keys, expected.keys
+        previous_ei, ei = nil, 0
+        ai = 0
+
+        # When diffing a hash, we're more interested in the 'actual' version
+        # than the 'expected' version, because that's the ultimate truth.
+        # Therefore, the diff is presented from the perspective of the 'actual'
+        # hash, and we start off by looping over it.
+        while ai < aks.size
+          ak = aks[ai]
+          av, ev = actual[ak], expected[ak]
+          # While we iterate over 'actual' in order, we jump all over
+          # 'expected', trying to match up its keys with the keys in 'actual' as
+          # much as possible.
+          ei = eks.index(ak)
+
+          if should_add_noop_operation?(ak)
+            # (If we're here, it probably means that the key we're pointing to
+            # in the 'actual' and 'expected' hashes have the same value.)
+
+            if ei && previous_ei && (ei - previous_ei) > 1
+              # If we've jumped from one operation in the 'expected' hash to
+              # another operation later in 'expected' (due to the fact that the
+              # 'expected' hash is in a different order than 'actual'), collect
+              # any delete operations in between and add them to our operations
+              # array as deletes before adding the noop. If we don't do this
+              # now, then those deletes will disappear. (Again, we are mainly
+              # iterating over 'actual', so this is the only way to catch all of
+              # the keys in 'expected'.)
+              (previous_ei + 1).upto(ei - 1) do |ei2|
+                ek = eks[ei2]
+                ev2, av2 = expected[ek], actual[ek]
+
+                if (
+                  (!actual.include?(ek) || ev != av2) &&
+                  operations.none? { |operation|
+                    [:delete, :noop].include?(operation.name) &&
+                      operation.key == ek
+                  }
+                )
+                  operations << Operations::UnaryOperation.new(
+                    name: :delete,
+                    collection: expected,
+                    key: ek,
+                    value: ev2,
+                    index: ei2,
+                    index_in_collection: ei2,
+                  )
+                end
+              end
+            end
+
+            operations << Operations::UnaryOperation.new(
+              name: :noop,
+              collection: actual,
+              key: ak,
+              value: av,
+              index: ai,
+              index_in_collection: ai,
+            )
+          else
+            # (If we're here, it probably means that the key in 'actual' isn't
+            # present in 'expected' or the values don't match.)
+
+            if (
+              (operations.empty? || operations.last.name == :noop) &&
+              (ai == 0 || eks.include?(aks[ai - 1]))
+            )
+              # If we go from a match in the last iteration to a missing or
+              # extra key in this one, or we're at the first key in 'actual' and
+              # it's missing or extra, look for deletes in the 'expected' hash
+              # and add them to our list of operations before we add the
+              # inserts. In most cases we will accomplish this by backtracking a
+              # bit to the key in 'expected' that matched the key in 'actual' we
+              # processed in the previous iteration (or just the first key in
+              # 'expected' if this is the first key in 'actual'), and then
+              # iterating from there through 'expected' until we reach the end
+              # or we hit some other condition (see below).
+
+              start_index =
+                if ai > 0
+                  eks.index(aks[ai - 1]) + 1
+                else
+                  0
+                end
+
+              start_index.upto(eks.size - 1) do |ei2|
+                ek = eks[ei2]
+                ev, av2 = expected[ek], actual[ek]
+
+                if actual.include?(ek) && ev == av2
+                  # If the key in 'expected' we've landed on happens to be a
+                  # match in 'actual', then stop, because it's going to be
+                  # handled in some future iteration of the 'actual' loop.
+                  break
+                elsif (
+                  aks[ai + 1 .. -1].any? { |k|
+                    expected.include?(k) && expected[k] != actual[k]
+                  }
+                )
+                  # While we backtracked a bit to iterate over 'expected', we
+                  # now have to look ahead. If we will end up encountering a
+                  # insert that matches this delete later, stop and go back to
+                  # iterating over 'actual'. This is because the delete we would
+                  # have added now will be added later when we encounter the
+                  # associated insert, so we don't want to add it twice.
+                  break
+                else
+                  operations << Operations::UnaryOperation.new(
+                    name: :delete,
+                    collection: expected,
+                    key: ek,
+                    value: ev,
+                    index: ei2,
+                    index_in_collection: ei2,
+                  )
+                end
+
+                if ek == ak && ev != av
+                  # If we're pointing to the same key in 'expected' as in
+                  # 'actual', but with different values, go ahead and add an
+                  # insert now to accompany the delete added above. That way
+                  # they appear together, which will be easier to read.
+                  operations << Operations::UnaryOperation.new(
+                    name: :insert,
+                    collection: actual,
+                    key: ak,
+                    value: av,
+                    index: ai,
+                    index_in_collection: ai,
+                  )
+                end
+              end
+            end
+
+            if (
+              expected.include?(ak) &&
+              ev != av &&
+              operations.none? { |op| op.name == :delete && op.key == ak }
+            )
+              # If we're here, it means that we didn't encounter any delete
+              # operations above for whatever reason and so we need to add a
+              # delete to represent the fact that the value for this key has
+              # changed.
+              operations << Operations::UnaryOperation.new(
+                name: :delete,
+                collection: expected,
+                key: ak,
+                value: expected[ak],
+                index: ei,
+                index_in_collection: ei,
+              )
+            end
+
+            if operations.none? { |op| op.name == :insert && op.key == ak }
+              # If we're here, it means that we didn't encounter any insert
+              # operations above. Since we already handled delete, the only
+              # alternative is that this key must not exist in 'expected', so
+              # we need to add an insert.
+              operations << Operations::UnaryOperation.new(
+                name: :insert,
+                collection: actual,
+                key: ak,
+                value: av,
+                index: ai,
+                index_in_collection: ai,
+              )
+            end
+          end
+
+          ai += 1
+          previous_ei = ei
+        end
+
+        # The last thing to do is this: if there are keys in 'expected' that
+        # aren't in 'actual', and they aren't associated with any inserts to
+        # where they would have been added above, tack those deletes onto the
+        # end of our operations array.
+        (eks - aks - operations.map(&:key)).each do |ek|
+          ei = eks.index(ek)
+          ev = expected[ek]
+
+          operations << Operations::UnaryOperation.new(
+            name: :delete,
+            collection: expected,
+            key: ek,
+            value: ev,
+            index: ei,
+            index_in_collection: ei,
+          )
+        end
+
+        operations
+      end
+
+      def should_add_noop_operation?(key)
+        expected.include?(key) && expected[key] == actual[key]
+      end
+
+      def all_keys
+        actual.keys | expected.keys
+      end
+    end
+  end
+end

data/lib/super_diff/operation_tree_builders/main.rb

@@ -0,0 +1,42 @@
+module SuperDiff
+  module OperationTreeBuilders
+    class Main
+      extend AttrExtras.mixin
+
+      method_object [:expected!, :actual!, :all_or_nothing!]
+
+      def call
+        if resolved_class
+          resolved_class.call(
+            expected: expected,
+            actual: actual,
+          )
+        elsif all_or_nothing?
+          raise NoOperationTreeBuilderAvailableError.create(expected, actual)
+        else
+          nil
+        end
+      end
+
+      private
+
+      attr_query :all_or_nothing?
+
+      def resolved_class
+        available_classes.find { |klass| klass.applies_to?(expected, actual) }
+      end
+
+      def available_classes
+        classes =
+          SuperDiff.configuration.extra_operation_tree_builder_classes +
+          DEFAULTS
+
+        if all_or_nothing?
+          classes + [DefaultObject]
+        else
+          classes
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/{operational_sequencers → operation_tree_builders}/multiline_string.rb

@@ -1,5 +1,5 @@
 module SuperDiff
-  module OperationalSequencers
+  module OperationTreeBuilders
     class MultilineString < Base
       def self.applies_to?(expected, actual)
         expected.is_a?(::String) && actual.is_a?(::String) &&
@@ -30,8 +30,8 @@ module SuperDiff
         end
       end
 
-      def build_operation_sequencer
-        OperationSequences::Array.new([])
+      def build_operation_tree
+        OperationTrees::MultilineString.new([])
       end
 
       private

data/lib/super_diff/operation_tree_builders/time_like.rb

@@ -0,0 +1,34 @@
+module SuperDiff
+  module OperationTreeBuilders
+    class TimeLike < CustomObject
+      def self.applies_to?(expected, actual)
+        SuperDiff.time_like?(expected) && SuperDiff.time_like?(actual)
+      end
+
+      protected
+
+      def attribute_names
+        base = [
+          "year",
+          "month",
+          "day",
+          "hour",
+          "min",
+          "sec",
+          "nsec",
+          "zone",
+          "gmt_offset",
+        ]
+
+        # If timezones are different, also show a normalized timestamp at the
+        # end of the diff to help visualize why they are different moments in
+        # time.
+        if actual.zone != expected.zone
+          base + ["utc"]
+        else
+          base
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/operation_trees.rb

@@ -0,0 +1,13 @@
+module SuperDiff
+  module OperationTrees
+    autoload :Array, "super_diff/operation_trees/array"
+    autoload :Base, "super_diff/operation_trees/base"
+    autoload :CustomObject, "super_diff/operation_trees/custom_object"
+    autoload :DefaultObject, "super_diff/operation_trees/default_object"
+    autoload :Hash, "super_diff/operation_trees/hash"
+    autoload :Main, "super_diff/operation_trees/main"
+    autoload :MultilineString, "super_diff/operation_trees/multiline_string"
+  end
+end
+
+require "super_diff/operation_trees/defaults"

data/lib/super_diff/{operation_sequences → operation_trees}/array.rb

@@ -1,6 +1,10 @@
 module SuperDiff
-  module OperationSequences
+  module OperationTrees
     class Array < Base
+      def self.applies_to?(value)
+        value.is_a?(::Array)
+      end
+
       def to_diff(indent_level:, collection_prefix:, add_comma:)
         DiffFormatters::Array.call(
           self,

data/lib/super_diff/{operation_sequences → operation_trees}/base.rb

@@ -1,6 +1,14 @@
+require 'delegate'
+
 module SuperDiff
-  module OperationSequences
+  module OperationTrees
     class Base < SimpleDelegator
+      def self.applies_to?(_value)
+        unimplemented_class_method!
+      end
+
+      extend ImplementationChecks
+
       # rubocop:disable Lint/UnusedMethodArgument
       def to_diff(indent_level:, add_comma: false, collection_prefix: nil)
         raise NotImplementedError

data/lib/super_diff/{operation_sequences → operation_trees}/custom_object.rb

@@ -1,6 +1,10 @@
 module SuperDiff
-  module OperationSequences
+  module OperationTrees
     class CustomObject < DefaultObject
+      def self.applies_to?(value)
+        value.respond_to?(:attributes_for_super_diff)
+      end
+
       def to_diff(indent_level:, add_comma: false, collection_prefix: nil)
         DiffFormatters::CustomObject.call(
           self,

data/lib/super_diff/{operation_sequences → operation_trees}/default_object.rb

@@ -1,25 +1,27 @@
 module SuperDiff
-  module OperationSequences
+  module OperationTrees
     class DefaultObject < Base
+      def self.applies_to?(_value)
+        true
+      end
+
+      attr_reader :value_class
+
+      # TODO: Default this to collection.class?
       def initialize(collection, value_class:)
         super(collection)
 
         @value_class = value_class
       end
 
-      def to_diff(indent_level:, add_comma: false, collection_prefix: nil)
-        DiffFormatters::DefaultObject.call(
+      def to_diff(indent_level:, add_comma: false, **_rest)
+        DiffFormatters::Main.call(
           self,
           indent_level: indent_level,
-          collection_prefix: collection_prefix,
           add_comma: add_comma,
           value_class: value_class,
         )
       end
-
-      private
-
-      attr_reader :value_class
     end
   end
 end