super_diff 0.12.1 → 0.14.0

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module RSpec
     module InspectionTreeBuilders

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module RSpec
     module InspectionTreeBuilders
@@ -9,19 +11,19 @@ module SuperDiff
         def call
           Core::InspectionTree.new do |t1|
             t1.as_prelude_when_rendering_to_lines do |t2|
-              t2.add_text "#<a value within "
+              t2.add_text '#<a value within '
 
               t2.add_inspection_of(
-                object.base_matcher.instance_variable_get("@delta"),
+                object.base_matcher.instance_variable_get('@delta'),
                 as_lines: false
               )
 
-              t2.add_text " of "
+              t2.add_text ' of '
             end
 
             t1.add_inspection_of object.expected
 
-            t1.add_text ">"
+            t1.add_text '>'
           end
         end
       end

data/lib/super_diff/rspec/inspection_tree_builders.rb

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module RSpec
     module MatcherTextBuilders
@@ -40,11 +42,9 @@ module SuperDiff
 
         protected
 
-        def add_extra_after_expected_to(template)
-        end
+        def add_extra_after_expected_to(template); end
 
-        def add_extra_after_error
-        end
+        def add_extra_after_error; end
 
         def actual_color
           SuperDiff.configuration.actual_color
@@ -74,7 +74,7 @@ module SuperDiff
           template.add_break
           template.insert expected_section
           add_extra_after_expected_to(template)
-          template.add_text_in_singleline_mode "."
+          template.add_text_in_singleline_mode '.'
           add_extra_after_error
         end
 
@@ -83,12 +83,12 @@ module SuperDiff
           template.add_text_in_multiline_mode do
             actual_phrase.rjust(phrase_width)
           end
-          template.add_text " "
+          template.add_text ' '
           add_actual_value
         end
 
         def actual_phrase
-          "Expected"
+          'Expected'
         end
 
         def add_actual_value
@@ -109,7 +109,7 @@ module SuperDiff
           if respond_to?(:add_expected_value_to, true)
             add_expected_value_to(template, expected_for_failure_message)
           else
-            template.add_text " "
+            template.add_text ' '
             template.add_text_in_color(
               expected_color,
               expected_for_failure_message
@@ -121,7 +121,7 @@ module SuperDiff
           if respond_to?(:add_expected_value_to, true)
             add_expected_value_to(template, expected_for_description)
           else
-            template.add_text " "
+            template.add_text ' '
             template.add_text_in_color(expected_color, expected_for_description)
           end
         end
@@ -131,13 +131,13 @@ module SuperDiff
         end
 
         def to_or_not_to
-          negated? ? "not to" : "to"
+          negated? ? 'not to' : 'to'
         end
 
         def phrase_width
           [actual_phrase, expected_phrase].map do |text|
-              Csi.decolorize(text.to_s).length
-            end
+            Csi.decolorize(text.to_s).length
+          end
             .max
         end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module RSpec
     module MatcherTextBuilders
@@ -18,11 +20,11 @@ module SuperDiff
 
         def expected_action_for_failure_message
           if predicate_accessible?
-            "return a truthy result for"
+            'return a truthy result for'
           elsif private_predicate?
-            "have a public method"
+            'have a public method'
           else
-            "respond to"
+            'respond to'
           end
         end
 
@@ -35,12 +37,12 @@ module SuperDiff
         end
 
         def add_expected_value_to_failure_message(template)
-          template.add_text " "
+          template.add_text ' '
           template.add_text_in_color(
             expected_color,
             "#{expected_for_failure_message}?"
           )
-          template.add_text " or "
+          template.add_text ' or '
           template.add_text_in_color(
             expected_color,
             "#{expected_for_failure_message}s?"
@@ -48,12 +50,12 @@ module SuperDiff
         end
 
         def add_expected_value_to_description(template)
-          template.add_text " "
+          template.add_text ' '
           template.add_text_in_color(
             expected_color,
             "`#{expected_for_description}?`"
           )
-          template.add_text " or "
+          template.add_text ' or '
           template.add_text_in_color(
             expected_color,
             "`#{expected_for_description}s?`"
@@ -63,18 +65,18 @@ module SuperDiff
         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 " or "
-            template.add_text_in_color(:blue, "be_truthy")
-            template.add_text " instead?)"
+            template.add_text '(Perhaps you want to use '
+            template.add_text_in_color(:blue, 'be(true)')
+            template.add_text ' or '
+            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 " or "
-            template.add_text_in_color(:blue, "be_falsey")
-            template.add_text " instead?)"
+            template.add_text '(Perhaps you want to use '
+            template.add_text_in_color(:blue, 'be(false)')
+            template.add_text ' or '
+            template.add_text_in_color(:blue, 'be_falsey')
+            template.add_text ' instead?)'
           end
         end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module RSpec
     module MatcherTextBuilders
@@ -5,7 +7,7 @@ module SuperDiff
         protected
 
         def add_expected_value_to(template, expected)
-          template.add_text " "
+          template.add_text ' '
           template.add_list_in_color(expected_color, expected)
         end
       end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module RSpec
     module MatcherTextBuilders
@@ -12,11 +14,11 @@ module SuperDiff
 
         def expected_action_for_failure_message
           if predicate_accessible?
-            "return a truthy result for"
+            'return a truthy result for'
           elsif private_predicate?
-            "have a public method"
+            'have a public method'
           else
-            "respond to"
+            'respond to'
           end
         end
 
@@ -29,7 +31,7 @@ module SuperDiff
         end
 
         def add_expected_value_to_failure_message(template)
-          template.add_text " "
+          template.add_text ' '
           template.add_text_in_color(
             expected_color,
             expected_for_failure_message
@@ -37,7 +39,7 @@ module SuperDiff
         end
 
         def add_expected_value_to_description(template)
-          template.add_text " "
+          template.add_text ' '
           template.add_text_in_color(
             expected_color,
             "`#{expected_for_description}`"

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module RSpec
     module MatcherTextBuilders
@@ -8,10 +10,10 @@ module SuperDiff
         end
 
         def add_extra
-          if expected_captures
-            template.add_text "with captures "
-            template.add_text_in_color :blue, description_of(expected_captures)
-          end
+          return unless expected_captures
+
+          template.add_text 'with captures '
+          template.add_text_in_color :blue, description_of(expected_captures)
         end
 
         private

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module RSpec
     module MatcherTextBuilders
@@ -5,10 +7,10 @@ module SuperDiff
         protected
 
         def actual_phrase
-          if actual == "exception-free block"
-            "Expected"
+          if actual == 'exception-free block'
+            'Expected'
           else
-            "Expected raised exception"
+            'Expected raised exception'
           end
         end
       end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module RSpec
     module MatcherTextBuilders
@@ -19,7 +21,7 @@ module SuperDiff
         protected
 
         def add_expected_value_to(template, expected)
-          template.add_text " "
+          template.add_text ' '
           template.add_list_in_color(expected_color, expected)
         end
 
@@ -28,7 +30,7 @@ module SuperDiff
 
           if arbitrary_keywords?
             add_arbitrary_keywords_clause_to(template)
-          elsif has_expected_keywords?
+          elsif expected_keywords?
             add_keywords_clause_to(template)
           end
 
@@ -43,8 +45,8 @@ module SuperDiff
           @arbitrary_keywords
         end
 
-        def has_expected_keywords?
-          expected_keywords && expected_keywords.count > 0
+        def expected_keywords?
+          expected_keywords&.count&.positive?
         end
 
         def unlimited_arguments?
@@ -52,34 +54,34 @@ module SuperDiff
         end
 
         def add_arity_clause_to(template)
-          template.add_text " with "
+          template.add_text ' with '
           template.add_text_in_color expected_color, expected_arity
-          template.add_text " "
-          template.add_text pluralize("argument", expected_arity)
+          template.add_text ' '
+          template.add_text pluralize('argument', expected_arity)
         end
 
         def add_arbitrary_keywords_clause_to(template)
-          template.add_text " with "
-          template.add_text_in_color expected_color, "any"
-          template.add_text " keywords"
+          template.add_text ' with '
+          template.add_text_in_color expected_color, 'any'
+          template.add_text ' keywords'
         end
 
         def add_keywords_clause_to(template)
-          template.add_text " with "
-          template.add_text pluralize("keyword", expected_keywords.length)
-          template.add_text " "
+          template.add_text ' with '
+          template.add_text pluralize('keyword', expected_keywords.length)
+          template.add_text ' '
           template.add_list_in_color expected_color, expected_keywords
         end
 
         def add_unlimited_arguments_clause_to(template)
-          if arbitrary_keywords? || has_expected_keywords?
-            template.add_text " and "
+          if arbitrary_keywords? || expected_keywords?
+            template.add_text ' and '
           else
-            template.add_text " with "
+            template.add_text ' with '
           end
 
-          template.add_text_in_color expected_color, "unlimited"
-          template.add_text " arguments"
+          template.add_text_in_color expected_color, 'unlimited'
+          template.add_text ' arguments'
         end
 
         def pluralize(word, count)

data/lib/super_diff/rspec/matcher_text_builders.rb

@@ -1,25 +1,27 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module RSpec
     module MatcherTextBuilders
-      autoload :Base, "super_diff/rspec/matcher_text_builders/base"
+      autoload :Base, 'super_diff/rspec/matcher_text_builders/base'
       autoload(
         :BePredicate,
-        "super_diff/rspec/matcher_text_builders/be_predicate"
+        'super_diff/rspec/matcher_text_builders/be_predicate'
       )
       autoload(
         :ContainExactly,
-        "super_diff/rspec/matcher_text_builders/contain_exactly"
+        'super_diff/rspec/matcher_text_builders/contain_exactly'
       )
       autoload(
         :HavePredicate,
-        "super_diff/rspec/matcher_text_builders/have_predicate"
+        'super_diff/rspec/matcher_text_builders/have_predicate'
       )
-      autoload :Match, "super_diff/rspec/matcher_text_builders/match"
+      autoload :Match, 'super_diff/rspec/matcher_text_builders/match'
       autoload(
         :RaiseError,
-        "super_diff/rspec/matcher_text_builders/raise_error"
+        'super_diff/rspec/matcher_text_builders/raise_error'
       )
-      autoload(:RespondTo, "super_diff/rspec/matcher_text_builders/respond_to")
+      autoload(:RespondTo, 'super_diff/rspec/matcher_text_builders/respond_to')
     end
   end
 end

data/lib/super_diff/rspec/matcher_text_template.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module RSpec
     class MatcherTextTemplate
@@ -13,41 +15,41 @@ module SuperDiff
         yield self if block_given?
       end
 
-      def add_text(*args, &block)
-        add_token(PlainText, *args, &block)
+      def add_text(...)
+        add_token(PlainText, ...)
       end
 
-      def add_text_in_color(*args, &block)
-        add_token(ColorizedText, *args, &block)
+      def add_text_in_color(...)
+        add_token(ColorizedText, ...)
       end
 
-      def add_text_in_singleline_mode(*args, &block)
-        add_token(PlainTextInSinglelineMode, *args, &block)
+      def add_text_in_singleline_mode(...)
+        add_token(PlainTextInSinglelineMode, ...)
       end
 
-      def add_text_in_multiline_mode(*args, &block)
-        add_token(PlainTextInMultilineMode, *args, &block)
+      def add_text_in_multiline_mode(...)
+        add_token(PlainTextInMultilineMode, ...)
       end
 
-      def add_list_in_color(*args, &block)
-        add_token(ColorizedList, *args, &block)
+      def add_list_in_color(...)
+        add_token(ColorizedList, ...)
       end
 
-      def add_break(*args, &block)
-        add_token(Break, *args, &block)
+      def add_break(...)
+        add_token(Break, ...)
       end
 
-      def insert(*args, &block)
-        add_token(Insertion, *args, &block)
+      def insert(...)
+        add_token(Insertion, ...)
       end
 
       def length_of_first_paragraph
-        Csi.decolorize(to_string_in_singleline_mode).split(/\n\n/).first.length
+        Csi.decolorize(to_string_in_singleline_mode).split("\n\n").first.length
       end
 
       def to_s(as_single_line: nil)
         if length_of_first_paragraph > MAX_LINE_LENGTH ||
-             as_single_line == false
+           as_single_line == false
           to_string_in_multiline_mode
         elsif length_of_first_paragraph <= MAX_LINE_LENGTH ||
               as_single_line == true
@@ -67,21 +69,17 @@ module SuperDiff
 
       attr_reader :tokens
 
-      def add_token(klass, *args, &block)
-        tokens << klass.new(*args, &block)
+      def add_token(klass, ...)
+        tokens << klass.new(...)
       end
 
       class Base
         def to_string_in_singleline_mode
-          raise NotImplementedError.new(
-                  "#{self.class} must support #to_string_in_singleline_mode"
-                )
+          raise NotImplementedError, "#{self.class} must support #to_string_in_singleline_mode"
         end
 
         def to_string_in_multiline_mode
-          raise NotImplementedError.new(
-                  "#{self.class} must support #to_string_in_multiline_mode"
-                )
+          raise NotImplementedError, "#{self.class} must support #to_string_in_multiline_mode"
         end
 
         def length
@@ -91,6 +89,7 @@ module SuperDiff
 
       class Text < Base
         def initialize(immediate_value = nil, &block)
+          super()
           @immediate_value = immediate_value
           @block = block
         end
@@ -104,7 +103,7 @@ module SuperDiff
         end
 
         def to_s
-          raise NotImplementedError.new("#{self.class} must support #to_s")
+          raise NotImplementedError, "#{self.class} must support #to_s"
         end
 
         protected
@@ -112,11 +111,7 @@ module SuperDiff
         attr_reader :immediate_value, :block
 
         def evaluate
-          if immediate_value && block
-            raise ArgumentError.new(
-                    "Cannot provide both immediate value and block"
-                  )
-          end
+          raise ArgumentError, 'Cannot provide both immediate value and block' if immediate_value && block
 
           immediate_value || block.call
         end
@@ -124,12 +119,12 @@ module SuperDiff
         def to_sentence(values)
           case values.length
           when 0
-            ""
+            ''
           when 1
             values[0]
           else
             # TODO: Use Oxford comma
-            values[0..-2].join(", ") + " and #{values[-1]}"
+            values[0..-2].join(', ') + " and #{values[-1]}"
           end
         end
       end
@@ -141,8 +136,8 @@ module SuperDiff
       end
 
       class ColorizedText < Text
-        def initialize(color, *args, &block)
-          super(*args, &block)
+        def initialize(color, ...)
+          super(...)
 
           @color = color
         end
@@ -165,8 +160,8 @@ module SuperDiff
       end
 
       class ColorizedList < Text
-        def initialize(color, *args, &block)
-          super(*args, &block)
+        def initialize(color, ...)
+          super(...)
 
           @color = color
         end
@@ -199,13 +194,13 @@ module SuperDiff
         end
 
         def to_string_in_multiline_mode
-          ""
+          ''
         end
       end
 
       class PlainTextInMultilineMode < Text
         def to_string_in_singleline_mode
-          ""
+          ''
         end
 
         def to_string_in_multiline_mode
@@ -215,7 +210,7 @@ module SuperDiff
 
       class Break < Base
         def to_string_in_singleline_mode
-          " "
+          ' '
         end
 
         def to_string_in_multiline_mode

data/lib/super_diff/rspec/object_inspection.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module RSpec
     module ObjectInspection
       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
+            warn <<~WARNING
+              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")}
+            WARNING
             RSpec::InspectionTreeBuilders.const_get(missing_const_name)
           else
             super