super_diff 0.12.1 → 0.15.0

data/lib/super_diff/basic/operation_tree_builders/default_object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Basic
     module OperationTreeBuilders
@@ -7,7 +9,7 @@ module SuperDiff
         end
 
         def initialize(*args)
-          super(*args)
+          super
 
           establish_expected_and_actual_attributes
         end
@@ -15,11 +17,10 @@ module SuperDiff
         protected
 
         def unary_operations
-          attribute_names.reduce([]) do |operations, name|
+          attribute_names.each_with_object([]) do |name, operations|
             possibly_add_noop_operation_to(operations, name)
             possibly_add_delete_operation_to(operations, name)
             possibly_add_insert_operation_to(operations, name)
-            operations
           end
         end
 
@@ -32,7 +33,7 @@ module SuperDiff
         def attribute_names
           (
             expected.instance_variables.sort & actual.instance_variables.sort
-          ).map { |variable_name| variable_name[1..-1] }
+          ).map { |variable_name| variable_name[1..] }
         end
 
         private
@@ -52,15 +53,15 @@ module SuperDiff
         end
 
         def possibly_add_noop_operation_to(operations, attribute_name)
-          if should_add_noop_operation?(attribute_name)
-            operations << Core::UnaryOperation.new(
-              name: :noop,
-              collection: actual_attributes,
-              key: attribute_name,
-              index: attribute_names.index(attribute_name),
-              value: actual_attributes[attribute_name]
-            )
-          end
+          return unless should_add_noop_operation?(attribute_name)
+
+          operations << Core::UnaryOperation.new(
+            name: :noop,
+            collection: actual_attributes,
+            key: attribute_name,
+            index: attribute_names.index(attribute_name),
+            value: actual_attributes[attribute_name]
+          )
         end
 
         def should_add_noop_operation?(attribute_name)
@@ -71,15 +72,15 @@ module SuperDiff
         end
 
         def possibly_add_delete_operation_to(operations, attribute_name)
-          if should_add_delete_operation?(attribute_name)
-            operations << Core::UnaryOperation.new(
-              name: :delete,
-              collection: expected_attributes,
-              key: attribute_name,
-              index: attribute_names.index(attribute_name),
-              value: expected_attributes[attribute_name]
-            )
-          end
+          return unless should_add_delete_operation?(attribute_name)
+
+          operations << Core::UnaryOperation.new(
+            name: :delete,
+            collection: expected_attributes,
+            key: attribute_name,
+            index: attribute_names.index(attribute_name),
+            value: expected_attributes[attribute_name]
+          )
         end
 
         def should_add_delete_operation?(attribute_name)
@@ -92,15 +93,15 @@ module SuperDiff
         end
 
         def possibly_add_insert_operation_to(operations, attribute_name)
-          if should_add_insert_operation?(attribute_name)
-            operations << Core::UnaryOperation.new(
-              name: :insert,
-              collection: actual_attributes,
-              key: attribute_name,
-              index: attribute_names.index(attribute_name),
-              value: actual_attributes[attribute_name]
-            )
-          end
+          return unless should_add_insert_operation?(attribute_name)
+
+          operations << Core::UnaryOperation.new(
+            name: :insert,
+            collection: actual_attributes,
+            key: attribute_name,
+            index: attribute_names.index(attribute_name),
+            value: actual_attributes[attribute_name]
+          )
         end
 
         def should_add_insert_operation?(attribute_name)

data/lib/super_diff/basic/operation_tree_builders/hash.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Basic
     module OperationTreeBuilders
@@ -20,8 +22,10 @@ module SuperDiff
 
         def unary_operations_using_variant_of_patience_algorithm
           operations = []
-          aks, eks = actual.keys, expected.keys
-          previous_ei, ei = nil, 0
+          aks = actual.keys
+          eks = expected.keys
+          previous_ei = nil
+          ei = 0
           ai = 0
 
           # When diffing a hash, we're more interested in the 'actual' version
@@ -30,7 +34,8 @@ module SuperDiff
           # hash, and we start off by looping over it.
           while ai < aks.size
             ak = aks[ai]
-            av, ev = actual[ak], expected[ak]
+            av = actual[ak]
+            ev = 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.
@@ -51,23 +56,23 @@ module SuperDiff
                 # the keys in 'expected'.)
                 (previous_ei + 1).upto(ei - 1) do |ei2|
                   ek = eks[ei2]
