actionmailer 2.3.18 → 3.0.0.beta

data/lib/action_mailer/collector.rb

@@ -0,0 +1,36 @@
+require 'abstract_controller/collector'
+require 'active_support/core_ext/hash/reverse_merge'
+require 'active_support/core_ext/array/extract_options'
+
+module ActionMailer #:nodoc:
+  class Collector
+    include AbstractController::Collector
+    attr_reader :responses
+
+    def initialize(context, &block)
+      @context = context
+      @responses = []
+      @default_render = block
+      @default_formats = context.formats
+    end
+
+    def any(*args, &block)
+      options = args.extract_options!
+      raise "You have to supply at least one format" if args.empty?
+      args.each { |type| send(type, options.dup, &block) }
+    end
+    alias :all :any
+
+    def custom(mime, options={}, &block)
+      options.reverse_merge!(:content_type => mime.to_s)
+      @context.formats = [mime.to_sym]
+      options[:body] = if block
+        block.call
+      else
+        @default_render.call
+      end
+      @responses << options
+      @context.formats = @default_formats
+    end
+  end
+end

data/lib/action_mailer/delivery_methods.rb

@@ -0,0 +1,86 @@
+require 'tmpdir'
+
+module ActionMailer
+  # This modules handles everything related to the delivery, from registering new
+  # delivery methods to configuring the mail object to be sent.
+  module DeliveryMethods
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :delivery_methods, :delivery_method
+
+      # Do not make this inheritable, because we always want it to propagate
+      cattr_accessor :raise_delivery_errors
+      self.raise_delivery_errors = true
+
+      cattr_accessor :perform_deliveries
+      self.perform_deliveries = true
+
+      self.delivery_methods = {}.freeze
+      self.delivery_method  = :smtp
+
+      add_delivery_method :smtp, Mail::SMTP,
+        :address              => "localhost",
+        :port                 => 25,
+        :domain               => 'localhost.localdomain',
+        :user_name            => nil,
+        :password             => nil,
+        :authentication       => nil,
+        :enable_starttls_auto => true
+
+      add_delivery_method :file, Mail::FileDelivery,
+        :location => defined?(Rails.root) ? "#{Rails.root}/tmp/mails" : "#{Dir.tmpdir}/mails"
+
+      add_delivery_method :sendmail, Mail::Sendmail,
+        :location   => '/usr/sbin/sendmail',
+        :arguments  => '-i -t'
+
+      add_delivery_method :test, Mail::TestMailer
+    end
+
+    module ClassMethods
+      # Provides a list of emails that have been delivered by Mail::TestMailer
+      delegate :deliveries, :deliveries=, :to => Mail::TestMailer
+
+      # Adds a new delivery method through the given class using the given symbol
+      # as alias and the default options supplied:
+      #
+      # Example:
+      # 
+      #   add_delivery_method :sendmail, Mail::Sendmail,
+      #     :location   => '/usr/sbin/sendmail',
+      #     :arguments  => '-i -t'
+      # 
+      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) #:nodoc:
+        method ||= self.delivery_method
+        mail.delivery_handler = self
+
+        case method
+        when NilClass
+          raise "Delivery method cannot be nil"
+        when Symbol
+          if klass = delivery_methods[method.to_sym]
+            mail.delivery_method(klass, send(:"#{method}_settings"))
+          else
+            raise "Invalid delivery method #{method.inspect}"
+          end
+        else
+          mail.delivery_method(method)
+        end
+
+        mail.perform_deliveries    = perform_deliveries
+        mail.raise_delivery_errors = raise_delivery_errors
+      end
+    end
+
+    def wrap_delivery_behavior!(*args) #:nodoc:
+      self.class.wrap_delivery_behavior(message, *args)
+    end
+  end
+end

data/lib/action_mailer/deprecated_api.rb

@@ -0,0 +1,139 @@
+module ActionMailer
+  # This is the API which is deprecated and is going to be removed on Rails 3.1 release.
+  # Part of the old API will be deprecated after 3.1, for a smoother deprecation process.
+  # Chech those in OldApi instead.
+  module DeprecatedApi #:nodoc:
+    extend ActiveSupport::Concern
+
+    included do
+      [:charset, :content_type, :mime_version, :implicit_parts_order].each do |method|
+        class_eval <<-FILE, __FILE__, __LINE__ + 1
+          def self.default_#{method}
+            @@default_#{method}
+          end
+
+          def self.default_#{method}=(value)
+            ActiveSupport::Deprecation.warn "ActionMailer::Base.default_#{method}=value is deprecated, " <<
+              "use default :#{method} => value instead"
+            @@default_#{method} = value
+          end
+
+          @@default_#{method} = nil
+        FILE
+      end
+    end
+
+    module ClassMethods
+      # Deliver the given mail object directly. This can be used to deliver
+      # a preconstructed mail object, like:
+      #
+      #   email = MyMailer.create_some_mail(parameters)
+      #   email.set_some_obscure_header "frobnicate"
+      #   MyMailer.deliver(email)
+      def deliver(mail, show_warning=true)
+        if show_warning
+          ActiveSupport::Deprecation.warn "#{self}.deliver is deprecated, call " <<
+            "deliver in the mailer instance instead", caller[0,2]
+        end
+
+        raise "no mail object available for delivery!" unless mail
+        wrap_delivery_behavior(mail)
+        mail.deliver
+        mail
+      end
+
+      def template_root
+        self.view_paths && self.view_paths.first
+      end
+
+      def template_root=(root)
+        ActiveSupport::Deprecation.warn "template_root= is deprecated, use prepend_view_path instead", caller[0,2]
+        self.view_paths = ActionView::Base.process_view_paths(root)
+      end
+
+      def respond_to?(method_symbol, include_private = false)
+        matches_dynamic_method?(method_symbol) || super
+      end
+
+      def method_missing(method_symbol, *parameters)
+        if match = matches_dynamic_method?(method_symbol)
+          case match[1]
+            when 'create'
+              ActiveSupport::Deprecation.warn "#{self}.create_#{match[2]} is deprecated, " <<
+                "use #{self}.#{match[2]} instead", caller[0,2]
+              new(match[2], *parameters).message
+            when 'deliver'
+              ActiveSupport::Deprecation.warn "#{self}.deliver_#{match[2]} is deprecated, " <<
+                "use #{self}.#{match[2]}.deliver instead", caller[0,2]
+              new(match[2], *parameters).message.deliver
+            else super
+          end
+        else
+          super
+        end
+      end
+
+    private
+
+      def matches_dynamic_method?(method_name)
+        method_name = method_name.to_s
+        /^(create|deliver)_([_a-z]\w*)/.match(method_name) || /^(new)$/.match(method_name)
+      end
+    end
+
+    # Delivers a Mail object. By default, it delivers the cached mail
+    # object (from the <tt>create!</tt> method). If no cached mail object exists, and
+    # no alternate has been given as the parameter, this will fail.
+    def deliver!(mail = @_message)
+      ActiveSupport::Deprecation.warn "Calling deliver in the AM::Base object is deprecated, " <<
+        "please call deliver in the Mail instance", caller[0,2]
+      self.class.deliver(mail, false)
+    end
+    alias :deliver :deliver!
+
+    def render(*args)
+      options = args.last.is_a?(Hash) ? args.last : {}
+
+      if options[:body].is_a?(Hash)
+        ActiveSupport::Deprecation.warn(':body in render deprecated. Please use instance ' <<
+                                        'variables as assigns instead', caller[0,1])
+
+        options[:body].each { |k,v| instance_variable_set(:"@#{k}", v) }
+      end
+      super
+    end
+
+    # Render a message but does not set it as mail body. Useful for rendering
+    # data for part and attachments.
+    #
+    # Examples:
+    #
+    #   render_message "special_message"
+    #   render_message :template => "special_message"
+    #   render_message :inline => "<%= 'Hi!' %>"
+    #
+    def render_message(*args)
+      ActiveSupport::Deprecation.warn "render_message is deprecated, use render instead", caller[0,2]
+      render(*args)
+    end
+
+  private
+
+    def initialize_defaults(*)
+      @charset              ||= self.class.default_charset.try(:dup)
+      @content_type         ||= self.class.default_content_type.try(:dup)
+      @implicit_parts_order ||= self.class.default_implicit_parts_order.try(:dup)
+      @mime_version         ||= self.class.default_mime_version.try(:dup)
+      super
+    end
+
+    def create_parts
+      if @body.is_a?(Hash) && !@body.empty?
+        ActiveSupport::Deprecation.warn "Giving a hash to body is deprecated, please use instance variables instead", caller[0,2]
+        @body.each { |k, v| instance_variable_set(:"@#{k}", v) }
+      end
+      super
+    end
+
+  end
+end

data/lib/action_mailer/mail_helper.rb

@@ -1,17 +1,29 @@
-module MailHelper
-  # Uses Text::Format to take the text and format it, indented two spaces for
-  # each line, and wrapped at 72 columns.
-  def block_format(text)
-    formatted = text.split(/\n\r\n/).collect { |paragraph| 
-      Text::Format.new(
-        :columns => 72, :first_indent => 2, :body_indent => 2, :text => paragraph
-      ).format
-    }.join("\n")
+module ActionMailer
+  module MailHelper
+    # Uses Text::Format to take the text and format it, indented two spaces for
+    # each line, and wrapped at 72 columns.
+    def block_format(text)
+      formatted = text.split(/\n\r\n/).collect { |paragraph|
+        Text::Format.new(
+          :columns => 72, :first_indent => 2, :body_indent => 2, :text => paragraph
+        ).format
+      }.join("\n")
     
-    # Make list points stand on their own line
-    formatted.gsub!(/[ ]*([*]+) ([^*]*)/) { |s| "  #{$1} #{$2.strip}\n" }
-    formatted.gsub!(/[ ]*([#]+) ([^#]*)/) { |s| "  #{$1} #{$2.strip}\n" }
+      # Make list points stand on their own line
+      formatted.gsub!(/[ ]*([*]+) ([^*]*)/) { |s| "  #{$1} #{$2.strip}\n" }
+      formatted.gsub!(/[ ]*([#]+) ([^#]*)/) { |s| "  #{$1} #{$2.strip}\n" }
+ 
+      formatted
+    end
 
-    formatted
+    # Access the mailer instance.
+    def mailer
+      @_controller
+    end
+
+    # Access the message instance.
+    def message
+      @_message
+    end
   end
 end

data/lib/action_mailer/old_api.rb

@@ -0,0 +1,248 @@
+require 'active_support/core_ext/object/try'
+
+module ActionMailer
+  module OldApi #:nodoc:
+    extend ActiveSupport::Concern
+
+    included do
+      extend ActionMailer::AdvAttrAccessor
+
+      @@protected_instance_variables = %w(@parts)
+      cattr_reader :protected_instance_variables
+
+      # Specify the BCC addresses for the message
+      adv_attr_accessor :bcc
+
+      # Specify the CC addresses for the message.
+      adv_attr_accessor :cc
+
+      # Specify the charset to use for the message. This defaults to the
+      # +default_charset+ specified for ActionMailer::Base.
+      adv_attr_accessor :charset
+
+      # Specify the content type for the message. This defaults to <tt>text/plain</tt>
+      # in most cases, but can be automatically set in some situations.
+      adv_attr_accessor :content_type
+
+      # Specify the from address for the message.
+      adv_attr_accessor :from
+
+      # Specify the address (if different than the "from" address) to direct
+      # replies to this message.
+      adv_attr_accessor :reply_to
+
+      # Specify additional headers to be added to the message.
+      adv_attr_accessor :headers
+
+      # Specify the order in which parts should be sorted, based on content-type.
+      # This defaults to the value for the +default_implicit_parts_order+.
+      adv_attr_accessor :implicit_parts_order
+
+      # Defaults to "1.0", but may be explicitly given if needed.
+      adv_attr_accessor :mime_version
+
+      # The recipient addresses for the message, either as a string (for a single
+      # address) or an array (for multiple addresses).
+      adv_attr_accessor :recipients
+
+      # The date on which the message was sent. If not set (the default), the
+      # header will be set by the delivery agent.
+      adv_attr_accessor :sent_on
+
+      # Specify the subject of the message.
+      adv_attr_accessor :subject
+
+      # Specify the template name to use for current message. This is the "base"
+      # template name, without the extension or directory, and may be used to
+      # have multiple mailer methods share the same template.
+      adv_attr_accessor :template
+
+      # Override the mailer name, which defaults to an inflected version of the
+      # mailer's class name. If you want to use a template in a non-standard
+      # location, you can use this to specify that location.
+      adv_attr_accessor :mailer_name
+
+      # Define the body of the message. This is either a Hash (in which case it
+      # specifies the variables to pass to the template when it is rendered),
+      # or a string, in which case it specifies the actual text of the message.
+      adv_attr_accessor :body
+
+      # Alias controller_path to mailer_name so render :partial in views work.
+      alias :controller_path :mailer_name
+    end
+
+    def process(method_name, *args)
+      initialize_defaults(method_name)
+      super
+      unless @mail_was_called
+        create_parts
+        create_mail
+      end
+      @_message
+    end
+
+    # Add a part to a multipart message, with the given content-type. The
+    # part itself is yielded to the block so that other properties (charset,
+    # body, headers, etc.) can be set on it.
+    def part(params)
+      params = {:content_type => params} if String === params
+
+      if custom_headers = params.delete(:headers)
+        params.merge!(custom_headers)
+      end
+
+      part = Mail::Part.new(params)
+
+      yield part if block_given?
+      @parts << part
+    end
+
+    # Add an attachment to a multipart message. This is simply a part with the
+    # content-disposition set to "attachment".
+    def attachment(params, &block)
+      params = { :content_type => params } if String === params
+
+      params[:content] ||= params.delete(:data) || params.delete(:body)
+
+      if params[:filename]
+        params = normalize_file_hash(params)
+      else
+        params = normalize_nonfile_hash(params)
+      end
+
+      part(params, &block)
+    end
+
+  protected
+
+    def normalize_nonfile_hash(params)
+      content_disposition = "attachment;"
+      
+      mime_type = params.delete(:mime_type)
+      
+      if content_type = params.delete(:content_type)
+        content_type = "#{mime_type || content_type};"
+      end
+
+      params[:body] = params.delete(:data) if params[:data]
+      
+      { :content_type => content_type,
+        :content_disposition => content_disposition }.merge(params)
+    end
+    
+    def normalize_file_hash(params)
+      filename = File.basename(params.delete(:filename))
+      content_disposition = "attachment; filename=\"#{File.basename(filename)}\""
+      
+      mime_type = params.delete(:mime_type)
+      
+      if (content_type = params.delete(:content_type)) && (content_type !~ /filename=/)
+        content_type = "#{mime_type || content_type}; filename=\"#{filename}\""
+      end
+      
+      params[:body] = params.delete(:data) if params[:data]
+      
+      { :content_type => content_type,
+        :content_disposition => content_disposition }.merge(params)
+    end
+    
+    def create_mail 
+      m = @_message
+
+      quote_fields!({:subject => subject, :to => recipients, :from => from,
+                    :bcc => bcc, :cc => cc, :reply_to => reply_to}, charset)
+
+      m.mime_version = mime_version    unless mime_version.nil?
+      m.date         = sent_on.to_time rescue sent_on if sent_on
+
+      @headers.each { |k, v| m[k] = v }
+
+      real_content_type, ctype_attrs = parse_content_type
+      main_type, sub_type = split_content_type(real_content_type)
+
+      if @parts.size == 1 && @parts.first.parts.empty?
+        m.content_type([main_type, sub_type, ctype_attrs])
+        m.body = @parts.first.body.encoded
+      else
+        @parts.each do |p|
+          m.add_part(p)
+        end
+
+        m.body.set_sort_order(@implicit_parts_order)
+        m.body.sort_parts!
+
+        if real_content_type =~ /multipart/
+          ctype_attrs.delete "charset"
+          m.content_type([main_type, sub_type, ctype_attrs])
+        end
+      end
+
+      wrap_delivery_behavior!
+      m.content_transfer_encoding = '8bit' unless m.body.only_us_ascii?
+      
+      @_message
+    end
+    
+    # Set up the default values for the various instance variables of this
+    # mailer. Subclasses may override this method to provide different
+    # defaults.
+    def initialize_defaults(method_name) 
+      @charset              ||= self.class.default[:charset].try(:dup)
+      @content_type         ||= self.class.default[:content_type].try(:dup)
+      @implicit_parts_order ||= self.class.default[:parts_order].try(:dup)
+      @mime_version         ||= self.class.default[:mime_version].try(:dup)
+
+      @mailer_name   ||= self.class.mailer_name.dup
+      @template      ||= method_name
+      @mail_was_called = false
+
+      @parts   ||= []
+      @headers ||= {}
+      @sent_on ||= Time.now
+      @body ||= {}
+    end
+
+    def create_parts 
+      if String === @body
+        @parts.unshift create_inline_part(@body)
+      elsif @parts.empty? || @parts.all? { |p| p.content_disposition =~ /^attachment/ }
+        self.class.view_paths.first.find_all(@template, {}, @mailer_name).each do |template|
+          @parts << create_inline_part(render_to_body(:_template => template), template.mime_type)
+        end
+
+        if @parts.size > 1
+          @content_type = "multipart/alternative" if @content_type !~ /^multipart/
+        end
+
+        # If this is a multipart e-mail add the mime_version if it is not
+        # already set.
+        @mime_version ||= "1.0" if !@parts.empty?
+      end
+    end
+
+    def create_inline_part(body, mime_type=nil) 
+      ct = mime_type || "text/plain"
+      main_type, sub_type = split_content_type(ct.to_s)
+
+      Mail::Part.new(
+        :content_type => [main_type, sub_type, {:charset => charset}],
+        :content_disposition => "inline",
+        :body => body
+      )
+    end
+
+    def split_content_type(ct) 
+      ct.to_s.split("/")
+    end
+
+    def parse_content_type(defaults=nil) 
+      if @content_type.blank?
+        [ nil, {} ]
+      else
+        ctype, *attrs = @content_type.split(/;\s*/)
+        attrs = attrs.inject({}) { |h,s| k,v = s.split(/\=/, 2); h[k] = v; h }
+        [ctype, {"charset" => @charset}.merge(attrs)]
+      end
+    end
+  end
+end

data/lib/action_mailer/quoting.rb

@@ -1,6 +1,8 @@
-# encoding: us-ascii
 module ActionMailer
   module Quoting #:nodoc:
+    # TODO extract this into Mail itself.
+    # 
+    # 
     # Convert the given text into quoted printable format, with an instruction
     # that the text be eventually interpreted in the given charset.
     def quoted_printable(text, charset)
@@ -44,7 +46,7 @@ module ActionMailer
     # "to", "from", "cc", "bcc" and "reply-to" headers.
     def quote_address_if_necessary(address, charset)
       if Array === address
-        address.map { |a| quote_address_if_necessary(a, charset) }
+        address.map { |a| quote_address_if_necessary(a, charset) }.join(", ")
       elsif address =~ /^(\S.*)\s+(<.*>)$/
         address = $2
         phrase = quote_if_necessary($1.gsub(/^['"](.*)['"]$/, '\1'), charset)

data/lib/action_mailer/railtie.rb

@@ -0,0 +1,25 @@
+require "action_mailer"
+require "rails"
+
+module ActionMailer
+  class Railtie < Rails::Railtie
+    railtie_name :action_mailer
+
+    require "action_mailer/railties/subscriber"
+    subscriber ActionMailer::Railties::Subscriber.new
+
+    initializer "action_mailer.logger" do
+      ActionMailer::Base.logger ||= Rails.logger
+    end
+
+    initializer "action_mailer.set_configs" do |app|
+      app.config.action_mailer.each do |k,v|
+        ActionMailer::Base.send "#{k}=", v
+      end
+    end
+
+    initializer "action_mailer.url_for" do |app|
+      ActionMailer::Base.send(:include, ActionController::UrlFor) if defined?(ActionController)
+    end
+  end
+end

data/lib/action_mailer/railties/subscriber.rb

@@ -0,0 +1,20 @@
+module ActionMailer
+  module Railties
+    class Subscriber < Rails::Subscriber
+      def deliver(event)
+        recipients = Array(event.payload[:to]).join(', ')
+        info("\nSent mail to #{recipients} (%1.fms)" % event.duration)
+        debug(event.payload[:mail])
+      end
+
+      def receive(event)
+        info("\nReceived mail (%.1fms)" % event.duration)
+        debug(event.payload[:mail])
+      end
+
+      def logger
+        ActionMailer::Base.logger
+      end
+    end
+  end
+end

data/lib/action_mailer/test_case.rb

@@ -1,5 +1,3 @@
-require 'active_support/test_case'
-
 module ActionMailer
   class NonInferrableMailerError < ::StandardError
     def initialize(name)
@@ -39,12 +37,12 @@ module ActionMailer
       def initialize_test_deliveries
         ActionMailer::Base.delivery_method = :test
         ActionMailer::Base.perform_deliveries = true
-        ActionMailer::Base.deliveries = []
+        ActionMailer::Base.deliveries.clear
       end
 
       def set_expected_mail
-        @expected = TMail::Mail.new
-        @expected.set_content_type "text", "plain", { "charset" => charset }
+        @expected = Mail.new
+        @expected.content_type ["text", "plain", { "charset" => charset }]
         @expected.mime_version = '1.0'
       end
 
@@ -58,7 +56,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
 end

data/lib/action_mailer/test_helper.rb

@@ -58,7 +58,6 @@ module ActionMailer
   end
 end
 
-# TODO: Deprecate this
 module Test
   module Unit
     class TestCase

data/lib/action_mailer/tmail_compat.rb

@@ -0,0 +1,34 @@
+module Mail
+  class Message
+    
+    def set_content_type(*args)
+      ActiveSupport::Deprecation.warn('Message#set_content_type is deprecated, please just call ' <<
+                                      'Message#content_type with the same arguments', caller[0,2])
+      content_type(*args)
+    end
+    
+    alias :old_transfer_encoding :transfer_encoding
+    def transfer_encoding(value = nil)
+      if value
+        ActiveSupport::Deprecation.warn('Message#transfer_encoding is deprecated, please call ' <<
+                                        'Message#content_transfer_encoding with the same arguments', caller[0,2])
+        content_transfer_encoding(value)
+      else
+        old_transfer_encoding
+      end
+    end
+
+    def transfer_encoding=(value)
+      ActiveSupport::Deprecation.warn('Message#transfer_encoding= is deprecated, please call ' <<
+                                      'Message#content_transfer_encoding= with the same arguments', caller[0,2])
+      self.content_transfer_encoding = value
+    end
+
+    def original_filename
+      ActiveSupport::Deprecation.warn('Message#original_filename is deprecated, ' <<
+                                      'please call Message#filename', caller[0,2])
+      filename
+    end
+    
+  end
+end