* lib/ftools.rb: documented

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@5700 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

lib/ftools.rb

@@ -1,8 +1,50 @@
+# 
+# = ftools.rb: Extra tools for the File class
+#
+# Author:: WANTANABE, Hirofumi
+# Documentation:: Zachary Landau
+#
+# This library can be distributed under the terms of the Ruby license.
+# You can freely distribute/modify this library.
+#
+# It is included in the Ruby standard library.
+#
+# == Description
+#
+# +ftools+ adds several (class, not instance) methods to the File class, for copying, moving,
+# deleting, installing, and comparing files, as well as creating a directory path.  See the
+# File class for details.
+#
+# +fileutils+ contains all or nearly all the same functionality and more, and is a recommended
+# option over +ftools+. 
+#
+
+
+#
+# When you
+#
+#   require 'ftools'
+#
+# then the File class aquires some utility methods for copying, moving, and deleting files, and
+# more.
+#
+# See the method descriptions below, and consider using +fileutils+ as it is more
+# comprehensive.
+#
+class File
+end
+
 class << File
 
   BUFSIZE = 8 * 1024
 
-  def catname from, to
+  #
+  # If +to+ is a valid directory, +from+ will be appended to +to+, adding
+  # and escaping backslashes as necessary. Otherwise, +to+ will be returned.
+  # Useful for appending +from+ to +to+ only if the filename was not specified
+  # in +to+. 
+  #
+  def catname(from, to)
     if FileTest.directory? to
       File.join to.sub(%r([/\\]$), ''), basename(from)
     else
@@ -10,9 +52,11 @@ class << File
     end
   end
 
-# copy file
+  #
-
+  # Copies a file +from+ to +to+. If +to+ is a directory, copies +from+
-  def syscopy from, to
+  # to <tt>to/from</tt>.
+  #
+  def syscopy(from, to)
     to = catname(from, to)
 
     fmode = stat(from).mode
@@ -38,16 +82,24 @@ class << File
     ret
   end
 
-  def copy from, to, verbose = false
+  #
+  # Copies a file +from+ to +to+ using #syscopy. If +to+ is a directory,
+  # copies +from+ to <tt>to/from</tt>. If +verbose+ is true, <tt>from -> to</tt>
+  # is printed.
+  #
+  def copy(from, to, verbose = false)
     $deferr.print from, " -> ", catname(from, to), "\n" if verbose
     syscopy from, to
   end
 
   alias cp copy
 
-# move file
+  #
-
+  # Moves a file +from+ to +to+ using #syscopy. If +to+ is a directory,
-  def move from, to, verbose = false
+  # copies from +from+ to <tt>to/from</tt>. If +verbose+ is true, <tt>from -> to</tt>
+  # is printed.
+  #
+  def move(from, to, verbose = false)
     to = catname(from, to)
     $deferr.print from, " -> ", to, "\n" if verbose
 
@@ -74,11 +126,11 @@ class << File
 
   alias mv move
 
-#  compare two files
+  #
-#   true:  identical
+  # Returns +true+ iff the contents of files +from+ and +to+ are
-#   false: not identical
+  # identical. If +verbose+ is +true+, <tt>from <=> to</tt> is printed.
-
+  #
-  def compare from, to, verbose = false
+  def compare(from, to, verbose = false)
     $deferr.print from, " <=> ", to, "\n" if verbose
 
     return false if stat(from).size != stat(to).size
@@ -111,8 +163,11 @@ class << File
 
   alias cmp compare
 
-#  unlink files safely
+  #
-
+  # Removes a list of files. Each parameter should be the name of the file to
+  # delete. If the last parameter isn't a String, verbose mode will be enabled.
+  # Returns the number of files deleted.
+  #
   def safe_unlink(*files)
     verbose = if files[-1].is_a? String then false else files.pop end
     begin
@@ -126,6 +181,20 @@ class << File
 
   alias rm_f safe_unlink
 
+  #
+  # Creates a directory and all its parent directories.
+  # For example,
+  #
+  #	File.makedirs '/usr/lib/ruby'
+  #
+  # causes the following directories to be made, if they do not exist.
+  #	* /usr
+  #	* /usr/lib
+  #	* /usr/lib/ruby
+  #
+  # You can pass several directories, each as a parameter. If the last
+  # parameter isn't a String, verbose mode wil be enabled.
+  #
   def makedirs(*dirs)
     verbose = if dirs[-1].is_a? String then false else dirs.pop end
 #    mode = if dirs[-1].is_a? Fixnum then dirs.pop else 0755 end
@@ -150,6 +219,15 @@ class << File
   alias o_chmod chmod
 
   vsave, $VERBOSE = $VERBOSE, false
+
+  #
+  # Changes permission bits on +files+ to the bit pattern represented
+  # by +mode+. If the last parameter isn't a String, verbose mode will
+  # be enabled.
+  #
+  #   File.chmod 0755, 'somecommand'
+  #   File.chmod 0644, 'my.rb', 'your.rb', true
+  #
   def chmod(mode, *files)
     verbose = if files[-1].is_a? String then false else files.pop end
     $deferr.printf "chmod %04o %s\n", mode, files.join(" ") if verbose
@@ -157,6 +235,12 @@ class << File
   end
   $VERBOSE = vsave
 
+  #
+  # If +src+ is not the same as +dest+, copies it and changes the permission
+  # mode to +mode+. If +dest+ is a directory, destination is <tt>dest/src</tt>.
+  # If +mode+ is not set, default is used. If +verbose+ is set to true, the
+  # name of each file copied will be printed.
+  #
   def install(from, to, mode = nil, verbose = false)
     to = catname(from, to)
     unless FileTest.exist? to and cmp from, to
@@ -167,4 +251,5 @@ class << File
   end
 
 end
+
 # vi:set sw=2: