rspec-core 3.2.3 → 3.3.0

data/lib/rspec/core/configuration_options.rb

@@ -1,6 +1,5 @@
 require 'erb'
 require 'shellwords'
-require 'set'
 
 module RSpec
   module Core
@@ -53,12 +52,12 @@ module RSpec
         end
       end
 
-      UNFORCED_OPTIONS = [
+      UNFORCED_OPTIONS = Set.new([
         :requires, :profile, :drb, :libs, :files_or_directories_to_run,
         :full_description, :full_backtrace, :tty
-      ].to_set
+      ])
 
-      UNPROCESSABLE_OPTIONS = [:formatters].to_set
+      UNPROCESSABLE_OPTIONS = Set.new([:formatters])
 
       def force?(key)
         !UNFORCED_OPTIONS.include?(key)
@@ -82,7 +81,7 @@ module RSpec
 
         # `files_or_directories_to_run` uses `default_path` so it must be
         # set before it.
-        :default_path,
+        :default_path, :only_failures,
 
         # These must be set before `requires` to support checking
         # `config.files_to_run` from within `spec_helper.rb` when a
@@ -120,11 +119,16 @@ module RSpec
       end
 
       def env_options
-        ENV["SPEC_OPTS"] ? Parser.parse(Shellwords.split(ENV["SPEC_OPTS"])) : {}
+        return {} unless ENV['SPEC_OPTS']
+
+        parse_args_ignoring_files_or_dirs_to_run(
+          Shellwords.split(ENV["SPEC_OPTS"]),
+          "ENV['SPEC_OPTS']"
+        )
       end
 
       def command_line_options
-        @command_line_options ||= Parser.parse(@args).merge :files_or_directories_to_run => @args
+        @command_line_options ||= Parser.parse(@args)
       end
 
       def custom_options
@@ -144,7 +148,14 @@ module RSpec
       end
 
       def options_from(path)
-        Parser.parse(args_from_options_file(path))
+        args = args_from_options_file(path)
+        parse_args_ignoring_files_or_dirs_to_run(args, path)
+      end
+
+      def parse_args_ignoring_files_or_dirs_to_run(args, source)
+        options = Parser.parse(args, source)
+        options.delete(:files_or_directories_to_run)
+        options
       end
 
       def args_from_options_file(path)
@@ -162,11 +173,11 @@ module RSpec
       end
 
       def project_options_file
-        ".rspec"
+        "./.rspec"
       end
 
       def local_options_file
-        ".rspec-local"
+        "./.rspec-local"
       end
 
       def global_options_file

data/lib/rspec/core/example.rb

@@ -92,15 +92,32 @@ module RSpec
         inspect_output
       end
 
-      # Returns the argument that can be passed to the `rspec` command to rerun this example.
-      def rerun_argument
-        loaded_spec_files = RSpec.configuration.loaded_spec_files
+      # Returns the location-based argument that can be passed to the `rspec` command to rerun this example.
+      def location_rerun_argument
+        @location_rerun_argument ||= begin
+          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])
+          Metadata.ascending(metadata) do |meta|
+            return meta[:location] if loaded_spec_files.include?(meta[:absolute_file_path])
+          end
         end
       end
 
+      # Returns the location-based argument that can be passed to the `rspec` command to rerun this example.
+      #
+      # @deprecated Use {#location_rerun_argument} instead.
+      # @note If there are multiple examples identified by this location, they will use {#id}
+      #   to rerun instead, but this method will still return the location (that's why it is deprecated!).
+      def rerun_argument
+        location_rerun_argument
+      end
+
+      # @return [String] the unique id of this example. Pass
+      #   this at the command line to re-run this exact example.
+      def id
+        @id ||= Metadata.id_from(metadata)
+      end
+
       # @attr_reader
       #
       # Returns the first exception raised in the context of running this
@@ -138,13 +155,24 @@ module RSpec
         @example_block       = example_block
 
         @metadata = Metadata::ExampleHash.create(
-          @example_group_class.metadata, user_metadata, description, example_block
+          @example_group_class.metadata, user_metadata,
+          example_group_class.method(:next_runnable_index_for),
+          description, example_block
         )
 
+        # This should perhaps be done in `Metadata::ExampleHash.create`,
+        # but the logic there has no knowledge of `RSpec.world` and we
+        # want to keep it that way. It's easier to just assign it here.
+        @metadata[:last_run_status] = RSpec.configuration.last_run_statuses[id]
+
         @example_group_instance = @exception = nil
         @clock = RSpec::Core::Time
+        @reporter = RSpec::Core::NullReporter
       end
 
+      # @return [RSpec::Core::Reporter] the current reporter for the example
+      attr_reader :reporter
+
       # Returns the example group class that provides the context for running
       # this example.
       def example_group
@@ -160,6 +188,7 @@ module RSpec
       # @param example_group_instance the instance of an ExampleGroup subclass
       def run(example_group_instance, reporter)
         @example_group_instance = example_group_instance
+        @reporter = reporter
         hooks.register_global_singleton_context_hooks(self, RSpec.configuration.hooks)
         RSpec.configuration.configure_example(self)
         RSpec.current_example = self
@@ -196,10 +225,7 @@ module RSpec
         rescue Exception => e
           set_exception(e)
         ensure
-          ExampleGroup.each_instance_variable_for_example(@example_group_instance) do |ivar|
-            @example_group_instance.instance_variable_set(ivar, nil)
-          end
-          @example_group_instance = nil
+          @example_group_instance = nil # if you love something... let it go
         end
 
         finish(reporter)
@@ -278,29 +304,55 @@ module RSpec
 
       # @private
       #
-      # Used internally to set an exception in an after hook, which
-      # captures the exception but doesn't raise it.
-      def set_exception(exception, context=nil)
-        if pending? && !(Pending::PendingExampleFixedError === exception)
-          execution_result.pending_exception = exception
+      # The exception that will be displayed to the user -- either the failure of
+      # the example or the `pending_exception` if the example is pending.
+      def display_exception
+        @exception || execution_result.pending_exception
+      end
+
+      # @private
+      #
+      # Assigns the exception that will be displayed to the user -- either the failure of
+      # the example or the `pending_exception` if the example is pending.
+      def display_exception=(ex)
+        if pending? && !(Pending::PendingExampleFixedError === ex)
+          @exception = nil
+          execution_result.pending_fixed = false
+          execution_result.pending_exception = ex
         else
-          if @exception
-            # An error has already been set; we don't want to override it,
-            # but we also don't want silence the error, so let's print it.
-            msg = <<-EOS
+          @exception = ex
+        end
+      end
 
-  An error occurred #{context}
-    #{exception.class}: #{exception.message}
-    occurred at #{exception.backtrace.first}
+      # rubocop:disable Style/AccessorMethodName
 
-            EOS
-            RSpec.configuration.reporter.message(msg)
-          end
+      # @private
+      #
+      # Used internally to set an exception in an after hook, which
+      # captures the exception but doesn't raise it.
+      def set_exception(exception)
+        return self.display_exception = exception unless display_exception
 
-          @exception ||= exception
+        unless RSpec::Core::MultipleExceptionError === display_exception
+          self.display_exception = RSpec::Core::MultipleExceptionError.new(display_exception)
         end
+
+        display_exception.add exception
+      end
+
+      # @private
+      #
+      # Used to set the exception when `aggregate_failures` fails.
+      def set_aggregate_failures_exception(exception)
+        return set_exception(exception) unless display_exception
+
+        exception = RSpec::Core::MultipleExceptionError::InterfaceTag.for(exception)
+        exception.add display_exception
+        self.display_exception = exception
       end
 
+      # rubocop:enable Style/AccessorMethodName
+
       # @private
       #
       # Used internally to set an exception and fail without actually executing
@@ -321,13 +373,6 @@ module RSpec
         finish(reporter)
       end
 
-      # @private
-      def instance_exec_with_rescue(context, &block)
-        @example_group_instance.instance_exec(self, &block)
-      rescue Exception => e
-        set_exception(e, context)
-      end
-
       # @private
       def instance_exec(*args, &block)
         @example_group_instance.instance_exec(*args, &block)
@@ -342,7 +387,7 @@ module RSpec
       def with_around_example_hooks
         hooks.run(:around, :example, self) { yield }
       rescue Exception => e
-        set_exception(e, "in an `around(:example)` hook")
+        set_exception(e)
       end
 
       def start(reporter)
