actionmailer 5.0.7.2 → 5.1.0.beta1

data/lib/action_mailer/collector.rb

@@ -1,6 +1,6 @@
-require 'abstract_controller/collector'
-require 'active_support/core_ext/hash/reverse_merge'
-require 'active_support/core_ext/array/extract_options'
+require "abstract_controller/collector"
+require "active_support/core_ext/hash/reverse_merge"
+require "active_support/core_ext/array/extract_options"
 
 module ActionMailer
   class Collector

data/lib/action_mailer/delivery_job.rb

@@ -1,4 +1,4 @@
-require 'active_job'
+require "active_job"
 
 module ActionMailer
   # The <tt>ActionMailer::DeliveryJob</tt> class is used when you

data/lib/action_mailer/delivery_methods.rb

@@ -1,4 +1,4 @@
-require 'tmpdir'
+require "tmpdir"
 
 module ActionMailer
   # This module handles everything related to mail delivery, from registering
@@ -25,7 +25,7 @@ module ActionMailer
       add_delivery_method :smtp, Mail::SMTP,
         address:              "localhost",
         port:                 25,
-        domain:               'localhost.localdomain',
+        domain:               "localhost.localdomain",
         user_name:            nil,
         password:             nil,
         authentication:       nil,
@@ -35,8 +35,8 @@ module ActionMailer
         location: defined?(Rails.root) ? "#{Rails.root}/tmp/mails" : "#{Dir.tmpdir}/mails"
 
       add_delivery_method :sendmail, Mail::Sendmail,
-        location:  '/usr/sbin/sendmail',
-        arguments: '-i'
+        location:  "/usr/sbin/sendmail",
+        arguments: "-i"
 
       add_delivery_method :test, Mail::TestMailer
     end
@@ -52,14 +52,14 @@ module ActionMailer
       #   add_delivery_method :sendmail, Mail::Sendmail,
       #     location:  '/usr/sbin/sendmail',
       #     arguments: '-i'
-      def add_delivery_method(symbol, klass, default_options={})
+      def add_delivery_method(symbol, klass, default_options = {})
         class_attribute(:"#{symbol}_settings") unless respond_to?(:"#{symbol}_settings")
         send(:"#{symbol}_settings=", default_options)
         self.delivery_methods = delivery_methods.merge(symbol.to_sym => klass).freeze
       end
 
-      def wrap_delivery_behavior(mail, method=nil, options=nil) # :nodoc:
-        method ||= self.delivery_method
+      def wrap_delivery_behavior(mail, method = nil, options = nil) # :nodoc:
+        method ||= delivery_method
         mail.delivery_handler = self
 
         case method

data/lib/action_mailer/gem_version.rb

@@ -6,9 +6,9 @@ module ActionMailer
 
   module VERSION
     MAJOR = 5
-    MINOR = 0
-    TINY  = 7
-    PRE   = "2"
+    MINOR = 1
+    TINY  = 0
+    PRE   = "beta1"
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end

data/lib/action_mailer/inline_preview_interceptor.rb

@@ -1,4 +1,4 @@
-require 'base64'
+require "base64"
 
 module ActionMailer
   # Implements a mailer preview interceptor that converts image tag src attributes
@@ -11,7 +11,7 @@ module ActionMailer
   #   ActionMailer::Base.preview_interceptors.delete(ActionMailer::InlinePreviewInterceptor)
   #
   class InlinePreviewInterceptor
-    PATTERN  = /src=(?:"cid:[^"]+"|'cid:[^']+')/i
+    PATTERN = /src=(?:"cid:[^"]+"|'cid:[^']+')/i
 
     include Base64
 
@@ -26,7 +26,7 @@ module ActionMailer
     def transform! #:nodoc:
       return message if html_part.blank?
 
-      html_source.gsub!(PATTERN) do |match|
+      html_part.body = html_part.decoded.gsub(PATTERN) do |match|
         if part = find_part(match[9..-2])
           %[src="#{data_url(part)}"]
         else
@@ -46,16 +46,12 @@ module ActionMailer
         @html_part ||= message.html_part
       end
 
-      def html_source
-        html_part.body.raw_source
-      end
-
       def data_url(part)
         "data:#{part.mime_type};base64,#{strict_encode64(part.body.raw_source)}"
       end
 
       def find_part(cid)
-        message.all_parts.find{ |p| p.attachment? && p.cid == cid }
+        message.all_parts.find { |p| p.attachment? && p.cid == cid }
       end
   end
 end

data/lib/action_mailer/log_subscriber.rb

@@ -1,4 +1,4 @@
-require 'active_support/log_subscriber'
+require "active_support/log_subscriber"
 
 module ActionMailer
   # Implements the ActiveSupport::LogSubscriber for logging notifications when
