padrino-mailer 0.16.0.pre4 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a39de3466c63a873148cfe2b7505c63eca732ab67d2eaee4459b40fe18d56fdb
-  data.tar.gz: 9e17be58b8de1b8f76e66abe6ef41d08eab519aa8c7645fad7d9418db55f7b87
+  metadata.gz: c46c1f19967fd458ae6b7a70a8941dca6034e5efe925b2bda5676ac304820259
+  data.tar.gz: 39603fd4d73b1c39ee81079bd2abc23b6f6daa3c5516f3404a4df3dc6c0353f7
 SHA512:
-  metadata.gz: 2dce0ac3d7e5e69b10cb16f0faf11d30724a1a47b85b3720288526626364066ef68ade6ca92fa2a78480d635e1240bd3e9917ba2983d80cf1d31a707a0da387a
-  data.tar.gz: 35fba3bb110e839a078851451ab2e2a7fcb85590d44b5c22eada6308c5c26f9baebd0cc98308eb14ac38c8362d99adedb81060270d7cab8428026da2bc937aee
+  metadata.gz: 1ce813f2e2349a375585cb91a9344cc6e5b4481abd4a696810df88dd4c369c69863ea7002de0069c3f996f90642a99254c25ab523170edbe9dd61a79be942adc
+  data.tar.gz: 3e9f4ea2c1f6400b3003e44557d9edd433d58892473a0c98d33d8e3b6b22efd931b165a2dd874c5e857e063c31ed703a24eb383c0db572615469f64570a6ef82

data/README.rdoc

@@ -13,14 +13,14 @@ Let's take a look at using the Mailer in an application. By default, the Mailer
 command on the server. However, SMTP is also supported using the following configuration:
 
   # Example for configuring gmail smtp
-  set :delivery_method, :smtp => {
-    :address              => "smtp.gmail.com",
-    :port                 => 587,
-    :domain               => 'your.host.name',
-    :user_name            => '<username>',
-    :password             => '<password>',
-    :authentication       => 'plain',
-    :enable_starttls_auto => true
+  set :delivery_method, smtp: {
+    address:              "smtp.gmail.com",
+    port:                 587,
+    domain:               'your.host.name',
+    user_name:            '<username>',
+    password:             '<password>',
+    authentication:       'plain',
+    enable_starttls_auto: true
   }
 
 Once the delivery settings have been defined, the default will become smtp delivery but can be
@@ -33,7 +33,7 @@ Delivering an email from within your controller is simple:
 
   # app/controllers/session.rb
   post :create do
-    email(:to => "john@smith.com", :subject => "Successfully Registered!", :body => "Test Body")
+    email(to: "john@smith.com", subject: "Successfully Registered!", body: "Test Body")
   end
 
 Padrino also supports structured mailer declarations. We can define a new mailer using a <tt>mailer</tt> block.
@@ -41,14 +41,14 @@ Padrino also supports structured mailer declarations. We can define a new mailer
   # app/mailers/sample_mailer.rb
   MyAppName.mailers :sample do
     email :registration do |name|
-      from    'admin@site.com'
-      to      'user@domain.com'
-      subject 'Welcome to the site!'
-      locals  :name => name
-      content_type 'html'        # optional, defaults to plain/text
-      charset 'windows-1252'     # optional, defaults to utf-8
-      via     :sendmail          # optional, smtp if defined otherwise sendmail
-      render  'registration'
+      from         'admin@site.com'
+      to           'user@domain.com'
+      subject      'Welcome to the site!'
+      locals       name: name
+      content_type 'html'             # optional, defaults to plain/text
+      charset      'windows-1252'     # optional, defaults to utf-8
+      via          :sendmail          # optional, smtp if defined otherwise sendmail
+      render       'registration'
     end
   end
 
@@ -69,16 +69,16 @@ In addition to a standard body, Padrino also easily supports multi-part emails:
 Defaults can also be declared on a per-mailer or app-wide basis:
 
   # app/app.rb
-  set :mailer_defaults, :from => 'admin@site.com'
+  set :mailer_defaults, from: 'admin@site.com'
 
   # app/mailers/sample_mailer.rb
   MyAppName.mailers :sample do
-    defaults :content_type => 'html'
+    defaults content_type: 'html'
     email :registration do |name, age|
       # Uses default 'content_type' and 'from' values but can also overwrite them
       to      'user@domain.com'
       subject 'Welcome to the site!'
-      locals  :name => name
+      locals  name: name
       render  'registration'
     end
   end

data/Rakefile

@@ -1 +1 @@
-require File.expand_path(File.dirname(__FILE__) + '/../gem_rake_helper')
+require_relative '../gem_rake_helper'

data/lib/padrino-mailer/base.rb

@@ -5,12 +5,12 @@ module Padrino
     #
     # You can set the default delivery settings from your app through:
     #
-    #  set :delivery_method, :smtp => {
-    #    :address         => 'smtp.yourserver.com',
-    #    :port            => '25',
-    #    :user_name       => 'user',
-    #    :password        => 'pass',
-    #    :authentication  => :plain
+    #  set :delivery_method, smtp: {
+    #    address:        'smtp.yourserver.com',
+    #    port:           '25',
+    #    user_name:      'user',
+    #    password:       'pass',
+    #    authentication: :plain
     #  }
     #
     # or sendmail:
@@ -27,12 +27,12 @@ module Padrino
     #
     #   # app/mailers/sample_mailer.rb
     #   MyAppName.mailers :sample do
-    #     defaults :content_type => 'html'
+    #     defaults content_type: 'html'
     #     email :registration do |name, age|
     #       to      'user@domain.com'
     #       from    'admin@site.com'
     #       subject 'Welcome to the site!'
-    #       locals  :name => name
+    #       locals  name: name
     #       render  'registration'
     #     end
     #   end
@@ -74,15 +74,15 @@ module Padrino
       # @example
       #   email :birthday do |name, age|
       #     subject "Happy Birthday!"
-      #     to   'john@fake.com'
-      #     from 'noreply@birthday.com'
-      #     locals 'name' => name, 'age' => age
+      #     to      'john@fake.com'
+      #     from    'noreply@birthday.com'
+      #     locals  name: name, age: age
       #     render 'birthday'
       #   end
       #
       def email(name, &block)
         raise "The email '#{name}' is already defined" if self.messages[name]
-        self.messages[name] = Proc.new { |*attrs|
+        self.messages[name] = proc { |*attrs|
           message = app.settings._padrino_mailer::Message.new(self.app)
           message.mailer_name = mailer_name
           message.message_name = name
@@ -92,7 +92,7 @@ module Padrino
           message
         }
       end
-      alias :message :email
+      alias message email
 
       # Defines the default attributes for a message in this mailer
       # (including app-wide defaults).
@@ -102,11 +102,11 @@ module Padrino
       #
       # @example
       #   mailer :alternate do
-      #     defaults :from => 'padrino@from.com', :to => 'padrino@to.com'
+      #     defaults from: 'padrino@from.com', to: 'padrino@to.com'
       #     email(:foo) do; end
       #   end
       #
-      def defaults(attributes=nil)
+      def defaults(attributes = nil)
         if attributes.nil? # Retrieve the default values
           @app.respond_to?(:mailer_defaults) ? @app.mailer_defaults.merge(@defaults) : @defaults
         else # updates the default values

data/lib/padrino-mailer/ext.rb

@@ -16,7 +16,7 @@ module Mail # @private
         settings.views            = File.join(app.views, 'mailers')
         settings.reload_templates = app.reload_templates?
       else
-        settings.views = File.expand_path("./mailers")
+        settings.views = File.expand_path('./mailers')
         settings.reload_templates = true
       end
 
@@ -24,8 +24,8 @@ module Mail # @private
 
       initialize_without_app(*args, &block)
     end
-    alias_method :initialize_without_app, :initialize
-    alias_method :initialize, :initialize_with_app
+    alias initialize_without_app initialize
+    alias initialize initialize_with_app
 
     ##
     # Setup like in Sinatra/Padrino apps content_type and template lookup.
@@ -59,9 +59,9 @@ module Mail # @private
     #  text_part { render('multipart/basic.text') }
     #
     def text_part(value = nil, &block)
-      add_resolved_part(:variable     => :text_part,
-                        :value        => value,
-                        :content_type => 'text/plain',
+      add_resolved_part(variable: :text_part,
+                        value: value,
+                        content_type: 'text/plain',
                         &block)
     end
 
@@ -75,18 +75,18 @@ module Mail # @private
     #  html_part { render('multipart/basic.html') }
     #
     def html_part(value = nil, &block)
-      add_resolved_part(:variable     => :html_part,
-                        :value        => value,
-                        :content_type => 'text/html',
+      add_resolved_part(variable: :html_part,
+                        value: value,
+                        content_type: 'text/html',
                         &block)
     end
 
     def add_resolved_part(attributes = {}, &block)
       variable, value, content_type = attributes.values_at(:variable, :value, :content_type)
       if block_given? || value
-        instance_variable_set "@#{variable}", self.part(:content_type => content_type,
-                                                        :body => value,
-                                                        :part_block => block)
+        instance_variable_set "@#{variable}", self.part(content_type: content_type,
+                                                        body: value,
+                                                        part_block: block)
         add_multipart_alternate_header if self.send(variable)
       else
         instance_variable_get("@#{variable}") || find_first_mime_type(content_type)
@@ -98,9 +98,9 @@ module Mail # @private
     #
     # @example
     #  mail = Mail.new do
-    #    part :content_type => "multipart/alternative", :content_disposition => "inline" do |p|
-    #      p.part :content_type => "text/plain", :body => "test text\nline #2"
-    #      p.part :content_type => "text/html", :body => "<b>test</b> HTML<br/>\nline #2"
+    #    part content_type: 'multipart/alternative', content_disposition: 'inline' do |p|
+    #      p.part content_type: 'text/plain', body: "test text\nline #2"
+    #      p.part content_type: 'text/html', body: "<b>test</b> HTML<br/>\nline #2"
     #    end
     #  end
     #
@@ -116,13 +116,14 @@ module Mail # @private
     end
 
     def do_delivery_with_logging
-      logger.debug "Sending email to: #{destinations.join(" ")}"
-      encoded.each_line { |line| logger << ("  " + line.strip) } if logger.debug?
+      logger.debug "Sending email to: #{destinations.join(' ')}"
+      encoded.each_line { |line| logger << "  #{line.strip}" } if logger.debug?
       do_delivery_without_logging
     end
+
     if Padrino.respond_to?(:logger)
-      alias_method :do_delivery_without_logging, :do_delivery
-      alias_method :do_delivery, :do_delivery_with_logging
+      alias do_delivery_without_logging do_delivery
+      alias do_delivery do_delivery_with_logging
     end
 
     ##
@@ -136,7 +137,7 @@ module Mail # @private
     # Sinatra almost compatibility.
     #
     def self.set(name, value)
-      self.class.instance_eval{ define_method(name) { value } unless method_defined?(:erb) }
+      self.class.instance_eval { define_method(name) { value } unless method_defined?(:erb) }
     end
 
     ##
@@ -192,14 +193,14 @@ module Mail # @private
     # Return the path of this file, only for compatibility with Sinatra rendering methods.
     #
     def self.caller_locations
-      [[File.dirname(__FILE__), 1]]
+      [[__dir__, 1]]
     end
 
     ##
     # Return the default encoding.
     #
     def self.default_encoding
-      "utf-8"
+      'utf-8'
     end
 
     ##
@@ -241,20 +242,20 @@ module Mail # @private
     #
     # See Padrino::Mailer::Mime for more usage informations.
     #
-    def content_type_with_symbol(value=nil)
-      value = Padrino::Mailer::Mime::MIME_TYPES.find { |k,v| v == value }[0] rescue value if value.is_a?(Symbol)
+    def content_type_with_symbol(value = nil)
+      value = Padrino::Mailer::Mime::MIME_TYPES.find { |_k, v| v == value }[0] rescue value if value.is_a?(Symbol)
       mime = content_type_without_symbol(value)
       Padrino::Mailer::Mime.mime_type(mime)
     end
-    alias_method :content_type_without_symbol, :content_type
-    alias_method :content_type, :content_type_with_symbol
+    alias content_type_without_symbol content_type
+    alias content_type content_type_with_symbol
 
     private
 
     ##
     # Defines the render for the mailer utilizing the padrino 'rendering' module
     #
-    def render(engine=nil, data=nil, options={}, locals={}, &block)
+    def render(engine = nil, data = nil, options = {}, locals = {}, &block)
       locals = @_locals || {} if !options[:locals] && locals.empty?
       @template_cache.clear if settings.reload_templates?
 
@@ -276,8 +277,8 @@ module Mail # @private
       self.body = super(engine, data, options, locals, &block) if provides.empty?
     end
 
-    alias_method :original_partial, :partial if instance_methods.include?(:partial)
-    def partial(template, options={}, &block)
+    alias original_partial partial if instance_methods.include?(:partial)
+    def partial(template, options = {}, &block)
       raise "gem 'padrino-helpers' is required to render partials" unless respond_to?(:original_partial)
       self.body = original_partial(template, options, &block)
     end

data/lib/padrino-mailer/helpers.rb

@@ -19,14 +19,14 @@ module Padrino
       # @example
       #   email do
       #     to      @user.email
-      #     from    "awesomeness@example.com"
-      #     subject "Welcome to Awesomeness!"
-      #     locals  :a => a, :b => b
+      #     from    'awesomeness@example.com'
+      #     subject 'Welcome to Awesomeness!'
+      #     locals  a: a, b: b
       #     render  'path/to/my/template'
       #   end
       #
       # @see ClassMethods#email
-      def email(mail_attributes={}, &block)
+      def email(mail_attributes = {}, &block)
         settings.email(mail_attributes, &block)
       end
 
@@ -41,8 +41,8 @@ module Padrino
       #   The parameters to pass to the mailer.
       #
       # @example
-      #   deliver(:sample, :birthday, "Joey", 21)
-      #   deliver(:example, :message, "John")
+      #   deliver(:sample, :birthday, 'Joey', 21)
+      #   deliver(:example, :message, 'John')
       #
       # @see ClassMethods#deliver
       def deliver(mailer_name, message_name, *attributes)
@@ -78,7 +78,7 @@ module Padrino
         #       subject 'Happy Birthday!'
         #       to      'john@fake.com'
         #       from    'noreply@birthday.com'
-        #       locals  :name => name, :age => age
+        #       locals  name: name, age: age
         #       render  'sample/birthday'
         #     end
         #   end
@@ -89,7 +89,7 @@ module Padrino
           registered_mailers[name] = mailer
           mailer
         end
-        alias :mailers :mailer
+        alias mailers mailer
 
         ##
         # Delivers a mailer message email with the given attributes.
@@ -102,12 +102,12 @@ module Padrino
         #   The parameters to pass to the mailer.
         #
         # @example
-        #   deliver(:sample, :birthday, "Joey", 21)
-        #   deliver(:example, :message, "John")
+        #   deliver(:sample, :birthday, 'Joey', 21)
+        #   deliver(:example, :message, 'John')
         #
         def deliver(mailer_name, message_name, *attributes)
-          mailer = registered_mailers[mailer_name] or fail "mailer '#{mailer_name}' is not registered"
-          message = mailer.messages[message_name] or fail "mailer '#{mailer_name}' has no message '#{message_name}'"
+          mailer = registered_mailers[mailer_name] or raise "mailer '#{mailer_name}' is not registered"
+          message = mailer.messages[message_name] or raise "mailer '#{mailer_name}' has no message '#{message_name}'"
           message = message.call(*attributes)
           message.delivery_method(*delivery_settings)
           message.deliver
@@ -122,18 +122,18 @@ module Padrino
         #   The block mail attributes for this message.
         #
         # @example
-        #   MyApp.email(:to => 'to@ma.il', :from => 'from@ma.il', :subject => 'Welcome!', :body => 'Welcome Here!')
+        #   MyApp.email(to: 'to@ma.il', from: 'from@ma.il', subject: 'Welcome!', body: 'Welcome Here!')
         #
         #   # or if you prefer blocks
         #
         #   MyApp.email do
-        #     to @user.email
-        #     from "awesomeness@example.com"
-        #     subject "Welcome to Awesomeness!"
-        #     body 'path/to/my/template', :locals => { :a => a, :b => b }
+        #     to      @user.email
+        #     from    'awesomeness@example.com'
+        #     subject 'Welcome to Awesomeness!'
+        #     body    'path/to/my/template', locals: { a: a, b: b }
         #   end
         #
-        def email(mail_attributes={}, &block)
+        def email(mail_attributes = {}, &block)
           message = _padrino_mailer::Message.new(self)
           message.delivery_method(*delivery_settings)
           message.instance_eval(&block) if block_given?
@@ -143,16 +143,17 @@ module Padrino
         end
 
         private
+
         ##
         # Returns the parsed delivery method options.
         #
         def delivery_settings
           @_delivery_setting ||= begin
             if Gem.win_platform? && !respond_to?(:delivery_method)
-              raise "To use mailers on Windows you must set a :delivery_method, see http://padrinorb.com/guides/features/padrino-mailer/#configuration"
+              raise 'To use mailers on Windows you must set a :delivery_method, see http://padrinorb.com/guides/features/padrino-mailer/#configuration'
             end
 
-            return [:sendmail, { :location => `which sendmail`.chomp }] unless respond_to?(:delivery_method)
+            return [:sendmail, { location: `which sendmail`.chomp }] unless respond_to?(:delivery_method)
             return [delivery_method.keys[0], delivery_method.values[0]] if delivery_method.is_a?(Hash)
             return [delivery_method, {}] if delivery_method.is_a?(Symbol)
             [nil, {}]

data/lib/padrino-mailer/mime.rb

@@ -26,7 +26,7 @@ module Padrino
       #
       #   Padrino::Mailer::Mime::MIME_TYPES.fetch('text/plain', :plain)
       #
-      def self.mime_type(mime, fallback=:plain)
+      def self.mime_type(mime, fallback = :plain)
         MIME_TYPES.fetch(mime.to_s.split(';').first.to_s.downcase, fallback)
       end
 
@@ -39,9 +39,9 @@ module Padrino
       #   Padrino::Mailer::Mime::MIME_TYPES.merge!("text/xml" => :xml)
       #
       MIME_TYPES = {
-        "text/html"  => :html,
-        "text/plain" => :plain,
-        "text/xml"   => :xml
+        'text/html' => :html,
+        'text/plain' => :plain,
+        'text/xml' => :xml
       }
     end
   end

data/lib/padrino-mailer.rb

@@ -46,11 +46,9 @@ module Padrino
           app._padrino_mailer = Mail
         }
         app.helpers Padrino::Mailer::Helpers
-        unless app.respond_to?(:mailer)
-          app.send(:extend, Padrino::Mailer::Helpers::ClassMethods)
-        end
+        app.send(:extend, Padrino::Mailer::Helpers::ClassMethods) unless app.respond_to?(:mailer)
       end
-      alias :included :registered
+      alias included registered
     end
   end
 end

data/padrino-mailer.gemspec

@@ -1,28 +1,28 @@
 #!/usr/bin/env gem build
 # encoding: utf-8
 
-require File.expand_path("../../padrino-core/lib/padrino-core/version.rb", __FILE__)
+require File.expand_path('../padrino-core/lib/padrino-core/version.rb', __dir__)
 
 Gem::Specification.new do |s|
-  s.name = "padrino-mailer"
-  s.authors = ["Padrino Team", "Nathan Esquenazi", "Davide D'Agostino", "Arthur Chiu"]
-  s.email = "padrinorb@gmail.com"
-  s.summary = "Mailer system for padrino"
-  s.homepage = "http://www.padrinorb.com"
-  s.description = "Mailer system for padrino allowing easy delivery of application emails"
-  s.required_rubygems_version = ">= 1.3.6"
+  s.name = 'padrino-mailer'
+  s.authors = ['Padrino Team', 'Nathan Esquenazi', "Davide D'Agostino", 'Arthur Chiu']
+  s.email = 'padrinorb@gmail.com'
+  s.summary = 'Mailer system for padrino'
+  s.homepage = 'http://www.padrinorb.com'
+  s.description = 'Mailer system for padrino allowing easy delivery of application emails'
+  s.required_rubygems_version = '>= 1.3.6'
   s.version = Padrino.version
-  s.date = Time.now.strftime("%Y-%m-%d")
-  s.license = "MIT"
+  s.date = Time.now.strftime('%Y-%m-%d')
+  s.license = 'MIT'
 
-  s.extra_rdoc_files = Dir["*.rdoc"]
+  s.extra_rdoc_files = Dir['*.rdoc']
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
-  s.rdoc_options  = ["--charset=UTF-8"]
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+  s.rdoc_options  = ['--charset=UTF-8']
 
-  s.add_dependency("padrino-core", Padrino.version)
-  s.add_dependency("mime-types", ">= 3.1", "< 4")
-  s.add_dependency("mail", "~> 2.5")
+  s.add_dependency('padrino-core', Padrino.version)
+  s.add_dependency('mime-types', '>= 3.1', '< 4')
+  s.add_dependency('mail', '~> 2.5')
 end