rio 0.4.2 → 0.5.1

data/lib/rio/if/rubyio.rb

@@ -1,6 +1,7 @@
+# -*- coding: utf-8 -*-
 #--
-# =============================================================================== 
-# Copyright (c) 2005,2006,2007,2008 Christopher Kleckner
+# ===========================================================================
+# Copyright (c) 2005-2012 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -18,22 +19,9 @@
 # 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 IF
     module RubyIO
@@ -49,13 +37,13 @@ module RIO
       #
       def gets(sep_string=$/) target.gets(sep_string) end
 
-      # IF::Grande#each_record
+      # {#each_record}[rdoc-ref:IF::Grande#each_record]
       # 
       #
       #def each_record(&block) target.each_record(&block); self end
 
 
-      # IF::Grande#each_row
+      # {#each_row}[rdoc-ref:IF::Grande#each_row]
       #
       #
       #def each_row(&block) target.each_row(&block); self end
@@ -68,9 +56,9 @@ module RIO
       # The Rio will be opened for reading if not already.
       # lineno counts the number of times gets is called, rather than the number of newlines encountered --
       # so lineno will only be accurate if the file is read exclusively with line-oriented methods 
-      # (IF::RubyIO#readline, IF::GrandeStream#each_line, IF::RubyIO#gets etc.)
+      # ({#readline}[rdoc-ref:IF::RubyIO#readline], {#each_line}[rdoc-ref:IF::GrandeStream#each_line], {#gets}[rdoc-ref:IF::RubyIO#gets] etc.)
       # 
-      # See also the $. variable and IF::RubyIO#recno
+      # See also the $. variable and {#recno}[rdoc-ref:IF::RubyIO#recno]
       #  f = rio("testfile")
       #  f.lineno   #=> 0
       #  f.gets     #=> "This is line one\n"
@@ -100,7 +88,7 @@ module RIO
       # used by the grande selection methods. It represents the zero-based index of the
       # last record read. Returns nil until a record has been read.
       # 
-      # see IF::GrandeStream#lines IF::GrandeStream#bytes and IF::GrandeStream#records
+      # see {#lines}[rdoc-ref:IF::GrandeStream#lines] {#bytes}[rdoc-ref:IF::GrandeStream#bytes] and {#records}[rdoc-ref:IF::GrandeStream#records]
       #
       # To illustrate: Given a file containing three lines "L0\n","L1\n","L2\n"
       # and a Range (0..1)
@@ -118,11 +106,11 @@ module RIO
       #
       #  anarray = rio('afile').lines[0..1] # anarray == ["L0\n", "L1\n"]
       #
-      # +recno+ counts the number of times IF::GrandeStream#getrec or IF::Grande#each is used to get a record. 
+      # +recno+ counts the number of times {#getrec}[rdoc-ref:IF::GrandeStream#getrec] or {#each}[rdoc-ref:IF::Grande#each] is used to get a record. 
       # so +recno+ will only concern parts of the file read with grande methods 
-      # IF::Grande#each, IF::Grande#[], IF::GrandeStream#getrec 
+      # {#each}[rdoc-ref:IF::Grande#each], {#[]}[link:RIO/IF/Grande.html#method-i-5B-5D], {#getrec}[rdoc-ref:IF::GrandeStream#getrec] 
       # 
-      # See also IF::RubyIO#lineno
+      # See also {#lineno}[rdoc-ref:IF::RubyIO#lineno]
       def recno() target.recno() end
 
 
@@ -155,7 +143,7 @@ module RIO
       def each_byte(*args,&block) target.each_byte(*args,&block); self end
 
 
-      # IF::RubyIO#each_bytes
+      # {#each_bytes}[rdoc-ref:IF::RubyIO#each_bytes]
       #
       #
       #def each_bytes(nb,*args,&block) target.each_bytes(nb,*args,&block); self end
@@ -207,7 +195,7 @@ module RIO
       # data is reached, readpartial returns with the data. If EOF is reached,
       # readpartial raises EOFError.
       #
