rspec-expectations 2.99.0.beta2 → 2.99.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6638fae315b3f230a14e4e9a58b845016e1f2cd1
+  data.tar.gz: 7f54fd6c65671705178edae5454c4b7c6712aac2
+SHA512:
+  metadata.gz: dc9c8cc98c5d0863ba78a930e14866fed155ff606f83b96eac184ae2beeec7077d5a17613f7a49b79d7809bbf359e49289f6730ab9736ced587338769f5720bc
+  data.tar.gz: 4cef0dcd237b8853ef730e171d333e325d141826f13e4c721a92c5e9bd71a136ea7e375c4d01d808a529dc0d209b710993ed2e949c3a3bc5e4d43b0a082ad511

data/Changelog.md

@@ -1,5 +1,28 @@
+### 2.99.0.rc1 / 2014-05-18
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.99.0.beta2...2.99.0.rc1)
+
+Deprecations:
+
+* Deprecate `matcher_execution_context` attribute on DSL-defined
+  custom matchers. (Myron Marston)
+* Deprecate `RSpec::Matchers::Pretty#_pretty_print`. (Myron Marston)
+* Deprecate `RSpec::Matchers::Pretty#expected_to_sentence`. (Myron Marston)
+* Deprecate `RSpec::Matchers::Configuration` in favor of
+  `RSpec::Expectations::Configuration`. (Myron Marston)
+* Deprecate `be_xyz` predicate matcher on an object that doesn't respond to
+  `xyz?` or `xyzs?`. (Daniel Fone)
+* Deprecate `have_xyz` matcher on an object that doesn't respond to `has_xyz?`.
+  (Daniel Fone)
+* Deprecate `have_xyz` matcher on an object that has a private method `has_xyz?`.
+  (Jon Rowe)
+* Issue a deprecation warning when a block expectation expression is
+  used with a matcher that doesn't explicitly support block expectations
+  via `supports_block_expectations?`. (Myron Marston)
+* Deprecate `require 'rspec-expectations'`. Use
+  `require 'rspec/expectations'` instead. (Myron Marston)
+
 ### 2.99.0.beta2 / 2014-02-17
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.99.0.beta1...v2.99.0.beta2)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.99.0.beta1...v2.99.0.beta2)
 
 Deprecations:
 
@@ -25,7 +48,7 @@ Deprecations:
   work properly. (Jon Rowe)
 
 ### 2.99.0.beta1 / 2013-11-07
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.14.4...v2.99.0.beta1)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.14.4...v2.99.0.beta1)
 
 Deprecations:
 
@@ -50,7 +73,7 @@ Deprecations:
     either purpose, but RSpec 3.0 will not.
 
 ### 2.14.5 / 2014-02-01
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.14.4...v2.14.5)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.14.4...v2.14.5)
 
 Bug fixes
 
@@ -58,7 +81,7 @@ Bug fixes
   (yujinakayama)
 
 ### 2.14.4 / 2013-11-06
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.14.3...v2.14.4)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.14.3...v2.14.4)
 
 Bug fixes
 
@@ -67,7 +90,7 @@ Bug fixes
   back to default internal encoding with replacing characters. (Jon Rowe)
 
 ### 2.14.3 / 2013-09-22
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.14.2...v2.14.3)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.14.2...v2.14.3)
 
 Bug fixes
 
@@ -78,7 +101,7 @@ Bug fixes
   `method_missing` (Jon Rowe)
 
 ### 2.14.2 / 2013-08-14
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.14.1...v2.14.2)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.14.1...v2.14.2)
 
 Bug fixes
 
@@ -94,7 +117,7 @@ Bug fixes
   `SomeClass === SomeClass` returns false. (Myron Marston)
 
 ### 2.14.1 / 2013-08-08
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.14.0...2.14.1)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.14.0...2.14.1)
 
 Bug fixes
 
@@ -103,7 +126,7 @@ Bug fixes
   errors (Jon Rowe).
 
 ### 2.14.0 / 2013-07-06
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.14.0.rc1...v2.14.0)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.14.0.rc1...v2.14.0)
 
 Bug fixes
 
@@ -115,7 +138,7 @@ Bug fixes
   change...`  (Sam Phippen).
 
 ### 2.14.0.rc1 / 2013-05-27
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.13.0...v2.14.0.rc1)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.13.0...v2.14.0.rc1)
 
 Enhancements
 
@@ -149,7 +172,7 @@ Deprecations
   error_ to pass. (Sam Phippen and David Chelimsky)
 
 ### 2.13.0 / 2013-02-23
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.12.1...v2.13.0)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.12.1...v2.13.0)
 
 Enhancements
 
@@ -180,7 +203,7 @@ Bug fixes
   printed for empty diffs (Myron Marston).
 
 ### 2.12.1 / 2012-12-15
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.12.0...v2.12.1)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.12.0...v2.12.1)
 
 Bug fixes
 
@@ -192,7 +215,7 @@ Bug fixes
   (Steven Harman)
 
 ### 2.12.0 / 2012-11-12
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.11.3...v2.12.0)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.11.3...v2.12.0)
 
 Enhancements
 
@@ -215,7 +238,7 @@ Bug fixes
   (Tom Stuart)
 
 ### 2.11.3 / 2012-09-04
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.11.2...v2.11.3)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.11.2...v2.11.3)
 
 Bug fixes
 
@@ -231,7 +254,7 @@ Bug fixes
     }.to change { user.last_emailed_at }.to be_within(1.second).of(Time.zone.now)
 
 ### 2.11.2 / 2012-07-25
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.11.1...v2.11.2)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.11.1...v2.11.2)
 
 Bug fixes
 
@@ -240,7 +263,7 @@ Bug fixes
   of the object hierarchy. (Gabriel Gilder)
 
 ### 2.11.1 / 2012-07-08
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.11.0...v2.11.1)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.11.0...v2.11.1)
 
 Bug fixes
 
@@ -249,7 +272,7 @@ Bug fixes
     * `Time`, for example, is a legit alternative.
 
 ### 2.11.0 / 2012-07-07
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.10.0...v2.11.0)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.10.0...v2.11.0)
 
 Enhancements
 
@@ -272,7 +295,7 @@ Bug fixes
   Marston)
 
 ### 2.10.0 / 2012-05-03
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.9.1...v2.10.0)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.9.1...v2.10.0)
 
 Enhancements
 
@@ -290,7 +313,7 @@ Bug fixes
 * Fix message-specific specs to pass on Rubinius (John Firebaugh)
 
 ### 2.9.1 / 2012-04-03
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.9.0...v2.9.1)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.9.0...v2.9.1)
 
 Bug fixes
 
@@ -301,7 +324,7 @@ Bug fixes
 * Fix using execution context methods in nested DSL matchers (mirasrael)
 
 ### 2.9.0 / 2012-03-17
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.8.0...v2.9.0)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.8.0...v2.9.0)
 
 Enhancements
 
@@ -321,7 +344,7 @@ Bug fixes
 
 ### 2.8.0 / 2012-01-04
 
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.8.0.rc2...v2.8.0)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.8.0.rc2...v2.8.0)
 
 Enhancements
 
@@ -330,13 +353,13 @@ Enhancements
 
 ### 2.8.0.rc2 / 2011-12-19
 
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.8.0.rc1...v2.8.0.rc2)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.8.0.rc1...v2.8.0.rc2)
 
 No changes for this release. Just releasing with the other rspec gems.
 
 ### 2.8.0.rc1 / 2011-11-06
 
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.7.0...v2.8.0.rc1)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.7.0...v2.8.0.rc1)
 
 Enhancements
 
@@ -345,7 +368,7 @@ Enhancements
 
 ### 2.7.0 / 2011-10-16
 
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.6.0...v2.7.0)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.6.0...v2.7.0)
 
 Enhancements
 
@@ -363,7 +386,7 @@ Bug fixes
 
 ### 2.6.0 / 2011-05-12
 
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.5.0...v2.6.0)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.5.0...v2.6.0)
 
 Enhancements
 
@@ -381,7 +404,7 @@ Bug fixes
 
 ### 2.5.0 / 2011-02-05
 
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.4.0...v2.5.0)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.4.0...v2.5.0)
 
 Enhancements
 
@@ -394,7 +417,7 @@ Documentation
 
 ### 2.4.0 / 2011-01-02
 
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.3.0...v2.4.0)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.3.0...v2.4.0)
 
 No functional changes in this release, which was made to align with the
 rspec-core-2.4.0 release.
@@ -405,7 +428,7 @@ Enhancements
 
 ### 2.3.0 / 2010-12-12
 
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.2.1...v2.3.0)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.2.1...v2.3.0)
 
 Enhancements
 
@@ -413,11 +436,11 @@ Enhancements
 
 ### 2.2.0 / 2010-11-28
 
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.1.0...v2.2.0)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.1.0...v2.2.0)
 
 ### 2.1.0 / 2010-11-07
 
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.0.1...v2.1.0)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.0.1...v2.1.0)
 
 Enhancements
 
@@ -436,7 +459,7 @@ Bug fixes
 
 ### 2.0.0 / 2010-10-10
 
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.0.0.rc...v2.0.0)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.0.0.rc...v2.0.0)
 
 Enhancements
 
@@ -451,7 +474,7 @@ Bug fixes
 
 ### 2.0.0.rc / 2010-10-05
 
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.0.0.beta.22...v2.0.0.rc)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.0.0.beta.22...v2.0.0.rc)
 
 Enhancements
 
@@ -464,7 +487,7 @@ Bug fixes
 
 ### 2.0.0.beta.22 / 2010-09-12
 
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.0.0.beta.20...v2.0.0.beta.22)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v2.0.0.beta.20...v2.0.0.beta.22)
 
 Enhancements
 

data/features/README.md

@@ -23,7 +23,7 @@ Note: You can also use `expect(..).to_not` instead of `expect(..).not_to`.
 
 ## What is a matcher?
 
-A Matcher is any object that responds to the following methods:
+A matcher is any object that responds to the following methods:
 
     matches?(actual)
     failure_message_for_should
@@ -33,6 +33,7 @@ These methods are also part of the matcher protocol, but are optional:
     does_not_match?(actual)
     failure_message_for_should_not
     description
+    supports_block_expectations?
 
 RSpec ships with a number of built-in matchers and a DSL for writing custom
 matchers.

data/lib/rspec-expectations.rb

@@ -1 +1,6 @@
 require "rspec/expectations"
+
+RSpec.deprecate("`require 'rspec-expectations'`",
+                :replacement => "`require 'rspec/expectations'`",
+                # we explcitly pass a caller because CallerFilter ignores this file
+                :call_site => caller[RUBY_PLATFORM == 'java' ? 2 : 0])

data/lib/rspec/expectations.rb

@@ -1,7 +1,7 @@
 require 'rspec/expectations/extensions'
 require 'rspec/matchers'
 require 'rspec/expectations/expectation_target'
-require 'rspec/matchers/configuration'
+require 'rspec/expectations/configuration'
 require 'rspec/expectations/fail_with'
 require 'rspec/expectations/errors'
 require 'rspec/expectations/deprecation'

data/lib/rspec/{matchers → expectations}/configuration.rb

@@ -1,7 +1,7 @@
 require 'rspec/expectations/syntax'
 
 module RSpec
-  module Matchers
+  module Expectations
     # Provides configuration options for rspec-expectations.
     class Configuration
       # Configures the supported syntax.
@@ -94,11 +94,13 @@ module RSpec
         end
       end
     end
+  end
 
+  module Matchers
     # The configuration object
-    # @return [RSpec::Matchers::Configuration] the configuration object
+    # @return [RSpec::Expectations::Configuration] the configuration object
     def self.configuration
-      @configuration ||= Configuration.new
+      @configuration ||= Expectations::Configuration.new
     end
 
     # set default syntax

data/lib/rspec/expectations/expectation_target.rb

@@ -1,23 +1,48 @@
 module RSpec
   module Expectations
     # Wraps the target of an expectation.
+    #
     # @example
-    #   expect(something) # => ExpectationTarget wrapping something
+    #   expect(something)       # => ExpectationTarget wrapping something
+    #   expect { do_something } # => ExpectationTarget wrapping the block
     #
     #   # used with `to`
     #   expect(actual).to eq(3)
     #
     #   # with `not_to`
     #   expect(actual).not_to eq(3)
+    #
+    # @note `ExpectationTarget` is not intended to be instantiated
+    #   directly by users. Use `expect` instead.
     class ExpectationTarget
       class << self
         attr_accessor :deprecated_should_enabled
         alias deprecated_should_enabled? deprecated_should_enabled
       end
 
+      # @private
+      # Used as a sentinel value to be able to tell when the user
+      # did not pass an argument. We can't use `nil` for that because
+      # `nil` is a valid value to pass.
+      UndefinedValue = Module.new
+
       # @api private
-      def initialize(target)
-        @target = target
+      def initialize(value)
+        @target = value
+      end
+
+      # @private
+      def self.for(value, block)
+        if UndefinedValue.equal?(value)
+          unless block
+            raise ArgumentError, "You must pass either an argument or a block to `expect`."
+          end
+          BlockExpectationTarget.new(block)
+        elsif block
+          raise ArgumentError, "You cannot pass both an argument and a block to `expect`."
+        else
+          new(value)
+        end
       end
 
       # Runs the given expectation, passing if `matcher` returns true.
@@ -30,7 +55,7 @@ module RSpec
       # @return [Boolean] true if the expectation succeeds (else raises)
       # @see RSpec::Matchers
       def to(matcher=nil, message=nil, &block)
-        prevent_operator_matchers(:to, matcher)
+        prevent_operator_matchers(:to) unless matcher
         RSpec::Expectations::PositiveExpectationHandler.handle_matcher(@target, matcher, message, &block)
       end
 
@@ -43,7 +68,7 @@ module RSpec
       # @return [Boolean] false if the negative expectation succeeds (else raises)
       # @see RSpec::Matchers
       def not_to(matcher=nil, message=nil, &block)
-        prevent_operator_matchers(:not_to, matcher)
+        prevent_operator_matchers(:not_to) unless matcher
         RSpec::Expectations::NegativeExpectationHandler.handle_matcher(@target, matcher, message, &block)
       end
       alias to_not not_to
@@ -75,13 +100,55 @@ module RSpec
 
     private
 
-      def prevent_operator_matchers(verb, matcher)
-        return if matcher
-
+      def prevent_operator_matchers(verb)
         raise ArgumentError, "The expect syntax does not support operator matchers, " +
                              "so you must pass a matcher to `##{verb}`."
       end
     end
+
+    # @private
+    # Validates the provided matcher to ensure it supports block
+    # expectations, in order to avoid user confusion when they
+    # use a block thinking the expectation will be on the return
+    # value of the block rather than the block itself.
+    class BlockExpectationTarget < ExpectationTarget
+      def to(matcher, message=nil, &block)
+        enforce_block_expectation(matcher)
+        super
+      end
+
+      def not_to(matcher, message=nil, &block)
+        enforce_block_expectation(matcher)
+        super
+      end
+      alias to_not not_to
+
+    private
+
+      def enforce_block_expectation(matcher)
+        return if supports_block_expectations?(matcher)
+
+        RSpec.deprecate("Using a matcher in a block expectation expression " +
+                        "(e.g. `expect { }.to matcher`) that does not implement " +
+                        "`supports_block_expectations?`",
+                        :replacement => "a value expectation expression " +
+                        "(e.g. `expect(value).to matcher`) or implement " +
+                        "`supports_block_expectations?` on the provided matcher " +
+                        "(#{description_of matcher})")
+      end
+
+      def supports_block_expectations?(matcher)
+        matcher.supports_block_expectations?
+      rescue NoMethodError
+        false
+      end
+
+      def description_of(matcher)
+        matcher.description
+      rescue NoMethodError
+        matcher.inspect
+      end
+    end
   end
 end