rspec-core 3.12.2 → 3.13.5

data/README.md

@@ -116,6 +116,11 @@ pretty much the same as `shared_examples` and `include_examples`, providing
 more accurate naming when you share hooks, `let` declarations, helper methods,
 etc, but no examples.
 
+If you want to reuse shared examples or contexts across your RSpec suite you can
+define them in a stand alone _*.rb_ files (_spec/support/shared_examples/definition.rb_
+for example). But you will have to manually `require` them (there is no autoloading of
+_spec/support/_ directory unless you set it up yourself).
+
 ## Metadata
 
 rspec-core stores a metadata hash with every example and group, which

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

@@ -136,7 +136,7 @@ module RSpec
         end
 
         def get_expected_failures_for?(ids)
-          ids_to_run = ids + failed_example_ids
+          ids_to_run = all_example_ids & (ids + failed_example_ids)
           notify(
             :bisect_individual_run_start,
             :command => shell_command.repro_command_from(ids_to_run),

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

@@ -102,6 +102,7 @@ module RSpec
         private
 
           def run_specs(run_descriptor)
+            # :nocov: - Executed in a forked process, by integration/bisect_spec
             $stdout = $stderr = @spec_output
             formatter = CaptureFormatter.new(run_descriptor.failed_example_ids)
 
@@ -125,6 +126,7 @@ module RSpec
             else
               @channel.send(latest_run_results)
             end
+            # :nocov:
           end
         end
 

data/lib/rspec/core/configuration.rb

@@ -453,11 +453,30 @@ module RSpec
       add_setting :threadsafe
 
       # @macro add_setting
-      # Maximum count of failed source lines to display in the failure reports.
-      # (default `10`).
+      # Maximum count of failed source lines to display in the failure reports
+      # (defaults to `10`).
       # return [Integer]
       add_setting :max_displayed_failure_line_count
 
+      # @macro full_cause_backtrace
+      # Display the full backtrace of an exceptions cause (defaults to `false`).
+      # return [Boolean]
+      add_setting :full_cause_backtrace
+
+      # @macro add_setting
+      # Format the output for pending examples. Can be set to:
+      #  - :full (default) - pending examples appear similarly to failures
+      #  - :no_backtrace - same as above, but with no backtrace
+      #  - :skip - do not show the section at all
+      # return [Symbol]
+      add_read_only_setting :pending_failure_output
+      def pending_failure_output=(mode)
+        raise ArgumentError,
+              "`pending_failure_output` can be set to :full, :no_backtrace, " \
+              "or :skip" unless [:full, :no_backtrace, :skip].include?(mode)
+        @pending_failure_output = mode
+      end
+
       # Determines which bisect runner implementation gets used to run subsets
       # of the suite during a bisection. Your choices are:
       #
@@ -557,8 +576,10 @@ module RSpec
         @derived_metadata_blocks = FilterableItemRepository::QueryOptimized.new(:any?)
         @threadsafe = true
         @max_displayed_failure_line_count = 10
+        @full_cause_backtrace = false
         @world = World::Null
         @shared_context_metadata_behavior = :trigger_inclusion
+        @pending_failure_output = :full
 
         define_built_in_hooks
       end
@@ -1381,6 +1402,9 @@ module RSpec
       #
       #       # included in examples with `:type => :request` metadata
       #       config.include(AuthenticationHelpers, :type => :request)
+      #
+      #       # included in examples where the `:type` metadata matches a proc condition
+      #       config.include(AuthenticationHelpers, :type => proc { |type, _metadata| [:request, :controller].include?(type) })
       #     end
       #
       #     describe "edit profile", :preferences, :type => :request do
@@ -1573,8 +1597,10 @@ 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| load_file_handling_errors(:require, path) }
-        @requires += paths
+        paths.each { |path|
+          load_file_handling_errors(:require, path)
+          @requires << path
+        }
       end
 
       # @private
@@ -1743,8 +1769,9 @@ module RSpec
       # @private
       RAISE_ERROR_WARNING_NOTIFIER = lambda { |message| raise message }
 
-      # Turns warnings into errors. This can be useful when
+      # Turns RSpec warnings into errors. This can be useful when
       # you want RSpec to run in a 'strict' no warning situation.
+      # (Note this does not capture or raise on Ruby warnings).
       #
       # @example
       #
@@ -2120,6 +2147,13 @@ module RSpec
         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 SyntaxError => ex
+        relative_file = Metadata.relative_path(file)
+        reporter.notify_non_example_exception(
+          ex,
+          "While loading #{relative_file} a `raise SyntaxError` occurred, RSpec will now quit."
+        )
+        RSpec.world.rspec_is_quitting = true
       rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex
         relative_file = Metadata.relative_path(file)
         reporter.notify_non_example_exception(ex, "An error occurred while loading #{relative_file}.")

data/lib/rspec/core/configuration_options.rb

@@ -79,6 +79,10 @@ module RSpec
         # deprecation (or otherwise access the reporter).
         :deprecation_stream,
 
+        # In order for `RSpec.configuration.dry_run?` to return `true` during
+        # processing the `requires` option, it must be parsed before it.
+        :dry_run,
+
         # load paths depend on nothing, but must be set before `requires`
         # to support load-path-relative requires.
         :libs,
@@ -169,9 +173,11 @@ module RSpec
       def args_from_options_file(path)
         return [] unless path && File.exist?(path)
         config_string = options_file_as_erb_string(path)
-        FlatMap.flat_map(config_string.split(/\n+/), &:shellsplit)
+        config_lines = config_string.split(/\n+/).reject { |s| s =~ /\A\s*#/ }
+        FlatMap.flat_map(config_lines, &:shellsplit)
       end
 
+      # :nocov:
       def options_file_as_erb_string(path)
         if RUBY_VERSION >= '2.6'
           ERB.new(File.read(path), :trim_mode => '-').result(binding)
@@ -179,6 +185,7 @@ module RSpec
           ERB.new(File.read(path), nil, '-').result(binding)
         end
       end
+      # :nocov:
 
       def custom_options_file
         command_line_options[:custom_options_file]

data/lib/rspec/core/did_you_mean.rb

@@ -11,6 +11,7 @@ module RSpec
 
       if defined?(::DidYouMean::SpellChecker)
         # provide probable suggestions
+        # :nocov: - not installed on CI
         def call
           checker = ::DidYouMean::SpellChecker.new(:dictionary => Dir["spec/**/*.rb"])
           probables = checker.correct(relative_file_name.sub('./', ''))[0..2]
@@ -18,15 +19,19 @@ module RSpec
 
           formats probables
         end
+        # :nocov:
       else
         # return a hint if API for ::DidYouMean::SpellChecker not supported
+        # :nocov:
         def call
           "\nHint: Install the `did_you_mean` gem in order to provide suggestions for similarly named files."
         end
+        # :nocov:
       end
 
       private
 
+      # :nocov:
       def formats(probables)
         rspec_format = probables.map { |s, _| "rspec ./#{s}" }
         red_font(top_and_tail rspec_format)
@@ -41,6 +46,7 @@ module RSpec
         colorizer = ::RSpec::Core::Formatters::ConsoleCodes
         colorizer.wrap mytext, :failure
       end
+      # :nocov:
     end
   end
 end

data/lib/rspec/core/drb.rb

@@ -91,7 +91,7 @@ module RSpec
       def add_filter(argv, name, hash)
         hash.each_pair do |k, v|
           next if CONDITIONAL_FILTERS.include?(k)
-          tag = name == :inclusion ? k.to_s : "~#{k}".dup
+          tag = name == :inclusion ? k.to_s.dup : "~#{k}".dup
           tag << ":#{v}" if v.is_a?(String)
           argv << "--tag" << tag
         end unless hash.empty?

data/lib/rspec/core/example.rb

@@ -98,7 +98,7 @@ module RSpec
           loaded_spec_files = RSpec.configuration.loaded_spec_files
 
           Metadata.ascending(metadata) do |meta|
-            return meta[:location] if loaded_spec_files.include?(meta[:absolute_file_path])
+            break meta[:location] if loaded_spec_files.include?(meta[:absolute_file_path])
           end
         end
       end

data/lib/rspec/core/example_group.rb

@@ -204,6 +204,7 @@ module RSpec
       # @private
       # @macro [attach] define_example_group_method
       #   @!scope class
+      #   @method $1
       #   @overload $1
       #   @overload $1(&example_group_definition)
       #     @param example_group_definition [Block] The definition of the example group.
@@ -212,6 +213,7 @@ module RSpec
       #     @param metadata [Array<Symbol>, Hash] Metadata for the group.
       #       Symbols will be transformed into hash entries with `true` values.
       #     @param example_group_definition [Block] The definition of the example group.
+      #   @return [RSpec::Core::ExampleGroup]
       #
       #   Generates a subclass of this example group which inherits
       #   everything except the examples themselves.
@@ -312,6 +314,11 @@ module RSpec
       # @private
       # @macro [attach] define_nested_shared_group_method
       #   @!scope class
+      #   @method $1(name, *args, &block)
+      #     @param name [String, Symbol] The name of the shared group to include.
+      #     @param args [Array] Pass parameters to a shared example group
+      #     @param block [Block] Additional context to pass to the shared group.
+      #     @return [RSpec::Core::ExampleGroup]
       #
       #   @see SharedExampleGroup
       def self.define_nested_shared_group_method(new_name, report_label="it should behave like")

data/lib/rspec/core/filter_manager.rb

@@ -202,8 +202,8 @@ module RSpec
 
       def split_file_scoped_rules
         rules_dup = @rules.dup
-        locations = rules_dup.delete(:locations) { Hash.new([]) }
-        ids       = rules_dup.delete(:ids)       { Hash.new([]) }
+        locations = rules_dup.delete(:locations) { Hash.new { [] } }
+        ids       = rules_dup.delete(:ids)       { Hash.new { [] } }
 
         return locations, ids, self.class.new(rules_dup)
       end

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

@@ -56,7 +56,12 @@ module RSpec
               end
 
               unless last_cause.backtrace.nil? || last_cause.backtrace.empty?
-                cause << ("  #{backtrace_formatter.format_backtrace(last_cause.backtrace, example.metadata).first}")
+                lines = backtrace_formatter.format_backtrace(last_cause.backtrace, example.metadata)
+                lines = [lines[0]] unless RSpec.configuration.full_cause_backtrace # rubocop:disable Metrics/BlockNesting
+
+                lines.each do |line|
+                  cause << ("  #{line}")
+                end
               end
             end
 
@@ -175,11 +180,25 @@ module RSpec
         end
 
         # rubocop:disable Lint/RescueException
-        def exception_message_string(exception)
-          exception.message.to_s
-        rescue Exception => other
-          "A #{exception.class} for which `exception.message.to_s` raises #{other.class}."
+        # :nocov:
+        if SyntaxError.instance_methods.include?(:detailed_message)
+          def exception_message_string(exception)
+            case exception
+            when SyntaxError then exception.detailed_message.to_s
+            else
+              exception.message.to_s
+            end
+          rescue Exception => other
+            "A #{exception.class} for which `exception.message.to_s` raises #{other.class}."
+          end
+        else
+          def exception_message_string(exception)
+            exception.message.to_s
+          rescue Exception => other
+            "A #{exception.class} for which `exception.message.to_s` raises #{other.class}."
+          end
         end
+        # :nocov:
         # rubocop:enable Lint/RescueException
 
         def exception_lines
@@ -235,22 +254,25 @@ module RSpec
         rescue SnippetExtractor::NoSuchLineError
           ["Unable to find matching line in #{file_path}"]
         rescue SecurityError
+          # :nocov: - SecurityError is no longer produced starting in ruby 2.7
           ["Unable to read failed line"]
+          # :nocov:
         end
 
         def find_failed_line
           line_regex = RSpec.configuration.in_project_source_dir_regex
           loaded_spec_files = RSpec.configuration.loaded_spec_files
 
-          exception_backtrace.reject! do |line|
-            line.start_with?("<internal:")
-          end
+          reduced_backtrace =
+            exception_backtrace.reject do |line|
+              line.start_with?("<internal:")
+            end
 
-          exception_backtrace.find do |line|
+          reduced_backtrace.find do |line|
             next unless (line_path = line[/(.+?):(\d+)(|:\d+)/, 1])
             path = File.expand_path(line_path)
             loaded_spec_files.include?(path) || path =~ line_regex
-          end || exception_backtrace.first
+          end || reduced_backtrace.first
         end
 
         def formatted_message_and_backtrace(colorizer)
@@ -267,9 +289,11 @@ module RSpec
             encoded_string(description)
           end
         else # for 1.8.7
+          # :nocov:
           def encoded_description(description)
             description
           end
+          # :nocov:
         end
 
         def exception_backtrace
@@ -312,10 +336,14 @@ module RSpec
                 ]
               }
             elsif @execution_result.status == :pending
