rmail 0.17 → 1.0.0

data/NEWS

@@ -1,3 +1,13 @@
+= Changes in RubyMail 1.0.0 (released 2008-01-05)
+
+- This version differs *only* in the changes required for Ruby 1.9
+  support.  It is otherwise "bug compatible" with version 0.17.  Users
+  of version 0.17 can safely upgrade to 1.0.0.  You will lose the
+  ability to run the tests if you are using Ruby 1.6 (but who is doing
+  that these days?).
+
+- Add a Rakefile.  Add a gem hosted on rubyforge.org.
+
 = Changes in RubyMail 0.17 (released 2004-04-27)
 
 - Handle parsing addresses with non-ASCII display names.  We don't do

data/Rakefile

@@ -0,0 +1,186 @@
+# -*- ruby -*-
+
+#
+# This is a Ruby file, used by the "rake" make-like program.
+#
+
+begin
+  # First, we use a few ruby things...
+  require 'rubygems'
+  require 'rake/gempackagetask'
+end
+require 'rake/rdoctask'
+require 'rake/testtask'
+require 'shellwords'
+
+#
+# The default task is run if rake is given no explicit arguments.
+#
+desc "Default Task"
+task :default => :test
+
+#
+# Test tasks
+#
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/test*.rb'
+  t.verbose = true
+end
+
+
+def unreleasable_reason
+  can_release_package
+  unreleasable_reason
+end
+
+def can_release_package
+  reasons = []
+
+  unless news_is_current
+    reasons << 'the NEWS file is not current'
+  end
+
+  unless defined?(Gem)
+    reasons << 'RubyGems is not installed'
+  end
+
+  reason = if reasons.empty?
+             ""
+           else
+             last = reasons.pop
+             ("Can not release package because " +
+              (reasons.empty? ? "#{last}." :
+               (reasons.join(", ") + " and #{last}.")))
+           end
+  can_release = reason.length == 0
+
+  self.class.module_eval <<-END_OF_CODE
+  def unreleasable_reason
+    \"#{reason}\"
+  end
+  def can_release_package
+    #{can_release.inspect}
+  end
+  END_OF_CODE
+
+  can_release_package
+end
+
+# Is the NEWS file current?
+def news_is_current
+  today = Time.now.strftime('%Y-%m-%d')
+  version = Regexp.new(Regexp.quote(PKG_VERSION))
+  if IO.readlines('NEWS').first =~
+      /= Changes in RubyMail #{PKG_VERSION} \(released #{today}\)$/
+    true
+  else
+    false
+  end
+end
+
+
+#
+# These PKG_ variables are used by Rake's package rule.
+#
+PKG_VERSION = begin
+                version= IO.readlines('version').first.chomp
+                if version =~ /^\d+\.\d+\.\d+$/
+                  version.untaint
+                else
+                  fail "package version is bogus"
+                end
+                version
+              end
+
+PKG_FILES = FileList.new('test/**/*',
+                         'guide/**/*',
+                         'lib/**/*',
+                         'install.rb',
+                         'NEWS',
+                         'NOTES',
+                         'README',
+                         'THANKS',
+                         'TODO',
+                         'Rakefile',
+                         'version')
+
+#
+# Teach Rake how to build the RDoc documentation for this package.
+#
+rdoc = Rake::RDocTask.new do |rdoc|
+  rdoc.main = 'README'
+  rdoc.rdoc_files.include("README", "NEWS", "THANKS",
+                          "TODO", "guide/*.txt", "lib/**/*.rb")
+  rdoc.rdoc_files.exclude(/\bSCCS\b/,
+                          "lib/rubymail/parser/*")
+  unreleased = if can_release_package
+                 ""
+               else
+                 " (UNRELEASED!)"
+               end
+  rdoc.title = "RubyMail Documentation (version #{PKG_VERSION})"
+  rdoc.options << '--exclude' << 'SCCS'
+end
+
+# Make sure that we don't package anything that hasn't been tagged.
+task :package => [ :can_release ]
+
+desc "Check if the package is in a releasable state."
+task :can_release do
+  unless can_release_package
+    puts unreleasable_reason
+  end
+end
+
+#
+# Create a Gem::Specification right in the Rakefile, using some of the
+# variables we have set up above.
+#
+if defined?(Gem)
+  spec = Gem::Specification.new do |s|
+    s.name = 'rmail'
+    s.version = PKG_VERSION + if can_release_package
+                                ''
+                              else
+                                '.666'
+                              end
+    s.summary = 'A MIME mail parsing and generation library.'
+    s.description = <<-EOF
+    RMail is a lightweight mail library containing various utility classes and
+    modules that allow ruby scripts to parse, modify, and generate MIME mail
+    messages.
+    EOF
+
+    s.files = PKG_FILES.to_a
+
+    s.required_ruby_version = Gem::Version::Requirement.new(">= 1.8.1")
+
+    s.has_rdoc = true
+    s.extra_rdoc_files = rdoc.rdoc_files.reject { |fn| fn =~ /\.rb$/ }.to_a
+    s.rdoc_options.concat([ '--title', rdoc.title, '--main', rdoc.main,
+                            rdoc.options ].flatten)
+
+    s.test_files = FileList['test/tc_*.rb'].to_a
+
+    s.author = "Matt Armstrong"
+    s.email = "matt@rfc20.org"
+    s.homepage = "http://www.rfc20.org/rubymail"
+
+    s.rubyforge_project = "rubymail"
+  end
+
+  #
+  # Use our Gem::Specification to make some package tasks.
+  #
+  Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.need_zip = true
+    pkg.need_tar = true
+  end
+end
+
+desc "Install RubyMail using the standard install.rb script"
+task :install do
+  ruby "install.rb"
+end
+

