actionmailer 5.0.0.rc1 → 5.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd0a6570d581cc9eb29bbd91afa234749b7bf58b
-  data.tar.gz: b534939a5472dff982dc1572c6dd015ef320fa65
+  metadata.gz: 4c66edc530e47491b457fe5bbe6bd663b368c860
+  data.tar.gz: 0410986754bdd911c65d0ea400c597560b2fa7dd
 SHA512:
-  metadata.gz: 66af363c4f40905f436e8bbaa6ed8211ffe4314664f552f519f0c54bca405a1fc061b11d294da6d31b0482fedf33ca8aed1a56dac949e3032fc79adedb289169
-  data.tar.gz: 99e8516d59ed27dceb6da172db9a1494fa80824b2caab45b08f5816716e987ef6b215b87a207d122cdf9bc55c991032254ada4f153af6ce71885aa6616461af1
+  metadata.gz: 7b14aa9dc2a1d810efd1bac5f8f0773b8d9e13faa07489d1c7cb15180d5bc479a48a2fb6d5e8098577ce61066cd0fa00f94db381e18a6320d2eaf79516f81937
+  data.tar.gz: d6cd2bde888ec9757f1c113f67feac6aa7605589416ec2ced1bf56af3b6d95c8d8e410ed58ab0b3d601495241006b153b5b685a77a11d00f153893d73ef197f2

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## Rails 5.0.0.rc2 (June 22, 2016) ##
+
+*   Exception handling: use `rescue_from` to handle exceptions raised by
+    mailer actions, by message delivery, and by deferred delivery jobs.
+
+    *Jeremy Daer*
+
+
 ## Rails 5.0.0.rc1 (May 06, 2016) ##
 
 *   No changes.

data/lib/action_mailer/base.rb

@@ -5,6 +5,7 @@ require 'active_support/core_ext/hash/except'
 require 'active_support/core_ext/module/anonymous'
 
 require 'action_mailer/log_subscriber'
+require 'action_mailer/rescuable'
 
 module ActionMailer
   # Action Mailer allows you to send email from your application using a mailer model and views.
@@ -419,6 +420,7 @@ module ActionMailer
   # * <tt>deliver_later_queue_name</tt> - The name of the queue used with <tt>deliver_later</tt>.
   class Base < AbstractController::Base
     include DeliveryMethods
+    include Rescuable
     include Previews
 
     abstract!

data/lib/action_mailer/delivery_job.rb

@@ -3,11 +3,32 @@ require 'active_job'
 module ActionMailer
   # The <tt>ActionMailer::DeliveryJob</tt> class is used when you
   # want to send emails outside of the request-response cycle.
+  #
+  # Exceptions are rescued and handled by the mailer class.
   class DeliveryJob < ActiveJob::Base # :nodoc:
     queue_as { ActionMailer::Base.deliver_later_queue_name }
 
+    rescue_from StandardError, with: :handle_exception_with_mailer_class
+
     def perform(mailer, mail_method, delivery_method, *args) #:nodoc:
       mailer.constantize.public_send(mail_method, *args).send(delivery_method)
     end
+
+    private
+      # "Deserialize" the mailer class name by hand in case another argument
+      # (like a Global ID reference) raised DeserializationError.
+      def mailer_class
+        if mailer = Array(@serialized_arguments).first || Array(arguments).first
+          mailer.constantize
+        end
+      end
+
+      def handle_exception_with_mailer_class(exception)
+        if klass = mailer_class
+          klass.handle_exception exception
+        else
+          raise exception
+        end
+      end
   end
 end

data/lib/action_mailer/gem_version.rb

@@ -8,7 +8,7 @@ module ActionMailer
     MAJOR = 5
     MINOR = 0
     TINY  = 0
-    PRE   = "rc1"
+    PRE   = "rc2"
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end

data/lib/action_mailer/message_delivery.rb

@@ -1,7 +1,6 @@
 require 'delegate'
 
 module ActionMailer
-
   # The <tt>ActionMailer::MessageDelivery</tt> class is used by
   # <tt>ActionMailer::Base</tt> when creating a new mailer.
   # <tt>MessageDelivery</tt> is a wrapper (+Delegator+ subclass) around a lazy
@@ -14,30 +13,35 @@ module ActionMailer
   #   Notifier.welcome(User.first).deliver_later # enqueue email delivery as a job through Active Job
   #   Notifier.welcome(User.first).message       # a Mail::Message object
   class MessageDelivery < Delegator
-    def initialize(mailer, mail_method, *args) #:nodoc:
-      @mailer = mailer
-      @mail_method = mail_method
-      @args = args
-      @obj = nil
+    def initialize(mailer_class, action, *args) #:nodoc:
+      @mailer_class, @action, @args = mailer_class, action, args
+
+      # The mail is only processed if we try to call any methods on it.
+      # Typical usage will leave it unloaded and call deliver_later.
+      @processed_mailer = nil
+      @mail_message = nil
     end
 
