rspec-core 2.0.1 → 2.1.0

data/Gemfile

@@ -1,5 +1,9 @@
 source "http://rubygems.org"
 
+%w[rspec-core rspec-expectations rspec-mocks].each do |lib|
+  gem lib, :path => File.expand_path("../../#{lib}", __FILE__)
+end
+
 gem "rake"
 gem "cucumber", "0.8.5"
 gem "aruba", "0.2.2"
@@ -11,9 +15,10 @@ gem "rr"
 gem "flexmock"
 gem "nokogiri"
 gem "syntax"
-gem "rspec-core", :path => "."
-gem "rspec-expectations", :path => "../rspec-expectations"
-gem "rspec-mocks", :path => "../rspec-mocks"
+gem "relish", "~> 0.0.3"
+gem "guard-rspec"
+gem "growl"
+gem "rb-fsevent"
 
 unless RUBY_PLATFORM == "java"
   gem "ruby-prof"

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', :version => 2 do
+  watch('^spec/(.*)_spec.rb')
+  watch('^lib/(.*)\.rb')         { |m| "spec/#{m[1]}_spec.rb" }
+  watch('^spec/spec_helper.rb')  { "spec" }
+end

data/History.markdown

@@ -1,11 +1,41 @@
 ## rspec-core release history (incomplete)
 
