rspec-expectations 3.9.4 → 3.11.0

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/throw_symbol.rb

@@ -94,6 +94,12 @@ module RSpec
           true
         end
 
+        # @api private
+        def supports_value_expectations?
+          false
+        end
+
+        # @api private
         def expects_call_stack_jump?
           true
         end

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
-          @expectation_type = @expected_yields_count = nil
-        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?
-          return @probe.num_yields > 0 unless @expectation_type
-          @probe.num_yields.__send__(@expectation_type, @expected_yields_count)
+          expected_count_matches?(@probe.num_yields)
         end
 
         # @private
@@ -179,48 +129,17 @@ module RSpec
           true
         end
 
-      private
-
-        def set_expected_yields_count(relativity, n)
-          raise "Multiple count constraints are not supported" if @expectation_type
-
-          @expectation_type = relativity
-          @expected_yields_count = count_constraint_to_number(n)
+        # @private
+        def supports_value_expectations?
+          false
         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
+      private
 
         def failure_reason
           return ' but was not a block' unless @probe.has_block?
-          "#{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 nil then ''
-          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
 
@@ -255,6 +174,11 @@ module RSpec
           true
         end
 
+        # @private
+        def supports_value_expectations?
+          false
+        end
+
       private
 
         def positive_failure_reason
@@ -317,6 +241,11 @@ module RSpec
           true
         end
 
+        # @private
+        def supports_value_expectations?
+          false
+        end
+
       private
 
         def positive_failure_reason
@@ -414,6 +343,11 @@ module RSpec
           true
         end
 
+        # @private
+        def supports_value_expectations?
+          false
+        end
+
       private
 
         def expected_arg_description

data/lib/rspec/matchers/built_in.rb

@@ -16,8 +16,9 @@ module RSpec
       autoload :Be,                      'rspec/matchers/built_in/be'
       autoload :BeComparedTo,            'rspec/matchers/built_in/be'
       autoload :BeFalsey,                'rspec/matchers/built_in/be'
+      autoload :BeHelpers,               'rspec/matchers/built_in/be'
       autoload :BeNil,                   'rspec/matchers/built_in/be'
-      autoload :BePredicate,             'rspec/matchers/built_in/be'
+      autoload :BePredicate,             'rspec/matchers/built_in/has'
       autoload :BeTruthy,                'rspec/matchers/built_in/be'
       autoload :BeWithin,                'rspec/matchers/built_in/be_within'
       autoload :Change,                  'rspec/matchers/built_in/change'

data/lib/rspec/matchers/dsl.rb

@@ -403,6 +403,10 @@ module RSpec
           false
         end
 
+        def supports_value_expectations?
+          true
+        end
+
         # Most matchers do not expect call stack jumps.
         def expects_call_stack_jump?
           false

data/lib/rspec/matchers/matcher_protocol.rb

@@ -60,6 +60,12 @@ module RSpec
       #   @return [Boolean] true if this matcher can be used in block expressions.
       #   @note If not defined, RSpec assumes a value of `false` for this method.
 
+      # @!method supports_value_expectations?
+      #   Indicates that this matcher can be used in a value expectation expression,
+      #   such as `expect(foo).to eq(bar)`.
+      #   @return [Boolean] true if this matcher can be used in value expressions.
+      #   @note If not defined, RSpec assumes a value of `true` for this method.
+
       # @!method expects_call_stack_jump?
       #   Indicates that when this matcher is used in a block expectation
       #   expression, it expects the block to use a ruby construct that causes

data/lib/rspec/matchers.rb

@@ -316,9 +316,9 @@ module RSpec
     def be_falsey
       BuiltIn::BeFalsey.new
     end
-    alias_matcher :be_falsy,       :be_falsey
+    alias_matcher :be_falsy, :be_falsey
     alias_matcher :a_falsey_value, :be_falsey
-    alias_matcher :a_falsy_value,  :be_falsey
+    alias_matcher :a_falsy_value, :be_falsey
 
     # Passes if actual is nil
     def be_nil
@@ -379,7 +379,7 @@ module RSpec
       BuiltIn::BeAKindOf.new(expected)
     end
     alias_method :be_kind_of, :be_a_kind_of
