rspec-core 3.7.1 → 3.8.0

data/lib/rspec/core/configuration_options.rb

@@ -4,8 +4,9 @@ require 'shellwords'
 module RSpec
   module Core
     # Responsible for utilizing externally provided configuration options,
-    # whether via the command line, `.rspec`, `~/.rspec`, `.rspec-local`
-    # or a custom options file.
+    # whether via the command line, `.rspec`, `~/.rspec`,
+    # `$XDG_CONFIG_HOME/rspec/options`, `.rspec-local` or a custom options
+    # file.
     class ConfigurationOptions
       # @param args [Array<String>] command line arguments
       def initialize(args)
@@ -118,7 +119,11 @@ module RSpec
       end
 
       def file_options
-        custom_options_file ? [custom_options] : [global_options, project_options, local_options]
+        if custom_options_file
+          [custom_options]
+        else
+          [global_options, project_options, local_options]
+        end
       end
 
       def env_options
@@ -168,7 +173,11 @@ module RSpec
       end
 
       def options_file_as_erb_string(path)
-        ERB.new(File.read(path), nil, '-').result(binding)
+        if RUBY_VERSION >= '2.6'
+          ERB.new(File.read(path), :trim_mode => '-').result(binding)
+        else
+          ERB.new(File.read(path), nil, '-').result(binding)
+        end
       end
 
       def custom_options_file
@@ -184,6 +193,17 @@ module RSpec
       end
 
       def global_options_file
+        xdg_options_file_if_exists || home_options_file_path
+      end
+
+      def xdg_options_file_if_exists
+        path = xdg_options_file_path
+        if path && File.exist?(path)
+          path
+        end
+      end
+
+      def home_options_file_path
         File.join(File.expand_path("~"), ".rspec")
       rescue ArgumentError
         # :nocov:
@@ -191,6 +211,23 @@ module RSpec
         nil
         # :nocov:
       end
+
+      def xdg_options_file_path
+        xdg_config_home = resolve_xdg_config_home
+        if xdg_config_home
+          File.join(xdg_config_home, "rspec", "options")
+        end
+      end
+
+      def resolve_xdg_config_home
+        File.expand_path(ENV.fetch("XDG_CONFIG_HOME", "~/.config"))
+      rescue ArgumentError
+        # :nocov:
+        # On Ruby 2.4, `File.expand("~")` works even if `ENV['HOME']` is not set.
+        # But on earlier versions, it fails.
+        nil
+        # :nocov:
+      end
     end
   end
 end

data/lib/rspec/core/example.rb

@@ -393,7 +393,7 @@ module RSpec
         end
       end
 
-      # rubocop:disable Style/AccessorMethodName
+      # rubocop:disable Naming/AccessorMethodName
 
       # @private
       #
@@ -420,7 +420,7 @@ module RSpec
         self.display_exception = exception
       end
 
-      # rubocop:enable Style/AccessorMethodName
+      # rubocop:enable Naming/AccessorMethodName
 
       # @private
       #
@@ -642,12 +642,12 @@ module RSpec
         @reporter = reporter
       end
 
-      # rubocop:disable Style/AccessorMethodName
+      # rubocop:disable Naming/AccessorMethodName
       def set_exception(exception)
         reporter.notify_non_example_exception(exception, "An error occurred in #{description}.")
         RSpec.world.wants_to_quit = true
       end
-      # rubocop:enable Style/AccessorMethodName
+      # rubocop:enable Naming/AccessorMethodName
     end
   end
 end

data/lib/rspec/core/example_group.rb

@@ -107,6 +107,7 @@ module RSpec
       # @private
       # @macro [attach] define_example_method
       #   @!scope class
+      #   @method $1
       #   @overload $1
       #   @overload $1(&example_implementation)
       #     @param example_implementation [Block] The implementation of the example.

data/lib/rspec/core/formatters.rb

@@ -72,7 +72,7 @@ module RSpec::Core::Formatters
   autoload :ProgressFormatter,        'rspec/core/formatters/progress_formatter'
   autoload :ProfileFormatter,         'rspec/core/formatters/profile_formatter'
   autoload :JsonFormatter,            'rspec/core/formatters/json_formatter'
-  autoload :BisectFormatter,          'rspec/core/formatters/bisect_formatter'
+  autoload :BisectDRbFormatter,       'rspec/core/formatters/bisect_drb_formatter'
   autoload :ExceptionPresenter,       'rspec/core/formatters/exception_presenter'
 
   # Register the formatter class
@@ -133,9 +133,6 @@ module RSpec::Core::Formatters
       end
 
       return unless RSpec.configuration.profile_examples?
-
-      @reporter.setup_profiler
-
       return if existing_formatter_implements?(:dump_profile)
 
       add RSpec::Core::Formatters::ProfileFormatter, output_stream
@@ -143,6 +140,13 @@ module RSpec::Core::Formatters
 
     # @private
     def add(formatter_to_use, *paths)
+      # If a formatter instance was passed, we can register it directly,
+      # with no need for any of the further processing that happens below.
+      if Loader.formatters.key?(formatter_to_use.class)
+        register formatter_to_use, notifications_for(formatter_to_use.class)
+        return
+      end
+
       formatter_class = find_formatter(formatter_to_use)
 
       args = paths.map { |p| p.respond_to?(:puts) ? p : open_stream(p) }
@@ -206,8 +210,8 @@ module RSpec::Core::Formatters
         ProgressFormatter
       when 'j', 'json'
         JsonFormatter
-      when 'bisect'
-        BisectFormatter
+      when 'bisect-drb'
+        BisectDRbFormatter
       end
     end
 

data/lib/rspec/core/formatters/base_bisect_formatter.rb

@@ -0,0 +1,45 @@
+RSpec::Support.require_rspec_core "bisect/utilities"
+
+module RSpec
+  module Core
+    module Formatters
+      # Contains common logic for formatters used by `--bisect` to communicate results
+      # back to the bisect runner.
+      #
+      # Subclasses must define a `notify_results(all_example_ids, failed_example_ids)`
+      # method.
+      # @private
+      class BaseBisectFormatter
+        def self.inherited(formatter)
+          Formatters.register formatter, :start_dump, :example_failed, :example_finished
+        end
+
+        def initialize(expected_failures)
+          @all_example_ids = []
+          @failed_example_ids = []
+          @remaining_failures = expected_failures
+        end
+
+        def example_failed(notification)
+          @failed_example_ids << notification.example.id
+        end
+
+        def example_finished(notification)
+          @all_example_ids << notification.example.id
+          return unless @remaining_failures.include?(notification.example.id)
+          @remaining_failures.delete(notification.example.id)
+
+          status = notification.example.execution_result.status
+          return if status == :failed && !@remaining_failures.empty?
+          RSpec.world.wants_to_quit = true
+        end
+
+        def start_dump(_notification)
+          # `notify_results` is defined in the subclass
+          notify_results(Bisect::ExampleSetDescriptor.new(
+            @all_example_ids, @failed_example_ids))
+        end
+      end
+    end
+  end
+end

data/lib/rspec/core/formatters/bisect_drb_formatter.rb

@@ -0,0 +1,29 @@
+require 'drb/drb'
+RSpec::Support.require_rspec_core "formatters/base_bisect_formatter"
+
+module RSpec
+  module Core
+    module Formatters
+      # Used by `--bisect`. When it shells out and runs a portion of the suite, it uses
+      # this formatter as a means to have the status reported back to it, via DRb.
+      #
+      # Note that since DRb calls carry considerable overhead compared to normal
+      # method calls, we try to minimize the number of DRb calls for perf reasons,
+      # opting to communicate only at the start and the end of the run, rather than
+      # after each example.
+      # @private
+      class BisectDRbFormatter < BaseBisectFormatter
+        def initialize(_output)
+          drb_uri = "druby://localhost:#{RSpec.configuration.drb_port}"
+          @bisect_server = DRbObject.new_with_uri(drb_uri)
+          RSpec.configuration.files_or_directories_to_run = @bisect_server.files_or_directories_to_run
+          super(Set.new(@bisect_server.expected_failures))
+        end
+
+        def notify_results(results)
+          @bisect_server.latest_run_results = results
+        end
+      end
+    end
+  end
+end

data/lib/rspec/core/formatters/bisect_progress_formatter.rb

@@ -6,19 +6,14 @@ module RSpec
       # @private
       # Produces progress output while bisecting.
       class BisectProgressFormatter < BaseTextFormatter
