rspec-core 2.12.2 → 2.13.0

data/Changelog.md

@@ -1,3 +1,34 @@
+### 2.13.0 / 2013-02-23
+[full changelog](http://github.com/rspec/rspec-core/compare/v2.12.2...v2.13.0)
+
+Enhancements
+
+* Allow `--profile` option to take a count argument that
+  determines the number of slow examples to dump
+  (Greggory Rothmeier).
+* Add `subject!` that is the analog to `let!`. It defines an
+  explicit subject and sets a `before` hook that will invoke
+  the subject (Zubin Henner).
+* Fix `let` and `subject` declaration so that `super`
+  and `return` can be used in them, just like in a normal
+  method. (Myron Marston)
+* Allow output colors to be configured individually.
+  (Charlie Maffitt)
+
+Bug fixes
+
+* Don't blow up when dumping error output for instances
+  of anonymous error classes (Myron Marston).
+* Fix default backtrace filters so lines from projects
+  containing "gems" in the name are not filtered, but
+  lines from installed gems still are (Myron Marston).
+* Fix autotest command so that is uses double quotes
+  rather than single quotes for windows compatibility
+  (Jonas Tingeborn).
+* Fix `its` so that uses of `subject` in a `before` or `let`
+  declaration in the parent group continue to reference the
+  parent group's subject. (Olek Janiszewski)
+
 ### 2.12.2 / 2012-12-13
 [full changelog](http://github.com/rspec/rspec-core/compare/v2.12.1...v2.12.2)
 

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/badge.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)
 
 rspec-core provides the structure for writing executable examples of how your
 code should behave, and an `rspec` command with tools to constrain which
@@ -28,7 +28,7 @@ describe Order do
       :price => Money.new(2.22, :USD),
       :quantity => 2
     )))
-    order.total.should eq(Money.new(5.55, :USD))
+    expect(order.total).to eq(Money.new(5.55, :USD))
   end
 end
 ```
@@ -77,7 +77,7 @@ in any group using `include_examples`.
 ```ruby
 shared_examples "collections" do |collection_class|
   it "is empty when first created" do
-    collection_class.new.should be_empty
+    expect(collection_class.new).to be_empty
   end
 end
 
@@ -102,7 +102,7 @@ etc, but no examples.
 ## metadata
 
 rspec-core stores a metadata hash with every example and group, which
-contains like their descriptions, the locations at which they were
+contains their descriptions, the locations at which they were
 declared, etc, etc. This hash powers many of rspec-core's features,
 including output formatters (which access descriptions and locations),
 and filtering before and after hooks.
@@ -112,7 +112,7 @@ extension, you can access it from an example like this:
 
 ```ruby
 it "does something" do
-  example.metadata[:description].should eq("does something")
+  expect(example.metadata[:description]).to eq("does something")
 end
 ```
 
@@ -125,19 +125,19 @@ using the `described_class` method, which is a wrapper for
 ```ruby
 describe Widget do
   example do
-    described_class.should equal(Widget)
+    expect(described_class).to equal(Widget)
   end
 end
 ```
 
 This is useful in extensions or shared example groups in which the specific
-class is unknown. Taking the shared examples example from above, we can
+class is unknown. Taking the collections shared example group from above, we can
 clean it up a bit using `described_class`:
 
 ```ruby
 shared_examples "collections" do
   it "is empty when first created" do
-    described.new.should be_empty
+    expect(described_class.new).to be_empty
   end
 end
 
@@ -153,7 +153,8 @@ end
 ## the `rspec` command
 
 When you install the rspec-core gem, it installs the `rspec` executable,
-which you'll use to run rspec. The `rspec` comes with many useful options.
+which you'll use to run rspec. The `rspec` command comes with many useful
+options.
 Run `rspec --help` to see the complete list.
 
 ## store command line options `.rspec`
@@ -198,7 +199,7 @@ this before you write any implementation code:
 # in spec/calculator_spec.rb
 describe Calculator do
   it "add(x,y) returns the sum of its arguments" do
-    Calculator.new.add(1, 2).should eq(3)
+    expect(Calculator.new.add(1, 2)).to eq(3)
   end
 end
 ```

data/features/command_line/example_name_option.feature

@@ -2,13 +2,13 @@ Feature: --example option
 
   Use the --example (or -e) option to filter examples by name.
 
-  The argument is compiled to a Ruby Regexp, and matched against the full
-  description of the example, which is the concatenation of descriptions of the
-  group (including any nested groups) and the example.
+  The argument is matched against the full description of the example,
+  which is the concatenation of descriptions of the group (including
+  any nested groups) and the example.
 
   This allows you to run a single uniquely named example, all examples with
   similar names, all the examples in a uniquely named group, etc, etc.
-  
+
   You can also use the option more than once to specify multiple example matches.
 
   Background:
@@ -49,7 +49,7 @@ Feature: --example option
 
   Scenario: no matches
     When I run `rspec . --example nothing_like_this`
-    Then the examples should all pass
+    Then the process should succeed even though no examples were run
 
   Scenario: match on one word
     When I run `rspec . --example example`
@@ -67,10 +67,6 @@ Feature: --example option
     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'`
-    Then the examples should all pass
-
   Scenario: all examples in one group
     When I run `rspec . --example 'first group'`
     Then the examples should all pass
@@ -86,7 +82,7 @@ Feature: --example option
   Scenario: Object#method
     When I run `rspec . --example 'Array#length'`
     Then the examples should all pass
-    
+
   Scenario: Multiple applications of example name option
     When I run `rspec . --example 'first group' --example 'second group' --format d`
     Then the examples should all pass

data/features/command_line/tag.feature

@@ -1,16 +1,16 @@
 Feature: --tag option
 
   Use the --tag (or -t) option to filter the examples by tags.
-  
+
   The tag can be a simple name or a name:value pair. In the first case,
   examples with :name => true will be filtered. In the second case, examples
   with :name => value will be filtered, where value is always a string.  In
   both cases, name is converted to a symbol.
-  
+
   Tags can also be used to exclude examples by adding a ~ before the tag.  For
   example ~tag will exclude all examples marked with :tag => true and
   ~tag:value will exclude all examples marked with :tag => value.
-  
+
   To be compatible with the Cucumber syntax, tags can optionally start with
   an @ symbol, which will be ignored.
 
@@ -29,7 +29,7 @@ Feature: --tag option
 
   Scenario: filter examples with non-existent tag
     When I run `rspec . --tag mytag`
-    And the examples should all pass
+    Then the process should succeed even though no examples were run
 
   Scenario: filter examples with a simple tag
     When I run `rspec . --tag focus`
@@ -49,7 +49,7 @@ Feature: --tag option
       """
     And the output should contain "2 examples"
     And the examples should all pass
-  
+
   Scenario: filter examples with a name:value tag and @
     When I run `rspec . --tag @type:special`
     Then the output should contain:
@@ -57,7 +57,7 @@ Feature: --tag option
       include {:type=>"special"}
       """
     And the examples should all pass
-  
+
   Scenario: exclude examples with a simple tag
     When I run `rspec . --tag ~skip`
     Then the output should contain "exclude {:skip=>true}"
@@ -67,7 +67,7 @@ Feature: --tag option
     When I run `rspec . --tag ~@skip`
     Then the output should contain "exclude {:skip=>true}"
     Then the examples should all pass
-    
+
   Scenario: exclude examples with a name:value tag
     When I run `rspec . --tag ~speed:slow`
     Then the output should contain:
