rspec-core 2.13.1 → 2.14.0.rc1

data/Changelog.md

@@ -1,3 +1,83 @@
+### 2.14.0.rc1 / 2013-05-27
+[full changelog](http://github.com/rspec/rspec-core/compare/v2.13.1...v2.14.0.rc1)
+
+Enhancements
+
+* Improved Windows detection inside Git Bash, for better `--color` handling.
+* Add profiling of the slowest example groups to `--profile` option.
+  The output is sorted by the slowest average example groups.
+* Don't show slow examples if there's a failure and both `--fail-fast`
+  and `--profile` options are used (Paweł Gościcki).
+* Rather than always adding `spec` to the load path, add the configured
+  `--default-path` to the load path (which defaults to `spec`). This
+  better supports folks who choose to put their specs in a different
+  directory (John Feminella).
+* Add some logic to test time duration precision. Make it a
+  function of time, dropping precision as the time increases. (Aaron Kromer)
+* Add new `backtrace_inclusion_patterns` config option. Backtrace lines
+  that match one of these patterns will _always_ be included in the
+  backtrace, even if they match an exclusion pattern, too (Sam Phippen).
+* Support ERB trim mode using the `-` when parsing `.rspec` as ERB
+  (Gabor Garami).
+* Give a better error message when let and subject are called without a block.
+  (Sam Phippen).
+* List the precedence of `.rspec-local` in the configuration documentation
+  (Sam Phippen)
+* Support `{a,b}` shell expansion syntax in `--pattern` option
+  (Konstantin Haase).
+* Add cucumber documentation for --require command line option
+  (Bradley Schaefer)
+* Expose configruation options via config:
+  * `config.libs` returns the libs configured to be added onto the load path
+  * `full_backtrace?` returns the state of the backtrace cleaner
+  * `debug?` returns true when the debugger is loaded
+  * `line_numbers` returns the line numbers we are filtering by (if any)
+  * `full_description` returns the RegExp used to filter descriptions
+  (Jon Rowe)
+* Add setters for RSpec.world and RSpec.configuration (Alex Soulim)
+* Configure ruby's warning behaviour with `--warnings` (Jon Rowe)
+* Fix an obscure issue on old versions of `1.8.7` where `Time.dup` wouldn't
+  allow access to `Time.now` (Jon Rowe)
+* Make `shared_examples_for` context aware, so that keys may be safely reused
+  in multiple contexts without colliding. (Jon Rowe)
+* Add a configurable `deprecation_stream` (Jon Rowe)
+* Publish deprecations through a formatter (David Chelimsky)
+
+Bug fixes
+
+* Make JSON formatter behave the same when it comes to `--profile` as
+  the text formatter (Paweł Gościcki).
+* Fix named subjects so that if an inner group defines a method that
+  overrides the named method, `subject` still retains the originally
+  declared value (Myron Marston).
+* Fix random ordering so that it does not cause `rand` in examples in
+  nested sibling contexts to return the same value (Max Shytikov).
+* Use the new `backtrace_inclusion_patterns` config option to ensure
+  that folks who develop code in a directory matching one of the default
+  exclusion patterns (e.g. `gems`) still get the normal backtrace
+  filtering (Sam Phippen).
+* Fix ordering of `before` hooks so that `before` hooks declared in
+  `RSpec.configure` run before `before` hooks declared in a shared
+  context (Michi Huber and Tejas Dinkar).
+* Fix `Example#full_description` so that it gets filled in by the last
+  matcher description (as `Example#description` already did) when no
+  doc string has been provided (David Chelimsky).
+* Fix the memoized methods (`let` and `subject`) leaking `define_method`
+  as a `public` method. (Thomas Holmes and Jon Rowe) (#873)
+* Fix warnings coming from the test suite. (Pete Higgins)
+
+Deprecations
+
+* Deprecate `Configuration#backtrace_clean_patterns` in favor of
+  `Configuration#backtrace_exclusion_patterns` for greater consistency
+  and symmetry with new `backtrace_inclusion_patterns` config option
+  (Sam Phippen).
+* Deprecate `Configuration#requires=` in favor of using ruby's
+  `require`. Requires specified by the command line can still be
+  accessed by the `Configuration#require` reader. (Bradley Schaefer)
+* Deprecate calling `SharedExampleGroups` defined across sibling contexts
+  (Jon Rowe)
+
 ### 2.13.1 / 2013-03-12
 [full changelog](http://github.com/rspec/rspec-core/compare/v2.13.0...v2.13.1)
 

data/exe/autospec

@@ -6,7 +6,7 @@ REMOVAL NOTICE: you are using behaviour that has been
 removed from rspec-2.
 
 * The 'autospec' command is no longer supported.
-* Please use 'autotest' insted.
+* Please use 'autotest' instead.
 
 This message will be removed from a future version of rspec.
 ************************************************************

data/features/README.md

@@ -2,8 +2,8 @@ rspec-core provides the structure for RSpec code examples:
 
     describe Account do
       it "has a balance of zero when first opened" do
-        # example code goes here - for more on the 
-        # code inside the examples, see rspec-expectations 
+        # example code goes here - for more on the
+        # code inside the examples, see rspec-expectations
         # and rspec-mocks
       end
     end

data/features/command_line/format_option.feature

@@ -2,30 +2,24 @@ Feature: --format option
 
   Use the --format option to tell RSpec how to format the output.
 
-  RSpec ships with a few formatters built in. By default, it uses the progress
+  RSpec ships with several formatters built in. By default, it uses the progress
   formatter, which generates output like this:
 
       ....F.....*.....
 
   A '.' represents a passing example, 'F' is failing, and '*' is pending.
 
-  To see the documentation strings passed to each describe(), context(), and it()
-  method, use the documentation formatter:
+  Use the documentation formatter to see the documentation strings passed to
+  `describe`, `it`, and their aliases:
 
       $ rspec spec --format documentation
 
-  You can also specify an output target (STDOUT by default) by appending a
-  filename to the argument:
+  You can also specify an output target ($stdout by default) with an --out
+  option immediately following the --format option:
 
-    $ rspec spec --format documentation --out rspec.txt
+      $ rspec spec --format documentation --out rspec.txt
 
-  `rspec --help` lists available formatters:
-
-      [p]rogress (default - dots)
-      [d]ocumentation (group and example names)
-      [h]tml
-      [t]extmate
-      custom formatter class name
+  Run `rspec --help` to see a listing of available formatters.
 
   Background:
     Given a file named "example_spec.rb" with:
@@ -69,7 +63,7 @@ Feature: --format option
         does something that is pending (PENDING: No reason given)
       """
 
-  Scenario: multiple formats
+  Scenario: multiple formats and output targets
     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

@@ -3,7 +3,7 @@ Feature: line number appended to file path
   To run one or more examples or groups, you can append the line number to the path, e.g.
 
       rspec path/to/example_spec.rb:37
-  
+
   Background:
     Given a file named "example_spec.rb" with:
       """ruby
@@ -12,17 +12,17 @@ Feature: line number appended to file path
         it "first example in outer group" do
 
         end
-        
+
         it "second example in outer group" do
 
         end
 
         describe "nested group" do
-          
+
           it "example in nested group" do
 
           end
-        
+
         end
 
       end

data/features/command_line/line_number_option.feature

@@ -49,7 +49,7 @@ Feature: --line_number option
         it { should be > 8 }
 
         it { should be < 10 }
-        
+
       end
       """
     When I run `rspec example_spec.rb --line_number 5 --format doc`

data/features/command_line/rake_task.feature

@@ -1,5 +1,5 @@
 Feature: rake task
-  
+
   RSpec ships with a rake task with a number of useful options
 
   Scenario: default options with passing spec (prints command and exit status is 0)
@@ -42,7 +42,7 @@ Feature: rake task
       """
     When I run `rake`
     Then the exit status should be 1
-      
+
   Scenario: fail_on_error = false with failing spec (exit status is 0)
     Given a file named "Rakefile" with:
       """ruby

data/features/command_line/require_option.feature

@@ -0,0 +1,43 @@
+Feature: --require option
+
+  Use the `--require` (or `-r`) option to specify a file to require
+  before running specs.
+
+  Scenario: using the --require option
+    Given a file named "logging_formatter.rb" with:
+      """ruby
+      require "rspec/core/formatters/base_text_formatter"
+      require 'delegate'
+
+      class LoggingFormatter < RSpec::Core::Formatters::BaseTextFormatter
+        def initialize(output)
+          super LoggingIO.new(output)
+        end
+
+        class LoggingIO < SimpleDelegator
+          def initialize(output)
+            @file = File.new('rspec.log', 'w')
+            super
+          end
+
+          def puts(message)
+            [@file, __getobj__].each { |out| out.puts message }
+          end
+
+          def close
+            @file.close
+          end
+        end
+      end
+      """
+    And a file named "spec/example_spec.rb" with:
+      """ruby
+      describe "an embarassing situation" do
+        it "happens to everyone" do
+        end
+      end
+      """
+    When I run `rspec --require ./logging_formatter.rb --format LoggingFormatter`
+    Then the output should contain "1 example, 0 failures"
+    And  the file "rspec.log" should contain "1 example, 0 failures"
+    And  the exit status should be 0

data/features/command_line/ruby.feature

@@ -1,8 +1,8 @@
 Feature: run with ruby command
 
   You can use the `ruby` command to run specs. You just need to require
-  `rspec/autorun`. 
-  
+  `rspec/autorun`.
+
   Generally speaking, you're better off using the `rspec` command, which
   requires `rspec/autorun` for you, but some tools only work with the `ruby`
   command.

data/features/command_line/warnings_option.feature

@@ -0,0 +1,27 @@
+Feature: run with warnings enabled
+
+  You can use the `--warnings` option to run specs with warnings enabled
+
+  Scenario:
+    Given a file named "example_spec.rb" with:
+      """ruby
+      describe do
+        it 'generates warning' do
+          @undefined
+        end
+      end
+      """
+    When I run `rspec --warnings example_spec.rb`
+    Then the output should contain "warning"
+
+  Scenario:
+    Given a file named "example_spec.rb" with:
+      """ruby
+      describe do
+        it 'generates warning' do
+          @undefined
+        end
+      end
+      """
+    When I run `rspec example_spec.rb`
+    Then the output should not contain "warning"

data/features/configuration/backtrace_clean_patterns.feature

@@ -56,7 +56,7 @@ Feature: Backtrace cleaning
     RSpec::Matchers.define :be_baz do |_|
       match do |actual|
         actual == "baz"
-      end 
+      end
     end
     """
     And a file named "spec/example_spec.rb" with:
@@ -82,7 +82,7 @@ Feature: Backtrace cleaning
     RSpec::Matchers.define :be_baz do |_|
       match do |actual|
         actual == "baz"
-      end 
+      end
     end
     """
     And a file named "spec/example_spec.rb" with:

data/features/configuration/deprecation_stream.feature

@@ -0,0 +1,58 @@
+Feature: deprecation_stream
+
+  Define a custom output stream for warning about deprecations (default `$stderr`).
+
+    RSpec.configure {|c| c.deprecation_stream = File.open('deprecations.txt', 'w') }
+
+  or
+
+    RSpec.configure {|c| c.deprecation_stream = 'deprecations.txt' }
+
+  Background:
+    Given a file named "lib/foo.rb" with:
+      """ruby
+      class Foo
+        def bar
+          RSpec.deprecate "Foo#bar"
+        end
+      end
+      """
+
+  Scenario: default - print deprecations to $stderr
+    Given a file named "spec/example_spec.rb" with:
+      """ruby
+      require "foo"
+      describe "calling a deprecated method" do
+        example { Foo.new.bar }
+      end
+      """
+    When I run `rspec spec/example_spec.rb`
+    Then the output should contain "DEPRECATION: Foo#bar is deprecated"
+
+  Scenario: configure using the path to a file
+    Given a file named "spec/example_spec.rb" with:
+      """ruby
+      require "foo"
+      RSpec.configure {|c| c.deprecation_stream = 'deprecations.txt' }
+      describe "calling a deprecated method" do
+        example { Foo.new.bar }
+      end
+      """
+    When I run `rspec spec/example_spec.rb`
+    Then the output should not contain "DEPRECATION"
+    But the output should contain "1 deprecation logged to deprecations.txt"
+    And the file "deprecations.txt" should contain "Foo#bar is deprecated"
+
+  Scenario: configure using a File object
+    Given a file named "spec/example_spec.rb" with:
+      """ruby
+      require "foo"
+      RSpec.configure {|c| c.deprecation_stream = File.open('deprecations.txt', 'w') }
+      describe "calling a deprecated method" do
+        example { Foo.new.bar }
+      end
+      """
+    When I run `rspec spec/example_spec.rb`
+    Then the output should not contain "DEPRECATION"
+    But the output should contain "1 deprecation logged to deprecations.txt"
+    And the file "deprecations.txt" should contain "Foo#bar is deprecated"

data/features/configuration/pattern.feature

@@ -28,3 +28,11 @@ Feature: pattern
   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"
+
+  Scenario: the --pattern flag can be used to pass in multiple patterns, separated by comma
+   When I run `rspec -P "**/*_test.rb,**/*_spec.rb"`
+   Then the output should contain "3 examples, 0 failures"
+
+  Scenario: the --pattern flag accepts shell style glob unions
+   When I run `rspec -P "**/*_{test,spec}.rb"`
+   Then the output should contain "3 examples, 0 failures"

data/features/configuration/profile.feature

@@ -4,7 +4,8 @@ Feature: Profile examples
   `#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.
+  slow examples. If `--fail-fast` option is used together with `--profile`
+  and there is a failure, slow examples are not shown.
 
   Background:
     Given a file named "spec/spec_helper.rb" with:
@@ -15,7 +16,7 @@ Feature: Profile examples
       require "spec_helper"
 
       describe "something" do
-        it "sleeps for 0.1 secionds (example 1)" do
+        it "sleeps for 0.1 seconds (example 1)" do
           sleep 0.1
           1.should == 1
         end
@@ -161,3 +162,59 @@ Feature: Profile examples
     And the output should not contain "example 10"
     And the output should not contain "example 11"
 
+  Scenario: Using `--profile` with `--fail-fast` shows slow examples if everything passes
+    When I run `rspec spec --fail-fast --profile`
+    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: Using `--profile` shows slow examples even in case of failures
+    Given a file named "spec/example_spec.rb" with:
+      """ruby
+      require "spec_helper"
+
+      describe "something" do
+        it "sleeps for 0.1 seconds (example 1)" do
+          sleep 0.1
+          1.should == 1
+        end
+
+        it "fails" do
+          fail
+        end
+      end
+      """
+    When I run `rspec spec --profile`
+    Then the output should contain "2 examples, 1 failure"
+    And the output should contain "Top 2 slowest examples"
+    And the output should contain "example 1"
+
+  Scenario: Using `--profile` with `--fail-fast` doesn't show slow examples in case of failures
+    Given a file named "spec/example_spec.rb" with:
+      """ruby
+      require "spec_helper"
+
+      describe "something" do
+        it "sleeps for 0.1 seconds (example 1)" do
+          sleep 0.1
+          1.should == 1
+        end
+
+        it "fails" do
+          fail
+        end
+      end
+      """
+    When I run `rspec spec --fail-fast --profile`
+    Then the output should not contain "Top 2 slowest examples"
+    And the output should not contain "example 1"