tablatom-rubydoctest 0.2.1 → 1.0.0

data/lib/special_directive.rb

@@ -0,0 +1,44 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'lines'
+
+module RubyDocTest
+  class SpecialDirective < Lines
+    NAMES = ["doctest:", "!!!", "doctest_require:"]
+    NAMES_FOR_RX = NAMES.map{ |n| Regexp.escape(n) }.join("|")
+    
+    # === Test
+    #
+    # doctest: The name of the directive should be detected in the first line
+    # >> s = RubyDocTest::SpecialDirective.new(["doctest: Testing Stuff", "Other Stuff"])
+    # >> s.name
+    # => "doctest:"
+    def name
+      if m = lines.first.match(/^#{Regexp.escape(indentation)}(#{NAMES_FOR_RX})/)
+        m[1]
+      end
+    end
+    
+    # === Test
+    #
+    # doctest: The value of the directive should be detected in the first line
+    # >> s = RubyDocTest::SpecialDirective.new(["doctest: Testing Stuff", "Other Stuff"])
+    # >> s.value
+    # => "Testing Stuff"
+    #
+    # >> s = RubyDocTest::SpecialDirective.new(["  # doctest: Testing Stuff", "  # Other Stuff"])
+    # >> s.value
+    # => "Testing Stuff"
+    #
+    # doctest: Multiple lines for the directive value should work as well
+    # >> s = RubyDocTest::SpecialDirective.new(["doctest: Testing Stuff", "  On Two Lines"])
+    # >> s.value
+    # => "Testing Stuff\nOn Two Lines"
+    def value
+      if m = lines.join("\n").match(/^#{Regexp.escape(indentation)}(#{NAMES_FOR_RX})(.*)/m)
+        m[2].strip
+      end
+    end
+  end
+end

data/lib/statement.rb

@@ -0,0 +1,75 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubydoctest'
+require 'lines'
+
+module RubyDocTest
+  class EvaluationError < Exception
+    attr_reader :statement, :original_exception
+    def initialize(statement, original_exception)
+      @statement, @original_exception = statement, original_exception
+    end
+  end
+  
+  class Statement < Lines
+    
+    attr_reader :actual_result
+    
+    # === Tests
+    # 
+    # doctest: The FILENAME ruby constant should be replaced by the name of the file
+    # >> __FILE__[/statement\.rb$/]
+    # => "statement.rb"
+    def initialize(doc_lines, line_index = 0, file_name = nil)
+      @file_name = file_name
+      super(doc_lines, line_index)
+    end
+    
+    # === Tests
+    # 
+    # doctest: A statement should parse out a '>>' irb prompt
+    # >> s = RubyDocTest::Statement.new([">> a = 1"])
+    # >> s.source_code
+    # => "a = 1"
+    #
+    # doctest: More than one line should get included, if indentation so indicates
+    # >> s = RubyDocTest::Statement.new([">> b = 1 +", " 1", "not part of the statement"])
+    # >> s.source_code
+    # => "b = 1 +\n1"
+    #
+    # doctest: Lines indented by ?> should have the ?> removed.
+    # >> s = RubyDocTest::Statement.new([">> b = 1 +", "?> 1"])
+    # >> s.source_code
+    # => "b = 1 +\n1"
+    def source_code
+      lines.first =~ /^#{Regexp.escape(indentation)}>>\s(.*)$/
+      first = [$1]
+      remaining = (lines[1..-1] || [])
+      (first + remaining).join("\n")
+    end
+    
+    # === Test
+    #
+    # doctest: Evaluating a multi-line statement should be ok
+    # >> s = RubyDocTest::Statement.new([">> b = 1 +", " 1", "not part of the statement"])
+    # >> s.evaluate
+    # => 2
+    #
+    # doctest: Evaluating a syntax error should raise an EvaluationError
+    # >> s = RubyDocTest::Statement.new([">> b = 1 +"])
+    # >> begin s.evaluate; :fail; rescue RubyDocTest::EvaluationError; :ok end
+    # => :ok
+    def evaluate
+      sc = source_code.gsub("__FILE__", @file_name.inspect)
+      # puts "EVAL: #{sc}"
+      @actual_result = eval(sc, TOPLEVEL_BINDING, __FILE__, __LINE__)
+    rescue Exception => e
+      if RubyDocTest.trace
+        raise e.class, e.to_s + "\n" + e.backtrace.first
+      else
+        raise EvaluationError.new(self, e)
+      end
+    end
+  end
+end

data/lib/test.rb

@@ -0,0 +1,29 @@
+module RubyDocTest
+  # This is the top-level 'test' container that holds an optional description and one
+  # or more CodeBlock objects.
+  class Test
+    attr_accessor :description
+    attr_reader :code_blocks, :passed
+    
+    def initialize(description, code_blocks)
+      @description, @code_blocks = description, code_blocks
+    end
+    
+    def pass?
+      @passed = @code_blocks.all?{ |c| c.pass? }
+    end
+    
+    def first_failed
+      @code_blocks.detect{ |cb| !cb.pass? }
+    end
+    
+    def actual_result
+      first_failed.actual_result.inspect
+    end
+    
+    def expected_result
+      first_failed.expected_result
+    end
+  end
+  
+end

data/rubydoctest.gemspec

@@ -0,0 +1,32 @@
+Gem::Specification.new do |s|
+  s.name = %q{rubydoctest}
+  s.version = "1.0.0"
+
+  s.specification_version = 2 if s.respond_to? :specification_version=
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Duane Johnson", "Tom Locke", "Dr Nic Williams"]
+  s.date = %q{2008-06-21}
+  s.default_executable = %q{rubydoctest}
+  s.description = %q{Ruby version of Python's doctest tool, but a bit different.}
+  s.email = ["duane.johnson@gmail.com"]
+  s.executables = ["rubydoctest"]
+  s.extra_rdoc_files = ["History.txt", "License.txt", "Manifest.txt", "PostInstall.txt", "README.txt", "website/index.txt"]
+  s.files = IO.read("Manifest.txt").split("\n")
+  s.has_rdoc = true
+  s.homepage = %q{http://rubydoctest.rubyforge.org}
+  s.post_install_message = %q{
+rubydoctest comes as an executable that takes a file or directory:
+	
+  rubydoctest .
+	rubydoctest simple.doctest
+
+
+}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{rubydoctest}
+  s.rubygems_version = %q{1.1.1}
+  s.summary = %q{Ruby version of Python's doctest tool, but a bit different.}
+  s.test_files = []
+end

data/script/rstakeout

@@ -0,0 +1,92 @@
+#!/usr/bin/env ruby
+
+##
+# Originally by Mike Clark.
+#
+# From http://www.pragmaticautomation.com/cgi-bin/pragauto.cgi/Monitor/StakingOutFileChanges.rdoc
+#
+# Runs a user-defined command when files are modified.
+#
+# Like autotest, but more customizable. This is useful when you want to do
+# something other than run tests. For example, generate a PDF book, run
+# a single test, or run a legacy Test::Unit suite in an app that also
+# has an rSpec suite.
+#
+# Can use Ruby's Dir[] to get file glob. Quote your args to take advantage of this.
+#
+#  rstakeout 'rake test:recent' **/*.rb
+#  => Only watches Ruby files one directory down (no quotes)
+#
+#  rstakeout 'rake test:recent' '**/*.rb'
+#  => Watches all Ruby files in all directories and subdirectories
+#
+# Modified (with permission) by Geoffrey Grosenbach to call growlnotify for
+# rspec and Test::Unit output.
+#
+# See the PeepCode screencast on rSpec or other blog articles for instructions on
+# setting up growlnotify.
+
+def growl(title, msg, img, pri=0, sticky="")
+  system "growlnotify -n autotest --image ~/.autotest_images/#{img} -p #{pri} -m #{msg.inspect} #{title} #{sticky}"
+end
+
+def self.growl_fail(output)
+  growl "FAIL", "#{output}", "fail.png", 2
+end
+
+def self.growl_pass(output)
+  growl "Pass", "#{output}", "pass.png"
+end
+
+command = ARGV.shift
+files = {}
+
+ARGV.each do |arg|
+  Dir[arg].each { |file|
+    files[file] = File.mtime(file)
+  }
+end
+
+puts "Watching #{files.keys.join(', ')}\n\nFiles: #{files.keys.length}"
+
+trap('INT') do
+  puts "\nQuitting..."
+  exit
+end
+
+
+loop do
+
+  sleep 1
+
+  changed_file, last_changed = files.find { |file, last_changed|
+    File.mtime(file) > last_changed
+  }
+
+  if changed_file
+    files[changed_file] = File.mtime(changed_file)
+    puts "=> #{changed_file} changed, running #{command}"
+    args = ""
+    args += ARGV.last == '--pass-as-arg' ? changed_file : ""
+    args += ARGV.last == '--pass-as-env' ? "CHANGED=#{changed_file}" : ""
+    puts "Executing: #{command} #{args}"
+    results = `#{command} #{args}`
+    puts results
+
+    if results.include? 'tests'
+      output = results.slice(/(\d+)\s+tests?,\s*(\d+)\s+assertions?,\s*(\d+)\s+failures?(,\s*(\d+)\s+errors)?/)
+      if output
+        $~[3].to_i + $~[5].to_i > 0 ? growl_fail(output) : growl_pass(output)
+      end
+    else
+      output = results.slice(/(\d+)\s+examples?,\s*(\d+)\s+failures?(,\s*(\d+)\s+not implemented)?/)
+      if output
+        $~[2].to_i > 0 ? growl_fail(output) : growl_pass(output)
+      end
+    end
+    # TODO Generic growl notification for other actions
+
+    puts "=> done"
+  end
+
+end

data/tasks/doctests.rake

@@ -0,0 +1,29 @@
+namespace :test do
+  desc "Run doctests"
+  task :doctest do
+    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
+    desc "Run rstakeout on test/doctest files"
+    task :auto do
+      tests = "#{File.dirname(__FILE__)}/../test/doctest/*"
+      tests_path = File.dirname(tests)
+      files = "#{File.dirname(__FILE__)}/../lib/*.rb #{File.dirname(__FILE__)}/../bin/*"
+      sh "#{File.dirname(__FILE__)}/../script/rstakeout 'rake test:doctest:changed DOCTESTS=#{tests_path}' #{tests} #{files} --pass-as-env"
+    end
+    
+    desc "Run doctest(s) based on a specific file that changed"
+    task :changed do
+      file = ENV['CHANGED']
+      doctests = ENV['DOCTESTS']
+      unless file && doctests
+        puts "Requires ENV['CHANGED']=file_path and ENV['DOCTESTS']=some/path/**/*.doctest"
+        exit
+      end
+      tests = File.basename(file) =~ %r{\..*doctest\Z} ? file : doctests
+      sh "ruby #{File.dirname(__FILE__)}/../bin/rubydoctest #{tests}"
+    end
+  end
+end

data/textmate/DocTest (Markdown).textmate

@@ -0,0 +1,7 @@
+{	scopeName = 'text.html.markdown.ruby.doctest';
+	fileTypes = ( 'doctest', 'rdoctest' );
+	patterns = (
+		{	include = 'text.ruby.doctest'; },
+		{	include = 'text.html.markdown'; }
+	);
+}

data/textmate/DocTest (Ruby).textmate

@@ -0,0 +1,55 @@
+{	scopeName = 'source.ruby.doctest';
+	patterns = (
+		{	name = 'comment.block.documentation.ruby';
+			comment = 'multiline comments';
+			begin = '^=begin';
+			end = '^=end';
+			captures = { 0 = { name = 'punctuation.definition.comment.ruby'; }; };
+			patterns = (
+				{ include = "text.ruby.doctest"; }
+			);
+		},
+		{
+			name = 'source.ruby.doctest.description.commented';
+			begin = '^([ \t]*(#)\s+)(doctest:)(.*)';
+			end = '^(?!\1)|^(?=\1[^\s])|^(?=\1$)';
+			captures = {
+				2 = { name = 'comment.line.number-sign.ruby';};
+				3 = { name = 'keyword.ruby.doctest'; };
+				4 = { name = 'comment.ruby.doctest'; };
+			};
+			patterns = (
+				{ include = '#indented_description'; }
+			);
+		},
+		{
+			name = 'source.ruby.doctest.statement.commented';
+			begin = '^([ \t]*(#)\s+)(>>|=>|doctest_require:)';
+			end = '^(?!\1)|^(?=\1[^\s])|^(?=\1$)';
+			captures = {
+				2 = { name = 'comment.line.number-sign.ruby'; };
+				3 = { name = 'keyword.ruby.doctest'; };
+			};
+			patterns = (
+				{ include = 'source.ruby.rails'; }
+			);
+		},
+		{
+			name = 'source.ruby.doctest.directive';
+			begin = '^([ \t]*(#)\s+)(\!\!\!)\s*$';
+			end = '\n';
+			captures = {
+				2 = { name = 'comment.line.number-sign.ruby'; };
+				3 = { name = 'keyword.ruby.doctest'; };
+			};
+		},
+		{	include = 'source.ruby'; }
+	);
+	repository = {
+		indented_description = {
+			name = 'comment.ruby.doctest';
+			begin = '^([ \t]*#\s+)(.+)';
+			end = '^(?!\1)';
+		};
+	};
+}

data/textmate/DocTest (Text).textmate

@@ -0,0 +1,66 @@
+{	scopeName = 'text.ruby.doctest';
+	fileTypes = ( 'txt', 'text' );
+	patterns = (
+		{
+			name = 'source.ruby.doctest.description.unindented';
+			begin = '^(doctest:)(.*)';
+			end = '^(?=[^\s]|$)';
+			captures = {
+				1 = { name = 'keyword.ruby.doctest'; };
+				2 = { name = 'comment.ruby.doctest'; };
+			};
+			patterns = (
+				{ include = '#indented_description'; }
+			);
+		},
+		{
+			name = 'source.ruby.doctest.description.indented';
+			begin = '^(\s+)(doctest:)(.*)';
+			end = '^(?!\1)|^(?=\1[^\s])|^(?=\1$)';
+			captures = {
+				2 = { name = 'keyword.ruby.doctest'; };
+				3 = { name = 'comment.ruby.doctest'; };
+			};
+			patterns = (
+				{ include = '#indented_description'; }
+			);
+		},
+		{
+			name = 'source.ruby.doctest.statement.unindented';
+			begin = '^(>>|=>|doctest_require:)';
+			end = '^(?=[^\s]|$)';
+			captures = {
+				1 = { name = 'keyword.ruby.doctest'; };
+			};
+			patterns = (
+				{ include = 'source.ruby.rails'; }
+			);
+		},
+		{
+			name = 'source.ruby.doctest.statement.indented';
+			begin = '^(\s+)(>>|=>|doctest_require:)';
+			end = '^(?!\1)|^(?=\1[^\s])|^(?=\1$)';
+			captures = {
+				2 = { name = 'keyword.ruby.doctest'; };
+			};
+			patterns = (
+				{ include = 'source.ruby.rails'; }
+			);
+		},
+		{
+			name = 'source.ruby.doctest.directive';
+			begin = '^(\s*)(\!\!\!)\s*$';
+			end = '\n';
+			captures = {
+				2 = { name = 'keyword.ruby.doctest'; };
+			};
+		}
+	);
+	repository = {
+		indented_description = {
+			name = 'comment.ruby.doctest';
+			begin = '^(\s+)(.+)';
+			end = '^(?!\1)';
+		};
+	};
+}

data/website/index.html

@@ -1,11 +1,141 @@
-<html>
-	<head>
-		<meta http-equiv="Content-type" content="text/html; charset=utf-8">
-		<title>rubydoctest</title>
-		
-	</head>
-	<body id="body">
-		<p>This page has not yet been created for RubyGem <code>rubydoctest</code></p>
-		<p>To the developer: To generate it, update website/index.txt and run the rake task <code>website</code> to generate this <code>index.html</code> file.</p>
-	</body>
-</html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <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
+  </title>
+  <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
+<style>
+
+</style>
+  <script type="text/javascript">
+    window.onload = function() {
+      settings = {
+          tl: { radius: 10 },
+          tr: { radius: 10 },
+          bl: { radius: 10 },
+          br: { radius: 10 },
+          antiAlias: true,
+          autoPad: true,
+          validTags: ["div"]
+      }
+      var versionBox = new curvyCorners(settings, document.getElementById("version"));
+      versionBox.applyCornersToAll();
+    }
+  </script>
+</head>
+<body>
+<div id="main">
+
+    <h1>rubydoctest</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>
+    </div>
+    <h1>&#x2192; &#8216;rubydoctest&#8217;</h1>
+
+
+	<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>
+
+
+	<h2>The basics</h2>
+
+
+	<h2>Demonstration of usage</h2>
+
+
+	<h2>Forum</h2>
+
+
+	<p><a href="http://groups.google.com/group/rubydoctest">http://groups.google.com/group/rubydoctest</a></p>
+
+
+	<p><span class="caps">TODO</span> &#8211; create Google Group &#8211; rubydoctest</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&#8217;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> &#8211; 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> &#8211; 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&#8217; 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> &#8211; add &#8220;github_username: username&#8221; to ~/.rubyforge/user-config.yml and newgem will reuse it for future projects.</p>
+
+
+	<ul>
+	<li>gitorious: <a href="git://gitorious.org/rubydoctest/mainline.git">git://gitorious.org/rubydoctest/mainline.git</a></li>
+	</ul>
+
+
+<pre>git clone git://gitorious.org/rubydoctest/mainline.git</pre>
+
+	<h3>Build and test instructions</h3>
+
+
+<pre>cd rubydoctest
+rake test
+rake install_gem</pre>
+
+	<h2>License</h2>
+
+
+	<p>This code is free to use under the terms of the <span class="caps">MIT</span> license.</p>
+
+
+	<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 class="coda">
+      <a href="mailto:duane.johnson@gmail.com">Duane Johnson</a>, 17th June 2008<br>
+      Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
+    </p>
+</div>
+
+<!-- insert site tracking codes here, like Google Urchin -->
+
+</body>
+</html>