+    # Method calls are delegated to the Mail::Message that's ready to deliver.
     def __getobj__ #:nodoc:
-      @obj ||= begin
-                 mailer = @mailer.new
-                 mailer.process @mail_method, *@args
-                 mailer.message
-               end
+      @mail_message ||= processed_mailer.message
     end
 
-    def __setobj__(obj) #:nodoc:
-      @obj = obj
+    # Unused except for delegator internals (dup, marshaling).
+    def __setobj__(mail_message) #:nodoc:
+      @mail_message = mail_message
     end
 
-    # Returns the Mail::Message object
+    # Returns the resulting Mail::Message
     def message
       __getobj__
     end
 
+    # Was the delegate loaded, causing the mailer action to be processed?
+    def processed?
+      @processed_mailer || @mail_message
+    end
+
     # Enqueues the email to be delivered through Active Job. When the
     # job runs it will send the email using +deliver_now!+. That means
     # that the message will be sent bypassing checking +perform_deliveries+
@@ -78,7 +82,9 @@ module ActionMailer
     #   Notifier.welcome(User.first).deliver_now!
     #
     def deliver_now!
-      message.deliver!
+      processed_mailer.handle_exceptions do
+        message.deliver!
+      end
     end
 
     # Delivers an email:
@@ -86,24 +92,33 @@ module ActionMailer
     #   Notifier.welcome(User.first).deliver_now
     #
     def deliver_now
-      message.deliver
+      processed_mailer.handle_exceptions do
+        message.deliver
+      end
     end
 
     private
+      # Returns the processed Mailer instance. We keep this instance
+      # on hand so we can delegate exception handling to it.
+      def processed_mailer
+        @processed_mailer ||= @mailer_class.new.tap do |mailer|
+          mailer.process @action, *@args
+        end
+      end
 
       def enqueue_delivery(delivery_method, options={})
-        if @obj
-          raise "You've accessed the message before asking to deliver it " \
-            "later, so you may have made local changes that would be " \
-            "silently lost if we enqueued a job to deliver it. Why? Only " \
+        if processed?
+          ::Kernel.raise "You've accessed the message before asking to " \
+            "deliver it later, so you may have made local changes that would " \
+            "be silently lost if we enqueued a job to deliver it. Why? Only " \
             "the mailer method *arguments* are passed with the delivery job! " \
             "Do not access the message in any way if you mean to deliver it " \
             "later. Workarounds: 1. don't touch the message before calling " \
             "#deliver_later, 2. only touch the message *within your mailer " \
             "method*, or 3. use a custom Active Job instead of #deliver_later."
         else
-          args = @mailer.name, @mail_method.to_s, delivery_method.to_s, *@args
-          ActionMailer::DeliveryJob.set(options).perform_later(*args)
+          args = @mailer_class.name, @action.to_s, delivery_method.to_s, *@args
+          ::ActionMailer::DeliveryJob.set(options).perform_later(*args)
         end
       end
   end

data/lib/action_mailer/rescuable.rb

@@ -0,0 +1,27 @@
+module ActionMailer #:nodoc:
+  # Provides `rescue_from` for mailers. Wraps mailer action processing,
+  # mail job processing, and mail delivery.
+  module Rescuable
+    extend ActiveSupport::Concern
+    include ActiveSupport::Rescuable
+
+    class_methods do
+      def handle_exception(exception) #:nodoc:
+        rescue_with_handler(exception) || raise(exception)
+      end
+    end
+
+    def handle_exceptions #:nodoc:
+      yield
+    rescue => exception
+      rescue_with_handler(exception) || raise
+    end
+
+    private
+      def process(*)
+        handle_exceptions do
+          super
+        end
+      end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actionmailer
 version: !ruby/object:Gem::Version
-  version: 5.0.0.rc1
+  version: 5.0.0.rc2
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-06 00:00:00.000000000 Z
+date: 2016-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.0.rc1
+        version: 5.0.0.rc2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.0.rc1
+        version: 5.0.0.rc2
 - !ruby/object:Gem::Dependency
   name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.0.rc1
+        version: 5.0.0.rc2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.0.rc1
+        version: 5.0.0.rc2
 - !ruby/object:Gem::Dependency
   name: activejob
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.0.rc1
+        version: 5.0.0.rc2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.0.rc1
+        version: 5.0.0.rc2
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
@@ -114,6 +114,7 @@ files:
 - lib/action_mailer/message_delivery.rb
 - lib/action_mailer/preview.rb
 - lib/action_mailer/railtie.rb
+- lib/action_mailer/rescuable.rb
 - lib/action_mailer/test_case.rb
 - lib/action_mailer/test_helper.rb
 - lib/action_mailer/version.rb
@@ -142,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - none
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Email composition, delivery, and receiving framework (part of Rails).