super_diff 0.10.0 → 0.11.0

data/lib/super_diff/object_inspection/inspection_tree_builders/hash.rb

@@ -7,31 +7,56 @@ module SuperDiff
         end
 
         def call
-          empty = -> { object.empty? }
-          nonempty = -> { !object.empty? }
-
-          InspectionTree.new do
-            only_when empty do
-              as_lines_when_rendering_to_lines { add_text "{}" }
+          InspectionTree.new do |t1|
+            t1.only_when empty do |t2|
+              # stree-ignore
+              t2.as_lines_when_rendering_to_lines do |t3|
+                t3.add_text "{}"
+              end
             end
 
-            only_when nonempty do
-              as_lines_when_rendering_to_lines(collection_bookend: :open) do
-                add_text "{"
+            t1.only_when nonempty do |t2|
+              # stree-ignore
+              t2.as_lines_when_rendering_to_lines(
+                collection_bookend: :open
+              ) do |t3|
+                t3.add_text "{"
               end
 
-              when_rendering_to_string { add_text " " }
+              # stree-ignore
+              t2.when_rendering_to_string do |t3|
+                t3.add_text " "
+              end
 
-              nested { |hash| insert_hash_inspection_of(hash) }
+              # stree-ignore
+              t2.nested do |t3|
+                t3.insert_hash_inspection_of(object)
+              end
 
-              when_rendering_to_string { add_text " " }
+              # stree-ignore
+              t2.when_rendering_to_string do |t3|
+                t3.add_text " "
+              end
 
-              as_lines_when_rendering_to_lines(collection_bookend: :close) do
-                add_text "}"
+              # stree-ignore
+              t2.as_lines_when_rendering_to_lines(
+                collection_bookend: :close
+              ) do |t3|
+                t3.add_text "}"
               end
             end
           end
         end
+
+        private
+
+        def empty
+          -> { object.empty? }
+        end
+
+        def nonempty
+          -> { !object.empty? }
+        end
       end
     end
   end

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

@@ -7,11 +7,9 @@ module SuperDiff
         end
 
         def call
-          InspectionTree.new do
-            as_lines_when_rendering_to_lines do
-              # rubocop:disable Style/SymbolProc
-              add_text { |object| object.inspect }
-              # rubocop:enable Style/SymbolProc
+          InspectionTree.new do |t1|
+            t1.as_lines_when_rendering_to_lines do |t2|
+              t2.add_text object.inspect
             end
           end
         end

data/lib/super_diff/object_inspection/inspection_tree_builders/time_like.rb

@@ -7,37 +7,48 @@ module SuperDiff
         end
 
         def call
-          InspectionTree.new do
-            as_lines_when_rendering_to_lines(collection_bookend: :open) do
-              add_text { |time| "#<#{time.class} " }
+          InspectionTree.new do |t1|
+            t1.as_lines_when_rendering_to_lines(
+              collection_bookend: :open
+            ) do |t2|
+              t2.add_text "#<#{object.class} "
 
-              when_rendering_to_lines { add_text "{" }
+              # stree-ignore
+              t2.when_rendering_to_lines do |t3|
+                t3.add_text "{"
+              end
             end
 
-            when_rendering_to_string do
-              add_text do |time|
-                time.strftime("%Y-%m-%d %H:%M:%S") +
-                  (time.subsec == 0 ? "" : "+#{time.subsec.inspect}") + " " +
-                  time.strftime("%:z") + (time.zone ? " (#{time.zone})" : "")
-              end
+            t1.when_rendering_to_string do |t2|
+              t2.add_text(
+                object.strftime("%Y-%m-%d %H:%M:%S") +
+                  (object.subsec == 0 ? "" : "+#{object.subsec.inspect}") +
+                  " " + object.strftime("%:z") +
+                  (object.zone ? " (#{object.zone})" : "")
+              )
             end
 
-            when_rendering_to_lines do
-              nested do |time|
-                insert_separated_list(
+            t1.when_rendering_to_lines do |t2|
+              t2.nested do |t3|
+                t3.insert_separated_list(
                   %i[year month day hour min sec subsec zone utc_offset]
-                ) do |name|
-                  add_text name.to_s
-                  add_text ": "
-                  add_inspection_of time.public_send(name)
+                ) do |t4, name|
+                  t4.add_text name.to_s
+                  t4.add_text ": "
+                  t4.add_inspection_of object.public_send(name)
                 end
               end
             end
 
-            as_lines_when_rendering_to_lines(collection_bookend: :close) do
-              when_rendering_to_lines { add_text "}" }
+            t1.as_lines_when_rendering_to_lines(
+              collection_bookend: :close
+            ) do |t2|
+              # stree-ignore
+              t2.when_rendering_to_lines do |t3|
+                t3.add_text "}"
+              end
 
-              add_text ">"
+              t2.add_text ">"
             end
           end
         end

data/lib/super_diff/object_inspection/inspection_tree_builders.rb

@@ -37,6 +37,10 @@ module SuperDiff
         :TimeLike,
         "super_diff/object_inspection/inspection_tree_builders/time_like"
       )