-                  ev2, av2 = expected[ek], actual[ek]
+                  ev2 = expected[ek]
+                  av2 = actual[ek]
 
-                  if (
+                  next unless
                        (!actual.include?(ek) || ev2 != av2) &&
-                         operations.none? do |operation|
-                           %i[delete noop].include?(operation.name) &&
-                             operation.key == ek
-                         end
-                     )
-                    operations << Core::UnaryOperation.new(
-                      name: :delete,
-                      collection: expected,
-                      key: ek,
-                      value: ev2,
-                      index: ei2
-                    )
-                  end
+                       operations.none? do |operation|
+                         %i[delete noop].include?(operation.name) &&
+                         operation.key == ek
+                       end
+
+                  operations << Core::UnaryOperation.new(
+                    name: :delete,
+                    collection: expected,
+                    key: ek,
+                    value: ev2,
+                    index: ei2
+                  )
                 end
               end
 
@@ -82,10 +87,9 @@ module SuperDiff
               # (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 (operations.empty? || operations.last.name == :noop) &&
+                 (ai.zero? || 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
@@ -98,7 +102,7 @@ module SuperDiff
                 # or we hit some other condition (see below).
 
                 start_index =
-                  if ai > 0
+                  if ai.positive?
                     eks.index(aks[ai - 1]) + 1
                   else
                     0
@@ -106,18 +110,18 @@ module SuperDiff
 
                 start_index.upto(eks.size - 1) do |ei2|
                   ek = eks[ei2]
-                  ev, av2 = expected[ek], actual[ek]
+                  ev = expected[ek]
+                  av2 = 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? do |k|
+                  elsif aks[ai + 1..].any? do |k| # rubocop:disable Lint/DuplicateBranch for clarity
                           expected.include?(k) && expected[k] != actual[k]
                         end
-                      )
+
                     # 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
@@ -135,28 +139,27 @@ module SuperDiff
                     )
                   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 << Core::UnaryOperation.new(
-                      name: :insert,
-                      collection: actual,
-                      key: ak,
-                      value: av,
-                      index: ai
-                    )
-                  end
+                  next unless 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 << Core::UnaryOperation.new(
+                    name: :insert,
+                    collection: actual,
+                    key: ak,
+                    value: av,
+                    index: ai
+                  )
                 end
               end
 
-              if (
-                   expected.include?(ak) && ev != av &&
-                     operations.none? do |op|
-                       op.name == :delete && op.key == ak
-                     end
-                 )
+              if expected.include?(ak) && ev != av &&
+                 operations.none? do |op|
+                   op.name == :delete && op.key == ak
+                 end
+
                 # 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

data/lib/super_diff/basic/operation_tree_builders/multiline_string.rb

@@ -1,4 +1,6 @@
-require "patience_diff"
+# frozen_string_literal: true
+
+require 'patience_diff'
 
 module SuperDiff
   module Basic
@@ -10,7 +12,7 @@ module SuperDiff
         end
 
         def initialize(*args)
-          super(*args)
+          super
 
           @original_expected = @expected
           @original_actual = @actual
@@ -42,7 +44,7 @@ module SuperDiff
         attr_reader :sequence_matcher, :original_expected, :original_actual
 
         def split_into_lines(string)
-          string.scan(/.+(?:\r|\n|\r\n|\Z)/)
+          string.scan(/.*(?:\r|\n|\r\n|\Z)/)
         end
 
         def opcodes

data/lib/super_diff/basic/operation_tree_builders/time_like.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Basic
     module OperationTreeBuilders
@@ -14,10 +16,10 @@ module SuperDiff
           # 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
+          if actual.zone == expected.zone
             base
+          else
+            base + ['utc']
           end
         end
       end

data/lib/super_diff/basic/operation_tree_builders.rb

@@ -1,31 +1,37 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Basic
     module OperationTreeBuilders
-      autoload :Array, "super_diff/basic/operation_tree_builders/array"
+      autoload :Array, 'super_diff/basic/operation_tree_builders/array'
       autoload(
         :CustomObject,
-        "super_diff/basic/operation_tree_builders/custom_object"
+        'super_diff/basic/operation_tree_builders/custom_object'
+      )
+      autoload(
+        :DataObject,
+        'super_diff/basic/operation_tree_builders/data_object'
       )
       autoload(
         :DefaultObject,
-        "super_diff/basic/operation_tree_builders/default_object"
+        'super_diff/basic/operation_tree_builders/default_object'
       )