@@ -7,7 +7,7 @@ module ActionMailer
     # An email was delivered.
     def deliver(event)
       info do
-        recipients = Array(event.payload[:to]).join(', ')
+        recipients = Array(event.payload[:to]).join(", ")
         "Sent mail to #{recipients} (#{event.duration.round(1)}ms)"
       end
 

data/lib/action_mailer/mail_helper.rb

@@ -54,7 +54,7 @@ module ActionMailer
       sentences = [[]]
 
       text.split.each do |word|
-        if sentences.first.present? && (sentences.last + [word]).join(' ').length > len
+        if sentences.first.present? && (sentences.last + [word]).join(" ").length > len
           sentences << [word]
         else
           sentences.last << word

data/lib/action_mailer/message_delivery.rb

@@ -1,4 +1,4 @@
-require 'delegate'
+require "delegate"
 
 module ActionMailer
   # The <tt>ActionMailer::MessageDelivery</tt> class is used by
@@ -56,7 +56,7 @@ module ActionMailer
     # * <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
     # * <tt>:queue</tt> - Enqueue the email on the specified queue
-    def deliver_later!(options={})
+    def deliver_later!(options = {})
       enqueue_delivery :deliver_now!, options
     end
 
@@ -72,7 +72,7 @@ module ActionMailer
     # * <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.
     # * <tt>:queue</tt> - Enqueue the email on the specified queue.
-    def deliver_later(options={})
+    def deliver_later(options = {})
       enqueue_delivery :deliver_now, options
     end
 
@@ -106,7 +106,7 @@ module ActionMailer
         end
       end
 
-      def enqueue_delivery(delivery_method, options={})
+      def enqueue_delivery(delivery_method, options = {})
         if processed?
           ::Kernel.raise "You've accessed the message before asking to " \
             "deliver it later, so you may have made local changes that would " \

data/lib/action_mailer/parameterized.rb

@@ -0,0 +1,152 @@
+module ActionMailer
+  # Provides the option to parameterize mailers in order to share instance variable
+  # setup, processing, and common headers.
+  #
+  # Consider this example that does not use parameterization:
+  #
+  #   class InvitationsMailer < ApplicationMailer
+  #     def account_invitation(inviter, invitee)
+  #       @account = inviter.account
+  #       @inviter = inviter
+  #       @invitee = invitee
+  #
+  #       subject = "#{@inviter.name} invited you to their Basecamp (#{@account.name})"
+  #
+  #       mail \
+  #         subject:   subject,
+  #         to:        invitee.email_address,
+  #         from:      common_address(inviter),
+  #         reply_to:  inviter.email_address_with_name
+  #     end
+  #
+  #     def project_invitation(project, inviter, invitee)
+  #       @account = inviter.account
+  #       @project = project
+  #       @inviter = inviter
+  #       @invitee = invitee
+  #       @summarizer = ProjectInvitationSummarizer.new(@project.bucket)
+  #
+  #       subject = "#{@inviter.name.familiar} added you to a project in Basecamp (#{@account.name})"
+  #
+  #       mail \
+  #         subject:   subject,
+  #         to:        invitee.email_address,
+  #         from:      common_address(inviter),
+  #         reply_to:  inviter.email_address_with_name
+  #     end
+  #
+  #     def bulk_project_invitation(projects, inviter, invitee)
+  #       @account  = inviter.account
+  #       @projects = projects.sort_by(&:name)
+  #       @inviter  = inviter
+  #       @invitee  = invitee
+  #
+  #       subject = "#{@inviter.name.familiar} added you to some new stuff in Basecamp (#{@account.name})"
+  #
+  #       mail \
+  #         subject:   subject,
+  #         to:        invitee.email_address,
+  #         from:      common_address(inviter),
+  #         reply_to:  inviter.email_address_with_name
+  #     end
+  #   end
+  #
+  #   InvitationsMailer.account_invitation(person_a, person_b).deliver_later
+  #
+  # Using parameterized mailers, this can be rewritten as:
+  #
+  #   class InvitationsMailer < ApplicationMailer
+  #     before_action { @inviter, @invitee = params[:inviter], params[:invitee] }
+  #     before_action { @account = params[:inviter].account }
+  #
+  #     default to:       -> { @invitee.email_address },
+  #             from:     -> { common_address(@inviter) },
+  #             reply_to: -> { @inviter.email_address_with_name }
+  #
+  #     def account_invitation
+  #       mail subject: "#{@inviter.name} invited you to their Basecamp (#{@account.name})"
+  #     end
+  #
+  #     def project_invitation
+  #       @project    = params[:project]
+  #       @summarizer = ProjectInvitationSummarizer.new(@project.bucket)
+  #
+  #       mail subject: "#{@inviter.name.familiar} added you to a project in Basecamp (#{@account.name})"
+  #     end
+  #
+  #     def bulk_project_invitation
+  #       @projects = params[:projects].sort_by(&:name)
+  #
+  #       mail subject: "#{@inviter.name.familiar} added you to some new stuff in Basecamp (#{@account.name})"
+  #     end
+  #   end
+  #
+  #   InvitationsMailer.with(inviter: person_a, invitee: person_b).account_invitation.deliver_later
+  module Parameterized
+    extend ActiveSupport::Concern
+
+    included do
+      attr_accessor :params
+    end
+
+    module ClassMethods
+      # Provide the parameters to the mailer in order to use them in the instance methods and callbacks.
+      #
+      #   InvitationsMailer.with(inviter: person_a, invitee: person_b).account_invitation.deliver_later
+      #
+      # See Parameterized documentation for full example.
+      def with(params)
+        ActionMailer::Parameterized::Mailer.new(self, params)
+      end
+    end
+
+    class Mailer # :nodoc:
+      def initialize(mailer, params)
+        @mailer, @params = mailer, params
+      end
+
+      private
+        def method_missing(method_name, *args)
+          if @mailer.action_methods.include?(method_name.to_s)
+            ActionMailer::Parameterized::MessageDelivery.new(@mailer, method_name, @params, *args)
+          else
+            super
+          end
+        end
+
+        def respond_to_missing?(method, include_all = false)
+          @mailer.respond_to?(method, include_all)
+        end
+    end
+
+    class MessageDelivery < ActionMailer::MessageDelivery # :nodoc:
+      def initialize(mailer_class, action, params, *args)
+        super(mailer_class, action, *args)
+        @params = params
+      end
+
+      private
+        def processed_mailer
+          @processed_mailer ||= @mailer_class.new.tap do |mailer|
+            mailer.params = @params
+            mailer.process @action, *@args
+          end
+        end
+
+        def enqueue_delivery(delivery_method, options = {})
+          if processed?
+            super
+          else
+            args = @mailer_class.name, @action.to_s, delivery_method.to_s, @params, *@args
+            ActionMailer::Parameterized::DeliveryJob.set(options).perform_later(*args)
+          end
+        end
+    end
+
+    class DeliveryJob < ActionMailer::DeliveryJob # :nodoc:
+      def perform(mailer, mail_method, delivery_method, params, *args)
+        mailer.constantize.with(params).public_send(mail_method, *args).send(delivery_method)
+      end
+    end
+  end
+end

