hanami-mailer 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b08471dba84f2f9e6f8b13c5085ed9a2f094430109ce674a8758cc244cee1c2d
-  data.tar.gz: 93194e1b4eefe4cb6e2c7d4eb5048ba7878d5fa1dbd4e16dcd3f11d512c0dcb3
+  metadata.gz: 7c6d1550998953f3d5e03031b550d543559c5be86ffd4f1c523062d497a2ccc5
+  data.tar.gz: b8405f76831e172ad647ec01ac9a139a7b9e0542db64443715ea5e8bdda2b3eb
 SHA512:
-  metadata.gz: 947a24021f123919dee44bf2d388ed82c6edbec1984e8e2fdd2dab5ada8a9e245c375338ea2db90fb9e0ccef0f3964999792c45deaa50fd9121674805d2447a3
-  data.tar.gz: d215ed8af0cac8ebac90c49d260831a1f0205627e72a3fe97f59b7c9db50dcb77c6b15425eeb5b2c878f714ad1f79025e435857b5019736b98d061e6c9511d19
+  metadata.gz: 4fcb959ad5f4e8f2c6e8a1605a48dce7d07ec781dca766d7127989b6e2ec9485ae2f82321ec0ff38f07f7313bdc29474437771045d84d7e1b85a432ad53d763c
+  data.tar.gz: 3daf620d72aff005141b9954ef526406c4f522894b0f5bad7a39f2193c40ddfffbecc553c171a70c87615528a4b8eafbdf3dea312ec49553874ec2b00d624b1c

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Hanami::Mailer
 Mail for Ruby applications
 
+## v1.3.2 - 2020-02-03
+### Added
+- [Luca Guidi] Official support for Ruby: MRI 2.7
+- [glaszig] Added `Hanami::Mailer.return_path` and `#return_path` to specify `MAIL FROM` address
+
 ## v1.3.1 - 2019-01-18
 ### Added
 - [Luca Guidi] Official support for Ruby: MRI 2.6

data/README.md

@@ -5,7 +5,7 @@ Mail for Ruby applications.
 ## Status
 
 [![Gem Version](https://badge.fury.io/rb/hanami-mailer.svg)](https://badge.fury.io/rb/hanami-mailer)
-[![TravisCI](https://travis-ci.org/hanami/mailer.svg?branch=master)](https://travis-ci.org/hanami/mailer)
+[![Build Status](https://ci.hanamirb.org/api/badges/hanami/mailer/status.svg)](https://ci.hanamirb.org/hanami/mailer)
 [![CircleCI](https://circleci.com/gh/hanami/mailer/tree/master.svg?style=svg)](https://circleci.com/gh/hanami/mailer/tree/master)
 [![Test Coverage](https://codecov.io/gh/hanami/mailer/branch/master/graph/badge.svg)](https://codecov.io/gh/hanami/mailer)
 [![Depfu](https://badges.depfu.com/badges/739c6e10eaf20d3ba4240d00828284db/overview.svg)](https://depfu.com/github/hanami/mailer?project=Bundler)
@@ -80,6 +80,7 @@ end.load!
 class WelcomeMailer
   include Hanami::Mailer
 
+  return_path 'bounce@sender.com'
   from 'noreply@sender.com'
   to   'noreply@recipient.com'
   cc   'cc@sender.com'

data/hanami-mailer.gemspec

@@ -24,6 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'mail',         '~> 2.6'
 
   spec.add_development_dependency 'bundler', '>= 1.6', '< 3'
-  spec.add_development_dependency 'rake',  '~> 12'
+  spec.add_development_dependency 'rake',  '~> 13'
   spec.add_development_dependency 'rspec', '~> 3.7'
 end

data/lib/hanami/mailer.rb

@@ -223,8 +223,8 @@ module Hanami
     # @api private
     def deliver
       mail.deliver
-    rescue ArgumentError => e
-      raise MissingDeliveryDataError if e.message =~ /SMTP (From|To) address/
+    rescue ArgumentError => exception
+      raise MissingDeliveryDataError if exception.message =~ /SMTP (From|To) address/
 
       raise
     end
@@ -284,6 +284,7 @@ module Hanami
     # rubocop:disable Metrics/AbcSize
     def build
       Mail.new.tap do |m|
+        m.return_path = __dsl(:return_path)
         m.from     = __dsl(:from)
         m.to       = __dsl(:to)
         m.cc       = __dsl(:cc)

data/lib/hanami/mailer/dsl.rb

@@ -11,12 +11,13 @@ module Hanami
       # @api private
       def self.extended(base)
         base.class_eval do
-          @from     = nil
-          @to       = nil
-          @cc       = nil
-          @bcc      = nil
-          @reply_to = nil
-          @subject  = nil
+          @from        = nil
+          @to          = nil
+          @cc          = nil
+          @bcc         = nil
+          @reply_to    = nil
+          @return_path = nil
+          @subject     = nil
         end
       end
 
@@ -86,6 +87,63 @@ module Hanami
         end
       end
 
+      # Sets the MAIL FROM address for mail messages.
+      # This lets you specify a "bounce address" different from the sender
+      # address specified with `from`.
+      #
+      # It accepts a hardcoded value as a string, or a symbol that represents
+      # an instance method for more complex logic.
+      #
+      # This value is optional.
+      #
+      # When a value is given, specify the MAIL FROM address of the email
+      # Otherwise, it returns the MAIL FROM address 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 return_path(value)
+      #   Sets the MAIL FROM address
+      #   @param value [String, Symbol] the hardcoded value or method name
+      #   @return [NilClass]
+      #
+      # @overload return_path
+      #   Returns the MAIL FROM address
+      #   @return [String, Symbol] the MAIL FROM address
+      #
+      # @since 1.3.2
+      #
+      # @example Hardcoded value (String)
+      #   require 'hanami/mailer'
+      #
+      #   class WelcomeMailer
+      #     include Hanami::Mailer
+      #
+      #     return_path "bounce@example.com"
+      #   end
+      #
+      # @example Method (Symbol)
+      #   require 'hanami/mailer'
+      #
+      #   class WelcomeMailer
+      #     include Hanami::Mailer
+      #     return_path :bounce_address
+      #
+      #     private
+      #
+      #     def bounce_address
+      #       "bounce@example.com"
+      #     end
+      #   end
+      def return_path(value = nil)
+        if value.nil?
+          @return_path
+        else
+          @return_path = value
+        end
+      end
+
       # Sets the sender for mail messages
       #
       # It accepts a hardcoded value as a string, or a symbol that represents

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

@@ -45,7 +45,7 @@ module Hanami
         # @since 0.1.0
         # @api private
         def replace!(token)
-          @name.gsub!(/\A#{token}#{NAMESPACE_SEPARATOR}/, '')
+          @name = @name.gsub(/\A#{token}#{NAMESPACE_SEPARATOR}/, '')
         end
       end
     end

data/lib/hanami/mailer/template.rb

@@ -9,8 +9,8 @@ module Hanami
     #
     # TODO this is identical to Hanami::View, consider to move into Hanami::Utils
     class Template
-      def initialize(template)
-        @_template = Tilt.new(template)
+      def initialize(template, encoding = Encoding::UTF_8)
+        @_template = Tilt.new(template, default_encoding: encoding)
       end
 
       # Render the template within the context of the given scope.

data/lib/hanami/mailer/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-mailer
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-18 00:00:00.000000000 Z
+date: 2020-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hanami-utils
@@ -84,14 +84,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -144,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Mail for Ruby applications.