@@ -75,7 +75,7 @@ Feature: --tag option
       exclude {:speed=>"slow"}
       """
     Then the examples should all pass
-  
+
   Scenario: exclude examples with a name:value tag and @
     When I run `rspec . --tag ~@speed:slow`
     Then the output should contain:
@@ -89,3 +89,10 @@ Feature: --tag option
     Then the output should contain "include {:focus=>true}"
     And the output should contain "exclude {:skip=>true}"
     And the examples should all pass
+
+  Scenario: exclude examples with multiple tags
+    When I run `rspec . --tag ~skip --tag ~speed:slow`
+    Then the output should contain one of the following:
+      | exclude {:skip=>true, :speed=>"slow"} |
+      | exclude {:speed=>"slow", :skip=>true} |
+    Then the examples should all pass

data/features/configuration/backtrace_clean_patterns.feature

@@ -0,0 +1,102 @@
+Feature: Backtrace cleaning
+
+  To aid in diagnozing spec failures, RSpec cleans matching lines from backtraces. The default patterns cleaned are:
+
+    /\/lib\d*\/ruby\//,
+    /org\/jruby\//,
+    /bin\//,
+    /gems/,
+    /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.
+
+  Scenario: default configuration
+    Given a file named "spec/failing_spec.rb" with:
+    """ruby
+    describe "2 + 2" do
+      it "is 5" do
+        (2+2).should eq(5)
+      end
+    end
+    """
+    When I run `rspec`
+    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
+    Given a file named "spec/spec_helper.rb" with:
+    """ruby
+    RSpec.configure do |config|
+      config.backtrace_clean_patterns = [
+        /spec_helper/
+      ]
+    end
+
+    def foo
+      "bar"
+    end
+    """
+    And a file named "spec/example_spec.rb" with:
+    """ruby
+    require 'spec_helper'
+    describe "foo" do
+      it "returns baz" do
+        foo.should eq("baz")
+      end
+    end
+    """
+    When I run `rspec`
+    Then the output should contain "1 example, 1 failure"
+    And the output should contain "lib/rspec/expectations"
+
+  Scenario: Adding a pattern
+    Given a file named "spec/matchers/be_baz_matcher.rb" with:
+    """ruby
+    RSpec::Matchers.define :be_baz do |_|
+      match do |actual|
+        actual == "baz"
+      end 
+    end
+    """
+    And a file named "spec/example_spec.rb" with:
+    """ruby
+    RSpec.configure do |config|
+      config.backtrace_clean_patterns << /be_baz_matcher/
+    end
+
+    describe "bar" do
+      it "is baz" do
+        "bar".should be_baz
+      end
+    end
+    """
+    When I run `rspec`
+    Then the output should contain "1 example, 1 failure"
+    But the output should not contain "be_baz_matcher"
+    And the output should not contain "lib/rspec/expectations"
+
+  Scenario: Running with the --backtrace option
+    Given a file named "spec/matchers/be_baz_matcher.rb" with:
+    """ruby
+    RSpec::Matchers.define :be_baz do |_|
+      match do |actual|
+        actual == "baz"
+      end 
+    end
+    """
+    And a file named "spec/example_spec.rb" with:
+    """ruby
+    RSpec.configure do |config|
+      config.backtrace_clean_patterns << /be_baz_matcher/
+    end
+
+    describe "bar" do
+      it "is baz" do
+        "bar".should be_baz
+      end
+    end
+    """
+    When I run `rspec --backtrace`
+    Then the output should contain "1 example, 1 failure"
+    And the output should not contain "be_baz_matcher"

data/features/configuration/failure_exit_code.feature

@@ -0,0 +1,36 @@
+Feature: failure exit code
+
+  Use the feature_exit_code option to set a custom exit code when RSpec fails.
+
+    RSpec.configure { |c| c.failure_exit_code = 42 }
+
+  Background:
+    Given a file named "spec/spec_helper.rb" with:
+      """ruby
+      RSpec.configure { |c| c.failure_exit_code = 42 }
+      """
+
+  Scenario: a failing spec with the default exit code
+    Given a file named "spec/example_spec.rb" with:
+      """ruby
+      describe "something" do
+        it "fails" do
+          fail
+        end
+      end
+      """
+    When I run `rspec spec/example_spec.rb`
+    Then the exit status should be 1
+
+  Scenario: a failing spec with a custom exit code
+    Given a file named "spec/example_spec.rb" with:
+      """ruby
+      require 'spec_helper'
+      describe "something" do
+        it "fails" do
+          fail
+        end
+      end
+      """
+    When I run `rspec spec/example_spec.rb`
+    Then the exit status should be 42

data/features/configuration/order_and_seed.feature

@@ -0,0 +1,3 @@
+Feature: set the order and/or seed
+
+  You can set the order to run specs and specify a seed if you are running the specs using the 'random' ordering.  See <a href='../command_line/order.feature'>the documentation on the --order command line option</a> for more on this.

data/features/configuration/output_stream.feature

@@ -0,0 +1,24 @@
+Feature: output_stream
+
+  Define a custom output stream (default `$stdout`).  Aliases: `:output`, `:out`.
+
+    RSpec.configure { |c| c.output_stream = File.open('saved_output', 'w') }
+
+  Background:
+    Given a file named "spec/spec_helper.rb" with:
+      """ruby
+      RSpec.configure {|c| c.output_stream = File.open('saved_output', 'w') }
+      """
+
+  Scenario: redirecting output
+    Given a file named "spec/example_spec.rb" with:
+      """ruby
+      require 'spec_helper'
+      describe "an example" do
+        it "passes" do
+          true
+        end
+      end
+      """
+    When I run `rspec spec/example_spec.rb`
+    Then the file "saved_output" should contain "1 example, 0 failures"

data/features/configuration/pattern.feature

@@ -0,0 +1,30 @@
+Feature: pattern
+
+  Use the pattern option to tell RSpec to look for specs in files that match a pattern other than "**/*_spec.rb".
+
+  Background:
+    Given a file named "spec/example_spec.rb" with:
+      """ruby
+      describe "two specs here" do
+        it "passes" do
+        end
+
+        it "passes too" do
+        end
+      end
+      """
+    And a file named "spec/example_test.rb" with:
+      """ruby
+      describe "only one spec" do
+        it "passes" do
+        end
+      end
+      """
+
+  Scenario: by default, RSpec runs files that match "**/*_spec.rb"
+   When I run `rspec`
+   Then the output should contain "2 examples, 0 failures"
+
+  Scenario: the --pattern flag makes RSpec run files matching the specified pattern and ignore the default pattern
+   When I run `rspec -P "**/*_test.rb"`
+   Then the output should contain "1 example, 0 failures"

data/features/configuration/profile.feature

@@ -0,0 +1,163 @@
+Feature: Profile examples
+
+  The `--profile` command line option (available from `RSpec.configure` as
+  `#profile_examples`), when set, will cause RSpec to dump out a list of
+  your slowest examples. By default, it prints the 10 slowest examples,
+  but you can set it to a different value to have it print more or fewer
+  slow examples.
+
+  Background:
+    Given a file named "spec/spec_helper.rb" with:
+      """ruby
+      """
+    And a file named "spec/example_spec.rb" with:
+      """ruby
+      require "spec_helper"
+
+      describe "something" do
+        it "sleeps for 0.1 secionds (example 1)" do
+          sleep 0.1
+          1.should == 1
+        end
+
+        it "sleeps for 0 seconds (example 2)" do
+          2.should == 2
+        end
+
+        it "sleeps for 0.15 seconds (example 3)" do
+          sleep 0.15
+          3.should == 3
+        end
+
+        it "sleeps for 0.05 seconds (example 4)" do
+          sleep 0.05
+          4.should == 4
+        end
+
+        it "sleeps for 0.05 seconds (example 5)" do
+          sleep 0.05
+          5.should == 5
+        end
+
+        it "sleeps for 0.05 seconds (example 6)" do
+          sleep 0.05
+          6.should == 6
+        end
+
+        it "sleeps for 0.05 seconds (example 7)" do
+          sleep 0.05
+          7.should == 7
+        end
+
+        it "sleeps for 0.05 seconds (example 8)" do
+          sleep 0.05
+          8.should == 8
+        end
+
+        it "sleeps for 0.05 seconds (example 9)" do
+          sleep 0.05
+          9.should == 9
+        end
+
+        it "sleeps for 0.05 seconds (example 10)" do
+          sleep 0.05
+          10.should == 10
+        end
+
+        it "sleeps for 0.05 seconds (example 11)" do
+          sleep 0.05
+          11.should == 11
+        end
+      end
+      """
+
+  Scenario: by default does not show profile
+    When I run `rspec spec`
+    Then the examples should all pass
+    And the output should not contain "example 1"
+    And the output should not contain "example 2"
+    And the output should not contain "example 3"
+    And the output should not contain "example 4"
+    And the output should not contain "example 5"
+    And the output should not contain "example 6"
+    And the output should not contain "example 7"
+    And the output should not contain "example 8"
+    And the output should not contain "example 9"
+    And the output should not contain "example 10"
+    And the output should not contain "example 11"
+
+  Scenario: setting `profile_examples` to true shows 10 examples
+    Given a file named "spec/spec_helper.rb" with:
+      """ruby
+      RSpec.configure { |c| c.profile_examples = true }
+      """
+    When I run `rspec spec`
+    Then the examples should all pass
+    And the output should contain "Top 10 slowest examples"
+    And the output should contain "example 1"
+    And the output should not contain "example 2"
+    And the output should contain "example 3"
+    And the output should contain "example 4"
+    And the output should contain "example 5"
+    And the output should contain "example 6"
+    And the output should contain "example 7"
+    And the output should contain "example 8"
+    And the output should contain "example 9"
+    And the output should contain "example 10"
+    And the output should contain "example 11"
+
+  Scenario: setting `profile_examples` to 2 shows 2 examples
+    Given a file named "spec/spec_helper.rb" with:
+      """ruby
+      RSpec.configure { |c| c.profile_examples = 2 }
+      """
+    When I run `rspec spec`
+    Then the examples should all pass
+    And the output should contain "Top 2 slowest examples"
+    And the output should contain "example 1"
+    And the output should not contain "example 2"
+    And the output should contain "example 3"
+    And the output should not contain "example 4"
+    And the output should not contain "example 5"
+    And the output should not contain "example 6"
+    And the output should not contain "example 7"
+    And the output should not contain "example 8"
+    And the output should not contain "example 9"
+    And the output should not contain "example 10"
+    And the output should not contain "example 11"
+
+  Scenario: setting profile examples through CLI
+    When I run `rspec spec --profile 2`
+    Then the examples should all pass
+    And the output should contain "Top 2 slowest examples"
+    And the output should contain "example 1"
+    And the output should not contain "example 2"
+    And the output should contain "example 3"
+    And the output should not contain "example 4"
+    And the output should not contain "example 5"
+    And the output should not contain "example 6"
+    And the output should not contain "example 7"
+    And the output should not contain "example 8"
+    And the output should not contain "example 9"
+    And the output should not contain "example 10"
+    And the output should not contain "example 11"
+
+  Scenario: Using `--no-profile` overrules config options
+    Given a file named "spec/spec_helper.rb" with:
+      """ruby
+      RSpec.configure { |c| c.profile_examples = true }
+      """
+    When I run `rspec spec --no-profile`
+    Then the examples should all pass
+    And the output should not contain "example 1"
+    And the output should not contain "example 2"
+    And the output should not contain "example 3"
+    And the output should not contain "example 4"
+    And the output should not contain "example 5"
+    And the output should not contain "example 6"
+    And the output should not contain "example 7"
+    And the output should not contain "example 8"
+    And the output should not contain "example 9"
+    And the output should not contain "example 10"
+    And the output should not contain "example 11"
+