data/lib/action_mailer/preview.rb

@@ -1,4 +1,4 @@
-require 'active_support/descendants_tracker'
+require "active_support/descendants_tracker"
 
 module ActionMailer
   module Previews #:nodoc:
@@ -34,7 +34,8 @@ module ActionMailer
       # Either a class or a string can be passed in as the Interceptor. If a
       # string is passed in it will be <tt>constantize</tt>d.
       def register_preview_interceptor(interceptor)
-        preview_interceptor = case interceptor
+        preview_interceptor = \
+          case interceptor
           when String, Symbol
             interceptor.to_s.camelize.constantize
           else
@@ -62,7 +63,7 @@ module ActionMailer
       # interceptors will be informed so that they can transform the message
       # as they would if the mail was actually being delivered.
       def call(email)
-        preview = self.new
+        preview = new
         message = preview.public_send(email)
         inform_preview_interceptors(message)
         message
@@ -80,35 +81,35 @@ module ActionMailer
 
       # Returns true if the preview exists.
       def exists?(preview)
-        all.any?{ |p| p.preview_name == preview }
+        all.any? { |p| p.preview_name == preview }
       end
 
       # Find a mailer preview by its underscored class name.
       def find(preview)
-        all.find{ |p| p.preview_name == preview }
+        all.find { |p| p.preview_name == preview }
       end
 
       # Returns the underscored name of the mailer preview without the suffix.
       def preview_name
-        name.sub(/Preview$/, '').underscore
+        name.sub(/Preview$/, "").underscore
       end
 
-      protected
-        def load_previews #:nodoc:
+      private
+        def load_previews
           if preview_path
-            Dir["#{preview_path}/**/*_preview.rb"].each{ |file| require_dependency file }
+            Dir["#{preview_path}/**/*_preview.rb"].each { |file| require_dependency file }
           end
         end
 
-        def preview_path #:nodoc:
+        def preview_path
           Base.preview_path
         end
 
-        def show_previews #:nodoc:
+        def show_previews
           Base.show_previews
         end
 
-        def inform_preview_interceptors(message) #:nodoc:
+        def inform_preview_interceptors(message)
           Base.preview_interceptors.each do |interceptor|
             interceptor.previewing_email(message)
           end

data/lib/action_mailer/railtie.rb

