rspec-mocks 3.1.3 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8967bb910d6e9e42450e14ac9ce3fd37b078ba5e
-  data.tar.gz: e05cfe6e3b29c252f091de7f562e3b2424a14a1c
+  metadata.gz: 23676d8c392cc0e21a6fc7fdec5248f084775150
+  data.tar.gz: fbaf8723ad0840c4da3dc8c6cc21093d2bd2f1c7
 SHA512:
-  metadata.gz: 72a62c1548028c0517d412fdd5b62bd8047135a6a25696f180df864b9cc4e0332be07f29290888fe1375afa7de822e404f36d6111e83ab739dee57cbf5676c17
-  data.tar.gz: 496c5678781c6c5f14a3d929521f3e57698a28bf25766efd67eb5d918f93c108467228636275fbedbf71a34b56d28acb001ce47a6bd215cf74bb28e465b28b39
+  metadata.gz: 2563565823fee6d8c5f0a3358af1fb0ed0a12d77f1128c82bcae6d3583cfdd7206d59dfbf2d0213d10ce10c5a480b31317b92194586c0ce7e1fb800e4e8b95c5
+  data.tar.gz: 00664f4764abbf01ab4c93986454c1d7582abba0fefc378f5abf1a4908fc2e66028242565843377b53e4f58310937d8c7c4747a2b961c9009e36774be83a4e62

data.tar.gz.sig

