rspec-core 3.1.7 → 3.2.0

data/lib/rspec/core/option_parser.rb

@@ -25,9 +25,9 @@ module RSpec::Core
       OptionParser.new do |parser|
         parser.banner = "Usage: rspec [options] [files or directories]\n\n"
 
-        parser.on('-I PATH', 'Specify PATH to add to $LOAD_PATH (may be used more than once).') do |dir|
+        parser.on('-I PATH', 'Specify PATH to add to $LOAD_PATH (may be used more than once).') do |dirs|
           options[:libs] ||= []
-          options[:libs] << dir
+          options[:libs].concat(dirs.split(File::PATH_SEPARATOR))
         end
 
         parser.on('-r', '--require PATH', 'Require a file.') do |path|
@@ -59,7 +59,8 @@ module RSpec::Core
           options[:fail_fast] = false
         end
 
-        parser.on('--failure-exit-code CODE', Integer, 'Override the exit code used when there are failing specs.') do |code|
+        parser.on('--failure-exit-code CODE', Integer,
+                  'Override the exit code used when there are failing specs.') do |code|
           options[:failure_exit_code] = code
         end
 
@@ -115,7 +116,8 @@ module RSpec::Core
           options[:color] = o
         end
 
-        parser.on('-p', '--[no-]profile [COUNT]', 'Enable profiling of examples and list the slowest examples (default: 10).') do |argument|
+        parser.on('-p', '--[no-]profile [COUNT]',
+                  'Enable profiling of examples and list the slowest examples (default: 10).') do |argument|
           options[:profile_examples] = if argument.nil?
                                          true
                                        elsif argument == false
@@ -153,7 +155,8 @@ FILTERING
           options[:pattern] = o
         end
 
-        parser.on('--exclude-pattern PATTERN', 'Load files except those matching pattern. Opposite effect of --pattern.') do |o|
+        parser.on('--exclude-pattern PATTERN',
+                  'Load files except those matching pattern. Opposite effect of --pattern.') do |o|
           options[:exclude_pattern] = o
         end
 
@@ -198,18 +201,21 @@ FILTERING
           exit
         end
 
-        # these options would otherwise be confusing to users, so we forcibly prevent them from executing
-        # --I is too similar to -I
-        # -d was a shorthand for --debugger, which is removed, but now would trigger --default-path
+        # These options would otherwise be confusing to users, so we forcibly
+        # prevent them from executing.
+        #
+        #   * --I is too similar to -I.
+        #   * -d was a shorthand for --debugger, which is removed, but now would
+        #     trigger --default-path.
         invalid_options = %w[-d --I]
 
         parser.on_tail('-h', '--help', "You're looking at it.") do
