wishdev-rio 0.4.3.1

data/build_doc.rb

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby
+#--
+# =============================================================================== 
+# Copyright (c) 2005,2006,2007 Christopher Kleckner
+# All rights reserved
+#
+# This file is part of the Rio library for ruby.
+#
+# Rio is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# Rio is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Rio; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+# =============================================================================== 
+#
+# To create the documentation for Rio run the command
+#   ruby build_doc.rb
+# from the distribution directory.
+#++
+
+$:.unshift 'lib'
+require 'rio'
+require 'rio/prompt'
+require 'doc/pkg_def'
+
+module DFLT
+  RDOC_DIR = rio('doc/rdoc')
+end
+
+#puts "Rio interactive RDoc installer."
+def doc_dir?(d)
+  have_dirs = ['classes','files'].inject(true) {|isdir,f| isdir and rio(d,f).dir?}
+  have_files = ['created.rid','fr_class_index.html',
+                'fr_file_index.html','fr_method_index.html',
+                'index.html','rdoc-style.css'].inject(true) { |isfile,f| isfile && rio(d,f).file? }
+  have_dirs && have_files
+end
+
+rdoc_dir = RIO.promptr('Where shall I build the rdoc documentation',DFLT::RDOC_DIR)
+
+if rdoc_dir.exist?
+  delit = 'y'
+  if rdoc_dir.dir?
+    unless doc_dir?(rdoc_dir)
+      delit = RIO.promptd("Directory '#{rdoc_dir}' exists. Would you like to delete it? ", 'n' )
+    end
+  else
+    delit = RIO.promptd("Non directory '#{rdoc_dir}' exists. Would you like to delete it? ", 'n' )
+  end
+  if delit =~ /^[yY]/
+    rio(rdoc_dir).delete!
+  else
+    exit(-1)
+  end
+end
+
+
+rdoc_dir = rio(rdoc_dir)
+
+
+argv = []
+argv << '--op' << rdoc_dir.to_s
+argv += PKG::RDOC_OPTIONS
+argv += PKG::FILES::DOC
+
+require 'rdoc/rdoc'
+begin
+  r = RDoc::RDoc.new
+  r.document(argv)
+rescue RDoc::RDocError => e
+  $stderr.puts e.message
+  exit(1)
+end
+
+docindex = (rdoc_dir/'index.html').abs.to_url
+msg = "Please point your browser at '#{docindex}'" 
+lin =  ">" + ">" * (msg.length+2) + ">"
+
+puts
+puts lin
+puts "> " + msg + " >"
+puts lin
+__END__
+
+
+

data/doc/ANNOUNCE

@@ -0,0 +1,159 @@
+Rio 0.4.3
+
+= Rio - Ruby I/O Facilitator
+
+fa-cil-i-tate: To make easy or easier.
+
+== Overview
+
+Rio is a facade for most of the standard ruby classes that deal with
+I/O; providing a simple, intuitive, succinct interface to the
+functionality provided by IO, File, Dir, Pathname, FileUtils,
+Tempfile, StringIO, OpenURI and others. Rio also provides an
+application level interface which allows many common I/O idioms to be
+expressed succinctly.
+
+
+== SYNOPSIS
+
+For the following assume:
+ astring = ""
+ anarray = []
+
+Iterate over the .rb files in a directory.
+ rio('adir').files('*.rb') { |entrio| ... }
+
+Return an array of the .rb files in a directory.
+ anarray = rio('adir').files['*.rb']
+
+Copy the .rb files in a directory.to another directory.
+ rio('adir').files('*.rb') > rio('another_directory')
+
+Iterate over the .rb files in a directory and its subdirectories.
+ rio('adir').all.files('*.rb') { |entrio| ... }
+
+Return an array of the .rb files in a directory and its
+subdirectories.
+ anarray = rio('adir').all.files['*.rb']
+
+Copy or append a file to a string
+ rio('afile') > astring      # copy
+ rio('afile') >> astring     # append
+
+Copy or append a string to a file
+ rio('afile') < astring      # copy
+ rio('afile') << astring     # append
+
+Copy or append the lines of a file to an array
+ rio('afile') > anarray     
+ rio('afile') >> anarray
+ 
+Copy or append a file to another file
+ rio('afile') > rio('another_file')  
+ rio('afile') >> rio('another_file') 
+
+Copy a file to a directory
+ rio('adir') << rio('afile')
+
+Copy a directory to another directory
+ rio('adir') >> rio('another_directory')
+
+Copy a web-page to a file
+ rio('http://rubydoc.org/') > rio('afile')
+
+Read a web-page into a string
+ astring = rio('http://rubydoc.org/').read
+
+Ways to get the chomped lines of a file into an array
+ anarray = rio('afile').chomp[]         # subscript operator
+ rio('afile').chomp > anarray           # copy-to operator
+ anarray = rio('afile').chomp.to_a      # to_a
+ anarray = rio('afile').chomp.readlines # IO#readlines
+ 
+Iterate over selected lines of a file
+ rio('adir').lines(0..3) { |aline| ... }       # a range of lines
+ rio('adir').lines(/re/) { |aline| ... }       # by regular expression
+ rio('adir').lines(0..3,/re/) { |aline| ... }  # or both
+ 
+Return selected lines of a file as an array
+ rio('adir').lines[0..3]       # a range of lines
+ rio('adir').lines[/re/]       # by regular expression
+ rio('adir').lines[0..3,/re/]  # or both
+ 
+Iterate over selected chomped lines of a file
+ rio('adir').chomp.lines(0..3) { |aline| ... } # a range of lines
+ rio('adir').chomp.lines(/re/) { |aline| ... } # by regular expression
+
+Return selected chomped lines of a file as an array
+ rio('adir').chomp[0..3]  # a range of lines
+ rio('adir').chomp[/re/]  # by regular expression
+ 
+Copy a gzipped file un-gzipping it
+ rio('afile.gz').gzip > rio('afile')
+
+Copy a plain file, gzipping it
+ rio('afile.gz').gzip < rio('afile')
+
+Copy a file from a ftp server into a local file un-gzipping it
+ rio('ftp://host/afile.gz').gzip > rio('afile')
+
+Return an array of .rb files excluding symlinks to .rb files
+ rio('adir').files('*.rb').skip[:symlink?]
+
+Put the first 10 chomped lines of a gzipped file into an array
+ anarray =  rio('afile.gz').chomp.gzip[0...10] 
+
+Copy lines 0 and 3 thru 5 of a gzipped file on an ftp server to stdout
+ rio('ftp://host/afile.gz').gzip.lines(0,3..5) > ?-
+
+Return an array of files in a directory and its subdirectories,
+without descending into .svn directories.
+ rio('adir').norecurse(/^\.svn$/).files[]
+
+Iterate over the non-empty, non-comment chomped lines of a file
+ rio('afile').chomp.skip(:empty?,/^\s*#/) { |line| ... }
+
+Copy the output of th ps command into an array, skipping the header
+line and the ps command entry
+ rio(?-,'ps -a').skiplines(0,/ps$/) > anarray 
+
+Prompt for input and return what was typed
+ ans = rio(?-).print("Type Something: ").chomp.gets 
+
+Change the extension of all .htm files in a directory and its
+subdirectories to .html
+ rio('adir').rename.all.files('*.htm') do |htmfile|
+   htmfile.extname = '.html'
+ end
+
+Copy a CSV file, changing the separator to a semicolon
+ rio('comma.csv').csv > rio('semicolon.csv').csv(';')
+
+Iterate through a CSVfile with each line parsed into an array
+ rio('afile.csv').csv { |array_of_fields| ...}
+
+Create a tab separated file of accounts in a UNIX passwd file,
+listing only the username, uid, and realname fields
+ rio('/etc/passwd').csv(':').columns(0,2,4) > rio('rpt').csv("\t")
+
+Pipe multiple commands
+ rio('afile') | rio(?-,'acmd') | 'another_cmd' | ?-
+
+== Contact
+
+Project:: http://rubyforge.org/projects/rio/
+Documentation:: http://rio.rubyforge.org/
+Bugs:: http://rubyforge.org/tracker/?group_id=821
+Email:: rio4ruby@rubyforge.org
+Blog:: http://rio4ruby.blogspot.com
+
+== Copyright
+== Ruby 1.9 Mods
+Copyright (c) 2009 John W Higgins. All rights reserved
+Copyright (c) 2005,2006,2007 Christopher Kleckner. All rights reserved
+
+== License
+Rio is released under the GNU General Public License
+(http://www.gnu.org/licenses/gpl.html)
+
+-Christopher Kleckner 

data/doc/RELEASE_NOTES

@@ -0,0 +1,308 @@
+=== Rio - Ruby I/O Facilitator
+
+Rio is a facade for most of the standard ruby classes that deal with
+I/O; providing a simple, intuitive, succinct interface to the
+functionality provided by IO, File, Dir, Pathname, FileUtils,
+Tempfile, StringIO, OpenURI and others. Rio also provides an
+application level interface which allows many common I/O idioms to be
+expressed succinctly.
+
+fa-cil-i-tate:  To make easy or easier.
+
+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.
+
+Suggested Reading
+* RIO::Doc::SYNOPSIS
+* RIO::Doc::INTRO
+* RIO::Doc::HOWTO
+* RIO::Rio
+
+== New for version 0.4.1
+* Bug fixes to better handle file system paths with URI special
+  characters.
+* Other bug fixes.
+
+== New for version 0.4.0
+* Alpha. 
+
+
+== New for version 0.3.9
+* Bug fixes, code cleanup. 
+* See Rio#split
+
+
+== New for version 0.3.8
+* Enhanced support for FTP file-systems. All of Rio's most powerful
+  idioms are now supported seamlessly on FTP servers.
+
+   # copy a file from or to an FTP server
+   rio('ftp://ahost/adir/afile') > rio('localfile') # server -> local file
+   rio('ftp://ahost/adir/afile') < rio('localfile') # local file -> server
+
+   # copy an entire directory structure from or to an FTP server
+   rio('ftp://ahost/adir') > rio('localdir') # server -> local directory
+   rio('ftp://ahost/adir') < rio('localdir') # local directory -> server
+
+  All of Rio's grande selection and filtering options are available for
+  files and directories on FTP servers.
+
+   # create a gzipped copy of a web page on an ftp server
+   rio('ftp://ftphost/f.html.gz').gzip < rio('http://httphost/f.html')
+
+   # dump the first 10 lines of a gzipped log file on an FTP server to stdout
+   rio('ftp://ftphost/logfile.txt').lines(0...10) > ?-
+
+   # iterate through the entries of a directory on an FTP server
+   rio('ftp://ftphost/adir').entries { |entrio| ... }
+
+   # get an array of all .rb files on an ftp server
+   rb_files = rio('ftp://ftphost/').all.files['*.rb']
+
+* More tests
+* Bug fixes
+
+== Version 0.3.7
+* Maintenance release
+
+== New for version 0.3.6
+* Pipe operator and command pipes
+
+  Pipe multiple commands
+   rio('afile') | rio(?-,'acmd') | 'another_cmd' | ?-
+
+  Run the same series of commands, with different input and/or output
+   cmdpipe = rio(?-,'acmd') | rio(?-,'another_cmd')
+   rio('infile1') | cmdpipe | rio('outfile1')
+   rio('infile2') | cmdpipe | rio('outfile2')
+
+   cmdpipe2 = rio(?|,'cmd1','cmd2',rio('outfile'))   # create a cmdpipe Rio
+   rio('infile1') | cmdpipe2       # run with input coming from a file
+   rio(?-) | cmdpipe2              # same commands with input from stdin
+
+
+== New for version 0.3.5
+* Partial support for MS Windows drive and UNC path specifications
+  
+  The separator must be '/'. Back-slashes are not supported.
+
+  Drives and UNC paths may be specified as expected:
+   rio("D:/adir/afile")
+   rio('//ahost/adir/afile')
+
+  This support has introduced a change in the behaviour
+  of Rio#path. Rio#path now returns the path on the 
+  file-system for Rios that are on the file-system; returns the path
+  portion of the URL for FTP, HTTP and other Rios that
+  have a path, and return nil for Rios that have no path
+   rio('/a/b/c').path                     #==> "/a/b/c"
+   rio('b/c').path                        #==> "b/c"
+   rio('C:/b/c').path                     #==> "C:/b/c"
+   rio('//ahost/a/b').path                #==> "//ahost/a/b"
+   rio('file://ahost/a/b').path           #==> "//ahost/a/b"
+   rio('file:///a/b').path                #==> "/a/b"
+   rio('file://localhost/a/b').path       #==> "/a/b"
+   rio('http://ahost/index.html').path    #==> "/index.html"
+   rio('stdin:').path                     #==> nil
+
+
+== New for version 0.3.4
+* New Grande Selection parameter.
+
+  A major weakness of Rio's selection methods (lines, files, etc.)
+  has always been that it only implemented a logical OR.
+
+   rio('afile').lines(0..10,/Rio/) {...}
+  iterates through lines that are in the range 0..10 OR 
+  contain 'Rio'.
+
+   rio('adir').files(:executable?,'*.rb') {...}
+  iterates through files that are executable OR match '*.rb'
+
+  Selecting files that matched both required using a proc.
+   rio('adir').files(proc{ |f| f.executable? and f.fnmatch?('*.rb')}) {...}
+
+  Rio's grande selection methods will now accept an array of conditions
+  which must all be matched, in order to be selected. A logical AND.
+
+   rio('adir').files([:executable?,'*.rb']) {...}
+  
+  The array, of course, need not be the only paramter. 
+
+   rio('adir').files('*.exe',[:executable?,'*.rb']) {...}
+
+  selects .exe files and .rb files that are executable.
+
+* Renamed some of grande rejection methods. 
+  (based on a suggestion by Gavin Sinclair)
+   nolines => skiplines
+   nofiles => skipfiles
+  etc.
+
+* New skip() grande method
+   rio('afile').skip.lines(/Rio/)       # same as skiplines(/Rio/)
+   rio('afile').lines(/Rio/).skip(0..9) # lines with 'Rio', exclude 
+                                        # the first ten lines
+
+* Alternative syntaxes for creating Rios that have no path.
+
+   rio(?-)          # create a Rio refering to stdio
+   rio(:stdio)      # same thing.
+   rio.stdio        # same thing
+   RIO.stdio        # ditto
+   RIO::Rio.stdio   # once again
+
+* From Pathname added
+  * root?
+  * mountpoint?
+  * realpath
+  * cleanpath
+
+* Removed Rio#slurp in favor of Rio#contents.
+
+
+* Added aliases for the copy operators. (suggested by Dave Burt)
+   * copy_to >
+   * append_to >>
+   * copy_from <
+   * append_from <<
+
+
+* Bug fixes and corrections    
+  
+Project:: http://rubyforge.org/projects/rio/
+Documentation:: http://rio.rubyforge.org/
+Bugs:: http://rubyforge.org/tracker/?group_id=821
+Email:: rio4ruby@rubyforge.org
+
+== New for version 0.3.3
+* Expanded support and documentation for CSV files
+  Examples:
+  * Copy, changing the separator to a semicolon
+     rio('comma.csv').csv > rio('semicolon.csv').csv(';')
+  * Iterate through a file with each line parsed into an array
+     rio('afile.csv').csv { |array_of_fields| ...}
+  * Create an array of arrays of selected fields
+     array_of_arrays = rio('afile.csv').csv.columns(1..3,7).to_a
+  * Create a tab separated file of accounts in a UNIX passwd file,
+    listing only the username, uid, and realname fields
+     rio('/etc/passwd').csv(':').columns(0,2,4) > rio('report).csv("\t")
+
+Project:: http://rubyforge.org/projects/rio/
+Documentation:: http://rio.rubyforge.org/
+Bugs:: http://rubyforge.org/tracker/?group_id=821
+
+== New for version 0.3.2
+
+* Based on a suggestion by Wybo Decker and code attributed to Nobu Nokada, 
+  Rio now supports temporary directories in addition to temporary files.
+* Bug fixes
+* More tests and documentation.
+
+== SYNOPSIS
+
+For the following assume:
+ astring = ""
+ anarray = []
+
+Copy a file into a string
+ rio('afile') > astring 
+
+Copy the chomped lines of a file into an array
+ rio('afile').chomp > anarray
+ 
+Copy a file into another file
+ rio('afile') > rio('another_file')
+
+Copy a file into a directory
+ rio('afile') > rio('adir')
+
+Copy an entire directory structure into another directory
+ rio('adir') > rio('another_directory')
+
+Copy a web page into a file
+ rio('http://rubydoc.org/') > rio('afile')
+
+Copy a file from a ftp server into a file
+ rio('ftp://host/afile.gz') > rio('afile.gz')
+
+Copy a gzipped file un-gzipping it
+ rio('afile.gz').gzip > rio('afile')
+
+Copy a file from a ftp server into a local file un-gzipping it
+ rio('ftp://host/afile.gz').gzip > rio('afile')
+
+Copy a plain file, gzipping it
+ rio('afile.gz').gzip < rio('afile')
+
+Iterate over the entries in a directory
+ rio('adir').entries { |entrio| ... }
+
+Iterate over only the files in a directory
+ rio('adir').files { |entrio| ... }
+
+Iterate over only the .rb files in a directory
+ rio('adir').files('*.rb') { |entrio| ... }
+
+Create an array of the .rb entries in a directory
+ anarray = rio('adir')['*.rb']
+
+Iterate over the .rb files in a directory and its subdirectories
+ rio('adir').all.files('*.rb') { |entrio| ... }
+
+Create an array of the .rb entries in a directory and its subdirectories
+ anarray = rio('adir').all['*.rb']
+
+Create an array of the .rb files in a directory and its subdirectories
+ anarray = rio('adir').all.files['*.rb']
+
+Copy an entire directory structure but only the .rb files from a directory and its subdirectories 
+into another directory
+ rio('adir').dirs.files('*.rb') > rio('another_directory')
+
+Iterate over the chomped lines of a file
+ rio('afile').chomp.lines { |line| ... }
+
+Put the chomped lines of a file into an array
+ anarray = rio('afile').chomp.lines[]
+
+Iterate over the first 10 chomped lines of a file
+ rio('afile').chomp.lines(0..9) { |line| ... }
+
+Put the first 10 chomped lines of a file into an array
+ anarray = rio('afile').chomp.lines[0..9]
+
+Copy the first 10 lines of a file into another file
+ rio('afile').lines(0..9) > rio('another_file')
+
+Copy the first 10 lines of a file to stdout
+ rio('afile').lines(0..9) > rio(?-)
+
+Copy the first 10 lines of a gzipped file to stdout
+ rio('afile.gz').gzip.lines(0..9) > rio(?-)
+
+Copy the first 10 lines of a gzipped file on an ftp server to stdout
+ rio('ftp://host/afile.gz').gzip.lines(0..9) > rio(?-)
+
+Put the first 100 chomped lines of a gzipped file into an array
+ anarray =  rio('afile.gz').gzip[0...100] 
+
+Copy the output of th ps command into an array, skipping the header line and the ps command entry
+ rio(?-,'ps -a').skiplines(0,/ps$/) > anarray 
+
+Prompt for input and return what was typed
+ ans = rio(?-).print("Type Something: ").chomp.gets 
+
+Change the extension of all files with the extension '.htm' in a directory and its
+subdirectories to have the extension '.html'
+ rio('adir').rename.all.files('*.htm') do |htmfile|
+   htmfile.extname = '.html'
+ end
+
+Create a symbolic link 'asymlink' in 'adir' which refers to 'adir/afile'
+ rio('adir/afile').symlinke('adir/asymlink')
+
+