-      # When readpartial doesn�t blocks, it returns or raises immediately. If
+      # When readpartial doesn�t blocks, it returns or raises immediately. If
       # the buffer is not empty, it returns the data in the buffer. Otherwise
       # if the stream has some content, it returns the data in the
       # stream. Otherwise if the stream is reached to EOF, it raises EOFError.
@@ -262,7 +250,7 @@ module RIO
       # 
       def print(*args,&block) target.print(*args,&block); self end
 
-      # Writes the given objects to the rio as with IF::RubyIO#print and then closes the Rio. 
+      # Writes the given objects to the rio as with {#print}[rdoc-ref:IF::RubyIO#print] and then closes the Rio. 
       # Returns the Rio.
       #
       # Equivalent to rio.print(*args).close
@@ -272,7 +260,7 @@ module RIO
       def print!(*args,&block) target.print!(*args,&block); self end
 
 
-      # Writes the given objects to the rio as with IF::RubyIO#printf and then closes the rio. 
+      # Writes the given objects to the rio as with {#printf}[rdoc-ref:IF::RubyIO#printf] and then closes the rio. 
       # Returns the rio.
       #
       # Equivalent to rio.printf(*args).close
@@ -288,7 +276,7 @@ module RIO
       def printf(*argv) target.printf(*argv); self end
 
 
-      # Writes the given objects to the rio as with IF::RubyIO#putc and then closes the rio. 
+      # Writes the given objects to the rio as with {#putc}[rdoc-ref:IF::RubyIO#putc] and then closes the rio. 
       # Returns the rio.
       #
       # Equivalent to rio.putc(*args).close
@@ -315,14 +303,14 @@ module RIO
 
       # Calls IO#puts
       #
-      # Writes the given objects to the rio as with IF::RubyIO#print. 
+      # Writes the given objects to the rio as with {#print}[rdoc-ref:IF::RubyIO#print]. 
       # Writes a record separator (typically a newline) after any that do not already end with a newline sequence. 
       # If called with an array argument, writes each element on a new line. 
       # If called without arguments, outputs a single record separator.
       # Returns the rio.
       def puts(*args) target.puts(*args); self end
 
-      # Writes the given objects to the rio as with IF::RubyIO#puts and then closes the rio. 
+      # Writes the given objects to the rio as with {#puts}[rdoc-ref:IF::RubyIO#puts] and then closes the rio. 
       # Returns the rio.
       #
       # Equivalent to rio.puts(*args).close
@@ -332,7 +320,7 @@ module RIO
       def puts!(*args) target.puts!(*args); self end
 
 
-      # Writes the given objects to the rio as with IF::RubyIO#write and then closes the rio. 
+      # Writes the given objects to the rio as with {#write}[rdoc-ref:IF::RubyIO#write] and then closes the rio. 
       #
       # Equivalent to
       #  ario.write(*args)
@@ -359,17 +347,17 @@ module RIO
 
       # Provides direct access to the IO handle (as would be returned by ::IO#new) *with* filtering. 
       # Reading from and writing to this handle will be affected
-      # by such things as IF::GrandeStream#gzip and IF::GrandeStream#chomp if they were specified for the Rio. 
+      # by such things as {#gzip}[rdoc-ref:IF::GrandeStream#gzip] and {#chomp}[rdoc-ref:IF::GrandeStream#chomp] if they were specified for the Rio. 
       # 
-      # Compare this with IF::RubyIO#ios
+      # Compare this with {#ios}[rdoc-ref:IF::RubyIO#ios]
       #
       def ioh(*args) target.ioh() end
 
       # Provides direct access to the IO handle (as would be returned by ::IO#new) 
       # Reading from and writing to this handle 
-      # is *not* affected by such things as IF::GrandeStream#gzip and IF::GrandeStream#chomp.
+      # is *not* affected by such things as {#gzip}[rdoc-ref:IF::GrandeStream#gzip] and {#chomp}[rdoc-ref:IF::GrandeStream#chomp].
       #
-      # Compare this with IF::RubyIO#ioh
+      # Compare this with {#ioh}[rdoc-ref:IF::RubyIO#ioh]
       #
       def ios(*args) target.ios() end
 
@@ -378,14 +366,14 @@ module RIO
       # Explicitly set the mode with which a Rio will be opened.
       #   ario.mode('r+')   => ario
       # Normally one needs never open a Rio or specify its mode -- the mode is determined by the
-      # operation the Rio is asked to perform. (i.e. IF::RubyIO#print requires write access, IF::RubyIO#readlines requires
+      # operation the Rio is asked to perform. (i.e. {#print}[rdoc-ref:IF::RubyIO#print] requires write access, {#readlines}[rdoc-ref:IF::RubyIO#readlines] requires
       # read access). However there are times when one wishes to be specific about the mode with which a Rio
       # will be opened. Note that explicitly setting the mode overrides all of Rio's internal mode
-      # logic. If a mode is specified via IF::RubyIO#mode or IF::FileOrDir#open that mode will be used. Period.
+      # logic. If a mode is specified via {#mode}[rdoc-ref:IF::RubyIO#mode] or {#open}[rdoc-ref:IF::FileOrDir#open] that mode will be used. Period.
       #
       # Returns the Rio.
       #
-      # See also IF::RubyIO#mode?
+      # See also {#mode?}[rdoc-ref:IF::RubyIO#mode?]
       # 
       # If the mode is given as a String, it must be one of the values listed in the following table.
       #
@@ -425,15 +413,15 @@ module RIO
       # Query a Rio's mode
       #    ario.mode?      #=> a mode string
       #
-      # See IF::RubyIO#mode
+      # See {#mode}[rdoc-ref:IF::RubyIO#mode]
       #
       #  ario = rio('afile')
       #  ario.puts("Hello World") 
-      #  ario.mode?      #=> 'w' IF::RubyIO#puts requires write access
+      #  ario.mode?      #=> 'w' {#puts}[rdoc-ref:IF::RubyIO#puts] requires write access
       #
       #  ario = rio('afile')
       #  ario.gets
-      #  ario.mode?      #=> 'r' IF::RubyIO#gets requires read access
+      #  ario.mode?      #=> 'r' {#gets}[rdoc-ref:IF::RubyIO#gets] requires read access
       #
       #  ario = rio('afile').mode('w+').nocloseoneof
       #  ario.gets
@@ -492,7 +480,7 @@ module RIO
       # Immediately writes all buffered data in _ario_ to disk and
       # return _ario_. 
       # Does nothing if the underlying operating system does not support
-      # _fsync(2)_. Note that +fsync+ differs from using IF::RubyIO#sync. The
+      # _fsync(2)_. Note that +fsync+ differs from using {#sync}[rdoc-ref:IF::RubyIO#sync]. The
       # latter ensures that data is flushed from Ruby's buffers, but
       # doesn't not guarantee that the underlying operating system actually
       # writes it to disk.
@@ -630,7 +618,7 @@ module RIO
       # it immediately if already open. When sync mode is
       # true, all output is immediately flushed to the underlying operating
       # system and is not buffered internally. Returns the rio. See
-      # also IF::RubyIO#fsync, IF::RubyIO#nosync, IF::RubyIO#sync?.
+      # also {#fsync}[rdoc-ref:IF::RubyIO#fsync], {#nosync}[rdoc-ref:IF::RubyIO#nosync], {#sync?}[rdoc-ref:IF::RubyIO#sync?].
       #
       # If a block is given behaves like <tt>ario.sync(arg).each(&block)</tt>
       #
@@ -645,7 +633,7 @@ module RIO
       # it immediately if already open. When sync mode is
       # true, all output is immediately flushed to the underlying operating
       # system and is not buffered internally. Returns the rio. See
-      # also IF::RubyIO#fsync, IF::RubyIO#sync, IF::RubyIO#sync?.
+      # also {#fsync}[rdoc-ref:IF::RubyIO#fsync], {#sync}[rdoc-ref:IF::RubyIO#sync], {#sync?}[rdoc-ref:IF::RubyIO#sync?].
       #
       # If a block is given behaves like <tt>ario.nosync.each(&block)</tt>
       #
@@ -660,8 +648,8 @@ module RIO
       #      ario.sync?    => true or false
       # Returns the current "sync mode" of _ario_. When sync mode is true,
       # all output is immediately flushed to the underlying operating
-      # system and is not buffered by Ruby internally. See also IF::RubyIO#fsync,
-      # IF::RubyIO#sync, IF::RubyIO#nosync
+      # system and is not buffered by Ruby internally. See also {#fsync}[rdoc-ref:IF::RubyIO#fsync],
+      # {#sync}[rdoc-ref:IF::RubyIO#sync], {#nosync}[rdoc-ref:IF::RubyIO#nosync]
       #
       #  f = rio("testfile")
       #  f.sync?   #=> false

data/lib/rio/if/string.rb

@@ -1,6 +1,6 @@
 #--
-# =============================================================================== 
-# Copyright (c) 2005,2006,2007,2008 Christopher Kleckner
+# ===========================================================================
+# Copyright (c) 2005-2012 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -18,22 +18,9 @@
 # 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
   class Rio
     # Returns the String associated with a Rio which references a StringIO object.

data/lib/rio/if/temp.rb

@@ -1,6 +1,6 @@
 #--
-# =============================================================================== 
-# Copyright (c) 2005,2006,2007,2008 Christopher Kleckner
+# ===========================================================================
+# Copyright (c) 2005-2012 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -18,22 +18,9 @@
 # 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
   class Rio
     #def file() target.file; self end

data/lib/rio/if/test.rb

@@ -1,6 +1,7 @@
+# -*- coding: utf-8 -*-
 #--
-# =============================================================================== 
-# Copyright (c) 2005,2006,2007,2008 Christopher Kleckner
+# ===========================================================================
+# Copyright (c) 2005-2012 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -18,22 +19,9 @@
 # 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 IF
     module Test
@@ -89,7 +77,7 @@ module RIO
       #
       # Calls File#fnmatch?
       #
-      # Returns true if IF::Path#path matches <i>pattern</i>. The
+      # Returns true if {#path}[rdoc-ref:IF::Path#path] matches <i>pattern</i>. The
       # pattern is not a regular expression; instead it follows rules
       # similar to shell filename globbing. It may contain the following
       # metacharacters:
@@ -124,8 +112,8 @@ module RIO
 
       # Calls File#ftype
       #
-      # Identifies the type of the named file; the return string is one of 'file�, 'directory�, 
-      # 'characterSpecial�, 'blockSpecial�, 'fifo�, 'link�, 'socket�, or 'unknown�.
+      # Identifies the type of the named file; the return string is one of 'file�, 'directory�, 
+      # 'characterSpecial�, 'blockSpecial�, 'fifo�, 'link�, 'socket�, or 'unknown�.
       def ftype(*args) target.ftype(*args) end
 
       # Calls File#stat
@@ -236,7 +224,7 @@ module RIO
       def zero?(*args) target.zero?(*args) end
 
 
-      # Returns true if the rio represents an absolute path or URI. Alias for IF::Test#absolute?
+      # Returns true if the rio represents an absolute path or URI. Alias for {#absolute?}[rdoc-ref:IF::Test#absolute?]
       #
       #  rio('/tmp').abs?                     # >> true
       #  rio('.ssh').abs?                     # >> false

data/lib/rio/if/yaml.rb

@@ -1,6 +1,6 @@
 #--
-# =============================================================================== 
-# Copyright (c) 2005,2006,2007,2008 Christopher Kleckner
+# ===========================================================================
+# Copyright (c) 2005-2012 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -18,22 +18,9 @@
 # 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 IF
     module YAML
@@ -50,7 +37,7 @@ module RIO
       # +lines+ is the default.
       #
       # The YAML extension distingishes between items selected using
-      # IF::GrandeStream#records, IF::GrandeStream#rows and IF::GrandeStream#lines. 
+      # {#records}[rdoc-ref:IF::GrandeStream#records], {#rows}[rdoc-ref:IF::GrandeStream#rows] and {#lines}[rdoc-ref:IF::GrandeStream#lines]. 
       # Rio returns objects loaded via
       # YAML#load when +records+ or #objects is used; returns the YAML text as a String
       # when +rows+ or #documents is used; and returns lines as Strings as normal when
