bryanlarsen-rubydoctest 1.0.2

data/lib/special_directive.rb

@@ -0,0 +1,54 @@
+$:.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:", "it:", "!!!", "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:"
+    #
+    # doctest: "it:" is a valid directive
+    # >> s = RubyDocTest::SpecialDirective.new(["it: should test stuff"])
+    # >> s.name
+    # => "it:"
+    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"
+    #
+    # doctest: "it" should also work as a directive
+    # >> s = RubyDocTest::SpecialDirective.new(["it: should do something"])
+    # >> s.value
+    # => "should do something"
+    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,81 @@
+$:.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)
+      if RubyDocTest.verbose
+        puts "EVAL: #{sc}"
+      end
+      @actual_result = eval(sc, TOPLEVEL_BINDING, __FILE__, __LINE__)
+      if RubyDocTest.verbose
+        puts "RESULT: #{@actual_result}"
+      end
+      @actual_result
+    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,72 @@
+Gem::Specification.new do |s|
+  s.name = "rubydoctest"
+  s.version = "1.0.2"
+
+  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 = "2008-12-06"
+  s.default_executable = "rubydoctest"
+  s.description = "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"]
+  manifest = <<-MANIFEST
+    History.txt
+    License.txt
+    Manifest.txt
+    PostInstall.txt
+    README.txt
+    Rakefile
+    bin/rubydoctest
+    config/hoe.rb
+    config/requirements.rb
+    lib/code_block.rb
+    lib/doctest_require.rb
+    lib/lines.rb
+    lib/result.rb
+    lib/rubydoctest.rb
+    lib/rubydoctest/version.rb
+    lib/runner.rb
+    lib/special_directive.rb
+    lib/statement.rb
+    lib/test.rb
+    rubydoctest.gemspec
+    script/console
+    script/destroy
+    script/generate
+    script/rstakeout
+    script/txt2html
+    setup.rb
+    tasks/deployment.rake
+    tasks/doctests.rake
+    tasks/environment.rake
+    tasks/website.rake
+    textmate/DocTest (Markdown).textmate
+    textmate/DocTest (Ruby).textmate
+    textmate/DocTest (Text).textmate
+    website/index.html
+    website/index.txt
+    website/javascripts/rounded_corners_lite.inc.js
+    website/stylesheets/screen.css
+    website/template.html.erb
+  MANIFEST
+  s.files = manifest.strip.split("\n").map{|m| m.strip}
+  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/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/rubydoctest.rb'}"
+puts "Loading rubydoctest gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

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/script/txt2html

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+
+GEM_NAME = 'rubydoctest' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'rubydoctest'
+
+require 'rubygems'
+begin
+  require 'newgem'
+  require 'rubyforge'
+rescue LoadError
+  puts "\n\nGenerating the website requires the newgem RubyGem"
+  puts "Install: gem install newgem\n\n"
+  exit(1)
+end
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + "/../lib/#{GEM_NAME}/version.rb"
+
+version  = Rubydoctest::VERSION::STRING
+download = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+def rubyforge_project_id
+  RubyForge.new.autoconfig["group_ids"][RUBYFORGE_PROJECT]
+end
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.join(File.dirname(__FILE__), '/../website/template.html.erb')
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.html.erb] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text_template = fsrc.read
+  body_text = ERB.new(body_text_template).result(binding)
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)