Merge pull request #1491 from c960657/autoload-fields

Lazy-load fields and elements

Author: mikel

CHANGELOG.rdoc

@@ -1,6 +1,7 @@
 == Version 2.9.0 (unreleased)
 
 Breaking changes:
+* Mail::Field::FIELDS_MAP now contains class names, not Class instances (c960657)
 
 Compatibility:
 

lib/mail.rb

@@ -48,7 +48,7 @@ def self.eager_autoload!
   require 'mail/field'
   require 'mail/field_list'
 
-  require 'mail/envelope'
+  register_autoload :Envelope, 'mail/envelope'
 
   # Autoload header field elements and transfer encodings.
   require 'mail/elements'
@@ -58,7 +58,7 @@ def self.eager_autoload!
   require 'mail/encodings/unix_to_unix'
 
   require 'mail/matchers/has_sent_mail'
-  require 'mail/matchers/attachment_matchers.rb'
+  require 'mail/matchers/attachment_matchers'
 
   # Finally... require all the Mail.methods
   require 'mail/mail'

lib/mail/field.rb

@@ -36,40 +36,68 @@ class Field
     KNOWN_FIELDS = STRUCTURED_FIELDS + ['comments', 'subject']
 
     FIELDS_MAP = {
-      "to" => ToField,
-      "cc" => CcField,
-      "bcc" => BccField,
-      "message-id" => MessageIdField,
-      "in-reply-to" => InReplyToField,
-      "references" => ReferencesField,
-      "subject" => SubjectField,
-      "comments" => CommentsField,
-      "keywords" => KeywordsField,
-      "date" => DateField,
-      "from" => FromField,
-      "sender" => SenderField,
-      "reply-to" => ReplyToField,
-      "resent-date" => ResentDateField,
-      "resent-from" => ResentFromField,
-      "resent-sender" =>  ResentSenderField,
-      "resent-to" => ResentToField,
-      "resent-cc" => ResentCcField,
-      "resent-bcc" => ResentBccField,
-      "resent-message-id" => ResentMessageIdField,
-      "return-path" => ReturnPathField,
-      "received" => ReceivedField,
-      "mime-version" => MimeVersionField,
-      "content-transfer-encoding" => ContentTransferEncodingField,
-      "content-description" => ContentDescriptionField,
-      "content-disposition" => ContentDispositionField,
-      "content-type" => ContentTypeField,
-      "content-id" => ContentIdField,
-      "content-location" => ContentLocationField,
+      "to" => "ToField",
+      "cc" => "CcField",
+      "bcc" => "BccField",
+      "message-id" => "MessageIdField",
+      "in-reply-to" => "InReplyToField",
+      "references" => "ReferencesField",
+      "subject" => "SubjectField",
+      "comments" => "CommentsField",
+      "keywords" => "KeywordsField",
+      "date" => "DateField",
+      "from" => "FromField",
+      "sender" => "SenderField",
+      "reply-to" => "ReplyToField",
+      "resent-date" => "ResentDateField",
+      "resent-from" => "ResentFromField",
+      "resent-sender" => "ResentSenderField",
+      "resent-to" => "ResentToField",
+      "resent-cc" => "ResentCcField",
+      "resent-bcc" => "ResentBccField",
+      "resent-message-id" => "ResentMessageIdField",
+      "return-path" => "ReturnPathField",
+      "received" => "ReceivedField",
+      "mime-version" => "MimeVersionField",
+      "content-transfer-encoding" => "ContentTransferEncodingField",
+      "content-description" => "ContentDescriptionField",
+      "content-disposition" => "ContentDispositionField",
+      "content-type" => "ContentTypeField",
+      "content-id" => "ContentIdField",
+      "content-location" => "ContentLocationField",
     }
 
-    FIELD_NAME_MAP = FIELDS_MAP.inject({}) do |map, (field, field_klass)|
-      map.update(field => field_klass::NAME)
-    end
+    FIELD_NAME_MAP = {
+      "to" => "To",
+      "cc" => "Cc",
+      "bcc" => "Bcc",
+      "message-id" => "Message-ID",
+      "in-reply-to" => "In-Reply-To",
+      "references" => "References",
+      "subject" => "Subject",
+      "comments" => "Comments",
+      "keywords" => "Keywords",
+      "date" => "Date",
+      "from" => "From",
+      "sender" => "Sender",
+      "reply-to" => "Reply-To",
+      "resent-date" => "Resent-Date",
+      "resent-from" => "Resent-From",
+      "resent-sender" => "Resent-Sender",
+      "resent-to" => "Resent-To",
+      "resent-cc" => "Resent-Cc",
+      "resent-bcc" => "Resent-Bcc",
+      "resent-message-id" => "Resent-Message-ID",
+      "return-path" => "Return-Path",
+      "received" => "Received",
+      "mime-version" => "MIME-Version",
+      "content-transfer-encoding" => "Content-Transfer-Encoding",
+      "content-description" => "Content-Description",
+      "content-disposition" => "Content-Disposition",
+      "content-type" => "Content-Type",
+      "content-id" => "Content-ID",
+      "content-location" => "Content-Location",
+    }
 
     # Generic Field Exception
     class FieldError < StandardError
@@ -145,7 +173,8 @@ def split(raw_field) #:nodoc:
       end
 
       def field_class_for(name) #:nodoc:
-        FIELDS_MAP[name.to_s.downcase]
+        class_name = FIELDS_MAP[name.to_s.downcase]
+        Mail.const_get(class_name) if class_name
       end
     end
 
@@ -176,7 +205,8 @@ def initialize(name, value = nil, charset = 'utf-8')
         @unparsed_value = value
         @charset = charset
       end
-      @name = FIELD_NAME_MAP[@name.to_s.downcase] || @name
+      klass = self.class.field_class_for(@name)
+      @name = klass ? klass::NAME : @name
     end
 
     def field=(field)

lib/mail/fields.rb

@@ -1,6 +1,12 @@
 # frozen_string_literal: true
 module Mail
+  register_autoload :CommonField, 'mail/fields/common_field'
+  register_autoload :CommonAddressField, 'mail/fields/common_address_field'
+  register_autoload :CommonMessageIdField, 'mail/fields/common_message_id_field'
+  register_autoload :CommonDateField, 'mail/fields/common_date_field'
+
   register_autoload :UnstructuredField, 'mail/fields/unstructured_field'
+  register_autoload :NamedUnstructuredField, 'mail/fields/named_unstructured_field'
   register_autoload :StructuredField, 'mail/fields/structured_field'
   register_autoload :OptionalField, 'mail/fields/optional_field'
 
@@ -19,6 +25,7 @@ module Mail
   register_autoload :KeywordsField, 'mail/fields/keywords_field'
   register_autoload :MessageIdField, 'mail/fields/message_id_field'
   register_autoload :MimeVersionField, 'mail/fields/mime_version_field'
+  register_autoload :NamedStructuredField, 'mail/fields/named_structured_field'
   register_autoload :ReceivedField, 'mail/fields/received_field'
   register_autoload :ReferencesField, 'mail/fields/references_field'
   register_autoload :ReplyToField, 'mail/fields/reply_to_field'
@@ -33,4 +40,6 @@ module Mail
   register_autoload :SenderField, 'mail/fields/sender_field'
   register_autoload :SubjectField, 'mail/fields/subject_field'
   register_autoload :ToField, 'mail/fields/to_field'
+
+  register_autoload :ParameterHash, 'mail/fields/parameter_hash'
 end

lib/mail/fields/bcc_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_address_field'
 
 module Mail
   # = Blind Carbon Copy Field

lib/mail/fields/cc_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_address_field'
 
 module Mail
   # = Carbon Copy Field

lib/mail/fields/comments_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/named_unstructured_field'
 
 module Mail
   # = Comments Field

lib/mail/fields/common_address_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/named_structured_field'
 
 module Mail
   class AddressContainer < Array #:nodoc:

lib/mail/fields/common_date_field.rb

@@ -1,5 +1,3 @@
-require 'mail/fields/named_structured_field'
-require 'mail/elements/date_time_element'
 require 'mail/utilities'
 
 module Mail

lib/mail/fields/common_message_id_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/named_structured_field'
 require 'mail/utilities'
 
 module Mail

lib/mail/fields/content_description_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/named_unstructured_field'
 
 module Mail
   class ContentDescriptionField < NamedUnstructuredField #:nodoc:

lib/mail/fields/content_disposition_field.rb

@@ -1,7 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/named_structured_field'
-require 'mail/fields/parameter_hash'
 
 module Mail
   class ContentDispositionField < NamedStructuredField #:nodoc:

lib/mail/fields/content_id_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/named_structured_field'
 require 'mail/utilities'
 
 module Mail

lib/mail/fields/content_location_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/named_structured_field'
 
 module Mail
   class ContentLocationField < NamedStructuredField #:nodoc:

lib/mail/fields/content_transfer_encoding_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/named_structured_field'
 
 module Mail
   class ContentTransferEncodingField < NamedStructuredField #:nodoc:

lib/mail/fields/content_type_field.rb

@@ -1,7 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/named_structured_field'
-require 'mail/fields/parameter_hash'
 
 module Mail
   class ContentTypeField < NamedStructuredField #:nodoc:

lib/mail/fields/date_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_date_field'
 
 module Mail
   # = Date Field

lib/mail/fields/from_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_address_field'
 
 module Mail
   # = From Field

lib/mail/fields/in_reply_to_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_message_id_field'
 
 module Mail
   # = In-Reply-To Field

lib/mail/fields/keywords_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/named_structured_field'
 
 module Mail
   # keywords        =       "Keywords:" phrase *("," phrase) CRLF

lib/mail/fields/message_id_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_message_id_field'
 require 'mail/utilities'
 
 module Mail

lib/mail/fields/mime_version_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/named_structured_field'
 require 'mail/utilities'
 
 module Mail

lib/mail/fields/named_structured_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/structured_field'
 
 module Mail
   class NamedStructuredField < StructuredField #:nodoc:

lib/mail/fields/named_unstructured_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/unstructured_field'
 
 module Mail
   class NamedUnstructuredField < UnstructuredField #:nodoc:

lib/mail/fields/optional_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/unstructured_field'
 
 module Mail
   # The field names of any optional-field MUST NOT be identical to any

lib/mail/fields/received_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/named_structured_field'
 
 module Mail
   # trace           =       [return]

lib/mail/fields/references_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_message_id_field'
 
 module Mail
   # = References Field

lib/mail/fields/reply_to_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_address_field'
 
 module Mail
   # = Reply-To Field

lib/mail/fields/resent_bcc_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_address_field'
 
 module Mail
   # = Resent-Bcc Field

lib/mail/fields/resent_cc_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_address_field'
 
 module Mail
   # = Resent-Cc Field

lib/mail/fields/resent_date_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_date_field'
 
 module Mail
   #

lib/mail/fields/resent_from_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_address_field'
 
 module Mail
   # = Resent-From Field

lib/mail/fields/resent_message_id_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_message_id_field'
 
 module Mail
   #

lib/mail/fields/resent_sender_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_address_field'
 
 module Mail
   # = Resent-Sender Field

lib/mail/fields/resent_to_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_address_field'
 
 module Mail
   # = Resent-To Field

lib/mail/fields/return_path_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_address_field'
 
 module Mail
   # 4.4.3.  REPLY-TO / RESENT-REPLY-TO