-              {
+              options = {
                 :message_color    => RSpec.configuration.pending_color,
                 :detail_formatter => PENDING_DETAIL_FORMATTER
               }
+              if RSpec.configuration.pending_failure_output == :no_backtrace
+                options[:backtrace_formatter] = EmptyBacktraceFormatter
+              end
+              options
             end
           end
 
@@ -376,7 +404,7 @@ module RSpec
                 failure   = common_backtrace_truncater.with_truncated_backtrace(failure)
                 presenter = ExceptionPresenter.new(failure, @example, options)
                 presenter.fully_formatted_lines(
-                  "#{failure_number ? "#{failure_number}." : ''}#{index + 1}",
+                  "#{"#{failure_number}." if failure_number}#{index + 1}",
                   colorizer
                 )
               end

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

@@ -93,7 +93,9 @@ module RSpec
             "# Couldn't get snippet for #{file}"
           end
         rescue SecurityError
+          # :nocov: - SecurityError is no longer produced starting in ruby 2.7
           "# Couldn't get snippet for #{file}"
+          # :nocov:
         end
 
         # @api private

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

@@ -32,15 +32,16 @@ module RSpec
           @output_hash[:summary_line] = summary.totals_line
         end
 
-        def stop(notification)
-          @output_hash[:examples] = notification.examples.map do |example|
-            format_example(example).tap do |hash|
-              e = example.exception
+        def stop(group_notification)
+          @output_hash[:examples] = group_notification.notifications.map do |notification|
+            format_example(notification.example).tap do |hash|
+              e = notification.example.exception
+
               if e
-                hash[:exception] =  {
+                hash[:exception] = {
                   :class => e.class.name,
                   :message => e.message,
-                  :backtrace => e.backtrace,
+                  :backtrace => notification.formatted_backtrace,
                 }
               end
             end

data/lib/rspec/core/hooks.rb

@@ -461,7 +461,7 @@ module RSpec
             # TODO: consider making this an error in RSpec 4. For SemVer reasons,
             # we are only warning in RSpec 3.
             RSpec.warn_with "WARNING: `around(:context)` hooks are not supported and " \
-                            "behave like `around(:example)."
+                            "behave like `around(:example)`."
           end
 
           hook = HOOK_TYPES[position][scope].new(block, options)

data/lib/rspec/core/metadata.rb

@@ -47,7 +47,7 @@ module RSpec
         return nil if line == '-e:1'.freeze
         line
       rescue SecurityError
-        # :nocov:
+        # :nocov: - SecurityError is no longer produced starting in ruby 2.7
         nil
         # :nocov:
       end

data/lib/rspec/core/notifications.rb

@@ -120,6 +120,8 @@ module RSpec::Core
       # @return [String] The list of pending examples, fully formatted in the
       #   way that RSpec's built-in formatters emit.
       def fully_formatted_pending_examples(colorizer=::RSpec::Core::Formatters::ConsoleCodes)
+        return if RSpec.configuration.pending_failure_output == :skip
+
         formatted = "\nPending: (Failures listed here are expected and do not affect your suite's status)\n".dup
 
         pending_notifications.each_with_index do |notification, index|

data/lib/rspec/core/option_parser.rb

@@ -185,7 +185,9 @@ module RSpec::Core
 
         parser.on('-w', '--warnings', 'Enable ruby warnings') do
           if Object.const_defined?(:Warning) && Warning.respond_to?(:[]=)
+            # :nocov: on older Ruby without Warning
             Warning[:deprecated] = true
+            # :nocov:
           end
           $VERBOSE = true
         end

data/lib/rspec/core/ordering.rb

@@ -78,6 +78,30 @@ module RSpec
         end
       end
 
+      # @private
+      # A strategy which delays looking up the ordering until needed
+      class Delayed
+        def initialize(registry, name)
+          @registry = registry
+          @name = name
+        end
+
+        def order(list)
+          strategy.order(list)
+        end
+
+        private
+
+        def strategy
+          @strategy ||= lookup_strategy
+        end
+
+        def lookup_strategy
+          raise "Undefined ordering strategy #{@name.inspect}" unless @registry.has_strategy?(@name)
+          @registry.fetch(@name)
+        end
+      end
+
       # @private
       # Stores the different ordering strategies.
       class Registry
@@ -99,6 +123,10 @@ module RSpec
           @strategies.fetch(name, &fallback)
         end
 
+        def has_strategy?(name)
+          @strategies.key?(name)
+        end
+
         def register(sym, strategy)
           @strategies[sym] = strategy
         end
@@ -143,9 +171,20 @@ module RSpec
                             :defined
                           elsif order == 'recently-modified'
                             :recently_modified
+                          else
+                            order.to_sym
                           end
 
-          register_ordering(:global, ordering_registry.fetch(ordering_name)) if ordering_name
+          if ordering_name
+            strategy =
+              if ordering_registry.has_strategy?(ordering_name)
+                ordering_registry.fetch(ordering_name)
+              else
+                Delayed.new(ordering_registry, ordering_name)
+              end
+
+            register_ordering(:global, strategy)
+          end
         end
 
         def force(hash)

data/lib/rspec/core/output_wrapper.rb

@@ -15,13 +15,13 @@ module RSpec
       end
 
       def method_missing(name, *args, &block)
-        output.send(name, *args, &block)
+        output.__send__(name, *args, &block)
       end
 
       # Redirect calls for IO interface methods
       IO.instance_methods(false).each do |method|
         define_method(method) do |*args, &block|
-          output.send(method, *args, &block)
+          output.__send__(method, *args, &block)
         end
       end
     end

data/lib/rspec/core/pending.rb

@@ -59,7 +59,7 @@ module RSpec
       #   executed. If you need to consider hooks as pending as well you can use
       #   the pending metadata as an alternative, e.g.
       #   `it "does something", pending: "message"`.
-      def pending(message=nil)
+      def pending(message=nil, &_block)
         current_example = RSpec.current_example
 
         if block_given?

data/lib/rspec/core/rake_task.rb

@@ -47,6 +47,7 @@ module RSpec
 
       if RUBY_VERSION < "1.9.0" || Support::Ruby.jruby?
         # Run RSpec with a clean (empty) environment is not supported
+        # :nocov:
         def with_clean_environment=(_value)
           raise ArgumentError, "Running in a clean environment is not supported on Ruby versions before 1.9.0"
         end
@@ -55,6 +56,7 @@ module RSpec
         def with_clean_environment
           false
         end
+        # :nocov:
       else
         # Run RSpec with a clean (empty) environment.
         attr_accessor :with_clean_environment

data/lib/rspec/core/reporter.rb

@@ -172,10 +172,11 @@ module RSpec::Core
     # @private
     def finish
       close_after do
-        stop
+        examples_notification = Notifications::ExamplesNotification.new(self)
+        stop(examples_notification)
         notify :start_dump,    Notifications::NullNotification
-        notify :dump_pending,  Notifications::ExamplesNotification.new(self)
-        notify :dump_failures, Notifications::ExamplesNotification.new(self)
+        notify :dump_pending,  examples_notification
+        notify :dump_failures, examples_notification
         notify :deprecation_summary, Notifications::NullNotification
         unless mute_profile_output?
           notify :dump_profile, Notifications::ProfileNotification.new(@duration, @examples,
@@ -197,9 +198,9 @@ module RSpec::Core
     end
 
     # @private
-    def stop
+    def stop(notification)
       @duration = (RSpec::Core::Time.now - @start).to_f if @start
-      notify :stop, Notifications::ExamplesNotification.new(self)
+      notify :stop, notification
     end
 
     # @private

data/lib/rspec/core/runner.rb

@@ -182,7 +182,11 @@ module RSpec
           exit!(1)
         else
           RSpec.world.wants_to_quit = true
-          $stderr.puts "\nRSpec is shutting down and will print the summary report... Interrupt again to force quit."
+
+          $stderr.puts(
+            "\nRSpec is shutting down and will print the summary report... Interrupt again to force quit " \
+            "(warning: at_exit hooks will be skipped if you force quit)."
+          )
         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.12.2'
+      STRING = '3.13.5'
     end
   end
 end