actionmailer 4.1.0.beta2 → 4.1.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d1be44f98a1d15f4147084fe748a4d2bb341f84
-  data.tar.gz: 4f45039a7220de20dd7c39d81637958d81f1a798
+  metadata.gz: a14d6592f23edce89a35a8e248fe9c9aab6ec9db
+  data.tar.gz: 9b164dc18c93ab42fe0202d5ba9be3832ce417cd
 SHA512:
-  metadata.gz: 2aed9b26621ecc7880aa8643667e28f90dcf09495bdffa7bc3d0dfb491abc053fdb44546a47c0f5037c80d462ba5a96c0dd946ccf13ec2fff590ad9b5405eb98
-  data.tar.gz: 5df15c31c6bb1ae07e92ab3cb8c81eaa302736a06cec85b81085232a6ea2d4397e165223a577b78a8026c8d336d82b48c8154eeb3cd9a566a9e2cee5a22f0e77
+  metadata.gz: 8ae74e8854276fced21a93d2994ae4841afe49777b96ca49f7b341ed1241ccaae293546c09a00c877ef9afe8f2f07a68f60832729d5ab6eba073b420897c589a
+  data.tar.gz: ca8bf17a413211b4696fdbf3dc91e9f1310da3dc35fe5c322d6265468fd281a2c01b67920651e7a4f40ae678065d258adc876afac204e2b29ab5c691b03e6024

data/CHANGELOG.md

@@ -1,10 +1,34 @@
-*   Add mailer previews feature based on 37 Signals mail_view gem
+*   Support the use of underscored symbols when registering interceptors and
+    observers like we do elsewhere within Rails.
+
+    *Andrew White*
+
+*   Add the ability to intercept emails before previewing in a similar fashion
+    to how emails can be intercepted before delivery.
+
+    Fixes #13622.
+
+    Example:
+
+        class CSSInlineStyler
+          def self.previewing_email(message)
+            # inline CSS styles
+          end
+        end
+
+        ActionMailer::Base.register_preview_interceptor CSSInlineStyler
+
+    *Andrew White*
+
+*   Add mailer previews feature based on 37 Signals mail_view gem.
 
     *Andrew White*
 
 *   Calling `mail()` without arguments serves as getter for the current mail
     message and keeps previously set headers.
 
+    Fixes #13090.
+
     Example:
 
         class MailerWithCallback < ActionMailer::Base

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2004-2013 David Heinemeier Hansson
+Copyright (c) 2004-2014 David Heinemeier Hansson
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -74,7 +74,7 @@ Or you can just chain the methods together like:
 
 == Setting defaults
 
-It is possible to set default values that will be used in every method in your Action Mailer class. To implement this functionality, you just call the public class method <tt>default</tt> which you get for free from <tt>ActionMailer::Base</tt>. This method accepts a Hash as the parameter. You can use any of the headers e-mail messages has, like <tt>:from</tt> as the key. You can also pass in a string as the key, like "Content-Type", but Action Mailer does this out of the box for you, so you won't need to worry about that. Finally, it is also possible to pass in a Proc that will get evaluated when it is needed.
+It is possible to set default values that will be used in every method in your Action Mailer class. To implement this functionality, you just call the public class method <tt>default</tt> which you get for free from <tt>ActionMailer::Base</tt>. This method accepts a Hash as the parameter. You can use any of the headers email messages have, like <tt>:from</tt> as the key. You can also pass in a string as the key, like "Content-Type", but Action Mailer does this out of the box for you, so you won't need to worry about that. Finally, it is also possible to pass in a Proc that will get evaluated when it is needed.
 
 Note that every value you set with this method will get overwritten if you use the same key in your mailer method.
 

data/lib/action_mailer.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2004-2013 David Heinemeier Hansson
+# Copyright (c) 2004-2014 David Heinemeier Hansson
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/lib/action_mailer/base.rb

@@ -50,8 +50,8 @@ module ActionMailer
   #
   # * <tt>mail</tt> - Allows you to specify email to be sent.
   #
-  # The hash passed to the mail method allows you to specify any header that a Mail::Message
-  # will accept (any valid Email header including optional fields).
+  # The hash passed to the mail method allows you to specify any header that a <tt>Mail::Message</tt>
+  # will accept (any valid email header including optional fields).
   #
   # The mail method, if not passed a block, will inspect your views and send all the views with
   # the same name as the method, so the above action would send the +welcome.text.erb+ view
@@ -229,7 +229,7 @@ module ActionMailer
   # An interceptor class must implement the <tt>:delivering_email(message)</tt> method which will be
   # called before the email is sent, allowing you to make modifications to the email before it hits
   # the delivery agents. Your class should make any needed modifications directly to the passed
-  # in Mail::Message instance.
+  # in <tt>Mail::Message</tt> instance.
   #
   # = Default Hash
   #
@@ -320,13 +320,31 @@ module ActionMailer
   #     end
   #   end
   #
-  # Methods must return a Mail::Message object which can be generated by calling the mailer
+  # 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
   # of <tt>test/mailers/previews</tt>:
   #
   #     config.action_mailer.preview_path = "#{Rails.root}/lib/mailer_previews"
   #
+  # An overview of all previews is accessible at <tt>http://localhost:3000/rails/mailers</tt>
+  # on a running development server instance.
+  #
+  # Previews can also be intercepted in a similar manner as deliveries can be by registering
+  # a preview interceptor that has a <tt>previewing_email</tt> method:
+  #
+  #   class CssInlineStyler
+  #     def self.previewing_email(message)
+  #       # inline CSS styles
+  #     end
+  #   end
+  #
+  #   config.action_mailer.register_preview_interceptor :css_inline_styler
+  #
+  # Note that interceptors need to be registered both with <tt>register_interceptor</tt>
+  # and <tt>register_preview_interceptor</tt> if they should operate on both sending and
+  # previewing emails.
+  #
   # = Configuration options
   #
   # These options are specified on the class level, like
@@ -336,7 +354,7 @@ module ActionMailer
   #   per the above section.
   #
   # * <tt>logger</tt> - the logger is used for generating information on the mailing run if available.
-  #   Can be set to nil for no logging. Compatible with both Ruby's own Logger and Log4r loggers.
+  #   Can be set to +nil+ for no logging. Compatible with both Ruby's own +Logger+ and Log4r loggers.
   #
   # * <tt>smtp_settings</tt> - Allows detailed configuration for <tt>:smtp</tt> delivery method:
   #   * <tt>:address</tt> - Allows you to use a remote mail server. Just change it from its default
@@ -354,8 +372,9 @@ module ActionMailer
   #     and starts to use it.
   #   * <tt>:openssl_verify_mode</tt> - When using TLS, you can set how OpenSSL checks the certificate. This is
   #     really useful if you need to validate a self-signed and/or a wildcard certificate. You can use the name
-  #     of an OpenSSL verify constant ('none', 'peer', 'client_once', 'fail_if_no_peer_cert') or directly the
-  #     constant  (OpenSSL::SSL::VERIFY_NONE, OpenSSL::SSL::VERIFY_PEER, ...).
+  #     of an OpenSSL verify constant (<tt>'none'</tt>, <tt>'peer'</tt>, <tt>'client_once'</tt>,
+  #     <tt>'fail_if_no_peer_cert'</tt>) or directly the constant (<tt>OpenSSL::SSL::VERIFY_NONE</tt>,
+  #     <tt>OpenSSL::SSL::VERIFY_PEER</tt>, ...).
   #
   # * <tt>sendmail_settings</tt> - Allows you to override options for the <tt>:sendmail</tt> delivery method.
   #   * <tt>:location</tt> - The location of the sendmail executable. Defaults to <tt>/usr/sbin/sendmail</tt>.
@@ -370,7 +389,7 @@ module ActionMailer
   #
   # * <tt>delivery_method</tt> - Defines a delivery method. Possible values are <tt>:smtp</tt> (default),
   #   <tt>:sendmail</tt>, <tt>:test</tt>, and <tt>:file</tt>. Or you may provide a custom delivery method
