padrino-mailer 0.11.3 → 0.11.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4999c3dcec320d0c662c16b4090d00dd5e9ced37
+  data.tar.gz: cb78ad0c60e2dd5c708f2eeb0b4dc9f531e1905d
+SHA512:
+  metadata.gz: 8f35233554b45bc32089ef1d7024c8a3f1f115d72d11041907dedbcd0f61943f56f269e3edcdf332491a97efa0b644b5952305da2829f432fb8048a98346ae98
+  data.tar.gz: b2b7be9ea7403e1c3aea64809e0fa7cc44b6410b3766c43126293da22cce10b396004e517903543728c81b2281dd7543a8e9ab91e5f42570db42d05ab305c44c

data/README.rdoc

@@ -102,4 +102,4 @@ The mailer also supports the attachment of files and various other options. Be s
 
 == Copyright
 
-Copyright (c) Padrino. See LICENSE for details.
+Copyright (c) 2011-2013 Padrino. See LICENSE for details.

data/lib/padrino-mailer.rb

@@ -7,7 +7,8 @@ require 'padrino-core/support_lite' unless defined?(SupportLite)
 
 module Padrino
   ##
-  # This component uses the +mail+ library to create a powerful but simple mailer within Padrino (and Sinatra).
+  # This component uses the +mail+ library to create a powerful but simple
+  # mailer within Padrino (and Sinatra).
   # There is full support for using plain or html content-types as well as for file attachments.
   #
   # Using the mailer in Padrino has two forms. The 'quick' method requires only use
@@ -23,8 +24,6 @@ module Padrino
   #    end
   #  end
   #
-  # For a more detailed guide, please read the {Padrino Mailer}[http://www.padrinorb.com/guides/padrino-mailer] guide.
-  #
   module Mailer
     class << self
       ##
@@ -38,7 +37,6 @@ module Padrino
       #     register Padrino::Mailer::Helpers
       #   end
       #
-      # @api public
       def registered(app)
         require 'padrino-mailer/base'
         require 'padrino-mailer/helpers'
@@ -53,5 +51,5 @@ module Padrino
       end
       alias :included :registered
     end
-  end # Mailer
-end # Padrino
+  end
+end

data/lib/padrino-mailer/base.rb

@@ -41,11 +41,10 @@ module Padrino
     #
     #  deliver(:sample, :registration, "Bob", "21")
     #
-    # For a more detailed guide, please read the {Padrino Mailer}[http://www.padrinorb.com/guides/padrino-mailer] guide.
-    #
     class Base
       attr_accessor :delivery_settings, :app, :mailer_name, :messages
 
+      ##
       # Constructs a +Mailer+ base object with specified options.
       #
       # @param [Sinatra::Application] app
@@ -56,7 +55,6 @@ module Padrino
       #   The +email+ definitions block.
       #
       # @see Padrino::Mailer::Helpers::ClassMethods#mailer
-      # @api private
       def initialize(app, name, &block)
         @mailer_name = name
         @messages    = {}
@@ -65,7 +63,8 @@ module Padrino
         instance_eval(&block)
       end
 
-      # Defines a mailer object allowing the definition of various email messages that can be delivered.
+      # Defines a mailer object allowing the definition of various email
+      # messages that can be delivered.
       #
       # @param [Symbol] name
       #   The name of this email message.
@@ -81,7 +80,6 @@ module Padrino
       #     render 'birthday'
       #   end
       #
-      # @api public
       def email(name, &block)
         raise "The email '#{name}' is already defined" if self.messages[name].present?
         self.messages[name] = Proc.new { |*attrs|
@@ -94,7 +92,8 @@ module Padrino
       end
       alias :message :email
 
-      # Defines the default attributes for a message in this mailer (including app-wide defaults).
+      # Defines the default attributes for a message in this mailer
+      # (including app-wide defaults).
       #
       # @param [Hash] attributes
       #   The hash of message options to use as default.
@@ -105,7 +104,6 @@ module Padrino
       #     email(:foo) do; end
       #   end
       #
-      # @api public
       def defaults(attributes=nil)
         if attributes.nil? # Retrieve the default values
           @app.respond_to?(:mailer_defaults) ? @app.mailer_defaults.merge(@defaults) : @defaults
@@ -113,6 +111,6 @@ module Padrino
           @defaults = attributes
         end
       end
-    end # Base
-  end # Mailer
-end # Padrino
+    end
+  end
+end

data/lib/padrino-mailer/ext.rb

@@ -12,23 +12,22 @@ module Mail # @private
         settings.views            = File.join(app.views, 'mailers')
         settings.reload_templates = app.reload_templates?
       else
-        # Set a default view for this class
         settings.views = File.expand_path("./mailers")
         settings.reload_templates = true
       end
 
       initialize_template_settings!
 
-      # Run the original initialize
       initialize_without_app(*args, &block)
     end
     alias_method_chain :initialize, :app
 
+    ##
     # Setup like in Sinatra/Padrino apps content_type and template lookup.
     #
     # @example
-    #   # This add a email plain part if a template called bar.plain.* is found
-    #   # and a html part if a template called bar.html.* is found
+    #   # This add an email plain part if a template called bar.plain.* is found
+    #   # and a HTML part if a template called bar.html.* is found
     #   email do
     #     from     'from@email.com'
     #     to       'to@email.com'
@@ -45,6 +44,7 @@ module Mail # @private
       end
     end
 
+    ##
     # Helper to add a text part to a multipart/alternative email. If this and
     # html_part are both defined in a message, then it will be a multipart/alternative
     # message and set itself that way.
@@ -60,7 +60,8 @@ module Mail # @private
                         &block)
     end
 
-    # Helper to add a html part to a multipart/alternative email. If this and
+    ##
+    # Helper to add a HTML part to a multipart/alternative email. If this and
     # text_part are both defined in a message, then it will be a multipart/alternative
     # message and set itself that way.
     #
@@ -87,6 +88,7 @@ module Mail # @private
       end
     end
 
+    ##
     # Allows you to add a part in block form to an existing mail message object.
     #
     # @example
@@ -114,12 +116,14 @@ module Mail # @private
     end
     alias_method_chain :do_delivery, :logging if Padrino.respond_to?(:logger)
 
+    ##
     # Sinatra and Padrino compatibility.
     #
     def settings
       self.class
     end
 
+    ##
     # Sets the message defined template path to the given view path.
     #
     def views(value)
@@ -133,48 +137,56 @@ module Mail # @private
       @_locals = value
     end
 
+    ##
     # Returns the templates for this message.
     #
     def self.templates
       @_templates ||= {}
     end
 
+    ##
     # Sets the message defined template path to the given view path.
     #
     def self.views=(value)
       @_views = value
     end
 
+    ##
     # Returns the template view path defined for this message.
     #
     def self.views
       @_views
     end
 
+    ##
     # Modify whether templates should be reloaded (for development).
     #
     def self.reload_templates=(value)
       @_reload_templates = value
     end
 
+    ##
     # Returns true if the templates will be reloaded; false otherwise.
     #
     def self.reload_templates?
       @_reload_templates
     end
 
+    ##
     # Return the path of this file, only for compatibility with Sinatra rendering methods.
     #
     def self.caller_locations
       [[File.dirname(__FILE__), 1]]
     end
 
+    ##
     # Return the default encoding.
     #
     def self.default_encoding
       "utf-8"
     end
 
+    ##
     # Modify the default attributes for this message (if not explicitly specified).
     #
     def defaults=(attributes)
@@ -182,6 +194,7 @@ module Mail # @private
       @_defaults.each_pair { |k, v| default(k.to_sym, v) } if @_defaults.is_a?(Hash)
     end
 
+    ##
     # Check if we can log.
     #
     def self.logging?
@@ -192,7 +205,9 @@ module Mail # @private
       @_logging = value
     end
 
-    # Shortcut for delivery_method with smarter SMTP overwrites
+    ##
+    # Shortcut for delivery_method with smarter SMTP overwrites.
+    #
     def via(method = nil, settings = {})
       if method.nil?
         delivery_method
@@ -203,6 +218,7 @@ module Mail # @private
       end
     end
 
+    ##
     # If the value is empty return a symbol that represent the content type so:
     #
     #   "text/plain" => :plain
@@ -218,10 +234,11 @@ module Mail # @private
 
     private
 
+    ##
     # Defines the render for the mailer utilizing the padrino 'rendering' module
+    #
     def render(engine, data=nil, options={}, locals={}, &block)
       locals = @_locals if options[:locals].blank? && locals.blank?
-      # Reload templates
       @template_cache.clear if settings.reload_templates?
 
       provides.each do |format|
@@ -235,11 +252,13 @@ module Mail # @private
       self.body = super(engine, data, options, locals, &block) if provides.empty?
     end
 
+    ##
     # Register all special template configurations Padrino has to our fake settings object.
+    #
     def initialize_template_settings!
       Padrino::Rendering.engine_configurations.each do |name, value|
         settings.class.instance_eval { define_method(name) { value } }
       end
     end
-  end # Message
-end # Mail
+  end
+end

data/lib/padrino-mailer/helpers.rb

@@ -8,6 +8,7 @@ module Padrino
         base.extend(ClassMethods)
       end
 
+      ##
       # Delivers an email with the given mail attributes.
       #
       # @param [Hash] mail_attributes
@@ -25,11 +26,11 @@ module Padrino
       #   end
       #
       # @see ClassMethods#email
-      # @api public
       def email(mail_attributes={}, &block)
         settings.email(mail_attributes, &block)
       end
 
+      ##
       # Delivers a mailer message email with the given attributes.
       #
       # @param [Symbol] mailer_name
@@ -44,27 +45,29 @@ module Padrino
       #   deliver(:example, :message, "John")
       #
       # @see ClassMethods#deliver
-      # @api public
       def deliver(mailer_name, message_name, *attributes)
         settings.deliver(mailer_name, message_name, *attributes)
       end
 
-      # Class methods responsible for registering mailers, configuring settings and delivering messages.
+      # Class methods responsible for registering mailers, configuring
+      # settings and delivering messages.
       #
       module ClassMethods
-        def inherited(subclass) # @private
+        def inherited(subclass)
           @_registered_mailers ||= {}
           super(subclass)
         end
 
+        ##
         # Returns all registered mailers for this application.
         #
-        # @private
         def registered_mailers
           @_registered_mailers ||= {}
         end
 
-        # Defines a mailer object allowing the definition of various email messages that can be delivered.
+        ##
+        # Defines a mailer object allowing the definition of various
+        # email messages that can be delivered.
         #
         # @param [Symbol] name
         #   The name of the mailer to initialize.
@@ -80,7 +83,6 @@ module Padrino
         #     end
         #   end
         #
-        # @api public
         def mailer(name, &block)
           mailer                   = Padrino::Mailer::Base.new(self, name, &block)
           mailer.delivery_settings = delivery_settings
@@ -89,6 +91,7 @@ module Padrino
         end
         alias :mailers :mailer
 
+        ##
         # Delivers a mailer message email with the given attributes.
         #
         # @param [Symbol] mailer_name
@@ -102,17 +105,17 @@ module Padrino
         #   deliver(:sample, :birthday, "Joey", 21)
         #   deliver(:example, :message, "John")
         #
-        # @api public
         def deliver(mailer_name, message_name, *attributes)
           message = registered_mailers[mailer_name].messages[message_name].call(*attributes)
           message.delivery_method(*delivery_settings)
           message.deliver
         end
 
+        ##
         # Delivers an email with the given mail attributes with specified and default settings.
         #
         # @param [Hash] mail_attributes
-        #   The attributes for this message (to, from, subject, cc, bcc, body, etc).
+        #   The attributes for this message (to, from, subject, cc, bcc, body, etc.).
         # @param [Proc] block
         #   The block mail attributes for this message.
         #
@@ -128,7 +131,6 @@ module Padrino
         #     body 'path/to/my/template', :locals => { :a => a, :b => b }
         #   end
         #
-        # @api public
         def email(mail_attributes={}, &block)
           message = _padrino_mailer::Message.new(self)
           message.delivery_method(*delivery_settings)
@@ -139,6 +141,7 @@ module Padrino
         end
 
         private
+        ##
         # Returns the parsed delivery method options.
         #
         def delivery_settings
@@ -151,6 +154,6 @@ module Padrino
           end
         end
       end
-    end # Helpers
-  end # Mailer
-end # Padrino
+    end
+  end
+end

data/lib/padrino-mailer/mime.rb

@@ -1,13 +1,13 @@
 module Padrino
   module Mailer
-
+    ##
     # Handles MIME type declarations for mail delivery.
     #
     module Mime
-
+      ##
       # Returns Symbol with mime type if found, otherwise use +fallback+.
       # +mime+ should be the content type like "text/plain"
-      # +fallback+ may be any symbol
+      # +fallback+ may be any symbol.
       #
       # Also see the documentation for {MIME_TYPES}.
       #
@@ -30,6 +30,7 @@ module Padrino
         MIME_TYPES.fetch(mime.to_s.downcase, fallback)
       end
 
+      ##
       # List of common mime-types, selected from various sources
       # according to their usefulness for an email scope.
       #
@@ -42,6 +43,6 @@ module Padrino
         "text/plain" => :plain,
         "text/xml"   => :xml
       }
-    end # Mime
-  end # Mailer
-end # Padrino
+    end
+  end
+end

data/test/test_email.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/helper')
 
 describe "Email" do
 
-  context 'the mailer in a app' do
+  context 'the mailer in an app' do
     should 'send a basic inline email' do
       mock_app do
         register Padrino::Mailer

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: padrino-mailer
 version: !ruby/object:Gem::Version
-  version: 0.11.3
-  prerelease: 
+  version: 0.11.4
 platform: ruby
 authors:
 - Padrino Team
@@ -12,28 +11,25 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-29 00:00:00.000000000 Z
+date: 2013-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: padrino-core
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: 0.11.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: 0.11.4
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -41,7 +37,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -93,28 +88,27 @@ files:
 - test/test_part.rb
 homepage: http://www.padrinorb.com
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --charset=UTF-8
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: padrino-mailer
-rubygems_version: 1.8.25
+rubygems_version: 2.0.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Mailer system for padrino
 test_files:
 - test/fixtures/basic.erb