@@ -1,3 +1,5 @@
-�V��F��W��S��
-r6�5Vr�����m}�[��?�j5�w��b�<:n��1�Ҝl�9K(%p��6��wx��-Z����ڃm��������D�L����t7a����6I��~�>��p
%]` �ՅN����앻��rz��q��w�㟢Ra�hؑj
-"�E�DL��v�g�G.QR�Óc�nJ�,��j{4�)�qNJ+�)Dg�N�2���&%��w�ׯ��#a
+*�$���W��_��Y�&Q�H$$Y"p+@�΢@�ڟ�TO�@��.7ીu�[�d�}�)�5˸p���\��p������B�f�j��w��K�|�)�K{bC�
+b��h�l?Ս�)qx���ٮ�eXIY�ё�ء"�o��E��P������<�U�}�yf�罣���[�ܲx
+Mc�l�|��
+�ި�7�=63[?�����;�[\���x�Jɸn@��@�ʎ���x�*�=O��h�;�%��Ya^R�M/��n�*o�W�$Ze�dR�%�=
+�������#��y� �����1ʔ��t�"�2� *(C������8+�r�=�M

data/Changelog.md

@@ -1,3 +1,59 @@
+### 3.2.0 / 2015-02-03
+[Full Changelog](http://github.com/rspec/rspec-mocks/compare/v3.1.3...v3.2.0)
+
+Enhancements:
+
+* Treat `any_args` as an arg splat, allowing it to match an arbitrary
+  number of args at any point in an arg list. (Myron Marston, #786)
+* Print diffs when arguments in mock expectations are mismatched.
+  (Sam Phippen, #751)
+* Support names for verified doubles (`instance_double`, `instance_spy`,
+  `class_double`, `class_spy`, `object_double`, `object_spy`). (Cezary
+  Baginski, #826)
+* Make `array_including` and `hash_including` argument matchers composable.
+  (Sam Phippen, #819)
+* Make `allow_any_instance_of(...).to receive(...).and_wrap_original`
+  work. (Ryan Fitzgerald, #869)
+
+Bug Fixes:
+
+* Provide a clear error when users wrongly combine `no_args` with
+  additional arguments (e.g. `expect().to receive().with(no_args, 1)`).
+  (Myron Marston, #786)
+* Provide a clear error when users wrongly use `any_args` multiple times in the
+  same argument list (e.g. `expect().to receive().with(any_args, 1, any_args)`.
+  (Myron Marston, #786)
+* Prevent the error generator from using user object #description methods.
+  See [#685](https://github.com/rspec/rspec-mocks/issues/685).
+  (Sam Phippen, #751)
+* Make verified doubles declared as `(instance|class)_double(SomeConst)`
+  work properly when `SomeConst` has previously been stubbed.
+  `(instance|class)_double("SomeClass")` already worked properly.
+  (Myron Marston, #824)
+* Add a matcher description for `receive`, `receive_messages` and
+  `receive_message_chain`. (Myron Marston, #828)
+* Validate invocation args for null object verified doubles.
+  (Myron Marston, #829)
+* Fix `RSpec::Mocks::Constant.original` when called with an invalid
+  constant to return an object indicating the constant name is invalid,
+  rather than blowing up. (Myron Marston, #833)
+* Make `extend RSpec::Mocks::ExampleMethods` on any object work properly
+  to add the rspec-mocks API to that object. Previously, `expect` would
+  be undefined. (Myron Marston, #846)
+* Fix `require 'rspec/mocks/standalone'` so that it only affects `main`
+  and not every object. It's really only intended to be used in a REPL
+  like IRB, but some gems have loaded it, thinking it needs to be loaded
+  when using rspec-mocks outside the context of rspec-core.
+  (Myron Marston, #846)
+* Prevent message expectations from being modified by customization methods
+  (e.g. `with`) after they have been invoked. (Sam Phippen and Melanie Gilman, #837)
+* Handle cases where a method stub cannot be removed due to something
+  external to RSpec monkeying with the method definition. This can
+  happen, for example, when you `file.reopen(io)` after previously
+  stubbing a method on the `file` object. (Myron Marston, #853)
+* Provide a clear error when received message args are mutated before
+  a `have_received(...).with(...)` expectation. (Myron Marston, #868)
+
 ### 3.1.3 / 2014-10-08
 [Full Changelog](http://github.com/rspec/rspec-mocks/compare/v3.1.2...v3.1.3)
 
@@ -48,7 +104,7 @@ Enhancements:
 * Add `and_wrap_original` modifier for partial doubles to mutate the
   response from a method. (Jon Rowe, #762)
 
-Bugfixes:
+Bug Fixes:
 
 * Remove `any_number_of_times` from `any_instance` recorders that were
   erroneously causing mention of the method in documentation. (Jon Rowe, #760)
@@ -240,7 +296,7 @@ Bug Fixes:
   behavior. (Maurício Linhares)
 
 ### 3.0.0.beta1 / 2013-11-07
-[Full Changelog](http://github.com/rspec/rspec-mocks/compare/v2.99.2...v3.0.0.beta1)
+[Full Changelog](http://github.com/rspec/rspec-mocks/compare/v2.99.3...v3.0.0.beta1)
 
 Breaking Changes for 3.0.0:
 
@@ -303,6 +359,13 @@ Bug Fixes:
   returns `nil` or `''` so that you still get a useful message.
   (Nick DeLuca)
 
+### 2.99.3 / 2015-01-09
+[Full Changelog](http://github.com/rspec/rspec-mocks/compare/v2.99.2...v2.99.3)
+
+Bug Fixes:
+
+* Fix regression that caused an error when a test double was deserialized from YAML. (Yuji Nakayama, #777)
+
 ### 2.99.2 / 2014-07-21
 [Full Changelog](http://github.com/rspec/rspec-mocks/compare/v2.99.1...v2.99.2)
 

data/README.md

@@ -1,4 +1,4 @@
-# RSpec Mocks [![Build Status](https://secure.travis-ci.org/rspec/rspec-mocks.png?branch=master)](http://travis-ci.org/rspec/rspec-mocks) [![Code Climate](https://codeclimate.com/github/rspec/rspec-mocks.png)](https://codeclimate.com/github/rspec/rspec-mocks)
+# 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 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,6 +8,15 @@ 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
+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 => "git://github.com/rspec/#{lib}.git", :branch => 'master'
+end
+```
+
 ## Test Doubles
 
 A test double is an object that stands in for another object in your system
@@ -32,6 +41,16 @@ 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).
 
