tdoc 0.1.0

data/README.rdoc

@@ -0,0 +1,28 @@
+
+=Tdoc 
+
+== 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
+- 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
+  - tdoc_context
+  - tdoc_setup
+  - examples
+
+  tdoc_require: rubygems
+
+  examples:
+    
+    >> "asdf"
+    -> "asdf"
+
+  usage:
+
+    tdoc [test_directory] [extention]
+
+
+

data/bin/tdoc.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/ruby
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$: << 'lib'
+
+TEST_DIR=ARGV[0] || 'tdoc/'
+EXTENTION=ARGV[1] || '.tdoc'
+LINST='^[#|\s]*'
+
+def mk_context(file,test_case=nil)
+  test_name=File.basename(file).sub(EXTENTION,'')
+  unless test_case
+    test_case=eval "::Test#{test_name.capitalize}=Class.new(Test::Unit::TestCase)"
+  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].to_a.each {|c| mk_context "#{TEST_DIR}#{c}", test_case}
+  tests=text.split(/#{LINST}[Ee]xamples:/).to_a[1..-1].to_a.map do |test|
+    [test.split(/\n/)[0], test.scan(/#{LINST}>>\s*(.+)\n#{LINST}=>\s*(.+)/) ]
+  end
+  test_case.class_eval do
+    context test_name do 
+      setup do 
+        eval directives[:setup].to_a.join ';'
+      end
+      tests.each do |test|
+        should test[0] do
+          test[1].each do |assertion|
+            assert_equal eval(assertion[0]), eval(assertion[1])
+          end
+        end
+      end
+    end
+  end
+end
+def mk_tests(test_dir)
+  files=Dir.glob("#{test_dir}*#{EXTENTION}")
+  files.each { |file| mk_context(file)}
+end
+mk_tests(TEST_DIR)
+
+
+

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: tdoc
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Herb Daily
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-25 00:00:00 -03:00
+default_executable: tdoc.rb
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.11.3
+    version: 
+description: "Combines Test::Unit, Shoulda, and Rdoc to embed tests inside documentation "
+email: herb.daily@safe-mail.net
+executables: 
+- tdoc.rb
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- bin/tdoc.rb
+has_rdoc: true
+homepage: http://github.com/herbdaily/tdoc
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: 1.0.0
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Test oriented documentation
+test_files: []
+