narf 0.5.1

data/README

@@ -0,0 +1,124 @@
+=== Purpose
+  
+NARF is a replacement for, and derivative of, the Ruby CGI
+library. It exists one reason:
+
+* To trivialize web development
+
+We hope that these 3 lines of development will accomplish our task:
+
+* To provide a clean API for writing Web applications.
+
+* To make it very easy to write testable Web applications (using
+  Web::Testing), and provide a template system (Web::Narflates).
+
+* To test the above goals by developing integrated, high quality,
+  configurable versions of common web apps in a simple and easy
+  to use manner.  The heart of http://www.narf-lib.org, Web::Wiki
+  is an easy to use wiki.  Not the only one, but it does make
+  us eat our own dogfood :-)
+
+NARF does all of this as a regular CGI application.  It also runs in-process under fastcgi, mod_ruby, and webrick.  View these files for details:
+
+* sapi/fastcgi/INSTALL.txt
+* sapi/mod_ruby/INSTALL.txt
+* sapi/webrick/INSTALL.txt
+
+=== Installation
+
+Run the installer for NARF:
+
+    ruby build.rb test (optional)
+
+    ruby install.rb config
+    ruby install.rb setup
+    ruby install.rb install
+
+=== Dependencies
+
+NARF requires the following packages on ruby 1.6.  These packages are included in ruby 1.8:
+
+testunit (unit testing framework):
+http://testunit.talbott.ws/packages/testunit-0.1.6.tar.gz
+
+strscan (string scanner library):
+http://www.loveruby.net/archive/strscan/strscan-0.6.5.tar.gz
+
+You can use raa-install (http://www.ruby-lang.org/raa/list.rhtml?id=729) for
+this:
+    raa-install -i testunit
+    raa-install -i strscan 
+
+=== Hello World
+
+    require 'web'
+    Web << 'Hello World'
+
+=== Testing an App
+
+If you haven't noticed, NARF has a cgi style api.  It's also has a testing api.  Given these files:
+
+    script.rb
+    test.rb
+
+where script.rb is:
+
+    #!/usr/bin/ruby
+    require 'web'
+
+    Web << "param is #{Web["param"]}"
+
+and test.rb is:
+    
+    require 'web'
+    require 'test/unit'
+
+    class MyAppTest < Test::Unit::TestCase
+        include Web::Testing
+
+        def test_prints_content
+            do_request "script.rb", "param" => "THIS!"
+            assert_content "param is THIS!"
+	end
+    end
+
+Do this to run tests:
+
+     ruby test.rb
+
+See Web::Testing for more examples.
+
+=== Websites
+
+Home page:
+http://www.narf-lib.org
+
+Project info page, including downloads and CVS instructions:
+http://www.sourceforge.net/projects/narf-lib
+  
+=== Credits
+
+Narf was written by Tom Clarke and Patrick May, partly based on cgi.rb
+written by Wakou Aoyama. It makes significant use of ruby-htmltools,
+written by Ned Konz.  Also, Keunwoo Lee patched Request.read_multipart
+to be cleaner.  
+
+NARF contains code from the following projects, and we are in their debt:
+
+ruby-htmltools::
+    This is a Ruby library for building trees representing HTML structure.
+    http://bike-nomad.com/ruby
+sgml-parser::
+    The html-parser package is a variant language implementation of the
+    Python's SGML parser (sgmllib.py), HTML parser (htmllib.py) and
+    Formatter (formatter.py).
+    http://www.jin.gr.jp/%7Enahi/Ruby/html-parser/README.html
+webunit::
+    WebUnit is Ruby API for testing html/cgi without browser, and is
+    idealy suited for automated unit testing of web sites when combined
+    with a Ruby unit test framework such as RubyUnit. It was designed
+    and implemented by Masaki Suketa.
+    http://www.xpenguin.biz/download/webunit/index-en.html
+
+Thanks also go to http://www.sourceforge.net for hosting the
+project's CVS and website

data/TODO

@@ -0,0 +1,88 @@
+=== TODO:
+
+Miscellaneous
+
+* Fix tests that rely on tmp, to work on Windows
+
+* Remove Web.process from all tests
+  (how about, seperate cgi tests from framework tests instead of
+   deleting all the cgi tests.  and move Web.process to Web::CGI)
+
+* Remove all rdoc files from CVS
+
+* Rename repository to narf-lib or narf
+
+Web::Narflates
+
+* Replace the Foreach syntax with the following:
+<narf:foreach item="i" in="credits">
+
+* Add support for RadioButtons
+
+* pass through all values not depended on by the tag parser.
+
+* Add support for links so that they correctly link to the current
+cgi, or to a different one.
+
+* Support form submits, and redirects to urls of the form "?foo=bar",
+ie no script is mentioned.
+
+* Provide a hook into test_unit to allow sessions to be automatically reset
+  before a setup
+
+* Have the tag parser report which tag was not matched
+
+* The following line produces an unhelpful error message:
+    <narf:foreach from"items" item="item">
+
+* Make VarNotFoundException report a better error message, including
+line number and what var was not found. Print out some context from
+the template too.
+
+* Add better error reporting (including line numbers and context) for
+template parse errors. 
+
+* Add tests to test Web::Link
+
+Web::Testing
+
+* Allow clicking of links in a test.
+
+* Add support for submitting a form to a CGI other than the current one.
+
+* Have Values in textarea's and value attributes in other fields
+correctly escaped so all escaping issues are handled. 
+
+* Add support for specific buttons to be submitted on a form.
+
+* Provide a default form submit that submits any un-named form on the
+page. 
+
+* Allow a request to be made directly to a form, passing in objects
+(objects should be serialized, unserialized before passing)
+ 
+* Add an assert that a particular template was used
+	assert_form_displayed MyTemplate
+
+* Add a way to find out how long an array is in a test
+
+* Add error reporting for when a template can not be found
+
+* Report errors for unrecognized parameters for do_request
+
+* Have assert_includes handle array fields to allow for parameters
+with array types.
+
+Web::SimpleDispatcher
+
+* Support for useful data-binding might include
+  - Optionally, not having eveything written back to the form
+  - Automatic data type conversions, perhaps specified in a form tag. 
+
+* Submit could do with a more helpful error message. If a field is not
+present, it could list out the fields that are present.
+
+* Have do request automatically encode objects
+
+* Make sure round trip object serialization works correctly
+

data/bin/narftest

@@ -0,0 +1,17 @@
+#!/usr/local/bin/ruby
+require 'test/unit'
+require 'test/unit/ui/console/testrunner'
+require 'test/unit/testcase'
+
+
+$:.replace(["#{Dir.pwd}/src","#{Dir.pwd}/config"].concat($:))
+
+require 'web'
+
+$RUNNING_AS_TEST=true
+
+Dir["tests/*.rb"].each { |test|
+    require test
+}
+
+Web.set_docroot File.join(Dir.pwd,"html")

data/bug.rb

@@ -0,0 +1,9 @@
+continuation = []
+at_exit{
+  puts 'at_exit'
+  continuation[0].call unless continuation[0].nil?
+}
+callcc{ |c|
+  continuation[0] = c
+}
+puts 'running'

data/build.rb

@@ -0,0 +1,314 @@
+#!/usr/bin/env ruby
+
+# require 'stringio'
+
+# GC.disable
+require 'ftools'
+require 'find'
+
+def temp_dir
+    (ENV["TEMP"] || "/tmp").gsub(/\\+/, "/")
+end
+
+def make_temp( path )
+  File.join( temp_dir, path)
+end
+
+
+
+def File.rm_rf( path )
+  if File.exists? path
+    doomed = []
+    Find.find( path ) { |filename|
+      doomed.push filename
+    }
+    doomed.reverse.each{ |filename|
+      if File.directory? filename
+        Dir.rmdir( filename )
+      else
+      File.delete( filename )
+      end
+    }
+  end
+end
+
+module Test
+    module Unit
+	class TestCase
+	    @@subclasses = []
+	    
+	    def TestCase.inherited(sub)
+		@@subclasses.push sub
+	    end
+	    
+	    def TestCase.all_suite
+		suite = Test::Unit::TestSuite.new
+		@@subclasses.each{ |sub|
+		    suite << sub.suite # te
+		}
+		suite
+	    end
+	end
+    end
+end
+
+class Target
+    @@targets = {}
+    def Target.run(name="")
+	if (keys.include? name)
+	    @@targets[name].run
+	else
+	    help_text
+	end
+    end
+
+    def Target.keys
+        @@targets.keys.sort
+    end
+
+    def Target.first
+	keys.first
+    end
+
+    def Target.justify
+	justify = 0
+
+	keys.each { |key|
+	    justify = key.length if (key.length > justify)
+	}
+
+	justify + 1
+    end
+
+    def Target.help_text
+	text  = "Usage:   ruby build.rb [ #{ keys.join( " | ") } ]" + $/
+	text += @@targets[keys.first].help_text( "Options: ", justify )
+	keys.slice(1...keys.length).each{ |key|
+	    text += @@targets[key].help_text( "         ", justify )
+	}
+	puts text
+    end
+
+    attr_reader :name, :description
+    def initialize( name, description, &run )
+	@name = name
+	@description = description
+	@run = run || Target.method(:help_text)
+	@@targets[name] = self
+    end
+
+    def run
+	$stderr.puts "Target: " + name + " | " + description
+	@run.call
+    end
+
+    def help_text( prefix, justify )
+	prefix + name.ljust(justify) + " -- " + description + $/
+    end
+end
+
+Target.new( "upload_doc", "upload doc" ) {
+    Target.run( "rdoc" )
+    `scp -r doc/rdoc/* patsplat@ssh.narf-lib.org:~/narf-lib.org/doc`
+}
+
+  Target.new( "rdoc", "build rdoc" ) {
+    begin
+      require 'rdoc/rdoc'
+      
+      rdoc = RDoc::RDoc.new
+      rdoc.document( [  
+                       # set the output directory
+                       "-o", 
+                      "doc/rdoc/",
+                      
+                      # set the main page
+                      "--main",
+                      "README",
+                      
+                      # list the files to be excluded
+                      "--exclude",
+                      /htmltools|htmlparser|unit|writableio|tagparser|strscanparser|web\/action|assertinclude|buffer|formreader|forms|runner|simpledispatcher|traceoutput|linker|page|lib\/web\/sapi/,
+
+                      # list the files / dirs to be parsed for documentation
+                      "README",
+                      "examples/examples.rdoc",
+                      "lib/web.rb",
+                      "lib/web",
+                      "doc/apache_cgi.txt",
+                      "doc/fastcgi.txt",
+                      "doc/mod_ruby.txt",
+                      "doc/webrick.txt"
+                       
+			  ] )
+    rescue LoadError => error
+	puts "Building the rdocs will require 'rdoc/rdoc'"
+	puts "visit http://rdoc.sourceforge.net/ to obtain this library"
+    end
+}
+
+Target.new( "test", "run narf unit tests" ) {
+    require 'test/unit'
+    require 'test/unit/ui/console/testrunner'
+
+    $:.replace(['lib'].concat($:))
+
+    require 'web'
+
+    Dir["test/*.rb"].each { |test|
+	require test
+    }
+
+    # buffered test runner is a custom made test runner
+    # that lives in the test dir
+    Test::Unit::UI::Console::TestRunner.new(Test::Unit::TestCase.all_suite
+						    ).start
+}
+  
+  Target.new( "testwiki", "test narf wiki" ) {
+    require 'test/unit'
+    require 'test/unit/ui/console/testrunner'
+
+    $:.replace(['./lib/'].concat($:)) 
+
+    require 'web'
+    require 'web/wiki'
+
+    def setup_wiki
+      File.rm_rf( Web::Wiki::store_dir )
+    end
+    
+    alias :teardown_wiki :setup_wiki
+
+    Web::Wiki::set_pref(:store_dir  => make_temp("test.pages/"),
+                        :store_url  => "../test.pages/",
+                        :tarpit_dir => make_temp("tarpit/"),
+                        :vandals    => "vandals.test.txt",
+                        :baseurl    => "wiki.rb" )
+    Web.set_docroot( File.join(Dir.pwd,"examples") )
+
+    # a bunch of the illustration_page functions don't work on windows
+    #require 'test/wiki/test.illustration_page.rb'
+    Dir["test/wiki/*.rb"].each { |test|
+      require test
+    }
+    #require 'test/wiki/test.wiki.rb'
+
+    # buffered test runner is a custom made test runner
+    # that lives in the test dir
+    Test::Unit::UI::Console::TestRunner.new(Test::Unit::TestCase.all_suite).start
+
+}
+
+Target.new( "testwebunit", "test web unit" ) {
+    $: << "lib"
+    ENV['URLBASE'] = ARGV[1] || "http://www.hexane.org/webtest/"
+    
+    require 'web/unit/runtest'
+    
+    Web::Unit.runtest(Dir["test/webunit/test*.rb"])
+}
+
+Target.new( "testexamples", "test narf examples" ) {
+    require 'test/unit'
+    require 'test/unit/ui/console/testrunner'
+
+    $:.replace(['./lib/'].concat($:)) 
+
+    require 'web'
+    require 'web/wiki'
+
+    Web.set_docroot File.join(Dir.pwd,"examples")
+
+    Dir["examples/test/*.rb"].each { |test|
+        require test
+    }
+
+    # buffered test runner is a custom made test runner
+    # that lives in the test dir
+    Test::Unit::UI::Console::TestRunner.new(Test::Unit::TestCase.all_suite ).start
+}
+
+
+def install_dir
+    $:.find { |dir|
+        /site_ruby\/\d.\d\z/ =~ dir
+    } + "/"
+end
+
+FILES = [ "web",
+          "web.rb",
+          "web/action.rb",
+	  "web/assertinclude.rb",
+	  "web/buffer.rb",
+	  "web/request.rb",
+	  "web/session.rb",
+	  "web/template.rb",
+	  "web/writableio.rb",
+          "web/rhp.rb" ]
+
+OLD_FILES = [ "web",
+              "narf.rb",
+	      "narf/app.rb",
+	      "narf/assertinclude.rb",
+	      "narf/buffer.rb",
+	      "narf/request.rb",
+	      "narf/session.rb",
+	      "narf/template.rb",
+	      "narf/writableio.rb"	]
+
+Target.new( "uninstall", "delete narf files from site_ruby" ){
+
+    file_list = (FILES.reverse | OLD_FILES.reverse ).collect{|file|
+        install_dir + file
+    }
+
+    file_list.push( "/usr/bin/rhp")
+
+    file_list.each{ |file|
+	if File.exists? file
+	    if File.stat(file).directory?
+                Dir.delete file
+	    else
+                File.delete file
+            end
+	end
+    }
+}
+
+Target.new( "compile_narf_runner", "" ) {
+  Dir.mkdir "bin" unless File.exists? "bin"
+  narf_c = File.open( 'sapi/apache_cgi/src/narf.c', 'r' ) { |f|
+    f.read
+  }
+  require 'rbconfig'
+  narf_c.gsub!( /(ruby)/, Config::CONFIG["bindir"] + "/ruby" )
+  File.open( 'sapi/apache_cgi/src/narf-path_adjusted.c', 'wb') { |f|
+    f.write(narf_c)
+  }
+  `gcc sapi/apache_cgi/src/narf-path_adjusted.c -o sapi/apache_cgi/bin/narf`
+}
+
+Target.new( "install", "install narf in site ruby" ){
+
+    Target.run( "uninstall" )
+    Target.run( "compile_rhp" )
+
+    FILES.each{ |file|
+            from, to = "lib/" + file, install_dir + file
+
+            if (File.stat(from).directory?)
+	        unless File.exists? to
+		    puts "Creating #{to}"
+                    Dir.mkdir to 
+                end
+            else
+                puts "#{ from } => #{ to }...\n"
+	        File.copy( from, to )
+            end
+    }
+
+    File.copy( "rhp", "/usr/bin/rhp" )
+}
+
+Target.run( ARGV[0] ) if ($0 == __FILE__)