maildir 0.4.0 → 0.5.0

data/README.rdoc

@@ -6,7 +6,9 @@ A ruby library for reading and writing messages in the maildir format.
 
 See http://cr.yp.to/proto/maildir.html and http://en.wikipedia.org/wiki/Maildir
 
-As Daniel J. Berstein puts it: "Two words: no locks." The maildir format allows multiple processes to read and write arbitrary messages without file locks.
+"Two words: no locks." -- Daniel J. Berstein
+
+The maildir format allows multiple processes to read and write arbitrary messages without file locks.
 
 New messages are initially written to a "tmp" directory with an automatically-generated unique filename. After the message is written, it's moved to the "new" directory where other processes may read it.
 
@@ -104,9 +106,9 @@ It's trivial to create a custom serializer. Implement the following two methods:
   load(path)
   dump(data, path)
 
-== Credits
+== Contributors
 
-niklas | brueckenschlaeger, http://github.com/nilclass added subdir & courierimapkeywords support
+Niklas E. Cathor (http://github.com/nilclass) added subdir & courierimapkeywords support
 
 == Copyright
 

data/Rakefile

@@ -15,7 +15,7 @@ begin
     gemspec.description = "A ruby library for reading and writing arbitrary messages in DJB's maildir format"
     gemspec.email = "aaron@ktheory.com"
     gemspec.homepage = "http://github.com/ktheory/maildir"
-    gemspec.authors = ["Aaron Suggs"]
+    gemspec.authors = ["Aaron Suggs", "Niklas E. Cathor"]
     gemspec.add_development_dependency "shoulda", ">= 0"
     gemspec.add_development_dependency "mail", ">= 0"
     gemspec.add_development_dependency "json", ">= 0"
@@ -29,4 +29,4 @@ end
 desc "Run benchmarks"
 task :bench do
   load File.join(File.dirname(__FILE__), "benchmarks", "runner")
-end
+end

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/lib/maildir.rb

@@ -2,7 +2,6 @@ require 'fileutils' # For create_directories
 class Maildir
 
   SUBDIRS = [:tmp, :new, :cur].freeze
-  READABLE_DIRS = SUBDIRS.reject{|s| :tmp == s}.freeze
 
   include Comparable
 

data/lib/maildir/keywords.rb

@@ -1,22 +1,27 @@
 # implements IMAP Keywords as used by the Courier Mail Server
 # see http://www.courier-mta.org/imap/README.imapkeywords.html for details
 
-require 'ftools'
 require 'maildir'
 module Maildir::Keywords
   def self.included(base)
     Maildir::Message.send(:include, MessageExtension)
   end
 
+  def keyword_dir
+    @keyword_dir ||= File.join(path, 'courierimapkeywords')
+    Dir.mkdir(@keyword_dir) unless File.directory?(@keyword_dir)
+    return @keyword_dir
+  end
+
   # process contents of courierimapkeywords/ directory as described in README.imapkeywords
   def read_keywords
     messages = (list(:cur) + list(:new)).inject({}) { |m, msg| m[msg.unique_name] = msg ; m }
     t = Time.now.to_i / 300
-    keyword_dir = File.join(path, 'courierimapkeywords')
     keywords = []
     state = :head
     # process :list
-    File.open(File.join(keyword_dir, ':list')).each_line do |line|
+    list_file = File.join(keyword_dir, ':list')
+    File.open(list_file).each_line do |line|
       line.strip!
       if state == :head
         if line.empty?
@@ -30,7 +35,7 @@ module Maildir::Keywords
           msg.set_keywords(ids.split(/\s/).map {|id| keywords[id.to_i - 1] })
         end
       end
-    end
+    end if File.exist?(list_file)
     # collect keyword files
     keyword_files = (Dir.entries(keyword_dir) - %w(. .. :list)).inject({}) do |keyword_files, file|
       if file =~ /^\.(\d+)\.(.*)$/
@@ -39,7 +44,7 @@ module Maildir::Keywords
       else
         n = t + 1
         key = file
-        File.move(File.join(keyword_dir, file), File.join(keyword_dir, ".#{n}.#{key}"))
+        FileUtils.mv(File.join(keyword_dir, file), File.join(keyword_dir, ".#{n}.#{key}"))
       end
       if msg = messages[key]
         (keyword_files[key] ||= []) << [n, key]
@@ -49,13 +54,15 @@ module Maildir::Keywords
           File.unlink(fname)
         end
       end
+      next(keyword_files)
     end
     # process keyword files
     keyword_files.each_pair do |key, files|
       files.sort! { |a, b| a[0] <=> b[0] }
-      files[0..-2].each { |f| File.unlink(File.join(keyword_dir, ".#{f.join('.')}")) } if n_files.last[0] < t
+      files[0..-2].each { |f| File.unlink(File.join(keyword_dir, ".#{f.join('.')}")) } if files.last[0] < t
       msg = messages[key]
-      current_keywords = File.read(files.last).read.split(/\s+/)
+      file = (File.exist?(File.join(keyword_dir, files.last[1])) ? files.last[1] : ".#{files.last.join('.')}")
+      current_keywords = File.read(File.join(keyword_dir, file)).split(/\s+/)
       msg.set_keywords(current_keywords)
       if (add = (current_keywords - keywords)).any?
         keywords += add
@@ -72,7 +79,7 @@ module Maildir::Keywords
         @keywords[key] = msg.keywords
       end
     }
-    File.move(tmp_file, File.join(keyword_dir, ':list'))
+    FileUtils.mv(tmp_file, list_file)
   end
 
   def keywords(key)
@@ -88,9 +95,9 @@ module Maildir::Keywords
 
     # sets given keywords on the message.
     def keywords=(list)
-      tmp_fname = File.join(maildir.path, 'tmp', unique_name)
+      tmp_fname = File.join(@maildir.path, 'tmp', unique_name)
       File.open(tmp_fname, 'w') { |f| f.write(list.join("\n")) }
-      File.move(tmp_fname, File.join(maildir.path, 'courierimapkeywords', unique_name))
+      FileUtils.mv(tmp_fname, File.join(@maildir.keyword_dir, unique_name))
     end
 
     # sets @keywords to the given list

data/lib/maildir/subdirs.rb

@@ -11,6 +11,10 @@ module Maildir::Subdirs
     end
   end
 
+  def name
+    root? ? ROOT_NAME : subdir_parts(path).last
+  end
+
   def create_subdir(name)
     raise ArgumentError.new("'name' may not contain delimiter character (#{DELIM})") if name.include?(DELIM)
     full_name = (root? ? [] : subdir_parts(File.basename(path))).push(name).unshift('').join(DELIM)
@@ -54,6 +58,7 @@ module Maildir::Subdirs
   private
 
   def subdir_parts(path)
+    path.sub!(/\/$/, '') # remove trailing slash
     parts = (path.split(DELIM) - [''])
     # some clients (e.g. Thunderbird) mess up namespaces so subdirs
     # end up looking like '.INBOX.Trash' instead of '.Trash'

data/maildir.gemspec

@@ -5,10 +5,10 @@
 
 Gem::Specification.new do |s|
   s.name = %q{maildir}
