CODEWITHSUNDEEP
rubyrspec
CharlesHorse
CharlesHorse

Reputation: 449

Allow vs Stub, what's the difference?

What is the difference between the following lines of (rspec) code and regardless if they are the same or different, when should you use one instead of the other?

book = double("book")
allow(book).to receive(:title) { "The RSpec Book" }

versus

book = double("book")
book.stub(:title).and_return("The RSpec Book")

Upvotes: 34

Views: 12466

Answers (1)

jurglic
jurglic

Reputation: 3737

There are 2 differences but the result is exactly the same. Both are in regards to the rspec mocks/expectations syntax.

  1. Use of #allow instead of #stub method. First case uses the new rspec syntax introduced this year. This is now the preferred way of using rspec. Altough the old syntax isn't deprecated, it will probably be disabled by default in rspec3. More info on this topic from the maintainer of rspec: https://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/ https://rspec.info/blog/2013/07/the-plan-for-rspec-3/

  2. Use of block instead of #and_return to define the returning value. This has nothing to do with the mentioned syntax change; both approaches have been available for quite a while (since rspec 1). It is more appropriate to use the #and_return method, since it is (a) the default way, (b) more readable and (c) comes without any runtime overhead. The second approach using block is usually reserved to the corner cases, when you wish to return something of more dynamic nature - not a constant, but some kind of calculation.

The answer to your question would be to use combination of both:

  • use the #allow instead of #stub
  • use #and_return instead of block, unless you need to return dynamically calculated value

E.g.:

book = double('book')
allow(book).to receive(:title).and_return('The RSpec Book')

Upvotes: 41

Related Questions