rspec-support 3.0.4 → 3.12.1

data/lib/rspec/support/spec/shell_out.rb

@@ -0,0 +1,108 @@
+require 'open3'
+require 'rake/file_utils'
+require 'shellwords'
+
+module RSpec
+  module Support
+    module ShellOut
+      def with_env(vars)
+        original = ENV.to_hash
+        vars.each { |k, v| ENV[k] = v }
+
+        begin
+          yield
+        ensure
+          ENV.replace(original)
+        end
+      end
+
+      if Open3.respond_to?(:capture3) # 1.9+
+        def shell_out(*command)
+          stdout, stderr, status = Open3.capture3(*command)
+          return stdout, filter(stderr), status
+        end
+      else # 1.8.7
+        # popen3 doesn't provide the exit status so we fake it out.
+        FakeProcessStatus = Struct.new(:exitstatus)
+
+        def shell_out(*command)
+          stdout = stderr = nil
+
+          Open3.popen3(*command) do |_in, out, err|
+            stdout = out.read
+            stderr = err.read
+          end
+
+          status = FakeProcessStatus.new(0)
+          return stdout, filter(stderr), status
+        end
+      end
+
+      def run_ruby_with_current_load_path(ruby_command, *flags)
+        command = [
+          FileUtils::RUBY,
+          "-I#{$LOAD_PATH.map(&:shellescape).join(File::PATH_SEPARATOR)}",
+          "-e", ruby_command, *flags
+        ]
+
+        # Unset these env vars because `ruby -w` will issue warnings whenever
+        # they are set to non-default values.
+        with_env 'RUBY_GC_HEAP_FREE_SLOTS' => nil, 'RUBY_GC_MALLOC_LIMIT' => nil,
+                 'RUBY_FREE_MIN' => nil do
+          shell_out(*command)
+        end
+      end
+
+      LINES_TO_IGNORE =
+        [
+          # Ignore bundler warning.
+          %r{bundler/source/rubygems},
+          # Ignore bundler + rubygems warning.
+          %r{site_ruby/\d\.\d\.\d/rubygems},
+          %r{jruby-\d\.\d\.\d+\.\d/lib/ruby/stdlib/rubygems},
+          # This is required for windows for some reason
+          %r{lib/bundler/rubygems},
+          # This is a JRuby file that generates warnings on 9.0.3.0
+          %r{lib/ruby/stdlib/jar},
+          # This is a JRuby file that generates warnings on 9.1.7.0
+          %r{org/jruby/RubyKernel\.java},
+          # This is a JRuby gem that generates warnings on 9.1.7.0
+          %r{ffi-1\.13\.\d+-java},
+          %r{uninitialized constant FFI},
+          # These are related to the above, there is a warning about io from FFI
+          %r{jruby-\d\.\d\.\d+\.\d/lib/ruby/stdlib/io},
+          %r{io/console on JRuby shells out to stty for most operations},
+          # This is a JRuby 9.1.17.0 error on Github Actions
+          %r{io/console not supported; tty will not be manipulated},
+          # This is a JRuby 9.2.1.x error
+          %r{jruby/kernel/gem_prelude},
+          %r{lib/jruby\.jar!/jruby/preludes},
+          # Ignore some JRuby errors for gems
+          %r{jruby/\d\.\d(\.\d)?/gems/aruba},
+          %r{jruby/\d\.\d(\.\d)?/gems/ffi},
+        ]
+
+      def strip_known_warnings(input)
+        input.split("\n").reject do |l|
+          LINES_TO_IGNORE.any? { |to_ignore| l =~ to_ignore } ||
+          # Remove blank lines
+          l == "" || l.nil?
+        end.join("\n")
+      end
+
+    private
+
+      if Ruby.jruby?
+        def filter(output)
+          output.each_line.reject do |line|
+            line.include?("lib/ruby/shared/rubygems")
+          end.join($/)
+        end
+      else
+        def filter(output)
+          output
+        end
+      end
+    end
+  end
+end

data/lib/rspec/support/spec/stderr_splitter.rb

@@ -6,15 +6,16 @@ module RSpec
       def initialize(original)
         @orig_stderr    = original
         @output_tracker = ::StringIO.new
+        @last_line = nil
       end
 
       respond_to_name = (::RUBY_VERSION.to_f < 1.9) ? :respond_to? : :respond_to_missing?
       define_method respond_to_name do |*args|
-        @orig_stderr.respond_to?(*args) || super
+        @orig_stderr.respond_to?(*args) || super(*args)
       end
 
       def method_missing(name, *args, &block)
-        @output_tracker.__send__(name, *args, &block)
+        @output_tracker.__send__(name, *args, &block) if @output_tracker.respond_to?(name)
         @orig_stderr.__send__(name, *args, &block)
       end
 
@@ -22,13 +23,35 @@ module RSpec
         @orig_stderr == other
       end
 
+      def reopen(*args)
+        reset!
+        @orig_stderr.reopen(*args)
+      end
+
+      # To work around JRuby error:
+      # can't convert RSpec::Support::StdErrSplitter into String
+      def to_io
+        @orig_stderr.to_io
+      end
+
       # To work around JRuby error:
       # TypeError: $stderr must have write method, RSpec::StdErrSplitter given
       def write(line)
-        if line !~ %r{^\S+/gems/\S+:\d+: warning:} # http://rubular.com/r/kqeUIZOfPG
-          @orig_stderr.write(line)
-          @output_tracker.write(line)
-        end
+        return if line =~ %r{^\S+/gems/\S+:\d+: warning:} # http://rubular.com/r/kqeUIZOfPG
+
+        # Ruby 2.7.0 warnings from keyword arguments span multiple lines, extend check above
+        # to look for the next line.
+        return if @last_line =~ %r{^\S+/gems/\S+:\d+: warning:} &&
+                  line =~ %r{warning: The called method .* is defined here}
+
+        # Ruby 2.7.0 complains about hashes used in place of keyword arguments
+        # Aruba 0.14.2 uses this internally triggering that here
+        return if line =~ %r{lib/ruby/2\.7\.0/fileutils\.rb:622: warning:}
+
+        @orig_stderr.write(line)
+        @output_tracker.write(line)
+      ensure
+        @last_line = line
       end
 
       def has_output?
@@ -39,15 +62,14 @@ module RSpec
         @output_tracker = ::StringIO.new
       end
 
-      def verify_example!(example)
-        example.send(:fail,"Warnings were generated: #{output}") if has_output?
+      def verify_no_warnings!
+        raise "Warnings were generated: #{output}" if has_output?
         reset!
       end
 
       def output
         @output_tracker.string
       end
-
     end
   end
 end

data/lib/rspec/support/spec/string_matcher.rb

@@ -0,0 +1,45 @@
+require 'rspec/matchers'
+# Special matcher for comparing encoded strings so that
+# we don't run any expectation failures through the Differ,
+# which also relies on EncodedString. Instead, confirm the
+# strings have the same bytes.
+RSpec::Matchers.define :be_identical_string do |expected|
+  if String.method_defined?(:encoding)
+    match do
+      expected_encoding? &&
+        actual.bytes.to_a == expected.bytes.to_a
+    end
+
+    failure_message do
+      "expected\n#{actual.inspect} (#{actual.encoding.name}) to be identical to\n"\
+        "#{expected.inspect} (#{expected.encoding.name})\n"\
+        "The exact bytes are printed below for more detail:\n"\
+        "#{actual.bytes.to_a}\n"\
+        "#{expected.bytes.to_a}\n"\
+    end
+
+    # Depends on chaining :with_same_encoding for it to
+    # check for string encoding.
+    def expected_encoding?
+      if defined?(@expect_same_encoding) && @expect_same_encoding
+        actual.encoding == expected.encoding
+      else
+        true
+      end
+    end
+  else
+    match do
+      actual.split(//) == expected.split(//)
+    end
+
+    failure_message do
+      "expected\n#{actual.inspect} to be identical to\n#{expected.inspect}\n"
+    end
+  end
+
+  chain :with_same_encoding do
+    @expect_same_encoding ||= true
+  end
+end
+RSpec::Matchers.alias_matcher :a_string_identical_to, :be_identical_string
+RSpec::Matchers.alias_matcher :be_diffed_as, :be_identical_string

data/lib/rspec/support/spec/with_isolated_directory.rb

@@ -0,0 +1,13 @@
+require 'tmpdir'
+
+RSpec.shared_context "isolated directory" do
+  around do |ex|
+    Dir.mktmpdir do |tmp_dir|
+      Dir.chdir(tmp_dir, &ex)
+    end
+  end
+end
+
+RSpec.configure do |c|
+  c.include_context "isolated directory", :isolated_directory => true
+end

data/lib/rspec/support/spec/with_isolated_stderr.rb

@@ -1,7 +1,6 @@
 module RSpec
   module Support
     module WithIsolatedStdErr
-
       def with_isolated_stderr
         original = $stderr
         $stderr = StringIO.new
@@ -9,7 +8,6 @@ module RSpec
       ensure
         $stderr = original
       end
-
     end
   end
 end

data/lib/rspec/support/spec.rb

@@ -1,8 +1,13 @@
 require 'rspec/support'
+require 'rspec/support/spec/in_sub_process'
+
 RSpec::Support.require_rspec_support "spec/deprecation_helpers"
+RSpec::Support.require_rspec_support "spec/diff_helpers"
 RSpec::Support.require_rspec_support "spec/with_isolated_stderr"
 RSpec::Support.require_rspec_support "spec/stderr_splitter"
 RSpec::Support.require_rspec_support "spec/formatting_support"
+RSpec::Support.require_rspec_support "spec/with_isolated_directory"
+RSpec::Support.require_rspec_support "ruby_features"
 
 warning_preventer = $stderr = RSpec::Support::StdErrSplitter.new($stderr)
 
@@ -10,14 +15,15 @@ RSpec.configure do |c|
   c.include RSpecHelpers
   c.include RSpec::Support::WithIsolatedStdErr
   c.include RSpec::Support::FormattingSupport
+  c.include RSpec::Support::InSubProcess
 
   unless defined?(Debugger) # debugger causes warnings when used
     c.before do
       warning_preventer.reset!
     end
 
-    c.after do |example|
-      warning_preventer.verify_example!(example)
+    c.after do
+      warning_preventer.verify_no_warnings!
     end
   end
 
@@ -26,37 +32,51 @@ RSpec.configure do |c|
     c.default_formatter = 'doc'
   end
 
-  c.filter_run :focus
-  c.run_all_when_everything_filtered = true
-end
+  c.filter_run_when_matching :focus
 
-module RSpec::Support::Spec
-  def self.setup_simplecov(&block)
-    # Simplecov emits some ruby warnings when loaded, so silence them.
-    old_verbose, $VERBOSE = $VERBOSE, false
+  c.example_status_persistence_file_path = "./spec/examples.txt"
+
+  c.define_derived_metadata :failing_on_windows_ci do |meta|
+    meta[:pending] ||= "This spec fails on Windows CI and needs someone to fix it."
+  end if RSpec::Support::OS.windows? && ENV['CI']
+end
 
-    return if ENV['NO_COVERAGE'] || RUBY_VERSION < '1.9.3' || RUBY_ENGINE != 'ruby'
+module RSpec
+  module Support
+    module Spec
+      def self.setup_simplecov(&block)
+        # Simplecov emits some ruby warnings when loaded, so silence them.
+        old_verbose, $VERBOSE = $VERBOSE, false
 
-    # Don't load it when we're running a single isolated
-    # test file rather than the whole suite.
-    return if RSpec.configuration.files_to_run.one?
+        return if ENV['NO_COVERAGE'] || RUBY_VERSION < '1.9.3'
+        return if RUBY_ENGINE != 'ruby' || RSpec::Support::OS.windows?
 
-    require 'simplecov'
+        # Don't load it when we're running a single isolated
+        # test file rather than the whole suite.
+        return if RSpec.configuration.files_to_run.one?
 
-    SimpleCov.start do
-      add_filter "./bundle/"
-      add_filter "./tmp/"
-      add_filter do |source_file|
-        # Filter out `spec` directory except when it is under `lib`
-        # (as is the case in rspec-support)
-        source_file.filename.include?('/spec/') && !source_file.filename.include?('/lib/')
+        require 'simplecov'
+        start_simplecov(&block)
+      rescue LoadError
+        warn "Simplecov could not be loaded"
+      ensure
+        $VERBOSE = old_verbose
       end
 
-      instance_eval(&block) if block
+      def self.start_simplecov(&block)
+        SimpleCov.start do
+          add_filter "bundle/"
+          add_filter "tmp/"
+          add_filter do |source_file|
+            # Filter out `spec` directory except when it is under `lib`
+            # (as is the case in rspec-support)
+            source_file.filename.include?('/spec/') && !source_file.filename.include?('/lib/')
+          end
+
+          instance_eval(&block) if block
+        end
+      end
+      private_class_method :start_simplecov
     end
-  rescue LoadError
-  ensure
-    $VERBOSE = old_verbose
   end
 end
-

data/lib/rspec/support/version.rb

@@ -1,7 +1,7 @@
 module RSpec
   module Support
     module Version
-      STRING = '3.0.4'
+      STRING = '3.12.1'
     end
   end
 end

data/lib/rspec/support/warnings.rb

@@ -4,7 +4,7 @@ RSpec::Support.require_rspec_support "caller_filter"
 module RSpec
   module Support
     module Warnings
-      def deprecate(deprecated, options = {})
+      def deprecate(deprecated, options={})
         warn_with "DEPRECATION: #{deprecated} is deprecated.", options
       end
 
@@ -12,7 +12,7 @@ module RSpec
       #
       # Used internally to print deprecation warnings
       # when rspec-core isn't loaded
-      def warn_deprecation(message, options = {})
+      def warn_deprecation(message, options={})
         warn_with "DEPRECATION: \n #{message}", options
       end
 
@@ -26,11 +26,11 @@ module RSpec
       # @private
       #
       # Used internally to print longer warnings
-      def warn_with(message, options = {})
+      def warn_with(message, options={})
         call_site = options.fetch(:call_site) { CallerFilter.first_non_rspec_line }
-        message << " Use #{options[:replacement]} instead." if options[:replacement]
-        message << " Called from #{call_site}." if call_site
-        ::Kernel.warn message
+        message += " Use #{options[:replacement]} instead." if options[:replacement]
+        message += " Called from #{call_site}." if call_site
+        Support.warning_notifier.call message
       end
     end
   end

data/lib/rspec/support/with_keywords_when_needed.rb

@@ -0,0 +1,33 @@
+RSpec::Support.require_rspec_support("method_signature_verifier")
+
+module RSpec
+  module Support
+    module WithKeywordsWhenNeeded
+      # This module adds keyword sensitive support for core ruby methods
+      # where we cannot use `ruby2_keywords` directly.
+
+      module_function
+
+      if RSpec::Support::RubyFeatures.kw_args_supported?
+        # Remove this in RSpec 4 in favour of explicitly passed in kwargs where
+        # this is used. Works around a warning in Ruby 2.7
+
+        def class_exec(klass, *args, &block)
+          if MethodSignature.new(block).has_kw_args_in?(args)
+            binding.eval(<<-CODE, __FILE__, __LINE__)
+            kwargs = args.pop
+            klass.class_exec(*args, **kwargs, &block)
+            CODE
+          else
+            klass.class_exec(*args, &block)
+          end
+        end
+        ruby2_keywords :class_exec if respond_to?(:ruby2_keywords, true)
+      else
+        def class_exec(klass, *args, &block)
+          klass.class_exec(*args, &block)
+        end
+      end
+    end
+  end
+end

data/lib/rspec/support.rb

@@ -14,7 +14,12 @@ module RSpec
     def self.define_optimized_require_for_rspec(lib, &require_relative)
       name = "require_rspec_#{lib}"
 
-      if Kernel.respond_to?(:require_relative)
+      if RUBY_PLATFORM == 'java' && !Kernel.respond_to?(:require)
+        # JRuby 9.1.17.0 has developed a regression for require
+        (class << self; self; end).__send__(:define_method, name) do |f|
+          Kernel.send(:require, "rspec/#{lib}/#{f}")
+        end
+      elsif Kernel.respond_to?(:require_relative)
         (class << self; self; end).__send__(:define_method, name) do |f|
           require_relative.call("#{lib}/#{f}")
         end
@@ -51,7 +56,7 @@ module RSpec
           handle = object.method(method_name)
           raise original unless handle.is_a? Method
           handle
-        rescue Exception
+        rescue Support::AllExceptionsExceptOnesWeMustNotRescue
           raise original
         end
       end
@@ -67,10 +72,89 @@ module RSpec
           handle = object.method(method_name)
           raise original unless handle.is_a? Method
           handle
-        rescue Exception
+        rescue Support::AllExceptionsExceptOnesWeMustNotRescue
           raise original
         end
       end
     end
+
+    # @api private
+    #
+    # Used internally to get a class of a given object, even if it does not respond to #class.
+    def self.class_of(object)
+      object.class
+    rescue NoMethodError
+      singleton_class = class << object; self; end
+      singleton_class.ancestors.find { |ancestor| !ancestor.equal?(singleton_class) }
+    end
+
+    # A single thread local variable so we don't excessively pollute that namespace.
+    if RUBY_VERSION.to_f >= 2
+      def self.thread_local_data
+        Thread.current.thread_variable_get(:__rspec) || Thread.current.thread_variable_set(:__rspec, {})
+      end
+    else
+      def self.thread_local_data
+        Thread.current[:__rspec] ||= {}
+      end
+    end
+
+    # @api private
+    def self.failure_notifier=(callable)
+      thread_local_data[:failure_notifier] = callable
+    end
+
+    # @private
+    DEFAULT_FAILURE_NOTIFIER = lambda { |failure, _opts| raise failure }
+
+    # @api private
+    def self.failure_notifier
+      thread_local_data[:failure_notifier] || DEFAULT_FAILURE_NOTIFIER
+    end
+
+    # @api private
+    def self.notify_failure(failure, options={})
+      failure_notifier.call(failure, options)
+    end
+
+    # @api private
+    def self.with_failure_notifier(callable)
+      orig_notifier = failure_notifier
+      self.failure_notifier = callable
+      yield
+    ensure
+      self.failure_notifier = orig_notifier
+    end
+
+    class << self
+      # @api private
+      attr_writer :warning_notifier
+    end
+
+    # @private
+    DEFAULT_WARNING_NOTIFIER = lambda { |warning| ::Kernel.warn warning }
+
+    # @api private
+    def self.warning_notifier
+      @warning_notifier ||= DEFAULT_WARNING_NOTIFIER
+    end
+
+    # @private
+    module AllExceptionsExceptOnesWeMustNotRescue
+      # These exceptions are dangerous to rescue as rescuing them
+      # would interfere with things we should not interfere with.
+      AVOID_RESCUING = [NoMemoryError, SignalException, Interrupt, SystemExit]
+
+      def self.===(exception)
+        AVOID_RESCUING.none? { |ar| ar === exception }
+      end
+    end
+
+    # The Differ is only needed when a spec fails with a diffable failure.
+    # In the more common case of all specs passing or the only failures being
+    # non-diffable, we can avoid the extra cost of loading the differ, diff-lcs,
+    # pp, etc by avoiding an unnecessary require. Instead, autoload will take
+    # care of loading the differ on first use.
+    autoload :Differ, "rspec/support/differ"
   end
 end