doctest 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-04-12
+
+* 1 major enhancement:
+  * Initial release

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,26 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/doctest
+config/hoe.rb
+config/requirements.rb
+lib/doctest.rb
+lib/doctest/version.rb
+log/debug.log
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_doctest.rb
+test/test_helper.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/README.txt

@@ -0,0 +1,48 @@
+= doctest
+
+* FIX (url)
+
+== DESCRIPTION:
+
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== 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/doctest

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+#
+#  Created on 2008-4-12.
+#  Copyright (c) 2008. All rights reserved.
+
+begin
+  require 'rubygems'
+rescue LoadError
+  # no rubygems to load, so we fail silently
+end
+
+require 'doctest'
+DocTest.run

data/config/hoe.rb

@@ -0,0 +1,70 @@
+require 'doctest/version'
+
+AUTHOR = 'FIXME full name'  # can also be an array of Authors
+EMAIL = "FIXME email"
+DESCRIPTION = "description of gem"
+GEM_NAME = 'doctest' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'doctest' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@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 = Doctest::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'doctest 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.developer(AUTHOR, 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 = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #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'

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/doctest.rb

@@ -0,0 +1,204 @@
+=begin
+A testing module allowing for people to add IRB code snippets to their code descriptions, which IRB code snippets 'second' as tests for the code itself.
+Ex:
+=begin
+# doctest This function adds 2 to its parameters
+>> setup(1)
+#=end
+def setup a
+ a + 2
+end
+=> 3
+=end
+
+# todo:
+# the 'inline for rubydoc' option
+# low priority:
+# make it even more robust to errors--if it errs, look for internal hashes, convert
+# Fix so raising errors validates -- currently ignores
+# multi line strings
+# option to run each in its own directory
+# tell them how to change dirs on their own [add an end guy?]
+# #doctest_end
+# WAY more line logic
+# some way of reusing tests, like classes [?] or functions :) -- this doctest gets this replaced with this :P
+# normal code inline [maybe that can raise if it errs, maybe more]
+# check python's --what they got?
+# use rspec, how can it improve?
+# todo better params
+
+if ARGV[0] == '--help'
+  print "
+  use: doctest file_name.rb (or directory_name): default '.'
+  -- note it recurses and scans all .rb in that directory and its subdirectories
+  ex: doctest .
+  doctest file.rb
+  doctest dir #also scans its subdirs
+"
+  exit
+end
+
+BINDING = binding()
+
+class DocTest
+  CODE_REGEX = Regexp.new(/^(>>|irb.*?>) (.*)/)
+  RESULT_REGEX = Regexp.new(/^=> (.*)/)
+  EXCEPTION_REGEX = Regexp.new(/^([A-Z][A-Za-z0-9]*):/)
+
+  def get_ruby_files(dir_name)
+    ruby_file_names = []
+  
+    Dir.foreach(dir_name) do |file_name|
+      unless file_name == '.' || file_name == '..'
+        full_name = File.join(dir_name, file_name)
+        if /.*\.rb$/ =~ full_name
+          ruby_file_names << full_name
+        elsif File.directory? full_name
+          sub_files = get_ruby_files(full_name)
+          ruby_file_names.concat(sub_files) unless sub_files.empty?
+        end
+      end
+    end
+  
+    ruby_file_names
+  end
+=begin
+#doctest normalize substring
+>> a = DocTest.new
+=> #<DocTest:0x37012c>
+>> a.normalize_result('0xtion:0x1876bc0 @@p')
+=> "0xtion:0xXXXXXXXX @@p"
+=end
+  def normalize_result(input)
+    input.gsub(/:0x([a-f0-9]){5,8}/, ':0xXXXXXXXX')  # makes them all 8 digits long
+  end
+
+  def failure_report(statement, expected_result, result)
+    report = "\n FAILED" #add line number logic here
+    report << " Code: " << statement << "\n"
+    report << " Expected: " << expected_result << "\n"
+    report << " But got: " << result
+  end
+
+=begin
+#doctest should match with hashes
+>> {1=>1, 2=>2, 3=> 3, 4=>4,5=>5}
+=> {5=>5, 1=>1, 2=>2, 3=>3, 4=>4}
+now test with different ordered hashes
+>> {1=>1, 2=>2, 3=> 3, 4=>4,5=>5}
+=> {4=>4, 1=>1, 2=>2, 3=>3, 5=>5}
+>> {1=>":0x123456", 2=>2, 3=> 3, 4=>4,5=>5}
+=> {4=>4, 1=>":0x123456", 2=>2, 3=>3, 5=>5}
+=end
+   def dbg
+     require 'rubygems'; require 'ruby-debug'; debugger
+  end
+
+  def run_doc_tests(doc_test)
+    statement, report = '', ''
+    wrong, passed = 0, 0
+    doc_test.split("\n").each do |line|
+      case line
+        when CODE_REGEX
+          statement << CODE_REGEX.match(line)[2]
+        when RESULT_REGEX, EXCEPTION_REGEX
+          if line =~ RESULT_REGEX
+		expected_result_string = normalize_result(RESULT_REGEX.match(line)[1])
+	  else
+		raise unless line =~ EXCEPTION_REGEX
+		expected_result_string = $1
+	  end
+	
+          begin
+		result_we_got = eval(statement, BINDING)
+	  rescue Exception => e
+		result_we_got = e.class
+          end
+       
+          they_match = false 
+          if result_we_got.class.ancestors.include? Hash
+            # change them to 'kind of real' hashes, so that we cancompare them and have comparison work--hashes sometimes display in different orders when printed
+            expected_result = eval(expected_result_string, BINDING)
+	    if eval(normalize_result(result_we_got.inspect), BINDING) == expected_result # todo some tests for this with whack-o stuff thrown in  :)
+		# the Hashes matched, string-wise
+		they_match = true
+	    end
+          end
+
+	  they_match = true if expected_result_string =~ /#doctest_fail_ok/
+          result_string = normalize_result(result_we_got.inspect)
+	  they_match = true if result_string == expected_result_string
+          unless they_match
+            report << failure_report(statement, expected_result_string, result_string)
+            wrong += 1
+          else
+            passed += 1
+          end
+          statement = '' # reset it for the next round
+      end
+    end
+    return passed, wrong, report
+  end
+
+  def process_ruby_file(file_name)
+    tests, succeeded, failed = 0, 0, 0
+    file_report = ''
+    code = File.read file_name
+
+    startup_code_for_this_file = code.scan(/begin\s#setup_doctest once_per_file(.*?)=end/m)
+  
+    if startup_code_for_this_file.length > 0
+      raise 'can only do one_time_file_setup declaration once' if startup_code_for_this_file.length > 1 or startup_code_for_this_file[0].length > 1
+      startup_code_for_this_file = startup_code_for_this_file[0][0]
+      begin
+      	eval startup_code_for_this_file, BINDING
+      rescue Exception => e
+	print "Uh oh unable to execute startup code for #{file_name}...continuing #{e}\n"
+      end
+    end
+  
+    # todo would be nice to have multiple tests in the same comment block
+    # so a scan + sub scan for doctests
+    code.scan(/=begin\s#doctest([^\n]*)\n(.*?)=end/m) do |doc_test| # could do--replace default named ones with their line number :)
+      require file_name # might as well have its functions available to itself :P
+      # todo could tear out anything loaded after each file, I suppose, as active support does
+      file_report << "\n Testing '#{doc_test[0]}'..."
+      passed, wrong, report = run_doc_tests(doc_test[1])
+      file_report += (wrong == 0 ? "OK" : report)
+      tests += 1
+      succeeded += passed
+      failed += wrong
+    end
+    file_report = "Processing '#{file_name}' from current directory " + file_report unless file_report.empty?
+    return tests, succeeded, failed, file_report
+  end
+  def DocTest.run
+   # parse command line--currently just 'filename' or 'directory name'
+   runner = DocTest.new
+   if File.directory? ARGV[0] || ''
+     ruby_file_names = runner.get_ruby_files(ARGV[0])
+   elsif File.exist? ARGV[0] || ''
+     ruby_file_names = [ARGV[0]]
+   else
+     ruby_file_names = runner.get_ruby_files('.')
+   end
+ 
+   total_report = "Looking for doctests in a total of #{ruby_file_names.length} possible files\n"
+   total_files, total_tests, total_succeeded, total_failed = 0, 0, 0, 0
+   ruby_file_names.each do |ruby_file_name|
+     tests, succeeded, failed, report = runner.process_ruby_file(ruby_file_name)
+     total_files += 1 if tests > 0
+     total_tests += tests
+     total_succeeded += succeeded
+     total_failed += failed
+     total_report << report << "\n" unless report.empty?
+   end
+   total_report << "Total files: #{total_files}, total tests: #{total_tests}, assertions succeeded: #{total_succeeded}, assertions failed: #{total_failed}"
+   puts total_report
+  end
+
+end
+
+if $0 == __FILE__
+ DocTest.run
+end

data/lib/doctest/version.rb

@@ -0,0 +1,9 @@
+module Doctest #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+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/doctest.rb'}"
+puts "Loading doctest 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)