-          # removing the blank invalid options from the output
+          # Removing the blank invalid options from the output.
           puts parser.to_s.gsub(/^\s+(#{invalid_options.join('|')})\s*$\n/, '')
           exit
         end
 
-        # this prevents usage of the invalid_options
+        # This prevents usage of the invalid_options.
         invalid_options.each do |option|
           parser.on(option) do
             raise OptionParser::InvalidOption.new

data/lib/rspec/core/pending.rb

@@ -1,9 +1,10 @@
 module RSpec
   module Core
-    # Provides methods to mark examples as pending. These methods are available to be
-    # called from within any example or hook.
+    # Provides methods to mark examples as pending. These methods are available
+    # to be called from within any example or hook.
     module Pending
-      # Raised in the middle of an example to indicate that it should be marked as skipped.
+      # Raised in the middle of an example to indicate that it should be marked
+      # as skipped.
       class SkipDeclaredInExample < StandardError
         attr_reader :argument
 
@@ -12,8 +13,9 @@ module RSpec
         end
       end
 
-      # If Test::Unit is loaded, we'll use its error as baseclass, so that Test::Unit
-      # will report unmet RSpec expectations as failures rather than errors.
+      # If Test::Unit is loaded, we'll use its error as baseclass, so that
+      # Test::Unit will report unmet RSpec expectations as failures rather than
+      # errors.
       begin
         class PendingExampleFixedError < Test::Unit::AssertionFailedError; end
       rescue
@@ -71,7 +73,7 @@ module RSpec
         if block_given?
           raise ArgumentError, <<-EOS.gsub(/^\s+\|/, '')
             |The semantics of `RSpec::Core::Pending#pending` have changed in
-            |RSpec 3.  In RSpec 2.x, it caused the example to be skipped. In
+            |RSpec 3. In RSpec 2.x, it caused the example to be skipped. In
             |RSpec 3, the rest of the example is still run but is expected to
             |fail, and will be marked as a failure (rather than as pending) if
             |the example passes.
@@ -123,7 +125,7 @@ module RSpec
 
       # @private
       #
-      # Mark example as skipped
+      # Mark example as skipped.
       #
       # @param example [RSpec::Core::Example] the example to mark as skipped
       # @param message_or_bool [Boolean, String] the message to use, or true
@@ -134,7 +136,7 @@ module RSpec
 
       # @private
       #
-      # Mark example as pending
+      # Mark example as pending.
       #
       # @param example [RSpec::Core::Example] the example to mark as pending
       # @param message_or_bool [Boolean, String] the message to use, or true
@@ -152,7 +154,7 @@ module RSpec
 
       # @private
       #
-      # Mark example as fixed
+      # Mark example as fixed.
       #
       # @param example [RSpec::Core::Example] the example to mark as fixed
       def self.mark_fixed!(example)

data/lib/rspec/core/project_initializer.rb

@@ -3,7 +3,7 @@ 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
 

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

@@ -1,14 +1,16 @@
 # 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, 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 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.
@@ -22,10 +24,10 @@ RSpec.configure do |config|
     # 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"
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
     # ...rather than:
-    #   # => "be bigger than 2"
+    #     # => "be bigger than 2"
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
 
@@ -48,8 +50,8 @@ RSpec.configure do |config|
   config.filter_run :focus
   config.run_all_when_everything_filtered = true
 
-  # Limits the available syntax to the non-monkey patched syntax that is recommended.
-  # For more details, see:
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
   #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
   #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
   #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching

data/lib/rspec/core/rake_task.rb

@@ -1,71 +1,51 @@
 require 'rake'
 require 'rake/tasklib'
-require 'rbconfig'
+require 'rspec/support/ruby_features'
 
 module RSpec
   module Core
-    # Rspec rake task
+    # RSpec rake task
     #
     # @see Rakefile
     class RakeTask < ::Rake::TaskLib
       include ::Rake::DSL if defined?(::Rake::DSL)
 
-      # 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'
 
-      # Name of task.
-      #
-      # default:
-      #   :spec
+      # Name of task. Defaults to `:spec`.
       attr_accessor :name
 
       # Files matching this pattern will be loaded.
-      #
-      # default:
-      #   'spec/**{,/*/**}/*_spec.rb'
+      # Defaults to `'spec/**{,/*/**}/*_spec.rb'`.
       attr_accessor :pattern
 
       # Files matching this pattern will be excluded.
-      #
-      # default:
-      #   'spec/**/*_spec.rb'
+      # Defaults to `nil`.
       attr_accessor :exclude_pattern
 
-      # Whether or not to fail Rake when an error occurs (typically when examples fail).
-      #
-      # default:
-      #   true
+      # 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
 
       # 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)
@@ -93,7 +73,7 @@ module RSpec
 
         return unless fail_on_error && !success
 
-        $stderr.puts "#{command} failed"
+        $stderr.puts "#{command} failed" if verbose
         exit $?.exitstatus
       end
 
@@ -117,31 +97,36 @@ module RSpec
         elsif String === pattern && !File.exist?(pattern)
           "--pattern #{escape pattern}"
         else
-          # 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:
+          # 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.
+          #   * 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.
+          # 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`.
+          # 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.
+          # TODO: consider deprecating support for this and removing it in
+          #   RSpec 4.
           FileList[pattern].sort.map { |file| escape file }
         end
       end
 
-      # Manaully comparing because in 3.2 we have RSpec::Support::OS.windows?
-      # but in 3.1 we don't and requiring rspec/world would be weighty here.
-      if RbConfig::CONFIG['host_os'] =~ /cygwin|mswin|mingw|bccwin|wince|emx/
+      if RSpec::Support::OS.windows?
         def escape(shell_command)
           "'#{shell_command.gsub("'", "\'")}'"
         end
@@ -162,7 +147,7 @@ module RSpec
         cmd_parts << RUBY
         cmd_parts << ruby_opts
         cmd_parts << rspec_load_path
-        cmd_parts << rspec_path
+        cmd_parts << escape(rspec_path)
         cmd_parts << file_inclusion_specification
         cmd_parts << file_exclusion_specification
         cmd_parts << rspec_opts

data/lib/rspec/core/reporter.rb

@@ -14,11 +14,20 @@ module RSpec::Core
     # @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
+    # @private
+    def reset
+      @examples = []
+      @failed_examples = []
+      @pending_examples = []
+    end
+
+    # 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 obect 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
@@ -61,6 +70,7 @@ module RSpec::Core
       @start = time
       @load_time = (@start - @configuration.start_time).to_f
       notify :start, Notifications::StartNotification.new(expected_example_count, @load_time)
+      notify :seed, Notifications::SeedNotification.new(@configuration.seed, seed_used?)
     end
 
     # @private
@@ -113,10 +123,12 @@ module RSpec::Core
       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)
       end
+      notify :dump_summary, Notifications::SummaryNotification.new(@duration, @examples, @failed_examples,
+                                                                   @pending_examples, @load_time)
       notify :seed, Notifications::SeedNotification.new(@configuration.seed, seed_used?)
     ensure
       notify :close, Notifications::NullNotification
@@ -138,7 +150,8 @@ module RSpec::Core
   private
 
     def mute_profile_output?
-      # Don't print out profiled info if there are failures and `--fail-fast` is used, it just clutters the 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)
     end
 
@@ -146,4 +159,14 @@ module RSpec::Core
       @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
+  private
+
+    def method_missing(*)
+      # ignore
+    end
+  end
 end

data/lib/rspec/core/ruby_project.rb

@@ -1,9 +1,6 @@
 # This is borrowed (slightly modified) from Scott Taylor's
 # project_path project:
 #   http://github.com/smtlaissezfaire/project_path
-
-require 'pathname'
-
 module RSpec
   module Core
     # @private
@@ -29,8 +26,19 @@ module RSpec
       end
 
       def ascend_until
-        Pathname(File.expand_path('.')).ascend do |path|
+        fs = File::SEPARATOR
+        escaped_slash = "\\#{fs}"
+        special = "_RSPEC_ESCAPED_SLASH_"
+        project_path = File.expand_path(".")
+        parts = project_path.gsub(escaped_slash, special).squeeze(fs).split(fs).map do |x|
+          x.gsub(special, escaped_slash)
+        end
+
+        until parts.empty?
+          path = parts.join(fs)
+          path = fs if path == ""
           return path if yield(path)
+          parts.pop
         end
       end
 

data/lib/rspec/core/runner.rb

@@ -24,14 +24,15 @@ module RSpec
           next unless $!.nil? || $!.is_a?(SystemExit)
 
           # We got here because either the end of the program was reached or
-          # somebody called Kernel#exit.  Run the specs and then override any
+          # somebody called Kernel#exit. Run the specs and then override any
           # existing exit status with RSpec's exit status if any specs failed.
           invoke
         end
         @installed_at_exit = true
       end
 
-      # Runs the suite of specs and exits the process with an appropriate exit code.
+      # Runs the suite of specs and exits the process with an appropriate exit
+      # code.
       def self.invoke
         disable_autorun!
         status = run(ARGV, $stderr, $stdout).to_i
@@ -105,12 +106,8 @@ module RSpec
       #   failed.
       def run_specs(example_groups)
         @configuration.reporter.report(@world.example_count(example_groups)) do |reporter|
-          begin
-            hook_context = SuiteHookContext.new
-            @configuration.hooks.run(:before, :suite, hook_context)
+          @configuration.with_suite_hooks do
             example_groups.map { |g| g.run(reporter) }.all? ? 0 : @configuration.failure_exit_code
-          ensure
-            @configuration.hooks.run(:after, :suite, hook_context)
           end
         end
       end
@@ -150,7 +147,7 @@ module RSpec
         trap('INT') do
           exit!(1) if RSpec.world.wants_to_quit
           RSpec.world.wants_to_quit = true
-          STDERR.puts "\nExiting... Interrupt again to exit immediately."
+          STDERR.puts "\nRSpec is shutting down and will print the summary report... Interrupt again to force quit."
         end
       end
     end