maildir 2.0.0 → 2.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: efbd522270f3b5117699a34ecc2770d7b8ae99adfef53f5b4583d44751a793f8
+  data.tar.gz: '08fe926a74261382c5ab07b2f870d0a90e26743f14c2038b4f05a03b9cf939dc'
+SHA512:
+  metadata.gz: 44229a540b0c1397fed9787375608798ad5420fb76bee795ede3b8920d28695eea18a25451c963dc96bbcdd58e6b1345a7395188e760b431fe93a383247325b4
+  data.tar.gz: dccdb7449eb51f0a4fc9de41f522a57fc6f08a0811481a980d355295e0da051fef8b6f2978a511165b78097e7ad8301ab63e2399c27a4ff8e81cc22815e56a32

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,10 @@ 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]
+{<img src="https://codeclimate.com/github/ktheory/maildir.png" />}[https://codeclimate.com/github/ktheory/maildir]
+
+
 == Install
 
  gem install maildir
@@ -50,6 +54,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
@@ -110,8 +120,11 @@ As of version 1.0.0, the Maildir::Serializer::Base can write IO streams as well
 
   message.add(STDIN)
 
-This will use Ruby 1.9's more efficient IO.copy_stream method if available,
-and degrade gracefully in Ruby 1.8.
+This will use the more efficient IO.copy_stream method from Ruby 1.9+ if
+available, and degrade gracefully in Ruby 1.8. (Important note: Please be aware
+that Ruby 1.8.x is no longer officially supported by the maildir gem; see
+[.travis.yml](https://github.com/ktheory/maildir/blob/master/.travis.yml) for a
+list of currently-supported Ruby versions.)
 
 As of version 1.0.2, serializers are autoloaded. Thus it is no longer necessary to manually require them.
 
@@ -138,6 +151,10 @@ It's trivial to create a custom serializer. Implement the following two methods:
 
 * Aaron Suggs (github[http://github.com/ktheory])
 
+== Maintainer
+
+* Todd A. Jacobs (github[http://github.com/codegnome])
+
 == Contributors
 
 * Niklas E. Cathor (github[http://github.com/nilclass])
@@ -147,4 +164,4 @@ It's trivial to create a custom serializer. Implement the following two methods:
 
 == Copyright
 
-Copyright (c) 2010 Aaron Suggs. See LICENSE for details.
+Copyright (c) 2010-2014 Aaron Suggs. See LICENSE for details.

data/Rakefile

@@ -1,7 +1,9 @@
+require 'bundler/setup'
 require 'rake/testtask'
+require 'bundler/gem_tasks'
+
 Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList['test/test*.rb']
+  t.pattern = "test/test_*.rb"
   t.verbose = true
 end
 

data/lib/maildir.rb

@@ -14,10 +14,11 @@ class Maildir
   include Comparable
 
   attr_reader :path
-  attr_accessor :serializer
+  attr_writer :serializer
 
   # Default serializer.
-  @@serializer = Maildir::Serializer::Base.new
+  DEFAULT_SERIALIZER = Maildir::Serializer::Base.new.freeze
+  @@serializer = DEFAULT_SERIALIZER
 
   # Gets the default serializer.
   def self.serializer
@@ -40,7 +41,7 @@ class Maildir
 
   # Returns own serializer or falls back to default.
   def serializer
-    @serializer || @@serializer
+    @serializer ||= @@serializer
   end
 
   # Compare maildirs by their paths.
@@ -76,6 +77,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 +95,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 +139,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

@@ -41,7 +41,8 @@ class Maildir::Message
   def initialize(maildir, key=nil)
     @maildir = maildir
     if key.nil?
-      @dir = :tmp
+      @dir         = :tmp
+      @info        = nil
       @unique_name = Maildir::UniqueName.create
     else
       parse_key(key)
@@ -119,7 +120,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.
@@ -134,10 +135,13 @@ class Maildir::Message
     self.flags = (flags << flag.upcase)
   end
 
-  # Removes a flag from a message.
+  # Removes flags from a message.
   # Returns the message's key if successful, false otherwise.
-  def remove_flag(flag)
-    self.flags = flags.delete_if{|f| f == flag.upcase}
+  #
+  # flags:: String or Array
+  def remove_flag(flags)
+    return self.flags if !flags || flags.empty?
+    self.flags = self.flags.reject { |f| f =~ /[#{Array(flags).join}]/i }
   end
 
   # Returns the filename of the 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

@@ -2,12 +2,15 @@
 class Maildir::UniqueName
   require 'thread' # For mutex support
   require 'socket' # For getting the hostname
+
+  COUNTER_MUTEX = Mutex.new
+
   class << self
     # Return a thread-safe increasing counter
     def counter
-      @counter_mutex ||= Mutex.new
-      @counter_mutex.synchronize do
-        @counter = @counter.to_i + 1
+      COUNTER_MUTEX.synchronize do
+        @counter ||= 0
+        @counter = @counter.to_i.succ
       end
     end
 
@@ -37,7 +40,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.2.3'
 end

data/test/helper.rb

@@ -0,0 +1,40 @@
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'shoulda'
+require 'maildir'
+
+# Require all the serializers
+serializers = File.expand_path('../../lib/maildir/serializer/*.rb', __FILE__)
+Dir.glob(serializers).each do |serializer|
+  require serializer
+end
+
+class Minitest::Test
+  # Create a reusable maildir that's cleaned up when the tests are done
+  def temp_maildir
+    Maildir.new("/tmp/maildir_test")
+  end
+
+  def setup
+    # Wait until everything's loaded and tests are running to require FakeFS
+    require 'fakefs'
+  end
+
+  # 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
+end

data/test/test_maildir.rb

@@ -1,5 +1,5 @@
-require 'test_helper'
-class TestMaildir < Test::Unit::TestCase
+require_relative 'helper'
+class TestMaildir < Minitest::Test
 
   context "A maildir" do
     setup do
@@ -53,12 +53,78 @@ class TestMaildir < Test::Unit::TestCase
       messages = temp_maildir.list(:new)
       assert_equal messages, [@message]
     end
+    
+    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
+
+  context "multiple flags" do
+    should "be added in sorted order" do
+      sorted_flags   = 'FS'
+      unsorted_flags = 'SF'
 
-    should "list a cur message" do
       @message = temp_maildir.add("")
       @message.process
-      messages = temp_maildir.list(:cur)
-      assert_equal messages, [@message]
+      @message.add_flag(unsorted_flags)
+
+      assert_equal sorted_flags.split(''), @message.flags
+    end
+
+    should "be removed from flag list" do
+      flags_to_add    = 'FSXYZ'
+      flags_to_remove = 'XYZ'
+      flags_remaining = 'FS'
+
+      @message = temp_maildir.add("")
+      @message.process
+      @message.add_flag(flags_to_add)
+      assert_equal flags_to_add.split(''), @message.flags
+
+      @message.remove_flag(flags_to_remove)
+      assert_equal flags_remaining.split(''), @message.flags
     end
   end
 

data/test/test_message.rb

@@ -1,5 +1,5 @@
-require 'test_helper'
-class TestMessage < Test::Unit::TestCase
+require_relative 'helper'
+class TestMessage < Minitest::Test
 
   context "A message" do
     setup do
@@ -53,7 +53,7 @@ class TestMessage < Test::Unit::TestCase
     end
 
     should "not be writable" do
-      assert_raise RuntimeError do
+      assert_raises RuntimeError do
         @message.write("nope!")
       end
     end
@@ -77,9 +77,18 @@ class TestMessage < Test::Unit::TestCase
       assert File.exists?(@message.path)
     end
 
+    # Detect order-dependent regressions when SEED=48094.
+    should "use the Base serializer" do
+      assert_equal Maildir::Serializer::Base, Maildir.serializer.class
+    end
+
     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
@@ -91,7 +100,7 @@ class TestMessage < Test::Unit::TestCase
     end
 
     should "not be writable" do
-      assert_raise RuntimeError do
+      assert_raises RuntimeError do
         @message.write("nope!")
       end
     end
@@ -108,7 +117,7 @@ class TestMessage < Test::Unit::TestCase
       info = "2,FRS"
       @message.info = "2,FRS"
       assert_equal @message.info, info
-      assert_match /#{info}$/, @message.path
+      assert_match(/#{info}$/, @message.path)
     end
 
     should "add and remove flags" do
@@ -137,7 +146,7 @@ class TestMessage < Test::Unit::TestCase
         @message.flags = arg
         assert_equal results, @message.flags
         path_suffix = "#{Maildir::Message::INFO}#{results.join('')}"
-        assert_match /#{path_suffix}$/, @message.path
+        assert_match(/#{path_suffix}$/, @message.path)
       end
     end
   end
@@ -176,14 +185,13 @@ class TestMessage < Test::Unit::TestCase
     end
 
     should "raise error for data" do
-      assert_raise Errno::ENOENT do
+      assert_raises Errno::ENOENT do
         @message.data
       end
       assert @message.frozen?
     end
 
     should "not be processed" do
-      old_key = @message.key
       assert_equal false, @message.process
       assert @message.frozen?
     end
@@ -204,9 +212,9 @@ class TestMessage < Test::Unit::TestCase
     should "differ" do
       @message1 = temp_maildir.add("")
       @message2 = temp_maildir.add("")
-      assert_equal -1, @message1 <=> @message2
+      assert_equal(-1, @message1 <=> @message2)
       assert_equal 1,  @message2 <=> @message1
-      assert_not_equal @message1, @message2
+      refute_equal @message1, @message2
     end
   end
 

data/test/test_serializers.rb

@@ -1,6 +1,5 @@
-require 'test_helper'
-class TestSerializers < Test::Unit::TestCase
-
+require_relative 'helper'
+class TestSerializers < Minitest::Test
 
   serializers = [
     # Test the base serializer with a string
@@ -35,6 +34,10 @@ class TestSerializers < Test::Unit::TestCase
         @message = temp_maildir.add(@data)
       end
 
+      teardown do
+        Maildir.serializer = Maildir::DEFAULT_SERIALIZER
+      end
+
       should "have the correct data" do
         assert_equal @data, @message.data
       end

data/test/test_unique_name.rb

@@ -1,5 +1,5 @@
-require 'test_helper'
-class TestUniqueName < Test::Unit::TestCase
+require_relative 'helper'
+class TestUniqueName < Minitest::Test
 
   context "A UniqueName" do
     setup do
@@ -17,18 +17,28 @@ class TestUniqueName < Test::Unit::TestCase
     end
 
     should "begin with timestamp" do
-      assert_match /^#{@now.to_i}/, @name
+      assert_match(/^#{@now.to_i}/, @name)
     end
 
     should "end with hostname" do
-      assert_match /#{Socket.gethostname}$/, @name
+      assert_match(/#{Socket.gethostname}$/, @name)
     end
 
     should "be unique when created in the same microsecond" do
       @new_name = Maildir::UniqueName.new
       # Set @now be identical in both UniqueName instances
       @new_name.send(:instance_variable_set, :@now, @now)
-      assert_not_equal @name, @new_name.to_s
+      refute_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,123 +1,135 @@
 --- !ruby/object:Gem::Specification
 name: maildir
 version: !ruby/object:Gem::Version
-  version: 2.0.0
-  prerelease: 
+  version: 2.2.3
 platform: ruby
 authors:
 - Aaron Suggs
-autorequire: 
+- Todd A. Jacobs
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-09-09 00:00:00.000000000Z
+date:
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70101941878220 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70101941878220
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70101941877660 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70101941877660
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mail
-  requirement: &70101941877140 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70101941877140
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70101941876660 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70101941876660
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: fakefs
-  requirement: &70101941876060 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.2
   type: :development
   prerelease: false
-  version_requirements: *70101941876060
+  version_requirements: !ruby/object:Gem::Requirement
+    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
+email:
+- aaron@ktheory.com
+- spamivore+maildir.gem@codegnome.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/maildir/message.rb
+- lib/maildir.rb
+- lib/maildir
+- lib/maildir/serializer
 - lib/maildir/serializer/base.rb
 - lib/maildir/serializer/json.rb
-- lib/maildir/serializer/mail.rb
-- lib/maildir/serializer/marshal.rb
 - lib/maildir/serializer/yaml.rb
+- lib/maildir/serializer/marshal.rb
+- lib/maildir/serializer/mail.rb
+- lib/maildir/message.rb
 - lib/maildir/unique_name.rb
 - lib/maildir/version.rb
-- lib/maildir.rb
 - LICENSE
 - README.rdoc
 - Rakefile
-- test/test_helper.rb
-- test/test_maildir.rb
-- test/test_message.rb
-- test/test_serializers.rb
-- test/test_unique_name.rb
 homepage: http://github.com/ktheory/maildir
 licenses: []
-post_install_message: 
+metadata: {}
+post_install_message:
 rdoc_options:
-- --charset=UTF-8
+- "--charset=UTF-8"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.7
-signing_key: 
-specification_version: 3
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
 summary: Read & write messages in the maildir format
 test_files:
-- test/test_helper.rb
+- test/helper.rb
 - test/test_maildir.rb
 - test/test_message.rb
-- test/test_serializers.rb
 - test/test_unique_name.rb
+- test/test_serializers.rb

data/test/test_helper.rb

@@ -1,33 +0,0 @@
-require 'test/unit'
-require 'shoulda'
-require 'maildir'
-
-# Require all the serializers
-serializers = File.expand_path('../../lib/maildir/serializer/*.rb', __FILE__)
-Dir.glob(serializers).each do |serializer|
-  require serializer
-end
-
-require 'fakefs'
-
-# Create a reusable maildir that's cleaned up when the tests are done
-def temp_maildir
-  Maildir.new("/tmp/maildir_test")
-end
-
-# 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