super_diff 0.11.0 → 0.12.0

data/lib/super_diff/core/configuration.rb

@@ -0,0 +1,192 @@
+module SuperDiff
+  module Core
+    class Configuration
+      attr_reader(
+        :extra_diff_formatter_classes,
+        :extra_differ_classes,
+        :extra_inspection_tree_builder_classes,
+        :extra_operation_tree_builder_classes,
+        :extra_operation_tree_classes
+      )
+      attr_accessor(
+        :actual_color,
+        :border_color,
+        :color_enabled,
+        :diff_elision_enabled,
+        :diff_elision_maximum,
+        :elision_marker_color,
+        :expected_color,
+        :header_color,
+        :key_enabled
+      )
+
+      def initialize(options = {})
+        @actual_color = :yellow
+        @border_color = :blue
+        @color_enabled = color_enabled_by_default?
+        @diff_elision_enabled = false
+        @diff_elision_maximum = 0
+        @elision_marker_color = :cyan
+        @expected_color = :magenta
+        @extra_diff_formatter_classes = [].freeze
+        @extra_differ_classes = [].freeze
+        @extra_inspection_tree_builder_classes = [].freeze
+        @extra_operation_tree_builder_classes = [].freeze
+        @extra_operation_tree_classes = [].freeze
+        @header_color = :white
+        @key_enabled = true
+
+        merge!(options)
+      end
+
+      def initialize_dup(original)
+        super
+        @extra_differ_classes = original.extra_differ_classes.dup.freeze
+        @extra_operation_tree_builder_classes =
+          original.extra_operation_tree_builder_classes.dup.freeze
+        @extra_operation_tree_classes =
+          original.extra_operation_tree_classes.dup.freeze
+        @extra_inspection_tree_builder_classes =
+          original.extra_inspection_tree_builder_classes.dup.freeze
+      end
+
+      def color_enabled?
+        @color_enabled
+      end
+
+      def diff_elision_enabled?
+        @diff_elision_enabled
+      end
+
+      def key_enabled?
+        @key_enabled
+      end
+
+      def merge!(configuration_or_options)
+        options =
+          if configuration_or_options.is_a?(self.class)
+            configuration_or_options.to_h
+          else
+            configuration_or_options
+          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
+      )
+
+      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
+      )
+
+      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
+
+      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
+
+      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
+      )
+
+      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
+      )
+
+      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
+      )
+
+      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
+      )
+
+      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
+      )
+
+      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
+      )
+
+      def to_h
+        {
+          actual_color: actual_color,
+          border_color: border_color,
+          color_enabled: color_enabled?,
+          diff_elision_enabled: diff_elision_enabled?,
+          diff_elision_maximum: diff_elision_maximum,
+          elision_marker_color: elision_marker_color,
+          expected_color: expected_color,
+          extra_diff_formatter_classes: extra_diff_formatter_classes.dup,
+          extra_differ_classes: extra_differ_classes.dup,
+          extra_inspection_tree_builder_classes:
+            extra_inspection_tree_builder_classes.dup,
+          extra_operation_tree_builder_classes:
+            extra_operation_tree_builder_classes.dup,
+          extra_operation_tree_classes: extra_operation_tree_classes.dup,
+          header_color: header_color,
+          key_enabled: key_enabled?
+        }
+      end
+
+      private
+
+      def color_enabled_by_default?
+        ENV["CI"] == "true" || $stdout.respond_to?(:tty?) && $stdout.tty?
+      end
+    end
+  end
+end

data/lib/super_diff/core/differ_dispatcher.rb

@@ -0,0 +1,33 @@
+module SuperDiff
+  module Core
+    class DifferDispatcher
+      extend AttrExtras.mixin
+
+      method_object(
+        :expected,
+        :actual,
+        [:available_classes, indent_level: 0, raise_if_nothing_applies: true]
+      )
+
+      def call
+        pp available_classes: available_classes
+
+        if resolved_class
+          resolved_class.call(expected, actual, indent_level: indent_level)
+        elsif raise_if_nothing_applies?
+          raise NoDifferAvailableError.create(expected, actual)
+        else
+          ""
+        end
+      end
+
+      private
+
+      attr_query :raise_if_nothing_applies?
+
+      def resolved_class
+        available_classes.find { |klass| klass.applies_to?(expected, actual) }
+      end
+    end
+  end
+end

