testdoc 0.0.2

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2009-01-08
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,19 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/testdoc.rb
+lib/testdoc_module.rb
+lib/testdoc/testdocoptions.rb
+lib/testdoc/testdocparser.rb
+lib/testdoc/footer.html.erb
+lib/testdoc/header.html.erb
+lib/testdoc/template.html.erb
+lib/testdoc/template.debug.erb
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_testdoc.rb
+bin/testdoc

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on testdoc, see http://testdoc.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,72 @@
+= testdoc
+
+* FIX (url)
+
+== DESCRIPTION:
+
+Generate testplans from annotated sourcecode. 
+
+Author: Thomas Flemming, thomasfl(snabela)usit.uio.no
+
+== FEATURES/PROBLEMS:
+
+* Only supports ruby sourcecode.
+
+== SYNOPSIS:
+
+Examples: 
+
+ $testdoc
+ $testdoc rubyfil.rb
+ $testdoc --title "Overskrift" rubyfil.rb
+ $testdoc *.rb
+ $testdoc --help
+
+Sample ruby sourcecode annotations:
+
+   # testplan: Title
+   # test: Title
+   # task: Title
+   #       multiline
+   # check: Title
+
+Syntax:
+
+   TESTPLAN => [#testplan: .*] TESTS
+   TEST     => '#test:' TITLE TASKS*
+   TITLE    => .*\n [#.*]*
+   TASKS    => '#task:' CHECKS* *
+   CHECKS   => '#checks' TITLE
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (TODO sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 TestDoc
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,28 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/testdoc'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('testdoc', TestDoc::VERSION) do |p|
+  p.developer('FIXME full name', 'FIXME email')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+  # p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+  # ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/bin/testdoc

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+ 
+require 'rubygems'
+require 'testdoc'
+ 
+if %w(-v --version).include? ARGV.first
+  require File.dirname(__FILE__) + "/../lib/testdoc"
+  puts "#{File.basename($0)} #{TestDoc::VERSION}"
+  
+  exit(0)
+end
+
+require File.dirname(__FILE__) + "/../lib/testdoc_module"
+
+t = TestDoc::TestDoc.new
+t.document(ARGV)

data/lib/testdoc/footer.html.erb

@@ -0,0 +1,5 @@
+
+
+<p>Generated by testdoc.rb</p>
+</body>
+</html>

data/lib/testdoc/header.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+    <title><%=@title%></title>
+    <link rel="stylesheet" href="http://www.usit.uio.no/visuell-profil/css/uio.css" type="text/css">
+    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+    <meta name="robots" content="index,nofollow" />
+</head>
+<body>
+<h1><%=@title%></h1>
+
+

data/lib/testdoc/template.debug.erb

@@ -0,0 +1,21 @@
+<% testplans.each do |testplan| %>
+<% if testplan.title != nil %>
+testplan:<%= testplan.title %>
+<% end %>
+
+<% testplan.tests.each do |test| %>
+  test: <%=test.title%> (id:<%=test.id%> tasks:<%=test.tasks.size%>)    checks:<%=test.number_of_checks%>
+
+<% test.tasks.each do |task| %>
+      task: <%=task.title%> (id:<%=task.id%>)
+<%if (task.checks == nil)%>
+          check: NIL
+<%end%>
+<% task.checks.each do |check| %>
+          check:<%=check.title %> (id:<%=check.id%>)
+
+<% end %>
+<% end %>
+<% end %>
+<% end %>
+

data/lib/testdoc/template.html.erb

@@ -0,0 +1,61 @@
+<% testplans.each do |testplan| %>
+<% if testplan.title != nil %><h2><%= testplan.title %><% end %></h2>
+<% if testplan.comments != nil %><p><%= testplan.comments %><% end %></p>
+<% if (testplan.tests == nil) then
+     exit(0)
+   end %>
+   <table cellpadding="3" border="1" width="80%">
+   <tr align="left">
+       <td><b>Nr</b>
+       <td><b>Betegnelse</b></td>
+       <td><b>Aksjoner</b></td>
+       <td><b>Sjekkliste</b></td>
+       <td><b>Resultat</b></td>
+   </tr>
+<%testplan.tests.each do |test| %>
+
+   <tr valign="top">
+       <td<%if(test.tasks.size > 1)%> rowspan="<%=test.number_of_checks%>"<%end%>><%=test.id%></td>
+       <td<%if(test.tasks.size > 1)%> rowspan="<%=test.number_of_checks%>"<%end%>><%=test.title%></td>
+ <%if (test.tasks.size == 0)%>
+
+       <td>&nbsp;</td>
+       <td>&nbsp;</td>
+       <td>&nbsp;</td>
+   </tr>
+ <%end%>
+ <%task_count = 0%>
+ <%test.tasks.each do |task| %>
+    <%task_count += 1%>
+
+       <td<%if(task.checks.size > 1)%> rowspan="<%=test.tasks.size %>"<%end%>><i><%=task.id%></i>:<%=task.title%> </td>
+    <%if (task.checks.size == 0)%>
+
+       <td>&nbsp;</td>
+       <td>&nbsp;</td>
+   </tr>
+
+     <%if(test.tasks.size > task_count)%>
+
+   <tr valign="top">
+     <%end%>
+   <%end%>
+   <%checks_count=0%>
+   <%task.checks.each do |check| %>
+     <%checks_count += 1%>
+
+       <td><i><%=check.id%></i>: <%=check.title %></td>
+       <td>&nbsp;</td>
+   </tr>
+         <%if( task.checks.size > checks_count || test.tasks.size > task_count)%>
+
+   <tr>
+         <%end%>
+    <%end%>
+  <%end%>
+<%end%>
+
+</table>
+<%end%>
+
+