super_diff 0.4.2 → 0.5.0

data/lib/super_diff/differs/base.rb

@@ -5,7 +5,9 @@ module SuperDiff
         raise NotImplementedError
       end
 
+      extend ImplementationChecks
       extend AttrExtras.mixin
+      include ImplementationChecks
 
       method_object(
         :expected,
@@ -13,13 +15,15 @@ module SuperDiff
         [
           :indent_level!,
           index_in_collection: nil,
-          extra_operational_sequencer_classes: [],
-          extra_diff_formatter_classes: [],
         ],
       )
 
       def call
-        raise NotImplementedError
+        operation_tree.to_diff(
+          indent_level: indent_level,
+          collection_prefix: nil,
+          add_comma: false,
+        )
       end
 
       protected
@@ -27,6 +31,19 @@ module SuperDiff
       def indentation
         " " * (indent_level * 2)
       end
+
+      def operation_tree_builder_class
+        unimplemented_instance_method!
+      end
+
+      private
+
+      def operation_tree
+        operation_tree_builder_class.call(
+          expected: expected,
+          actual: actual,
+        )
+      end
     end
   end
 end

data/lib/super_diff/differs/custom_object.rb

@@ -7,19 +7,10 @@ module SuperDiff
           actual.respond_to?(:attributes_for_super_diff)
       end
 
-      def call
-        operations.to_diff(indent_level: indent_level)
-      end
-
       private
 
-      def operations
-        OperationalSequencers::CustomObject.call(
-          expected: expected,
-          actual: actual,
-          extra_operational_sequencer_classes: extra_operational_sequencer_classes,
-          extra_diff_formatter_classes: extra_diff_formatter_classes,
-        )
+      def operation_tree_builder_class
+        OperationTreeBuilders::CustomObject
       end
     end
   end

data/lib/super_diff/differs/default_object.rb

@@ -5,19 +5,13 @@ module SuperDiff
         expected.class == actual.class
       end
 
-      def call
-        operations.to_diff(indent_level: indent_level)
-      end
-
       private
 
