super_diff 0.12.1 → 0.14.0

data/lib/super_diff/equality_matchers/singleline_string.rb

@@ -1,26 +1,28 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module EqualityMatchers
     class SinglelineString < Base
       def self.applies_to?(value)
-        value.class == ::String
+        value.instance_of?(::String)
       end
 
       def fail
         <<~OUTPUT.strip
-          Differing strings.
+            Differing strings.
 
-          #{
-          Core::Helpers.style(
-            :expected,
-            "Expected: " + SuperDiff.inspect_object(expected, as_lines: false)
-          )
-        }
-          #{
-          Core::Helpers.style(
-            :actual,
-            "  Actual: " + SuperDiff.inspect_object(actual, as_lines: false)
-          )
-        }
+            #{
+            Core::Helpers.style(
+              :expected,
+              "Expected: #{SuperDiff.inspect_object(expected, as_lines: false)}"
+            )
+          }
+            #{
+            Core::Helpers.style(
+              :actual,
+              "  Actual: #{SuperDiff.inspect_object(actual, as_lines: false)}"
+            )
+          }
         OUTPUT
       end
     end

data/lib/super_diff/equality_matchers.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module EqualityMatchers
-    autoload :Array, "super_diff/equality_matchers/array"
-    autoload :Base, "super_diff/equality_matchers/base"
-    autoload :Hash, "super_diff/equality_matchers/hash"
-    autoload :Main, "super_diff/equality_matchers/main"
-    autoload :MultilineString, "super_diff/equality_matchers/multiline_string"
-    autoload :Default, "super_diff/equality_matchers/default"
-    autoload :Primitive, "super_diff/equality_matchers/primitive"
+    autoload :Array, 'super_diff/equality_matchers/array'
+    autoload :Base, 'super_diff/equality_matchers/base'
+    autoload :Hash, 'super_diff/equality_matchers/hash'
+    autoload :Main, 'super_diff/equality_matchers/main'
+    autoload :MultilineString, 'super_diff/equality_matchers/multiline_string'
+    autoload :Default, 'super_diff/equality_matchers/default'
+    autoload :Primitive, 'super_diff/equality_matchers/primitive'
     autoload(
       :SinglelineString,
-      "super_diff/equality_matchers/singleline_string"
+      'super_diff/equality_matchers/singleline_string'
     )
   end
 end
 
-require "super_diff/equality_matchers/defaults"
+require 'super_diff/equality_matchers/defaults'

data/lib/super_diff/errors.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Errors
     def self.const_missing(missing_const_name)
       if Core.const_defined?(missing_const_name)
-        warn <<~EOT
+        warn <<~WARNING
           WARNING: SuperDiff::Errors::#{missing_const_name} is deprecated and will be removed in the next major release.
           Please use SuperDiff::Core::#{missing_const_name} instead.
           #{caller_locations.join("\n")}
-        EOT
+        WARNING
         Core.const_get(missing_const_name)
       else
         super

data/lib/super_diff/object_inspection.rb

@@ -1,20 +1,22 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module ObjectInspection
     module InspectionTreeBuilders
       def self.const_missing(missing_const_name)
         if missing_const_name == :Base
-          warn <<~EOT
+          warn <<~WARNING
             WARNING: SuperDiff::ObjectInspection::InspectionTreeBuilders::#{missing_const_name} is deprecated and will be removed in the next major release.
             Please use SuperDiff::Core::AbstractInspectionTreeBuilder instead.
             #{caller_locations.join("\n")}
-          EOT
+          WARNING
           Core::AbstractInspectionTreeBuilder
         elsif Basic::InspectionTreeBuilders.const_defined?(missing_const_name)
-          warn <<~EOT
-          WARNING: SuperDiff::ObjectInspection::InspectionTreeBuilders::#{missing_const_name} is deprecated and will be removed in the next major release.
-          Please use SuperDiff::Basic::InspectionTreeBuilders::#{missing_const_name} instead.
-          #{caller_locations.join("\n")}
-        EOT
+          warn <<~WARNING
+            WARNING: SuperDiff::ObjectInspection::InspectionTreeBuilders::#{missing_const_name} is deprecated and will be removed in the next major release.
+            Please use SuperDiff::Basic::InspectionTreeBuilders::#{missing_const_name} instead.
+            #{caller_locations.join("\n")}
+          WARNING
           Basic::InspectionTreeBuilders.const_get(missing_const_name)
         else
           super
