Fix RSpec/MessageChain "better" docs. #848
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The original code results in an error, `receive` takes a single argument of the method name.
```
NoMethodError:
undefined method `to_sym' for {:bar=>#<Thing:0x00007ff34792c178 @baz=42>}:Hash
Did you mean? to_s
to_set
```
|
Here's some code showing the equivalency between the bad and better. require 'rspec'
class Thing
attr_accessor :baz
def initialize(baz:)
@baz = baz
end
end
class Foo
def bar
23
end
end
RSpec.describe 'receive' do
let(:foo) { Foo.new }
shared_examples 'baz is 42' do
it 'foo.bar.baz is 42' do
expect(foo.bar.baz).to eq 42
end
end
context 'with receive_message_chain' do
before do
allow(foo).to receive_message_chain(:bar, :baz).and_return(42)
end
it_behaves_like 'baz is 42'
end
context 'with receive.and_return' do
let(:thing) {
Thing.new(baz: 42)
}
before do
allow(foo).to receive(:bar).and_return(thing)
end
it_behaves_like 'baz is 42'
end
end |
Darhazer
approved these changes
Dec 13, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The original code results in an error because
receivetakes a single argument of the method name which it tries to symbolize.I believe what it's trying to do is
allow(foo).to receive(:bar).and_return(thing).Before submitting the PR make sure the following are checked:
master(if not - rebase it).bundle exec rake) passes (be sure to run this locally, since it may produce updated documentation that you will need to commit).