have_enqueued_mail マッチャー

have_enqueued_mail（または enqueue_mail としてもエイリアスされる）マッチャーは、指定されたメーラーがキューに入れられたかどうかを確認するために使用されます。

背景

アクティブジョブが利用可能であることが前提です。

メーラークラスとメソッド名の確認

"spec/mailers/user_mailer_spec.rb" という名前のファイルがあるとします。

require "rails_helper"

RSpec.describe NotificationsMailer do
  it "matches with enqueued mailer" do
    ActiveJob::Base.queue_adapter = :test
    expect {
      NotificationsMailer.signup.deliver_later
    }.to have_enqueued_mail(NotificationsMailer, :signup)
  end
end

rspec spec/mailers/user_mailer_spec.rb を実行すると、

すべての例がパスするはずです。

メーラーのキューイング時間の確認

"spec/mailers/user_mailer_spec.rb" という名前のファイルがあるとします。

require "rails_helper"

RSpec.describe NotificationsMailer do
  it "matches with enqueued mailer" do
    ActiveJob::Base.queue_adapter = :test
    expect {
      NotificationsMailer.signup.deliver_later(wait_until: Date.tomorrow.noon)
    }.to have_enqueued_mail.at(Date.tomorrow.noon)
  end
end

rspec spec/mailers/user_mailer_spec.rb を実行すると、

すべての例がパスするはずです。

メーラーの引数の確認

"app/mailers/my_mailer.rb" という名前のファイルがあるとします。

class MyMailer < ApplicationMailer

  def signup(user = nil)
    @user = user

    mail to: "to@example.org"
  end
end

"spec/mailers/my_mailer_spec.rb" という名前のファイルがあるとします。

require "rails_helper"

RSpec.describe MyMailer do
  it "matches with enqueued mailer" do
    ActiveJob::Base.queue_adapter = :test
    # Works with plain args
    expect {
      MyMailer.signup('user').deliver_later
    }.to have_enqueued_mail(MyMailer, :signup).with('user')
  end
end

rspec spec/mailers/my_mailer_spec.rb を実行すると、

すべての例がパスするはずです。

メーラーのパラメータ化

"app/mailers/my_mailer.rb" という名前のファイルがあるとします。

class MyMailer < ApplicationMailer

  def signup
    @foo = params[:foo]

    mail to: "to@example.org"
  end
end

"spec/mailers/my_mailer_spec.rb" という名前のファイルがあるとします。

require "rails_helper"

RSpec.describe MyMailer do
  it "matches with enqueued mailer" do
    ActiveJob::Base.queue_adapter = :test
    # Works with named parameters
    expect {
      MyMailer.with(foo: 'bar').signup.deliver_later
    }.to have_enqueued_mail(MyMailer, :signup).with(a_hash_including(params: {foo: 'bar'}))
  end
end

rspec spec/mailers/my_mailer_spec.rb を実行すると、

すべての例がパスするはずです。

メーラーのパラメータ化と引数の渡し方

"app/mailers/my_mailer.rb" という名前のファイルがあるとします。

class MyMailer < ApplicationMailer

  def signup(user)
    @user = user
    @foo = params[:foo]

    mail to: "to@example.org"
  end
end

"spec/mailers/my_mailer_spec.rb" という名前のファイルがあるとします。

require "rails_helper"

RSpec.describe MyMailer do
  it "matches with enqueued mailer" do
    ActiveJob::Base.queue_adapter = :test
    # Works also with both, named parameters match first argument
    expect {
      MyMailer.with(foo: 'bar').signup('user').deliver_later
    }.to have_enqueued_mail(MyMailer, :signup).with(params: {foo: 'bar'}, args: ['user'])
  end
end

rspec spec/mailers/my_mailer_spec.rb を実行すると、

すべての例がパスするはずです。