mail 2.5.4 → 2.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ecb5e9115e61802f251480eef90c6698ac665d0b
+  data.tar.gz: a1105d5defc2c7b374598a392e5f5dc4d1452a21
+SHA512:
+  metadata.gz: 103d2126c02d1aeb5ffd4982f261407af16652fd181f6e0fc63bf12702e5aa1ea3c7f863a3c39f822ba3b8e8cf704782d1beb7c4e2e28cba5f4fc2931151cf0e
+  data.tar.gz: 6f25c0decaf77a0314b42d0fbf6c61edfc7f2fe9b4bbeef004e34a7127882093b660108cd7728a108f26b1b3dcf2664beac4e5e6d0d0d3e68565f78fdd273d4e

data/CHANGELOG.rdoc

@@ -1,9 +1,10 @@
 == HEAD
 
-
-== Version 2.5.4 - Tue May 14 14:45:00 +1100 2013 Mikel Lindsaar <mikel@lindsaar.net>
+== Version 2.6.0 - Mon Jun 2 22:49 +1100 2014 Mikel Lindsaar <mikel@reinteractive.net>
 
 Features:
+* Allow interceptors and observers to be unregistered (zuhao)
+* Added feature to find the mail in uid (taketin)
 * Save settings passed to TestMailer#new (svanderbleek)
 * Allow the setting of envelope from directly (jeremy)
 * Accept other IETF/IANA-registered Content-Types and Content-Transfer-Encodings (jeremy)
@@ -19,9 +20,13 @@ Features:
 * Close pull request 389 - Don't add superfluous message headers to MIME parts (djmaze, jeremy)
 
 Performance:
+* Migrate to RAGEL based parser, awesome work by (bpot)
+* Performance improvements for people parsing email headers (ConradIrwin)
 * Close pull request 488 - Speed up field construction & comparison (bpot)
 
 Bugs:
+* Fix for when content looks like field name (kjg)
+* Don't change original when you change a copy (TylerRick)
 * Don't include separating semicolon in paramter value when sanitizing (bpot)
 * Fix fencepost encoding problem with binhex strings and only one token (drasch)
 * Fix sendmail delivery to addresses with a leading hyphen (lifo, jeremy)

data/CONTRIBUTING.md

@@ -43,3 +43,16 @@ Syntax:
 * Follow the conventions you see used in the source already.
 
 And in case we didn't emphasize it enough: we love specs!
+
+### Testing against mime-types versions:
+
+Use [appraisal](https://github.com/thoughtbot/appraisal) to run against all supported versions of mime-types.
+
+1. Run `(bundle check || bundle) && appraisal` so that all the 'appraised' gemfiles are bundled.
+2. Run either `appraisal rake` or `rake appraisal` to run all the tests.
+
+To run only one 'appraised' gemfile, run. e.g. `BUNDLE_GEMFILE=gemfiles/mime_types_edge.gemfile (bundle check || bundle) && rake`
+
+To change the appraisals, modify the `Appraisals` file, run `appraisal`, commit the generated gemfiles, and modify the .travis.yml matrix.
+
+To run on all rubies / gemfiles, just like TravisCI, see [WWTD](https://github.com/grosser/wwtd).

data/Dependencies.txt

@@ -1,3 +1,2 @@
-treetop: we need to include this in the gem spec
 tlsmail: if ruby < 1.8.6... we could make it optional, or embed it in Mail
 mime/types: I think we embed a simplified version, or help maintain it, it is old (2006)

data/Gemfile

@@ -1,13 +1,15 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 
-gem "treetop", "~> 1.4.10"
-gem "mime-types", "~> 1.16"
-gem "tlsmail" if RUBY_VERSION <= '1.8.6'
+gem "tlsmail", "~> 0.0.1" if RUBY_VERSION <= "1.8.6"
+gem "jruby-openssl", :platforms => :jruby
 
-gem 'jruby-openssl', :platform => :jruby
+group :development, :test do
+  gem "appraisal", "~> 1.0"
+end
 
-group :test do
-  gem "ruby-debug", :platform => :mri_18
+# For gems not required to run tests
+group :local_development, :test do
+  gem "ruby-debug", :platforms => :mri_18
 end

data/README.md

@@ -15,11 +15,11 @@ Built from my experience with TMail, it is designed to be a pure ruby
 implementation that makes generating, sending and parsing emails a no
 brainer.
 
-It is also designed form the ground up to work with Ruby 1.9.  This is because
-Ruby 1.9 handles text encodings much more magically than Ruby 1.8.x and so
-these features have been taken full advantage of in this library allowing
-Mail to handle a lot more messages more cleanly than TMail.  Mail does run on
-Ruby 1.8.x... it's just not as fun to code.
+It is also designed form the ground up to work with the more modern versions
+of Ruby.  This is because Ruby > 1.9 handles text encodings much more wonderfully
+than Ruby 1.8.x and so these features have been taken full advantage of in this
+library allowing Mail to handle a lot more messages more cleanly than TMail.
+Mail does run on Ruby 1.8.x... it's just not as fun to code.
 
 Finally, Mail has been designed with a very simple object oriented system
 that really opens up the email messages you are parsing, if you know what
@@ -44,14 +44,23 @@ Compatibility
 
 Every Mail commit is tested by Travis on the [following platforms](https://github.com/mikel/mail/blob/master/.travis.yml)
 
-* ruby-1.8.7-p370 [ i686 ]
-* ruby-1.9.2-p290 [ x86_64 ]
+* ruby-1.8.7-p374 [ i686 ]
+* ruby-1.9.2-p320 [ x86_64 ]
 * ruby-1.9.3-p327 [ x86_64 ]
-* ruby-2.0.0-rc1 [ x86_64 ]
-* jruby-1.6.8 [ x86_64 ]
-* jruby-1.7.0 [ x86_64 ]
-* rbx-d18 [ x86_64 ]
-* rbx-d19 [ x86_64 ]
+* ruby-2.0.0-p451 [ x86_64 ]
+* ruby-2.1.2 [ x86_64 ]
+* ruby-head [ x86_64 ]
+* jruby [ x86_64 ]
+* jruby-head [ x86_64 ]
+* rbx-2 [ x86_64 ]
+
+Testing a specific mime type (needed for 1.8.7 for example) can be done manually with:
+
+  $ BUNDLE_GEMFILE=gemfiles/mime_types_1.16.gemfile bundle check
+  $ BUNDLE_GEMFILE=gemfiles/mime_types_1.16.gemfile bundle
+  $ BUNDLE_GEMFILE=gemfiles/mime_types_1.16.gemfile rake
+
+
 
 Discussion
 ----------
@@ -186,6 +195,8 @@ mail['from'] = 'mikel@test.lindsaar.net'
 mail[:to]    = 'you@test.lindsaar.net'
 mail.subject = 'This is a test email'
 
+mail.header['X-Custom-Header'] = 'custom value'
+
 mail.to_s #=> "From: mikel@test.lindsaar.net\r\nTo: you@...
 ```
 
@@ -228,10 +239,10 @@ easy as:
 
 ```ruby
 Mail.deliver do
-   from    'me@test.lindsaar.net'
-   to      'you@test.lindsaar.net'
-   subject 'Here is the image you wanted'
-   body    File.read('body.txt')
+  from     'me@test.lindsaar.net'
+  to       'you@test.lindsaar.net'
+  subject  'Here is the image you wanted'
+  body     File.read('body.txt')
   add_file '/full/path/to/somefile.png'
 end
 ```
@@ -266,6 +277,15 @@ mail.delivery_method :sendmail
 mail.deliver
 ```
 
+Sending via smtp (for example to [mailcatcher](https://github.com/sj26/mailcatcher))
+```ruby
+
+Mail.defaults do
+  delivery_method :smtp, address: "localhost", port: 1025
+end
+```
+
+
 Exim requires its own delivery manager, and can be used like so:
 
 ```ruby
@@ -319,7 +339,7 @@ emails.length #=> LOTS!
 ```ruby
 mail = Mail.read('/path/to/message.eml')
 
-mail.envelope.from   #=> 'mikel@test.lindsaar.net'
+mail.envelope_from   #=> 'mikel@test.lindsaar.net'
 mail.from.addresses  #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
 mail.sender.address  #=> 'mikel@test.lindsaar.net'
 mail.to              #=> 'bob@test.lindsaar.net'
@@ -350,7 +370,7 @@ mail.parts[1].content_type_parameters  #=> {'name' => 'my.pdf'}
 Mail generates a tree of parts.  Each message has many or no parts.  Each part
 is another message which can have many or no parts.
 
-A message will only have parts if it is a multipart/mixed or related/mixed
+A message will only have parts if it is a multipart/mixed or multipart/related
 content type and has a boundary defined.
 
 ### Testing and extracting attachments
@@ -363,7 +383,7 @@ mail.attachments.each do | attachment |
     filename = attachment.filename
     begin
       File.open(images_dir + filename, "w+b", 0644) {|f| f.write attachment.body.decoded}
-    rescue Exception => e
+    rescue => e
       puts "Unable to save data for #{filename} because #{e.message}"
     end
   end
@@ -546,7 +566,7 @@ Using Mail with Testing or Spec'ing Libraries
 If mail is part of your system, you'll need a way to test it without actually
 sending emails, the TestMailer can do this for you.
 
-```
+```ruby
 require 'mail'
 => true
 Mail.defaults do
@@ -572,7 +592,7 @@ Mail::TestMailer.deliveries.clear
 
 There is also a set of RSpec matchers stolen fr^H^H^H^H^H^H^H^H inspired by Shoulda's ActionMailer matchers (you'll want to set <code>delivery_method</code> as above too):
 
-```
+```ruby
 Mail.defaults do
   delivery_method :test # in practice you'd do this in spec_helper.rb
 end

data/Rakefile

@@ -1,4 +1,6 @@
-ENV['BUNDLE_GEMFILE'] = File.expand_path('../Gemfile', __FILE__)
+if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
+  ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __FILE__)
+end
 require 'rubygems'
 require 'bundler/setup'
 
@@ -17,5 +19,11 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   t.rspec_opts = %w(--backtrace --color)
 end
 
+begin
+  require "appraisal"
+rescue LoadError
+  warn "Appraisal is only available in test/development"
+end
+
 # load custom rake tasks
-Dir["#{File.dirname(__FILE__)}/lib/tasks/**/*.rake"].sort.each { |ext| load ext }
+Dir["#{File.dirname(__FILE__)}/tasks/**/*.rake"].sort.each { |ext| load ext }

data/VERSION

@@ -0,0 +1,4 @@
+major:2
+minor:6
+patch:0
+build:

data/lib/mail/body.rb

@@ -127,9 +127,9 @@ module Mail
     def sort_parts!
       @parts.each do |p|
         p.body.set_sort_order(@part_sort_order)
-        @parts.sort!(@part_sort_order)
         p.body.sort_parts!
       end
+      @parts.sort!(@part_sort_order)
     end
     
     # Returns the raw source that the body was initialized with, without
@@ -257,7 +257,7 @@ module Mail
     
     def split!(boundary)
       self.boundary = boundary
-      parts = raw_source.split(/(?:\A|\r\n)--#{Regexp.escape(boundary)}(?=(?:--)?\s*$)/)
+      parts = raw_source.split(/(?:\A|\r\n)--#{Regexp.escape(boundary || "")}(?=(?:--)?\s*$)/)
       # Make the preamble equal to the preamble (if any)
       self.preamble = parts[0].to_s.strip
       # Make the epilogue equal to the epilogue (if any)

data/lib/mail/core_extensions/string.rb

@@ -1,11 +1,21 @@
 # encoding: utf-8
 class String #:nodoc:
+
+  if RUBY_VERSION >= '1.9'
+    # This 1.9 only regex can save a reasonable amount of time (~20%)
+    # by not matching "\r\n" so the string is returned unchanged in
+    # the common case.
+    CRLF_REGEX = Regexp.new("(?<!\r)\n|\r(?!\n)")
+  else
+    CRLF_REGEX = /\n|\r\n|\r/
+  end
+
   def to_crlf
-    to_str.gsub(/\n|\r\n|\r/) { "\r\n" }
+    to_str.gsub(CRLF_REGEX, "\r\n")
   end
 
   def to_lf
-    to_str.gsub(/\n|\r\n|\r/) { "\n" }
+    to_str.gsub(/\r\n|\r/, "\n")
   end
 
   unless String.instance_methods(false).map {|m| m.to_sym}.include?(:blank?)

data/lib/mail/elements/address.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 module Mail
   class Address
-    
+
     include Mail::Utilities
     
     # Mail::Address handles all email addresses in Mail.  It takes an email address string
@@ -22,21 +22,19 @@ module Mail
     #  a.to_s         #=> 'Mikel Lindsaar <mikel@test.lindsaar.net> (My email address)'
     def initialize(value = nil)
       @output_type = :decode
-      @tree = nil
-      @raw_text = value
-      case
-      when value.nil?
+      if value.nil?
         @parsed = false
+        @data = nil
         return
       else
         parse(value)
       end
     end
     
-    # Returns the raw imput of the passed in string, this is before it is passed
+    # Returns the raw input of the passed in string, this is before it is passed
     # by the parser.
     def raw
-      @raw_text
+      @data.raw
     end
 
     # Returns a correctly formatted address for the email going out.  If given
@@ -48,15 +46,14 @@ module Mail
     #  a.format #=> 'Mikel Lindsaar <mikel@test.lindsaar.net> (My email address)'
     def format
       parse unless @parsed
-      case
-      when tree.nil?
+      if @data.nil?
         ''
-      when display_name
+      elsif display_name
         [quote_phrase(display_name), "<#{address}>", format_comments].compact.join(" ")
-      when address
+      elsif address
         [address, format_comments].compact.join(" ")
       else
-        tree.text_value
+        raw
       end
     end
 
@@ -106,7 +103,7 @@ module Mail
     #  a.local #=> 'mikel'
     def local
       parse unless @parsed
-      "#{obs_domain_list}#{get_local.strip}" if get_local
+      "#{@data.obs_domain_list}#{get_local.strip}" if get_local
     end
 
     # Returns the domain part (the right hand side of the @ sign in the email address) of
@@ -174,29 +171,24 @@ module Mail
     
     def parse(value = nil)
       @parsed = true
-      case
-      when value.nil?
+
+      case value
+      when NilClass
+        @data = nil
         nil
-      when value.class == String
-        self.tree = Mail::AddressList.new(value).address_nodes.first
-      else
-        self.tree = value
+      when Mail::Parsers::AddressStruct
+        @data = value
+      when String
+        @raw_text = value
+        if value.blank?
+          @data = nil
+        else
+          address_list = Mail::Parsers::AddressListsParser.new.parse(value)
+          @data = address_list.addresses.first
+        end
       end
     end
     
-    
-    def get_domain
-      if tree.respond_to?(:angle_addr) && tree.angle_addr.respond_to?(:addr_spec) && tree.angle_addr.addr_spec.respond_to?(:domain)
-        @domain_text ||= tree.angle_addr.addr_spec.domain.text_value.strip
-      elsif tree.respond_to?(:domain)
-        @domain_text ||= tree.domain.text_value.strip
-      elsif tree.respond_to?(:addr_spec) && tree.addr_spec.respond_to?(:domain)
-        tree.addr_spec.domain.text_value.strip
-      else
-        nil
-      end
-    end
-
     def strip_all_comments(string)
       unless comments.blank?
         comments.each do |comment|
@@ -209,7 +201,7 @@ module Mail
     def strip_domain_comments(value)
       unless comments.blank?
         comments.each do |comment|
-          if get_domain && get_domain.include?("(#{comment})")
+          if @data.domain && @data.domain.include?("(#{comment})")
             value = value.gsub("(#{comment})", '')
           end
         end
@@ -217,20 +209,11 @@ module Mail
       value.to_s.strip
     end
     
-    def get_comments
-      if tree.respond_to?(:comments)
-        @comments = tree.comments.map { |c| unparen(c.text_value.to_str) } 
-      else
-        @comments = []
-      end
-    end
-    
     def get_display_name
-      if tree.respond_to?(:display_name)
-        name = unquote(tree.display_name.text_value.strip)
-        str = strip_all_comments(name.to_s)
-      elsif comments
-        if domain
+      if @data.display_name
+        str = strip_all_comments(@data.display_name.to_s)
+      elsif @data.comments
+        if @data.domain
           str = strip_domain_comments(format_comments)
         else
           str = nil
@@ -263,15 +246,6 @@ module Mail
       end
     end
     
-    # Provides access to the Treetop parse tree for this address
-    def tree
-      @tree
-    end
-    
-    def tree=(value)
-      @tree = value
-    end
-    
     def format_comments
       if comments
         comment_text = comments.map {|c| escape_paren(c) }.join(' ').squeeze(" ")
@@ -280,35 +254,17 @@ module Mail
         nil
       end
     end
-   
-    def obs_domain_list
-      if tree.respond_to?(:angle_addr)
-        obs = tree.angle_addr.elements.select { |e| e.respond_to?(:obs_domain_list) }
-        !obs.empty? ? obs.first.text_value : nil
-      else
-        nil
-      end
-    end
-    
+
     def get_local
-      case
-      when tree.respond_to?(:local_dot_atom_text)
-        tree.local_dot_atom_text.text_value
-      when tree.respond_to?(:angle_addr) && tree.angle_addr.respond_to?(:addr_spec) && tree.angle_addr.addr_spec.respond_to?(:local_part)
-        tree.angle_addr.addr_spec.local_part.text_value
-      when tree.respond_to?(:addr_spec) && tree.addr_spec.respond_to?(:local_part)
-        tree.addr_spec.local_part.text_value
-      when tree.respond_to?(:angle_addr) && tree.angle_addr.respond_to?(:addr_spec) && tree.angle_addr.addr_spec.respond_to?(:local_dot_atom_text)
-        # Ignore local dot atom text when in angle brackets
-        nil
-      when tree.respond_to?(:addr_spec) && tree.addr_spec.respond_to?(:local_dot_atom_text)
-        # Ignore local dot atom text when in angle brackets
-        nil
-      else
-        tree && tree.respond_to?(:local_part) ? tree.local_part.text_value : nil
-      end
+      @data && @data.local
+    end
+
+    def get_domain
+      @data && @data.domain
     end
     
- 
+    def get_comments
+      @data && @data.comments
+    end
   end
 end

data/lib/mail/elements/address_list.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 module Mail
   class AddressList # :nodoc:
-    
+
     # Mail::AddressList is the class that parses To, From and other address fields from
     # emails passed into Mail.
     # 
@@ -18,57 +18,34 @@ module Mail
     #  a.addresses    #=> [#<Mail::Address:14943130 Address: |ada@test.lindsaar.net...
     #  a.group_names  #=> ["My Group"]
     def initialize(string)
-      if string.blank?
-        @address_nodes = []
-        return self
-      end
-      parser = Mail::AddressListsParser.new
-      if tree = parser.parse(string)
-        @address_nodes = tree.addresses
-      else
-        raise Mail::Field::ParseError.new(AddressListsParser, string, parser.failure_reason)
-      end
+      @addresses_grouped_by_group = nil
+      @address_list = Parsers::AddressListsParser.new.parse(string)
     end
     
     # Returns a list of address objects from the parsed line
     def addresses
-      @addresses ||= get_addresses.map do |address_tree|
-        Mail::Address.new(address_tree)
+      @addresses ||= @address_list.addresses.map do |address_data|
+        Mail::Address.new(address_data)
       end
     end
-    
-    # Returns a list of all recipient syntax trees that are not part of a group
-    def individual_recipients # :nodoc:
-      @individual_recipients ||= @address_nodes - group_recipients
-    end
-    
-    # Returns a list of all recipient syntax trees that are part of a group
-    def group_recipients # :nodoc:
-      @group_recipients ||= @address_nodes.select { |an| an.respond_to?(:group_name) }
+
+    def addresses_grouped_by_group
+      return @addresses_grouped_by_group if @addresses_grouped_by_group
+
+      @addresses_grouped_by_group = {}
+
+      @address_list.addresses.each do |address_data|
+        if group = address_data.group
+          @addresses_grouped_by_group[group] ||= []
+          @addresses_grouped_by_group[group] << Mail::Address.new(address_data)
+        end
+      end
+      @addresses_grouped_by_group
     end
     
     # Returns the names as an array of strings of all groups
     def group_names # :nodoc:
-      group_recipients.map { |g| g.group_name.text_value }
-    end
-    
-    # Returns a list of address syntax trees
-    def address_nodes # :nodoc:
-      @address_nodes
-    end
-    
-    private
-    
-    def get_addresses
-      (individual_recipients + group_recipients.map { |g| get_group_addresses(g) }).flatten
-    end
-    
-    def get_group_addresses(g)
-      if g.group_list.respond_to?(:addresses)
-        g.group_list.addresses
-      else
-        []
-      end
+      @address_list.group_names
     end
   end
 end

data/lib/mail/elements/content_disposition_element.rb

@@ -5,13 +5,9 @@ module Mail
     include Mail::Utilities
     
     def initialize( string )
-      parser = Mail::ContentDispositionParser.new
-      if tree = parser.parse(cleaned(string))
-        @disposition_type = tree.disposition_type.text_value.downcase
-        @parameters = tree.parameters
-      else
-        raise Mail::Field::ParseError.new(ContentDispositionElement, string, parser.failure_reason)
-      end
+      content_disposition = Mail::Parsers::ContentDispositionParser.new.parse(cleaned(string))
+      @disposition_type = content_disposition.disposition_type
+      @parameters = content_disposition.parameters
     end
     
     def disposition_type

data/lib/mail/elements/content_location_element.rb

@@ -5,12 +5,8 @@ module Mail
     include Mail::Utilities
     
     def initialize( string )
-      parser = Mail::ContentLocationParser.new
-      if tree = parser.parse(string)
-        @location = tree.location.text_value
-      else
-        raise Mail::Field::ParseError.new(ContentLocationElement, string, parser.failure_reason)
-      end
+      content_location = Mail::Parsers::ContentLocationParser.new.parse(string)
+      @location = content_location.location
     end
     
     def location

data/lib/mail/elements/content_transfer_encoding_element.rb

@@ -4,16 +4,9 @@ module Mail
     
     include Mail::Utilities
     
-    def initialize( string )
-      parser = Mail::ContentTransferEncodingParser.new
-      case
-      when string.blank?
-        @encoding = ''
-      when tree = parser.parse(string.to_s.downcase)
-        @encoding = tree.encoding.text_value
-      else
-        raise Mail::Field::ParseError.new(ContentTransferEncodingElement, string, parser.failure_reason)
-      end
+    def initialize(string)
+      content_transfer_encoding = Mail::Parsers::ContentTransferEncodingParser.new.parse(string)
+      @encoding = content_transfer_encoding.encoding
     end
     
     def encoding

data/lib/mail/elements/content_type_element.rb

@@ -5,14 +5,10 @@ module Mail
     include Mail::Utilities
     
     def initialize( string )
-      parser = Mail::ContentTypeParser.new
-      if tree = parser.parse(cleaned(string))
-        @main_type = tree.main_type.text_value.downcase
-        @sub_type = tree.sub_type.text_value.downcase
-        @parameters = tree.parameters
-      else
-        raise Mail::Field::ParseError.new(ContentTypeElement, string, parser.failure_reason)
-      end
+      content_type = Mail::Parsers::ContentTypeParser.new.parse(cleaned(string))
+      @main_type = content_type.main_type
+      @sub_type = content_type.sub_type
+      @parameters = content_type.parameters
     end
     
     def main_type

data/lib/mail/elements/date_time_element.rb

@@ -5,13 +5,9 @@ module Mail
     include Mail::Utilities
     
     def initialize( string )
-      parser = Mail::DateTimeParser.new
-      if tree = parser.parse(string)
-        @date_string = tree.date.text_value
-        @time_string = tree.time.text_value
-      else
-        raise Mail::Field::ParseError.new(DateTimeElement, string, parser.failure_reason)
-      end
+      date_time = Mail::Parsers::DateTimeParser.new.parse(string)
+      @date_string = date_time.date_string
+      @time_string = date_time.time_string
     end
     
     def date_string