rspec-core 2.5.1 → 2.6.0

data/features/filtering/inclusion_filters.feature

@@ -4,6 +4,9 @@ Feature: inclusion filters
   most common use case is to focus on a subset of examples as you're focused on
   a particular problem.
 
+  If you set the `treat_symbols_as_metadata_keys_with_true_values` config option
+  to `true`, you can specify metadata using only symbols.
+
   Background:
     Given a file named "spec/spec_helper.rb" with:
       """
@@ -26,7 +29,7 @@ Feature: inclusion filters
         end
       end
       """
-    When I run "rspec spec/sample_spec.rb --format doc"
+    When I run `rspec spec/sample_spec.rb --format doc`
     Then the output should contain "does another thing"
     And the output should not contain "does one thing"
 
@@ -48,7 +51,7 @@ Feature: inclusion filters
         end
       end
       """
-    When I run "rspec spec/sample_spec.rb --format doc"
+    When I run `rspec spec/sample_spec.rb --format doc`
     Then the output should contain "group 1 example 1"
     And  the output should contain "group 1 example 2"
     And  the output should not contain "group 2 example 1"
@@ -76,8 +79,28 @@ Feature: inclusion filters
         end
       end
       """
-    When I run "rspec ./spec/before_after_all_inclusion_filter_spec.rb"
+    When I run `rspec ./spec/before_after_all_inclusion_filter_spec.rb`
     Then the output should contain "before all in focused group"
      And the output should contain "after all in focused group"
      And the output should not contain "before all in unfocused group"
      And the output should not contain "after all in unfocused group"
+
+  Scenario: Use symbols as metadata
+    Given a file named "symbols_as_metadata_spec.rb" with:
+      """
+      RSpec.configure do |c|
+        c.treat_symbols_as_metadata_keys_with_true_values = true
+        c.filter_run :current_example
+      end
+
+      describe "something" do
+        it "does one thing" do
+        end
+
+        it "does another thing", :current_example do
+        end
+      end
+      """
+    When I run `rspec symbols_as_metadata_spec.rb --format doc`
+    Then the output should contain "does another thing"
+    And the output should not contain "does one thing"

data/features/filtering/run_all_when_everything_filtered.feature

@@ -31,8 +31,8 @@ Feature: run all when everything filtered
         end
       end
       """
-    When I run "rspec spec/sample_spec.rb --format doc"
-    Then the output should contain "No examples were matched by {:focus=>true}, running all"
+    When I run `rspec spec/sample_spec.rb --format doc`
+    Then the output should contain "No examples matched {:focus=>true}"
     And the examples should all pass
     And the output should contain:
       """

data/features/formatters/custom_formatter.feature

@@ -31,6 +31,6 @@ Feature: custom formatters
         end
       end
       """
-    When I run "rspec example_spec.rb --require ./custom_formatter.rb --format CustomFormatter"
+    When I run `rspec example_spec.rb --require ./custom_formatter.rb --format CustomFormatter`
     Then the output should contain "example: my example"
     And  the exit status should be 0

data/features/formatters/text_formatter.feature

@@ -0,0 +1,43 @@
+Feature: text formatter
+
+  In order to easily see the result of running my specs
+  As an RSpec user
+  I want clear, concise, well-formatted output
+
+  Scenario: Backtrace formatting for failing specs in multiple files
+    Given a file named "string_spec.rb" with:
+      """
+      describe String do
+        it "has a failing example" do
+          "foo".reverse.should == "ofo"
+        end
+      end
+      """
+    And a file named "integer_spec.rb" with:
+      """
+      require 'rspec/autorun'
+
+      describe Integer do
+        it "has a failing example" do
+          (7 + 5).should == 11
+        end
+      end
+      """
+    When I run `ruby ./integer_spec.rb ./string_spec.rb`
+    Then the backtrace-normalized output should contain:
+      """
+      Failures:
+
+        1) Integer has a failing example
+           Failure/Error: (7 + 5).should == 11
+             expected: 11
+                  got: 12 (using ==)
+           # ./integer_spec.rb:5
+
+        2) String has a failing example
+           Failure/Error: "foo".reverse.should == "ofo"
+             expected: "ofo"
+                  got: "oof" (using ==)
+           # ./string_spec.rb:3
+      """
+

data/features/helper_methods/arbitrary_methods.feature

@@ -18,7 +18,7 @@ Feature: arbitrary helper methods
         end
       end
       """
-    When I run "rspec example_spec.rb"
+    When I run `rspec example_spec.rb`
     Then the examples should all pass
 
   Scenario: use a method defined in a parent group
@@ -36,5 +36,5 @@ Feature: arbitrary helper methods
         end
       end
       """
-    When I run "rspec example_spec.rb"
+    When I run `rspec example_spec.rb`
     Then the examples should all pass

data/features/helper_methods/let.feature

@@ -24,7 +24,7 @@ Feature: let and let!
         end
       end
       """
-    When I run "rspec let_spec.rb"
+    When I run `rspec let_spec.rb`
     Then the examples should all pass
 
   Scenario: use let! to define a memoized helper method that is called in a before hook
@@ -46,5 +46,5 @@ Feature: let and let!
         end
       end
       """
-    When I run "rspec let_bang_spec.rb"
+    When I run `rspec let_bang_spec.rb`
     Then the examples should all pass

data/features/helper_methods/modules.feature

@@ -0,0 +1,149 @@
+Feature: Define helper methods in a module
+
+  You can define helper methods in a module and include it in
+  your example groups using the `config.include` configuration
+  option.  `config.extend` can be used to extend the module onto
+  your example groups so that the methods in the module are available
+  in the example groups themselves (but not in the actual examples).
+
+  You can also include or extend the module onto only certain example
+  groups by passing a metadata hash as the last argument.  Only groups
+  that match the given metadata will include or extend the module.
+
+  If you set the `treat_symbols_as_metadata_keys_with_true_values` config option
+  to `true`, you can specify metadata using only symbols.
+
+  Background:
+    Given a file named "helpers.rb" with:
+      """
+      module Helpers
+        def help
+          :available
+        end
+      end
+      """
+
+  Scenario: include a module in all example groups
+    Given a file named "include_module_spec.rb" with:
+      """
+      require './helpers'
+
+      RSpec.configure do |c|
+        c.include Helpers
+      end
+
+      describe "an example group" do
+        it "has access the helper methods defined in the module" do
+          help.should be(:available)
+        end
+      end
+      """
+    When I run `rspec include_module_spec.rb`
+    Then the examples should all pass
+
+  Scenario: extend a module in all example groups
+    Given a file named "extend_module_spec.rb" with:
+      """
+      require './helpers'
+
+      RSpec.configure do |c|
+        c.extend Helpers
+      end
+
+      describe "an example group" do
+        puts "Help is #{help}"
+
+        it "does not have access to the helper methods defined in the module" do
+          expect { help }.to raise_error(NameError)
+        end
+      end
+      """
+    When I run `rspec extend_module_spec.rb`
+    Then the examples should all pass
+    And the output should contain "Help is available"
+
+  Scenario: include a module in only some example groups
+    Given a file named "include_module_in_some_groups_spec.rb" with:
+      """
+      require './helpers'
+
+      RSpec.configure do |c|
+        c.include Helpers, :foo => :bar
+      end
+
+      describe "an example group with matching metadata", :foo => :bar do
+        it "has access the helper methods defined in the module" do
+          help.should be(:available)
+        end
+      end
+
+      describe "an example group without matching metadata" do
+        it "does not have access to the helper methods defined in the module" do
+          expect { help }.to raise_error(NameError)
+        end
+      end
+      """
+    When I run `rspec include_module_in_some_groups_spec.rb`
+    Then the examples should all pass
+
+  Scenario: extend a module in only some example groups
+    Given a file named "extend_module_in_only_some_groups_spec.rb" with:
+      """
+      require './helpers'
+
+      RSpec.configure do |c|
+        c.extend Helpers, :foo => :bar
+      end
+
+      describe "an example group with matching metadata", :foo => :bar do
+        puts "In a matching group, help is #{help}"
+
+        it "does not have access to the helper methods defined in the module" do
+          expect { help }.to raise_error(NameError)
+        end
+      end
+
+      describe "an example group without matching metadata" do
+        puts "In a non-matching group, help is #{help rescue 'not available'}"
+
+        it "does not have access to the helper methods defined in the module" do
+          expect { help }.to raise_error(NameError)
+        end
+      end
+      """
+    When I run `rspec extend_module_in_only_some_groups_spec.rb`
+    Then the examples should all pass
+    And the output should contain "In a matching group, help is available"
+    And the output should contain "In a non-matching group, help is not available"
+
+  Scenario: use symbols as metadata
+    Given a file named "symbols_as_metadata_spec.rb" with:
+      """
+      require './helpers'
+
+      RSpec.configure do |c|
+        c.treat_symbols_as_metadata_keys_with_true_values = true
+        c.include Helpers, :include_helpers
+        c.extend  Helpers, :extend_helpers
+      end
+
+      describe "an example group with matching include metadata", :include_helpers do
+        puts "In a group not matching the extend filter, help is #{help rescue 'not available'}"
+
+        it "has access the helper methods defined in the module" do
+          help.should be(:available)
+        end
+      end
+
+      describe "an example group with matching extend metadata", :extend_helpers do
+        puts "In a group matching the extend filter, help is #{help}"
+
+        it "does not have access to the helper methods defined in the module" do
+          expect { help }.to raise_error(NameError)
+        end
+      end
+      """
+    When I run `rspec symbols_as_metadata_spec.rb`
+    Then the examples should all pass
+    And the output should contain "In a group not matching the extend filter, help is not available"
+    And the output should contain "In a group matching the extend filter, help is available"

data/features/hooks/around_hooks.feature

@@ -9,6 +9,13 @@ Feature: around hooks
   example, if your database library offers a transaction method that receives
   a block, you can use an around hook as described in the first scenario:
 
+  WARNING: around hooks do not share state with the example the way before and
+  after hooks do. This means that you can not share instance variables between
+  around hooks and examples.
+
+  Also, mock frameworks are set up and torn down within the context of running
+  the example, so you can not interact with them directly in around hooks.
+
   Scenario: use the example as a proc within the block passed to around()
     Given a file named "example_spec.rb" with:
       """
@@ -30,7 +37,7 @@ Feature: around hooks
         end
       end
       """
-    When I run "rspec example_spec.rb"
+    When I run `rspec example_spec.rb`
     Then the output should contain:
       """
       open transaction
@@ -53,7 +60,7 @@ Feature: around hooks
         end
       end
       """
-    When I run "rspec example_spec.rb"
+    When I run `rspec example_spec.rb`
     Then the output should contain:
       """
       around each before
@@ -74,7 +81,7 @@ Feature: around hooks
         end
       end
       """
-    When I run "rspec example_spec.rb"
+    When I run `rspec example_spec.rb`
     Then the output should contain "this should show up in the output"
 
   Scenario: define a global around hook
@@ -94,7 +101,7 @@ Feature: around hooks
         end
       end
       """
-    When I run "rspec example_spec.rb"
+    When I run `rspec example_spec.rb`
     Then the output should contain:
       """
       around each before
@@ -125,7 +132,7 @@ Feature: around hooks
         end
       end
       """
-    When I run "rspec example_spec.rb"
+    When I run `rspec example_spec.rb`
     Then the output should contain:
       """
       around each before
@@ -158,7 +165,7 @@ Feature: around hooks
         end
       end
       """
-    When I run "rspec example_spec.rb"
+    When I run `rspec example_spec.rb`
     Then the output should contain:
       """
       before all
@@ -189,7 +196,7 @@ Feature: around hooks
         end
       end
       """
-    When I run "rspec example_spec.rb"
+    When I run `rspec example_spec.rb`
     Then the output should contain "1 example, 0 failure"
 
   Scenario: implicitly pending examples are detected as Not Yet Implemented
@@ -203,7 +210,7 @@ Feature: around hooks
         it "should be detected as Not Yet Implemented"
       end
       """
-    When I run "rspec example_spec.rb"
+    When I run `rspec example_spec.rb`
     Then the output should contain "1 example, 0 failures, 1 pending"
     And the output should contain:
       """
@@ -226,7 +233,7 @@ Feature: around hooks
         end
       end
       """
-    When I run "rspec example_spec.rb"
+    When I run `rspec example_spec.rb`
     Then the output should contain "1 example, 0 failures, 1 pending"
     And the output should contain:
       """
@@ -256,7 +263,7 @@ Feature: around hooks
         end
       end
       """
-    When I run "rspec example_spec.rb"
+    When I run `rspec example_spec.rb`
     Then the output should contain "1 example, 0 failure"
     And the output should contain:
       """
@@ -316,7 +323,7 @@ Feature: around hooks
       end
     end
     """
-    When I run "rspec example_spec.rb"
+    When I run `rspec example_spec.rb`
     Then the output should contain "1 example, 0 failure"
     And the output should contain:
     """

data/features/hooks/before_and_after_hooks.feature

@@ -52,7 +52,7 @@ Feature: before and after hooks
         end
       end
       """
-    When I run "rspec ./before_each_spec.rb"
+    When I run `rspec before_each_spec.rb`
     Then the examples should all pass
 
   Scenario: define before(:all) block in example group
@@ -86,10 +86,10 @@ Feature: before and after hooks
         end
       end
       """
-    When I run "rspec ./before_all_spec.rb"
+    When I run `rspec before_all_spec.rb`
     Then the examples should all pass
 
-    When I run "rspec ./before_all_spec.rb:15"
+    When I run `rspec before_all_spec.rb:15`
     Then the examples should all pass
 
   Scenario: failure in before(:all) block
@@ -124,7 +124,7 @@ Feature: before and after hooks
         end
       end
       """
-    When I run "rspec ./before_all_spec.rb --format documentation"
+    When I run `rspec before_all_spec.rb --format documentation`
     Then the output should contain "5 examples, 5 failures"
     And the output should contain:
       """
@@ -139,15 +139,12 @@ Feature: before and after hooks
       after all ran
       """
 
-    When I run "rspec ./before_all_spec.rb:9 --format documentation"
+    When I run `rspec before_all_spec.rb:9 --format documentation`
     Then the output should contain "1 example, 1 failure"
     And the output should contain:
       """
       an error in before(:all)
         fails this example, too (FAILED - 1)
-        nested group
-          yet another level deep
-      after all ran
       """
 
   Scenario: failure in after(:all) block
@@ -165,7 +162,7 @@ Feature: before and after hooks
         end
       end
       """
-    When I run "rspec after_all_spec.rb"
+    When I run `rspec after_all_spec.rb`
     Then the examples should all pass
     And the output should contain:
       """
@@ -200,7 +197,7 @@ Feature: before and after hooks
         end
       end
       """
-    When I run "rspec ./befores_in_configuration_spec.rb"
+    When I run `rspec befores_in_configuration_spec.rb`
     Then the examples should all pass
 
   Scenario: before/after blocks are run in order
@@ -230,7 +227,7 @@ Feature: before and after hooks
         end
       end
       """
-    When I run "rspec ./ensure_block_order_spec.rb"
+    When I run `rspec ensure_block_order_spec.rb`
     Then the output should contain:
       """
       before all
@@ -275,7 +272,7 @@ Feature: before and after hooks
         end
       end
       """
-    When I run "rspec configuration_spec.rb"
+    When I run `rspec configuration_spec.rb`
     Then the output should contain:
       """
       before suite
@@ -316,7 +313,7 @@ Feature: before and after hooks
 
       end
       """
-    When I run "rspec ./before_and_after_all_spec.rb"
+    When I run `rspec before_and_after_all_spec.rb`
     Then the examples should all pass
     And the output should contain:
       """
@@ -326,7 +323,7 @@ Feature: before and after hooks
       outer after all
       """
 
-    When I run "rspec ./before_and_after_all_spec.rb:14"
+    When I run `rspec before_and_after_all_spec.rb:14`
     Then the examples should all pass
     And the output should contain:
       """
@@ -336,7 +333,7 @@ Feature: before and after hooks
       outer after all
       """
 
-    When I run "rspec ./before_and_after_all_spec.rb:6"
+    When I run `rspec before_and_after_all_spec.rb:6`
     Then the examples should all pass
     And the output should contain:
       """
@@ -371,7 +368,7 @@ Feature: before and after hooks
         end
       end
       """
-    When I run "rspec before_all_spec.rb"
+    When I run `rspec before_all_spec.rb`
     Then the examples should all pass
 
   Scenario: before/after all blocks have access to state
@@ -402,12 +399,11 @@ Feature: before and after hooks
         end
 
         after(:all) do
-          # p @outer_state.nil?
           @outer_state.should eq("set in outer before all")
         end
       end
       """
-    When I run "rspec ./before_and_after_all_spec.rb"
+    When I run `rspec before_and_after_all_spec.rb`
     Then the examples should all pass
 
   Scenario: exception in before(:each) is captured and reported as failure
@@ -422,6 +418,6 @@ Feature: before and after hooks
         end
       end
       """
-    When I run "rspec ./error_in_before_each_spec.rb"
+    When I run `rspec error_in_before_each_spec.rb`
     Then the output should contain "1 example, 1 failure"
     And the output should contain "this error"