メインコンテンツまでスキップ

メッセージチェーン

特定の状況で、receiveの代わりにreceive_message_chainを使用して、メッセージのチェーンをスタブ化することができます。

allow(double).to receive_message_chain("foo.bar") { :baz }
allow(double).to receive_message_chain(:foo, :bar => :baz)
allow(double).to receive_message_chain(:foo, :bar) { :baz }

上記の3つの形式のいずれかが与えられた場合：

double.foo.bar # => :baz

Rails/ActiveRecordでの一般的な使用例：

allow(Article).to receive_message_chain("recent.published") { [Article.new] }

receive_message_chainは、and_return、and_yieldなどの応答の評価と一緒に使用するように設計されています。レガシーの理由から、stub_chainとの互換性もサポートされていますが、その使用は良い慣行とは見なされていません。将来のバージョンでは、stub_chainの互換性のサポートが削除される可能性があります。

exactly（つまり、exactly(2).times）のようなカスタマイズはサポートされていません。

警告：

チェーンは任意の長さにすることができ、これによりデメテルの法則を破ることが非常に簡単になります。そのため、receive_message_chainの使用はコードの臭いと見なすべきです。すべてのコードの臭いが実際の問題を示すわけではありませんが（フルエントインターフェースを考えてみてください）、receive_message_chainは依然として壊れやすい例を生み出します。たとえば、スペックでallow(foo).to receive_message_chain(:bar, :baz => 37)と書いて、実装がfoo.baz.barを呼び出す場合、スタブは機能しません。

receive_message_chainを使用したチェーンは、チェーンの適用方法について曖昧さを生み出し、実装コードの複雑な相互作用に設計上の圧力をかけます。そのため、receive_message_chainはreceiveの完璧な代替ではありません（詳細な説明については、Issue 921を参照してください）。doubleやinstance_doubleなどの他のモッキングメソッドは、これらの相互作用を持つコードをテストするためのより良い方法を提供します。

ダブルにreceive_message_chainを使用する​

以下の内容で「receive_message_chain_spec.rb」という名前のファイルがあるとします：

RSpec.describe "Using receive_message_chain on a double" do
  let(:dbl) { double }

  example "using a string and a block" do
    allow(dbl).to receive_message_chain("foo.bar") { :baz }
    expect(dbl.foo.bar).to eq(:baz)
  end

  example "using symbols and a hash" do
    allow(dbl).to receive_message_chain(:foo, :bar => :baz)
    expect(dbl.foo.bar).to eq(:baz)
  end

  example "using symbols and a block" do
    allow(dbl).to receive_message_chain(:foo, :bar) { :baz }
    expect(dbl.foo.bar).to eq(:baz)
  end
end

When I run rspec receive_message_chain_spec.rb

Then the examples should all pass.

任意のクラスのインスタンスで receive_message_chain を使用する​

Given a file named "receive_message_chain_spec.rb" with:

RSpec.describe "Using receive_message_chain on any instance of a class" do
  example "using a string and a block" do
    allow_any_instance_of(Object).to receive_message_chain("foo.bar") { :baz }
    expect(Object.new.foo.bar).to eq(:baz)
  end

  example "using symbols and a hash" do
    allow_any_instance_of(Object).to receive_message_chain(:foo, :bar => :baz)
    expect(Object.new.foo.bar).to eq(:baz)
  end

  example "using symbols and a block" do
    allow_any_instance_of(Object).to receive_message_chain(:foo, :bar) { :baz }
    expect(Object.new.foo.bar).to eq(:baz)
  end
end

When I run rspec receive_message_chain_spec.rb

Then the examples should all pass.