rio 0.3.1 → 0.3.2

data/ChangeLog

@@ -1,4 +1,144 @@
 ------------------------------------------------------------------------
+r74 | kit | 2005-08-16 11:00:55 -0700 (Tue, 16 Aug 2005) | 1 line
+Changed paths:
+   M /rio/trunk/doc/ANNOUNCE
+   M /rio/trunk/doc/RELEASE_NOTES
+
+ANNOUNCE & RELEASE_NOTES
+------------------------------------------------------------------------
+r72 | kit | 2005-08-16 07:42:58 -0700 (Tue, 16 Aug 2005) | 1 line
+Changed paths:
+   M /rio/trunk/lib/rio/state.rb
+
+ initialized
+------------------------------------------------------------------------
+r68 | kit | 2005-08-16 07:35:28 -0700 (Tue, 16 Aug 2005) | 1 line
+Changed paths:
+   M /rio/trunk/doc/ANNOUNCE
+   M /rio/trunk/doc/RELEASE_NOTES
+
+ANNOUNCE and RELEASE_NOTES
+------------------------------------------------------------------------
+r63 | kit | 2005-08-15 14:58:10 -0700 (Mon, 15 Aug 2005) | 1 line
+Changed paths:
+   M /rio/trunk/lib/rio/constructor.rb
+   M /rio/trunk/lib/rio/doc/INTRO.rb
+
+Tempfile and Tempdir documentation
+------------------------------------------------------------------------
+r62 | kit | 2005-08-15 14:39:16 -0700 (Mon, 15 Aug 2005) | 1 line
+Changed paths:
+   M /rio/trunk/lib/rio/factory.rb
+   M /rio/trunk/lib/rio/ops/dir.rb
+   M /rio/trunk/lib/rio/rl/base.rb
+   M /rio/trunk/lib/rio/rl/path.rb
+   A /rio/trunk/lib/rio/scheme/temp.rb
+   D /rio/trunk/lib/rio/scheme/tempdir.rb
+   D /rio/trunk/lib/rio/scheme/tempfile.rb
+   M /rio/trunk/test/tc/all.rb
+   M /rio/trunk/test/tc/riorl.rb
+   A /rio/trunk/test/tc/temp.rb
+
+combined testfile and testdir
+------------------------------------------------------------------------
+r59 | kit | 2005-08-13 14:46:18 -0700 (Sat, 13 Aug 2005) | 1 line
+Changed paths:
+   M /rio/trunk/lib/rio/rl/path.rb
+   M /rio/trunk/lib/rio/version.rb
+   M /rio/trunk/lib/rio.rb
+   M /rio/trunk/test/tc/copylines.rb
+
+New Version
+------------------------------------------------------------------------
+r57 | kit | 2005-08-13 14:35:16 -0700 (Sat, 13 Aug 2005) | 1 line
+Changed paths:
+   M /rio/trunk/ex/findinruby
+   M /rio/trunk/ex/findruby
+   M /rio/trunk/lib/rio/argv.rb
+   M /rio/trunk/lib/rio/context/dir.rb
+   M /rio/trunk/lib/rio/context.rb
+   M /rio/trunk/lib/rio/doc/HOWTO.rb
+   M /rio/trunk/lib/rio/grande.rb
+   M /rio/trunk/lib/rio/matchrecord.rb
+   M /rio/trunk/lib/rio/ops/stream/input.rb
+   M /rio/trunk/test/tc/all.rb
+   M /rio/trunk/test/tc/copylines.rb
+   A /rio/trunk/test/tc/tempdir.rb
+
+documentation and fixed examples; added test for tempdirs
+------------------------------------------------------------------------
+r56 | kit | 2005-08-11 10:47:05 -0700 (Thu, 11 Aug 2005) | 1 line
+Changed paths:
+   M /rio/trunk/lib/rio/dir.rb
+   M /rio/trunk/lib/rio/factory.rb
+   M /rio/trunk/lib/rio/scheme/tempdir.rb
+   M /rio/trunk/lib/rio/tempdir.rb
+
+tempdir support
+------------------------------------------------------------------------
+r55 | kit | 2005-08-11 09:18:09 -0700 (Thu, 11 Aug 2005) | 1 line
+Changed paths:
+   A /rio/trunk/doc/ANNOUNCE
+   A /rio/trunk/lib/rio/scheme/tempdir.rb
+   A /rio/trunk/lib/rio/tempdir.rb
+   M /rio/trunk/test/tc/all.rb
+   A /rio/trunk/test/tc/tempfile.rb
+
+Preliminary code for tempdir: scheme
+------------------------------------------------------------------------
+r54 | kit | 2005-08-10 18:34:27 -0700 (Wed, 10 Aug 2005) | 1 line
+Changed paths:
+   M /rio/trunk/lib/rio/factory.rb
+   M /rio/trunk/lib/rio/scheme/path.rb
+   M /rio/trunk/lib/rio/scheme/tempfile.rb
+
+Fix in tempfile
+------------------------------------------------------------------------
+r53 | kit | 2005-08-10 12:59:56 -0700 (Wed, 10 Aug 2005) | 1 line
+Changed paths:
+   M /rio/trunk/lib/rio/scheme/tempfile.rb
+   M /rio/trunk/lib/rio/state.rb
+   M /rio/trunk/lib/rio/stream.rb
+   M /rio/trunk/test/tc/all.rb
+   A /rio/trunk/test/tc/riorl.rb
+
+fix for tempfile rios
+------------------------------------------------------------------------
+r52 | kit | 2005-08-08 09:56:51 -0700 (Mon, 08 Aug 2005) | 1 line
+Changed paths:
+   M /rio/trunk/lib/rio/context/methods.rb
+   M /rio/trunk/lib/rio/doc/HOWTO.rb
+   M /rio/trunk/lib/rio/doc/INTRO.rb
+   M /rio/trunk/lib/rio/doc/SYNOPSIS.rb
+   M /rio/trunk/lib/rio/stream/open.rb
+
+Channge noclose to noautoclose, and documentation
+------------------------------------------------------------------------
+r51 | kit | 2005-08-07 16:22:20 -0700 (Sun, 07 Aug 2005) | 1 line
+Changed paths:
+   M /rio/trunk/lib/rio/doc/INTRO.rb
+
+Documentation
+------------------------------------------------------------------------
+r50 | kit | 2005-08-07 14:49:26 -0700 (Sun, 07 Aug 2005) | 1 line
+Changed paths:
+   M /rio/trunk/Rakefile
+   M /rio/trunk/lib/rio/doc/SYNOPSIS.rb
+   M /rio/trunk/lib/rio/if/basic.rb
+   M /rio/trunk/lib/rio/if/path.rb
+   M /rio/trunk/lib/rio/ops/path.rb
+   M /rio/trunk/lib/rio/rl/ioi.rb
+   M /rio/trunk/lib/rio/rl/path.rb
+   M /rio/trunk/lib/rio/rl/uri.rb
+   M /rio/trunk/lib/rio/scheme/cmdio.rb
+   M /rio/trunk/lib/rio/scheme/stdio.rb
+   M /rio/trunk/lib/rio/scheme/strio.rb
+   M /rio/trunk/lib/rio/scheme/sysio.rb
+   M /rio/trunk/lib/rio/scheme/tcp.rb
+   M /rio/trunk/lib/rio/scheme/tempfile.rb
+
+reworked the way base paths are handled
+------------------------------------------------------------------------
 r45 | kit | 2005-08-06 09:17:04 -0700 (Sat, 06 Aug 2005) | 1 line
 Changed paths:
    M /rio/trunk/README

data/Rakefile

@@ -178,7 +178,7 @@ task :svn_version do
   relo =`svn list #{relu.to_url}`
   if relo.size > 0
     $stderr.puts "Release #{relu.to_url} exists!"
-    exit -1
+    exit(-1)
   end
   msg = "Release #{PKG::VERSION} of #{PKG::NAME}"
   cmd = sprintf('svn copy %s %s -m "%s"',proju.to_url, relu.to_url, msg)

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.3.2

data/doc/ANNOUNCE

@@ -0,0 +1,87 @@
+For your perusal -- Rio 0.3.2
+
+== Overview
+
+Rio is a Ruby I/O convenience class wrapping much of the functionality
+of IO, File and Dir. Rio also uses Pathname, FileUtils, Tempfile,
+StringIO, OpenURI, 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.
+
+
+== 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.
+
+
+== Version 0.3.1
+
+A Rio is and can manipulate:
+* a path
+* the string representing that path
+* the file, directory, web-page, or IO object to which that path refers
+* the object created by opening that file or directory.
+
+A Rio open itself, closes itself and selects its mode based on how it
+used and the object referenced.
+
+== Grande interface
+
+With the grande interface you can:
+
+Copy...
+ rio('afile') > astring                    # a file into a string
+ rio('afile') < astring                    # a string into a file
+ rio('afile') > anarray                    # lines of a file into array
+ rio('afile') < anarray                    # an array into a file
+ rio('afile') > rio('another_file')        # a file into another file
+ rio('adir') > rio('another_directory')    # a directory into another
+ rio('http://rubydoc.org/') > rio('afile') # a web page into a file
+
+Iterate...
+ rio('adir').entries { |entrio| ... }      # over directory entries
+ rio('adir').files { |entrio| ... }        # over only files
+ rio('adir').dirs { |entrio| ... }         # over only directories
+ rio('afile').lines { |line| ... }         # over lines in a file
+
+Create an array...
+ rio('adir').files[]                       # of files
+ rio('adir').dirs[]                        # of directories
+ rio('afile').lines[]                      # of lines
+
+Whether copying, iterating or returning an array
+Rio provides common input manipulations
+
+ rio('afile').chomp > anarray              # chomped lines to an array
+ anarray = rio('afile').chomp[]            # same thing
+ rio('afile.gz').gzip > rio('afile')       # ungzip a file
+ rio('afile.gz').gzip < rio('afile')       # gzip a file
+ rio('afile.gz').chomp { |line| ...}       # iterate chomped lines
+
+Whether copying, iterating or returning an array
+Rio provides simple input selection
+
+ rio('afile').lines(0..9) > rio('file2')   # the first 10 lines
+ rio('afile').lines(/Rio/) { |line| ...}   # lines containing 'Rio'
+ anarray = rio('adir').files['*.rb']       # ruby files
+
+Manipulation and selection methods can be combined
+
+ rio('afile').gzip.lines(/Rio/) > astring  # 'Rio' lines from gz file
+ anarray = rio('afile').chomp[0..9]        # first 10 lines chomped
+
+Many more examples and documentation at http://rio.rubyforge.org/
+
+== Copyright
+Copyright (c) 2005, Christopher Kleckner. All rights reserved
+
+== License
+Rio is released under the GNU General Public License
+(http://www.gnu.org/licenses/gp l.html)
+
+-Christopher Kleckner 

data/doc/RELEASE_NOTES

@@ -24,6 +24,13 @@ Suggested Reading
 * RIO::Doc::HOWTO
 * RIO::Rio
 
+== 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:

data/doc/rdoc/classes/Kernel.html

@@ -112,8 +112,8 @@ subject to change without notice.</b>
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000184">io</a>&nbsp;&nbsp;
-      <a href="#M000183">rio</a>&nbsp;&nbsp;
+      <a href="#M000183">io</a>&nbsp;&nbsp;
+      <a href="#M000182">rio</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -135,8 +135,8 @@ subject to change without notice.</b>
     <div id="methods">
       <h3 class="section-bar">Public Instance methods</h3>
 
-      <div id="method-M000184" class="method-detail">
-        <a name="M000184"></a>
+      <div id="method-M000183" class="method-detail">
+        <a name="M000183"></a>
 
         <div class="method-heading">
           <span class="method-name">io</span><span class="method-args">(*args)</span>
@@ -144,17 +144,17 @@ subject to change without notice.</b>
       
         <div class="method-description">
           <p>
-Alias for <a href="Kernel.html#M000183">rio</a>
+Alias for <a href="Kernel.html#M000182">rio</a>
 </p>
         </div>
       </div>
 
-      <div id="method-M000183" class="method-detail">
-        <a name="M000183"></a>
+      <div id="method-M000182" class="method-detail">
+        <a name="M000182"></a>
 
         <div class="method-heading">
-          <a href="Kernel.src/M000183.html" target="Code" class="method-signature"
-            onclick="popupCode('Kernel.src/M000183.html');return false;">
+          <a href="Kernel.src/M000182.html" target="Code" class="method-signature"
+            onclick="popupCode('Kernel.src/M000182.html');return false;">
           <span class="method-name">rio</span><span class="method-args">(*args) {|self| ...}</span>
           </a>
         </div>

data/doc/rdoc/classes/RIO.html

@@ -443,6 +443,41 @@ choosing
  rio(??)
  rio(??,basename='rio',tmpdir=Dir::tmpdir)
 </pre>
+<p>
+To create a temporary object that will become a file or a directory,
+depending on how you use it:
+</p>
+<pre>
+ rio(??)
+ rio(??,basename='rio',tmpdir=Dir::tmpdir)
+</pre>
+<p>
+To force it to become a file
+</p>
+<pre>
+ rio(??).file
+</pre>
+<p>
+or just write to it.
+</p>
+<p>
+To force it to become a directory:
+</p>
+<pre>
+ rio(??).dir
+</pre>
+<p>
+or
+</p>
+<pre>
+ rio(??).mkdir
+</pre>
+<p>
+or
+</p>
+<pre>
+ rio(??).chdir
+</pre>
 <h5>Creating a <a href="RIO/Rio.html">Rio</a> that refers to an arbitrary TCPSocket</h5>
 <pre>
  rio('tcp:',hostname,port)

data/doc/rdoc/classes/RIO.src/M000001.html

@@ -10,9 +10,9 @@
   <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre>     <span class="ruby-comment cmt"># File lib/rio/constructor.rb, line 153</span>
-153:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rio</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>,<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)  <span class="ruby-comment cmt"># :yields: self</span>
-154:     <span class="ruby-constant">Rio</span>.<span class="ruby-identifier">rio</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>,<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>) 
-155:   <span class="ruby-keyword kw">end</span></pre>
+  <pre>     <span class="ruby-comment cmt"># File lib/rio/constructor.rb, line 170</span>
+170:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rio</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>,<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)  <span class="ruby-comment cmt"># :yields: self</span>
+171:     <span class="ruby-constant">Rio</span>.<span class="ruby-identifier">rio</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>,<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>) 
+172:   <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/doc/rdoc/classes/RIO.src/M000002.html

@@ -10,9 +10,9 @@
   <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre>     <span class="ruby-comment cmt"># File lib/rio/constructor.rb, line 160</span>
-160:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">cwd</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>,<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)  <span class="ruby-comment cmt"># :yields: self</span>
-161:     <span class="ruby-constant">Rio</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">getwd</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>,<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>) 
-162:   <span class="ruby-keyword kw">end</span></pre>
+  <pre>     <span class="ruby-comment cmt"># File lib/rio/constructor.rb, line 177</span>
+177:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">cwd</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>,<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)  <span class="ruby-comment cmt"># :yields: self</span>
+178:     <span class="ruby-constant">Rio</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">getwd</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>,<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>) 
+179:   <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/doc/rdoc/classes/RIO.src/M000003.html

@@ -10,9 +10,9 @@
   <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre>     <span class="ruby-comment cmt"># File lib/rio/constructor.rb, line 167</span>
-167:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">root</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>,<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>) <span class="ruby-comment cmt"># :yields: self</span>
-168:     <span class="ruby-constant">Rio</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">rootpath</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>,<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>) 
-169:   <span class="ruby-keyword kw">end</span></pre>
+  <pre>     <span class="ruby-comment cmt"># File lib/rio/constructor.rb, line 184</span>
+184:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">root</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>,<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>) <span class="ruby-comment cmt"># :yields: self</span>
+185:     <span class="ruby-constant">Rio</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">rootpath</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>,<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>) 
+186:   <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/doc/rdoc/classes/RIO/Doc/HOWTO.html

@@ -161,7 +161,7 @@ line chomped
 
 <pre>
  # method 1
- array = ario.chomp.lines(/^\s*require/)
+ array = ario.chomp.lines[/^\s*require/]
  # method 2
  ario.chomp.lines(/^\s*require/) &gt; array
 </pre>
@@ -266,7 +266,7 @@ lines longer than 1024 chars
  # method 2
  ario.print(string)
  # method 3
- ario.noclose &lt; string
+ ario.noautoclose &lt; string
 </pre>
 </li>
 <li>Write a string to a file and close the file
@@ -288,7 +288,7 @@ lines longer than 1024 chars
  # method 2
  ario.a.print(string)
  # method 3
- ario.noclose &lt;&lt; string
+ ario.noautoclose &lt;&lt; string
 </pre>
 </li>
 <li>Append a string to a file and close the file
@@ -309,7 +309,7 @@ lines longer than 1024 chars
  ario = rio('afile').nocloseoncopy
  ario &lt;&lt; array
  # method 2
- ario.noclose &lt; array
+ ario.noautoclose &lt; array
 </pre>
 </li>
 <li>Write an array to a file and close the file
@@ -441,12 +441,16 @@ including those in subdirectories, except those in subdirectories name
  array = ario.norecurse('.svn')['*.txt']
 </pre>
 </li>
-<li>Iterate through all ruby files in a directory structure except those in the
-&#8217;.svn&#8217; and &#8216;pkg&#8217; directories
+<li>Iterate through ruby files in a directory and subdirectories skipping those
+in the &#8217;.svn&#8217;, and &#8216;pkg&#8217; directories
 
 <pre>
  # method 1
- ario.norecurse('.svn','pkg').files('*.rb',proc{ |f| f.executable? and f[0] =~ /^#!.+ruby/ }) { |f| ... }
+ is_ruby_exe = proc{ |f| f.executable? and f[0][0] =~ /^#!.+ruby/ }
+ ario.norecurse('.svn','pkg').files('*.rb',is_ruby_exe) { |f| ... }
+ # method 2
+ is_ruby_exe = proc{ |f| f.executable? and f.gets =~ /^#!.+ruby/ }
+ ario.norecurse('.svn','pkg').files('*.rb',is_ruby_exe) { |f| ... }
 </pre>
 </li>
 <li>Put all files excluding those that are symlinks to files in an array