rspec-core 2.99.2 → 3.0.0.beta1

data/License.txt

@@ -1,5 +1,6 @@
 (The MIT License)
 
+Copyright (c) 2012 Chad Humphries, David Chelimsky, Myron Marston
 Copyright (c) 2009 Chad Humphries, David Chelimsky
 Copyright (c) 2006 David Chelimsky, The RSpec Development Team
 Copyright (c) 2005 Steven Baker

data/README.md

@@ -1,4 +1,4 @@
-# rspec-core [![Build Status](https://secure.travis-ci.org/rspec/rspec-core.png?branch=master)](http://travis-ci.org/rspec/rspec-core) [![Code Climate](https://codeclimate.com/github/rspec/rspec-core.png)](https://codeclimate.com/github/rspec/rspec-core)
+# rspec-core [![Build Status](https://secure.travis-ci.org/rspec/rspec-core.png?branch=master)](http://travis-ci.org/rspec/rspec-core) [![Code Climate](https://codeclimate.com/github/rspec/rspec-core.png)](https://codeclimate.com/github/rspec/rspec-core) [![Coverage Status](https://coveralls.io/repos/rspec/rspec-core/badge.png?branch=master)](https://coveralls.io/r/rspec/rspec-core?branch=master)
 
 rspec-core provides the structure for writing executable examples of how your
 code should behave, and an `rspec` command with tools to constrain which
@@ -165,30 +165,9 @@ the command line.
 
 ## autotest integration
 
-rspec-core ships with an Autotest extension, which is loaded automatically if
-there is a `.rspec` file in the project's root directory.
-
-## rcov integration
-
-rcov is best integrated via the [rcov rake
-task](http://www.rubydoc.info/github/relevance/rcov/master/Rcov/RcovTask).
-
-rcov can also be integrated via the rspec rake task, but it requires a bit
-more setup:
-
-```ruby
-# Rakefile
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec) do |config|
-  config.rcov = true
-end
-
-task :default => :spec
-
-# spec/spec_helper.rb
-require 'rspec/autorun' # **add this**
-```
+rspec-core no longer ships with an Autotest extension, if you require Autotest
+integration, please use the `rspec-autotest` gem and see [rspec/auto-test](https://github.com/rspec/auto-test)
+for details
 
 ## get started
 

data/features/Upgrade.md

@@ -123,10 +123,10 @@ Use :if and :unless keys to conditionally run examples with simple boolean
 expressions:
 
     describe "something" do
-      it "does something", :if => RUBY_VERSION == 1.8.6 do
+      it "does something", :if => RUBY_VERSION == 1.8.7 do
         # ...
       end
-      it "does something", :unless => RUBY_VERSION == 1.8.6 do
+      it "does something", :unless => RUBY_VERSION == 1.8.7 do
         # ...
       end
     end
@@ -285,14 +285,6 @@ A few things changed in the Rake task used to run specs:
     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
@@ -311,10 +303,6 @@ A few things changed in the Rake task used to run specs:
           t.pattern = 'spec/**/*_spec.rb'
         end
 
-### autotest
-
-`autospec` is dead. Long live `autotest`.
-
 ### RSpec is the new Spec
 
 The root namespace (top level module) is now `RSpec` instead of `Spec`, and

data/features/command_line/dry_run.feature

@@ -0,0 +1,29 @@
+Feature: --dry-run
+
+  Use the `--dry-run` option to have RSpec print your suite's formatter
+  output without running any examples or hooks.
+
+  Scenario: Using --dry-run
+    Given a file named "spec/dry_run_spec.rb" with:
+      """ruby
+      RSpec.configure do |c|
+        c.before(:suite) { puts "before suite" }
+        c.after(:suite)  { puts "after suite"  }
+      end
+
+      describe "dry run" do
+        before(:all)  { fail }
+        before(:each) { fail }
+
+        it "fails in example" do
+          fail
+        end
+
+        after(:each) { fail }
+        after(:all)  { fail }
+      end
+      """
+    When I run `rspec --dry-run`
+    Then the output should contain "1 example, 0 failures"
+     And the output should not contain "before suite"
+     And the output should not contain "after suite"

data/features/command_line/example_name_option.feature

@@ -41,7 +41,7 @@ Feature: --example option
       describe Array do
         describe "#length" do
           it "is the number of items" do
-            Array.new([1,2,3]).length.should eq 3
+            expect(Array.new([1,2,3]).length).to eq 3
           end
         end
       end

data/features/command_line/fail_fast.feature

@@ -0,0 +1,26 @@
+Feature: --fail-fast
+
+  Use the `--fail-fast` option to tell RSpec to stop running the test suite on the first failed test.
+
+  You may also specify `--no-fail-fast` to turn it off (default behaviour).
+
+  Background:
+    Given a file named "fail_fast_spec.rb" with:
+      """ruby
+      describe "fail fast" do
+        it "passing test" do; end
+        it "failing test" do
+          fail
+        end
+        it "this should not be run" do; end
+      end
+      """
+
+  Scenario: Using --fail-fast
+    When I run `rspec . --fail-fast`
+    Then the output should contain ".F"
+    Then the output should not contain ".F."
+
+  Scenario: Using --no-fail-fast
+    When I run `rspec . --no-fail-fast`
+    Then the output should contain ".F."

data/features/command_line/format_option.feature

@@ -26,15 +26,15 @@ Feature: --format option
       """ruby
       describe "something" do
         it "does something that passes" do
-          5.should eq(5)
+          expect(5).to eq(5)
         end
 
         it "does something that fails" do
-          5.should eq(4)
+          expect(5).to eq(4)
         end
 
         it "does something that is pending", :pending => true do
-          5.should be > 3
+          expect(5).to be > 3
         end
       end
       """

data/features/command_line/line_number_option.feature

@@ -14,26 +14,30 @@ Feature: --line_number option
       describe 9 do
 
         it "should be > 8" do
-          9.should be > 8
+          expect(9).to be > 8
         end
 
         it "should be < 10" do
-          9.should be < 10
+          expect(9).to be < 10
         end
 
         it "should be 3 squared" do
-          9.should be 3*3
+          expect(9).to be 3*3
         end
 
       end
       """
-    When I run `rspec example_spec.rb --line_number 5`
+    When I run `rspec example_spec.rb --line_number 5 --format doc`
     Then the examples should all pass
-    And the output should contain "1 example"
+    And the output should contain "should be > 8"
+    But the output should not contain "should be < 10"
+    And the output should not contain "should be 3*3"
 
-    When I run `rspec example_spec.rb --line_number 5 --line_number 9`
+    When I run `rspec example_spec.rb --line_number 5 --line_number 9 --format doc`
     Then the examples should all pass
-    And the output should contain "2 examples"
+    And the output should contain "should be > 8"
+    And the output should contain "should be < 10"
+    But the output should not contain "should be 3*3"
 
   Scenario: one liner
     Given a file named "example_spec.rb" with:
@@ -42,12 +46,13 @@ Feature: --line_number option
 
       describe 9 do
 
-        it { is_expected.to be > 8 }
+        it { should be > 8 }
 
-        it { is_expected.not_to be < 10 }
+        it { should be < 10 }
 
       end
       """
-    When I run `rspec example_spec.rb --line_number 5`
+    When I run `rspec example_spec.rb --line_number 5 --format doc`
     Then the examples should all pass
-    And the output should contain "1 example"
+    Then the output should contain "should be > 8"
+    But the output should not contain "should be < 10"

data/features/command_line/order.feature

@@ -6,14 +6,13 @@ Feature: --order (new in rspec-core-2.8)
   `defined` is the default, which executes groups and examples in the
   order they are defined as the spec files are loaded.
 
-  Use `rand` to randomize the order of files, groups within files, and
-  examples within groups.*
+  Use `rand` to randomize the order of groups and examples within groups.*
 
   * Nested groups are always run from top-level to bottom-level in order to avoid
     executing `before(:all)` and `after(:all)` hooks more than once, but the order
     of groups at each level is randomized.
 
-  You can also specify a seed
+  You can also specify a seed:
 
   <h3>Examples</h3>
 

data/features/command_line/pattern_option.feature

@@ -11,7 +11,7 @@ Feature: pattern option
       """ruby
       describe "addition" do
         it "adds things" do
-          (1 + 2).should eq(3)
+          expect(1 + 2).to eq(3)
         end
       end
       """
@@ -23,7 +23,7 @@ Feature: pattern option
       """ruby
       describe "addition" do
         it "adds things" do
-          (1 + 2).should eq(3)
+          expect(1 + 2).to eq(3)
         end
       end
       """
@@ -41,7 +41,7 @@ Feature: pattern option
       """ruby
       describe "addition" do
         it "adds things" do
-          (1 + 2).should eq(3)
+          expect(1 + 2).to eq(3)
         end
       end
       """

data/features/command_line/randomization.feature

@@ -0,0 +1,63 @@
+Feature: Randomization can be reproduced across test runs
+
+  In Ruby, randomness is seeded by calling `srand`
+  and passing it the seed that you want to use.
+  By doing this, subsequent calls to `rand`, `shuffle`, `sample`, etc.
+  will all be randomized the same way given the same seed is passed to `srand`.
+
+  RSpec takes care not to seed randomization directly
+  when taking action that involves randomness
+  (such as random ordering of examples).
+
+  Since RSpec does not ever invoke `srand`, this means that you
+  are free to choose which, if any, mechanism is used to seed randomization.
+
+  There is an example below of how to use RSpec's seed for this purpose
+  if you wish to do so.
+
+  If you would like to manage seeding randomization without any help from RSpec,
+  please keep the following things in mind:
+
+    * The seed should never be hard-coded.
+
+      The first example below only does this to show that seeding randomization
+      with a seed other than the one used by RSpec
+      will correctly seed randomization.
+
+    * Report the seed that was chosen.
+
+      The randomization that was used for a given test run can not be reproduced
+      if noone knows what seed was used to begin with.
+
+    * Provide a mechanism to feed the seed into the tests.
+
+      Without this, the call to `srand` will have to be hard-coded any time
+      it is necessary to replicate a given test run's randomness.
+
+  Background:
+    Given a file named "spec/random_spec.rb" with:
+      """ruby
+      require 'spec_helper'
+
+      describe 'randomized example' do
+        it 'prints random numbers' do
+          puts 5.times.map { rand(99) }.join("-")
+        end
+      end
+      """
+
+  Scenario: Specifying a seed using srand provides predictable randomization
+    Given a file named "spec/spec_helper.rb" with:
+      """ruby
+      srand 123
+      """
+    When I run `rspec`
+    Then the output should contain "66-92-98-17-83"
+
+  Scenario: Passing the RSpec seed to srand provides predictable randomization
+    Given a file named "spec/spec_helper.rb" with:
+      """ruby
+      srand RSpec.configuration.seed
+      """
+    When I run `rspec --seed 123`
+    Then the output should contain "66-92-98-17-83"

data/features/command_line/require_option.feature

@@ -20,8 +20,8 @@ Feature: --require option
             super
           end
 
-          def puts(message)
-            [@file, __getobj__].each { |out| out.puts message }
+          def puts(*args)
+            [@file, __getobj__].each { |out| out.puts(*args) }
           end
 
           def close

data/features/command_line/ruby.feature

@@ -14,7 +14,7 @@ Feature: run with ruby command
 
       describe 1 do
         it "is < 2" do
-          1.should be < 2
+          expect(1).to be < 2
         end
       end
       """

data/features/configuration/alias_example_to.feature

@@ -1,48 +1,39 @@
 Feature: alias_example_to
 
   Use `config.alias_example_to` to create new example group methods
-  that define examples with the configured metadata.
+  that define examples with the configured metadata.  You can also
+  specify metadata using only symbols.
 
-  If you set the `treat_symbols_as_metadata_keys_with_true_values` config option
-  to `true`, you can specify metadata using only symbols.
-
-  Scenario: Use alias_example_to to define focused example
+  Scenario: Use alias_example_to to define pending example
     Given a file named "alias_example_to_spec.rb" with:
       """ruby
       RSpec.configure do |c|
-        c.alias_example_to :fit, :focused => true
-        c.filter_run :focused => true
+        c.alias_example_to :pit, :pending => "Pit alias used"
       end
 
       describe "an example group" do
-        it "does one thing" do
-        end
-
-        fit "does another thing" do
+        pit "does something later on" do
+          fail "not implemented yet"
         end
       end
       """
     When I run `rspec alias_example_to_spec.rb --format doc`
-    Then the output should contain "does another thing"
-    And the output should not contain "does one thing"
+    Then the output should contain "does something later on (PENDING: Pit alias used)"
+    And the output should contain "0 failures"
 
   Scenario: use symbols as metadata
     Given a file named "use_symbols_as_metadata_spec.rb" with:
       """ruby
       RSpec.configure do |c|
-        c.treat_symbols_as_metadata_keys_with_true_values = true
-        c.alias_example_to :fit, :focused
-        c.filter_run :focused
+        c.alias_example_to :pit, :pending
       end
 
       describe "an example group" do
-        it "does one thing" do
-        end
-
-        fit "does another thing" do
+        pit "does something later on" do
+          fail "not implemented yet"
         end
       end
       """
     When I run `rspec use_symbols_as_metadata_spec.rb --format doc`
-    Then the output should contain "does another thing"
-    And the output should not contain "does one thing"
+    Then the output should contain "does something later on (PENDING: No reason given)"
+    And the output should contain "0 failures"

data/features/configuration/{backtrace_clean_patterns.feature → backtrace_exclusion_patterns.feature}

@@ -1,6 +1,7 @@
-Feature: Backtrace cleaning
+Feature: Excluding lines from the backtrace
 
-  To aid in diagnozing spec failures, RSpec cleans matching lines from backtraces. The default patterns cleaned are:
+  To reduce the noise when diagnosing , RSpec excludes matching lines from
+  backtraces. The default exclusion patterns are:
 
     /\/lib\d*\/ruby\//,
     /org\/jruby\//,
@@ -9,14 +10,16 @@ Feature: Backtrace cleaning
     /spec\/spec_helper\.rb/,
     /lib\/rspec\/(core|expectations|matchers|mocks)/
 
-  This list can be modified or replaced with the `backtrace_clean_patterns` option. Additionally, rspec can be run with the `--backtrace` option to skip backtrace cleaning entirely.
+  This list can be modified or replaced with the `backtrace_exclusion_patterns`
+  option. Additionally, rspec can be run with the `--backtrace` option to skip
+  backtrace cleaning entirely.
 
-  Scenario: default configuration
+  Scenario: using default backtrace_exclusion_patterns
     Given a file named "spec/failing_spec.rb" with:
     """ruby
     describe "2 + 2" do
       it "is 5" do
-        (2+2).should eq(5)
+        expect(2+2).to eq(5)
       end
     end
     """
@@ -24,11 +27,11 @@ Feature: Backtrace cleaning
     Then the output should contain "1 example, 1 failure"
     And the output should not contain "lib/rspec/expectations"
 
-  Scenario: With a custom setting for backtrace_clean_patterns
+  Scenario: replacing backtrace_exclusion_patterns
     Given a file named "spec/spec_helper.rb" with:
     """ruby
     RSpec.configure do |config|
-      config.backtrace_clean_patterns = [
+      config.backtrace_exclusion_patterns = [
         /spec_helper/
       ]
     end
@@ -42,7 +45,7 @@ Feature: Backtrace cleaning
     require 'spec_helper'
     describe "foo" do
       it "returns baz" do
-        foo.should eq("baz")
+        expect(foo).to eq("baz")
       end
     end
     """
@@ -50,7 +53,7 @@ Feature: Backtrace cleaning
     Then the output should contain "1 example, 1 failure"
     And the output should contain "lib/rspec/expectations"
 
-  Scenario: Adding a pattern
+  Scenario: appending to backtrace_exclusion_patterns
     Given a file named "spec/matchers/be_baz_matcher.rb" with:
     """ruby
     RSpec::Matchers.define :be_baz do |_|
@@ -62,12 +65,12 @@ Feature: Backtrace cleaning
     And a file named "spec/example_spec.rb" with:
     """ruby
     RSpec.configure do |config|
-      config.backtrace_clean_patterns << /be_baz_matcher/
+      config.backtrace_exclusion_patterns << /be_baz_matcher/
     end
 
     describe "bar" do
       it "is baz" do
-        "bar".should be_baz
+        expect("bar").to be_baz
       end
     end
     """
@@ -76,7 +79,7 @@ Feature: Backtrace cleaning
     But the output should not contain "be_baz_matcher"
     And the output should not contain "lib/rspec/expectations"
 
-  Scenario: Running with the --backtrace option
+  Scenario: running rspec with the --backtrace option
     Given a file named "spec/matchers/be_baz_matcher.rb" with:
     """ruby
     RSpec::Matchers.define :be_baz do |_|
@@ -88,12 +91,12 @@ Feature: Backtrace cleaning
     And a file named "spec/example_spec.rb" with:
     """ruby
     RSpec.configure do |config|
-      config.backtrace_clean_patterns << /be_baz_matcher/
+      config.backtrace_exclusion_patterns << /be_baz_matcher/
     end
 
     describe "bar" do
       it "is baz" do
-        "bar".should be_baz
+        expect("bar").to be_baz
       end
     end
     """