@@ -25,11 +27,11 @@ module SuperDiff
     module Nodes
       def self.const_missing(missing_const_name)
         if Core::InspectionTreeNodes.const_defined?(missing_const_name)
-          warn <<~EOT
+          warn <<~WARNING
             WARNING: SuperDiff::ObjectInspection::Nodes::#{missing_const_name} is deprecated and will be removed in the next major release.
             Please use SuperDiff::Core::InspectionTreeNodes::#{missing_const_name} instead.
             #{caller_locations.join("\n")}
-          EOT
+          WARNING
           Core::InspectionTreeNodes.const_get(missing_const_name)
         else
           super
@@ -39,25 +41,25 @@ module SuperDiff
 
     def self.const_missing(missing_const_name)
       if missing_const_name == :PrefixForNextNode
-        warn <<~EOT
+        warn <<~WARNING
           WARNING: SuperDiff::ObjectInspection::PrefixForNextNode is deprecated and will be removed in the next major release.
           Please use SuperDiff::Core::PrefixForNextInspectionTreeNode instead.
           #{caller_locations.join("\n")}
-        EOT
+        WARNING
         Core::PrefixForNextInspectionTreeNode
       elsif missing_const_name == :PreludeForNextNode
-        warn <<~EOT
+        warn <<~WARNING
           WARNING: SuperDiff::ObjectInspection::PreludeForNextNode is deprecated and will be removed in the next major release.
           Please use SuperDiff::Core::PreludeForNextInspectionTreeNode instead.
           #{caller_locations.join("\n")}
-        EOT
+        WARNING
         Core::PreludeForNextInspectionTreeNode
       elsif Core.const_defined?(missing_const_name)
-        warn <<~EOT
+        warn <<~WARNING
           WARNING: SuperDiff::ObjectInspection::#{missing_const_name} is deprecated and will be removed in the next major release.
           Please use SuperDiff::Core::#{missing_const_name} instead.
           #{caller_locations.join("\n")}
-        EOT
+        WARNING
         Core.const_get(missing_const_name)
       else
         super

data/lib/super_diff/operation_tree_builders.rb

@@ -1,19 +1,21 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module OperationTreeBuilders
     def self.const_missing(missing_const_name)
       if missing_const_name == :Base
-        warn <<~EOT
+        warn <<~WARNING
           WARNING: SuperDiff::OperationTreeBuilders::#{missing_const_name} is deprecated and will be removed in the next major release.
           Please use SuperDiff::Core::AbstractOperationTreeBuilder instead.
           #{caller_locations.join("\n")}
-        EOT
+        WARNING
         Core::AbstractOperationTreeBuilder
       elsif Basic::OperationTreeBuilders.const_defined?(missing_const_name)
-        warn <<~EOT
+        warn <<~WARNING
           WARNING: SuperDiff::OperationTreeBuilders::#{missing_const_name} is deprecated and will be removed in the next major release.
           Please use SuperDiff::Basic::OperationTreeBuilders::#{missing_const_name} instead.
           #{caller_locations.join("\n")}
-        EOT
+        WARNING
         Basic::OperationTreeBuilders.const_get(missing_const_name)
       else
         super

data/lib/super_diff/operation_tree_flatteners.rb

@@ -1,19 +1,21 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module OperationTreeFlatteners
     def self.const_missing(missing_const_name)
       if missing_const_name == :Base
-        warn <<~EOT
+        warn <<~WARNING
           WARNING: SuperDiff::OperationTreeFlatteners::#{missing_const_name} is deprecated and will be removed in the next major release.
           Please use SuperDiff::Core::AbstractOperationTreeFlattener instead.
           #{caller_locations.join("\n")}
-        EOT
+        WARNING
         Core::AbstractOperationTreeFlattener
       elsif Basic::OperationTreeFlatteners.const_defined?(missing_const_name)
-        warn <<~EOT
+        warn <<~WARNING
           WARNING: SuperDiff::OperationTreeFlatteners::#{missing_const_name} is deprecated and will be removed in the next major release.
           Please use SuperDiff::Basic::OperationTreeFlatteners::#{missing_const_name} instead.
           #{caller_locations.join("\n")}
-        EOT
+        WARNING
         Basic::OperationTreeFlatteners.const_get(missing_const_name)
       else
         super

data/lib/super_diff/operation_trees.rb

@@ -1,19 +1,21 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module OperationTrees
     def self.const_missing(missing_const_name)
       if missing_const_name == :Base