-  #   object e.g. MyOwnDeliveryMethodClass. See the Mail gem documentation on the interface you need to
+  #   object e.g. +MyOwnDeliveryMethodClass+. See the Mail gem documentation on the interface you need to
   #   implement for a custom delivery agent.
   #
   # * <tt>perform_deliveries</tt> - Determines whether emails are actually sent from Action Mailer when you
@@ -425,18 +444,30 @@ module ActionMailer
       end
 
       # Register an Observer which will be notified when mail is delivered.
-      # Either a class or a string can be passed in as the Observer. If a string is passed in
-      # it will be +constantize+d.
+      # Either a class, string or symbol can be passed in as the Observer.
+      # If a string or symbol is passed in it will be camelized and constantized.
       def register_observer(observer)
-        delivery_observer = (observer.is_a?(String) ? observer.constantize : observer)
+        delivery_observer = case observer
+          when String, Symbol
+            observer.to_s.camelize.constantize
+          else
+            observer
+          end
+
         Mail.register_observer(delivery_observer)
       end
 
       # Register an Interceptor which will be called before mail is sent.
-      # 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.
+      # Either a class, string or symbol can be passed in as the Interceptor.
+      # If a string or symbol is passed in it will be camelized and constantized.
       def register_interceptor(interceptor)
-        delivery_interceptor = (interceptor.is_a?(String) ? interceptor.constantize : interceptor)
+        delivery_interceptor = case interceptor
+          when String, Symbol
+            interceptor.to_s.camelize.constantize
+          else
+            interceptor
+          end
+
         Mail.register_interceptor(delivery_interceptor)
       end
 
@@ -484,11 +515,11 @@ module ActionMailer
         end
       end
 
-      # Wraps an email delivery inside of ActiveSupport::Notifications instrumentation.
+      # Wraps an email delivery inside of <tt>ActiveSupport::Notifications</tt> instrumentation.
       #
-      # This method is actually called by the Mail::Message object itself
-      # through a callback when you call +:deliver+ on the Mail::Message,
-      # calling +deliver_mail+ directly and passing a Mail::Message will do
+      # This method is actually called by the <tt>Mail::Message</tt> object itself
+      # through a callback when you call <tt>:deliver</tt> on the <tt>Mail::Message</tt>,
+      # calling +deliver_mail+ directly and passing a <tt>Mail::Message</tt> will do
       # nothing except tell the logger you sent the email.
       def deliver_mail(mail) #:nodoc:
         ActiveSupport::Notifications.instrument("deliver.action_mailer") do |payload|
@@ -564,18 +595,18 @@ module ActionMailer
       self.class.mailer_name
     end
 
-    # Allows you to pass random and unusual headers to the new Mail::Message
+    # Allows you to pass random and unusual headers to the new <tt>Mail::Message</tt>
     # object which will add them to itself.
     #
     #   headers['X-Special-Domain-Specific-Header'] = "SecretValue"
     #
     # You can also pass a hash into headers of header field names and values,
-    # which will then be set on the Mail::Message object:
+    # which will then be set on the <tt>Mail::Message</tt> object:
     #
     #   headers 'X-Special-Domain-Specific-Header' => "SecretValue",
     #           'In-Reply-To' => incoming.message_id
     #
-    # The resulting Mail::Message will have the following in its header:
+    # The resulting <tt>Mail::Message</tt> will have the following in its header:
     #
     #   X-Special-Domain-Specific-Header: SecretValue
     def headers(args = nil)
@@ -664,13 +695,13 @@ module ActionMailer
     # templates in the view paths using by default the mailer name and the
     # method name that it is being called from, it will then create parts for
     # each of these templates intelligently, making educated guesses on correct
-    # content type and sequence, and return a fully prepared Mail::Message
-    # ready to call +:deliver+ on to send.
+    # content type and sequence, and return a fully prepared <tt>Mail::Message</tt>
+    # ready to call <tt>:deliver</tt> on to send.
     #
     # For example:
     #
     #   class Notifier < ActionMailer::Base
-    #     default from: 'no-reply@test.lindsaar.net',
+    #     default from: 'no-reply@test.lindsaar.net'
     #
     #     def welcome
     #       mail(to: 'mikel@test.lindsaar.net')
@@ -733,7 +764,7 @@ module ActionMailer
       m.charset = charset = headers[:charset]
 
       # Set configure delivery behavior
-      wrap_delivery_behavior!(headers.delete(:delivery_method),headers.delete(:delivery_method_options))
+      wrap_delivery_behavior!(headers.delete(:delivery_method), headers.delete(:delivery_method_options))
 
       # Assign all headers except parts_order, content_type and body
       assignable = headers.except(:parts_order, :content_type, :body, :template_name, :template_path)

data/lib/action_mailer/preview.rb

@@ -9,7 +9,32 @@ module ActionMailer
       #
       #     config.action_mailer.preview_path = "#{Rails.root}/lib/mailer_previews"
       #
-      class_attribute :preview_path, instance_writer: false
+      mattr_accessor :preview_path, instance_writer: false
+
+      # :nodoc:
+      mattr_accessor :preview_interceptors, instance_writer: false
+      self.preview_interceptors = []
+
+      # Register one or more Interceptors which will be called before mail is previewed.
+      def register_preview_interceptors(*interceptors)
+        interceptors.flatten.compact.each { |interceptor| register_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.
+      def register_preview_interceptor(interceptor)
+        preview_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
 
@@ -23,10 +48,14 @@ module ActionMailer
         descendants
       end
 
-      # Returns the mail object for the given email name
+      # 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
-        preview.public_send(email)
+        message = preview.public_send(email)
+        inform_preview_interceptors(message)
+        message
       end
 
       # Returns all of the available email previews
@@ -56,12 +85,20 @@ module ActionMailer
 
       protected
         def load_previews #:nodoc:
-          Dir["#{preview_path}/**/*_preview.rb"].each{ |file| require_dependency file }
+          if preview_path
+            Dir["#{preview_path}/**/*_preview.rb"].each{ |file| require_dependency file }
+          end
         end
 
         def preview_path #:nodoc:
           Base.preview_path
         end
+
+        def inform_preview_interceptors(message) #:nodoc:
+          Base.preview_interceptors.each do |interceptor|
+            interceptor.previewing_email(message)
+          end
+        end
     end
   end
 end

data/lib/action_mailer/railtie.rb

@@ -19,6 +19,10 @@ module ActionMailer
       options.javascripts_dir ||= paths["public/javascripts"].first
       options.stylesheets_dir ||= paths["public/stylesheets"].first
 
+      if Rails.env.development?
+        options.preview_path  ||= defined?(Rails.root) ? "#{Rails.root}/test/mailers/previews" : nil
+      end
+
       # make sure readers methods get compiled
       options.asset_host          ||= app.config.asset_host
       options.relative_url_root   ||= app.config.relative_url_root
@@ -41,11 +45,9 @@ module ActionMailer
       end
     end
 
-    initializer "action_mailer.configure_mailer_previews", before: :set_autoload_paths do |app|
-      if Rails.env.development?
-        options = app.config.action_mailer
-        options.preview_path ||= defined?(Rails.root) ? "#{Rails.root}/test/mailers/previews" : nil
-        app.config.autoload_paths << options.preview_path
+    config.after_initialize do
+      if ActionMailer::Base.preview_path
+        ActiveSupport::Dependencies.autoload_paths << ActionMailer::Base.preview_path
       end
     end
   end

data/lib/action_mailer/version.rb

@@ -1,7 +1,7 @@
 module ActionMailer
   # Returns the version of the currently loaded ActionMailer as a Gem::Version
   def self.version
-    Gem::Version.new "4.1.0.beta2"
+    Gem::Version.new "4.1.0.rc1"
   end
 
   module VERSION #:nodoc:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: actionmailer
 version: !ruby/object:Gem::Version
-  version: 4.1.0.beta2
+  version: 4.1.0.rc1
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.1.0.beta2
+        version: 4.1.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.1.0.beta2
+        version: 4.1.0.rc1
 - !ruby/object:Gem::Dependency
   name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.1.0.beta2
+        version: 4.1.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.1.0.beta2
+        version: 4.1.0.rc1
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement