rspec-core 2.5.1 → 2.6.0

data/.travis.yml

@@ -0,0 +1,7 @@
+script: "rake"
+rvm:
+  - 1.8.6
+  - 1.8.7
+  - 1.9.1
+  - 1.9.2
+  - ree

data/Gemfile

@@ -1,19 +1,20 @@
 source "http://rubygems.org"
 
 ### rspec libs
-%w[rspec-core rspec-expectations rspec-mocks].each do |lib|
+%w[rspec rspec-core rspec-expectations rspec-mocks].each do |lib|
   library_path = File.expand_path("../../#{lib}", __FILE__)
   if File.exist?(library_path)
     gem lib, :path => library_path
   else
-    gem lib
+    gem lib, :git => "git://github.com/rspec/#{lib}.git"
   end
 end
 
+
 ### dev dependencies
 gem "rake", "0.8.7"
-gem "cucumber", "0.9.4"
-gem "aruba", "0.2.2"
+gem "cucumber", "~> 0.10.2"
+gem "aruba", "~> 0.3.6"
 gem "rcov", "0.9.9", :platforms => :mri
 gem "relish", "0.2.0"
 gem "guard-rspec", "0.1.9"
@@ -21,17 +22,14 @@ gem "growl", "1.0.3"
 gem "ZenTest", "~> 4.4.2"
 gem "nokogiri", "1.4.4"
 
-if RUBY_PLATFORM =~ /darwin/
-  gem "autotest-fsevent", "~> 0.2.4"
-  gem "autotest-growl", "~> 0.2.9"
+platforms :mri_18 do
+  gem 'ruby-debug'
 end
 
-gem "ruby-debug", :platforms => :mri_18
-gem "ruby-debug19", "~> 0.11.6", :platforms => :mri_19
-
-case RUBY_VERSION
-  when '1.9.1'; gem 'ruby-debug-base19', '0.11.23'
-  when '1.9.2'; gem 'ruby-debug-base19', '0.11.24'
+platforms :mri_19 do
+  gem 'linecache19', '0.5.11' # 0.5.12 cannot install on 1.9.1, and 0.5.11 appears to work with both 1.9.1 & 1.9.2
+  gem 'ruby-debug19'
+  gem 'ruby-debug-base19', RUBY_VERSION == '1.9.1' ? '0.11.23' : '~> 0.11.24'
 end
 
 platforms :mri_18, :mri_19 do
@@ -46,7 +44,7 @@ end
 ### rspec-core only
 gem "mocha", "~> 0.9.10"
 gem "rr", "~> 1.0.2"
-gem "flexmock", "~> 0.8.11"
+gem "flexmock", "0.8.8"
 
 ### optional runtime deps
 gem "syntax", "1.0.0"

data/README.md

@@ -1,6 +1,9 @@
 # RSpec Core
 
