rspec-core 3.7.0 → 3.8.0

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
         #

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

@@ -13,6 +13,25 @@ module RSpec
           implementation.highlight_syntax(lines)
         end
 
+        # rubocop:disable Lint/RescueException
+        # rubocop:disable Lint/HandleExceptions
+        def self.attempt_to_add_rspec_terms_to_coderay_keywords
+          CodeRay::Scanners::Ruby::Patterns::IDENT_KIND.add(%w[
+            describe context
+            it specify
+            before after around
+            let subject
+            expect allow
+          ], :keyword)
+        rescue Exception
+          # Mutating CodeRay's contants like this is not a public API
+          # and might not always work. If we cannot add our keywords
+          # to CodeRay it is not a big deal and not worth raising an
+          # error over, so we ignore it.
+        end
+      # rubocop:enable Lint/HandleExceptions
+      # rubocop:enable Lint/RescueException
+
       private
 
         if RSpec::Support::OS.windows?
@@ -38,25 +57,6 @@ module RSpec
           end
         end
 
-        # rubocop:disable Lint/RescueException
-        # rubocop:disable Lint/HandleExceptions
-        def self.attempt_to_add_rspec_terms_to_coderay_keywords
-          CodeRay::Scanners::Ruby::Patterns::IDENT_KIND.add(%w[
-            describe context
-            it specify
-            before after around
-            let subject
-            expect allow
-          ], :keyword)
-        rescue Exception
-          # Mutating CodeRay's contants like this is not a public API
-          # and might not always work. If we cannot add our keywords
-          # to CodeRay it is not a big deal and not worth raising an
-          # error over, so we ignore it.
-        end
-        # rubocop:enable Lint/HandleExceptions
-        # rubocop:enable Lint/RescueException
-
         # @private
         module CodeRayImplementation
           RESET_CODE = "\e[0m"

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/hooks.rb

@@ -322,7 +322,7 @@ module RSpec
       #     end
       #
       # The yielded example aliases `run` with `call`, which lets you treat it
-      # like a `Proc`. This is especially handy when working with libaries
+      # like a `Proc`. This is especially handy when working with libraries
       # that manage their own setup and teardown using a block or proc syntax,
       # e.g.
       #
@@ -339,8 +339,6 @@ module RSpec
         @hooks ||= HookCollections.new(self, FilterableItemRepository::UpdateOptimized)
       end
 
-    private
-
       # @private
       Hook = Struct.new(:block, :options)
 

data/lib/rspec/core/invocations.rb

@@ -26,21 +26,23 @@ module RSpec
 
       # @private
       class Bisect
-        def call(options, _err, _out)
+        def call(options, err, out)
           RSpec::Support.require_rspec_core "bisect/coordinator"
+          runner = Runner.new(options).tap { |r| r.configure(err, out) }
+          formatter = bisect_formatter_klass_for(options.options[:bisect]).new(
+            out, runner.configuration.bisect_runner
+          )
 
           success = RSpec::Core::Bisect::Coordinator.bisect_with(
-            options.args,
-            RSpec.configuration,
-            bisect_formatter_for(options.options[:bisect])
+            runner, options.args, formatter
           )
 
           success ? 0 : 1
         end
 
-        private
+      private
 
-        def bisect_formatter_for(argument)
+        def bisect_formatter_klass_for(argument)
           return Formatters::BisectDebugFormatter if argument == "verbose"
           Formatters::BisectProgressFormatter
         end

data/lib/rspec/core/memoized_helpers.rb

@@ -483,9 +483,9 @@ EOS
       def self.module_for(example_group)
         get_constant_or_yield(example_group, :LetDefinitions) do
           mod = Module.new do
-            include Module.new {
+            include(Module.new {
               example_group.const_set(:NamedSubjectPreventSuper, self)
-            }
+            })
           end
 
           example_group.const_set(:LetDefinitions, mod)

data/lib/rspec/core/profiler.rb

@@ -20,7 +20,9 @@ module RSpec
       def example_group_finished(notification)
         return unless notification.group.top_level?
 
-        @example_groups[notification.group][:total_time] =  Time.now - @example_groups[notification.group][:start]
+        group = @example_groups[notification.group]
+        return unless group.key?(:start)
+        group[:total_time] = Time.now - group[:start]
       end
 
       def example_started(notification)

data/lib/rspec/core/reporter.rb

@@ -21,17 +21,12 @@ module RSpec::Core
       @non_example_exception_count = 0
       @setup_default = lambda {}
       @setup = false
+      @profiler = nil
     end
 
     # @private
     attr_reader :examples, :failed_examples, :pending_examples
 
