Allow multiple message allowances/expectations via `receive_messages` #399

JonRowe · 2013-08-09T13:03:57Z

Further to #368 this allow multiple message allowances/expectations via receive_messages.

myronmarston · 2013-08-09T14:50:48Z

lib/rspec/mocks/matchers/receives_messages.rb

+              receiver.send(method_name,subject,&block)
+            end
+          end
+        end


It seems like a lot of overhead to go through to repeatedly delegate to the Receive matcher here (which in turn delegates to a more fundamental underlying mechanism). Among other things, if you have provided a hash of 6 messages, the receive matchers will each get the mock proxy individually, causing 6 mock proxy lookups when one would suffice.

What would it look like to bypass the receive matcher?

It's the same as setting up each expectation / allowance, so it's no additional overhead, but it looked to me like it would involve a fair amount of repetition to extract this out...

Actually, in #401 @xaviershay has some perf improvements that this PR should take advantage of, I think: he's introduced the concept of a "simple stub" for these sorts of message/return-value pairs, and it looks to greatly improve perf.

So, I'm thinking we should merge his PR first (it sounds like he'll address my feedback soon and it's very close to being ready to merge) and then refactor this to use add_simple_stub under the covers.

Thoughts?

I like that idea, I'll take a look when it's merged.

JonRowe · 2013-08-12T21:11:50Z

As promised, refactored to use the improvements from #401

myronmarston · 2013-08-13T06:23:00Z

lib/rspec/mocks/framework.rb

@@ -28,6 +28,7 @@
 require 'rspec/mocks/mutate_const'
 require 'rspec/mocks/matchers/have_received'
 require 'rspec/mocks/matchers/receive'
+require 'rspec/mocks/matchers/receives_messages'


The matcher is receive_messages not receives_messages....shouldn't the file be named accordingly?

myronmarston · 2013-08-13T15:49:55Z

lib/rspec/mocks/matchers/receive_messages.rb

+          @message_return_value_hash.each do |message, value|
+            yield host, message, value
+          end
+        end


This is much more readable/understandable than the map_on thing you had before. Thanks!

One suggestion, though: given that the host argument is just yielded back to the caller, it seems a bit unnecessary. The name of this method also suggests that this method does something with it or uses it to determine what messages to yield.

Is there a reason you chose to pass it through? I'd probably (slightly) favor just putting a host = blah line at the call sites and then change this to each_message.

I liked the look of passing it in and out rather than having a local variable, that was all

JonRowe · 2013-08-13T21:42:41Z

Whats the story with #401 and #404 and this?

xaviershay · 2013-08-14T04:00:23Z

#401 is broken, if it needs to be re-implemented this patch will have to change too. I need to understand how this PR interacts with it. Didn't leave myself enough time to do that tonight, unfortunately.

myronmarston · 2013-08-16T15:20:52Z

spec/rspec/mocks/matchers/receive_messages_spec.rb

+      end
+    end
+  end
+end


I'd like to see some specs that document how .not_to receive_messages is handled. Can you add those?

JonRowe · 2013-08-19T16:41:17Z

@myronmarston I've added in specs covering what happens when you attempt to use the negative (I'm disallowing it) but I'm having trouble consistently getting a partial mocking failure. What should trigger it? I don't want to create order dependant specs...

JonRowe · 2013-09-03T22:37:47Z

Ping! Any advice?

myronmarston · 2013-09-04T06:35:02Z

lib/rspec/mocks/message_expectation.rb

+        end
+      rescue RSpec::Mocks::MockExpectationError => error
+        error.backtrace.insert(0, @backtrace_line)
+        Kernel::raise error
      end


The logic in this method (particularly the rescue and backtrace insertion bit) is very similar to what's already here:

rspec-mocks/lib/rspec/mocks/message_expectation.rb

Lines 247 to 252 in 3ac6f4e

def verify_messages_received

generate_error unless expected_messages_received? || failed_fast?

rescue RSpec::Mocks::MockExpectationError => error

error.backtrace.insert(0, @expected_from)

Kernel::raise error

end

Can some common logic be extracted?

JonRowe · 2013-09-09T05:28:49Z

I'll squash this before we merge it but I'm leaving the history until I'm ready for that :)

myronmarston · 2013-09-09T05:56:26Z

lib/rspec/mocks/message_expectation.rb

+
+    # Insert original locations into stacktraces
+    # @api private
+    class BacktrackRestore


BacktrackRestore is a very odd name. I have no idea what the name has to do with what the code below does...

I don't have a better name idea yet, though :(.

I've changed to InsertOntoBacktrace.line

coveralls · 2013-09-09T07:10:01Z

Coverage decreased (-0.06%) when pulling c3bdeff on receive_messages into 3ac6f4e on master.

JonRowe · 2013-09-09T07:10:46Z

Ok, this now resets partial mocks properly (it was actually a fairly trivial change as we have a separate PartialMockProxy to handle this).

One thing I haven't done, and this is deliberate cause my head hurts just thinking about it, is handle resetting 'any_instance' stubs/expectations, because they are already reset entirely separately from everything else, and I'm using the existing stub/expectation functionality for those (it's not new code).

They already don't reset cleanly, so I figure that's a new issue.

myronmarston · 2013-09-10T14:42:46Z

They already don't reset cleanly, so I figure that's a new issue.

That's news to me. Can you open an rspec-mocks issue includes a code snippet that demonstrates the problem?

Allow multiple message allowances/expectations via `receive_messages`

myronmarston · 2013-09-12T01:35:20Z

Merged. Thanks @JonRowe!

JonRowe · 2013-09-12T06:05:53Z

Weren't we going to squash this? :P

myronmarston · 2013-09-12T12:39:02Z

Oh yeah.....too late now, I guess.

JonRowe · 2013-09-12T12:39:48Z

Yup, oh well :)

rosenfeld · 2013-09-12T17:24:38Z

👍

myronmarston reviewed Aug 9, 2013
View reviewed changes

myronmarston reviewed Aug 13, 2013
View reviewed changes

myronmarston mentioned this pull request Aug 13, 2013

Fix behaviour for simple stubs when stubbing core methods. #404

Merged

myronmarston reviewed Aug 13, 2013
View reviewed changes

myronmarston reviewed Aug 16, 2013
View reviewed changes

myronmarston reviewed Sep 4, 2013
View reviewed changes

JonRowe added 11 commits September 9, 2013 13:15

grammar

4566fc6

remove simple expectation error message

ea7885d

assert on message and fix backtrace location

d1f72dd

cheat 1.8.7 not ordering hashes

476b9a0

correct expression name

4f9a9e5

refactor matcher messages for unsupported operations

35cce72

preventing negative usage of receive_messages

8752218

refactor error handling

f9caf99

wording change for docs

fd0f91c

ws

d46944e

specify -> example and spacing

2586e72

myronmarston reviewed Sep 9, 2013
View reviewed changes

JonRowe added 3 commits September 9, 2013 16:00

warn about do/end blocks

8db5cbe

rename extracted backtrace logic

4cdb8bc

handle resetting partial objects

c3bdeff

JonRowe mentioned this pull request Sep 10, 2013

any_instance partial mocks aren't reset #416

Merged

myronmarston added a commit that referenced this pull request Sep 12, 2013

Merge pull request #399 from rspec/receive_messages

69954e9

Allow multiple message allowances/expectations via `receive_messages`

myronmarston merged commit 69954e9 into master Sep 12, 2013

myronmarston deleted the receive_messages branch September 12, 2013 01:35

myronmarston mentioned this pull request Sep 12, 2013

allow receive with multiple methods #368

Closed

yujinakayama mentioned this pull request Sep 24, 2013

Support conversion to allow(…).to receive_messages yujinakayama/transpec#6

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow multiple message allowances/expectations via `receive_messages` #399

Allow multiple message allowances/expectations via `receive_messages` #399

JonRowe commented Aug 9, 2013

myronmarston Aug 9, 2013

JonRowe Aug 10, 2013

myronmarston Aug 10, 2013

JonRowe Aug 10, 2013

JonRowe commented Aug 12, 2013

myronmarston Aug 13, 2013

myronmarston Aug 13, 2013

JonRowe Aug 13, 2013

JonRowe commented Aug 13, 2013

xaviershay commented Aug 14, 2013

myronmarston Aug 16, 2013

JonRowe commented Aug 19, 2013

JonRowe commented Sep 3, 2013

myronmarston Sep 4, 2013

JonRowe Sep 9, 2013

JonRowe commented Sep 9, 2013

myronmarston Sep 9, 2013

JonRowe Sep 9, 2013

coveralls commented Sep 9, 2013

JonRowe commented Sep 9, 2013

myronmarston commented Sep 10, 2013

myronmarston commented Sep 12, 2013

JonRowe commented Sep 12, 2013

myronmarston commented Sep 12, 2013

JonRowe commented Sep 12, 2013

rosenfeld commented Sep 12, 2013

	def verify_messages_received
	generate_error unless expected_messages_received? \|\| failed_fast?
	rescue RSpec::Mocks::MockExpectationError => error
	error.backtrace.insert(0, @expected_from)
	Kernel::raise error
	end

Allow multiple message allowances/expectations via receive_messages #399

Allow multiple message allowances/expectations via receive_messages #399

Conversation

JonRowe commented Aug 9, 2013

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JonRowe commented Aug 12, 2013

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JonRowe commented Aug 13, 2013

xaviershay commented Aug 14, 2013

Choose a reason for hiding this comment

JonRowe commented Aug 19, 2013

JonRowe commented Sep 3, 2013

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JonRowe commented Sep 9, 2013

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coveralls commented Sep 9, 2013

JonRowe commented Sep 9, 2013

myronmarston commented Sep 10, 2013

myronmarston commented Sep 12, 2013

JonRowe commented Sep 12, 2013

myronmarston commented Sep 12, 2013

JonRowe commented Sep 12, 2013

rosenfeld commented Sep 12, 2013

Allow multiple message allowances/expectations via `receive_messages` #399

Allow multiple message allowances/expectations via `receive_messages` #399