-  s.version = "0.4.0"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Aaron Suggs"]
+  s.authors = ["Aaron Suggs", "Niklas E. Cathor"]
   s.date = %q{2010-01-24}
   s.description = %q{A ruby library for reading and writing arbitrary messages in DJB's maildir format}
   s.email = %q{aaron@ktheory.com}
@@ -35,9 +35,11 @@ Gem::Specification.new do |s|
      "lib/maildir/unique_name.rb",
      "maildir.gemspec",
      "test/test_helper.rb",
+     "test/test_keywords.rb",
      "test/test_maildir.rb",
      "test/test_message.rb",
      "test/test_serializers.rb",
+     "test/test_subdirs.rb",
      "test/test_unique_name.rb"
   ]
   s.homepage = %q{http://github.com/ktheory/maildir}
@@ -47,9 +49,11 @@ Gem::Specification.new do |s|
   s.summary = %q{Read & write messages in the maildir format}
   s.test_files = [
     "test/test_helper.rb",
+     "test/test_keywords.rb",
      "test/test_maildir.rb",
      "test/test_message.rb",
      "test/test_serializers.rb",
+     "test/test_subdirs.rb",
      "test/test_unique_name.rb"
   ]
 

data/test/test_helper.rb

@@ -1,7 +1,5 @@
-require 'rubygems'
 require 'test/unit'
 require 'shoulda'
-require 'fileutils'
 require 'maildir'
 
 # Require all the serializers
@@ -20,7 +18,19 @@ def temp_maildir
   Maildir.new("/tmp/maildir_test")
 end
 
-# Useful for testing that strings defined & not empty
+# create the subdir tree:
+# | INBOX
+# |-- a
+# | |-- x
+# | |-- y
+# |-- b
+def setup_subdirs(maildir)
+  %w(a b a.x a.y).each do |x|
+    Maildir.new(File.join(maildir.path, ".#{x}"))
+  end
+end
+
+# Test that objects are neither nil nor empty
 def assert_not_empty(obj, msg='')
   assert !obj.nil? && !obj.empty?, msg
 end

data/test/test_keywords.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+require 'maildir/keywords'
+class TestKeywords < Test::Unit::TestCase
+  context "A message" do
+    setup do
+      @data = "foo\n"
+      @msg = Maildir::Message.create(temp_maildir, @data)
+    end
+
+    should "remember keywords" do
+      kw = %w(Junk Seen)
+      @msg.keywords = kw
+      assert (@msg.keywords & kw).size == 2
+    end
+  end
+end

data/test/test_maildir.rb

@@ -70,4 +70,4 @@ class TestMaildir < Test::Unit::TestCase
       assert_equal stale_tmp, temp_maildir.get_stale_tmp
     end
   end
-end
+end

data/test/test_serializers.rb

@@ -16,7 +16,7 @@ class TestSerializers < Test::Unit::TestCase
         when Maildir::Serializer::Mail
           Mail.new
         else
-          # Test a few common data structures
+          # Test a few common types
           [1, nil, {"foo" => true}]
         end
 

data/test/test_subdirs.rb

@@ -0,0 +1,46 @@
+require 'test_helper'
+require 'maildir/subdirs'
+class TestSubdirs < Test::Unit::TestCase
+  context "A maildir" do
+    setup do
+      FakeFS::FileSystem.clear
+      @maildir = temp_maildir
+      setup_subdirs(@maildir)
+    end
+
+    should "have subdirs" do
+      assert @maildir.subdirs.any?
+    end
+
+    should "be called INBOX" do
+      assert @maildir.name == 'INBOX'
+    end
+
+    should "include direct subdirs" do
+      subdir_names = @maildir.subdirs.map(&:name)
+      assert subdir_names.include?('a') && subdir_names.include?('b')
+    end
+
+    should "not include deeper subdirs" do
+      subdir_names = @maildir.subdirs.map(&:name)
+      assert ! subdir_names.include?('x') && ! subdir_names.include?('a.x')
+    end
+
+    should "create more subdirs" do
+      @maildir.create_subdir("test")
+      assert @maildir.subdirs.map(&:name).include?("test")
+    end
+  end
+
+  context "A subdir" do
+    setup do
+      FakeFS::FileSystem.clear
+      @maildir = temp_maildir
+      setup_subdirs(@maildir)
+    end
+
+    should "include more subdirs" do
+      assert_not_empty @maildir.subdirs.select{ |sd| sd.name == 'a'}.first.subdirs
+    end
+  end
+end

metadata

@@ -1,10 +1,11 @@
 --- !ruby/object:Gem::Specification 
 name: maildir
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Aaron Suggs
+- Niklas E. Cathor
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -80,9 +81,11 @@ files:
 - lib/maildir/unique_name.rb
 - maildir.gemspec
 - test/test_helper.rb
+- test/test_keywords.rb
 - test/test_maildir.rb
 - test/test_message.rb
 - test/test_serializers.rb
+- test/test_subdirs.rb
 - test/test_unique_name.rb
 has_rdoc: true
 homepage: http://github.com/ktheory/maildir
@@ -114,7 +117,9 @@ specification_version: 3
 summary: Read & write messages in the maildir format
 test_files: 
 - test/test_helper.rb
+- test/test_keywords.rb
 - test/test_maildir.rb
 - test/test_message.rb
 - test/test_serializers.rb
+- test/test_subdirs.rb
 - test/test_unique_name.rb