-      def operations
-        OperationalSequencer.call(
+      def operation_tree
+        OperationTreeBuilders::Main.call(
           expected: expected,
           actual: actual,
           all_or_nothing: true,
-          extra_classes: extra_operational_sequencer_classes,
-          extra_diff_formatter_classes: extra_diff_formatter_classes,
         )
       end
     end

data/lib/super_diff/differs/defaults.rb

@@ -0,0 +1,12 @@
+module SuperDiff
+  module Differs
+    DEFAULTS = [
+      Array,
+      Hash,
+      TimeLike,
+      MultilineString,
+      CustomObject,
+      DefaultObject,
+    ].freeze
+  end
+end

data/lib/super_diff/differs/hash.rb

@@ -5,19 +5,10 @@ module SuperDiff
         expected.is_a?(::Hash) && actual.is_a?(::Hash)
       end
 
-      def call
-        DiffFormatters::Hash.call(operations, indent_level: indent_level)
-      end
-
       private
 
-      def operations
-        OperationalSequencers::Hash.call(
-          expected: expected,
-          actual: actual,
-          extra_operational_sequencer_classes: extra_operational_sequencer_classes,
-          extra_diff_formatter_classes: extra_diff_formatter_classes,
-        )
+      def operation_tree_builder_class
+        OperationTreeBuilders::Hash
       end
     end
   end

data/lib/super_diff/differs/main.rb

@@ -0,0 +1,48 @@
+module SuperDiff
+  module Differs
+    class Main
+      extend AttrExtras.mixin
+
+      method_object(
+        :expected,
+        :actual,
+        [
+          indent_level: 0,
+          index_in_collection: nil,
+          omit_empty: false,
+        ],
+      )
+
+      def call
+        if resolved_class
+          resolved_class.call(
+            expected,
+            actual,
+            indent_level: indent_level,
+            index_in_collection: index_in_collection,
+          )
+        else
+          raise Errors::NoDifferAvailableError.create(expected, actual)
+        end
+      end
+
+      private
+
+      attr_query :omit_empty?
+
+      def resolved_class
+        available_classes.find { |klass| klass.applies_to?(expected, actual) }
+      end
+
+      def available_classes
+        classes = SuperDiff.configuration.extra_differ_classes + DEFAULTS
+
+        if omit_empty?
+          classes
+        else
+          classes + [Empty]
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/differs/multiline_string.rb

@@ -6,22 +6,10 @@ module SuperDiff
           (expected.include?("\n") || actual.include?("\n"))
       end
 
-      def call
-        DiffFormatters::MultilineString.call(
-          operations,
-          indent_level: indent_level,
-        )
-      end
-
       private
 
-      def operations
-        OperationalSequencers::MultilineString.call(
-          expected: expected,
-          actual: actual,
-          extra_operational_sequencer_classes: extra_operational_sequencer_classes,
-          extra_diff_formatter_classes: extra_diff_formatter_classes,
-        )
+      def operation_tree_builder_class
+        OperationTreeBuilders::MultilineString
       end
     end
   end

data/lib/super_diff/differs/time_like.rb

@@ -0,0 +1,15 @@
+module SuperDiff
+  module Differs
+    class TimeLike < Base
+      def self.applies_to?(expected, actual)
+        SuperDiff.time_like?(expected) && SuperDiff.time_like?(actual)
+      end
+
+      private
+
+      def operation_tree_builder_class
+        OperationTreeBuilders::TimeLike
+      end
+    end
+  end
+end

data/lib/super_diff/equality_matchers.rb

@@ -3,6 +3,7 @@ module SuperDiff
     autoload :Array, "super_diff/equality_matchers/array"
     autoload :Base, "super_diff/equality_matchers/base"
     autoload :Hash, "super_diff/equality_matchers/hash"
+    autoload :Main, "super_diff/equality_matchers/main"
     autoload :MultilineString, "super_diff/equality_matchers/multiline_string"
     autoload :Default, "super_diff/equality_matchers/default"
     autoload :Primitive, "super_diff/equality_matchers/primitive"
@@ -10,14 +11,7 @@ module SuperDiff
       :SinglelineString,
       "super_diff/equality_matchers/singleline_string",
     )
-
-    DEFAULTS = [
-      Primitive,
-      Array,
-      Hash,
-      MultilineString,
-      SinglelineString,
-      Default,
-    ].freeze
   end
 end
+
+require "super_diff/equality_matchers/defaults"

data/lib/super_diff/equality_matchers/array.rb

@@ -33,13 +33,7 @@ module SuperDiff
       protected
 
       def diff
-        Differs::Array.call(
-          expected,
-          actual,
-          indent_level: 0,
-          extra_operational_sequencer_classes: extra_operational_sequencer_classes,
-          extra_diff_formatter_classes: extra_diff_formatter_classes,
-        )
+        Differs::Array.call(expected, actual, indent_level: 0)
       end
     end
   end

data/lib/super_diff/equality_matchers/base.rb

@@ -11,7 +11,7 @@ module SuperDiff
         [
           :expected!,
           :actual!,
-          extra_operational_sequencer_classes: [],
+          extra_operation_tree_builder_classes: [],
           extra_diff_formatter_classes: [],
         ]
       )

data/lib/super_diff/equality_matchers/default.rb

@@ -47,13 +47,7 @@ module SuperDiff
       end
 
       def diff
-        Differ.call(
-          expected,
-          actual,
-          indent_level: 0,
-          extra_operational_sequencer_classes: extra_operational_sequencer_classes,
-          extra_diff_formatter_classes: extra_diff_formatter_classes,
-        )
+        Differs::Main.call(expected, actual, indent_level: 0)
       end
     end
   end

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

@@ -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

@@ -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/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/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