rio 0.3.3 → 0.3.4

data/lib/rio/if.rb

@@ -42,8 +42,9 @@ end
 
 require 'rio/if/internal'
 require 'rio/if/basic'
-require 'rio/if/methods'
 require 'rio/if/grande'
+require 'rio/if/grande_entry'
+require 'rio/if/grande_stream'
 
 require 'rio/if/test'
 require 'rio/if/path'

data/lib/rio/if/basic.rb

@@ -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_s
+    # Match - invokes other.=~, passing the value returned by Rio#to_str
     def =~(other) target =~ other end
       
   end

data/lib/rio/if/csv.rb

@@ -60,7 +60,7 @@ module RIO
     #  rio("afile.csv").csv.nocolumns(2,3..5) { |array_of_fields| ... }
     #
     #  # an array containg all but the first line returning columns 5,6 and 7
-    #  rio("afile.csv").csv.columns(5..7).nolines[0]
+    #  rio("afile.csv").csv.columns(5..7).skiplines[0]
     #
     # See RIO::Doc::INTRO for complete documentation on csv mode.
     def csv(field_separator=',',record_separator=nil,&block) 

data/lib/rio/if/dir.rb

@@ -59,225 +59,6 @@ module RIO
 
 
 
-    # Grande Directory Selection Method 
-    #
-    # Sets the rio to return directories. _args_ can be used to select which directories are returned.
-    #  ario.files(*args) do |f|
-    #    f.directory?      #=> true
-    #  end
-    # No aguments selects all directories.
-    # if _args_ are:
-    # Regexp:: selects matching directories
-    # glob::   selects matching directories
-    # Proc::   called for each directory. the directory is processed unless the proc returns false
-    # Symbol:: sent to each directory. Each directory is processed unless the symbol returns false
-    #
-    # If a block is given, behaves like <tt>ario.dirs(*args).each(&block)</tt>
-    #
-    # See also Rio#files, Rio#entries, Rio#nodirs
-    #
-    #  rio('adir').dirs { |frio| ... } # process all directories in 'adir'    
-    #  rio('adir').all.dirs { |frio| ... } #  same thing recursively
-    #  rio('adir').dirs(/^\./) { |frio| ...} # process dot directories
-    #  rio('adir').dirs[/^\./] # return an array of dot directories
-    #  rio('adir').dirs[:symlink?] # an array of symlinks to directories
-    #
-    def dirs(*args,&block) target.dirs(*args,&block); self end
-    
-    # Grande Directory Exclude Method 
-    #
-    # If no args are provided selects anything but directories.
-    #  ario.nodirs do |el|
-    #    el.directory?     #=> false
-    #  end
-    # If args are provided, sets the rio to select directories as with Rio#dirs, but the arguments are
-    # used to determine which directories will *not* be processed
-    #
-    # If a block is given behaves like 
-    #  ario.nodirs(*args).each(&block)
-    #
-    # See Rio#dirs
-    #
-    #  rio('adir').nodirs { |ent| ... } # iterate through everything except directories
-    #  rio('adir').nodirs(/^\./) { |drio| ... } # iterate through directories, skipping dot directories
-    # 
-    #
-    def nodirs(*args,&block) target.nodirs(*args,&block); self end
-
-
-    # Grande Directory Entry Selection Method 
-    #
-    # No aguments selects all entries.
-    #
-    # if +args+ are:
-    # Regexp:: selects matching entries
-    # glob::   selects matching entries
-    # Proc::   called for each entry. the entry is processed unless the proc returns false
-    # Symbol:: sent to each entry. Each entry is processed unless the symbol returns false
-    #
-    # If a block is given, behaves like <tt>ario.etries(*args).each(&block)</tt>
-    #
-    # See also Rio#files, Rio#dirs, Rio#noentries
-    #
-    #  rio('adir').entries { |frio| ... } # process all entries in 'adir'    
-    #  rio('adir').all.entries { |frio| ... } #  same thing recursively
-    #  rio('adir').entries(/^\./) { |frio| ...} # process entries starting with a dot
-    #  rio('adir').entries[/^\./] # return an array of all entries starting with a dot
-    #  rio('adir').entries[:symlink?] # an array of symlinks in 'adir'
-    #
-    def entries(*args,&block) target.entries(*args,&block); self end
-
-    # Grande Directory Entry Rejection Method 
-    #
-    # No aguments rejects all entries.
-    #
-    # Behaves like Rio#entries, except that matching entries are excluded.
-    #
-    def noentries(*args,&block) target.noentries(*args,&block); self end
-
-    
-    # Grande File Selection Method 
-    #
-    # Sets the rio to return files. +args+ can be used to select which files are returned.
-    #  ario.files(*args) do |f|
-    #    f.file?      #=> true
-    #  end
-    # No aguments selects all files.
-    #
-    # +args+ may be one or more of the following:
-    # Regexp:: selects matching files
-    # String:: treated as a glob, and selects matching files
-    # Proc::   called for each file. the file is processed unless the proc returns false
-    # Symbol:: sent to each file. Each file is processed unless the symbol returns false
-    #
-    # If a block is given, behaves like <tt>ario.files(*args).each</tt>
-    #
-    # See also Rio#dirs, Rio#entries, Rio#nofiles
-    #
-    #  rio('adir').files { |frio| ... } # process all files in 'adir'    
-    #  rio('adir').all.files { |frio| ... } #  same thing recursively
-    #  rio('adir').files('*.rb') { |frio| ...} # process .rb files
-    #  rio('adir').files['*.rb'] # return an array of .rb files
-    #  rio('adir').files[/\.rb$/] # same thing using a regular expression
-    #  rio('adir').files[:symlink?] # an array of symlinks to files
-    #
-    # For Rios that refer to files, <tt>files(*args)</tt> causes the file to be processed only if 
-    # it meets the criteria specified by the args.
-    #
-    #  rio('afile.z').files['*.z'] #=> [rio('afile.z')]
-    #  rio('afile.q').files['*.z'] #=> []
-    #
-    # Example
-    #
-    # Problem:
-    #
-    # Need an array of all ruby programs in a directory and its subdirectories, skipping those in _subversion_ (.svn) 
-    # directories. For the purposes of this problem, a Ruby program is defined as a file ending with .rb or a file
-    # that is executable and whose shebang line contains 'ruby'
-    #
-    #  rio(path).norecurse('.svn').files['*.rb',proc{ |f| f.executable? and f.gets =~ /^#!.+ruby/ }]
-    #
-    # Explanation:
-    #
-    # Create a Rio for a directory
-    #  rio(path)
-    # Specify that '.svn' directories should not be included in recursion.
-    #  rio(path).norecurse('.svn')
-    # Select files
-    #  rio(path).norecurse('.svn').files
-    # Limit to files ending with '.rb'
-    #  rio(path).norecurse('.svn').files('*.rb')
-    # Also allow files that are both executable and whose first line is a shebang-ruby line
-    #  rio(path).norecurse('.svn').files('*.rb',proc{ |f| f.executable? and f.gets =~ /^#!.+ruby/ })
-    # Return an array rather than iterating thru them
-    #  rio(path).norecurse('.svn').files['*.rb',proc{ |f| f.executable? and f.gets =~ /^#!.+ruby/ }]
-    #
-    def files(*args,&block) target.files(*args,&block); self end
-
-    # Grande File Exclude Method 
-    #
-    # If no args are provided selects anything but files.
-    #  ario.nofiles do |el|
-    #    el.file?     #=> false
-    #  end
-    # If args are provided, sets the rio to select files as with Rio#files, but the arguments are
-    # used to determine which files will *not* be processed
-    #
-    # If a block is given behaves like <tt>ario.nofiles(*args).each(&block)</tt>
-    #
-    # See Rio#files
-    #
-    #  rio('adir').nofiles { |ent| ... } # iterate through everything except files
-    #  rio('adir').nofiles(*~) { |frio| ... } # iterate through files, skipping those ending with a tilde
-    # 
-    #
-    def nofiles(*args,&block) target.nofiles(*args,&block); self end
-
-
-    # Returns +true+ if the rio is in +all+ (recursive) mode. See Rio#all
-    #
-    #  adir = rio('adir').all.dirs
-    #  adir.all? # true
-    #  adir.each do |subdir|
-    #    subdir.all?  # true
-    #  end
-    #
-    #  rio('adir').all? # false
-    #  
-    def all?() target.all?() end
-
-
-    # Grande Directory Recursion Method
-    # 
-    # Sets the Rio to all mode (recursive)
-    # 
-    # When called with a block, behaves as if all.each(&block) had been called
-    # 
-    # +all+ causes subsequent calls to +files+ or +dirs+ to be applied recursively
-    # to subdirectories
-    #
-    #  rio('adir').all.files('*.[ch]').each { |file| ... } # process all c language source files in adir 
-    #                                                      # and all subdirectories of adir
-    #  rio('adir').all.files(/\.[ch]$/) { |file| ... }     # same as above
-    #  rio('adir').files("*.[ch]").all { |file| ... }      # once again
-    #  rio('adir').all.files["*.[ch]"]                     # same, but return an array instead of iterating
-    #  
-    def all(arg=true,&block) target.all(arg,&block); self end
-
-
-    # Grande Directory Recursion Selection Method
-    # 
-    # Sets the Rio to recurse into directories like Rio#all. If no args are provided behaves like Rio#all. 
-    # If args are provided, they are processed like Rio#dirs, to select which subdirectories should 
-    # be recursed into. Rio#recurse always implies Rio#all.
-    #
-    # +args+ may be one or more of:
-    # Regexp::  recurse into matching subdirectories
-    # glob::    recurse into matching subdirectories
-    # Proc::    called for each directory. The directory is recursed into unless the proc returns false
-    # Symbol::  sent to each directory. Each directory is recursed into unless the symbol returns false
-    #
-    # If a block is given, behaves like <tt>ario.recurse(*args).each(&block)</tt>
-    #
-    # See also Rio#norecurse, Rio#all, Rio#dirs
-    #
-    #  rio('adir').all.recurse('test*') { |drio| ... } # process all entries and all entries in subdirectories
-    #                                                  # starting with 'test' -- recursively
-    #
-    def recurse(*args,&block) target.recurse(*args,&block); self end
-
-
-    # Grande Directory Recursion Exclude Method
-    # 
-    # Sets the Rio to recurse into directories like Rio#all. If no args are provided, no
-    # directories will be recursed into. If args are provided, behaves like Rio#recurse, except
-    # that mathcing will *not* be recursed into
-    #
-    #  rio('adir').norecurse('.svn') { |drio| ... } # recurse, skipping subversion directories
-    #
-    def norecurse(*args,&block) target.norecurse(*args,&block); self end
-
-
     # Calls Find#find
     #
     # Uses Find#find to find all entries recursively for a Rio that 
