rspec-core 2.14.8 → 2.99.0.beta1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTM2OGJjNTJkZDc1YzY0YjQyZjNkMzAxNmE5ZWMxZGMxZmU5ZDc2Zg==
+    MTdkZDRlZWFhNzlmYjQ5NmE0MDkxYzVlMjhmOGVkM2I5ZTgwYzZhOQ==
   data.tar.gz: !binary |-
-    NjNkNjgwMDViNGQ0NjJiNzYyYzgyMTY4Njk4OGM1Y2EwZmYzOTg3Zg==
+    YmRhMTUxODliMzRmOTczZmZkYjAyNjk3NGFkMmY3MzRmYTY2MDVhZg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ODc0NWVjMjVjM2QxZDE3YTFiZmMwY2Y4MzY0NTg2OGFmZDJkNjMzOWM0ZTI4
-    NWE2NDJhNmQ0ZmIwMDA1MzAyYjBmZWRkYmRhZTA1MTY0ODZhOWVlMWFlNjQz
-    N2QxZmY2NjIwYzA4Nzk1ZjM0NzU4NzcxODcyZjI0ZWUyZjZlOTY=
+    YTZkZWQyOWRhMmE4NTRiNmRhY2I0Zjc1Mzg2MzgwYjFkNzdiYjBjNzI4ZGY5
+    YzZkNjdhZDhlOTMyNzFiZTBlMjE4MDQ4OTYxY2MwNzZhZjQ5ODdlODFmNDgx
+    N2YxNmY2MDczNWFhNWM4YjdlY2YwMjA5ZDZjMDNiZmMyMGIyMzg=
   data.tar.gz: !binary |-
-    MzFiOTZkZWI3ZDFmMDg5ODMzY2M3ODdlYTI1MWVlOTI1OTU5OGI4OTYyNDkz
-    OThkMWZiYTBkNmFkMmIzMThjZDc4OTI1NDY3OTNkZjc5NDYzNTcwMDUzNTFk
-    NTE1MzA0MGE5YTg1Njg4OGQwM2M1ZDI1ZGJjODE4MTNjMDJkM2Q=
+    YjBlYmZlMTY4ZWI1NDQ5NDY3MTgzYWVkMGRjODE3NDJkNzk3MmUzNTU5ZmEw
+    NGY3NWE1YTRiMjMxNTdmMjJjOTk3ZjA0NDU3NTk5NGZhOTQ2ZDQ2NWJhM2Nj
+    ZDgxZmI0NzI5MWQ4ZjVhOGIwNmU0M2VhZWU3YmQ2MTc4MmNkY2I=

data/Changelog.md

@@ -1,10 +1,55 @@
-### 2.14.8 / 2014-02-27
-[Full Changelog](http://github.com/rspec/rspec-core/compare/v2.14.7...v2.14.8)
+### 2.99.0.beta1 / 2013-11-07
+[full changelog](http://github.com/rspec/rspec-core/compare/v2.14.7...v2.99.0.beta1)
 
-Bug fixes:
+Enhancements
 
-* Fix regression with the `TextMateFormatter` that prevented backtrace links
-  from being clickable. (Stefan Daschek)
+* Block-based DSL methods that run in the context of an example
+  (`it`, `before(:each)`, `after(:each)`, `let` and `subject`)
+  now yield the example as a block argument. (David Chelimsky)
+* Warn when the name of more than one example group is submitted to
+  `include_examples` and it's aliases. (David Chelimsky)
+* Add `expose_current_running_example_as` config option for
+  use during the upgrade process when external gems use the
+  deprecated `RSpec::Core::ExampleGroup#example` and
+  `RSpec::Core::ExampleGroup#running_example` methods. (Myron Marston)
+* Limit spamminess of deprecation messages. (Bradley Schaefer, Loren Segal)
+* Add `config.raise_errors_for_deprecations!` option, which turns
+  deprecations warnings into errors to surface the full backtrace
+  of the call site. (Myron Marston)
+
+Deprecations
+
+* Deprecate `RSpec::Core::ExampleGroup#example` and
+  `RSpec::Core::ExampleGroup#running_example` methods. If you need
+  access to the example (e.g. to get its metadata), use a block argument
+  instead. (David Chelimsky)
+* Deprecate use of `autotest/rspec2` in favour of `rspec-autotest`. (Jon Rowe)
+* Deprecate RSpec's built-in debugger support. Use a CLI option like
+  `-rruby-debug` (for the ruby-debug gem) or `-rdebugger` (for the
+  debugger gem) instead. (Myron Marston)
+* Deprecate `RSpec.configuration.treat_symbols_as_metadata_keys_with_true_values = false`.
+  RSpec 3 will not support having this option set to `false`. (Myron Marston)
+* Deprecate accessing a `let` or `subject` declaration in
+  a `after(:all)` hook. (Myron Marston, Jon Rowe)
+* Deprecate built-in `its` usage in favor of `rspec-its` gem due to planned
+  removal in RSpec 3. (Peter Alfvin)
+* Deprecate `RSpec::Core::PendingExampleFixedError` in favor of
+  `RSpec::Core::Pending::PendingExampleFixedError`. (Myron Marston)
+* Deprecate `RSpec::Core::Configuration#out` and
+  `RSpec::Core::Configuration#output` in favor of
+  `RSpec::Core::Configuration#output_stream`. (Myron Marston)
+* Deprecate legacy ordering APIs.
+  * You should use `register_ordering(:global)` instead of these:
+    * `RSpec::Core::Configuration#order_examples`
+    * `RSpec::Core::Configuration#order_groups`
+    * `RSpec::Core::Configuration#order_groups_and_examples`
+  * These are deprecated with no replacement because in RSpec 3
+    ordering is a property of individual example groups rather than
+    just a global property of the entire test suite:
+    * `RSpec::Core::Configuration#order`
+    * `RSpec::Core::Configuration#randomize?`
+  * `--order default` is deprecated in favor of `--order defined`
+  (Myron Marston)
 
 ### 2.14.7 / 2013-10-29
 [full changelog](http://github.com/rspec/rspec-core/compare/v2.14.6...v2.14.7)
@@ -27,7 +72,8 @@ Bug fixes:
 
 * Format stringified numbers correctly when mathn library is loaded.
   (Jay Hayes)
-* Fix an issue that prevented the use of frozen error objects. (Lars Gierth)
+* Fix an issue that prevented the use of frozen error objects. (Lars
+  Gierth)
 
 ### 2.14.5 / 2013-08-13
 [full changelog](http://github.com/rspec/rspec-core/compare/v2.14.4...v2.14.5)
@@ -106,7 +152,7 @@ Enhancements
 * Apply focus to examples defined with `fit` (equivalent of
   `it "description", focus: true`) (Michael de Silva)
 
-Bug fixes
+Bug fix
 
 * Ensure methods defined by `let` take precedence over others
   when there is a name collision (e.g. from an included module).
@@ -141,7 +187,7 @@ Enhancements
   (Konstantin Haase).
 * Add cucumber documentation for --require command line option
   (Bradley Schaefer)
-* Expose configruation options via config:
+* Expose configuration 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

data/features/command_line/order.feature

@@ -1,13 +1,10 @@
 Feature: --order (new in rspec-core-2.8)
 
   Use the `--order` option to tell RSpec how to order the files, groups, and
-  examples. Options are `default` and `rand`:
+  examples. Options are `defined` and `rand`.
 
-  Default is:
-
-    * files are ordered based on the underlying file system's order (typically
-      case-sensitive alpha on *nix OS's and case-insenstive alpha in Windows)
-    * groups/examples are loaded in the order in which they are declared
+  `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.*
@@ -20,10 +17,10 @@ Feature: --order (new in rspec-core-2.8)
 
   <h3>Examples</h3>
 
-      --order default
+      --order defined
       --order rand
       --order rand:123
       --seed 123 # same as --order rand:123
 
-  The `default` option is only necessary when you have `--order rand` stored in a
+  The `defined` option is only necessary when you have `--order rand` stored in a
   config file (e.g. `.rspec`) and you want to override it from the command line.

data/features/configuration/custom_settings.feature

@@ -15,17 +15,17 @@ Feature: custom settings
         end
 
         it "acts false by default" do
-          RSpec.configuration.custom_setting.should be_false
+          RSpec.configuration.custom_setting.should be_falsey
         end
 
         it "is exposed as a predicate" do
-          RSpec.configuration.custom_setting?.should be_false
+          RSpec.configuration.custom_setting?.should be_falsey
         end
 
         it "can be overridden" do
           RSpec.configuration.custom_setting = true
-          RSpec.configuration.custom_setting.should be_true
-          RSpec.configuration.custom_setting?.should be_true
+          RSpec.configuration.custom_setting.should be_truthy
+          RSpec.configuration.custom_setting?.should be_truthy
         end
       end
       """
@@ -41,17 +41,17 @@ Feature: custom settings
 
       describe "custom setting" do
         it "is true by default" do
-          RSpec.configuration.custom_setting.should be_true
+          RSpec.configuration.custom_setting.should be_truthy
         end
 
         it "is exposed as a predicate" do
-          RSpec.configuration.custom_setting?.should be_true
+          RSpec.configuration.custom_setting?.should be_truthy
         end
 
         it "can be overridden" do
           RSpec.configuration.custom_setting = false
-          RSpec.configuration.custom_setting.should be_false
-          RSpec.configuration.custom_setting?.should be_false
+          RSpec.configuration.custom_setting.should be_falsey
+          RSpec.configuration.custom_setting?.should be_falsey
         end
       end
       """
@@ -71,11 +71,11 @@ Feature: custom settings
 
       describe "custom setting" do
         it "returns the value set in the last cofigure block to get eval'd" do
-          RSpec.configuration.custom_setting.should be_true
+          RSpec.configuration.custom_setting.should be_truthy
         end
 
         it "is exposed as a predicate" do
-          RSpec.configuration.custom_setting?.should be_true
+          RSpec.configuration.custom_setting?.should be_truthy
         end
       end
       """

data/features/configuration/deprecation_stream.feature

@@ -27,7 +27,7 @@ Feature: deprecation_stream
       end
       """
     When I run `rspec spec/example_spec.rb`
-    Then the output should contain "DEPRECATION: Foo#bar is deprecated"
+    Then the output should contain "Deprecation Warnings:\n\nFoo#bar is deprecated"
 
   Scenario: configure using the path to a file
     Given a file named "spec/example_spec.rb" with:
@@ -39,7 +39,7 @@ Feature: deprecation_stream
       end
       """
     When I run `rspec spec/example_spec.rb`
-    Then the output should not contain "DEPRECATION"
+    Then the output should not contain "Deprecation Warnings:"
     But the output should contain "1 deprecation logged to deprecations.txt"
     And the file "deprecations.txt" should contain "Foo#bar is deprecated"
 
@@ -53,6 +53,6 @@ Feature: deprecation_stream
       end
       """
     When I run `rspec spec/example_spec.rb`
-    Then the output should not contain "DEPRECATION"
+    Then the output should not contain "Deprecation Warnings:"
     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/read_options_from_file.feature

@@ -66,7 +66,7 @@ Feature: read command line configuration options from files
       """ruby
       describe "custom options file" do
         it "causes .rspec to be ignored" do
-          RSpec.configuration.color_enabled.should be_false
+          RSpec.configuration.color_enabled.should be_falsey
         end
       end
       """

data/features/example_groups/shared_examples.feature

@@ -53,13 +53,13 @@ Feature: shared examples
         describe "#include?" do
           context "with an an item that is in the collection" do
             it "returns true" do
-              collection.include?(7).should be_true
+              collection.include?(7).should be_truthy
             end
           end
 
           context "with an an item that is not in the collection" do
             it "returns false" do
-              collection.include?(9).should be_false
+              collection.include?(9).should be_falsey
             end
           end
         end

data/features/hooks/around_hooks.feature

@@ -192,7 +192,7 @@ Feature: around hooks
         end
 
         it "runs the example in the correct context" do
-          included_in_configure_block.should be_true
+          included_in_configure_block.should be_truthy
         end
       end
       """

data/features/metadata/current_example.feature

@@ -1,14 +1,53 @@
 Feature: current example
 
   You can reference the example object, and access its metadata, using
-  the `example` method within an example.
+  a block argument to it, before and after hooks, let, and subject.
 
   Scenario: access the example object from within an example
     Given a file named "spec/example_spec.rb" with:
       """ruby
-      describe "an example" do
-        it "knows itself as example" do
-          example.description.should eq("knows itself as example")
+      describe "example as block arg to it, before, and after" do
+        before do |example|
+          expect(example.description).to eq("is the example object")
+        end
+
+        after do |example|
+          expect(example.description).to eq("is the example object")
+        end
+
+        it "is the example object" do |example|
+          expect(example.description).to eq("is the example object")
+        end
+      end
+
+      describe "example as block arg to let" do
+        let(:the_description) do |example|
+          example.description
+        end
+
+        it "is the example object" do |example|
+          expect(the_description).to eq("is the example object")
+        end
+      end
+
+      describe "example as block arg to subject" do
+        subject do |example|
+          example.description
+        end
+
+        it "is the example object" do |example|
+          expect(subject).to eq("is the example object")
+        end
+      end
+
+      describe "example as block arg to subject with a name" do
+        subject(:the_subject) do |example|
+          example.description
+        end
+
+        it "is the example object" do |example|
+          expect(the_subject).to eq("is the example object")
+          expect(subject).to eq("is the example object")
         end
       end
       """

data/features/metadata/user_defined.feature

@@ -25,20 +25,20 @@ Feature: User-defined metadata
     Given a file named "define_group_metadata_with_hash_spec.rb" with:
       """ruby
       describe "a group with user-defined metadata", :foo => 17 do
-        it 'has access to the metadata in the example' do
+        it 'has access to the metadata in the example' do |example|
           example.metadata[:foo].should eq(17)
         end
 
-        it 'does not have access to metadata defined on sub-groups' do
+        it 'does not have access to metadata defined on sub-groups' do |example|
           example.metadata.should_not include(:bar)
         end
 
         describe 'a sub-group with user-defined metadata', :bar => 12 do
-          it 'has access to the sub-group metadata' do
+          it 'has access to the sub-group metadata' do |example|
             example.metadata[:foo].should eq(17)
           end
 
-          it 'also has access to metadata defined on parent groups' do
+          it 'also has access to metadata defined on parent groups' do |example|
             example.metadata[:bar].should eq(12)
           end
         end
@@ -51,12 +51,12 @@ Feature: User-defined metadata
     Given a file named "define_example_metadata_with_hash_spec.rb" with:
       """ruby
       describe "a group with no user-defined metadata" do
-        it 'has an example with metadata', :foo => 17 do
+        it 'has an example with metadata', :foo => 17 do |example|
           example.metadata[:foo].should eq(17)
           example.metadata.should_not include(:bar)
         end
 
-        it 'has another example with metadata', :bar => 12, :bazz => 33 do
+        it 'has another example with metadata', :bar => 12, :bazz => 33 do |example|
           example.metadata[:bar].should eq(12)
           example.metadata[:bazz].should eq(33)
           example.metadata.should_not include(:foo)
@@ -70,12 +70,12 @@ Feature: User-defined metadata
     Given a file named "override_metadata_spec.rb" with:
       """ruby
       describe "a group with user-defined metadata", :foo => 'bar' do
-        it 'can be overridden by an example', :foo => 'bazz' do
+        it 'can be overridden by an example', :foo => 'bazz' do |example|
           example.metadata[:foo].should == 'bazz'
         end
 
         describe "a sub-group with an override", :foo => 'goo' do
-          it 'can be overridden by a sub-group' do
+          it 'can be overridden by a sub-group' do |example|
             example.metadata[:foo].should == 'goo'
           end
         end
@@ -92,19 +92,19 @@ Feature: User-defined metadata
       end
 
       describe "a group with simple metadata", :fast, :simple, :bug => 73 do
-        it 'has `:fast => true` metadata' do
+        it 'has `:fast => true` metadata' do |example|
           example.metadata[:fast].should == true
         end
 
-        it 'has `:simple => true` metadata' do
+        it 'has `:simple => true` metadata' do |example|
           example.metadata[:simple].should == true
         end
 
-        it 'can still use a hash for metadata' do
+        it 'can still use a hash for metadata' do |example|
           example.metadata[:bug].should eq(73)
         end
 
-        it 'can define simple metadata on an example', :special do
+        it 'can define simple metadata on an example', :special do |example|
           example.metadata[:special].should == true
         end
       end

data/lib/autotest/rspec2.rb

@@ -1,73 +1,77 @@
-require 'autotest'
-require 'rspec/core/deprecation'
+begin
+  require 'rspec/autotest'
+rescue LoadError
+  require 'autotest'
 
-# Derived from the `Autotest` class, extends the `autotest` command to work
-# with RSpec.
-#
-# @note this will be extracted to a separate gem when we release rspec-3.
-class Autotest::Rspec2 < Autotest
+  # Derived from the `Autotest` class, extends the `autotest` command to work
+  # with RSpec.
+  #
+  # @note this will be extracted to a separate gem when we release rspec-3.
+  class Autotest::Rspec2 < Autotest
 
-  RSPEC_EXECUTABLE = File.expand_path('../../../exe/rspec', __FILE__)
+    RSPEC_EXECUTABLE = File.expand_path('../../../exe/rspec', __FILE__)
 
-  def initialize
-    super()
-    clear_mappings
-    setup_rspec_project_mappings
+    def initialize
+      super()
+      clear_mappings
+      setup_rspec_project_mappings
 
-    # Example for Ruby 1.8: http://rubular.com/r/AOXNVDrZpx
-    # Example for Ruby 1.9: http://rubular.com/r/85ag5AZ2jP
-    self.failed_results_re = /^\s*\d+\).*\n\s+(?:\e\[\d*m)?Failure.*(\n(?:\e\[\d*m)?\s+#\s(.*)?:\d+(?::.*)?(?:\e\[\d*m)?)+$/m
-    self.completed_re = /\n(?:\e\[\d*m)?\d* examples?/m
-  end
+      # Example for Ruby 1.8: http://rubular.com/r/AOXNVDrZpx
+      # Example for Ruby 1.9: http://rubular.com/r/85ag5AZ2jP
+      self.failed_results_re = /^\s*\d+\).*\n\s+(?:\e\[\d*m)?Failure.*(\n(?:\e\[\d*m)?\s+#\s(.*)?:\d+(?::.*)?(?:\e\[\d*m)?)+$/m
+      self.completed_re = /\n(?:\e\[\d*m)?\d* examples?/m
+    end
 
-  # Adds conventional spec-to-file mappings to Autotest configuation.
-  def setup_rspec_project_mappings
-    add_mapping(%r%^spec/.*_spec\.rb$%) { |filename, _|
-      filename
-    }
-    add_mapping(%r%^lib/(.*)\.rb$%) { |_, m|
-      ["spec/#{m[1]}_spec.rb"]
-    }
-    add_mapping(%r%^spec/(spec_helper|shared/.*)\.rb$%) {
-      files_matching %r%^spec/.*_spec\.rb$%
-    }
-  end
+    # Adds conventional spec-to-file mappings to Autotest configuation.
+    def setup_rspec_project_mappings
+      add_mapping(%r%^spec/.*_spec\.rb$%) { |filename, _|
+        filename
+      }
+      add_mapping(%r%^lib/(.*)\.rb$%) { |_, m|
+        ["spec/#{m[1]}_spec.rb"]
+      }
+      add_mapping(%r%^spec/(spec_helper|shared/.*)\.rb$%) {
+        files_matching %r%^spec/.*_spec\.rb$%
+      }
+    end
 
-  # Overrides Autotest's implementation to read rspec output
-  def consolidate_failures(failed)
-    filters = new_hash_of_arrays
-    failed.each do |spec, trace|
-      if trace =~ /(.*spec\.rb)/
-        filters[$1] << spec
+    # Overrides Autotest's implementation to read rspec output
+    def consolidate_failures(failed)
+      filters = new_hash_of_arrays
+      failed.each do |spec, trace|
+        if trace =~ /(.*spec\.rb)/
+          filters[$1] << spec
+        end
       end
+      return filters
     end
-    return filters
-  end
 
-  # Overrides Autotest's implementation to generate the rspec command to run
-  def make_test_cmd(files_to_test)
-    files_to_test.empty? ? '' :
-      %|#{prefix}"#{ruby}"#{suffix} -S "#{RSPEC_EXECUTABLE}" --tty #{normalize(files_to_test).keys.flatten.map { |f| %|"#{f}"|}.join(' ')}|
-  end
+    # Overrides Autotest's implementation to generate the rspec command to run
+    def make_test_cmd(files_to_test)
+      files_to_test.empty? ? '' :
+        %|#{prefix}"#{ruby}"#{suffix} -S "#{RSPEC_EXECUTABLE}" --tty #{normalize(files_to_test).keys.flatten.map { |f| %|"#{f}"|}.join(' ')}|
+    end
 
-  # Generates a map of filenames to Arrays for Autotest
-  def normalize(files_to_test)
-    files_to_test.keys.inject({}) do |result, filename|
-      result.merge!(File.expand_path(filename) => [])
+    # Generates a map of filenames to Arrays for Autotest
+    def normalize(files_to_test)
+      files_to_test.keys.inject({}) do |result, filename|
+        result.merge!(File.expand_path(filename) => [])
+      end
     end
-  end
 
-  private
+    private
 
-  def suffix
-    using_bundler? ? "" : defined?(:Gem) ? " -rrubygems" : ""
-  end
+    def suffix
+      using_bundler? ? "" : defined?(:Gem) ? " -rrubygems" : ""
+    end
 
-  def using_bundler?
-    prefix =~ /bundle exec/
-  end
+    def using_bundler?
+      prefix =~ /bundle exec/
+    end
 
-  def gemfile?
-    File.exist?('./Gemfile')
+    def gemfile?
+      File.exist?('./Gemfile')
+    end
   end
+  Autotest.add_hook(:ran_command) { warn "\n\e[31mUsing the built in rspec-core autotest support is deprecated and will be removed in RSpec 3. Please switch to the rspec-autotest gem\e[0m" }
 end