rspec-expectations 3.9.4 → 3.11.0

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

@@ -0,0 +1,169 @@
+module RSpec
+  module Matchers
+    module BuiltIn
+      # @api private
+      # Asbtract class to implement `once`, `at_least` and other
+      # count constraints.
+      module CountExpectation
+        # @api public
+        # Specifies that the method is expected to match once.
+        def once
+          exactly(1)
+        end
+
+        # @api public
+        # Specifies that the method is expected to match twice.
+        def twice
+          exactly(2)
+        end
+
+        # @api public
+        # Specifies that the method is expected to match thrice.
+        def thrice
+          exactly(3)
+        end
+
+        # @api public
+        # Specifies that the method is expected to match the given number of times.
+        def exactly(number)
+          set_expected_count(:==, number)
+          self
+        end
+
+        # @api public
+        # Specifies the maximum number of times the method is expected to match
+        def at_most(number)
+          set_expected_count(:<=, number)
+          self
+        end
+
+        # @api public
+        # Specifies the minimum number of times the method is expected to match
+        def at_least(number)
+          set_expected_count(:>=, number)
+          self
+        end
+
+        # @api public
+        # No-op. Provides syntactic sugar.
+        def times
+          self
+        end
+
+      protected
+        # @api private
+        attr_reader :count_expectation_type, :expected_count
+
+      private
+
+        if RUBY_VERSION.to_f > 1.8
+          def cover?(count, number)
+            count.cover?(number)
+          end
+        else
+          def cover?(count, number)
+            number >= count.first && number <= count.last
+          end
+        end
+
+        def expected_count_matches?(actual_count)
+          @actual_count = actual_count
+          return @actual_count > 0 unless count_expectation_type
+          return cover?(expected_count, actual_count) if count_expectation_type == :<=>
+
+          @actual_count.__send__(count_expectation_type, expected_count)
+        end
+
+        def has_expected_count?
+          !!count_expectation_type
+        end
+
+        def set_expected_count(relativity, n)
+          raise_unsupported_count_expectation if unsupported_count_expectation?(relativity)
+
+          count = count_constraint_to_number(n)
+
+          if count_expectation_type == :<= && relativity == :>=
+            raise_impossible_count_expectation(count) if count > expected_count
+            @count_expectation_type = :<=>
+            @expected_count = count..expected_count
+          elsif count_expectation_type == :>= && relativity == :<=
+            raise_impossible_count_expectation(count) if count < expected_count
+            @count_expectation_type = :<=>
+            @expected_count = expected_count..count
+          else
+            @count_expectation_type = relativity
+            @expected_count = count
+          end
+        end
+
+        def raise_impossible_count_expectation(count)
+          text =
+            case count_expectation_type
+            when :<= then "at_least(#{count}).at_most(#{expected_count})"
+            when :>= then "at_least(#{expected_count}).at_most(#{count})"
+            end
+          raise ArgumentError, "The constraint #{text} is not possible"
+        end
+
+        def raise_unsupported_count_expectation
+          text =
+            case count_expectation_type
+            when :<= then "at_least"
+            when :>= then "at_most"
+            when :<=> then "at_least/at_most combination"
+            else "count"
+            end
+          raise ArgumentError, "Multiple #{text} constraints are not supported"
+        end
+
+        def count_constraint_to_number(n)
+          case n
+          when Numeric then n
+          when :once then 1
+          when :twice then 2
+          when :thrice then 3
+          else
+            raise ArgumentError, "Expected a number, :once, :twice or :thrice," \
+              " but got #{n}"
+          end
+        end
+
+        def unsupported_count_expectation?(relativity)
+          return true if count_expectation_type == :==
+          return true if count_expectation_type == :<=>
+          (count_expectation_type == :<= && relativity == :<=) ||
+            (count_expectation_type == :>= && relativity == :>=)
+        end
+
+        def count_expectation_description
+          "#{human_readable_expectation_type}#{human_readable_count(expected_count)}"
+        end
+
+        def count_failure_reason(action)
+          "#{count_expectation_description}" \
+          " but #{action}#{human_readable_count(@actual_count)}"
+        end
+
+        def human_readable_expectation_type
+          case count_expectation_type
+          when :<= then ' at most'
+          when :>= then ' at least'
+          when :<=> then ' between'
+          else ''
+          end
+        end
+
+        def human_readable_count(count)
+          case count
+          when Range then " #{count.first} and #{count.last} times"
+          when nil then ''
+          when 1 then ' once'
+          when 2 then ' twice'
+          else " #{count} times"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -2,9 +2,11 @@ module RSpec
   module Matchers
     module BuiltIn
       # @api private
-      # Provides the implementation for `has_<predicate>`.
-      # Not intended to be instantiated directly.
-      class Has < BaseMatcher
+      # Provides the implementation for dynamic predicate matchers.
+      # Not intended to be inherited directly.
+      class DynamicPredicate < BaseMatcher
+        include BeHelpers
+
         def initialize(method_name, *args, &block)
           @method_name, @args, @block = method_name, args, block
         end
@@ -21,31 +23,31 @@ module RSpec
         def does_not_match?(actual, &block)
           @actual = actual
           @block ||= block
-          predicate_accessible? && !predicate_matches?
+          predicate_accessible? && predicate_matches?(false)
         end
 
         # @api private
         # @return [String]
         def failure_message
-          validity_message || "expected ##{predicate}#{failure_message_args_description} to return true, got false"
+          failure_message_expecting(true)
         end
 
         # @api private
         # @return [String]
         def failure_message_when_negated
-          validity_message || "expected ##{predicate}#{failure_message_args_description} to return false, got true"
+          failure_message_expecting(false)
         end
 
         # @api private
         # @return [String]
         def description
-          [method_description, args_description].compact.join(' ')
+          "#{method_description}#{args_to_sentence}"
         end
 
       private
 
         def predicate_accessible?
-          !private_predicate? && predicate_exists?
+          @actual.respond_to? predicate
         end
 
         # support 1.8.7, evaluate once at load time for performance
@@ -61,44 +63,105 @@ module RSpec
           end
         end
 
-        def predicate_exists?
-          @actual.respond_to? predicate
+        def predicate_result
+          @predicate_result = actual.__send__(predicate_method_name, *@args, &@block)
         end
 
-        def predicate_matches?
-          @actual.__send__(predicate, *@args, &@block)
+        def predicate_method_name
+          predicate
         end
 
-        def predicate
+        def predicate_matches?(value=true)
+          if RSpec::Expectations.configuration.strict_predicate_matchers?
+            value == predicate_result
+          else
+            value == !!predicate_result
+          end
+        end
+
+        def root
           # On 1.9, there appears to be a bug where String#match can return `false`
           # rather than the match data object. Changing to Regex#match appears to
           # work around this bug. For an example of this bug, see:
           # https://travis-ci.org/rspec/rspec-expectations/jobs/27549635
-          @predicate ||= :"has_#{Matchers::HAS_REGEX.match(@method_name.to_s).captures.first}?"
+          self.class::REGEX.match(@method_name.to_s).captures.first
         end
 
         def method_description
-          @method_name.to_s.tr('_', ' ')
+          EnglishPhrasing.split_words(@method_name)
         end
 
-        def args_description
-          return nil if @args.empty?
-          @args.map { |arg| RSpec::Support::ObjectFormatter.format(arg) }.join(', ')
+        def failure_message_expecting(value)
+          validity_message ||
+            "expected `#{actual_formatted}.#{predicate}#{args_to_s}` to #{expectation_of value}, got #{description_of @predicate_result}"
         end
 
-        def failure_message_args_description
-          desc = args_description
-          "(#{desc})" if desc
+        def expectation_of(value)
+          if RSpec::Expectations.configuration.strict_predicate_matchers?
+            "return #{value}"
+          elsif value
+            "be truthy"
+          else
+            "be falsey"
+          end
         end
 
         def validity_message
+          return nil if predicate_accessible?
+
+          "expected #{actual_formatted} to respond to `#{predicate}`#{failure_to_respond_explanation}"
+        end
+
+        def failure_to_respond_explanation
           if private_predicate?
-            "expected #{@actual} to respond to `#{predicate}` but `#{predicate}` is a private method"
-          elsif !predicate_exists?
-            "expected #{@actual} to respond to `#{predicate}`"
+            " but `#{predicate}` is a private method"
           end
         end
       end
+
+      # @api private
+      # Provides the implementation for `has_<predicate>`.
+      # Not intended to be instantiated directly.
+      class Has < DynamicPredicate
+        # :nodoc:
+        REGEX = Matchers::HAS_REGEX
+      private
+        def predicate
+          @predicate ||= :"has_#{root}?"
+        end
+      end
+
+      # @api private
+      # Provides the implementation of `be_<predicate>`.
+      # Not intended to be instantiated directly.
+      class BePredicate < DynamicPredicate
+        # :nodoc:
+        REGEX = Matchers::BE_PREDICATE_REGEX
+      private
+        def predicate
+          @predicate ||= :"#{root}?"
+        end
+
+        def predicate_method_name
+          actual.respond_to?(predicate) ? predicate : present_tense_predicate
+        end
+
+        def failure_to_respond_explanation
+          super || if predicate == :true?
+                     " or perhaps you meant `be true` or `be_truthy`"
+                   elsif predicate == :false?
+                     " or perhaps you meant `be false` or `be_falsey`"
+                   end
+        end
+
+        def predicate_accessible?
+          super || actual.respond_to?(present_tense_predicate)
+        end
+
+        def present_tense_predicate
+          :"#{root}s?"
+        end
+      end
     end
   end
 end

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(Hash === expected ? expected : 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/output.rb

@@ -94,6 +94,13 @@ module RSpec
           true
         end
 
+        # @api private
+        # Indicates this matcher matches against a block only.
+        # @return [False]
+        def supports_value_expectations?
+          false
+        end
+
       private
 
         def captured?

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
@@ -52,14 +59,17 @@ module RSpec
             given_proc.call
           rescue Exception => @actual_error
             if values_match?(@expected_error, @actual_error) ||
-               values_match?(@expected_error, @actual_error.message)
+               values_match?(@expected_error, actual_error_message)
               @raised_expected_error = true
               @with_expected_message = verify_message
             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
 
@@ -76,6 +86,12 @@ module RSpec
           true
         end
 
+        # @private
+        def supports_value_expectations?
+          false
+        end
+
+        # @private
         def expects_call_stack_jump?
           true
         end
@@ -83,7 +99,7 @@ module RSpec
         # @api private
         # @return [String]
         def failure_message
-          @eval_block ? @actual_error.message : "expected #{expected_error}#{given_error}"
+          @eval_block ? actual_error_message : "expected #{expected_error}#{given_error}"
         end
 
         # @api private
@@ -100,6 +116,12 @@ module RSpec
 
       private
 
+        def actual_error_message
+          return nil unless @actual_error
+
+          @actual_error.respond_to?(:original_message) ? @actual_error.original_message : @actual_error.message
+        end
+
         def expectation_matched?
           error_and_message_match? && block_matches?
         end
@@ -128,32 +150,38 @@ module RSpec
 
         def verify_message
           return true if @expected_message.nil?
-          values_match?(@expected_message, @actual_error.message.to_s)
+          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 +194,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 " \