hanami-mailer 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb739b22196267893812b43fcf2c2e7b37185e3f
-  data.tar.gz: d0686236004144e85a9a1d1bac67447b3f344acf
+  metadata.gz: f6bc33d0ec8a8e972be6d7de97473a6508616459
+  data.tar.gz: 5b79dacf8ff839f77fc066210673087f250ec52c
 SHA512:
-  metadata.gz: 418c209b8b97286b1076579537bccb7cec64bf51abfaeb881a10ff374601bb564630aea514b1eb17b176427c5a51d1723d9833edf8cba03f348a9f8427cb7803
-  data.tar.gz: d495d3926cb1afe2f1fbb5769e262db19daa7296647c00ebf15232d156f6f8fb3b39c81f8116cd7d34ec8d1bc055b8b76c15742f807e23e2e62d7749cee5c307
+  metadata.gz: 13d2f8eafab2fc9a87bae04276f30d1e1e1bf24c05c630aa80d2538699f4690ab8ec9eeb4ee68845a4068fdd865abe47ece7df925efc909dc412c6749ef98771
+  data.tar.gz: b8805778f4496eec6961429d3493478076c49142d757faa5a9905b71baada249d4c9ef32cf7a5711035f10bf9edf1c18c0417499d54b15c4a7740017aa92f030

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Hanami::Router
 Mail for Ruby applications
 
+## v0.3.0 - 2016-07-22
+### Added
+– [Anton Dabydov] Blind carbon copy (bcc) option
+– [Anton Dabydov] Carbon copy (cc) option
+
+### Changed
+– [Luca Guidi] Drop support for Ruby 2.0 and 2.1
+
 ## v0.2.0 - 2016-01-22
 ### Changed
 - [Luca Guidi] Renamed the project

data/README.md

@@ -66,7 +66,7 @@ A mailer with `.to` and `.from` addresses and mailer delivery:
 ```ruby
 require 'hanami/mailer'
 
-Hanami::Mailer.configuration do
+Hanami::Mailer.configure do
   delivery_method :smtp,
     address:              "smtp.gmail.com",
     port:                 587,
@@ -80,8 +80,11 @@ end.load!
 class WelcomeMailer
   include Hanami::Mailer
 
-  from    'noreply@sender.com'
-  to      'noreply@recipient.com'
+  from 'noreply@sender.com'
+  to   'noreply@recipient.com'
+  cc   'cc@sender.com'
+  bcc  'alice@example.com'
+
   subject 'Welcome'
 end
 
@@ -90,15 +93,13 @@ WelcomeMailer.deliver
 
 ### Locals
 
-The set of objects passed in the `deliver` call are called `locals` and are avaliable inside the mailer and the template.
+The set of objects passed in the `deliver` call are called `locals` and are available inside the mailer and the template.
 
 ```ruby
 require 'hanami/mailer'
 
-User = Struct.new(:name, :username)
-user = User.new('Luca', 'jodosha')
-
-Hanami::Mailer.load!
+User = Struct.new(:name, :username, :email)
+luca = User.new('Luca', 'jodosha', 'luca@jodosha.com')
 
 class WelcomeMailer
   include Hanami::Mailer
@@ -114,7 +115,7 @@ class WelcomeMailer
   end
 end
 
-InvoiceMailer.deliver(user: luca)
+WelcomeMailer.deliver(user: luca)
 ```
 
 The corresponding `erb` file:

data/hanami-mailer.gemspec

@@ -8,22 +8,22 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Luca Guidi', 'Ines Coelho', 'Rosa Faria']
   spec.email         = ['me@lucaguidi.com', 'ines.opcoelho@gmail.com', 'rosa1853@live.com']
 
-  spec.summary       = %q{Mail for Ruby applications.}
-  spec.description   = %q{Mail for Ruby applications and Hanami mailers}
+  spec.summary       = 'Mail for Ruby applications.'
+  spec.description   = 'Mail for Ruby applications and Hanami mailers'
   spec.homepage      = 'http://hanamirb.org'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -- lib/* CHANGELOG.md LICENSE.md README.md hanami-mailer.gemspec`.split($/)
