mail 1.5.0 → 1.5.1

data/Rakefile

@@ -12,7 +12,7 @@ require 'bundler'
 
 spec = Gem::Specification.new do |s|
   s.name        = "mail"
-  s.version     = "1.5.0"
+  s.version     = "1.5.1"
   s.author      = "Mike Lindsaar"
   s.email       = "raasdnil@gmail.com"
   s.homepage    = "http://github.com/mikel/mail"

data/lib/mail/message.rb

@@ -47,10 +47,59 @@ module Mail
     include Patterns
     include Utilities
     
-    # Creates a new Mail::Message object through .new
+    # ==Making an email
+    # 
+    # You can make an new mail object via a block, passing a string, file or direct assignment.
+    # 
+    # ===Making an email via a block
+    # 
+    #  mail = Mail.new do
+    #       from 'mikel@test.lindsaar.net'
+    #         to 'you@test.lindsaar.net'
+    #    subject 'This is a test email'
+    #       body File.read('body.txt')
+    #  end
+    # 
+    #  mail.to_s #=> "From: mikel@test.lindsaar.net\r\nTo: you@...
+    #
+    # ===Making an email via passing a string
+    # 
+    #  mail = Mail.new("To: mikel@test.lindsaar.net\r\nSubject: Hello\r\n\r\nHi there!")
+    #  mail.body.to_s #=> 'Hi there!'
+    #  mail.subject   #=> 'Hello'
+    #  mail.to        #=> 'mikel@test.lindsaar.net'
+    # 
+    # ===Making an email from a file
+    # 
+    #  mail = Mail.read('path/to/file.eml')
+    #  mail.body.to_s #=> 'Hi there!'
+    #  mail.subject   #=> 'Hello'
+    #  mail.to        #=> 'mikel@test.lindsaar.net'
+    # 
+    # ===Making an email via assignment
+    # 
+    # You can assign values to a mail object via four approaches:
+    # 
+    # * Message#field_name=(value)
+    # * Message#field_name(value)
+    # * Message#['field_name']=(value)
+    # * Message#[:field_name]=(value)
+    # 
+    # Examples:
+    # 
+    #  mail = Mail.new
+    #  mail['from'] = 'mikel@test.lindsaar.net'
+    #  mail[:to]    = 'you@test.lindsaar.net'
+    #  mail.subject 'This is a test email'
+    #  mail.body    = 'This is a body'
+    # 
+    #  mail.to_s #=> "From: mikel@test.lindsaar.net\r\nTo: you@...
+    # 
     def initialize(*args, &block)
       @body = nil
-
+      @text_part = nil
+      @html_part = nil
+      
       if args.flatten.first.respond_to?(:each_pair)
         init_with_hash(args.flatten.first)
       else
@@ -64,10 +113,30 @@ module Mail
       self
     end
     
+    # Delivers an mail object.
+    # 
+    # Examples:
+    # 
+    #  mail = Mail.read('file.eml')
+    #  mail.deliver!
     def deliver!
       Deliverable.perform_delivery!(self)
     end
     
+    # Provides the operator needed for sort et al.
+    # 
+    # Compares this mail object with another mail object, this is done by date, so an
+    # email that is older than another will appear first.
+    # 
+    # Example:
+    # 
+    #  mail1 = Mail.new do
+    #    date(Time.now)
+    #  end
+    #  mail2 = Mail.new do
+    #    date(Time.now - 86400) # 1 day older
+    #  end
+    #  [mail2, mail1].sort #=> [mail2, mail1]
     def <=>(other)
       if other.nil?
         1
@@ -76,11 +145,48 @@ module Mail
       end
     end
     
+    # Two emails are the same if they have the same fields and body contents. One
+    # gotcha here is that Mail will insert Message-IDs when calling encoded, so doing
+    # mail1.encoded == mail2.encoded is most probably not going to return what you think
+    # as the assigned Message-IDs by Mail (if not already defined as the same) will ensure
+    # that the two objects are unique, and this comparison will ALWAYS return false.
+    # 
+    # So the == operator has been defined like so:  Two messages are the same if they have
+    # the same content, ignoring the Message-ID field, unless BOTH emails have a defined and
+    # different Message-ID value, then they are false.
+    # 
+    # So, in practice the == operator works like this:
+    # 
+    #  m1 = Mail.new("Subject: Hello\r\n\r\nHello")
+    #  m2 = Mail.new("Subject: Hello\r\n\r\nHello")
+    #  m1 == m2 #=> true
+    # 
+    #  m1 = Mail.new("Subject: Hello\r\n\r\nHello")
+    #  m2 = Mail.new("Message-ID: <1234@test>\r\nSubject: Hello\r\n\r\nHello")
+    #  m1 == m2 #=> true
+    # 
+    #  m1 = Mail.new("Message-ID: <1234@test>\r\nSubject: Hello\r\n\r\nHello")
+    #  m2 = Mail.new("Subject: Hello\r\n\r\nHello")
+    #  m1 == m2 #=> true
+    # 
+    #  m1 = Mail.new("Message-ID: <1234@test>\r\nSubject: Hello\r\n\r\nHello")
+    #  m2 = Mail.new("Message-ID: <1234@test>\r\nSubject: Hello\r\n\r\nHello")
+    #  m1 == m2 #=> true
+    # 
+    #  m1 = Mail.new("Message-ID: <1234@test>\r\nSubject: Hello\r\n\r\nHello")
+    #  m2 = Mail.new("Message-ID: <DIFFERENT@test>\r\nSubject: Hello\r\n\r\nHello")
+    #  m1 == m2 #=> false
     def ==(other)
-      unless other.respond_to?(:encoded)
-        false
+      return false unless other.respond_to?(:encoded)
+      
+      if self.message_id && other.message_id
+        result = (self.encoded == other.encoded)
       else
-        self.encoded == other.encoded
+        self_message_id, other_message_id = self.message_id, other.message_id
+        self.message_id, other.message_id = '<temp@test>', '<temp@test>'
+        result = self.encoded == other.encoded
+        self.message_id, other.message_id = "<#{self_message_id}>", "<#{other_message_id}>"
+        result
       end
     end
     
@@ -96,10 +202,7 @@ module Mail
       @raw_source
     end
     
-    def raw_source=(value)
-      @raw_source = value.to_crlf
-    end
-    
+    # Sets the envelope from for the email
     def set_envelope( val )
       @raw_envelope = val
       @envelope = Mail::Envelope.new( val )
@@ -1141,7 +1244,7 @@ module Mail
     def html_part(&block)
       if block_given?
         @html_part = Mail::Part.new(&block)
-        add_multipart_alternate_header
+        add_multipart_alternate_header unless html_part.blank?
         add_part(@html_part)
       else
         @html_part
@@ -1152,7 +1255,7 @@ module Mail
     def text_part(&block)
       if block_given?
         @text_part = Mail::Part.new(&block)
-        add_multipart_alternate_header
+        add_multipart_alternate_header unless html_part.blank?
         add_part(@text_part)
       else
         @text_part
@@ -1168,7 +1271,7 @@ module Mail
       else
         @html_part = Mail::Part.new('Content-Type: text/html;')
       end
-      add_multipart_alternate_header
+      add_multipart_alternate_header unless text_part.blank?
       add_part(@html_part)
     end
     
@@ -1181,7 +1284,7 @@ module Mail
       else
         @text_part = Mail::Part.new('Content-Type: text/plain;')
       end
-      add_multipart_alternate_header
+      add_multipart_alternate_header unless html_part.blank?
       add_part(@text_part)
     end
 
@@ -1330,6 +1433,10 @@ module Mail
       self.body   = body_part
     end
     
+    def raw_source=(value)
+      @raw_source = value.to_crlf
+    end
+    
     def set_envelope_header
       if match_data = raw_source.to_s.match(/^From\s(#{TEXT}+)#{CRLF}(.*)/m)
         set_envelope(match_data[1])

data/lib/mail/parsers/content_type.rb

@@ -80,19 +80,24 @@ module Mail
               s5 << r6
               if r6
                 if has_terminal?(";", false, index)
-                  r7 = instantiate_node(SyntaxNode,input, index...(index + 1))
+                  r8 = instantiate_node(SyntaxNode,input, index...(index + 1))
                   @index += 1
                 else
                   terminal_parse_failure(";")
-                  r7 = nil
+                  r8 = nil
+                end
+                if r8
+                  r7 = r8
+                else
+                  r7 = instantiate_node(SyntaxNode,input, index...index)
                 end
                 s5 << r7
                 if r7
-                  r8 = _nt_parameter
-                  s5 << r8
-                  if r8
-                    r9 = _nt_CFWS
-                    s5 << r9
+                  r9 = _nt_parameter
+                  s5 << r9
+                  if r9
+                    r10 = _nt_CFWS
+                    s5 << r10
                   end
                 end
               end

data/lib/mail/parsers/content_type.treetop

@@ -5,7 +5,7 @@ module Mail
     include RFC2045
     
     rule content_type
-      main_type "/" sub_type param_hashes:(CFWS ";" parameter CFWS)* {
+      main_type "/" sub_type param_hashes:(CFWS ";"? parameter CFWS)* {
         def parameters
           param_hashes.elements.map do |param|
             param.parameter.param_hash

data/lib/mail/vendor/treetop-1.4.3/examples/lambda_calculus/arithmetic.rb

@@ -2,7 +2,7 @@ module Arithmetic
   include Treetop::Runtime
   
   def root
-    @root || :expression
+    @root ||= :expression
   end
   
   def _nt_expression

data/lib/mail/vendor/treetop-1.4.3/examples/lambda_calculus/lambda_calculus.rb

@@ -2,7 +2,7 @@ module LambdaCalculus
   include Treetop::Runtime
   
   def root
-    @root || :program
+    @root ||= :program
   end
   
   include Arithmetic

data/lib/mail/vendor/treetop-1.4.3/lib/treetop/compiler/metagrammar.rb

@@ -7,7 +7,7 @@ module Treetop
       include Treetop::Runtime
 
       def root
-        @root || :treetop_file
+        @root ||= :treetop_file
       end
 
       module TreetopFile0

data/lib/mail/version.rb

@@ -3,7 +3,7 @@ module Mail
   module VERSION
     MAJOR = 1
     MINOR = 5
-    TINY  = 0
+    TINY  = 1
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/tasks/corpus.rake

@@ -1,16 +1,17 @@
 namespace :corpus do
 
   task :load_mail do
+    $:.unshift File.expand_path('../', File.dirname(__FILE__))
     require 'lib/mail'
   end
   
   # Used to run parsing against an arbitrary corpus of email.
   # For example: http://plg.uwaterloo.ca/~gvcormac/treccorpus/
-  desc "Provide a LOCATION=/some/dir to verify parsing in bulk"
+  desc "Provide a LOCATION=/some/dir to verify parsing in bulk, otherwise defaults"
   task :verify_all => :load_mail do
 
-    root_of_corpus    = ENV['LOCATION']
-    @save_failures_to = ENV['SAVE_TO']
+    root_of_corpus    = ENV['LOCATION'] || 'spec/fixtures/corpus/spam'
+    @save_failures_to = ENV['SAVE_TO']  || 'spec/fixtures/emails/failed_emails'
     @failed_emails    = []
     @checked_count    = 0
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mail
 version: !ruby/object:Gem::Version 
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors: 
 - Mike Lindsaar
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-03 00:00:00 +11:00
+date: 2010-01-04 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency