super_diff 0.12.1 → 0.15.0

data/lib/super_diff/basic/operation_trees.rb

@@ -1,22 +1,24 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Basic
     module OperationTrees
-      autoload :Array, "super_diff/basic/operation_trees/array"
-      autoload :CustomObject, "super_diff/basic/operation_trees/custom_object"
-      autoload :DefaultObject, "super_diff/basic/operation_trees/default_object"
-      autoload :Hash, "super_diff/basic/operation_trees/hash"
+      autoload :Array, 'super_diff/basic/operation_trees/array'
+      autoload :CustomObject, 'super_diff/basic/operation_trees/custom_object'
+      autoload :DefaultObject, 'super_diff/basic/operation_trees/default_object'
+      autoload :Hash, 'super_diff/basic/operation_trees/hash'
       autoload(
         :MultilineString,
-        "super_diff/basic/operation_trees/multiline_string"
+        'super_diff/basic/operation_trees/multiline_string'
       )
 
       class Main
         def self.call(*args)
-          warn <<~EOT
+          warn <<~WARNING
             WARNING: SuperDiff::OperationTrees::Main.call(...) is deprecated and will be removed in the next major release.
             Please use SuperDiff.find_operation_tree_for(...) instead.
             #{caller_locations.join("\n")}
-          EOT
+          WARNING
           SuperDiff.find_operation_tree_for(*args)
         end
       end

data/lib/super_diff/basic.rb

@@ -1,12 +1,14 @@
-require "super_diff/basic/differs"
-require "super_diff/basic/inspection_tree_builders"
-require "super_diff/basic/operation_tree_builders"
-require "super_diff/basic/operation_tree_flatteners"
-require "super_diff/basic/operation_trees"
+# frozen_string_literal: true
+
+require 'super_diff/basic/differs'
+require 'super_diff/basic/inspection_tree_builders'
+require 'super_diff/basic/operation_tree_builders'
+require 'super_diff/basic/operation_tree_flatteners'
+require 'super_diff/basic/operation_trees'
 
 module SuperDiff
   module Basic
-    autoload :DiffFormatters, "super_diff/basic/diff_formatters"
+    autoload :DiffFormatters, 'super_diff/basic/diff_formatters'
 
     SuperDiff.configuration.tap do |config|
       config.add_extra_differ_classes(
@@ -26,6 +28,8 @@ module SuperDiff
         InspectionTreeBuilders::Primitive,
         InspectionTreeBuilders::TimeLike,
         InspectionTreeBuilders::DateLike,
+        InspectionTreeBuilders::DataObject,
+        InspectionTreeBuilders::RangeObject,
         InspectionTreeBuilders::DefaultObject
       )
 
@@ -34,7 +38,8 @@ module SuperDiff
         OperationTreeBuilders::Hash,
         OperationTreeBuilders::TimeLike,
         OperationTreeBuilders::DateLike,
-        OperationTreeBuilders::CustomObject
+        OperationTreeBuilders::CustomObject,
+        OperationTreeBuilders::DataObject
       )
 
       config.add_extra_operation_tree_classes(

data/lib/super_diff/core/abstract_differ.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Core
     class AbstractDiffer

data/lib/super_diff/core/abstract_inspection_tree_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Core
     class AbstractInspectionTreeBuilder

data/lib/super_diff/core/abstract_operation_tree.rb

@@ -1,4 +1,6 @@
-require "forwardable"
+# frozen_string_literal: true
+
+require 'forwardable'
 
 module SuperDiff
   module Core
@@ -32,7 +34,7 @@ module SuperDiff
       end
 
       def pretty_print(pp)
-        pp.group(1, "#<#{self.class.name} [", "]>") do
+        pp.group(1, "#<#{self.class.name} [", ']>') do
           pp.breakable
           pp.seplist(self) { |value| pp.pp value }
         end

data/lib/super_diff/core/abstract_operation_tree_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Core
     class AbstractOperationTreeBuilder
@@ -31,16 +33,15 @@ module SuperDiff
         operation_tree = build_operation_tree
         unmatched_delete_operations = []
 
-        unary_operations.each_with_index do |operation, index|
-          if (
-               operation.name == :insert &&
-                 (
-                   delete_operation =
-                     unmatched_delete_operations.find do |op|
-                       op.key == operation.key
-                     end
-                 ) && (insert_operation = operation)
-             )
+        unary_operations.each_with_index do |operation, _index|
+          if operation.name == :insert &&
+             (
+               delete_operation =
+                 unmatched_delete_operations.find do |op|
+                   op.key == operation.key
+                 end
+             ) && (insert_operation = operation)
+
             unmatched_delete_operations.delete(delete_operation)
 
             if (
@@ -64,9 +65,7 @@ module SuperDiff
               operation_tree << insert_operation
             end
           else
-            if operation.name == :delete
-              unmatched_delete_operations << operation
-            end
+            unmatched_delete_operations << operation if operation.name == :delete
 
             operation_tree << operation
           end
@@ -76,11 +75,9 @@ module SuperDiff
       end
 
       def possible_comparison_of(operation, next_operation)
-        if should_compare?(operation, next_operation)
-          compare(operation.value, next_operation.value)
-        else
-          nil
-        end
+        return unless should_compare?(operation, next_operation)
+
+        compare(operation.value, next_operation.value)
       end
 
       def should_compare?(operation, next_operation)

data/lib/super_diff/core/abstract_operation_tree_flattener.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Core
     class AbstractOperationTreeFlattener
@@ -21,7 +23,7 @@ module SuperDiff
       def beginning_lines
         if tiered_lines.empty?
           []
-        elsif indentation_level > 0
+        elsif indentation_level.positive?
           [tiered_lines[0]]
         else
           [tiered_lines[0].with_complete_bookend(:open)]
@@ -35,7 +37,7 @@ module SuperDiff
       def ending_lines
         if tiered_lines.empty?
           []
-        elsif indentation_level > 0
+        elsif indentation_level.positive?
           [tiered_lines[-1]]
         else
           [tiered_lines[-1].with_complete_bookend(:close)]
@@ -43,7 +45,7 @@ module SuperDiff
       end
 
       def tiered_lines
-        @_tiered_lines ||= build_tiered_lines
+        @tiered_lines ||= build_tiered_lines
       end
     end
   end

data/lib/super_diff/core/binary_operation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Core
     class BinaryOperation
@@ -14,7 +16,7 @@ module SuperDiff
           :right_value!,
           :left_index!,
           :right_index!,
-          children: []
+          { children: [] }
         ]
       )
     end

data/lib/super_diff/core/colorized_document_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Core
     module ColorizedDocumentExtensions

data/lib/super_diff/core/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Core
     class Configuration
@@ -23,7 +25,7 @@ module SuperDiff
       def initialize(options = {})
         @actual_color = :yellow
         @border_color = :blue
-        @color_enabled = color_enabled_by_default?
+        @color_enabled = nil
         @diff_elision_enabled = false
         @diff_elision_maximum = 0
         @elision_marker_color = :cyan
@@ -41,6 +43,8 @@ module SuperDiff
 
       def initialize_dup(original)
         super
+        @extra_diff_formatter_classes =
+          original.extra_diff_formatter_classes.dup.freeze
         @extra_differ_classes = original.extra_differ_classes.dup.freeze
         @extra_operation_tree_builder_classes =
           original.extra_operation_tree_builder_classes.dup.freeze
@@ -51,6 +55,8 @@ module SuperDiff
       end
 
       def color_enabled?
+        return color_enabled_by_default? if @color_enabled.nil?
+
         @color_enabled
       end
 
@@ -71,101 +77,71 @@ module SuperDiff
           end
 
         options.each { |key, value| instance_variable_set("@#{key}", value) }
-
-        updated
-      end
-
-      def updated
-        SuperDiff::Csi.color_enabled = color_enabled?
       end
 
       def add_extra_diff_formatter_classes(*classes)
         @extra_diff_formatter_classes =
           (@extra_diff_formatter_classes + classes).freeze
       end
-      alias_method(
-        :add_extra_diff_formatter_class,
-        :add_extra_diff_formatter_classes
-      )
+      alias add_extra_diff_formatter_class add_extra_diff_formatter_classes
 
       def prepend_extra_diff_formatter_classes(*classes)
         @extra_diff_formatter_classes =
           (classes + @extra_diff_formatter_classes).freeze
       end
-      alias_method(
-        :prepend_extra_diff_formatter_class,
-        :prepend_extra_diff_formatter_classes
-      )
+      alias prepend_extra_diff_formatter_class prepend_extra_diff_formatter_classes
 
       def add_extra_differ_classes(*classes)
         @extra_differ_classes = (@extra_differ_classes + classes).freeze
       end
-      alias_method :add_extra_differ_class, :add_extra_differ_classes
+      alias add_extra_differ_class add_extra_differ_classes
 
       def prepend_extra_differ_classes(*classes)
         @extra_differ_classes = (classes + @extra_differ_classes).freeze
       end
-      alias_method :prepend_extra_differ_class, :prepend_extra_differ_classes
+      alias prepend_extra_differ_class prepend_extra_differ_classes
 
       def add_extra_inspection_tree_builder_classes(*classes)
         @extra_inspection_tree_builder_classes =
           (@extra_inspection_tree_builder_classes + classes).freeze
       end
-      alias_method(
-        :add_extra_inspection_tree_builder_class,
-        :add_extra_inspection_tree_builder_classes
-      )
+      alias add_extra_inspection_tree_builder_class add_extra_inspection_tree_builder_classes
 
       def prepend_extra_inspection_tree_builder_classes(*classes)
         @extra_inspection_tree_builder_classes =
           (classes + @extra_inspection_tree_builder_classes).freeze
       end
-      alias_method(
-        :prepend_extra_inspection_tree_builder_class,
-        :prepend_extra_inspection_tree_builder_classes
-      )
+      alias prepend_extra_inspection_tree_builder_class prepend_extra_inspection_tree_builder_classes
 
       def add_extra_operation_tree_builder_classes(*classes)
         @extra_operation_tree_builder_classes =
           (@extra_operation_tree_builder_classes + classes).freeze
       end
-      alias_method(
-        :add_extra_operation_tree_builder_class,
-        :add_extra_operation_tree_builder_classes
-      )
+      alias add_extra_operation_tree_builder_class add_extra_operation_tree_builder_classes
 
       def prepend_extra_operation_tree_builder_classes(*classes)
         @extra_operation_tree_builder_classes =
           (classes + @extra_operation_tree_builder_classes).freeze
       end
-      alias_method(
-        :prepend_extra_operation_tree_builder_class,
-        :prepend_extra_operation_tree_builder_classes
-      )
+      alias prepend_extra_operation_tree_builder_class prepend_extra_operation_tree_builder_classes
 
       def add_extra_operation_tree_classes(*classes)
         @extra_operation_tree_classes =
           (@extra_operation_tree_classes + classes).freeze
       end
-      alias_method(
-        :add_extra_operation_tree_class,
-        :add_extra_operation_tree_classes
-      )
+      alias add_extra_operation_tree_class add_extra_operation_tree_classes
 
       def prepend_extra_operation_tree_classes(*classes)
         @extra_operation_tree_classes =
           (classes + @extra_operation_tree_classes).freeze
       end
-      alias_method(
-        :prepend_extra_operation_tree_class,
-        :prepend_extra_operation_tree_classes
-      )
+      alias prepend_extra_operation_tree_class prepend_extra_operation_tree_classes
 
       def to_h
         {
           actual_color: actual_color,
           border_color: border_color,
-          color_enabled: color_enabled?,
+          color_enabled: @color_enabled,
           diff_elision_enabled: diff_elision_enabled?,
           diff_elision_maximum: diff_elision_maximum,
           elision_marker_color: elision_marker_color,
@@ -185,7 +161,11 @@ module SuperDiff
       private
 
       def color_enabled_by_default?
-        ENV["CI"] == "true" || $stdout.respond_to?(:tty?) && $stdout.tty?
+        return true if ENV['CI'] == 'true'
+
+        return ::RSpec.configuration.color_enabled? if defined?(::SuperDiff::RSpec)
+
+        $stdout.respond_to?(:tty?) && $stdout.tty?
       end
     end
   end

data/lib/super_diff/core/differ_dispatcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Core
     class DifferDispatcher
@@ -6,7 +8,7 @@ module SuperDiff
       method_object(
         :expected,
         :actual,
-        [:available_classes, indent_level: 0, raise_if_nothing_applies: true]
+        [:available_classes, { indent_level: 0, raise_if_nothing_applies: true }]
       )
 
       def call
@@ -15,7 +17,7 @@ module SuperDiff
         elsif raise_if_nothing_applies?
           raise NoDifferAvailableError.create(expected, actual)
         else
-          ""
+          ''
         end
       end
 

data/lib/super_diff/core/gem_version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Core
     class GemVersion

data/lib/super_diff/core/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Core
     module Helpers
@@ -6,7 +8,7 @@ module SuperDiff
       # TODO: Simplify this
       def style(*args, color_enabled: true, **opts, &block)
         klass =
-          if color_enabled && Csi.color_enabled?
+          if color_enabled && SuperDiff.configuration.color_enabled?
             Csi::ColorizedDocument
           else
             Csi::UncolorizedDocument
@@ -26,13 +28,13 @@ module SuperDiff
       def plural_type_for(value)
         case value
         when Numeric
-          "numbers"
+          'numbers'
         when String
-          "strings"
+          'strings'
         when Symbol
-          "symbols"
+          'symbols'
         else
-          "objects"
+          'objects'
         end
       end
 
@@ -49,26 +51,26 @@ module SuperDiff
       if jruby?
         def object_address_for(object)
           # Source: <https://github.com/jruby/jruby/blob/master/core/src/main/java/org/jruby/RubyBasicObject.java>
-          "0x%x" % object.hash
+          '0x%x' % object.hash
         end
-      elsif ruby_version_matches?(">= 2.7.0")
-        require "json"
-        require "objspace"
+      elsif ruby_version_matches?('>= 2.7.0')
+        require 'json'
+        require 'objspace'
 
         def object_address_for(object)
           # Sources: <https://bugs.ruby-lang.org/issues/15408> and <https://bugs.ruby-lang.org/issues/15626#Object-ID>
           json = JSON.parse(ObjectSpace.dump(object))
-          json.is_a?(Hash) ? "0x%016x" % Integer(json["address"], 16) : ""
+          json.is_a?(Hash) ? '0x%016x' % Integer(json['address'], 16) : ''
         end
       else
         def object_address_for(object)
-          "0x%016x" % (object.object_id * 2)
+          format('0x%016x', (object.object_id * 2))
         end
       end
 
       def with_slice_of_array_replaced(array, range, replacement)
         beginning =
-          if range.begin > 0
+          if range.begin.positive?
             array[Range.new(0, range.begin - 1)]
           else
             []

data/lib/super_diff/core/implementation_checks.rb

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Core
     module ImplementationChecks
-      protected def unimplemented_instance_method!
+      protected
+
+      def unimplemented_instance_method!
         raise(
           NotImplementedError,
           "#{self.class} must implement ##{caller_locations(1, 1).first.label}",
@@ -9,7 +13,7 @@ module SuperDiff
         )
       end
 
-      protected def unimplemented_class_method!
+      def unimplemented_class_method!
         raise(
           NotImplementedError,
           "#{self} must implement .#{caller_locations(1, 1).first.label}",

data/lib/super_diff/core/inspection_tree.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Core
     class InspectionTree
@@ -21,11 +23,11 @@ module SuperDiff
       end
 
       def before_each_callbacks
-        @_before_each_callbacks ||= Hash.new { |h, k| h[k] = [] }
+        @before_each_callbacks ||= Hash.new { |h, k| h[k] = [] }
       end
 
       def render_to_string(object)
-        nodes.reduce("") do |string, node|
+        nodes.reduce('') do |string, node|
           string + node.render_to_string(object)
         end
       end
@@ -34,7 +36,7 @@ module SuperDiff
         nodes
           .each_with_index
           .reduce(
-            [TieredLines.new, "", ""]
+            [TieredLines.new, '', '']
           ) do |(tiered_lines, prelude, prefix), (node, index)|
             UpdateTieredLines.call(
               object: object,
@@ -59,10 +61,10 @@ module SuperDiff
         insert_separated_list(array) do |t, value|
           # Have to do these shenanigans so that if value is a hash, Ruby
           # doesn't try to interpret it as keyword args
-          if Helpers.ruby_version_matches?(">= 2.7.1")
+          if Helpers.ruby_version_matches?('>= 2.7.1')
             t.add_inspection_of(value, **{})
           else
-            t.add_inspection_of(*[value, {}])
+            t.add_inspection_of(value, {})
           end
         end
       end
@@ -80,16 +82,16 @@ module SuperDiff
           else
             t1.as_prefix_when_rendering_to_lines do |t2|
               t2.add_inspection_of key, as_lines: false
-              t2.add_text " => "
+              t2.add_text ' => '
             end
           end
 
           # Have to do these shenanigans so that if hash[key] is a hash, Ruby
           # doesn't try to interpret it as keyword args
-          if Helpers.ruby_version_matches?(">= 2.7.1")
+          if Helpers.ruby_version_matches?('>= 2.7.1')
             t1.add_inspection_of(hash[key], **{})
           else
-            t1.add_inspection_of(*[hash[key], {}])
+            t1.add_inspection_of(hash[key], {})
           end
         end
       end
@@ -99,10 +101,10 @@ module SuperDiff
           as_lines_when_rendering_to_lines(
             add_comma: index < enumerable.size - 1
           ) do |t1|
-            if index > 0
+            if index.positive?
               # stree-ignore
               t1.when_rendering_to_string do |t2|
-                t2.add_text " "
+                t2.add_text ' '
               end
             end
             t1.evaluate_block(value, &block)
@@ -114,36 +116,34 @@ module SuperDiff
 
       attr_reader :disallowed_node_names, :nodes
 
-      def add_node(node_class, *args, **options, &block)
-        if disallowed_node_names.include?(node_class.name)
-          raise DisallowedNodeError.create(node_name: node_class.name)
-        end
+      def add_node(node_class, ...)
+        raise DisallowedNodeError.create(node_name: node_class.name) if disallowed_node_names.include?(node_class.name)
 
-        append_node(build_node(node_class, *args, **options, &block))
+        append_node(build_node(node_class, ...))
       end
 
       def append_node(node)
         nodes.push(node)
       end
 
-      def build_node(node_class, *args, **options, &block)
-        node_class.new(self, *args, **options, &block)
+      def build_node(node_class, ...)
+        node_class.new(self, ...)
       end
 
       class UpdateTieredLines
         extend AttrExtras.mixin
 
         method_object %i[
-                        object!
-                        type!
-                        indentation_level!
-                        nodes!
-                        tiered_lines!
-                        prelude!
-                        prefix!
-                        node!
-                        index!
-                      ]
+          object!
+          type!
+          indentation_level!
+          nodes!
+          tiered_lines!
+          prelude!
+          prefix!
+          node!
+          index!
+        ]
 
         def call
           if rendering.is_a?(Array)
@@ -165,18 +165,18 @@ module SuperDiff
         def concat_with_lines
           additional_lines =
             prefix_with(prefix, prepend_with(prelude, rendering))
-          [tiered_lines + additional_lines, "", ""]
+          [tiered_lines + additional_lines, '', '']
         end
 
         def prefix_with(prefix, text)
-          prefix.empty? ? text : [text[0].prefixed_with(prefix)] + text[1..-1]
+          prefix.empty? ? text : [text[0].prefixed_with(prefix)] + text[1..]
         end
 
         def prepend_with(prelude, text)
           if prelude.empty?
             text
           else
-            [text[0].with_value_prepended(prelude)] + text[1..-1]
+            [text[0].with_value_prepended(prelude)] + text[1..]
           end
         end
 
@@ -187,7 +187,7 @@ module SuperDiff
         def add_to_last_line
           new_lines =
             tiered_lines[0..-2] +
-              [tiered_lines[-1].with_value_appended(rendering)]
+            [tiered_lines[-1].with_value_appended(rendering)]
           [new_lines, prelude, prefix]
         end
 
@@ -198,13 +198,13 @@ module SuperDiff
         def add_to_lines
           new_lines =
             tiered_lines +
-              [
-                Line.new(
-                  type: type,
-                  indentation_level: indentation_level,
-                  value: rendering
-                )
-              ]
+            [
+              Line.new(
+                type: type,
+                indentation_level: indentation_level,
+                value: rendering
+              )
+            ]
           [new_lines, prelude, prefix]
         end