@@ -329,7 +110,7 @@ module RIO
     # 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 rmtree.each(&block) had been called
+    # If called with a block, behaves as if <tt>rmtree.each(&block)</tt> had been called
     # 
     # See also Rio#delete!
     #

data/lib/rio/if/fileordir.rb

@@ -38,15 +38,28 @@
 module RIO
   class Rio
 
+    # undocumented
+    def open(m,*args,&block) target.open(m,*args,&block); self end
+#       if block_given?
+#         old_closeoncopy,old_closeoneof = closeoncopy?,closeoneof?
+#         begin
+#           return yield(nocloseoncopy.nocloseoneof)
+#         ensure
+#           reset.closeoncopy(old_closeoncopy).closeoneof(old_closeoneof)
+#         end
+#       end
+#       self 
+#     end
+
     # Creates a symbolic link _dest_ which points to the Rio's Rio#fspath.  
     # Raises a NotImplementedError exception on platforms that do not support symbolic links.
     # _dest_ may be a Rio, a String, or anything that will create an appropriate Rio 
-    # when passed to Rio#new 
+    # when passed to Rio#new .
     # If _dest_ already exists and is a directory, creates a symbolic link in the _dest_ directory,
-    # named with the name returned by Rio#filename
+    # named with the name returned by Rio#filename.
     # If _dest_ already exists and it is not a directory, raises Errno::EEXIST.
     # 
-    # Returns the Rio (not the symlink)
+    # Returns the Rio (not the symlink).
     #
     # Rio#symlink differs from File#symlink when the Rio or the _dest_ path has directory information.
     # In this case Rio#symlink creates a symlink that actually refers to the Rio's location 
@@ -78,17 +91,18 @@ module RIO
     #
     def readlink(*args) target.readlink(*args) end
 
-    # If called with an argument calls FileUtils#rename
-    # If called without an argument puts the Rio in a rename mode in
-    # which changes to the Rio's path affect a rename of the file
-    # on the file system.
-    # 
+    # If called with an argument calls FileUtils#rename.
+    # If called without an argument puts the Rio in "rename mode". 
     # Proxy for FileUtils#rename
     #  ario = rio('afile.cpp')
     #  ario.rename('afile.cxx') # renamed the file, but ario still references
     #                           # the old path
     # Rename Mode
     #
+    # In rename mode changes to a Rio's path with Rio#dirname=, Rio#filename=, 
+    # Rio#basename=, and Rio#extname= also cause the object on the filesystem
+    # to be renamed.
+    #
     # Change the extension of all'.cpp' files in 'adir' to '.cxx'
     #  rio('adir').rename.files('*.cpp') do |file|
     #    file.ext = '.cxx' # 'file' references the new path and the actual file is renamed
@@ -168,12 +182,12 @@ module RIO
     # Seeks to a given offset _amount_ in the stream according to the
     # value of _whence_:
     #
-    #  IO::SEEK_CUR  | Seeks to <em>amount</em> plus current position
+    #  IO::SEEK_CUR  | Seeks to 'amount' plus current position
     #  --------------+----------------------------------------------------
-    #  IO::SEEK_END  | Seeks to <em>amount</em> plus end of stream (you probably
-    #                | want a negative value for <em>amount</em>)
+    #  IO::SEEK_END  | Seeks to 'amount' plus end of stream (you probably
+    #                | want a negative value for 'amount')
     #  --------------+----------------------------------------------------
-    #  IO::SEEK_SET  | Seeks to the absolute location given by <em>amount</em>
+    #  IO::SEEK_SET  | Seeks to the absolute location given by 'amount'
     #
     # Example:
     #

data/lib/rio/if/grande.rb

@@ -77,8 +77,8 @@ module RIO
     # What constitutes an array element is determined by Rio#lines, Rio#bytes, 
     # or by an extension such as Rio#csv. Rio#lines is the default.
     # 
-    # Arguments may consist of zero or more integers, ranges, regular expressions, symbols
-    # and procs. 
+    # Arguments may consist of zero or more integers, ranges, regular expressions, symbols,
+    # procs, and arrays
     # An empty argument list selects all records
     #
     # Records are selected as follows.
@@ -87,6 +87,8 @@ module RIO
     # integer:: treated like a one element range
     # symbol::  the symbol is sent to the string. record is selected unless false is returned
     # proc::    the proc is called with the string as an argument. record is selected unless false is returned
+    # array::   the array may contain any of the other selector types. record is selected
+    #           unless any of the selectors returns false. (a logical and)
     # 
     # A record matching *any* of the selectors will be included in the array. (acts like an _or_)
     #
@@ -186,7 +188,7 @@ module RIO
     #  rio('adir').files['*.txt'] # array of all .txt files
     #
     #  rio('adir').dirs['CSV'] # array of all CSV directories
-    #  rio('adir').nodirs['CSV'] # array of all non-CSV directories
+    #  rio('adir').skipdirs['CSV'] # array of all non-CSV directories
     #
     def [](*selectors) target[*selectors] end
 
@@ -377,7 +379,7 @@ module RIO
     #  rio('afile').chomp.lines(0..9) > ary # same thing with lines chomped
     #  rio('afile').gzip.chomp.lines(0..9) > ary # same thing from a gzipped file
     #
-    #  rio('afile').nolines(0..9) > ary # ary will contain all but the first ten lines of the file
+    #  rio('afile').skiplines(0..9) > ary # ary will contain all but the first ten lines of the file
     #
     #  rio('adir') > ary # ary will contain a Rio for each entry in the directory
     #  rio('adir').files > ary # same, but only files
@@ -385,7 +387,7 @@ module RIO
     # 
     # Copying to a string
     #  rio('afile') > astring # slurp the entire contents of the file into astring
-    #  astring = rio('afile').slurp # same effect
+    #  astring = rio('afile').contents # same effect
     #
     # Copy the first line *and* every line containing the word Rio into a gzipped file
     #  rio('src').lines(1,/Rio/) > rio('dst.gz').gzip
@@ -400,7 +402,7 @@ module RIO
     def >(destination) target > destination; self end
 
     # Alias for Rio#> (copy-to grande operator)
-    def copy(destination) target.copy(destination); self end
+    def copy_to(destination) target.copy_to(destination); self end
 
     # Grande Append-To Operator
     # 
@@ -424,6 +426,10 @@ module RIO
     def >>(destination) target >> destination; self end
 
     
+    # Alias for Rio#>> (append-to grande operator)
+    def append_to(destination) target.append_to(destination); self end
+
+
     # Grande Append-From Operator
     # 
     # The append-from grande-operator copies a Rio from another Rio or another ruby object. This
@@ -438,6 +444,11 @@ module RIO
     # See Rio#< (copy-from)
     def <<(source) target << source; self end
 
+
+    # Alias for Rio#<< (append-from grande operator)
+    def append_from(source) target.append_from(source); self end
+
+
     # Grande Copy-From Operator
     # 
     # The copy-from grande-operator copies a Rio from another Rio or another ruby object. 
@@ -521,6 +532,10 @@ module RIO
     #
     def <(source) target < source; self end
 
+    # Alias for Rio#< (copy-from grande operator)
+    def copy_from(source) target.copy_from(source); self end
+
+
     # Reads and returns the next record from a Rio, honoring the grande selection methods. 
     #
     # Returns nil on end of file.
@@ -534,5 +549,39 @@ module RIO
     #  a_nil  = ario.getrec 
     def getrec() target.getrec() end
 
+    # Grande Exclude method
+    # 
+    # +skip+ can be used in two ways.
+    #
+    # If called with no arguments it reverses the polarity of the
+    # next non-skip grande selection method that is called. That is,
+    # it turns +lines+, +records+, +rows+, +files+, +dirs+ and +entries+
+    # into +skiplines+, +skiprecords+, +skiprows+, +skipfiles+, 
+    # +skipdirs+, and +skipentries+, respectively.
+    #
+    #  rio('afile').skip.lines(0..5) # same as rio('afile').skiplines(0..5)
+    #  rio('adir').skip.files('*~')  # same as rio('adir').skipfiles('*~')
+    #
+    # Note that it only affects the next selection method seen -- and may be
+    # used more than once. If no grande selection method is seen, +skip+ is
+    # ignored.
+    #
+    # When called with arguments it acts like Rio#skipentries for directory 
+    # Rios and like Rio#skiprecords for stream Rios.
+    #
+    #  rio('afile').lines(/Rio/).skip[0..4] # lines containg 'Rio' excluding the
+    #                                       # first five lines
+    #
+    #  rio('adir').files('*.rb').skip[:symlink?] # .rb files, but not symlinks to
+    #                                            # .rb files
+    #
+    # If a block is given, behaves as if <tt>skip(*args).each(&block)</tt> had been called.
+    #
+    # Returns the Rio.
+    #
+    # See Rio#skiplines, Rio#skiprecords, Rio#skiprows, Rio#skipfiles, 
+    # Rio#skipdirs, and Rio#skipentries.
+    #
+    def skip(*args,&block) target.skip(*args,&block); self end 
   end
 end