+### 2.1.0 / 2010-11-07
+
+[full changelog](http://github.com/rspec/rspec-core/compare/v2.0.1...v2.1.0)
+
+* Enhancments
+  * Add skip_bundler option to rake task to tell rake task to ignore the
+    presence of a Gemfile (jfelchner)
+  * Add gemfile option to rake task to tell rake task what Gemfile to look
+    for (defaults to 'Gemfile')
+  * Allow passing caller trace into Metadata to support extensions (Glenn
+    Vanderburg)
+  * Add deprecation warning for Spec::Runner.configure to aid upgrade from
+    RSpec-1
+  * Add deprecated Spec::Rake::SpecTask to aid upgrade from RSpec-1
+  * Add 'autospec' command with helpful message to aid upgrade from RSpec-1
+  * Add support for filtering with tags on CLI (Lailson Bandeira)
+  * Add a helpful message about RUBYOPT when require fails in bin/rspec
+    (slyphon)
+  * Add "-Ilib" to the default rcov options (Tianyi Cui)
+  * Make the expectation framework configurable (default rspec, of course)
+    (Justin Ko)
+  * Add 'pending' to be conditional (Myron Marston)
+  * Add explicit support for :if and :unless as metadata keys for conditional run
+    of examples (Myron Marston)
+  * Add --fail-fast command line option (Jeff Kreeftmeijer)
+
+* Bug fixes
+  * Eliminate stack overflow with "subject { self }"
+  * Require 'rspec/core' in the Raketask (ensures it required when running rcov)
+
 ### 2.0.1 / 2010-10-18
 
 [full changelog](http://github.com/rspec/rspec-core/compare/v2.0.0...v2.0.1)
 
 * Bug fixes
-  * restore color when using spork + autotest
+  * Restore color when using spork + autotest
   * Pending examples without docstrings render the correct message (Josep M. Bach)
   * Fixed bug where a failure in a spec file ending in anything but _spec.rb would
     fail in a confusing way.
@@ -28,7 +58,7 @@
 
 * Enhancements
   * implicitly require unknown formatters so you don't have to require the
-    file explicitly on the commmand line (Michael Grosser) 
+    file explicitly on the commmand line (Michael Grosser)
   * add --out/-o option to assign output target
   * added fail_fast configuration option to abort on first failure
   * support a Hash subject (its([:key]) { should == value }) (Josep M. Bach)

data/README.markdown

@@ -2,13 +2,20 @@
 
 Behaviour Driven Development for Ruby
 
-## Upgrading from rspec-1.x
+## Documentation
 
-See [Upgrade.markdown](http://github.com/rspec/rspec-core/blob/master/Upgrade.markdown)
+* [Cucumber features](http://relishapp.com/rspec/rspec-core/v/2-0)
+* [RDoc](http://rubydoc.info/gems/rspec-core/2.0.1/frames)
 
 ## Install
 
-    gem install rspec -v 2.0.0
+    gem install rspec      # for rspec-core, rspec-expectations, rspec-mocks
+    gem install rspec-core # for rspec-core only
+
+## Upgrading from rspec-1.x
+
+See [Upgrade.markdown](http://github.com/rspec/rspec-core/blob/master/Upgrade.markdown)
+
 
 This will install the rspec, rspec-core, rspec-expectations and rspec-mocks
 gems.

data/Rakefile

@@ -18,10 +18,6 @@ class Cucumber::Rake::Task::ForkedCucumberRunner
   end
 end
 
-task :cleanup_rcov_files do
-  rm_rf 'coverage.data'
-end
-
 desc "Run all examples"
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.rspec_path = 'bin/rspec'
@@ -30,25 +26,28 @@ end
 
 Cucumber::Rake::Task.new(:cucumber)
 
-namespace :spec do
-  desc "Run all examples using rcov"
-  RSpec::Core::RakeTask.new :rcov => :cleanup_rcov_files do |t|
+namespace :rcov do
+  task :cleanup do
+    rm_rf 'coverage.data'
+  end
+
+  RSpec::Core::RakeTask.new :spec do |t|
     t.rcov = true
     t.rcov_opts =  %[-Ilib -Ispec --exclude "gems/*,features"]
-    t.rcov_opts << %[--text-report --sort coverage --no-html --aggregate coverage.data]
+    t.rcov_opts << %[--no-html --aggregate coverage.data]
   end
-end
 
-namespace :cucumber do
-  desc "Run cucumber features using rcov"
-  Cucumber::Rake::Task.new :rcov => :cleanup_rcov_files do |t|
+  Cucumber::Rake::Task.new :cucumber do |t|
     t.cucumber_opts = %w{--format progress}
     t.rcov = true
     t.rcov_opts =  %[-Ilib -Ispec --exclude "gems/*,features"]
     t.rcov_opts << %[--text-report --sort coverage --aggregate coverage.data]
   end
+
 end
 
+task :rcov => ["rcov:cleanup", "rcov:spec", "rcov:cucumber"]
+
 task :default => [:spec, :cucumber]
 
 task :clobber do
@@ -60,7 +59,7 @@ end
 desc "Push cukes to relishapp using the relish-client-gem"
 task :relish, :version do |t, args|
   raise "rake relish[VERSION]" unless args[:version]
-  sh "bundle exec relish --organization rspec --project rspec-core -v #{args[:version]} push"
+  sh "relish push --organization rspec --project rspec-core -v #{args[:version]}"
 end
 
 Rake::RDocTask.new do |rdoc|

data/Upgrade.markdown

@@ -1,148 +1,67 @@
-# Upgrade to rspec-core-2.0
+# New features in rspec-core-2.1
 
-## What's changed since RSpec-1
+## Command line
 
-### rspec command
-
-The command to run specs is now `rspec` instead of `spec`.
-
-    rspec ./spec
-
-#### Co-habitation of rspec-1 and rspec-2
-
-Early beta versions of RSpec-2 included a `spec` command, which conflicted with
-the RSpec-1 `spec` command because RSpec-1's was installed by the rspec gem,
-while RSpec-2's is installed by the rspec-core gem.
-
-If you installed one of these early versions, the safest bet is to uninstall
-rspec-1 and rspec-core-2, and then reinstall both. After you do this, you will
-be able to run rspec-2 like this:
-
-    `rspec ./spec`
-
-... and rspec-1 like this:
-
-    `spec _1.3.1_ ./spec`
-
-Rubygems inspects the first argument to any gem executable to see if it's
-formatted like a version number surrounded by underscores. If so, it uses that
-version (e.g.  `1.3.1`). If not, it uses the most recent version (e.g.
-`2.0.0`).
-
-### rake task
-
-The RSpec rake task has moved to:
-
-    'rspec/core/rake_task'
-
-RCov options are now set directly on the Rake task:
-
-    RSpec::Core::RakeTask.new(:rcov) do |t|
-      t.rcov_opts =  %q[--exclude "spec"]
-    end
-
-In RSpec-1, the rake task would read in rcov options from an `rcov.opts`
-file. This is ignored by RSpec-2.
-
-### autotest
-
-RSpec-2 works with autotest as follows:
-
-    rspec --configure autotest
-
-This adds `./autotest/discover.rb` with:
-
-    Autotest.add_discovery { "rspec2" }
-
-Now, on the command line just type:
-
-    autotest
-
-Or, if you're using bundler:
-
-    bundle exec autotest
-
-The `autospec` command is a thing of the past. 
-
-### RSpec is the new Spec
-
-The root namespace (top level module) is now `RSpec` instead of `Spec`, and
-the root directory under `lib` within all of the `rspec` gems is `rspec` instead of `spec`.
+### `--tags`
 
-### Configuration
-
-Typically in `spec/spec_helper.rb`, configuration is now done like this:
+Now you can tag groups and examples using metadata and access those tags from
+the command line. So if you have a group with `:foo => true`:
 
-    RSpec.configure do |c|
-      # ....
+    describe "something", :foo => true do
+      it "does something" do
+        # ...
+      end
     end
 
-### .rspec
+... now you can run just that group like this:
 
-Command line options can be persisted in a `.rspec` file in a project. You
-can also store a `.rspec` file in your home directory (`~/.rspec`) with global
-options. Precedence is:
+    rspec spec --tags foo
 
-    command line
-    ./.rspec
-    ~/.rspec
+### `--fail-fast`
 
-### Bones
+Add this flag to the command line to tell rspec to clean up and exit after the
+first failure:
 
-Bones produces a handy little Rakefile to provide several services including
-running specs. The current version (3.4.7) still assumes RSpec-1. To bring its
-Rakefile into conformance with RSpec-2 a few changes are necessary.
+    rspec spec --fail-fast
 
-1.  The require line has changed to `require 'spec/rake/spectask'`
+## Metata/filtering
 
-2.  The `spec_opts` accessor has been deprecated in favor of `rspec_opts`. Also,
-    the `rspec` command no longer supports the `--options` command line option
-    so the options must be embedded directly in the Rakefile, or stored in the
-    `.rspec` files mentioned above.
+### :if and :unless keys
 
-3.  The `spec_files` accessor has been replaced by `pattern`.
-
-Here is a complete example:
-
-    # rspec-1
-    Spec::Rake::SpecTask.new do |t|
-      t.spec_opts = ['--options', "\"spec/spec.opts\""]
-      t.spec_files = FileList['spec/**/*.rb']
-    end
-
-becomes:
+Use :if and :unless keys to conditionally run examples with simple boolean
+expressions:
 
-    # rspec-2
-    RSpec::Core::RakeTask.new do |t|
-      t.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb"]
-      t.pattern = 'spec/**/*_spec.rb'
+    describe "something" do
+      it "does something", :if => RUBY_VERSION == 1.8.6 do
+        # ...
+      end
+      it "does something", :unless => RUBY_VERSION == 1.8.6 do
+        # ...
+      end
     end
 
-### `context` is no longer a top-level method
+## Conditionally 'pending' examples
 
-We removed `context` from the main object because it was creating conflicts with
-IRB and some users who had `Context` domain objects. `describe` is still there,
-so if you want to use `context` at the top level, just alias it:
-
-    alias :context :describe
-
-Of course, you can still use `context` to declare a nested group:
+Make examples pending based on a condition.  This is most useful when you
+have an example that runs in multiple contexts and fails in one of those due to
+a bug in a third-party dependency that you expect to be fixed in the future.
 
     describe "something" do
-      context "in some context" do
-        it "does something" do
-          # ...
+      it "does something that doesn't yet work right on JRuby" do
+        pending("waiting for the JRuby team to fix issue XYZ", :if => RUBY_PLATFORM == 'java') do
+          # the content of your spec
         end
       end
     end
 
-### `$KCODE` no longer set implicitly to `'u'`
+This example would run normally on all ruby interpretters except JRuby.  On JRuby,
+it uses the block form of `pending`, which causes the example to still be run and
+will remain pending as long as it fails.  In the future, if you upgraded your
+JRuby installation to a newer release that allows the example to pass, RSpec
+will report it as a failure (`Expected pending '...' to fail.  No Error was raised.`),
+so that know that you can remove the call to `pending`.
 
-In RSpec-1, the runner set `$KCODE` to `'u'`, which impacts, among other
-things, the behaviour of Regular Expressions when applied to non-ascii
-characters. This is no longer the case in RSpec-2.
-
-## What's new
+# New features in rspec-core-2.0
 
 ### Runner
 
@@ -233,3 +152,138 @@ NOTICE: The including example groups no longer have access to any of the
 methods, hooks, or state defined inside a shared group. This will break specs
 that were using shared example groups to extend the behavior of including
 groups in any way besides their intended purpose: to add examples to a group.
+
+# Upgrading from rspec-1.x
+
+### rspec command
+
+The command to run specs is now `rspec` instead of `spec`.
+
+    rspec ./spec
+
+#### Co-habitation of rspec-1 and rspec-2
+
+Early beta versions of RSpec-2 included a `spec` command, which conflicted with
+the RSpec-1 `spec` command because RSpec-1's was installed by the rspec gem,
+while RSpec-2's is installed by the rspec-core gem.
+
+If you installed one of these early versions, the safest bet is to uninstall
+rspec-1 and rspec-core-2, and then reinstall both. After you do this, you will
+be able to run rspec-2 like this:
+
+    rspec ./spec
+
+... and rspec-1 like this:
+
+    spec _1.3.1_ ./spec
+
+Rubygems inspects the first argument to any gem executable to see if it's
+formatted like a version number surrounded by underscores. If so, it uses that
+version (e.g.  `1.3.1`). If not, it uses the most recent version (e.g.
+`2.0.0`).
+
+### rake task
+
+A few things changed in the Rake task used to run specs:
+
+1.  The file in which it is defined changed from `spec/rake/spectask` to
+    `rspec/core/rake_task`
+
+2.  The `spec_opts` accessor has been deprecated in favor of `rspec_opts`. Also,
+    the `rspec` command no longer supports the `--options` command line option
+    so the options must be embedded directly in the Rakefile, or stored in the
+    `.rspec` files mentioned above.
+    
+3.  In RSpec-1, the rake task would read in rcov options from an `rcov.opts`
+    file. This is ignored by RSpec-2. RCov options are now set directly on the Rake
+    task:
+
+        RSpec::Core::RakeTask.new(:rcov) do |t|
+          t.rcov_opts =  %q[--exclude "spec"]
+        end
+
+3.  The `spec_files` accessor has been replaced by `pattern`.
+
+        # rspec-1
+        require 'spec/rake/spectask'
+
+        Spec::Rake::SpecTask.new do |t|
+          t.spec_opts = ['--options', "\"spec/spec.opts\""]
+          t.spec_files = FileList['spec/**/*.rb']
+        end
+
+        # rspec-2
+        require 'rspec/core/rake_task'
+
+        RSpec::Core::RakeTask.new do |t|
+          t.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb"]
+          t.pattern = 'spec/**/*_spec.rb'
+        end
+
+### autotest
+
+RSpec-2 works with autotest as follows:
+
+    rspec --configure autotest
+
+This adds `./autotest/discover.rb` with:
+
+    Autotest.add_discovery { "rspec2" }
+
+Now, on the command line just type:
+
+    autotest
+
+Or, if you're using bundler:
+
+    bundle exec autotest
+
+The `autospec` command is a thing of the past. 
+
+### RSpec is the new Spec
+
+The root namespace (top level module) is now `RSpec` instead of `Spec`, and
+the root directory under `lib` within all of the `rspec` gems is `rspec` instead of `spec`.
+
+### Configuration
+
+Typically in `spec/spec_helper.rb`, configuration is now done like this:
+
+    RSpec.configure do |c|
+      # ....
+    end
+
+### .rspec
+
+Command line options can be persisted in a `.rspec` file in a project. You
+can also store a `.rspec` file in your home directory (`~/.rspec`) with global
+options. Precedence is:
+
+    command line
+    ./.rspec
+    ~/.rspec
+
+### `context` is no longer a top-level method
+
+We removed `context` from the main object because it was creating conflicts with
+IRB and some users who had `Context` domain objects. `describe` is still there,
+so if you want to use `context` at the top level, just alias it:
+
+    alias :context :describe
+
+Of course, you can still use `context` to declare a nested group:
+
+    describe "something" do
+      context "in some context" do
+        it "does something" do
+          # ...
+        end
+      end
+    end
+
+### `$KCODE` no longer set implicitly to `'u'`
+
+In RSpec-1, the runner set `$KCODE` to `'u'`, which impacts, among other
+things, the behaviour of Regular Expressions when applied to non-ascii
+characters. This is no longer the case in RSpec-2.
+