rspec-core 3.0.4 → 3.12.2

data/lib/rspec/core/profiler.rb

@@ -0,0 +1,34 @@
+module RSpec
+  module Core
+    # @private
+    class Profiler
+      NOTIFICATIONS = [:example_group_started, :example_group_finished, :example_started]
+
+      def initialize
+        @example_groups = Hash.new { |h, k| h[k] = { :count => 0 } }
+      end
+
+      attr_reader :example_groups
+
+      def example_group_started(notification)
+        return unless notification.group.top_level?
+
+        @example_groups[notification.group][:start] = Time.now
+        @example_groups[notification.group][:description] = notification.group.top_level_description
+      end
+
+      def example_group_finished(notification)
+        return unless notification.group.top_level?
+
+        group = @example_groups[notification.group]
+        return unless group.key?(:start)
+        group[:total_time] = Time.now - group[:start]
+      end
+
+      def example_started(notification)
+        group = notification.example.example_group.parent_groups.last
+        @example_groups[group][:count] += 1
+      end
+    end
+  end
+end

data/lib/rspec/core/project_initializer/.rspec

@@ -1,3 +1 @@
---color
---warnings
 --require spec_helper

data/lib/rspec/core/project_initializer/spec/spec_helper.rb

@@ -1,29 +1,72 @@
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# The generated `.rspec` file contains `--require spec_helper` which will cause this
-# file to always be loaded, without a need to explicitly require it in any files.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
 #
 # Given that it is always loaded, you are encouraged to keep this file as
 # light-weight as possible. Requiring heavyweight dependencies from this file
 # will add to the boot time of your test suite on EVERY test run, even for an
-# individual file that may not need all of that loaded. Instead, make a
-# separate helper file that requires this one and then use it only in the specs
-# that actually need it.
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
 #
-# The `.rspec` file also contains a few flags that are not defaults but that
-# users commonly want.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
 # The settings below are suggested to provide a good initial experience
 # with RSpec, but feel free to customize to your heart's content.
 =begin
-  # These two settings work together to allow you to limit a spec run
-  # to individual examples or groups you care about by tagging them with
-  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
-  # get run.
-  config.filter_run :focus
-  config.run_all_when_everything_filtered = true
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  # https://rspec.info/features/3-12/rspec-core/configuration/zero-monkey-patching-mode/
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
 
   # Many RSpec users commonly either run the entire suite or an individual
   # file, and it's useful to allow more verbose output when running an
@@ -32,7 +75,7 @@ RSpec.configure do |config|
     # Use the documentation formatter for detailed output,
     # unless a formatter has already been configured
     # (e.g. via a command-line flag).
-    config.default_formatter = 'doc'
+    config.default_formatter = "doc"
   end
 
   # Print the 10 slowest examples and example groups at the
@@ -51,28 +94,5 @@ RSpec.configure do |config|
   # test failures related to randomization by passing the same `--seed` value
   # as the one that triggered the failure.
   Kernel.srand config.seed
-
-  # rspec-expectations config goes here. You can use an alternate
-  # assertion/expectation library such as wrong or the stdlib/minitest
-  # assertions if you prefer.
-  config.expect_with :rspec do |expectations|
-    # Enable only the newer, non-monkey-patching expect syntax.
-    # For more details, see:
-    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
-    expectations.syntax = :expect
-  end
-
-  # rspec-mocks config goes here. You can use an alternate test double
-  # library (such as bogus or mocha) by changing the `mock_with` option here.
-  config.mock_with :rspec do |mocks|
-    # Enable only the newer, non-monkey-patching expect syntax.
-    # For more details, see:
-    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
-    mocks.syntax = :expect
-
-    # Prevents you from mocking or stubbing a method that does not exist on
-    # a real object. This is generally recommended.
-    mocks.verify_partial_doubles = true
-  end
 =end
 end

data/lib/rspec/core/project_initializer.rb

@@ -1,14 +1,16 @@
+RSpec::Support.require_rspec_support "directory_maker"
+
 module RSpec
   module Core
     # @private
-    # Generates conventional files for an rspec project
+    # Generates conventional files for an RSpec project.
     class ProjectInitializer
       attr_reader :destination, :stream, :template_path
 
       DOT_RSPEC_FILE = '.rspec'
       SPEC_HELPER_FILE =  'spec/spec_helper.rb'
 
-      def initialize(opts = {})
+      def initialize(opts={})
         @destination = opts.fetch(:destination, Dir.getwd)
         @stream = opts.fetch(:report_stream, $stdout)
         @template_path = opts.fetch(:template_path) do
@@ -28,7 +30,7 @@ module RSpec
         return report_exists(file) if File.exist?(destination_file)
 
         report_creating(file)
-        FileUtils.mkdir_p(File.dirname(destination_file))
+        RSpec::Support::DirectoryMaker.mkdir_p(File.dirname(destination_file))
         File.open(destination_file, 'w') do |f|
           f.write File.read(File.join(template_path, file))
         end

data/lib/rspec/core/rake_task.rb

@@ -1,69 +1,77 @@
-require 'rspec/support'
-require 'rspec/core/version'
-RSpec::Support.require_rspec_support "warnings"
-
 require 'rake'
 require 'rake/tasklib'
-require 'shellwords'
+require 'rspec/support'
+
+RSpec::Support.require_rspec_support "ruby_features"
+
+# :nocov:
+unless RSpec::Support.respond_to?(:require_rspec_core)
+  RSpec::Support.define_optimized_require_for_rspec(:core) { |f| require_relative "../#{f}" }
+end
+# :nocov:
+
+RSpec::Support.require_rspec_core "shell_escape"
 
 module RSpec
   module Core
-    # Rspec rake task
+    # RSpec rake task
     #
     # @see Rakefile
     class RakeTask < ::Rake::TaskLib
       include ::Rake::DSL if defined?(::Rake::DSL)
+      include RSpec::Core::ShellEscape
 
-      # Default path to the rspec executable
+      # Default path to the RSpec executable.
       DEFAULT_RSPEC_PATH = File.expand_path('../../../../exe/rspec', __FILE__)
 
       # Default pattern for spec files.
-      DEFAULT_PATTERN = './spec{,/*/**}/*_spec.rb'
+      DEFAULT_PATTERN = 'spec/**{,/*/**}/*_spec.rb'
 
-      # Name of task.
-      #
-      # default:
-      #   :spec
+      # Name of task. Defaults to `:spec`.
       attr_accessor :name
 
-      # Glob pattern to match files.
-      #
-      # default:
-      #   'spec/**/*_spec.rb'
+      # Files matching this pattern will be loaded.
+      # Defaults to `'spec/**{,/*/**}/*_spec.rb'`.
       attr_accessor :pattern
 
-      # Whether or not to fail Rake when an error occurs (typically when examples fail).
-      #
-      # default:
-      #   true
+      # Files matching this pattern will be excluded.
+      # Defaults to `nil`.
+      attr_accessor :exclude_pattern
+
+      # Whether or not to fail Rake when an error occurs (typically when
+      # examples fail). Defaults to `true`.
       attr_accessor :fail_on_error
 
       # A message to print to stderr when there are failures.
       attr_accessor :failure_message
 
+      if RUBY_VERSION < "1.9.0" || Support::Ruby.jruby?
+        # Run RSpec with a clean (empty) environment is not supported
+        def with_clean_environment=(_value)
+          raise ArgumentError, "Running in a clean environment is not supported on Ruby versions before 1.9.0"
+        end
+
+        # Run RSpec with a clean (empty) environment is not supported
+        def with_clean_environment
+          false
+        end
+      else
+        # Run RSpec with a clean (empty) environment.
+        attr_accessor :with_clean_environment
+      end
+
       # Use verbose output. If this is set to true, the task will print the
-      # executed spec command to stdout.
-      #
-      # default:
-      #   true
+      # executed spec command to stdout. Defaults to `true`.
       attr_accessor :verbose
 
-      # Command line options to pass to ruby.
-      #
-      # default:
-      #   nil
+      # Command line options to pass to ruby. Defaults to `nil`.
       attr_accessor :ruby_opts
 
-      # Path to rspec
-      #
-      # default:
-      #   'rspec'
+      # Path to RSpec. Defaults to the absolute path to the
+      # rspec binary from the loaded rspec-core gem.
       attr_accessor :rspec_path
 
