maildir 0.6.0 → 1.0.0

data/README.rdoc

@@ -73,7 +73,7 @@ By default, message data are written and read from disk as a string. It's often
 
 The following serializers are included:
 
-* Maildir::Serializer::Base (the default)
+* Maildir::Serializer::Base (default)
 * Maildir::Serializer::Mail
 * Maildir::Serializer::Marshal
 * Maildir::Serializer::JSON
@@ -85,6 +85,13 @@ 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:
+
+  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.
+
 The Mail serializer takes a ruby Mail object (http://github.com/mikel/mail) and writes RFC2822 email messages.
 
   require 'maildir/serializer/mail'
@@ -109,6 +116,7 @@ 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
 
 == Copyright
 

data/Rakefile

@@ -7,25 +7,6 @@ end
 
 task :default => :test
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gemspec|
-    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"
-    gemspec.homepage = "http://github.com/ktheory/maildir"
-    gemspec.authors = ["Aaron Suggs", "Niklas E. Cathor"]
-    gemspec.add_development_dependency "shoulda", ">= 0"
-    gemspec.add_development_dependency "mail", ">= 0"
-    gemspec.add_development_dependency "json", ">= 0"
-    gemspec.add_development_dependency "ktheory-fakefs", ">= 0"
-  end
-  Jeweler::GemcutterTasks.new
-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")
@@ -34,4 +15,4 @@ end
 desc "Remove trailing whitespace"
 task :whitespace do
   sh %{find . -name '*.rb' -exec sed -i '' 's/ *$//g' {} \\;}
-end
+end

data/lib/maildir/serializer/base.rb

@@ -13,7 +13,23 @@ module Maildir::Serializer
     end
 
     # Writes data to path. Returns number of bytes written.
+    # If data acts like an IO object (i.e., data responds to the read method),
+    # we call data.read or the more efficient IO.copy_stream available in
+    # ruby 1.9.1.
     def dump(data, path)
+      if data.respond_to?(:read)
+        if IO.respond_to?(:copy_stream)
+          IO.copy_stream(data, path)
+        else
+          write(data.read, path)
+        end
+      else
+        write(data, path)
+      end
+    end
+
+    protected
+    def write(data, path)
       File.open(path, "w") {|file| file.write(data)}
     end
   end

data/lib/maildir/serializer/json.rb

@@ -1,13 +1,21 @@
-require 'json'
+# Prefer yajl JSON library
+begin
+  require 'yajl/json_gem'
+rescue LoadError
+  require 'json'
+end
+
 # Serialize messages as JSON
-class Maildir::Serializer::JSON < Maildir::Serializer::Base
-  # Read data from path and parse it as JSON.
-  def load(path)
-    ::JSON.load(super(path))
-  end
+module Maildir::Serializer
+  class JSON < Base
+    # Read data from path and parse it as JSON.
+    def load(path)
+      ::JSON.load(super(path))
+    end
 
-  # Dump data as JSON and writes it to path.
-  def dump(data, path)
-    super(data.to_json, path)
+    # Dump data as JSON and writes it to path.
+    def dump(data, path)
+      super(data.to_json, path)
+    end
   end
 end

data/lib/maildir/unique_name.rb

@@ -45,19 +45,6 @@ class Maildir::UniqueName
     Socket.gethostname
   end
 
-  def secure_random(bytes=8)
-    # File.read("/dev/urandom", bytes).unpack("H*")[0]
-    raise "Not implemented"
-  end
-
-  def inode
-    raise "Not implemented"
-  end
-
-  def device_number
-    raise "Not implemented"
-  end
-
   def microsecond
     @now.usec.to_s
   end

data/lib/maildir/version.rb

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

data/test/test_serializers.rb

@@ -1,7 +1,12 @@
 require 'test_helper'
 class TestSerializers < Test::Unit::TestCase
 
+
   serializers = [
+    # Test the base serializer with a string
+    [Maildir::Serializer::Base,    lambda {|data| data}],
+    # Test base serializer with IO object
+    [Maildir::Serializer::Base,    lambda {|data| s = StringIO.new(data); s.rewind; s}],
     [Maildir::Serializer::Mail,    lambda {|data| Mail.new(data).to_s}],
     [Maildir::Serializer::Marshal, lambda {|data| Marshal.dump(data)}],
     [Maildir::Serializer::JSON,    lambda {|data| JSON.dump(data)}],
@@ -9,15 +14,20 @@ class TestSerializers < Test::Unit::TestCase
   ]
 
   serializers.each do |klass, dumper|
-    context "A message serialized with #{klass}" do
+    # NB: dumper.object_id makes test names unique
+    context "A message serialized with #{klass} (#{dumper.object_id})" do
       setup do
         FakeFS::FileSystem.clear
         @data = case klass.new
         when Maildir::Serializer::Mail
           Mail.new
-        else
+        when Maildir::Serializer::Marshal, Maildir::Serializer::JSON, Maildir::Serializer::YAML
           # Test a few common types
           [1, nil, {"foo" => true}]
+        when Maildir::Serializer::Base
+          "Hello World!"
+        else
+          raise "Unknown class #{klass.inspect}"
         end
 
         # Set the message serializer
@@ -30,7 +40,10 @@ class TestSerializers < Test::Unit::TestCase
       end
 
       should "have serialized data on disk" do
-        assert_equal dumper.call(@data), File.read(@message.path)
+        expected_data = dumper.call(@data)
+        # Read the expected_data if @data is an IO object
+        expected_data = expected_data.read if expected_data.respond_to?(:read)
+        assert_equal expected_data, File.read(@message.path)
       end
     end
   end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: maildir
 version: !ruby/object:Gem::Version 
-  version: 0.6.0
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Aaron Suggs
@@ -10,66 +16,88 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-28 00:00:00 -05:00
+date: 2010-12-19 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: shoulda
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: mail
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: json
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: ktheory-fakefs
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id005
 description: A ruby library for reading and writing arbitrary messages in DJB's maildir format
 email: aaron@ktheory.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
-- .gitignore
-- LICENSE
-- README.rdoc
-- Rakefile
-- VERSION
-- benchmarks/runner
-- lib/maildir.rb
 - lib/maildir/keywords.rb
 - lib/maildir/message.rb
 - lib/maildir/serializer/base.rb
@@ -79,7 +107,11 @@ files:
 - lib/maildir/serializer/yaml.rb
 - lib/maildir/subdirs.rb
 - lib/maildir/unique_name.rb
-- maildir.gemspec
+- lib/maildir/version.rb
+- lib/maildir.rb
+- LICENSE
+- README.rdoc
+- Rakefile
 - test/test_helper.rb
 - test/test_keywords.rb
 - test/test_maildir.rb
@@ -97,21 +129,29 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+      hash: 17
+      segments: 
+      - 1
+      - 3
+      - 5
+      version: 1.3.5
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Read & write messages in the maildir format

data/.gitignore

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

data/VERSION

@@ -1 +0,0 @@
-0.6.0

data/benchmarks/runner

@@ -1,30 +0,0 @@
-#!/usr/bin/env ruby
-$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
-require 'maildir'
-require 'benchmark'
-
-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("") } }
-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/maildir.gemspec

@@ -1,82 +0,0 @@
-# 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.6.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Aaron Suggs", "Niklas E. Cathor"]
-  s.date = %q{2010-01-28}
-  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",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "benchmarks/runner",
-     "lib/maildir.rb",
-     "lib/maildir/keywords.rb",
-     "lib/maildir/message.rb",
-     "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/subdirs.rb",
-     "lib/maildir/unique_name.rb",
-     "maildir.gemspec",
-     "test/test_helper.rb",
-     "test/test_keywords.rb",
-     "test/test_maildir.rb",
-     "test/test_message.rb",
-     "test/test_serializers.rb",
-     "test/test_subdirs.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_keywords.rb",
-     "test/test_maildir.rb",
-     "test/test_message.rb",
-     "test/test_serializers.rb",
-     "test/test_subdirs.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<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<mail>, [">= 0"])
-      s.add_development_dependency(%q<json>, [">= 0"])
-      s.add_development_dependency(%q<ktheory-fakefs>, [">= 0"])
-    else
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<mail>, [">= 0"])
-      s.add_dependency(%q<json>, [">= 0"])
-      s.add_dependency(%q<ktheory-fakefs>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<mail>, [">= 0"])
-    s.add_dependency(%q<json>, [">= 0"])
-    s.add_dependency(%q<ktheory-fakefs>, [">= 0"])
-  end
-end
-