-      autoload :Hash, "super_diff/basic/operation_tree_builders/hash"
+      autoload :Hash, 'super_diff/basic/operation_tree_builders/hash'
       # TODO: Where is this used?
       autoload(
         :MultilineString,
-        "super_diff/basic/operation_tree_builders/multiline_string"
+        'super_diff/basic/operation_tree_builders/multiline_string'
       )
-      autoload :TimeLike, "super_diff/basic/operation_tree_builders/time_like"
-      autoload :DateLike, "super_diff/basic/operation_tree_builders/date_like"
+      autoload :TimeLike, 'super_diff/basic/operation_tree_builders/time_like'
+      autoload :DateLike, 'super_diff/basic/operation_tree_builders/date_like'
 
       class Main
         def self.call(*args)
-          warn <<~EOT
+          warn <<~WARNING
             WARNING: SuperDiff::OperationTreeBuilders::Main.call(...) is deprecated and will be removed in the next major release.
             Please use SuperDiff.build_operation_tree_for(...) instead.
             #{caller_locations.join("\n")}
-          EOT
+          WARNING
           SuperDiff.build_operation_tree_for(*args)
         end
       end

data/lib/super_diff/basic/operation_tree_flatteners/array.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Basic
     module OperationTreeFlatteners
@@ -5,11 +7,11 @@ module SuperDiff
         protected
 
         def open_token
-          "["
+          '['
         end
 
         def close_token
-          "]"
+          ']'
         end
       end
     end

data/lib/super_diff/basic/operation_tree_flatteners/collection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Basic
     module OperationTreeFlatteners
@@ -23,7 +25,7 @@ module SuperDiff
         end
 
         def inner_lines
-          @_inner_lines ||=
+          @inner_lines ||=
             operation_tree.flat_map do |operation|
               lines =
                 if operation.name == :change
@@ -52,7 +54,7 @@ module SuperDiff
         end
 
         def add_prefix_at_beginning_of_lines(lines, operation)
-          [lines[0].prefixed_with(item_prefix_for(operation))] + lines[1..-1]
+          [lines[0].prefixed_with(item_prefix_for(operation))] + lines[1..]
         end
 
         def maybe_add_comma_at_end_of_lines(lines, operation)
@@ -81,13 +83,11 @@ module SuperDiff
             operation.left_collection,
             operation.right_collection
           ) do |already_seen|
-            if already_seen
-              raise InfiniteRecursionError
-            else
-              operation.children.flatten(
-                indentation_level: indentation_level + 1
-              )
-            end
+            raise InfiniteRecursionError if already_seen
+
+            operation.children.flatten(
+              indentation_level: indentation_level + 1
+            )
           end
         end
 
@@ -117,7 +117,7 @@ module SuperDiff
         end
 
         def item_prefix_for(_operation)
-          ""
+          ''
         end
 
         def build_lines_from_inspection_of(value, type:, indentation_level:)
@@ -131,7 +131,7 @@ module SuperDiff
 
         class InfiniteRecursionError < StandardError
           def initialize(_message = nil)
-            super("Unhandled recursive data structure encountered!")
+            super('Unhandled recursive data structure encountered!')
           end
         end
       end

data/lib/super_diff/basic/operation_tree_flatteners/custom_object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Basic
     module OperationTreeFlatteners
@@ -5,16 +7,16 @@ module SuperDiff
         protected
 
         def open_token
-          "#<%<class>s {" % { class: operation_tree.underlying_object.class }
+          format('#<%<class>s {', class: operation_tree.underlying_object.class)
         end
 
         def close_token
-          "}>"
+          '}>'
         end
 
         def item_prefix_for(operation)
           key =
-            # Note: We could have used the right_key here too, they're both the
+            # NOTE: We could have used the right_key here too, they're both the
             # same keys
             if operation.respond_to?(:left_key)
               operation.left_key

data/lib/super_diff/basic/operation_tree_flatteners/default_object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Basic
     module OperationTreeFlatteners
@@ -5,18 +7,17 @@ module SuperDiff
         protected
 
         def open_token