-        # We've named all events with a `bisect_` prefix to prevent naming collisions.
-        Formatters.register self, :bisect_starting, :bisect_original_run_complete,
-                            :bisect_round_started, :bisect_individual_run_complete,
-                            :bisect_complete, :bisect_repro_command,
-                            :bisect_failed, :bisect_aborted,
-                            :bisect_round_ignoring_ids, :bisect_round_detected_multiple_culprits,
-                            :bisect_dependency_check_started, :bisect_dependency_check_passed,
-                            :bisect_dependency_check_failed
+        def initialize(output, bisect_runner)
+          super(output)
+          @bisect_runner = bisect_runner
+        end
 
         def bisect_starting(notification)
           @round_count = 0
-          options = notification.original_cli_args.join(' ')
-          output.puts "Bisect started using options: #{options.inspect}"
+          output.puts bisect_started_message(notification)
           output.print "Running suite to find failures..."
         end
 
@@ -40,6 +35,16 @@ module RSpec
 
         def bisect_dependency_check_failed(_notification)
           output.puts " failure(s) do not require any non-failures to run first"
+
+          if @bisect_runner == :fork
+            output.puts
+            output.puts "=" * 80
+            output.puts "NOTE: this bisect run used `config.bisect_runner = :fork`, which generally"
+            output.puts "provides significantly faster bisection runs than the old shell-based runner,"
+            output.puts "but may inaccurately report that no non-failures are required. If this result"
+            output.puts "is unexpected, consider setting `config.bisect_runner = :shell` and trying again."
+            output.puts "=" * 80
+          end
         end
 
         def bisect_round_started(notification, include_trailing_space=true)
@@ -85,16 +90,20 @@ module RSpec
           output.puts "\n\nBisect aborted!"
           output.puts "\nThe most minimal reproduction command discovered so far is:\n  #{notification.repro}"
         end
+
+      private
+
+        def bisect_started_message(notification)
+          options = notification.original_cli_args.join(' ')
+          "Bisect started using options: #{options.inspect}"
+        end
       end
 
       # @private
-      # Produces detailed debug output while bisecting. Used when
-      # bisect is performed while the `DEBUG_RSPEC_BISECT` ENV var is used.
-      # Designed to provide details for us when we need to troubleshoot bisect bugs.
+      # Produces detailed debug output while bisecting. Used when bisect is
+      # performed with `--bisect=verbose`. Designed to provide details for
+      # us when we need to troubleshoot bisect bugs.
       class BisectDebugFormatter < BisectProgressFormatter
-        Formatters.register self, :bisect_original_run_complete, :bisect_individual_run_start,
-                            :bisect_individual_run_complete, :bisect_round_ignoring_ids
-
         def bisect_original_run_complete(notification)
           output.puts " (#{Helpers.format_duration(notification.duration)})"
 
@@ -138,6 +147,10 @@ module RSpec
           formatted_ids = organized_ids.map { |id| "    - #{id}" }.join("\n")
           "#{description} (#{ids.size}):\n#{formatted_ids}"
         end
+
+        def bisect_started_message(notification)
+          "#{super} and bisect runner: #{notification.bisect_runner.inspect}"
+        end
       end
     end
   end

data/lib/rspec/core/formatters/deprecation_formatter.rb

@@ -62,6 +62,7 @@ module RSpec
         TOO_MANY_WARNINGS_NOTICE  = "Too many similar deprecation messages " \
           "reported, disregarding further reports. #{DEPRECATION_STREAM_NOTICE}"
 
+        # @private
         SpecifiedDeprecationMessage = Struct.new(:type) do
           def initialize(data)
             @message = data.message
@@ -80,7 +81,7 @@ module RSpec
 
           def output_formatted(str)
             return str unless str.lines.count > 1
-            separator = "#{'-' * 80}"
+            separator = '-' * 80
             "#{separator}\n#{str.chomp}\n#{separator}"
           end
 
@@ -89,6 +90,7 @@ module RSpec
           end
         end
 
+        # @private
         GeneratedDeprecationMessage = Struct.new(:type) do
           def initialize(data)
             @data = data

data/lib/rspec/core/formatters/exception_presenter.rb

@@ -379,6 +379,7 @@ module RSpec
                 parent_bt[index] != child_bt[index]
               end
 
+              return child if index_before_first_common_frame.nil?
               return child if index_before_first_common_frame == -1
 
               child = child.dup

data/lib/rspec/core/formatters/html_printer.rb

@@ -115,7 +115,6 @@ module RSpec
           "style=\"margin-left: #{(number_of_parents - 1) * 15}px;\""
         end
 
-        # rubocop:disable LineLength
         REPORT_HEADER = <<-EOF
 <div class="rspec-report">
 
