модуль ActionMailer::TestHelper

# File actionmailer/lib/action_mailer/test_helper.rb, line 34
def assert_emails(number, &block)
  if block_given?
    original_count = ActionMailer::Base.deliveries.size
    perform_enqueued_jobs(only: ->(job) { delivery_job_filter(job) }, &block)
    new_count = ActionMailer::Base.deliveries.size
    assert_equal number, new_count - original_count, "#{number} emails expected, but #{new_count - original_count} 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 126
def assert_enqueued_email_with(mailer, method, args: nil, queue: ActionMailer::Base.deliver_later_queue_name || "default", &block)
  args = if args.is_a?(Hash)
    [mailer.to_s, method.to_s, "deliver_now", params: args, args: []]
  else
    [mailer.to_s, method.to_s, "deliver_now", args: Array(args)]
  end
  assert_enqueued_with(job: mailer.delivery_job, args: args, queue: queue.to_s, &block)
end

Проверяет, что конкретное письмо было поставлено в очередь, при необходимости сопоставляя аргументы.

def test_email
  ContactMailer.welcome.deliver_later
  assert_enqueued_email_with ContactMailer, :welcome
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_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 92
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 64
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 150
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