TwP-turn 0.5.1

data/History.txt

@@ -0,0 +1,23 @@
+== 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,117 @@
+= 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 'facets' 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:
+
+If you have the 'facets' 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.
+
+=== 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:
+
+* facets 2.0+
+
+== 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,32 @@
+
+begin
+  require 'bones'
+  Bones.setup
+rescue LoadError
+  begin
+    load 'tasks/setup.rb'
+  rescue LoadError
+    raise RuntimeError, '### please install the "bones" gem ###'
+  end
+end
+
+task :default => 'test'
+
+PROJ.name = 'turn'
+PROJ.summary = 'Test::Unit Reporter (New) -- new output format for Test::Unit'
+PROJ.authors = 'Tim Pease'
+PROJ.email = 'tim.pease@gmail.com'
+PROJ.url = 'http://codeforpeople.rubyforge.org/turn'
+PROJ.version = '0.5.1'
+PROJ.ignore_file = '.gitignore'
+
+PROJ.rubyforge.name = 'codeforpeople'
+
+PROJ.rdoc.exclude << '^lib/'
+PROJ.rdoc.remote_dir = PROJ.name
+
+PROJ.ann.email[:server] = 'smtp.gmail.com'
+PROJ.ann.email[:port] = 587
+PROJ.ann.email[:from] = 'Tim Pease'
+
+# EOF

data/Release.txt

@@ -0,0 +1,29 @@
+= Turn 0.5
+
+Turn has turned 0.5 with some signifficant new features.
+
+While Turn still provides the exact same functionality for running
+tests via ruby or testrb as previous versions. The turn commandline 
+utility has been completely rewritten with expanded capabilites. 
+
+The turn command now features three run modes:
+
+* Solo runner for running each test file in a separate process.
+* Cross runner for running test file pairs in separate processes.
+* Normal runner, which of course runs all test in a single process.
+
+It also support three report modes:
+
+* Progress reporter which uses a progress bar.
+* Minimal reporter which provides traditional "dot" progress.
+* Outline reporter populaized by turn.
+
+The is also a special Marshal Mode which dumps test results as YAML.
+And the underlying API makes it easy create new reporters.
+
+To get a quick rundown on how to use the new commandline:
+
+  $ turn --help
+
+Enjoy!
+

data/VERSION

@@ -0,0 +1 @@
+turn 0.5.1 stable (2009-03-25)

data/bin/turn

@@ -0,0 +1,4 @@
+#!/usr/bin/ruby
+
+load 'turn/command.rb'
+

data/lib/turn.rb

@@ -0,0 +1,80 @@
+require 'test/unit/ui/console/testrunner'
+require 'turn/colorize'
+
+module ::Test::Unit
+module UI
+module Console
+  class TestRunner
+    include Turn::Colorize
+
+    alias :t_attach_to_mediator :attach_to_mediator
+    def attach_to_mediator
+      @mediator.add_listener(TestRunnerMediator::STARTED, &method(:t_started))
+      @mediator.add_listener(TestRunnerMediator::FINISHED, &method(:t_finished))
+      @mediator.add_listener(TestCase::STARTED, &method(:t_test_started))
+      @mediator.add_listener(TestCase::FINISHED, &method(:t_test_finished))
+      @mediator.add_listener(TestResult::FAULT, &method(:t_fault))
+      @io.sync = true
+      @t_cur_file, @t_fault = nil
+    end
+
+    def t_started( result )
+      @t_result = result
+    end
+
+    def t_finished( elapsed_time )
+      failure = @t_result.failure_count
+      error   = @t_result.error_count
+      total   = @t_result.run_count
+      pass = total - failure - error
+
+      bar = '=' * 78
+      if COLORIZE
+        bar = if pass == total then ::ANSICode.green bar
+              else ::ANSICode.red bar end
+      end
+
+      @io.puts bar
+      @io.puts "  pass: %d,  fail: %d,  error: %d" % [pass, failure, error]
+      @io.puts "  total: %d tests with %d assertions in #{elapsed_time} seconds" % [total, @t_result.assertion_count]
+      @io.puts bar
+    end
+
+    def t_test_started( name )
+      method, file = name.scan(%r/^([^\(]+)\(([^\)]+)\)/o).flatten!
+      if @t_cur_file != file
+        @t_cur_file = file
+        @io.puts file
+      end
+      @io.print "    %-69s" % method
+    end
+
+    def t_test_finished( name )
+      @io.puts " #{PASS}" unless @t_fault
+      @t_fault = false
+    end
+
+    def t_fault( fault )
+      @t_fault = true
+      msg = "\t"
+
+      case fault
+      when ::Test::Unit::Error
+        @io.puts ERROR
+        msg << fault.to_s.split("\n")[2..-1].join("\n\t")
+      when ::Test::Unit::Failure
+        @io.puts " #{FAIL}"
+        msg << fault.location[0].to_s << "\n\t"
+        msg << fault.message.gsub("\n","\n\t")
+      end
+
+      msg = ::ANSICode.magenta msg if COLORIZE
+      @io.puts msg
+    end
+
+  end
+end
+end
+end
+
+# EOF

data/lib/turn/colorize.rb

@@ -0,0 +1,29 @@
+begin
+  require 'facets/ansicode'
+rescue LoadError
+  begin
+    require 'rubygems'
+    require 'facets/ansicode'
+  rescue LoadError
+  end
+end
+
+module Turn
+  
+  module Colorize
+
+    COLORIZE = defined?(::ANSICode) && ENV.has_key?('TERM')
+
+    if COLORIZE
+      PASS  = ::ANSICode.green('PASS')
+      FAIL  = ::ANSICode.red('FAIL')
+      ERROR = ::ANSICode.white(::ANSICode.on_red('ERROR'))
+    else
+      PASS  = "PASS"
+      FAIL  = "FAIL"
+      ERROR = "ERROR"
+    end
+
+  end
+
+end

