nilclass-maildir 0.4.3 → 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

@@ -10,7 +10,7 @@ task :default => :test
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gemspec|
-    gemspec.name = "nilclass-maildir"
+    gemspec.name = "maildir"
     gemspec.summary = "Read & write messages in the maildir format"
     gemspec.description = "A ruby library for reading and writing arbitrary messages in DJB's maildir format"
     gemspec.email = "aaron@ktheory.com"

data/VERSION

@@ -1 +1 @@
-0.4.3
+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
 
@@ -86,6 +85,17 @@ class Maildir
     Maildir::Message.new(self, key)
   end
 
+  # Returns a message object for the given unique name.
+  # This allows retrieving messages where the flags may have changed,
+  # but obviously is slower than getting it by key.
+  def find(unique_name)
+    get_dir_listing(:cur).each do |key|
+      # NOTE: I used split(File::SEPARATOR) and split(':') here first,
+      #       but when benchmarking it turned out this is 2 times faster.
+      return get(key) if key.match(/cur\/(.*):.*$/)[1] == unique_name
+    end
+  end
+
   # Deletes the message for key by calling destroy() on the message.
   def delete(key)
     get(key).destroy
@@ -112,4 +122,4 @@ class Maildir
 end
 require 'maildir/unique_name'
 require 'maildir/serializer/base'
-require 'maildir/message'
+require 'maildir/message'

data/maildir.gemspec

@@ -1,11 +1,11 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{maildir}
-  s.version = "0.4.1"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aaron Suggs", "Niklas E. Cathor"]
@@ -48,13 +48,13 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{Read & write messages in the maildir format}
   s.test_files = [
-    "test/test_serializers.rb",
+    "test/test_helper.rb",
      "test/test_keywords.rb",
-     "test/test_helper.rb",
-     "test/test_subdirs.rb",
+     "test/test_maildir.rb",
      "test/test_message.rb",
-     "test/test_unique_name.rb",
-     "test/test_maildir.rb"
+     "test/test_serializers.rb",
+     "test/test_subdirs.rb",
+     "test/test_unique_name.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -79,3 +79,4 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<ktheory-fakefs>, [">= 0"])
   end
 end
+

data/test/test_helper.rb

@@ -1,7 +1,6 @@
-require 'rubygems'
 require 'test/unit'
+require 'rubygems'
 require 'shoulda'
-require 'fileutils'
 require 'maildir'
 
 # Require all the serializers
@@ -17,7 +16,7 @@ require 'fakefs'
 
 # Create a reusable maildir that's cleaned up when the tests are done
 def temp_maildir
-    Maildir.new("/tmp/maildir_test")
+  Maildir.new("/tmp/maildir_test")
 end
 
 # create the subdir tree:
@@ -32,7 +31,7 @@ def setup_subdirs(maildir)
   end
 end
 
-# Useful for testing that strings defined & not empty
+# 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

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

data/test/test_maildir.rb

@@ -41,14 +41,20 @@ class TestMaildir < Test::Unit::TestCase
     should "list a new message" do
       @message = temp_maildir.add("")
       messages = temp_maildir.list(:new)
-      assert messages.include?(@message)
+      assert_equal messages, [@message]
     end
 
     should "list a cur message" do
       @message = temp_maildir.add("")
       @message.process
       messages = temp_maildir.list(:cur)
-      assert messages.include?(@message)
+      assert_equal messages, [@message]
+    end
+
+    should "find a message by unique name" do
+      @message = temp_maildir.add("")
+      @message.process
+      assert_equal temp_maildir.find(@message.unique_name), @message
     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
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nilclass-maildir
 version: !ruby/object:Gem::Version 
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors: 
 - Aaron Suggs
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-24 00:00:00 +01:00
+date: 2010-01-25 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency