maildir 1.0.0 → 1.0.1

data/README.rdoc

@@ -16,12 +16,13 @@ While the maildir format was created for email, it works well for arbitrary data
 
 == Install
 
- sudo gem install maildir
+ gem install maildir
 
 == Usage
 
 Create a maildir in /home/aaron/mail
 
+  require 'maildir'
   maildir = Maildir.new("/home/aaron/mail") # creates tmp, new, and cur dirs
   # call Maildir.new("/home/aaron/mail", false) to skip directory creation.
 
@@ -67,6 +68,19 @@ Delete the message from disk
   message.destroy # => returns the frozen message
   maildir.list(:cur) # => []
 
+=== Cleaning up from orphaned messages
+
+An expected (though rare) behavior is for partially-written messages to be
+orphaned in the tmp folder (when clients fail before fully writing a message).
+
+Find messages in tmp that haven't been changed in 36 hours:
+
+  maildir.get_stale_tmp
+
+Clean them up:
+
+  maildir.get_stale_tmp.each{|msg| msg.destroy}
+
 == Pluggable serializers
 
 By default, message data are written and read from disk as a string. It's often desirable to process the string into a useful object. Maildir supports configurable serializers to convert message data into a useful object.
@@ -85,7 +99,7 @@ Maildir::Serializer::Base simply reads and writes strings to disk.
   message = maildir.add("Hello World!") # writes "Hello World!" to disk
   message.data # => "Hello World!"
 
-As of version 0.7, the Maildir::Serializer::Base can write IO streams as well as strings. For example:
+As of version 1.0.0, the Maildir::Serializer::Base can write IO streams as well as strings. For example:
 
   message.add(STDIN)
 
@@ -115,8 +129,11 @@ It's trivial to create a custom serializer. Implement the following two methods:
 
 == Contributors
 
-Niklas E. Cathor (http://github.com/nilclass) added subdir & courierimapkeywords support
-Ali Polatel (http://github.com/alip) for suggesting IO.copy_stream
+* Aaron Suggs (github[http://github.com/ktheory]) Primary author
+* Niklas E. Cathor (github[http://github.com/nilclass]) added subdir & courierimapkeywords support
+* Ali Polatel (github[http://github.com/alip]) for suggesting IO.copy_stream
+* Harry Vangberg (github[http://github.com/vangberg]) for fixing tests in ruby 1.9
+* Alexander Flatter (github[http://github.com/aflatter]) for improving serializers
 
 == Copyright
 

data/lib/maildir.rb

@@ -6,6 +6,7 @@ class Maildir
   include Comparable
 
   attr_reader :path
+  attr_accessor :serializer
 
   # Create a new maildir at +path+. If +create+ is true, will ensure that the
   # required subdirectories exist.

data/lib/maildir/message.rb

@@ -70,9 +70,10 @@ class Maildir::Message
     "#<#{self.class} key=#{key} maildir=#{@maildir.inspect}>"
   end
 
-  # Returns the class' serializer
+  # Determines the serializer by first trying the maildir and then falling
+  # back to the default serializer.
   def serializer
-    @@serializer
+    @maildir.serializer || @@serializer
   end
 
   # Writes data to disk. Can only be called on messages instantiated without

data/lib/maildir/version.rb

@@ -1,3 +1,3 @@
 class Maildir
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/test/test_helper.rb

@@ -3,14 +3,11 @@ require 'shoulda'
 require 'maildir'
 
 # Require all the serializers
-serializers = File.join(File.dirname(__FILE__), "..","lib","maildir","serializer","*")
+serializers = File.expand_path('../../lib/maildir/serializer/*.rb', __FILE__)
 Dir.glob(serializers).each do |serializer|
   require serializer
 end
 
-# Require 'ktheory-fakefs' until issues 28, 29, and 30 are resolved in
-# defunkt/fakefs. See http://github.com/defunkt/fakefs/issues
-gem "ktheory-fakefs"
 require 'fakefs'
 
 # Create a reusable maildir that's cleaned up when the tests are done

data/test/test_maildir.rb

@@ -17,6 +17,16 @@ class TestMaildir < Test::Unit::TestCase
       end
     end
 
+    should "have no serializer" do
+      assert temp_maildir.serializer.nil?
+    end
+
+    should "set serializer" do
+      maildir = temp_maildir
+      maildir.serializer = :test
+      assert_equal maildir.serializer, :test
+    end
+
     should "expand paths" do
       maildir = Maildir.new("~/test_maildir/")
       expanded_path = File.expand_path("~/test_maildir")

data/test/test_message.rb

@@ -1,6 +1,23 @@
 require 'test_helper'
 class TestMessage < Test::Unit::TestCase
 
+  context "A message" do
+    setup do
+      FakeFS::FileSystem.clear
+      @maildir = temp_maildir
+      @message = Maildir::Message.new(@maildir)
+    end
+
+    should "use default serializer" do
+      assert_equal @message.serializer, Maildir::Message.serializer
+    end
+
+    should "prefer serializer of its maildir" do
+      @maildir.serializer = :foo
+      assert_equal @message.serializer, :foo
+    end
+  end
+
   context "An new, unwritten message" do
     setup do
       FakeFS::FileSystem.clear

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: maildir
 version: !ruby/object:Gem::Version 
-  hash: 23
-  prerelease: false
+  hash: 21
+  prerelease: 
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Aaron Suggs
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-19 00:00:00 -05:00
+date: 2011-05-08 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -76,17 +76,19 @@ dependencies:
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: ktheory-fakefs
+  name: fakefs
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 23
         segments: 
         - 0
-        version: "0"
+        - 3
+        - 2
+        version: 0.3.2
   type: :development
   version_requirements: *id005
 description: A ruby library for reading and writing arbitrary messages in DJB's maildir format
@@ -151,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Read & write messages in the maildir format