testdoc 0.0.3 → 0.1.0

data/README.rdoc

@@ -4,9 +4,9 @@
 
 == DESCRIPTION:
 
-Generate testplans from annotated sourcecode. 
+Generate testplans from annotated sourcecode.
 
-Author: Thomas Flemming, thomasfl(snabela)usit.uio.no
+Author: Thomas Flemming, thomas.flemming (at) gmail.com
 
 == FEATURES/PROBLEMS:
 
@@ -14,7 +14,7 @@ Author: Thomas Flemming, thomasfl(snabela)usit.uio.no
 
 == SYNOPSIS:
 
-Examples: 
+Examples:
 
  $testdoc
  $testdoc rubyfil.rb
@@ -24,19 +24,24 @@ Examples:
 
 Sample ruby sourcecode annotations:
 
-   # testplan: Title
-   # test: Title
-   # task: Title
-   #       multiline
-   # check: Title
+   # @testplan: Title
+   class MyTests
 
+     # @test: Title
+     should "Login " do
+       # @task: Title
+       #       multiline
+       # @check: Title
+     end
+
+   end
 Syntax:
 
-   TESTPLAN => [#testplan: .*] TESTS
-   TEST     => '#test:' TITLE TASKS*
+   TESTPLAN => [@testplan: .*] TESTS
+   TEST     => '@test:' TITLE TASKS*
    TITLE    => .*\n [#.*]*
-   TASKS    => '#task:' CHECKS* *
-   CHECKS   => '#checks' TITLE
+   TASKS    => '@task:' CHECKS* *
+   CHECKS   => '@checks' TITLE
 
 == REQUIREMENTS:
 
@@ -50,7 +55,7 @@ Syntax:
 
 (The MIT License)
 
-Copyright (c) 2009 TestDoc
+Copyright (c) 2009 Thomas Flemming
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,28 +1,23 @@
+require 'rubygems'
+require 'hoe'
+
 %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('Thomas Flemming', 'thomasfl@usit.uio.no')
   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.rubyforge_name       = p.name
+  p.summary = "Documentation generator for tests you want to give manuel testers."
   p.extra_dev_deps = [
-    ['newgem', ">= #{::Newgem::VERSION}"]
+    ['newgem', ">= #{::Newgem::VERSION}"],
+    ['hoe', '>= 2.9.1']
   ]
-  
+
   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/lib/testdoc.rb

@@ -3,7 +3,7 @@ $:.unshift(File.dirname(__FILE__)) unless
 
 
 module TestDoc
-  VERSION = '0.0.3'
+  VERSION = '0.1.0'
 
 end
 

data/lib/testdoc_module.rb

@@ -5,11 +5,6 @@ module TestDoc
   require File.dirname(__FILE__) +  '/testdoc/testdocoptions'
   require File.dirname(__FILE__) +  '/testdoc/testdocparser'
 
-
-
-# module TestDoc
-
-
   class TestDoc
 
     GENERATORS = {} # Not in use
@@ -56,15 +51,13 @@ module TestDoc
           @num_files += 1
         end
 
-        # basename = File.basename(fn).split("\.")[0]
-        # puts "DEBUG" + basename + ".html"
       end
 
       if(not options.quiet) then
         puts ''
         puts ''
         puts 'Generating TestDoc HTML: testplan.html...'
-        # puts "Files:   #@num_files"
+
         puts "Parsed files: #@num_files"
       end
 
@@ -106,19 +99,19 @@ module TestDoc
       content.split(/\n/).map do |line|
         line_number = line_number + 1
 
-        if line =~ /.*#.*test:(.*)/i then
+        if line =~ /.*#.*@test (.*)/i then
           symbol = :test
           testdoc_array[counter] = [:test,$1.gsub(/^\s+/, ""),line_number]
           counter = counter + 1
-        elsif line =~ /.*#.*task:(.*)/i then
+        elsif line =~ /.*#.*@task (.*)/i then
           testdoc_array[counter] = [:task,$1.gsub(/^\s+/, ""),line_number]
           counter = counter + 1
           symbol = :task
-        elsif line =~ /.*#.*check:(.*)/i then
+        elsif line =~ /.*#.*@check (.*)/i then
           testdoc_array[counter] = [:check,$1.gsub(/^\s+/, ""),line_number]
           counter = counter + 1
           symbol = :check
-        elsif line =~ /.*#.*testplan:(.*)/i then
+        elsif line =~ /.*#.*@testplan (.*)/i then
           testdoc_array[counter] = [:testplan,$1.gsub(/^\s+/, "") + "#",line_number]
           counter = counter + 1
           symbol = :testplan
@@ -136,7 +129,6 @@ module TestDoc
 
     # Given a list of files and directories, create a list
     # of all the Ruby files they contain.
-
     def normalized_file_list(options, relative_files, force_doc = false, exclude_pattern=nil)
       file_list = []
 

data/test/test_testdoc.rb

@@ -1,5 +1,6 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
 
+
 class TestTestdoc < Test::Unit::TestCase
 
   def setup

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: testdoc
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Thomas Flemming
@@ -9,30 +15,58 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-27 00:00:00 +01:00
+date: 2011-03-07 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: newgem
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.2.3
-    version: 
+        hash: 5
+        segments: 
+        - 1
+        - 5
+        - 3
+        version: 1.5.3
+  type: :development
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: hoe
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 41
+        segments: 
+        - 2
+        - 9
+        - 1
+        version: 2.9.1
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.0
-    version: 
-description: "Generate testplans from annotated sourcecode.   Author: Thomas Flemming, thomasfl(snabela)usit.uio.no"
+        hash: 41
+        segments: 
+        - 2
+        - 9
+        - 1
+        version: 2.9.1
+  type: :development
+  version_requirements: *id003
+description: ""
 email: 
 - thomasfl@usit.uio.no
 executables: 
@@ -42,7 +76,6 @@ extensions: []
 extra_rdoc_files: 
 - History.txt
 - Manifest.txt
-- README.rdoc
 files: 
 - History.txt
 - Manifest.txt
@@ -59,33 +92,42 @@ files:
 - test/test_helper.rb
 - test/test_testdoc.rb
 - bin/testdoc
+- .gemtest
 has_rdoc: true
-homepage: FIX (url)
+homepage: 
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
-- README.rdoc
+- README.txt
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: testdoc
-rubygems_version: 1.3.1
+rubygems_version: 1.5.0
 signing_key: 
-specification_version: 2
-summary: Generate testplans from annotated sourcecode
+specification_version: 3
+summary: Documentation generator for tests you want to give manuel testers.
 test_files: 
 - test/test_helper.rb
 - test/test_testdoc.rb