rspec-core 3.5.4 → 3.9.0

data/lib/rspec/core/bisect/server.rb

@@ -1,13 +1,11 @@
 require 'drb/drb'
 require 'drb/acl'
+RSpec::Support.require_rspec_core "bisect/utilities"
 
 module RSpec
   module Core
     # @private
     module Bisect
-      # @private
-      BisectFailedError = Class.new(StandardError)
-
       # @private
       # A DRb server that receives run results from a separate RSpec process
       # started by the bisect process.
@@ -25,12 +23,17 @@ module RSpec
           self.files_or_directories_to_run = files_or_directories_to_run
           self.latest_run_results = nil
           run_output = yield
-          latest_run_results || raise_bisect_failed(run_output)
+
+          if latest_run_results.nil? || latest_run_results.all_example_ids.empty?
+            raise BisectFailedError.for_failed_spec_run(run_output)
+          end
+
+          latest_run_results
         end
 
         def start
           # Only allow remote DRb requests from this machine.
-          DRb.install_acl ACL.new(%w[ deny all allow localhost allow 127.0.0.1 ])
+          DRb.install_acl ACL.new(%w[ deny all allow localhost allow 127.0.0.1 allow ::1 ])
 
           # We pass `nil` as the first arg to allow it to pick a DRb port.
           @drb = DRb.start_service(nil, self)
@@ -44,21 +47,14 @@ module RSpec
           @drb_port ||= Integer(@drb.uri[/\d+$/])
         end
 
-        # Fetched via DRb by the BisectFormatter to determine when to abort.
+        # Fetched via DRb by the BisectDRbFormatter to determine when to abort.
         attr_accessor :expected_failures
 
-        # Set via DRb by the BisectFormatter with the results of the run.
+        # Set via DRb by the BisectDRbFormatter with the results of the run.
         attr_accessor :latest_run_results
 
         # Fetched via DRb to tell clients which files to run
         attr_accessor :files_or_directories_to_run
-
-      private
-
-        def raise_bisect_failed(run_output)
-          raise BisectFailedError, "Failed to get results from the spec " \
-                "run. Spec run output:\n\n#{run_output}"
-        end
       end
     end
   end

data/lib/rspec/core/bisect/{runner.rb → shell_command.rb}

@@ -1,36 +1,30 @@
 RSpec::Support.require_rspec_core "shell_escape"
-require 'open3'
 require 'shellwords'
 
 module RSpec
   module Core
     module Bisect
-      # Provides an API to run the suite for a set of locations, using
-      # the given bisect server to capture the results.
+      # Provides an API to generate shell commands to run the suite for a
+      # set of locations, using the given bisect server to capture the results.
       # @private
-      class Runner
+      class ShellCommand
         attr_reader :original_cli_args
 
-        def initialize(server, original_cli_args)
-          @server            = server
+        def initialize(original_cli_args)
           @original_cli_args = original_cli_args.reject { |arg| arg.start_with?("--bisect") }
         end
 
-        def run(locations)
-          run_locations(locations, original_results.failed_example_ids)
-        end
-
-        def command_for(locations)
+        def command_for(locations, server)
           parts = []
 
           parts << RUBY << load_path
           parts << open3_safe_escape(RSpec::Core.path_to_executable)
 
-          parts << "--format"   << "bisect"
-          parts << "--drb-port" << @server.drb_port
+          parts << "--format"   << "bisect-drb"
+          parts << "--drb-port" << server.drb_port
 
-          parts.concat reusable_cli_options
-          parts.concat locations.map { |l| open3_safe_escape(l) }
+          parts.concat(reusable_cli_options)
+          parts.concat(locations.map { |l| open3_safe_escape(l) })
 
           parts.join(" ")
         end
@@ -46,8 +40,24 @@ module RSpec
           parts.join(" ")
         end
 
-        def original_results
-          @original_results ||= run_locations(original_locations)
+        def original_locations
+          parsed_original_cli_options.fetch(:files_or_directories_to_run)
+        end
+
+        def bisect_environment_hash
+          if ENV.key?('SPEC_OPTS')
+            { 'SPEC_OPTS' => spec_opts_without_bisect }
+          else
+            {}
+          end
+        end
+
+        def spec_opts_without_bisect
+          Shellwords.join(
+            Shellwords.split(ENV.fetch('SPEC_OPTS', '')).reject do |arg|
+              arg =~ /^--bisect/
+            end
+          )
         end
 
       private
@@ -63,61 +73,12 @@ module RSpec
           alias open3_safe_escape escape
         end
 
-        def run_locations(*capture_args)
-          @server.capture_run_results(*capture_args) do
-            run_command command_for([])
-          end
-        end
-
-        # `Open3.capture2e` does not work on JRuby:
-        # https://github.com/jruby/jruby/issues/2766
-        if Open3.respond_to?(:capture2e) && !RSpec::Support::Ruby.jruby?
-          def run_command(cmd)
-            Open3.capture2e(bisect_environment_hash, cmd).first
-          end
-        else # for 1.8.7
-          # :nocov:
-          def run_command(cmd)
-            out = err = nil
-
-            original_spec_opts = ENV['SPEC_OPTS']
-            ENV['SPEC_OPTS'] = spec_opts_without_bisect
-
-            Open3.popen3(cmd) do |_, stdout, stderr|
-              # Reading the streams blocks until the process is complete
-              out = stdout.read
-              err = stderr.read
-            end
-
-            "Stdout:\n#{out}\n\nStderr:\n#{err}"
-          ensure
-            ENV['SPEC_OPTS'] = original_spec_opts
-          end
-          # :nocov:
-        end
-
-        def bisect_environment_hash
-          if ENV.key?('SPEC_OPTS')
-            { 'SPEC_OPTS' => spec_opts_without_bisect }
-          else
-            {}
-          end
-        end
-
         def environment_repro_parts
           bisect_environment_hash.map do |k, v|
             %Q(#{k}="#{v}")
           end
         end
 
-        def spec_opts_without_bisect
-          Shellwords.join(
-            Shellwords.split(ENV.fetch('SPEC_OPTS', '')).reject do |arg|
-              arg =~ /^--bisect/
-            end
-          )
-        end
-
         def reusable_cli_options
           @reusable_cli_options ||= begin
             opts = original_cli_args_without_locations
@@ -146,10 +107,6 @@ module RSpec
           @parsed_original_cli_options ||= Parser.parse(@original_cli_args)
         end
 
-        def original_locations
-          parsed_original_cli_options.fetch(:files_or_directories_to_run)
-        end
-
         def load_path
           @load_path ||= "-I#{$LOAD_PATH.map { |p| open3_safe_escape(p) }.join(':')}"
         end

data/lib/rspec/core/bisect/shell_runner.rb

@@ -0,0 +1,73 @@
+require 'open3'
+RSpec::Support.require_rspec_core "bisect/server"
+
+module RSpec
+  module Core
+    module Bisect
+      # Provides an API to run the suite for a set of locations, using
+      # the given bisect server to capture the results.
+      #
+      # Sets of specs are run by shelling out.
+      # @private
+      class ShellRunner
+        def self.start(shell_command, _spec_runner)
+          Server.run do |server|
+            yield new(server, shell_command)
+          end
+        end
+
+        def self.name
+          :shell
+        end
+
+        def initialize(server, shell_command)
+          @server        = server
+          @shell_command = shell_command
+        end
+
+        def run(locations)
+          run_locations(locations, original_results.failed_example_ids)
+        end
+
+        def original_results
+          @original_results ||= run_locations(@shell_command.original_locations)
+        end
+
+      private
+
+        def run_locations(*capture_args)
+          @server.capture_run_results(*capture_args) do
+            run_command @shell_command.command_for([], @server)
+          end
+        end
+
+        # `Open3.capture2e` does not work on JRuby:
+        # https://github.com/jruby/jruby/issues/2766
+        if Open3.respond_to?(:capture2e) && !RSpec::Support::Ruby.jruby?
+          def run_command(cmd)
+            Open3.capture2e(@shell_command.bisect_environment_hash, cmd).first
+          end
+        else # for 1.8.7
+          # :nocov:
+          def run_command(cmd)
+            out = err = nil
+
+            original_spec_opts = ENV['SPEC_OPTS']
+            ENV['SPEC_OPTS'] = @shell_command.spec_opts_without_bisect
+
+            Open3.popen3(cmd) do |_, stdout, stderr|
+              # Reading the streams blocks until the process is complete
+              out = stdout.read
+              err = stderr.read
+            end
+
+            "Stdout:\n#{out}\n\nStderr:\n#{err}"
+          ensure
+            ENV['SPEC_OPTS'] = original_spec_opts
+          end
+          # :nocov:
+        end
+      end
+    end
+  end
+end

data/lib/rspec/core/bisect/utilities.rb

@@ -0,0 +1,58 @@
+module RSpec
+  module Core
+    module Bisect
+      # @private
+      ExampleSetDescriptor = Struct.new(:all_example_ids, :failed_example_ids)
+
+      # @private
+      class BisectFailedError < StandardError
+        def self.for_failed_spec_run(spec_output)
+          new("Failed to get results from the spec run. Spec run output:\n\n" +
+              spec_output)
+        end
+      end
+
+      # Wraps a `formatter` providing a simple means to notify it in place
+      # of an `RSpec::Core::Reporter`, without involving configuration in
+      # any way.
+      # @private
+      class Notifier
+        def initialize(formatter)
+          @formatter = formatter
+        end
+
+        def publish(event, *args)
+          return unless @formatter.respond_to?(event)
+          notification = Notifications::CustomNotification.for(*args)
+          @formatter.__send__(event, notification)
+        end
+      end
+
+      # Wraps a pipe to support sending objects between a child and
+      # parent process.
+      # @private
+      class Channel
+        def initialize
+          @read_io, @write_io = IO.pipe
+        end
+
+        def send(message)
+          packet = Marshal.dump(message)
+          @write_io.write("#{packet.bytesize}\n#{packet}")
+        end
+
+        # rubocop:disable Security/MarshalLoad
+        def receive
+          packet_size = Integer(@read_io.gets)
+          Marshal.load(@read_io.read(packet_size))
+        end
+        # rubocop:enable Security/MarshalLoad
+
+        def close
+          @read_io.close
+          @write_io.close
+        end
+      end
+    end
+  end
+end

data/lib/rspec/core/configuration.rb

@@ -1,6 +1,7 @@
 RSpec::Support.require_rspec_core "backtrace_formatter"
 RSpec::Support.require_rspec_core "ruby_project"
 RSpec::Support.require_rspec_core "formatters/deprecation_formatter"
+RSpec::Support.require_rspec_core "output_wrapper"
 
 module RSpec
   module Core
@@ -8,10 +9,24 @@ module RSpec
 
     # Stores runtime configuration information.
     #
-    # Configuration options are loaded from `~/.rspec`, `.rspec`,
-    # `.rspec-local`, command line switches, and the `SPEC_OPTS` environment
-    # variable (listed in lowest to highest precedence; for example, an option
-    # in `~/.rspec` can be overridden by an option in `.rspec-local`).
+    # Configuration options are loaded from multiple files and joined together
+    # with command-line switches and the `SPEC_OPTS` environment variable.
+    #
+    # Precedence order (where later entries overwrite earlier entries on
+    # conflicts):
+    #
+    #   * Global (`$XDG_CONFIG_HOME/rspec/options`, or `~/.rspec` if it does
+    #     not exist)
+    #   * Project-specific (`./.rspec`)
+    #   * Local (`./.rspec-local`)
+    #   * Command-line options
+    #   * `SPEC_OPTS`
+    #
+    # For example, an option set in the local file will override an option set
+    # in your global file.
+    #
+    # The global, project-specific and local files can all be overridden with a
+    # separate custom file using the --options command-line parameter.
     #
     # @example Standard settings
     #     RSpec.configure do |c|
@@ -88,7 +103,6 @@ module RSpec
 
       # @macro [attach] add_setting
       #   @!attribute [rw] $1
-      #   @!method $1=(value)
       #
       # @macro [attach] define_reader
       #   @!attribute [r] $1
@@ -100,6 +114,7 @@ module RSpec
       #
       # @note Other scripts invoking `rspec` indirectly will ignore this
       #   setting.
+      # @return [String]
       add_read_only_setting :default_path
       def default_path=(path)
         project_source_dirs << path
@@ -109,6 +124,7 @@ module RSpec
       # @macro add_setting
       # Run examples over DRb (default: `false`). RSpec doesn't supply the DRb
       # server, but you can use tools like spork.
+      # @return [Boolean]
       add_setting :drb
 
       # @macro add_setting
@@ -121,6 +137,7 @@ module RSpec
 
       # Indicates if the DSL has been exposed off of modules and `main`.
       # Default: true
+      # @return [Boolean]
       def expose_dsl_globally?
         Core::DSL.exposed_globally?
       end
@@ -141,7 +158,7 @@ module RSpec
 
       # Determines where deprecation warnings are printed.
       # Defaults to `$stderr`.
-      # @return [IO, String] IO to write to or filename to write to
+      # @return [IO, String] IO or filename to write to
       define_reader :deprecation_stream
 
       # Determines where deprecation warnings are printed.
@@ -160,7 +177,7 @@ module RSpec
 
       # @macro define_reader
       # The file path to use for persisting example statuses. Necessary for the
-      # `--only-failures` and `--next-failures` CLI options.
+      # `--only-failures` and `--next-failure` CLI options.
       #
       # @overload example_status_persistence_file_path
       #   @return [String] the file path
@@ -169,7 +186,7 @@ module RSpec
       define_reader :example_status_persistence_file_path
 
       # Sets the file path to use for persisting example statuses. Necessary for the
-      # `--only-failures` and `--next-failures` CLI options.
+      # `--only-failures` and `--next-failure` CLI options.
       def example_status_persistence_file_path=(value)
         @example_status_persistence_file_path = value
         clear_values_derived_from_example_status_persistence_file_path
@@ -185,10 +202,33 @@ module RSpec
         only_failures? && !example_status_persistence_file_path
       end
 
-      # @macro add_setting
+      # @macro define_reader
       # If specified, indicates the number of failures required before cleaning
-      # up and exit (default: `nil`).
-      add_setting :fail_fast
+      # up and exit (default: `nil`). Can also be `true` to fail and exit on first
+      # failure
+      define_reader :fail_fast
+
+      # @see fail_fast
+      def fail_fast=(value)
+        case value
+        when true, 'true'
+          @fail_fast = true
+        when false, 'false', 0
+          @fail_fast = false
+        when nil
+          @fail_fast = nil
+        else
+          @fail_fast = value.to_i
+
+          if value.to_i == 0
+            # TODO: in RSpec 4, consider raising an error here.
+            RSpec.warning "Cannot set `RSpec.configuration.fail_fast`" \
+              " to `#{value.inspect}`. Only `true`, `false`, `nil` and integers" \
+              " are valid values."
+            @fail_fast = true
+          end
+        end
+      end
 
       # @macro add_setting
       # Prints the formatter output of your suite without running any
@@ -197,24 +237,33 @@ module RSpec
 
       # @macro add_setting
       # The exit code to return if there are any failures (default: 1).
+      # @return [Integer]
       add_setting :failure_exit_code
 
+      # @macro add_setting
+      # Whether or not to fail when there are no RSpec examples (default: false).
+      # @return [Boolean]
+      add_setting :fail_if_no_examples
+
       # @macro define_reader
       # Indicates files configured to be required.
+      # @return [Array<String>]
       define_reader :requires
 
       # @macro define_reader
       # Returns dirs that have been prepended to the load path by the `-I`
       # command line option.
+      # @return [Array<String>]
       define_reader :libs
 
       # @macro add_setting
       # Determines where RSpec will send its output.
       # Default: `$stdout`.
+      # @return [IO, String]
       define_reader :output_stream
 
       # Set the output stream for reporter.
-      # @attr value [IO] value for output, defaults to $stdout
+      # @attr value [IO, String] IO to write to or filename to write to, defaults to $stdout
       def output_stream=(value)
         if @reporter && !value.equal?(@output_stream)
           warn "RSpec's reporter has already been initialized with " \
@@ -223,11 +272,13 @@ module RSpec
             "it to take effect. (Called from #{CallerFilter.first_non_rspec_line})"
         else
           @output_stream = value
+          output_wrapper.output = @output_stream
         end
       end
 
       # @macro define_reader
       # Load files matching this pattern (default: `'**{,/*/**}/*_spec.rb'`).
+      # @return [String]
       define_reader :pattern
 
       # Set pattern to match files to load.
@@ -238,6 +289,7 @@ module RSpec
 
       # @macro define_reader
       # Exclude files matching this pattern.
+      # @return [String]
       define_reader :exclude_pattern
 
       # Set pattern to match files to exclude.
@@ -259,6 +311,7 @@ module RSpec
       # @macro add_setting
       # Report the times for the slowest examples (default: `false`).
       # Use this to specify the number of examples to include in the profile.
+      # @return [Boolean]
       add_setting :profile_examples
 
       # @macro add_setting
@@ -269,55 +322,56 @@ module RSpec
       add_setting :run_all_when_everything_filtered
 
       # @macro add_setting
-      # Color to use to indicate success.
-      # @param color [Symbol] defaults to `:green` but can be set to one of the
-      #   following: `[:black, :white, :red, :green, :yellow, :blue, :magenta,
-      #   :cyan]`
+      # Color to use to indicate success.  Defaults to `:green` but can be set
+      # to one of the following: `[:black, :white, :red, :green, :yellow,
+      # :blue, :magenta, :cyan]`
+      # @return [Symbol]
       add_setting :success_color
 
       # @macro add_setting
-      # Color to use to print pending examples.
-      # @param color [Symbol] defaults to `:yellow` but can be set to one of the
-      #   following: `[:black, :white, :red, :green, :yellow, :blue, :magenta,
-      #   :cyan]`
+      # Color to use to print pending examples.  Defaults to `:yellow` but can
+      # be set to one of the following: `[:black, :white, :red, :green,
+      # :yellow, :blue, :magenta, :cyan]`
+      # @return [Symbol]
       add_setting :pending_color
 
       # @macro add_setting
-      # Color to use to indicate failure.
-      # @param color [Symbol] defaults to `:red` but can be set to one of the
-      #   following: `[:black, :white, :red, :green, :yellow, :blue, :magenta,
-      #   :cyan]`
+      # Color to use to indicate failure.  Defaults to `:red` but can be set to
+      # one of the following: `[:black, :white, :red, :green, :yellow, :blue,
+      # :magenta, :cyan]`
+      # @return [Symbol]
       add_setting :failure_color
 
       # @macro add_setting
-      # The default output color.
-      # @param color [Symbol] defaults to `:white` but can be set to one of the
-      #   following: `[:black, :white, :red, :green, :yellow, :blue, :magenta,
-      #   :cyan]`
+      # The default output color. Defaults to `:white` but can be set to one of
+      # the following: `[:black, :white, :red, :green, :yellow, :blue,
+      # :magenta, :cyan]`
+      # @return [Symbol]
       add_setting :default_color
 
       # @macro add_setting
-      # Color used when a pending example is fixed.
-      # @param color [Symbol] defaults to `:blue` but can be set to one of the
-      #   following: `[:black, :white, :red, :green, :yellow, :blue, :magenta,
-      #   :cyan]`
+      # Color used when a pending example is fixed. Defaults to `:blue` but can
+      # be set to one of the following: `[:black, :white, :red, :green,
+      # :yellow, :blue, :magenta, :cyan]`
+      # @return [Symbol]
       add_setting :fixed_color
 
       # @macro add_setting
-      # Color used to print details.
-      # @param color [Symbol] defaults to `:cyan` but can be set to one of the
-      #   following: `[:black, :white, :red, :green, :yellow, :blue, :magenta,
-      #   :cyan]`
+      # Color used to print details.  Defaults to `:cyan` but can be set to one
+      # of the following: `[:black, :white, :red, :green, :yellow, :blue,
+      # :magenta, :cyan]`
+      # @return [Symbol]
       add_setting :detail_color
 
       # @macro add_setting
       # Don't print filter info i.e. "Run options: include {:focus=>true}"
       # (default `false`).
+      # return [Boolean]
       add_setting :silence_filter_announcements
 
-      # Deprecated. This config option was added in RSpec 2 to pave the way
-      # for this being the default behavior in RSpec 3. Now this option is
-      # a no-op.
+      # @deprecated This config option was added in RSpec 2 to pave the way
+      #   for this being the default behavior in RSpec 3. Now this option is
+      #   a no-op.
       def treat_symbols_as_metadata_keys_with_true_values=(_value)
         RSpec.deprecate(
           "RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values=",
@@ -381,19 +435,55 @@ module RSpec
       end
 
       # Record the start time of the spec suite to measure load time.
+      # return [Time]
       add_setting :start_time
 
       # @macro add_setting
       # Use threadsafe options where available.
       # Currently this will place a mutex around memoized values such as let blocks.
+      # return [Boolean]
       add_setting :threadsafe
 
       # @macro add_setting
       # Maximum count of failed source lines to display in the failure reports.
       # (default `10`).
+      # return [Integer]
       add_setting :max_displayed_failure_line_count
 
+      # Determines which bisect runner implementation gets used to run subsets
+      # of the suite during a bisection. Your choices are:
+      #
+      #   - `:shell`: Performs a spec run by shelling out, booting RSpec and your
+      #     application environment each time. This runner is the most widely
+      #     compatible runner, but is not as fast. On platforms that do not
+      #     support forking, this is the default.
+      #   - `:fork`: Pre-boots RSpec and your application environment in a parent
+      #     process, and then forks a child process for each spec run. This runner
+      #     tends to be significantly faster than the `:shell` runner but cannot
+      #     be used in some situations. On platforms that support forking, this
+      #     is the default. If you use this runner, you should ensure that all
+      #     of your one-time setup logic goes in a `before(:suite)` hook instead
+      #     of getting run at the top-level of a file loaded by `--require`.
+      #
+      # @note This option will only be used by `--bisect` if you set it in a file
+      #   loaded via `--require`.
+      #
+      # @return [Symbol]
+      attr_reader :bisect_runner
+      def bisect_runner=(value)
+        if @bisect_runner_class && value != @bisect_runner
+          raise "`config.bisect_runner = #{value.inspect}` can no longer take " \
+            "effect as the #{@bisect_runner.inspect} bisect runnner is already " \
+            "in use. This config setting must be set in a file loaded by a " \
+            "`--require` option (passed at the CLI or in a `.rspec` file) for " \
+            "it to have any effect."
+        end
+
+        @bisect_runner = value
+      end
+
       # @private
+      # @deprecated Use {#color_mode} = :on, instead of {#color} with {#tty}
       add_setting :tty
       # @private
       attr_writer :files_to_run
@@ -404,8 +494,9 @@ module RSpec
       # @private
       attr_reader :backtrace_formatter, :ordering_manager, :loaded_spec_files
 
-      # rubocop:disable Metrics/AbcSize
-      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+
+      # Build an object to store runtime configuration options and set defaults
       def initialize
         # rubocop:disable Style/GlobalVars
         @start_time = $_rspec_core_load_started_at || ::RSpec::Core::Time.now
@@ -415,6 +506,9 @@ module RSpec
         @extend_modules  = FilterableItemRepository::QueryOptimized.new(:any?)
         @prepend_modules = FilterableItemRepository::QueryOptimized.new(:any?)
 
+        @bisect_runner = RSpec::Support::RubyFeatures.fork_supported? ? :fork : :shell
+        @bisect_runner_class = nil
+
         @before_suite_hooks = []
         @after_suite_hooks  = []
 
@@ -422,9 +516,11 @@ module RSpec
         @files_or_directories_to_run = []
         @loaded_spec_files = Set.new
         @color = false
+        @color_mode = :automatic
         @pattern = '**{,/*/**}/*_spec.rb'
         @exclude_pattern = ''
         @failure_exit_code = 1
+        @fail_if_no_examples = false
         @spec_files_loaded = false
 
         @backtrace_formatter = BacktraceFormatter.new
@@ -456,8 +552,7 @@ module RSpec
 
         define_built_in_hooks
       end
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
       # @private
       #
@@ -473,8 +568,14 @@ module RSpec
       # @private
       def reset
         @spec_files_loaded = false
+        reset_reporter
+      end
+
+      # @private
+      def reset_reporter
         @reporter = nil
         @formatter_loader = nil
+        @output_wrapper = nil
       end
 
       # @private
@@ -532,6 +633,7 @@ module RSpec
       end
 
       # Returns the configured mock framework adapter module.
+      # @return [Symbol]
       def mock_framework
         if @mock_framework.nil?
           begin
@@ -559,12 +661,13 @@ module RSpec
       # To override this behaviour and display a full backtrace, use
       # `--backtrace` on the command line, in a `.rspec` file, or in the
       # `rspec_options` attribute of RSpec's rake task.
+      # @return [Array<Regexp>]
       def backtrace_exclusion_patterns
         @backtrace_formatter.exclusion_patterns
       end
 
       # Set regular expressions used to exclude lines in backtrace.
-      # @param patterns [Regexp] set the backtrace exlusion pattern
+      # @param patterns [Array<Regexp>] set backtrace_formatter exlusion_patterns
       def backtrace_exclusion_patterns=(patterns)
         @backtrace_formatter.exclusion_patterns = patterns
       end
@@ -577,12 +680,13 @@ module RSpec
       # will be included.
       #
       # You can modify the list via the getter, or replace it with the setter.
+      # @return [Array<Regexp>]
       def backtrace_inclusion_patterns
         @backtrace_formatter.inclusion_patterns
       end
 
       # Set regular expressions used to include lines in backtrace.
-      # @attr patterns [Regexp] set backtrace_formatter inclusion_patterns
+      # @attr patterns [Array<Regexp>] set backtrace_formatter inclusion_patterns
       def backtrace_inclusion_patterns=(patterns)
         @backtrace_formatter.inclusion_patterns = patterns
       end
@@ -773,24 +877,54 @@ module RSpec
         @backtrace_formatter.full_backtrace = true_or_false
       end
 
-      # Returns the configuration option for color, but should not
-      # be used to check if color is supported.
+      # Enables color output if the output is a TTY.  As of RSpec 3.6, this is
+      # the default behavior and this option is retained only for backwards
+      # compatibility.
       #
+      # @deprecated No longer recommended because of complex behavior. Instead,
+      #   rely on the fact that TTYs will display color by default, or set
+      #   {#color_mode} to :on to display color on a non-TTY output.
+      # @see color_mode
       # @see color_enabled?
       # @return [Boolean]
       def color
         value_for(:color) { @color }
       end
 
+      # The mode for determining whether to display output in color. One of:
+      #
+      # - :automatic - the output will be in color if the output is a TTY (the
+      #   default)
+      # - :on - the output will be in color, whether or not the output is a TTY
+      # - :off - the output will not be in color
+      #
+      # @see color_enabled?
+      # @return [Boolean]
+      def color_mode
+        value_for(:color_mode) { @color_mode }
+      end
+
       # Check if color is enabled for a particular output.
       # @param output [IO] an output stream to use, defaults to the current
       #        `output_stream`
       # @return [Boolean]
       def color_enabled?(output=output_stream)
-        output_to_tty?(output) && color
+        case color_mode
+        when :on then true
+        when :off then false
+        else # automatic
+          output_to_tty?(output) || (color && tty?)
+        end
       end
 
+      # Set the color mode.
+      attr_writer :color_mode
+
       # Toggle output color.
+      #
+      # @deprecated No longer recommended because of complex behavior. Instead,
+      #   rely on the fact that TTYs will display color by default, or set
+      #   {:color_mode} to :on to display color on a non-TTY output.
       attr_writer :color
 
       # @private
@@ -813,19 +947,22 @@ module RSpec
       end
 
       # @overload add_formatter(formatter)
+      # @overload add_formatter(formatter, output)
       #
-      # Adds a formatter to the formatters collection. `formatter` can be a
-      # string representing any of the built-in formatters (see
-      # `built_in_formatter`), or a custom formatter class.
+      # @param formatter [Class, String, Object] formatter to use. Can be any of the
+      #   string values supported from the CLI (`p`/`progress`,
+      #   `d`/`doc`/`documentation`, `h`/`html`, or `j`/`json`), any
+      #   class that implements the formatter protocol and has registered
+      #   itself with RSpec as a formatter, or a formatter instance.
+      # @param output [String, IO] where the formatter will write its output.
+      #   Can be an IO object or a string path to a file. If not provided,
+      #   the configured `output_stream` (`$stdout`, by default) will be used.
       #
-      # ### Note
+      # Adds a formatter to the set RSpec will use for this run.
       #
-      # For internal purposes, `add_formatter` also accepts the name of a class
-      # and paths to use for output streams, but you should consider that a
-      # private api that may change at any time without notice.
-      def add_formatter(formatter_to_use, *paths)
-        paths << output_stream if paths.empty?
-        formatter_loader.add formatter_to_use, *paths
+      # @see RSpec::Core::Formatters::Protocol
+      def add_formatter(formatter, output=output_wrapper)
+        formatter_loader.add(formatter, output)
       end
       alias_method :formatter=, :add_formatter
 
@@ -890,7 +1027,7 @@ module RSpec
         @reporter_buffer || @reporter ||=
           begin
             @reporter_buffer = DeprecationReporterBuffer.new
-            formatter_loader.setup_default output_stream, deprecation_stream
+            formatter_loader.prepare_default output_wrapper, deprecation_stream
             @reporter_buffer.play_onto(formatter_loader.reporter)
             @reporter_buffer = nil
             formatter_loader.reporter
@@ -934,7 +1071,9 @@ module RSpec
           if (path = example_status_persistence_file_path)
             begin
               ExampleStatusPersister.load_from(path).inject(statuses) do |hash, example|
-                hash[example.fetch(:example_id)] = example.fetch(:status)
+                status = example[:status]
+                status = UNKNOWN_STATUS unless VALID_STATUSES.include?(status)
+                hash[example.fetch(:example_id)] = status
                 hash
               end
             rescue SystemCallError => e
@@ -954,6 +1093,15 @@ module RSpec
       # @private
       FAILED_STATUS = "failed".freeze
 
+      # @private
+      PASSED_STATUS = "passed".freeze
+
+      # @private
+      PENDING_STATUS = "pending".freeze
+
+      # @private
+      VALID_STATUSES = [UNKNOWN_STATUS, FAILED_STATUS, PASSED_STATUS, PENDING_STATUS]
+
       # @private
       def spec_files_with_failures
         @spec_files_with_failures ||= last_run_statuses.inject(Set.new) do |files, (id, status)|
@@ -981,7 +1129,7 @@ module RSpec
       #
       #   # This lets you do this:
       #
-      #   describe Thing do
+      #   RSpec.describe Thing do
       #     pending "does something" do
       #       thing = Thing.new
       #     end
@@ -989,7 +1137,7 @@ module RSpec
       #
       #   # ... which is the equivalent of
       #
-      #   describe Thing do
+      #   RSpec.describe Thing do
       #     it "does something", :pending => true do
       #       thing = Thing.new
       #     end
@@ -1042,7 +1190,7 @@ module RSpec
       #
       #   # allows the user to include a shared example group like:
       #
-      #   describe Entity do
+      #   RSpec.describe Entity do
       #     it_has_behavior 'sortability' do
       #       let(:sortable) { Entity.new }
       #     end
@@ -1391,7 +1539,7 @@ module RSpec
       def requires=(paths)
         directories = ['lib', default_path].select { |p| File.directory? p }
         RSpec::Core::RubyProject.add_to_load_path(*directories)
-        paths.each { |path| require path }
+        paths.each { |path| load_file_handling_errors(:require, path) }
         @requires += paths
       end
 
@@ -1432,7 +1580,7 @@ module RSpec
 
         files_to_run.uniq.each do |f|
           file = File.expand_path(f)
-          load file
+          load_file_handling_errors(:load, file)
           loaded_spec_files << file
         end
 
@@ -1460,8 +1608,6 @@ module RSpec
       end
 
       # @private
-      # @macro [attach] delegate_to_ordering_manager
-      #   @!method $1
       def self.delegate_to_ordering_manager(*methods)
         methods.each do |method|
           define_method method do |*args, &block|
@@ -1470,12 +1616,12 @@ module RSpec
         end
       end
 
-      # @macro delegate_to_ordering_manager
+      # @!method seed=(value)
       #
       # Sets the seed value and sets the default global ordering to random.
       delegate_to_ordering_manager :seed=
 
-      # @macro delegate_to_ordering_manager
+      # @!method seed
       # Seed for random ordering (default: generated randomly each run).
       #
       # When you run specs with `--order random`, RSpec generates a random seed
@@ -1489,7 +1635,7 @@ module RSpec
       # don't accidentally leave the seed encoded.
       delegate_to_ordering_manager :seed
 
-      # @macro delegate_to_ordering_manager
+      # @!method order=(value)
       #
       # Sets the default global ordering strategy. By default this can be one
       # of `:defined`, `:random`, but is customizable through the
@@ -1499,7 +1645,8 @@ module RSpec
       # @see #register_ordering
       delegate_to_ordering_manager :order=
 
-      # @macro delegate_to_ordering_manager
+      # @!method register_ordering(name)
+      #
       # Registers a named ordering strategy that can later be
       # used to order an example group's subgroups by adding
       # `:order => <name>` metadata to the example group.
@@ -1594,7 +1741,7 @@ module RSpec
       #     rspec.expose_current_running_example_as :example
       #   end
       #
-      #   describe MyClass do
+      #   RSpec.describe MyClass do
       #     before do
       #       # `example` can be used here because of the above config.
       #       do_something if example.metadata[:type] == "foo"
@@ -1658,7 +1805,7 @@ module RSpec
       #       mocks.patch_marshal_to_support_partial_doubles = false
       #     end
       #
-      #     config.mock_with :rspec do |expectations|
+      #     config.expect_with :rspec do |expectations|
       #       expectations.syntax = :expect
       #     end
       #   end
@@ -1712,7 +1859,7 @@ module RSpec
       #       require 'support/db'
       #     end
       #   end
-      def when_first_matching_example_defined(*filters, &block)
+      def when_first_matching_example_defined(*filters)
         specified_meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)
 
         callback = lambda do |example_or_group_meta|
@@ -1721,9 +1868,9 @@ module RSpec
           return unless example_or_group_meta.key?(:example_group)
 
           # Ensure the callback only fires once.
-          @derived_metadata_blocks.items_for(specified_meta).delete(callback)
+          @derived_metadata_blocks.delete(callback, specified_meta)
 
-          block.call
+          yield
         end
 
         @derived_metadata_blocks.append(callback, specified_meta)
@@ -1731,9 +1878,28 @@ module RSpec
 
       # @private
       def apply_derived_metadata_to(metadata)
-        @derived_metadata_blocks.items_for(metadata).each do |block|
-          block.call(metadata)
+        already_run_blocks = Set.new
+
+        # We loop and attempt to re-apply metadata blocks to support cascades
+        # (e.g. where a derived bit of metadata triggers the application of
+        # another piece of derived metadata, etc)
+        #
+        # We limit our looping to 200 times as a way to detect infinitely recursing derived metadata blocks.
+        # It's hard to imagine a valid use case for a derived metadata cascade greater than 200 iterations.
+        200.times do
+          return if @derived_metadata_blocks.items_for(metadata).all? do |block|
+            already_run_blocks.include?(block).tap do |skip_block|
+              block.call(metadata) unless skip_block
+              already_run_blocks << block
+            end
+          end
         end
+
+        # If we got here, then `@derived_metadata_blocks.items_for(metadata).all?` never returned
+        # `true` above and we treat this as an attempt to recurse infinitely. It's better to fail
+        # with a clear # error than hang indefinitely, which is what would happen if we didn't limit
+        # the looping above.
+        raise SystemStackError, "Attempted to recursively derive metadata indefinitely."
       end
 
       # Defines a `before` hook. See {Hooks#before} for full docs.
@@ -1749,6 +1915,12 @@ module RSpec
         handle_suite_hook(scope, meta) do
           @before_suite_hooks << Hooks::BeforeHook.new(block, {})
         end || begin
+          # defeat Ruby 2.5 lazy proc allocation to ensure
+          # the methods below are passed the same proc instances
+          # so `Hook` equality is preserved. For more info, see:
+          # https://bugs.ruby-lang.org/issues/14045#note-5
+          block.__id__
+
           add_hook_to_existing_matching_groups(meta, scope) { |g| g.before(scope, *meta, &block) }
           super(scope, *meta, &block)
         end
@@ -1772,6 +1944,12 @@ module RSpec
         handle_suite_hook(scope, meta) do
           @before_suite_hooks.unshift Hooks::BeforeHook.new(block, {})
         end || begin
+          # defeat Ruby 2.5 lazy proc allocation to ensure
+          # the methods below are passed the same proc instances
+          # so `Hook` equality is preserved. For more info, see:
+          # https://bugs.ruby-lang.org/issues/14045#note-5
+          block.__id__
+
           add_hook_to_existing_matching_groups(meta, scope) { |g| g.prepend_before(scope, *meta, &block) }
           super(scope, *meta, &block)
         end
@@ -1790,6 +1968,12 @@ module RSpec
         handle_suite_hook(scope, meta) do
           @after_suite_hooks.unshift Hooks::AfterHook.new(block, {})
         end || begin
+          # defeat Ruby 2.5 lazy proc allocation to ensure
+          # the methods below are passed the same proc instances
+          # so `Hook` equality is preserved. For more info, see:
+          # https://bugs.ruby-lang.org/issues/14045#note-5
+          block.__id__
+
           add_hook_to_existing_matching_groups(meta, scope) { |g| g.after(scope, *meta, &block) }
           super(scope, *meta, &block)
         end
@@ -1813,6 +1997,12 @@ module RSpec
         handle_suite_hook(scope, meta) do
           @after_suite_hooks << Hooks::AfterHook.new(block, {})
         end || begin
+          # defeat Ruby 2.5 lazy proc allocation to ensure
+          # the methods below are passed the same proc instances
+          # so `Hook` equality is preserved. For more info, see:
+          # https://bugs.ruby-lang.org/issues/14045#note-5
+          block.__id__
+
           add_hook_to_existing_matching_groups(meta, scope) { |g| g.append_after(scope, *meta, &block) }
           super(scope, *meta, &block)
         end
@@ -1822,6 +2012,12 @@ module RSpec
       #
       # See {Hooks#around} for full `around` hook docs.
       def around(scope=nil, *meta, &block)
+        # defeat Ruby 2.5 lazy proc allocation to ensure
+        # the methods below are passed the same proc instances
+        # so `Hook` equality is preserved. For more info, see:
+        # https://bugs.ruby-lang.org/issues/14045#note-5
+        block.__id__
+
         add_hook_to_existing_matching_groups(meta, scope) { |g| g.around(scope, *meta, &block) }
         super(scope, *meta, &block)
       end
@@ -1857,8 +2053,38 @@ module RSpec
         @on_example_group_definition_callbacks ||= []
       end
 
+      # @private
+      def bisect_runner_class
+        @bisect_runner_class ||= begin
+          case bisect_runner
+          when :fork
+            RSpec::Support.require_rspec_core 'bisect/fork_runner'
+            Bisect::ForkRunner
+          when :shell
+            RSpec::Support.require_rspec_core 'bisect/shell_runner'
+            Bisect::ShellRunner
+          else
+            raise "Unsupported value for `bisect_runner` (#{bisect_runner.inspect}). " \
+                  "Only `:fork` and `:shell` are supported."
+          end
+        end
+      end
+
     private
 
+      def load_file_handling_errors(method, file)
+        __send__(method, file)
+      rescue LoadError => ex
+        relative_file = Metadata.relative_path(file)
+        suggestions = DidYouMean.new(relative_file).call
+        reporter.notify_non_example_exception(ex, "An error occurred while loading #{relative_file}.#{suggestions}")
+        RSpec.world.wants_to_quit = true
+      rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex
+        relative_file = Metadata.relative_path(file)
+        reporter.notify_non_example_exception(ex, "An error occurred while loading #{relative_file}.")
+        RSpec.world.wants_to_quit = true
+      end
+
       def handle_suite_hook(scope, meta)
         return nil unless scope == :suite
 
@@ -1882,6 +2108,12 @@ module RSpec
             hook.run(context)
           rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex
             context.set_exception(ex)
+
+            # Do not run subsequent `before` hooks if one fails.
+            # But for `after` hooks, we run them all so that all
+            # cleanup bits get a chance to complete, minimizing the
+            # chance that resources get left behind.
+            break if hooks.equal?(@before_suite_hooks)
           end
         end
       end
@@ -1985,8 +2217,12 @@ module RSpec
         )
       end
 
+      def output_wrapper
+        @output_wrapper ||= OutputWrapper.new(output_stream)
+      end
+
       def output_to_tty?(output=output_stream)
-        tty? || (output.respond_to?(:tty?) && output.tty?)
+        output.respond_to?(:tty?) && output.tty?
       end
 
       def conditionally_disable_mocks_monkey_patching