@@ -398,13 +443,7 @@ module RSpec
       def verify_mocks
         @example_group_instance.verify_mocks_for_rspec if mocks_need_verification?
       rescue Exception => e
-        if pending?
-          execution_result.pending_fixed = false
-          execution_result.pending_exception = e
-          @exception = nil
-        else
-          set_exception(e)
-        end
+        set_exception(e)
       end
 
       def mocks_need_verification?
@@ -431,14 +470,6 @@ module RSpec
         "example at #{location}"
       end
 
-      def skip_message
-        if String === skip
-          skip
-        else
-          Pending::NO_REASON_GIVEN
-        end
-      end
-
       # Represents the result of executing an example.
       # Behaves like a hash for backwards compatibility.
       class ExecutionResult
@@ -529,10 +560,13 @@ module RSpec
         super(AnonymousExampleGroup, "", {})
       end
 
+      # rubocop:disable Style/AccessorMethodName
+
       # To ensure we don't silence errors.
-      def set_exception(exception, _context=nil)
+      def set_exception(exception)
         raise exception
       end
+      # rubocop:enable Style/AccessorMethodName
     end
   end
 end

data/lib/rspec/core/example_group.rb

@@ -142,8 +142,9 @@ module RSpec
           options.update(:skip => RSpec::Core::Pending::NOT_YET_IMPLEMENTED) unless block
           options.update(extra_options)
 
-          examples << RSpec::Core::Example.new(self, desc, options, block)
-          examples.last
+          example = RSpec::Core::Example.new(self, desc, options, block)
+          examples << example
+          example
         end
       end
 
@@ -230,7 +231,7 @@ module RSpec
       # @see DSL#describe
       def self.define_example_group_method(name, metadata={})
         idempotently_define_singleton_method(name) do |*args, &example_group_block|
-          thread_data = RSpec.thread_local_metadata
+          thread_data = RSpec::Support.thread_local_data
           top_level   = self == ExampleGroup
 
           if top_level
@@ -359,7 +360,6 @@ module RSpec
       def self.subclass(parent, description, args, &example_group_block)
         subclass = Class.new(parent)
         subclass.set_it_up(description, *args, &example_group_block)
-        ExampleGroups.assign_const(subclass)
         subclass.module_exec(&example_group_block) if example_group_block
 
         # The LetDefinitions module must be included _after_ other modules
@@ -372,7 +372,7 @@ module RSpec
       end
 
       # @private
-      def self.set_it_up(*args, &example_group_block)
+      def self.set_it_up(description, *args, &example_group_block)
         # Ruby 1.9 has a bug that can lead to infinite recursion and a
         # SystemStackError if you include a module in a superclass after
         # including it in a subclass: https://gist.github.com/845896
@@ -383,13 +383,14 @@ module RSpec
         # here.
         ensure_example_groups_are_configured
 
-        description = args.shift
         user_metadata = Metadata.build_hash_from(args)
-        args.unshift(description)
 
         @metadata = Metadata::ExampleGroupHash.create(
-          superclass_metadata, user_metadata, *args, &example_group_block
+          superclass_metadata, user_metadata,
+          superclass.method(:next_runnable_index_for),
+          description, *args, &example_group_block
         )
+        ExampleGroups.assign_const(self)
 
         hooks.register_globals(self, RSpec.configuration.hooks)
         RSpec.configuration.configure_group(self)
@@ -416,6 +417,15 @@ module RSpec
         @children ||= []
       end
 
+      # @private
+      def self.next_runnable_index_for(file)
+        if self == ExampleGroup
+          RSpec.world.num_example_groups_defined_in(file)
+        else
+          children.count + examples.count
+        end + 1
+      end
+
       # @private
       def self.descendants
         @_descendants ||= [self] + FlatMap.flat_map(children, &:descendants)
@@ -428,7 +438,7 @@ module RSpec
 
       # @private
       def self.top_level?
-        @top_level ||= superclass == ExampleGroup
+        superclass == ExampleGroup
       end
 
       # @private
@@ -458,7 +468,7 @@ module RSpec
       def self.run_before_context_hooks(example_group_instance)
         set_ivars(example_group_instance, superclass_before_context_ivars)
 
