rspec-expectations 2.14.5 → 2.99.0

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)
@@ -11,7 +13,11 @@ module RSpec
                       else expected
                       end
           @relativity = relativity
+
           @actual = @collection_name = @plural_collection_name = nil
+          @target_owns_a_collection = false
+          @negative_expectation = false
+          @expectation_format_method = "to"
         end
 
         def relativities
@@ -29,13 +35,20 @@ module RSpec
             for query_method in QUERY_METHODS
               next unless collection.respond_to?(query_method)
               @actual = collection.__send__(query_method)
-              break unless @actual.nil?
+
+              if @actual
+                print_deprecation_message(query_method)
+                break
+              end
             end
+
             raise not_a_collection if @actual.nil?
           else
             query_method = determine_query_method(collection)
             raise not_a_collection unless query_method
             @actual = collection.__send__(query_method)
+
+            print_deprecation_message(query_method)
           end
           case @relativity
           when :at_least then @actual >= @expected
@@ -43,12 +56,19 @@ module RSpec
           else                @actual == @expected
           end
         end
-        alias == matches?
+
+        def does_not_match?(collection_or_owner)
+          @negative_expectation = true
+          @expectation_format_method = "to_not"
+          !matches?(collection_or_owner)
+        end
 
         def determine_collection(collection_or_owner)
           if collection_or_owner.respond_to?(@collection_name)
+            @target_owns_a_collection = true
             collection_or_owner.__send__(@collection_name, *@args, &@block)
           elsif (@plural_collection_name && collection_or_owner.respond_to?(@plural_collection_name))
+            @target_owns_a_collection = true
             collection_or_owner.__send__(@plural_collection_name, *@args, &@block)
           elsif determine_query_method(collection_or_owner)
             collection_or_owner
@@ -118,6 +138,135 @@ EOF
         def enumerator_class
           RUBY_VERSION < '1.9' ? Enumerable::Enumerator : Enumerator
         end
