openlogic-turn 0.8.2

data/History.txt

@@ -0,0 +1,54 @@
+== 0.8.1 / 2010-09-10
+  * Fix misspelling of "raised" which prevented proper recording of errors.
+  * Fix IsoRunner so it passes error, not just error message.
+
+== 0.8.0 / 2010-06-02
+  * Mintest support
+  * Two new reporters
+
+== 0.7.1 / 2009-12-25
+  * Copied String#tab from Facets.
+  * Facets is no longer needed as direct dependency.
+
+== 0.7.0 / 2009-10-13
+  * Fix typo and potential bug.
+  * Running ruby with /usr/bin/env for portability
+  * Adding --name=PATTERN for test name filtering
+  * ANSI class is all caps
+
+== 0.6.3 / 2009-10-12
+  * Fixing require statements
+
+== 0.6.2 / 2009-10-07
+  * Detecting rails environment and adjusting output accordingly
+  * Colorizing the filename
+
+== 0.6.1 / 2009-08-26
+  * Switched ANSI color support to ANSI project.
+
+== 0.6.0 / 2009-05-30
+  * Testrunner @io renamed to @output for test/unit 2.
+
+== 0.5.1 / 2009-03-25
+  * fixed a "convert nil into String" error
+
+== 0.4.0 / 2008-09-18
+  * add solo and cross runners
+  * move Colorize into separate file
+  * use ::ANSICode instead of ::Console::ANSICode
+
+== 0.3.0 / 2007-12-11
+  * color highlighting now works (need facets-2.0 library)
+
+== 0.2.0 / 2006-11-26
+  * add the "turn" executable
+  * fixed warnings
+
+== 0.1.2 / 2006-11-13
+  * added some instructions for using the package
+
+== 0.1.1 / 2006-11-10
+  * removed explicit dependency on the 'hoe' gem
+
+== 0.1.0 / 2006-11-10
+  * initial release

data/README.txt

@@ -0,0 +1,116 @@
+= TURN - Test::Unit Reporter (New)
+    by Tim Pease
+    http://codeforpeople.rubyforge.org/turn
+
+== DESCRIPTION:
+
+TURN is a new way to view Test::Unit results. With longer running tests, it
+can be very frustrating to see a failure (....F...) and then have to wait till
+all the tests finish before you can see what the exact failure was. TURN
+displays each test on a separate line with failures being displayed
+immediately instead of at the end of the tests.
+  
+If you have the 'ansi' gem installed, then TURN output will be displayed in
+wonderful technicolor (but only if your terminal supports ANSI color codes).
+Well, the only colors are green and red, but that is still color.
+
+== FEATURES:
+
+General usage provides better test output. Here is some sample output:
+
+  TestMyClass
+      test_alt                                                            PASS
+      test_alt_eq                                                         PASS
+      test_bad                                                            FAIL
+          ./test/test_my_class.rb:64:in `test_bad'
+          <false> is not true.
+      test_foo                                                            PASS
+      test_foo_eq                                                         PASS
+  TestYourClass
+      test_method_a                                                       PASS
+      test_method_b                                                       PASS
+      test_method_c                                                       PASS
+  ============================================================================
+    pass: 7,  fail: 1,  error: 0
+    total: 15 tests with 42 assertions in 0.018 seconds
+  ============================================================================
+
+Turn also provides solo and cross test modes when run from the *turn* commandline
+application.
+
+== SYNOPSIS:
+
+Turn can be using from the command-line or via require. The command-line tool
+offers additional options for how one runs tests.
+
+=== Command Line
+
+You can use the *turn* executable in place of the *ruby* interpreter.
+
+  turn -Ilib test/test_all.rb
+
+This will invoke the ruby interpreter and automatically require the turn
+formatting library. All command line arguments are passed "as is" to the
+ruby interpreter.
+
+To use the solo runner.
+
+  turn --solo -Ilib test/
+
+This will run all tests in the test/ directory in a separate process.
+Likewise for the cross runner.
+
+  turn --cross -Ilib test/
+
+This will run every pairing of tests in a separate process.
+
+=== Require
+
+Simply require the TURN package from within your test suite.
+
+  require 'turn'
+
+This will configure Test::Unit to use TURN formatting for displaying test
+restuls. A better line to use, though, is the following:
+
+  begin; require 'turn'; rescue LoadError; end
+
+When you distribute your code, the test suite can be run without requiring
+the end user to install the TURN package.
+
+For a Rails application, put the require line into the 'test/test_helper.rb'
+scipt. Now your Rails tests will use TURN formatting.
+
+== REQUIREMENTS:
+
+* ansi 1.1+ (for colorized output and progressbar output mode)
+
+== INSTALL:
+
+* sudo gem install turn
+
+== LICENSE:
+
+MIT License
+
+Copyright (c) 2006-2008
+
+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,40 @@
+begin
+  require 'bones'
+rescue LoadError
+  abort '### please install the "bones" gem ###'
+end
+
+task :default => 'test'
+
+Bones {
+  name         'openlogic-turn'
+  summary      'Test::Unit Reporter (New) -- new output format for Test::Unit'
+  authors      'Tim Pease'
+  email        'tim.pease@gmail.com'
+  url          'http://gemcutter.org/gems/turn'
+  version      File.read('Version.txt').strip
+  ignore_file  '.gitignore'
+  rubyforge.name 'codeforpeople'
+
+  exclude      << '^work'
+  rdoc.exclude << '^lib'
+
+  use_gmail
+
+  depend_on 'ansi'
+  depend_on 'bones-git', :development => true
+}
+
+# Might be useful one day, so we'll leave it here.
+#
+# Rake::TaskManager.class_eval do
+#   def remove_task(task_name)
+#     @tasks.delete(task_name.to_s)
+#   end
+# end
+#
+# def remove_task(task_name)
+#   Rake.application.remove_task(task_name)
+# end
+
+# EOF

data/Release.txt

@@ -0,0 +1,33 @@
+= Turn 0.8.0
+
+Version 0.8.0 is a fairly significant release for Turn. This release
+adds support for Ruby 1.9's Minitest framework. You can even use
+minitest with Ruby 1.8 by supplying the --minitest option on the turn
+command line.
+
+In addition, two new reporters have been a added, a new "pretty" reporter
+which provides a more a modern "OSX" look (thanks Paydro) and a Cue
+reporter which seeks user input with each failure or error (thanks
+Shindo).
+
+With this release we are encouraging users to move away from using
+autorun modes. Autorunning is when your test script includes code
+that "automagically" sets up a test runner, e.g. require 'test/unit'
+and MiniTest::Unit.autorun, and by simply running the scripts
+through the ruby interpretor the tests get run. There are a number
+of problems with this approach. To begin with, running tests this way
+limits Turn of a single mode of operation (that's no fun!) More
+importantly it prevents interoperability between the old TestUnit
+and the new MiniTest systems. By leaving these out and using a 
+commandline runner you can use the same tests for each version of
+Ruby. This may require some adjutments to build tools, but hell,
+why not use Turn there too. The Turn::Controller class makes it
+damn easy.
+
+One last note. Turn is no longer compatible with TestUnit 2.0+.
+TestUnit and MiniTest are deverging and after some consideration
+it was decided that Turn's goal is to support Ruby's native test
+framework, whatever it may be.
+
+Enjoy!
+

data/Version.txt

@@ -0,0 +1 @@
+0.8.2

data/bin/turn

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'turn/command'
+Turn::Command.main(*ARGV)
+

data/demo/test_autorun_minitest.rb

@@ -0,0 +1,26 @@
+require 'minitest/unit'
+require 'turn'
+
+class SampleCase1 < MiniTest::Unit::TestCase
+  def test_sample_pass1
+    assert_equal(1,1)
+  end
+  def test_sample_pass2
+    assert_equal(2,2)
+  end
+
+  def test_sample_fail1
+    assert_equal(1,2)
+  end
+  def test_sample_fail2
+    assert_include(1,[])
+  end
+
+  def test_sample_error1
+    raise StandardError, "Raised exception!"
+  end
+  def test_sample_error2
+    raise StandardError, "Raised another exception!"
+  end
+end
+

data/demo/test_autorun_testunit.rb

@@ -0,0 +1,26 @@
+require 'test/unit'
+require 'turn'
+
+class SampleCase1 < Test::Unit::TestCase
+  def test_sample_pass1
+    assert_equal(1,1)
+  end
+  def test_sample_pass2
+    assert_equal(2,2)
+  end
+
+  def test_sample_fail1
+    assert_equal(1,2)
+  end
+  def test_sample_fail2
+    assert_include(1,[])
+  end
+
+  def test_sample_error1
+    raise StandardError, "Raised exception!"
+  end
+  def test_sample_error2
+    raise StandardError, "Raised another exception!"
+  end
+end
+

data/demo/test_sample.rb

@@ -0,0 +1,35 @@
+class SampleCase1 < Test::Unit::TestCase
+  def test_sample_pass1
+    assert_equal(1,1)
+  end
+  def test_sample_pass2
+    assert_equal(2,2)
+  end
+
+  def test_sample_fail1
+    assert_equal(1,2)
+  end
+  def test_sample_fail2
+    assert_include(1,[])
+  end
+
+  def test_sample_error1
+    raise StandardError, "Raised exception!"
+  end
+  def test_sample_error2
+    raise StandardError, "Raised another exception!"
+  end
+end
+
+
+class SampleCase2 < Test::Unit::TestCase
+  def test_sample_pass1
+    assert_equal(1,1)
+  end
+  def test_sample_pass2
+    assert_equal(1,1)
+  end
+end
+
+class EmptyCase < Test::Unit::TestCase
+end

data/demo/test_sample2.rb

@@ -0,0 +1,33 @@
+class Sample2Case1 < Test::Unit::TestCase
+  def test_sample_pass1
+    assert_equal(1,1)
+  end
+  def test_sample_pass2
+    assert_equal(2,2)
+  end
+
+  def test_sample_fail1
+    assert_equal(1,2)
+  end
+  def test_sample_fail2
+    assert_include(1,[])
+  end
+
+  def test_sample_error1
+    raise StandardError, "Raised exception!"
+  end
+  def test_sample_error2
+    raise StandardError, "Raised another exception!"
+  end
+end
+
+
+class Sample2Case2 < Test::Unit::TestCase
+  def test_sample_pass1
+    assert_equal(1,1)
+  end
+  def test_sample_pass2
+    assert_equal(1,1)
+  end
+end
+

data/lib/turn.rb

@@ -0,0 +1,19 @@
+module Turn
+  # Returns +true+ if the ruby version supports minitest.
+  # Otherwise, +false+ is returned.
+  def self.minitest?
+    RUBY_VERSION >= '1.9'
+  end
+end
+
+unless defined?(Turn::Command)
+  if Turn.minitest?
+    require 'turn/autorun/minitest'
+    MiniTest::Unit.autorun
+  else
+    require 'turn/autorun/testunit'
+  end
+  #autoload :Test,     'turn/autorun/testunit'
+  #autoload :MiniTest, 'turn/autorun/minitest'
+end
+

data/lib/turn/autorun/minitest.rb

@@ -0,0 +1,155 @@
+require 'minitest/unit'
+require 'minitest/spec'
+#require 'rubygems'
+require 'ansi'
+
+class MiniTest::Unit
+  include ANSI::Code
+
+  PADDING_SIZE = 4
+
+  def run(args = [])
+    @verbose = true
+
+    filter = if args.first =~ /^(-n|--name)$/ then
+               args.shift
+               arg = args.shift
+               arg =~ /\/(.*)\// ? Regexp.new($1) : arg
+             else
+               /./ # anything - ^test_ already filtered by #tests
+             end
+
+    @@out.puts "Loaded suite #{$0.sub(/\.rb$/, '')}\nStarted"
+
+    start = Time.now
+    run_test_suites filter
+
+    @@out.puts
+    @@out.puts "Finished in #{'%.6f' % (Time.now - start)} seconds."
+
+    @@out.puts
+
+    @@out.print "%d tests, " % test_count
+    @@out.print "%d assertions, " % assertion_count
+    @@out.print red { "%d failures, " % failures }
+    @@out.print yellow { "%d errors, " % errors }
+    @@out.puts cyan { "%d skips" % skips}
+
+    return failures + errors if @test_count > 0 # or return nil...
+  end
+
+  # Overwrite #run_test_suites so that it prints out reports
+  # as errors are generated.
+  def run_test_suites(filter = /./)
+    @test_count, @assertion_count = 0, 0
+    old_sync, @@out.sync = @@out.sync, true if @@out.respond_to? :sync=
+    TestCase.test_suites.each do |suite|
+      test_cases = suite.test_methods.grep(filter)
+      if test_cases.size > 0
+        @@out.print "\n#{suite}:\n"
+      end
+
+      test_cases.each do |test|
+        inst = suite.new test
+        inst._assertions = 0
+
+        t = Time.now
+
+        @broken = nil
+
+        @@out.print(case inst.run(self)
+                    when :pass
+                      @broken = false
+                      green { pad_with_size "PASS" }
+                    when :error
+                      @broken = true
+                      yellow { pad_with_size "ERROR" }
+                    when :fail
+                      @broken = true
+                      red { pad_with_size "FAIL" }
+                    when :skip
+                      @broken = false
+                      cyan { pad_with_size "SKIP" }
+                    end)
+
+
+        @@out.print " #{test}"
+        @@out.print " (%.2fs) " % (Time.now - t)
+
+        if @broken
+          @@out.puts
+
+          report = @report.last
+          @@out.puts pad(report[:message], 10)
+          trace = MiniTest::filter_backtrace(report[:exception].backtrace).first
+          @@out.print pad(trace, 10)
+
+          @@out.puts
+        end
+
+        @@out.puts
+        @test_count += 1
+        @assertion_count += inst._assertions
+      end
+    end
+    @@out.sync = old_sync if @@out.respond_to? :sync=
+    [@test_count, @assertion_count]
+  end
+
+  def pad(str, size=PADDING_SIZE)
+    " " * size + str
+  end
+
+  def pad_with_size(str)
+    pad("%5s" % str)
+  end
+
+  # Overwrite #puke method so that is stores a hash
+  # with :message and :exception keys.
+  def puke(klass, meth, e)
+    result = nil
+    msg = case e
+        when MiniTest::Skip
+          @skips += 1
+          result = :skip
+          e.message
+        when MiniTest::Assertion
+          @failures += 1
+          result = :fail
+          e.message
+        else
+          @errors += 1
+          result = :error
+          "#{e.class}: #{e.message}\n"
+        end
+
+    @report << {:message => msg, :exception => e}
+    result
+  end
+
+
+  class TestCase
+    # Overwrite #run method so that is uses symbols
+    # as return values rather than characters.
+    def run(runner)
+      result = :pass
+      begin
+        @passed = nil
+        self.setup
+        self.__send__ self.__name__
+        @passed = true
+      rescue Exception => e
+        @passed = false
+        result = runner.puke(self.class, self.__name__, e)
+      ensure
+        begin
+          self.teardown
+        rescue Exception => e
+          result = runner.puke(self.class, self.__name__, e)
+        end
+      end
+      result
+    end
+  end
+end
+