rspec-core 2.11.1 → 3.11.0

data/lib/rspec/core/rake_task.rb

@@ -1,178 +1,187 @@
-require 'rspec/core'
-require 'rspec/core/deprecation'
 require 'rake'
 require 'rake/tasklib'
+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
+    #
+    # @see Rakefile
     class RakeTask < ::Rake::TaskLib
       include ::Rake::DSL if defined?(::Rake::DSL)
+      include RSpec::Core::ShellEscape
 
-      # Name of task.
-      #
-      # default:
-      #   :spec
-      attr_accessor :name
+      # Default path to the RSpec executable.
+      DEFAULT_RSPEC_PATH = File.expand_path('../../../../exe/rspec', __FILE__)
 
-      # Glob pattern to match files.
-      #
-      # default:
-      #   'spec/**/*_spec.rb'
-      attr_accessor :pattern
+      # Default pattern for spec files.
+      DEFAULT_PATTERN = 'spec/**{,/*/**}/*_spec.rb'
 
-      # @deprecated
-      # Has no effect. The rake task now checks ENV['BUNDLE_GEMFILE'] instead.
-      def skip_bundler=(*)
-        RSpec.deprecate("RSpec::Core::RakeTask#skip_bundler=")
-      end
+      # Name of task. Defaults to `:spec`.
+      attr_accessor :name
 
-      # @deprecated
-      # Has no effect. The rake task now checks ENV['BUNDLE_GEMFILE'] instead.
-      def gemfile=(*)
-        RSpec.deprecate("RSpec::Core::RakeTask#gemfile=", 'ENV["BUNDLE_GEMFILE"]')
-      end
+      # Files matching this pattern will be loaded.
+      # Defaults to `'spec/**{,/*/**}/*_spec.rb'`.
+      attr_accessor :pattern
 
-      # @deprecated
-      # Use ruby_opts="-w" instead.
-      #
-      # When true, requests that the specs be run with the warning flag set.
-      # e.g. "ruby -w"
-      #
-      # default:
-      #   false
-      def warning=(true_or_false)
-        RSpec.deprecate("RSpec::Core::RakeTask#warning=", 'ruby_opts="-w"')
-        @warning = true_or_false
-      end
+      # 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).
-      #
-      # 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
 
+      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
 
-      # Use rcov for code coverage?
-      #
-      # default:
-      #   false
-      attr_accessor :rcov
-
-      # Path to rcov.
-      #
-      # default:
-      #   'rcov'
-      attr_accessor :rcov_path
-
-      # Command line options to pass to rcov.
-      #
-      # default:
-      #   nil
-      attr_accessor :rcov_opts
-
-      # 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
 
-      # @deprecated
-      # Use rspec_opts instead.
-      #
-      # Command line options to pass to rspec.
-      #
-      # default:
-      #   nil
-      def spec_opts=(opts)
-        RSpec.deprecate('RSpec::Core::RakeTask#spec_opts=', 'rspec_opts=')
-        @rspec_opts = opts
+      def initialize(*args, &task_block)
+        @name          = args.shift || :spec
+        @ruby_opts     = nil
+        @rspec_opts    = nil
+        @verbose       = true
+        @fail_on_error = true
+        @rspec_path    = DEFAULT_RSPEC_PATH
+        @pattern       = DEFAULT_PATTERN
+
+        define(args, &task_block)
       end
 
-      def initialize(*args)
-        @name = args.shift || :spec
-        @pattern, @rcov_path, @rcov_opts, @ruby_opts, @rspec_opts = nil, nil, nil, nil, nil
-        @warning, @rcov = false, false
-        @verbose, @fail_on_error = true, true
-
-        yield self if block_given?
-
-        @rcov_path  ||= 'rcov'
-        @rspec_path ||= 'rspec'
-        @pattern    ||= './spec{,/*/**}/*_spec.rb'
-
-        desc("Run RSpec code examples") unless ::Rake.application.last_comment
-
-        task name do
-          RakeFileUtils.send(:verbose, verbose) do
-            if files_to_run.empty?
-              puts "No examples matching #{pattern} could be found"
-            else
-              begin
-                puts spec_command if verbose
-                success = system(spec_command)
-              rescue
-                puts failure_message if failure_message
-              end
-              raise("#{spec_command} failed") if fail_on_error unless success
-            end
-          end
+      # @private
+      def run_task(verbose)
+        command = spec_command
+        puts command if verbose
+
+        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
 
-      def files_to_run
+      # @private
+      def define(args, &task_block)
+        desc "Run RSpec code examples" unless ::Rake.application.last_description
+
+        task name, *args do |_, task_args|
+          RakeFileUtils.__send__(:verbose, verbose) do
+            task_block.call(*[self, task_args].slice(0, task_block.arity)) if task_block
+            run_task verbose
+          end
+        end
+      end
+
+      def file_inclusion_specification
         if ENV['SPEC']
-          FileList[ ENV['SPEC'] ]
+          FileList[ENV['SPEC']].sort
+        elsif String === pattern && !File.exist?(pattern)
+          return if [*rspec_opts].any? { |opt| opt =~ /--pattern/ }
+          "--pattern #{escape pattern}"
         else
