super_diff 0.2.0 → 0.5.0

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,55 +9,87 @@ 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.partial_hash?(value)
-      partial_placeholder?(value) &&
+    def self.a_hash_including_something?(value)
+      fuzzy_object?(value) &&
         value.respond_to?(:expecteds) &&
         value.expecteds.one? &&
         value.expecteds.first.is_a?(::Hash)
     end
 
-    def self.partial_array?(value)
-      partial_placeholder?(value) &&
+    def self.a_collection_including_something?(value)
+      fuzzy_object?(value) &&
         value.respond_to?(:expecteds) &&
         !(value.expecteds.one? && value.expecteds.first.is_a?(::Hash))
     end
 
-    def self.partial_object?(value)
-      partial_placeholder?(value) &&
+    def self.an_object_having_some_attributes?(value)
+      fuzzy_object?(value) &&
         value.base_matcher.is_a?(::RSpec::Matchers::BuiltIn::HaveAttributes)
     end
 
-    def self.collection_containing_exactly?(value)
-      partial_placeholder?(value) &&
+    def self.a_collection_containing_exactly_something?(value)
+      fuzzy_object?(value) &&
         value.base_matcher.is_a?(::RSpec::Matchers::BuiltIn::ContainExactly)
     end
 
-    def self.partial_placeholder?(value)
+    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::PartialArray,
-              Differs::PartialHash,
-              Differs::PartialObject,
-            ],
-            extra_operational_sequencer_classes: [
-              *RSpec.configuration.extra_operational_sequencer_classes,
-              OperationalSequencers::CollectionContainingExactly,
-              OperationalSequencers::PartialArray,
-              OperationalSequencers::PartialHash,
-              OperationalSequencers::PartialObject,
-            ],
-            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.rb

@@ -5,9 +5,15 @@ module SuperDiff
         :CollectionContainingExactly,
         "super_diff/rspec/differs/collection_containing_exactly",
       )
-      autoload :PartialArray, "super_diff/rspec/differs/partial_array"
-      autoload :PartialHash, "super_diff/rspec/differs/partial_hash"
-      autoload :PartialObject, "super_diff/rspec/differs/partial_object"
+      autoload(
+        :CollectionIncluding,
+        "super_diff/rspec/differs/collection_including",
+      )
+      autoload :HashIncluding, "super_diff/rspec/differs/hash_including"
+      autoload(
+        :ObjectHavingAttributes,
+        "super_diff/rspec/differs/object_having_attributes",
+      )
     end
   end
 end

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

@@ -3,19 +3,14 @@ module SuperDiff
     module Differs
       class CollectionContainingExactly < SuperDiff::Differs::Array
         def self.applies_to?(expected, actual)
-          SuperDiff::RSpec.collection_containing_exactly?(expected) &&
+          SuperDiff::RSpec.a_collection_containing_exactly_something?(expected) &&
             actual.is_a?(::Array)
         end
 
         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

@@ -0,0 +1,18 @@
+module SuperDiff
+  module RSpec
+    module Differs
+      class CollectionIncluding < SuperDiff::Differs::Array
+        def self.applies_to?(expected, actual)
+          SuperDiff::RSpec.a_collection_including_something?(expected) &&
+            actual.is_a?(::Array)
+        end
+
+        private
+
+        def operation_tree_builder_class
+          OperationTreeBuilders::CollectionIncluding
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module SuperDiff
+  module RSpec
+    module Differs
+      class HashIncluding < SuperDiff::Differs::Hash
+        def self.applies_to?(expected, actual)
+          SuperDiff::RSpec.a_hash_including_something?(expected) &&
+            actual.is_a?(::Hash)
+        end
+
+        private
+
+        def operation_tree_builder_class
+          OperationTreeBuilders::HashIncluding
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module SuperDiff
+  module RSpec
+    module Differs
+      class ObjectHavingAttributes < SuperDiff::Differs::DefaultObject
+        def self.applies_to?(expected, _actual)
+          SuperDiff::RSpec.an_object_having_some_attributes?(expected)
+        end
+
+        private
+
+        def operation_tree_builder_class
+          OperationTreeBuilders::ObjectHavingAttributes
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/rspec/matcher_text_builders.rb

@@ -10,6 +10,10 @@ module SuperDiff
         :ContainExactly,
         "super_diff/rspec/matcher_text_builders/contain_exactly",
       )
+      autoload(
+        :HavePredicate,
+        "super_diff/rspec/matcher_text_builders/have_predicate",
+      )
       autoload :Match, "super_diff/rspec/matcher_text_builders/match"
       autoload(
         :RaiseError,

data/lib/super_diff/rspec/matcher_text_builders/be_predicate.rb

@@ -36,27 +36,46 @@ module SuperDiff
           end
         end
 
-        def add_expected_value_to(template, expected)
+        def add_expected_value_to_failure_message(template)
           template.add_text " "
-          template.add_text_in_color(alpha_color, "`#{expected}?`")
+          template.add_text_in_color(
+            alpha_color,
+            "#{expected_for_failure_message}?",
+          )
           template.add_text " or "
-          template.add_text_in_color(alpha_color, "`#{expected}s?`")
+          template.add_text_in_color(
+            alpha_color,
+            "#{expected_for_failure_message}s?",
+          )
+        end
+
+        def add_expected_value_to_description(template)
+          template.add_text " "
+          template.add_text_in_color(
+            alpha_color,
+            "`#{expected_for_description}?`",
+          )
+          template.add_text " or "
+          template.add_text_in_color(
+            alpha_color,
+            "`#{expected_for_description}s?`",
+          )
         end
 
         def add_extra_after_error
           if expected_predicate_method_name == :true?
             template.add_text "\n\n"
             template.add_text "(Perhaps you want to use "
-            template.add_text_in_color(:blue, "`be(true)`")
+            template.add_text_in_color(:blue, "be(true)")
             template.add_text " or "
-            template.add_text_in_color(:blue, "`be_truthy`")
+            template.add_text_in_color(:blue, "be_truthy")
             template.add_text " instead?)"
           elsif expected_predicate_method_name == :false?
             template.add_text "\n\n"
             template.add_text "(Perhaps you want to use "
-            template.add_text_in_color(:blue, "`be(false)`")
+            template.add_text_in_color(:blue, "be(false)")
             template.add_text " or "
-            template.add_text_in_color(:blue, "`be_falsey`")
+            template.add_text_in_color(:blue, "be_falsey")
             template.add_text " instead?)"
           end
         end

data/lib/super_diff/rspec/matcher_text_builders/have_predicate.rb

@@ -0,0 +1,61 @@
+module SuperDiff
+  module RSpec
+    module MatcherTextBuilders
+      class HavePredicate < Base
+        def initialize(predicate_accessible:, private_predicate:, **rest)
+          super(**rest)
+          @predicate_accessible = predicate_accessible
+          @private_predicate = private_predicate
+        end
+
+        protected
+
+        def expected_action_for_failure_message
+          if predicate_accessible?
+            "return a truthy result for"
+          elsif private_predicate?
+            "have a public method"
+          else
+            "respond to"
+          end
+        end
+
+        def beta_color
+          :yellow
+        end
+
+        def add_actual_value
+          template.add_text_in_color(beta_color) do
+            description_of(actual)
+          end
+        end
+
+        def add_expected_value_to_failure_message(template)
+          template.add_text " "
+          template.add_text_in_color(
+            alpha_color,
+            expected_for_failure_message,
+          )
+        end
+
+        def add_expected_value_to_description(template)
+          template.add_text " "
+          template.add_text_in_color(
+            alpha_color,
+            "`#{expected_for_description}`",
+          )
+        end
+
+        private
+
+        def private_predicate?
+          @private_predicate
+        end
+
+        def predicate_accessible?
+          @predicate_accessible
+        end
+      end
+    end
+  end
+end