super_diff 0.4.1 → 0.5.3

data/lib/super_diff/active_support/diff_formatters/hash_with_indifferent_access.rb

@@ -2,8 +2,8 @@ module SuperDiff
   module ActiveSupport
     module DiffFormatters
       class HashWithIndifferentAccess < SuperDiff::DiffFormatters::Base
-        def self.applies_to?(operations)
-          operations.is_a?(OperationSequences::HashWithIndifferentAccess)
+        def self.applies_to?(operation_tree)
+          operation_tree.is_a?(OperationTrees::HashWithIndifferentAccess)
         end
 
         def call
@@ -25,7 +25,7 @@ module SuperDiff
                 "#{key.inspect} => "
               end
             },
-            operations: operations,
+            operation_tree: operation_tree,
             indent_level: indent_level,
             add_comma: add_comma?,
           )

data/lib/super_diff/active_support/differs/hash_with_indifferent_access.rb

@@ -15,19 +15,17 @@ module SuperDiff
 
         def call
           DiffFormatters::HashWithIndifferentAccess.call(
-            operations,
+            operation_tree,
             indent_level: indent_level,
           )
         end
 
         private
 
-        def operations
-          OperationalSequencers::HashWithIndifferentAccess.call(
+        def operation_tree
+          OperationTreeBuilders::HashWithIndifferentAccess.call(
             expected: expected,
             actual: actual,
-            extra_operational_sequencer_classes: extra_operational_sequencer_classes,
-            extra_diff_formatter_classes: extra_diff_formatter_classes,
           )
         end
       end

data/lib/super_diff/active_support/object_inspection/inspectors/hash_with_indifferent_access.rb

@@ -2,15 +2,25 @@ module SuperDiff
   module ActiveSupport
     module ObjectInspection
       module Inspectors
-        HashWithIndifferentAccess = SuperDiff::ObjectInspection::InspectionTree.new do
-          add_text "#<HashWithIndifferentAccess {"
-
-          nested do |hash|
-            insert_hash_inspection_of(hash)
+        class HashWithIndifferentAccess < SuperDiff::ObjectInspection::Inspectors::Base
+          def self.applies_to?(value)
+            value.is_a?(::HashWithIndifferentAccess)
           end
 
-          add_break " "
-          add_text "}>"
+          protected
+
+          def inspection_tree
+            SuperDiff::ObjectInspection::InspectionTree.new do
+              add_text "#<HashWithIndifferentAccess {"
+
+              nested do |hash|
+                insert_hash_inspection_of(hash)
+              end
+
+              add_break " "
+              add_text "}>"
+            end
+          end
         end
       end
     end

data/lib/super_diff/active_support/operation_tree_builders.rb

@@ -0,0 +1,10 @@
+module SuperDiff
+  module ActiveSupport
+    module OperationTreeBuilders
+      autoload(
+        :HashWithIndifferentAccess,
+        "super_diff/active_support/operation_tree_builders/hash_with_indifferent_access",
+      )
+    end
+  end
+end

data/lib/super_diff/active_support/{operational_sequencers → operation_tree_builders}/hash_with_indifferent_access.rb

@@ -1,7 +1,7 @@
 module SuperDiff
   module ActiveSupport
-    module OperationalSequencers
-      class HashWithIndifferentAccess < SuperDiff::OperationalSequencers::Hash
+    module OperationTreeBuilders
+      class HashWithIndifferentAccess < SuperDiff::OperationTreeBuilders::Hash
         def initialize(expected:, actual:, **rest)
           super
 

data/lib/super_diff/active_support/{operation_sequences.rb → operation_trees.rb}

@@ -1,9 +1,9 @@
 module SuperDiff
   module ActiveSupport
-    module OperationSequences
+    module OperationTrees
       autoload(
         :HashWithIndifferentAccess,
-        "super_diff/active_support/operation_sequences/hash_with_indifferent_access",
+        "super_diff/active_support/operation_trees/hash_with_indifferent_access",
       )
     end
   end

data/lib/super_diff/active_support/{operation_sequences → operation_trees}/hash_with_indifferent_access.rb

@@ -1,7 +1,7 @@
 module SuperDiff
   module ActiveSupport
-    module OperationSequences
-      class HashWithIndifferentAccess < SuperDiff::OperationSequences::Base
+    module OperationTrees
+      class HashWithIndifferentAccess < SuperDiff::OperationTrees::Base
         def to_diff(indent_level:, collection_prefix:, add_comma:)
           DiffFormatters::HashWithIndifferentAccess.call(
             self,

data/lib/super_diff/configuration.rb

@@ -0,0 +1,60 @@
+module SuperDiff
+  class Configuration
+    attr_reader(
+      :extra_differ_classes,
+      :extra_operation_tree_builder_classes,
+      :extra_operation_tree_classes,
+      :extra_diff_formatter_classes,
+      :extra_inspector_classes,
+    )
+
+    def initialize
+      @extra_differ_classes = [].freeze
+      @extra_operation_tree_builder_classes = [].freeze
+      @extra_operation_tree_classes = [].freeze
+      @extra_diff_formatter_classes = [].freeze
+      @extra_inspector_classes = [].freeze
+    end
+
+    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 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 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 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 add_extra_inspector_classes(*classes)
+      @extra_inspector_classes =
+        (@extra_inspector_classes + classes).freeze
+    end
+    alias_method(
+      :add_extra_inspector_class,
+      :add_extra_inspector_classes,
+    )
+  end
+end

data/lib/super_diff/diff_formatters.rb

@@ -6,9 +6,9 @@ module SuperDiff
     autoload :CustomObject, "super_diff/diff_formatters/custom_object"
     autoload :DefaultObject, "super_diff/diff_formatters/default_object"
     autoload :Hash, "super_diff/diff_formatters/hash"
+    autoload :Main, "super_diff/diff_formatters/main"
     autoload :MultilineString, "super_diff/diff_formatters/multiline_string"
-
-    # TODO: Why doesn't this include CustomObject and DefaultObject?
-    DEFAULTS = [Array, Hash, MultilineString].freeze
   end
 end
+
+require "super_diff/diff_formatters/defaults"

data/lib/super_diff/diff_formatters/array.rb

@@ -1,8 +1,8 @@
 module SuperDiff
   module DiffFormatters
     class Array < Base
-      def self.applies_to?(operations)
-        operations.is_a?(OperationSequences::Array)
+      def self.applies_to?(operation_tree)
+        operation_tree.is_a?(OperationTrees::Array)
       end
 
       def call
@@ -11,7 +11,7 @@ module SuperDiff
           close_token: "]",
           collection_prefix: collection_prefix,
           build_item_prefix: proc { "" },
-          operations: operations,
+          operation_tree: operation_tree,
           indent_level: indent_level,
           add_comma: add_comma?,
         )

data/lib/super_diff/diff_formatters/base.rb

@@ -1,14 +1,15 @@
 module SuperDiff
   module DiffFormatters
     class Base
-      def self.applies_to?(_operations)
+      def self.applies_to?(*)
         raise NotImplementedError
       end
 
+      include ImplementationChecks
       extend AttrExtras.mixin
 
       method_object(
-        :operations,
+        :operation_tree,
         [
           :indent_level!,
           collection_prefix: "",

data/lib/super_diff/diff_formatters/collection.rb

@@ -10,7 +10,7 @@ module SuperDiff
         [
           :open_token!,
           :close_token!,
-          :operations!,
+          :operation_tree!,
           :indent_level!,
           :add_comma!,
           :collection_prefix!,
@@ -35,7 +35,7 @@ module SuperDiff
       end
 
       def contents
-        operations.map do |operation|
+        operation_tree.map do |operation|
           if operation.name == :change
             handle_change_operation(operation)
           else

data/lib/super_diff/diff_formatters/custom_object.rb

@@ -1,8 +1,8 @@
 module SuperDiff
   module DiffFormatters
     class CustomObject < DefaultObject
-      def self.applies_to?(operations)
-        operations.is_a?(OperationSequences::CustomObject)
+      def self.applies_to?(operation_tree)
+        operation_tree.is_a?(OperationTrees::CustomObject)
       end
 
       def call
@@ -20,7 +20,7 @@ module SuperDiff
 
             "#{key}: "
           },
-          operations: operations,
+          operation_tree: operation_tree,
           indent_level: indent_level,
           add_comma: add_comma?,
         )

data/lib/super_diff/diff_formatters/default_object.rb

@@ -1,12 +1,12 @@
 module SuperDiff
   module DiffFormatters
     class DefaultObject < Base
-      def self.applies_to?(operations)
-        operations.is_a?(OperationSequences::DefaultObject)
+      def self.applies_to?(operation_tree)
+        operation_tree.is_a?(OperationTrees::DefaultObject)
       end
 
-      def initialize(operations, value_class: nil, **rest)
-        super(operations, **rest)
+      def initialize(operation_tree, value_class: nil, **rest)
+        super(operation_tree, **rest)
 
         @value_class = value_class
       end
@@ -26,7 +26,7 @@ module SuperDiff
 
             "@#{key}="
           },
-          operations: operations,
+          operation_tree: operation_tree,
           indent_level: indent_level,
           add_comma: add_comma?,
         )
@@ -38,9 +38,7 @@ module SuperDiff
         if @value_class
           @value_class
         else
-          raise NotImplementedError.new(
-            "You must override #value_class in your subclass.",
-          )
+          unimplemented_instance_method!
         end
       end
     end

data/lib/super_diff/diff_formatters/defaults.rb

@@ -0,0 +1,10 @@
+module SuperDiff
+  module DiffFormatters
+    DEFAULTS = [
+      Array,
+      Hash,
+      CustomObject,
+      DefaultObject,
+    ].freeze
+  end
+end

data/lib/super_diff/diff_formatters/hash.rb

@@ -1,8 +1,8 @@
 module SuperDiff
   module DiffFormatters
     class Hash < Base
-      def self.applies_to?(operations)
-        operations.is_a?(OperationSequences::Hash)
+      def self.applies_to?(operation_tree)
+        operation_tree.is_a?(OperationTrees::Hash)
       end
 
       def call
@@ -24,7 +24,7 @@ module SuperDiff
               "#{key.inspect} => "
             end
           },
-          operations: operations,
+          operation_tree: operation_tree,
           indent_level: indent_level,
           add_comma: add_comma?,
         )

data/lib/super_diff/diff_formatters/main.rb

@@ -0,0 +1,41 @@
+module SuperDiff
+  module DiffFormatters
+    class Main
+      extend AttrExtras.mixin
+
+      method_object(
+        :operation_tree,
+        [
+          :indent_level!,
+          add_comma: false,
+          value_class: nil,
+        ],
+      )
+
+      def call
+        if resolved_class
+          resolved_class.call(
+            operation_tree,
+            indent_level: indent_level,
+            add_comma: add_comma?,
+            value_class: value_class,
+          )
+        else
+          raise NoDiffFormatterAvailableError.create(operation_tree)
+        end
+      end
+
+      private
+
+      attr_query :add_comma?
+
+      def resolved_class
+        available_classes.find { |klass| klass.applies_to?(operation_tree) }
+      end
+
+      def available_classes
+        DEFAULTS + SuperDiff.configuration.extra_diff_formatter_classes
+      end
+    end
+  end
+end