-          FileList[ pattern ].map { |f| f.gsub(/"/, '\"').gsub(/'/, "\\\\'") }
+          # 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 spec_command
-        @spec_command ||= begin
-                            cmd_parts = []
-                            cmd_parts << RUBY
-                            cmd_parts << ruby_opts
-                            cmd_parts << "-w" if @warning
-                            cmd_parts << "-S" << runner
-                            cmd_parts << "-Ispec:lib" << rcov_opts if rcov
-                            cmd_parts << files_to_run
-                            cmd_parts << "--" if rcov && rspec_opts
-                            cmd_parts << rspec_opts
-                            cmd_parts.flatten.reject(&blank).join(" ")
-                          end
+      def file_exclusion_specification
+        " --exclude-pattern #{escape exclude_pattern}" if exclude_pattern
       end
 
-    private
-
-      def runner
-        rcov ? rcov_path : rspec_path
+      def spec_command
+        cmd_parts = []
+        cmd_parts << RUBY
+        cmd_parts << ruby_opts
+        cmd_parts << rspec_load_path
+        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(
+            /#{File::SEPARATOR}rspec-(core|support)[^#{File::SEPARATOR}]*#{File::SEPARATOR}lib/
+          ).uniq
+
+          "-I#{core_and_support.map { |file| escape file }.join(File::PATH_SEPARATOR)}"
+        end
       end
     end
   end

data/lib/rspec/core/reporter.rb

@@ -1,102 +1,265 @@
 module RSpec::Core
+  # A reporter will send notifications to listeners, usually formatters for the
+  # spec suite run.
   class Reporter
-    def initialize(*formatters)
-      @formatters = formatters
-      @example_count = @failure_count = @pending_count = 0
-      @duration = @start = nil
+    # @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 }
+      @examples = []
+      @failed_examples = []
+      @pending_examples = []
+      @duration = @start = @load_time = nil
+      @non_example_exception_count = 0
+      @setup_default = lambda {}
+      @setup = false
+      @profiler = nil
     end
 
-    # @api
+    # @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.
+    #
+    # @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
+      end
+      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
+
+    # @overload report(count, &block)
     # @overload report(count, &block)
-    # @overload report(count, seed, &block)
-    # @param [Integer] count the number of examples being run
-    # @param [Integer] seed the seed used to randomize the spec run
-    # @param [Block] block yields itself for further reporting.
+    # @param expected_example_count [Integer] the number of examples being run
+    # @yield [Block] block yields itself for further reporting.
     #
     # Initializes the report run and yields itself for further reporting. The
     # block is required, so that the reporter can manage cleaning up after the
     # run.
     #
-    # ### Warning:
-    #
-    # The `seed` argument is an internal API and is not guaranteed to be
-    # supported in the future.
-    #
     # @example
     #
     #     reporter.report(group.examples.size) do |r|
     #       example_groups.map {|g| g.run(r) }
     #     end
     #
-    def report(expected_example_count, seed=nil)
+    def report(expected_example_count)
       start(expected_example_count)
       begin
         yield self
       ensure
-        finish(seed)
+        finish
       end
     end
 
-    def start(expected_example_count)
-      @start = Time.now
-      notify :start, expected_example_count
+    # @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)
+      @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
+
+    # @param message [#to_s] A message object to send to formatters
+    #
+    # Send a custom message to supporting formatters.
     def message(message)
-      notify :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, group unless group.descendant_filtered_examples.empty?
+      notify :example_group_started, Notifications::GroupNotification.new(group) unless group.descendant_filtered_examples.empty?
     end
 
+    # @private
     def example_group_finished(group)
-      notify :example_group_finished, group unless group.descendant_filtered_examples.empty?
+      notify :example_group_finished, Notifications::GroupNotification.new(group) unless group.descendant_filtered_examples.empty?
     end
 
+    # @private
     def example_started(example)
-      @example_count += 1
-      notify :example_started, example
+      @examples << example
+      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, example
+      notify :example_passed, Notifications::ExampleNotification.for(example)
     end
 
+    # @private
     def example_failed(example)
-      @failure_count += 1
-      notify :example_failed, example
+      @failed_examples << example
+      notify :example_failed, Notifications::ExampleNotification.for(example)
     end
 
+    # @private
     def example_pending(example)
-      @pending_count += 1
-      notify :example_pending, example
+      @pending_examples << example
+      notify :example_pending, Notifications::ExampleNotification.for(example)
     end
 
-    def finish(seed)
-      begin
+    # @private
+    def deprecation(hash)
+      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
+      close_after do
         stop
-        notify :start_dump
-        notify :dump_pending
-        notify :dump_failures
-        notify :dump_summary, @duration, @example_count, @failure_count, @pending_count
-        notify :seed, seed if seed
-      ensure
-        notify :close
+        notify :start_dump,    Notifications::NullNotification
+        notify :dump_pending,  Notifications::ExamplesNotification.new(self)
+        notify :dump_failures, Notifications::ExamplesNotification.new(self)
+        notify :deprecation_summary, Notifications::NullNotification
+        unless mute_profile_output?
+          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?)
       end
     end
 
-    alias_method :abort, :finish
+    # @private
+    def close_after
+      yield
+    ensure
+      close
+    end
 
+    # @private
     def stop
-      @duration = Time.now - @start if @start
-      notify :stop
+      @duration = (RSpec::Core::Time.now - @start).to_f if @start
+      notify :stop, Notifications::ExamplesNotification.new(self)
     end
 
-    def notify(method, *args, &block)
-      @formatters.each do |formatter|
-        formatter.send method, *args, &block
+    # @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? || 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

data/lib/rspec/core/ruby_project.rb

@@ -1,14 +1,12 @@
 # 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
     module RubyProject
       def add_to_load_path(*dirs)
-        dirs.map {|dir| add_dir_to_load_path(File.join(root, dir))}
+        dirs.each { |dir| add_dir_to_load_path(File.join(root, dir)) }
       end
 
       def add_dir_to_load_path(dir)
@@ -24,12 +22,23 @@ module RSpec
       end
 
       def find_first_parent_containing(dir)
-        ascend_until {|path| File.exists?(File.join(path, dir))}
+        ascend_until { |path| File.exist?(File.join(path, dir)) }
       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