rspec-expectations 2.99.2 → 3.0.0.beta1

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

@@ -13,14 +13,11 @@ 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 = UNDEFINED)
-          @expected = expected unless UNDEFINED.equal?(expected)
+        def initialize(expected = nil)
+          @expected = expected
         end
 
         def matches?(actual)
@@ -39,32 +36,28 @@ module RSpec
         end
 
         def failure_message_for_should
-          assert_ivars :@actual
-          "expected #{@actual.inspect} to #{name_to_sentence}#{to_sentence expected}"
+          assert_ivars :@actual, :@expected
+          "expected #{@actual.inspect} to #{name_to_sentence}#{expected_to_sentence}"
         end
 
         def failure_message_for_should_not
-          assert_ivars :@actual
-          "expected #{@actual.inspect} not to #{name_to_sentence}#{to_sentence expected}"
+          assert_ivars :@actual, :@expected
+          "expected #{@actual.inspect} not to #{name_to_sentence}#{expected_to_sentence}"
         end
 
         def description
-          defined?(@expected) ? "#{name_to_sentence} #{@expected.inspect}" : name_to_sentence
+          expected ? "#{name_to_sentence} #{@expected.inspect}" : name_to_sentence
         end
 
         def diffable?
           false
         end
 
-        # @api private
-        # Most matchers are value matchers (i.e. meant to work with `expect(value)`)
-        # rather than block matchers (i.e. meant to work with `expect { }`), so
-        # this defaults to false. Block matchers must override this to return true.
-        def supports_block_expectations?
-          false
+        def ==(other)
+          matches?(other)
         end
 
-      private
+        private
 
         def assert_ivars *ivars
           raise "#{self.class.name} needs to supply #{to_sentence ivars}" unless ivars.all? { |v| instance_variables.map(&:intern).include? v }

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

@@ -143,23 +143,17 @@ it is a bit confusing.
           @actual = actual
 
           if is_private_on?( @actual )
-            RSpec.deprecate "matching with be_#{predicate.to_s.gsub(/\?$/,'')} on private method #{predicate}",
-              :replacement => "`expect(object.send(#{predicate.inspect})).to be_true` or change the method's visibility to public",
-              :call_site => caller(0)[3]
+            raise Expectations::ExpectationNotMetError.new("expectation set on private method `#{predicate}`")
           end
 
           begin
-            @result = actual.__send__(predicate, *@args, &@block)
-            check_respond_to(predicate)
-            return @result
+            return @result = actual.__send__(predicate, *@args, &@block)
           rescue NameError => predicate_missing_error
             "this needs to be here or rcov will not count this branch even though it's executed in a code example"
           end
 
           begin
-            @result = actual.__send__(present_tense_predicate, *@args, &@block)
-            check_respond_to(present_tense_predicate)
-            return @result
+            return @result = actual.__send__(present_tense_predicate, *@args, &@block)
           rescue NameError
             raise predicate_missing_error
           end
@@ -179,10 +173,10 @@ it is a bit confusing.
           "#{prefix_to_sentence}#{expected_to_sentence}#{args_to_sentence}"
         end
 
-      private
+        private
 
         # support 1.8.7
-        if String === methods.first
+        if methods.first.is_a? String
           def is_private_on? actual
             actual.private_methods.include? predicate.to_s
           end
@@ -213,13 +207,6 @@ it is a bit confusing.
         def prefix_to_sentence
           split_words(@prefix)
         end
-
-        def check_respond_to(method)
-          RSpec.deprecate(
-            "Matching with #{@prefix}#{@expected} on an object that doesn't respond to `#{method}`",
-            :replacement => "`respond_to_missing?` or `respond_to?` on your object"
-          ) unless actual.respond_to?(method)
-        end
       end
     end
   end

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

@@ -2,8 +2,6 @@ module RSpec
   module Matchers
     module BuiltIn
       class BeWithin
-        include MatchAliases
-
         def initialize(delta)
           @delta = delta
         end
@@ -14,6 +12,7 @@ module RSpec
           raise needs_subtractable unless @actual.respond_to? :-
           (@actual - @expected).abs <= @tolerance
         end
+        alias == matches?
 
         def of(expected)
           @expected  = expected
