super_diff 0.10.0 → 0.12.0

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

@@ -0,0 +1,40 @@
+module SuperDiff
+  module RSpec
+    module InspectionTreeBuilders
+      class HashIncluding < Core::AbstractInspectionTreeBuilder
+        def self.applies_to?(value)
+          SuperDiff::RSpec.a_hash_including_something?(value) ||
+            SuperDiff::RSpec.hash_including_something?(value)
+        end
+
+        def call
+          Core::InspectionTree.new do |t1|
+            # stree-ignore
+            t1.as_lines_when_rendering_to_lines(
+                collection_bookend: :open
+              ) do |t2|
+                t2.add_text "#<a hash including ("
+              end
+
+            t1.nested do |t2|
+              if SuperDiff::RSpec.a_hash_including_something?(object)
+                t2.insert_hash_inspection_of(object.expecteds.first)
+              else
+                t2.insert_hash_inspection_of(
+                  object.instance_variable_get(:@expected)
+                )
+              end
+            end
+
+            # stree-ignore
+            t1.as_lines_when_rendering_to_lines(
+                collection_bookend: :close
+              ) do |t2|
+                t2.add_text ")>"
+              end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/rspec/inspection_tree_builders/instance_of.rb

@@ -0,0 +1,25 @@
+module SuperDiff
+  module RSpec
+    module InspectionTreeBuilders
+      class InstanceOf < Core::AbstractInspectionTreeBuilder
+        def self.applies_to?(value)
+          SuperDiff::RSpec.an_instance_of_something?(value) ||
+            SuperDiff::RSpec.instance_of_something?(value)
+        end
+
+        def call
+          Core::InspectionTree.new do |t1|
+            klass =
+              if SuperDiff::RSpec.an_instance_of_something?(object)
+                object.expected
+              else
+                object.instance_variable_get(:@klass)
+              end
+
+            t1.add_text "#<an instance of #{klass}>"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/rspec/inspection_tree_builders/kind_of.rb

@@ -0,0 +1,25 @@
+module SuperDiff
+  module RSpec
+    module InspectionTreeBuilders
+      class KindOf < Core::AbstractInspectionTreeBuilder
+        def self.applies_to?(value)
+          SuperDiff::RSpec.a_kind_of_something?(value) ||
+            SuperDiff::RSpec.kind_of_something?(value)
+        end
+
+        def call
+          Core::InspectionTree.new do |t1|
+            klass =
+              if SuperDiff::RSpec.a_kind_of_something?(object)
+                object.expected
+              else
+                object.instance_variable_get(:@klass)
+              end
+
+            t1.add_text "#<a kind of #{klass}>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+module SuperDiff
+  module RSpec
+    module InspectionTreeBuilders
+      class ObjectHavingAttributes < Core::AbstractInspectionTreeBuilder
+        def self.applies_to?(value)
+          SuperDiff::RSpec.an_object_having_some_attributes?(value)
+        end
+
+        def call
+          Core::InspectionTree.new do |t1|
+            # stree-ignore
+            t1.as_lines_when_rendering_to_lines(
+                collection_bookend: :open
+              ) do |t2|
+                t2.add_text "#<an object having attributes ("
+              end
+
+            # stree-ignore
+            t1.nested do |t2|
+                t2.insert_hash_inspection_of(object.expected)
+              end
+
+            # stree-ignore
+            t1.as_lines_when_rendering_to_lines(
+                collection_bookend: :close
+              ) do |t2|
+                t2.add_text ")>"
+              end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/rspec/inspection_tree_builders/primitive.rb

@@ -0,0 +1,9 @@
+module SuperDiff
+  module RSpec
+    module InspectionTreeBuilders
+      # TODO: Is this needed?
+      class Primitive < Basic::InspectionTreeBuilders::Primitive
+      end
+    end
+  end
+end

data/lib/super_diff/rspec/inspection_tree_builders/value_within.rb

@@ -0,0 +1,30 @@
+module SuperDiff
+  module RSpec
+    module InspectionTreeBuilders
+      class ValueWithin < Core::AbstractInspectionTreeBuilder
+        def self.applies_to?(value)
+          SuperDiff::RSpec.a_value_within_something?(value)
+        end
+
+        def call
+          Core::InspectionTree.new do |t1|
+            t1.as_prelude_when_rendering_to_lines do |t2|
+              t2.add_text "#<a value within "
+
+              t2.add_inspection_of(
+                object.base_matcher.instance_variable_get("@delta"),
+                as_lines: false
+              )
+
+              t2.add_text " of "
+            end
+
+            t1.add_inspection_of object.expected
+
+            t1.add_text ">"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/rspec/inspection_tree_builders.rb

@@ -0,0 +1,40 @@
+module SuperDiff
+  module RSpec
+    module InspectionTreeBuilders
+      autoload(
+        :CollectionContainingExactly,
+        "super_diff/rspec/inspection_tree_builders/collection_containing_exactly"
+      )
+      autoload(
+        :CollectionIncluding,
+        "super_diff/rspec/inspection_tree_builders/collection_including"
+      )
+      autoload :Double, "super_diff/rspec/inspection_tree_builders/double"
+      autoload(
+        :GenericDescribableMatcher,
+        "super_diff/rspec/inspection_tree_builders/generic_describable_matcher"
+      )
+      autoload(
+        :HashIncluding,
+        "super_diff/rspec/inspection_tree_builders/hash_including"
+      )
+      autoload(
+        :InstanceOf,
+        "super_diff/rspec/inspection_tree_builders/instance_of"
+      )
+      autoload :KindOf, "super_diff/rspec/inspection_tree_builders/kind_of"
+      autoload(
+        :ObjectHavingAttributes,
+        "super_diff/rspec/inspection_tree_builders/object_having_attributes"
+      )
+      autoload(
+        :Primitive,
+        "super_diff/rspec/inspection_tree_builders/primitive"
+      )
+      autoload(
+        :ValueWithin,
+        "super_diff/rspec/inspection_tree_builders/value_within"
+      )
+    end
+  end
+end

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

@@ -5,14 +5,10 @@ module SuperDiff
         protected
 
         def actual_phrase
-          actual ? "Expected raised exception" : "Expected"
-        end
-
-        def add_actual_value
-          if actual
-            template.add_text_in_color(actual_color) { actual }
+          if actual == "exception-free block"
+            "Expected"
           else
-            template.add_text("block")
+            "Expected raised exception"
           end
         end
       end

data/lib/super_diff/rspec/monkey_patches.rb

@@ -218,7 +218,10 @@ module RSpec
                   }
                 end
               end
-
+              @failure_line_groups << {
+                lines: extra_failure_lines,
+                already_colorized: true
+              }
               @failure_line_groups
             end
           end
@@ -241,6 +244,24 @@ module RSpec
             lines
           end
 
+          # Override to ensure that each item in the array returned is one and
+          # only one line and doesn't contain any newline characters
+          def extra_failure_lines
+            @extra_failure_lines ||=
+              begin
+                original_lines = Array(example.metadata[:extra_failure_lines])
+                normalized_lines =
+                  original_lines.flat_map { |line| line.split("\n") }
+                unless normalized_lines.empty?
+                  unless normalized_lines.first == ""
+                    normalized_lines.unshift("")
+                  end
+                  normalized_lines.push("") unless normalized_lines.last == ""
+                end
+                normalized_lines
+              end
+          end
+
           # Exclude this file from being included in backtraces, so that the
           # SnippetExtractor prints the right thing
           def find_failed_line
@@ -701,9 +722,15 @@ module RSpec
         SuperDiff.insert_overrides(self, SuperDiff::RSpec::AugmentedMatcher)
 
         SuperDiff.insert_overrides(self) do