+      autoload(
+        :DateLike,
+        "super_diff/object_inspection/inspection_tree_builders/date_like"
+      )
     end
   end
 end

data/lib/super_diff/object_inspection/nodes/as_lines_when_rendering_to_lines.rb

@@ -15,9 +15,10 @@ module SuperDiff
           *args,
           add_comma: false,
           collection_bookend: nil,
-          **rest
+          **rest,
+          &block
         )
-          super(tree, *args, **rest)
+          super(tree, *args, **rest, &block)
 
           @add_comma = add_comma
           @collection_bookend = collection_bookend

data/lib/super_diff/operation_tree_builders/date_like.rb

@@ -0,0 +1,15 @@
+module SuperDiff
+  module OperationTreeBuilders
+    class DateLike < CustomObject
+      def self.applies_to?(expected, actual)
+        SuperDiff.date_like?(expected) && SuperDiff.date_like?(actual)
+      end
+
+      protected
+
+      def attribute_names
+        %w[year month day]
+      end
+    end
+  end
+end

data/lib/super_diff/operation_tree_builders/defaults.rb

@@ -1,5 +1,5 @@
 module SuperDiff
   module OperationTreeBuilders
-    DEFAULTS = [Array, Hash, TimeLike, CustomObject].freeze
+    DEFAULTS = [Array, Hash, TimeLike, DateLike, CustomObject].freeze
   end
 end

data/lib/super_diff/operation_tree_builders.rb

@@ -12,6 +12,7 @@ module SuperDiff
       "super_diff/operation_tree_builders/multiline_string"
     )
     autoload :TimeLike, "super_diff/operation_tree_builders/time_like"
+    autoload :DateLike, "super_diff/operation_tree_builders/date_like"
   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/inspection_tree_builders/collection_containing_exactly.rb

@@ -8,17 +8,24 @@ module SuperDiff
           end
 
           def call
-            SuperDiff::ObjectInspection::InspectionTree.new do
-              as_lines_when_rendering_to_lines(collection_bookend: :open) do
-                add_text "#<a collection containing exactly ("
+            SuperDiff::ObjectInspection::InspectionTree.new do |t1|
+              # stree-ignore
+              t1.as_lines_when_rendering_to_lines(
+                collection_bookend: :open
+              ) do |t2|
+                t2.add_text "#<a collection containing exactly ("
               end
 
-              nested do |aliased_matcher|
-                insert_array_inspection_of(aliased_matcher.expected)
+              # stree-ignore
+              t1.nested do |t2|
+                t2.insert_array_inspection_of(object.expected)
               end
 
-              as_lines_when_rendering_to_lines(collection_bookend: :close) do
-                add_text ")>"
+              # stree-ignore
+              t1.as_lines_when_rendering_to_lines(
+                collection_bookend: :close
+              ) do |t2|
+                t2.add_text ")>"
               end
             end
           end

data/lib/super_diff/rspec/object_inspection/inspection_tree_builders/collection_including.rb

@@ -9,23 +9,29 @@ module SuperDiff
           end
 
           def call
-            SuperDiff::ObjectInspection::InspectionTree.new do
-              as_lines_when_rendering_to_lines(collection_bookend: :open) do
-                add_text "#<a collection including ("
+            SuperDiff::ObjectInspection::InspectionTree.new do |t1|
+              # stree-ignore
+              t1.as_lines_when_rendering_to_lines(
+                collection_bookend: :open
+              ) do |t2|
+                t2.add_text "#<a collection including ("
               end
 
-              nested do |value|
-                array =
-                  if SuperDiff::RSpec.a_collection_including_something?(value)
-                    value.expecteds
-                  else
-                    value.instance_variable_get(:@expected)
-                  end
-                insert_array_inspection_of(array)
+              t1.nested do |t2|
+                if SuperDiff::RSpec.a_collection_including_something?(object)
+                  t2.insert_array_inspection_of(object.expecteds)
+                else
+                  t2.insert_array_inspection_of(
+                    object.instance_variable_get(:@expected)
+                  )
+                end
               end
 
-              as_lines_when_rendering_to_lines(collection_bookend: :close) do
-                add_text ")>"
+              # stree-ignore
+              t1.as_lines_when_rendering_to_lines(
+                collection_bookend: :close
+              ) do |t2|
+                t2.add_text ")>"
               end
             end
           end

data/lib/super_diff/rspec/object_inspection/inspection_tree_builders/double.rb

@@ -8,47 +8,51 @@ module SuperDiff
           end
 
           def call
-            builder = self
-            empty = -> { empty? }
-            nonempty = -> { !empty? }
-
-            SuperDiff::ObjectInspection::InspectionTree.new do
-              only_when empty do
-                as_lines_when_rendering_to_lines do
-                  add_text do |object|
-                    inspected_class = builder.inspected_class
-                    inspected_name = builder.inspected_name
-                    "#<#{inspected_class} #{inspected_name}>"
-                  end
+            SuperDiff::ObjectInspection::InspectionTree.new do |t1|
+              t1.only_when method(:empty?) do |t2|
+                t2.as_lines_when_rendering_to_lines do |t3|
+                  t3.add_text("#<#{inspected_class} #{inspected_name}>")
                 end
               end
 
