rio 0.3.9 → 0.4.0

data/lib/rio/cp.rb

@@ -187,18 +187,19 @@ module RIO
         protected
 
         def cpfrom_(arg)
-            case arg
-            when ::Array then cpfrom_array_(arg)
-            when ::IO then cpfrom_obj_(arg)
-            when ::String then 
-              self.put_(arg)
-            else cpfrom_rio_(arg)
-            end
-            self
+          case arg
+          when ::Array then cpfrom_array_(arg)
+          when ::IO then cpfrom_obj_(arg)
+          when ::String then 
+            self.put_(arg)
+          else cpfrom_rio_(arg)
+          end
+          self
         end
         def cpfrom_rio_(arg)
           ario = ensure_rio(arg)
           #p ario.cx
+
           ario.copying(self).each { |el|
             self << el
           }.copying_done(self)

data/lib/rio/doc/HOWTO.rb

@@ -38,10 +38,13 @@ module RIO
 module Doc #:doc:
 =begin rdoc
 
-= 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.
 
 == HOWTO...
 
@@ -96,14 +99,18 @@ IO, File, Dir, Pathname, FileUtils, Tempfile, StringIO, OpenURI, Zlib, and CSV.
 
 * Append the first 10 lines of a file into an array, with each line chomped
    # method 1
-   array += ario.chomp.lines[0...10]
+   array += ario.chomp[0...10]
    # method 2
+   array += ario.chomp.lines[0...10]
+   # method 3
    ario.chomp.lines(0...10) >> array
 
 * Read all lines starting with 'require' into an array, with each line chomped
    # method 1
-   array = ario.chomp.lines[/^\s*require/]
+   array = ario.chomp[/^\s*require/]
    # method 2
+   array = ario.chomp.lines[/^\s*require/]
+   # method 3
    ario.chomp.lines(/^\s*require/) > array
 
 * Read a gzipped file into a string
@@ -141,21 +148,25 @@ IO, File, Dir, Pathname, FileUtils, Tempfile, StringIO, OpenURI, Zlib, and CSV.
    rio('afile.rb.gz').gzip.lines(0,/^\s*#/) { |line| ... }
 
 * Iterate through the lines of a ruby file that are neither empty nor comments, with all lines chomped
-   rio('afile.rb.gz').chomp.skiplines(/^\s*#/,:empty?) { |line| ... }
+   rio('afile.rb').chomp.skiplines(/^\s*#/,:empty?) { |line| ... }
 
 * Read all the comment lines from a ruby file into an array with all lines chomped
    # method 1
-   array = rio('afile.rb').chomp.lines[/^\s*#/]
+   array = rio('afile.rb').chomp[/^\s*#/]
    # method 2
+   array = rio('afile.rb').chomp.lines[/^\s*#/]
+   # method 3
    rio('afile.rb').chomp.lines(/^\s*#/) > array
   
 
 * Read lines of a file into an array, with each line chomped, skipping any lines longer than 1024 chars
    # method 1
-   ario.chomp.lines(proc{ |line| line.length <= 1024}) > array
+   array = ario.chomp[proc{ |line| line.length <= 1024}]
    # method 2
-   array = ario.chomp.skiplines[proc{ |line| line.length > 1024}]
+   ario.chomp.lines(proc{ |line| line.length <= 1024}) > array
    # method 3
+   array = ario.chomp.skiplines[proc{ |line| line.length > 1024}]
+   # method 4
    array = ario.chomp.lines(proc{ |line| line.length <= 1024}).to_a
 
 ---
@@ -221,17 +232,17 @@ IO, File, Dir, Pathname, FileUtils, Tempfile, StringIO, OpenURI, Zlib, and CSV.
    # method 1
    array = ario[0..9,99]
    # method 2
-   array = ario[0...10,99..99]
+   array = ario.lines[0..9,99]
    # method 3
-   ario(0..9,99) > array
+   ario.lines(0..9,99) > array
   
-* Put lines one thru ten,line 100 and lines starting with 'zippy' into an array
+* Put lines one thru ten,line 100 and lines starting with 'rio4ruby' into an array
    # method 1
-   array = ario[0..9,99,/^zippy/]
+   array = ario[0..9,99,/^rio4ruby/]
    # method 2
-   array = ario[0...10,99..99,/^zippy/]
+   array = ario.lines[0..9,99,/^rio4ruby/]
    # method 3
-   ario(0..9,99,/^zippy/) > array
+   ario.lines(0..9,99,/^rio4ruby/) > array
   
 * Put lines that are longer than 128 bytes into an array
    # method 1
@@ -240,20 +251,22 @@ IO, File, Dir, Pathname, FileUtils, Tempfile, StringIO, OpenURI, Zlib, and CSV.
    array = ario.lines[proc{ |l| l.length > 128}]
    # method 3
    array = ario.skiplines[proc{ |l| l.length <= 128}]
+   # method 4
+   array = ario.skip.lines[proc{ |l| l.length <= 128}]
   
-* Copy all lines that do not start with 'zippy' into another file
+* Copy all lines that do not start with 'rio4ruby' into another file
    # method 1
-   ario.skiplines(/^zippy/) > rio('another_file')
+   ario.skiplines(/^rio4ruby/) > rio('another_file')
    # method 2
-   ario.lines.skiplines(/^zippy/) > rio('another_file')
+   ario.lines.skiplines(/^rio4ruby/) > rio('another_file')
    # method 3
-   rio('another_file') < ario.skiplines(/^zippy/)
+   rio('another_file') < ario.skiplines(/^rio4ruby/)
   
-* Copy the first 10 lines and lines starting with 'zippy', but exclude any lines longer than 128 bytes
+* Copy the first 10 lines and lines starting with 'rio4ruby', but exclude any lines longer than 128 bytes
    # method 1
-   ario.lines(0...10,/^zippy/).skiplines(proc{ |l| l.length > 128}] > rio('another_file')
+   ario.lines(0...10,/^rio4ruby/).skiplines(proc{ |l| l.length > 128}] > rio('another_file')
    # method 2
-   rio('another_file') < ario.lines(0...10,/^zippy/).skiplines(proc{ |l| l.length > 128})
+   rio('another_file') < ario.lines(0...10,/^rio4ruby/).skiplines(proc{ |l| l.length > 128})
   
 
 
@@ -458,9 +471,9 @@ IO, File, Dir, Pathname, FileUtils, Tempfile, StringIO, OpenURI, Zlib, and CSV.
 
 * Count the lines of code in a directory tree of ruby source files
    # method 1
-   cnt = ario.all.files('*.rb').chomp.skiplines(/^\s*#/,/^\s*$/).inject(0) { |sum,l|  sum += 1 }
+   cnt = ario.all.files('*.rb').skiplines[/^\s*#/,/^\s*$/].size
    # method 2
-   cnt = ario.all.files('*.rb').chomp.skiplines[/^\s*#/,/^\s*$/].size
+   cnt = ario.all.files('*.rb').skiplines(/^\s*#/,/^\s*$/).inject(0) { |sum,l|  sum += 1 }
 
 * Concatanate the contents of all .txt files in a directory into an array
    # method 1
@@ -550,19 +563,21 @@ IO, File, Dir, Pathname, FileUtils, Tempfile, StringIO, OpenURI, Zlib, and CSV.
 
 * Dump a file to stdout
    # method 1
-   rio(?-) << rio('afile')
+   rio('afile') > ?-
    # method 2
-   rio('afile') >> rio(?-)
-   # method 3
    rio('afile') > rio(?-)
+   # method 3
+   rio(?-) << rio('afile')
    # method 4
-   rio(?-) < rio('afile')
+   rio('afile') >> ?-
    # method 5
+   rio(?-) < rio('afile')
+   # method 6
    rio(?-).print(rio('afile').contents)
 
 * Emulate a simplified unix 'head' command which reads from stdin and writes the first 10 lines to stdout
    # method 1
-   rio(?-).lines(0..9) > rio(?-)
+   rio(?-).lines(0..9) > ?-
 
 ---
 
@@ -629,9 +644,9 @@ IO, File, Dir, Pathname, FileUtils, Tempfile, StringIO, OpenURI, Zlib, and CSV.
    # method 1
    ario.rename.extname = '.html'
 
-* Change a files basename to 'zippy' without changing its extension
+* Change a files basename to 'rio4ruby' without changing its extension
    # method 1
-   ario.rename.basename = 'zippy'
+   ario.rename.basename = 'rio4ruby'
 
 * Change a file ending with '.tar.gz' to end with '.tgz'
    # method 1
@@ -678,7 +693,6 @@ IO, File, Dir, Pathname, FileUtils, Tempfile, StringIO, OpenURI, Zlib, and CSV.
    ap = ap.join('subdirectory')
    # method 3
    ap = rio(ap,'subdirectory')
-   # method 4
 
 * Create a Rio from an array of subdirectories
    dirs = ['adir','subdir1','subdir2']

data/lib/rio/doc/INDEX.rb

@@ -0,0 +1,311 @@
+#--
+# =============================================================================== 
+# 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.
+#
+# Suggested Reading
+# * RIO::Doc::SYNOPSIS
+# * RIO::Doc::INTRO
+# * RIO::Doc::HOWTO
+# * RIO::Doc::EXAMPLES
+# * RIO::Rio
+#
+
+
+module RIO
+module Doc
+=begin rdoc
+
+= Rio - Index
+
+Constructors:
+RIO#rio
+RIO#cwd
+RIO#root
+
+Directories:
+RIO::IF::Dir#chdir
+RIO::IF::Dir#find
+RIO::IF::Dir#glob
+RIO::IF::Dir#mkdir
+RIO::IF::Dir#mkpath
+RIO::IF::Dir#rmdir
+RIO::IF::Dir#rmtree
+
+Files:
+RIO::IF::File#clear
+RIO::IF::File#rm
+RIO::IF::File#touch
+RIO::IF::File#truncate
+
+Files or Directories:
+RIO::IF::FileOrDir#open
+RIO::IF::FileOrDir#pos
+RIO::IF::FileOrDir#pos=
+RIO::IF::FileOrDir#read
+RIO::IF::FileOrDir#readlink
+RIO::IF::FileOrDir#rename
+RIO::IF::FileOrDir#rename!
+RIO::IF::FileOrDir#reopen
+RIO::IF::FileOrDir#rewind
+RIO::IF::FileOrDir#seek
+RIO::IF::FileOrDir#symlink
+RIO::IF::FileOrDir#tell
+
+Path:
+RIO::IF::Path#/
+RIO::IF::Path#abs
+RIO::IF::Path#base
+RIO::IF::Path#basename
+RIO::IF::Path#basename=
+RIO::IF::Path#cleanpath
+RIO::IF::Path#dirname
+RIO::IF::Path#dirname=
+RIO::IF::Path#expand_path
+RIO::IF::Path#ext
+RIO::IF::Path#ext?
+RIO::IF::Path#extname
+RIO::IF::Path#extname=
+RIO::IF::Path#filename
+RIO::IF::Path#filename=
+RIO::IF::Path#fspath
+RIO::IF::Path#host
+RIO::IF::Path#join
+RIO::IF::Path#join!
+RIO::IF::Path#merge
+RIO::IF::Path#noext
+RIO::IF::Path#opaque
+RIO::IF::Path#path
+RIO::IF::Path#realpath
+RIO::IF::Path#rel
+RIO::IF::Path#route_from
+RIO::IF::Path#route_to
+RIO::IF::Path#scheme
+RIO::IF::Path#splitpath
+RIO::IF::Path#to_uri
+RIO::IF::Path#to_url
+RIO::IF::Path#urlpath
+
+String:
+RIO::IF::String#+
+RIO::IF::String#gsub
+RIO::IF::String#sub
+
+Grande:
+RIO::IF::Grande#[]
+RIO::IF::Grande#<
+RIO::IF::Grande#<<
+RIO::IF::Grande#>
+RIO::IF::Grande#>>
+RIO::IF::Grande#|
+RIO::IF::Grande#append_from
+RIO::IF::Grande#append_to
+RIO::IF::Grande#copy_from
+RIO::IF::Grande#copy_to
+RIO::IF::Grande#delete
+RIO::IF::Grande#delete!
+RIO::IF::Grande#each
+RIO::IF::Grande#empty?
+RIO::IF::Grande#get
+RIO::IF::Grande#skip
+RIO::IF::Grande#split
+RIO::IF::Grande#to_a
+
+Grande Directory:
+RIO::IF::GrandeEntry#all
+RIO::IF::GrandeEntry#all?
+RIO::IF::GrandeEntry#dirs
+RIO::IF::GrandeEntry#entries
+RIO::IF::GrandeEntry#files
+RIO::IF::GrandeEntry#norecurse
+RIO::IF::GrandeEntry#recurse
+RIO::IF::GrandeEntry#skipdirs
+RIO::IF::GrandeEntry#skipentries
+RIO::IF::GrandeEntry#skipfiles
+
+Grande Stream:
+RIO::IF::GrandeStream#+@
+RIO::IF::GrandeStream#a
+RIO::IF::GrandeStream#a!
+RIO::IF::GrandeStream#bytes
+RIO::IF::GrandeStream#chomp
+RIO::IF::GrandeStream#chomp?
+RIO::IF::GrandeStream#closeoncopy
+RIO::IF::GrandeStream#closeoncopy?
+RIO::IF::GrandeStream#closeoneof
+RIO::IF::GrandeStream#closeoneof?
+RIO::IF::GrandeStream#contents
+RIO::IF::GrandeStream#getline
+RIO::IF::GrandeStream#getrec
+RIO::IF::GrandeStream#getrow
+RIO::IF::GrandeStream#gzip
+RIO::IF::GrandeStream#gzip?
+RIO::IF::GrandeStream#line
+RIO::IF::GrandeStream#lines
+RIO::IF::GrandeStream#noautoclose
+RIO::IF::GrandeStream#nocloseoncopy
+RIO::IF::GrandeStream#nocloseoneof
+RIO::IF::GrandeStream#putrec
+RIO::IF::GrandeStream#r
+RIO::IF::GrandeStream#r!
+RIO::IF::GrandeStream#record
+RIO::IF::GrandeStream#records
+RIO::IF::GrandeStream#row
+RIO::IF::GrandeStream#rows
+RIO::IF::GrandeStream#skiplines
+RIO::IF::GrandeStream#skiprecords
+RIO::IF::GrandeStream#skiprows
+RIO::IF::GrandeStream#splitlines
+RIO::IF::GrandeStream#strip
+RIO::IF::GrandeStream#strip?
+RIO::IF::GrandeStream#w
+RIO::IF::GrandeStream#w!
+
+Ruby I/O:
+RIO::IF::RubyIO#binmode
+RIO::IF::RubyIO#close
+RIO::IF::RubyIO#close_write
+RIO::IF::RubyIO#each_byte
+RIO::IF::RubyIO#each_line
+RIO::IF::RubyIO#eof?
+RIO::IF::RubyIO#fcntl
+RIO::IF::RubyIO#fileno
+RIO::IF::RubyIO#flush
+RIO::IF::RubyIO#fsync
+RIO::IF::RubyIO#getc
+RIO::IF::RubyIO#gets
+RIO::IF::RubyIO#ioctl
+RIO::IF::RubyIO#ioh
+RIO::IF::RubyIO#ios
+RIO::IF::RubyIO#lineno
+RIO::IF::RubyIO#lineno=
+RIO::IF::RubyIO#mode
+RIO::IF::RubyIO#mode?
+RIO::IF::RubyIO#nosync
+RIO::IF::RubyIO#pid
+RIO::IF::RubyIO#print
+RIO::IF::RubyIO#print!
+RIO::IF::RubyIO#printf
+RIO::IF::RubyIO#printf!
+RIO::IF::RubyIO#putc
+RIO::IF::RubyIO#putc!
+RIO::IF::RubyIO#puts
+RIO::IF::RubyIO#puts!
+RIO::IF::RubyIO#readline
+RIO::IF::RubyIO#readlines
+RIO::IF::RubyIO#readpartial
+RIO::IF::RubyIO#recno
+RIO::IF::RubyIO#sync
+RIO::IF::RubyIO#sync?
+RIO::IF::RubyIO#to_i
+RIO::IF::RubyIO#to_io
+RIO::IF::RubyIO#tty?
+RIO::IF::RubyIO#ungetc
+RIO::IF::RubyIO#write
+RIO::IF::RubyIO#write!
+
+Test:
+RIO::IF::Test#abs?
+RIO::IF::Test#absolute?
+RIO::IF::Test#atime
+RIO::IF::Test#blockdev?
+RIO::IF::Test#chardev?
+RIO::IF::Test#closed?
+RIO::IF::Test#ctime
+RIO::IF::Test#dir?
+RIO::IF::Test#directory?
+RIO::IF::Test#executable_real?
+RIO::IF::Test#executable?
+RIO::IF::Test#exist?
+RIO::IF::Test#file?
+RIO::IF::Test#fnmatch?
+RIO::IF::Test#ftype
+RIO::IF::Test#grpowned?
+RIO::IF::Test#lstat
+RIO::IF::Test#mountpoint?
+RIO::IF::Test#mtime
+RIO::IF::Test#open?
+RIO::IF::Test#owned?
+RIO::IF::Test#pipe?
+RIO::IF::Test#readable_real?
+RIO::IF::Test#readable?
+RIO::IF::Test#root?
+RIO::IF::Test#setgid?
+RIO::IF::Test#setuid?
+RIO::IF::Test#size
+RIO::IF::Test#size?
+RIO::IF::Test#socket?
+RIO::IF::Test#stat
+RIO::IF::Test#sticky?
+RIO::IF::Test#symlink?
+RIO::IF::Test#writable_real?
+RIO::IF::Test#writable?
+RIO::IF::Test#zero?
+
+
+Basic:
+RIO::Rio#==
+RIO::Rio#===
+RIO::Rio#=~
+RIO::Rio#dup
+RIO::Rio#eql?
+RIO::Rio#hash
+RIO::Rio#initialize_copy
+RIO::Rio#inspect
+RIO::Rio#length
+RIO::Rio#new
+RIO::Rio#rio
+RIO::Rio#string
+RIO::Rio#to_s
+RIO::Rio#to_str
+
+CSV:
+RIO::IF::CSV#columns
+RIO::IF::CSV#csv
+RIO::IF::CSV#skipcolumns
+
+YAML:
+RIO::IF::YAML#document
+RIO::IF::YAML#documents
+RIO::IF::YAML#dump
+RIO::IF::YAML#getobj
+RIO::IF::YAML#load
+RIO::IF::YAML#object
+RIO::IF::YAML#objects
+RIO::IF::YAML#putobj
+RIO::IF::YAML#putobj!
+RIO::IF::YAML#skipdocuments
+RIO::IF::YAML#skipobjects
+RIO::IF::YAML#yaml
+RIO::IF::YAML#yaml?
+
+
+
+=end
+module INDEX
+end
+end
+end
+