rio 0.3.8 → 0.3.9

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

@@ -0,0 +1,130 @@
+# 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
+#
+
+
+# This is disgraceful -- a hack required to exert control over how rubygems builds
+# documentation for Rio. My desire to have the command "gem install rio" build the
+# docs correctly overrides my sense of propriety in this case. I apologize to anyone
+# who should have to look at this ugliness. 
+
+# Begin UGLY
+module Generators #:nodoc: all
+  #####################################################################
+  #
+  # Handle common markup tasks for the various Html classes
+  #
+
+  module MarkUp
+
+    # Convert a string in markup format into HTML. We keep a cached
+    # SimpleMarkup object lying around after the first time we're
+    # called per object.
+
+    def markup(str, remove_para=false)
+      return '' unless str
+      unless defined? @markup
+        #p 'RIO MARKUP'
+        @markup = SM::SimpleMarkup.new
+
+        # class names, variable names, file names, or instance variables
+#        @markup.add_special(/(
+#                               \b([A-Z]\w*(::\w+)*[.\#]\w+)  #    A::B.meth
+#                             | \b([A-Z]\w+(::\w+)*)       #    A::B..
+#                             | \#\w+[!?=]?                #    #meth_name 
+#                             | \b\w+([_\/\.]+\w+)+[!?=]?  #    meth_name
+#                             )/x, 
+#                            :CROSSREF)
+        meth_name_re = '\w+[!?=]?|<{1,2}|>{1,2}|\[\]|\||\/|\+@?|={2,3}|=~'
+        @markup.add_special(/(
+                               \b([A-Z]\w*(::\w+)*[.\#](#{meth_name_re}))  #    A::B.meth
+                             | \b([A-Z]\w+(::\w+)*)       #    A::B..
+                             | \#(#{meth_name_re})                #    #meth_name 
+                             | \b\w+([_\/\.]+\w+)+[!?=]?  #    meth_name
+                             )/x, 
+                            :CROSSREF)
+
+        # external hyperlinks
+        @markup.add_special(/((link:|https?:|mailto:|ftp:|www\.)\S+\w)/, :HYPERLINK)
+
+        # and links of the form  <text>[<url>]
+        @markup.add_special(/(((\{.*?\})|\b\S+?)\[\S+?\.\S+?\])/, :TIDYLINK)
+#        @markup.add_special(/\b(\S+?\[\S+?\.\S+?\])/, :TIDYLINK)
+
+      end
+      unless defined? @html_formatter
+        @html_formatter = HyperlinkHtml.new(self.path, self)
+      end
+
+      # Convert leading comment markers to spaces, but only
+      # if all non-blank lines have them
+
+      if str =~ /^(?>\s*)[^\#]/
+        content = str
+      else
+        content = str.gsub(/^\s*(#+)/)  { $1.tr('#',' ') }
+      end
+
+      res = @markup.convert(content, @html_formatter)
+      if remove_para
+        res.sub!(/^<p>/, '')
+        res.sub!(/<\/p>$/, '')
+      end
+      res
+    end
+  end
+end
+module Generators
+  class HyperlinkHtml < SM::ToHtml
+    def handle_special_CROSSREF(special)
+      #p 'handle_special_CROSSREF'
+      name = special.text
+      if name[0,1] == '#'
+        lookup = name[1..-1]
+        name = lookup unless Options.instance.show_hash
+      else
+        lookup = name
+      end
+
+      if /([A-Z].*)[.\#](.*)/ =~ lookup
+        container = $1
+        method = $2
+        ref = @context.find_symbol(container, method)
+      else
+        ref = @context.find_symbol(lookup)
+      end
+
+      if ref and ref.document_self
+        #print "#{name} =>"
+        name.sub!(/^(RIO::)?IF::.+\#/,'Rio#')
+        name.sub!(/^#/,'Rio#')
+        #puts " #{name}"
+        if %w[Rio Grande String].include?(name) or name =~ /^(Dir)/
+        #if %w[Rio Grande String].include?(name)
+          name
+        else
+          "<a href=\"#{ref.as_href(@from_path)}\">#{name}</a>"
+        end
+      else
+        name
+      end
+    end
+  end
+end
+# End UGLY

data/doc/pkg_def.rb

@@ -0,0 +1,66 @@
+#--
+# =============================================================================== 
+# 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.
+#++
+
+require 'rio/doc'
+
+module PKG
+  NAME = "rio"
+  TITLE = RIO::TITLE
+  VERSION = RIO::VERSION
+  FULLNAME = PKG::NAME + "-" + PKG::VERSION
+  SUMMARY = RIO::SUMMARY
+  DESCRIPTION = RIO::DESCRIPTION
+  AUTHOR = "Christopher Kleckner"
+  EMAIL = "rio4ruby@rubyforge.org"
+  HOMEPAGE = "http://rio.rubyforge.org/"
+  RUBYFORGE_PROJECT = "rio"
+  RDOC_OPTIONS = ['--show-hash','--line-numbers','-mRIO::Doc::SYNOPSIS','-Tdoc/generators/template/html/rio.rb']
+  module FILES
+    SRC = rio('lib').norecurse('.svn').files['*.rb']
+    DOC = rio['README'] + rio('lib')['rio.rb'] + rio('lib/rio/doc/')['*.rb'] +
+                        rio('lib/rio/if/')['*.rb'] + rio('lib/rio')['kernel.rb','constructor.rb']
+    XMP = rio('ex').entries[]
+    D2 = rio('doc').norecurse('.svn').all.files.skip.dirs['rdoc','.svn']
+    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 }
+end

data/ex/catcsv.rb

@@ -0,0 +1,64 @@
+#!/usr/local/bin/ruby
+
+require 'rio'
+require 'rio/argv'
+# Concatonate all the CSV files in a directory, but only include the header
+# line from one of them.
+require 'optparse'
+require 'optparse/time'
+require 'ostruct'
+require 'pp'
+
+class CatCSVOptions
+  
+  #
+  # Return a structure describing the options.
+  #
+  def self.parse(args)
+    # The options specified on the command line will be collected in *options*.
+    # We set default values here.
+    options = OpenStruct.new
+    options.outfile = nil
+    
+    opts = OptionParser.new do |opts|
+      opts.banner = "Usage: #{$0} [options] csv_directory"
+      
+      opts.separator ""
+      opts.separator "Specific options:"
+      
+      opts.on("-o", "--output [OUTPUT_FILE]", "Specify the output CSV file") do |ofile|
+        options.outfile = ofile
+      end
+      
+      # No argument, shows at tail.  This will print an options summary.
+      # Try it and see!
+      opts.on_tail("-h", "--help", "Show this message") do
+        puts opts
+        exit
+      end
+      
+      # Print the version.
+      opts.on_tail("--version", "Show version") do
+        puts OptionParser::Version.join('.')
+        exit
+      end
+    end
+    
+    opts.parse!(args)
+    options
+  end  # parse()
+  
+end 
+
+options = CatCSVOptions.parse(ARGV)
+
+csvdir = RIO.ARGV.shift
+unless csvdir
+  puts options
+  exit
+end
+output_file = options.outfile ? rio(options.outfile) : rio(csvdir.filename + '.all.csv')
+
+output_file << rio(csvdir).files['*.csv'][0][0] << rio(csvdir).skip.lines(0)
+
+__END__

data/ex/colx.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+require 'rio'
+
+RGBFILE = rio(__FILE__).dirname/'rgb.txt.gz'
+
+RGBFILE.gzip.lines(/^\s*(\d+)\s+(\d+)\s+(\d+)\s+(\S.+)/) do |line,ma| 
+  printf("#%02x%02x%02x\t%s\n",*ma[1..4])
+end

data/ex/findinruby

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'rio'
+require 'rio/argv'
+
+re = ARGV.shift
+
+is_ruby_exe = proc{ |f| f.executable? and f.line[0] =~ /^#!.+ruby/ }
+
+RIO.ARGV.each do |rpath|
+  rpath.norecurse('.svn','pkg').files('*.rb',is_ruby_exe) do |f|
+    print f.lines(/#{re}/).map{ |l| "#{f}: #{l}" }
+  end
+end
+__END__

data/ex/findruby

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'rio'
+require 'rio/argv'
+
+is_ruby_exe = proc{ |f| f.executable? and f.line[0] =~ /^#!.+ruby/ }
+
+RIO.ARGV.each do |rpath|
+  rpath.norecurse('.svn','pkg').files('*.rb',is_ruby_exe) do |f|
+    puts f
+  end
+end
+
+__END__

data/ex/passwd_report.rb

@@ -0,0 +1,8 @@
+#!/usr/local/bin/ruby
+require 'rio'
+
+# 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(?-).csv("\t")
+

data/ex/prompt.rb

@@ -0,0 +1,25 @@
+#!/usr/local/bin/ruby
+
+require 'rio'
+
+ans = rio(?-).chomp.print("Type Something: ").gets
+rio(?-).puts("You typed '#{ans}'")
+
+# Could also be written like this
+#
+#stdio = rio(?-).chomp
+#ans = stdio.print("Type Something: ").gets
+#stdio.puts("You typed '#{ans}'")
+#
+# Or even this
+#
+#stdio = rio(?-).chomp
+#stdio.puts("You typed '#{stdio.print("Type Something: ").gets}'")
+#
+# Or this
+#
+#rio(?-).puts("You typed '#{rio(?-).chomp.print("Type Something: ").gets}'")
+#
+
+
+__END__

data/ex/riocat

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+
+require 'rio'
+
+# riocat: reads from stdin and writes it to stdout
+# example use:
+#   riocat < afile.txt >bfile.txt
+# 
+# explanation:
+#
+# rio(?-)
+#   rio(?-): a rio that will be connected to stdin or stdout depending how it is used
+#
+# rio(?-)
+#   rio(?-): a rio that will be connected to stdin or stdout depending how it is used
+#
+# <
+#   <: copy operator indicating rio on left is written to and the rio on the right is read from
+#
+rio(?-) < ?-
+
+#
+# this could also be written
+#    rio(?-) < rio(?-)
+# or
+#    rio(?-) > ?-
+# or
+#    rio(?-) > rio(?-)
+#
+#
+# this is similar but reads the entire file before writing
+#    rio(?-).print!( rio(?-).slurp )
+
+
+
+#rio(?-).print!( rio(?-).slurp)
+
+
+# DONT DO THIS:
+#io = rio(?-)
+#io.print!( io.slurp )
+

data/ex/riogunzip

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require 'rio'
+# riogunzip: reads from stdin, gzips and writes it to stdout
+# example use:
+#   riogunzip < afile.txt.gz
+# 
+# explanation:
+#
+# rio(?-).gzip
+#   rio(?-): a rio that will be connected to stdin or stdout depending how it is used
+#   .gzip: filter the input or output through Zlib:Gzip[Reader or Writer]
+#
+# rio(?-)
+#   rio(?-): a rio that will be connected to stdin or stdout depending how it is used
+#
+# <
+#   rio copy operator indicating the direction of data
+#   pointed in this direction the rio on the right is read from and the one on the left is
+#   written. (or stdin and stdout respectively)
+#
+rio(?-).gzip > rio(?-)
+
+# could be written this way
+# rio(?-) < rio(?-).gzip
+#
+# this is similar, but reads the entire file in before writing it out
+#    rio(?-).print!( rio(?-).gzip.contents )
+#
+#rio(?-).gzip.each_record do |rec|
+#  rio(?-).print(rec)
+#end

data/ex/riogzip

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+require 'rio'
+# riogzip: reads from stdin, gzips and writes it to stdout
+# example use:
+#   riogzip < afile.txt > afile.txt.gz
+# 
+# explanation:
+#
+# rio(?-).gzip
+#   rio(?-): a rio that will be connected to stdin or stdout depending how it is used
+#   .gzip: filter the input or output through Zlib:Gzip[Reader or Writer]
+#
+# rio(?-)
+#   rio(?-): a rio that will be connected to stdin or stdout depending how it is used
+#
+# <
+# rio copy operator indicating the direction of data
+
+rio(?-).gzip < rio(?-)
+
+# 
+# could also be written:
+# rio(?-) > rio(?-).gzip
+# 

data/ex/rioprompt.rb

@@ -0,0 +1,10 @@
+#!/usr/local/bin/ruby
+
+require 'rio/prompt'
+
+case answer = RIO.prompt("What is the crux of the biscuit: ")
+when /the apostrophe/i 
+  puts 'Billy was a Mountain'
+else 
+  puts "You typed '#{answer}'"
+end