модуль ActionMailer::TestHelper

# File actionmailer/lib/action_mailer/test_helper.rb, line 35
def assert_emails(number, &block)
  if block_given?
    diff = capture_emails(&block).length
    assert_equal number, diff, "#{number} emails expected, but #{diff} were sent"
  else
    assert_equal number, ActionMailer::Base.deliveries.size
  end
end

Утверждает, что количество отправленных писем соответствует заданному числу.

def test_emails
  assert_emails 0
  ContactMailer.welcome.deliver_now
  assert_emails 1
  ContactMailer.welcome.deliver_now
  assert_emails 2
end

Если передан блок, этот блок должен вызвать отправку указанного количества писем.

def test_emails_again
  assert_emails 1 do
    ContactMailer.welcome.deliver_now
  end

  assert_emails 2 do
    ContactMailer.welcome.deliver_now
    ContactMailer.welcome.deliver_later
  end
end

# File actionmailer/lib/action_mailer/test_helper.rb, line 157
def assert_enqueued_email_with(mailer, method, params: nil, args: nil, queue: nil, &block)
  if mailer.is_a? ActionMailer::Parameterized::Mailer
    params = mailer.instance_variable_get(:@params)
    mailer = mailer.instance_variable_get(:@mailer)
  end

  args = Array(args) unless args.is_a?(Proc)
  queue ||= mailer.deliver_later_queue_name || ActiveJob::Base.default_queue_name

  expected = ->(job_args) do
    job_kwargs = job_args.extract_options!

    [mailer.to_s, method.to_s, "deliver_now"] == job_args &&
      params === job_kwargs[:params] && args === job_kwargs[:args]
  end

  assert_enqueued_with(job: mailer.delivery_job, args: expected, queue: queue.to_s, &block)
end

Утверждает, что конкретное письмо было помещено в очередь, необязательно сопоставляя аргументы и/или параметры.

def test_email
  ContactMailer.welcome.deliver_later
  assert_enqueued_email_with ContactMailer, :welcome
end

def test_email_with_parameters
  ContactMailer.with(greeting: "Hello").welcome.deliver_later
  assert_enqueued_email_with ContactMailer, :welcome, args: { greeting: "Hello" }
end

def test_email_with_arguments
  ContactMailer.welcome("Hello", "Goodbye").deliver_later
  assert_enqueued_email_with ContactMailer, :welcome, args: ["Hello", "Goodbye"]
end

def test_email_with_named_arguments
  ContactMailer.welcome(greeting: "Hello", farewell: "Goodbye").deliver_later
  assert_enqueued_email_with ContactMailer, :welcome, args: [{ greeting: "Hello", farewell: "Goodbye" }]
end

def test_email_with_parameters_and_arguments
  ContactMailer.with(greeting: "Hello").welcome("Cheers", "Goodbye").deliver_later
  assert_enqueued_email_with ContactMailer, :welcome, params: { greeting: "Hello" }, args: ["Cheers", "Goodbye"]
end

def test_email_with_parameters_and_named_arguments
  ContactMailer.with(greeting: "Hello").welcome(farewell: "Goodbye").deliver_later
  assert_enqueued_email_with ContactMailer, :welcome, params: { greeting: "Hello" }, args: [{farewell: "Goodbye"}]
end

def test_email_with_parameterized_mailer
  ContactMailer.with(greeting: "Hello").welcome.deliver_later
  assert_enqueued_email_with ContactMailer.with(greeting: "Hello"), :welcome
end

def test_email_with_matchers
  ContactMailer.with(greeting: "Hello").welcome("Cheers", "Goodbye").deliver_later
  assert_enqueued_email_with ContactMailer, :welcome,
    params: ->(params) { /hello/i.match?(params[:greeting]) },
    args: ->(args) { /cheers/i.match?(args[0]) }
end

Если передан блок, этот блок должен вызвать помещение указанного письма в очередь.

def test_email_in_block
  assert_enqueued_email_with ContactMailer, :welcome do
    ContactMailer.welcome.deliver_later
  end
end

Если args задан как Hash, то сопоставляется параметризованное письмо.

def test_parameterized_email
  assert_enqueued_email_with ContactMailer, :welcome,
    args: {email: 'user@example.com'} do
    ContactMailer.with(email: 'user@example.com').welcome.deliver_later
  end
end

# File actionmailer/lib/action_mailer/test_helper.rb, line 91
def assert_enqueued_emails(number, &block)
  assert_enqueued_jobs(number, only: ->(job) { delivery_job_filter(job) }, &block)
end

Утверждает, что количество писем, запущенных в очередь для последующей доставки, соответствует заданному числу.

def test_emails
  assert_enqueued_emails 0
  ContactMailer.welcome.deliver_later
  assert_enqueued_emails 1
  ContactMailer.welcome.deliver_later
  assert_enqueued_emails 2
end

Если передан блок, этот блок должен вызвать помещение указанного количества писем в очередь.

def test_emails_again
  assert_enqueued_emails 1 do
    ContactMailer.welcome.deliver_later
  end

  assert_enqueued_emails 2 do
    ContactMailer.welcome.deliver_later
    ContactMailer.welcome.deliver_later
  end
end

# File actionmailer/lib/action_mailer/test_helper.rb, line 63
def assert_no_emails(&block)
  assert_emails 0, &block
end

Утверждает, что письма не были отправлены.

def test_emails
  assert_no_emails
  ContactMailer.welcome.deliver_now
  assert_emails 1
end

Если передан блок, этот блок не должен вызывать отправку каких-либо писем.

def test_emails_again
  assert_no_emails do
    # No emails should be sent from this block
  end
end

Примечание: это утверждение просто сокращенная запись для:

assert_emails 0, &block

# File actionmailer/lib/action_mailer/test_helper.rb, line 191
def assert_no_enqueued_emails(&block)
  assert_enqueued_emails 0, &block
end

Утверждает, что письма не помещены в очередь для последующей доставки.

def test_no_emails
  assert_no_enqueued_emails
  ContactMailer.welcome.deliver_later
  assert_enqueued_emails 1
end

Если передан блок, он не должен вызвать помещение каких-либо писем в очередь.

def test_no_emails
  assert_no_enqueued_emails do
    # No emails should be enqueued from this block
  end
end

# File actionmailer/lib/action_mailer/test_helper.rb, line 249
def capture_emails(&block)
  original_count = ActionMailer::Base.deliveries.size
  deliver_enqueued_emails(&block)
  new_count = ActionMailer::Base.deliveries.size
  diff = new_count - original_count
  ActionMailer::Base.deliveries.last(diff)
end

Возвращает любые письма, которые были отправлены в блоке.

def test_emails
  emails = capture_emails do
    ContactMailer.welcome.deliver_now
  end
  assert_equal "Hi there", emails.first.subject

  emails = capture_emails do
    ContactMailer.welcome.deliver_now
    ContactMailer.welcome.deliver_later
  end
  assert_equal "Hi there", emails.first.subject
end

# File actionmailer/lib/action_mailer/test_helper.rb, line 231
def deliver_enqueued_emails(queue: nil, at: nil, &block)
  perform_enqueued_jobs(only: ->(job) { delivery_job_filter(job) }, queue: queue, at: at, &block)
end

Доставляет все письма из очереди. Если передан блок, доставляет все письма, которые были помещены в очередь в течение действия блока. Если блок не передан, доставляет все письма из очереди до этого момента в тесте.

def test_deliver_enqueued_emails
  deliver_enqueued_emails do
    ContactMailer.welcome.deliver_later
  end

  assert_emails 1
end

def test_deliver_enqueued_emails_without_block
  ContactMailer.welcome.deliver_later

  deliver_enqueued_emails

  assert_emails 1
end

Если указан параметр :queue, то будут доставлены только письма из определённой очереди.

def test_deliver_enqueued_emails_with_queue
  deliver_enqueued_emails queue: :external_mailers do
    CustomerMailer.deliver_later_queue_name = :external_mailers
    CustomerMailer.welcome.deliver_later # will be performed
    EmployeeMailer.deliver_later_queue_name = :internal_mailers
    EmployeeMailer.welcome.deliver_later # will not be performed
  end

  assert_emails 1
end

Если указан параметр :at, то будут доставлены письма, помещённые в очередь для немедленной доставки или до указанного времени.