-    alias_matcher :a_kind_of,  :be_a_kind_of
+    alias_matcher :a_kind_of, :be_a_kind_of
 
     # Passes if actual.between?(min, max). Works with any Comparable object,
     # including String, Symbol, Time, or Numeric (Fixnum, Bignum, Integer,
@@ -406,7 +406,7 @@ module RSpec
       BuiltIn::BeWithin.new(delta)
     end
     alias_matcher :a_value_within, :be_within
-    alias_matcher :within,         :be_within
+    alias_matcher :within, :be_within
 
     # Applied to a proc, specifies that its execution will cause some value to
     # change.
@@ -492,8 +492,8 @@ module RSpec
     def change(receiver=nil, message=nil, &block)
       BuiltIn::Change.new(receiver, message, &block)
     end
-    alias_matcher :a_block_changing,  :change
-    alias_matcher :changing,          :change
+    alias_matcher :a_block_changing, :change
+    alias_matcher :changing, :change
 
     # Passes if actual contains all of the expected regardless of order.
     # This works for collections. Pass in multiple args and it will only
@@ -511,7 +511,7 @@ module RSpec
       BuiltIn::ContainExactly.new(items)
     end
     alias_matcher :a_collection_containing_exactly, :contain_exactly
-    alias_matcher :containing_exactly,              :contain_exactly
+    alias_matcher :containing_exactly, :contain_exactly
 
     # Passes if actual covers expected. This works for
     # Ranges. You can also pass in multiple args
@@ -529,7 +529,7 @@ module RSpec
       BuiltIn::Cover.new(*values)
     end
     alias_matcher :a_range_covering, :cover
-    alias_matcher :covering,         :cover
+    alias_matcher :covering, :cover
 
     # Matches if the actual value ends with the expected value(s). In the case
     # of a string, matches against the last `expected.length` characters of the
@@ -544,8 +544,8 @@ module RSpec
       BuiltIn::EndWith.new(*expected)
     end
     alias_matcher :a_collection_ending_with, :end_with
-    alias_matcher :a_string_ending_with,     :end_with
-    alias_matcher :ending_with,              :end_with
+    alias_matcher :a_string_ending_with, :end_with
+    alias_matcher :ending_with, :end_with
 
     # Passes if <tt>actual == expected</tt>.
     #
@@ -559,7 +559,7 @@ module RSpec
       BuiltIn::Eq.new(expected)
     end
     alias_matcher :an_object_eq_to, :eq
-    alias_matcher :eq_to,           :eq
+    alias_matcher :eq_to, :eq
 
     # Passes if `actual.eql?(expected)`
     #
@@ -573,7 +573,7 @@ module RSpec
       BuiltIn::Eql.new(expected)
     end
     alias_matcher :an_object_eql_to, :eql
-    alias_matcher :eql_to,           :eql
+    alias_matcher :eql_to, :eql
 
     # Passes if <tt>actual.equal?(expected)</tt> (object identity).
     #
@@ -587,7 +587,7 @@ module RSpec
       BuiltIn::Equal.new(expected)
     end
     alias_matcher :an_object_equal_to, :equal
-    alias_matcher :equal_to,           :equal
+    alias_matcher :equal_to, :equal
 
     # Passes if `actual.exist?` or `actual.exists?`
     #
@@ -597,7 +597,7 @@ module RSpec
       BuiltIn::Exist.new(*args)
     end
     alias_matcher :an_object_existing, :exist
-    alias_matcher :existing,           :exist
+    alias_matcher :existing, :exist
 
     # Passes if actual's attribute values match the expected attributes hash.
     # This works no matter how you define your attribute readers.
@@ -617,7 +617,7 @@ module RSpec
       BuiltIn::HaveAttributes.new(expected)
     end
     alias_matcher :an_object_having_attributes, :have_attributes
-    alias_matcher :having_attributes,           :have_attributes
+    alias_matcher :having_attributes, :have_attributes
 
     # Passes if actual includes expected. This works for
     # collections and Strings. You can also pass in multiple args
@@ -640,9 +640,9 @@ module RSpec
       BuiltIn::Include.new(*expected)
     end
     alias_matcher :a_collection_including, :include
