cutest 1.0.0.beta → 1.0.0.beta1

data/README.markdown

@@ -6,12 +6,9 @@ Forking tests.
 Description
 -----------
 
-Run tests in separate processes to avoid shared state.
-
-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.
+Each test file is run in a forked process to avoid shared state. Once a failure
+is found, you get a report detailing what failed and how to locate the error
+and the rest of the file is skipped.
 
 You can use the `scope` command around tests: it guarantees that no instance
 variables are shared between tests.
@@ -35,12 +32,11 @@ block as a parameter to the `test` blocks.
 The `test` method executes the passed block after running `prepare` and
 `setup`. This is where assertions must be declared.
 
-Two assertions are available: `assert` and `assert_raise`. The first accepts a
-value and raises an `AssertionFailed` exception if it's false or nil, and the
-later receives an expected exception and a block: the block is executed and
-the raised exception is compared with the expected one. An `AssertionFailed`
-exception is raised if the block runs fine or if the raised exception doesn't
-match the expectation.
+Three assertions are available: `assert`, that accepts a value and raises
+if it's false or nil; `assert_equal`, that raises if its arguments are not
+equal; and `assert_raise`, that executes a passed block and compares the raised
+exception to the expected one. In all cases, if the expectation is no met, an
+`AssertionFailed` exception is raised.
 
 Usage
 -----
@@ -115,24 +111,23 @@ 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.
+If you get an error when running the tests, this is what you will see:
+
+    Exception: assert_equal 24, params[:a] # 24 != 23
+    test/setup.rb +14
+
+Command Line Interface
+----------------------
+
+The tool `cutest` accepts a list of files and sends them to `Cutest.run`. If
+you need to require a file or library before running the tests, as is the case
+with test helpers, use the `-r` flag:
+
+    $ cutest -r test/helper.rb test/*_test.rb
+
+If you want to check which version you are running, try the `-v` flag.
+
+If you want to require ruby-debug, use the `--debug` flag.
 
 Installation
 ------------

data/bin/cutest

@@ -3,7 +3,7 @@
 require File.expand_path("../lib/cutest", File.dirname(__FILE__))
 
 if ARGV.empty?
-  puts "usage: cutest [-r lib] [-v] file ..."
+  puts "usage: cutest [-r lib] [-v] [--debug] file ..."
   exit
 end
 
@@ -13,7 +13,7 @@ class Cutest
   # http://github.com/soveran/clap
   # http://rubygems.org/gems/clap
   class Clap
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
 
     attr :argv
     attr :opts
@@ -23,7 +23,7 @@ class Cutest
     end
 
     def initialize(argv, opts)
-      @argv = argv.reverse.dup
+      @argv = argv.dup
       @opts = opts
     end
 
@@ -31,13 +31,24 @@ class Cutest
       args = []
 
       while argv.any?
-        item = argv.pop
 
-        if opts[item]
+        item = argv.shift
+        flag = opts[item]
+
+        if flag
+
+          # Work around lambda semantics in 1.8.7.
+          arity = [flag.arity, 0].max
+
+          # Raise if there are not enough parameters
+          # available for the flag.
+          if argv.size < arity
+            raise ArgumentError
+          end
 
           # Call the lambda with N items from argv,
           # where N is the lambda's arity.
-          opts[item].call(*argv.pop(opts[item].arity))
+          flag.call(*argv.shift(arity))
         else
 
           # Collect the items that don't correspond to
@@ -52,7 +63,8 @@ class Cutest
 end
 
 files = Cutest::Clap.run ARGV,
-  "-r" => lambda { |file| require file },
-  "-v" => lambda { puts Cutest::VERSION }
+  "-r"      => lambda { |file| require file },
+  "-v"      => lambda { puts Cutest::VERSION },
+  "--debug" => lambda { ENV["DEBUG"] = true }
 
 Cutest.run(Dir[*files]) if files.any?

data/cutest.gemspec

@@ -1,11 +1,11 @@
 Gem::Specification.new do |s|
   s.name              = "cutest"
-  s.version           = "1.0.0.beta"
+  s.version           = "1.0.0.beta1"
   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.files = ["LICENSE", "README.markdown", "Rakefile", "lib/cutest.rb", "cutest.gemspec", "test/assert.rb", "test/assert_equal.rb", "test/assert_raise.rb", "test/prepare.rb", "test/run.rb", "test/scopes.rb", "test/setup.rb"]
   s.executables.push "cutest"
 end

data/lib/cutest.rb

@@ -1,59 +1,56 @@
-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
+  VERSION = "1.0.0.beta1"
 
-Debugger.settings[:autoeval] = 1
-Debugger.settings[:autolist] = 1
-Debugger.settings[:listsize] = 5
-Debugger.settings[:reload_source_on_change] = 1
+  if ENV["DEBUG"]
+    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
-  VERSION = "1.0.0.beta"
+    Debugger.settings[:autoeval] = 1
+    Debugger.settings[:autolist] = 1
+    Debugger.settings[:listsize] = 5
+    Debugger.settings[:reload_source_on_change] = 1
+  end
 
   def self.run(files)
-    trap("INT")  { exit }
-    trap("TERM") { exit }
-
     files.each do |file|
-      Debugger.start do
+      stdin, stdout = IO.pipe
 
-        loop do
-          stdin, stdout = IO.pipe
+      fork do
+        stdin.close
 
-          fork do
-            stdin.close
+        begin
+          load(file)
 
-            begin
-              load(file)
+        rescue LoadError, SyntaxError
+          puts ["\n", error([file, $!.message])]
+          exit
 
-            rescue LoadError, SyntaxError
-              puts ["\n", error([file, $!.message])]
-              exit
+        rescue Exception
+          fn, ln = $!.backtrace.first.split(":")
+          message = File.readlines(fn)[ln.to_i - 1]
+          stdout.write("#{fn}\n#{ln}\n#{error(message.strip)} # #{$!.message}")
+        end
 
-            rescue Exception
-              fn, ln = $!.backtrace.first.split(":")
-              stdout.write("#{fn}\n#{ln}\n#{error($!)}\n#{hint}")
-            end
-          end
+        stdout.close
+      end
 
-          stdout.close
+      stdout.close
 
-          Process.wait
+      Process.wait
 
-          output = stdin.read
+      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
+      stdin.close
+
+      unless output.empty?
+        fn, ln, error = output.split("\n")
+
+        puts "\n#{error}\n#{fn} +#{ln}"
       end
     end
 
@@ -64,11 +61,6 @@ class Cutest
     "\033[01;36mException: \033[01;33m#{e}\033[00m"
   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
   end
 
@@ -86,8 +78,8 @@ end
 module Kernel
 private
 
-  # Use Thread.current[:cutest] to store information about test preparation and
-  # setup.
+  # Use Thread.current[:cutest] to store information about test preparation
+  # and setup.
   Thread.current[:cutest] ||= { :prepare => [] }
 
   # Shortcut to access Thread.current[:cutest].
@@ -101,31 +93,31 @@ private
     Cutest::Scope.new(&block).call
   end
 
-  # Prepare the environment in order to run the tests. This method can be called
-  # many times, and each new block is appended to a list of preparation blocks.
-  # When a test is executed, all the preparation blocks are ran in the order they
-  # were declared. If called without a block, it returns the array of preparation
-  # blocks.
+  # Prepare the environment in order to run the tests. This method can be
+  # called many times, and each new block is appended to a list of
+  # preparation blocks. When a test is executed, all the preparation blocks
+  # are ran in the order they were declared. If called without a block, it
+  # returns the array of preparation blocks.
   def prepare(&block)
     cutest[:prepare] << block if block_given?
     cutest[:prepare]
   end
 
-  # Setup parameters for the tests. The block passed to setup is evaluated before
-  # running each test, and the result of the setup block is passed to the test as
-  # a parameter. If the setup and the tests are declared at the same level (in
-  # the global scope or in a sub scope), it is possible to use instance
-  # variables, but the parameter passing pattern is recommended to ensure there
-  # are no side effects.
+  # Setup parameters for the tests. The block passed to setup is evaluated
+  # before running each test, and the result of the setup block is passed to
+  # the test as a parameter. If the setup and the tests are declared at the
+  # same level (in the global scope or in a sub scope), it is possible to use
+  # instance variables, but the parameter passing pattern is recommended to
+  # ensure there are no side effects.
   #
   # If the setup blocks are declared in the global scope and the tests are
   # declared in sub scopes, the parameter passing usage is required.
   #
-  # Setup blocks can be defined many times, but each new definition overrides the
-  # previous one. It is recommended to split the tests in many different files
-  # (the report is per file, not per assertion). Usually one setup block per file
-  # is enough, but nothing forbids having different scopes with different setup
-  # blocks.
+  # Setup blocks can be defined many times, but each new definition overrides
+  # the previous one. It is recommended to split the tests in many different
+  # files (the report is per file, not per assertion). Usually one setup
+  # block per file is enough, but nothing forbids having different scopes
+  # with different setup blocks.
   def setup(&block)
     cutest[:setup] = block if block_given?
     cutest[:setup]
@@ -136,8 +128,8 @@ private
 
   # Call the prepare and setup blocks before executing the test. Even
   # though the assertions can live anywhere (it's not mandatory to put them
-  # inside test blocks), it is necessary to wrap them in test blocks in order to
-  # execute preparation and setup blocks.
+  # inside test blocks), it is necessary to wrap them in test blocks in order
+  # to execute preparation and setup blocks.
   def test(name = nil, &block)
     cutest[:test] = name
 
@@ -147,7 +139,13 @@ private
 
   # Assert that value is not nil or false.
   def assert(value)
-    flunk unless value
+    flunk("assertion failed") unless value
+    print "."
+  end
+
+  # Assert that two values are equal.
+  def assert_equal(value, other)
+    flunk("#{value} != #{other}") unless value == other
     print "."
   end
 
@@ -157,15 +155,15 @@ private
       yield
     rescue => exception
     ensure
-      flunk unless exception.kind_of?(expected)
+      flunk("got #{exception} instead") 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
-    exception = Cutest::AssertionFailed.new
+  def flunk(message = nil)
+    exception = Cutest::AssertionFailed.new(message)
     exception.set_backtrace([caller[1]])
 
     raise exception

data/test/assert_equal.rb

@@ -0,0 +1,9 @@
+test  do
+  assert_equal 1, 1
+end
+
+test "raises if the assertion fails" do
+  assert_raise(Cutest::AssertionFailed) do
+    assert_equal 1, 2
+  end
+end

data/test/setup.rb

@@ -11,7 +11,7 @@ test "if the params are modified..." do |params|
 end
 
 test "...it should preserve the original values from the setup" do |params|
-  assert 23 == params[:a]
+  assert_equal 23, params[:a]
 end
 
 setup do

metadata

@@ -6,8 +6,8 @@ version: !ruby/object:Gem::Version
   - 1
   - 0
   - 0
-  - beta
-  version: 1.0.0.beta
+  - beta1
+  version: 1.0.0.beta1
 platform: ruby
 authors: 
 - Damian Janowski
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-10 00:00:00 -03:00
+date: 2010-10-30 00:00:00 -03:00
 default_executable: 
 dependencies: []
 
@@ -37,6 +37,7 @@ files:
 - lib/cutest.rb
 - cutest.gemspec
 - test/assert.rb
+- test/assert_equal.rb
 - test/assert_raise.rb
 - test/prepare.rb
 - test/run.rb