@@ -1,4 +1,4 @@
-require 'active_job/railtie'
+require "active_job/railtie"
 require "action_mailer"
 require "rails"
 require "abstract_controller/railties/routes_helpers"
@@ -18,7 +18,7 @@ module ActionMailer
 
       if app.config.force_ssl
         options.default_url_options ||= {}
-        options.default_url_options[:protocol] ||= 'https'
+        options.default_url_options[:protocol] ||= "https"
       end
 
       options.assets_dir      ||= paths["public"].first
@@ -28,7 +28,7 @@ module ActionMailer
       options.cache_store ||= Rails.cache
 
       if options.show_previews
-        options.preview_path  ||= defined?(Rails.root) ? "#{Rails.root}/test/mailers/previews" : nil
+        options.preview_path ||= defined?(Rails.root) ? "#{Rails.root}/test/mailers/previews" : nil
       end
 
       # make sure readers methods get compiled
@@ -44,7 +44,7 @@ module ActionMailer
         register_preview_interceptors(options.delete(:preview_interceptors))
         register_observers(options.delete(:observers))
 
-        options.each { |k,v| send("#{k}=", v) }
+        options.each { |k, v| send("#{k}=", v) }
       end
 
       ActiveSupport.on_load(:action_dispatch_integration_test) { include ActionMailer::TestCase::ClearTestDeliveries }
@@ -61,8 +61,8 @@ module ActionMailer
 
       if options.show_previews
         app.routes.prepend do
-          get '/rails/mailers'         => "rails/mailers#index", internal: true
-          get '/rails/mailers/*path'   => "rails/mailers#preview", internal: true
+          get "/rails/mailers"         => "rails/mailers#index", internal: true
+          get "/rails/mailers/*path"   => "rails/mailers#preview", internal: true
         end
 
         if options.preview_path

data/lib/action_mailer/test_case.rb

@@ -1,11 +1,11 @@
-require 'active_support/test_case'
-require 'rails-dom-testing'
+require "active_support/test_case"
+require "rails-dom-testing"
 
 module ActionMailer
   class NonInferrableMailerError < ::StandardError
     def initialize(name)
-      super "Unable to determine the mailer to test from #{name}. " +
-        "You'll need to specify it using tests YourMailer in your " +
+      super "Unable to determine the mailer to test from #{name}. " \
+        "You'll need to specify it using tests YourMailer in your " \
         "test case definition"
     end
   end
@@ -21,11 +21,11 @@ module ActionMailer
 
       private
 
-      def clear_test_deliveries
-        if ActionMailer::Base.delivery_method == :test
-          ActionMailer::Base.deliveries.clear
+        def clear_test_deliveries
+          if ActionMailer::Base.delivery_method == :test
+            ActionMailer::Base.deliveries.clear
+          end
         end
-      end
     end
 
     module Behavior
@@ -57,7 +57,7 @@ module ActionMailer
         end
 
         def mailer_class
-          if mailer = self._mailer_class
+          if mailer = _mailer_class
             mailer
           else
             tests determine_default_mailer(name)
@@ -73,38 +73,36 @@ module ActionMailer
         end
       end
 
-      protected
+      private
 
-        def initialize_test_deliveries # :nodoc:
+        def initialize_test_deliveries
           set_delivery_method :test
           @old_perform_deliveries = ActionMailer::Base.perform_deliveries
           ActionMailer::Base.perform_deliveries = true
           ActionMailer::Base.deliveries.clear
         end
 
-        def restore_test_deliveries # :nodoc:
+        def restore_test_deliveries
           restore_delivery_method
           ActionMailer::Base.perform_deliveries = @old_perform_deliveries
         end
 
-        def set_delivery_method(method) # :nodoc:
+        def set_delivery_method(method)
           @old_delivery_method = ActionMailer::Base.delivery_method
           ActionMailer::Base.delivery_method = method
         end
 
-        def restore_delivery_method # :nodoc:
+        def restore_delivery_method
           ActionMailer::Base.deliveries.clear
           ActionMailer::Base.delivery_method = @old_delivery_method
         end
 
-        def set_expected_mail # :nodoc:
+        def set_expected_mail
           @expected = Mail.new
           @expected.content_type ["text", "plain", { "charset" => charset }]
-          @expected.mime_version = '1.0'
+          @expected.mime_version = "1.0"
         end
 
-      private
-
         def charset
           "UTF-8"
         end
@@ -114,7 +112,7 @@ module ActionMailer
         end
 
         def read_fixture(action)
-          IO.readlines(File.join(Rails.root, 'test', 'fixtures', self.class.mailer_class.name.underscore, action))
+          IO.readlines(File.join(Rails.root, "test", "fixtures", self.class.mailer_class.name.underscore, action))
         end
     end