@@ -1,4 +1,4 @@
pkg
.DS_Store
config/*.yml
-*.tmproj
\ No newline at end of file
+*.tmproj
.gitignore
@@ -1,3 +1,9 @@
+== 1.0.0 2008-06-23
+
+* Added doctest: and doctest_require: special directives.
+* Bug fixes.
+* Documentation and wiki.
+
== 0.3.0 2008-06-17
* Added ability to put doctest code within .rb file comments
History.txt
@@ -1,13 +1,21 @@
#!/usr/bin/env ruby
-if ARGV.empty?
+options, files = ARGV.partition{ |a| a =~ /^-/ }
+
+if ARGV.empty? or options.include?("-h") or options.include?("--help")
+ require 'rubydoctest/version'
puts <<-DIRECTIONS
- USAGE: rubydoctest [options] <files>
+Ruby DocTest #{Rubydoctest::VERSION::STRING}
+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:
+ General:
+ --help - show this usage / help information
+ -t<n> - only run test number n, e.g. -t1 -t3
+
Output Format:
--html - output in HTML format
--plain - force output in plain text (no Ansi colors)
@@ -22,14 +30,15 @@ if ARGV.empty?
exit 0
end
-options, files = ARGV.partition{ |a| a =~ /^--/ }
-
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")
+tests = options.map{ |o| o =~ /^-t(\d+)/; $1 }.compact
+ruby_lines << "RubyDocTest.tests = #{tests.inspect};" if tests.size > 0
+
requires = requires.map {|lib| "require '#{lib}'; "}.join
def files_runner(command, files, requires, lines)
bin/rubydoctest
@@ -7,7 +7,7 @@ require "runner"
module RubyDocTest
class << self
- attr_accessor :trace, :ignore_interactive
+ attr_accessor :trace, :ignore_interactive, :tests
attr_writer :output_format
def output_format
lib/rubydoctest.rb
@@ -117,14 +117,14 @@ module RubyDocTest
def run
prepare_tests
- newline = "\n "
+ newline = "\n "
everything_passed = true
puts "=== Testing '#{@file_name}'..."
ok, fail, err = 0, 0, 0
- @tests.each do |t|
+ @tests.each_with_index do |t, index|
if SpecialDirective === t and t.name == "!!!"
start_irb unless RubyDocTest.ignore_interactive
- else
+ elsif RubyDocTest.tests.nil? or RubyDocTest.tests.include?(index + 1)
begin
if t.pass?
ok += 1
@@ -151,6 +151,7 @@ module RubyDocTest
:yellow)
end
puts \
+ "#{((index + 1).to_s + ".").ljust(3)} " +
"#{format_color(*status)} | " +
"#{t.description.split("\n").join(newline)}" +
(detail ? newline + detail : "")
lib/runner.rb
@@ -31,6 +31,16 @@
3 = { name = 'keyword.ruby.doctest'; };
};
patterns = (
+ {
+ begin = '^([ \t]*(#)\s+)';
+ end = '\n';
+ captures = {
+ 2 = { name = 'comment.line.number-sign.ruby'; };
+ };
+ patterns = (
+ { include = 'source.ruby.rails'; }
+ );
+ },
{ include = 'source.ruby.rails'; }
);
},
textmate/DocTest (Ruby).textmate
@@ -5,7 +5,7 @@
<link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
- rubydoctest
+ Ruby DocTest
</title>
<script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
<style>
@@ -30,7 +30,7 @@
<body>
<div id="main">
- <h1>rubydoctest</h1>
+ <h1>Ruby DocTest</h1>
<div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/rubydoctest"; return false'>
<p>Get Version</p>
<a href="http://rubyforge.org/projects/rubydoctest" class="numbers">1.0.0</a>
@@ -41,82 +41,35 @@
<h2>What</h2>
- <h2>Installing</h2>
-
-
- <p><pre class='syntax'><span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="ident">rubydoctest</span></pre></p>
+ <p>Ruby DocTest is a tool that lets you put irb-style tests in your documentation. It’s similar to Python’s doctest, but different in several ways.</p>
- <h2>The basics</h2>
-
-
- <h2>Demonstration of usage</h2>
+ <h2>Installing</h2>
- <h2>Forum</h2>
+ <p><pre class='syntax'><span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="ident">rubydoctest</span></pre></p>
- <p><a href="http://groups.google.com/group/rubydoctest">http://groups.google.com/group/rubydoctest</a></p>
+ <h2>Wiki, Documentation, Examples</h2>
- <p><span class="caps">TODO</span> – create Google Group – rubydoctest</p>
+ <p>See the <a href="http://github.com/tablatom/rubydoctest/wikis">github wiki</a></p>
<h2>How to submit patches</h2>
- <p>Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people’s code</a> and for section <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups">8b: Submit patch to Google Groups</a>, use the Google Group above.</p>
-
-
- <p><span class="caps">TODO</span> – pick <span class="caps">SVN</span> or Git instructions</p>
-
-
- <p>The trunk repository is <code>svn://rubyforge.org/var/svn/rubydoctest/trunk</code> for anonymous access.</p>
-
-
- <p><span class="caps">OOOORRRR</span></p>
-
-
- <p>You can fetch the source from either:</p>
-
-
- <ul>
- <li>rubyforge: <span class="caps">MISSING IN ACTION</span></li>
- </ul>
-
-
- <p><span class="caps">TODO</span> – You can not created a RubyForge project, OR have not run <code>rubyforge config</code>
-yet to refresh your local rubyforge data with this projects’ id information.</p>
-
-
- <p>When you do this, this message will magically disappear!</p>
-
-
- <p>Or you can hack website/index.txt and make it all go away!!</p>
-
-
- <ul>
- <li>github: <a href="http://github.com/GITHUB_USERNAME/rubydoctest/tree/master">http://github.com/GITHUB_USERNAME/rubydoctest/tree/master</a></li>
- </ul>
-
-
-<pre>git clone git://github.com/GITHUB_USERNAME/rubydoctest.git</pre>
-
- <p><span class="caps">TODO</span> – add “github_username: username” to ~/.rubyforge/user-config.yml and newgem will reuse it for future projects.</p>
-
+ <p>Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people’s code</a>.</p>
- <ul>
- <li>gitorious: <a href="git://gitorious.org/rubydoctest/mainline.git">git://gitorious.org/rubydoctest/mainline.git</a></li>
- </ul>
+ <p>The git repository is <code>http://github.com/tablatom/rubydoctest/tree/master</code> for anonymous access.</p>
-<pre>git clone git://gitorious.org/rubydoctest/mainline.git</pre>
<h3>Build and test instructions</h3>
<pre>cd rubydoctest
-rake test
+rake test:doctest
rake install_gem</pre>
<h2>License</h2>
@@ -128,9 +81,9 @@ rake install_gem</pre>
<h2>Contact</h2>
- <p>Comments are welcome. Send an email to <a href="mailto:FIXME"><span class="caps">FIXME</span> full name</a> email via the <a href="http://groups.google.com/group/rubydoctest">forum</a></p>
+ <p>Comments are welcome. Send an email to <a href="mailto:duane.johnson@gmail.com">Duane Johnson</a>.</p>
<p class="coda">
- <a href="mailto:duane.johnson@gmail.com">Duane Johnson</a>, 17th June 2008<br>
+ <a href="mailto:duane.johnson@gmail.com">Duane Johnson</a>, 23rd June 2008<br>
Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
</p>
</div>
website/index.html
@@ -1,83 +1,37 @@
-h1. rubydoctest
+h1. Ruby DocTest
h1. → 'rubydoctest'
h2. What
+Ruby DocTest is a tool that lets you put irb-style tests in your documentation. It’s similar to Python’s doctest, but different in several ways.
h2. Installing
<pre syntax="ruby">sudo gem install rubydoctest</pre>
-h2. The basics
+h2. Wiki, Documentation, Examples
-
-h2. Demonstration of usage
-
-
-
-h2. Forum
-
-"http://groups.google.com/group/rubydoctest":http://groups.google.com/group/rubydoctest
-
-TODO - create Google Group - rubydoctest
+See the "github wiki":http://github.com/tablatom/rubydoctest/wikis
h2. How to submit patches
-Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above.
-
-TODO - pick SVN or Git instructions
-
-The trunk repository is <code>svn://rubyforge.org/var/svn/rubydoctest/trunk</code> for anonymous access.
-
-OOOORRRR
-
-You can fetch the source from either:
-
-<% if rubyforge_project_id %>
-
-* rubyforge: "http://rubyforge.org/scm/?group_id=<%= rubyforge_project_id %>":http://rubyforge.org/scm/?group_id=<%= rubyforge_project_id %>
-
-<pre>git clone git://rubyforge.org/rubydoctest.git</pre>
+Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/.
-<% else %>
-
-* rubyforge: MISSING IN ACTION
-
-TODO - You can not created a RubyForge project, OR have not run <code>rubyforge config</code>
-yet to refresh your local rubyforge data with this projects' id information.
-
-When you do this, this message will magically disappear!
-
-Or you can hack website/index.txt and make it all go away!!
-
-<% end %>
-
-* github: "http://github.com/GITHUB_USERNAME/rubydoctest/tree/master":http://github.com/GITHUB_USERNAME/rubydoctest/tree/master
-
-<pre>git clone git://github.com/GITHUB_USERNAME/rubydoctest.git</pre>
-
-
-TODO - add "github_username: username" to ~/.rubyforge/user-config.yml and newgem will reuse it for future projects.
-
-
-* gitorious: "git://gitorious.org/rubydoctest/mainline.git":git://gitorious.org/rubydoctest/mainline.git
-
-<pre>git clone git://gitorious.org/rubydoctest/mainline.git</pre>
+The git repository is <code>http://github.com/tablatom/rubydoctest/tree/master</code> for anonymous access.
h3. Build and test instructions
<pre>cd rubydoctest
-rake test
+rake test:doctest
rake install_gem</pre>
-
h2. License
This code is free to use under the terms of the MIT license.
h2. Contact
-Comments are welcome. Send an email to "FIXME full name":mailto:FIXME email via the "forum":http://groups.google.com/group/rubydoctest
+Comments are welcome. Send an email to "Duane Johnson":mailto:duane.johnson@gmail.com.
website/index.txt
caa8f1a1a5536d51065f2c9ebe2f4ffcca292a26
Duane Johnson
duane.johnson@gmail.com
http://github.com/tablatom/rubydoctest/commit/0973138ca464e4d3561d050d02ab6e8c947d9f31
0973138ca464e4d3561d050d02ab6e8c947d9f31
2008-07-02T07:35:10-07:00
2008-07-02T07:35:10-07:00
Added -h / --help to command line. Added -t<n> to command-line so specific tests can be run. Added test numbers to output.
1d2e6000c7129e22cf44b4e325746424d48c9b70
Duane Johnson
duane.johnson@gmail.com