maildir 2.0.0 → 2.1.0

data/README.rdoc

@@ -6,7 +6,7 @@ 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
 
-"Two words: no locks." -- Daniel J. Berstein
+"Two words: no locks." -- Daniel J. Bernstein
 
 The maildir format allows multiple processes to read and write arbitrary messages without file locks.
 
@@ -14,6 +14,9 @@ New messages are initially written to a "tmp" directory with an automatically-ge
 
 While the maildir format was created for email, it works well for arbitrary data. This library can read & write email messages or arbitrary data. See Pluggable serializers for more.
 
+{<img src="https://secure.travis-ci.org/ktheory/maildir.png" />}[http://travis-ci.org/ktheory/maildir]
+
+
 == Install
 
  gem install maildir
@@ -50,6 +53,12 @@ Add some flags to the message to indicate state. See "What can I put in info" at
   message.remove_flag("F") # unflag the message
   message.add_flag("T") # Mark the message as "trashed"
 
+List :cur messages based on flags.
+
+  maildir.list(:cur, :flags => 'F') # => lists all messages with flag 'F
+  maildir.list(:cur, :flags => 'FS') # => lists all messages with flag 'F' and 'S'; Flags must be specified in acending ASCII order ('FS' and not 'SF')
+  maildir.list(:cur, :flags => '') # => lists all messages without any flags
+
 Get a key to uniquely identify the message
 
   key = message.key

data/lib/maildir.rb

@@ -76,6 +76,14 @@ class Maildir
   end
 
   # Returns an arry of messages from :new or :cur directory, sorted by key.
+  # If options[:flags] is specified and directory is :cur, returns messages with flags specified
+  # 
+  # E.g.
+  # maildir.list(:cur, :flags => 'F') # => lists all messages with flag 'F'
+  # maildir.list(:cur, :flags => 'FS') # => lists all messages with flag 'F' and 'S'; Flags must be specified in acending ASCII order ('FS' and not 'SF')
+  # maildir.list(:cur, :flags => '') # => lists all messages without any flags
+  # This option does not work for :new directory
+  #
   # If options[:limit] is specified, returns only so many keys.
   #
   # E.g.
@@ -86,7 +94,10 @@ class Maildir
       raise ArgumentError, "dir must be :new, :cur, or :tmp"
     end
 
-    keys = get_dir_listing(dir)
+    # Set flags to filter messages
+    # Silently ignored if dir is :new
+    flags = (dir.to_sym == :cur) ? options[:flags] : nil
+    keys = get_dir_listing(dir, :flags => flags)
 
     # Sort the keys (chronological order)
     # TODO: make sorting configurable
@@ -127,8 +138,10 @@ class Maildir
 
   protected
   # Returns an array of keys in dir
-  def get_dir_listing(dir)
-    search_path = File.join(self.path, dir.to_s, '*')
+  def get_dir_listing(dir, options={})
+  	filter = "*"
+  	filter = "#{filter}:2,#{options[:flags]}" if options[:flags]
+    search_path = File.join(self.path, dir.to_s, filter)
     keys = Dir.glob(search_path)
     #  Remove the maildir's path from the keys
     keys.each do |key|

data/lib/maildir/message.rb

@@ -119,7 +119,7 @@ class Maildir::Message
 
   # Returns an array of single letter flags applied to the message
   def flags
-    @info.sub(INFO,'').split(//)
+    @info.to_s.sub(INFO,'').split(//)
   end
 
   # Sets the flags on a message.

data/lib/maildir/serializer/base.rb

@@ -10,7 +10,9 @@ class Maildir
     class Base
       # Reads the file at path. Returns the contents of path.
       def load(path)
-        File.read(path)
+        File.open(path,'rb') do |f|
+          f.read
+        end
       end
 
       # Writes data to path. Returns number of bytes written.

data/lib/maildir/unique_name.rb

@@ -37,7 +37,7 @@ class Maildir::UniqueName
   # The middle part contains the microsecond, the process id, and a
   # per-process incrementing counter
   def middle
-    "M#{microsecond}P#{process_id}Q#{delivery_count}"
+    "M#{'%06d' % microsecond}P#{process_id}Q#{delivery_count}"
   end
 
   # The right part is the hostname

data/lib/maildir/version.rb

@@ -1,3 +1,3 @@
 class Maildir
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

data/test/test_maildir.rb

@@ -53,12 +53,51 @@ class TestMaildir < Test::Unit::TestCase
       messages = temp_maildir.list(:new)
       assert_equal messages, [@message]
     end
-
-    should "list a cur message" do
-      @message = temp_maildir.add("")
-      @message.process
-      messages = temp_maildir.list(:cur)
-      assert_equal messages, [@message]
+    
+    context "cur message" do
+      should "list a cur message" do
+        @message = temp_maildir.add("")
+        @message.process
+        messages = temp_maildir.list(:cur)
+        assert_equal messages, [@message]
+      end
+      
+      should "list and filter cur messages based on flags" do
+        @message = temp_maildir.add("")
+        @message.process
+        
+        @flagged_message = temp_maildir.add("")
+        @flagged_message.process
+        @flagged_message.add_flag('F')
+        
+        messages = temp_maildir.list(:cur, :flags => 'F')
+        assert_equal messages, [@flagged_message]
+      end
+      
+      should "list and filter cur messages based on multiple flags" do
+        @message = temp_maildir.add("")
+        @message.process
+        
+        @flagged_message = temp_maildir.add("")
+        @flagged_message.process
+        @flagged_message.add_flag('F')
+        @flagged_message.add_flag('S')
+        
+        messages = temp_maildir.list(:cur, :flags => 'FS')
+        assert_equal messages, [@flagged_message]
+      end
+      
+      should "list and filter cur messages without any flags" do
+        @message = temp_maildir.add("")
+        @message.process
+        
+        @flagged_message = temp_maildir.add("")
+        @flagged_message.process
+        @flagged_message.add_flag('F')
+        
+        messages = temp_maildir.list(:cur, :flags => '')
+        assert_equal messages, [@message]
+      end
     end
   end
 

data/test/test_message.rb

@@ -80,6 +80,10 @@ class TestMessage < Test::Unit::TestCase
     should "have the correct data" do
       assert_equal @data, @message.data
     end
+
+    should "have empty flags" do
+      assert_equal [], @message.flags
+    end
   end
 
   context "A processed message" do

data/test/test_unique_name.rb

@@ -30,6 +30,16 @@ class TestUniqueName < Test::Unit::TestCase
       @new_name.send(:instance_variable_set, :@now, @now)
       assert_not_equal @name, @new_name.to_s
     end
+    
+    should "be chronological" do
+      @name1 = Maildir::UniqueName.new
+      @name1.send(:instance_variable_set, :@now, Time.at(0.000009))
+      
+      @name2 = Maildir::UniqueName.new
+      @name2.send(:instance_variable_set, :@now, Time.at(0.100000))
+      
+      assert_operator @name2.to_s, :>, @name1.to_s
+    end
 
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maildir
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-09 00:00:00.000000000Z
+date: 2012-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70101941878220 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70101941878220
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70101941877660 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70101941877660
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mail
-  requirement: &70101941877140 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70101941877140
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70101941876660 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +69,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70101941876660
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: fakefs
-  requirement: &70101941876060 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +85,12 @@ dependencies:
         version: 0.3.2
   type: :development
   prerelease: false
-  version_requirements: *70101941876060
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.2
 description: A ruby library for reading and writing arbitrary messages in DJB's maildir
   format
 email: aaron@ktheory.com
@@ -111,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.5
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.7
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Read & write messages in the maildir format