rio 0.3.8 → 0.3.9

data/lib/rio/handle.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================== 
-# Copyright (c) 2005, 2006 Christopher Kleckner
+# Copyright (c) 2005,2006,2007 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -23,16 +23,15 @@
 #
 # To create the documentation for Rio run the command
 #  ruby build_doc.rb
-# from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
+# from the distribution directory.
 #
 # Suggested Reading
 # * RIO::Doc::SYNOPSIS
 # * RIO::Doc::INTRO
 # * RIO::Doc::HOWTO
+# * RIO::Doc::EXAMPLES
 # * RIO::Rio
 #
-# <b>Rio is pre-alpha software. 
-# The documented interface and behavior is subject to change without notice.</b>
 
 
 require 'rio/base'

data/lib/rio/if.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================== 
-# Copyright (c) 2005, 2006 Christopher Kleckner
+# Copyright (c) 2005,2006,2007 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -23,16 +23,15 @@
 #
 # To create the documentation for Rio run the command
 #  ruby build_doc.rb
-# from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
+# from the distribution directory.
 #
 # Suggested Reading
 # * RIO::Doc::SYNOPSIS
 # * RIO::Doc::INTRO
 # * RIO::Doc::HOWTO
+# * RIO::Doc::EXAMPLES
 # * RIO::Rio
 #
-# <b>Rio is pre-alpha software. 
-# The documented interface and behavior is subject to change without notice.</b>
 
 
 module RIO
@@ -46,15 +45,20 @@ end
 
 require 'rio/if/internal'
 require 'rio/if/basic'
-require 'rio/if/grande'
-require 'rio/if/grande_entry'
-require 'rio/if/grande_stream'
 
-require 'rio/if/test'
-require 'rio/if/path'
-require 'rio/if/fileordir'
-require 'rio/if/file'
-require 'rio/if/dir'
-require 'rio/if/stream'
-require 'rio/if/temp'
-require 'rio/if/string'
+module RIO
+  class Rio
+    require 'rio/if/grande'
+    require 'rio/if/grande_entry'
+    require 'rio/if/grande_stream'
+    
+    require 'rio/if/test'
+    require 'rio/if/path'
+    require 'rio/if/fileordir'
+    require 'rio/if/file'
+    require 'rio/if/dir'
+    require 'rio/if/rubyio'
+    require 'rio/if/temp'
+    require 'rio/if/string'
+  end
+end

data/lib/rio/if/basic.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================== 
-# Copyright (c) 2005, 2006 Christopher Kleckner
+# Copyright (c) 2005,2006,2007 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -23,16 +23,15 @@
 #
 # To create the documentation for Rio run the command
 #  ruby build_doc.rb
-# from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
+# from the distribution directory.
 #
 # Suggested Reading
 # * RIO::Doc::SYNOPSIS
 # * RIO::Doc::INTRO
 # * RIO::Doc::HOWTO
+# * RIO::Doc::EXAMPLES
 # * RIO::Rio
 #
-# <b>Rio is pre-alpha software. 
-# The documented interface and behavior is subject to change without notice.</b>
 
 
 module RIO
@@ -42,10 +41,11 @@ module RIO
     
     # Returns the length of the Rio's String representation
     # 
-    # To get the size of the underlying file system object use Rio#size
+    # To get the size of the underlying file system object use RIO::IF::Test#size
     def length() target.length end
 
-    # Equality - calls to_s on the other object and compares it with the value returned by Rio#to_s
+    # Equality - calls to_s on _other_ and compares its return value 
+    # with the value returned by Rio#to_s
     def ==(other) target == other end
 
     # Equality (for case statements) same as Rio#==
@@ -57,7 +57,7 @@ module RIO
     # Returns true if their String representations are eql?
     def eql?(other) target.eql?(other) end
 
-    # Match - invokes other.=~, passing the value returned by Rio#to_str
+    # Match - invokes _other_.=~, passing the value returned by Rio#to_str
     def =~(other) target =~ other end
       
   end

data/lib/rio/if/csv.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================== 
-# Copyright (c) 2005, 2006 Christopher Kleckner
+# Copyright (c) 2005,2006,2007 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -23,16 +23,15 @@
 #
 # To create the documentation for Rio run the command
 #  ruby build_doc.rb
-# from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
+# from the distribution directory.
 #
 # Suggested Reading
 # * RIO::Doc::SYNOPSIS
 # * RIO::Doc::INTRO
 # * RIO::Doc::HOWTO
+# * RIO::Doc::EXAMPLES
 # * RIO::Rio
 #
-# <b>Rio is pre-alpha software. 
-# The documented interface and behavior is subject to change without notice.</b>
 
 
 module RIO
@@ -42,9 +41,9 @@ module RIO
       #def dir() target.dir end
       
       # Puts a Rio in CSV mode and sets the field and record separators.
-      # In csv mode selecting with Rio#records will cause each line
+      # In csv mode selecting with IF::GrandeStream#records will cause each line
       # read to be parsed into a line with the CSV standard library.
-      # Specifying using Rio#lines to select will return unparsed strings
+      # Specifying using IF::GrandeStream#lines to select will return unparsed strings
       # as normal.
       #
       #  # copy a csv file, changing the field separator

data/lib/rio/if/dir.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================== 
-# Copyright (c) 2005, 2006 Christopher Kleckner
+# Copyright (c) 2005,2006,2007 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -23,129 +23,135 @@
 #
 # To create the documentation for Rio run the command
 #  ruby build_doc.rb
-# from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
+# from the distribution directory.
 #
 # Suggested Reading
 # * RIO::Doc::SYNOPSIS
 # * RIO::Doc::INTRO
 # * RIO::Doc::HOWTO
+# * RIO::Doc::EXAMPLES
 # * RIO::Rio
 #
-# <b>Rio is pre-alpha software. 
-# The documented interface and behavior is subject to change without notice.</b>
 
 
 module RIO
-  class Rio
-    # Calls Dir#chdir.
-    #
-    # Changes the current working directory of the process to the directory specified by the Rio. 
-    # Raises a SystemCallError (probably Errno::ENOENT) if the target directory does not exist or 
-    # if the Rio does not reference a directory.
-    #
-    # If a block is given changes to the directory specified by the rio for the length of the block
-    # and changes back outside the block
-    #
-    # Returns the Rio
-    #
-    #  rio('/home').chdir  # change the current working directory to /home
-    #  # the working directory here is /home
-    #  rio('/tmp/data/mydata').delete!.mkpath.chdir {
-    #     # the working directory here is /tmp/data/mydata
-    #  }
-    #  # the working directory here is /home
-    #
-    def chdir(&block) target.chdir(&block);self end
-
-
-
-    # Calls Find#find
-    #
-    # Uses Find#find to find all entries recursively for a Rio that 
-    # specifies a directory. Note that there are other ways to recurse through
-    # a directory structure using a Rio. See Rio#each and Rio#all.
-    #
-    # Calls the block passing a Rio for each entry found. The Rio inherits
-    # file attrubutes from the directory Rio.
-    #
-    # Returns itself
-    #
-    #  rio('adir').find { |entrio| puts "#{entrio}: #{entrio.file?}" }
-    #
-    #  rio('adir').chomp.find do |entrio|
-    #    next unless entrio.file?
-    #    lines = entrio[0..10]  # lines are chomped because 'chomp' was inherited
-    #  end
-    #
-    def find(*args,&block) target.find_entries(*args,&block); self end
-
-
-    # Calls Dir#glob
-    #
-    # Returns the filenames found by expanding the pattern given in string, 
-    # either as an array or as parameters to the block. In both cases the filenames
-    # are expressed as a Rio.
-    # Note that this pattern is not a regexp (it�s closer to a shell glob). 
-    # See File::fnmatch for details of file name matching and the meaning of the flags parameter.
-    #
-    #
-    def glob(string,*args,&block) target.glob(string,*args,&block) end
-
-
-    # Calls Dir#rmdir
-    #
-    # Deletes the directory referenced by the Rio. 
-    # Raises a subclass of SystemCallError if the directory isn�t empty.
-    # Returns the Rio. If the directory does not exist, just returns the Rio.
-    #
-    # See also Rio#rmtree, Rio#delete, Rio#delete!
-    #
-    #    rio('adir').rmdir # remove the empty directory 'adir'
-    #
-    def rmdir() target.rmdir(); self end
-
-
-    # Calls FileUtils#rmtree
-    #
-    # Removes a directory Rio recursively. Returns the Rio. 
-    # If the directory does not exist, simply returns the Rio
-    #
-    # If called with a block, behaves as if <tt>rmtree.each(&block)</tt> had been called
-    # 
-    # See also Rio#delete!
-    #
-    #  rio('adir').rmtree # removes the directory 'adir' recursively
-    #
-    #  # delete the directory 'adir', recreate it and then change to the new directory
-    #  rio('adir/asubdir').rmtree.mkpath.chdir {
-    #    ...
-    #  }
-    #
-    # 
-    def rmtree() target.rmtree(); self end
-
-    # Calls FileUtils#mkpath
-    #
-    # Makes a new directory named by the Rio and any directories in its path that do not exist.
-    # 
-    # Returns the Rio. If the directory already exists, just returns the Rio.
-    #
-    #  rio('adir/a/b').mkpath
-    def mkpath(&block) target.mkpath(&block); self end
-
-    
-    # Calls FileUtils#mkdir
-    #
-    # Makes a new directory named by the Rio with permissions specified by the optional parameter. 
-    # The permissions may be modified by the value of File::umask
-    #
-    # Returns the Rio. If the directory already exists, just returns the Rio.
-    #
-    #  rio('adir').mkdir
-    def mkdir(*args,&block) target.mkdir(*args,&block); self end
-
-
-
+  module IF
+    module Dir
+      # Calls ::Dir#chdir.
+      #
+      # Changes the current working directory of the process to the directory specified by the Rio. 
+      # Raises a SystemCallError (probably Errno::ENOENT) if the target directory does not exist or 
+      # if the Rio does not reference a directory.
+      #
+      # If a block is given changes to the directory specified by the rio for the length of the block
+      # and changes back outside the block
+      #
+      # Returns the Rio
+      #
+      #  rio('/home').chdir  # change the current working directory to /home
+      #  # the working directory here is /home
+      #  rio('/tmp/data/mydata').delete!.mkpath.chdir {
+      #     # the working directory here is /tmp/data/mydata
+      #  }
+      #  # the working directory here is /home
+      #
+      def chdir(&block) target.chdir(&block);self end
+
+
+
+      # Calls Find#find
+      #
+      # Uses ::Find#find to find all entries recursively for a Rio that 
+      # specifies a directory. Note that there are other ways to recurse through
+      # a directory structure using a Rio. See IF::Grande#each and IF::GrandeEntry#all.
+      #
+      # Calls the block passing a Rio for each entry found. The Rio inherits
+      # file attrubutes from the directory Rio.
+      #
+      # Returns itself
+      #
+      #  rio('adir').find { |entrio| puts "#{entrio}: #{entrio.file?}" }
+      #
+      #  rio('adir').chomp.find do |entrio|
+      #    next unless entrio.file?
+      #    lines = entrio[0..10]  # lines are chomped because 'chomp' was inherited
+      #  end
+      #
+      def find(*args,&block) target.find_entries(*args,&block); self end
+
+
+      # Calls ::Dir#glob
+      #
+      # Returns the filenames found by expanding the pattern given in string, 
+      # either as an array or as parameters to the block. In both cases the filenames
+      # are expressed as a Rio.
+      # Note that this pattern is not a regexp (it�s closer to a shell glob). 
+      # See File::fnmatch for details of file name matching and the meaning of the flags parameter.
+      #
+      #
+      def glob(string,*args,&block) target.glob(string,*args,&block) end
+
+
+      # Calls ::Dir#rmdir
+      #
+      # Deletes the directory referenced by the Rio. 
+      # Raises a subclass of SystemCallError if the directory isn�t empty.
+      # Returns the Rio. If the directory does not exist, just returns the Rio.
+      #
+      # See also #rmtree, IF::Grande#delete, IF::Grande#delete!
+      #
+      #    rio('adir').rmdir # remove the empty directory 'adir'
+      #
+      def rmdir() target.rmdir(); self end
+
+
+      # Calls FileUtils#rmtree
+      #
+      # Removes a directory Rio recursively. Returns the Rio. 
+      # If the directory does not exist, simply returns the Rio
+      #
+      # If called with a block, behaves as if <tt>rmtree.each(&block)</tt> had been called
+      # 
+      # See also IF::Grande#delete!
+      #
+      #  rio('adir').rmtree # removes the directory 'adir' recursively
+      #
+      #  # delete the directory 'adir', recreate it and then change to the new directory
+      #  rio('adir/asubdir').rmtree.mkpath.chdir {
+      #    ...
+      #  }
+      #
+      # 
+      def rmtree() target.rmtree(); self end
+
+      # Calls FileUtils#mkpath
+      #
+      # Makes a new directory named by the Rio and any directories in its path that do not exist.
+      # 
+      # Returns the Rio. If the directory already exists, just returns the Rio.
+      #
+      #  rio('adir/a/b').mkpath
+      def mkpath(&block) target.mkpath(&block); self end
+
+      
+      # Calls FileUtils#mkdir
+      #
+      # Makes a new directory named by the Rio with permissions specified by the optional parameter. 
+      # The permissions may be modified by the value of File::umask
+      #
+      # Returns the Rio. If the directory already exists, just returns the Rio.
+      #
+      #  rio('adir').mkdir
+      def mkdir(*args,&block) target.mkdir(*args,&block); self end
+
+
+
+    end
   end
 end
 
+module RIO
+  class Rio
+    include RIO::IF::Dir
+  end
+end

data/lib/rio/if/file.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================== 
-# Copyright (c) 2005, 2006 Christopher Kleckner
+# Copyright (c) 2005,2006,2007 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -23,59 +23,67 @@
 #
 # To create the documentation for Rio run the command
 #  ruby build_doc.rb
-# from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
+# from the distribution directory.
 #
 # Suggested Reading
 # * RIO::Doc::SYNOPSIS
 # * RIO::Doc::INTRO
 # * RIO::Doc::HOWTO
+# * RIO::Doc::EXAMPLES
 # * RIO::Rio
 #
-# <b>Rio is pre-alpha software. 
-# The documented interface and behavior is subject to change without notice.</b>
 
 
 module RIO
-  class Rio
-    # Calls FileUtils#rm
-    #
-    # Deletes the referenced file, returning the Rio. Raises an exception on any error. 
-    #
-    # See also Rio#delete, Rio#delete!, Rio#rmdir.
-    def rm() target.rm(); self end
-    
-    
-    # Calls FileUtils#touch
-    #
-    # Updates modification time (mtime) and access time (atime) of a Rio.
-    # A file is created if it doesn't exist.
-    #
-    def touch() target.touch(); self end
-    
-    # Calls File#truncate
-    #
-    # Truncates a file referenced by a Rio to be at most +sz+ bytes long. 
-    # Not available on all platforms.
-    #
-    #  f = rio("out")
-    #  f.print!("1234567890")
-    #  f.size                     #=> 10
-    #  f.truncate(5)
-    #  f.size()                   #=> 5
-    #
-    # If called with no arguments, truncates the Rio at the
-    # value returned by Rio#pos().
-    #  f.read(2)
-    #  f.truncate.size            #=> 2
-    #  f.contents                 #=> "12"
-    #
-    # Returns the Rio
-    #
-    def truncate(sz=pos()) target.truncate(sz); self end
-    
-    # Calls Rio#truncate(0)
-    #
-    def clear() target.clear(); self end
+  module IF
+    module File
+      
+      # Calls FileUtils#rm
+      #
+      # Deletes the referenced file, returning the Rio. Raises an exception on any error. 
+      #
+      # See also IF::Grande#delete, IF::Grande#delete!, IF::Dir#rmdir.
+      def rm() target.rm(); self end
+      
+      
+      # Calls FileUtils#touch
+      #
+      # Updates modification time (mtime) and access time (atime) of a Rio.
+      # A file is created if it doesn't exist.
+      #
+      def touch() target.touch(); self end
+      
+      # Calls File#truncate
+      #
+      # Truncates a file referenced by a Rio to be at most +sz+ bytes long. 
+      # Not available on all platforms.
+      #
+      #  f = rio("out")
+      #  f.print!("1234567890")
+      #  f.size                     #=> 10
+      #  f.truncate(5)
+      #  f.size()                   #=> 5
+      #
+      # If called with no arguments, truncates the Rio at the
+      # value returned by IF::FileOrDir#pos().
+      #  f.read(2)
+      #  f.truncate.size            #=> 2
+      #  f.contents                 #=> "12"
+      #
+      # Returns the Rio
+      #
+      def truncate(sz=pos()) target.truncate(sz); self end
+      
+      # Calls IF::File#truncate(0)
+      #
+      def clear() target.clear(); self end
+
+    end
+  end
+end
 
+module RIO
+  class Rio
+    include RIO::IF::File
   end
 end