mail 2.6.3 → 2.7.0

data/lib/mail/multibyte/chars.rb

@@ -1,4 +1,6 @@
 # encoding: utf-8
+# frozen_string_literal: true
+require 'mail/multibyte/unicode'
 
 module Mail #:nodoc:
   module Multibyte #:nodoc:
@@ -39,7 +41,7 @@ module Mail #:nodoc:
       if RUBY_VERSION >= "1.9"
         # Creates a new Chars instance by wrapping _string_.
         def initialize(string)
-          @wrapped_string = string
+          @wrapped_string = string.dup
           @wrapped_string.force_encoding(Encoding::UTF_8) unless @wrapped_string.frozen?
         end
       else
@@ -102,7 +104,7 @@ module Mail #:nodoc:
         # Returns a new Chars object containing the _other_ object concatenated to the string.
         #
         # Example:
-        #   ('Café'.mb_chars + ' périferôl').to_s # => "Café périferôl"
+        #   (Mail::Multibyte.mb_chars('Café') + ' périferôl').to_s # => "Café périferôl"
         def +(other)
           chars(@wrapped_string + other)
         end
@@ -110,7 +112,7 @@ module Mail #:nodoc:
         # Like <tt>String#=~</tt> only it returns the character offset (in codepoints) instead of the byte offset.
         #
         # Example:
-        #   'Café périferôl'.mb_chars =~ /ô/ # => 12
+        #   Mail::Multibyte.mb_chars('Café périferôl') =~ /ô/ # => 12
         def =~(other)
           translate_offset(@wrapped_string =~ other)
         end
@@ -118,7 +120,7 @@ module Mail #:nodoc:
         # Inserts the passed string at specified codepoint offsets.
         #
         # Example:
-        #   'Café'.mb_chars.insert(4, ' périferôl').to_s # => "Café périferôl"
+        #   Mail::Multibyte.mb_chars('Café').insert(4, ' périferôl').to_s # => "Café périferôl"
         def insert(offset, fragment)
           unpacked = Unicode.u_unpack(@wrapped_string)
           unless offset > unpacked.length
@@ -134,7 +136,7 @@ module Mail #:nodoc:
         # Returns +true+ if contained string contains _other_. Returns +false+ otherwise.
         #
         # Example:
-        #   'Café'.mb_chars.include?('é') # => true
+        #   Mail::Multibyte.mb_chars('Café').include?('é') # => true
         def include?(other)
           # We have to redefine this method because Enumerable defines it.
           @wrapped_string.include?(other)
@@ -143,8 +145,8 @@ module Mail #:nodoc:
         # Returns the position _needle_ in the string, counting in codepoints. Returns +nil+ if _needle_ isn't found.
         #
         # Example:
-        #   'Café périferôl'.mb_chars.index('ô')   # => 12
-        #   'Café périferôl'.mb_chars.index(/\w/u) # => 0
+        #   Mail::Multibyte.mb_chars('Café périferôl').index('ô')   # => 12
+        #   Mail::Multibyte.mb_chars('Café périferôl').index(/\w/u) # => 0
         def index(needle, offset=0)
           wrapped_offset = first(offset).wrapped_string.length
           index = @wrapped_string.index(needle, wrapped_offset)
@@ -156,8 +158,8 @@ module Mail #:nodoc:
         # string. Returns +nil+ if _needle_ isn't found.
         #
         # Example:
-        #   'Café périferôl'.mb_chars.rindex('é')   # => 6
-        #   'Café périferôl'.mb_chars.rindex(/\w/u) # => 13
+        #   Mail::Multibyte.mb_chars('Café périferôl').rindex('é')   # => 6
+        #   Mail::Multibyte.mb_chars('Café périferôl').rindex(/\w/u) # => 13
         def rindex(needle, offset=nil)
           offset ||= length
           wrapped_offset = first(offset).wrapped_string.length
@@ -189,7 +191,7 @@ module Mail #:nodoc:
         # Returns the codepoint of the first character in the string.
         #
         # Example:
-        #   'こんにちは'.mb_chars.ord # => 12371
+        #   Mail::Multibyte.mb_chars('こんにちは').ord # => 12371
         def ord
           Unicode.u_unpack(@wrapped_string)[0]
         end
@@ -198,10 +200,10 @@ module Mail #:nodoc:
         #
         # Example:
         #
-        #   "¾ cup".mb_chars.rjust(8).to_s
+        #   Mail::Multibyte.mb_chars("¾ cup").rjust(8).to_s
         #   # => "   ¾ cup"
         #
-        #   "¾ cup".mb_chars.rjust(8, " ").to_s # Use non-breaking whitespace
+        #   Mail::Multibyte.mb_chars("¾ cup").rjust(8, " ").to_s # Use non-breaking whitespace
         #   # => "   ¾ cup"
         def rjust(integer, padstr=' ')
           justify(integer, :right, padstr)
@@ -211,10 +213,10 @@ module Mail #:nodoc:
         #
         # Example:
         #
-        #   "¾ cup".mb_chars.rjust(8).to_s
+        #   Mail::Multibyte.mb_chars("¾ cup").rjust(8).to_s
         #   # => "¾ cup   "
         #
-        #   "¾ cup".mb_chars.rjust(8, " ").to_s # Use non-breaking whitespace
+        #   Mail::Multibyte.mb_chars("¾ cup").rjust(8, " ").to_s # Use non-breaking whitespace
         #   # => "¾ cup   "
         def ljust(integer, padstr=' ')
           justify(integer, :left, padstr)
@@ -224,10 +226,10 @@ module Mail #:nodoc:
         #
         # Example:
         #
-        #   "¾ cup".mb_chars.center(8).to_s
+        #   Mail::Multibyte.mb_chars("¾ cup").center(8).to_s
         #   # => " ¾ cup  "
         #
-        #   "¾ cup".mb_chars.center(8, " ").to_s # Use non-breaking whitespace
+        #   Mail::Multibyte.mb_chars("¾ cup").center(8, " ").to_s # Use non-breaking whitespace
         #   # => " ¾ cup  "
         def center(integer, padstr=' ')
           justify(integer, :center, padstr)
@@ -243,7 +245,7 @@ module Mail #:nodoc:
       # instances instead of String. This makes chaining methods easier.
       #
       # Example:
-      #   'Café périferôl'.mb_chars.split(/é/).map { |part| part.upcase.to_s } # => ["CAF", " P", "RIFERÔL"]
+      #   Mail::Multibyte.mb_chars('Café périferôl').split(/é/).map { |part| part.upcase.to_s } # => ["CAF", " P", "RIFERÔL"]
       def split(*args)
         @wrapped_string.split(*args).map { |i| i.mb_chars }
       end
@@ -268,12 +270,12 @@ module Mail #:nodoc:
           @wrapped_string[*args] = replace_by
         else
           result = Unicode.u_unpack(@wrapped_string)
-          if args[0].is_a?(Fixnum)
+          if args[0].is_a?(Integer)
             raise IndexError, "index #{args[0]} out of string" if args[0] >= result.length
             min = args[0]
             max = args[1].nil? ? min : (min + args[1] - 1)
             range = Range.new(min, max)
-            replace_by = [replace_by].pack('U') if replace_by.is_a?(Fixnum)
+            replace_by = [replace_by].pack('U') if replace_by.is_a?(Integer)
           elsif args.first.is_a?(Range)
             raise RangeError, "#{args[0]} out of range" if args[0].min >= result.length
             range = args[0]
@@ -291,7 +293,7 @@ module Mail #:nodoc:
       # Reverses all characters in the string.
       #
       # Example:
-      #   'Café'.mb_chars.reverse.to_s # => 'éfaC'
+      #   Mail::Multibyte.mb_chars('Café').reverse.to_s # => 'éfaC'
       def reverse
         chars(Unicode.g_unpack(@wrapped_string).reverse.flatten.pack('U*'))
       end
@@ -300,7 +302,7 @@ module Mail #:nodoc:
       # character.
       #
       # Example:
-      #   'こんにちは'.mb_chars.slice(2..3).to_s # => "にち"
+      #   Mail::Multibyte.mb_chars('こんにちは').slice(2..3).to_s # => "にち"
       def slice(*args)
         if args.size > 2
           raise ArgumentError, "wrong number of arguments (#{args.size} for 1)" # Do as if we were native
@@ -337,7 +339,7 @@ module Mail #:nodoc:
       # Convert characters in the string to uppercase.
       #
       # Example:
-      #   'Laurent, où sont les tests ?'.mb_chars.upcase.to_s # => "LAURENT, OÙ SONT LES TESTS ?"
+      #   Mail::Multibyte.mb_chars('Laurent, où sont les tests ?').upcase.to_s # => "LAURENT, OÙ SONT LES TESTS ?"
       def upcase
         chars(Unicode.apply_mapping(@wrapped_string, :uppercase_mapping))
       end
@@ -345,7 +347,7 @@ module Mail #:nodoc:
       # Convert characters in the string to lowercase.
       #
       # Example:
-      #   'VĚDA A VÝZKUM'.mb_chars.downcase.to_s # => "věda a výzkum"
+      #   Mail::Multibyte.mb_chars('VĚDA A VÝZKUM').downcase.to_s # => "věda a výzkum"
       def downcase
         chars(Unicode.apply_mapping(@wrapped_string, :lowercase_mapping))
       end
@@ -353,7 +355,7 @@ module Mail #:nodoc:
       # Converts the first character to uppercase and the remainder to lowercase.
       #
       # Example:
-      #  'über'.mb_chars.capitalize.to_s # => "Über"
+      #  Mail::Multibyte.mb_chars('über').capitalize.to_s # => "Über"
       def capitalize
         (slice(0) || chars('')).upcase + (slice(1..-1) || chars('')).downcase
       end
@@ -361,8 +363,8 @@ module Mail #:nodoc:
       # Capitalizes the first letter of every word, when possible.
       #
       # Example:
-      #   "ÉL QUE SE ENTERÓ".mb_chars.titleize    # => "Él Que Se Enteró"
-      #   "日本語".mb_chars.titleize                 # => "日本語"
+      #   Mail::Multibyte.mb_chars("ÉL QUE SE ENTERÓ").titleize    # => "Él Que Se Enteró"
+      #   Mail::Multibyte.mb_chars("日本語").titleize                 # => "日本語"
       def titleize
         chars(downcase.to_s.gsub(/\b('?\S)/u) { Unicode.apply_mapping $1, :uppercase_mapping })
       end
@@ -382,7 +384,7 @@ module Mail #:nodoc:
       #
       # Example:
       #   'é'.length                         # => 2
-      #   'é'.mb_chars.decompose.to_s.length # => 3
+      #   Mail::Multibyte.mb_chars('é').decompose.to_s.length # => 3
       def decompose
         chars(Unicode.decompose_codepoints(:canonical, Unicode.u_unpack(@wrapped_string)).pack('U*'))
       end
@@ -391,7 +393,7 @@ module Mail #:nodoc:
       #
       # Example:
       #   'é'.length                       # => 3
-      #   'é'.mb_chars.compose.to_s.length # => 2
+      #   Mail::Multibyte.mb_chars('é').compose.to_s.length # => 2
       def compose
         chars(Unicode.compose_codepoints(Unicode.u_unpack(@wrapped_string)).pack('U*'))
       end
@@ -399,8 +401,8 @@ module Mail #:nodoc:
       # Returns the number of grapheme clusters in the string.
       #
       # Example:
-      #   'क्षि'.mb_chars.length   # => 4
-      #   'क्षि'.mb_chars.g_length # => 3
+      #   Mail::Multibyte.mb_chars('क्षि').length   # => 4
+      #   Mail::Multibyte.mb_chars('क्षि').g_length # => 3
       def g_length
         Unicode.g_unpack(@wrapped_string).length
       end

data/lib/mail/multibyte/unicode.rb

@@ -1,6 +1,27 @@
+# frozen_string_literal: true
 module Mail
   module Multibyte
     module Unicode
+      # Adapted from https://github.com/rails/rails/blob/master/activesupport/lib/active_support/multibyte/unicode.rb
+      # under the MIT license
+      # The Unicode version that is supported by the implementation
+      UNICODE_VERSION = '7.0.0'
+
+      # Holds data about a codepoint in the Unicode database.
+      class Codepoint
+        attr_accessor :code, :combining_class, :decomp_type, :decomp_mapping, :uppercase_mapping, :lowercase_mapping
+
+        # Initializing Codepoint object with default values
+        def initialize
+          @combining_class = 0
+          @uppercase_mapping = 0
+          @lowercase_mapping = 0
+        end
+
+        def swapcase_mapping
+          uppercase_mapping > 0 ? uppercase_mapping : lowercase_mapping
+        end
+      end
 
       extend self
 
@@ -8,9 +29,6 @@ module Mail
       # information about normalization.
       NORMALIZATION_FORMS = [:c, :kc, :d, :kd]
 
-      # The Unicode version that is supported by the implementation
-      UNICODE_VERSION = '5.2.0'
-
       # The default normalization used for operations that require normalization. It can be set to any of the
       # normalizations in NORMALIZATION_FORMS.
       #
@@ -308,11 +326,6 @@ module Mail
         end.pack('U*')
       end
 
-      # Holds data about a codepoint in the Unicode database
-      class Codepoint
-        attr_accessor :code, :combining_class, :decomp_type, :decomp_mapping, :uppercase_mapping, :lowercase_mapping
-      end
-
       # Holds static data from the Unicode database
       class UnicodeDatabase
         ATTRIBUTES = :codepoints, :composition_exclusion, :composition_map, :boundary, :cp1252
@@ -390,11 +403,3 @@ module Mail
     end
   end
 end
-
-unless defined?(ActiveSupport)
-  module ActiveSupport
-    unless const_defined?(:Multibyte)
-      Multibyte = Mail::Multibyte
-    end
-  end
-end

data/lib/mail/multibyte/utils.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module Mail #:nodoc:
   module Multibyte #:nodoc:

data/lib/mail/multibyte.rb

@@ -1,23 +1,73 @@
 # encoding: utf-8
+# frozen_string_literal: true
+require 'mail/multibyte/chars'
+
 module Mail #:nodoc:
   module Multibyte
-    require 'mail/multibyte/exceptions'
-    require 'mail/multibyte/chars'
-    require 'mail/multibyte/unicode'
+    # Raised when a problem with the encoding was found.
+    class EncodingError < StandardError; end
 
-    # The proxy class returned when calling mb_chars. You can use this accessor to configure your own proxy
-    # class so you can support other encodings. See the Mail::Multibyte::Chars implementation for
-    # an example how to do this.
-    #
-    # Example:
-    #   Mail::Multibyte.proxy_class = CharsForUTF32
-    def self.proxy_class=(klass)
-      @proxy_class = klass
+    class << self
+      # The proxy class returned when calling mb_chars. You can use this accessor to configure your own proxy
+      # class so you can support other encodings. See the Mail::Multibyte::Chars implementation for
+      # an example how to do this.
+      #
+      # Example:
+      #   Mail::Multibyte.proxy_class = CharsForUTF32
+      attr_accessor :proxy_class
     end
 
-    # Returns the current proxy class
-    def self.proxy_class
-      @proxy_class ||= Mail::Multibyte::Chars
+    self.proxy_class = Mail::Multibyte::Chars
+
+    if RUBY_VERSION >= "1.9"
+      # == Multibyte proxy
+      #
+      # +mb_chars+ is a multibyte safe proxy for string methods.
+      #
+      # In Ruby 1.8 and older it creates and returns an instance of the Mail::Multibyte::Chars class which
+      # encapsulates the original string. A Unicode safe version of all the String methods are defined on this proxy
+      # class. If the proxy class doesn't respond to a certain method, it's forwarded to the encapsuled string.
+      #
+      #   name = 'Claus Müller'
+      #   name.reverse # => "rell??M sualC"
+      #   name.length  # => 13
+      #
+      #   name.mb_chars.reverse.to_s # => "rellüM sualC"
+      #   name.mb_chars.length       # => 12
+      #
+      # In Ruby 1.9 and newer +mb_chars+ returns +self+ because String is (mostly) encoding aware. This means that
+      # it becomes easy to run one version of your code on multiple Ruby versions.
+      #
+      # == Method chaining
+      #
+      # All the methods on the Chars proxy which normally return a string will return a Chars object. This allows
+      # method chaining on the result of any of these methods.
+      #
+      #   name.mb_chars.reverse.length # => 12
+      #
+      # == Interoperability and configuration
+      #
+      # The Chars object tries to be as interchangeable with String objects as possible: sorting and comparing between
+      # String and Char work like expected. The bang! methods change the internal string representation in the Chars
+      # object. Interoperability problems can be resolved easily with a +to_s+ call.
+      #
+      # For more information about the methods defined on the Chars proxy see Mail::Multibyte::Chars. For
+      # information about how to change the default Multibyte behaviour see Mail::Multibyte.
+      def self.mb_chars(str)
+        if proxy_class.consumes?(str)
+          proxy_class.new(str)
+        else
+          str
+        end
+      end
+    else
+      def self.mb_chars(str)
+        if proxy_class.wants?(str)
+          proxy_class.new(str)
+        else
+          str
+        end
+      end
     end
 
     # Regular expressions that describe valid byte sequences for a character
@@ -39,4 +89,4 @@ module Mail #:nodoc:
   end
 end
 
-require 'mail/multibyte/utils'
+require 'mail/multibyte/utils'

data/lib/mail/network/delivery_methods/exim.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Mail
 
   # A delivery method implementation which sends via exim.
@@ -36,17 +37,13 @@ module Mail
   #
   #   mail.deliver!
   class Exim < Sendmail
-    def initialize(values)
-      self.settings = { :location       => '/usr/sbin/exim',
-                        :arguments      => '-i -t' }.merge(values)
-    end
+    DEFAULTS = {
+      :location   => '/usr/sbin/exim',
+      :arguments  => '-i -t'
+    }
 
-    def self.call(path, arguments, destinations, mail)
-      popen "#{path} #{arguments}" do |io|
-        io.puts mail.encoded.to_lf
-        io.flush
-      end
+    def self.call(path, arguments, destinations, encoded_message)
+      super path, arguments, nil, encoded_message
     end
-
   end
 end

data/lib/mail/network/delivery_methods/file_delivery.rb

@@ -1,7 +1,7 @@
+# frozen_string_literal: true
 require 'mail/check_delivery_params'
 
 module Mail
-  
   # FileDelivery class delivers emails into multiple files based on the destination
   # address.  Each file is appended to if it already exists.
   # 
@@ -13,22 +13,20 @@ module Mail
   # Make sure the path you specify with :location is writable by the Ruby process
   # running Mail.
   class FileDelivery
-    include Mail::CheckDeliveryParams
-
     if RUBY_VERSION >= '1.9.1'
       require 'fileutils'
     else
       require 'ftools'
     end
 
+    attr_accessor :settings
+
     def initialize(values)
       self.settings = { :location => './mails' }.merge!(values)
     end
-    
-    attr_accessor :settings
-    
+
     def deliver!(mail)
-      check_delivery_params(mail)
+      Mail::CheckDeliveryParams.check(mail)
 
       if ::File.respond_to?(:makedirs)
         ::File.makedirs settings[:location]
@@ -40,6 +38,5 @@ module Mail
         ::File.open(::File.join(settings[:location], File.basename(to.to_s)), 'a') { |f| "#{f.write(mail.encoded)}\r\n\r\n" }
       end
     end
-    
   end
 end

data/lib/mail/network/delivery_methods/logger_delivery.rb

@@ -0,0 +1,37 @@
+require 'mail/check_delivery_params'
+
+module Mail
+  class LoggerDelivery
+    include Mail::CheckDeliveryParams
+
+    attr_reader :logger, :severity, :settings
+
+    def initialize(settings)
+      @settings = settings
+      @logger   = settings.fetch(:logger) { default_logger }
+      @severity = derive_severity(settings[:severity])
+    end
+
+    def deliver!(mail)
+      Mail::CheckDeliveryParams.check(mail)
+      logger.log(severity) { mail.encoded }
+    end
+
+    private
+      def default_logger
+        require 'logger'
+        ::Logger.new($stdout)
+      end
+
+      def derive_severity(severity)
+        case severity
+        when nil
+          Logger::INFO
+        when Integer
+          severity
+        else
+          Logger.const_get(severity.to_s.upcase)
+        end
+      end
+  end
+end

data/lib/mail/network/delivery_methods/sendmail.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'mail/check_delivery_params'
 
 module Mail
@@ -37,19 +38,21 @@ module Mail
   #
   #   mail.deliver!
   class Sendmail
-    include Mail::CheckDeliveryParams
+    DEFAULTS = {
+      :location   => '/usr/sbin/sendmail',
+      :arguments  => '-i'
+    }
+
+    attr_accessor :settings
 
     def initialize(values)
-      self.settings = { :location       => '/usr/sbin/sendmail',
-                        :arguments      => '-i' }.merge(values)
+      self.settings = self.class::DEFAULTS.merge(values)
     end
 
-    attr_accessor :settings
-
     def deliver!(mail)
-      smtp_from, smtp_to, message = check_delivery_params(mail)
+      smtp_from, smtp_to, message = Mail::CheckDeliveryParams.check(mail)
 
-      from = "-f #{self.class.shellquote(smtp_from)}"
+      from = "-f #{self.class.shellquote(smtp_from)}" if smtp_from
       to = smtp_to.map { |_to| self.class.shellquote(_to) }.join(' ')
 
       arguments = "#{settings[:arguments]} #{from} --"
@@ -58,7 +61,7 @@ module Mail
 
     def self.call(path, arguments, destinations, encoded_message)
       popen "#{path} #{arguments} #{destinations}" do |io|
-        io.puts encoded_message.to_lf
+        io.puts ::Mail::Utilities.binary_unsafe_to_lf(encoded_message)
         io.flush
       end
     end
@@ -74,15 +77,18 @@ module Mail
     end
 
     # The following is an adaptation of ruby 1.9.2's shellwords.rb file,
-    # it is modified to include '+' in the allowed list to allow for
-    # sendmail to accept email addresses as the sender with a + in them.
+    # with the following modifications:
+    #
+    # - Wraps in double quotes
+    # - Allows '+' to accept email addresses with them
+    # - Allows '~' as it is not unescaped in double quotes
     def self.shellquote(address)
       # Process as a single byte sequence because not all shell
       # implementations are multibyte aware.
       #
       # A LF cannot be escaped with a backslash because a backslash + LF
       # combo is regarded as line continuation and simply ignored. Strip it.
-      escaped = address.gsub(/([^A-Za-z0-9_\s\+\-.,:\/@])/n, "\\\\\\1").gsub("\n", '')
+      escaped = address.gsub(/([^A-Za-z0-9_\s\+\-.,:\/@~])/n, "\\\\\\1").gsub("\n", '')
       %("#{escaped}")
     end
   end