1 files changed, 329 insertions, 80 deletions
diff --git a/actionmailer/test/base_test.rb b/actionmailer/test/base_test.rb
index b74728ae34..50f2c71737 100644
--- a/actionmailer/test/base_test.rb
+++ b/actionmailer/test/base_test.rb
@@ -1,4 +1,3 @@
-# encoding: utf-8
 require 'abstract_unit'
 require 'set'
 
@@ -10,9 +9,20 @@ require 'mailers/proc_mailer'
 require 'mailers/asset_mailer'
 
 class BaseTest < ActiveSupport::TestCase
-  def teardown
-    ActionMailer::Base.asset_host = nil
-    ActionMailer::Base.assets_dir = nil
+  include Rails::Dom::Testing::Assertions::DomAssertions
+
+  setup do
+    @original_delivery_method = ActionMailer::Base.delivery_method
+    ActionMailer::Base.delivery_method = :test
+    @original_asset_host = ActionMailer::Base.asset_host
+    @original_assets_dir = ActionMailer::Base.assets_dir
+  end
+
+  teardown do
+    ActionMailer::Base.asset_host = @original_asset_host
+    ActionMailer::Base.assets_dir = @original_assets_dir
+    BaseMailer.deliveries.clear
+    ActionMailer::Base.delivery_method = @original_delivery_method
   end
 
   test "method call to mail does not raise error" do
@@ -103,6 +113,7 @@ class BaseTest < ActiveSupport::TestCase
   test "attachment gets content type from filename" do
     email = BaseMailer.attachment_with_content
     assert_equal('invoice.pdf', email.attachments[0].filename)
+    assert_equal('application/pdf', email.attachments[0].mime_type)
   end
 
   test "attachment with hash" do
@@ -200,25 +211,82 @@ class BaseTest < ActiveSupport::TestCase
   end
 
   test "subject gets default from I18n" do
-    BaseMailer.default subject: nil
-    email = BaseMailer.welcome(subject: nil)
-    assert_equal "Welcome", email.subject
+    with_default BaseMailer, subject: nil do
+      email = BaseMailer.welcome(subject: nil)
+      assert_equal "Welcome", email.subject
 
-    I18n.backend.store_translations('en', base_mailer: {welcome: {subject: "New Subject!"}})
-    email = BaseMailer.welcome(subject: nil)
-    assert_equal "New Subject!", email.subject
+      with_translation 'en', base_mailer: {welcome: {subject: "New Subject!"}} do
+        email = BaseMailer.welcome(subject: nil)
+        assert_equal "New Subject!", email.subject
+      end
+    end
   end
 
   test 'default subject can have interpolations' do
-    I18n.backend.store_translations('en', base_mailer: {with_subject_interpolations: {subject: 'Will the real %{rapper_or_impersonator} please stand up?'}})
-    email = BaseMailer.with_subject_interpolations
-    assert_equal 'Will the real Slim Shady please stand up?', email.subject
+    with_translation 'en', base_mailer: {with_subject_interpolations: {subject: 'Will the real %{rapper_or_impersonator} please stand up?'}} do
+      email = BaseMailer.with_subject_interpolations
+      assert_equal 'Will the real Slim Shady please stand up?', email.subject
+    end
   end
 
   test "translations are scoped properly" do
-    I18n.backend.store_translations('en', base_mailer: {email_with_translations: {greet_user: "Hello %{name}!"}})
-    email = BaseMailer.email_with_translations
-    assert_equal 'Hello lifo!', email.body.encoded
+    with_translation 'en', base_mailer: {email_with_translations: {greet_user: "Hello %{name}!"}} do
+      email = BaseMailer.email_with_translations
+      assert_equal 'Hello lifo!', email.body.encoded
+    end
+  end
+
+  test "adding attachments after mail was called raises exception" do
+    class LateAttachmentMailer < ActionMailer::Base
+      def welcome
+        mail body: "yay", from: "welcome@example.com", to: "to@example.com"
+        attachments['invoice.pdf'] = 'This is test File content'
+      end
+    end
+
+    e = assert_raises(RuntimeError) { LateAttachmentMailer.welcome.message }
+    assert_match(/Can't add attachments after `mail` was called./, e.message)
+  end
+
+  test "adding inline attachments after mail was called raises exception" do
+    class LateInlineAttachmentMailer < ActionMailer::Base
+      def welcome
+        mail body: "yay", from: "welcome@example.com", to: "to@example.com"
+        attachments.inline['invoice.pdf'] = 'This is test File content'
+      end
+    end
+
+    e = assert_raises(RuntimeError) { LateInlineAttachmentMailer.welcome.message }
+    assert_match(/Can't add attachments after `mail` was called./, e.message)
+  end
+
+  test "adding inline attachments while rendering mail works" do
+    class LateInlineAttachmentMailer < ActionMailer::Base
+      def on_render
+        mail from: "welcome@example.com", to: "to@example.com"
+      end
+    end
+
+    mail = LateInlineAttachmentMailer.on_render
+    assert_nothing_raised { mail.message }
+
+    assert_equal ["image/jpeg; filename=controller_attachments.jpg",
+                  "image/jpeg; filename=attachments.jpg"], mail.attachments.inline.map {|a| a['Content-Type'].to_s }
+  end
+
+  test "accessing attachments works after mail was called" do
+    class LateAttachmentAccessorMailer < ActionMailer::Base
+      def welcome
+        attachments['invoice.pdf'] = 'This is test File content'
+        mail body: "yay", from: "welcome@example.com", to: "to@example.com"
+
+        unless attachments.map(&:filename) == ["invoice.pdf"]
+          raise Minitest::Assertion, "Should allow access to attachments"
+        end
+      end
+    end
+
+    assert_nothing_raised { LateAttachmentAccessorMailer.welcome.message }
   end
 
   # Implicit multipart
@@ -284,10 +352,35 @@ class BaseTest < ActiveSupport::TestCase
       assert_equal("text/plain", email.parts[0].mime_type)
       assert_equal("Implicit with locale PL TEXT", email.parts[0].body.encoded)
       assert_equal("text/html", email.parts[1].mime_type)
-      assert_equal("Implicit with locale HTML", email.parts[1].body.encoded)
+      assert_equal("Implicit with locale EN HTML", email.parts[1].body.encoded)
+    end
+  end
+
+  test "implicit multipart with fallback locale" do
+    fallback_backend = Class.new(I18n::Backend::Simple) do
+      include I18n::Backend::Fallbacks
+    end
+
+    begin
+      backend = I18n.backend
+      I18n.backend = fallback_backend.new
+      I18n.fallbacks[:"de-AT"] = [:de]
+
+      swap I18n, locale: 'de-AT' do
+        email = BaseMailer.implicit_with_locale
+        assert_equal(2, email.parts.size)
+        assert_equal("multipart/alternative", email.mime_type)
+        assert_equal("text/plain", email.parts[0].mime_type)
+        assert_equal("Implicit with locale DE-AT TEXT", email.parts[0].body.encoded)
+        assert_equal("text/html", email.parts[1].mime_type)
+        assert_equal("Implicit with locale DE HTML", email.parts[1].body.encoded)
+      end
+    ensure
+      I18n.backend = backend
     end
   end
 
+
   test "implicit multipart with several view paths uses the first one with template" do
     old = BaseMailer.view_paths
     begin
@@ -356,6 +449,13 @@ class BaseTest < ActiveSupport::TestCase
     assert_equal("Format with any!", email.parts[1].body.encoded)
   end
 
+  test 'explicit without specifying format with format.any' do
+    error = assert_raises(ArgumentError) do
+      BaseMailer.explicit_without_specifying_format_with_any.parts
+    end
+    assert_equal "You have to supply at least one format", error.message
+  end
+
   test "explicit multipart with format(Hash)" do
     email = BaseMailer.explicit_multipart_with_options(true)
     email.ready_to_send!
@@ -406,65 +506,63 @@ class BaseTest < ActiveSupport::TestCase
   end
 
   test "calling just the action should return the generated mail object" do
-    BaseMailer.deliveries.clear
     email = BaseMailer.welcome
     assert_equal(0, BaseMailer.deliveries.length)
     assert_equal('The first email on new API!', email.subject)
   end
 
   test "calling deliver on the action should deliver the mail object" do
-    BaseMailer.deliveries.clear
-    BaseMailer.expects(:deliver_mail).once
-    mail = BaseMailer.welcome.deliver
-    assert_equal 'The first email on new API!', mail.subject
+    assert_called(BaseMailer, :deliver_mail) do
+      mail = BaseMailer.welcome.deliver_now
+      assert_equal 'The first email on new API!', mail.subject
+    end
   end
 
   test "calling deliver on the action should increment the deliveries collection if using the test mailer" do
-    BaseMailer.delivery_method = :test
-    BaseMailer.deliveries.clear
-    BaseMailer.welcome.deliver
+    BaseMailer.welcome.deliver_now
     assert_equal(1, BaseMailer.deliveries.length)
   end
 
   test "calling deliver, ActionMailer should yield back to mail to let it call :do_delivery on itself" do
     mail = Mail::Message.new
-    mail.expects(:do_delivery).once
-    BaseMailer.expects(:welcome).returns(mail)
-    BaseMailer.welcome.deliver
+    assert_called(mail, :do_delivery) do
+      assert_called(BaseMailer, :welcome, returns: mail) do
+        BaseMailer.welcome.deliver
+      end
+    end
   end
 
   # Rendering
   test "you can specify a different template for implicit render" do
-    mail = BaseMailer.implicit_different_template('implicit_multipart').deliver
+    mail = BaseMailer.implicit_different_template('implicit_multipart').deliver_now
     assert_equal("HTML Implicit Multipart", mail.html_part.body.decoded)
     assert_equal("TEXT Implicit Multipart", mail.text_part.body.decoded)
   end
 
   test "should raise if missing template in implicit render" do
-    BaseMailer.deliveries.clear
     assert_raises ActionView::MissingTemplate do
-      BaseMailer.implicit_different_template('missing_template').deliver
+      BaseMailer.implicit_different_template('missing_template').deliver_now
     end
     assert_equal(0, BaseMailer.deliveries.length)
   end
 
   test "you can specify a different template for explicit render" do
-    mail = BaseMailer.explicit_different_template('explicit_multipart_templates').deliver
+    mail = BaseMailer.explicit_different_template('explicit_multipart_templates').deliver_now
     assert_equal("HTML Explicit Multipart Templates", mail.html_part.body.decoded)
     assert_equal("TEXT Explicit Multipart Templates", mail.text_part.body.decoded)
   end
 
   test "you can specify a different layout" do
-    mail = BaseMailer.different_layout('different_layout').deliver
+    mail = BaseMailer.different_layout('different_layout').deliver_now
     assert_equal("HTML -- HTML", mail.html_part.body.decoded)
     assert_equal("PLAIN -- PLAIN", mail.text_part.body.decoded)
   end
 
   test "you can specify the template path for implicit lookup" do
-    mail = BaseMailer.welcome_from_another_path('another.path/base_mailer').deliver
+    mail = BaseMailer.welcome_from_another_path('another.path/base_mailer').deliver_now
     assert_equal("Welcome from another path", mail.body.encoded)
 
-    mail = BaseMailer.welcome_from_another_path(['unknown/invalid', 'another.path/base_mailer']).deliver
+    mail = BaseMailer.welcome_from_another_path(['unknown/invalid', 'another.path/base_mailer']).deliver_now
     assert_equal("Welcome from another path", mail.body.encoded)
   end
 
@@ -474,34 +572,33 @@ class BaseTest < ActiveSupport::TestCase
 
     mail = AssetMailer.welcome
 
-    assert_equal(%{<img alt="Dummy" src="http://global.com/images/dummy.png" />}, mail.body.to_s.strip)
+    assert_dom_equal(%{<img alt="Dummy" src="http://global.com/images/dummy.png" />}, mail.body.to_s.strip)
   end
 
   test "assets tags should use a Mailer's asset_host settings when available" do
-    begin
-      ActionMailer::Base.config.asset_host = "http://global.com"
-      ActionMailer::Base.config.assets_dir = "global/"
+    ActionMailer::Base.config.asset_host = "http://global.com"
+    ActionMailer::Base.config.assets_dir = "global/"
 
-      AssetMailer.asset_host = "http://local.com"
+    TempAssetMailer = Class.new(AssetMailer) do
+      self.mailer_name = "asset_mailer"
+      self.asset_host = "http://local.com"
+    end
 
-      mail = AssetMailer.welcome
+    mail = TempAssetMailer.welcome
 
-      assert_equal(%{<img alt="Dummy" src="http://local.com/images/dummy.png" />}, mail.body.to_s.strip)
-    ensure
-      AssetMailer.asset_host = ActionMailer::Base.config.asset_host
-    end
+    assert_dom_equal(%{<img alt="Dummy" src="http://local.com/images/dummy.png" />}, mail.body.to_s.strip)
   end
 
   test 'the view is not rendered when mail was never called' do
     mail = BaseMailer.without_mail_call
     assert_equal('', mail.body.to_s.strip)
-    mail.deliver
+    mail.deliver_now
   end
 
   test 'the return value of mailer methods is not relevant' do
     mail = BaseMailer.with_nil_as_return_value
     assert_equal('Welcome', mail.body.to_s.strip)
-    mail.deliver
+    mail.deliver_now
   end
 
   # Before and After hooks
@@ -517,65 +614,106 @@ class BaseTest < ActiveSupport::TestCase
   end
 
   test "you can register an observer to the mail object that gets informed on email delivery" do
-    ActionMailer::Base.register_observer(MyObserver)
-    mail = BaseMailer.welcome
-    MyObserver.expects(:delivered_email).with(mail)
-    mail.deliver
+    mail_side_effects do
+      ActionMailer::Base.register_observer(MyObserver)
+      mail = BaseMailer.welcome
+      assert_called_with(MyObserver, :delivered_email, [mail]) do
+        mail.deliver_now
+      end
+    end
   end
 
   test "you can register an observer using its stringified name to the mail object that gets informed on email delivery" do
-    ActionMailer::Base.register_observer("BaseTest::MyObserver")
-    mail = BaseMailer.welcome
-    MyObserver.expects(:delivered_email).with(mail)
-    mail.deliver
+    mail_side_effects do
+      ActionMailer::Base.register_observer("BaseTest::MyObserver")
+      mail = BaseMailer.welcome
+      assert_called_with(MyObserver, :delivered_email, [mail]) do
+        mail.deliver_now
+      end
+    end
+  end
+
+  test "you can register an observer using its symbolized underscored name to the mail object that gets informed on email delivery" do
+    mail_side_effects do
+      ActionMailer::Base.register_observer(:"base_test/my_observer")
+      mail = BaseMailer.welcome
+      assert_called_with(MyObserver, :delivered_email, [mail]) do
+        mail.deliver_now
+      end
+    end
   end
 
   test "you can register multiple observers to the mail object that both get informed on email delivery" do
-    ActionMailer::Base.register_observers("BaseTest::MyObserver", MySecondObserver)
-    mail = BaseMailer.welcome
-    MyObserver.expects(:delivered_email).with(mail)
-    MySecondObserver.expects(:delivered_email).with(mail)
-    mail.deliver
+    mail_side_effects do
+      ActionMailer::Base.register_observers("BaseTest::MyObserver", MySecondObserver)
+      mail = BaseMailer.welcome
+      assert_called_with(MyObserver, :delivered_email, [mail]) do
+        assert_called_with(MySecondObserver, :delivered_email, [mail]) do
+          mail.deliver_now
+        end
+      end
+    end
   end
 
   class MyInterceptor
-    def self.delivering_email(mail)
-    end
+    def self.delivering_email(mail); end
+    def self.previewing_email(mail); end
   end
 
   class MySecondInterceptor
-    def self.delivering_email(mail)
-    end
+    def self.delivering_email(mail); end
+    def self.previewing_email(mail); end
   end
 
   test "you can register an interceptor to the mail object that gets passed the mail object before delivery" do
-    ActionMailer::Base.register_interceptor(MyInterceptor)
-    mail = BaseMailer.welcome
-    MyInterceptor.expects(:delivering_email).with(mail)
-    mail.deliver
+    mail_side_effects do
+      ActionMailer::Base.register_interceptor(MyInterceptor)
+      mail = BaseMailer.welcome
+      assert_called_with(MyInterceptor, :delivering_email, [mail]) do
+        mail.deliver_now
+      end
+    end
   end
 
   test "you can register an interceptor using its stringified name to the mail object that gets passed the mail object before delivery" do
-    ActionMailer::Base.register_interceptor("BaseTest::MyInterceptor")
-    mail = BaseMailer.welcome
-    MyInterceptor.expects(:delivering_email).with(mail)
-    mail.deliver
+    mail_side_effects do
+      ActionMailer::Base.register_interceptor("BaseTest::MyInterceptor")
+      mail = BaseMailer.welcome
+      assert_called_with(MyInterceptor, :delivering_email, [mail]) do
+        mail.deliver_now
+      end
+    end
+  end
+
+  test "you can register an interceptor using its symbolized underscored name to the mail object that gets passed the mail object before delivery" do
+    mail_side_effects do
+      ActionMailer::Base.register_interceptor(:"base_test/my_interceptor")
+      mail = BaseMailer.welcome
+      assert_called_with(MyInterceptor, :delivering_email, [mail]) do
+        mail.deliver_now
+      end
+    end
   end
 
   test "you can register multiple interceptors to the mail object that both get passed the mail object before delivery" do
-    ActionMailer::Base.register_interceptors("BaseTest::MyInterceptor", MySecondInterceptor)
-    mail = BaseMailer.welcome
-    MyInterceptor.expects(:delivering_email).with(mail)
-    MySecondInterceptor.expects(:delivering_email).with(mail)
-    mail.deliver
+    mail_side_effects do
+      ActionMailer::Base.register_interceptors("BaseTest::MyInterceptor", MySecondInterceptor)
+      mail = BaseMailer.welcome
+      assert_called_with(MyInterceptor, :delivering_email, [mail]) do
+        assert_called_with(MySecondInterceptor, :delivering_email, [mail]) do
+          mail.deliver_now
+        end
+      end
+    end
   end
 
   test "being able to put proc's into the defaults hash and they get evaluated on mail sending" do
     mail1 = ProcMailer.welcome['X-Proc-Method']
     yesterday = 1.day.ago
-    Time.stubs(:now).returns(yesterday)
-    mail2 = ProcMailer.welcome['X-Proc-Method']
-    assert(mail1.to_s.to_i > mail2.to_s.to_i)
+    Time.stub(:now, yesterday) do
+      mail2 = ProcMailer.welcome['X-Proc-Method']
+      assert(mail1.to_s.to_i > mail2.to_s.to_i)
+    end
   end
 
   test 'default values which have to_proc (e.g. symbols) should not be considered procs' do
@@ -671,6 +809,27 @@ class BaseTest < ActiveSupport::TestCase
     assert_equal ["robert.pankowecki@gmail.com"], DefaultFromMailer.welcome.from
   end
 
+  test "mail() without arguments serves as getter for the current mail message" do
+    class MailerWithCallback < ActionMailer::Base
+      after_action :a_callback
+
+      def welcome
+        headers('X-Special-Header' => 'special indeed!')
+        mail subject: "subject", body: "hello world", to: ["joe@example.com"]
+      end
+
+      def a_callback
+        mail.to << "jane@example.com"
+      end
+    end
+
+    mail = MailerWithCallback.welcome
+    assert_equal "subject", mail.subject
+    assert_equal ["joe@example.com", "jane@example.com"], mail.to
+    assert_equal "hello world", mail.body.encoded.strip
+    assert_equal "special indeed!", mail["X-Special-Header"].to_s
+  end
+
   protected
 
     # Execute the block setting the given values and restoring old values after
@@ -695,4 +854,94 @@ class BaseTest < ActiveSupport::TestCase
     ensure
       klass.default_params = old
     end
+
+    # A simple hack to restore the observers and interceptors for Mail, as it
+    # does not have an unregister API yet.
+    def mail_side_effects
+      old_observers = Mail.class_variable_get(:@@delivery_notification_observers)
+      old_delivery_interceptors = Mail.class_variable_get(:@@delivery_interceptors)
+      yield
+    ensure
+      Mail.class_variable_set(:@@delivery_notification_observers, old_observers)
+      Mail.class_variable_set(:@@delivery_interceptors, old_delivery_interceptors)
+    end
+
+    def with_translation(locale, data)
+      I18n.backend.store_translations(locale, data)
+      yield
+    ensure
+      I18n.backend.reload!
+    end
+end
+
+class BasePreviewInterceptorsTest < ActiveSupport::TestCase
+  teardown do
+    ActionMailer::Base.preview_interceptors.clear
+  end
+
+  class BaseMailerPreview < ActionMailer::Preview
+    def welcome
+      BaseMailer.welcome
+    end
+  end
+
+  class MyInterceptor
+    def self.delivering_email(mail); end
+    def self.previewing_email(mail); end
+  end
+
+  class MySecondInterceptor
+    def self.delivering_email(mail); end
+    def self.previewing_email(mail); end
+  end
+
+  test "you can register a preview interceptor to the mail object that gets passed the mail object before previewing" do
+    ActionMailer::Base.register_preview_interceptor(MyInterceptor)
+    mail = BaseMailer.welcome
+    stub_any_instance(BaseMailerPreview) do |instance|
+      instance.stub(:welcome, mail) do
+        assert_called_with(MyInterceptor, :previewing_email, [mail]) do
+          BaseMailerPreview.call(:welcome)
+        end
+      end
+    end
+  end
+
+  test "you can register a preview interceptor using its stringified name to the mail object that gets passed the mail object before previewing" do
+    ActionMailer::Base.register_preview_interceptor("BasePreviewInterceptorsTest::MyInterceptor")
+    mail = BaseMailer.welcome
+    stub_any_instance(BaseMailerPreview) do |instance|
+      instance.stub(:welcome, mail) do
+        assert_called_with(MyInterceptor, :previewing_email, [mail]) do
+          BaseMailerPreview.call(:welcome)
+        end
+      end
+    end
+  end
+
+  test "you can register an interceptor using its symbolized underscored name to the mail object that gets passed the mail object before previewing" do
+    ActionMailer::Base.register_preview_interceptor(:"base_preview_interceptors_test/my_interceptor")
+    mail = BaseMailer.welcome
+    stub_any_instance(BaseMailerPreview) do |instance|
+      instance.stub(:welcome, mail) do
+        assert_called_with(MyInterceptor, :previewing_email, [mail]) do
+          BaseMailerPreview.call(:welcome)
+        end
+      end
+    end
+  end
+
+  test "you can register multiple preview interceptors to the mail object that both get passed the mail object before previewing" do
+    ActionMailer::Base.register_preview_interceptors("BasePreviewInterceptorsTest::MyInterceptor", MySecondInterceptor)
+    mail = BaseMailer.welcome
+    stub_any_instance(BaseMailerPreview) do |instance|
+      instance.stub(:welcome, mail) do
+        assert_called_with(MyInterceptor, :previewing_email, [mail]) do
+          assert_called_with(MySecondInterceptor, :previewing_email, [mail]) do
+            BaseMailerPreview.call(:welcome)
+          end
+        end
+      end
+    end
+  end
 end