super_diff 0.4.2 → 0.6.0

data/lib/super_diff/equality_matchers/defaults.rb

@@ -0,0 +1,12 @@
+module SuperDiff
+  module EqualityMatchers
+    DEFAULTS = [
+      Primitive,
+      Array,
+      Hash,
+      MultilineString,
+      SinglelineString,
+      Default,
+    ].freeze
+  end
+end

data/lib/super_diff/equality_matchers/hash.rb

@@ -11,14 +11,14 @@ module SuperDiff
 
           #{
             Helpers.style(
-              :alpha,
+              :expected,
               "Expected: " +
               ObjectInspection.inspect(expected, as_single_line: true),
             )
           }
           #{
             Helpers.style(
-              :beta,
+              :actual,
               "  Actual: " +
               ObjectInspection.inspect(actual, as_single_line: true),
             )
@@ -33,13 +33,7 @@ module SuperDiff
       protected
 
       def diff
-        Differs::Hash.call(
-          expected,
-          actual,
-          indent_level: 0,
-          extra_operational_sequencer_classes: extra_operational_sequencer_classes,
-          extra_diff_formatter_classes: extra_diff_formatter_classes,
-        )
+        Differs::Hash.call(expected, actual, indent_level: 0)
       end
     end
   end

data/lib/super_diff/equality_matchers/main.rb

@@ -0,0 +1,21 @@
+module SuperDiff
+  module EqualityMatchers
+    class Main
+      extend AttrExtras.mixin
+
+      method_object [:expected!, :actual!, extra_classes: []]
+
+      def call
+        resolved_class.call(expected: expected, actual: actual)
+      end
+
+      private
+
+      def resolved_class
+        (DEFAULTS + extra_classes).find do |klass|
+          klass.applies_to?(expected) && klass.applies_to?(actual)
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/equality_matchers/multiline_string.rb

@@ -12,14 +12,14 @@ module SuperDiff
           #{
             # TODO: This whole thing should not be red or green, just the values
             Helpers.style(
-              :alpha,
+              :expected,
               "Expected: " +
               ObjectInspection.inspect(expected, as_single_line: true),
             )
           }
           #{
             Helpers.style(
-              :beta,
+              :actual,
               "  Actual: " +
               ObjectInspection.inspect(actual, as_single_line: true),
             )
@@ -34,13 +34,7 @@ module SuperDiff
       private
 
       def diff
-        Differs::MultilineString.call(
-          expected,
-          actual,
-          indent_level: 0,
-          extra_operational_sequencer_classes: extra_operational_sequencer_classes,
-          extra_diff_formatter_classes: extra_diff_formatter_classes,
-        )
+        Differs::MultilineString.call(expected, actual, indent_level: 0)
       end
     end
   end

data/lib/super_diff/equality_matchers/primitive.rb

@@ -15,14 +15,14 @@ module SuperDiff
 
           #{
             Helpers.style(
-              :alpha,
+              :expected,
               "Expected: " +
               ObjectInspection.inspect(expected, as_single_line: true),
             )
           }
           #{
             Helpers.style(
-              :beta,
+              :actual,
               "  Actual: " +
               ObjectInspection.inspect(actual, as_single_line: true),
             )

data/lib/super_diff/equality_matchers/singleline_string.rb

@@ -11,14 +11,14 @@ module SuperDiff
 
           #{
             Helpers.style(
-              :alpha,
+              :expected,
               "Expected: " +
               ObjectInspection.inspect(expected, as_single_line: true),
             )
           }
           #{
             Helpers.style(
-              :beta,
+              :actual,
               "  Actual: " +
               ObjectInspection.inspect(actual, as_single_line: true),
             )

data/lib/super_diff/errors.rb

@@ -0,0 +1,16 @@
+module SuperDiff
+  module Errors
+    autoload(
+      :NoDiffFormatterAvailableError,
+      "super_diff/errors/no_diff_formatter_available_error",
+    )
+    autoload(
+      :NoDifferAvailableError,
+      "super_diff/errors/no_differ_available_error",
+    )
+    autoload(
+      :NoOperationTreeBuilderAvailableError,
+      "super_diff/errors/no_operation_tree_builder_available_error",
+    )
+  end
+end

data/lib/super_diff/errors/no_diff_formatter_available_error.rb

@@ -0,0 +1,21 @@
+module SuperDiff
+  module Errors
+    class NoDiffFormatterAvailableError < StandardError
+      def self.create(operation_tree)
+        allocate.tap do |error|
+          error.operation_tree = operation_tree
+          error.__send__(:initialize)
+        end
+      end
+
+      attr_accessor :operation_tree
+
+      def initialize
+        super(<<-MESSAGE)
+There is no diff formatter available to handle an operation tree object of
+#{operation_tree.class}.
+        MESSAGE
+      end
+    end
+  end
+end

data/lib/super_diff/errors/no_differ_available_error.rb

@@ -0,0 +1,24 @@
+module SuperDiff
+  module Errors
+    class NoDifferAvailableError < StandardError
+      def self.create(expected, actual)
+        allocate.tap do |error|
+          error.expected = expected
+          error.actual = actual
+          error.__send__(:initialize)
+        end
+      end
+
+      attr_accessor :expected, :actual
+
+      def initialize
+        super(<<-MESSAGE)
+There is no differ available to handle an "expected" value of type
+#{expected.class}
+and an "actual" value of type
+#{actual.class}.
+        MESSAGE
+      end
+    end
+  end
+end

data/lib/super_diff/errors/no_operational_sequencer_available_error.rb

@@ -0,0 +1,22 @@
+module SuperDiff
+  module Errors
+    class NoOperationalSequencerAvailableError < StandardError
+      def self.create(expected, actual)
+        allocate.tap do |error|
+          error.expected = expected
+          error.actual = actual
+          error.__send__(:initialize)
+        end
+      end
+
+      attr_accessor :expected, :actual
+
+      def initialize
+        super(<<-MESSAGE)
+There is no operational sequencer available to handle an "expected" value of
+type #{expected.class} and an "actual" value of type #{actual.class}.
+        MESSAGE
+      end
+    end
+  end
+end

data/lib/super_diff/gem_version.rb

@@ -0,0 +1,45 @@
+module SuperDiff
+  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

data/lib/super_diff/implementation_checks.rb

@@ -0,0 +1,19 @@
+module SuperDiff
+  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

data/lib/super_diff/object_inspection.rb

@@ -1,24 +1,15 @@
 module SuperDiff
   module ObjectInspection
     autoload :InspectionTree, "super_diff/object_inspection/inspection_tree"
-    autoload :Inspector, "super_diff/object_inspection/inspector"
     autoload :Inspectors, "super_diff/object_inspection/inspectors"
-    autoload :Map, "super_diff/object_inspection/map"
     autoload :Nodes, "super_diff/object_inspection/nodes"
 
-    class << self
-      attr_accessor :map
-    end
-
     def self.inspect(object, as_single_line:, indent_level: 0)
-      Inspector.call(
-        map,
+      Inspectors::Main.call(
         object,
         as_single_line: as_single_line,
         indent_level: indent_level,
       )
     end
-
-    self.map = Map.new
   end
 end

data/lib/super_diff/object_inspection/inspection_tree.rb

@@ -107,8 +107,12 @@ module SuperDiff
         end
       end
 
-      def add_inspection_of(value)
-        add_node :inspection, value
+      def add_inspection_of(value = nil, &block)
+        if block
+          add_node :inspection, &block
+        else
+          add_node :inspection, value
+        end
       end
 
       def apply_tree(tree)

data/lib/super_diff/object_inspection/inspectors.rb

@@ -1,6 +1,7 @@
 module SuperDiff
   module ObjectInspection
     module Inspectors
+      autoload :Base, "super_diff/object_inspection/inspectors/base"
       autoload :Array, "super_diff/object_inspection/inspectors/array"
       autoload(
         :CustomObject,
@@ -11,9 +12,12 @@ module SuperDiff
         "super_diff/object_inspection/inspectors/default_object",
       )
       autoload :Hash, "super_diff/object_inspection/inspectors/hash"
+      autoload :Main, "super_diff/object_inspection/inspectors/main"
       autoload :Primitive, "super_diff/object_inspection/inspectors/primitive"
       autoload :String, "super_diff/object_inspection/inspectors/string"
-      autoload :Time, "super_diff/object_inspection/inspectors/time"
+      autoload :TimeLike, "super_diff/object_inspection/inspectors/time_like"
     end
   end
 end
+
+require "super_diff/object_inspection/inspectors/defaults"

data/lib/super_diff/object_inspection/inspectors/array.rb

@@ -1,20 +1,30 @@
 module SuperDiff
   module ObjectInspection
     module Inspectors
-      Array = InspectionTree.new do
-        when_empty do
-          add_text "[]"
+      class Array < Base
+        def self.applies_to?(value)
+          value.is_a?(::Array)
         end
 
-        when_non_empty do
-          add_text "["
+        protected
 
-          nested do |array|
-            insert_array_inspection_of(array)
-          end
+        def inspection_tree
+          InspectionTree.new do
+            when_empty do
+              add_text "[]"
+            end
+
+            when_non_empty do
+              add_text "["
 
-          add_break
-          add_text "]"
+              nested do |array|
+                insert_array_inspection_of(array)
+              end
+
+              add_break
+              add_text "]"
+            end
+          end
         end
       end
     end

data/lib/super_diff/object_inspection/inspectors/base.rb

@@ -0,0 +1,36 @@
+module SuperDiff
+  module ObjectInspection
+    module Inspectors
+      class Base
+        extend AttrExtras.mixin
+        extend ImplementationChecks
+
+        def self.applies_to?(_value)
+          unimplemented_class_method!
+        end
+
+        method_object :object, [:as_single_line!, :indent_level]
+
+        def call
+          SuperDiff::RecursionGuard.substituting_recursion_of(object) do
+            inspection_tree.evaluate(
+              object,
+              as_single_line: as_single_line,
+              indent_level: indent_level,
+            )
+          end
+        end
+
+        protected
+
+        def inspection_tree
+          unimplemented_instance_method!
+        end
+
+        private
+
+        attr_query :as_single_line?
+      end
+    end
+  end
+end

data/lib/super_diff/object_inspection/inspectors/custom_object.rb

@@ -1,26 +1,36 @@
 module SuperDiff
   module ObjectInspection
     module Inspectors
-      CustomObject = InspectionTree.new do
-        add_text do |object|
-          "#<#{object.class}"
+      class CustomObject < Base
+        def self.applies_to?(value)
+          value.respond_to?(:attributes_for_super_diff)
         end
 
-        when_multiline do
-          add_text " {"
-        end
+        protected
 
-        nested do |object|
-          insert_hash_inspection_of(object.attributes_for_super_diff)
-        end
+        def inspection_tree
+          InspectionTree.new do
+            add_text do |object|
+              "#<#{object.class}"
+            end
 
-        add_break
+            when_multiline do
+              add_text " {"
+            end
 
-        when_multiline do
-          add_text "}"
-        end
+            nested do |object|
+              insert_hash_inspection_of(object.attributes_for_super_diff)
+            end
 
-        add_text ">"
+            add_break
+
+            when_multiline do
+              add_text "}"
+            end
+
+            add_text ">"
+          end
+        end
       end
     end
   end