rspec-core 3.0.0.beta1 → 3.0.0.beta2

data/Changelog.md

@@ -1,3 +1,100 @@
+### 3.0.0.beta2 / 2014-02-17
+[full changelog](http://github.com/rspec/rspec-core/compare/v3.0.0.beta1...v3.0.0.beta2)
+
+Breaking Changes for 3.0.0:
+
+* Make `mock_with` option more strict. Strings are no longer supported
+  (e.g. `mock_with "mocha"`) -- use a symbol instead. Also, unrecognized
+  values will now result in an error rather than falling back to the
+  null mocking adapter. If you want to use the null mocking adapter,
+  use `mock_with :nothing` (as has been documented for a long time).
+  (Myron Marston)
+* Remove support for overriding RSpec's built-in `:if` and `:unless`
+  filters. (Ashish Dixit)
+* Custom formatters are now required to call
+  `RSpec::Core::Formatters.register(formatter_class, *notifications)`
+  where `notifications` is the list of events the formatter wishes to
+  be notified about. Notifications are handled by methods matching the
+  names on formatters. This allows us to add or remove notifications
+  without breaking existing formatters. (Jon Rowe)
+* Change arguments passed to formatters. Rather than passing multiple
+  arguments (which limits are ability to add additional arguments as
+  doing so would break existing formatters), we now pass a notification
+  value object that exposes the same data via attributes. This will
+  allow us to add new bits of data to a notification event without
+  breaking existing formattesr. (Jon Rowe)
+* Remove support for deprecated `:alias` option for
+  `RSpec.configuration.add_setting`. (Myron Marston)
+* Remove support for deprecated `RSpec.configuration.requires = [...]`.
+  (Myron Marston)
+* Remove support for deprecated `--formatter` CLI option. (Myron Marston)
+* Remove support for deprecated `--configure` CLI option. (Myron Marston)
+* Remove support for deprecated `RSpec::Core::RakeTask#spec_opts=`.
+  (Myron Marston)
+* An example group level `pending` block or `:pending` metadata now executes
+  the example and cause a failure if it passes, otherwise it will be pending if
+  it fails. The old "never run" behaviour is still used for `xexample`, `xit`,
+  and `xspecify`, or via a new `skip` method or `:skip` metadata option.
+  (Xavier Shay)
+* After calling `pending` inside an example, the remainder of the example will
+  now be run. If it passes a failure is raised, otherwise the example is marked
+  pending. The old "never run" behaviour is provided a by a new `skip` method.
+  (Xavier Shay)
+* Pending blocks inside an example have been removed as a feature with no
+  direct replacement. Use `skip` or `pending` without a block. (Xavier Shay)
+* Pending statement is no longer allowed in `before(:all)` hooks. Use `skip`
+  instead.  (Xavier Shay)
+* Remove `show_failures_in_pending_blocks` configuration option. (Xavier Shay)
+* Remove support for specifying the documentation formatter using
+  's', 'n', 'spec' or 'nested'. (Jon Rowe)
+
+Enhancements:
+
+* Add `is_expected` for one-liners that read well with the
+  `expect`-based syntax. `is_expected` is simply defined as
+  `expect(subject)` and can be used in an expression like:
+  `it { is_expected.to read_well }`. (Myron Marston)
+* Add example run time to JSON formatter output. (Karthik Kastury)
+* Add more suggested settings to the files generated by
+  `rspec --init`. (Myron Marston)
+* Add `config.alias_example_group_to`, which can be used to define a
+  new method that defines an example group with the provided metadata.
+  (Michi Huber)
+* Add `xdescribe` and `xcontext` as shortcuts to make an example group
+  pending. (Myron Marston)
+* Add `fdescribe` and `fcontext` as shortcuts to focus an example group.
+  (Myron Marston)
+* Don't autorun specs via `#at_exit` by default. `require 'rspec/autorun'`
+  is only needed when running specs via `ruby`, as it always has been.
+  Running specs via `rake` or `rspec` are both unaffected. (Ben Hoskings)
+* Add `expose_dsl_globally` config option, defaulting to true. When disabled
+  it will remove the monkey patches rspec-core adds to `main` and `Module`
+  (e.g. `describe`, `shared_examples_for`, etc).  (Jon Rowe)
+* Expose RSpec DSL entry point methods (`describe`,
+  `shared_examples_for`, etc) on the `RSpec` constant. Intended for use
+  when `expose_dsl_globally` is set to `false`. (Jon Rowe)
+* For consistency, expose all example group aliases (including
+  `context`) on the `RSpec` constant. If `expose_dsl_globally` is set to
+  `true`, also expose them on `main` and `Module`. Historically, only `describe`
+  was exposed. (Jon Rowe, Michi Huber)
+
+Bug Fixes:
+
+* Fix failure (undefined method `path`) in end-of-run summary
+  when `raise_errors_for_deprecations!` is configured. (Myron Marston)
+* Issue error when attempting to use -i or --I on command line,
+  too close to -I to be considered short hand for --init. (Jon Rowe)
+* Prevent adding formatters to an output target if the same
+  formatter has already been added to that output. (Alex Peattie)
+* Allow a matcher-generated example description to be used when
+  the example is pending. (Myron Marston)
+* Ensure the configured `failure_exit_code` is used by the rake
+  task when there is a failure. (Jon Rowe)
+* Restore behaviour whereby system exclusion filters take priority over working
+  directory (was broken in beta1). (Jon Rowe)
+* Prevent RSpec mangling file names that have substrings containing `line_number`
+  or `default_path`. (Matijs van Zuijlen)
+
 ### 3.0.0.beta1 / 2013-11-07
 [full changelog](http://github.com/rspec/rspec-core/compare/v2.99.0.beta1...v3.0.0.beta1)
 
@@ -62,6 +159,46 @@ Deprecations
   longer has an affect now that the behavior it enabled is always
   enabled. (Myron Marston)
 
+### 2.99.0.beta2 / 2014-02-17
+[full changelog](http://github.com/rspec/rspec-core/compare/v2.99.0.beta1...v2.99.0.beta2)
+
+Enhancements:
+
+* Add `is_expected` for one-liners that read well with the
+  `expect`-based syntax. `is_expected` is simply defined as
+  `expect(subject)` and can be used in an expression like:
+  `it { is_expected.to read_well }`. (Myron Marston)
+* Backport `skip` from RSpec 3, which acts like `pending` did in RSpec 2
+  when not given a block, since the behavior of `pending` is changing in
+  RSpec 3. (Xavier Shay)
+
+Deprecations:
+
+* Deprecate inexact `mock_with` config options. RSpec 3 will only support
+  the exact symbols `:rspec`, `:mocha`, `:flexmock`, `:rr` or `:nothing`
+  (or any module that implements the adapter interface). RSpec 2 did
+  fuzzy matching but this will not be supported going forward.
+  (Myron Marston)
+* Deprecate `show_failures_in_pending_blocks` config option. To achieve
+  the same behavior as the option enabled, you can use a custom
+  formatter instead. (Xavier Shay)
+* Add a deprecation warning for the fact that the behavior of `pending`
+  is changing in RSpec 3 -- rather than skipping the example (as it did
+  in 2.x when no block was provided), it will run the example and mark
+  it as failed if no exception is raised. Use `skip` instead to preserve
+  the old behavior. (Xavier Shay)
+* Deprecate 's', 'n', 'spec' and 'nested' as aliases for documentation
+  formatter. (Jon Rowe)
+* Deprecate `RSpec::Core::Reporter#abort` in favor of
+  `RSpec::Core::Reporter#finish`. (Jon Rowe)
+
+Bug Fixes:
+
+* Fix failure (undefined method `path`) in end-of-run summary
+  when `raise_errors_for_deprecations!` is configured. (Myron Marston)
+* Fix issue were overridding spec ordering from the command line wasnt
+  fully recognised interally. (Jon Rowe)
+
 ### 2.99.0.beta1 / 2013-11-07
 [full changelog](http://github.com/rspec/rspec-core/compare/v2.14.7...v2.99.0.beta1)
 

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) [![Coverage Status](https://coveralls.io/repos/rspec/rspec-core/badge.png?branch=master)](https://coveralls.io/r/rspec/rspec-core?branch=master)
+# 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
@@ -166,7 +166,7 @@ the command line.
 ## autotest integration
 
 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)
+integration, please use the `rspec-autotest` gem and see [rspec/rspec-autotest](https://github.com/rspec/rspec-autotest)
 for details
 
 ## get started

data/exe/rspec

@@ -1,25 +1,4 @@
 #!/usr/bin/env ruby
 
-begin
-  require 'rspec/autorun'
-rescue LoadError
-  $stderr.puts <<-EOS
-#{'*'*50}
-  Could not find 'rspec/autorun'
-
-  This may happen if you're using rubygems as your package manager, but it is not
-  being required through some mechanism before executing the rspec command.
-
-  You may need to do one of the following in your shell:
-
-    # for bash/zsh
-    export RUBYOPT=rubygems
-
-    # for csh, etc.
-    set RUBYOPT=rubygems
-
-  For background, please see http://gist.github.com/54177.
-#{'*'*50}
-  EOS
-  exit(1)
-end
+require 'rspec/core'
+RSpec::Core::Runner.invoke

data/features/README.md

@@ -10,8 +10,4 @@ rspec-core provides the structure for RSpec code examples:
 
 ## Issues
 
-This documentation is [open
-source](https://github.com/rspec/rspec-core/tree/master/features), and a work
-in progress.  If you find it incomplete or confusing, please [submit an
-issue](http://github.com/rspec/rspec-core/issues), or, better yet, [a pull
-request](http://github.com/rspec/rspec-core).
+This documentation is [open source](https://github.com/rspec/rspec-core/tree/master/features), and a work in progress.  If you find it incomplete or confusing, please [submit an issue](http://github.com/rspec/rspec-core/issues), or, better yet, [a pull request](http://github.com/rspec/rspec-core).

data/features/command_line/README.md

@@ -8,14 +8,9 @@ For a full list of options, run the `rspec` command with the `--help` flag:
 ### 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`
+command, however, you'll need to require `"rspec/autorun"`. You can
+either pass a `-rrspec/autorun` CLI option when invoking `ruby`, or add
+a `require 'rspec/autorun'` to one or more of your spec files.
 
 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
@@ -23,6 +18,8 @@ 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:
+If you're using the `ruby` command, you'll need to do this yourself
+(with the `-I` option).  Putting these together, your command might be
+something like this:
 
-    ruby -Ilib -Ispec path/to/spec.rb
+    $ ruby -Ilib -Ispec -rrspec/autorun path/to/spec.rb

data/features/command_line/exit_status.feature

@@ -71,7 +71,7 @@ Feature: exit status
       require 'rspec/autorun'
       at_exit { exit(0) }
 
-      describe "exit 0 at_exit" do
+      RSpec.describe "exit 0 at_exit" do
         it "does not interfere with rspec's exit code" do
           fail
         end

data/features/command_line/format_option.feature

@@ -34,7 +34,7 @@ Feature: --format option
         end
 
         it "does something that is pending", :pending => true do
-          expect(5).to be > 3
+          expect(5).to be < 3
         end
       end
       """

data/features/command_line/init.feature

@@ -1,7 +1,8 @@
 Feature: --init option
 
   Use the --init option on the command line to generate conventional
-  files for an rspec project.
+  files for an rspec project. It generates a `.rspec` and
+  `spec/spec_helper.rb` with some example settings to get you started.
 
   Scenario: generate .rspec
     When I run `rspec --init`
@@ -16,3 +17,41 @@ Feature: --init option
       """
     When I run `rspec --init`
     Then the output should contain "exist   .rspec"
+
+  Scenario: Accept and use the recommended settings in spec_helper (which are initially commented out).
+    Given I have a brand new project with no files
+      And I have run `rspec --init`
+     When I accept the recommended settings by removing `=begin` and `=end` from `spec/spec_helper.rb`
+      And I create "spec/addition_spec.rb" with the following content:
+        """ruby
+        RSpec.describe "Addition" do
+          it "works" do
+            expect(1 + 1).to eq(2)
+          end
+        end
+        """
+      And I create "spec/subtraction_spec.rb" with the following content:
+        """ruby
+        RSpec.describe "Subtraction" do
+          it "works" do
+            expect(1 - 1).to eq(0)
+          end
+        end
+        """
+
+     When I run `rspec`
+     Then the examples should all pass
+      And the output should not contain:
+        """
+        Addition
+          works
+        """
+
+     When I run `rspec spec/addition_spec.rb`
+     Then the examples should all pass
+      And the output should contain:
+        """
+        Addition
+          works
+        """
+

data/features/command_line/line_number_option.feature

@@ -46,9 +46,9 @@ Feature: --line_number option
 
       describe 9 do
 
-        it { should be > 8 }
+        it { is_expected.to be > 8 }
 
-        it { should be < 10 }
+        it { is_expected.not_to be < 10 }
 
       end
       """

data/features/command_line/ruby.feature

@@ -4,15 +4,15 @@ Feature: run with ruby command
   `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.
+  avoids the complexity of `rspec/autorun` (e.g. no `at_exit` hook needed!),
+  but some tools only work with the `ruby` command.
 
-  Scenario:
+  Scenario: Require `rspec/autorun` from a spec file
     Given a file named "example_spec.rb" with:
       """ruby
       require 'rspec/autorun'
 
-      describe 1 do
+      RSpec.describe 1 do
         it "is < 2" do
           expect(1).to be < 2
         end
@@ -20,3 +20,4 @@ Feature: run with ruby command
       """
     When I run `ruby example_spec.rb`
     Then the output should contain "1 example, 0 failures"
+

data/features/configuration/enable_global_dsl.feature

@@ -0,0 +1,54 @@
+Feature: Global namespace DSL
+
+  RSpec has a few top-level constructs that allow you to begin describing
+  behaviour:
+
+  * `RSpec.describe`: Define a named context for a group of examples.
+  * `RSpec.shared_examples_for`: Define a set of shared examples that can later be included in an example group.
+  * `RSpec.shared_context`: define some common context (using `before`, `let`, helper methods, etc) that can later be included in an example group.
+
+  Historically, these constructs have been available directly off of the main
+  object, so that you could use these at the start of a file without the
+  `RSpec.` prefix. They have also been available off of any class or module so
+  that you can scope your examples within a particular constant namespace.
+
+  RSpec 3 now provides an option to disable this global monkey patching:
+
+  `config.expose_dsl_globally = false`.
+
+  For backwards compatibility it defaults to true.
+
+  Scenario: by default RSpec allows the DSL to be used globally
+    Given a file named "spec/example_spec.rb" with:
+      """ruby
+      describe "specs here" do
+        it "passes" do
+        end
+      end
+      """
+   When I run `rspec`
+   Then the output should contain "1 example, 0 failures"
+
+  Scenario: when exposing globally is disabled the top level DSL no longer works
+    Given a file named "spec/example_spec.rb" with:
+      """ruby
+      RSpec.configure { |c| c.expose_dsl_globally = false }
+      describe "specs here" do
+        it "passes" do
+        end
+      end
+      """
+   When I run `rspec`
+   Then the output should contain "undefined method `describe'"
+
+  Scenario: regardless of setting
+    Given a file named "spec/example_spec.rb" with:
+      """ruby
+      RSpec.configure { |c| c.expose_dsl_globally = true }
+      RSpec.describe "specs here" do
+        it "passes" do
+        end
+      end
+      """
+   When I run `rspec`
+   Then the output should contain "1 example, 0 failures"

data/features/example_groups/aliasing.feature

@@ -0,0 +1,48 @@
+Feature: aliasing
+
+  `describe` and `context` are the default aliases for `example_group`.
+  You can define your own aliases for `example_group` and give those
+  custom aliases default metadata.
+
+  RSpec provides a few built-in aliases:
+
+    * `xdescribe` and `xcontext` add `:pending` metadata to the
+      example group in order to temporarily disable the examples.
+    * `fdescribe` and `fcontext` add `:focus` metadata to the
+      example group in order to make it easy to temporarily
+      focus the example group (when combined with `config.filter_run :focus`.)
+
+  Scenario: custom example group aliases with metadata
+    Given a file named "nested_example_group_aliases_spec.rb" with:
+    """ruby
+    RSpec.configure do |c|
+      c.alias_example_group_to :detail, :detailed => true
+    end
+
+    RSpec.detail "a detail" do
+      it "can do some less important stuff" do
+      end
+    end
+
+    RSpec.describe "a thing" do
+      describe "in broad strokes" do
+        it "can do things" do
+        end
+      end
+
+      detail "something less important" do
+        it "can do an unimportant thing" do
+        end
+      end
+    end
+    """
+    When I run `rspec nested_example_group_aliases_spec.rb --tag detailed -fdoc`
+    Then the output should contain:
+      """
+      a detail
+        can do some less important stuff
+
+      a thing
+        something less important
+      """
+

data/features/example_groups/basic_structure.feature

@@ -23,7 +23,7 @@ Feature: basic structure (describe/it)
       end
     end
     """
-    When I run `rspec sample_spec.rb -fn`
+    When I run `rspec sample_spec.rb -fdoc`
     Then the output should contain:
       """
       something