super_diff 0.4.0 → 0.5.2

data/lib/super_diff/active_record/object_inspection/inspectors/active_record_relation.rb

@@ -2,15 +2,25 @@ module SuperDiff
   module ActiveRecord
     module ObjectInspection
       module Inspectors
-        ActiveRecordRelation = SuperDiff::ObjectInspection::InspectionTree.new do
-          add_text "#<ActiveRecord::Relation ["
-
-          nested do |array|
-            insert_array_inspection_of(array)
+        class ActiveRecordRelation < SuperDiff::ObjectInspection::Inspectors::Base
+          def self.applies_to?(value)
+            value.is_a?(::ActiveRecord::Relation)
           end
 
-          add_break
-          add_text "]>"
+          protected
+
+          def inspection_tree
+            SuperDiff::ObjectInspection::InspectionTree.new do
+              add_text "#<ActiveRecord::Relation ["
+
+              nested do |array|
+                insert_array_inspection_of(array)
+              end
+
+              add_break
+              add_text "]>"
+            end
+          end
         end
       end
     end

data/lib/super_diff/active_record/operation_tree_builders.rb

@@ -0,0 +1,14 @@
+module SuperDiff
+  module ActiveRecord
+    module OperationTreeBuilders
+      autoload(
+        :ActiveRecordModel,
+        "super_diff/active_record/operation_tree_builders/active_record_model",
+      )
+      autoload(
+        :ActiveRecordRelation,
+        "super_diff/active_record/operation_tree_builders/active_record_relation",
+      )
+    end
+  end
+end

data/lib/super_diff/active_record/{operational_sequencers → operation_tree_builders}/active_record_model.rb

@@ -1,7 +1,7 @@
 module SuperDiff
   module ActiveRecord
-    module OperationalSequencers
-      class ActiveRecordModel < SuperDiff::OperationalSequencers::CustomObject
+    module OperationTreeBuilders
+      class ActiveRecordModel < SuperDiff::OperationTreeBuilders::CustomObject
         def self.applies_to?(expected, actual)
           expected.is_a?(::ActiveRecord::Base) &&
             actual.is_a?(::ActiveRecord::Base) &&

data/lib/super_diff/active_record/{operational_sequencers → operation_tree_builders}/active_record_relation.rb

@@ -1,7 +1,7 @@
 module SuperDiff
   module ActiveRecord
-    module OperationalSequencers
-      class ActiveRecordRelation < SuperDiff::OperationalSequencers::Array
+    module OperationTreeBuilders
+      class ActiveRecordRelation < SuperDiff::OperationTreeBuilders::Array
         def self.applies_to?(expected, actual)
           expected.is_a?(::Array) &&
             actual.is_a?(::ActiveRecord::Relation)
@@ -15,8 +15,8 @@ module SuperDiff
 
         private
 
-        def operations
-          @_operations ||= OperationSequences::ActiveRecordRelation.new([])
+        def operation_tree
+          @_operation_tree ||= OperationTrees::ActiveRecordRelation.new([])
         end
       end
     end

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

@@ -1,9 +1,9 @@
 module SuperDiff
   module ActiveRecord
-    module OperationSequences
+    module OperationTrees
       autoload(
         :ActiveRecordRelation,
-        "super_diff/active_record/operation_sequences/active_record_relation",
+        "super_diff/active_record/operation_trees/active_record_relation",
       )
     end
   end

data/lib/super_diff/active_record/{operation_sequences → operation_trees}/active_record_relation.rb

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

data/lib/super_diff/active_support.rb

@@ -4,30 +4,27 @@ module SuperDiff
     autoload :Differs, "super_diff/active_support/differs"
     autoload :ObjectInspection, "super_diff/active_support/object_inspection"
     autoload(
-      :OperationalSequencers,
-      "super_diff/active_support/operational_sequencers",
+      :OperationTreeBuilders,
+      "super_diff/active_support/operation_tree_builders",
     )
     autoload(
       :OperationalSequences,
       "super_diff/active_support/operational_sequences",
     )
-  end
-end
 
-if defined?(SuperDiff::RSpec)
-  SuperDiff::RSpec.configure do |config|
-    config.add_extra_differ_class(
-      SuperDiff::ActiveSupport::Differs::HashWithIndifferentAccess,
-    )
-    config.add_extra_operational_sequencer_class(
-      SuperDiff::ActiveSupport::OperationalSequencers::HashWithIndifferentAccess,
-    )
-    config.add_extra_diff_formatter_class(
-      SuperDiff::ActiveSupport::DiffFormatters::HashWithIndifferentAccess,
-    )
+    SuperDiff.configure do |config|
+      config.add_extra_differ_classes(
+        Differs::HashWithIndifferentAccess,
+      )
+      config.add_extra_operation_tree_builder_classes(
+        OperationTreeBuilders::HashWithIndifferentAccess,
+      )
+      config.add_extra_diff_formatter_classes(
+        DiffFormatters::HashWithIndifferentAccess,
+      )
+      config.add_extra_inspector_classes(
+        ObjectInspection::Inspectors::HashWithIndifferentAccess,
+      )
+    end
   end
 end
-
-SuperDiff::ObjectInspection.map.prepend(
-  SuperDiff::ActiveSupport::ObjectInspection::MapExtension,
-)

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