-        ContextHookMemoizedHash::Before.isolate_for_context_hook(example_group_instance) do
+        ContextHookMemoized::Before.isolate_for_context_hook(example_group_instance) do
           hooks.run(:before, :context, example_group_instance)
         end
       ensure
@@ -471,6 +481,7 @@ module RSpec
           superclass.before_context_ivars
         end
       else # 1.8.7
+        # :nocov:
         # @private
         def self.superclass_before_context_ivars
           if superclass.respond_to?(:before_context_ivars)
@@ -485,13 +496,14 @@ module RSpec
             ancestors.find { |a| a.respond_to?(:before_context_ivars) }.before_context_ivars
           end
         end
+        # :nocov:
       end
 
       # @private
       def self.run_after_context_hooks(example_group_instance)
         set_ivars(example_group_instance, before_context_ivars)
 
-        ContextHookMemoizedHash::After.isolate_for_context_hook(example_group_instance) do
+        ContextHookMemoized::After.isolate_for_context_hook(example_group_instance) do
           hooks.run(:after, :context, example_group_instance)
         end
       ensure
@@ -499,11 +511,8 @@ module RSpec
       end
 
       # Runs all the examples in this group.
-      def self.run(reporter=RSpec::Core::NullReporter.new)
-        if RSpec.world.wants_to_quit
-          RSpec.world.clear_remaining_example_groups if top_level?
-          return
-        end
+      def self.run(reporter=RSpec::Core::NullReporter)
+        return if RSpec.world.wants_to_quit
         reporter.example_group_started(self)
 
         should_run_context_hooks = descendant_filtered_examples.any?
@@ -518,6 +527,7 @@ module RSpec
         rescue Exception => ex
           RSpec.world.wants_to_quit = true if fail_fast?
           for_filtered_examples(reporter) { |example| example.fail_with_exception(reporter, ex) }
+          false
         ensure
           run_after_context_hooks(new('after(:context) hook')) if should_run_context_hooks
           reporter.example_group_finished(self)
@@ -576,6 +586,12 @@ module RSpec
           FlatMap.flat_map(children, &:declaration_line_numbers)
       end
 
+      # @return [String] the unique id of this example group. Pass
+      #   this at the command line to re-run this exact example group.
+      def self.id
+        Metadata.id_from(metadata)
+      end
+
       # @private
       def self.top_level_description
         parent_groups.last.description
@@ -587,8 +603,10 @@ module RSpec
       end
 
       if RUBY_VERSION.to_f < 1.9
+        # :nocov:
         # @private
         INSTANCE_VARIABLE_TO_IGNORE = '@__inspect_output'.freeze
+        # :nocov:
       else
         # @private
         INSTANCE_VARIABLE_TO_IGNORE = :@__inspect_output
@@ -603,6 +621,7 @@ module RSpec
 
       def initialize(inspect_output=nil)
         @__inspect_output = inspect_output || '(no description provided)'
+        super() # no args get passed
       end
 
       # @private
@@ -611,10 +630,12 @@ module RSpec
       end
 
       unless method_defined?(:singleton_class) # for 1.8.7
+        # :nocov:
         # @private
         def singleton_class
           class << self; self; end
         end
+        # :nocov:
       end
 
       # Raised when an RSpec API is called in the wrong scope, such as `before`
@@ -689,17 +710,22 @@ module RSpec
 
       # @private
       def self.current_backtrace
-        RSpec.thread_local_metadata[:shared_example_group_inclusions].reverse
+        shared_example_group_inclusions.reverse
       end
 
       # @private
       def self.with_frame(name, location)
-        current_stack = RSpec.thread_local_metadata[:shared_example_group_inclusions]
+        current_stack = shared_example_group_inclusions
         current_stack << new(name, location)
         yield
       ensure
         current_stack.pop
       end
+
+      # @private
+      def self.shared_example_group_inclusions
+        RSpec::Support.thread_local_data[:shared_example_group_inclusions] ||= []
+      end
     end
   end
 
@@ -746,6 +772,7 @@ module RSpec
     end
 
     if RUBY_VERSION == '1.9.2'
+      # :nocov:
       class << self
         alias _base_name_for base_name_for
         def base_name_for(group)
@@ -753,6 +780,7 @@ module RSpec
         end
       end
       private_class_method :_base_name_for
+      # :nocov:
     end
 
     def self.disambiguate(name, const_scope)