rspec-expectations 3.9.3 → 3.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba515bcbb264eef62d6948840e73b71ef3a68ed947d2e711df04fdf1b04fa4ec
-  data.tar.gz: ba8501df256831e843786ca4f78cc7825e8ad6dca125191beda504de0c1d16e7
+  metadata.gz: a1042199b6d7c762e4a79740c4996cfb198c2a5599091f9e80c4b934021dcfdd
+  data.tar.gz: 4aadaf8516b655b927d4daa574851e4d2113b7c0294b83f01a751b0ee785d11e
 SHA512:
-  metadata.gz: ac2ff1267b689ba5daf08898a11ff97f1f2554db817f43135a6b1d96bcada94f03d728ddda4050158fcf8a483b8295644457aea810d18b37686d5aa253007917
-  data.tar.gz: 6527bed095e09131e0e8a50f12784d017953f073b4099d710df7fff638f632d03bedba40836adeba6aa33f51d9d4c501f795c364c6e1304ddc8c41225df2c18d
+  metadata.gz: f78ad1ed8b49b3ad14c101221cfc8d380f01e31ea4c374b480ca1a514e26a3933bb05b1a1123e12cadaa5aff1d35b6e556703f0783f297dc0502e3ff2306404f
+  data.tar.gz: 8998ea12bd8f10ae89b18b2e138b338839202db95bb88328b16ce5435422c1cc1f2b6625f2a97aa653749ca33e93a288db7720526da954e01999214d99eb798d

data/Changelog.md

@@ -1,5 +1,55 @@
+### Development
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.10.2...3-10-maintenance)
+
+### 3.10.2 / 2022-01-14
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.10.1...v3.10.2)
+
+Bug Fixes:
+
+* Fix support for dynamic matchers for expectation target checks (Phil Pirozhkov, #1294)
+* Fix `expect(array).to include(hash).times`, previously this would fail due to
+  matching the entire array as a single hash, rather than a member of the hash.
+  (Slava Kardakov, #1322)
+* Ensure `raise_error` matches works with the `error_highlight` option from Ruby 3.1.
+  (Peter Goldstein, #1339)
+
+### 3.10.1 / 2020-12-27
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.10.0...v3.10.1)
+
+Bug Fixes:
+
+* Allow JRuby 9.2.x.x to generate backtraces normally rather than via our
+  backfill workaround. (#1230, Jon Rowe)
+
+### 3.10.0 / 2020-10-30
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.9.3...v3.10.0)
+
+Enhancements:
+
+* Allow `include` matcher to be chained with `once`, `at_least`, etc. for simple cases.
+  (Marc-André Lafortune, #1168)
+* Add an explicit warning when `nil` is passed to `raise_error`. (Phil Pirozhkov, #1143)
+* Improve `include` matcher's composability. (Phil Pirozhkov, #1155)
+* Mocks expectations can now set a custom failure message.
+  (Benoit Tigeot and Nicolas Zermati, #1156)
+* `aggregate_failures` now shows the backtrace line for each failure. (Fabricio Bedin, #1163)
+* Support multiple combinations of `yield_control` modifiers like `at_least`, `at_most`.
+  (Jon Rowe, #1169)
+* Dynamic `have_<n>` matchers now have output consistent with other dynamic matchers.
+  (Marc-André Lafortune, #1195)
+* New config option `strict_predicate_matchers` allows predicate matcher to be strict
+  (i.e. match for `true` or `false`) instead of the default (match truthy vs `false` or `nil`).
+  (Marc-André Lafortune, #1196)
+
+### 3.9.4 / 2020-10-29
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.9.3...v3.9.4)
+
+Bug Fixes:
+
+* Fix regression with `be_` and `have_` matchers and arguments implementing `to_hash`
+  were they would act like keywords and be cast to a hash. (Jon Rowe, #1222)
+
 ### 3.9.3 / 2020-10-23
-[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.9.2...v3.9.3)
 
 Bug Fixes:
 
@@ -14,6 +64,7 @@ Bug Fixes:
 * Prevent errors from causing false positives when using `be <operator>` comparison, e.g.
   `expect(1).not_to be < 'a'` will now correctly fail rather than pass. (Jon Rowe, #1208)
 
+
 ### 3.9.2 / 2020-05-08
 [Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.9.1...v3.9.2)
 

data/README.md

@@ -1,4 +1,4 @@
-# RSpec Expectations [![Build Status](https://secure.travis-ci.org/rspec/rspec-expectations.svg?branch=main)](http://travis-ci.org/rspec/rspec-expectations) [![Code Climate](https://codeclimate.com/github/rspec/rspec-expectations.svg)](https://codeclimate.com/github/rspec/rspec-expectations)
+# RSpec Expectations [![Build Status](https://github.com/rspec/rspec-expectations/workflows/RSpec%20CI/badge.svg?branch=3-10-maintenance)](https://github.com/rspec/rspec-expectations/actions) [![Code Climate](https://codeclimate.com/github/rspec/rspec-expectations.svg)](https://codeclimate.com/github/rspec/rspec-expectations)
 
 RSpec::Expectations lets you express expected outcomes on an object in an
 example.

data/lib/rspec/expectations/configuration.rb

@@ -28,6 +28,7 @@ module RSpec
 
       def initialize
         @on_potential_false_positives = :warn
+        @strict_predicate_matchers = false
       end
 
       # Configures the supported syntax.
@@ -185,6 +186,20 @@ module RSpec
         @on_potential_false_positives = behavior
       end
 
+      # Configures RSpec to check predicate matchers to `be(true)` / `be(false)` (strict),
+      # or `be_truthy` / `be_falsey` (not strict).
+      # Historically, the default was `false`, but `true` is recommended.
+      def strict_predicate_matchers=(flag)
+        raise ArgumentError, "Pass `true` or `false`" unless flag == true || flag == false
+        @strict_predicate_matchers = flag
+      end
+
+      attr_reader :strict_predicate_matchers
+
+      def strict_predicate_matchers?
+        @strict_predicate_matchers
+      end
+
       # Indicates what RSpec will do about matcher use which will
       # potentially cause false positives in tests, generally you want to
       # avoid such scenarios so this defaults to `true`.

data/lib/rspec/expectations/expectation_target.rb

@@ -57,7 +57,7 @@ module RSpec
         #   expect { perform }.to raise_error
         # @param [Matcher]
         #   matcher
-        # @param [String or Proc] message optional message to display when the expectation fails
+        # @param [String, Proc] message optional message to display when the expectation fails
         # @return [Boolean] true if the expectation succeeds (else raises)
         # @see RSpec::Matchers
         def to(matcher=nil, message=nil, &block)
@@ -70,7 +70,7 @@ module RSpec
         #   expect(value).not_to eq(5)
         # @param [Matcher]
         #   matcher
-        # @param [String or Proc] message optional message to display when the expectation fails
+        # @param [String, Proc] message optional message to display when the expectation fails
         # @return [Boolean] false if the negative expectation succeeds (else raises)
         # @see RSpec::Matchers
         def not_to(matcher=nil, message=nil, &block)
@@ -118,9 +118,7 @@ module RSpec
       end
 
       def supports_block_expectations?(matcher)
-        matcher.supports_block_expectations?
-      rescue NoMethodError
-        false
+        matcher.respond_to?(:supports_block_expectations?) && matcher.supports_block_expectations?
       end
     end
   end

data/lib/rspec/expectations/failure_aggregator.rb

@@ -52,10 +52,10 @@ module RSpec
 
     private
 
-      if RSpec::Support::Ruby.jruby?
-        # On JRuby, `caller` and `raise` produce different backtraces with regards to `.java`
-        # stack frames. It's important that we use `raise` for JRuby to produce a backtrace
-        # that has a continuous common section with the raised `MultipleExpectationsNotMetError`,
+      if RSpec::Support::Ruby.jruby? && RSpec::Support::Ruby.jruby_version < '9.2.0.0'
+        # On JRuby 9.1.x.x and before, `caller` and `raise` produce different backtraces with
+        # regards to `.java` stack frames. It's important that we use `raise` for JRuby to produce
+        # a backtrace that has a continuous common section with the raised `MultipleExpectationsNotMetError`,
         # so that rspec-core's truncation logic can work properly on it to list the backtrace
         # relative to the `aggregate_failures` block.
         def assign_backtrace(failure)
@@ -150,11 +150,29 @@ module RSpec
       def enumerated(exceptions, index_offset)
         exceptions.each_with_index.map do |exception, index|
           index += index_offset
-          formatted_message = yield exception
+          formatted_message = "#{yield exception}\n#{format_backtrace(exception.backtrace).first}"
           "#{index_label index}#{indented formatted_message, index}"
         end
       end
 
+      def exclusion_patterns
+        patterns = %w[/lib\d*/ruby/ bin/ exe/rspec /lib/bundler/ /exe/bundle:]
+        patterns << "org/jruby/" if RSpec::Support::Ruby.jruby?
+        patterns.map! { |s| Regexp.new(s.gsub('/', File::SEPARATOR)) }
+      end
+
+      def format_backtrace(backtrace)
+        backtrace.map { |l| backtrace_line(l) }.compact.tap { |filtered| filtered.concat backtrace if filtered.empty? }
+      end
+
+      def backtrace_line(line)
+        return if [Regexp.union(RSpec::CallerFilter::IGNORE_REGEX, *exclusion_patterns)].any? { |p| line =~ p }
+
+        # It changes the current path that is relative to
+        # system root to be relative to the project root.
+        line.sub(/(\A|\s)#{File.expand_path('.')}(#{File::SEPARATOR}|\s|\Z)/, '\\1.\\2'.freeze).sub(/\A([^:]+:\d+)$/, '\\1'.freeze)
+      end
+
       def enumerated_failures
         enumerated(failures, 0, &:message)
       end

data/lib/rspec/expectations/handler.rb

@@ -44,10 +44,16 @@ module RSpec
 
     # @private
     class PositiveExpectationHandler
-      def self.handle_matcher(actual, initial_matcher, message=nil, &block)
-        ExpectationHelper.with_matcher(self, initial_matcher, message) do |matcher|
+      def self.handle_matcher(actual, initial_matcher, custom_message=nil, &block)
+        ExpectationHelper.with_matcher(self, initial_matcher, custom_message) do |matcher|
           return ::RSpec::Matchers::BuiltIn::PositiveOperatorMatcher.new(actual) unless initial_matcher
-          matcher.matches?(actual, &block) || ExpectationHelper.handle_failure(matcher, message, :failure_message)
+
+          match_result = matcher.matches?(actual, &block)
+          if custom_message && match_result.respond_to?(:error_generator)
+            match_result.error_generator.opts[:message] = custom_message
+          end
+
+          match_result || ExpectationHelper.handle_failure(matcher, custom_message, :failure_message)
         end
       end
 
@@ -66,10 +72,16 @@ module RSpec
 
     # @private
     class NegativeExpectationHandler
-      def self.handle_matcher(actual, initial_matcher, message=nil, &block)
-        ExpectationHelper.with_matcher(self, initial_matcher, message) do |matcher|
+      def self.handle_matcher(actual, initial_matcher, custom_message=nil, &block)
+        ExpectationHelper.with_matcher(self, initial_matcher, custom_message) do |matcher|
           return ::RSpec::Matchers::BuiltIn::NegativeOperatorMatcher.new(actual) unless initial_matcher
-          does_not_match?(matcher, actual, &block) || ExpectationHelper.handle_failure(matcher, message, :failure_message_when_negated)
+
+          negated_match_result = does_not_match?(matcher, actual, &block)
+          if custom_message && negated_match_result.respond_to?(:error_generator)
+            negated_match_result.error_generator.opts[:message] = custom_message
+          end
+
+          negated_match_result || ExpectationHelper.handle_failure(matcher, custom_message, :failure_message_when_negated)
         end
       end
 

data/lib/rspec/expectations/version.rb

@@ -2,7 +2,7 @@ module RSpec
   module Expectations
     # @private
     module Version
-      STRING = '3.9.3'
+      STRING = '3.10.2'
     end
   end
 end

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

@@ -186,139 +186,6 @@ module RSpec
           @actual.__send__ @operator, @expected
         end
       end
-
-      # @api private
-      # Provides the implementation of `be_<predicate>`.
-      # Not intended to be instantiated directly.
-      class BePredicate < BaseMatcher
-        include BeHelpers
-
-        if RSpec::Support::RubyFeatures.kw_args_supported?
-          binding.eval(<<-CODE, __FILE__, __LINE__)
-          def initialize(*args, **kwargs, &block)
-            @expected = parse_expected(args.shift)
-            @args = args
-            @kwargs = kwargs
-            @block = block
-          end
-          CODE
-        else
-          def initialize(*args, &block)
-            @expected = parse_expected(args.shift)
-            @args = args
-            @block = block
-          end
-        end
-
-        def matches?(actual, &block)
-          @actual  = actual
-          @block ||= block
-          predicate_accessible? && predicate_matches?
-        end
-
-        def does_not_match?(actual, &block)
-          @actual  = actual
-          @block ||= block
-          predicate_accessible? && !predicate_matches?
-        end
-
-        # @api private
-        # @return [String]
-        def failure_message
-          failure_message_expecting(true)
-        end
-
-        # @api private
-        # @return [String]
-        def failure_message_when_negated
-          failure_message_expecting(false)
-        end
-
-        # @api private
-        # @return [String]
-        def description
-          "#{prefix_to_sentence}#{expected_to_sentence}#{args_to_sentence}"
-        end
-
-      private
-
-        def predicate_accessible?
-          actual.respond_to?(predicate) || actual.respond_to?(present_tense_predicate)
-        end
-
-        # support 1.8.7, evaluate once at load time for performance
-        if String === methods.first
-          # :nocov:
-          def private_predicate?
-            @actual.private_methods.include? predicate.to_s
-          end
-          # :nocov:
-        else
-          def private_predicate?
-            @actual.private_methods.include? predicate
-          end
-        end
-
-        if RSpec::Support::RubyFeatures.kw_args_supported?
-          binding.eval(<<-CODE, __FILE__, __LINE__)
-          def predicate_matches?
-            method_name = actual.respond_to?(predicate) ? predicate : present_tense_predicate
-            if @kwargs.empty?
-              @predicate_matches = actual.__send__(method_name, *@args, &@block)
-            else
-              @predicate_matches = actual.__send__(method_name, *@args, **@kwargs, &@block)
-            end
-          end
-          CODE
-        else
-          def predicate_matches?
-            method_name = actual.respond_to?(predicate) ? predicate : present_tense_predicate
-            @predicate_matches = actual.__send__(method_name, *@args, &@block)
-          end
-        end
-
-        def predicate
-          :"#{@expected}?"
-        end
-
-        def present_tense_predicate
-          :"#{@expected}s?"
-        end
-
-        def parse_expected(expected)
-          @prefix, expected = prefix_and_expected(expected)
-          expected
-        end
-
-        def prefix_and_expected(symbol)
-          Matchers::BE_PREDICATE_REGEX.match(symbol.to_s).captures.compact
-        end
-
-        def prefix_to_sentence
-          EnglishPhrasing.split_words(@prefix)
-        end
-
-        def failure_message_expecting(value)
-          validity_message ||
-            "expected `#{actual_formatted}.#{predicate}#{args_to_s}` to return #{value}, got #{description_of @predicate_matches}"
-        end
-
-        def validity_message
-          return nil if predicate_accessible?
-
-          msg = "expected #{actual_formatted} to respond to `#{predicate}`".dup
-
-          if private_predicate?
-            msg << " but `#{predicate}` is a private method"
-          elsif predicate == :true?
-            msg << " or perhaps you meant `be true` or `be_truthy`"
-          elsif predicate == :false?
-            msg << " or perhaps you meant `be false` or `be_falsey`"
-          end
-
-          msg
-        end
-      end
     end
   end
 end

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