testdoc 0.0.2

data/lib/testdoc/testdocparser.rb

@@ -0,0 +1,178 @@
+# TestDocParser
+
+class TestPlan
+  attr_accessor :tests, :title, :comments
+end
+
+
+class TestItem
+    attr_accessor :tasks, :title, :id, :number_of_checks, :checks_tasks_count
+end
+
+class Task
+  attr_accessor :checks, :title, :id
+end
+
+class Check
+  attr_accessor :title, :id
+end
+
+class TestDocParser
+
+  attr_accessor :options
+
+  def initialize(lines,filename)
+    @lines = lines
+    @filename = filename
+    @line_counter = 0
+    read_line()
+    @progress = $stderr
+  end
+
+  def error(msg)
+    puts @filename + ":" + @src_line_number.to_s + " Error: " + msg
+    puts "  # " + @tag.to_s + ":" + @param
+    exit(0)
+  end
+
+  def read_line
+    src_line = @lines[@line_counter]
+    if src_line == nil then
+      @tag = ""
+      @param = ""
+      return false
+    end
+    @tag = src_line[0]
+    @param = src_line[1]
+    @src_line_number = src_line[2]
+    @line_counter = @line_counter + 1
+    return true
+  end
+
+  def progress(char)
+    unless @options.quiet
+      @progress.print(char)
+      @progress.flush
+    end
+  end
+
+
+  # Directive 'testplan:' is optional, but is expected to be first.
+  def process_testplan
+    testplans = []
+    @testplans_counter = 0
+
+    if(@tag == :testplan) then
+      testplan = TestPlan.new
+      testplan.title = @param.split("#")[0]
+      testplan.comments = @param.split("#")[1]
+      read_line()
+    else
+      testplan = TestPlan.new
+    end
+    testplan.tests = process_tests()
+    testplans[@testplans_counter] = testplan
+    @testplans_counter += 1
+
+    # count number of tasks and checks for each test
+    # for setting correct rowspan in html
+    if (testplans == nil)
+      return nil
+    end
+    testplans.each do |testplan|
+      if (testplan.tests == nil)
+        return nil
+      end
+      testplan.tests.each do |test|
+        checks_tasks_count = 0
+
+        test.tasks.each do |task|
+          if(task.checks.size == 0)
+            checks_tasks_count += 1
+          end
+          task.checks.each do |check|
+            checks_tasks_count += 1
+          end
+        end
+        # number_of_checks is an alias for checks_tasks_count
+        test.number_of_checks = checks_tasks_count.to_s
+        test.checks_tasks_count = checks_tasks_count.to_s
+      end
+    end
+
+    # return parsed testplan
+    return testplans
+  end
+
+  def process_tests
+    tests = []
+    @tests_counter = 0
+    if (@tag == :test)
+      while(@tag == :test ) do
+        progress("t")
+        test = TestItem.new()
+        test.title = @param
+        test.id = (@tests_counter + 1).to_s
+        read_line()
+
+        test.tasks = process_tasks
+        tests[@tests_counter] = test
+        @tests_counter += 1
+      end
+      return tests
+    else
+      progress("-")
+      # progress("Warning: no directives found")
+      ## error("Could not find any 'test:' directives.")
+      return nil
+    end
+  end
+
+  def process_tasks
+    tasks = []
+    @tasks_counter = 0
+    if(@tag == :check) then
+      error("Excepted 'task:' directive before 'check:' directive.")
+    end
+    while(@tag == :task) do
+      progress(".")
+      task = Task.new
+      task.title = @param
+      task.id = (@tests_counter + 1).to_s + "." + (@tasks_counter + 1).to_s
+      read_line()
+
+      task.checks = process_checks
+#       # pad tree with 'empty' checks
+#       if(task.checks.size == 0)then
+#         checks = []
+#         check = Check.new
+#         check.title = "- Empty -"
+#         check.id = "0"
+#         checks[0] = check
+#         task.checks = checks
+#       end
+      tasks[@tasks_counter] = task
+      @tasks_counter += 1
+    end
+    return tasks
+  end
+
+
+  def process_checks
+    checks = []
+    @checks_counter = 0
+    while(@tag == :check) do
+      progress("c")
+      check = Check.new
+      check.title = @param
+      check.id = (@tests_counter + 1).to_s
+      check.id = check.id + "." + (@tasks_counter + 1).to_s
+      check.id = check.id + "." + (@checks_counter + 1).to_s
+      checks[@checks_counter] = check
+      @checks_counter += 1
+      read_line()
+    end
+    return checks
+  end
+
+end

data/lib/testdoc.rb

@@ -0,0 +1,10 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+
+module TestDoc
+  VERSION = '0.0.2'
+
+end
+
+

data/lib/testdoc_module.rb

@@ -0,0 +1,182 @@
+
+module TestDoc
+
+  require 'erb'
+  require File.dirname(__FILE__) +  '/testdoc/testdocoptions'
+  require File.dirname(__FILE__) +  '/testdoc/testdocparser'
+
+
+
+# module TestDoc
+
+
+  class TestDoc
+
+    GENERATORS = {} # Not in use
+
+    # Name of the dotfile that contains the description of files to be
+    # processed in the current directory
+    DOT_DOC_FILENAME = ".document"
+
+    # Main method
+    def document(argv)
+
+      options = Options.instance
+      options.parse(argv, GENERATORS)
+      @generated_content = ""
+
+      puts "Title:" + options.title
+      @title =  options.title
+      header = File.dirname(__FILE__) + "/testdoc/header.html.erb"
+      @generated_content = process_template(header, nil) unless options.text
+      @progress = $stderr unless options.quiet
+      @num_files = 0
+      @options = options
+      files = options.files
+      files = ["."] if files.empty?
+
+      file_list = normalized_file_list(options, files, true)
+
+      template_file = File.dirname(__FILE__) + "/testdoc/template.html.erb"
+      if(options.text) then
+        template_file = File.dirname(__FILE__) + "/testdoc/template.debug.erb"
+      end
+
+      file_list.each do |fn|
+        $stderr.printf("\n%35s: ", File.basename(fn)) unless options.quiet
+        content = File.open(fn, "r") {|f| f.read}
+        testdoc_directives = []
+        testdoc_directives = parse_file(content)
+        parser = TestDocParser.new(testdoc_directives,File.basename(fn))
+        parser.options = options
+        testplans = []
+        testplans = parser.process_testplan
+        if(testplans) then
+          @generated_content += process_template(template_file,testplans)
+          @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
+
+      if( not options.text) then
+        footer = File.dirname(__FILE__) + "/testdoc/footer.html.erb"
+        @generated_content += process_template(footer, nil)
+        output_file = File.new("testplan.html", "w")
+        output_file.puts @generated_content
+      else
+        puts @generated_content
+      end
+
+    end
+
+    def process_template(template_file,testplans)
+      template = File.open(template_file, "r") {|f| f.read}
+      rhtml = ERB.new(template, safe_level = 0, trim_mode = 1 )
+      generated_html = rhtml.result(b=binding() ).gsub(/\n\n/,"\n")
+    end
+
+    # Exctract comments from file and return it in an array
+    def parse_file(content)
+
+      if /\t/ =~ content
+        tab_width = Options.instance.tab_width
+        content = content.split(/\n/).map do |line|
+          1 while line.gsub!(/\t+/) { ' ' * (tab_width*$&.length - $`.length % tab_width)}  && $~ #`
+          line
+        end .join("\n")
+      end
+      @content   = content
+      @content << "\n" unless @content[-1,1] == "\n"
+
+      testdoc_array = []
+      counter = 0
+
+      symbol = nil
+      line_number = 0
+      content.split(/\n/).map do |line|
+        line_number = line_number + 1
+
+        if line =~ /.*#.*test:(.*)/i then
+          symbol = :test
+          testdoc_array[counter] = [:test,$1.gsub(/^\s+/, ""),line_number]
+          counter = counter + 1
+        elsif line =~ /.*#.*task:(.*)/i then
+          testdoc_array[counter] = [:task,$1.gsub(/^\s+/, ""),line_number]
+          counter = counter + 1
+          symbol = :task
+        elsif line =~ /.*#.*check:(.*)/i then
+          testdoc_array[counter] = [:check,$1.gsub(/^\s+/, ""),line_number]
+          counter = counter + 1
+          symbol = :check
+        elsif line =~ /.*#.*testplan:(.*)/i then
+          testdoc_array[counter] = [:testplan,$1.gsub(/^\s+/, "") + "#",line_number]
+          counter = counter + 1
+          symbol = :testplan
+        elsif line =~ /.*#(.*)/ && symbol != nil then
+          testdoc_array[counter - 1][1] = testdoc_array[counter - 1][1] + " " + $1.gsub(/^ */, ' ')
+
+        else
+          symbol = nil
+        end
+
+      end
+
+      return testdoc_array
+    end
+
+    # 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 = []
+
+      relative_files.each do |rel_file_name|
+        next if exclude_pattern && exclude_pattern =~ rel_file_name
+        stat = File.stat(rel_file_name)
+        case type = stat.ftype
+        when "file"
+          next if @last_created and stat.mtime < @last_created
+          file_list << rel_file_name.sub(/^\.\//, '') ##  if force_doc || ParserFactory.can_parse(rel_file_name)
+        when "directory"
+          next if rel_file_name == "CVS" || rel_file_name == ".svn"
+          # puts "DEBUG: rel_file_name: " + rel_file_name
+          dot_doc = File.join(rel_file_name, DOT_DOC_FILENAME)
+          if File.file?(dot_doc)
+            file_list.concat(parse_dot_doc_file(rel_file_name, dot_doc, options))
+          else
+            file_list.concat(list_files_in_directory(rel_file_name, options))
+          end
+        else
+          raise TestDocError.new("I can't deal with a #{type} #{rel_file_name}")
+        end
+      end
+      file_list
+    end
+
+    # Return a list of the files to be processed in
+    # a directory. We know that this directory doesn't have
+    # a .document file, so we're looking for real files. However
+    # we may well contain subdirectories which must
+    # be tested for .document files
+    def list_files_in_directory(dir, options)
+      normalized_file_list(options, Dir.glob(File.join(dir, "*")), false, options.exclude)
+    end
+
+  end
+
+  class TestDocError < Exception
+  end
+
+end
+
+

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/testdoc.rb'}"
+puts "Loading testdoc gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/testdoc'

data/test/test_testdoc.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestTestdoc < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: testdoc
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- FIXME full name
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-09 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: "Generate testplans from annotated sourcecode.   Author: Thomas Flemming, thomasfl(snabela)usit.uio.no"
+email: 
+- FIXME email
+executables: 
+- testdoc
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- 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
+has_rdoc: true
+homepage: FIX (url)
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: testdoc
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Generate testplans from annotated sourcecode
+test_files: 
+- test/test_helper.rb
+- test/test_testdoc.rb