padrino-mailer 0.7.5 → 0.7.6

data/VERSION

@@ -1 +1 @@
-0.7.5
+0.7.6

data/lib/padrino-mailer/base.rb

@@ -1,49 +1,54 @@
-=begin
-
-This is the abstract class that other mailers will inherit from in order to send mail
-
-You can set the default delivery settings through:
-
-  Padrino::Mailer::Base.smtp_settings = {
-    :host   => 'smtp.yourserver.com',
-    :port   => '25',
-    :user   => 'user',
-    :pass   => 'pass',
-    :auth   => :plain # :plain, :login, :cram_md5, no auth by default
-    :domain => "localhost.localdomain" # the HELO domain provided by the client to the server
-  }
-
-and then all delivered mail will use these settings unless otherwise specified.
-
-=end
-
 module Padrino
   module Mailer
+    ##
+    # This is the abstract class that other mailers will inherit from in order to send mail
+    # 
+    # You can set the default delivery settings through:
+    # 
+    #   Padrino::Mailer::Base.smtp_settings = {
+    #     :host   => 'smtp.yourserver.com',
+    #     :port   => '25',
+    #     :user   => 'user',
+    #     :pass   => 'pass',
+    #     :auth   => :plain # :plain, :login, :cram_md5, no auth by default
+    #     :domain => "localhost.localdomain" # the HELO domain provided by the client to the server
+    #   }
+    # 
+    # and then all delivered mail will use these settings unless otherwise specified.
+    # 
     class Base
+      ##
       # Returns the available mail fields when composing a message
+      # 
       def self.mail_fields
         [:to, :from, :subject, :type, :charset, :via, :attachments]
       end
 
       attr_accessor :mail_attributes
 
-      def initialize(mail_name=nil)
+      def initialize(mail_name=nil) #:nodoc:
         @mail_name = mail_name
         @mail_attributes = {}
       end
 
+      ##
       # Defines a method allowing mail attributes to be set into a hash for use when delivering
+      # 
       self.mail_fields.each do |field|
         define_method(field) { |value| @mail_attributes[field] = value }
       end
 
+      ##
       # Assigns the body key to the mail attributes either with the rendered body from a template or the given string value
+      # 
       def body(body_value)
         @mail_attributes[:body] = Tilt.new(template_path).render(self, body_value.symbolize_keys) if body_value.is_a?(Hash)
         @mail_attributes[:body] = body_value if body_value.is_a?(String)
       end
 
+      ##
       # Returns the path to the email template searched for using glob pattern
+      # 
       def template_path
         Dir[File.join(self.views_path, self.class.name.underscore.split("/").last, "#{@mail_name}.*")].first
       end
@@ -51,25 +56,34 @@ module Padrino
       cattr_accessor :smtp_settings
       cattr_accessor :views_path
 
+      ##
       # Delivers the specified message for mail_name to the intended recipients
       # mail_name corresponds to the name of a defined method within the mailer class
-      # SampleMailer.deliver(:birthday_message)
+      # 
+      # ==== Examples
+      # 
+      #   SampleMailer.deliver(:birthday_message)
+      # 
       def self.deliver(mail_name, *args)
         mail_object = self.new(mail_name)
         mail_object.method(mail_name).call(*args)
         MailObject.new(mail_object.mail_attributes, self.smtp_settings).deliver
       end
 
+      ##
       # Returns true if a mail exists with the name being delivered
+      # 
       def self.respond_to?(method_sym, include_private = false)
         method_sym.to_s =~ /deliver_(.*)/ ? self.method_defined?($1) : super
       end
 
+      ##
       # Handles method missing for a mailer class. Delivers a message based on the method
       # being called i.e #deliver_birthday_message(22) invokes #birthday_message(22) to setup mail object
+      # 
       def self.method_missing(method_sym, *arguments, &block)
         method_sym.to_s =~ /deliver_(.*)/ ? self.deliver($1, *arguments) : super
       end
-    end
-  end
-end
+    end # Base
+  end # Mailer
+end # Padrino

data/lib/padrino-mailer/delivery.rb

@@ -90,6 +90,6 @@ module Padrino
           smtp.finish
         end
       end
-    end
-  end
-end
+    end # Delivery
+  end # Mailer
+end # Padrino

data/lib/padrino-mailer/mail_object.rb

@@ -1,16 +1,34 @@
-# This represents a particular mail object which will need to be sent
-# A mail_object requires the mail attributes and the delivery_settings
-
 module Padrino
   module Mailer
+    ##
+    # This represents a particular mail object which will need to be sent
+    # A mail_object requires the mail attributes and the delivery_settings
+    # 
     class MailObject
+      ##
+      # Initialize a new MailObject
+      # 
+      # ==== Examples
+      # 
+      #   Padrino::Mailer::MailObject.new(
+      #     :subject => "Hey this is my subject",
+      #     :to => "info@padrinorb.org", 
+      #     :from => "foo@bar.com", 
+      #     :body => "This is my body"
+      #   ).deliver
+      # 
       def initialize(mail_attributes={}, smtp_settings={})
         @mail_attributes = mail_attributes.dup
         @smtp_settings = smtp_settings.dup if smtp_settings.present?
       end
 
+      ##
       # Constructs the delivery attributes for the message and then sends the mail
-      # @mail_object.deliver
+      # 
+      # ==== Examples
+      # 
+      #   @mail_object.deliver
+      # 
       def deliver
         @mail_attributes.reverse_merge!(:via => self.delivery_method.to_sym)
         @mail_attributes.reverse_merge!(:smtp => @smtp_settings) if using_smtp?
@@ -18,22 +36,21 @@ module Padrino
       end
 
       protected
+        # Returns the delivery method to use for this mail object
+        # @mo.delivery_method => :smtp || :sendmail
+        def delivery_method
+          @mail_attributes[:via] || (@smtp_settings.present? ? :smtp : :sendmail)
+        end
 
-      # Returns the delivery method to use for this mail object
-      # @mo.delivery_method => :smtp || :sendmail
-      def delivery_method
-        @mail_attributes[:via] || (@smtp_settings.present? ? :smtp : :sendmail)
-      end
+        # Returns true if the mail object is going to be delivered using smtp
+        def using_smtp?
+          delivery_method.to_s =~ /smtp/
+        end
 
-      # Returns true if the mail object is going to be delivered using smtp
-      def using_smtp?
-        delivery_method.to_s =~ /smtp/
-      end
-
-      # Performs the actual email sending
-      def send_mail(delivery_attributes)
-        Delivery.mail(delivery_attributes) && true
-      end
-    end
-  end
-end
+        # Performs the actual email sending
+        def send_mail(delivery_attributes)
+          Delivery.mail(delivery_attributes) && true
+        end
+    end # MailObject
+  end # Mailer
+end # Padrino

data/lib/padrino-mailer.rb

@@ -4,9 +4,18 @@ require 'padrino-core/support_lite'
 Dir[File.dirname(__FILE__) + '/padrino-mailer/**/*.rb'].each { |file| require file }
 
 module Padrino
+  ##
+  # This component uses an enhanced version of the excellent pony library (vendored) for a powerful but simple mailer 
+  # system within Padrino (and Sinatra).
+  # There is full support for using an html content type as well as for file attachments. 
+  # The MailerPlugin has many similarities to ActionMailer but is much lighterweight and (arguably) easier to use.
+  # 
   module Mailer
+    ##
+    # Used Padrino::Application for register Padrino::Mailer::Base::views_path
+    # 
     def self.registered(app)
       Padrino::Mailer::Base::views_path = app.views
     end
-  end  
-end
+  end # Mailer
+end # Padrino

data/padrino-mailer.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{padrino-mailer}
-  s.version = "0.7.5"
+  s.version = "0.7.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Padrino Team", "Nathan Esquenazi", "Davide D'Agostino", "Arthur Chiu"]
-  s.date = %q{2010-02-09}
+  s.date = %q{2010-02-10}
   s.description = %q{Mailer system for padrino allowing easy delivery of application emails}
   s.email = %q{padrinorb@gmail.com}
   s.extra_rdoc_files = [
@@ -49,7 +49,7 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<sinatra>, [">= 0.9.2"])
-      s.add_runtime_dependency(%q<padrino-core>, ["= 0.7.5"])
+      s.add_runtime_dependency(%q<padrino-core>, ["= 0.7.6"])
       s.add_runtime_dependency(%q<tilt>, [">= 0.2"])
       s.add_runtime_dependency(%q<tmail>, [">= 1.2"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
@@ -59,7 +59,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<webrat>, [">= 0.5.1"])
     else
       s.add_dependency(%q<sinatra>, [">= 0.9.2"])
-      s.add_dependency(%q<padrino-core>, ["= 0.7.5"])
+      s.add_dependency(%q<padrino-core>, ["= 0.7.6"])
       s.add_dependency(%q<tilt>, [">= 0.2"])
       s.add_dependency(%q<tmail>, [">= 1.2"])
       s.add_dependency(%q<shoulda>, [">= 0"])
@@ -70,7 +70,7 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<sinatra>, [">= 0.9.2"])
-    s.add_dependency(%q<padrino-core>, ["= 0.7.5"])
+    s.add_dependency(%q<padrino-core>, ["= 0.7.6"])
     s.add_dependency(%q<tilt>, [">= 0.2"])
     s.add_dependency(%q<tmail>, [">= 1.2"])
     s.add_dependency(%q<shoulda>, [">= 0"])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: padrino-mailer
 version: !ruby/object:Gem::Version 
-  version: 0.7.5
+  version: 0.7.6
 platform: ruby
 authors: 
 - Padrino Team
@@ -12,7 +12,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-09 00:00:00 +01:00
+date: 2010-02-10 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,7 +33,7 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        version: 0.7.5
+        version: 0.7.6
     version: 
 - !ruby/object:Gem::Dependency 
   name: tilt