actionmailer 4.2.0.beta1 → 4.2.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b645b4249222f8f9158e506e7ce6f9896b94ffb1
-  data.tar.gz: c37159e974453b38edeb571c2a7856520c80bd40
+  metadata.gz: 0bc83dd8e3d6e0dc2a2c465cec4353f5b5f38b21
+  data.tar.gz: 2d58f9767f0129b86e0b55e8efbc5de107e0e198
 SHA512:
-  metadata.gz: b7be91503097c551664c180a89064411f1a0e0caedcb57568b72a952dbb1ba416e1b0cdb6921caa23eda9cd7cf35cdb7838dfe22e8885805d7bfbe385afbb5e1
-  data.tar.gz: b5f6483b59c93b59c7f290ece2214e96def84c552255f5365b2cf5fe0a02eeb94ace98e024ec223e2f6aaa74dff81d62332dbf1fd85acb2f5cf6fffa23d0eebc
+  metadata.gz: c256f706c7a3e161616067951e18fe8b40492d80888aedcee325063042602e06b807ce3cb780fe278e6d17a4d5bdae371d2687ebe37f6483a02f035588db1cfe
+  data.tar.gz: 38e1ad4db887bf5b561b40a8dceefadee960c1f1f1ac6c427bba146cfd8e21720257789569e9c901740171135e4a230ec542cf2454332c637d5c4adad21453be

data/CHANGELOG.md

@@ -1,11 +1,19 @@
-*   Added #deliver_later in addition to #deliver, which will enqueue a job to render and
-    deliver the mail instead of delivering it right at that moment. The job is enqueued 
-    using the new Active Job framework in Rails, and will use whatever queue is configured for Rails.
-    
+*   Attachments can be added while rendering the mail template.
+
+    Fixes #16974.
+
+    *Christian Felder*
+
+*   Added `#deliver_later`, `#deliver_now` and deprecate `#deliver` in favour of
+    `#deliver_now`. `#deliver_later` will enqueue a job to render and deliver
+    the mail instead of delivering it right at that moment. The job is enqueued
+    using the new Active Job framework in Rails, and will use whatever queue is
+    configured for Rails.
+
     *DHH/Abdelkader Boudih/Cristian Bica*
 
-*   Make ActionMailer::Previews methods class methods. Previously they were
-    instance methods and ActionMailer tries to render a message when they
+*   Make `ActionMailer::Previews` methods class methods. Previously they were
+    instance methods and `ActionMailer` tries to render a message when they
     are called.
 
     *Cristian Bica*

data/README.rdoc

@@ -65,12 +65,12 @@ In order to send mails, you simply call the method and then call +deliver+ on th
 
 Calling the method returns a Mail Message object:
 
-  message = Notifier.welcome("david@loudthinking.com")  # => Returns a Mail::Message object
-  message.deliver                                       # => delivers the email
+  message = Notifier.welcome("david@loudthinking.com")   # => Returns a Mail::Message object
+  message.deliver_now                                    # => delivers the email
 
 Or you can just chain the methods together like:
 
-  Notifier.welcome("david@loudthinking.com").deliver    # Creates the email and sends it immediately
+  Notifier.welcome("david@loudthinking.com").deliver_now # Creates the email and sends it immediately
 
 == Setting defaults
 

data/lib/action_mailer/base.rb

@@ -138,9 +138,20 @@ module ActionMailer
   # Once a mailer action and template are defined, you can deliver your message or create it and save it
   # for delivery later:
   #
-  #   Notifier.welcome(david).deliver # sends the email
-  #   mail = Notifier.welcome(david)  # => a Mail::Message object
-  #   mail.deliver                    # sends the email
+  #   Notifier.welcome(User.first).deliver_now # sends the email
+  #   mail = Notifier.welcome(User.first)      # => an ActionMailer::MessageDelivery object
+  #   mail.deliver_now                    # sends the email
+  #
+  # The <tt>ActionMailer::MessageDelivery</tt> class is a wrapper around a <tt>Mail::Message</tt> object. If
+  # you want direct access to the <tt>Mail::Message</tt> object you can call the <tt>message</tt> method on
+  # the <tt>ActionMailer::MessageDelivery</tt> object.
+  #
+  #   Notifier.welcome(User.first).message     # => a Mail::Message object
+  #
+  # Action Mailer is nicely integrated with Active Job so you can send emails in the background (example: outside
+  # of the request-response cycle, so the user doesn't have to wait on it):
+  #
+  #   Notifier.welcome(User.first).deliver_later # enqueue the email sending to Active Job
   #
   # You never instantiate your mailer class. Rather, you just call the method you defined on the class itself.
   #
