rspec-support 3.0.4 → 3.12.1

data/lib/rspec/support/differ.rb

@@ -1,15 +1,17 @@
 RSpec::Support.require_rspec_support 'encoded_string'
 RSpec::Support.require_rspec_support 'hunk_generator'
+RSpec::Support.require_rspec_support "object_formatter"
 
 require 'pp'
 
 module RSpec
   module Support
+    # rubocop:disable Metrics/ClassLength
     class Differ
       def diff(actual, expected)
         diff = ""
 
-        if actual && expected
+        unless actual.nil? || expected.nil?
           if all_strings?(actual, expected)
             if any_multiline_strings?(actual, expected)
               diff = diff_as_string(coerce_to_string(actual), coerce_to_string(expected))
@@ -22,34 +24,35 @@ module RSpec
         diff.to_s
       end
 
+      # rubocop:disable Metrics/MethodLength
       def diff_as_string(actual, expected)
-        @encoding = pick_encoding actual, expected
+        encoding = EncodedString.pick_encoding(actual, expected)
 
-        @actual   = EncodedString.new(actual, @encoding)
-        @expected = EncodedString.new(expected, @encoding)
+        actual   = EncodedString.new(actual, encoding)
+        expected = EncodedString.new(expected, encoding)
 
-        output = EncodedString.new("\n", @encoding)
+        output = EncodedString.new("\n", encoding)
+        hunks = build_hunks(actual, expected)
 
         hunks.each_cons(2) do |prev_hunk, current_hunk|
           begin
             if current_hunk.overlaps?(prev_hunk)
               add_old_hunk_to_hunk(current_hunk, prev_hunk)
             else
-              add_to_output(output, prev_hunk.diff(format).to_s)
+              add_to_output(output, prev_hunk.diff(format_type).to_s)
             end
           ensure
             add_to_output(output, "\n")
           end
         end
 
-        if hunks.last
-          finalize_output(output, hunks.last.diff(format).to_s)
-        end
+        finalize_output(output, hunks.last.diff(format_type).to_s) if hunks.last
 
         color_diff output
       rescue Encoding::CompatibilityError
-        handle_encoding_errors
+        handle_encoding_errors(actual, expected)
       end
+      # rubocop:enable Metrics/MethodLength
 
       def diff_as_object(actual, expected)
         actual_as_string = object_to_string(actual)
@@ -57,8 +60,9 @@ module RSpec
         diff_as_string(actual_as_string, expected_as_string)
       end
 
-      attr_reader :color
-      alias_method :color?, :color
+      def color?
+        @color
+      end
 
       def initialize(opts={})
         @color = opts.fetch(:color, false)
@@ -68,19 +72,19 @@ module RSpec
     private
 
       def no_procs?(*args)
-        args.flatten.none? { |a| Proc === a}
+        safely_flatten(args).none? { |a| Proc === a }
       end
 
       def all_strings?(*args)
-        args.flatten.all? { |a| String === a}
+        safely_flatten(args).all? { |a| String === a }
       end
 
       def any_multiline_strings?(*args)
-        all_strings?(*args) && args.flatten.any? { |a| multiline?(a) }
+        all_strings?(*args) && safely_flatten(args).any? { |a| multiline?(a) }
       end
 
       def no_numbers?(*args)
-        args.flatten.none? { |a| Numeric === a}
+        safely_flatten(args).none? { |a| Numeric === a }
       end
 
       def coerce_to_string(string_or_array)
@@ -93,7 +97,7 @@ module RSpec
           if Array === entry
             entry.inspect
           else
-            entry.to_s.gsub("\n", "\\n")
+            entry.to_s.gsub("\n", "\\n").gsub("\r", "\\r")
           end
         end
       end
@@ -108,8 +112,8 @@ module RSpec
         end
       end
 
-      def hunks
-        @hunks ||= HunkGenerator.new(@actual, @expected).hunks
+      def build_hunks(actual, expected)
+        HunkGenerator.new(actual, expected).hunks
       end
 
       def finalize_output(output, final_line)
@@ -125,7 +129,12 @@ module RSpec
         hunk.merge(oldhunk)
       end
 
-      def format
+      def safely_flatten(array)
+        array = array.flatten(1) until (array == array.flatten(1))
+        array
+      end
+
+      def format_type
         :unified
       end
 
@@ -152,7 +161,7 @@ module RSpec
       def color_diff(diff)
         return diff unless color?
 