@@ -139,7 +138,6 @@ module RSpec
 
 <div class="results">
 EOF
-        # rubocop:enable LineLength
 
         GLOBAL_SCRIPTS = <<-EOF
 

data/lib/rspec/core/formatters/protocol.rb

@@ -17,12 +17,12 @@ module RSpec
       # @see RSpec::Core::Formatters::BaseTextFormatter
       # @see RSpec::Core::Reporter
       class Protocol
-        # @method initialize
+        # @method initialize(output)
         # @api public
         #
         # @param output [IO] the formatter output
 
-        # @method start
+        # @method start(notification)
         # @api public
         # @group Suite Notifications
         #
@@ -35,7 +35,7 @@ module RSpec
         #
         # @param notification [Notifications::StartNotification]
 
-        # @method example_group_started
+        # @method example_group_started(notification)
         # @api public
         # @group Group Notifications
         #
@@ -48,7 +48,7 @@ module RSpec
         # @param notification [Notifications::GroupNotification] containing example_group
         #   subclass of {ExampleGroup}
 
-        # @method example_group_finished
+        # @method example_group_finished(notification)
         # @api public
         # @group Group Notifications
         #
@@ -57,7 +57,7 @@ module RSpec
         # @param notification [Notifications::GroupNotification] containing example_group
         #   subclass of {ExampleGroup}
 
-        # @method example_started
+        # @method example_started(notification)
         # @api public
         # @group Example Notifications
         #
@@ -66,7 +66,7 @@ module RSpec
         # @param notification [Notifications::ExampleNotification] containing example subclass
         #   of {Example}
 
-        # @method example_finished
+        # @method example_finished(notification)
         # @api public
         # @group Example Notifications
         #
@@ -75,7 +75,7 @@ module RSpec
         # @param notification [Notifications::ExampleNotification] containing example subclass
         #   of {Example}
 
-        # @method example_passed
+        # @method example_passed(notification)
         # @api public
         # @group Example Notifications
         #
@@ -84,7 +84,7 @@ module RSpec
         # @param notification [Notifications::ExampleNotification] containing example subclass
         #   of {Example}
 
-        # @method example_pending
+        # @method example_pending(notification)
         # @api public
         # @group Example Notifications
         #
@@ -93,7 +93,7 @@ module RSpec
         # @param notification [Notifications::ExampleNotification] containing example subclass
         #   of {Example}
 
-        # @method example_failed
+        # @method example_failed(notification)
         # @api public
         # @group Example Notifications
         #
@@ -102,7 +102,7 @@ module RSpec
         # @param notification [Notifications::ExampleNotification] containing example subclass
         #   of {Example}
 
-        # @method message
+        # @method message(notification)
         # @api public
         # @group Suite Notifications
         #
@@ -110,7 +110,7 @@ module RSpec
         #
         # @param notification [Notifications::MessageNotification] containing message
 
-        # @method stop
+        # @method stop(notification)
         # @api public
         # @group Suite Notifications
         #
@@ -119,7 +119,7 @@ module RSpec
         #
         # @param notification [Notifications::NullNotification]
 
-        # @method start_dump
+        # @method start_dump(notification)
         # @api public
         # @group Suite Notifications
         #
@@ -130,7 +130,7 @@ module RSpec
         #
         # @param notification [Notifications::NullNotification]
 
-        # @method dump_failures
+        # @method dump_failures(notification)
         # @api public
         # @group Suite Notifications
         #
@@ -138,7 +138,7 @@ module RSpec
         #
         # @param notification [Notifications::NullNotification]
 
-        # @method dump_summary
+        # @method dump_summary(summary)
         # @api public
         # @group Suite Notifications
         #
@@ -148,7 +148,7 @@ module RSpec
         # @param summary [Notifications::SummaryNotification] containing duration,
         #   example_count, failure_count and pending_count
 
-        # @method dump_profile
+        # @method dump_profile(profile)
         # @api public
         # @group Suite Notifications
         #
@@ -158,7 +158,7 @@ module RSpec
         # @param profile [Notifications::ProfileNotification] containing duration,
         #   slowest_examples and slowest_example_groups
 
-        # @method dump_pending
+        # @method dump_pending(notification)
         # @api public
         # @group Suite Notifications
         #
@@ -167,7 +167,7 @@ module RSpec
         #
         # @param notification [Notifications::NullNotification]
 
-        # @method close
+        # @method close(notification)
         # @api public
         # @group Suite Notifications
         #