+Verifying doubles can also accept custom identifiers, just like double(), e.g.:
+
+```ruby
+books = []
+books << instance_double("Book", :rspec_book, :pages => 250)
+books << instance_double("Book", "(Untitled)", :pages => 5000)
+
+puts books.inspect # with names, it's clearer which were actually added
+```
+
 ## Method Stubs
 
 A method stub is an implementation that returns a pre-determined value.  Method
@@ -42,7 +61,7 @@ rspec-mocks supports 3 forms for declaring method stubs:
 allow(book).to receive(:title) { "The RSpec Book" }
 allow(book).to receive(:title).and_return("The RSpec Book")
 allow(book).to receive_messages(
-    :title => "The RSpec Book", 
+    :title => "The RSpec Book",
     :subtitle => "Behaviour-Driven Development with RSpec, Cucumber, and Friends")
 ```
 
@@ -206,8 +225,9 @@ rspec-mocks also adds some keyword Symbols that you can use to
 specify certain kinds of arguments:
 
 ```ruby
-expect(double).to receive(:msg).with(no_args())
-expect(double).to receive(:msg).with(any_args())
+expect(double).to receive(:msg).with(no_args)
+expect(double).to receive(:msg).with(any_args)
+expect(double).to receive(:msg).with(1, any_args) # any args acts like an arg splat and can go anywhere
 expect(double).to receive(:msg).with(1, kind_of(Numeric), "b") #2nd argument can be any kind of Numeric
 expect(double).to receive(:msg).with(1, boolean(), "b") #2nd argument can be true or false
 expect(double).to receive(:msg).with(1, /abc/, "b") #2nd argument can be any String matching the submitted Regexp
@@ -366,7 +386,7 @@ general we discourage its use for a number of reasons:
 
 * The `rspec-mocks` API is designed for individual object instances, but this
   feature operates on entire classes of objects. As a result there are some
-  sematically confusing edge cases. For example in
+  semantically confusing edge cases. For example in
   `expect_any_instance_of(Widget).to receive(:name).twice` it isn't clear
   whether each specific instance is expected to receive `name` twice, or if two
   receives total are expected. (It's the former.)

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

@@ -34,6 +34,7 @@ module RSpec
           record :and_throw
           record :and_yield
           record :and_call_original
+          record :and_wrap_original
           record :with
           record :once
           record :twice

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

@@ -31,7 +31,8 @@ module RSpec
             :and_return => [:with, nil],
             :and_raise => [:with, nil],
             :and_yield => [:with, nil],
-            :and_call_original => [:with, nil]
+            :and_call_original => [:with, nil],
+            :and_wrap_original => [:with, nil]
           }
         end
 

data/lib/rspec/mocks/argument_list_matcher.rb

@@ -44,12 +44,7 @@ module RSpec
       # @see #args_match?
       def initialize(*expected_args)
         @expected_args = expected_args
-
-        @matchers = case expected_args.first
-                    when ArgumentMatchers::AnyArgsMatcher then Array
-                    when ArgumentMatchers::NoArgsMatcher  then []
-                    else expected_args
-                    end
+        ensure_expected_args_valid!
       end
 
       # @api public
@@ -60,13 +55,46 @@ module RSpec
       #
       # @see #initialize
       def args_match?(*args)
-        Support::FuzzyMatcher.values_match?(@matchers, args)
+        Support::FuzzyMatcher.values_match?(resolve_expected_args_based_on(args), args)
+      end
+
+      # @private
+      # Resolves abstract arg placeholders like `no_args` and `any_args` into
+      # a more concrete arg list based on the provided `actual_args`.
+      def resolve_expected_args_based_on(actual_args)
+        return [] if [ArgumentMatchers::NoArgsMatcher::INSTANCE] == expected_args
+
+        any_args_index = expected_args.index(ArgumentMatchers::AnyArgsMatcher::INSTANCE)
+        return expected_args unless any_args_index
+
+        replace_any_args_with_splat_of_anything(any_args_index, actual_args.count)
+      end
+
+    private
+
+      def replace_any_args_with_splat_of_anything(before_count, actual_args_count)
+        any_args_count  = actual_args_count   - expected_args.count + 1
+        after_count     = expected_args.count - before_count        - 1
+
+        any_args = 1.upto(any_args_count).map { ArgumentMatchers::AnyArgMatcher::INSTANCE }
+        expected_args.first(before_count) + any_args + expected_args.last(after_count)
+      end
+
+      def ensure_expected_args_valid!
+        if expected_args.count(ArgumentMatchers::AnyArgsMatcher::INSTANCE) > 1
+          raise ArgumentError, "`any_args` can only be passed to " \
+                "`with` once but you have passed it multiple times."
+        elsif expected_args.count > 1 && expected_args.include?(ArgumentMatchers::NoArgsMatcher::INSTANCE)
+          raise ArgumentError, "`no_args` can only be passed as a " \
+                "singleton argument to `with` (i.e. `with(no_args)`), " \
+                "but you have passed additional arguments."
+        end
       end
 
       # Value that will match all argument lists.
       #
       # @private
-      MATCH_ALL = new(ArgumentMatchers::AnyArgsMatcher.new)
+      MATCH_ALL = new(ArgumentMatchers::AnyArgsMatcher::INSTANCE)
     end
   end
 end

data/lib/rspec/mocks/argument_matchers.rb

@@ -14,14 +14,18 @@ module RSpec
     #
     # @see ArgumentListMatcher
     module ArgumentMatchers
-      # Matches any args at all. Supports a more explicit variation of
-      # `expect(object).to receive(:message)`
+      # Acts like an arg splat, matching any number of args at any point in an arg list.
       #
       # @example
       #
-      #   expect(object).to receive(:message).with(any_args)
+      #   expect(object).to receive(:message).with(1, 2, any_args)
+      #
+      #   # matches any of these:
+      #   object.message(1, 2)
+      #   object.message(1, 2, 3)
+      #   object.message(1, 2, 3, 4)
       def any_args
-        AnyArgsMatcher.new
+        AnyArgsMatcher::INSTANCE
       end
 
       # Matches any argument at all.
@@ -30,7 +34,7 @@ module RSpec
       #
       #   expect(object).to receive(:message).with(anything)
       def anything
-        AnyArgMatcher.new
+        AnyArgMatcher::INSTANCE
       end
 
       # Matches no arguments.
@@ -39,7 +43,7 @@ module RSpec
       #
       #   expect(object).to receive(:message).with(no_args)
       def no_args
-        NoArgsMatcher.new
+        NoArgsMatcher::INSTANCE
       end
 
       # Matches if the actual argument responds to the specified messages.
@@ -58,7 +62,7 @@ module RSpec
       #
       #   expect(object).to receive(:message).with(boolean())
       def boolean
-        BooleanMatcher.new
+        BooleanMatcher::INSTANCE
       end
 
       # Matches a hash that includes the specified key(s) or key/value pairs.
@@ -122,19 +126,36 @@ module RSpec
       # @private
       def self.anythingize_lonely_keys(*args)
         hash = args.last.class == Hash ? args.delete_at(-1) : {}
-        args.each { | arg | hash[arg] = AnyArgMatcher.new }
+        args.each { | arg | hash[arg] = AnyArgMatcher::INSTANCE }
         hash
       end
 
+      # Intended to be subclassed by stateless, immutable argument matchers.
+      # Provides a `<klass name>::INSTANCE` constant for accessing a global
+      # singleton instance of the matcher. There is no need to construct
+      # multiple instance since there is no state. It also facilities the
+      # special case logic we need for some of these matchers, by making it
+      # easy to do comparisons like: `[klass::INSTANCE] == args` rather than
+      # `args.count == 1 && klass === args.first`.
+      #
+      # @private
+      class SingletonMatcher
+        private_class_method :new
+
+        def self.inherited(subklass)
+          subklass.const_set(:INSTANCE, subklass.send(:new))
+        end
+      end
+
       # @private
-      class AnyArgsMatcher
+      class AnyArgsMatcher < SingletonMatcher
         def description
-          "any args"
+          "*(any args)"
         end
       end
 
       # @private
-      class AnyArgMatcher
+      class AnyArgMatcher < SingletonMatcher
         def ===(_other)
           true
         end
@@ -145,14 +166,14 @@ module RSpec
       end
 
       # @private
-      class NoArgsMatcher
+      class NoArgsMatcher < SingletonMatcher
         def description
           "no args"
         end
       end
 
       # @private
-      class BooleanMatcher
+      class BooleanMatcher < SingletonMatcher
         def ===(value)
           true == value || false == value
         end
@@ -177,7 +198,20 @@ module RSpec
         end
 
         def description(name)
-          "#{name}(#{@expected.inspect.sub(/^\{/, "").sub(/\}$/, "")})"
+          "#{name}(#{formatted_expected_hash.inspect.sub(/^\{/, "").sub(/\}$/, "")})"
+        end
+
+      private
+
+        def formatted_expected_hash
+          Hash[
+            @expected.map do |k, v|
+              k = RSpec::Support.rspec_description_for_object(k)
+              v = RSpec::Support.rspec_description_for_object(v)
+
+              [k, v]
+            end
+          ]
         end
       end
 
@@ -210,11 +244,24 @@ module RSpec
         end
 
         def ===(actual)
-          Set.new(actual).superset?(Set.new(@expected))
+          actual = actual.uniq
+          @expected.uniq.all? do |expected_element|
+            actual.any? do |actual_element|
+              RSpec::Support::FuzzyMatcher.values_match?(expected_element, actual_element)
+            end
+          end
         end
 
         def description
-          "array_including(#{@expected.join(", ")})"
+          "array_including(#{formatted_expected_values})"
+        end
+
+      private
+
+        def formatted_expected_values
+          @expected.map do |x|
+            RSpec::Support.rspec_description_for_object(x)
+          end.join(", ")
         end
       end
 

data/lib/rspec/mocks/configuration.rb

@@ -104,6 +104,23 @@ module RSpec
       # isolated unit test will prevent you from being able to isolate it!
       attr_writer :verify_doubled_constant_names
 
+      # Provides a way to perform customisations when verifying doubles.
+      #
+      # @example
+      #
+      #  RSpec::Mocks.configuration.when_declaring_verifying_double do |ref|
+      #    ref.some_method!
+      #  end
+      def when_declaring_verifying_double(&block)
+        verifying_double_declaration_callbacks << block
+      end
+
+      # @api private
+      # Returns an array of blocks to call when verifying doubles
+      def verifying_double_declaration_callbacks
+        @verifying_double_declaration_callbacks ||= []
+      end
+
       def transfer_nested_constants?
         !!@transfer_nested_constants
       end
@@ -123,6 +140,24 @@ module RSpec
         @verify_partial_doubles
       end
 
+      if ::RSpec.respond_to?(:configuration)
+        def color?
+          ::RSpec.configuration.color_enabled?
+        end
+      else
+        # Indicates whether or not diffs should be colored.
+        # Delegates to rspec-core's color option if rspec-core
+        # is loaded; otherwise you can set it here.
+        attr_writer :color
+
+        # Indicates whether or not diffs should be colored.
+        # Delegates to rspec-core's color option if rspec-core
+        # is loaded; otherwise you can set it here.
+        def color?
+          @color
+        end
+      end
+
       # Monkey-patch `Marshal.dump` to enable dumping of mocked or stubbed
       # objects. By default this will not work since RSpec mocks works by
       # adding singleton methods that cannot be serialized. This patch removes