narf 0.5.1

data/lib/web.rb

@@ -0,0 +1,290 @@
+require 'test/unit/assertions'
+
+require 'web/strscanparser'
+require 'web/action'
+require 'web/buffer'
+require 'web/upload'
+require 'web/parser'
+require 'web/session'
+require 'web/writableio'
+require 'web/template'
+require 'web/assertinclude'
+require 'web/forms'
+require 'web/tagparser'
+require 'web/testing'
+require 'web/formreader.rb'
+require 'web/simpledispatcher'
+require 'web/traceoutput'
+require 'web/mime'
+require 'web/cgi'
+
+require 'web/htmltools/tree'
+
+# Write output to client.  Replaces Kernel.puts;
+# use that or $stderr.puts if you want the standard puts.
+def puts( *args )
+    Web.puts args
+end
+
+begin
+    require('stringio') 
+rescue LoadError    
+  module Web
+    class StringIO  # :nodoc:
+      def initialize
+        @___content___ = ""
+      end
+      
+      def read
+        @___content___
+      end
+      
+      def clear
+        @___content___ = ""
+      end
+      
+      def string
+        @___content___
+      end
+      
+      def puts(*args)
+        @___content___ << args.join("\n") << "\n"
+      end
+      
+      def << var
+        @___content___ << var.to_s
+      end
+      
+      def write var
+        @___content___ << var.to_s
+      end
+      
+      def print var
+        @___content___ << var.to_s
+      end
+    end
+  end
+  
+  unless Kernel.const_defined? "StringIO"
+    StringIO = Web::StringIO.clone
+  end
+end
+
+# == Purpose
+# Web provides an infrastructure for building and testing
+# web applications.
+#
+# == Usage
+# Use the Web module to interact with the client.  The module
+# delegates to a Web::CGI object, which does the actual work.
+#
+#     #!/usr/bin/narf
+#     Web["field"]                      # access parameters
+#     Web.cookies["muppet"]             # access cookies
+#     Web.session["key"] ||= "value"    # get and set session values
+#     Web.set_cookie( "muppet", "cookie monster" ) # set cookies
+#     Web.puts "something"              # print 'something' out
+#
+# If the request contained multipart/form-data, uploaded files are returned as
+# Web::Upload objects.  Other parameters are treated as strings.
+#
+# == Output
+#
+# You write output as if it were an IO:
+#     Web << "<h1>Hello World!</h1>"
+#     Web.print "<p>We have lots of tricks for you.<br>"
+#     Web.write "From kungfu to jiujitsu<br>"
+#     Web.puts  "anything and everything works</p>."
+# or even:
+#     puts "hello world"
+#
+# Narf buffers output by default.  Buffered output allows you to set headers
+# (cookies, redirects, status, etc.) at any point before the cgi is flushed.
+# You can force this by calling:
+#     Web.flush
+#
+# Once the headers are sent to the client, you cannot set any more headers.
+#
+# == Error Handling
+#
+# For cgi-scripts under Apache, one can use the 'bin/narf'
+# script instead of using the ruby executable.  This little c program
+# doesn't do much fancy, but it can trap syntax errors and send them
+# back to the browser.  <i>I would especially appreciate security-related
+# feedback; narf.c is contributed and I am not a c programmer.</i>
+#
+# == Sessions:
+#
+# Sessions provide a way of storing data between Web
+# requests. Anything that can be marshalled can be stored in the
+# session. 
+#
+# === Getting and Setting values in a session
+#
+#      Web.session["key"] = "value"
+#      Web.session["key"]             # => "value"
+#
+# === Deleting session values
+#
+#      Web.session["key"] = "value"
+#      Web.session["key"].delete      # => "value"
+#      Web.session["key"]             # => "nil"
+#
+# === Iterating through session keys
+#
+#      Web.session.each do |key, val|
+#          Web.puts "#{key} => #{val}<br>"
+#      end
+#
+# === Resetting the Session
+#
+# Reseting the session to an empty hash is simple:
+#     Web.session.reset
+#
+# === Testing
+#
+# Narf takes testing very seriously.  I consider supporting
+# testing to be part of the contract when writing a IO library.
+# See Web::Testing for more details.
+#
+module Web
+    class << self
+      # Web delegates to the current
+      # cgi object.  This is the recommended
+      # way to use narf:
+      #
+      #    Web["param"]
+      #    Web << "hello world"
+      #    Web.set_redirect( "http://www.narf-lib.org" )
+      #    ...
+      # 
+      # The documentation for these methods is on the Web::CGI object.
+      def method_missing(method, *args, &block)
+        CGI.get_cgi.send(method,*args, &block)
+      end
+
+      def set_cgi( cgi )
+        CGI.set_cgi( cgi )
+      end
+
+      def get_cgi
+        CGI.get_cgi
+      end
+
+      def process(options={}, &block)
+        CGI.process(options, &block)
+      end
+    end
+
+    # this is a bit incomplete -- only encodes ampersands
+    def Web::html_encode(string)
+      return nil unless string
+      newstring = string.dup
+      { /&/ => '&amp;' }.each{ |char, entity|
+        newstring.gsub!( char, entity )
+      }
+      newstring
+    end
+    
+    # Escape URL encode
+    #     url_encoded_string = Web::escape("string")
+    def Web::escape(string)
+      return nil unless string
+      string.gsub(/([^ a-zA-Z0-9_.-]+)/n) do
+        '%' + $1.unpack('H2' * $1.size).join('%').upcase
+      end.tr(' ', '+')
+    end
+    
+    # Unescape URL encoded
+    #     string = Web::unescape("url encoded string")
+    def Web::unescape(string)
+      return nil unless string
+      string.tr('+', ' ').gsub(/((?:%[0-9a-fA-F]{2})+)/n) do
+        [$1.delete('%')].pack('H*')
+      end
+    end
+    
+    RFC822_DAYS = %w[ Sun Mon Tue Wed Thu Fri Sat ]
+    RFC822_MONTHS = %w[ Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec ]
+    # Make RFC1123 date string
+    #     Web::rfc1123_date(Time.now) # => Sat, 01 Jan 2000 00:00:00 GMT
+    def Web::rfc1123_date(time)
+      t = time.clone.gmtime
+      return format("%s, %.2d %s %.4d %.2d:%.2d:%.2d GMT",
+                    RFC822_DAYS[t.wday], t.day, RFC822_MONTHS[t.month-1], t.year,
+                    t.hour, t.min, t.sec)
+    end
+    
+    HTTP_STATUS = {"200" => "OK",
+                   "206" => "Partial Content",
+                   "300" => "Multiple Choices",
+                   "301" => "Moved Permanently",
+                   "302" => "Found",
+                   "304" => "Not Modified",
+                   "400" => "Bad Request",
+                   "401" => "Authorization Required",
+                   "403" => "Forbidden",
+                   "404" => "Not Found",
+                   "405" => "Method Not Allowed",
+                   "406" => "Not Acceptable",
+                   "411" => "Length Required",
+                   "412" => "Precondition Failed",
+                   "500" => "Internal Server Error",
+                   "501" => "Method Not Implemented",
+                   "502" => "Bad Gateway",
+                   "506" => "Variant Also Negotiates"
+    }
+
+
+    TRACE_STYLESHEET=<<-EOF
+<style type="text/css">
+span.tracecontent { background-color:white; color:black;font: 10pt verdana, arial; }
+span.tracecontent table { font: 10pt verdana, arial; cellspacing:0; cellpadding:0; margin-bottom:25}
+span.tracecontent tr.subhead { background-color:cccccc;}
+span.tracecontent th { padding:0,3,0,3 }
+span.tracecontent th.alt { background-color:black; color:white; padding:3,3,2,3; }
+span.tracecontent td { padding:0,3,0,3 }
+span.tracecontent tr.alt { background-color:eeeeee }
+span.tracecontent h1 { font: 24pt verdana, arial; margin:0,0,0,0}
+span.tracecontent h2 { font: 18pt verdana, arial; margin:0,0,0,0}
+span.tracecontent h3 { font: 12pt verdana, arial; margin:0,0,0,0}
+span.tracecontent th a { color:darkblue; font: 8pt verdana, arial; }
+span.tracecontent a { color:darkblue;text-decoration:none }
+span.tracecontent a:hover { color:darkblue;text-decoration:underline; }
+span.tracecontent div.outer { width:90%; margin:15,15,15,15}
+span.tracecontent table.viewmenu td { background-color:006699; color:white; padding:0,5,0,5; }
+span.tracecontent table.viewmenu td.end { padding:0,0,0,0; }
+span.tracecontent table.viewmenu a {color:white; font: 8pt verdana, arial; }
+span.tracecontent table.viewmenu a:hover {color:white; font: 8pt verdana, arial; }
+span.tracecontent a.tinylink {color:darkblue; font: 8pt verdana, arial;text-decoration:underline;}
+span.tracecontent a.link {color:darkblue; text-decoration:underline;}
+span.tracecontent div.buffer {padding-top:7; padding-bottom:17;}
+span.tracecontent .small { font: 8pt verdana, arial }
+span.tracecontent table td { padding-right:20 }
+span.tracecontent table td.nopad { padding-right:5 }
+</style>
+EOF
+
+
+    # wrapper for web errors
+    class Error < Exception # :nodoc:
+	
+    end
+
+end
+
+module HTMLTree # :nodoc: all
+    module TreeElement
+	def get_elements aname, elements=[]
+	    children.each { |element|
+		if element.tag == aname
+		    elements.push element
+		else
+		    element.get_elements aname, elements
+		end
+	    }
+	    elements
+	end
+    end
+end
+