@@ -322,8 +333,8 @@ module ActionMailer
   #   end
   #
   # Methods must return a <tt>Mail::Message</tt> object which can be generated by calling the mailer
-  # method without the additional <tt>deliver</tt>. The location of the mailer previews
-  # directory can be configured using the <tt>preview_path</tt> option which has a default
+  # method without the additional <tt>deliver_now</tt> / <tt>deliver_later</tt>. The location of the
+  # mailer previews directory can be configured using the <tt>preview_path</tt> option which has a default
   # of <tt>test/mailers/previews</tt>:
   #
   #   config.action_mailer.preview_path = "#{Rails.root}/lib/mailer_previews"
@@ -764,7 +775,6 @@ module ActionMailer
     def mail(headers = {}, &block)
       return @_message if @_mail_was_called && headers.blank? && !block
 
-      @_mail_was_called = true
       m = @_message
 
       # At the beginning, do not consider class default for content_type
@@ -792,6 +802,8 @@ module ActionMailer
 
       # Render the templates and blocks
       responses = collect_responses(headers, &block)
+      @_mail_was_called = true
+
       create_parts_from_responses(m, responses)
 
       # Setup content type, reapply charset and handle parts order

data/lib/action_mailer/delivery_job.rb

@@ -1,10 +1,10 @@
 require 'active_job'
 
 module ActionMailer
-  class DeliveryJob < ActiveJob::Base
+  class DeliveryJob < ActiveJob::Base #:nodoc:
     queue_as :mailers
 
-    def perform(mailer, mail_method, delivery_method, *args)
+    def perform(mailer, mail_method, delivery_method, *args) #:nodoc#
       mailer.constantize.public_send(mail_method, *args).send(delivery_method)
     end
   end

data/lib/action_mailer/gem_version.rb

@@ -1,5 +1,5 @@
 module ActionMailer
-  # Returns the version of the currently loaded ActionMailer as a <tt>Gem::Version</tt>
+  # Returns the version of the currently loaded Action Mailer as a <tt>Gem::Version</tt>
   def self.gem_version
     Gem::Version.new VERSION::STRING
   end
@@ -8,7 +8,7 @@ module ActionMailer
     MAJOR = 4
     MINOR = 2
     TINY  = 0
-    PRE   = "beta1"
+    PRE   = "beta2"
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end

data/lib/action_mailer/mail_helper.rb

@@ -29,7 +29,7 @@ module ActionMailer
 
     # Access the message attachments list.
     def attachments
-      @_message.attachments
+      mailer.attachments
     end
 
     # Returns +text+ wrapped at +len+ columns and indented +indent+ spaces.

data/lib/action_mailer/message_delivery.rb

@@ -1,45 +1,104 @@
 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
+  # created <tt>Mail::Message</tt>. You can get direct access to the
+  # <tt>Mail::Message</tt>, deliver the email or schedule the email to be sent
+  # through Active Job.
+  #
+  #   Notifier.welcome(User.first)               # an ActionMailer::MessageDelivery object
+  #   Notifier.welcome(User.first).deliver_now   # sends the email
+  #   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)
+    def initialize(mailer, mail_method, *args) #:nodoc:
       @mailer = mailer
       @mail_method = mail_method
       @args = args
     end
 
-    def __getobj__
+    def __getobj__ #:nodoc:
       @obj ||= @mailer.send(:new, @mail_method, *@args).message
     end
 
-    def __setobj__(obj)
+    def __setobj__(obj) #:nodoc:
       @obj = obj
     end
 
-    def message #:nodoc:
+    # Returns the Mail::Message object
+    def message
       __getobj__
     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+
+    # and +raise_delivery_errors+, so use with caution.
+    #
+    #   Notifier.welcome(User.first).deliver_later!
+    #   Notifier.welcome(User.first).deliver_later!(wait: 1.hour)
+    #   Notifier.welcome(User.first).deliver_later!(wait_until: 10.hours.from_now)
+    #
+    # Options:
+    #
+    # * <tt>:wait</tt> - Enqueue the email to be delivered with a delay
+    # * <tt>:wait_until</tt> - Enqueue the email to be delivered at (after) a specific date / time
     def deliver_later!(options={})
-      enqueue_delivery :deliver!, options
+      enqueue_delivery :deliver_now!, options
     end
 
+    # Enqueues the email to be delivered through Active Job. When the
+    # job runs it will send the email using +deliver_now+.
+    #
+    #   Notifier.welcome(User.first).deliver_later
+    #   Notifier.welcome(User.first).deliver_later(wait: 1.hour)
+    #   Notifier.welcome(User.first).deliver_later(wait_until: 10.hours.from_now)
+    #
+    # Options:
+    #
+    # * <tt>:wait</tt> - Enqueue the email to be delivered with a delay
+    # * <tt>:wait_until</tt> - Enqueue the email to be delivered at (after) a specific date / time
     def deliver_later(options={})
-      enqueue_delivery :deliver, options
+      enqueue_delivery :deliver_now, options
+    end
+
+    # Delivers an email without checking +perform_deliveries+ and +raise_delivery_errors+,
+    # so use with caution.
+    #
+    #   Notifier.welcome(User.first).deliver_now!
+    #
+    def deliver_now!
+      message.deliver!
+    end
+
+    # Delivers an email:
+    #
+    #   Notifier.welcome(User.first).deliver_now
+    #
+    def deliver_now
+      message.deliver
+    end
+
+    def deliver! #:nodoc:
+      ActiveSupport::Deprecation.warn "#deliver! is deprecated and will be removed in Rails 5. " \
+        "Use #deliver_now! to deliver immediately or #deliver_later! to deliver through Active Job."
+      deliver_now!
+    end
+
+    def deliver #:nodoc:
+      ActiveSupport::Deprecation.warn "#deliver is deprecated and will be removed in Rails 5. " \
+        "Use #deliver_now to deliver immediately or #deliver_later to deliver through Active Job."
+      deliver_now
     end
 
     private
-    def enqueue_delivery(delivery_method, options={})
-      args = @mailer.name, @mail_method.to_s, delivery_method.to_s, *@args
-      enqueue_method = :enqueue
-      if options[:at]
-        enqueue_method = :enqueue_at
-        args.unshift options[:at]
-      elsif options[:in]
-        enqueue_method = :enqueue_in
-        args.unshift options[:in]
+
+      def enqueue_delivery(delivery_method, options={})
+        args = @mailer.name, @mail_method.to_s, delivery_method.to_s, *@args
+        ActionMailer::DeliveryJob.set(options).perform_later(*args)
       end
-      ActionMailer::DeliveryJob.send enqueue_method, *args
-    end
   end
 end

data/lib/action_mailer/railtie.rb

@@ -1,3 +1,4 @@
+require 'active_job/railtie'
 require "action_mailer"
 require "rails"
 require "abstract_controller/railties/routes_helpers"

data/lib/action_mailer/test_helper.rb

@@ -6,9 +6,9 @@ module ActionMailer
     #
     #   def test_emails
     #     assert_emails 0
-    #     ContactMailer.welcome.deliver
+    #     ContactMailer.welcome.deliver_now
     #     assert_emails 1
-    #     ContactMailer.welcome.deliver
+    #     ContactMailer.welcome.deliver_now
     #     assert_emails 2
     #   end
     #
@@ -17,12 +17,12 @@ module ActionMailer
     #
     #   def test_emails_again
     #     assert_emails 1 do
-    #       ContactMailer.welcome.deliver
+    #       ContactMailer.welcome.deliver_now
     #     end
     #
     #     assert_emails 2 do
-    #       ContactMailer.welcome.deliver
-    #       ContactMailer.welcome.deliver
+    #       ContactMailer.welcome.deliver_now
+    #       ContactMailer.welcome.deliver_now
     #     end
     #   end
     def assert_emails(number)
@@ -40,7 +40,7 @@ module ActionMailer
     #
     #   def test_emails
     #     assert_no_emails
-    #     ContactMailer.welcome.deliver
+    #     ContactMailer.welcome.deliver_now
     #     assert_emails 1
     #   end
     #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actionmailer
 version: !ruby/object:Gem::Version
-  version: 4.2.0.beta1
+  version: 4.2.0.beta2
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-20 00:00:00.000000000 Z
+date: 2014-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0.beta1
+        version: 4.2.0.beta2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0.beta1
+        version: 4.2.0.beta2
 - !ruby/object:Gem::Dependency
   name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0.beta1
+        version: 4.2.0.beta2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0.beta1
+        version: 4.2.0.beta2
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.0.beta2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.0.beta2
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +81,7 @@ dependencies:
         version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 1.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -77,7 +91,7 @@ dependencies:
         version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 1.0.3
 description: Email on Rails. Compose, deliver, receive, and test emails using the
   familiar controller/view pattern. First-class support for multipart email and attachments.
 email: david@loudthinking.com