+  spec.files         = `git ls-files -- lib/* CHANGELOG.md LICENSE.md README.md hanami-mailer.gemspec`.split($/) # rubocop:disable Style/SpecialGlobalVars
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.0.0'
+  spec.required_ruby_version = '>= 2.2.0'
 
-  spec.add_dependency 'hanami-utils', '~> 0.7'
+  spec.add_dependency 'hanami-utils', '~> 0.8'
   spec.add_dependency 'tilt',         '~> 2.0', '>= 2.0.1'
   spec.add_dependency 'mail',         '~> 2.5'
 
   spec.add_development_dependency 'bundler', '~> 1.10'
-  spec.add_development_dependency 'rake',    '~> 10.0'
+  spec.add_development_dependency 'rake',     '~> 11'
   spec.add_development_dependency 'minitest', '~> 5.7'
 end

data/lib/hanami-mailer.rb

@@ -1 +1 @@
-require 'hanami/mailer'
+require 'hanami/mailer' # rubocop:disable Style/FileName

data/lib/hanami/mailer.rb

@@ -73,7 +73,7 @@ module Hanami
     #
     # @see http://www.ruby-doc.org/core/Module.html#method-i-included
     def self.included(base)
-      conf = self.configuration
+      conf = configuration
       conf.add_mailer(base)
 
       base.class_eval do
@@ -134,7 +134,7 @@ module Hanami
       # <tt>Signup::Welcome.deliver(format: :txt)</tt>
       #
       # All the given locals, excepted the reserved ones (<tt>:format</tt> and
-      # <tt>charset</tt>), are avaliable as rendering context for the templates.
+      # <tt>charset</tt>), are available as rendering context for the templates.
       #
       # @param locals [Hash] a set of objects that acts as context for the rendering
       # @option :format [Symbol] specify format to deliver
@@ -197,19 +197,8 @@ module Hanami
     def initialize(locals = {})
       @locals  = locals
       @format  = locals.fetch(:format, nil)
-      @charset = charset = locals.fetch(:charset, self.class.configuration.default_charset)
-      @mail    = Mail.new.tap do |m|
-        m.from    = __dsl(:from)
-        m.to      = __dsl(:to)
-        m.subject = __dsl(:subject)
-
-        m.charset   = charset
-        m.html_part = __part(:html)
-        m.text_part = __part(:txt)
-
-        m.delivery_method(*Hanami::Mailer.configuration.delivery_method)
-      end
-
+      @charset = locals.fetch(:charset, self.class.configuration.default_charset)
+      @mail    = build
       prepare
     end
 
@@ -286,6 +275,26 @@ module Hanami
 
     private
 
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
+    def build
+      Mail.new.tap do |m|
+        m.from    = __dsl(:from)
+        m.to      = __dsl(:to)
+        m.cc      = __dsl(:cc)
+        m.bcc     = __dsl(:bcc)
+        m.subject = __dsl(:subject)
+
+        m.charset   = charset
+        m.html_part = __part(:html)
+        m.text_part = __part(:txt)
+
+        m.delivery_method(*Hanami::Mailer.configuration.delivery_method)
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
+
     # @private
     # @since 0.1.0
     def __dsl(method_name)
@@ -301,7 +310,7 @@ module Hanami
     # @since 0.1.0
     def __part(format)
       Mail::Part.new.tap do |part|
-        part.content_type = "#{ CONTENT_TYPES.fetch(format) }; charset=#{ charset }"
+        part.content_type = "#{CONTENT_TYPES.fetch(format)}; charset=#{charset}"
         part.body         = render(format)
       end if __part?(format)
     end

data/lib/hanami/mailer/configuration.rb

@@ -144,7 +144,7 @@ module Hanami
       #
       # @see Hanami::Mailer.configure
       def prepare(&blk)
-        if block_given?
+        if block_given? # rubocop:disable Style/GuardClause
           @modules.push(blk)
         else
           raise ArgumentError.new('Please provide a block')
@@ -191,7 +191,7 @@ module Hanami
         @modules = []
       end
 
-      alias_method :unload!, :reset!
+      alias unload! reset!
 
       # Copy the configuration for the given mailer
       #
@@ -283,6 +283,7 @@ module Hanami
       end
 
       protected
+
       # @api private
       # @since 0.1.0
       attr_writer :root

data/lib/hanami/mailer/dsl.rb

@@ -7,6 +7,18 @@ module Hanami
     #
     # @since 0.1.0
     module Dsl
+      # @since 0.3.0
+      # @api private
+      def self.extended(base)
+        base.class_eval do
+          @from    = nil
+          @to      = nil
+          @cc      = nil
+          @bcc     = nil
+          @subject = nil
+        end
+      end
+
       # Set the template name IF it differs from the convention.
       #
       # For a given mailer named <tt>Signup::Welcome</tt> it will look for
@@ -129,6 +141,184 @@ module Hanami
         end
       end
 
+      # Sets the cc (carbon copy) for mail messages
+      #
+      # It accepts a hardcoded value as a string or array of strings.
+      # For dynamic values, you can specify a symbol that represents an instance
+      # method.
+      #
+      # This value is optional.
+      #
+      # When a value is given, it specifies the cc for the email.
+      # When a value is not given, it returns the cc of the email.
+      #
+      # This is part of a DSL, for this reason when this method is called with
+      # an argument, it will set the corresponding class variable. When
+      # called without, it will return the already set value, or the default.
+      #
+      # @overload cc(value)
+      #   Sets the cc
+      #   @param value [String, Array, Symbol] the hardcoded value or method name
+      #   @return [NilClass]
+      #
+      # @overload cc
+      #   Returns the cc
+      #   @return [String, Array, Symbol] the recipient
+      #
+      # @since 0.3.0
+      #
+      # @example Hardcoded value (String)
+      #   require 'hanami/mailer'
+      #
+      #   class WelcomeMailer
+      #     include Hanami::Mailer
+      #
+      #     to "user@example.com"
+      #     cc "other.user@example.com"
+      #   end
+      #
+      # @example Hardcoded value (Array)
+      #   require 'hanami/mailer'
+      #
+      #   class WelcomeMailer
+      #     include Hanami::Mailer
+      #
+      #     to ["user-1@example.com", "user-2@example.com"]
+      #     cc ["other.user-1@example.com", "other.user-2@example.com"]
+      #   end
+      #
+      # @example Method (Symbol)
+      #   require 'hanami/mailer'
+      #
+      #   class WelcomeMailer
+      #     include Hanami::Mailer
+      #     to "user@example.com"
+      #     cc :email_address
+      #
+      #     private
+      #
+      #     def email_address
+      #       user.email
+      #     end
+      #   end
+      #
+      #   other_user = User.new(name: 'L')
+      #   WelcomeMailer.deliver(user: other_user)
+      #
+      # @example Method that returns a collection of recipients
+      #   require 'hanami/mailer'
+      #
+      #   class WelcomeMailer
+      #     include Hanami::Mailer
+      #     to "user@example.com"
+      #     cc :recipients
+      #
+      #     private
+      #
+      #     def recipients
+      #       users.map(&:email)
+      #     end
+      #   end
+      #
+      #   other_users = [User.new(name: 'L'), User.new(name: 'MG')]
+      #   WelcomeMailer.deliver(users: other_users)
+      def cc(value = nil)
+        if value.nil?
+          @cc
+        else
+          @cc = value
+        end
+      end
+
+      # Sets the bcc (blind carbon copy) for mail messages
+      #
+      # It accepts a hardcoded value as a string or array of strings.
+      # For dynamic values, you can specify a symbol that represents an instance
+      # method.
+      #
+      # This value is optional.
+      #
+      # When a value is given, it specifies the bcc for the email.
+      # When a value is not given, it returns the bcc of the email.
+      #
+      # This is part of a DSL, for this reason when this method is called with
+      # an argument, it will set the corresponding class variable. When
+      # called without, it will return the already set value, or the default.
+      #
+      # @overload bcc(value)
+      #   Sets the bcc
+      #   @param value [String, Array, Symbol] the hardcoded value or method name
+      #   @return [NilClass]
+      #
+      # @overload bcc
+      #   Returns the bcc
+      #   @return [String, Array, Symbol] the recipient
+      #
+      # @since 0.3.0
+      #
+      # @example Hardcoded value (String)
+      #   require 'hanami/mailer'
+      #
+      #   class WelcomeMailer
+      #     include Hanami::Mailer
+      #
+      #     to "user@example.com"
+      #     bcc "other.user@example.com"
+      #   end
+      #
+      # @example Hardcoded value (Array)
+      #   require 'hanami/mailer'
+      #
+      #   class WelcomeMailer
+      #     include Hanami::Mailer
+      #
+      #     to ["user-1@example.com", "user-2@example.com"]
+      #     bcc ["other.user-1@example.com", "other.user-2@example.com"]
+      #   end
+      #
+      # @example Method (Symbol)
+      #   require 'hanami/mailer'
+      #
+      #   class WelcomeMailer
+      #     include Hanami::Mailer
+      #     to "user@example.com"
+      #     bcc :email_address
+      #
+      #     private
+      #
+      #     def email_address
+      #       user.email
+      #     end
+      #   end
+      #
+      #   other_user = User.new(name: 'L')
+      #   WelcomeMailer.deliver(user: other_user)
+      #
+      # @example Method that returns a collection of recipients
+      #   require 'hanami/mailer'
+      #
+      #   class WelcomeMailer
+      #     include Hanami::Mailer
+      #     to "user@example.com"
+      #     bcc :recipients
+      #
+      #     private
+      #
+      #     def recipients
+      #       users.map(&:email)
+      #     end
+      #   end
+      #
+      #   other_users = [User.new(name: 'L'), User.new(name: 'MG')]
+      #   WelcomeMailer.deliver(users: other_users)
+      def bcc(value = nil)
+        if value.nil?
+          @bcc
+        else
+          @bcc = value
+        end
+      end
+
       # Sets the recipient for mail messages
       #
       # It accepts a hardcoded value as a string or array of strings.

data/lib/hanami/mailer/rendering/template_name.rb

@@ -26,6 +26,7 @@ module Hanami
         end
 
         private
+
         # @since 0.1.0
         # @api private
         def compile!(namespace)
@@ -44,7 +45,7 @@ module Hanami
         # @since 0.1.0
         # @api private
         def replace!(token)
-          @name.gsub!(%r{\A#{ token }#{ NAMESPACE_SEPARATOR }}, '')
+          @name.gsub!(/\A#{token}#{NAMESPACE_SEPARATOR}/, '')
         end
       end
     end

data/lib/hanami/mailer/rendering/templates_finder.rb

@@ -69,11 +69,11 @@ module Hanami
         #   Hanami::Mailer::Rendering::TemplatesFinder.new(Mailers::Welcome).find
         #     # => [#<Hanami::Mailer::Template:0x007f8a0a86a970 ... @file="/path/to/templates/welcome.html.erb">]
         def find
-          templates = Hash.new
+          templates = Hash[]
           _find.map do |template|
             name = File.basename(template)
-            format = (( name.split(".") )[-2]).to_sym
-            templates[ format ] = Mailer::Template.new(template)
+            format = (name.split('.')[-2]).to_sym
+            templates[format] = Mailer::Template.new(template)
           end
           templates
         end
@@ -83,7 +83,7 @@ module Hanami
         # @api private
         # @since 0.1.0
         def _find(lookup = search_path)
-          Dir.glob( "#{ [root, lookup, template_name].join(separator) }.#{ format }.#{ engines }" )
+          Dir.glob("#{[root, lookup, template_name].join(separator)}.#{format}.#{engines}")
         end
 
         # @api private

data/lib/hanami/mailer/version.rb

@@ -1,6 +1,6 @@
 module Hanami
   module Mailer
     # @since 0.1.0
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hanami-mailer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Luca Guidi
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-22 00:00:00.000000000 Z
+date: 2016-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hanami-utils
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
@@ -80,14 +80,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -135,7 +135,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -143,9 +143,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Mail for Ruby applications.
 test_files: []
-has_rdoc: