mail 2.7.1 → 2.8.0

data/lib/mail/fields/content_disposition_field.rb

@@ -1,25 +1,18 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common/parameter_hash'
+require 'mail/fields/named_structured_field'
+require 'mail/fields/parameter_hash'
 
 module Mail
-  class ContentDispositionField < StructuredField
+  class ContentDispositionField < NamedStructuredField #:nodoc:
+    NAME = 'Content-Disposition'
 
-    FIELD_NAME = 'content-disposition'
-    CAPITALIZED_FIELD = 'Content-Disposition'
-
-    def initialize(value = nil, charset = 'utf-8')
-      self.charset = charset
-      value = ensure_filename_quoted(value)
-      super(CAPITALIZED_FIELD, value, charset)
-      self.parse
-      self
+    def self.singular?
+      true
     end
 
-    def parse(val = value)
-      unless Utilities.blank?(val)
-        @element = Mail::ContentDispositionElement.new(val)
-      end
+    def initialize(value = nil, charset = nil)
+      super ensure_filename_quoted(value), charset
     end
 
     def element
@@ -37,35 +30,17 @@ module Mail
     end
 
     def filename
-      case
-      when parameters['filename']
-        @filename = parameters['filename']
-      when parameters['name']
-        @filename = parameters['name']
-      else
-        @filename = nil
-      end
-      @filename
+      @filename ||= parameters['filename'] || parameters['name']
     end
 
-    # TODO: Fix this up
     def encoded
-      if parameters.length > 0
-        p = ";\r\n\s#{parameters.encoded}\r\n"
-      else
-        p = "\r\n"
-      end
-      "#{CAPITALIZED_FIELD}: #{disposition_type}" + p
+      p = ";\r\n\s#{parameters.encoded}" if parameters.length > 0
+      "#{name}: #{disposition_type}#{p}\r\n"
     end
 
     def decoded
-      if parameters.length > 0
-        p = "; #{parameters.decoded}"
-      else
-        p = ""
-      end
-      "#{disposition_type}" + p
+      p = "; #{parameters.decoded}" if parameters.length > 0
+      "#{disposition_type}#{p}"
     end
-
   end
 end

data/lib/mail/fields/content_id_field.rb

@@ -1,63 +1,36 @@
 # encoding: utf-8
 # frozen_string_literal: true
-# 
-# 
-# 
+require 'mail/fields/named_structured_field'
+require 'mail/utilities'
+
 module Mail
-  class ContentIdField < StructuredField
-    
-    FIELD_NAME = 'content-id'
-    CAPITALIZED_FIELD = "Content-ID"
-    
-    def initialize(value = nil, charset = 'utf-8')
-      self.charset = charset
-      @uniq = 1
-      if Utilities.blank?(value)
-        value = generate_content_id
-      else
-        value = value.to_s
-      end
-      super(CAPITALIZED_FIELD, value, charset)
-      self.parse
-      self
-    end
-    
-    def parse(val = value)
-      unless Utilities.blank?(val)
-        @element = Mail::MessageIdsElement.new(val)
-      end
-    end
-    
+  class ContentIdField < NamedStructuredField #:nodoc:
+    NAME = 'Content-ID'
+
+    def self.singular?
+      true
+    end
+
+    def initialize(value = nil, charset = nil)
+      value = Mail::Utilities.generate_message_id if Utilities.blank?(value)
+      super value, charset
+    end
+
     def element
       @element ||= Mail::MessageIdsElement.new(value)
     end
-    
-    def name
-      'Content-ID'
-    end
-    
+
     def content_id
       element.message_id
     end
-    
-    def to_s
-      "<#{content_id}>"
-    end
-    
-    # TODO: Fix this up
-    def encoded
-      "#{CAPITALIZED_FIELD}: #{to_s}\r\n"
-    end
-    
-    def decoded
-      "#{to_s}"
-    end
-    
+
     private
-    
-    def generate_content_id
-      "<#{Mail.random_tag}@#{::Socket.gethostname}.mail>"
-    end
-    
+      def do_decode
+        "<#{content_id}>"
+      end
+
+      def do_encode
+        "#{name}: #{do_decode}\r\n"
+      end
   end
 end

data/lib/mail/fields/content_location_field.rb

@@ -1,27 +1,15 @@
 # encoding: utf-8
 # frozen_string_literal: true
-# 
-# 
-# 
+require 'mail/fields/named_structured_field'
+
 module Mail
-  class ContentLocationField < StructuredField
-    
-    FIELD_NAME = 'content-location'
-    CAPITALIZED_FIELD = 'Content-Location'
-    
-    def initialize(value = nil, charset = 'utf-8')
-      self.charset = charset
-      super(CAPITALIZED_FIELD, value, charset)
-      self.parse
-      self
-    end
-    
-    def parse(val = value)
-      unless Utilities.blank?(val)
-        @element = Mail::ContentLocationElement.new(val)
-      end
+  class ContentLocationField < NamedStructuredField #:nodoc:
+    NAME = 'Content-Location'
+
+    def self.singular?
+      true
     end
-    
+
     def element
       @element ||= Mail::ContentLocationElement.new(value)
     end
@@ -30,14 +18,12 @@ module Mail
       element.location
     end
 
-    # TODO: Fix this up
     def encoded
-      "#{CAPITALIZED_FIELD}: #{location}\r\n"
+      "#{name}: #{location}\r\n"
     end
-    
+
     def decoded
-      location 
+      location
     end
-
   end
 end

data/lib/mail/fields/content_transfer_encoding_field.rb

@@ -1,45 +1,45 @@
 # encoding: utf-8
 # frozen_string_literal: true
-# 
-# 
-# 
+require 'mail/fields/named_structured_field'
+
 module Mail
-  class ContentTransferEncodingField < StructuredField
-    
-    FIELD_NAME = 'content-transfer-encoding'
-    CAPITALIZED_FIELD = 'Content-Transfer-Encoding'
-    
-    def initialize(value = nil, charset = 'utf-8')
-      self.charset = charset
-      value = '7bit' if value.to_s =~ /7-?bits?/i
-      value = '8bit' if value.to_s =~ /8-?bits?/i
-      super(CAPITALIZED_FIELD, value, charset)
-      self.parse
-      self
+  class ContentTransferEncodingField < NamedStructuredField #:nodoc:
+    NAME = 'Content-Transfer-Encoding'
+
+    def self.singular?
+      true
     end
-    
-    def parse(val = value)
-      unless Utilities.blank?(val)
-        @element = Mail::ContentTransferEncodingElement.new(val)
+
+    def self.normalize_content_transfer_encoding(value)
+      case value
+      when /7-?bits?/i
+        '7bit'
+      when /8-?bits?/i
+        '8bit'
+      else
+        value
       end
     end
-    
+
+    def initialize(value = nil, charset = nil)
+      super self.class.normalize_content_transfer_encoding(value), charset
+    end
+
     def element
       @element ||= Mail::ContentTransferEncodingElement.new(value)
     end
-    
+
     def encoding
       element.encoding
     end
-    
-    # TODO: Fix this up
-    def encoded
-      "#{CAPITALIZED_FIELD}: #{encoding}\r\n"
-    end
-    
-    def decoded
-      encoding
-    end
-    
+
+    private
+      def do_encode
+        "#{name}: #{encoding}\r\n"
+      end
+
+      def do_decode
+        encoding
+      end
   end
 end

data/lib/mail/fields/content_type_field.rb

@@ -1,53 +1,55 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common/parameter_hash'
+require 'mail/fields/named_structured_field'
+require 'mail/fields/parameter_hash'
 
 module Mail
-  class ContentTypeField < StructuredField
+  class ContentTypeField < NamedStructuredField #:nodoc:
+    NAME = 'Content-Type'
 
-    FIELD_NAME = 'content-type'
-    CAPITALIZED_FIELD = 'Content-Type'
+    class << self
+      def singular?
+        true
+      end
+
+      def with_boundary(type)
+        new "#{type}; boundary=#{generate_boundary}"
+      end
+
+      def generate_boundary
+        "--==_mimepart_#{Mail.random_tag}"
+      end
+    end
 
-    def initialize(value = nil, charset = 'utf-8')
-      self.charset = charset
-      if value.class == Array
+    def initialize(value = nil, charset = nil)
+      if value.is_a? Array
         @main_type = value[0]
         @sub_type = value[1]
         @parameters = ParameterHash.new.merge!(value.last)
       else
         @main_type = nil
         @sub_type = nil
-        @parameters = nil
         value = value.to_s
       end
-      value = ensure_filename_quoted(value)
-      super(CAPITALIZED_FIELD, value, charset)
-      self.parse
-      self
-    end
 
-    def parse(val = value)
-      unless Utilities.blank?(val)
-        self.value = val
-        @element = nil
-        element
-      end
+      super ensure_filename_quoted(value), charset
     end
 
     def element
-      begin
-        @element ||= Mail::ContentTypeElement.new(value)
-      rescue
-        attempt_to_clean
-      end
+      @element ||=
+        begin
+          Mail::ContentTypeElement.new(value)
+        rescue Mail::Field::ParseError
+          attempt_to_clean
+        end
     end
 
     def attempt_to_clean
       # Sanitize the value, handle special cases
-      @element ||= Mail::ContentTypeElement.new(sanatize(value))
-    rescue
+      Mail::ContentTypeElement.new(sanitize(value))
+    rescue Mail::Field::ParseError
       # All else fails, just get the MIME media type
-      @element ||= Mail::ContentTypeElement.new(get_mime_type(value))
+      Mail::ContentTypeElement.new(get_mime_type(value))
     end
 
     def main_type
@@ -61,31 +63,22 @@ module Mail
     def string
       "#{main_type}/#{sub_type}"
     end
+    alias_method :content_type, :string
 
     def default
       decoded
     end
 
-    alias :content_type :string
-
     def parameters
-      unless @parameters
+      unless defined? @parameters
         @parameters = ParameterHash.new
         element.parameters.each { |p| @parameters.merge!(p) }
       end
       @parameters
     end
 
-    def ContentTypeField.with_boundary(type)
-      new("#{type}; boundary=#{generate_boundary}")
-    end
-
-    def ContentTypeField.generate_boundary
-      "--==_mimepart_#{Mail.random_tag}"
-    end
-
     def value
-      if @value.class == Array
+      if @value.is_a? Array
         "#{@main_type}/#{@sub_type}; #{stringify(parameters)}"
       else
         @value
@@ -97,34 +90,17 @@ module Mail
     end
 
     def filename
-      case
-      when parameters['filename']
-        @filename = parameters['filename']
-      when parameters['name']
-        @filename = parameters['name']
-      else
-        @filename = nil
-      end
-      @filename
+      @filename ||= parameters['filename'] || parameters['name']
     end
 
-    # TODO: Fix this up
     def encoded
-      if parameters.length > 0
-        p = ";\r\n\s#{parameters.encoded}"
-      else
-        p = ""
-      end
-      "#{CAPITALIZED_FIELD}: #{content_type}#{p}\r\n"
+      p = ";\r\n\s#{parameters.encoded}" if parameters && parameters.length > 0
+      "#{name}: #{content_type}#{p}\r\n"
     end
 
     def decoded
-      if parameters.length > 0
-        p = "; #{parameters.decoded}"
-      else
-        p = ""
-      end
-      "#{content_type}" + p
+      p = "; #{parameters.decoded}" if parameters && parameters.length > 0
+      "#{content_type}#{p}"
     end
 
     private
@@ -140,16 +116,15 @@ module Mail
 
     # Various special cases from random emails found that I am not going to change
     # the parser for
-    def sanatize( val )
-
+    def sanitize(val)
       # TODO: check if there are cases where whitespace is not a separator
       val = val.
         gsub(/\s*=\s*/,'='). # remove whitespaces around equal sign
         gsub(/[; ]+/, '; '). #use '; ' as a separator (or EOL)
         gsub(/;\s*$/,'') #remove trailing to keep examples below
 
-      if val =~ /(boundary=(\S*))/i
-        val = "#{$`.downcase}boundary=#{$2}#{$'.downcase}"
+      if val =~ /((boundary|name|filename)=(\S*))/i
+        val = "#{$`.downcase}#{$2}=#{$3}#{$'.downcase}"
       else
         val.downcase!
       end
@@ -158,7 +133,7 @@ module Mail
       when val.chomp =~ /^\s*([\w\-]+)\/([\w\-]+)\s*;\s?(ISO[\w\-]+)$/i
         # Microsoft helper:
         # Handles 'type/subtype;ISO-8559-1'
-        "#{$1}/#{$2}; charset=#{quote_atom($3)}"
+        "#{$1}/#{$2}; charset=#{Utilities.quote_atom($3)}"
       when val.chomp =~ /^text;?$/i
         # Handles 'text;' and 'text'
         "text/plain;"
@@ -167,7 +142,7 @@ module Mail
         "text/plain; #{$2}"
       when val =~ /([\w\-]+\/[\w\-]+);\scharset="charset="(\w+)""/i
         # Handles text/html; charset="charset="GB2312""
-        "#{$1}; charset=#{quote_atom($2)}"
+        "#{$1}; charset=#{Utilities.quote_atom($2)}"
       when val =~ /([\w\-]+\/[\w\-]+);\s+(.*)/i
         type = $1
         # Handles misquoted param values
@@ -176,7 +151,7 @@ module Mail
         params = $2.to_s.split(/\s+/)
         params = params.map { |i| i.to_s.chomp.strip }
         params = params.map { |i| i.split(/\s*\=\s*/, 2) }
-        params = params.map { |i| "#{i[0]}=#{dquote(i[1].to_s.gsub(/;$/,""))}" }.join('; ')
+        params = params.map { |i| "#{i[0]}=#{Utilities.dquote(i[1].to_s.gsub(/;$/,""))}" }.join('; ')
         "#{type}; #{params}"
       when val =~ /^\s*$/
         'text/plain'
@@ -185,9 +160,9 @@ module Mail
       end
     end
 
-    def get_mime_type( val )
-      case
-      when val =~ /^([\w\-]+)\/([\w\-]+);.+$/i
+    def get_mime_type(val)
+      case val
+      when /^([\w\-]+)\/([\w\-]+);.+$/i
         "#{$1}/#{$2}"
       else
         'text/plain'

data/lib/mail/fields/date_field.rb

@@ -1,57 +1,29 @@
 # encoding: utf-8
 # frozen_string_literal: true
-#
-# = Date Field
-#
-# The Date field inherits from StructuredField and handles the Date: header
-# field in the email.
-#
-# Sending date to a mail message will instantiate a Mail::Field object that
-# has a DateField as its field type.  This includes all Mail::CommonAddress
-# module instance methods.
-#
-# There must be excatly one Date field in an RFC2822 email.
-#
-# == Examples:
-#
-#  mail = Mail.new
-#  mail.date = 'Mon, 24 Nov 1997 14:22:01 -0800'
-#  mail.date       #=> #<DateTime: 211747170121/86400,-1/3,2299161>
-#  mail.date.to_s  #=> 'Mon, 24 Nov 1997 14:22:01 -0800'
-#  mail[:date]     #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::DateField:0x180e1c4
-#  mail['date']    #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::DateField:0x180e1c4
-#  mail['Date']    #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::DateField:0x180e1c4
-#
-require 'mail/fields/common/common_date'
+require 'mail/fields/common_date_field'
 
 module Mail
-  class DateField < StructuredField
-
-    include Mail::CommonDate
-
-    FIELD_NAME = 'date'
-    CAPITALIZED_FIELD = "Date"
-
-    def initialize(value = nil, charset = 'utf-8')
-      self.charset = charset
-      if Utilities.blank?(value)
-        value = ::DateTime.now.strftime('%a, %d %b %Y %H:%M:%S %z')
-      else
-        value = value.to_s.gsub(/\(.*?\)/, '').squeeze(' ')
-        value = ::DateTime.parse(value).strftime('%a, %d %b %Y %H:%M:%S %z')
-      end
-      super(CAPITALIZED_FIELD, value, charset)
-    rescue ArgumentError => e
-      raise e unless "invalid date"==e.message
-    end
-
-    def encoded
-      do_encode(CAPITALIZED_FIELD)
-    end
-
-    def decoded
-      do_decode
-    end
-
+  # = Date Field
+  #
+  # The Date field inherits from StructuredField and handles the Date: header
+  # field in the email.
+  #
+  # Sending date to a mail message will instantiate a Mail::Field object that
+  # has a DateField as its field type.  This includes all Mail::CommonAddress
+  # module instance methods.
+  #
+  # There must be excatly one Date field in an RFC2822 email.
+  #
+  # == Examples:
+  #
+  #  mail = Mail.new
+  #  mail.date = 'Mon, 24 Nov 1997 14:22:01 -0800'
+  #  mail.date       #=> #<DateTime: 211747170121/86400,-1/3,2299161>
+  #  mail.date.to_s  #=> 'Mon, 24 Nov 1997 14:22:01 -0800'
+  #  mail[:date]     #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::DateField:0x180e1c4
+  #  mail['date']    #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::DateField:0x180e1c4
+  #  mail['Date']    #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::DateField:0x180e1c4
+  class DateField < CommonDateField #:nodoc:
+    NAME = 'Date'
   end
 end

data/lib/mail/fields/from_field.rb

@@ -1,55 +1,34 @@
 # encoding: utf-8
 # frozen_string_literal: true
-# 
-# = From Field
-# 
-# The From field inherits from StructuredField and handles the From: header
-# field in the email.
-# 
-# Sending from to a mail message will instantiate a Mail::Field object that
-# has a FromField as its field type.  This includes all Mail::CommonAddress
-# module instance metods.
-# 
-# Only one From field can appear in a header, though it can have multiple
-# addresses and groups of addresses.
-# 
-# == Examples:
-# 
-#  mail = Mail.new
-#  mail.from = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
-#  mail.from    #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
-#  mail[:from]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::FromField:0x180e1c4
-#  mail['from'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::FromField:0x180e1c4
-#  mail['From'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::FromField:0x180e1c4
-# 
-#  mail[:from].encoded   #=> 'from: Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net\r\n'
-#  mail[:from].decoded   #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
-#  mail[:from].addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
-#  mail[:from].formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
-# 
-require 'mail/fields/common/common_address'
+require 'mail/fields/common_address_field'
 
 module Mail
-  class FromField < StructuredField
-    
-    include Mail::CommonAddress
-    
-    FIELD_NAME = 'from'
-    CAPITALIZED_FIELD = 'From'
-    
-    def initialize(value = nil, charset = 'utf-8')
-      self.charset = charset
-      super(CAPITALIZED_FIELD, value, charset)
-      self
-    end
-    
-    def encoded
-      do_encode(CAPITALIZED_FIELD)
-    end
-    
-    def decoded
-      do_decode
-    end
-
+  # = From Field
+  #
+  # The From field inherits from StructuredField and handles the From: header
+  # field in the email.
+  #
+  # Sending from to a mail message will instantiate a Mail::Field object that
+  # has a FromField as its field type.  This includes all Mail::CommonAddress
+  # module instance metods.
+  #
+  # Only one From field can appear in a header, though it can have multiple
+  # addresses and groups of addresses.
+  #
+  # == Examples:
+  #
+  #  mail = Mail.new
+  #  mail.from = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+  #  mail.from    #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
+  #  mail[:from]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::FromField:0x180e1c4
+  #  mail['from'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::FromField:0x180e1c4
+  #  mail['From'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::FromField:0x180e1c4
+  #
+  #  mail[:from].encoded   #=> 'from: Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net\r\n'
+  #  mail[:from].decoded   #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+  #  mail[:from].addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
+  #  mail[:from].formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
+  class FromField < CommonAddressField #:nodoc:
+    NAME = 'From'
   end
 end