rdoctest 0.0.1 → 0.0.2

data/README.rdoc

@@ -25,7 +25,7 @@ Use the CLI:
   .
   Finished in ... seconds.
 
-  1 tests, 7 assertions, 0 failures, 0 errors, 0 skips
+  1 tests, 6 assertions, 0 failures, 0 errors, 0 skips
 
 
 == Examples
@@ -64,7 +64,7 @@ Rdoctest expects well-formatted RDoc. This means:
     #   >> 1 + 1
     #   => 2
     #
-    # More complex:
+    # More complex, testing output:
     #
     #   >> def hello_world
     #   >>   puts "Hello, world!"
@@ -88,6 +88,7 @@ Rdoctest's CLI works a lot like Ruby's.
   Usage: rdoctest [options] [file ...]
       -Idirectory
       -rlibrary
+      -f                               Don't automatically require files
       ...
 
 If you're testing a complex project, make sure you prepare necessary libraries
@@ -96,6 +97,12 @@ and load paths:
   % rdoctest -Ilib -rmylibrary lib/**/*.rb
 
 
+If your application handles the loading of files, suppress Rdoctest's autoload
+mechanism:
+
+  $ rdoctest -f -r./config/environment app/**/*.rb
+
+
 === Rake
 
 Rdoctest comes with a Rake task that you can load in your Rakefile.
@@ -104,12 +111,12 @@ Rdoctest comes with a Rake task that you can load in your Rakefile.
   Rdoctest::Task.new
 
 
-And run in your project:
+Running it is simple.
 
   % rake doctest
 
 
-It comes with a similar configuration to Rake's TestTask.
+It implements a configuration similar to Rake's TestTask.
 
   Rdoctest::Task.new :test do |t|
     t.libs      << 'lib'          # The 'lib' directory is loaded by default,
@@ -117,17 +124,34 @@ It comes with a similar configuration to Rake's TestTask.
   end
 
 
+=== Rails
+
+I haven't done much testing in Rails yet, but the following should work:
+
+First, update your Gemfile to include the gem in your test group.
+
+  group :test do
+    gem 'rdoctest'
+  end
+
+
+Run <tt>bundle install</tt>, and you can immediately invoke the CLI.
+
+  % rdoctest -f -r./config/environment app/**/*.rb lib/**/*.rb
+
+
 == Roadmap
 
-* Better detection of code blocks (the 3-space indent is too restrictive).
+* Better detection of code blocks (the 2-space indent is too restrictive).
 * Test plain text files (READMEs, for example).
 * Autotest integration?
+* Better Rails support?
 * Test shell snippets (beginning with <tt>$</tt> and <tt>%</tt>)?
 
 
 == Prior Art
 
