rspec-core 2.99.0 → 3.0.0

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

@@ -0,0 +1,78 @@
+# 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.
+#
+# 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.
+#
+# 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
+RSpec.configure do |config|
+# 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
+
+  # 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
+  # individual spec file.
+  if config.files_to_run.one?
+    # 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'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # 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,86 +1,46 @@
 module RSpec
   module Core
+    # @private
+    # Generates conventional files for an rspec project
     class ProjectInitializer
-      def initialize(arg=nil)
-        @arg = arg
-      end
+      attr_reader :destination, :stream, :template_path
 
-      def run
-        create_spec_helper_file
-        create_dot_rspec_file
-        delete_if_confirmed("autotest/discover.rb", <<-MESSAGE)
-  RSpec registers its own discover.rb with Autotest, so autotest/discover.rb is
-  no longer needed.
-        MESSAGE
+      DOT_RSPEC_FILE = '.rspec'
+      SPEC_HELPER_FILE =  'spec/spec_helper.rb'
 
-        delete_if_confirmed("lib/tasks/rspec.rake", <<-MESSAGE)
-  If the file in lib/tasks/rspec.rake is the one generated by rspec-rails-1x,
-  you can get rid of it, as it is no longer needed with rspec-2.
-        MESSAGE
+      def initialize(opts = {})
+        @destination = opts.fetch(:destination, Dir.getwd)
+        @stream = opts.fetch(:report_stream, $stdout)
+        @template_path = opts.fetch(:template_path) do
+          File.expand_path("../project_initializer", __FILE__)
+        end
       end
 
-      def create_dot_rspec_file
-        if File.exist?('.rspec')
-          report_exists('.rspec')
-        else
-          report_creating('.rspec')
-          File.open('.rspec','w') do |f|
-            f.write <<-CONTENT
---color
---format progress
-CONTENT
-          end
-        end
+      def run
+        copy_template DOT_RSPEC_FILE
+        copy_template SPEC_HELPER_FILE
       end
 
-      def create_spec_helper_file
-        if File.exist?('spec/spec_helper.rb')
-          report_exists("spec/spec_helper.rb")
-        else
-          report_creating("spec/spec_helper.rb")
-          FileUtils.mkdir_p('spec')
-          File.open('spec/spec_helper.rb','w') do |f|
-            f.write <<-CONTENT
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# Require this file using `require "spec_helper"` to ensure that it is only
-# loaded once.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
-RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
+    private
 
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = 'random'
-end
-CONTENT
-          end
-        end
-      end
+      def copy_template(file)
+        destination_file = File.join(destination, file)
+        return report_exists(file) if File.exist?(destination_file)
 
-      def delete_if_confirmed(path, message)
-        if File.exist?(path)
-          puts
-          puts message
-          puts
-          puts "  delete   #{path}? [y/n]"
-          FileUtils.rm_rf(path) if gets =~ /y/i
+        report_creating(file)
+        FileUtils.mkdir_p(File.dirname(destination_file))
+        File.open(destination_file, 'w') do |f|
+          f.write File.read(File.join(template_path, file))
         end
       end
 
       def report_exists(file)
-        puts "   exist   #{file}"
+        stream.puts "   exist   #{file}"
       end
 
       def report_creating(file)
-        puts "  create   #{file}"
+        stream.puts "  create   #{file}"
       end
-
     end
   end
 end

data/lib/rspec/core/rake_task.rb

@@ -1,13 +1,25 @@
-require 'rspec/core/backward_compatibility'
+require 'rspec/support'
+require 'rspec/core/version'
+RSpec::Support.require_rspec_support "warnings"
+
 require 'rake'
 require 'rake/tasklib'
 require 'shellwords'
 
 module RSpec
   module Core
+    # Rspec rake task
+    #
+    # @see Rakefile
     class RakeTask < ::Rake::TaskLib
       include ::Rake::DSL if defined?(::Rake::DSL)
 
+      # 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:
@@ -20,31 +32,6 @@ module RSpec
       #   'spec/**/*_spec.rb'
       attr_accessor :pattern
 
-      # @deprecated
-      # Has no effect. The rake task now checks ENV['BUNDLE_GEMFILE'] instead.
-      def skip_bundler=(*)
-        deprecate("RSpec::Core::RakeTask#skip_bundler=")
-      end
-
-      # @deprecated
-      # Has no effect. The rake task now checks ENV['BUNDLE_GEMFILE'] instead.
-      def gemfile=(*)
-        deprecate("RSpec::Core::RakeTask#gemfile=", :replacement => 'ENV["BUNDLE_GEMFILE"]')
-      end
-
-      # @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)
-        deprecate("RSpec::Core::RakeTask#warning=", :replacement => 'ruby_opts="-w"')
-        @warning = true_or_false
-      end
-
       # Whether or not to fail Rake when an error occurs (typically when examples fail).
       #
       # default:
@@ -61,51 +48,6 @@ module RSpec
       #   true
       attr_accessor :verbose
 
-      # Use rcov for code coverage?
-      #
-      # Due to the many ways `rcov` can run, if this option is enabled, it is
-      # required that `require 'rspec/autorun'` appears in `spec_helper`.rb
-      #
-      # default:
-      #   false
-      def rcov
-        deprecate("RSpec::Core::RakeTask#rcov")
-        @rcov
-      end
-
-      def rcov=(true_or_false)
-        deprecate("RSpec::Core::RakeTask#rcov=")
-        @rcov = true_or_false
-      end
-
-      # Path to rcov.
-      #
-      # default:
-      #   'rcov'
-      def rcov_path
-        deprecate("RSpec::Core::RakeTask#rcov_path")
-        @rcov_path
-      end
-
-      def rcov_path=(path)
-        deprecate("RSpec::Core::RakeTask#rcov_path=")
-        @rcov_path = path
-      end
-
-      # Command line options to pass to rcov.
-      #
-      # default:
-      #   nil
-      def rcov_opts
-        deprecate("RSpec::Core::RakeTask#rcov_opts")
-        @rcov_opts
-      end
-
-      def rcov_opts=(opts)
-        deprecate("RSpec::Core::RakeTask#rcov_opts=")
-        @rcov_opts = opts
-      end
-
       # Command line options to pass to ruby.
       #
       # default:
@@ -124,42 +66,19 @@ module RSpec
       #   nil
       attr_accessor :rspec_opts
 
-      # @deprecated
-      # Use rspec_opts instead.
-      #
-      # Command line options to pass to rspec.
-      #
-      # default:
-      #   nil
-      def spec_opts=(opts)
-        deprecate('RSpec::Core::RakeTask#spec_opts=', :replacement => 'rspec_opts=')
-        @rspec_opts = opts
-      end
-
       def initialize(*args, &task_block)
-        setup_ivars(args)
+        @name          = args.shift || :spec
+        @ruby_opts     = nil
+        @rspec_opts    = nil
+        @verbose       = true
+        @fail_on_error = true
+        @rspec_path    = DEFAULT_RSPEC_PATH
+        @pattern       = DEFAULT_PATTERN
 
-        desc "Run RSpec code examples" unless ::Rake.application.last_comment
-
-        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 setup_ivars(args)
-        @name = args.shift || :spec
-        @rcov_opts, @ruby_opts, @rspec_opts = nil, nil, nil
-        @warning, @rcov = false, false
-        @verbose, @fail_on_error = true, true
-
-        @rcov_path  = 'rcov'
-        @rspec_path = 'rspec'
-        @pattern    = './spec{,/*/**}/*_spec.rb'
+        define(args, &task_block)
       end
 
+      # @private
       def run_task(verbose)
         command = spec_command
 
@@ -169,18 +88,23 @@ module RSpec
         rescue
           puts failure_message if failure_message
         end
-        abort("#{command} failed") if fail_on_error unless success
+        if fail_on_error && !success
+          $stderr.puts "#{command} failed"
+          exit $?.exitstatus
+        end
       end
 
     private
 
-      if "".respond_to?(:shellescape)
-        def shellescape(string)
-          string.shellescape
-        end
-      else # 1.8.6's shellwords doesn't provide shellescape :(.
-        def shellescape(string)
-          string.gsub(/"/, '\"').gsub(/'/, "\\\\'")
+      # @private
+      def define(args, &task_block)
+        desc "Run RSpec code examples" unless ::Rake.application.last_comment
+
+        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
 
@@ -188,7 +112,7 @@ module RSpec
         if ENV['SPEC']
           FileList[ ENV['SPEC'] ].sort
         else
-          FileList[ pattern ].sort.map { |f| shellescape(f) }
+          FileList[ pattern ].sort.map(&:shellescape)
         end
       end
 
@@ -196,35 +120,25 @@ module RSpec
         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 << rspec_load_path
+        cmd_parts << "-S" << rspec_path
         cmd_parts << files_to_run
-        cmd_parts << "--" if @rcov && rspec_opts
         cmd_parts << rspec_opts
         cmd_parts.flatten.reject(&blank).join(" ")
       end
 
-      def runner
-        @rcov ? @rcov_path : rspec_path
-      end
-
       def blank
         lambda {|s| s.nil? || s == ""}
       end
 
-      def deprecate deprecated, opts = {}
-        # unless RSpec is loaded, deprecate won't work (simply requiring the
-        # deprecate file isn't enough) so this is a check for "is rspec already
-        # loaded?" "ok use the main deprecate hook" otherwise "simple fallback"
-        # Note that we don't need rspec to be loaded for the rake task to work
-        if RSpec.respond_to?(:deprecate)
-          RSpec.deprecate deprecated, opts
-        else
-          warn "DEPRECATION: #{deprecated} is deprecated."
+      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}
+
+          "-I#{core_and_support.map(&:shellescape).join(File::PATH_SEPARATOR)}"
         end
       end
-
     end
   end
 end

data/lib/rspec/core/reporter.rb

@@ -1,135 +1,152 @@
 module RSpec::Core
+  # A reporter will send notifications to listeners, usually formatters for the
+  # spec suite run.
   class Reporter
-    NOTIFICATIONS = %W[start message example_group_started example_group_finished example_started
-                       example_passed example_failed example_pending start_dump dump_pending
-                       dump_failures dump_summary seed close stop deprecation deprecation_summary].map { |n| n.to_sym }
-
-    def initialize(*formatters)
-      @listeners = Hash.new { |h,k| h[k] = [] }
-      formatters.each do |formatter|
-        register_listener(formatter, *NOTIFICATIONS)
-      end
-      @example_count = @failure_count = @pending_count = 0
-      @duration = @start = nil
+
+    def initialize(configuration)
+      @configuration = configuration
+      @listeners = Hash.new { |h,k| h[k] = Set.new }
+      @examples = []
+      @failed_examples = []
+      @pending_examples = []
+      @duration = @start = @load_time = nil
     end
 
-    # @api
-    # @param [Object] An obect that wishes to be notified of reporter events
-    # @param [Array] Array of symbols represents the events a listener wishes to subscribe too
-    #
+    # @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 if listener.respond_to?(notification)
+        @listeners[notification.to_sym] << listener
       end
       true
     end
 
+    # @private
     def registered_listeners(notification)
-      @listeners[notification]
+      @listeners[notification].to_a
     end
 
     # @api
     # @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.
+    # @overload report(count, &block)
+    # @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 = RSpec::Core::Time.now
-      notify :start, expected_example_count
+    # @private
+    def start(expected_example_count, time = RSpec::Core::Time.now)
+      @start = time
+      @load_time = (@start - @configuration.start_time).to_f
+      notify :start, Notifications::StartNotification.new(expected_example_count, @load_time)
     end
 
+    # @private
     def message(message)
-      notify :message, message
+      notify :message, Notifications::MessageNotification.new(message)
     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_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 deprecation(message)
-      notify :deprecation, message
+    # @private
+    def deprecation(hash)
+      notify :deprecation, Notifications::DeprecationNotification.from_hash(hash)
     end
 
-    def finish(seed)
+    # @private
+    def finish
       begin
         stop
-        notify :start_dump
-        notify :dump_pending
-        notify :dump_failures
-        notify :deprecation_summary
-        notify :dump_summary, @duration, @example_count, @failure_count, @pending_count
-        notify :seed, seed if seed
+        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)
+        end
+        notify :seed, Notifications::SeedNotification.new(@configuration.seed, seed_used?)
       ensure
-        notify :close
+        notify :close, Notifications::NullNotification
       end
     end
 
-    def abort(seed)
-      RSpec.deprecate "RSpec::Core::Reporter#abort", :replacement => "RSpec::Core::Reporter#finish"
-      finish(seed)
-    end
-
+    # @private
     def stop
       @duration = (RSpec::Core::Time.now - @start).to_f if @start
-      notify :stop
+      notify :stop, Notifications::ExamplesNotification.new(self)
     end
 
-    def notify(event, *args, &block)
+    # @private
+    def notify(event, notification)
       registered_listeners(event).each do |formatter|
-        formatter.send(event, *args, &block)
+        formatter.__send__(event, notification)
       end
     end
 
+  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
+      !@configuration.profile_examples? || (@configuration.fail_fast? && @failed_examples.size > 0)
+    end
+
+    def seed_used?
+      @configuration.seed && @configuration.seed_used?
+    end
   end
 end

data/lib/rspec/core/ruby_project.rb

@@ -6,6 +6,7 @@ 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))}
@@ -24,7 +25,7 @@ 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