maildir 0.1.0 → 0.2.0

data/.gitignore

@@ -0,0 +1,2 @@
+pkg/*
+benchmarks/scratch.rb

data/Rakefile

@@ -22,3 +22,8 @@ begin
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install jeweler"
 end
+
+desc "Run benchmarks"
+task :bench do
+  load File.join(File.dirname(__FILE__), "benchmarks", "runner")
+end

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/benchmarks/runner

@@ -1,4 +1,30 @@
 #!/usr/bin/env ruby
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'maildir'
+require 'benchmark'
 
-$: << File.join(File.dirname(__FILE__), '..', 'lib')
-require 'maildir'
+maildir_path = ENV['MAILDIR'] || "./tmp"
+maildir = Maildir.new(maildir_path)
+
+n = 300
+message = "Write #{n} messages:"
+tms = Benchmark.bmbm(message.size) do |x|
+   x.report(message) { n.times { maildir.add_message("") } }
+end
+
+puts "#{n/tms.first.real} messages per second"
+
+
+message = "List new:"
+tms = Benchmark.bm(message.size) do |x|
+  x.report(message) { n.times { maildir.list_keys(:new)} }
+end
+
+# require 'ruby-prof'
+# result = RubyProf.profile do
+#   n.times { maildir.list_keys(:new) }
+# end
+# 
+# # Print a graph profile to text
+# printer = RubyProf::GraphPrinter.new(result)
+# printer.print(STDOUT, 0)

data/lib/maildir.rb

@@ -1,3 +1,4 @@
+require 'fileutils'
 class Maildir
 
   SUBDIRS = [:tmp, :new, :cur].freeze
@@ -43,10 +44,10 @@ class Maildir
     get_dir_listing(new_or_cur)
   end
 
-  # Writes IO object out as a new message. See Maildir::Message.create for
-  # more.
-  def add_message(io)
-    Maildir::Message.create(self, io)
+  # Writes string_or_io object out as a new message. See
+  # Maildir::Message.create for more.
+  def add_message(string_or_io)
+    Maildir::Message.create(self, string_or_io)
   end
 
   def get_message(key)
@@ -57,8 +58,12 @@ class Maildir
   def get_dir_listing(new_or_cur)
     search_path = File.join(self.path, new_or_cur.to_s, '*')
     results = Dir.glob(search_path)
+
     # Remove the maildir's path from the beginning of the message path
-    results.map!{|message_path| message_path.sub!(self.path, '')}
+    @dir_listing_regexp ||= /^#{Regexp.quote(self.path)}/
+    results.each do |message_path|
+      message_path.sub!(@dir_listing_regexp, "")
+    end
   end
 end
 

data/lib/maildir/message.rb

@@ -5,24 +5,27 @@ class Maildir::Message
   INFO = "2,"
 
   class << self
-    # Create a new message in maildir with the contents of io. The message is
-    # first written to the tmp dir, then moved to new. This is a shortcut for:
+    # Create a new message in maildir with the contents of string_or_io.
+    # The message is first written to the tmp dir, then moved to new. This is
+    # a shortcut for:
     #   message = Maildir::Message.new(maildir)
-    #   message.write(io)
-    def create(maildir, io)
+    #   message.write(string_or_io)
+    def create(maildir, string_or_io)
       message = self.new(maildir)
-      message.write(io)
+      message.write(string_or_io)
       message
     end
   end
 
   attr_reader :dir, :unique_name, :info, :old_key
 
-  # Create a new, unwritten message:
-  # Message.new(maildir)
+  # Create a new, unwritten message or instantiate an existing message.
+  # If key is nil, create a new message:
+  #   Message.new(maildir) # => a new, unwritten message
   #
-  # Instantiate an existing message:
-  # Message.new(maildir, key)
+  # If +key+ is not nil, instantiate a message object for the message at
+  # +key+.
+  #   Message.new(maildir, key) # => an existing message
   def initialize(maildir, key=nil)
     @maildir = maildir
     if key.nil?
@@ -31,33 +34,44 @@ class Maildir::Message
       parse_key(key)
     end
 
-    raise ArgumentError, "State must be in #{Maildir::SUBDIRS.inspect}" unless Maildir::SUBDIRS.include? dir
+    unless Maildir::SUBDIRS.include? dir
+      raise ArgumentError, "State must be in #{Maildir::SUBDIRS.inspect}"
+    end
 
     if :tmp == dir
       @unique_name = Maildir::UniqueName.create
     end
   end
 
-  # Writes io to disk. Can only be called on messages instantiated without a
-  # key (which haven't been written to disk). If the io object has a 'read'
-  # method, calls io.read. Otherwise, calls io.to_s.
-  def write(io)
+  # Writes string_or_io to disk. Can only be called on messages
+  # instantiated without a key (which haven't been written to disk). If the
+  # +string_or_io+ object has a 'read' method, calls string_or_io.read.
+  # Otherwise, calls string_or_io.to_s.
+  #
+  # Returns the message's key
+  def write(string_or_io)
     raise "Can only write to messages in tmp" unless :tmp == @dir
     # Write out contents to tmp
     File.open(path, 'w') do |file|
-      file.puts io.respond_to?(:read) ? io.read : io.to_s
+      if string_or_io.respond_to?(:read)
+        file.puts string_or_io.read
+      else
+        file.puts string_or_io.to_s
+      end
     end
 
     # Rename to new
     rename(:new)
-
   end
 
-  # Move a message from new to cur, add info
+  # Move a message from new to cur, add info.
+  # Returns the message's key
   def process
     rename(:cur, INFO)
   end
 
+  # Set info on a message.
+  # Returns the message's key
   def info=(info)
     raise "Can only set info on cur messages" unless :cur == @dir
     rename(:cur, info)
@@ -68,6 +82,8 @@ class Maildir::Message
     @info.sub(INFO,'').split('')
   end
 
+  # Sets the flags on a message.
+  # Returns the message's key
   def flags=(*flags)
     self.info = INFO + sort_flags(flags.flatten.join(''))
   end
@@ -96,22 +112,29 @@ class Maildir::Message
     File.join(@maildir.path, key)
   end
 
-  def old_path
-    File.join(@maildir.path, old_key)
+  # Deletes the message path and freezes the message object
+  def destroy
+    File.delete(path)
+    freeze
   end
 
   protected
-  # Sets dir, unique_name, and info based in key
+  # Sets dir, unique_name, and info based on the key
   def parse_key(key)
     @dir, filename = key.split(File::SEPARATOR)
     @dir = @dir.to_sym
     @unique_name, @info = filename.split(COLON)
   end
 
+  # Ensure the flags are uppercase and sorted
   def sort_flags(flags)
     flags.split('').map{|f| f.upcase}.sort!.uniq.join('')
   end
 
+  def old_path
+    File.join(@maildir.path, old_key)
+  end
+
   def rename(new_dir, new_info=nil)
     # Safe the old key so we can revert to the old state
     @old_key = key
@@ -122,6 +145,7 @@ class Maildir::Message
 
     begin
       File.rename(old_path, path) unless old_path == path
+      return key
     rescue Errno::ENOENT
       # Restore ourselves to the old state
       parse_key(@old_key)

data/maildir.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# 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.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Aaron Suggs"]
+  s.date = %q{2010-01-05}
+  s.description = %q{A ruby library for reading and writing arbitrary messages in DJB's maildir format}
+  s.email = %q{aaron@ktheory.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "NOTES.txt",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "benchmarks/runner",
+     "lib/maildir.rb",
+     "lib/maildir/message.rb",
+     "lib/maildir/unique_name.rb",
+     "maildir.gemspec",
+     "test/test_helper.rb",
+     "test/test_maildir.rb",
+     "test/test_message.rb",
+     "test/test_unique_name.rb"
+  ]
+  s.homepage = %q{http://github.com/ktheory/maildir}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Read & write messages in the maildir format}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/test_maildir.rb",
+     "test/test_message.rb",
+     "test/test_unique_name.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/test/test_maildir.rb

@@ -33,6 +33,17 @@ class TestMaildir < Test::Unit::TestCase
       assert_equal temp_maildir.path, new_maildir.path
       assert_equal temp_maildir, new_maildir
     end
+    
+    context "with a message" do
+      setup do
+        @key = temp_maildir.add_message("").key
+      end
+
+      should "list the message in it's keys" do
+        keys = temp_maildir.list_keys(:new)
+        assert_equal keys, [@key]
+      end
+    end
   end
 
 end

data/test/test_message.rb

@@ -147,6 +147,15 @@ class TestMessage < Test::Unit::TestCase
           assert_match /#{path_suffix}$/, @message.path
         end
       end
+      context "when destroyed" do
+        setup { @message.destroy }
+        should "be frozen" do
+          assert @message.frozen?, "Message is not frozen"
+        end
+        should "have a nonexistant path" do
+          assert !File.exists?(@message.path), "Message path exists"
+        end
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: maildir
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Aaron Suggs
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-05 00:00:00 -05:00
+date: 2010-01-05 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,6 +32,7 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files: 
+- .gitignore
 - LICENSE
 - NOTES.txt
 - README.rdoc
@@ -41,6 +42,7 @@ files:
 - lib/maildir.rb
 - lib/maildir/message.rb
 - lib/maildir/unique_name.rb
+- maildir.gemspec
 - test/test_helper.rb
 - test/test_maildir.rb
 - test/test_message.rb