-          "#<#{operation_tree.underlying_object.class.name}:" +
-            Core::Helpers.object_address_for(operation_tree.underlying_object) +
-            " {"
+          "#<#{operation_tree.underlying_object.class.name}:" \
+            "#{Core::Helpers.object_address_for(operation_tree.underlying_object)} {"
         end
 
         def close_token
-          "}>"
+          '}>'
         end
 
         def item_prefix_for(operation)
           key =
-            # Note: We could have used the right_key here too, they're both the
+            # NOTE: We could have used the right_key here too, they're both the
             # same keys
             if operation.respond_to?(:left_key)
               operation.left_key

data/lib/super_diff/basic/operation_tree_flatteners/hash.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Basic
     module OperationTreeFlatteners
@@ -5,11 +7,11 @@ module SuperDiff
         protected
 
         def open_token
-          "{"
+          '{'
         end
 
         def close_token
-          "}"
+          '}'
         end
 
         def item_prefix_for(operation)
@@ -25,7 +27,7 @@ module SuperDiff
         end
 
         def key_for(operation)
-          # Note: We could have used the right_key here too, they're both the
+          # NOTE: We could have used the right_key here too, they're both the
           # same keys
           operation.respond_to?(:left_key) ? operation.left_key : operation.key
         end

data/lib/super_diff/basic/operation_tree_flatteners/multiline_string.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Basic
     module OperationTreeFlatteners
@@ -10,7 +12,7 @@ module SuperDiff
               # TODO: Test that quotes and things don't get escaped but escape
               # characters do
               value:
-                operation.value.inspect[1..-2].gsub(/\\"/, '"').gsub(/\\'/, "'")
+                operation.value.inspect[1..-2].gsub('\\"', '"').gsub("\\'", "'")
             )
           end
         end

data/lib/super_diff/basic/operation_tree_flatteners.rb

@@ -1,23 +1,25 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Basic
     module OperationTreeFlatteners
-      autoload :Array, "super_diff/basic/operation_tree_flatteners/array"
+      autoload :Array, 'super_diff/basic/operation_tree_flatteners/array'
       autoload(
         :Collection,
-        "super_diff/basic/operation_tree_flatteners/collection"
+        'super_diff/basic/operation_tree_flatteners/collection'
       )
       autoload(
         :CustomObject,
-        "super_diff/basic/operation_tree_flatteners/custom_object"
+        'super_diff/basic/operation_tree_flatteners/custom_object'
       )
       autoload(
         :DefaultObject,
-        "super_diff/basic/operation_tree_flatteners/default_object"
+        'super_diff/basic/operation_tree_flatteners/default_object'
       )
-      autoload :Hash, "super_diff/basic/operation_tree_flatteners/hash"
+      autoload :Hash, 'super_diff/basic/operation_tree_flatteners/hash'
       autoload(
         :MultilineString,
-        "super_diff/basic/operation_tree_flatteners/multiline_string"
+        'super_diff/basic/operation_tree_flatteners/multiline_string'
       )
     end
   end

data/lib/super_diff/basic/operation_trees/array.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Basic
     module OperationTrees

data/lib/super_diff/basic/operation_trees/custom_object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Basic
     module OperationTrees

data/lib/super_diff/basic/operation_trees/default_object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Basic
     module OperationTrees
@@ -17,18 +19,18 @@ module SuperDiff
           pp.text "#<#{self.class.name} "
           pp.nest(1) do
             pp.breakable
-            pp.text ":operations=>"
-            pp.group(1, "[", "]") do
+            pp.text ':operations=>'
+            pp.group(1, '[', ']') do
               pp.breakable
               pp.seplist(self) { |value| pp.pp value }
             end
             pp.comma_breakable
-            pp.text ":underlying_object=>"
+            pp.text ':underlying_object=>'
             pp.object_address_group underlying_object do
               # do nothing
             end
           end
-          pp.text ">"
+          pp.text '>'
         end
 
         protected

data/lib/super_diff/basic/operation_trees/hash.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Basic
     module OperationTrees

data/lib/super_diff/basic/operation_trees/multiline_string.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Basic
     module OperationTrees
       class MultilineString < Core::AbstractOperationTree
         def self.applies_to?(value)
-          value.is_a?(::String) && value.is_a?(::String)
+          value.is_a?(::String)
         end
 
         protected