rio 0.3.7 → 0.3.8

data/lib/rio/ftp/ftpfile.rb

@@ -0,0 +1,20 @@
+
+require 'tempfile'
+require 'delegate'
+module RIO
+  module FTP
+    class FTPFile < DelegateClass( ::Tempfile )
+      def initialize(remote_path, netftp)
+        @remote_path = remote_path
+        @netftp = netftp
+        @ftpfile = ::Tempfile.new('ftpfile')
+        super(@ftpfile)
+      end
+      def close()
+        super
+        @netftp.put(path(),@remote_path)
+      end
+      
+    end
+  end
+end

data/lib/rio/grande.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================== 
-# Copyright (c) 2005, Christopher Kleckner
+# Copyright (c) 2005, 2006 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -22,7 +22,7 @@
 #++
 #
 # To create the documentation for Rio run the command
-#  rake rdoc
+#  ruby build_doc.rb
 # from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
 #
 # Suggested Reading

data/lib/rio/handle.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================== 
-# Copyright (c) 2005, Christopher Kleckner
+# Copyright (c) 2005, 2006 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -22,7 +22,7 @@
 #++
 #
 # To create the documentation for Rio run the command
-#  rake rdoc
+#  ruby build_doc.rb
 # from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
 #
 # Suggested Reading

data/lib/rio/if/basic.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================== 
-# Copyright (c) 2005, Christopher Kleckner
+# Copyright (c) 2005, 2006 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -22,7 +22,7 @@
 #++
 #
 # To create the documentation for Rio run the command
-#  rake rdoc
+#  ruby build_doc.rb
 # from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
 #
 # Suggested Reading

data/lib/rio/if/csv.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================== 
-# Copyright (c) 2005, Christopher Kleckner
+# Copyright (c) 2005, 2006 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -22,7 +22,7 @@
 #++
 #
 # To create the documentation for Rio run the command
-#  rake rdoc
+#  ruby build_doc.rb
 # from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
 #
 # Suggested Reading

data/lib/rio/if/dir.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================== 
-# Copyright (c) 2005, Christopher Kleckner
+# Copyright (c) 2005, 2006 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -22,7 +22,7 @@
 #++
 #
 # To create the documentation for Rio run the command
-#  rake rdoc
+#  ruby build_doc.rb
 # from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
 #
 # Suggested Reading

data/lib/rio/if/file.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================== 
-# Copyright (c) 2005, Christopher Kleckner
+# Copyright (c) 2005, 2006 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -22,7 +22,7 @@
 #++
 #
 # To create the documentation for Rio run the command
-#  rake rdoc
+#  ruby build_doc.rb
 # from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
 #
 # Suggested Reading
@@ -52,6 +52,30 @@ module RIO
     #
     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
+
   end
 end

data/lib/rio/if/fileordir.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================== 
-# Copyright (c) 2005, Christopher Kleckner
+# Copyright (c) 2005, 2006 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -22,7 +22,7 @@
 #++
 #
 # To create the documentation for Rio run the command
-#  rake rdoc
+#  ruby build_doc.rb
 # from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
 #
 # Suggested Reading
@@ -40,16 +40,6 @@ module 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.
@@ -123,10 +113,10 @@ module RIO
     def rename!(*args,&block) target.rename!(*args,&block); self end
     
 
-    # For directories proxies Dir#read, otherwise proxies IO#read
+    # For directories calls Dir#read, otherwise calls IO#read
     #
-    # Proxy for IO#read
-    #      ario.read([integer [, buffer]])    => string, buffer, or nil
+    # For streams calls IO#read
+    #  ario.read([integer [, buffer]])    => string, buffer, or nil
     # Reads at most _integer_ bytes from the I/O stream, or to the end of
     # file if _integer_ is omitted or is +nil+. If the optional _buffer_
     # argument is present, it must reference a String, which will receive
@@ -137,15 +127,15 @@ module RIO
     #
     #  rio("testfile").read(16) #=> "This is line one"
     #
-    # Proxy for Dir#read
-    #     dir.read => ario or nil
+    # For directories calls Dir#read
+    #  dir.read => ario or nil
     #------------------------------------------------------------------------
-    #     Reads the next entry from _dir_ and returns it as a Rio. Returns
-    #     +nil+ at the end of the stream.
-    #        d = rio("testdir")
-    #        d.read   #=> rio(".")
-    #        d.read   #=> rio("..")
-    #        d.read   #=> rio("config.h")
+    # Reads the next entry from _dir_ and returns it as a Rio. Returns
+    # +nil+ at the end of the stream.
+    #  d = rio("testdir")
+    #  d.read   #=> rio(".")
+    #  d.read   #=> rio("..")
+    #  d.read   #=> rio("config.h")
     #
     def read(*args) target.read(*args)end
     
@@ -166,18 +156,18 @@ module RIO
     #  f.rewind.readline #=> "This is line one\n"
     #
     # Proxy for Dir#rewind
-    #     ario.rewind => ario
+    #  ario.rewind => ario
     #------------------------------------------------------------------------
-    #     Repositions _ario_ to the first entry.
+    # Repositions _ario_ to the first entry.
     #
-    #        d = rio("testdir")
-    #        d.read          #=> rio(".")
-    #        d.rewind.read   #=> rio(".")
+    #  d = rio("testdir")
+    #  d.read          #=> rio(".")
+    #  d.rewind.read   #=> rio(".")
     def rewind(&block) target.rewind(&block); self end
 
-    # For directories proxies Dir#seek, otherwise proxies IO#seek
+    # For directories calls Dir#seek, otherwise calls IO#seek
     #
-    # Proxy for IO#seek
+    # For streams calls IO#seek
     #      ario.seek(amount, whence=SEEK_SET) -> ario
     # Seeks to a given offset _amount_ in the stream according to the
     # value of _whence_:
@@ -194,25 +184,25 @@ module RIO
     #  f = rio("testfile")
     #  f.seek(-28, IO::SEEK_END).readline                  #=> "happily ever after. The End\n"
     #
-    # Proxy for Dir#seek
+    # For directories calls Dir#seek
     #     ario.seek( integer ) => ario
     # Seeks to a particular location in _ario_. _integer_ must be a value
-    # returned by +Dir#tell+ or Rio#tell.
-    #
-    #        d = rio("testdir")       #=> #<RIO::Rio:0x401b3c40>
-    #        d.read                   #=> rio(".")
-    #        i = d.tell               #=> 12
-    #        d.read                   #=> rio("..")
-    #        d.seek(i)                #=> #<RIO::Rio:0x401b3c40>
-    #        d.read                   #=> rio("..")
+    # returned by Rio#tell.
+    #
+    #  d = rio("testdir")       #=> #<RIO::Rio:0x401b3c40>
+    #  d.read                   #=> rio(".")
+    #  i = d.tell               #=> 12
+    #  d.read                   #=> rio("..")
+    #  d.seek(i)                #=> #<RIO::Rio:0x401b3c40>
+    #  d.read                   #=> rio("..")
     def seek(*args) target.seek(*args); self end
     #def seek(amount,whence=IO::SEEK_SET) target.seek(amount,whence) end
 
 
 
-    # For directories proxies Dir#pos, otherwise proxies IO#pos
+    # For directories calls Dir#pos, otherwise calls IO#pos
     #
-    # Proxy for IO#pos
+    # For streams calls IO#pos
     #      ario.pos     => integer
     #      ario.tell    => integer
     # Returns the current offset (in bytes) of _ario_.
@@ -223,24 +213,24 @@ module RIO
     #  f.pos    #=> 17
     #
     #
-    # Proxy for Dir#pos
+    # For directories calls Dir#pos
     #     ario.pos => integer
     #     ario.tell => integer
     # Returns the current position in _dir_. See also +Rio#seek+.
     #
-    #        d = rio("testdir")
-    #        d.pos   #=> 0
-    #        d.read  #=> rio(".")
-    #        d.pos   #=> 12
+    #     d = rio("testdir")
+    #     d.pos   #=> 0
+    #     d.read  #=> rio(".")
+    #     d.pos   #=> 12
     #
     def pos() target.pos end
 
     # See Rio#pos
     def tell() target.tell end
 
-    # For directories proxies Dir#pos=, otherwise proxies IO#pos=
+    # For directories calls Dir#pos=, otherwise calls IO#pos=
     #
-    # Proxy for IO#pos=
+    # For streams calls IO#pos=
     #      ario.pos = integer    => 0
     # Seeks to the given position (in bytes) in _ario_.
     #
@@ -248,7 +238,7 @@ module RIO
     #  f.pos = 17
     #  f.gets   #=> "This is line two\n"
     #
-    # Proxy for Dir#pos=
+    # For directories calls Dir#pos=
     #     ario.pos = integer     => integer
     #------------------------------------------------------------------------
     # Synonym for +Rio#seek+, but returns the position parameter.
@@ -261,6 +251,11 @@ module RIO
     #        d.read                   #=> rio("..")
     #
     def pos=(integer) target.pos = integer end
+
+    # For Streams calls IO#reopen, otherwise closes and re-opens 
+    # the Rio.
+    #
+    def reopen(mode=nil) target.reopen(mode); self end
   end
 end
 

data/lib/rio/if/grande.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================== 
-# Copyright (c) 2005, Christopher Kleckner
+# Copyright (c) 2005, 2006 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -22,7 +22,7 @@
 #++
 #
 # To create the documentation for Rio run the command
-#  rake rdoc
+#  ruby build_doc.rb
 # from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
 #
 # Suggested Reading
@@ -34,7 +34,7 @@
 # <b>Rio is pre-alpha software. 
 # The documented interface and behavior is subject to change without notice.</b>
 
-
+require 'rio/no_warn'
 module RIO
   class Rio
 #  module IF
@@ -87,9 +87,11 @@ module RIO
     # range::   specifies a range of records to be selected (zero based)
     # regexp::  matching records will be selected.
     # 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
+    # symbol::  the symbol is sent to each record. Record is selected 
+    #           unless false is returned
+    # proc::    the proc is called with the record 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_)
@@ -401,7 +403,12 @@ module RIO
     # file on a web site into a local gzipped csv file that uses semi-colons as separators
     #  rio('http://domain/file.csv.gz').columns(0,7..9).gzip.csv[0..9] > rio('localfile.csv.gz').csv(';').gzip
     #
-    def >(destination) target > destination; self end
+    def >(destination) 
+      RIO::no_warn {
+        target > destination;
+      } 
+      self 
+    end
 
     # Alias for Rio#> (copy-to grande operator)
     def copy_to(destination) target.copy_to(destination); self end
@@ -468,8 +475,7 @@ module RIO
     #  rio('afile') >> rio('anotherfile') # append the contents of 'afile' to 'anotherfile'
     #  rio('afile') >> rio('adir') # copies 'afile' to the directory 'adir'
     #  rio('adir') >> rio('anotherdir') # copy directory 'adir' recursively to 'anotherdir' 
-    #  rio('adir') >> array # appendscopy directory 'adir' recursively to 'anotherdir' 
-    #  rio('adir') >> ary # a Rio for each entry in the directory will be appended to ary
+    #  rio('adir') >> array # a Rio for each entry in the directory will be appended to ary
     def >>(destination) target >> destination; self end
 
     
@@ -577,7 +583,12 @@ module RIO
     #  
     # See also Rio#> (copy-to), Rio#each, Rio#[]
     #
-    def <(source) target < source; self end
+    def <(source) 
+      RIO::no_warn {
+        target < source
+      }
+      self 
+    end
 
     # Alias for Rio#< (copy-from grande operator)
     def copy_from(source) target.copy_from(source); self end
@@ -658,5 +669,16 @@ module RIO
     # Rio#skipdirs, and Rio#skipentries.
     #
     def skip(*args,&block) target.skip(*args,&block); self end 
+
+
+    # Returns true if the referenced file or directory is empty after honoring the grande 
+    # selection methods. 
+    #
+    #  rio('f0').delete!.touch.empty?        #=> true
+    #  rio('f1').puts!("Not Empty\n").empty? #=> false
+    #  rio('d0').delete!.mkdir.empty?        #=> true
+    #
+    def empty?() target.empty? end
+
   end
 end

data/lib/rio/if/grande_entry.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================== 
-# Copyright (c) 2005, Christopher Kleckner
+# Copyright (c) 2005, 2006 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -22,7 +22,7 @@
 #++
 #
 # To create the documentation for Rio run the command
-#  rake rdoc
+#  ruby build_doc.rb
 # from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
 #
 # Suggested Reading
@@ -43,12 +43,14 @@ module RIO
     #  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
+    # Fixnum:: matched against the "depth" of the directory
     #
     # If a block is given, behaves like <tt>ario.dirs(*args).each(&block)</tt>
     #
@@ -252,10 +254,14 @@ module RIO
     # is a shortcut for
     #  rio('adir').files('*.rb').to_a
     #
+    # and
+    #
     #  rio('adir')['*.rb']
     # is a shortcut for
     #  rio('adir').entries('*.rb').to_a
     #
+    # and
+    #
     #  rio('afile').lines[0..10]
     # is a shortcut for
     #  rio('afile').lines(0..10).to_a
@@ -328,6 +334,8 @@ module RIO
     # 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
+    # Fixnum::  recurse into directories only at the given depth
+    # Range::   recurse into directories at a range of depths
     #
     # If a block is given, behaves like <tt>ario.recurse(*args).each(&block)</tt>
     #
@@ -347,6 +355,8 @@ module RIO
     #
     #  rio('adir').norecurse('.svn') { |drio| ... } # recurse, skipping subversion directories
     #
+    #  rio('adir').norecurse(3) {|drio| ... } # only recurse 2 levels deep into a directory structure
+    #
     def norecurse(*args,&block) target.norecurse(*args,&block); self end
 
 

data/lib/rio/if/grande_stream.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================== 
-# Copyright (c) 2005, Christopher Kleckner
+# Copyright (c) 2005, 2006 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -22,7 +22,7 @@
 #++
 #
 # To create the documentation for Rio run the command
-#  rake rdoc
+#  ruby build_doc.rb
 # from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
 #
 # Suggested Reading
@@ -40,7 +40,7 @@ module RIO
 
     # Sets the rio to read lines and returns the Rio
     # 
-    # If called with a block behaves as if lines(*args).each(&block) had been called
+    # If called with a block behaves as if <tt>lines(*args).each(&block)</tt> had been called
     # 
     # +lines+ returns the Rio which called it. This might seem counter-intuitive at first. 
     # One might reasonably assume that
@@ -231,6 +231,16 @@ module RIO
     # to 'a','a+','w','w+','r' and 'r+' respectively. 
     def a() target.a(); self end
 
+    # Unary Plus. Alternate form of Rio#a
+    #  rio('f1') > rio('f2')     # copy f1 to f2
+    #  rio('f1') > rio('f2').a   # append f1 to f2
+    #  rio('f1') > +rio('f2')    # same thing
+    #  rio('f1') >> rio('f2')    # same thing
+    # 
+    def +@()
+      RIO::no_warn { +target }
+      self
+    end
 
     # Sets the implicit output mode to 'a+'. 
     # 
@@ -298,7 +308,7 @@ module RIO
     #  ario.closeoneof(&block) => ario
     #
     # +closeoneof+ causes a Rio to be closed automatically whenever the end of
