rspec-mocks 3.8.2 → 3.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 863a1af1be0ed566b9345a1bdb9ec999137b959e8612b102d6af6e8b43ecd001
-  data.tar.gz: 01f7282d03cea9cf658c3ada9bb008d7ab9f3d60313e092b9709a0b0e28685b3
+  metadata.gz: 8df50d671b287d9eea08c7e0af0cc98ae18da52ce63543c0e48378d4230a889f
+  data.tar.gz: 0e8e4186d4eefc8344439185e0533a53b980fd983f80d8faf600c5fe7f5ebf2d
 SHA512:
-  metadata.gz: 218a26419d38c53216a2c5a0275296b1c70239a240e0de6bc7cfbd8d837e703e2e1bd424fe11829400d7182c7f88a6d9690f4851f9883b8c87da6ae9c7e88378
-  data.tar.gz: 4c746074ce149784310c2aec5b7d0ba5939106a07bcd23ba8b9d917756cd99c849a7befdd052c71b241fc21c066a337e0c1fb286442cb4099d2b72e2729315d8
+  metadata.gz: 0b687302ef0bd48764d9b78df91c0ce9f4918e9697493fbf0d4083f77ac4bd99879a68975bca874b06a887d1f83bcaaca35f476d4a4036286684c37bb3e040c6
+  data.tar.gz: 102e13e93f56865812cf40a46e3be075f67984dde3eaae091b3b14ffae2c96623f6c2e85112c6ffe759fc7be83c4ba8d0133b59fa91d5d0a3055307dc5c13273

data/Changelog.md

