tdoc 0.3.0 → 0.4.0

data/README.rdoc

@@ -3,9 +3,19 @@
 
 == Test oriented documentation
 
-Tdoc combines rdoc, test::unit and shoulda, and concepts from rubytestdoc.
-
-- Tdoc files (default extention: .tdoc) map to Test::Unit::TestCase classes with a single context
+*note:* Version 0.4.0 completely breaks the API from 0.3.0
+
+Tdoc takes a single argument specifying the file or glob to be processed.  If no arguments are given, Tdoc will process "README.rdoc" in the working directory.
+
+- Tdoc will map each file given to a Test::Unit::TestCase.
+- For each such file, named e.g. '_filename_.rdoc', Tdoc will:
+  - require '<i>filename</i>_include.rb' if it exists
+  - create a context with the test case for each file in the directory named '_filename_' if it exists.
+  - process all :include: directives as follows:
+    - 
+    
+ 
+  
 - Tdoc directives take up 1 line, with the exception of the "examples" directive.  They may be preceded by any number of whitespace characters and terminate with a colon.
 - Tdoc understands the following directives:
   - tdoc_require
@@ -20,11 +30,11 @@ Tdoc combines rdoc, test::unit and shoulda, and concepts from rubytestdoc.
     assert_equal "asdf","asdf"
   Tdoc will then include all assertions within the context created from the example block
 
-  :include:rdoc/example.rdoc
-
 usage:
 
-  tdoc [test_directory] [extention]
+  tdoc [FILE_GLOB]
 
+examples:
 
+  :include:rdoc/example.rdoc
 

data/bin/tdoc.rb

@@ -2,52 +2,46 @@
 require 'rubygems'
 require 'test/unit'
 require 'shoulda'
-require 'optparse'
 
 $: << 'lib'
 
 LINST='^[#|\s]*'
+LINSTM='[#|\s]*'
+EXTENSIONS={:tests => '.rdoc',:requires => '_require.rb'}
+DEFAULT_FILE="README#{EXTENSIONS[:tests]}"
 
-def process
-  mk_context(@opts[:filename])
-end
-@opts={}
-OptionParser.new do |o|
-  o.on('-d DIRECTORY') { |d| @opts[:directory]=d}
-  o.on('-f FILENAME') { |f| @opts[:filename]=f}
-  o.on('-e EXTENTION') { |e| @opts[:extension]=e}
-  o.on('-h') { puts o; exit }
-  o.parse!
-end
-
-if @opts.empty?#for backward compatibility
-  TEST_DIR=ARGV[0] || 'tdoc/'
-  EXTENTION=ARGV[1] || '.tdoc'
-else
-  TEST_DIR=@opts[:directory] || 'rdoc/'
-  EXTENTION=@opts[:extension] || '.rdoc'
-end
-
-def mk_tests(test_dir)
-  files=Dir.glob("#{test_dir}*#{EXTENTION}")
-  files.each { |file| mk_context(file)}
+def process(files=nil) #called at end of script
+  files=ARGV.shift if ARGV
+  files||=DEFAULT_FILE
+    if files.class==Array
+      files.each {|f|`#{$PROGRAM_NAME} #{f}`}
+    else
+      mk_test_context(files)
+    end
 end
-def mk_context(file,test_case=nil)
-  test_name=File.basename(file).sub(EXTENTION,'')
+def mk_test_context(file, test_case=nil)
+  test_name=File.basename(file).sub(/\..*?$/,'')
+  test_dir=File.dirname(file)
   unless test_case
     test_case=Class.new(Test::Unit::TestCase)
     Object.const_set(:"Test#{test_name.capitalize}", test_case)
   end
   text=File.read(file)
-  directives=text.scan(/#{LINST}tdoc_(.+?):\s*(.+)/).inject({}) {|h,d| h[d[0].to_sym]||=[];h[d[0].to_sym] << d[1];h}
-  directives[:require].to_a.each {|r| require r}
-  directives[:context]||=[]
-  text.scan(/#{LINST}:include:\s*(.+)/).each do |i|
-    i[0].split(',').each do |file|
-      directives[:context] << file unless file.match(/^blob/)
+  opts={
+    :requires => Dir.glob("#{test_dir}/#{test_name}#{EXTENSIONS[:requires]}"),
+    :contexts => Dir.glob("#{test_dir}/#{test_name}/*#{EXTENSIONS[:tests]}"),
+    :test_cases => [],
+  }
+  [:requires, :test_cases].each do |opt|
+    text.scan(/#{LINST}:include:\s*(.+#{EXTENSIONS[opt]})/).each do |files|
+      files[0].split(',').each do |f|
+        opts[opt] << f unless f.match(/^blob/)
+      end
     end
   end
-  directives[:context].to_a.each {|c| mk_context "#{TEST_DIR}#{c}", test_case}
+  opts[:requires].each {|r| require "#{r}" if FileTest.exist? "#{r}" }
+  opts[:test_cases].delete_if {|c| c.match(/#{test_name}/)}
+  opts[:setup]=text.match(/#{LINSTM}setup\s+(.*?)#{LINSTM}end\s+/m).to_a[1]
   tests=text.split(/#{LINST}[Ee]xamples?:/).to_a[1..-1].to_a.map do |test|
     test.gsub!(/#{LINST}>>\s*(.+)\n#{LINST}=>\s*(.+)/) {|m| "assert_equal #{$1}, #{$2}"}
     lines=test.split(/\n/)
@@ -56,7 +50,7 @@ def mk_context(file,test_case=nil)
   end
   test_case.context test_name do 
     setup do 
-      eval directives[:setup].to_a.join ';'
+      eval opts[:setup].to_a.join ';'
     end
     tests.each do |test|
       should test[0] do
@@ -64,12 +58,7 @@ def mk_context(file,test_case=nil)
       end
     end
   end
+  opts[:contexts].compact.each {|c| mk_test_context "#{c}", test_case}
+  opts[:test_cases].each {|c| process(c)}
 end
-if Object.const_defined?(:TEST_DIR)
-  mk_tests(TEST_DIR)
-else
-  process
-end
-
-
-
+process

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tdoc
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Herb Daily
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-26 00:00:00 -03:00
+date: 2011-11-28 00:00:00 -03:00
 default_executable: tdoc.rb
 dependencies: 
 - !ruby/object:Gem::Dependency