rspec-core 3.0.4 → 3.12.2

data/lib/rspec/core/warnings.rb

@@ -6,8 +6,8 @@ module RSpec
     module Warnings
       # @private
       #
-      # Used internally to print deprecation warnings
-      def deprecate(deprecated, data = {})
+      # Used internally to print deprecation warnings.
+      def deprecate(deprecated, data={})
         RSpec.configuration.reporter.deprecation(
           {
             :deprecated => deprecated,
@@ -18,13 +18,13 @@ module RSpec
 
       # @private
       #
-      # Used internally to print deprecation warnings
-      def warn_deprecation(message, opts = {})
-        RSpec.configuration.reporter.deprecation opts.merge( :message => message )
+      # Used internally to print deprecation warnings.
+      def warn_deprecation(message, opts={})
+        RSpec.configuration.reporter.deprecation opts.merge(:message => message)
       end
 
       # @private
-      def warn_with(message, options = {})
+      def warn_with(message, options={})
         if options[:use_spec_location_as_call_site]
           message += "." unless message.end_with?(".")
 

data/lib/rspec/core/world.rb

@@ -2,44 +2,53 @@ module RSpec
   module Core
     # @api private
     #
-    # Internal container for global non-configuration data
+    # Internal container for global non-configuration data.
     class World
+      # @private
+      attr_reader :example_groups, :filtered_examples, :example_group_counts_by_spec_file
 
-      include RSpec::Core::Hooks
+      # Used internally to determine what to do when a SIGINT is received.
+      attr_accessor :wants_to_quit
 
+      # Used internally to signify that a SystemExit occurred in
+      # `Configuration#load_file_handling_errors`, and thus examples cannot
+      # be counted accurately. Specifically, we cannot accurately report
+      # "No examples found".
       # @private
-      attr_reader :example_groups, :filtered_examples
+      attr_accessor :rspec_is_quitting
 
-      # Used internally to determine what to do when a SIGINT is received
-      attr_accessor :wants_to_quit
+      # Used internally to signal that a failure outside of an example
+      # has occurred, and that therefore the exit status should indicate
+      # the run failed.
+      # @private
+      attr_accessor :non_example_failure
 
       def initialize(configuration=RSpec.configuration)
+        @wants_to_quit = false
+        @rspec_is_quitting = false
         @configuration = configuration
+        configuration.world = self
         @example_groups = []
-        @filtered_examples = Hash.new { |hash,group|
-          hash[group] = begin
-            examples = group.examples.dup
-            examples = filter_manager.prune(examples)
-            examples.uniq!
-            examples
-          end
-        }
-      end
-
-      # @private
-      # Used internally to clear remaining groups when fail_fast is set
-      def clear_remaining_example_groups
-        example_groups.clear
+        @example_group_counts_by_spec_file = Hash.new(0)
+        prepare_example_filtering
       end
 
-      # @private
-      def windows_os?
-        RbConfig::CONFIG['host_os'] =~ /cygwin|mswin|mingw|bccwin|wince|emx/
+      # @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
       end
 
       # @api private
       #
-      # Apply ordering strategy from configuration to example groups
+      # Apply ordering strategy from configuration to example groups.
       def ordered_example_groups
         ordering_strategy = @configuration.ordering_registry.fetch(:global)
         ordering_strategy.order(@example_groups)
@@ -47,10 +56,13 @@ module RSpec
 
       # @api private
       #
-      # Reset world to 'scratch' before running suite
+      # Reset world to 'scratch' before running suite.
       def reset
+        RSpec::ExampleGroups.remove_all_constants
         example_groups.clear
-        @shared_example_group_registry = nil
+        @sources_by_path.clear if defined?(@sources_by_path)
+        @syntax_highlighter = nil
+        @example_group_counts_by_spec_file = Hash.new(0)
       end
 
       # @private
@@ -58,12 +70,22 @@ module RSpec
         @configuration.filter_manager
       end
 
+      # @private
+      def registered_example_group_files
+        @example_group_counts_by_spec_file.keys
+      end
+
       # @api private
       #
-      # Register an example group
-      def register(example_group)
-        example_groups << example_group
-        example_group
+      # Records an example group.
+      def record(example_group)
+        @configuration.on_example_group_definition_callbacks.each { |block| block.call(example_group) }
+        @example_group_counts_by_spec_file[example_group.metadata[:absolute_file_path]] += 1
+      end
+
+      # @private
+      def num_example_groups_defined_in(file)
+        @example_group_counts_by_spec_file[file]
       end
 
       # @private
@@ -81,26 +103,46 @@ module RSpec
         @configuration.exclusion_filter
       end
 
-      # @private
-      def configure_group(group)
-        @configuration.configure_group(group)
-      end
-
       # @api private
       #
-      # Get count of examples to be run
+      # Get count of examples to be run.
       def example_count(groups=example_groups)
-        FlatMap.flat_map(groups) {|g| g.descendants}.
-          inject(0) {|sum, g| sum + g.filtered_examples.size}
+        FlatMap.flat_map(groups) { |g| g.descendants }.
+          inject(0) { |a, e| a + e.filtered_examples.size }
+      end
+
+      # @private
+      def all_example_groups
+        FlatMap.flat_map(example_groups) { |g| g.descendants }
+      end
+
+      # @private
+      def all_examples
+        FlatMap.flat_map(all_example_groups) { |g| g.examples }
+      end
+
+      # @private
+      # Traverses the tree of each top level group.
+      # For each it yields the group, then the children, recursively.
+      # Halts the traversal of a branch of the tree as soon as the passed block returns true.
+      # Note that siblings groups and their sub-trees will continue to be explored.
+      # This is intended to make it easy to find the top-most group that satisfies some
+      # condition.
+      def traverse_example_group_trees_until(&block)
+        example_groups.each do |group|
+          group.traverse_tree_until(&block)
+        end
       end
 
       # @api private
       #
-      # Find line number of previous declaration
-      def preceding_declaration_line(filter_line)
-        declaration_line_numbers.sort.inject(nil) do |highest_prior_declaration_line, line|
-          line <= filter_line ? line : highest_prior_declaration_line
+      # Find line number of previous declaration.
+      def preceding_declaration_line(absolute_file_name, filter_line)
+        line_numbers = descending_declaration_line_numbers_by_file.fetch(absolute_file_name) do
+          return nil
         end
+
+        line_numbers.find { |num| num <= filter_line }
       end
 
       # @private
@@ -108,10 +150,26 @@ module RSpec
         @configuration.reporter
       end
 
+      # @private
+      def source_from_file(path)
+        unless defined?(@sources_by_path)
+          RSpec::Support.require_rspec_support 'source'
+          @sources_by_path = {}
+        end
+
+        @sources_by_path[path] ||= Support::Source.from_file(path)
+      end
+
+      # @private
+      def syntax_highlighter
+        @syntax_highlighter ||= Formatters::SyntaxHighlighter.new(@configuration)
+      end
+
       # @api private
       #
-      # Notify reporter of filters
+      # Notify reporter of filters.
       def announce_filters
+        fail_if_config_and_cli_options_invalid
         filter_announcements = []
 
         announce_inclusion_filter filter_announcements
@@ -119,34 +177,35 @@ module RSpec
 
         unless filter_manager.empty?
           if filter_announcements.length == 1
-            reporter.message("Run options: #{filter_announcements[0]}")
+            report_filter_message("Run options: #{filter_announcements[0]}")
           else
-            reporter.message("Run options:\n  #{filter_announcements.join("\n  ")}")
+            report_filter_message("Run options:\n  #{filter_announcements.join("\n  ")}")
           end
         end
 
-        if @configuration.run_all_when_everything_filtered? && example_count.zero?
-          reporter.message("#{everything_filtered_message}; ignoring #{inclusion_filter.description}")
+        if @configuration.run_all_when_everything_filtered? && example_count.zero? && !@configuration.only_failures?
+          report_filter_message("#{everything_filtered_message}; ignoring #{inclusion_filter.description}")
           filtered_examples.clear
           inclusion_filter.clear
         end
 
-        if example_count.zero?
-          example_groups.clear
+        return unless example_count.zero?
+
+        example_groups.clear
+        unless rspec_is_quitting
           if filter_manager.empty?
-            reporter.message("No examples found.")
-          elsif exclusion_filter.empty?
-            message = everything_filtered_message
-            if @configuration.run_all_when_everything_filtered?
-              message << "; ignoring #{inclusion_filter.description}"
-            end
-            reporter.message(message)
-          elsif inclusion_filter.empty?
-            reporter.message(everything_filtered_message)
+            report_filter_message("No examples found.")
+          elsif exclusion_filter.empty? || inclusion_filter.empty?
+            report_filter_message(everything_filtered_message)
           end
         end
       end
 
+      # @private
+      def report_filter_message(message)
+        reporter.message(message) unless @configuration.silence_filter_announcements?
+      end
+
       # @private
       def everything_filtered_message
         "\nAll examples were filtered out"
@@ -154,30 +213,75 @@ module RSpec
 
       # @api private
       #
-      # Add inclusion filters to announcement message
+      # Add inclusion filters to announcement message.
       def announce_inclusion_filter(announcements)
-        unless inclusion_filter.empty?
-          announcements << "include #{inclusion_filter.description}"
-        end
+        return if inclusion_filter.empty?
+
+        announcements << "include #{inclusion_filter.description}"
       end
 
       # @api private
       #
-      # Add exclusion filters to announcement message
+      # Add exclusion filters to announcement message.
       def announce_exclusion_filter(announcements)
-        unless exclusion_filter.empty?
-          announcements << "exclude #{exclusion_filter.description}"
-        end
+        return if exclusion_filter.empty?
+
+        announcements << "exclude #{exclusion_filter.description}"
       end
 
     private
 
-      def declaration_line_numbers
-        @line_numbers ||= example_groups.inject([]) do |lines, g|
-          lines + g.declaration_line_numbers
+      def descending_declaration_line_numbers_by_file
+        @descending_declaration_line_numbers_by_file ||= begin
+          declaration_locations = FlatMap.flat_map(example_groups, &:declaration_locations)
+          hash_of_arrays = Hash.new { |h, k| h[k] = [] }
+
+          # TODO: change `inject` to `each_with_object` when we drop 1.8.7 support.
+          line_nums_by_file = declaration_locations.inject(hash_of_arrays) do |hash, (file_name, line_number)|
+            hash[file_name] << line_number
+            hash
+          end
+
+          line_nums_by_file.each_value do |list|
+            list.sort!
+            list.reverse!
+          end
         end
       end
 
+      def fail_if_config_and_cli_options_invalid
+        return unless @configuration.only_failures_but_not_configured?
+
+        reporter.abort_with(
+          "\nTo use `--only-failures`, you must first set " \
+          "`config.example_status_persistence_file_path`.",
+          1 # exit code
+        )
+      end
+
+      # @private
+      # Provides a null implementation for initial use by configuration.
+      module Null
+        def self.non_example_failure; end
+        def self.non_example_failure=(_); end
+
+        def self.registered_example_group_files
+          []
+        end
+
+        def self.traverse_example_group_trees_until
+        end
+
+        # :nocov:
+        def self.example_groups
+          []
+        end
+
+        def self.all_example_groups
+          []
+        end
+        # :nocov:
+      end
     end
   end
 end

data/lib/rspec/core.rb

@@ -1,5 +1,6 @@
+# rubocop:disable Style/GlobalVars
 $_rspec_core_load_started_at = Time.now
-require 'rbconfig'
+# rubocop:enable Style/GlobalVars
 
 require "rspec/support"
 RSpec::Support.require_rspec_support "caller_filter"
@@ -10,6 +11,7 @@ RSpec::Support.define_optimized_require_for_rspec(:core) { |f| require_relative
   version
   warnings
 
+  set
   flat_map
   filter_manager
   dsl
@@ -29,6 +31,7 @@ RSpec::Support.define_optimized_require_for_rspec(:core) { |f| require_relative
   option_parser
   configuration_options
   runner
+  invocations
   example
   shared_example_group
   example_group
@@ -40,18 +43,39 @@ module RSpec
 
   extend RSpec::Core::Warnings
 
-  # Used to ensure examples get reloaded between multiple runs in
-  # the same process.
+  class << self
+    # Setters for shared global objects
+    # @api private
+    attr_writer :configuration, :world
+  end
+
+  # Used to ensure examples get reloaded and user configuration gets reset to
+  # defaults between multiple runs in the same process.
   #
   # Users must invoke this if they want to have the configuration reset when
-  # they use runner multiple times within the same process.
+  # they use the runner multiple times within the same process. Users must deal
+  # themselves with re-configuration of RSpec before run.
   def self.reset
+    RSpec::ExampleGroups.remove_all_constants
     @world = nil
     @configuration = nil
   end
 
-  # Returns the global [Configuration](RSpec/Core/Configuration) object. While you
-  # _can_ use this method to access the configuration, the more common
+  # Used to ensure examples get reloaded between multiple runs in the same
+  # process and ensures user configuration is persisted.
+  #
+  # Users must invoke this if they want to clear all examples but preserve
+  # current configuration when they use the runner multiple times within the
+  # same process.
+  def self.clear_examples
+    world.reset
+    configuration.reset_reporter
+    configuration.start_time = ::RSpec::Core::Time.now
+    configuration.reset_filters
+  end
+
+  # Returns the global [Configuration](RSpec/Core/Configuration) object. While
+  # you _can_ use this method to access the configuration, the more common
   # convention is to use [RSpec.configure](RSpec#configure-class_method).
   #
   # @example
@@ -59,12 +83,7 @@ module RSpec
   # @see RSpec.configure
   # @see Core::Configuration
   def self.configuration
-    @configuration ||= begin
-                         config = RSpec::Core::Configuration.new
-                         config.expose_dsl_globally = true
-                         config
-                       end
-
+    @configuration ||= RSpec::Core::Configuration.new
   end
 
   # Yields the global configuration to a block.
@@ -101,30 +120,53 @@ module RSpec
   #     end
   #
   def self.current_example
-    thread_local_metadata[:current_example]
+    RSpec::Support.thread_local_data[:current_example]
   end
 
   # Set the current example being executed.
   # @api private
   def self.current_example=(example)
-    thread_local_metadata[:current_example] = example
+    RSpec::Support.thread_local_data[:current_example] = example
   end
 
-  # @private
-  # A single thread local variable so we don't excessively pollute that
-  # namespace.
-  def self.thread_local_metadata
-    Thread.current[:_rspec] ||= {}
+  # Set the current scope rspec is executing in
+  # @api private
+  def self.current_scope=(scope)
+    RSpec::Support.thread_local_data[:current_scope] = scope
+  end
+  RSpec.current_scope = :suite
+
+  # Get the current RSpec execution scope
+  #
+  # Returns (in order of lifecycle):
+  #   * `:suite` as an initial value, this is outside of the test lifecycle.
+  #   * `:before_suite_hook` during `before(:suite)` hooks.
+  #   * `:before_context_hook` during `before(:context)` hooks.
+  #   * `:before_example_hook` during `before(:example)` hooks and `around(:example)` before `example.run`.
+  #   * `:example` within the example run.
+  #   * `:after_example_hook` during `after(:example)` hooks and `around(:example)` after `example.run`.
+  #   * `:after_context_hook` during `after(:context)` hooks.
+  #   * `:after_suite_hook` during `after(:suite)` hooks.
+  #   * `:suite` as a final value, again this is outside of the test lifecycle.
+  #
+  # Reminder, `:context` hooks have `:all` alias and `:example` hooks have `:each` alias.
+  # @return [Symbol]
+  def self.current_scope
+    RSpec::Support.thread_local_data[:current_scope]
   end
 
   # @private
-  # Internal container for global non-configuration data
+  # Internal container for global non-configuration data.
   def self.world
     @world ||= RSpec::Core::World.new
   end
 
   # Namespace for the rspec-core code.
   module Core
+    autoload :ExampleStatusPersister, "rspec/core/example_status_persister"
+    autoload :Profiler,               "rspec/core/profiler"
+    autoload :DidYouMean,             "rspec/core/did_you_mean"
+
     # @private
     # This avoids issues with reporting time caused by examples that
     # change the value/meaning of Time.now without properly restoring
@@ -135,7 +177,7 @@ module RSpec
       end
     end
 
-    # @private path to executable file
+    # @private path to executable file.
     def self.path_to_executable
       @path_to_executable ||= File.expand_path('../../../exe/rspec', __FILE__)
     end
@@ -164,4 +206,7 @@ module RSpec
     require MODULES_TO_AUTOLOAD.fetch(name) { return super }
     ::RSpec.const_get(name)
   end
+
+  Core::DSL.expose_globally!
+  Core::SharedExampleGroup::TopLevelDSL.expose_globally!
 end