-        warn <<~EOT
+        warn <<~WARNING
           WARNING: SuperDiff::OperationTrees::#{missing_const_name} is deprecated and will be removed in the next major release.
           Please use SuperDiff::Core::AbstractOperationTree instead.
           #{caller_locations.join("\n")}
-        EOT
+        WARNING
         Core::AbstractOperationTree
       elsif Basic::OperationTrees.const_defined?(missing_const_name)
-        warn <<~EOT
+        warn <<~WARNING
           WARNING: SuperDiff::OperationTrees::#{missing_const_name} is deprecated and will be removed in the next major release.
           Please use SuperDiff::Basic::OperationTrees::#{missing_const_name} instead.
           #{caller_locations.join("\n")}
-        EOT
+        WARNING
         Basic::OperationTrees.const_get(missing_const_name)
       else
         super

data/lib/super_diff/operations.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module Operations
     def self.const_missing(missing_const_name)
       if Core.const_defined?(missing_const_name)
-        warn <<~EOT
+        warn <<~WARNING
           WARNING: SuperDiff::Operations::#{missing_const_name} is deprecated and will be removed in the next major release.
           Please use SuperDiff::Core::#{missing_const_name} instead.
           #{caller_locations.join("\n")}
-        EOT
+        WARNING
         Core.const_get(missing_const_name)
       else
         super

data/lib/super_diff/rails.rb

@@ -1,2 +1,4 @@
-require "super_diff/active_support"
-require "super_diff/active_record" if defined?(ActiveRecord)
+# frozen_string_literal: true
+
+require 'super_diff/active_support'
+require 'super_diff/active_record' if defined?(ActiveRecord)

data/lib/super_diff/rspec/augmented_matcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module RSpec
     module AugmentedMatcher
@@ -30,7 +32,7 @@ module SuperDiff
       end
 
       def matcher_text_builder
-        @_matcher_text_builder ||=
+        @matcher_text_builder ||=
           matcher_text_builder_class.new(**matcher_text_builder_args)
       end
 

data/lib/super_diff/rspec/differ.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module RSpec
     class Differ
@@ -8,19 +10,19 @@ module SuperDiff
       def diff
         if worth_diffing?
           diff = SuperDiff.diff(expected, actual)
-          "\n\n" + diff
+          "\n\n#{diff}"
         else
-          ""
+          ''
         end
       rescue Core::NoDifferAvailableError
-        ""
+        ''
       end
 
       private
 
       def worth_diffing?
         comparing_inequal_values? && !comparing_primitive_values? &&
-          !comparing_singleline_strings?
+          !comparing_proc_values? && !comparing_singleline_strings?
       end
 
       def comparing_inequal_values?
@@ -28,8 +30,15 @@ module SuperDiff
       end
 
       def comparing_primitive_values?
-        expected.is_a?(Symbol) || expected.is_a?(Integer) ||
-          [true, false, nil].include?(expected)
+        # strings are indeed primitives, but we still may want to diff them if
+        # they are multiline strings (see #comparing_singleline_strings?)
+        return false if expected.is_a?(String)
+
+        SuperDiff.primitive?(expected)
+      end
+
+      def comparing_proc_values?
+        expected.is_a?(Proc)
       end
 
       def comparing_singleline_strings?
@@ -38,7 +47,7 @@ module SuperDiff
       end
 
       def helpers
-        @_helpers ||= RSpecHelpers.new
+        @helpers ||= RSpecHelpers.new
       end
 
       class RSpecHelpers

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

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

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

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

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

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

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

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

data/lib/super_diff/rspec/differs.rb

@@ -1,18 +1,20 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module RSpec
     module Differs
       autoload(
         :CollectionContainingExactly,
-        "super_diff/rspec/differs/collection_containing_exactly"
+        'super_diff/rspec/differs/collection_containing_exactly'
       )
       autoload(
         :CollectionIncluding,
-        "super_diff/rspec/differs/collection_including"
+        'super_diff/rspec/differs/collection_including'
       )
-      autoload :HashIncluding, "super_diff/rspec/differs/hash_including"
+      autoload :HashIncluding, 'super_diff/rspec/differs/hash_including'
       autoload(
         :ObjectHavingAttributes,
-        "super_diff/rspec/differs/object_having_attributes"
+        'super_diff/rspec/differs/object_having_attributes'
       )
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module RSpec
     module InspectionTreeBuilders