-    alias_matcher :a_string_including,     :include
-    alias_matcher :a_hash_including,       :include
-    alias_matcher :including,              :include
+    alias_matcher :a_string_including, :include
+    alias_matcher :a_hash_including, :include
+    alias_matcher :including, :include
 
     # Passes if the provided matcher passes when checked against all
     # elements of the collection.
@@ -697,10 +697,10 @@ module RSpec
     def match(expected)
       BuiltIn::Match.new(expected)
     end
-    alias_matcher :match_regex,        :match
+    alias_matcher :match_regex, :match
     alias_matcher :an_object_matching, :match
-    alias_matcher :a_string_matching,  :match
-    alias_matcher :matching,           :match
+    alias_matcher :a_string_matching, :match
+    alias_matcher :matching, :match
 
     # An alternate form of `contain_exactly` that accepts
     # the expected contents as a single array arg rather
@@ -761,20 +761,22 @@ module RSpec
     #   expect { do_something_risky }.to raise_error
     #   expect { do_something_risky }.to raise_error(PoorRiskDecisionError)
     #   expect { do_something_risky }.to raise_error(PoorRiskDecisionError) { |error| expect(error.data).to eq 42 }
+    #   expect { do_something_risky }.to raise_error { |error| expect(error.data).to eq 42 }
     #   expect { do_something_risky }.to raise_error(PoorRiskDecisionError, "that was too risky")
     #   expect { do_something_risky }.to raise_error(PoorRiskDecisionError, /oo ri/)
+    #   expect { do_something_risky }.to raise_error("that was too risky")
     #
     #   expect { do_something_risky }.not_to raise_error
-    def raise_error(error=nil, message=nil, &block)
+    def raise_error(error=BuiltIn::RaiseError::UndefinedValue, message=nil, &block)
       BuiltIn::RaiseError.new(error, message, &block)
     end
-    alias_method :raise_exception,  :raise_error
+    alias_method :raise_exception, :raise_error
 
-    alias_matcher :a_block_raising,  :raise_error do |desc|
+    alias_matcher :a_block_raising, :raise_error do |desc|
       desc.sub("raise", "a block raising")
     end
 
-    alias_matcher :raising,        :raise_error do |desc|
+    alias_matcher :raising, :raise_error do |desc|
       desc.sub("raise", "raising")
     end
 
@@ -788,7 +790,7 @@ module RSpec
       BuiltIn::RespondTo.new(*names)
     end
     alias_matcher :an_object_responding_to, :respond_to
-    alias_matcher :responding_to,           :respond_to
+    alias_matcher :responding_to, :respond_to
 
     # Passes if the submitted block returns true. Yields target to the
     # block.
@@ -809,7 +811,7 @@ module RSpec
       BuiltIn::Satisfy.new(description, &block)
     end
     alias_matcher :an_object_satisfying, :satisfy
-    alias_matcher :satisfying,           :satisfy
+    alias_matcher :satisfying, :satisfy
 
     # Matches if the actual value starts with the expected value(s). In the
     # case of a string, matches against the first `expected.length` characters
@@ -824,8 +826,8 @@ module RSpec
       BuiltIn::StartWith.new(*expected)
     end
     alias_matcher :a_collection_starting_with, :start_with
-    alias_matcher :a_string_starting_with,     :start_with
-    alias_matcher :starting_with,              :start_with
+    alias_matcher :a_string_starting_with, :start_with
+    alias_matcher :starting_with, :start_with
 
     # Given no argument, matches if a proc throws any Symbol.
     #
@@ -850,7 +852,7 @@ module RSpec
       desc.sub("throw", "a block throwing")
     end
 
-    alias_matcher :throwing,        :throw_symbol do |desc|
+    alias_matcher :throwing, :throw_symbol do |desc|
       desc.sub("throw", "throwing")
     end
 
@@ -866,8 +868,8 @@ module RSpec
     def yield_control
       BuiltIn::YieldControl.new
     end
-    alias_matcher :a_block_yielding_control,  :yield_control
-    alias_matcher :yielding_control,          :yield_control
+    alias_matcher :a_block_yielding_control, :yield_control
+    alias_matcher :yielding_control, :yield_control
 
     # Passes if the method called in the expect block yields with
     # no arguments. Fails if it does not yield, or yields with arguments.
@@ -884,8 +886,8 @@ module RSpec
     def yield_with_no_args
       BuiltIn::YieldWithNoArgs.new
     end
-    alias_matcher :a_block_yielding_with_no_args,  :yield_with_no_args
-    alias_matcher :yielding_with_no_args,          :yield_with_no_args
+    alias_matcher :a_block_yielding_with_no_args, :yield_with_no_args
+    alias_matcher :yielding_with_no_args, :yield_with_no_args
 
     # Given no arguments, matches if the method called in the expect
     # block yields with arguments (regardless of what they are or how
@@ -914,8 +916,8 @@ module RSpec
     def yield_with_args(*args)
       BuiltIn::YieldWithArgs.new(*args)
     end
-    alias_matcher :a_block_yielding_with_args,  :yield_with_args
-    alias_matcher :yielding_with_args,          :yield_with_args
+    alias_matcher :a_block_yielding_with_args, :yield_with_args
+    alias_matcher :yielding_with_args, :yield_with_args
 
     # Designed for use with methods that repeatedly yield (such as
     # iterators). Passes if the method called in the expect block yields
@@ -935,8 +937,8 @@ module RSpec
     def yield_successive_args(*args)
       BuiltIn::YieldSuccessiveArgs.new(*args)
     end
-    alias_matcher :a_block_yielding_successive_args,  :yield_successive_args
-    alias_matcher :yielding_successive_args,          :yield_successive_args
+    alias_matcher :a_block_yielding_successive_args, :yield_successive_args
+    alias_matcher :yielding_successive_args, :yield_successive_args
 
     # Delegates to {RSpec::Expectations.configuration}.
     # This is here because rspec-core's `expect_with` option
@@ -949,7 +951,7 @@ module RSpec
 
   private
 
-    BE_PREDICATE_REGEX = /^(be_(?:an?_)?)(.*)/
+    BE_PREDICATE_REGEX = /^(?:be_(?:an?_)?)(.*)/
     HAS_REGEX = /^(?:have_)(.*)/
     DYNAMIC_MATCHER_REGEX = Regexp.union(BE_PREDICATE_REGEX, HAS_REGEX)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-expectations
 version: !ruby/object:Gem::Version
-  version: 3.9.4
+  version: 3.11.0
 platform: ruby
 authors:
 - Steven Baker
@@ -45,7 +45,7 @@ cert_chain:
   ZsVDj6a7lH3cNqtWXZxrb2wO38qV5AkYj8SQK7Hj3/Yui9myUX3crr+PdetazSqQ
   F3MdtaDehhjC
   -----END CERTIFICATE-----
-date: 2020-10-29 00:00:00.000000000 Z
+date: 2022-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-support
@@ -53,14 +53,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: 3.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: 3.11.0
 - !ruby/object:Gem::Dependency
   name: diff-lcs
   requirement: !ruby/object:Gem::Requirement
@@ -99,14 +99,14 @@ dependencies:
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
@@ -172,6 +172,7 @@ files:
 - lib/rspec/matchers/built_in/change.rb
 - lib/rspec/matchers/built_in/compound.rb
 - lib/rspec/matchers/built_in/contain_exactly.rb
+- lib/rspec/matchers/built_in/count_expectation.rb
 - lib/rspec/matchers/built_in/cover.rb
 - lib/rspec/matchers/built_in/eq.rb
 - lib/rspec/matchers/built_in/eql.rb
@@ -202,7 +203,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rspec/rspec-expectations/issues
-  changelog_uri: https://github.com/rspec/rspec-expectations/blob/v3.9.4/Changelog.md
+  changelog_uri: https://github.com/rspec/rspec-expectations/blob/v3.11.0/Changelog.md
   documentation_uri: https://rspec.info/documentation/
   mailing_list_uri: https://groups.google.com/forum/#!forum/rspec
   source_code_uri: https://github.com/rspec/rspec-expectations
@@ -222,8 +223,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
-summary: rspec-expectations-3.9.4
+summary: rspec-expectations-3.11.0
 test_files: []