textmate/DocTest (Markdown).textmate textmate/DocTest (Ruby).textmate textmate/DocTest (Text).textmate @@ -1,20 +1,18 @@ = Ruby DocTest -This work is originally from tablatom and drnic: +Official repository: * http://github.com/tablatom/rubydoctest -The new repository for 0.5 and up is at: - * http://github.com/canadaduane/rubydoctest +Wiki documentation: + * http://github.com/tablatom/rubydoctest/wikis == Description: Ruby version of Python's doctest tool, but a bit different. Ruby DocTest -allows you to put your tests right in with your Ruby code. It also allows you -to put tests in a separate documentation file and have the tests run -automatically. +allows you to: -There are two fundamental "modes" that Ruby DocTest works in: ruby source file -mode (":ruby") and doctest mode (":doctest"). See the examples section below. + 1. Write tests in irb format and keep them as comments next to your Ruby code. + 2. Write markdown documents with irb format tests embedded in them. == Synopsis: @@ -25,7 +23,8 @@ rubydoctest comes as an executable that takes a list of files: == Examples: -Here is how you might use RubyDocTest within an .rb file: +Here is how you might use RubyDocTest within a ruby source file (say called five.rb): + # doctest: Add 5 and 5 to get 10 # >> five_and_five # => 10 @@ -47,28 +46,7 @@ Here is an example doctest file (say called simple.doctest): >> 1 + 2 => 4 - Test a some multiline statements - - >> - class Person - attr_accessor :name - end - - >> Person - => Person - >> p = Person.new - >> p.name = "Tom" - >> p.name - => "Tom" - - - >> "a - b" - => "a\nb" - - >> 1 + - ?> 2 - => 3 +See the doc directory of this project for more .doctest examples and documentation. == Installation: @@ -78,7 +56,7 @@ Major releases: Build from source: - git clone git://github.com/canadaduane/rubydoctest.git + git clone git://github.com/tablatom/rubydoctest.git cd rubydoctest rake manifest:refresh && rake install README.txt @@ -2,11 +2,21 @@ if ARGV.empty? puts <<-DIRECTIONS - USAGE: rubydoctest [ --html ] [ --plain ] [ --trace ] [ --debugger ] <files> + USAGE: rubydoctest [options] <files> rubydoctest parses Ruby files (.rb) or DocTest files (.doctest) for irb-style sessions in comments, and runs the commented sessions as tests. + Options: + Output Format: + --html - output in HTML format + --plain - force output in plain text (no Ansi colors) + + Debug: + --ignore-interactive - do not heed !!! special directives + --trace - turn backtrace on to debug Ruby DocTest + --debugger - include ruby-debug library / gem + See http://github.com/tablatom/rubydoctest/wikis for more information. DIRECTIONS exit 0 @@ -18,6 +28,7 @@ requires = ['rubygems', File.dirname(__FILE__) + "/../lib/rubydoctest"] requires << 'ruby-debug' if options.include?("--debugger") ruby_lines = [] ruby_lines << "RubyDocTest.trace = true;" if options.include?("--trace") +ruby_lines << "RubyDocTest.ignore_interactive = true;" if options.include?("--ignore-interactive") requires = requires.map {|lib| "require '#{lib}'; "}.join bin/rubydoctest @@ -7,7 +7,7 @@ require "runner" module RubyDocTest class << self - attr_accessor :trace + attr_accessor :trace, :ignore_interactive attr_writer :output_format def output_format lib/rubydoctest.rb @@ -114,7 +114,7 @@ module RubyDocTest ok, fail, err = 0, 0, 0 @tests.each do |t| if SpecialDirective === t and t.name == "!!!" - start_irb + start_irb unless RubyDocTest.ignore_interactive else begin if t.pass? lib/runner.rb @@ -1,7 +1,8 @@ namespace :test do desc "Run doctests" task :doctest do - sh "ruby #{File.dirname(__FILE__)}/../bin/rubydoctest #{File.dirname(__FILE__)}/../test/doctest" + sh "ruby #{File.dirname(__FILE__)}/../bin/rubydoctest #{File.dirname(__FILE__)}/../lib/*.rb" + sh "ruby #{File.dirname(__FILE__)}/../bin/rubydoctest #{File.dirname(__FILE__)}/../doc/*.doctest" end namespace :doctest do tasks/doctests.rake aab168fdb48a14adc8896e78f252e0130c4c3eed Duane Johnson duane.johnson@gmail.com http://github.com/tablatom/rubydoctest/commit/4acf602ea5e12946bb6a75de5ae8bb859ea4fdf1 4acf602ea5e12946bb6a75de5ae8bb859ea4fdf1 2008-06-21T20:38:21-07:00 2008-06-21T20:38:21-07:00 Added TextMate language grammars. - Added --ignore-interactive command-line option (ignores '!!!' special directive) - Fixed that 'rake test:doctest' was not using new command line standards 0b2571536e9a89365c22c8fbd2a06420b242a10b Duane Johnson duane.johnson@gmail.com