super_diff 0.4.2 → 0.5.0

data/lib/super_diff/operation_tree_builders/main.rb

@@ -0,0 +1,42 @@
+module SuperDiff
+  module OperationTreeBuilders
+    class Main
+      extend AttrExtras.mixin
+
+      method_object [:expected!, :actual!, :all_or_nothing!]
+
+      def call
+        if resolved_class
+          resolved_class.call(
+            expected: expected,
+            actual: actual,
+          )
+        elsif all_or_nothing?
+          raise NoOperationTreeBuilderAvailableError.create(expected, actual)
+        else
+          nil
+        end
+      end
+
+      private
+
+      attr_query :all_or_nothing?
+
+      def resolved_class
+        available_classes.find { |klass| klass.applies_to?(expected, actual) }
+      end
+
+      def available_classes
+        classes =
+          SuperDiff.configuration.extra_operation_tree_builder_classes +
+          DEFAULTS
+
+        if all_or_nothing?
+          classes + [DefaultObject]
+        else
+          classes
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/{operational_sequencers → operation_tree_builders}/multiline_string.rb

@@ -1,5 +1,5 @@
 module SuperDiff
-  module OperationalSequencers
+  module OperationTreeBuilders
     class MultilineString < Base
       def self.applies_to?(expected, actual)
         expected.is_a?(::String) && actual.is_a?(::String) &&
@@ -30,8 +30,8 @@ module SuperDiff
         end
       end
 
-      def build_operation_sequencer
-        OperationSequences::Array.new([])
+      def build_operation_tree
+        OperationTrees::MultilineString.new([])
       end
 
       private

data/lib/super_diff/operation_tree_builders/time_like.rb

@@ -0,0 +1,34 @@
+module SuperDiff
+  module OperationTreeBuilders
+    class TimeLike < CustomObject
+      def self.applies_to?(expected, actual)
+        SuperDiff.time_like?(expected) && SuperDiff.time_like?(actual)
+      end
+
+      protected
+
+      def attribute_names
+        base = [
+          "year",
+          "month",
+          "day",
+          "hour",
+          "min",
+          "sec",
+          "nsec",
+          "zone",
+          "gmt_offset",
+        ]
+
+        # If timezones are different, also show a normalized timestamp at the
+        # end of the diff to help visualize why they are different moments in
+        # time.
+        if actual.zone != expected.zone
+          base + ["utc"]
+        else
+          base
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/operation_trees.rb

@@ -0,0 +1,13 @@
+module SuperDiff
+  module OperationTrees
+    autoload :Array, "super_diff/operation_trees/array"
+    autoload :Base, "super_diff/operation_trees/base"
+    autoload :CustomObject, "super_diff/operation_trees/custom_object"
+    autoload :DefaultObject, "super_diff/operation_trees/default_object"
+    autoload :Hash, "super_diff/operation_trees/hash"
+    autoload :Main, "super_diff/operation_trees/main"
+    autoload :MultilineString, "super_diff/operation_trees/multiline_string"
+  end
+end
+
+require "super_diff/operation_trees/defaults"

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

@@ -1,6 +1,10 @@
 module SuperDiff
-  module OperationSequences
+  module OperationTrees
     class Array < Base
+      def self.applies_to?(value)
+        value.is_a?(::Array)
+      end
+
       def to_diff(indent_level:, collection_prefix:, add_comma:)
         DiffFormatters::Array.call(
           self,

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

@@ -1,6 +1,12 @@
 module SuperDiff
-  module OperationSequences
+  module OperationTrees
     class Base < SimpleDelegator
+      def self.applies_to?(_value)
+        unimplemented_class_method!
+      end
+
+      extend ImplementationChecks
+
       # rubocop:disable Lint/UnusedMethodArgument
       def to_diff(indent_level:, add_comma: false, collection_prefix: nil)
         raise NotImplementedError

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

@@ -1,6 +1,10 @@
 module SuperDiff
-  module OperationSequences
+  module OperationTrees
     class CustomObject < DefaultObject
+      def self.applies_to?(value)
+        value.respond_to?(:attributes_for_super_diff)
+      end
+
       def to_diff(indent_level:, add_comma: false, collection_prefix: nil)
         DiffFormatters::CustomObject.call(
           self,

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

@@ -1,25 +1,27 @@
 module SuperDiff
-  module OperationSequences
+  module OperationTrees
     class DefaultObject < Base
+      def self.applies_to?(_value)
+        true
+      end
+
+      attr_reader :value_class
+
+      # TODO: Default this to collection.class?
       def initialize(collection, value_class:)
         super(collection)
 
         @value_class = value_class
       end
 
-      def to_diff(indent_level:, add_comma: false, collection_prefix: nil)
-        DiffFormatters::DefaultObject.call(
+      def to_diff(indent_level:, add_comma: false, **_rest)
+        DiffFormatters::Main.call(
           self,
           indent_level: indent_level,
-          collection_prefix: collection_prefix,
           add_comma: add_comma,
           value_class: value_class,
         )
       end
-
-      private
-
-      attr_reader :value_class
     end
   end
 end

data/lib/super_diff/operation_trees/defaults.rb

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

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

@@ -1,6 +1,10 @@
 module SuperDiff
-  module OperationSequences
+  module OperationTrees
     class Hash < Base
+      def self.applies_to?(value)
+        value.is_a?(::Hash)
+      end
+
       def to_diff(indent_level:, collection_prefix:, add_comma:)
         DiffFormatters::Hash.call(
           self,

data/lib/super_diff/operation_trees/main.rb

@@ -0,0 +1,35 @@
+module SuperDiff
+  module OperationTrees
+    class Main
+      extend AttrExtras.mixin
+
+      method_object :value
+
+      def call
+        if resolved_class
+          begin
+            resolved_class.new([], value_class: value.class)
+          rescue ArgumentError
+            resolved_class.new([])
+          end
+        else
+          raise Errors::NoOperationalSequenceAvailableError.create(value)
+        end
+      end
+
+      private
+
+      def resolved_class
+        if value.respond_to?(:attributes_for_super_diff)
+          CustomObject
+        else
+          available_classes.find { |klass| klass.applies_to?(value) }
+        end
+      end
+
+      def available_classes
+        SuperDiff.configuration.extra_operation_tree_classes + DEFAULTS
+      end
+    end
+  end
+end

data/lib/super_diff/operation_trees/multiline_string.rb

@@ -0,0 +1,18 @@
+module SuperDiff
+  module OperationTrees
+    class MultilineString < Base
+      def self.applies_to?(value)
+        value.is_a?(::String) && value.is_a?(::String)
+      end
+
+      def to_diff(indent_level:, collection_prefix:, add_comma:)
+        DiffFormatters::MultilineString.call(
+          self,
+          indent_level: indent_level,
+          collection_prefix: collection_prefix,
+          add_comma: add_comma,
+        )
+      end
+    end
+  end
+end

data/lib/super_diff/operations/unary_operation.rb

@@ -6,6 +6,7 @@ module SuperDiff
         :collection,
         :key,
         :value,
+        # TODO: Is this even used??
         :index,
         :index_in_collection,
       )
@@ -15,6 +16,7 @@ module SuperDiff
         collection:,
         key:,
         value:,
+        # TODO: Is this even used??
         index:,
         index_in_collection: index
       )
@@ -22,6 +24,7 @@ module SuperDiff
         @collection = collection
         @key = key
         @value = value
+        # TODO: Is this even used??
         @index = index
         @index_in_collection = index_in_collection
       end

data/lib/super_diff/rspec.rb

@@ -9,20 +9,14 @@ module SuperDiff
     autoload :MatcherTextBuilders, "super_diff/rspec/matcher_text_builders"
     autoload :MatcherTextTemplate, "super_diff/rspec/matcher_text_template"
     autoload :ObjectInspection, "super_diff/rspec/object_inspection"
-    autoload :OperationalSequencers, "super_diff/rspec/operational_sequencers"
-
-    class << self
-      attr_accessor :extra_differ_classes
-      attr_accessor :extra_operational_sequencer_classes
-      attr_accessor :extra_diff_formatter_classes
-    end
+    autoload :OperationTreeBuilders, "super_diff/rspec/operation_tree_builders"
 
     def self.configure
       yield configuration
     end
 
     def self.configuration
-      @_configuration ||= Configuration.new
+      SuperDiff.configuration
     end
 
     def self.a_hash_including_something?(value)
@@ -48,16 +42,54 @@ module SuperDiff
         value.base_matcher.is_a?(::RSpec::Matchers::BuiltIn::ContainExactly)
     end
 
+    def self.a_kind_of_something?(value)
+      fuzzy_object?(value) &&
+        value.base_matcher.is_a?(::RSpec::Matchers::BuiltIn::BeAKindOf)
+    end
+
+    def self.an_instance_of_something?(value)
+      fuzzy_object?(value) &&
+        value.base_matcher.is_a?(::RSpec::Matchers::BuiltIn::BeAnInstanceOf)
+    end
+
+    def self.a_value_within_something?(value)
+      fuzzy_object?(value) &&
+        value.base_matcher.is_a?(::RSpec::Matchers::BuiltIn::BeWithin)
+    end
+
     def self.fuzzy_object?(value)
       value.is_a?(::RSpec::Matchers::AliasedMatcher)
     end
+
+    SuperDiff.configuration.tap do |config|
+      config.add_extra_differ_classes(
+        Differs::CollectionContainingExactly,
+        Differs::CollectionIncluding,
+        Differs::HashIncluding,
+        Differs::ObjectHavingAttributes,
+      )
+
+      config.add_extra_operation_tree_builder_classes(
+        OperationTreeBuilders::CollectionContainingExactly,
+        OperationTreeBuilders::CollectionIncluding,
+        OperationTreeBuilders::HashIncluding,
+        OperationTreeBuilders::ObjectHavingAttributes,
+      )
+
+      config.add_extra_inspector_classes(
+        ObjectInspection::Inspectors::CollectionContainingExactly,
+        ObjectInspection::Inspectors::CollectionIncluding,
+        ObjectInspection::Inspectors::HashIncluding,
+        ObjectInspection::Inspectors::InstanceOf,
+        ObjectInspection::Inspectors::KindOf,
+        ObjectInspection::Inspectors::ObjectHavingAttributes,
+        ObjectInspection::Inspectors::Primitive,
+        ObjectInspection::Inspectors::ValueWithin,
+      )
+    end
   end
 end
 
 require_relative "rspec/monkey_patches"
 
-SuperDiff::ObjectInspection.map.prepend(
-  SuperDiff::RSpec::ObjectInspection::MapExtension,
-)
-
-SuperDiff::Csi.color_enabled = RSpec.configuration.color_enabled?
+SuperDiff::Csi.color_enabled = ::RSpec.configuration.color_enabled?

data/lib/super_diff/rspec/augmented_matcher.rb

@@ -31,7 +31,7 @@ module SuperDiff
 
       def matcher_text_builder
         @_matcher_text_builder ||=
-          matcher_text_builder_class.new(matcher_text_builder_args)
+          matcher_text_builder_class.new(**matcher_text_builder_args)
       end
 
       def matcher_text_builder_class

data/lib/super_diff/rspec/differ.rb

@@ -7,31 +7,16 @@ module SuperDiff
 
       def diff
         if worth_diffing?
-          diff = SuperDiff::Differ.call(
+          diff = SuperDiff::Differs::Main.call(
             expected,
             actual,
             omit_empty: true,
-            extra_classes: [
-              *RSpec.configuration.extra_differ_classes,
-              Differs::CollectionContainingExactly,
-              Differs::CollectionIncluding,
-              Differs::HashIncluding,
-              Differs::ObjectHavingAttributes,
-            ],
-            extra_operational_sequencer_classes: [
-              *RSpec.configuration.extra_operational_sequencer_classes,
-              OperationalSequencers::CollectionContainingExactly,
-              OperationalSequencers::CollectionIncluding,
-              OperationalSequencers::HashIncluding,
-              OperationalSequencers::ObjectHavingAttributes,
-            ],
-            extra_diff_formatter_classes: RSpec.configuration.extra_diff_formatter_classes,
           )
           "\n\n" + diff
         else
           ""
         end
-      rescue NoDifferAvailableError
+      rescue SuperDiff::Errors::NoDifferAvailableError
         ""
       end
 

data/lib/super_diff/rspec/differs/collection_containing_exactly.rb

@@ -9,13 +9,8 @@ module SuperDiff
 
         private
 
-        def operations
-          OperationalSequencers::CollectionContainingExactly.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::CollectionContainingExactly
         end
       end
     end

data/lib/super_diff/rspec/differs/collection_including.rb

@@ -9,13 +9,8 @@ module SuperDiff
 
         private
 
-        def operations
-          OperationalSequencers::CollectionIncluding.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::CollectionIncluding
         end
       end
     end