data/lib/turn/command.rb

@@ -0,0 +1,159 @@
+# Turn - Pretty Unit Test Runner for Ruby
+#
+# SYNOPSIS
+#   turn [OPTIONS] [RUN MODE] [OUTPUT MODE] [test globs...]
+#
+# OPTIONS
+#   -h --help             display this help information
+#      --live             don't use loadpath
+#      --log              log results to a file
+#   -I --loadpath=PATHS   add given paths to the $LOAD_PATH
+#   -r --requires=PATHS   require given paths before running tests
+#
+# RUN MODES
+#      --normal      run all tests in a single process [default]
+#      --solo        run each test in a separate process
+#      --cross       run each pair of test files in a separate process
+#
+# OUTPUT MODES
+#   -O --outline     turn's original case/test outline mode [default]
+#   -P --progress    indicates progress with progress bar
+#   -D --dotted      test/unit's traditonal dot-progress mode
+#   -M --marshal     dump output as YAML (normal run mode only)
+
+require 'getoptlong'
+require 'turn/controller'
+
+#RUBY = File.join(Config::CONFIG['bindir'], Config::CONFIG['ruby_install_name'])
+
+original_argv = ARGV.dup
+
+opts = GetoptLong.new(
+  [ '--help', '-h',     GetoptLong::NO_ARGUMENT ],
+  [ '--live',           GetoptLong::NO_ARGUMENT ],
+  [ '--log',            GetoptLong::OPTIONAL_ARGUMENT ],
+  [ '--loadpath', '-I', GetoptLong::REQUIRED_ARGUMENT ],
+  [ '--requires', '-r', GetoptLong::REQUIRED_ARGUMENT ],
+
+  # RUN MODES
+  [ '--normal',         GetoptLong::NO_ARGUMENT ],
+  [ '--solo',           GetoptLong::NO_ARGUMENT ],
+  [ '--cross',          GetoptLong::NO_ARGUMENT ],
+  #[ '--load',           GetoptLong::NO_ARGUMENT ],
+
+  # OUTPUT MODES
+  [ '--outline',  '-O', GetoptLong::NO_ARGUMENT ],
+  [ '--progress', '-P', GetoptLong::NO_ARGUMENT ],
+  [ '--dotted',   '-D', GetoptLong::NO_ARGUMENT ],
+  [ '--marshal',  '-M', GetoptLong::NO_ARGUMENT ]
+)
+
+live     = nil
+log      = nil
+loadpath = []
+requires = []
+
+runmode = nil
+outmode = nil
+
+opts.each do |opt, arg|
+  case opt
+  when '--help'
+    help, rest = File.read(__FILE__).split(/^\s*$/)
+    puts help.gsub(/^\#[ ]{0,1}/,'')
+    exit
+
+  when '--live'
+    live = true
+  when '--log'
+    log = true
+  when '--loadpath'
+    loadpath << arg
+  when '--requires'
+    requires << arg
+
+  when '--solo'
+    runmode = :solo
+  when '--cross'
+    runmode = :cross
+  when '--marshal'
+    runmode = :marshal
+    outmode = :marshal
+  when '--progress'
+    outmode = :progress
+  when '--outline'
+    outmode = :outline
+  when '--dotted'
+    outmode = :dotted
+  end
+end
+
+loadpath = ['lib'] if loadpath.empty?
+
+tests = ARGV.empty? ? nil : ARGV.dup
+
+case outmode
+when :marshal
+  reporter = Turn::MarshalReporter.new($stdout)
+when :progress
+  reporter = Turn::ProgressReporter.new($stdout)
+when :dotted
+  reporter = Turn::DotReporter.new($stdout)
+else
+  reporter = Turn::OutlineReporter.new($stdout)
+end
+
+case runmode
+when :marshal
+  require 'turn/runners/testrunner'
+  runner   = Turn::TestRunner
+when :solo
+  require 'turn/runners/solorunner'
+  runner = Turn::SoloRunner
+when :cross
+  require 'turn/runners/crossrunner'
+  runner = Turn::CrossRunner
+else
+  require 'turn/runners/testrunner'
+  runner = Turn::TestRunner
+end
+
+controller = Turn::Controller.new do |c|
+  c.live     = live
+  c.log      = log
+  c.loadpath = loadpath
+  c.requires = requires
+  c.tests    = tests
+  c.runner   = runner
+  c.reporter = reporter
+end
+
+controller.start
+
+=begin
+else
+
+  begin
+    require 'turn/adapters/testunit' # 'turn'
+  rescue LoadError
+    require 'rubygems'
+    require 'turn/adapters/testunit' # 'turn'
+  end
+
+  ARGV.each{ |a| Dir[a].each{ |f| require f }}
+  Turn::TestRunner.run(TS_MyTests)
+
+  #RUBY = File.join(Config::CONFIG['bindir'], Config::CONFIG['ruby_install_name'])
+  #
+  #begin
+  #  require 'turn'
+  #  Kernel.exec(RUBY, '-r', 'turn', *ARGV)
+  #rescue LoadError
+  #  require 'rubygems'
+  #  require 'turn'
+  #  Kernel.exec(RUBY, '-rubygems', '-r', 'turn', *ARGV)
+  #end
+
+end
+=end
+