rspec-core 2.7.0.rc1 → 2.7.0

data/README.md

@@ -1,23 +1,8 @@
-# RSpec Core
+# rspec-core
 
 RSpec Core provides the structure for writing executable examples of how your
 code should behave.
 
-[![build status](https://secure.travis-ci.org/rspec/rspec-core.png)](http://travis-ci.org/rspec/rspec-core)
-
-## Documentation
-
-The [Cucumber features](http://relishapp.com/rspec/rspec-core) are the
-most comprehensive and up-to-date docs for end-users.
-
-The [RDoc](http://rubydoc.info/gems/rspec-core/2.3.0/frames) provides
-additional information for contributors and/or extenders.
-
-All of the documentation is open source and a work in progress. If you find it
-lacking or confusing, you can help improve it by submitting requests and
-patches to the [rspec-core issue
-tracker](https://github.com/rspec/rspec-core/issues).
-
 ## Install
 
     gem install rspec      # for rspec-core, rspec-expectations, rspec-mocks
@@ -27,18 +12,14 @@ tracker](https://github.com/rspec/rspec-core/issues).
 
 See [features/Upgrade.md](http://github.com/rspec/rspec-core/blob/master/features/Upgrade.md)
 
-
-This will install the rspec, rspec-core, rspec-expectations and rspec-mocks
-gems.
-
 ## Get Started
 
 Start with a simple example of behavior you expect from your system. Do
 this before you write any implementation code:
 
     # in spec/calculator_spec.rb
-    describe Calculator, "add" do
-      it "returns the sum of its arguments" do
+    describe Calculator do
+      it "add(x,y) returns the sum of its arguments" do
         Calculator.new.add(1, 2).should eq(3)
       end
     end
@@ -60,8 +41,7 @@ Implement the simplest solution:
 Be sure to require the implementation file in the spec:
 
     # in spec/calculator_spec.rb
-    # - RSpec adds ./lib to the $LOAD_PATH, so you can
-    #   just require "calculator" directly
+    # - RSpec adds ./lib to the $LOAD_PATH
     require "calculator"
 
 Now run the spec again, and watch it pass:
@@ -72,7 +52,7 @@ Now run the spec again, and watch it pass:
     Finished in 0.000315 seconds
     1 example, 0 failures
 
-Use the documentation formatter to see the resulting spec:
+Use the `documentation` formatter to see the resulting spec:
 
     $ rspec spec/calculator_spec.rb --format doc
     Calculator add
@@ -81,26 +61,8 @@ Use the documentation formatter to see the resulting spec:
     Finished in 0.000379 seconds
     1 example, 0 failures
 
-## Known issues
-
-See [http://github.com/rspec/rspec-core/issues](http://github.com/rspec/rspec-core/issues)
-
-## Learn more
-
-While not comprehensive yet, you can learn quite a lot from the Cucumber
-features in the [features
-directory](http://github.com/rspec/rspec-core/tree/master/features/).  If there
-is a feature that is not documented there, or you find them insufficient to
-understand how to use a feature, please submit issues to
-[http://github.com/rspec/rspec-core/issues](http://github.com/rspec/rspec-core/issues).
-
-## Contribute
-
-See [http://github.com/rspec/rspec-dev](http://github.com/rspec/rspec-dev)
-
-## Also see
+## See also
 
 * [http://github.com/rspec/rspec](http://github.com/rspec/rspec)
 * [http://github.com/rspec/rspec-expectations](http://github.com/rspec/rspec-expectations)
 * [http://github.com/rspec/rspec-mocks](http://github.com/rspec/rspec-mocks)
-

data/features/Upgrade.md

@@ -1,13 +1,46 @@
-# rspec-core-2.7 (not yet released - coming soon)
+The [Changelog](changelog) has a complete list of everything that changed, but
+here are more detailed explanations for those items that warrant them.
 
-## `--default_path`
+# rspec-core-2.7.0.rc1
 
-Add the following to `.rspec`:
+## what's new
+
+### `rspec` command with no arguments
+
+Now you can just type
+
+    rspec
+
+to run all the specs in the `spec` directory.  If you keep your specs in a
+different directory, you can override the default with the `--default_path`
+argument in a config file:
 
     # in .rspec
-    --default_path spec
+    --default_path specs
+
+### `rspec` command supports multiple line numbers
+
+Use either of the following to run the examples declared on lines
+37 and 42 of `a_spec.rb`:
+
+    rspec path/to/a_spec.rb --line_number 37 --line_number 42
+    rspec path/to/a_spec.rb:37:42
+
+## what's changed
+
+### `skip_bundler` and `gemfile` rake task options are deprecated and have no effect.
+
+RSpec's rake task invokes the `rspec` command in a subshell. If you invoke
+`bundle exec rake` or include `Bundler.setup` in your `Rakefile`, then
+Bundler will be activated in the subshell as well.
+
+Previously, the rake task managed this for you based on the presence of a
+`Gemfile`. In 2.7.0.rc1, this is done based on the presence of the
+`BUNDLE_GEMFILE` environment variable, which is set in the parent shell by Bundler.
 
-And now you can just type `rspec` to run all the specs in the `spec` directory.
+In 2.7.0.rc2 (not yet released), the rake task doesn't do anything at all.
+Turns out Bundler just does the right thing, so rspec doesn't need to do
+anything.
 
 # rspec-core-2.6
 

data/features/command_line/exit_status.feature

@@ -1,7 +1,8 @@
 Feature: exit status
 
   The rspec command exits with an exit status of 0 if all examples pass,
-  and 1 if any examples fail.
+  and 1 if any examples fail. The failure exit code can be overridden
+  using the --failure-exit-code option.
 
   Scenario: exit with 0 when all examples pass
     Given a file named "ok_spec.rb" with:
@@ -51,6 +52,19 @@ Feature: exit status
     Then the exit status should be 0
     And the output should contain "0 examples"
 
+  Scenario: exit with 2 when one example fails and --failure-exit-code is 2
+    Given a file named "ko_spec.rb" with:
+      """
+      describe "KO" do
+        it "fails" do
+          raise "KO"
+        end
+      end
+      """
+    When I run `rspec --failure-exit-code 2 ko_spec.rb`
+    Then the exit status should be 2
+    And the output should contain "1 example, 1 failure"
+
   @wip
   Scenario: exit with rspec's exit code when an at_exit hook is added upstream
     Given a file named "exit_at_spec.rb" with:

data/features/example_groups/shared_context.feature

@@ -2,7 +2,7 @@ Feature: shared context
 
   Use `shared_context` to define a block that will be evaluated in the context
   of example groups either explicitly, using `include_context`, or implicitly by
-  matching metdata.
+  matching metadata.
 
   Background:
     Given a file named "shared_stuff.rb" with:

data/lib/autotest/rspec2.rb

@@ -18,6 +18,7 @@ class Autotest::Rspec2 < Autotest
     self.completed_re = /\n(?:\e\[\d*m)?\d* examples?/m
   end
 
+  # Adds conventional spec-to-file mappings to Autotest configuation.
   def setup_rspec_project_mappings
     add_mapping(%r%^spec/.*_spec\.rb$%) { |filename, _|
       filename
@@ -30,6 +31,7 @@ class Autotest::Rspec2 < Autotest
     }
   end
 
+  # Overrides Autotest's implementation to read rspec output
   def consolidate_failures(failed)
     filters = new_hash_of_arrays
     failed.each do |spec, trace|
@@ -40,26 +42,30 @@ class Autotest::Rspec2 < Autotest
     return filters
   end
 
+  # Overrides Autotest's implementation to generate the rspec command to run
   def make_test_cmd(files_to_test)
     files_to_test.empty? ? '' :
       "#{prefix}#{ruby}#{suffix} -S #{SPEC_PROGRAM} --tty #{normalize(files_to_test).keys.flatten.map { |f| "'#{f}'"}.join(' ')}"
   end
 
+  # Generates a map of filenames to Arrays for Autotest
   def normalize(files_to_test)
     files_to_test.keys.inject({}) do |result, filename|
-      result[File.expand_path(filename)] = []
-      result
+      result.merge!(File.expand_path(filename) => [])
     end
   end
 
+  # @private
   def suffix
     using_bundler? ? "" : defined?(:Gem) ? " -rrubygems" : ""
   end
 
+  # @private
   def using_bundler?
     prefix =~ /bundle exec/
   end
 
+  # @private
   def gemfile?
     File.exist?('./Gemfile')
   end

data/lib/rspec/core.rb

@@ -33,12 +33,6 @@ module RSpec
 
   SharedContext = Core::SharedContext
 
-  module Core
-    def self.install_directory
-      @install_directory ||= File.expand_path(File.dirname(__FILE__))
-    end
-  end
-
   # Used internally to determine what to do when a SIGINT is received
   def self.wants_to_quit
     world.wants_to_quit

data/lib/rspec/core/backward_compatibility.rb

@@ -1,6 +1,8 @@
 module RSpec
   module Core
     module ConstMissing
+      # Used to print deprecation warnings for Rspec and Spec constants (use
+      # RSpec instead)
       def const_missing(name)
         case name
         when :Rspec, :Spec
@@ -29,6 +31,7 @@ WARNING
   end
 
   module Runner
+    # @deprecated use RSpec.configure instead.
     def self.configure(&block)
       RSpec.deprecate("Spec::Runner.configure", "RSpec.configure")
       RSpec.configure(&block)
@@ -36,6 +39,8 @@ WARNING
   end
 
   module Rake
+    # Used to print deprecation warnings for Rake::SpecTask constant (use
+    # RSpec::Core::RakeTask instead)
     def self.const_missing(name)
       case name
       when :SpecTask

data/lib/rspec/core/command_line.rb

@@ -21,7 +21,7 @@ module RSpec
         @configuration.reporter.report(@world.example_count) do |reporter|
           begin
             @configuration.run_hook(:before, :suite)
-            @world.example_groups.map {|g| g.run(reporter)}.all? ? 0 : 1
+            @world.example_groups.map {|g| g.run(reporter)}.all? ? 0 : @configuration.failure_exit_code
           ensure
             @configuration.run_hook(:after, :suite)
           end

data/lib/rspec/core/configuration.rb

@@ -28,6 +28,7 @@ module RSpec
       add_setting :drb_port
       add_setting :profile_examples
       add_setting :fail_fast
+      add_setting :failure_exit_code, :default => 1
       add_setting :run_all_when_everything_filtered
       add_setting :exclusion_filter
       add_setting :inclusion_filter
@@ -120,7 +121,7 @@ module RSpec
         @settings ||= {}
       end
 
-      def clear_inclusion_filter # :nodoc:
+      def clear_inclusion_filter
         self.inclusion_filter = nil
       end
 

data/lib/rspec/core/deprecation.rb

@@ -1,6 +1,7 @@
 module RSpec
 
   class << self
+    # Used internally to print deprecation warnings
     def deprecate(method, alternate_method=nil, version=nil)
       version_string = version ? "rspec-#{version}" : "a future version of RSpec"
 
@@ -24,11 +25,13 @@ ADDITIONAL
       warn_deprecation(message)
     end
 
+    # Used internally to print deprecation warnings
     def warn_deprecation(message)
       send :warn, message
     end
   end
 
+  # @private
   class HashWithDeprecationNotice < Hash
 
     def initialize(method, alternate_method=nil)

data/lib/rspec/core/errors.rb

@@ -2,11 +2,10 @@ module RSpec
   module Core
     # If Test::Unit is loaed, we'll use its error as baseclass, so that Test::Unit
     # will report unmet RSpec expectations as failures rather than errors.
-    superclass = ['Test::Unit::AssertionFailedError', '::StandardError'].map do |c|
-      eval(c) rescue nil
-    end.compact.first
-
-    class PendingExampleFixedError < superclass
+    begin
+      class PendingExampleFixedError < Test::Unit::AssertionFailedError; end
+    rescue
+      class PendingExampleFixedError < StandardError; end
     end
   end
 end

data/lib/rspec/core/example.rb

@@ -27,7 +27,7 @@ module RSpec
         @example_group_class
       end
 
-      def around_hooks # :nodoc:
+      def around_hooks
         @around_hooks ||= example_group.around_hooks_for(self)
       end
 

data/lib/rspec/core/extensions/kernel.rb

@@ -1,5 +1,9 @@
 module Kernel
-  def debugger(*args)
-    (RSpec.configuration.error_stream || $stderr).puts "\n***** debugger statement ignored, use -d or --debug option to enable debugging\n#{caller(0)[1]}"
-  end unless respond_to?(:debugger)
+  unless respond_to?(:debugger)
+    # If not already defined by ruby-debug, this implementation prints helpful
+    # message to STDERR when ruby-debug is not loaded.
+    def debugger(*args)
+      (RSpec.configuration.error_stream || $stderr).puts "\n***** debugger statement ignored, use -d or --debug option to enable debugging\n#{caller(0)[1]}"
+    end 
+  end
 end

data/lib/rspec/core/formatters/snippet_extractor.rb

@@ -2,8 +2,8 @@ module RSpec
   module Core
     module Formatters
       # This class extracts code snippets by looking at the backtrace of the passed error
-      class SnippetExtractor #:nodoc:
-        class NullConverter; def convert(code, pre); code; end; end #:nodoc:
+      class SnippetExtractor
+        class NullConverter; def convert(code, pre); code; end; end
         
         begin
           require 'syntax/convertors/html'

data/lib/rspec/core/let.rb

@@ -86,12 +86,12 @@ module RSpec
       end
 
       module InstanceMethods
-        def __memoized # :nodoc:
+        def __memoized
           @__memoized ||= {}
         end
       end
 
-      def self.included(mod) # :nodoc:
+      def self.included(mod)
         mod.extend ClassMethods
         mod.__send__ :include, InstanceMethods
       end

data/lib/rspec/core/option_parser.rb

@@ -116,6 +116,10 @@ module RSpec::Core
           options[:fail_fast] = true
         end
 
+        parser.on('--failure-exit-code CODE', 'Override the exit code used when there are failing specs.') do |o|
+          options[:failure_exit_code] = o.to_i
+        end
+
         parser.on('-t', '--tag TAG[:VALUE]', 'Run examples with the specified tag',
                 'To exclude examples, add ~ before the tag (e.g. ~slow)',
                 '(TAG is always converted to a symbol)') do |tag|

data/lib/rspec/core/rake_task.rb

@@ -30,7 +30,7 @@ module RSpec
       # default:
       #   false
       def skip_bundler=(*)
-        RSpec.deprecate("RSpec::Core::RakeTask#skip_bundler=", 'ENV["BUNDLE_GEMFILE"]')
+        RSpec.deprecate("RSpec::Core::RakeTask#skip_bundler=")
       end
 
       # Deprecated and has no effect. The rake task now checks
@@ -154,7 +154,7 @@ module RSpec
 
     private
 
-      def files_to_run # :nodoc:
+      def files_to_run
         if ENV['SPEC']
           FileList[ ENV['SPEC'] ]
         else
@@ -165,7 +165,6 @@ module RSpec
       def spec_command
         @spec_command ||= begin
                             cmd_parts = []
-                            cmd_parts << "bundle exec" if bundler?
                             cmd_parts << RUBY
                             cmd_parts << ruby_opts
                             cmd_parts << "-w" if warning?
@@ -197,11 +196,6 @@ module RSpec
       def blank
         lambda {|s| s == ""}
       end
-
-      def bundler?
-        ENV["BUNDLE_GEMFILE"] if ENV["BUNDLE_GEMFILE"] unless ENV["BUNDLE_GEMFILE"] == ""
-      end
-
     end
   end
 end

data/lib/rspec/core/ruby_project.rb

@@ -11,23 +11,23 @@ module RSpec
         dirs.map {|dir| add_dir_to_load_path(File.join(root, dir))}
       end
 
-      def add_dir_to_load_path(dir) # :nodoc:
+      def add_dir_to_load_path(dir)
         $LOAD_PATH.unshift(dir) unless $LOAD_PATH.include?(dir)
       end
 
-      def root # :nodoc:
+      def root
         @project_root ||= determine_root
       end
 
-      def determine_root # :nodoc:
+      def determine_root
         find_first_parent_containing('spec') || '.'
       end
 
-      def find_first_parent_containing(dir) # :nodoc:
+      def find_first_parent_containing(dir)
         ascend_until {|path| File.exists?(File.join(path, dir))}
       end
 
-      def ascend_until # :nodoc:
+      def ascend_until
         Pathname(File.expand_path('.')).ascend do |path|
           return path if yield(path)
         end

data/lib/rspec/core/runner.rb

@@ -16,20 +16,20 @@ module RSpec
         @autorun_disabled = true
       end
 
-      def self.autorun_disabled? # :nodoc:
+      def self.autorun_disabled?
         @autorun_disabled ||= false
       end
 
-      def self.installed_at_exit? # :nodoc:
+      def self.installed_at_exit?
         @installed_at_exit ||= false
       end
 
-      def self.running_in_drb? # :nodoc:
+      def self.running_in_drb?
         (DRb.current_server rescue false) &&
          DRb.current_server.uri =~ /druby\:\/\/127.0.0.1\:/
       end
 
-      def self.trap_interrupt # :nodoc:
+      def self.trap_interrupt
         trap('INT') do
           exit!(1) if RSpec.wants_to_quit
           RSpec.wants_to_quit = true
@@ -72,11 +72,11 @@ module RSpec
         RSpec.reset
       end
 
-      def self.run_over_drb(options, err, out) # :nodoc:
+      def self.run_over_drb(options, err, out)
         DRbCommandLine.new(options).run(err, out)
       end
 
-      def self.run_in_process(options, err, out) # :nodoc:
+      def self.run_in_process(options, err, out)
         CommandLine.new(options, RSpec::configuration, RSpec::world).run(err, out)
       end
 

data/lib/rspec/core/subject.rb

@@ -152,7 +152,7 @@ module RSpec
           block ? @explicit_subject_block = block : explicit_subject || implicit_subject
         end
 
-        attr_reader :explicit_subject_block # :nodoc:
+        attr_reader :explicit_subject_block
 
         private
 

data/lib/rspec/core/version.rb

@@ -1,7 +1,7 @@
-module RSpec # :nodoc:
-  module Core # :nodoc:
-    module Version # :nodoc:
-      STRING = '2.7.0.rc1'
+module RSpec
+  module Core
+    module Version
+      STRING = '2.7.0'
     end
   end
 end

data/spec/rspec/core/command_line_spec.rb

@@ -27,11 +27,17 @@ module RSpec::Core
         result.should be(0)
       end
 
-      it "returns 1 if spec passes" do
+      it "returns 1 if spec fails" do
         err, out = StringIO.new, StringIO.new
         result = command_line([failing_spec_filename]).run(err, out)
         result.should be(1)
       end
+
+      it "returns 2 if spec fails and --failure-exit-code is 2" do
+        err, out = StringIO.new, StringIO.new
+        result = command_line([failing_spec_filename, "--failure-exit-code", "2"]).run(err, out)
+        result.should be(2)
+      end
     end
 
     context "given an Array of options" do

data/spec/rspec/core/configuration_options_spec.rb

@@ -168,6 +168,18 @@ describe RSpec::Core::ConfigurationOptions do
     end
   end
 
+  describe "--failure-exit-code" do
+    it "sets :failure_exit_code" do
+      parse_options('--failure-exit-code', '0').should include(:failure_exit_code => 0)
+      parse_options('--failure-exit-code', '1').should include(:failure_exit_code => 1)
+      parse_options('--failure-exit-code', '2').should include(:failure_exit_code => 2)
+    end
+
+    it "overrides previous :failure_exit_code" do
+      parse_options('--failure-exit-code', '2', '--failure-exit-code', '3').should include(:failure_exit_code => 3)
+    end
+  end
+
   describe "--options" do
     it "sets :custom_options_file" do
       parse_options(*%w[-O my.opts]).should include(:custom_options_file => "my.opts")

data/spec/rspec/core/rake_task_spec.rb

@@ -10,22 +10,6 @@ module RSpec::Core
       FileUtils::RUBY
     end
 
-    def with_bundle_gemfile(val)
-      begin
-        orig = ENV['BUNDLE_GEMFILE']
-        ENV['BUNDLE_GEMFILE'] = val
-        yield
-      ensure
-        ENV['BUNDLE_GEMFILE'] = orig
-      end
-    end
-
-    def without_bundler
-      with_bundle_gemfile nil do
-        yield
-      end
-    end
-
     def with_rcov
       task.rcov = true
       yield
@@ -35,52 +19,24 @@ module RSpec::Core
       task.__send__(:spec_command)
     end
 
-    context "default (BUNDLE_GEMFILE nil)" do
-      it "renders rspec" do
-        with_bundle_gemfile nil do
-          spec_command.should =~ /^#{ruby} -S rspec/
-        end
-      end
-    end
-
-    context "default (BUNDLE_GEMFILE '')" do
+    context "default" do
       it "renders rspec" do
-        with_bundle_gemfile '' do
-          spec_command.should =~ /^#{ruby} -S rspec/
-        end
-      end
-    end
-
-    context "with bundler (BUNDLE_GEMFILE non-blank)" do
-      it "renders bundle exec rspec" do
-        spec_command.should match(/bundle exec/)
+        spec_command.should =~ /^#{ruby} -S rspec/
       end
     end
 
     context "with rcov" do
       it "renders rcov" do
-        without_bundler do
           with_rcov do
             spec_command.should =~ /^#{ruby} -S rcov/
           end
         end
-      end
-
-      context "with bundler" do
-        it "renders bundle exec rcov" do
-          with_rcov do
-            spec_command.should =~ /^bundle exec #{ruby} -S rcov/
-          end
-        end
-      end
     end
 
     context "with ruby options" do
       it "renders them before -S" do
-        without_bundler do
           task.ruby_opts = "-w"
           spec_command.should =~ /^#{ruby} -w -S rspec/
-        end
       end
     end
 

metadata

@@ -1,15 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rspec-core
 version: !ruby/object:Gem::Version 
-  hash: 15424039
-  prerelease: 6
+  hash: 19
+  prerelease: 
   segments: 
   - 2
   - 7
   - 0
-  - rc
-  - 1
-  version: 2.7.0.rc1
+  version: 2.7.0
 platform: ruby
 authors: 
 - Chad Humphries
@@ -18,7 +16,7 @@ autorequire:
 bindir: exe
 cert_chain: []
 
-date: 2011-10-09 00:00:00 Z
+date: 2011-10-16 00:00:00 Z
 dependencies: []
 
 description: BDD for Ruby. RSpec runner and example groups.
@@ -212,21 +210,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
-      hash: 25
+      hash: 3
       segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: rspec
-rubygems_version: 1.8.6
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: rspec-core-2.7.0.rc1
+summary: rspec-core-2.7.0
 test_files: 
 - features/Autotest.md
 - features/README.md