rio 0.4.2 → 0.5.1

data/doc/RIOIS

@@ -1,215 +0,0 @@
-Rio IS
-
-=== EASY
-
-Anything that does I/O is a Rio:
-
-File:	   
- rio('aflile')
-Directory: 
- rio('adir')
-Web Page:  
- rio('http://ahost/adir/afile')
-Any IO:    
- rio(any_io)
-
-... much more
-
-Makes common tasks easy
-
- rio('afile') > rio('copy of afile')
- rio('adir') > rio('copy of adir')
- rio('gzipped_file.gz').gzip > rio('ungzipped_file')
- chomped_lines = rio('afile').chomp[]
-
-... much more
-
-=== Powerful
-
- rb_files= rio('adir').files['*.rb']
- rb_files_including_those_in_subdirectories = rio('adir').all.files['*.rb']
- first_ten_lines_chomped = rio('afile').chomp[0..9]
- first_ten_lines_chomped_from_gzipped_file = rio('afile.gz').gzip.chomp[0..9]
- first_ten_lines_chomped_from_gzipped_file_on_ftp_server = rio('ftp://ahost/afile.gz').gzip.chomp[0..9]
-
-... much more
-
-=== Consistent
-
-To iterate, add a block: 
- rio('afile').lines(/regular_expression/) { |line| ... }
- rio('adir').files('
-To return an array, use a subscript: 
- rio('afile').lines[/regular_expression/]
-To copy use the copy-operator: 
- rio('afile').lines(/regular_expression/) > rio('destination_file')
-
-
-
-
-
-= Rio - Ruby I/O Facilitator
-
-fa-cil-i-tate:  To make easy or easier [http://www.thefreedictionary.com/facilitate]
-
-== 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.
-
-== New
-
-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']
-
-
-== SYNOPSIS
-
-For the following assume:
- astring = ""
- anarray = []
-
-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 structure to another directory
- rio('adir') >> rio('another_directory')
-
-Copy a web-page to a file
- rio('http://rubydoc.org/') > rio('afile')
-
-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
- 
-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')
-
-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
-
- rio('adir').norecurse(/^\.svn$/,'CVS').files { |entrio| ... }
-
-Create an array of the .rb entries in a directory
- anarray = rio('adir')['*.rb']
-
-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| ... }
-
-Iterate over the non-empty, non-comment chomped lines of a file
- rio('afile').chomp.skip.lines(: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 
-
-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
-
-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(';')
-
-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
-
-== Copyright
-Copyright (c) 2005,2006,2007,2008 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/generators/template/html/rio.css

@@ -1,428 +0,0 @@
-/*
- *
- * = CSS2 RDoc HTML template
- *
- * This is a template for RDoc that uses XHTML 1.0 Transitional and dictates a
- * bit more of the appearance of the output to cascading stylesheets than the
- * default. It was designed for clean inline code display, and uses DHTMl to
- * toggle the visbility of each method's source with each click on the '[source]'
- * link.
- *
- * == Authors
- *
- * * Michael Granger <ged@FaerieMUD.org>
- *
- * Copyright (c) 2002, 2003 The FaerieMUD Consortium. Some rights reserved.
- *
- * This work is licensed under the Creative Commons Attribution License. To view
- * a copy of this license, visit http://creativecommons.org/licenses/by/1.0/ or
- * send a letter to Creative Commons, 559 Nathan Abbott Way, Stanford, California
- * 94305, USA.
- *
- *
- * Modified by Christopher Kleckner
- * Copyright (c) 2005,2006,2007,2008. Some rights reserved.
- * Licensed under the same terms as the original.
- */
-
-body {
-  font-family: Verdana,Arial,Helvetica,sans-serif;
-  font-size:   90%;
-  margin: 0;
-  margin-left: 0px;
-  padding: 0;
-  background: white;
-}
-
-h1,h2,h3,h4 { margin: 0; color: #8b4726; background: transparent; }
-h1 { font-size: 150%; }
-h2 { font-size: 140%; }
-h3 { font-size: 130%; }
-h4 { font-size: 120%; }
-h2,h3,h4 { margin-top: 1em; }
-
-a { 
-  background: transparent; 
-  color: #8b4500;  
-  text-decoration: none; 
-}
-a:hover { 
-  color: #ffa500;
-  background: #8b4500; 
-}
-
-/* Override the base stylesheet's Anchor inside a table cell */
-td > a {
-  background: transparent;
-  color: #099;
-  text-decoration: none;
-}
-
-small { 
-  font-size: 0.7em;
-}
-/* and inside a section title */
-.section-title > a {
-  background: transparent;
-  color: #8b4500; 
-  text-decoration: none;
-}
-
-/* === Structural elements =================================== */
-
-div#index {
-  margin: 0;
-  margin-left: 0px;
-  padding: 0;
-  font-size: 90%;
-  background: #ffdead;
-}
-
-
-div#index a {
-  margin-left: 0.7em;
-}
-div#index-entries a {
-  background: transparent;
-  margin-left: 0.7em;
-  color: #8b4500; 
-}
-div#index-entries a:hover {
-  background: transparent;
-  margin-left: 0.7em;
-  /*   color: #ffdead;  */
-  color: #ffdead; 
-  background: #8b4500; 
-  /*background: #ffdead;*/
-}
-.name-list a {
-  margin-left: 0.7em;
-  background: #ffdead; 
-  color: #8b4500; 
-}
-.name-list a:hover {
-  margin-left: 0.7em;
-  color: #ffdead; 
-  background: #8b4500; 
-}
-.section-bar {
-  color: #555;
-  /*   background: #8b4500; */
-  
-  border-bottom: 1px solid #999;
-  margin-left: 0px;
-}
-
-div#index .section-bar {
-  margin-left: 0px;
-  padding-left: 0.7em;
-  background: #8b4500; 
-  color: #ffdead;
-  font-size: small;
-}
-
-
-.section-title {
-  /*background: #8b4500; */
-  background: #ffdead;
-  color: #eee;
-  padding: 3px;
-  margin-top: 2em;
-  margin-left: 0px;
-  border: 1px solid #999;
-}
-
-div#classHeader, div#fileHeader {
-  width: auto;
-  color: white;
-  padding: 0.5em 1.5em 0.5em 1.5em;
-  margin: 0;
-  margin-left: 0px;
-  border-bottom: 3px solid #006;
-}
-
-div#classHeader a, div#fileHeader a {
-  background: inherit;
-  color: white;
-}
-
-div#classHeader td, div#fileHeader td {
-  background: inherit;
-  color: white;
-}
-
-
-div#fileHeader {
-  background: #8b4500; 
-
-}
-#fileHeader h1,#fileHeader h2,#fileHeader h3,#fileHeader h4 { 
-  margin: 0; 
-  color: #ffdead;
-}
-
-div#classHeader {
-  background: #8b4500; 
-}
-td.class-header-space-col {
-  width: 2em;
-}
-
-
-.class-mod {
-  font-size:  110%;
-  font-weight: bold;
-  font-family: monospace;
-  text-transform: lowercase;
-  text-align: bottom;
-             
-}
-.class-name-in-header {
-  font-size:  150%;
-  font-weight: bold;
-  font-family: monospace;
-}
-.in-url { 
-  font-size: 80%
-}
-
-div#bodyContent {
-    padding: 0 1.5em 0 1.5em;
-}
-
-
-div#description {
-    padding: 0.5em 1.5em;
-    /* background: #efefef; */
-    background: #ffdead;
-    border: 1px dotted #999;
-}
-
-div#description h1,h2,h3,h4,h5,h6 {
-    color: #8b4500;
-    background: transparent;
-}
-
-div#validator-badges {
-    text-align: center;
-}
-div#validator-badges img { border: 0; }
-
-div#copyright {
-    color: #333;
-    background: #efefef;
-    font: 0.75em sans-serif;
-    margin-top: 5em;
-    margin-bottom: 0;
-    padding: 0.5em 2em;
-}
-
-
-/* === Classes =================================== */
-
-table.header-table {
-    color: white;
-    font-size: small;
-}
-
-.type-note {
-    font-size: small;
-    color: #DEDEDE;
-}
-
-.xxsection-bar {
-    background: #eee;
-    color: #333;
-    padding: 3px;
-}
-
-
-
-.section-title {
-    background: #79a;
-    color: #eee;
-    padding: 3px;
-    margin-top: 2em;
-    margin-left: 0px;
-    border: 1px solid #999;
-}
-
-.top-aligned-row {  vertical-align: top }
-.bottom-aligned-row { vertical-align: bottom }
-
-span.include-name {
-  font-size: small;  
-}
-.include-name a {
-  font-weight: bold;
-}
-ul.includes-ul {
-  list-style-type: none;
-  padding-left: 1em;
-}
-
-
-/* --- Context section classes ----------------------- */
-
-.context-row { }
-.context-item-name { font-family: monospace; font-weight: bold; color: black; }
-.context-item-value { font-size: small; color: #448; }
-.context-item-desc { color: #333; padding-left: 2em; }
-
-/* --- Method classes -------------------------- */
-.method-detail {
-    background: #ffdead;
-    padding: 0;
-    margin-top: 0.5em;
-    margin-bottom: 1em;
-    border: 1px dotted #ccc;
-}
-.method-heading {
-  font-family: monospace; 
-  font-weight: bold;
-  font-size: 130%;
-  color: #191970;
-  /* background: #b0c4de; */
-  background: #ffa07a;
-  border-bottom: 1px solid #666;
-  padding: 0.2em 0.5em 0 0.5em;
-}
-.method-heading a {
-   text-decoration: none;
-}
-.method-heading a:hover {
-   text-decoration: underline;
-  background: inherit;
-  color: inherit;
-}
-.method-signature { color: black; background: inherit; }
-.method-name { font-weight: bold; }
-.method-args { font-style: italic; }
-
-.method-description { padding: 0 0.5em 0 0.5em; }
-pre.method-description 
-{ 
-  padding: 0 0.5em 0 0.5em; 
-  color: #ee2222;
-}
-
-#description pre
-{ 
-  padding: 0.2em 0 0.2em 0; 
-  margin: 0.3em 0 0.3em 0;  
-  background: #fff8dc;
-  /* background: #ffffff; */
-  border-left: 3px solid #8b6508; 
-  border-bottom: 1px solid #8b6508;
-  border-top: 1px solid #8b6508;
-}
-
-.method-description pre
-{ 
-  padding: 0.2em 0 0.2em 0; 
-  margin: 0.3em 0 0.3em 0;  
-  background: #fff8dc;
-  /* background: #ffffff; */
-  border-left: 3px solid #8b6508; 
-  border-bottom: 1px solid #8b6508;
-  border-top: 1px solid #8b6508;
-}
-
-
-#description h1 { 
-   color: #8b4500; 
-  margin: 0.5em 0 0.2em 0;
-  /*border: 1px solid red;*/
-  }
-#description h2 { 
-   color: #8b4500; 
-  margin: 0.5em 0 0.2em 0;
-  /*border: 1px solid red;*/
-  }
-#description h3 { 
-   color: #8b4500; 
-  margin: 0.5em 0 0.2em 0;
-  /*border: 1px solid red;*/
-  }
-#description h4 { 
-   color: #8b4500; 
-  margin: 0.5em 0 0.2em 0;
-  /*border: 1px solid red;*/
-  }
-#description p { 
-  margin: 0.5em 0 0.2em 0;
-  /*border: 1px solid red;*/
-  }
-#description ul { 
-  margin: 0.2em 0 0.5em 0;
-  /* border: 1px solid red; */
-  }
-#description a { 
-    background: #ffdead;
-                 /* background: #eef; */
-    color: #8b4500; 
-    text-decoration: none; 
-}
-#description a:hover {     text-decoration: underline;  }
-.method-description a { 
-    background: #ffdead;
-                 /* background: #eef; */
-    color: #8b4500; 
-    text-decoration: none; 
-}
-.method-description a:hover {     text-decoration: underline;  }
-
-.method-description table
-{ 
-  border-top: 1px solid brown; 
-  border-bottom: 1px solid brown; 
-  margin: 0.4em 2em 0.4em 2em;
-}
-.method-description li
-{ 
-  padding: 0 0 0 0; 
-  margin: 0 0 0 0; 
-                    
-}
-.method-description p { 
-  margin: 0.5em 0 0.2em 0;
-  /* border: 1px solid red; */
-  }
-.method-description tt { 
-  margin: 0.5em 0 0.2em 0;
-  font-weight: bold;                     
-  color: #000044;                       
-  }
-.method-description ul { 
-  margin: 0.2em 0 0.5em 0;
-  /* border: 1px solid red; */
-  }
-
-
-/* --- Source code sections -------------------- */
-
-a.source-toggle { font-size: 90%; }
-div.method-source-code {
-    background: #262626;
-    color: #ffdead;
-    margin: 1em;
-    padding: 0.5em;
-    border: 1px dashed #999;
-    overflow: hidden;
-}
-
-div.method-source-code pre { color: #ffdead; overflow: hidden; }
-
-/* --- Ruby keyword styles --------------------- */
-
-.standalone-code { background: #221111; color: #ffdead; overflow: hidden; }
-
-.ruby-constant  { color: #7fffd4; background: transparent; }
-.ruby-keyword { color: #00ffff; background: transparent; }
-.ruby-ivar    { color: #eedd82; background: transparent; }
-.ruby-operator  { color: #00ffee; background: transparent; }
-.ruby-identifier { color: #ffdead; background: transparent; }
-.ruby-node    { color: #ffa07a; background: transparent; }
-.ruby-comment { color: #b22222; font-weight: bold; background: transparent; }
-.ruby-regexp  { color: #ffa07a; background: transparent; }
-.ruby-value   { color: #7fffd4; background: transparent; }