rubydoctest 0.2.1

data/History.txt

@@ -0,0 +1,14 @@
+== 0.2.1 2008-05-26
+
+* Adding self-doctesting doctests
+
+== 0.2.0 2008-05-25
+
+* Initial changes by Dr Nic
+* __FILE__ is changed to the explicit file path (since it was eval'ing to the code, not the test file)
+* Starting to write doctests for the project itself
+
+== 0.1.0 2008-05-25
+
+* 1 major enhancement:
+  * Initial release from Tom's personal stash of code

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 FIXME full name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,31 @@
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+README.txt
+Rakefile
+bin/rubydoctest
+config/hoe.rb
+config/requirements.rb
+lib/rubydoctest.rb
+lib/rubydoctest/version.rb
+rubydoctest.gemspec
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/doctests.rake
+tasks/environment.rake
+tasks/website.rake
+test/doctest/file_relative.doctest
+test/doctest/runner.doctest
+test/doctest/simple.doctest
+test/test_helper.rb
+test/test_rubydoctest.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/PostInstall.txt

@@ -0,0 +1,8 @@
+
+rubydoctest comes as an executable that takes a file or directory:
+	
+	rubydoctest .
+	rubydoctest some/path/to/tests
+	rubydoctest simple.doctest
+
+

data/README.txt

@@ -0,0 +1,109 @@
+= rubydoctest
+
+* http://github.com/tablatom/rubydoctest
+
+== DESCRIPTION:
+
+Ruby version of Python's doctest tool, but a bit different.
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+rubydoctest comes as an executable that takes a file or directory:
+	
+  rubydoctest .
+	rubydoctest simple.doctest
+
+== EXAMPLE:
+	
+Here is an example doctest file (say called simple.doctest):
+	
+	# Simple test of RubyDocTest
+
+	This is an example test
+
+		>> 1 + 2
+		=> 3
+
+	And here's a test that will fail
+
+		>> 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
+
+== INSTALL:
+
+Major releases:
+
+	sudo gem install rubydoctest
+
+Build from source:
+
+	git clone git://github.com/tablatom/rubydoctest.git
+	cd rubydoctest
+	rake manifest && rake install
+
+== SELF-DOCTESTING:
+	
+Ruby DocTest uses itself to test and document itself.
+
+	rake test:doctest
+	
+In development of Ruby DocTest, there is an autotest system in-built
+using script/rstakeout
+
+	rake test:doctest:auto
+
+== TEXTMATE BUNDLE:
+	
+See http://github.com/drnic/ruby-doctest-tmbundle
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIX
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/bin/rubydoctest

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+USAGE = "USAGE: rdoctest [ --html ] [ --trace ] [ --debugger ] <path>"
+
+SUFFIX = "{r,}doctest"
+
+file = ARGV.pop or (puts USAGE; exit 1)
+
+requires = ['rubygems', File.dirname(__FILE__) + "/../lib/rubydoctest"]
+requires << 'ruby-debug' if ARGV.include?("--debugger")
+
+command = if ARGV.include?("--rcov")
+            args = (ARGV - ["--rcov"]).map { |a| %("#{a}") }.join(' ')
+            "rcov -x /gems/,rdoctest"
+          else
+            "ruby"
+          end
+trace = "RubyDocTest.trace = true;" if ARGV.include?("--trace")
+
+requires = requires.map {|lib| "require '#{lib}'; "}.join
+
+puts "<html><body><pre>" if ARGV.include?("--html")
+
+files = if File.directory?(file)
+          Dir["#{file}/**/*.#{SUFFIX}"]
+        else
+          [file]
+        end
+
+files.reverse_each do |f|
+  puts  "*** " + f.sub("#{file}/", "").sub(".#{SUFFIX}", ""), "" if files.length > 1
+  system %(#{command} -e "#{requires} #{trace} RubyDocTest.new(File.read('#{f}'), '#{f}').run")
+end
+
+puts "</pre></body></html>" if ARGV.include?("--html")

data/config/hoe.rb

@@ -0,0 +1,74 @@
+require 'rubydoctest/version'
+
+AUTHOR = ['Tom Locke', 'Dr Nic Williams']  # can also be an array of Authors
+EMAIL = "drnicwilliams@gmail.com"
+DESCRIPTION = "Ruby version of Python's doctest tool, but a bit different."
+GEM_NAME = 'rubydoctest' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'rubydoctest' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+#  ['activesupport', '>= 1.3.1']
+]    # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = Rubydoctest::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'rubydoctest documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR
+  p.email = EMAIL
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/rubydoctest.rb

@@ -0,0 +1,271 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'irb'
+
+class RubyDocTest
+  
+  class << self
+    attr_accessor :trace
+  end
+
+  PROMPT_RX = /^[>?]>( |\s*$)/
+  
+  RESULT_RX = /^=> /
+  
+  CODE_LINE_RX = /^(    |\t)/
+  
+  def initialize(src, file_name)
+    @passed = 0
+    @block_count = 0
+    @failures = []
+    @src_lines = src.split("\n")
+    @line_num = 0
+    @file_name = file_name
+    
+    # next_line # get first line
+  end
+  
+  def run
+    run_file
+    print_report
+  end
+  
+  attr_accessor :passed, :failures, :current_line, :src_lines, :line_num, :block_count
+  
+  def environment
+    TOPLEVEL_BINDING
+  end
+  
+  def next_line
+    @line_num += 1
+    @current_line = src_lines.shift
+  end
+  
+  def next_line?
+    src_lines.any?
+  end
+  
+  def strip_prompt(s)
+    s.sub(PROMPT_RX, "")
+  end
+
+  def result_start?(s=current_line)
+    s =~ RESULT_RX
+  end
+  
+  def string_result_start?(s=current_line)
+    s =~ /^=>""/
+  end
+  
+  def statement_start?(s=current_line)
+    s =~ PROMPT_RX
+  end
+  
+  def strip_result_marker(s=current_line)
+    s.sub(RESULT_RX, "")
+  end
+  
+  def normalize_result(s)
+    s.gsub(/:0x[a-f0-9]{8}>/, ':0xXXXXXXXX>').strip
+  end
+  
+  def code_line?(s=current_line)
+    s =~ CODE_LINE_RX
+  end
+  
+  def code_block_start?(s=current_line)
+    l = unindent_code_line
+    code_line? && (statement_start?(l) || irb_interrupt?(l))
+  end
+  
+  def blank_line?(s=current_line)
+    s =~ /^\s*$/
+  end
+  
+  def irb_interrupt?(line)
+    line =~ /!!!/
+  end
+  
+  def run_file
+    # run_code_block if code_block_start?
+    while next_line
+      run_code_block if code_block_start?
+    end
+    failures.length == 0
+  end
+  
+  def unindent_code_line(s=current_line)
+    s.sub(CODE_LINE_RX, "")
+  end
+  
+  
+  def get_code_lines
+    lines = []
+    while blank_line? || code_line?
+      lines << [unindent_code_line, line_num]
+      next_line
+    end
+    lines.pop while blank_line?(lines.last)
+    lines
+  end
+  
+  
+  def run_code_block
+    self.block_count += 1
+    
+    lines = get_code_lines
+    
+    reading = :statement
+
+    result = nil
+    statement = ""
+    statement_line = lines.first.last
+    lines.each do |line, line_num|
+      
+      if irb_interrupt?(line)
+        evaluate(statement, statement_line) unless statement == ""
+        
+        puts statement unless statement.blank?
+        puts "=> #{result}" unless result.blank?
+        puts
+        
+        start_irb
+        line = nil
+        
+      elsif string_result_start?(line)
+        reading = :string_result
+        line = nil
+        result = ""
+        
+      elsif result_start?(line)
+        reading = :ruby_result
+        line = strip_result_marker(line)
+        result = ""
+
+      elsif statement_start?(line)
+        if result
+          # start of a new statement
+          if reading == :string_result
+            # end of a string result statement
+            result.chomp!
+            run_statement(statement, result, statement_line, true)
+          else
+            run_statement(statement, result, statement_line)
+          end
+          statement_line = line_num
+          statement = ""
+          result = nil
+        end
+        reading = :statement
+      end
+      
+      if reading == :statement
+        # The statement has a prompt on every line
+        if line
+          line = strip_prompt(line)
+          statement << line + "\n" 
+        end
+      else
+        # There's only one result marker - stripped above
+        result << line + "\n" if line
+      end
+      
+    end
+    
+    if result.nil?
+      # The block ends with a statement - just evaluate it
+      evaluate(statement, statement_line)
+    else
+      run_statement(statement, result, statement_line)
+    end
+  end
+  
+  
+  def start_irb
+    IRB.init_config(nil)
+    IRB.conf[:PROMPT_MODE] = :SIMPLE
+    irb = IRB::Irb.new(IRB::WorkSpace.new(environment))
+    IRB.conf[:MAIN_CONTEXT] = irb.context
+    irb.eval_input
+  end
+  
+  
+  def run_statement(statement, expected_result, statement_line, string_comparison=false)
+    actual_result = evaluate(statement, statement_line)
+    
+    if result_matches?(expected_result, actual_result, string_comparison)
+      self.passed += 1
+    else
+      actual_result = actual_result.inspect unless string_comparison
+      failures << [statement, actual_result, expected_result, statement_line]
+    end
+  end
+  
+  
+  def result_matches?(expected_result, actual_result, string_comparison)
+    if string_comparison
+      actual_result == expected_result
+    else
+      actual_result = actual_result.inspect
+      normalize_result(expected_result) == normalize_result(actual_result) or
+          # If the expected result looks like a literal, see if they eval to equal objects - this will often fail
+          if expected_result =~ /^[:\[{A-Z'"%\/]/
+            begin
+              eval(expected_result) == eval(actual_result)
+            rescue Exception
+              false
+            end
+          end
+    end
+  end
+  
+  
+  def evaluate(statement, line_num)
+    statement.gsub!("__FILE__", @file_name.inspect)
+    eval(statement, environment, __FILE__, __LINE__)
+  rescue SyntaxError => e
+    puts "Syntax error in statement on line #{line_num}:"
+    puts indent(statement)
+    puts e.to_s
+    puts
+    exit 1
+  rescue Exception => e
+    puts "Exception in statement on line #{line_num}:"
+    puts indent(statement)
+    puts e.backtrace
+    
+    if RubyDocTest.trace
+      raise
+    else
+      puts e.to_s
+      puts
+      exit 1      
+    end
+  end
+  
+  
+  def number_run
+    passed + failures.length
+  end
+  
+  def indent(s, level=4)
+    spaces = " " * level
+    spaces + s.split("\n").join("\n#{spaces}")
+  end
+  
+  def print_report
+    statements_per_block = number_run.to_f / block_count
+    puts("%d blocks, %d tests (avg. %.1f/block), %d failures\n\n" %
+         [block_count, number_run, statements_per_block, failures.length])
+    
+    failures.each do |statement, actual, expected, lnum|
+      puts "Failure line #{lnum}"
+      puts "  Statement:", indent(statement)
+      puts "  Expected:",  indent(expected)
+      puts "  Got:\n",     indent(actual)
+      puts
+    end
+  end
+
+end