Changeset 9074 for lang/ruby/mdmaildir/mdd.rb

Timestamp:

04/07/08 16:46:43 (5 years ago)

Author:

ihag

Message:

lang/ruby/mdmaildir/mdmerge.rb:

• add -f COMMAND_FILE option for make cmdfile mode.
  
• add -c -f COMMAND_FILE option for commit from cmdfile mode.
  
• Introduced CMDProcessor class for abstracting the behavior of command.
  

lang/ruby/mdmaildir/mdd.rb: add comments.
lang/ruby/mdmaildir/README: fix typo.

Files:

• lang/ruby/mdmaildir/mdd.rb (modified) (8 diffs)

lang/ruby/mdmaildir/mdd.rb

@@ -1 +1 @@
 #!/usr/local/bin/ruby
 # $Id$
-require 'gdbm'
-require 'digest/sha1'
-require 'pp'
 
+#
+# = Manipulates message-digest file for whole of messages in the Maildir.
+#
+# Authors::  $Author: genta $
+# Revision:: $Revision: 77 $
+#
+class MDDigest
+  require 'gdbm'
+  require 'digest/sha1'
+  require 'pp'
 
-# Maildir digest file class
-class MDDigest
   attr_reader :path, :basedir, :db
+
+  # Create MDDigest instance.  MDDigest opens a message-digest file in
+  # the specified Maildir.  The message-digest file is stored into the
+  # top-level directory as filename like "_maildir_/mddigest".
+  #
+  # _maildir_:: Path of Maildir.
+  # returns::   An instance of MDDigest class
   def initialize(maildir)
     @basedir = maildir.dup
@@ -16 +28 @@
 
   def open;  @db = GDBM.open(@path); end
-  def close; @db.reorganize.close;   end
-  def clear; @db.clear;              end
+  private :open
 
+  # Close the backend DBM. Call this method at the end of your program.
+  def close;
+    @db.reorganize.close
+  end
+
+  # Truncate message-digest file.
+  def clear
+    @db.clear
+  end
+
+  # Caliculates a message-digest for specified message, and records it
+  # into message-digest file. 
+  #
+  # _path_::  Relative path of a message from Maildir directory.
+  # returns:: void
   def add(path)
     apath = abspath(path)
@@ -33 +59 @@
   end
 
+  # Check specified key and file are already records in message-digest
+  # file, or not.
+  #
+  # _key_::   Key of file-hash. It typically message-digest + size of
+  #           message.
+  # _file_::  Relative path of a message from Maildir directory.
+  # returns:: *true* if it already exists.
+  #           *false* for not exists.
   def has_file?(key, file)
     return false if @db[key].nil?
@@ -41 +75 @@
   end
 
+  # Wrapper of GDBM#each. It is for traversal all of messages in Maildir
+  # by using a message-digest file.
   def each(&block)
     @db.each(&block)
@@ -46 +82 @@
 
 
+  private
+
+  # Caliculates a Message digest for specified message.
+  #
+  # _file_::  Path for a message.
+  # returns:: Instance of Digest::SHA1.
   def hash(file)
     md = Digest::SHA1.new
@@ -57 +99 @@
   end
 
-  def abspath(file)
-    File.expand_path(file, @basedir)
-  end
-
+  # _key_::
+  # _dest_::
   def merge(key, dest)
     dfolder = folder(abspath(dest))
@@ -77 +117 @@
   end
 
+  # Determines a folder name for a specified message.
+  #
+  # _path_::  Relative path of a message from Maildir directory
+  # returns:: A folder name in Maildir for a message that directed by path.
   def folder(path)
     f, = path.split('/')
@@ -82 +126 @@
     return f
   end
+
+  # Convert relative path to the absolute path. The root of absolute path is
+  # Maildir directory.
+  #
+  # _file_::  Relative path from Maildir directory.
+  # returns:: Absolute path that converted from _file_.
+  def abspath(file)
+    File.expand_path(file, @basedir)
+  end
 end