@@ -92,20 +79,20 @@ module RIO
       #  rio('afile.yaml').yaml.dump(anobject)
       #
       #
-      # Single objects can be written using IF::GrandeStream#putrec (aliased to IF::YAML#putobj
-      # and IF::YAML#dump)
+      # Single objects can be written using {#putrec}[rdoc-ref:IF::GrandeStream#putrec] (aliased to {#putobj}[rdoc-ref:IF::YAML#putobj]
+      # and {#dump}[rdoc-ref:IF::YAML#dump])
       #
       #  rio('afile.yaml').yaml.putobj(anobject)
       #
-      # Single objects can be loaded using IF::GrandeStream#getrec (aliased to IF::YAML#getobj
-      # and IF::YAML#load)
+      # Single objects can be loaded using {#getrec}[rdoc-ref:IF::GrandeStream#getrec] (aliased to {#getobj}[rdoc-ref:IF::YAML#getobj]
+      # and {#load}[rdoc-ref:IF::YAML#load])
       #
       #  anobject = rio('afile.yaml').yaml.getobj
       #
       # A Rio in yaml-mode is just
       # like any other Rio. And all the things you can do with any Rio come
-      # for free.  They can be iterated over using IF::Grande#each and read into an
-      # array using IF::Grande#[] just like any other Rio. All the selection criteria
+      # for free.  They can be iterated over using {#each}[rdoc-ref:IF::Grande#each] and read into an
+      # array using {#[]}[link:RIO/IF/Grande.html#method-i-5B-5D] just like any other Rio. All the selection criteria
       # are identical also.
       #
       # Get the first three objects into an array:
@@ -142,7 +129,7 @@ module RIO
       def objects(*selectors,&block) target.objects(*selectors,&block); self end
 
 
-      # Reject objects from a YAML file. Calls IF::GrandeStream#skiprecords. See #yaml and RIO::Doc::INTRO
+      # Reject objects from a YAML file. Calls {#skiprecords}[rdoc-ref:IF::GrandeStream#skiprecords]. See #yaml and RIO::Doc::INTRO
       def skipobjects(*selectors,&block) target.skipobjects(*selectors,&block); self end
 
 
@@ -150,14 +137,14 @@ module RIO
       def documents(*selectors,&block) target.documents(*selectors,&block); self end
 
 
-      # Reject documents from a YAML file. Calls IF::GrandeStream#skiprows. See #yaml and RIO::Doc::INTRO
+      # Reject documents from a YAML file. Calls {#skiprows}[rdoc-ref:IF::GrandeStream#skiprows]. See #yaml and RIO::Doc::INTRO
       def skipdocuments(*selectors,&block) target.skipdocuments(*selectors,&block); self end
 
-      # Select a single object. See #objects, IF::GrandeStream#line and #yaml.
+      # Select a single object. See #objects, {#line}[rdoc-ref:IF::GrandeStream#line] and #yaml.
       def object(*args,&block) target.object(*args,&block); self end
 
 
-      # Select a single yaml document. See #documents, IF::GrandeStream#line and #yaml.
+      # Select a single yaml document. See #documents, {#line}[rdoc-ref:IF::GrandeStream#line] and #yaml.
       def document(*args,&block) target.document(*args,&block); self end
       
 
@@ -188,7 +175,7 @@ module RIO
       # Calls YAML.dump, leaving the Rio open.
       def putobj(obj) target.putobj(obj); self end
 
-      # Dumps an object to a Rio as with IF::YAML#putobj, and closes the Rio.
+      # Dumps an object to a Rio as with {#putobj}[rdoc-ref:IF::YAML#putobj], and closes the Rio.
       #
       #  rio('afile.yaml').yaml.putobj!(anobject)
       #
@@ -198,7 +185,7 @@ module RIO
       #
       def putobj!(obj) target.putobj!(obj); self end
 
-      # Alias for IF::YAML#putobj!
+      # Alias for {#putobj!}[rdoc-ref:IF::YAML#putobj!]
       def dump(obj) target.dump(obj); self end
 
     end