actionmailer 4.2.11.2 → 6.0.2.2

data/lib/action_mailer/parameterized.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+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 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
+
+    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
+            job  = delivery_job_class
+            args = arguments_for(job, delivery_method)
+            job.set(options).perform_later(*args)
+          end
+        end
+
+        def delivery_job_class
+          if @mailer_class.delivery_job <= MailDeliveryJob
+            @mailer_class.delivery_job
+          else
+            Parameterized::DeliveryJob
+          end
+        end
+
+        def arguments_for(delivery_job, delivery_method)
+          if delivery_job <= MailDeliveryJob
+            [@mailer_class.name, @action.to_s, delivery_method.to_s, params: @params, args: @args]
+          else
+            [@mailer_class.name, @action.to_s, delivery_method.to_s, @params, *@args]
+          end
+        end
+    end
+  end
+end

data/lib/action_mailer/preview.rb

@@ -1,4 +1,6 @@
-require 'active_support/descendants_tracker'
+# frozen_string_literal: true
+
+require "active_support/descendants_tracker"
 
 module ActionMailer
   module Previews #:nodoc:
@@ -15,13 +17,12 @@ module ActionMailer
       #
       #     config.action_mailer.show_previews = true
       #
-      # Defaults to true for development environment
+      # Defaults to +true+ for development environment
       #
       mattr_accessor :show_previews, instance_writer: false
 
       # :nodoc:
-      mattr_accessor :preview_interceptors, instance_writer: false
-      self.preview_interceptors = []
+      mattr_accessor :preview_interceptors, instance_writer: false, default: [ActionMailer::InlinePreviewInterceptor]
     end
 
     module ClassMethods
@@ -30,29 +31,53 @@ module ActionMailer
         interceptors.flatten.compact.each { |interceptor| register_preview_interceptor(interceptor) }
       end
 
+      # Unregister one or more previously registered Interceptors.
+      def unregister_preview_interceptors(*interceptors)
+        interceptors.flatten.compact.each { |interceptor| unregister_preview_interceptor(interceptor) }
+      end
+
       # Register an Interceptor which will be called before mail is previewed.
       # 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.
+      # string is passed in it will be constantized.
       def register_preview_interceptor(interceptor)
-        preview_interceptor = case interceptor
+        preview_interceptor = interceptor_class_for(interceptor)
+
+        unless preview_interceptors.include?(preview_interceptor)
+          preview_interceptors << preview_interceptor
+        end
+      end
+
+      # Unregister a previously registered Interceptor.
+      # Either a class or a string can be passed in as the Interceptor. If a
+      # string is passed in it will be constantized.
+      def unregister_preview_interceptor(interceptor)
+        preview_interceptors.delete(interceptor_class_for(interceptor))
+      end
+
+      private
+
+        def interceptor_class_for(interceptor)
+          case interceptor
           when String, Symbol
             interceptor.to_s.camelize.constantize
           else
             interceptor
           end
-
-        unless preview_interceptors.include?(preview_interceptor)
-          preview_interceptors << preview_interceptor
         end
-      end
     end
   end
 
   class Preview
     extend ActiveSupport::DescendantsTracker
 
+    attr_reader :params
+
+    def initialize(params = {})
+      @params = params
+    end
+
     class << self
-      # Returns all mailer preview classes
+      # Returns all mailer preview classes.
       def all
         load_previews if descendants.empty?
         descendants
@@ -61,54 +86,54 @@ module ActionMailer
       # Returns the mail object for the given email name. The registered preview
       # 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
+      def call(email, params = {})
+        preview = new(params)
         message = preview.public_send(email)
         inform_preview_interceptors(message)
         message
       end
 
-      # Returns all of the available email previews
+      # Returns all of the available email previews.
       def emails
         public_instance_methods(false).map(&:to_s).sort
       end
 
-      # Returns true if the email exists
+      # Returns +true+ if the email exists.
       def email_exists?(email)
         emails.include?(email)
       end
 
-      # Returns true if the preview exists
+      # 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
+      # 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
+      # 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"].sort.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,6 @@
-require 'active_job/railtie'
+# frozen_string_literal: true
+
+require "active_job/railtie"
 require "action_mailer"
 require "rails"
 require "abstract_controller/railties/routes_helpers"
@@ -16,13 +18,19 @@ module ActionMailer
       paths   = app.config.paths
       options = app.config.action_mailer
 
+      if app.config.force_ssl
+        options.default_url_options ||= {}
+        options.default_url_options[:protocol] ||= "https"
+      end
+
       options.assets_dir      ||= paths["public"].first
       options.javascripts_dir ||= paths["public/javascripts"].first
       options.stylesheets_dir ||= paths["public/stylesheets"].first
       options.show_previews = Rails.env.development? if options.show_previews.nil?
+      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
@@ -38,14 +46,24 @@ module ActionMailer
         register_preview_interceptors(options.delete(:preview_interceptors))
         register_observers(options.delete(:observers))
 
-        options.each { |k,v| send("#{k}=", v) }
-
-        if options.show_previews
-          app.routes.append do
-            get '/rails/mailers'         => "rails/mailers#index"
-            get '/rails/mailers/*path'   => "rails/mailers#preview"
-          end
+        if delivery_job = options.delete(:delivery_job)
+          self.delivery_job = delivery_job.constantize
         end
+
+        options.each { |k, v| send("#{k}=", v) }
+      end
+
+      ActiveSupport.on_load(:action_dispatch_integration_test) do
+        include ActionMailer::TestHelper
+        include ActionMailer::TestCase::ClearTestDeliveries
+      end
+    end
+
+    initializer "action_mailer.set_autoload_paths" do |app|
+      options = app.config.action_mailer
+
+      if options.show_previews && options.preview_path
+        ActiveSupport::Dependencies.autoload_paths << options.preview_path
       end
     end
 
@@ -55,9 +73,20 @@ module ActionMailer
       end
     end
 
-    config.after_initialize do
-      if ActionMailer::Base.preview_path
-        ActiveSupport::Dependencies.autoload_paths << ActionMailer::Base.preview_path
+    initializer "action_mailer.eager_load_actions" do
+      ActiveSupport.on_load(:after_initialize) do
+        ActionMailer::Base.descendants.each(&:action_methods) if config.eager_load
+      end
+    end
+
+    config.after_initialize do |app|
+      options = app.config.action_mailer
+
+      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
+        end
       end
     end
   end

data/lib/action_mailer/rescuable.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+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

data/lib/action_mailer/test_case.rb

@@ -1,16 +1,35 @@
-require 'active_support/test_case'
-require 'rails-dom-testing'
+# frozen_string_literal: true
+
+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
 
   class TestCase < ActiveSupport::TestCase
+    module ClearTestDeliveries
+      extend ActiveSupport::Concern
+
+      included do
+        setup :clear_test_deliveries
+        teardown :clear_test_deliveries
+      end
+
+      private
+
+        def clear_test_deliveries
+          if ActionMailer::Base.delivery_method == :test
+            ActionMailer::Base.deliveries.clear
+          end
+        end
+    end
+
     module Behavior
       extend ActiveSupport::Concern
 
@@ -24,6 +43,7 @@ module ActionMailer
         setup :initialize_test_deliveries
         setup :set_expected_mail
         teardown :restore_test_deliveries
+        ActiveSupport.run_load_hooks(:action_mailer_test_case, self)
       end
 
       module ClassMethods
@@ -39,7 +59,7 @@ module ActionMailer
         end
 
         def mailer_class
-          if mailer = self._mailer_class
+          if mailer = _mailer_class
             mailer
           else
             tests determine_default_mailer(name)
@@ -55,7 +75,7 @@ module ActionMailer
         end
       end
 
-      protected
+      private
 
         def initialize_test_deliveries
           set_delivery_method :test
@@ -82,11 +102,9 @@ module ActionMailer
         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
@@ -96,7 +114,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