+          def expected_action_for_description
+            "raise"
+          end
+
           def actual_for_matcher_text
             if @actual_error
               "#<#{@actual_error.class.name} #{@actual_error.message.inspect}>"
+            else
+              "exception-free block"
             end
           end
 
@@ -712,12 +739,19 @@ module RSpec
           end
 
           def expected_for_matcher_text
-            if @expected_message
-              "#<#{@expected_error.name} #{description_of(@expected_message)}>"
-            elsif @expected_error.is_a? Regexp
-              "#<Exception #{description_of(@expected_error)}>"
+            case @expected_message
+            when nil
+              if RSpec::Matchers.is_a_describable_matcher?(@expected_error)
+                description_of(@expected_error)
+              elsif @expected_error.is_a?(Regexp)
+                "a kind of Exception with message matching #{description_of(@expected_error)}"
+              else
+                "a kind of #{@expected_error}"
+              end
+            when Regexp
+              "#{described_expected_error} with message matching #{description_of(@expected_message)}"
             else
-              "#<#{@expected_error.name}>"
+              "#{described_expected_error} with message #{description_of(@expected_message)}"
             end
           end
 
@@ -730,12 +764,22 @@ module RSpec
           end
 
           def expected_action_for_failure_message
-            @actual_error ? "match" : "raise error"
+            @actual_error ? "match" : "raise"
           end
 
           def matcher_text_builder_class
             SuperDiff::RSpec::MatcherTextBuilders::RaiseError
           end
+
+          private
+
+          def described_expected_error
+            if @expected_error.is_a?(Class)
+              "a kind of #{@expected_error}"
+            else
+              description_of(@expected_error)
+            end
+          end
         end
 
         def self.matcher_name
@@ -782,7 +826,14 @@ module RSpec
       end
 
       def match_array(items)
-        BuiltIn::MatchArray.new(items.is_a?(String) ? [items] : items)
+        # This is a bit strange, but this is fundamentally different from
+        # splatting `items` in the argument list. It's functionally equivalent
+        # to, though not quite the same as:
+        #
+        #     items.is_a?(Array) ? items : [items]
+        #
+        items = *items
+        BuiltIn::MatchArray.new(items)
       end
     end
   end

data/lib/super_diff/rspec/object_inspection.rb

@@ -1,10 +1,20 @@
 module SuperDiff
   module RSpec
     module ObjectInspection
-      autoload(
-        :InspectionTreeBuilders,
-        "super_diff/rspec/object_inspection/inspection_tree_builders"
-      )
+      module InspectionTreeBuilders
+        def self.const_missing(missing_const_name)
+          if RSpec::InspectionTreeBuilders.const_defined?(missing_const_name)
+            warn <<~EOT
+          WARNING: SuperDiff::RSpec::ObjectInspection::InspectionTreeBuilders::#{missing_const_name} is deprecated and will be removed in the next major release.
+          Please use SuperDiff::RSpec::InspectionTreeBuilders::#{missing_const_name} instead.
+          #{caller_locations.join("\n")}
+        EOT
+            RSpec::InspectionTreeBuilders.const_get(missing_const_name)
+          else
+            super
+          end
+        end
+      end
     end
   end
 end

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

@@ -1,7 +1,7 @@
 module SuperDiff
   module RSpec
     module OperationTreeBuilders
-      class CollectionContainingExactly < SuperDiff::OperationTreeBuilders::Base
+      class CollectionContainingExactly < Core::AbstractOperationTreeBuilder
         def self.applies_to?(expected, actual)
           SuperDiff::RSpec.a_collection_containing_exactly_something?(
             expected
@@ -47,7 +47,7 @@ module SuperDiff
 
         def add_noop_to(operations, index)
           value = actual[index]
-          operations << ::SuperDiff::Operations::UnaryOperation.new(
+          operations << Core::UnaryOperation.new(
             name: :noop,
             collection: collection,
             key: index,
@@ -58,7 +58,7 @@ module SuperDiff
 
         def add_delete_to(operations, index)
           value = expected.expected[index]
-          operations << ::SuperDiff::Operations::UnaryOperation.new(
+          operations << Core::UnaryOperation.new(
             name: :delete,
             collection: collection,
             key: index,
@@ -69,7 +69,7 @@ module SuperDiff
 
         def add_insert_to(operations, index)
           value = actual[index]
-          operations << ::SuperDiff::Operations::UnaryOperation.new(
+          operations << Core::UnaryOperation.new(
             name: :insert,
             collection: collection,
             key: index,

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

@@ -1,7 +1,7 @@
 module SuperDiff
   module RSpec
     module OperationTreeBuilders
-      class CollectionIncluding < SuperDiff::OperationTreeBuilders::Array
+      class CollectionIncluding < Basic::OperationTreeBuilders::Array
         def self.applies_to?(expected, actual)
           (
             SuperDiff::RSpec.a_collection_including_something?(expected) ||

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

@@ -1,7 +1,7 @@
 module SuperDiff
   module RSpec
     module OperationTreeBuilders
-      class HashIncluding < SuperDiff::OperationTreeBuilders::Hash
+      class HashIncluding < Basic::OperationTreeBuilders::Hash
         include ::RSpec::Matchers::Composable
 
         def self.applies_to?(expected, actual)

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

@@ -1,7 +1,7 @@
 module SuperDiff
   module RSpec
     module OperationTreeBuilders
-      class ObjectHavingAttributes < SuperDiff::OperationTreeBuilders::DefaultObject
+      class ObjectHavingAttributes < Basic::OperationTreeBuilders::DefaultObject
         def self.applies_to?(expected, _actual)
           SuperDiff::RSpec.an_object_having_some_attributes?(expected)
         end
@@ -9,7 +9,7 @@ module SuperDiff
         protected
 
         def build_operation_tree
-          find_operation_tree_for(actual)
+          SuperDiff.find_operation_tree_for(actual)
         end
 
         def attribute_names

data/lib/super_diff/rspec.rb

@@ -1,15 +1,17 @@
 require "super_diff"
 
+require "super_diff/rspec/differs"
+require "super_diff/rspec/inspection_tree_builders"
+require "super_diff/rspec/operation_tree_builders"
+
 module SuperDiff
   module RSpec
     autoload :AugmentedMatcher, "super_diff/rspec/augmented_matcher"
     autoload :Configuration, "super_diff/rspec/configuration"
     autoload :Differ, "super_diff/rspec/differ"
-    autoload :Differs, "super_diff/rspec/differs"
     autoload :MatcherTextBuilders, "super_diff/rspec/matcher_text_builders"
     autoload :MatcherTextTemplate, "super_diff/rspec/matcher_text_template"
     autoload :ObjectInspection, "super_diff/rspec/object_inspection"
-    autoload :OperationTreeBuilders, "super_diff/rspec/operation_tree_builders"
 
     def self.configure(&block)
       SuperDiff.configure(&block)
@@ -20,7 +22,7 @@ module SuperDiff
     end
 
     def self.a_hash_including_something?(value)
-      fuzzy_object?(value) && value.respond_to?(:expecteds) &&
+      aliased_matcher?(value) && value.respond_to?(:expecteds) &&
         value.expecteds.one? && value.expecteds.first.is_a?(::Hash)
     end
 
@@ -31,7 +33,7 @@ module SuperDiff
     end
 
     def self.a_collection_including_something?(value)
-      fuzzy_object?(value) && value.respond_to?(:expecteds) &&
+      aliased_matcher?(value) && value.respond_to?(:expecteds) &&
         !(value.expecteds.one? && value.expecteds.first.is_a?(::Hash))
     end
 
@@ -40,17 +42,17 @@ module SuperDiff
     end
 
     def self.an_object_having_some_attributes?(value)
-      fuzzy_object?(value) &&
+      aliased_matcher?(value) &&
         value.base_matcher.is_a?(::RSpec::Matchers::BuiltIn::HaveAttributes)
     end
 
     def self.a_collection_containing_exactly_something?(value)
-      fuzzy_object?(value) &&
+      aliased_matcher?(value) &&
         value.base_matcher.is_a?(::RSpec::Matchers::BuiltIn::ContainExactly)
     end
 
     def self.a_kind_of_something?(value)
-      fuzzy_object?(value) &&
+      aliased_matcher?(value) &&
         value.base_matcher.is_a?(::RSpec::Matchers::BuiltIn::BeAKindOf)
     end
 
@@ -61,7 +63,7 @@ module SuperDiff
     end
 
     def self.an_instance_of_something?(value)
-      fuzzy_object?(value) &&
+      aliased_matcher?(value) &&
         value.base_matcher.is_a?(::RSpec::Matchers::BuiltIn::BeAnInstanceOf)
     end
 
@@ -72,11 +74,11 @@ module SuperDiff
     end
 
     def self.a_value_within_something?(value)
-      fuzzy_object?(value) &&
+      aliased_matcher?(value) &&
         value.base_matcher.is_a?(::RSpec::Matchers::BuiltIn::BeWithin)
     end
 
-    def self.fuzzy_object?(value)
+    def self.aliased_matcher?(value)
       value.is_a?(::RSpec::Matchers::AliasedMatcher)
     end
 
@@ -84,36 +86,37 @@ module SuperDiff
       @_rspec_version ||=
         begin
           require "rspec/core/version"
-          GemVersion.new(::RSpec::Core::Version::STRING)
+          Core::GemVersion.new(::RSpec::Core::Version::STRING)
         end
     end
 
     SuperDiff.configuration.tap do |config|
-      config.add_extra_differ_classes(
+      config.prepend_extra_differ_classes(
         Differs::CollectionContainingExactly,
         Differs::CollectionIncluding,
         Differs::HashIncluding,
         Differs::ObjectHavingAttributes
       )
 
-      config.add_extra_operation_tree_builder_classes(
+      config.prepend_extra_inspection_tree_builder_classes(
+        InspectionTreeBuilders::Double,
+        InspectionTreeBuilders::CollectionContainingExactly,
+        InspectionTreeBuilders::CollectionIncluding,
+        InspectionTreeBuilders::HashIncluding,
+        InspectionTreeBuilders::InstanceOf,
+        InspectionTreeBuilders::KindOf,
+        InspectionTreeBuilders::ObjectHavingAttributes,
+        # ObjectInspection::InspectionTreeBuilders::Primitive,
+        InspectionTreeBuilders::ValueWithin,
+        InspectionTreeBuilders::GenericDescribableMatcher
+      )
+
+      config.prepend_extra_operation_tree_builder_classes(
         OperationTreeBuilders::CollectionContainingExactly,
         OperationTreeBuilders::CollectionIncluding,
         OperationTreeBuilders::HashIncluding,
         OperationTreeBuilders::ObjectHavingAttributes
       )
-
-      config.add_extra_inspection_tree_builder_classes(
-        ObjectInspection::InspectionTreeBuilders::Double,
-        ObjectInspection::InspectionTreeBuilders::CollectionContainingExactly,
-        ObjectInspection::InspectionTreeBuilders::CollectionIncluding,
-        ObjectInspection::InspectionTreeBuilders::HashIncluding,
-        ObjectInspection::InspectionTreeBuilders::InstanceOf,
-        ObjectInspection::InspectionTreeBuilders::KindOf,
-        ObjectInspection::InspectionTreeBuilders::ObjectHavingAttributes,
-        # ObjectInspection::InspectionTreeBuilders::Primitive,
-        ObjectInspection::InspectionTreeBuilders::ValueWithin
-      )
     end
   end
 end

data/lib/super_diff/version.rb

@@ -1,3 +1,3 @@
 module SuperDiff
-  VERSION = "0.10.0".freeze
+  VERSION = "0.12.0".freeze
 end