-              only_when nonempty do
-                as_lines_when_rendering_to_lines(collection_bookend: :open) do
-                  add_text do |object|
-                    inspected_class = builder.inspected_class
-                    inspected_name = builder.inspected_name
-                    "#<#{inspected_class} #{inspected_name}"
-                  end
+              t1.only_when method(:nonempty?) do |t2|
+                t2.as_lines_when_rendering_to_lines(
+                  collection_bookend: :open
+                ) do |t3|
+                  t3.add_text("#<#{inspected_class} #{inspected_name}")
 
-                  when_rendering_to_lines { add_text " {" }
+                  # stree-ignore
+                  t3.when_rendering_to_lines do |t4|
+                    t4.add_text " {"
+                  end
                 end
 
-                when_rendering_to_string { add_text " " }
+                # stree-ignore
+                t2.when_rendering_to_string do |t3|
+                  t3.add_text " "
+                end
 
-                nested do |object|
-                  insert_hash_inspection_of(builder.doubled_methods)
+                # stree-ignore
+                t2.nested do |t3|
+                  t3.insert_hash_inspection_of doubled_methods
                 end
 
-                as_lines_when_rendering_to_lines(collection_bookend: :close) do
-                  when_rendering_to_lines { add_text "}" }
+                t2.as_lines_when_rendering_to_lines(
+                  collection_bookend: :close
+                ) do |t3|
+                  # stree-ignore
+                  t3.when_rendering_to_lines do |t4|
+                    t4.add_text "}"
+                  end
 
-                  add_text ">"
+                  t3.add_text ">"
                 end
               end
             end
           end
 
+          private
+
           def empty?
             doubled_methods.empty?
           end

data/lib/super_diff/rspec/object_inspection/inspection_tree_builders/generic_describable_matcher.rb

@@ -0,0 +1,19 @@
+module SuperDiff
+  module RSpec
+    module ObjectInspection
+      module InspectionTreeBuilders
+        class GenericDescribableMatcher < SuperDiff::ObjectInspection::InspectionTreeBuilders::Base
+          def self.applies_to?(value)
+            ::RSpec::Matchers.is_a_describable_matcher?(value)
+          end
+
+          def call
+            SuperDiff::ObjectInspection::InspectionTree.new do |t1|
+              t1.add_text "#<#{object.description}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -9,24 +9,29 @@ module SuperDiff
           end
 
           def call
-            SuperDiff::ObjectInspection::InspectionTree.new do
-              as_lines_when_rendering_to_lines(collection_bookend: :open) do
-                add_text "#<a hash including ("
+            SuperDiff::ObjectInspection::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
 
-              nested do |value|
-                hash =
-                  if SuperDiff::RSpec.a_hash_including_something?(value)
-                    value.expecteds.first
-                  else
-                    value.instance_variable_get(:@expected)
-                  end
-
-                insert_hash_inspection_of(hash)
+              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
 
-              as_lines_when_rendering_to_lines(collection_bookend: :close) do
-                add_text ")>"
+              # stree-ignore
+              t1.as_lines_when_rendering_to_lines(
+                collection_bookend: :close
+              ) do |t2|
+                t2.add_text ")>"
               end
             end
           end

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

@@ -9,16 +9,15 @@ module SuperDiff
           end
 
           def call
-            SuperDiff::ObjectInspection::InspectionTree.new do
-              add_text do |value|
-                klass =
-                  if SuperDiff::RSpec.an_instance_of_something?(value)
-                    value.expected
-                  else
-                    value.instance_variable_get(:@klass)
-                  end
-                "#<an instance of #{klass}>"
-              end
+            SuperDiff::ObjectInspection::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

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

@@ -9,16 +9,15 @@ module SuperDiff
           end
 
           def call
-            SuperDiff::ObjectInspection::InspectionTree.new do
-              add_text do |value|
-                klass =
-                  if SuperDiff::RSpec.a_kind_of_something?(value)
-                    value.expected
-                  else
-                    value.instance_variable_get(:@klass)
-                  end
-                "#<a kind of #{klass}>"
-              end
+            SuperDiff::ObjectInspection::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

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

@@ -8,17 +8,24 @@ module SuperDiff
           end
 
           def call
-            SuperDiff::ObjectInspection::InspectionTree.new do
-              as_lines_when_rendering_to_lines(collection_bookend: :open) do
-                add_text "#<an object having attributes ("
+            SuperDiff::ObjectInspection::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
 
-              nested do |aliased_matcher|
-                insert_hash_inspection_of(aliased_matcher.expected)
+              # stree-ignore
+              t1.nested do |t2|
+                t2.insert_hash_inspection_of(object.expected)
               end
 
-              as_lines_when_rendering_to_lines(collection_bookend: :close) do
-                add_text ")>"
+              # stree-ignore
+              t1.as_lines_when_rendering_to_lines(
+                collection_bookend: :close
+              ) do |t2|
+                t2.add_text ")>"
               end
             end
           end