-Behaviour Driven Development for Ruby
+RSpec Core provides the structure for writing executable examples of how your
+code should behave.
+
+[![build status](http://travis-ci.org/rspec/rspec-core.png)](http://travis-ci.org/rspec/rspec-core)
 
 ## Documentation
 

data/Rakefile

@@ -8,13 +8,25 @@ require "yaml"
 require "rake/rdoctask"
 require "rspec/core/rake_task"
 require "rspec/core/version"
-require "cucumber/rake/task"
 
-class Cucumber::Rake::Task::ForkedCucumberRunner
-  # When cucumber shells out, we still need it to run in the context of our
-  # bundle.
-  def run
-    sh "bundle exec #{RUBY} " + args.join(" ")
+cucumber_loaded = false
+begin
+  require "cucumber/rake/task"
+
+  Cucumber::Rake::Task.new(:cucumber)
+
+  class Cucumber::Rake::Task::ForkedCucumberRunner
+    # When cucumber shells out, we still need it to run in the context of our
+    # bundle.
+    def run
+      sh "bundle exec #{RUBY} " + args.join(" ")
+    end
+  end
+  cucumber_loaded = true
+rescue LoadError => e
+  puts "unable to load cucumber, some tasks unavailable"
+  task :cucumber do
+    # no-op
   end
 end
 
@@ -25,7 +37,6 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   t.verbose = false
 end
 
-Cucumber::Rake::Task.new(:cucumber)
 
 namespace :rcov do
   task :cleanup do
@@ -38,11 +49,17 @@ namespace :rcov do
     t.rcov_opts << %[--no-html --aggregate coverage.data]
   end
 
-  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]
+  if cucumber_loaded
+    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
+  else
+    task :cucumber do
+      # no-op
+    end
   end
 
 end

data/cucumber.yml

@@ -1,2 +1,2 @@
-default: --require features --strict --format progress --tags ~@wip features
+default: --require features --strict --format progress --tags ~@wip<%= RUBY_PLATFORM == 'java' ? ' --tags ~@no-jruby' : '' %> features
 wip:     --require features --tags @wip:3 --wip features

data/features/.nav

@@ -4,6 +4,16 @@
 - example_groups:
   - basic_structure.feature
   - shared_example_group.feature
+  - shared_context.feature
+- command_line:
+  - configure.feature
+  - example_name_option.feature
+  - format_option.feature
+  - line_number_option.feature
+  - tag.feature
+  - line_number_appended_to_path.feature
+  - exit_status.feature
+  - rake_task.feature
 - pending:
   - pending_examples.feature
 - hooks:
@@ -18,25 +28,21 @@
 - helper_methods:
   - let.feature
   - arbitrary_methods.feature
+  - modules.feature
 - metadata:
+  - current_example.feature
   - described_class.feature
+  - user_defined.feature
 - filtering:
   - inclusion_filters.feature
   - exclusion_filters.feature
-  - implicit_filters.feature
+  - if_and_unless.feature
   - run_all_when_everything_filtered.feature
-- command_line:
-  - configure.feature
-  - example_name_option.feature
-  - exit_status.feature
-  - line_number_appended_to_path.feature
-  - line_number_option.feature
-  - rake_task.feature
-  - tag.feature
 - configuration:
   - read_options_from_file.feature
   - fail_fast.feature
   - custom_settings.feature
+  - alias_example_to.feature
 - expectation_framework_integration:
   - configure_expectation_framework.feature
 - mock_framework_integration:

data/features/Autotest.md

@@ -1,14 +1,38 @@
-RSpec ships with a specialized subclass of Autotest. To tell RSpec to tell
-Autotest to use RSpec's extension, just add a `.rspec` file to your project's
-root directory. Then, just type:
+RSpec ships with a specialized subclass of Autotest. To use it, just add a
+`.rspec` file to your project's root directory, and run the `autotest` command
+as normal:
 
     $ autotest
 
-### Bundler
+## Bundler
 
-If you are using Bundler in your app, and you want the shell command to include
-`bundle exec`, require the Autotest bundler plugin in a `.autotest` file in the project's
-root directory or your home directory:
+The `autotest` command generates a shell command that runs your specs. If you
+are using Bundler, and you want the shell command to include `bundle exec`,
+require the Autotest bundler plugin in a `.autotest` file in the project's root
+directory or your home directory:
 
     # in .autotest
     require "autotest/bundler"
+
+## Upgrading from previous versions of rspec
+
+Previous versions of RSpec used a different mechanism for telling autotest to
+invoke RSpec's Autotest extension: it generated an `autotest/discover.rb` file
+in the project's root directory. This is no longer necessary with the new
+approach of RSpec looking for a `.rspec` file, so feel free to delete the
+`autotest/discover.rb` file in the project root if you have one.
+
+## Gotchas
+
+### Invalid Option: --tty
+
+The `--tty` option was [added in rspec-core-2.2.1](changelog), and is used
+internally by RSpec. If you see an error citing it as an invalid option, you'll
+probably see there are two or more versions of rspec-core in the backtrace: one
+< 2.2.1 and one >= 2.2.1.
+
+This usually happens because you have a newer rspec-core installed, and an
+older rspec-core specified in a Bundler Gemfile. If this is the case, you can:
+
+1. specify the newer version in the Gemfile (recommended)
+2. prefix the `autotest` command with `bundle exec`

data/features/Changelog.md

@@ -1,4 +1,47 @@
-### 2.5.1 / 2011-02-05
+### 2.6.0 / 2011-05-12
+
+[full changelog](http://github.com/rspec/rspec-core/compare/v2.5.1...v2.6.0)
+
+* Enhancements
+  * `shared_context` (Damian Nurzynski)
+      * extend groups matching specific metadata with:
+          * method definitions
+          * subject declarations
+          * let/let! declarations
+          * etc (anything you can do in a group)
+  * `its([:key])` works for any subject with #[]. (Peter Jaros)
+  * `treat_symbols_as_metadata_keys_with_true_values` (Myron Marston)
+  * Print a deprecation warning when you configure RSpec after defining
+    an example.  All configuration should happen before any examples are
+    defined. (Myron Marston)
+  * Pass the exit status of a DRb run to the invoking process. This causes
+    specs run via DRb to not just return true or false. (Ilkka Laukkanen)
+  * Refactoring of `ConfigurationOptions#parse_options` (Rodrigo Rosenfeld Rosas)
+  * Report excluded filters in runner output (tip from andyl)
+  * Clean up messages for filters/tags.
+  * Restore --pattern/-P command line option from rspec-1
+  * Support false as well as true in config.full_backtrace= (Andreas Tolf Tolfsen)
+
+* Bug fixes
+  * Don't stumble over an exception without a message (Hans Hasselberg)
+  * Remove non-ascii characters from comments that were choking rcov (Geoffrey
+    Byers)
+  * Fixed backtrace so it doesn't include lines from before the autorun at_exit
+    hook (Myron Marston)
+  * Include RSpec::Matchers when first example group is defined, rather
+    than just before running the examples.  This works around an obscure
+    bug in ruby 1.9 that can cause infinite recursion. (Myron Marston)
+  * Don't send `example_group_[started|finished]` to formatters for empty groups.
+  * Get specs passing on jruby (Sidu Ponnappa)
+  * Fix bug where mixing nested groups and outer-level examples gave
+    unpredictable :line_number behavior (Artur Małecki)
+  * Regexp.escape the argument to --example (tip from Elliot Winkler)
+  * Correctly pass/fail pending block with message expectations
+  * CommandLine returns exit status (0/1) instead of true/false
+  * Create path to formatter output file if it doesn't exist (marekj).
+
+
+### 2.5.1 / 2011-02-06
 
 [full changelog](http://github.com/rspec/rspec-core/compare/v2.5.0...v2.5.1)
 
@@ -68,7 +111,7 @@ If you don't want 'bundle exec', there is nothing you have to do.
 
 * Bug fixes
   * send debugger warning message to $stdout if RSpec.configuration.error_stream
-    has not been defined yet. 
+    has not been defined yet.
   * HTML Formatter _finally_ properly displays nested groups (Jarmo Pertman)
   * eliminate some warnings when running RSpec's own suite (Jarmo Pertman)
 
@@ -96,7 +139,7 @@ If you don't want 'bundle exec', there is nothing you have to do.
 
 * Bug fixes
   * alias_method instead of override Kernel#method_missing (John Wilger)
-  * changed --autotest to --tty in generated command (MIKAMI Yoshiyuki) 
+  * changed --autotest to --tty in generated command (MIKAMI Yoshiyuki)
   * revert change to debugger (had introduced conflict with Rails)
     * also restored --debugger/-debug option
 

data/features/Upgrade.md

@@ -1,3 +1,36 @@
+# rspec-core-2.6
+
+## new APIs for sharing content
+
+Use `shared_context` together with `include_context` to share before/after
+hooks, let declarations, and method definitions across example groups.
+
+Use `shared_examples` together with `include_examples` to share examples
+across different contexts.
+
+All of the old APIs are still supported, but these 4 are easy to remember, and
+serve most use cases.
+
+See `shared_context` and `shared_examples` under "Example Groups" for more
+information.
+
+## `treat_symbols_as_metadata_keys_with_true_values`
+
+Yes it's a long name, but it's a great feature, and it's going to be the
+default behavior in rspec-3. This lets you add metadata to a group or example
+like this:
+
+    describe "something", :awesome do
+      ...
+
+And then you can run that group (or example) using the tags feature:
+
+    rspec spec --tag awesome
+
+We're making this an opt-in for rspec-2.6 because `describe "string", :symbol`
+is a perfectly legal construct in pre-2.6 releases and we want to maintain
+compatibility in minor releases as much as is possible.
+
 # rspec-core-2.3
 
 ## `config.expect_with`
@@ -106,7 +139,7 @@ The most obvious use is for filtering the run. For example:
     end
 
 When you run the `rspec` command, rspec will run only the examples that have
-`:focus => true` in the hash. 
+`:focus => true` in the hash.
 
 You can also add `run_all_when_everything_filtered` to the config:
 
@@ -207,7 +240,7 @@ A few things changed in the Rake task used to run specs:
     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:

data/features/command_line/README.md

@@ -4,3 +4,25 @@ behavior, including output formats, filtering examples, etc.
 For a full list of options, run the `rspec` command with the `--help` flag:
 
     $ rspec --help
+
+### Run with `ruby`
+
+Generally, life is simpler if you just use the `rspec` command. If you must use the `ruby`
+command, however, you'll want to do the following:
+
+* `require 'rspec/autorun'`
+
+This tells RSpec to run your examples.  Do this in any file that you are
+passing to the `ruby` command.
+
+* Update the `LOAD_PATH`
+
+It is conventional to put configuration in and require assorted support files
+from `spec/spec_helper.rb`. It is also conventional to require that file from
+the spec files using `require 'spec_helper'`. This works because RSpec
+implicitly adds the `spec` directory to the `LOAD_PATH`. It also adds `lib`, so
+your implementation files will be on the `LOAD_PATH` as well.
+
+If you're using the `ruby` command, you'll need to do this yourself:
+
+    ruby -Ilib -Ispec path/to/spec.rb

data/features/command_line/configure.feature

@@ -8,7 +8,7 @@ Feature: --configure option
   to load RSpec's Autotest subclass.
 
   Scenario: generate .rspec file for autotest
-    When I run "rspec --configure autotest"
+    When I run `rspec --configure autotest`
     Then the following files should exist:
       | .rspec |
     And the output should contain ".rspec file did not exist, so it was created."
@@ -18,5 +18,5 @@ Feature: --configure option
       """
       --color
       """
-    When I run "rspec --configure autotest"
+    When I run `rspec --configure autotest`
     Then the output should contain ".rspec file already exists, so nothing was changed."

data/features/command_line/example_name_option.feature

@@ -46,41 +46,41 @@ Feature: --example option
       """
 
   Scenario: no matches
-    When I run "rspec . --example nothing_like_this"
+    When I run `rspec . --example nothing_like_this`
     Then the examples should all pass
 
   Scenario: match on one word
-    When I run "rspec . --example example"
+    When I run `rspec . --example example`
     Then the examples should all pass
 
   Scenario: one match in each context
-    When I run "rspec . --example 'first example'"
+    When I run `rspec . --example 'first example'`
     Then the examples should all pass
 
   Scenario: one match in one file using just the example name
-    When I run "rspec . --example 'first example in first group'"
+    When I run `rspec . --example 'first example in first group'`
     Then the examples should all pass
 
   Scenario: one match in one file using the example name and the group name
-    When I run "rspec . --example 'first group first example in first group'"
+    When I run `rspec . --example 'first group first example in first group'`
     Then the examples should all pass
 
   Scenario: one match in one file using regexp
-    When I run "rspec . --example 'first .* first example'"
+    When I run `rspec . --example 'first .* first example'`
     Then the examples should all pass
 
   Scenario: all examples in one group
-    When I run "rspec . --example 'first group'"
+    When I run `rspec . --example 'first group'`
     Then the examples should all pass
 
   Scenario: one match in one file with group name
-    When I run "rspec . --example 'second group first example'"
+    When I run `rspec . --example 'second group first example'`
     Then the examples should all pass
 
   Scenario: all examples in one group including examples in nested groups
-    When I run "rspec . --example 'third group'"
+    When I run `rspec . --example 'third group'`
     Then the examples should all pass
 
   Scenario: Object#method
-    When I run "rspec . --example 'Array#length'"
+    When I run `rspec . --example 'Array#length'`
     Then the examples should all pass

data/features/command_line/exit_status.feature

@@ -11,7 +11,7 @@ Feature: exit status
         end
       end
       """
-    When I run "rspec ok_spec.rb"
+    When I run `rspec ok_spec.rb`
     Then the exit status should be 0
     And the examples should all pass
 
@@ -24,7 +24,7 @@ Feature: exit status
         end
       end
       """
-    When I run "rspec ko_spec.rb"
+    When I run `rspec ko_spec.rb`
     Then the exit status should be 1
     And the output should contain "1 example, 1 failure"
 
@@ -39,7 +39,7 @@ Feature: exit status
         end
       end
       """
-    When I run "rspec nested_ko_spec.rb"
+    When I run `rspec nested_ko_spec.rb`
     Then the exit status should be 1
     And the output should contain "1 example, 1 failure"
       
@@ -47,6 +47,6 @@ Feature: exit status
     Given a file named "a_no_examples_spec.rb" with:
       """
       """
-    When I run "rspec a_no_examples_spec.rb"
+    When I run `rspec a_no_examples_spec.rb`
     Then the exit status should be 0
     And the output should contain "0 examples"

data/features/command_line/format_option.feature

@@ -38,11 +38,11 @@ Feature: --format option
       """
 
   Scenario: progress bar format (default)
-    When I run "rspec example_spec.rb"
+    When I run `rspec example_spec.rb`
     Then the output should contain ".F*"
 
   Scenario: documentation format
-    When I run "rspec example_spec.rb --format documentation"
+    When I run `rspec example_spec.rb --format documentation`
     Then the output should contain:
       """
       something
@@ -52,7 +52,7 @@ Feature: --format option
       """
 
   Scenario: documentation format saved to a file
-    When I run "rspec example_spec.rb --format documentation --out rspec.txt"
+    When I run `rspec example_spec.rb --format documentation --out rspec.txt`
     Then the file "rspec.txt" should contain:
       """
       something
@@ -62,7 +62,7 @@ Feature: --format option
       """
 
   Scenario: multiple formats
-    When I run "rspec example_spec.rb --format progress --format documentation --out rspec.txt"
+    When I run `rspec example_spec.rb --format progress --format documentation --out rspec.txt`
     Then the output should contain ".F*"
     And the file "rspec.txt" should contain:
       """

data/features/command_line/line_number_appended_to_path.feature

@@ -29,77 +29,77 @@ Feature: line number appended to file path
       """
 
   Scenario: nested groups - outer group on declaration line
-    When I run "rspec example_spec.rb:1 --format doc"
+    When I run `rspec example_spec.rb:1 --format doc`
     Then the examples should all pass
     And the output should contain "second example in outer group"
     And the output should contain "first example in outer group"
     And the output should contain "example in nested group"
 
   Scenario: nested groups - outer group inside block before example
-    When I run "rspec example_spec.rb:2 --format doc"
+    When I run `rspec example_spec.rb:2 --format doc`
     Then the examples should all pass
     And the output should contain "second example in outer group"
     And the output should contain "first example in outer group"
     And the output should contain "example in nested group"
 
   Scenario: nested groups - inner group on declaration line
-    When I run "rspec example_spec.rb:11 --format doc"
+    When I run `rspec example_spec.rb:11 --format doc`
     Then the examples should all pass
     And the output should contain "example in nested group"
     And the output should not contain "second example in outer group"
     And the output should not contain "first example in outer group"
 
   Scenario: nested groups - inner group inside block before example
-    When I run "rspec example_spec.rb:12 --format doc"
+    When I run `rspec example_spec.rb:12 --format doc`
     Then the examples should all pass
     And the output should contain "example in nested group"
     And the output should not contain "second example in outer group"
     And the output should not contain "first example in outer group"
 
   Scenario: two examples - first example on declaration line
-    When I run "rspec example_spec.rb:3 --format doc"
+    When I run `rspec example_spec.rb:3 --format doc`
     Then the examples should all pass
     And the output should contain "first example in outer group"
     But the output should not contain "second example in outer group"
     And the output should not contain "example in nested group"
 
   Scenario: two examples - first example inside block
-    When I run "rspec example_spec.rb:4 --format doc"
+    When I run `rspec example_spec.rb:4 --format doc`
     Then the examples should all pass
     And the output should contain "first example in outer group"
     But the output should not contain "second example in outer group"
     And the output should not contain "example in nested group"
 
   Scenario: two examples - first example on end
-    When I run "rspec example_spec.rb:5 --format doc"
+    When I run `rspec example_spec.rb:5 --format doc`
     Then the examples should all pass
     And the output should contain "first example in outer group"
     But the output should not contain "second example in outer group"
     And the output should not contain "example in nested group"
 
   Scenario: two examples - first example after end but before next example
-    When I run "rspec example_spec.rb:6 --format doc"
+    When I run `rspec example_spec.rb:6 --format doc`
     Then the examples should all pass
     And the output should contain "first example in outer group"
     But the output should not contain "second example in outer group"
     And the output should not contain "example in nested group"
 
   Scenario: two examples - second example on declaration line
-    When I run "rspec example_spec.rb:7 --format doc"
+    When I run `rspec example_spec.rb:7 --format doc`
     Then the examples should all pass
     And the output should contain "second example in outer group"
     But the output should not contain "first example in outer group"
     And the output should not contain "example in nested group"
 
   Scenario: two examples - second example inside block
-    When I run "rspec example_spec.rb:7 --format doc"
+    When I run `rspec example_spec.rb:7 --format doc`
     Then the examples should all pass
     And the output should contain "second example in outer group"
     But the output should not contain "first example in outer group"
     And the output should not contain "example in nested group"
 
   Scenario: two examples - second example on end
-    When I run "rspec example_spec.rb:7 --format doc"
+    When I run `rspec example_spec.rb:7 --format doc`
     Then the examples should all pass
     And the output should contain "second example in outer group"
     But the output should not contain "first example in outer group"

data/features/command_line/line_number_option.feature

@@ -21,7 +21,7 @@ Feature: --line_number option
         
       end
       """
-    When I run "rspec example_spec.rb --line_number 5 --format doc"
+    When I run `rspec example_spec.rb --line_number 5 --format doc`
     Then the examples should all pass
     Then the output should contain "should be > 8"
     But the output should not contain "should be < 10"
@@ -39,7 +39,7 @@ Feature: --line_number option
         
       end
       """
-    When I run "rspec example_spec.rb --line_number 5 --format doc"
+    When I run `rspec example_spec.rb --line_number 5 --format doc`
     Then the examples should all pass
     Then the output should contain "should be > 8"
     But the output should not contain "should be < 10"

data/features/command_line/rake_task.feature

@@ -19,7 +19,7 @@ Feature: rake task
         end
       end
       """
-    When I run "rake"
+    When I run `rake`
     Then the stderr should contain "ruby -S rspec"
     Then the exit status should be 0
 
@@ -40,7 +40,7 @@ Feature: rake task
         end
       end
       """
-    When I run "rake"
+    When I run `rake`
     Then the exit status should be 1
       
   Scenario: fail_on_error = false with failing spec (exit status is 0)
@@ -62,7 +62,7 @@ Feature: rake task
         end
       end
       """
-    When I run "rake"
+    When I run `rake`
     Then the exit status should be 0