data/lib/web.rb~

@@ -0,0 +1,290 @@
+require 'test/unit/assertions'
+
+require 'web/strscanparser'
+require 'web/action'
+require 'web/buffer'
+require 'web/upload'
+require 'web/parser'
+require 'web/session'
+require 'web/writableio'
+require 'web/template'
+require 'web/assertinclude'
+require 'web/forms'
+require 'web/tagparser'
+require 'web/testing'
+require 'web/formreader.rb'
+require 'web/simpledispatcher'
+require 'web/traceoutput'
+require 'web/mime'
+require 'web/cgi'
+
+require 'web/htmltools/tree'
+
+# Write output to client.  Replaces Kernel.puts;
+# use that or $stderr.puts if you want the standard puts.
+def puts( *args )
+    Web.puts args
+end
+
+begin
+    require('stringio') 
+rescue LoadError    
+  module Web
+    class StringIO  # :nodoc:
+      def initialize
+        @___content___ = ""
+      end
+      
+      def read
+        @___content___
+      end
+      
+      def clear
+        @___content___ = ""
+      end
+      
+      def string
+        @___content___
+      end
+      
+      def puts(*args)
+        @___content___ << args.join("\n") << "\n"
+      end
+      
+      def << var
+        @___content___ << var.to_s
+      end
+      
+      def write var
+        @___content___ << var.to_s
+      end
+      
+      def print var
+        @___content___ << var.to_s
+      end
+    end
+  end
+  
+  unless Kernel.const_defined? "StringIO"
+    StringIO = Web::StringIO.clone
+  end
+end
+
+# == Purpose
+# Web provides an infrastructure for building and testing
+# web applications.
+#
+# == Usage
+# Use the Web module to interact with the client.  The module
+# delegates to a Web::CGI object, which does the actual work.
+#
+#     #!/usr/bin/narf
+#     Web["field"]                      # access parameters
+#     Web.cookies["muppet"]             # access cookies
+#     Web.session["key"] ||= "value"    # get and set session values
+#     Web.set_cookie( "muppet", "cookie monster" ) # set cookies
+#     Web.puts "something"              # print 'something' out
+#
+# If the request contained multipart/form-data, uploaded files are returned as
+# Web::Upload objects.  Other parameters are treated as strings.
+#
+# == Output
+#
+# You write output as if it were an IO:
+#     Web << "<h1>Hello World!</h1>"
+#     Web.print "<p>We have lots of tricks for you.<br>"
+#     Web.write "From kungfu to jiujitsu<br>"
+#     Web.puts  "anything and everything works</p>."
+# or even:
+#     puts "hello world"
+#
+# Narf buffers output by default.  Buffered output allows you to set headers
+# (cookies, redirects, status, etc.) at any point before the cgi is flushed.
+# You can force this by calling:
+#     Web.flush
+#
+# Once the headers are sent to the client, you cannot set any more headers.
+#
+# == Error Handling
+#
+# For cgi-scripts under Apache, one can use the 'bin/narf'
+# script instead of using the ruby executable.  This little c program
+# doesn't do much fancy, but it can trap syntax errors and send them
+# back to the browser.  <i>I would especially appreciate security-related
+# feedback; narf.c is contributed and I am not a c programmer.</i>
+#
+# == Sessions:
+#
+# Sessions provide a way of storing data between Web
+# requests. Anything that can be marshalled can be stored in the
+# session. 
+#
+# === Getting and Setting values in a session
+#
+#      Web.session["key"] = "value"
+#      Web.session["key"]             # => "value"
+#
+# === Deleting session values
+#
+#      Web.session["key"] = "value"
+#      Web.session["key"].delete      # => "value"
+#      Web.session["key"]             # => "nil"
+#
+# === Iterating through session keys
+#
+#      Web.session.each do |key, val|
+#          Web.puts "#{key} => #{val}<br>"
+#      end
+#
+# === Resetting the Session
+#
+# Reseting the session to an empty hash is simple:
+#     Web.session.reset
+#
+# === Testing
+#
+# Narf takes testing very seriously.  I consider supporting
+# testing to be part of the contract when writing a IO library.
+# See Web::Testing for more details.
+#
+module Web
+    class << self
+      # Web delegates to the current
+      # cgi object.  This is the recommended
+      # way to use narf:
+      #
+      #    Web["param"]
+      #    Web << "hello world"
+      #    Web.set_redirect( "http://www.narf-lib.org" )
+      #    ...
+      # 
+      # The documentation for these methods is on the Web::CGI object.
+      def method_missing(method, *args, &block)
+        CGI.get_cgi.send(method,*args, &block)
+      end
+
+      def set_cgi( cgi )
+        CGI.set_cgi( cgi )
+      end
+
+      def get_cgi
+        CGI.get_cgi
+      end
+
+      def process(options={}, &block)
+        CGI.process(options, &block)
+      end
+    end
+
+    # this is a bit incomplete -- only encodes ampersands
+    def Web::html_encode(string)
+      return nil unless string
+      newstring = string.dup
+      { /&/ => '&amp;' }.each{ |char, entity|
+        newstring.gsub!( char, entity )
+      }
+      newstring
+    end
+    
+    # Escape URL encode
+    #     url_encoded_string = Web::escape("string")
+    def Web::escape(string)
+      return nil unless string
+      string.gsub(/([^ a-zA-Z0-9_.-]+)/n) do
+        '%' + $1.unpack('H2' * $1.size).join('%').upcase
+      end.tr(' ', '+')
+    end
+    
+    # Unescape URL encoded
+    #     string = Web::unescape("url encoded string")
+    def Web::unescape(string)
+      return nil unless string
+      string.tr('+', ' ').gsub(/((?:%[0-9a-fA-F]{2})+)/n) do
+        [$1.delete('%')].pack('H*')
+      end
+    end
+    
+    RFC822_DAYS = %w[ Sun Mon Tue Wed Thu Fri Sat ]
+    RFC822_MONTHS = %w[ Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec ]
+    # Make RFC1123 date string
+    #     Web::rfc1123_date(Time.now) # => Sat, 01 Jan 2000 00:00:00 GMT
+    def Web::rfc1123_date(time)
+      t = time.clone.gmtime
+      return format("%s, %.2d %s %.4d %.2d:%.2d:%.2d GMT",
+                    RFC822_DAYS[t.wday], t.day, RFC822_MONTHS[t.month-1], t.year,
+                    t.hour, t.min, t.sec)
+    end
+    
+    HTTP_STATUS = {"200" => "OK",
+                   "206" => "Partial Content",
+                   "300" => "Multiple Choices",
+                   "301" => "Moved Permanently",
+                   "302" => "Found",
+                   "304" => "Not Modified",
+                   "400" => "Bad Request",
+                   "401" => "Authorization Required",
+                   "403" => "Forbidden",
+                   "404" => "Not Found",
+                   "405" => "Method Not Allowed",
+                   "406" => "Not Acceptable",
+                   "411" => "Length Required",
+                   "412" => "Precondition Failed",
+                   "500" => "Internal Server Error",
+                   "501" => "Method Not Implemented",
+                   "502" => "Bad Gateway",
+                   "506" => "Variant Also Negotiates"
+    }
+
+
+    TRACE_STYLESHEET=<<-EOF
+<style type="text/css">
+span.tracecontent { background-color:white; color:black;font: 10pt verdana, arial; }
+span.tracecontent table { font: 10pt verdana, arial; cellspacing:0; cellpadding:0; margin-bottom:25}
+span.tracecontent tr.subhead { background-color:cccccc;}
+span.tracecontent th { padding:0,3,0,3 }
+span.tracecontent th.alt { background-color:black; color:white; padding:3,3,2,3; }
+span.tracecontent td { padding:0,3,0,3 }
+span.tracecontent tr.alt { background-color:eeeeee }
+span.tracecontent h1 { font: 24pt verdana, arial; margin:0,0,0,0}
+span.tracecontent h2 { font: 18pt verdana, arial; margin:0,0,0,0}
+span.tracecontent h3 { font: 12pt verdana, arial; margin:0,0,0,0}
+span.tracecontent th a { color:darkblue; font: 8pt verdana, arial; }
+span.tracecontent a { color:darkblue;text-decoration:none }
+span.tracecontent a:hover { color:darkblue;text-decoration:underline; }
+span.tracecontent div.outer { width:90%; margin:15,15,15,15}
+span.tracecontent table.viewmenu td { background-color:006699; color:white; padding:0,5,0,5; }
+span.tracecontent table.viewmenu td.end { padding:0,0,0,0; }
+span.tracecontent table.viewmenu a {color:white; font: 8pt verdana, arial; }
+span.tracecontent table.viewmenu a:hover {color:white; font: 8pt verdana, arial; }
+span.tracecontent a.tinylink {color:darkblue; font: 8pt verdana, arial;text-decoration:underline;}
+span.tracecontent a.link {color:darkblue; text-decoration:underline;}
+span.tracecontent div.buffer {padding-top:7; padding-bottom:17;}
+span.tracecontent .small { font: 8pt verdana, arial }
+span.tracecontent table td { padding-right:20 }
+span.tracecontent table td.nopad { padding-right:5 }
+</style>
+EOF
+
+
+    # wrapper for web errors
+    class Error < Exception # :nodoc:
+	
+    end
+
+end
+
+module HTMLTree # :nodoc: all
+    module TreeElement
+	def get_elements aname, elements=[]
+	    children.each { |element|
+		if element.tag == aname
+		    elements.push element
+		else
+		    element.get_elements aname, elements
+		end
+	    }
+	    elements
+	end
+    end
+end
+