+
+        def print_deprecation_message(query_method)
+          deprecation_message = "the rspec-collection_matchers gem "
+          deprecation_message << "or replace your expectation with something like "
+          if for_rspec_rails_error_on?
+            # It is supposed to be safe to be able to convert the args array to
+            # a string. This is because the `errors_on` method only takes two
+            # valid arguments: attribute name (symbol/string) and a hash
+            deprecated_call = expectation_expression(query_method, "record")
+            deprecated_call << "(#{errors_on_args_list})" unless @args.empty?
+
+            deprecation_message << <<-EOS.gsub(/^\s+\|/, '')
+              |
+              |
+              |    #{record_valid_expression}
+              |    expect(#{record_errors_expression(query_method)}).#{expectation_format_method} #{suggested_matcher_expression}
+              |
+            EOS
+          else
+            deprecated_call = expectation_expression(query_method)
+            deprecation_message << "`expect(#{cardinality_expression(query_method)}).#{expectation_format_method} #{suggested_matcher_expression}`"
+          end
+
+          RSpec.deprecate("`#{deprecated_call}`",
+            :replacement => deprecation_message,
+            :type        => "the have matcher"
+          )
+        end
+
+        def expectation_expression(query_method, target = nil)
+          target ||= target_expression
+          if @negative_expectation
+            RSpec::Expectations::Syntax.negative_expression(target, original_matcher_expression)
+          else
+            RSpec::Expectations::Syntax.positive_expression(target, original_matcher_expression)
+          end
+        end
+
+        def target_expression
+          if @target_owns_a_collection
+            'collection_owner'
+          else
+            'collection'
+          end
+        end
+
+        def original_matcher_expression
+          "#{matcher_method}(#{@expected}).#{@collection_name}"
+        end
+
+        def expectation_format_method
+          if @relativity == :exactly
+            @expectation_format_method
+          else
+            "to"
+          end
+        end
+
+        def cardinality_expression(query_method)
+          expression = "#{target_expression}."
+          expression << "#{@collection_name}." if @target_owns_a_collection
+          expression << String(query_method)
+        end
+
+        def suggested_matcher_expression
+          send("suggested_matcher_expression_for_#{@relativity}")
+        end
+
+        def suggested_matcher_expression_for_exactly
+          "eq(#{@expected})"
+        end
+
+        def suggested_matcher_expression_for_at_most
+          if @negative_expectation
+            "be > #{@expected}"
+          else
+            "be <= #{@expected}"
+          end
+        end
+
+        def suggested_matcher_expression_for_at_least
+          if @negative_expectation
+            "be < #{@expected}"
+          else
+            "be >= #{@expected}"
+          end
+        end
+
+        def matcher_method
+          case @relativity
+          when :exactly
+            "have"
+          when :at_most
+            "have_at_most"
+          when :at_least
+            "have_at_least"
+          end
+        end
+
+        # RSpec Rails `errors_on` specific helpers
+        def for_rspec_rails_error_on?
+          defined?(RSpec::Rails) &&
+            /\.errors?_on\b/ =~ original_matcher_expression
+        end
+
+        def errors_on_args_list
+          list = @args.first.inspect
+          context = validation_context
+          list << ", :context => #{context}" if context
+          list
+        end
+
+        def record_valid_expression
+          expression = "record.valid?"
+          if on_context = validation_context
+            expression << "(#{on_context})"
+          end
+          expression
+        end
+
+        def validation_context
+          return unless Hash === @args.last
+          @args.last[:context].inspect
+        end
+
+        def record_errors_expression(query_method)
+          attribute = (@args.first || :attr)
+          "record.errors[#{attribute.inspect}].#{String(query_method)}"
+        end
       end
     end
   end

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

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

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

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

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

@@ -2,6 +2,8 @@ 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
@@ -51,7 +53,6 @@ module RSpec
         ensure
           return (@raised_expected_error & @with_expected_message) ? (@eval_block ? @eval_block_passed : true) : false
         end
-        alias == matches?
 
         def does_not_match?(given_proc)
           !matches?(given_proc, :negative_expectation)
@@ -90,6 +91,11 @@ module RSpec
           "raise #{expected_error}"
         end
 
+        # @private
+        def supports_block_expectations?
+          true
+        end
+
         private
 
         def expected_error

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

@@ -2,6 +2,8 @@ module RSpec
   module Matchers
     module BuiltIn
       class RespondTo
+        include MatchAliases
+
         def initialize(*names)
           @names = names
           @expected_arity = nil
@@ -10,7 +12,6 @@ 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?
@@ -38,6 +39,11 @@ 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,6 +2,8 @@ module RSpec
   module Matchers
     module BuiltIn
       class Satisfy
+        include MatchAliases
+
         def initialize(&block)
           @block = block
         end
@@ -11,7 +13,6 @@ module RSpec
           @actual = actual
           @block.call(actual)
         end
-        alias == matches?
 
         def failure_message_for_should
           "expected #{@actual} to satisfy block"
@@ -24,6 +25,11 @@ module RSpec
         def description
           "satisfy block"
         end
+
+        # @private
+        def supports_block_expectations?
+          false
+        end
       end
     end
   end

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

@@ -2,6 +2,8 @@ module RSpec
   module Matchers
     module BuiltIn
       class ThrowSymbol
+        include MatchAliases
+
         def initialize(expected_symbol = nil, expected_arg=nil)
           @expected_symbol = expected_symbol
           @expected_arg = expected_arg
@@ -51,7 +53,6 @@ module RSpec
             end
           end
         end
-        alias == matches?
 
         def failure_message_for_should
           "expected #{expected} to be thrown, got #{caught}"
@@ -65,7 +66,14 @@ module RSpec
           "throw #{expected}"
         end
 
-        private
+        # @api private
+        # Indicates this matcher matches against a block.
+        # @return [True]
+        def supports_block_expectations?
+          true
+        end
+
+      private
 
         def expected(symbol_desc = 'a Symbol')
           throw_description(@expected_symbol || symbol_desc, @expected_arg)

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

@@ -121,7 +121,12 @@ module RSpec
           end
         end
 
-        private
+        # @private
+        def supports_block_expectations?
+          true
+        end
+
+      private
 
         def set_expected_yields_count(relativity, n)
           @expectation_type = relativity
@@ -169,6 +174,11 @@ module RSpec
           "expected given block not to yield with no arguments, but did"
         end
 
+        # @private
+        def supports_block_expectations?
+          true
+        end
+
       private
 
         def failure_reason
@@ -181,6 +191,8 @@ module RSpec
       end
 
       class YieldWithArgs
+        include MatchAliases
+
         def initialize(*args)
           @expected = args
         end
@@ -190,7 +202,6 @@ module RSpec
           @actual = @probe.single_yield_args
           @probe.yielded_once?(:yield_with_args) && args_match?
         end
-        alias == matches?
 
         def failure_message_for_should
           "expected given block to yield with arguments, but #{positive_failure_reason}"
@@ -206,6 +217,11 @@ module RSpec
           desc
         end
 
+        # @private
+        def supports_block_expectations?
+          true
+        end
+
       private
 
         def positive_failure_reason
@@ -251,6 +267,8 @@ module RSpec
       end
 
       class YieldSuccessiveArgs
+        include MatchAliases
+
         def initialize(*args)
           @expected = args
         end
@@ -260,7 +278,6 @@ module RSpec
           @actual = @probe.successive_yield_args
           args_match?
         end
-        alias == matches?
 
         def failure_message_for_should
           "expected given block to yield successively with arguments, but yielded with unexpected arguments" +
@@ -280,6 +297,11 @@ module RSpec
           desc
         end
 
+        # @private
+        def supports_block_expectations?
+          true
+        end
+
       private
 
         def args_match?

data/lib/rspec/matchers/built_in.rb

@@ -4,8 +4,8 @@ module RSpec
       require 'rspec/matchers/built_in/base_matcher'
       autoload :BeAnInstanceOf, 'rspec/matchers/built_in/be_instance_of'
       autoload :Be,             'rspec/matchers/built_in/be'
-      autoload :BeTrue,         'rspec/matchers/built_in/be'
-      autoload :BeFalse,        'rspec/matchers/built_in/be'
+      autoload :BeTruthy,         'rspec/matchers/built_in/be'
+      autoload :BeFalsey,        'rspec/matchers/built_in/be'
       autoload :BeNil,          'rspec/matchers/built_in/be'
       autoload :BeComparedTo,   'rspec/matchers/built_in/be'
       autoload :BePredicate,    'rspec/matchers/built_in/be'

data/lib/rspec/matchers/differentiate_block_method_types.rb

@@ -0,0 +1,55 @@
+module RSpec
+  module Matchers
+    # Evaluates a block in order to determine what methods, if any,
+    # it defines as instance methods (using `def foo`) vs singleton
+    # methods (using `def self.foo`).
+    #
+    # @api private
+    class DifferentiateBlockMethodTypes
+      def initialize(*block_args, &block)
+        @block_args = block_args
+        @block = block
+
+        ignore_macro_methods
+
+        capture_added_methods(singletons_singleton_class, singleton_methods)
+        capture_added_methods(singleton_class, instance_methods)
+
+        singleton_class.class_exec(*block_args, &block)
+      end
+
+      def singleton_methods
+        @singleton_methods ||= []
+      end
+
+      def instance_methods
+        @instance_methods ||= []
+      end
+
+    private
+
+      def capture_added_methods(object, method_list)
+        object.__send__(:define_method, :singleton_method_added) do |method_name|
+          method_list << method_name
+        end
+
+        method_list.delete(:singleton_method_added)
+      end
+
+      unless method_defined?(:singleton_class)
+        def singleton_class
+          class << self; self; end
+        end
+      end
+
+      def singletons_singleton_class
+        class << singleton_class; self; end
+      end
+
+      def ignore_macro_methods
+        def singleton_class.method_missing(*); self; end
+      end
+    end
+  end
+end
+

data/lib/rspec/matchers/dsl.rb

@@ -7,7 +7,8 @@ module RSpec
         matcher_template = RSpec::Matchers::DSL::Matcher.new(name, &declarations)
         define_method name do |*expected|
           matcher = matcher_template.for_expected(*expected)
-          matcher.matcher_execution_context = @matcher_execution_context ||= self
+          @matcher_execution_context ||= self
+          matcher.instance_variable_set(:@matcher_execution_context, @matcher_execution_context)
           matcher
         end
       end

data/lib/rspec/matchers/match_aliases.rb

@@ -0,0 +1,22 @@
+module RSpec
+  module Matchers
+    module MatchAliases
+      def ==(other)
+        return true if equal?(other)
+
+        matched = matches?(other)
+
+        if matched
+          RSpec.deprecate("Using `matcher == value` as an alias for `#matches?`", :replacement => "`matcher === value`")
+        end
+
+        matched
+      end
+
+      def ===(other)
+        matches?(other)
+      end
+    end
+  end
+end
+