-{rubydoctest}[http://github.com/tablatom/rubydoctest].
+{rubydoctest}[http://github.com/tablatom/rubydoctest]
 
 
 == License

data/bin/rdoctest

@@ -3,14 +3,21 @@ require 'optparse'
 lib = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift lib
 
+config = { :load_path => [] }
+
 options = OptionParser.new do |option|
   option.banner = "Usage: #{basename = File.basename $0} [options] [file ...]"
   option.on('-Idirectory') { |v|
-    $LOAD_PATH.concat v.split File::PATH_SEPARATOR
+    directories = v.split File::PATH_SEPARATOR
+    $LOAD_PATH.concat directories
+    config[:load_path].concat directories
   }
   option.on('-rlibrary') { |v|
     require v
   }
+  option.on('-f', "Don't automatically require files") { |v|
+    config[:force] = v
+  }
   option.on('--version') {
     require 'rdoctest/version'
     puts "#{basename} #{Rdoctest::Version::VERSION}"
@@ -29,3 +36,4 @@ if ARGF.argv.empty?
 end
 
 load 'rdoctest/runner.rb'
+Rdoctest::Runner.new(config).run

data/lib/rdoctest.rb

@@ -1,2 +1,4 @@
+require 'rdoctest/version'
+
 module Rdoctest # :nodoc:
 end

data/lib/rdoctest/runner.rb

@@ -1,6 +1,6 @@
 require 'stringio'
 require 'strscan'
-require 'test/unit'
+require 'rdoctest/test_case'
 
 module Rdoctest
   # The Runner takes RDoc example text and creates tests for them.
@@ -29,15 +29,17 @@ module Rdoctest
   #
   # Use ellipses for partial matches.
   #
-  #   >> a
+  #   >> ok
   #   NameError: undefined local variable or method `a'...
   class Runner
     @@ruby = /(.+?)# =>([^\n]+\n)/m
     @@irb  = /((?:^>> [^\n]+\n)+)((?:(?!^(?:>>|=>))[^\n]+\n)*)(^=> [^\n]+)?/m
 
-    attr_reader :files
+    attr_reader :files, :options
+
+    def initialize options = {}
+      @options = options
 
-    def initialize
       @files = {}
     end
 
@@ -56,15 +58,10 @@ module Rdoctest
         lineno += 1
 
         next in_comment = nil unless line.sub! /^ *# ?/, ''
-        in_comment   = lineno if line =~ /^={1,6} \S/
+        in_comment = lineno if line =~ /^={1,6} \S/
         in_comment ||= lineno
 
-        if in_test
-          in_test = false if line !~ /^(?: {2,}|$)/
-        else
-          in_test = true  if line =~ /^ {2}\S/
-        end
-
+        in_test = in_test ? line =~ (/^(?: {2,}|$)/) : line =~ /^ {2}\S/
         line = "\n" unless in_test
         ((files[filename] ||= {})[in_comment] ||= '') << line if in_comment
       end
@@ -78,25 +75,12 @@ module Rdoctest
         class_name = 'Rdoctest' if class_name.empty?
         require_filename filename
 
-        test_class = Class.new Test::Unit::TestCase do
+        test_class = Class.new Rdoctest::TestCase do
           lineno_and_lines.each_pair do |lineno, lines|
             next unless lines =~ /\S/ # /(?:^|# )=>/
             lines.gsub! /^  /, ''
 
-            define_method "assert_eval" do |expected, result, filename, lineno|
-              if expected.gsub!(/\.{3,}/, '.*')
-                assertion, expected = 'match', /#{expected}/
-              else
-                assertion = 'equal'
-              end
-
-              instance_eval <<ASSERTION, filename, lineno
-assert_#{assertion} #{expected.inspect}, #{result.inspect}
-ASSERTION
-            end
-
             define_method "test_line_#{lineno}" do
-              assertions = []
               scanner = StringScanner.new lines
 
               binding = send :binding
@@ -104,13 +88,12 @@ ASSERTION
                 code_lineno = lineno + scanner.pre_match.count("\n")
                 expected_lineno = code_lineno + scanner[1].count("\n")
 
-                result = eval scanner[1], binding #, filename, code_lineno
+                result = eval scanner[1], binding
                 assert_eval scanner[2].strip, result.inspect, filename,
                   expected_lineno
               end
-
               scanner.pos = 0
-              binding = send :binding
+
               while scanner.skip_until(@@irb)
                 code_lineno = lineno + scanner.pre_match.count("\n")
                 output_lineno = code_lineno + scanner[2].to_s.count("\n")
@@ -125,9 +108,10 @@ ASSERTION
                   $stdout, stdout = stdout, $stdout
                 end
 
-                stdout.rewind
-                output = stdout.read
-                assert_eval scanner[2], output, filename, output_lineno
+                stdout.rewind and output = stdout.read
+                unless output.empty?
+                  assert_eval scanner[2], output, filename, output_lineno
+                end
 
                 if scanner[3]
                   expected = scanner[3].sub(/^=> /, '').strip
@@ -144,9 +128,9 @@ ASSERTION
     end
 
     def require_filename filename
-      require filename.gsub(%r{^(?:lib)/|.rb$}, '') unless filename == '-'
+      return if options[:force] || filename == '-'
+      load_path = options[:load_path].join '|'
+      require filename.gsub(%r{^(?:#{load_path})/|.rb$}, '')
     end
   end
 end
-
-Rdoctest::Runner.new.run

data/lib/rdoctest/task.rb

@@ -31,7 +31,7 @@ module Rdoctest
     def define
       desc name ? "Run doctests for #{name}" : 'Run doctests'
       task name do
-        ruby "#{run_code} #{ruby_opts_string} #{file_list_string}"
+        system "#{run_code} #{ruby_opts_string} #{file_list_string}"
       end
     end
 

data/lib/rdoctest/test_case.rb

@@ -0,0 +1,19 @@
+require 'test/unit'
+
+module Rdoctest
+  class TestCase < Test::Unit::TestCase
+    private
+
+    def assert_eval expected, result, filename, lineno
+      if expected.gsub!(/\.{3,}/, '.*')
+        assertion, expected = 'match', /#{expected}/
+      else
+        assertion = 'equal'
+      end
+
+      instance_eval <<ASSERTION, filename, lineno
+assert_#{assertion} #{expected.inspect}, #{result.inspect}
+ASSERTION
+    end
+  end
+end

data/lib/rdoctest/version.rb

@@ -2,8 +2,9 @@ module Rdoctest
   module Version
     MAJOR = 0
     MINOR = 0
-    PATCH = 1
+    PATCH = 2
+    BETA  = nil
 
-    VERSION = [MAJOR, MINOR, PATCH].compact.join('.').freeze
+    VERSION = [MAJOR, MINOR, PATCH, BETA].compact.join('.').freeze
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Stephen Celis
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-05 00:00:00 -06:00
+date: 2010-12-08 00:00:00 -06:00
 default_executable: rdoctest
 dependencies: []
 
@@ -31,6 +31,7 @@ files:
 - Rakefile
 - lib/rdoctest/runner.rb
 - lib/rdoctest/task.rb
+- lib/rdoctest/test_case.rb
 - lib/rdoctest/version.rb
 - lib/rdoctest.rb
 - bin/rdoctest