-    # file is reached. This is handled at the IO level, and thus affects
+    # file is reached. This affects
     # all methods that read from a rio (Rio#readlines, Rio#to_a, Rio#each Rio#gets etc.)
     # Because +closeoneof+ must be on for many of Rio's most useful idioms,
     # it is on by default. +closeoneof+ can be turned off using Rio#nocloseoneof.
@@ -421,8 +431,8 @@ module RIO
     #
     #  rio('afile') < a_string # put a string into a file
     #  rio('afile') < an_array # put an array into a file
-    #  rio('afile') < rio('anotherfile').lines(1..10) # copy the first 10 lines of anotherfile into afile
-    #  rio('afile.gz').gzip < rio('anotherfile').lines(1..10) # same thing into a gzipped file
+    #  rio('afile') < rio('anotherfile').lines(0..9) # copy the first 10 lines of anotherfile into afile
+    #  rio('afile.gz').gzip < rio('anotherfile').lines(0..9) # same thing into a gzipped file
     #
     # In each of these cases, 'afile' would remain open after the copy and furthermore
     # since the destination Rio was not saved in a variable, There is no way to close file.
@@ -450,9 +460,7 @@ module RIO
     #
     # In perl the rio's destructor would be called, because there are no remaining references to the Rio
     # However, it my understanding and experience that in Ruby the finalizer will not necessarily be 
-    # called at this point. Calling all gurus: If I am missing something, 
-    # and there is a way to make this work without closeoncopy,
-    # please contact the author.
+    # called at this point. 
     #
     def closeoncopy(arg=true,&block) target.closeoncopy(arg,&block); self end
 
@@ -475,25 +483,6 @@ module RIO
     def closeoncopy?() target.closeoncopy?() end
 
 
-    # Rio#autorewind?
-    #
-    #
-    #def autorewind?() target.autorewind?() end
-
-
-    # Sets a Rio to 'autorewind'.
-    # autorewind is not a well thought out concept and probably will be
-    # removed. Do not use it.
-    #
-    def autorewind(*args,&block) target.autorewind(*args,&block); self end
-
-
-    # Rio#noautorewind
-    #
-    #
-    #def noautorewind(arg=false,&block) target.noautorewind(arg,&block); self end
-
-
     # Queries the Rio's chomp-mode.
     # See Rio#chomp.
     #

data/lib/rio/if/internal.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================== 
-# Copyright (c) 2005, Christopher Kleckner
+# Copyright (c) 2005, 2006 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -22,7 +22,7 @@
 #++
 #
 # To create the documentation for Rio run the command
-#  rake rdoc
+#  ruby build_doc.rb
 # from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
 #
 # Suggested Reading

data/lib/rio/if/path.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================== 
-# Copyright (c) 2005, Christopher Kleckner
+# Copyright (c) 2005, 2006 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -22,7 +22,7 @@
 #++
 #
 # To create the documentation for Rio run the command
-#  rake rdoc
+#  ruby build_doc.rb
 # from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
 #
 # Suggested Reading
@@ -67,11 +67,11 @@ module RIO
 
     # Returns the path for the Rio on the underlying file system
     # Returns nil if the Rio is not on the filesystem (i.e. stdin: or http: Rios)
-    def fspath(*args) target.fspath(*args) end
+    def fspath() target.fspath() end
 
     # Returns the path portion of the URL representation of the rio 
     # Returns nil if the Rio URL has no path (i.e. stdin: or http: Rios)
-    def urlpath(*args) target.urlpath(*args) end
+    def urlpath() target.urlpath() end
 
     # Proxy for File#expand_path
     #
@@ -417,8 +417,9 @@ module RIO
 
     # Calls URI#merge
     # 
-    # Merges two Rios. URI#merge does not document exactly what merging to URIs means. This appears to
-    # join the the paths with like <tt>other + path</tt>. See URI#merge for less information.
+    # Merges two Rios. URI#merge does not document exactly what merging two URIs means. 
+    # This appears to join the paths like <tt>other + path</tt>. 
+    # See URI#merge for less information.
     #
     def merge(other) target.merge(other)  end