@@ -10,22 +12,22 @@ module SuperDiff
           Core::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
+              collection_bookend: :open
+            ) do |t2|
+              t2.add_text '#<a collection containing exactly ('
+            end
 
             # stree-ignore
             t1.nested do |t2|
-                t2.insert_array_inspection_of(object.expected)
-              end
+              t2.insert_array_inspection_of(object.expected)
+            end
 
             # stree-ignore
             t1.as_lines_when_rendering_to_lines(
-                collection_bookend: :close
-              ) do |t2|
-                t2.add_text ")>"
-              end
+              collection_bookend: :close
+            ) do |t2|
+              t2.add_text ')>'
+            end
           end
         end
       end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module RSpec
     module InspectionTreeBuilders
@@ -11,10 +13,10 @@ module SuperDiff
           Core::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
+              collection_bookend: :open
+            ) do |t2|
+              t2.add_text '#<a collection including ('
+            end
 
             t1.nested do |t2|
               if SuperDiff::RSpec.a_collection_including_something?(object)
@@ -28,10 +30,10 @@ module SuperDiff
 
             # stree-ignore
             t1.as_lines_when_rendering_to_lines(
-                collection_bookend: :close
-              ) do |t2|
-                t2.add_text ")>"
-              end
+              collection_bookend: :close
+            ) do |t2|
+              t2.add_text ')>'
+            end
           end
         end
       end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module RSpec
     module InspectionTreeBuilders
@@ -22,29 +24,29 @@ module SuperDiff
 
                 # stree-ignore
                 t3.when_rendering_to_lines do |t4|
-                    t4.add_text " {"
-                  end
+                  t4.add_text ' {'
+                end
               end
 
               # stree-ignore
               t2.when_rendering_to_string do |t3|
-                  t3.add_text " "
-                end
+                t3.add_text ' '
+              end
 
               # stree-ignore
               t2.nested do |t3|
-                  t3.insert_hash_inspection_of doubled_methods
-                end
+                t3.insert_hash_inspection_of doubled_methods
+              end
 
               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
+                  t4.add_text '}'
+                end
 
-                t3.add_text ">"
+                t3.add_text '>'
               end
             end
           end
@@ -63,26 +65,26 @@ module SuperDiff
         def inspected_class
           case object
           when ::RSpec::Mocks::InstanceVerifyingDouble
-            "InstanceDouble"
+            'InstanceDouble'
           when ::RSpec::Mocks::ClassVerifyingDouble
-            "ClassDouble"
+            'ClassDouble'
           when ::RSpec::Mocks::ObjectVerifyingDouble
-            "ObjectDouble"
+            'ObjectDouble'
           else
-            "Double"
+            'Double'
           end
         end
 
         def inspected_name
-          if object.instance_variable_get("@name")
-            object.instance_variable_get("@name").inspect
+          if object.instance_variable_get('@name')
+            object.instance_variable_get('@name').inspect
           else
-            "(anonymous)"
+            '(anonymous)'
           end
         end
 
         def doubled_methods
-          @_doubled_methods ||=
+          @doubled_methods ||=
             doubled_method_names.reduce({}) do |hash, key|
               hash.merge(key => object.public_send(key))
             end
@@ -91,7 +93,7 @@ module SuperDiff
         def doubled_method_names
           object
             .__send__(:__mock_proxy)
-            .instance_variable_get("@method_doubles")
+            .instance_variable_get('@method_doubles')
             .keys
         end
       end

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

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module RSpec
     module InspectionTreeBuilders
@@ -11,10 +13,10 @@ module SuperDiff
           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
+              collection_bookend: :open
+            ) do |t2|
+              t2.add_text '#<a hash including ('
+            end
 
             t1.nested do |t2|
               if SuperDiff::RSpec.a_hash_including_something?(object)
@@ -28,10 +30,10 @@ module SuperDiff
 
             # stree-ignore
             t1.as_lines_when_rendering_to_lines(
-                collection_bookend: :close
-              ) do |t2|
-                t2.add_text ")>"
-              end
+              collection_bookend: :close
+            ) do |t2|
+              t2.add_text ')>'
+            end
           end
         end
       end

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

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

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

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module RSpec
     module InspectionTreeBuilders
@@ -10,22 +12,22 @@ module SuperDiff
           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
+              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
+              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
+              collection_bookend: :close
+            ) do |t2|
+              t2.add_text ')>'
+            end
           end
         end
       end