rspec-expectations 2.99.0.beta1 → 2.99.0.beta2

data/Changelog.md

@@ -1,7 +1,33 @@
+### 2.99.0.beta2 / 2014-02-17
+[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.99.0.beta1...v2.99.0.beta2)
+
+Deprecations:
+
+* Deprecate chaining `by`, `by_at_least`, `by_at_most` or `to` off of
+  `expect { }.not_to change { }`. The docs have always said these are
+  not supported for the negative form but now they explicitly raise
+  errors in RSpec 3. (Myron Marston)
+* Change the semantics of `expect { }.not_to change { x }.from(y)`.
+  In RSpec 2.x, this expectation would only fail if `x` started with
+  the value of `y` and changed. If it started with a different value
+  and changed, it would pass. In RSpec 3, it will pass only if the
+  value starts at `y` and it does not change. (Myron Marston)
+* Deprecate `matcher == value` as an alias for `matcher.matches?(value)`,
+  in favor of `matcher === value`. (Myron Marston)
+* Deprecate `RSpec::Matchers::OperatorMatcher` in favor of
+  `RSpec::Matchers::BuiltIn::OperatorMatcher`. (Myron Marston)
+* Deprecate auto-integration with Test::Unit and minitest.
+  Instead, include `RSpec::Matchers` in the appropriate test case
+  base class yourself. (Myron Marston)
+* Deprecate treating `#expected` on a DSL-generated custom matcher
+  as an array when only 1 argument is passed to the matcher method.
+  In RSpec 3 it will be the single value in order to make diffs
+  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)
 
-Deprecations
+Deprecations:
 
 * Deprecate `have`, `have_at_least` and `have_at_most`. You can continue using those
 	matchers through https://github.com/rspec/rspec-collection_matchers, or
@@ -23,6 +49,14 @@ Deprecations
   * RSpec 2.x allowed helper methods defined either way to be used for
     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)
+
+Bug fixes
+
+* Fix wrong matcher descriptions with falsey expected value
+  (yujinakayama)
+
 ### 2.14.4 / 2013-11-06
 [full changelog](http://github.com/rspec/rspec-expectations/compare/v2.14.3...v2.14.4)
 

data/features/step_definitions/additional_cli_steps.rb

@@ -20,3 +20,13 @@ Then /^the example should fail$/ do
   step %q{the output should contain "1 failure"}
   step %q{the exit status should not be 0}
 end
+
+deprecation_message = /rspec-expectations' built-in integration with (Test::Unit|minitest < 5.x) is deprecated/
+
+Then /^the output should contain a deprecation warning about rspec\-expecations' built\-in integration$/ do
+  expect(all_output).to match(deprecation_message)
+end
+
+Then /^the output should not contain a deprecation warning about rspec\-expecations' built\-in integration$/ do
+  expect(all_output).not_to match(deprecation_message)
+end

data/features/test_frameworks/test_unit.feature

@@ -42,3 +42,43 @@ Feature: Test::Unit integration
      Then the output should contain "3 tests, 0 assertions, 0 failures, 1 errors" or "3 tests, 0 assertions, 1 failures, 0 errors"
       And the output should contain "expected empty? to return true, got false"
       And the output should contain "be_an_int is deprecated"
+      And the output should contain a deprecation warning about rspec-expecations' built-in integration
+
+  Scenario: use rspec/expectations with Test::Unit
+    Given a file named "rspec_expectations_with_manual_integration_test.rb" with:
+      """
+      require 'test/unit'
+      require "rspec/expectations"
+
+      class RSpecExpectationsTest < Test::Unit::TestCase
+        include ::RSpec::Matchers
+
+        RSpec::Matchers.define :be_an_integer do
+          match { |actual| Integer === actual }
+        end
+
+        def be_an_int
+          # This is actually an internal rspec-expectations API, but is used
+          # here to demonstrate that deprecation warnings from within
+          # rspec-expectations work correcty without depending on rspec-core
+          RSpec.deprecate(:be_an_int, :replacement => :be_an_integer)
+          be_an_integer
+        end
+
+        def test_passing_expectation
+          expect(1 + 3).to eq 4
+        end
+
+        def test_failing_expectation
+          expect([1,2]).to be_empty
+        end
+
+        def test_custom_matcher_with_deprecation_warning
+          expect(1).to be_an_int
+        end
+      end
+      """
+     When I run `ruby rspec_expectations_with_manual_integration_test.rb`
+     Then the output should contain "3 tests, 0 assertions, 0 failures, 1 errors" or "3 tests, 0 assertions, 1 failures, 0 errors"
+      And the output should not contain a deprecation warning about rspec-expecations' built-in integration
+

data/lib/rspec/expectations/caller_filter.rb

@@ -3,53 +3,58 @@ module RSpec
   # non-rspec lines. This enables errors to be reported at the call site in
   # the code using the library, which is far more useful than the particular
   # internal method that raised an error.
-  class CallerFilter
-
-    RSPEC_LIBS = %w[
-      core
-      mocks
-      expectations
-      matchers
-      rails
-    ]
-
-    ADDITIONAL_TOP_LEVEL_FILES = %w[ autorun ]
-
-    LIB_REGEX = %r{/lib/rspec/(#{(RSPEC_LIBS + ADDITIONAL_TOP_LEVEL_FILES).join('|')})(\.rb|/)}
-
-    if RUBY_VERSION >= '2.0.0'
-      def self.first_non_rspec_line
-        # `caller` is an expensive method that scales linearly with the size of
-        # the stack. The performance hit for fetching it in chunks is small,
-        # and since the target line is probably near the top of the stack, the
-        # overall improvement of a chunked search like this is significant.
-        #
-        # See benchmarks/caller.rb for measurements.
-
-        # Initial value here is mostly arbitrary, but is chosen to give good
-        # performance on the common case of creating a double.
-        increment = 5
-        i         = 1
-        line      = nil
-
-        while !line
-          stack = caller(i, increment)
-          raise "No non-lib lines in stack" unless stack
-
-          line = stack.find { |l| l !~ LIB_REGEX }
-
-          i         += increment
-          increment *= 2 # The choice of two here is arbitrary.
-        end
 
-        line
-      end
-    else
-      # Earlier rubies do not support the two argument form of `caller`. This
-      # fallback is logically the same, but slower.
-      def self.first_non_rspec_line
-        caller.find { |line| line !~ LIB_REGEX }
+  unless defined?(CallerFilter)
+
+    class CallerFilter
+
+      RSPEC_LIBS = %w[
+        core
+        mocks
+        expectations
+        matchers
+        rails
+      ]
+
+      ADDITIONAL_TOP_LEVEL_FILES = %w[ autorun ]
+
+      LIB_REGEX = %r{/lib/rspec/(#{(RSPEC_LIBS + ADDITIONAL_TOP_LEVEL_FILES).join('|')})(\.rb|/)}
+
+      if RUBY_VERSION >= '2.0.0'
+        def self.first_non_rspec_line
+          # `caller` is an expensive method that scales linearly with the size of
+          # the stack. The performance hit for fetching it in chunks is small,
+          # and since the target line is probably near the top of the stack, the
+          # overall improvement of a chunked search like this is significant.
+          #
+          # See benchmarks/caller.rb for measurements.
+
+          # Initial value here is mostly arbitrary, but is chosen to give good
+          # performance on the common case of creating a double.
+          increment = 5
+          i         = 1
+          line      = nil
+
+          while !line
+            stack = caller(i, increment)
+            return nil unless stack
+
+            line = stack.find { |l| l !~ LIB_REGEX }
+
+            i         += increment
+            increment *= 2 # The choice of two here is arbitrary.
+          end
+
+          line
+        end
+      else
+        # Earlier rubies do not support the two argument form of `caller`. This
+        # fallback is logically the same, but slower.
+        def self.first_non_rspec_line
+          caller.find { |line| line !~ LIB_REGEX }
+        end
       end
     end
+
   end
 end

data/lib/rspec/expectations/deprecation.rb

@@ -12,6 +12,14 @@ module RSpec
         message << " Called from #{CallerFilter.first_non_rspec_line}."
         warn message
       end
+
+      # @private
+      #
+      # Used internally to print deprecation warnings
+      def warn_deprecation(warning)
+        message = "\nDEPRECATION: #{warning}\n"
+        warn message
+      end
     end
   end
 

data/lib/rspec/expectations/handler.rb

@@ -31,7 +31,11 @@ module RSpec
                     matcher.failure_message
 
         if matcher.respond_to?(:diffable?) && matcher.diffable?
-          ::RSpec::Expectations.fail_with message, matcher.expected, matcher.actual
+          if RSpec::Matchers::DSL::Matcher === matcher
+            ::RSpec::Expectations.fail_with message, matcher.expected_as_array, matcher.actual
+          else
+            ::RSpec::Expectations.fail_with message, matcher.expected, matcher.actual
+          end
         else
           ::RSpec::Expectations.fail_with message
         end

data/lib/rspec/expectations/version.rb

@@ -2,7 +2,7 @@ module RSpec
   module Expectations
     # @private
     module Version
-      STRING = '2.99.0.beta1'
+      STRING = '2.99.0.beta2'
     end
   end
 end

data/lib/rspec/matchers.rb

@@ -1,6 +1,7 @@
 require 'rspec/matchers/extensions/instance_eval_with_args'
 require 'rspec/matchers/pretty'
 
+require 'rspec/matchers/match_aliases'
 require 'rspec/matchers/built_in'
 require 'rspec/matchers/matcher'
 require 'rspec/matchers/operator_matcher'
@@ -707,6 +708,14 @@ module RSpec
       BuiltIn::MatchArray.new(array)
     end
 
-    OperatorMatcher.register(Enumerable, '=~', BuiltIn::MatchArray)
+    BuiltIn::OperatorMatcher.register(Enumerable, '=~', BuiltIn::MatchArray)
+
+    def self.const_missing(name)
+      return super unless name == :OperatorMatcher
+
+      RSpec.deprecate("RSpec::Matchers::OperatorMatcher",
+                      :replacement => "RSpec::Matchers::BuiltIn::OperatorMatcher")
+      BuiltIn::OperatorMatcher
+    end
   end
 end

data/lib/rspec/matchers/be_close.rb

@@ -2,7 +2,10 @@ module RSpec
   module Matchers
     # @deprecated use +be_within+ instead.
     def be_close(expected, delta)
-      RSpec.deprecate("be_close(#{expected}, #{delta})", :replacement => "be_within(#{delta}).of(#{expected})")
+      RSpec.deprecate("be_close(#{expected}, #{delta})",
+        :replacement => "be_within(#{delta}).of(#{expected})",
+        :type        => 'the be_close matcher'
+      )
       be_within(delta).of(expected)
     end
   end

data/lib/rspec/matchers/built_in/base_matcher.rb

@@ -13,11 +13,14 @@ module RSpec
       # class. If/when this changes, we will announce it and remove this warning.
       class BaseMatcher
         include RSpec::Matchers::Pretty
+        include RSpec::Matchers::MatchAliases
+
+        UNDEFINED = Object.new.freeze
 
         attr_reader :actual, :expected, :rescued_exception
 
-        def initialize(expected = nil)
-          @expected = expected
+        def initialize(expected = UNDEFINED)
+          @expected = expected unless UNDEFINED.equal?(expected)
         end
 
         def matches?(actual)
@@ -36,27 +39,23 @@ module RSpec
         end
 
         def failure_message_for_should
-          assert_ivars :@actual, :@expected
+          assert_ivars :@actual
           "expected #{@actual.inspect} to #{name_to_sentence}#{expected_to_sentence}"
         end
 
         def failure_message_for_should_not
-          assert_ivars :@actual, :@expected
+          assert_ivars :@actual
           "expected #{@actual.inspect} not to #{name_to_sentence}#{expected_to_sentence}"
         end
 
         def description
-          expected ? "#{name_to_sentence} #{@expected.inspect}" : name_to_sentence
+          defined?(@expected) ? "#{name_to_sentence} #{@expected.inspect}" : name_to_sentence
         end
 
         def diffable?
           false
         end
 
-        def ==(other)
-          matches?(other)
-        end
-
         private
 
         def assert_ivars *ivars

data/lib/rspec/matchers/built_in/be_within.rb

@@ -2,6 +2,8 @@ module RSpec
   module Matchers
     module BuiltIn
       class BeWithin
+        include MatchAliases
+
         def initialize(delta)
           @delta = delta
         end
@@ -12,7 +14,6 @@ module RSpec
           raise needs_subtractable unless @actual.respond_to? :-
           (@actual - @expected).abs <= @tolerance
         end
-        alias == matches?
 
         def of(expected)
           @expected  = expected

data/lib/rspec/matchers/built_in/change.rb

@@ -2,6 +2,8 @@ module RSpec
   module Matchers
     module BuiltIn
       class Change
+        include MatchAliases
+
         def initialize(receiver=nil, message=nil, &block)
           @message = message
           @value_proc = block || lambda {receiver.__send__(message)}
@@ -18,7 +20,41 @@ module RSpec
 
           (!change_expected? || changed?) && matches_before? && matches_after? && matches_expected_delta? && matches_min? && matches_max?
         end
-        alias == matches?
+
+        def does_not_match?(event_proc, &block)
+          expression = if @expected_delta
+            "by()"
+          elsif @minimum
+            "by_at_least()"
+          elsif @maximum
+            "by_at_most()"
+          elsif @eval_after
+            "to()"
+          end
+
+          if expression
+            RSpec.deprecate("`expect { }.not_to change { }.#{expression}`")
+          end
+
+          matched_positively = matches?(event_proc, &block)
+
+          unless matches_before?
+            RSpec.warn_deprecation(<<-EOS.gsub(/^\s+\|/, ''))
+              |--------------------------------------------------------------------
+              |The semantics of `expect { }.not_to change { }.from()` are changing
+              |in RSpec 3. In RSpec 2.x, this would pass if the value changed but
+              |the starting value was not what you specified with `from()`. In
+              |RSpec 3, this will only pass if the starting value matches your
+              |`from()` value _and_ it has not changed.
+              |
+              |You have an expectation that relies upon the old RSpec 2.x semantics
+              |at: #{CallerFilter.first_non_rspec_line}"
+              |--------------------------------------------------------------------
+            EOS
+          end
+
+          !matched_positively
+        end
 
         def raise_block_syntax_error
           raise SyntaxError.new(<<-MESSAGE)

data/lib/rspec/matchers/built_in/has.rb

@@ -2,6 +2,8 @@ module RSpec
   module Matchers
     module BuiltIn
       class Has
+        include MatchAliases
+
         def initialize(expected, *args)
           @expected, @args = expected, args
         end
@@ -9,7 +11,6 @@ module RSpec
         def matches?(actual)
           actual.__send__(predicate(@expected), *@args)
         end
-        alias == matches?
 
         def failure_message_for_should
           "expected ##{predicate(@expected)}#{failure_message_args_description} to return true, got false"

data/lib/rspec/matchers/built_in/have.rb

@@ -2,6 +2,8 @@ module RSpec
   module Matchers
     module BuiltIn
       class Have
+        include MatchAliases
+
         QUERY_METHODS = [:size, :length, :count].freeze
 
         def initialize(expected, relativity=:exactly)
@@ -54,7 +56,6 @@ module RSpec
           else                @actual == @expected
           end
         end
-        alias == matches?
 
         def does_not_match?(collection_or_owner)
           @negative_expectation = true
@@ -143,7 +144,10 @@ EOF
           deprecation_message << "or replace your expectation with something like "
           deprecation_message << "`expect(#{cardinality_expression(query_method)}).#{expectation_format_method} #{suggested_matcher_expression}`"
 
-          RSpec.deprecate("`#{expectation_expression(query_method)}`", :replacement => deprecation_message)
+          RSpec.deprecate("`#{expectation_expression(query_method)}`",
+            :replacement => deprecation_message,
+            :type        => "the have matcher"
+          )
         end
 
         def expectation_expression(query_method)