-    # @private
-    def setup_profiler
-      @profiler = Profiler.new
-      register_listener @profiler, *Profiler::NOTIFICATIONS
-    end
-
     # Registers a listener to a list of notifications. The reporter will send
     # notification of events to all registered listeners.
     #
@@ -231,6 +226,8 @@ module RSpec::Core
       return if @setup
 
       @setup_default.call
+      @profiler = Profiler.new
+      register_listener @profiler, *Profiler::NOTIFICATIONS
       @setup = true
     end
 

data/lib/rspec/core/runner.rb

@@ -94,9 +94,7 @@ module RSpec
       # @param err [IO] error stream
       # @param out [IO] output stream
       def setup(err, out)
-        @configuration.error_stream = err
-        @configuration.output_stream = out if @configuration.output_stream == $stdout
-        @options.configure(@configuration)
+        configure(err, out)
         @configuration.load_spec_files
         @world.announce_filters
       end
@@ -122,17 +120,11 @@ module RSpec
         success ? 0 : @configuration.failure_exit_code
       end
 
-    private
-
-      def persist_example_statuses
-        return unless (path = @configuration.example_status_persistence_file_path)
-
-        ExampleStatusPersister.persist(@world.all_examples, path)
-      rescue SystemCallError => e
-        RSpec.warning "Could not write example statuses to #{path} (configured as " \
-                      "`config.example_status_persistence_file_path`) due to a " \
-                      "system error: #{e.inspect}. Please check that the config " \
-                      "option is set to an accessible, valid file path", :call_site => nil
+      # @private
+      def configure(err, out)
+        @configuration.error_stream = err
+        @configuration.output_stream = out if @configuration.output_stream == $stdout
+        @options.configure(@configuration)
       end
 
       # @private
@@ -188,6 +180,20 @@ module RSpec
           $stderr.puts "\nRSpec is shutting down and will print the summary report... Interrupt again to force quit."
         end
       end
+
+    private
+
+      def persist_example_statuses
+        return if @configuration.dry_run
+        return unless (path = @configuration.example_status_persistence_file_path)
+
+        ExampleStatusPersister.persist(@world.all_examples, path)
+      rescue SystemCallError => e
+        RSpec.warning "Could not write example statuses to #{path} (configured as " \
+                      "`config.example_status_persistence_file_path`) due to a " \
+                      "system error: #{e.inspect}. Please check that the config " \
+                      "option is set to an accessible, valid file path", :call_site => nil
+      end
     end
   end
 end

data/lib/rspec/core/shared_example_group.rb

@@ -103,7 +103,6 @@ module RSpec
       # Shared examples top level DSL.
       module TopLevelDSL
         # @private
-        # rubocop:disable Lint/NestedMethodDefinition
         def self.definitions
           proc do
             def shared_examples(name, *args, &block)
@@ -113,7 +112,6 @@ module RSpec
             alias shared_examples_for shared_examples
           end
         end
-        # rubocop:enable Lint/NestedMethodDefinition
 
         # @private
         def self.exposed_globally?
@@ -259,7 +257,7 @@ module RSpec
           # :nocov:
           def ensure_block_has_source_location(block)
             source_location = yield.split(':')
-            block.extend Module.new { define_method(:source_location) { source_location } }
+            block.extend(Module.new { define_method(:source_location) { source_location } })
           end
           # :nocov:
         end

data/lib/rspec/core/shell_escape.rb

@@ -6,7 +6,7 @@ module RSpec
       module_function
 
       def quote(argument)
-        "'#{argument.gsub("'", "\\\\'")}'"
+        "'#{argument.to_s.gsub("'", "\\\\'")}'"
       end
 
       if RSpec::Support::OS.windows?
@@ -17,7 +17,7 @@ module RSpec
         require 'shellwords'
 
         def escape(shell_command)
-          shell_command.shellescape
+          Shellwords.escape(shell_command.to_s)
         end
       end
 

data/lib/rspec/core/version.rb

@@ -3,7 +3,7 @@ module RSpec
     # Version information for RSpec Core.
     module Version
       # Current version of RSpec Core, in semantic versioning format.
-      STRING = '3.7.0'
+      STRING = '3.8.0'
     end
   end
 end

data/lib/rspec/core/world.rb

@@ -21,6 +21,17 @@ module RSpec
         configuration.world = self
         @example_groups = []
         @example_group_counts_by_spec_file = Hash.new(0)
+        prepare_example_filtering
+      end
+
+      # @api public
+      #
+      # Prepares filters so that they apply to example groups when they run.
+      #
+      # This is a separate method so that filters can be modified/replaced and
+      # examples refiltered during a process's lifetime, which can be useful for
+      # a custom runner.
+      def prepare_example_filtering
         @filtered_examples = Hash.new do |hash, group|
           hash[group] = filter_manager.prune(group.examples)
         end