data/lib/super_diff/core/gem_version.rb

@@ -0,0 +1,47 @@
+module SuperDiff
+  module Core
+    class GemVersion
+      def initialize(version)
+        @version = Gem::Version.new(version.to_s)
+      end
+
+      def <(other)
+        compare?(:<, other)
+      end
+
+      def <=(other)
+        compare?(:<=, other)
+      end
+
+      def ==(other)
+        compare?(:==, other)
+      end
+
+      def >=(other)
+        compare?(:>=, other)
+      end
+
+      def >(other)
+        compare?(:>, other)
+      end
+
+      def =~(other)
+        Gem::Requirement.new(other).satisfied_by?(version)
+      end
+
+      def to_s
+        version.to_s
+      end
+
+      private
+
+      attr_reader :version
+
+      def compare?(operator, other_version)
+        Gem::Requirement.new("#{operator} #{other_version}").satisfied_by?(
+          version
+        )
+      end
+    end
+  end
+end

data/lib/super_diff/core/helpers.rb

@@ -0,0 +1,88 @@
+module SuperDiff
+  module Core
+    module Helpers
+      extend self
+
+      # TODO: Simplify this
+      def style(*args, color_enabled: true, **opts, &block)
+        klass =
+          if color_enabled && Csi.color_enabled?
+            Csi::ColorizedDocument
+          else
+            Csi::UncolorizedDocument
+          end
+
+        document = klass.new.extend(ColorizedDocumentExtensions)
+
+        if block
+          document.__send__(:evaluate_block, &block)
+        else
+          document.colorize(*args, **opts)
+        end
+
+        document
+      end
+
+      def plural_type_for(value)
+        case value
+        when Numeric
+          "numbers"
+        when String
+          "strings"
+        when Symbol
+          "symbols"
+        else
+          "objects"
+        end
+      end
+
+      def jruby?
+        defined?(JRUBY_VERSION)
+      end
+
+      def ruby_version_matches?(version_string)
+        Gem::Requirement.new(version_string).satisfied_by?(
+          Gem::Version.new(RUBY_VERSION)
+        )
+      end
+
+      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
+        end
+      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) : ""
+        end
+      else
+        def object_address_for(object)
+          "0x%016x" % (object.object_id * 2)
+        end
+      end
+
+      def with_slice_of_array_replaced(array, range, replacement)
+        beginning =
+          if range.begin > 0
+            array[Range.new(0, range.begin - 1)]
+          else
+            []
+          end
+
+        ending =
+          if range.end <= array.length - 1
+            array[Range.new(range.end + 1, array.length - 1)]
+          else
+            []
+          end
+
+        beginning + [replacement] + ending
+      end
+    end
+  end
+end

data/lib/super_diff/core/implementation_checks.rb

@@ -0,0 +1,21 @@
+module SuperDiff
+  module Core
+    module ImplementationChecks
+      protected def unimplemented_instance_method!
+        raise(
+          NotImplementedError,
+          "#{self.class} must implement ##{caller_locations(1, 1).first.label}",
+          caller(1)
+        )
+      end
+
+      protected def unimplemented_class_method!
+        raise(
+          NotImplementedError,
+          "#{self} must implement .#{caller_locations(1, 1).first.label}",
+          caller(1)
+        )
+      end
+    end
+  end
+end

data/lib/super_diff/{object_inspection → core}/inspection_tree.rb

@@ -1,5 +1,5 @@
 module SuperDiff
-  module ObjectInspection
+  module Core
     class InspectionTree
       include Enumerable
 
@@ -10,7 +10,7 @@ module SuperDiff
         evaluate_block(&block) if block
       end
 
-      Nodes.registry.each do |node_class|
+      InspectionTreeNodes.registry.each do |node_class|
         define_method(node_class.method_name) do |*args, **options, &block|
           add_node(node_class, *args, **options, &block)
         end
@@ -59,7 +59,7 @@ 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 SuperDiff::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, {}])
@@ -86,7 +86,7 @@ module SuperDiff
 
           # Have to do these shenanigans so that if hash[key] is a hash, Ruby
           # doesn't try to interpret it as keyword args