-      # Command line options to pass to rspec.
-      #
-      # default:
-      #   nil
+      # Command line options to pass to RSpec. Defaults to `nil`.
       attr_accessor :rspec_opts
 
       def initialize(*args, &task_block)
@@ -81,24 +89,26 @@ module RSpec
       # @private
       def run_task(verbose)
         command = spec_command
+        puts command if verbose
 
-        begin
-          puts command if verbose
-          success = system(command)
-        rescue
-          puts failure_message if failure_message
-        end
-        if fail_on_error && !success
-          $stderr.puts "#{command} failed"
-          exit $?.exitstatus
+        if with_clean_environment
+          return if system({}, command, :unsetenv_others => true)
+        else
+          return if system(command)
         end
+
+        puts failure_message if failure_message
+
+        return unless fail_on_error
+        $stderr.puts "#{command} failed" if verbose
+        exit $?.exitstatus || 1
       end
 
     private
 
       # @private
       def define(args, &task_block)
-        desc "Run RSpec code examples" unless ::Rake.application.last_comment
+        desc "Run RSpec code examples" unless ::Rake.application.last_description
 
         task name, *args do |_, task_args|
           RakeFileUtils.__send__(:verbose, verbose) do
@@ -108,35 +118,69 @@ module RSpec
         end
       end
 
-      def files_to_run
+      def file_inclusion_specification
         if ENV['SPEC']
-          FileList[ ENV['SPEC'] ].sort
+          FileList[ENV['SPEC']].sort
+        elsif String === pattern && !File.exist?(pattern)
+          return if [*rspec_opts].any? { |opt| opt =~ /--pattern/ }
+          "--pattern #{escape pattern}"
         else
-          FileList[ pattern ].sort.map(&:shellescape)
+          # Before RSpec 3.1, we used `FileList` to get the list of matched
+          # files, and then pass that along to the `rspec` command. Starting
+          # with 3.1, we prefer to pass along the pattern as-is to the `rspec`
+          # command, for 3 reasons:
+          #
+          #   * It's *much* less verbose to pass one `--pattern` option than a
+          #     long list of files.
+          #   * It ensures `task.pattern` and `--pattern` have the same
+          #     behavior.
+          #   * It fixes a bug, where
+          #     `task.pattern = pattern_that_matches_no_files` would run *all*
+          #     files because it would cause no pattern or file args to get
+          #     passed to `rspec`, which causes all files to get run.
+          #
+          # However, `FileList` is *far* more flexible than the `--pattern`
+          # option. Specifically, it supports individual files and directories,
+          # as well as arrays of files, directories and globs, as well as other
+          # `FileList` objects.
+          #
+          # For backwards compatibility, we have to fall back to using FileList
+          # if the user has passed a `pattern` option that will not work with
+          # `--pattern`.
+          #
+          # TODO: consider deprecating support for this and removing it in
+          #   RSpec 4.
+          FileList[pattern].sort.map { |file| escape file }
         end
       end
 
+      def file_exclusion_specification
+        " --exclude-pattern #{escape exclude_pattern}" if exclude_pattern
+      end
+
       def spec_command
         cmd_parts = []
         cmd_parts << RUBY
         cmd_parts << ruby_opts
         cmd_parts << rspec_load_path
-        cmd_parts << "-S" << rspec_path
-        cmd_parts << files_to_run
+        cmd_parts << escape(rspec_path)
+        cmd_parts << file_inclusion_specification
+        cmd_parts << file_exclusion_specification
         cmd_parts << rspec_opts
         cmd_parts.flatten.reject(&blank).join(" ")
       end
 
       def blank
-        lambda {|s| s.nil? || s == ""}
+        lambda { |s| s.nil? || s == "" }
       end
 
       def rspec_load_path
         @rspec_load_path ||= begin
-          core_and_support = $LOAD_PATH.grep \
-            %r{#{File::SEPARATOR}rspec-(core|support)[^#{File::SEPARATOR}]*#{File::SEPARATOR}lib}
+          core_and_support = $LOAD_PATH.grep(
+            /#{File::SEPARATOR}rspec-(core|support)[^#{File::SEPARATOR}]*#{File::SEPARATOR}lib/
+          ).uniq
 
-          "-I#{core_and_support.map(&:shellescape).join(File::PATH_SEPARATOR)}"
+          "-I#{core_and_support.map { |file| escape file }.join(File::PATH_SEPARATOR)}"
         end
       end
     end

data/lib/rspec/core/reporter.rb

@@ -2,24 +2,38 @@ module RSpec::Core
   # A reporter will send notifications to listeners, usually formatters for the
   # spec suite run.
   class Reporter
+    # @private
+    RSPEC_NOTIFICATIONS = Set.new(
+      [
+        :close, :deprecation, :deprecation_summary, :dump_failures, :dump_pending,
+        :dump_profile, :dump_summary, :example_failed, :example_group_finished,
+        :example_group_started, :example_passed, :example_pending, :example_started,
+        :message, :seed, :start, :start_dump, :stop, :example_finished
+      ])
 
     def initialize(configuration)
       @configuration = configuration
-      @listeners = Hash.new { |h,k| h[k] = Set.new }
+      @listeners = Hash.new { |h, k| h[k] = Set.new }
       @examples = []
       @failed_examples = []
       @pending_examples = []
       @duration = @start = @load_time = nil
+      @non_example_exception_count = 0
+      @setup_default = lambda {}
+      @setup = false
+      @profiler = nil
     end
 
     # @private
     attr_reader :examples, :failed_examples, :pending_examples
 
-    # Registers a listener to a list of notifications. The reporter will send notification of
-    # events to all registered listeners
+    # Registers a listener to a list of notifications. The reporter will send
+    # notification of events to all registered listeners.
     #
-    # @param listener [Object] An obect that wishes to be notified of reporter events
-    # @param notifications [Array] Array of symbols represents the events a listener wishes to subscribe too
+    # @param listener [Object] An object that wishes to be notified of reporter
+    #   events
+    # @param notifications [Array] Array of symbols represents the events a
+    #   listener wishes to subscribe too
     def register_listener(listener, *notifications)
       notifications.each do |notification|
         @listeners[notification.to_sym] << listener
@@ -27,12 +41,18 @@ module RSpec::Core
       true
     end
 
+    # @private
+    def prepare_default(loader, output_stream, deprecation_stream)
+      @setup_default = lambda do
+        loader.setup_default output_stream, deprecation_stream
+      end
+    end
+
     # @private
     def registered_listeners(notification)
       @listeners[notification].to_a
     end
 
-    # @api
     # @overload report(count, &block)
     # @overload report(count, &block)
     # @param expected_example_count [Integer] the number of examples being run
@@ -57,18 +77,42 @@ module RSpec::Core
       end
     end
 
+    # @param exit_code [Integer] the exit_code to be return by the reporter
+    #
+    # Reports a run that exited early without having run any examples.
+    #
+    def exit_early(exit_code)
+      report(0) { exit_code }
+    end
+
     # @private
-    def start(expected_example_count, time = RSpec::Core::Time.now)
+    def start(expected_example_count, time=RSpec::Core::Time.now)
       @start = time
       @load_time = (@start - @configuration.start_time).to_f
+      notify :seed, Notifications::SeedNotification.new(@configuration.seed, seed_used?)
       notify :start, Notifications::StartNotification.new(expected_example_count, @load_time)
     end
 
-    # @private
+    # @param message [#to_s] A message object to send to formatters
+    #
+    # Send a custom message to supporting formatters.
     def message(message)
       notify :message, Notifications::MessageNotification.new(message)
     end
 
+    # @param event [Symbol] Name of the custom event to trigger on formatters
+    # @param options [Hash] Hash of arguments to provide via `CustomNotification`
+    #
+    # Publish a custom event to supporting registered formatters.
+    # @see RSpec::Core::Notifications::CustomNotification
+    def publish(event, options={})
+      if RSPEC_NOTIFICATIONS.include? event
+        raise "RSpec::Core::Reporter#publish is intended for sending custom " \
+              "events not internal RSpec ones, please rename your custom event."
+      end
+      notify event, Notifications::CustomNotification.for(options)
+    end
+
     # @private
     def example_group_started(group)
       notify :example_group_started, Notifications::GroupNotification.new(group) unless group.descendant_filtered_examples.empty?
@@ -85,6 +129,11 @@ module RSpec::Core
       notify :example_started, Notifications::ExampleNotification.for(example)
     end
 
+    # @private
+    def example_finished(example)
+      notify :example_finished, Notifications::ExampleNotification.for(example)
+    end
+
     # @private
     def example_passed(example)
       notify :example_passed, Notifications::ExampleNotification.for(example)
@@ -107,24 +156,46 @@ module RSpec::Core
       notify :deprecation, Notifications::DeprecationNotification.from_hash(hash)
     end
 
+    # @private
+    # Provides a way to notify of an exception that is not tied to any
+    # particular example (such as an exception encountered in a :suite hook).
+    # Exceptions will be formatted the same way they normally are.
+    def notify_non_example_exception(exception, context_description)
+      @configuration.world.non_example_failure = true
+      @non_example_exception_count += 1
+
+      example = Example.new(AnonymousExampleGroup, context_description, {})
+      presenter = Formatters::ExceptionPresenter.new(exception, example, :indentation => 0)
+      message presenter.fully_formatted(nil)
+    end
+
     # @private
     def finish
-      begin
+      close_after do
         stop
         notify :start_dump,    Notifications::NullNotification
         notify :dump_pending,  Notifications::ExamplesNotification.new(self)
         notify :dump_failures, Notifications::ExamplesNotification.new(self)
         notify :deprecation_summary, Notifications::NullNotification
-        notify :dump_summary, Notifications::SummaryNotification.new(@duration, @examples, @failed_examples, @pending_examples, @load_time)
         unless mute_profile_output?
-          notify :dump_profile, Notifications::ProfileNotification.new(@duration, @examples, @configuration.profile_examples)
+          notify :dump_profile, Notifications::ProfileNotification.new(@duration, @examples,
+                                                                       @configuration.profile_examples,
+                                                                       @profiler.example_groups)
         end
+        notify :dump_summary, Notifications::SummaryNotification.new(@duration, @examples, @failed_examples,
+                                                                     @pending_examples, @load_time,
+                                                                     @non_example_exception_count)
         notify :seed, Notifications::SeedNotification.new(@configuration.seed, seed_used?)
-      ensure
-        notify :close, Notifications::NullNotification
       end
     end
 
+    # @private
+    def close_after
+      yield
+    ensure
+      close
+    end
+
     # @private
     def stop
       @duration = (RSpec::Core::Time.now - @start).to_f if @start
@@ -133,20 +204,62 @@ module RSpec::Core
 
     # @private
     def notify(event, notification)
+      ensure_listeners_ready
       registered_listeners(event).each do |formatter|
         formatter.__send__(event, notification)
       end
     end
 
+    # @private
+    def abort_with(msg, exit_status)
+      message(msg)
+      close
+      exit!(exit_status)
+    end
+
+    # @private
+    def fail_fast_limit_met?
+      return false unless (fail_fast = @configuration.fail_fast)
+
+      if fail_fast == true
+        @failed_examples.any?
+      else
+        fail_fast <= @failed_examples.size
+      end
+    end
+
   private
 
+    def ensure_listeners_ready
+      return if @setup
+
+      @setup_default.call
+      @profiler = Profiler.new
+      register_listener @profiler, *Profiler::NOTIFICATIONS
+      @setup = true
+    end
+
+    def close
+      notify :close, Notifications::NullNotification
+    end
+
     def mute_profile_output?
-      # Don't print out profiled info if there are failures and `--fail-fast` is used, it just clutters the output
-      !@configuration.profile_examples? || (@configuration.fail_fast? && @failed_examples.size > 0)
+      # Don't print out profiled info if there are failures and `--fail-fast` is
+      # used, it just clutters the output.
+      !@configuration.profile_examples? || fail_fast_limit_met?
     end
 
     def seed_used?
       @configuration.seed && @configuration.seed_used?
     end
   end
+
+  # @private
+  # # Used in place of a {Reporter} for situations where we don't want reporting output.
+  class NullReporter
+    def self.method_missing(*)
+      # ignore
+    end
+    private_class_method :method_missing
+  end
 end