Module: ActionMailer::TestHelper

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In: TestCase, TestCase::Behavior
Defined in:	actionmailer/lib/action_mailer/test_helper.rb

Overview

Provides helper methods for testing Action Mailer, including #assert_emails and #assert_no_emails

Instance Method Summary

#assert_emails(number)

Asserts that the number of emails sent matches the given number.
#assert_no_emails(&block)

Assert that no emails have been sent.

Instance Method Details

#assert_emails(number)

Asserts that the number of emails sent matches the given number.

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

If a block is passed, that block should cause the specified number of emails to be sent.

def test_emails_again
  assert_emails 1 do
    ContactMailer.welcome.deliver_now
  end

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

[ GitHub ]

# File 'actionmailer/lib/action_mailer/test_helper.rb', line 28


def assert_emails(number)
  if block_given?
    original_count = ActionMailer::Base.deliveries.size
    yield
    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

#assert_no_emails(&block)

Assert that no emails have been sent.

def test_emails
  assert_no_emails
  ContactMailer.welcome.deliver_now
  assert_emails 1
end

If a block is passed, that block should not cause any emails to be sent.

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

Note: This assertion is simply a shortcut for:

assert_emails 0

[ GitHub ]

# File 'actionmailer/lib/action_mailer/test_helper.rb', line 58


def assert_no_emails(&block)
  assert_emails 0, &block
end