-          if SuperDiff::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], {}])
@@ -148,11 +148,12 @@ module SuperDiff
         def call
           if rendering.is_a?(Array)
             concat_with_lines
-          elsif rendering.is_a?(PrefixForNextNode)
+          elsif rendering.is_a?(PrefixForNextInspectionTreeNode)
             add_to_prefix
           elsif tiered_lines.any?
             add_to_last_line
-          elsif index < nodes.size - 1 || rendering.is_a?(PreludeForNextNode)
+          elsif index < nodes.size - 1 ||
+                rendering.is_a?(PreludeForNextInspectionTreeNode)
             add_to_prelude
           else
             add_to_lines

data/lib/super_diff/core/inspection_tree_builder_dispatcher.rb

@@ -0,0 +1,23 @@
+module SuperDiff
+  module Core
+    class InspectionTreeBuilderDispatcher
+      extend AttrExtras.mixin
+
+      method_object :object, [:available_classes]
+
+      def call
+        if resolved_class
+          resolved_class.call(object)
+        else
+          raise NoInspectionTreeBuilderAvailableError.create(object)
+        end
+      end
+
+      private
+
+      def resolved_class
+        available_classes.find { |klass| klass.applies_to?(object) }
+      end
+    end
+  end
+end

data/lib/super_diff/{object_inspection/nodes → core/inspection_tree_nodes}/as_lines_when_rendering_to_lines.rb

@@ -1,6 +1,6 @@
 module SuperDiff
-  module ObjectInspection
-    module Nodes
+  module Core
+    module InspectionTreeNodes
       class AsLinesWhenRenderingToLines < Base
         def self.node_name
           :as_lines_when_rendering_to_lines
@@ -27,7 +27,13 @@ module SuperDiff
         def render_to_string(object)
           # TODO: This happens a lot, can we simplify this?
           string =
-            (block ? render_to_string_in_subtree(object) : immediate_value.to_s)
+            (
+              if block
+                render_to_string_in_subtree(object)
+              else
+                immediate_value.to_s
+              end
+            )
 
           add_comma? ? string + "," : string
         end

data/lib/super_diff/{object_inspection/nodes → core/inspection_tree_nodes}/as_prefix_when_rendering_to_lines.rb

@@ -1,6 +1,6 @@
 module SuperDiff
-  module ObjectInspection
-    module Nodes
+  module Core
+    module InspectionTreeNodes
       class AsPrefixWhenRenderingToLines < Base
         def self.name
           :as_prefix_when_rendering_to_lines
@@ -15,7 +15,7 @@ module SuperDiff
         end
 
         def render_to_lines(object, **)
-          ObjectInspection::PrefixForNextNode.new(render_to_string(object))
+          PrefixForNextInspectionTreeNode.new(render_to_string(object))
         end
       end
     end

data/lib/super_diff/{object_inspection/nodes → core/inspection_tree_nodes}/as_prelude_when_rendering_to_lines.rb

@@ -1,6 +1,6 @@
 module SuperDiff
-  module ObjectInspection
-    module Nodes
+  module Core
+    module InspectionTreeNodes
       class AsPreludeWhenRenderingToLines < Base
         def self.name
           :as_prelude_when_rendering_to_lines
@@ -15,7 +15,7 @@ module SuperDiff
         end
 
         def render_to_lines(object, **)
-          ObjectInspection::PreludeForNextNode.new(render_to_string(object))
+          PreludeForNextInspectionTreeNode.new(render_to_string(object))
         end
       end
     end

data/lib/super_diff/{object_inspection/nodes → core/inspection_tree_nodes}/as_single_line.rb

@@ -1,6 +1,6 @@
 module SuperDiff
-  module ObjectInspection
-    module Nodes
+  module Core
+    module InspectionTreeNodes
       class AsSingleLine < Base
         def self.node_name
           :as_single_line
@@ -16,7 +16,7 @@ module SuperDiff
 
         def render_to_lines(object, type:, indentation_level:)
           [
-            SuperDiff::Line.new(
+            Line.new(
               type: type,
               indentation_level: indentation_level,
               value: render_to_string(object)

data/lib/super_diff/{object_inspection/nodes → core/inspection_tree_nodes}/base.rb

@@ -1,6 +1,6 @@
 module SuperDiff
-  module ObjectInspection
-    module Nodes
+  module Core
+    module InspectionTreeNodes
       class Base
         def self.node_name
           unimplemented_class_method!

data/lib/super_diff/{object_inspection/nodes → core/inspection_tree_nodes}/inspection.rb

@@ -1,6 +1,6 @@
 module SuperDiff
-  module ObjectInspection
-    module Nodes
+  module Core
+    module InspectionTreeNodes
       class Inspection < Base
         def self.node_name
           :inspection
@@ -13,11 +13,9 @@ module SuperDiff
         def render_to_string(object)
           value = (block ? evaluate_block(object) : immediate_value)
 
-          SuperDiff::RecursionGuard.guarding_recursion_of(
-            value
-          ) do |already_seen|
+          RecursionGuard.guarding_recursion_of(value) do |already_seen|
             if already_seen
-              SuperDiff::RecursionGuard::PLACEHOLDER
+              RecursionGuard::PLACEHOLDER
             else
               SuperDiff.inspect_object(value, as_lines: false)
             end
@@ -27,15 +25,13 @@ module SuperDiff
         def render_to_lines(object, type:, indentation_level:)
           value = (block ? evaluate_block(object) : immediate_value)
 
-          SuperDiff::RecursionGuard.guarding_recursion_of(
-            value
-          ) do |already_seen|
+          RecursionGuard.guarding_recursion_of(value) do |already_seen|
             if already_seen
               [
-                SuperDiff::Line.new(
+                SuperDiff::Core::Line.new(
                   type: type,
                   indentation_level: indentation_level,
-                  value: SuperDiff::RecursionGuard::PLACEHOLDER
+                  value: RecursionGuard::PLACEHOLDER
                 )
               ]
             else

data/lib/super_diff/{object_inspection/nodes → core/inspection_tree_nodes}/nesting.rb

@@ -1,6 +1,6 @@
 module SuperDiff
-  module ObjectInspection
-    module Nodes
+  module Core
+    module InspectionTreeNodes
       class Nesting < Base
         def self.node_name
           :nesting

data/lib/super_diff/{object_inspection/nodes → core/inspection_tree_nodes}/only_when.rb

@@ -1,6 +1,6 @@
 module SuperDiff
-  module ObjectInspection
-    module Nodes
+  module Core
+    module InspectionTreeNodes
       class OnlyWhen < Base
         def self.node_name
           :only_when

data/lib/super_diff/{object_inspection/nodes → core/inspection_tree_nodes}/text.rb

@@ -1,6 +1,6 @@
 module SuperDiff
-  module ObjectInspection
-    module Nodes
+  module Core
+    module InspectionTreeNodes
       class Text < Base
         def self.node_name
           :text

data/lib/super_diff/{object_inspection/nodes → core/inspection_tree_nodes}/when_empty.rb

@@ -1,6 +1,6 @@
 module SuperDiff
-  module ObjectInspection
-    module Nodes
+  module Core
+    module InspectionTreeNodes
       class WhenEmpty < Base
         def self.node_name
           :when_empty

data/lib/super_diff/{object_inspection/nodes → core/inspection_tree_nodes}/when_non_empty.rb

@@ -1,6 +1,6 @@
 module SuperDiff
-  module ObjectInspection
-    module Nodes
+  module Core
+    module InspectionTreeNodes
       class WhenNonEmpty < Base
         def self.node_name
           :when_non_empty

data/lib/super_diff/{object_inspection/nodes → core/inspection_tree_nodes}/when_rendering_to_lines.rb

@@ -1,6 +1,6 @@
 module SuperDiff
-  module ObjectInspection
-    module Nodes
+  module Core
+    module InspectionTreeNodes
       class WhenRenderingToLines < Base
         def self.node_name
           :when_rendering_to_lines

data/lib/super_diff/{object_inspection/nodes → core/inspection_tree_nodes}/when_rendering_to_string.rb

@@ -1,6 +1,6 @@
 module SuperDiff
-  module ObjectInspection
-    module Nodes
+  module Core
+    module InspectionTreeNodes
       class WhenRenderingToString < Base
         def self.node_name
           :when_rendering_to_string