rspec-expectations 3.9.1 → 3.10.1

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

@@ -1,13 +1,17 @@
+require 'rspec/matchers/built_in/count_expectation'
+
 module RSpec
   module Matchers
     module BuiltIn
       # @api private
       # Provides the implementation for `include`.
       # Not intended to be instantiated directly.
-      class Include < BaseMatcher
+      class Include < BaseMatcher # rubocop:disable Metrics/ClassLength
+        include CountExpectation
         # @private
         attr_reader :expecteds
 
+        # @api private
         def initialize(*expecteds)
           @expecteds = expecteds
         end
@@ -15,21 +19,29 @@ module RSpec
         # @api private
         # @return [Boolean]
         def matches?(actual)
-          actual = actual.to_hash if convert_to_hash?(actual)
-          perform_match(actual) { |v| v }
+          check_actual?(actual) &&
+            if check_expected_count?
+              expected_count_matches?(count_inclusions)
+            else
+              perform_match { |v| v }
+            end
         end
 
         # @api private
         # @return [Boolean]
         def does_not_match?(actual)
-          actual = actual.to_hash if convert_to_hash?(actual)
-          perform_match(actual) { |v| !v }
+          check_actual?(actual) &&
+            if check_expected_count?
+              !expected_count_matches?(count_inclusions)
+            else
+              perform_match { |v| !v }
+            end
         end
 
         # @api private
         # @return [String]
         def description
-          improve_hash_formatting("include#{readable_list_of(expecteds)}")
+          improve_hash_formatting("include#{readable_list_of(expecteds)}#{count_expectation_description}")
         end
 
         # @api private
@@ -62,12 +74,33 @@ module RSpec
 
       private
 
-        def format_failure_message(preposition)
-          if actual.respond_to?(:include?)
-            improve_hash_formatting("expected #{description_of @actual} #{preposition} include#{readable_list_of @divergent_items}")
-          else
-            improve_hash_formatting(yield) + ", but it does not respond to `include?`"
+        def check_actual?(actual)
+          actual = actual.to_hash if convert_to_hash?(actual)
+          @actual = actual
+          @actual.respond_to?(:include?)
+        end
+
+        def check_expected_count?
+          case
+          when !has_expected_count?
+            return false
+          when expecteds.size != 1
+            raise NotImplementedError, 'Count constraint supported only when testing for a single value being included'
+          when actual.is_a?(Hash)
+            raise NotImplementedError, 'Count constraint on hash keys not implemented'
           end
+          true
+        end
+
+        def format_failure_message(preposition)
+          msg = if actual.respond_to?(:include?)
+                  "expected #{description_of @actual} #{preposition}" \
+                  " include#{readable_list_of @divergent_items}" \
+                  "#{count_failure_reason('it is included') if has_expected_count?}"
+                else
+                  "#{yield}, but it does not respond to `include?`"
+                end
+          improve_hash_formatting(msg)
         end
 
         def readable_list_of(items)
@@ -79,10 +112,9 @@ module RSpec
           end
         end
 
-        def perform_match(actual, &block)
-          @actual = actual
+        def perform_match(&block)
           @divergent_items = excluded_from_actual(&block)
-          actual.respond_to?(:include?) && @divergent_items.empty?
+          @divergent_items.empty?
         end
 
         def excluded_from_actual
@@ -107,7 +139,10 @@ module RSpec
         end
 
         def actual_hash_includes?(expected_key, expected_value)
-          actual_value = actual.fetch(expected_key) { return false }
+          actual_value =
+            actual.fetch(expected_key) do
+              actual.find(Proc.new { return false }) { |actual_key, _| values_match?(expected_key, actual_key) }[1]
+            end
           values_match?(expected_value, actual_value)
         end
 
@@ -131,6 +166,28 @@ module RSpec
           actual.any? { |value| values_match?(expected_item, value) }
         end
 
+        if RUBY_VERSION < '1.9'
+          def count_enumerable(expected_item)
+            actual.select { |value| values_match?(expected_item, value) }.size
+          end
+        else
+          def count_enumerable(expected_item)
+            actual.count { |value| values_match?(expected_item, value) }
+          end
+        end
+
+        def count_inclusions
+          @divergent_items = expected
+          case actual
+          when String
+            actual.scan(expected.first).length
+          when Enumerable
+            count_enumerable(expected.first)
+          else
+            raise NotImplementedError, 'Count constraints are implemented for Enumerable and String values only'
+          end
+        end
+
         def diff_would_wrongly_highlight_matched_item?
           return false unless actual.is_a?(String) && expected.is_a?(Array)
 

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

@@ -9,13 +9,20 @@ module RSpec
       class RaiseError
         include Composable
 
-        def initialize(expected_error_or_message=nil, expected_message=nil, &block)
+        # 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 we need to warn when `nil` is
+        # passed in a different way. It's an Object, not a Module, since Module's `===`
+        # does not evaluate to true when compared to itself.
+        UndefinedValue = Object.new.freeze
+
+        def initialize(expected_error_or_message, expected_message, &block)
           @block = block
           @actual_error = nil
-          @warn_about_bare_error = expected_error_or_message.nil?
+          @warn_about_bare_error = UndefinedValue === expected_error_or_message
+          @warn_about_nil_error = expected_error_or_message.nil?
 
           case expected_error_or_message
-          when nil
+          when nil, UndefinedValue
             @expected_error = Exception
             @expected_message = expected_message
           when String
@@ -58,8 +65,11 @@ module RSpec
             end
           end
 
-          warn_about_bare_error if warning_about_bare_error && !negative_expectation
-          eval_block if !negative_expectation && ready_to_eval_block?
+          unless negative_expectation
+            warn_about_bare_error! if warn_about_bare_error?
+            warn_about_nil_error! if warn_about_nil_error?
+            eval_block if ready_to_eval_block?
+          end
 
           expectation_matched?
         end
@@ -67,7 +77,7 @@ module RSpec
 
         # @private
         def does_not_match?(given_proc)
-          warn_for_false_positives
+          warn_for_negative_false_positives!
           !matches?(given_proc, :negative_expectation) && Proc === given_proc
         end
 
@@ -131,29 +141,35 @@ module RSpec
           values_match?(@expected_message, @actual_error.message.to_s)
         end
 
-        def warn_for_false_positives
+        def warn_for_negative_false_positives!
           expression = 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)`"
+                       elsif @warn_about_nil_error
+                         "`expect { }.not_to raise_error(nil)`"
                        end
 
           return unless expression
 
-          warn_about_negative_false_positive expression
+          warn_about_negative_false_positive! expression
         end
 
         def handle_warning(message)
           RSpec::Expectations.configuration.false_positives_handler.call(message)
         end
 
-        def warning_about_bare_error
+        def warn_about_bare_error?
           @warn_about_bare_error && @block.nil?
         end
 
-        def warn_about_bare_error
+        def warn_about_nil_error?
+          @warn_about_nil_error
+        end
+
+        def warn_about_bare_error!
           handle_warning("Using the `raise_error` matcher without providing a specific " \
                          "error or message risks false positives, since `raise_error` " \
                          "will match when Ruby raises a `NoMethodError`, `NameError` or " \
@@ -166,11 +182,24 @@ module RSpec
                          "_positives = :nothing`")
         end
 
-        def warn_about_negative_false_positive(expression)
+        def warn_about_nil_error!
+          handle_warning("Using the `raise_error` matcher with a `nil` error is probably " \
+                         "unintentional, it risks false positives, since `raise_error` " \
+                         "will match when Ruby raises a `NoMethodError`, `NameError` or " \
+                         "`ArgumentError`, potentially allowing the expectation to pass " \
+                         "without even executing the method you are intending to call. " \
+                         "#{warning}"\
+                         "Instead consider providing a specific error class or message. " \
+                         "This message can be suppressed by setting: " \
+                         "`RSpec::Expectations.configuration.on_potential_false" \
+                         "_positives = :nothing`")
+        end
+
+        def warn_about_negative_false_positive!(expression)
           handle_warning("Using #{expression} risks false positives, since literally " \
                          "any other error would cause the expectation to pass, " \
-                         "including those raised by Ruby (e.g. NoMethodError, NameError " \
-                         "and ArgumentError), meaning the code you are intending to test " \
+                         "including those raised by Ruby (e.g. `NoMethodError`, `NameError` " \
+                         "and `ArgumentError`), meaning the code you are intending to test " \
                          "may not even get reached. Instead consider using " \
                          "`expect { }.not_to raise_error` or `expect { }.to raise_error" \
                          "(DifferentSpecificErrorClass)`. This message can be suppressed by " \

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

@@ -1,7 +1,5 @@
 RSpec::Support.require_rspec_support "method_signature_verifier"
 
-# TODO: Refactor this file to be under our class length
-# rubocop:disable ClassLength
 module RSpec
   module Matchers
     module BuiltIn
@@ -118,49 +116,15 @@ module RSpec
           end
         end
 
-        def setup_method_signature_expectation
-          expectation = Support::MethodSignatureExpectation.new
-
-          if @expected_arity.is_a?(Range)
-            expectation.min_count = @expected_arity.min
-            expectation.max_count = @expected_arity.max
-          else
-            expectation.min_count = @expected_arity
-          end
-
-          expectation.keywords = @expected_keywords
-          expectation.expect_unlimited_arguments = @unlimited_arguments
-          expectation.expect_arbitrary_keywords  = @arbitrary_keywords
-
-          expectation
-        end
-
         def matches_arity?(actual, name)
-          expectation = setup_method_signature_expectation
-
-          return true if expectation.empty?
-
-          begin
-            Support::StrictSignatureVerifier.new(method_signature_for(actual, name)).
-              with_expectation(expectation).valid?
-          rescue NameError
-            return true if @ignoring_method_signature_failure
-            raise ArgumentError, "The #{matcher_name} matcher requires that " \
-                                 "the actual object define the method(s) in " \
-                                 "order to check arity, but the method " \
-                                 "`#{name}` is not defined. Remove the arity " \
-                                 "check or define the method to continue."
-          end
-        end
-
-        def method_signature_for(actual, name)
-          method_handle = Support.method_handle_for(actual, name)
-
-          if name == :new && method_handle.owner === ::Class && ::Class === actual
-            Support::MethodSignature.new(actual.instance_method(:initialize))
-          else
-            Support::MethodSignature.new(method_handle)
-          end
+          ArityCheck.new(@expected_arity, @expected_keywords, @arbitrary_keywords, @unlimited_arguments).matches?(actual, name)
+        rescue NameError
+          return true if @ignoring_method_signature_failure
+          raise ArgumentError, "The #{matcher_name} matcher requires that " \
+                               "the actual object define the method(s) in " \
+                               "order to check arity, but the method " \
+                               "`#{name}` is not defined. Remove the arity " \
+                               "check or define the method to continue."
         end
 
         def with_arity
@@ -192,8 +156,45 @@ module RSpec
         def pp_names
           @names.length == 1 ? "##{@names.first}" : description_of(@names)
         end
+
+        # @private
+        class ArityCheck
+          def initialize(expected_arity, expected_keywords, arbitrary_keywords, unlimited_arguments)
+            expectation = Support::MethodSignatureExpectation.new
+
+            if expected_arity.is_a?(Range)
+              expectation.min_count = expected_arity.min
+              expectation.max_count = expected_arity.max
+            else
+              expectation.min_count = expected_arity
+            end
+
+            expectation.keywords = expected_keywords
+            expectation.expect_unlimited_arguments = unlimited_arguments
+            expectation.expect_arbitrary_keywords  = arbitrary_keywords
+            @expectation = expectation
+          end
+
+          def matches?(actual, name)
+            return true if @expectation.empty?
+            verifier_for(actual, name).with_expectation(@expectation).valid?
+          end
+
+          def verifier_for(actual, name)
+            Support::StrictSignatureVerifier.new(method_signature_for(actual, name))
+          end
+
+          def method_signature_for(actual, name)
+            method_handle = Support.method_handle_for(actual, name)
+
+            if name == :new && method_handle.owner === ::Class && ::Class === actual
+              Support::MethodSignature.new(actual.instance_method(:initialize))
+            else
+              Support::MethodSignature.new(method_handle)
+            end
+          end
+        end
       end
     end
   end
 end
-# rubocop:enable ClassLength

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

@@ -1,3 +1,5 @@
+require 'rspec/matchers/built_in/count_expectation'
+
 RSpec::Support.require_rspec_support 'method_signature_verifier'
 
 module RSpec
@@ -97,64 +99,12 @@ module RSpec
       # Provides the implementation for `yield_control`.
       # Not intended to be instantiated directly.
       class YieldControl < BaseMatcher
-        def initialize
-          at_least(:once)
-        end
-
-        # @api public
-        # Specifies that the method is expected to yield once.
-        def once
-          exactly(1)
-          self
-        end
-
-        # @api public
-        # Specifies that the method is expected to yield twice.
-        def twice
-          exactly(2)
-          self
-        end
-
-        # @api public
-        # Specifies that the method is expected to yield thrice.
-        def thrice
-          exactly(3)
-          self
-        end
-
-        # @api public
-        # Specifies that the method is expected to yield the given number of times.
-        def exactly(number)
-          set_expected_yields_count(:==, number)
-          self
-        end
-
-        # @api public
-        # Specifies the maximum number of times the method is expected to yield
-        def at_most(number)
-          set_expected_yields_count(:<=, number)
-          self
-        end
-
-        # @api public
-        # Specifies the minimum number of times the method is expected to yield
-        def at_least(number)
-          set_expected_yields_count(:>=, number)
-          self
-        end
-
-        # @api public
-        # No-op. Provides syntactic sugar.
-        def times
-          self
-        end
-
+        include CountExpectation
         # @private
         def matches?(block)
           @probe = YieldProbe.probe(block)
           return false unless @probe.has_block?
-
-          @probe.num_yields.__send__(@expectation_type, @expected_yields_count)
+          expected_count_matches?(@probe.num_yields)
         end
 
         # @private
@@ -181,37 +131,10 @@ module RSpec
 
       private
 
-        def set_expected_yields_count(relativity, n)
-          @expectation_type = relativity
-          @expected_yields_count = case n
-                                   when Numeric then n
-                                   when :once then 1
-                                   when :twice then 2
-                                   when :thrice then 3
-                                   end
-        end
-
         def failure_reason
           return ' but was not a block' unless @probe.has_block?
-          return '' unless @expected_yields_count
-          " #{human_readable_expectation_type}#{human_readable_count(@expected_yields_count)}" \
-          " but yielded #{human_readable_count(@probe.num_yields)}"
-        end
-
-        def human_readable_expectation_type
-          case @expectation_type
-          when :<= then 'at most '
-          when :>= then 'at least '
-          else ''
-          end
-        end
-
-        def human_readable_count(count)
-          case count
-          when 1 then 'once'
-          when 2 then 'twice'
-          else "#{count} times"
-          end
+          return "#{count_expectation_description} but did not yield" if @probe.num_yields == 0
+          count_failure_reason('yielded')
         end
       end