data/TODO

@@ -6,6 +6,9 @@ is missing.
 - StreamHandler should get preamble_begin and preamble_end callbacks.
   Same for epilogue_begin, epilogue_end.
 
+- Add a Rakefile rule to run the tests in the super anal way (against
+  multiple versions of Ruby).
+
 = STOLEN
 
 - Header continuation issue:

data/lib/rmail/header.rb

@@ -263,7 +263,7 @@ module RMail
 
     # Deletes the field at the specified index and returns its value.
     def delete_at(index)
-      @fields[index, 1] = nil
+      @fields.delete_at(index)
       self
     end
 
@@ -282,7 +282,7 @@ module RMail
     # Returns self.
     def each                    # yields: name, value
       @fields.each { |i|
-        yield(i.name, i.value)
+        yield [i.name, i.value]
       }
     end
     alias each_pair each
@@ -832,15 +832,9 @@ module RMail
     # of this message.  This uses the contents of the To, Cc, and Bcc
     # fields.  Duplicate addresses are eliminated.
     def recipients
-      retval = RMail::Address::List.new
-      retval.concat(to)
-      retval.concat(cc)
-      retval.concat(bcc)
-      retval.uniq
+      RMail::Address::List.new([ to, cc, bcc ].flatten.uniq)
     end
 
-#    recipients
-
     # Retrieve a given field's value as an RMail::Address::List of
     # RMail::Address objects.
     #

data/{tests → test}/runtests.rb

@@ -30,6 +30,6 @@ path = File.expand_path(File.join(File.dirname($0), '..', 'lib'))
 puts "Prepending #{path} to the $LOAD_PATH"
 $LOAD_PATH.unshift(path)        # get our stuff first
 
-Dir['tests/test*.rb'].each {|f|
+Dir['test/test*.rb'].each {|f|
   require f
 }

data/{tests → test}/testaddress.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 #--
-#   Copyright (C) 2001, 2002, 2003 Matt Armstrong.  All rights reserved.
+#   Copyright (C) 2001, 2002, 2003, 2007 Matt Armstrong.  All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -25,7 +25,7 @@
 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #
 
-require 'tests/testbase'
+require 'test/testbase'
 require 'rmail/address'
 
 class TestRMailAddress < TestBase
@@ -44,7 +44,7 @@ class TestRMailAddress < TestBase
   def validate_method(object, method, *args)
     assert(method_list.include?(method),
 	   "#{method.inspect} not in #{method_list.inspect}")
-    assert_respond_to(method, object)
+    assert_respond_to(object, method)
     ret = nil
     ret = object.send(method, *args)
     if block_given?
@@ -1079,7 +1079,7 @@ class TestRMailAddress < TestBase
 	  end
 	}.to_s ]
       strings.each {|string|
-	assert_no_exception("failed for string #{string.inspect}") {
+	assert_nothing_raised("failed for string #{string.inspect}") {
 	  addrs = RMail::Address.parse(string)
 	  addrs.each {|address|
 	    method_list.each {|method|
@@ -1117,13 +1117,13 @@ class TestRMailAddress < TestBase
     assert_equal(nil, addr.domain)
     assert_equal(nil, addr.local)
 
-    e = assert_exception(ArgumentError) {
+    e = assert_raise(ArgumentError) {
       RMail::Address.new(["bob"])
     }
-    e = assert_exception(ArgumentError) {
+    e = assert_raise(ArgumentError) {
       RMail::Address.new(Object.new)
     }
-    e = assert_exception(ArgumentError) {
+    e = assert_raise(ArgumentError) {
       RMail::Address.new(Hash.new)
     }
   end
@@ -1176,13 +1176,13 @@ class TestRMailAddress < TestBase
     assert(a1.eql?(a2))
 
     a1 = RMail::Address.new("Zeus <bob@example.com>")
-    assert_exception(TypeError) {
+    assert_raise(TypeError) {
       a1.eql?("bob@eaxample.com")
     }
   end
 
   def test_rmail_address_hash
-    assert_no_exception {
+    assert_nothing_raised {
       RMail::Address.new.hash
     }
     a1 = RMail::Address.new("Zeus <bob@example.com>")

data/{tests → test}/testbase.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 #--
-#   Copyright (C) 2001, 2002, 2003 Matt Armstrong.  All rights reserved.
+#   Copyright (C) 2001, 2002, 2003, 2007 Matt Armstrong.  All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -27,28 +27,25 @@
 
 # Base for all the test cases, providing a default setup and teardown
 
-require 'rubyunit'
+require 'test/unit'
 require 'rbconfig.rb'
 require 'tempfile'
 require 'find'
-require 'ftools'
+require 'fileutils'
 
 begin
   require 'pp'
 rescue LoadError
 end
 
-class TestBase < RUNIT::TestCase
+class TestBase < Test::Unit::TestCase
   include Config
 
   attr_reader :scratch_dir
 
-  # NoMethodError was introduced in ruby 1.7
-  NO_METHOD_ERROR = if RUBY_VERSION >= "1.7"
-		      NoMethodError
-		    else
-		      NameError
-		    end
+  def test_nothing
+    assert(true)  # Appease Test::Unit
+  end
 
   # Print a string to a temporary file and return the file opened.
   # This lets you have some test data in a string, but access it with
@@ -107,7 +104,7 @@ class TestBase < RUNIT::TestCase
 
   def setup
     @scratch_dir = File.join(Dir.getwd, "_scratch_" + name)
-    @data_dir = File.join(Dir.getwd, "tests", "data")
+    @data_dir = File.join(Dir.getwd, "test", "data")
     @scratch_hash = {}
 
     cleandir(@scratch_dir)
@@ -131,7 +128,7 @@ class TestBase < RUNIT::TestCase
       yield f
     }
   rescue Errno::ENOENT
-    assert_fail("data file #{name.inspect} does not exist")
+    flunk("data file #{name.inspect} does not exist")
   end
 
   def data_as_string(name)