cutest 0.1.5 → 1.0.0.beta

data/README.markdown

@@ -8,10 +8,10 @@ Description
 
 Run tests in separate processes to avoid shared state.
 
-Each test file is run in a forked process and, if the second parameter to
-`Cutest.run` is true, it is also loaded inside an anonymous module. Once a
-failure is found in a file, the rest of the file is skipped and the error is
-reported. This way, running your test suite feels faster.
+Each test file is run in a forked process and. Once a failure is found in a
+file, you get a debugger and the ability to fix the error in place. If you
+choose to quit the debugger, the rest of the file is skipped. This way, doing
+TDD is easier and running your test suite feels faster.
 
 You can use the `scope` command around tests: it guarantees that no instance
 variables are shared between tests.
@@ -50,11 +50,15 @@ In your Rakefile:
     require "cutest"
 
     task :test do
-      Cutest.run(Dir["test/*"])
+      Cutest.run(Dir["test/*.rb"])
     end
 
     task :default => :test
 
+Or from the command line:
+
+    $ cutest test/*.rb
+
 In your tests:
 
     setup do
@@ -73,22 +77,6 @@ In your tests:
       assert 23 == params[:a]
     end
 
-
-To run the tests:
-
-    $ rake
-
-If you get an error, the report will look like this:
-
-    >> should preserve the original values from the setup
-    => assert 24 == params[:a]
-       test/a_test.rb +14
-
-
-Instead of a description of the error, you get to see the assertion
-that failed along with the file and line number. Adding a debugger and
-fixing the bug is left as an exercise for the reader.
-
 An example working with a prepare block:
 
     prepare do
@@ -122,9 +110,29 @@ And working with scopes:
 The tests in these two examples will pass.
 
 Unlike other testing frameworks, Cutest does not compile all the tests before
-running them. Another shift in design is that one dot is shown after a file is
-examined, and not the usual one-dot-per-assertion. And finally, the execution
-of a file stops one the first failure is found.
+running them.
+
+Handling errors
+---------------
+
+If you get an error when running the tests, you will see a debugger prompt:
+
+    Exception: Cutest::AssertionFailed
+    Type continue to retry or edit to modify the source
+    .Breakpoint 1 at test/setup.rb:14
+    [12, 16] in test/setup.rb
+       12
+       13  test "should preserve the original values from the setup" do |params|
+    => 14    assert 24 == params[:a]
+       15  end
+       16
+    test/setup.rb:14
+    assert 24 == params[:a]
+    (rdb:1)
+
+Instead of a getting a report of the error, you get to interact with it live
+and even fix it: if you type `edit`, the file is opened in your editor. Once
+you fix the code and save it, the debugger will reload it and retry.
 
 Installation
 ------------

data/bin/cutest

@@ -3,7 +3,56 @@
 require File.expand_path("../lib/cutest", File.dirname(__FILE__))
 
 if ARGV.empty?
-  puts "usage: cutest file ..."
-else
-  Cutest.run(Dir[*ARGV])
+  puts "usage: cutest [-r lib] [-v] file ..."
+  exit
 end
+
+class Cutest
+
+  # Clap: Command line argument parsing.
+  # http://github.com/soveran/clap
+  # http://rubygems.org/gems/clap
+  class Clap
+    VERSION = "0.0.1"
+
+    attr :argv
+    attr :opts
+
+    def self.run(args, opts)
+      new(args, opts).run
+    end
+
+    def initialize(argv, opts)
+      @argv = argv.reverse.dup
+      @opts = opts
+    end
+
+    def run
+      args = []
+
+      while argv.any?
+        item = argv.pop
+
+        if opts[item]
+
+          # Call the lambda with N items from argv,
+          # where N is the lambda's arity.
+          opts[item].call(*argv.pop(opts[item].arity))
+        else
+
+          # Collect the items that don't correspond to
+          # flags.
+          args << item
+        end
+      end
+
+      args
+    end
+  end
+end
+
+files = Cutest::Clap.run ARGV,
+  "-r" => lambda { |file| require file },
+  "-v" => lambda { puts Cutest::VERSION }
+
+Cutest.run(Dir[*files]) if files.any?

data/cutest.gemspec

@@ -1,12 +1,11 @@
 Gem::Specification.new do |s|
   s.name              = "cutest"
-  s.version           = "0.1.5"
+  s.version           = "1.0.0.beta"
   s.summary           = "Forking tests."
   s.description       = "Run tests in separate processes to avoid shared state."
   s.authors           = ["Damian Janowski", "Michel Martens"]
   s.email             = ["djanowski@dimaion.com", "michel@soveran.com"]
   s.homepage          = "http://github.com/djanowski/cutest"
   s.files = ["LICENSE", "README.markdown", "Rakefile", "lib/cutest.rb", "cutest.gemspec", "test/assert.rb", "test/assert_raise.rb", "test/prepare.rb", "test/run.rb", "test/scopes.rb", "test/setup.rb"]
-  s.add_dependency "batch", "~> 0.0.3"
   s.executables.push "cutest"
 end

data/lib/cutest.rb

@@ -1,48 +1,75 @@
-require "batch"
+begin
+  require "ruby-debug"
+rescue LoadError
+  puts "Cutest needs ruby-debug, but it couldn't be required."
+  puts "Please install ruby-debug or ruby-debug19 and try again."
+  exit
+end
 
-class Cutest < Batch
-  VERSION = "0.1.5"
+Debugger.settings[:autoeval] = 1
+Debugger.settings[:autolist] = 1
+Debugger.settings[:listsize] = 5
+Debugger.settings[:reload_source_on_change] = 1
 
-  def report_error(_, error)
-    $stderr.puts "#{error}\n"
-  end
+class Cutest
+  VERSION = "1.0.0.beta"
+
+  def self.run(files)
+    trap("INT")  { exit }
+    trap("TERM") { exit }
+
+    files.each do |file|
+      Debugger.start do
+
+        loop do
+          stdin, stdout = IO.pipe
+
+          fork do
+            stdin.close
 
-  def self.run(files, anonymous = false)
-    each(files) do |file|
-      read, write = IO.pipe
+            begin
+              load(file)
 
-      fork do
-        read.close
+            rescue LoadError, SyntaxError
+              puts ["\n", error([file, $!.message])]
+              exit
 
-        begin
-          load(file, anonymous)
+            rescue Exception
+              fn, ln = $!.backtrace.first.split(":")
+              stdout.write("#{fn}\n#{ln}\n#{error($!)}\n#{hint}")
+            end
+          end
 
-        rescue Cutest::AssertionFailed => e
-          write.puts e.message
+          stdout.close
 
-        rescue Exception => e
-          error = [e.message]
-          error += e.backtrace.take_while { |line| !line.index(__FILE__) }
+          Process.wait
 
-          write.puts ">> #{cutest[:test]}"
-          write.puts error.join("\n")
+          output = stdin.read
+
+          unless output.empty?
+            fn, ln, error, hint = output.split("\n")
+            Debugger.add_breakpoint(fn, ln.to_i)
+            puts ["\n", error, hint]
+          else
+            break
+          end
         end
       end
+    end
 
-      write.close
+    puts
+  end
 
-      Process.wait
+  def self.error(e)
+    "\033[01;36mException: \033[01;33m#{e}\033[00m"
+  end
 
-      output = read.read
-      raise Cutest::AssertionFailed.new(output) unless output.empty?
-      read.close
-    end
+  def self.hint
+    "\033[01;36mType \033[0;33mcontinue\033[0;36m to retry " +
+    "or \033[0;33medit\033[0;36m to modify the source\033[00m"
   end
 
   class AssertionFailed < StandardError
-    def backtrace
-      []
-    end
   end
 
   class Scope
@@ -121,6 +148,7 @@ private
   # Assert that value is not nil or false.
   def assert(value)
     flunk unless value
+    print "."
   end
 
   # Assert that the block doesn't raise the expected exception.
@@ -130,16 +158,16 @@ private
     rescue => exception
     ensure
       flunk unless exception.kind_of?(expected)
+      print "."
     end
   end
 
   # Stop the tests and raise an error where the message is the last line
   # executed before flunking.
   def flunk
-    file, line = caller[1].split(":")
-    code = File.readlines(file)[line.to_i - 1]
-    msg = ">> #{cutest[:test]}\n=> #{code.strip}\n   #{file} +#{line}"
+    exception = Cutest::AssertionFailed.new
+    exception.set_backtrace([caller[1]])
 
-    raise Cutest::AssertionFailed.new(msg)
+    raise exception
   end
 end

data/test/assert_raise.rb

@@ -4,7 +4,6 @@ test "catches the right exception" do
   end
 end
 
-
 test "raises if the expectation is not met" do
   assert_raise(Cutest::AssertionFailed) do
     assert_raise(RuntimeError) do

data/test/run.rb

@@ -11,7 +11,7 @@ ensure
 end
 
 test "output of successful run" do
-  expected = "  0% .\n100% \n"
+  expected = "\n"
 
   stdout, stderr = capture do
     Cutest.run(Dir["test/fixtures/success.rb"])
@@ -19,35 +19,3 @@ test "output of successful run" do
 
   assert stdout == expected
 end
-
-test "output of failed run" do
-  stdout, stderr = capture do
-    Cutest.run(Dir["test/fixtures/failure.rb"])
-  end
-
-  assert stdout == "  0% E\n100% \n"
-  assert stderr["\nSome errors occured:\n\n>> failed assertion\n=> assert false\n"]
-  assert stderr["test/fixtures/failure.rb +2\n\n"]
-end
-
-test "output of failed run on a custom assertion" do
-
-  stdout, stderr = capture do
-    Cutest.run(Dir["test/fixtures/fail_custom_assertion.rb"])
-  end
-
-  assert stdout == "  0% E\n100% \n"
-  assert stderr["\nSome errors occured:\n\n>> failed custom assertion\n=> assert_empty \"foo\"\n"]
-  assert stderr["test/fixtures/fail_custom_assertion.rb +6\n\n"]
-end
-
-test "output of failed run on an exception" do
-  stdout, stderr = capture do
-    Cutest.run(Dir["test/fixtures/exception.rb"])
-  end
-
-  assert stdout == "  0% E\n100% \n"
-  assert stderr["\nSome errors occured:\n\n>> some unhandled exception\nOops\n"]
-  assert stderr["test/fixtures/exception.rb:2:in `foo'\n"]
-  assert stderr["test/fixtures/exception.rb:6"]
-end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cutest
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  prerelease: true
   segments: 
-  - 0
   - 1
-  - 5
-  version: 0.1.5
+  - 0
+  - 0
+  - beta
+  version: 1.0.0.beta
 platform: ruby
 authors: 
 - Damian Janowski
@@ -15,24 +16,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-24 00:00:00 -03:00
+date: 2010-10-10 00:00:00 -03:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: batch
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 0
-        - 3
-        version: 0.0.3
-  type: :runtime
-  version_requirements: *id001
+dependencies: []
+
 description: Run tests in separate processes to avoid shared state.
 email: 
 - djanowski@dimaion.com
@@ -76,11 +63,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: