rio 0.3.9 → 0.4.0

data/README

@@ -18,10 +18,15 @@ along with Rio; if not, write to the Free Software
 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
 
-=== Rio - Ruby I/O Comfort Class
+= Rio - Ruby I/O Facilitator
 
-Rio wraps much of the functionality of IO, File, Dir, Pathname, FileUtils,
-Tempfile, StringIO, OpenURI, Zlib, and CSV.
+fa-cil-i-tate:  To make easy or easier [http://www.thefreedictionary.com/facilitate]
+
+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.
 
 ==== Building the documentation
 
@@ -31,12 +36,13 @@ from the distribution directory.
 
 Then point your browser at the 'doc/rdoc' directory.
 
-The RDoc template file included with the distribution contains some RDoc hacks
+The RDoc template file included with this distribution contains some RDoc hacks
 that overcomes some of RDoc's weaknesses and makes the documentation *much* more
-usable. It is unadvisable to build the RDoc documentation without these.
+usable. It is inadvisable to build the RDoc documentation without these.
 
 
 ===== Suggested Reading
+
 * RIO::Doc::SYNOPSIS
 * RIO::Doc::INTRO
 * RIO::Doc::HOWTO
@@ -62,9 +68,9 @@ To read the documentation without running rdoc, read the files:
 * lib/rio/if/*.rb
 
 
-Project:: http://rubyforge.org/projects/rio/
+Project::       http://rubyforge.org/projects/rio/
 Documentation:: http://rio.rubyforge.org/
-Bugs:: http://rubyforge.org/tracker/?group_id=821
-Email:: rio4ruby@rubyforge.org
+Bugs::          http://rubyforge.org/tracker/?group_id=821
+Email::         rio4ruby@rubyforge.org
 
 

data/Rakefile

@@ -43,7 +43,8 @@ require 'rio/version'
 require 'rio/doc'
 require 'rio'
 
-SVN_REPOSITORY_URL = 'svn+ssh://rio4ruby@rubyforge.org//var/svn/trunk/rio'
+SVN_REPOSITORY_ROOT = 'svn+ssh://rio4ruby@rubyforge.org//var/svn/rio'
+SVN_REPOSITORY_URL = [SVN_REPOSITORY_ROOT,'trunk/rio'].join('/')
  
 require 'doc/pkg_def'
 
@@ -118,9 +119,6 @@ task :gen_version do
 end
 
 
-#task :gen_files => [:gen_changelog, :gen_version, :gen_installrb]
-#CLOBBER << "ChangeLog" << "VERSION" << "install.rb"
-
 task :gen_files => [:gen_changelog, :gen_version]
 #task :gen_files => [:gen_version]
 CLOBBER << "ChangeLog" << "VERSION" 
@@ -148,8 +146,8 @@ Spec = Gem::Specification.new do |s|
   s.version = PKG::VERSION
   s.author = PKG::AUTHOR
   s.email = PKG::EMAIL
-  s.homepage = "http://rio.rubyforge.org/"
-  s.rubyforge_project = "rio"
+  s.homepage = PKG::HOMEPAGE
+  s.rubyforge_project = PKG::RUBYFORGE_PROJECT
 
   s.platform = Gem::Platform::RUBY
   s.summary = PKG::SUMMARY
@@ -168,7 +166,6 @@ Rake::GemPackageTask.new(Spec) do |p| end
 desc "Build the Gem spec file for the rio package"
 task :gemspec => "pkg/rio.gemspec"
 file "pkg/rio.gemspec" => ["pkg", "Rakefile"] do |t|
-  puts PKG::FILES::DIST
   open(t.name, "w") do |f| f.puts Spec.to_yaml end
 end
 
@@ -181,8 +178,9 @@ desc "Save the current code as a new svn version"
 task :svn_version do
   require 'rio'
   repos = rio(SVN_REPOSITORY_URL)
-  proju = rio(repos,PKG::NAME,'trunk') 
-  relu  = rio(repos,PKG::NAME,'tags','release-') + PKG::VERSION 
+  repo_root = rio(SVN_REPOSITORY_ROOT)
+  proju = rio(repo_root,'trunk',PKG::NAME) 
+  relu  = rio(repo_root,'tags',"release-#{PKG::VERSION}")
   relo =`svn list #{relu.to_url}`
   if relo.size > 0
     $stderr.puts "Release #{relu.to_url} exists!"

data/doc/ANNOUNCE

@@ -1,21 +1,39 @@
-Rio 0.3.9
+Rio 0.4.0
+
+= Rio - Ruby I/O Facilitator
 
 == Overview
 
-Rio is a Ruby I/O convenience class wrapping much of the functionality
-of IO, File and Dir. Rio also uses FileUtils, Tempfile, StringIO,
-OpenURI, Net::FTP, Zlib, and CSV to provide similar functionality
-using a simple consistent interface. In addition to forwarding the
-interfaces provided by IO, File, and Dir to an appropriate object, Rio
-provides a "grande" interface that allows many common application
-level I/O and file-system tasks to be expressed succinctly.
+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
 
-= SYNOPSIS
+fa-cil-i-tate:  To make easy or easier [http://www.thefreedictionary.com/facilitate]
 
 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.
+ 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.
+ rio('adir').all.files['*.rb']
+
 Copy or append a file to a string
  rio('afile') > astring      # copy
  rio('afile') >> astring     # append
@@ -35,18 +53,39 @@ Copy or append a file to another file
 Copy a file to a directory
  rio('adir') << rio('afile')
 
-Copy a directory structure to another directory
+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')
 
@@ -56,56 +95,32 @@ Copy a plain file, gzipping it
 Copy a file from a ftp server into a local file un-gzipping it
  rio('ftp://host/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| ... }
-
-Iterate over .rb files but not symlinks to .rb files
- rio('adir').files('*.rb').skip(:symlink?) { |entrio| ... }
-
-Iterate over only the _dot_ files in a directory
- rio('adir').files(/^\./) { |entrio| ... }
-
-Iterate over the files in a directory and its subdirectories, skipping
-'.svn' and 'CVS' directories
+Return an array of .rb files excluding symlinks to .rb files
+ rio('adir').files('*.rb').skip[:symlink?]
 
- rio('adir').norecurse(/^\.svn$/,'CVS').files { |entrio| ... }
+Put the first 10 chomped lines of a gzipped file into an array
+ anarray =  rio('afile.gz').chomp.gzip[0...10] 
 
-Create an array of the .rb entries in a directory
- anarray = rio('adir')['*.rb']
+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) > ?-
 
-Create an array of the .rb entries in a directory and its
-subdirectories.
- anarray = rio('adir').all['*.rb']
-
-Iterate over the .rb files in a directory and its subdirectories
- rio('adir').all.files('*.rb') { |entrio| ... }
+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.lines(:empty?,/^\s*#/) { |line| ... }
+ 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').skip.lines(0,/ps$/) > anarray 
+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
+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
 
-Create a symbolic link 'asymlink' in 'adir' which refers to
-'adir/afile'
- rio('adir/afile').symlink('adir/asymlink')
-
 Copy a CSV file, changing the separator to a semicolon
  rio('comma.csv').csv > rio('semicolon.csv').csv(';')
 

data/doc/RELEASE_NOTES

@@ -1,7 +1,12 @@
-=== Rio - Ruby I/O Comfort Class
+=== Rio - Ruby I/O Facilitator
 
-Rio is a convenience class wrapping much of the functionality of 
-IO, File, Dir, Pathname, FileUtils, Tempfile, StringIO, OpenURI, Zlib, and CSV.
+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 [http://www.thefreedictionary.com/facilitate]
 
 To create the documentation for Rio run the command
   ruby build_doc.rb
@@ -15,6 +20,10 @@ Suggested Reading
 * RIO::Doc::HOWTO
 * RIO::Rio
 
+== New for version 0.4.0
+* Alpha. 
+
+
 == New for version 0.3.9
 * Bug fixes, code cleanup, 
 

data/doc/RIOIS

@@ -48,17 +48,17 @@ To copy use the copy-operator:
 
 
 
+= Rio - Ruby I/O Facilitator
 
+fa-cil-i-tate:  To make easy or easier [http://www.thefreedictionary.com/facilitate]
 
 == Overview
 
-Rio is a Ruby I/O convenience class wrapping much of the functionality
-of IO, File and Dir. Rio also uses FileUtils, Tempfile, StringIO,
-OpenURI, Net::FTP, Zlib, and CSV to provide similar functionality
-using a simple consistent interface. In addition to forwarding the
-interfaces provided by IO, File, and Dir to an appropriate object, Rio
-provides a "grande" interface that allows many common application
-level I/O and file-system tasks to be expressed succinctly.
+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.
 
 == New
 

data/doc/generators/template/html/rio.rb

@@ -49,6 +49,7 @@ HEADER = XHTML_PREAMBLE + %{
   <title>%title%</title>
   <meta http-equiv="Content-Type" content="text/html; charset=%charset%" />
   <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <meta name="revisit-after" content="5 days">
   <link rel="stylesheet" href="%style_url%" type="text/css" media="screen" />
   <script type="text/javascript">
   // <![CDATA[
@@ -496,14 +497,12 @@ INDEX = %{<?xml version="1.0" encoding="%charset%"?>
 <head>
   <title>%title%</title>
   <meta http-equiv="Content-Type" content="text/html; charset=%charset%" />
-  <meta name="Description" content="Rio is a Ruby I/O convenience class wrapping 
-much of the functionality
-of IO, File and Dir. Rio also uses FileUtils, Tempfile, StringIO,
-OpenURI, Net::FTP, Zlib, and CSV to provide similar functionality
-using a simple consistent interface. In addition to forwarding the
-interfaces provided by IO, File, and Dir to an appropriate object, Rio
-provides a 'grande' interface that allows many common application
-level I/O and file-system tasks to be expressed succinctly."/>
+  <meta name="Description" content="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."/>
 </head>
 <frameset rows="20%, 80%">
     <frameset cols="25%,35%,45%">

data/doc/generators/template/html/ugly.rb

@@ -112,8 +112,10 @@ module Generators
 
       if ref and ref.document_self
         #print "#{name} =>"
-        name.sub!(/^(RIO::)?IF::.+\#/,'Rio#')
-        name.sub!(/^#/,'Rio#')
+        #name.sub!(/^(RIO::)?IF::.+\#/,'Rio#')
+        name.sub!(/^(RIO::)?IF::.+\#/,'')
+        #name.sub!(/^#/,'Rio#')
+        name.sub!(/^#/,'')
         #puts " #{name}"
         if %w[Rio Grande String].include?(name) or name =~ /^(Dir)/
         #if %w[Rio Grande String].include?(name)

data/doc/pkg_def.rb

@@ -36,8 +36,9 @@ module PKG
   DESCRIPTION = RIO::DESCRIPTION
   AUTHOR = "Christopher Kleckner"
   EMAIL = "rio4ruby@rubyforge.org"
-  HOMEPAGE = "http://rio.rubyforge.org/"
-  RUBYFORGE_PROJECT = "rio"
+  RUBYFORGE_PROJECT = PKG::NAME
+  HOMEPAGE = "http://#{PKG::RUBYFORGE_PROJECT}.rubyforge.org/"
+  RUBYFORGE_URL = "http://rubyforge.org/projects/#{PKG::RUBYFORGE_PROJECT}"
   RDOC_OPTIONS = ['--show-hash','--line-numbers','-mRIO::Doc::SYNOPSIS','-Tdoc/generators/template/html/rio.rb']
   module FILES
     SRC = rio('lib').norecurse('.svn').files['*.rb']
@@ -48,19 +49,12 @@ module PKG
     TST = rio('test').norecurse('.svn').all.files('*.rb').skip.dirs['qp','.svn']
     MSC = rio.files['setup.rb', 'build_doc.rb', 'COPYING', 'Rakefile', 'ChangeLog', 'VERSION']
     
-    #                              ) do |fl|
-#     fl.exclude( /\bsvn\b/ )
-#     fl.exclude( 'doc/rdoc' )
-#   end
     [SRC,DOC,XMP,D2,TST,MSC].each do |fary|
       fary.map! { |f| f.to_s }
     end
     DIST  =  SRC + DOC + XMP + D2 + TST + MSC
   end
 
-#   SRC_FILES = FileList['lib/**/*.rb']
-#   DOC_FILES = FileList['README','lib/rio.rb','lib/rio/doc/*.rb',
-#                        'lib/rio/if/*.rb','lib/rio/kernel.rb','lib/rio/constructor.rb']
   OUT_DIR = 'pkg'
-  OUT_FILES = %w[.gem .tar.gz .zip].map { |ex| OUT_DIR + '/' + FULLNAME + ex }
+  OUT_FILES = %w[.gem .tar.gz .zip].map { |ex| PKG::OUT_DIR + '/' + FULLNAME + ex }
 end

data/doc/rdoc/classes/Kernel.html

@@ -0,0 +1,133 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Module: Kernel</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <meta name="revisit-after" content="5 days">
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td class="class-mod"><strong>Module</strong></td>
+          <td class="class-name-in-header">Kernel</td>
+            <td rowspan="2" class="class-header-space-col"></td>
+            <td rowspan="2">
+                <a class="in-url" href="../files/lib/rio/kernel_rb.html">
+                lib/rio/kernel.rb
+                </a>
+        &nbsp;&nbsp;
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000233">rio</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000233" class="method-detail">
+        <a name="M000233"></a>
+
+        <div class="method-heading">
+          <a href="Kernel.src/M000233.html" target="Code" class="method-signature"
+            onclick="popupCode('Kernel.src/M000233.html');return false;">
+          <span class="method-name">rio</span><span class="method-args">(*args) {|self| ...}</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Shortcut for <a href="RIO.html#M000001">RIO.rio</a>
+</p>
+        </div>
+      </div>
+
+
+    </div>
+</div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+   <p><small>Copyright &copy; 2005,2006,2007 Christopher Kleckner.  <a href="http://www.gnu.org/licenses/gpl.html">All rights reserved</a>.</small></p>
+</div>
+
+</body>
+</html>