@@ -1,3 +1,56 @@
+### Development
+[Full Changelog](http://github.com/rspec/rspec-mocks/compare/v3.10.2...main)
+
+### 3.10.2 / 2021-01-27
+[Full Changelog](http://github.com/rspec/rspec-mocks/compare/v3.10.1...v3.10.2)
+
+Bug Fixes:
+
+* Support keyword arguments with `and_call_original` on Ruby 3.0.
+  (Bryan Powell, #1385)
+* `RSpec::Mocks::Constant#previously_defined?` is now always a boolean.
+  (Phil Pirozhkov, #1397)
+* Support keyword arguments on Ruby 3.0 when used with `expect_any_instance_of`
+  or `allow_any_instance_of` with `and_call_original`.
+  (Jess Hottenstein, #1407)
+
+### 3.10.1 / 2020-12-27
+[Full Changelog](http://github.com/rspec/rspec-mocks/compare/v3.10.0...v3.10.1)
+
+Bug Fixes:
+
+* Issue `ArgumentError` rather than `TypeError` when unsupported methods on
+  unsupported objects are attempted to be stubbed. (@zhisme, #1357)
+
+### 3.10.0 / 2020-10-30
+[Full Changelog](http://github.com/rspec/rspec-mocks/compare/v3.9.1...v3.10.0)
+
+Enhancements:
+* Add the ability to set a custom error generator in `MessageExpectation`.
+  This will allow rspec-expectations to inject a custom failure message.
+  (Benoit Tigeot and Nicolas Zermati, #1312)
+* Return the result of the block passed to `RSpec::Mocks.with_temporary_scope`
+  when block run. (@expeehaa, #1329)
+
+### 3.9.1 / 2019-12-31
+[Full Changelog](http://github.com/rspec/rspec-mocks/compare/v3.9.0...v3.9.1)
+
+Bug Fixes:
+
+* Trigger `RSpec::Mocks.configuration.verifying_double_callbacks` when using
+  `allow_any_instance_of` or `expect_any_instance_of` (Daniel Orner, #1309)
+
+### 3.9.0 / 2019-10-07
+[Full Changelog](http://github.com/rspec/rspec-mocks/compare/v3.8.2...v3.9.0)
+
+Enhancements:
+
+* Improve thread safety of message expectations by using Mutex to prevent
+  deadlocking errors. (Ry Biesemeyer, #1236)
+* Add the ability to use `time` as an alias for `times`. For example:
+  `expect(Class).to receive(:method).exactly(1).time`.
+  (Pistos, Benoit Tigeot, #1271)
+
 ### 3.8.2 / 2019-10-02
 [Full Changelog](http://github.com/rspec/rspec-mocks/compare/v3.8.1...v3.8.2)
 

data/README.md

@@ -1,4 +1,4 @@
-# RSpec Mocks [![Build Status](https://secure.travis-ci.org/rspec/rspec-mocks.svg?branch=master)](http://travis-ci.org/rspec/rspec-mocks) [![Code Climate](https://codeclimate.com/github/rspec/rspec-mocks.svg)](https://codeclimate.com/github/rspec/rspec-mocks)
+# RSpec Mocks [![Build Status](https://github.com/rspec/rspec-mocks/workflows/RSpec%20CI/badge.svg?branch=3-10-maintenance)](https://github.com/rspec/rspec-mocks/actions) [![Code Climate](https://codeclimate.com/github/rspec/rspec-mocks.svg)](https://codeclimate.com/github/rspec/rspec-mocks)
 rspec-mocks is a test-double framework for rspec with support for method stubs,
 fakes, and message expectations on generated test-doubles and real objects
 alike.
@@ -8,12 +8,12 @@ alike.
     gem install rspec       # for rspec-core, rspec-expectations, rspec-mocks
     gem install rspec-mocks # for rspec-mocks only
 
-Want to run against the `master` branch? You'll need to include the dependent
+Want to run against the `main` branch? You'll need to include the dependent
 RSpec repos as well. Add the following to your `Gemfile`:
 
 ```ruby
 %w[rspec-core rspec-expectations rspec-mocks rspec-support].each do |lib|
-  gem lib, :git => "https://github.com/rspec/#{lib}.git", :branch => 'master'
+  gem lib, :git => "https://github.com/rspec/#{lib}.git", :branch => 'main'
 end
 ```
 ## Contributing
@@ -53,7 +53,7 @@ book = instance_double("Book", :pages => 250)
 Verifying doubles have some clever tricks to enable you to both test in
 isolation without your dependencies loaded while still being able to validate
 them against real objects. More detail is available in [their
-documentation](https://github.com/rspec/rspec-mocks/blob/master/features/verifying_doubles).
+documentation](https://github.com/rspec/rspec-mocks/blob/main/features/verifying_doubles).
 
 Verifying doubles can also accept custom identifiers, just like double(), e.g.:
 
@@ -285,12 +285,15 @@ expect(double).to receive(:msg).with(hash_excluding(:a => 5)) # first arg is a h
 ```ruby
 expect(double).to receive(:msg).once
 expect(double).to receive(:msg).twice
+expect(double).to receive(:msg).exactly(n).time
 expect(double).to receive(:msg).exactly(n).times
 expect(double).to receive(:msg).at_least(:once)
 expect(double).to receive(:msg).at_least(:twice)
+expect(double).to receive(:msg).at_least(n).time
 expect(double).to receive(:msg).at_least(n).times
 expect(double).to receive(:msg).at_most(:once)
 expect(double).to receive(:msg).at_most(:twice)
+expect(double).to receive(:msg).at_most(n).time
 expect(double).to receive(:msg).at_most(n).times
 ```
 
@@ -327,7 +330,7 @@ expect(double).to receive(:msg).and_return(value)
 expect(double).to receive(:msg).exactly(3).times.and_return(value1, value2, value3)
   # returns value1 the first time, value2 the second, etc
 expect(double).to receive(:msg).and_raise(error)
-  # error can be an instantiated object or a class
+  # `error` can be an instantiated object (e.g. `StandardError.new(some_arg)`) or a class (e.g. `StandardError`)
   # if it is a class, it must be instantiable with no args
 expect(double).to receive(:msg).and_throw(:msg)
 expect(double).to receive(:msg).and_yield(values, to, yield)
@@ -400,7 +403,7 @@ your code.
 ## Stubbing and Hiding Constants
 
 See the [mutating constants
-README](https://github.com/rspec/rspec-mocks/blob/master/features/mutating_constants/README.md)
+README](https://github.com/rspec/rspec-mocks/blob/main/features/mutating_constants/README.md)
 for info on this feature.
 
 ## Use `before(:example)`, not `before(:context)`

data/lib/rspec/mocks.rb

@@ -87,12 +87,15 @@ module RSpec
 
     # Call the passed block and verify mocks after it has executed. This allows
     # mock usage in arbitrary places, such as a `before(:all)` hook.
+    #
+    # @return [Object] the return value from the block
     def self.with_temporary_scope
       setup
 
       begin
-        yield
+        result = yield
         verify
+        result
       ensure
         teardown
       end

data/lib/rspec/mocks/any_instance/chain.rb

@@ -41,6 +41,7 @@ module RSpec
           record :thrice
           record :exactly
           record :times
+          record :time
           record :never
           record :at_least
           record :at_most

data/lib/rspec/mocks/any_instance/recorder.rb

@@ -21,6 +21,11 @@ module RSpec
           @backed_up_method_owner = {}
           @klass = klass
           @expectation_set = false
+
+          return unless RSpec::Mocks.configuration.verify_partial_doubles?
+          RSpec::Mocks.configuration.verifying_double_callbacks.each do |block|
+            block.call(ObjectReference.for(klass))
+          end
         end
 
         # Initializes the recording a stub to be played back against any
@@ -256,6 +261,7 @@ module RSpec
             recorder.playback!(self, method_name)
             __send__(method_name, *args, &blk)
           end
+          @klass.__send__(:ruby2_keywords, method_name) if @klass.respond_to?(:ruby2_keywords, true)
         end
 
         def mark_invoked!(method_name)

data/lib/rspec/mocks/matchers/have_received.rb

@@ -5,7 +5,7 @@ module RSpec
       class HaveReceived
         include Matcher
 
-        COUNT_CONSTRAINTS = %w[exactly at_least at_most times once twice thrice]
+        COUNT_CONSTRAINTS = %w[exactly at_least at_most times time once twice thrice]
         ARGS_CONSTRAINTS = %w[with]
         CONSTRAINTS = COUNT_CONSTRAINTS + ARGS_CONSTRAINTS + %w[ordered]
 

data/lib/rspec/mocks/message_expectation.rb

@@ -1,3 +1,5 @@
+RSpec::Support.require_rspec_support 'mutex'
+
 module RSpec
   module Mocks
     # A message expectation that only allows concrete return values to be set
@@ -236,6 +238,7 @@ module RSpec
         self.inner_implementation_action = block
         self
       end
+      alias time times
 
       # Expect a message not to be received at all.
       #
@@ -357,12 +360,13 @@ module RSpec
       # some collaborators it delegates to for this stuff but for now this was
       # the simplest way to split the public from private stuff to make it
       # easier to publish the docs for the APIs we want published.
+      # rubocop:disable Metrics/ModuleLength
       module ImplementationDetails
         attr_accessor :error_generator, :implementation
         attr_reader :message
         attr_reader :orig_object
         attr_writer :expected_received_count, :expected_from, :argument_list_matcher
-        protected :expected_received_count=, :expected_from=, :error_generator, :error_generator=, :implementation=
+        protected :expected_received_count=, :expected_from=, :error_generator=, :implementation=
 
         # @private
         attr_reader :type
@@ -372,12 +376,13 @@ module RSpec
                        type=:expectation, opts={}, &implementation_block)
           @type = type
           @error_generator = error_generator
-          @error_generator.opts = opts
+          @error_generator.opts = error_generator.opts.merge(opts)
           @expected_from = expected_from
           @method_double = method_double
           @orig_object = @method_double.object
           @message = @method_double.method_name
           @actual_received_count = 0
+          @actual_received_count_write_mutex = Support::Mutex.new
           @expected_received_count = type == :expectation ? 1 : :any
           @argument_list_matcher = ArgumentListMatcher::MATCH_ALL
           @order_group = expectation_ordering
@@ -536,7 +541,9 @@ module RSpec
         end
 
         def increase_actual_received_count!
-          @actual_received_count += 1
+          @actual_received_count_write_mutex.synchronize do
+            @actual_received_count += 1
+          end
         end
 
       private
@@ -567,7 +574,9 @@ module RSpec
             parent_stub.invoke(nil, *args, &block)
           end
         ensure
-          @actual_received_count += increment
+          @actual_received_count_write_mutex.synchronize do
+            @actual_received_count += increment
+          end
         end
 
         def has_been_invoked?
@@ -626,6 +635,7 @@ module RSpec
           nil
         end
       end
+      # rubocop:enable Metrics/ModuleLength
 
       include ImplementationDetails
     end

data/lib/rspec/mocks/method_double.rb

@@ -63,6 +63,7 @@ module RSpec
           define_method(method_name) do |*args, &block|
             method_double.proxy_method_invoked(self, *args, &block)
           end
+          ruby2_keywords(method_name) if Module.private_method_defined?(:ruby2_keywords)
           __send__(visibility, method_name)
         end
 

data/lib/rspec/mocks/mutate_const.rb

@@ -66,7 +66,7 @@ module RSpec
 
       # @private
       def self.unmutated(name)
-        previously_defined = recursive_const_defined?(name)
+        previously_defined = !!recursive_const_defined?(name)
       rescue NameError
         new(name) do |c|
           c.valid_name = false

data/lib/rspec/mocks/proxy.rb

@@ -9,6 +9,11 @@ module RSpec
         end
       end
 
+      unless defined?(Mutex)
+        Support.require_rspec_support 'mutex'
+        Mutex = Support::Mutex
+      end
+
       # @private
       def ensure_implemented(*_args)
         # noop for basic proxies, see VerifyingProxy for behaviour.
@@ -16,15 +21,32 @@ module RSpec
 
       # @private
       def initialize(object, order_group, options={})
+        ensure_can_be_proxied!(object)
+
         @object = object
         @order_group = order_group
         @error_generator = ErrorGenerator.new(object)
         @messages_received = []
+        @messages_received_mutex = Mutex.new
         @options = options
         @null_object = false
         @method_doubles = Hash.new { |h, k| h[k] = MethodDouble.new(@object, k, self) }
       end
 
+      # @private
+      def ensure_can_be_proxied!(object)
+        return unless object.is_a?(Symbol) || object.frozen?
+        return if object.nil?
+
+        msg = "Cannot proxy frozen objects"
+        if Symbol === object
+          msg << ". Symbols such as #{object} cannot be mocked or stubbed."
+        else
+          msg << ", rspec-mocks relies on proxies for method stubbing and expectations."
+        end
+        raise ArgumentError, msg
+      end
+
       # @private
       attr_reader :object
 
@@ -90,27 +112,31 @@ module RSpec
           @error_generator.raise_expectation_on_unstubbed_method(expected_method_name)
         end
 
-        @messages_received.each do |(actual_method_name, args, received_block)|
-          next unless expectation.matches?(actual_method_name, *args)
+        @messages_received_mutex.synchronize do
+          @messages_received.each do |(actual_method_name, args, received_block)|
+            next unless expectation.matches?(actual_method_name, *args)
 
-          expectation.safe_invoke(nil)
-          block.call(*args, &received_block) if block
+            expectation.safe_invoke(nil)
+            block.call(*args, &received_block) if block
+          end
         end
       end
 
       # @private
       def check_for_unexpected_arguments(expectation)
-        return if @messages_received.empty?
+        @messages_received_mutex.synchronize do
+          return if @messages_received.empty?
 
-        return if @messages_received.any? { |method_name, args, _| expectation.matches?(method_name, *args) }
+          return if @messages_received.any? { |method_name, args, _| expectation.matches?(method_name, *args) }
 
-        name_but_not_args, others = @messages_received.partition do |(method_name, args, _)|
-          expectation.matches_name_but_not_args(method_name, *args)
-        end
+          name_but_not_args, others = @messages_received.partition do |(method_name, args, _)|
+            expectation.matches_name_but_not_args(method_name, *args)
+          end
 
-        return if name_but_not_args.empty? && !others.empty?
+          return if name_but_not_args.empty? && !others.empty?
 
-        expectation.raise_unexpected_message_args_error(name_but_not_args.map { |args| args[1] })
+          expectation.raise_unexpected_message_args_error(name_but_not_args.map { |args| args[1] })
+        end
       end
 
       # @private
@@ -141,17 +167,23 @@ module RSpec
 
       # @private
       def reset
-        @messages_received.clear
+        @messages_received_mutex.synchronize do
+          @messages_received.clear
+        end
       end
 
       # @private
       def received_message?(method_name, *args, &block)
-        @messages_received.any? { |array| array == [method_name, args, block] }
+        @messages_received_mutex.synchronize do
+          @messages_received.any? { |array| array == [method_name, args, block] }
+        end
       end
 
       # @private
       def messages_arg_list
-        @messages_received.map { |_, args, _| args }
+        @messages_received_mutex.synchronize do
+          @messages_received.map { |_, args, _| args }
+        end
       end
 
       # @private
@@ -162,7 +194,9 @@ module RSpec
       # @private
       def record_message_received(message, *args, &block)
         @order_group.invoked SpecificMessage.new(object, message, args)
-        @messages_received << [message, args, block]
+        @messages_received_mutex.synchronize do
+          @messages_received << [message, args, block]
+        end
       end
 
       # @private

data/lib/rspec/mocks/version.rb

@@ -3,7 +3,7 @@ module RSpec
     # Version information for RSpec mocks.
     module Version
       # Version of RSpec mocks currently in use in SemVer format.
-      STRING = '3.8.2'
+      STRING = '3.10.2'
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rspec-mocks
 version: !ruby/object:Gem::Version
-  version: 3.8.2
+  version: 3.10.2
 platform: ruby
 authors:
 - Steven Baker
 - David Chelimsky
 - Myron Marston
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -45,7 +45,7 @@ cert_chain:
   ZsVDj6a7lH3cNqtWXZxrb2wO38qV5AkYj8SQK7Hj3/Yui9myUX3crr+PdetazSqQ
   F3MdtaDehhjC
   -----END CERTIFICATE-----
-date: 2019-10-02 00:00:00.000000000 Z
+date: 2021-01-28 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.8.0
+        version: 3.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
   name: diff-lcs
   requirement: !ruby/object:Gem::Requirement
@@ -85,14 +85,14 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: 10.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: 10.0.0
 - !ruby/object:Gem::Dependency
@@ -194,11 +194,11 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rspec/rspec-mocks/issues
-  changelog_uri: https://github.com/rspec/rspec-mocks/blob/v3.8.2/Changelog.md
+  changelog_uri: https://github.com/rspec/rspec-mocks/blob/v3.10.2/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-mocks
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -214,8 +214,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.4
+signing_key:
 specification_version: 4
-summary: rspec-mocks-3.8.2
+summary: rspec-mocks-3.10.2
 test_files: []