-        diff.lines.map { |line|
+        diff.lines.map do |line|
           case line[0].chr
           when "+"
             green line
@@ -163,43 +172,44 @@ module RSpec
           else
             normal(line)
           end
-        }.join
+        end.join
       end
 
       def object_to_string(object)
         object = @object_preparer.call(object)
         case object
         when Hash
-          object.keys.sort_by { |k| k.to_s }.map do |key|
-            pp_key   = PP.singleline_pp(key, "")
-            pp_value = PP.singleline_pp(object[key], "")
-
-            "#{pp_key} => #{pp_value},"
-          end.join("\n")
+          hash_to_string(object)
+        when Array
+          PP.pp(ObjectFormatter.prepare_for_inspection(object), "".dup)
         when String
           object =~ /\n/ ? object : object.inspect
         else
-          PP.pp(object,"")
+          PP.pp(object, "".dup)
         end
       end
 
-      if String.method_defined?(:encoding)
-        def pick_encoding(source_a, source_b)
-          Encoding.compatible?(source_a, source_b) || Encoding.default_external
-        end
-      else
-        def pick_encoding(source_a, source_b)
-        end
+      def hash_to_string(hash)
+        formatted_hash = ObjectFormatter.prepare_for_inspection(hash)
+        formatted_hash.keys.sort_by { |k| k.to_s }.map do |key|
+          pp_key   = PP.singleline_pp(key, "".dup)
+          pp_value = PP.singleline_pp(formatted_hash[key], "".dup)
+
+          "#{pp_key} => #{pp_value},"
+        end.join("\n")
       end
 
-      def handle_encoding_errors
-        if @actual.source_encoding != @expected.source_encoding
-          "Could not produce a diff because the encoding of the actual string (#{@actual.source_encoding}) "+
-            "differs from the encoding of the expected string (#{@expected.source_encoding})"
+      def handle_encoding_errors(actual, expected)
+        if actual.source_encoding != expected.source_encoding
+          "Could not produce a diff because the encoding of the actual string " \
+          "(#{actual.source_encoding}) differs from the encoding of the expected " \
+          "string (#{expected.source_encoding})"
         else
-          "Could not produce a diff because of the encoding of the string (#{@expected.source_encoding})"
+          "Could not produce a diff because of the encoding of the string " \
+          "(#{expected.source_encoding})"
         end
       end
     end
+    # rubocop:enable Metrics/ClassLength
   end
 end

data/lib/rspec/support/directory_maker.rb

@@ -0,0 +1,63 @@
+RSpec::Support.require_rspec_support 'ruby_features'
+
+module RSpec
+  module Support
+    # @api private
+    #
+    # Replacement for fileutils#mkdir_p because we don't want to require parts
+    # of stdlib in RSpec.
+    class DirectoryMaker
+      # @api private
+      #
+      # Implements nested directory construction
+      def self.mkdir_p(path)
+        stack = generate_stack(path)
+        path.split(File::SEPARATOR).each do |part|
+          stack = generate_path(stack, part)
+          begin
+            Dir.mkdir(stack) unless directory_exists?(stack)
+          rescue Errno::EEXIST => e
+            raise e unless directory_exists?(stack)
+          rescue Errno::ENOTDIR => e
+            raise Errno::EEXIST, e.message
+          end
+        end
+      end
+
+      if OS.windows_file_path?
+        def self.generate_stack(path)
+          if path.start_with?(File::SEPARATOR)
+            File::SEPARATOR
+          elsif path[1] == ':'
+            ''
+          else
+            '.'
+          end
+        end
+        def self.generate_path(stack, part)
+          if stack == ''
+            part
+          elsif stack == File::SEPARATOR
+            File.join('', part)
+          else
+            File.join(stack, part)
+          end
+        end
+      else
+        def self.generate_stack(path)
+          path.start_with?(File::SEPARATOR) ? File::SEPARATOR : "."
+        end
+        def self.generate_path(stack, part)
+          File.join(stack, part)
+        end
+      end
+
+      def self.directory_exists?(dirname)
+        File.exist?(dirname) && File.directory?(dirname)
+      end
+      private_class_method :directory_exists?
+      private_class_method :generate_stack
+      private_class_method :generate_path
+    end
+  end
+end

data/lib/rspec/support/encoded_string.rb

@@ -2,10 +2,16 @@ module RSpec
   module Support
     # @private
     class EncodedString
+      # Reduce allocations by storing constants.
+      UTF_8    = "UTF-8"
+      US_ASCII = "US-ASCII"
 
-      MRI_UNICODE_UNKOWN_CHARACTER = "\xEF\xBF\xBD"
+      # Ruby's default replacement string is:
+      #   U+FFFD ("\xEF\xBF\xBD"), for Unicode encoding forms, else
+      #   ?      ("\x3F")
+      REPLACE = "?"
 
-      def initialize(string, encoding = nil)
+      def initialize(string, encoding=nil)
         @encoding = encoding
         @source_encoding = detect_source_encoding(string)
         @string = matching_encoding(string)
@@ -21,8 +27,18 @@ module RSpec
         @string << matching_encoding(string)
       end
 
-      def split(regex_or_string)
-        @string.split(matching_encoding(regex_or_string))
+      if Ruby.jruby?
+        def split(regex_or_string)
+          @string.split(matching_encoding(regex_or_string))
+        rescue ArgumentError
+          # JRuby raises an ArgumentError when splitting a source string that
+          # contains invalid bytes.
+          remove_invalid_bytes(@string).split regex_or_string
+        end
+      else
+        def split(regex_or_string)
+          @string.split(matching_encoding(regex_or_string))
+        end
       end
 
       def to_s
@@ -30,35 +46,114 @@ module RSpec
       end
       alias :to_str :to_s
 
-    private
-
       if String.method_defined?(:encoding)
+
+        private
+
+        # Encoding Exceptions:
+        #
+        # Raised by Encoding and String methods:
+        #   Encoding::UndefinedConversionError:
+        #     when a transcoding operation fails
+        #     if the String contains characters invalid for the target encoding
+        #     e.g. "\x80".encode('UTF-8','ASCII-8BIT')
+        #     vs "\x80".encode('UTF-8','ASCII-8BIT', undef: :replace, replace: '<undef>')
+        #     # => '<undef>'
+        #   Encoding::CompatibilityError
+        #     when Encoding.compatible?(str1, str2) is nil
+        #     e.g. utf_16le_emoji_string.split("\n")
+        #     e.g. valid_unicode_string.encode(utf8_encoding) << ascii_string
+        #   Encoding::InvalidByteSequenceError:
+        #     when the string being transcoded contains a byte invalid for
+        #     either the source or target encoding
+        #     e.g. "\x80".encode('UTF-8','US-ASCII')
+        #     vs "\x80".encode('UTF-8','US-ASCII', invalid: :replace, replace: '<byte>')
+        #     # => '<byte>'
+        #   ArgumentError
+        #     when operating on a string with invalid bytes
+        #     e.g."\x80".split("\n")
+        #   TypeError
+        #     when a symbol is passed as an encoding
+        #     Encoding.find(:"UTF-8")
+        #     when calling force_encoding on an object
+        #     that doesn't respond to #to_str
+        #
+        # Raised by transcoding methods:
+        #   Encoding::ConverterNotFoundError:
+        #     when a named encoding does not correspond with a known converter
+        #     e.g. 'abc'.force_encoding('UTF-8').encode('foo')
+        #     or a converter path cannot be found
+        #     e.g. "\x80".force_encoding('ASCII-8BIT').encode('Emacs-Mule')
+        #
+        # Raised by byte <-> char conversions
+        #   RangeError: out of char range
+        #     e.g. the UTF-16LE emoji: 128169.chr
         def matching_encoding(string)
+          string = remove_invalid_bytes(string)
           string.encode(@encoding)
         rescue Encoding::UndefinedConversionError, Encoding::InvalidByteSequenceError
-          normalize_missing(string.encode(@encoding, :invalid => :replace, :undef => :replace))
+          # Originally defined as a constant to avoid unneeded allocations, this hash must
+          # be defined inline (without {}) to avoid warnings on Ruby 2.7
+          #
+          # In MRI 2.1 'invalid: :replace' changed to also replace an invalid byte sequence
+          # see https://github.com/ruby/ruby/blob/v2_1_0/NEWS#L176
+          # https://www.ruby-forum.com/topic/6861247
+          # https://twitter.com/nalsh/status/553413844685438976
+          #
+          # For example, given:
+          #   "\x80".force_encoding("Emacs-Mule").encode(:invalid => :replace).bytes.to_a
+          #
+          # On MRI 2.1 or above: 63  # '?'
+          # else               : 128 # "\x80"
+          #
+          string.encode(@encoding, :invalid => :replace, :undef => :replace, :replace => REPLACE)
         rescue Encoding::ConverterNotFoundError
-          normalize_missing(string.force_encoding(@encoding).encode(:invalid => :replace))
+          # Originally defined as a constant to avoid unneeded allocations, this hash must
+          # be defined inline (without {}) to avoid warnings on Ruby 2.7
+          string.dup.force_encoding(@encoding).encode(:invalid => :replace, :replace => REPLACE)
         end
 
-        def normalize_missing(string)
-          if @encoding.to_s == "UTF-8"
-            string.gsub(MRI_UNICODE_UNKOWN_CHARACTER.force_encoding(@encoding), "?")
-          else
-            string
+        # Prevents raising ArgumentError
+        if String.method_defined?(:scrub)
+          # https://github.com/ruby/ruby/blob/eeb05e8c11/doc/NEWS-2.1.0#L120-L123
+          # https://github.com/ruby/ruby/blob/v2_1_0/string.c#L8242
+          # https://github.com/hsbt/string-scrub
+          # https://github.com/rubinius/rubinius/blob/v2.5.2/kernel/common/string.rb#L1913-L1972
+          def remove_invalid_bytes(string)
+            string.scrub(REPLACE)
+          end
+        else
+          # http://stackoverflow.com/a/8711118/879854
+          # Loop over chars in a string replacing chars
+          # with invalid encoding, which is a pretty good proxy
+          # for the invalid byte sequence that causes an ArgumentError
+          def remove_invalid_bytes(string)
+            string.chars.map do |char|
+              char.valid_encoding? ? char : REPLACE
+            end.join
           end
         end
 
         def detect_source_encoding(string)
           string.encoding
         end
+
+        def self.pick_encoding(source_a, source_b)
+          Encoding.compatible?(source_a, source_b) || Encoding.default_external
+        end
       else
+
+        def self.pick_encoding(_source_a, _source_b)
+        end
+
+        private
+
         def matching_encoding(string)
           string
         end
 
-        def detect_source_encoding(string)
-          'US-ASCII'
+        def detect_source_encoding(_string)
+          US_ASCII
         end
       end
     end

data/lib/rspec/support/fuzzy_matcher.rb

@@ -6,14 +6,14 @@ module RSpec
     module FuzzyMatcher
       # @api private
       def self.values_match?(expected, actual)
-        if Array === expected && Enumerable === actual
+        if Hash === actual
+          return hashes_match?(expected, actual) if Hash === expected
+        elsif Array === expected && Enumerable === actual && !(Struct === actual)
           return arrays_match?(expected, actual.to_a)
-        elsif Hash === expected && Hash === actual
-          return hashes_match?(expected, actual)
-        elsif actual == expected
-          return true
         end
 
+        return true if expected == actual
+
         begin
           expected === actual
         rescue ArgumentError
@@ -46,4 +46,3 @@ module RSpec
     end
   end
 end
-

data/lib/rspec/support/hunk_generator.rb

@@ -42,7 +42,6 @@ module RSpec
       def context_lines
         3
       end
-
     end
   end
 end

data/lib/rspec/support/matcher_definition.rb

@@ -0,0 +1,42 @@
+module RSpec
+  module Support
+    # @private
+    def self.matcher_definitions
+      @matcher_definitions ||= []
+    end
+
+    # Used internally to break cyclic dependency between mocks, expectations,
+    # and support. We don't currently have a consistent implementation of our
+    # matchers, though we are considering changing that:
+    # https://github.com/rspec/rspec-mocks/issues/513
+    #
+    # @private
+    def self.register_matcher_definition(&block)
+      matcher_definitions << block
+    end
+
+    # Remove a previously registered matcher. Useful for cleaning up after
+    # yourself in specs.
+    #
+    # @private
+    def self.deregister_matcher_definition(&block)
+      matcher_definitions.delete(block)
+    end
+
+    # @private
+    def self.is_a_matcher?(object)
+      matcher_definitions.any? { |md| md.call(object) }
+    end
+
+    # @api private
+    #
+    # gives a string representation of an object for use in RSpec descriptions
+    def self.rspec_description_for_object(object)
+      if RSpec::Support.is_a_matcher?(object) && object.respond_to?(:description)
+        object.description
+      else
+        object
+      end
+    end
+  end
+end