@@ -41,12 +40,7 @@ module RSpec
           "be within #{@delta}#{@unit} of #{@expected}"
         end
 
-        # @private
-        def supports_block_expectations?
-          false
-        end
-
-      private
+        private
 
         def needs_subtractable
           ArgumentError.new "The actual value (#{@actual.inspect}) must respond to `-`"

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

@@ -2,8 +2,6 @@ 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)}
@@ -20,39 +18,7 @@ module RSpec
 
           (!change_expected? || changed?) && matches_before? && matches_after? && matches_expected_delta? && matches_min? && matches_max?
         end
-
-        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
+        alias == matches?
 
         def raise_block_syntax_error
           raise SyntaxError.new(<<-MESSAGE)
@@ -124,10 +90,6 @@ MESSAGE
           "change ##{message}"
         end
 
-        def supports_block_expectations?
-          true
-        end
-
         private
 
         def failure_message_for_expected_after

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

@@ -2,57 +2,31 @@ module RSpec
   module Matchers
     module BuiltIn
       class Has
-        include MatchAliases
-
         def initialize(expected, *args)
           @expected, @args = expected, args
         end
 
         def matches?(actual)
-          method = predicate
-
-          if is_private_on?(actual)
-            RSpec.deprecate "matching with #{@expected} on private method #{predicate}",
-              :replacement => "`expect(object.send(#{predicate.inspect})).to be_true` or change the method's visibility to public"
-          end
-
-          result = actual.__send__(method, *@args)
-          check_respond_to(actual, method)
-          result
+          actual.__send__(predicate(@expected), *@args)
         end
+        alias == matches?
 
         def failure_message_for_should
-          "expected ##{predicate}#{failure_message_args_description} to return true, got false"
+          "expected ##{predicate(@expected)}#{failure_message_args_description} to return true, got false"
         end
 
         def failure_message_for_should_not
-          "expected ##{predicate}#{failure_message_args_description} to return false, got true"
+          "expected ##{predicate(@expected)}#{failure_message_args_description} to return false, got true"
         end
 
         def description
           [method_description(@expected), args_description].compact.join(' ')
         end
 
-        # @private
-        def supports_block_expectations?
-          false
-        end
-
-      private
+        private
 
-        # support 1.8.7
-        if String === methods.first
-          def is_private_on? actual
-            actual.private_methods.include? predicate.to_s
-          end
-        else
-          def is_private_on? actual
-            actual.private_methods.include? predicate
-          end
-        end
-
-        def predicate
-          "#{@expected.to_s.sub("have_","has_")}?".to_sym
+        def predicate(sym)
+          "#{sym.to_s.sub("have_","has_")}?".to_sym
         end
 
         def method_description(method)
@@ -68,13 +42,6 @@ module RSpec
           desc = args_description
           "(#{desc})" if desc
         end
-
-        def check_respond_to(actual, method)
-          RSpec.deprecate(
-            "Matching with #{@expected} on an object that doesn't respond to `#{method}`",
-            :replacement => "`respond_to_missing?` or `respond_to?` on your object"
-          ) unless actual.respond_to?(method)
-        end
       end
     end
   end

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

@@ -17,7 +17,7 @@ module RSpec
         end
 
         def description
-          "include#{to_sentence expected}"
+          "include#{expected_to_sentence}"
         end
 
         def diffable?

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

@@ -27,7 +27,7 @@ module RSpec
         end
 
         def description
-          "contain exactly#{to_sentence(expected)}"
+          "contain exactly #{_pretty_print(expected)}"
         end
 
         private

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

@@ -2,8 +2,6 @@ module RSpec
   module Matchers
     module BuiltIn
       class RaiseError
-        include MatchAliases
-
         def initialize(expected_error_or_message=Exception, expected_message=nil, &block)
           @block = block
           @actual_error = nil
@@ -15,29 +13,24 @@ module RSpec
           end
         end
 
-        def matches?(given_proc, negative_expectation = false)
-          if negative_expectation && (expecting_specific_exception? || @expected_message)
-            what_to_deprecate = if expecting_specific_exception? && @expected_message
-                                  "`expect { }.not_to raise_error(SpecificErrorClass, message)`"
-                                elsif expecting_specific_exception?
-                                  "`expect { }.not_to raise_error(SpecificErrorClass)`"
-                                elsif @expected_message
-                                  "`expect { }.not_to raise_error(message)`"
-                                end
+        def with_message(expected_message)
+          raise_message_already_set if @expected_message
+          @expected_message = expected_message
+          self
+        end
 
-            RSpec.deprecate(
-              what_to_deprecate,
-              :replacement => "`expect { }.not_to raise_error` (with no args)"
-            )
-          end
+        def matches?(given_proc, negative_expectation = false, &block)
+          @block ||= block
           @raised_expected_error = false
           @with_expected_message = false
           @eval_block = false
           @eval_block_passed = false
+
           unless given_proc.respond_to?(:call)
             ::Kernel.warn "`raise_error` was called with non-proc object #{given_proc.inspect}"
             return false
           end
+
           begin
             given_proc.call
           rescue Exception => @actual_error
@@ -50,11 +43,26 @@ module RSpec
           unless negative_expectation
             eval_block if @raised_expected_error && @with_expected_message && @block
           end
-        ensure
-          return (@raised_expected_error & @with_expected_message) ? (@eval_block ? @eval_block_passed : true) : false
+
+          expectation_matched?
+        end
+
+        alias == matches?
+
+        def expectation_matched?
+          error_and_message_match? && block_matches?
+        end
+
+        def error_and_message_match?
+          @raised_expected_error && @with_expected_message
+        end
+
+        def block_matches?
+          @eval_block ? @eval_block_passed : true
         end
 
         def does_not_match?(given_proc)
+          prevent_invalid_expectations
           !matches?(given_proc, :negative_expectation)
         end
 
@@ -91,13 +99,22 @@ module RSpec
           "raise #{expected_error}"
         end
 
-        # @private
-        def supports_block_expectations?
-          true
-        end
-
         private
 
+        def prevent_invalid_expectations
+          if (expecting_specific_exception? || @expected_message)
+            what_to_raise = if expecting_specific_exception? && @expected_message
+                                  "`expect { }.not_to raise_error(SpecificErrorClass, message)`"
+                                elsif expecting_specific_exception?
+                                  "`expect { }.not_to raise_error(SpecificErrorClass)`"
+                                elsif @expected_message
+                                  "`expect { }.not_to raise_error(message)`"
+                                end
+            specific_class_error = ArgumentError.new("#{what_to_raise} is not valid, use `expect { }.not_to raise_error` (with no args) instead")
+            raise specific_class_error
+          end
+        end
+
         def expected_error
           case @expected_message
           when nil
@@ -127,6 +144,10 @@ module RSpec
         def expecting_specific_exception?
           @expected_error != Exception
         end
+
+        def raise_message_already_set
+          raise "`expect { }.to raise_error(message).with_message(message)` is not valid. The matcher only allows the expected message to be specified once"
+        end
       end
     end
   end

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

@@ -2,8 +2,6 @@ module RSpec
   module Matchers
     module BuiltIn
       class RespondTo
-        include MatchAliases
-
         def initialize(*names)
           @names = names
           @expected_arity = nil
@@ -12,6 +10,7 @@ module RSpec
         def matches?(actual)
           find_failing_method_names(actual, :reject).empty?
         end
+        alias == matches?
 
         def does_not_match?(actual)
           find_failing_method_names(actual, :select).empty?
@@ -39,11 +38,6 @@ module RSpec
         end
         alias :arguments :argument
 
-        # @private
-        def supports_block_expectations?
-          false
-        end
-
         private
 
         def find_failing_method_names(actual, filter_method)

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

@@ -2,8 +2,6 @@ module RSpec
   module Matchers
     module BuiltIn
       class Satisfy
-        include MatchAliases
-
         def initialize(&block)
           @block = block
         end
@@ -13,6 +11,7 @@ module RSpec
           @actual = actual
           @block.call(actual)
         end
+        alias == matches?
 
         def failure_message_for_should
           "expected #{@actual} to satisfy block"
@@ -25,11 +24,6 @@ module RSpec
         def description
           "satisfy block"
         end
-
-        # @private
-        def supports_block_expectations?
-          false
-        end
       end
     end
   end