super_diff 0.9.0 → 0.10.0

data/lib/super_diff/rspec/monkey_patches.rb

@@ -60,19 +60,22 @@ module RSpec
             if code_or_symbol
               if (config_method = config_colors_to_methods[code_or_symbol])
                 console_code_for RSpec.configuration.__send__(config_method)
-              elsif RSpec::Core::Formatters::ConsoleCodes::VT100_CODE_VALUES.key?(code_or_symbol)
+              elsif RSpec::Core::Formatters::ConsoleCodes::VT100_CODE_VALUES.key?(
+                    code_or_symbol
+                  )
                 code_or_symbol
               else
-                RSpec::Core::Formatters::ConsoleCodes::VT100_CODES.fetch(code_or_symbol) do
+                RSpec::Core::Formatters::ConsoleCodes::VT100_CODES.fetch(
                   code_or_symbol
-                end
+                ) { code_or_symbol }
               end
             end
           end
 
           # Patch so it does not apply a color if code_or_symbol is nil
           def wrap(text, code_or_symbol)
-            if RSpec.configuration.color_enabled? && code = console_code_for(code_or_symbol)
+            if SuperDiff.configuration.color_enabled? &&
+                 code = console_code_for(code_or_symbol)
               "\e[#{code}m#{text}\e[0m"
             else
               text
@@ -86,50 +89,56 @@ module RSpec
         RESET_CODE = "\e[0m"
 
         SuperDiff.insert_overrides(self) do
-          def initialize(exception, example, options={})
-            @exception               = exception
-            @example                 = example
-            @message_color           = options.fetch(:message_color)          { RSpec.configuration.failure_color }
-            @description             = options.fetch(:description)            { example.full_description }
-            @detail_formatter        = options.fetch(:detail_formatter)       { Proc.new {} }
-            @extra_detail_formatter  = options.fetch(:extra_detail_formatter) { Proc.new {} }
-            @backtrace_formatter     = options.fetch(:backtrace_formatter)    { RSpec.configuration.backtrace_formatter }
-            @indentation             = options.fetch(:indentation, 2)
-            @skip_shared_group_trace = options.fetch(:skip_shared_group_trace, false)
+          def initialize(exception, example, options = {})
+            @exception = exception
+            @example = example
+            @message_color =
+              options.fetch(:message_color) do
+                RSpec.configuration.failure_color
+              end
+            @description =
+              options.fetch(:description) { example.full_description }
+            @detail_formatter = options.fetch(:detail_formatter) { Proc.new {} }
+            @extra_detail_formatter =
+              options.fetch(:extra_detail_formatter) { Proc.new {} }
+            @backtrace_formatter =
+              options.fetch(:backtrace_formatter) do
+                RSpec.configuration.backtrace_formatter
+              end
+            @indentation = options.fetch(:indentation, 2)
+            @skip_shared_group_trace =
+              options.fetch(:skip_shared_group_trace, false)
             # Patch to convert options[:failure_lines] to groups
             if options.include?(:failure_lines)
               @failure_line_groups = [
-                {
-                  lines: options[:failure_lines],
-                  already_colorized: false
-                }
+                { lines: options[:failure_lines], already_colorized: false }
               ]
             end
           end
 
           # Override to only color uncolored lines in red
           # and to not color empty lines
-          def colorized_message_lines(colorizer = ::RSpec::Core::Formatters::ConsoleCodes)
-            lines = failure_line_groups.flat_map do |group|
-              if group[:already_colorized]
-                group[:lines]
-              else
-                group[:lines].map do |line|
-                  if line.strip.empty?
-                    line
-                  else
-                    indentation = line[/^[ ]+/]
-                    rest = colorizer.wrap(line.sub(/^[ ]+/, ''), message_color)
-
-                    if indentation
-                      indentation + rest
+          def colorized_message_lines(
+            colorizer = ::RSpec::Core::Formatters::ConsoleCodes
+          )
+            lines =
+              failure_line_groups.flat_map do |group|
+                if group[:already_colorized]
+                  group[:lines]
+                else
+                  group[:lines].map do |line|
+                    if line.strip.empty?
+                      line
                     else
-                      rest
+                      indentation = line[/^[ ]+/]
+                      rest =
+                        colorizer.wrap(line.sub(/^[ ]+/, ""), message_color)
+
+                      indentation ? indentation + rest : rest
                     end
                   end
                 end
               end
-            end
 
             add_shared_group_lines(lines, colorizer)
           end
@@ -158,25 +167,24 @@ module RSpec
               @failure_line_groups
             else
               @failure_line_groups = [
-                {
-                  lines: failure_slash_error_lines,
-                  already_colorized: true
-                }
+                { lines: failure_slash_error_lines, already_colorized: true }
               ]
 
               sections = [failure_slash_error_lines, exception_lines]
-              separate_groups = (
-                sections.any? { |section| section.size > 1 } &&
-                !exception_lines.first.empty?
-              )
+              separate_groups =
+                (
+                  sections.any? { |section| section.size > 1 } &&
+                    !exception_lines.first.empty?
+                )
 
               if separate_groups
-                @failure_line_groups << { lines: [''], already_colorized: true }
+                @failure_line_groups << { lines: [""], already_colorized: true }
               end
 
-              already_colorized = exception_lines.any? do |line|
-                SuperDiff::Csi.already_colorized?(line)
-              end
+              already_colorized =
+                exception_lines.any? do |line|
+                  SuperDiff::Csi.already_colorized?(line)
+                end
 
               if already_colorized
                 @failure_line_groups << {
@@ -225,9 +233,8 @@ module RSpec
               lines[0] = failure_slash_error + lines[0].strip
             else
               least_indentation = SnippetExtractor.least_indentation_from(lines)
-              lines = lines.map do |line|
-                line.sub(/^#{least_indentation}/, '  ')
-              end
+              lines =
+                lines.map { |line| line.sub(/^#{least_indentation}/, "  ") }
               lines.unshift(failure_slash_error)
             end
 
@@ -243,7 +250,8 @@ module RSpec
             exception_backtrace.find do |line|
               next unless (line_path = line[/(.+?):(\d+)(|:\d+)/, 1])
               path = File.expand_path(line_path)
-              path != __FILE__ && (loaded_spec_files.include?(path) || path =~ line_regex)
+              path != __FILE__ &&
+                (loaded_spec_files.include?(path) || path =~ line_regex)
             end || exception_backtrace.first
           end
         end
@@ -286,36 +294,38 @@ module RSpec
         def from(expected)
           return expected if self === expected
 
-          text =
-            colorizer.wrap("Diff:", SuperDiff.configuration.header_color) +
-            "\n\n" +
-            colorizer.wrap(
-              "┌ (Key) ──────────────────────────┐",
-              SuperDiff.configuration.border_color
-            ) +
-            "\n" +
-            colorizer.wrap("│ ", SuperDiff.configuration.border_color) +
-            colorizer.wrap(
-              "‹-› in expected, not in actual",
-              SuperDiff.configuration.expected_color
-            ) +
-            colorizer.wrap("  │", SuperDiff.configuration.border_color) +
-            "\n" +
-            colorizer.wrap("│ ", SuperDiff.configuration.border_color) +
-            colorizer.wrap(
-              "‹+› in actual, not in expected",
-              SuperDiff.configuration.actual_color
-            ) +
-            colorizer.wrap("  │", SuperDiff.configuration.border_color) +
-            "\n" +
-            colorizer.wrap("│ ", SuperDiff.configuration.border_color) +
-            "‹ › in both expected and actual" +
-            colorizer.wrap(" │", SuperDiff.configuration.border_color) +
-            "\n" +
-            colorizer.wrap(
-              "└─────────────────────────────────┘",
-              SuperDiff.configuration.border_color
-            )
+          text = colorizer.wrap("Diff:", SuperDiff.configuration.header_color)
+
+          if SuperDiff.configuration.key_enabled?
+            text +=
+              "\n\n" +
+                colorizer.wrap(
+                  "┌ (Key) ──────────────────────────┐",
+                  SuperDiff.configuration.border_color
+                ) + "\n" +
+                colorizer.wrap("│ ", SuperDiff.configuration.border_color) +
+                colorizer.wrap(
+                  "‹-› in expected, not in actual",
+                  SuperDiff.configuration.expected_color
+                ) +
+                colorizer.wrap("  │", SuperDiff.configuration.border_color) +
+                "\n" +
+                colorizer.wrap("│ ", SuperDiff.configuration.border_color) +
+                colorizer.wrap(
+                  "‹+› in actual, not in expected",
+                  SuperDiff.configuration.actual_color
+                ) +
+                colorizer.wrap("  │", SuperDiff.configuration.border_color) +
+                "\n" +
+                colorizer.wrap("│ ", SuperDiff.configuration.border_color) +
+                "‹ › in both expected and actual" +
+                colorizer.wrap(" │", SuperDiff.configuration.border_color) +
+                "\n" +
+                colorizer.wrap(
+                  "└─────────────────────────────────┘",
+                  SuperDiff.configuration.border_color
+                )
+          end
 
           new([[expected, text]])
         end
@@ -330,22 +340,21 @@ module RSpec
         def message_with_diff(message, differ, actual)
           diff = diffs(differ, actual)
 
-          if diff.empty?
-            message
-          else
-            "#{message.rstrip}\n\n#{diff}"
-          end
+          diff.empty? ? message : "#{message.rstrip}\n\n#{diff}"
         end
 
         private
 
         # Add extra line breaks in between diffs, and colorize the word "Diff"
         def diffs(differ, actual)
-          @expected_list.map do |(expected, diff_label)|
-            diff = differ.diff(actual, expected)
-            next if diff.strip.empty?
-            diff_label + diff
-          end.compact.join("\n\n")
+          @expected_list
+            .map do |(expected, diff_label)|
+              diff = differ.diff(actual, expected)
+              next if diff.strip.empty?
+              diff_label + diff
+            end
+            .compact
+            .join("\n\n")
         end
       end
     end
@@ -366,7 +375,7 @@ module RSpec
 
         SuperDiff.insert_overrides(self) do
           def expected_action_for_matcher_text
-            if [:==, :===, :=~].include?(@operator)
+            if %i[== === =~].include?(@operator)
               "#{@operator}"
             else
               "be #{@operator}"
@@ -415,7 +424,7 @@ module RSpec
             if SuperDiff::RSpec.rspec_version < "3.10"
               expected
             else
-              predicate.to_s.chomp('?')
+              predicate.to_s.chomp("?")
             end
           end
 
@@ -507,7 +516,7 @@ module RSpec
 
           # Override to use (...) as delimiters rather than {...}
           def expected_for_matcher_text
-            super.sub(/^\{ /, '(').gsub(/ \}$/, ')')
+            super.sub(/^\{ /, "(").gsub(/ \}$/, ")")
           end
 
           # Override so that the differ knows that this is a partial object
@@ -538,14 +547,17 @@ module RSpec
           # Override this method to skip non-existent attributes, and to use
           # public_send
           def cache_all_values
-            @values = @expected.keys.inject({}) do |hash, attribute_key|
-              if @actual.respond_to?(attribute_key)
-                actual_value = @actual.public_send(attribute_key)
-                hash.merge(attribute_key => actual_value)
-              else
-                hash
-              end
-            end
+            @values =
+              @expected
+                .keys
+                .inject({}) do |hash, attribute_key|
+                  if @actual.respond_to?(attribute_key)
+                    actual_value = @actual.public_send(attribute_key)
+                    hash.merge(attribute_key => actual_value)
+                  else
+                    hash
+                  end
+                end
           end
 
           def actual_has_attribute?(attribute_key, attribute_value)
@@ -624,7 +636,8 @@ module RSpec
             if actual.respond_to?(:include?)
               message
             elsif message.end_with?(".")
-              message.sub("\.$", ", ") + "but it does not respond to `include?`."
+              message.sub("\.$", ", ") +
+                "but it does not respond to `include?`."
             else
               message + "\n\nBut it does not respond to `include?`."
             end
@@ -649,9 +662,10 @@ module RSpec
           # Update to use (...) as delimiter instead of {...}
           def readable_list_of(items)
             if items && items.all? { |item| item.is_a?(Hash) }
-              description_of(items.inject(:merge)).
-                sub(/^\{ /, '(').
-                sub(/ \}$/, ')')
+              description_of(items.inject(:merge)).sub(/^\{ /, "(").sub(
+                / \}$/,
+                ")"
+              )
             else
               super
             end
@@ -694,9 +708,7 @@ module RSpec
           end
 
           def actual_for_diff
-            if @actual_error
-              @actual_error.message
-            end
+            @actual_error.message if @actual_error
           end
 
           def expected_for_matcher_text
@@ -718,11 +730,7 @@ module RSpec
           end
 
           def expected_action_for_failure_message
-            if @actual_error
-              "match"
-            else
-              "raise error"
-            end
+            @actual_error ? "match" : "raise error"
           end
 
           def matcher_text_builder_class
@@ -770,9 +778,7 @@ module RSpec
 
     SuperDiff.insert_overrides(self) do
       def self.prepended(base)
-        base.class_eval do
-          alias_matcher :an_array_matching, :match_array
-        end
+        base.class_eval { alias_matcher :an_array_matching, :match_array }
       end
 
       def match_array(items)

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

@@ -4,7 +4,8 @@ module SuperDiff
       module InspectionTreeBuilders
         class CollectionIncluding < SuperDiff::ObjectInspection::InspectionTreeBuilders::Base
           def self.applies_to?(value)
-            SuperDiff::RSpec.a_collection_including_something?(value) || SuperDiff::RSpec.array_including_something?(value)
+            SuperDiff::RSpec.a_collection_including_something?(value) ||
+              SuperDiff::RSpec.array_including_something?(value)
           end
 
           def call
@@ -14,11 +15,12 @@ module SuperDiff
               end
 
               nested do |value|
-                array = if SuperDiff::RSpec.a_collection_including_something?(value)
-                          value.expecteds
-                        else
-                          value.instance_variable_get(:@expected)
-                        end
+                array =
+                  if SuperDiff::RSpec.a_collection_including_something?(value)
+                    value.expecteds
+                  else
+                    value.instance_variable_get(:@expected)
+                  end
                 insert_array_inspection_of(array)
               end
 

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

@@ -31,23 +31,17 @@ module SuperDiff
                     "#<#{inspected_class} #{inspected_name}"
                   end
 
-                  when_rendering_to_lines do
-                    add_text " {"
-                  end
+                  when_rendering_to_lines { add_text " {" }
                 end
 
-                when_rendering_to_string do
-                  add_text " "
-                end
+                when_rendering_to_string { add_text " " }
 
                 nested do |object|
                   insert_hash_inspection_of(builder.doubled_methods)
                 end
 
                 as_lines_when_rendering_to_lines(collection_bookend: :close) do
-                  when_rendering_to_lines do
-                    add_text "}"
-                  end
+                  when_rendering_to_lines { add_text "}" }
 
                   add_text ">"
                 end
@@ -85,16 +79,17 @@ module SuperDiff
           end
 
           def doubled_methods
-            @_doubled_methods ||= doubled_method_names.reduce({}) do |hash, key|
-              hash.merge(key => object.public_send(key))
-            end
+            @_doubled_methods ||=
+              doubled_method_names.reduce({}) do |hash, key|
+                hash.merge(key => object.public_send(key))
+              end
           end
 
           def doubled_method_names
-            object.
-              __send__(:__mock_proxy).
-              instance_variable_get("@method_doubles").
-              keys
+            object
+              .__send__(:__mock_proxy)
+              .instance_variable_get("@method_doubles")
+              .keys
           end
         end
       end

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

@@ -4,7 +4,8 @@ module SuperDiff
       module InspectionTreeBuilders
         class HashIncluding < SuperDiff::ObjectInspection::InspectionTreeBuilders::Base
           def self.applies_to?(value)
-            SuperDiff::RSpec.a_hash_including_something?(value) || SuperDiff::RSpec.hash_including_something?(value)
+            SuperDiff::RSpec.a_hash_including_something?(value) ||
+              SuperDiff::RSpec.hash_including_something?(value)
           end
 
           def call

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

@@ -4,17 +4,19 @@ module SuperDiff
       module InspectionTreeBuilders
         class InstanceOf < SuperDiff::ObjectInspection::InspectionTreeBuilders::Base
           def self.applies_to?(value)
-            SuperDiff::RSpec.an_instance_of_something?(value) || SuperDiff::RSpec.instance_of_something?(value)
+            SuperDiff::RSpec.an_instance_of_something?(value) ||
+              SuperDiff::RSpec.instance_of_something?(value)
           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
+                klass =
+                  if SuperDiff::RSpec.an_instance_of_something?(value)
+                    value.expected
+                  else
+                    value.instance_variable_get(:@klass)
+                  end
                 "#<an instance of #{klass}>"
               end
             end

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

@@ -4,17 +4,19 @@ module SuperDiff
       module InspectionTreeBuilders
         class KindOf < SuperDiff::ObjectInspection::InspectionTreeBuilders::Base
           def self.applies_to?(value)
-            SuperDiff::RSpec.a_kind_of_something?(value) || SuperDiff::RSpec.kind_of_something?(value)
+            SuperDiff::RSpec.a_kind_of_something?(value) ||
+              SuperDiff::RSpec.kind_of_something?(value)
           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
+                klass =
+                  if SuperDiff::RSpec.a_kind_of_something?(value)
+                    value.expected
+                  else
+                    value.instance_variable_get(:@klass)
+                  end
                 "#<a kind of #{klass}>"
               end
             end

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

@@ -4,39 +4,39 @@ module SuperDiff
       module InspectionTreeBuilders
         autoload(
           :CollectionContainingExactly,
-          "super_diff/rspec/object_inspection/inspection_tree_builders/collection_containing_exactly",
+          "super_diff/rspec/object_inspection/inspection_tree_builders/collection_containing_exactly"
         )
         autoload(
           :CollectionIncluding,
-          "super_diff/rspec/object_inspection/inspection_tree_builders/collection_including",
+          "super_diff/rspec/object_inspection/inspection_tree_builders/collection_including"
         )
         autoload(
           :Double,
-          "super_diff/rspec/object_inspection/inspection_tree_builders/double",
+          "super_diff/rspec/object_inspection/inspection_tree_builders/double"
         )
         autoload(
           :HashIncluding,
-          "super_diff/rspec/object_inspection/inspection_tree_builders/hash_including",
+          "super_diff/rspec/object_inspection/inspection_tree_builders/hash_including"
         )
         autoload(
           :InstanceOf,
-          "super_diff/rspec/object_inspection/inspection_tree_builders/instance_of",
+          "super_diff/rspec/object_inspection/inspection_tree_builders/instance_of"
         )
         autoload(
           :KindOf,
-          "super_diff/rspec/object_inspection/inspection_tree_builders/kind_of",
+          "super_diff/rspec/object_inspection/inspection_tree_builders/kind_of"
         )
         autoload(
           :ObjectHavingAttributes,
-          "super_diff/rspec/object_inspection/inspection_tree_builders/object_having_attributes",
+          "super_diff/rspec/object_inspection/inspection_tree_builders/object_having_attributes"
         )
         autoload(
           :Primitive,
-          "super_diff/rspec/object_inspection/inspection_tree_builders/primitive",
+          "super_diff/rspec/object_inspection/inspection_tree_builders/primitive"
         )
         autoload(
           :ValueWithin,
-          "super_diff/rspec/object_inspection/inspection_tree_builders/value_within",
+          "super_diff/rspec/object_inspection/inspection_tree_builders/value_within"
         )
       end
     end

data/lib/super_diff/rspec/object_inspection.rb

@@ -3,7 +3,7 @@ module SuperDiff
     module ObjectInspection
       autoload(
         :InspectionTreeBuilders,
-        "super_diff/rspec/object_inspection/inspection_tree_builders",
+        "super_diff/rspec/object_inspection/inspection_tree_builders"
       )
     end
   end

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

@@ -3,8 +3,9 @@ module SuperDiff
     module OperationTreeBuilders
       class CollectionContainingExactly < SuperDiff::OperationTreeBuilders::Base
         def self.applies_to?(expected, actual)
-          SuperDiff::RSpec.a_collection_containing_exactly_something?(expected) &&
-            actual.is_a?(::Array)
+          SuperDiff::RSpec.a_collection_containing_exactly_something?(
+            expected
+          ) && actual.is_a?(::Array)
         end
 
         def initialize(actual:, **)
@@ -17,11 +18,11 @@ module SuperDiff
         def unary_operations
           operations = []
 
-          (0...actual.length).reject do |index|
-            indexes_in_actual_but_not_in_expected.include?(index)
-          end.each do |index|
-            add_noop_to(operations, index)
-          end
+          (0...actual.length)
+            .reject do |index|
+              indexes_in_actual_but_not_in_expected.include?(index)
+            end
+            .each { |index| add_noop_to(operations, index) }
 
           indexes_in_actual_but_not_in_expected.each do |index|
             add_insert_to(operations, index)
@@ -51,7 +52,7 @@ module SuperDiff
             collection: collection,
             key: index,
             value: value,
-            index: index,
+            index: index
           )
         end
 
@@ -62,7 +63,7 @@ module SuperDiff
             collection: collection,
             key: index,
             value: value,
-            index: index,
+            index: index
           )
         end
 
@@ -73,7 +74,7 @@ module SuperDiff
             collection: collection,
             key: index,
             value: value,
-            index: index,
+            index: index
           )
         end