data/lib/super_diff/diff_formatters/multiline_string.rb

@@ -1,8 +1,8 @@
 module SuperDiff
   module DiffFormatters
     class MultilineString < Base
-      def self.applies_to?(operations)
-        operations.is_a?(OperationSequences::MultilineString)
+      def self.applies_to?(operation_tree)
+        operation_tree.is_a?(OperationTrees::MultilineString)
       end
 
       def call
@@ -12,7 +12,7 @@ module SuperDiff
       private
 
       def lines
-        operations.reduce([]) do |array, operation|
+        operation_tree.reduce([]) do |array, operation|
           case operation.name
           when :change
             array << Helpers.style(:alpha, "- #{operation.left_value}")

data/lib/super_diff/differs.rb

@@ -6,17 +6,10 @@ module SuperDiff
     autoload :DefaultObject, "super_diff/differs/default_object"
     autoload :Empty, "super_diff/differs/empty"
     autoload :Hash, "super_diff/differs/hash"
+    autoload :Main, "super_diff/differs/main"
     autoload :MultilineString, "super_diff/differs/multiline_string"
-    autoload :Time, "super_diff/differs/time"
-
-    DEFAULTS = [
-      Array,
-      Hash,
-      Time,
-      MultilineString,
-      CustomObject,
-      DefaultObject,
-      Empty,
-    ].freeze
+    autoload :TimeLike, "super_diff/differs/time_like"
   end
 end
+
+require "super_diff/differs/defaults"

data/lib/super_diff/differs/array.rb

@@ -5,19 +5,10 @@ module SuperDiff
         expected.is_a?(::Array) && actual.is_a?(::Array)
       end
 
-      def call
-        DiffFormatters::Array.call(operations, indent_level: indent_level)
-      end
-
       private
 
-      def operations
-        OperationalSequencers::Array.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::Array
       end
     end
   end