turn 0.8.2 → 0.9.7

data/CONTRIBUTING.md

@@ -0,0 +1,40 @@
+# CONTRIBUTING
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my_new_feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my_new_feature`)
+5. Create a new Pull Request
+
+If you are a project member please follow the same process (minus the forking). For significant changes please wait for another developer to review and merge them, whereas small contributions/fixes can be merged without review. The recommended naming scheme for feature branches is 'feature\_name\_$1\_`date +"%Y%m%d"`'.
+
+You may want to look into the [grb](http://github.com/jinzhu/grb) gem for easier handling of remote branches.
+
+
+## Building
+
+NOTE: The process described here will change sooner than later.
+
+Turn uses the Indexer and Mast gems to simplify project building.
+
+The Indexer gem defines a strict structure for project metadata. Use the `index`
+command to build the `.index` file from the editable `Index.rb` source.
+The `.gemspec` file is written to get the information it needs from the `.index`
+file. To build a gem simply use `gem build .gemspec`.
+
+The `mast` command is used to keep an up-to-date `Manifest.txt` file. The gemspec
+uses this file to determine which files to include in the gem. Just use
+`mast -u` to update it. The top line in the Manifest.txt file determines it's
+contents.
+
+
+## Solo and Cross Runners
+
+An important aspect of Turn's design that needs be kept in mind, is the way
+_solo_ and _cross_ testing features are implemented. This is some really
+neat code actually (IMO), but it might be difficult to grasp with out some
+explanation. What turn does when using the `--solo` or `--cross` options,
+is <i>shell out to itself</i> using the YAML reporter. It does this repeatedly
+for each test, or each pair of tests, respectively, and then collates all the
+resulting YAML reports into a single report, which it then feeds back into the
+selected reporter.

data/History.txt

@@ -1,5 +1,85 @@
+=== 0.9.7 / 2014-03-14
+  * Fix -n option for running named tests (#78)
+  * Change default output mode to 'pretty'
+  * Add option to print top 10 longest running tests
+  * Fix home directory lookup
+
+=== 0.9.6 / 2012-06-26
+  * Override output() instead of changeing @@out. (#96,#97)
+  * Update install instructions in README. (#95)
+  * Fix bug in gemspec that interfered with Bundler (#93)
+
+== 0.9.5 / 2012-04-15
+  * Add -m/-mark option to flag tests with high runtimes.
+  * Show per-test runtime in Pretty reporter. (#83)
+  * Fix colorization of result box. (Don Wilson) (#81, #85)
+  * Add support for natural test names in pretty format. (Don Wilson) (#86)
+  * Fix test rake task on Windows. (Don Wilson) (#88)
+
+== 0.9.4 / 2012-03-16
+  * Fix dot reporter to use `.` instead of `S` for passed tests.
+  * Do not filter backtraces of local directory.
+  * Do not colourize zero counts in pretty reporter.
+
+== 0.9.3 / 2012-02-17
+  * Default to pretty reporter.
+  * Can set reporter via `rpt` environment variable.
+  * Fix backtrace filter.
+  * Fix require warning when using cli.
+  * Add skip counts to reporter tallies. (y8)
+  * Improve Pretty reporter output. (y8)
+
+== 0.9.2 / 2012-02-08
+  * Fix colorization config issue.
+  * Switch to simple dotruby build system.
+
+== 0.9.1 / 2012-02-01
+  * MiniTest Only
+  * Fix issues with 1.8.7 support.
+
+== 0.9.0 / 2012-01-30
+  * Fix bundle exec issue, which means...
+  * Developer's must require `turn/autorun` instead fo just `turn`.
+  * Improve detection of TestUnit 1.x vs. MiniTest
+  * Show randomization seed number in output.
+  * Pretty format option is now `-R` instead of `-T`.
+  * Rename case match shortcut to `-c` instead of `-t`.
+  * Add support for skipped tests.
+  * Support max backtrace limit via `-b` option.
+  * Use $RUBY_IGNORE_CALLERS to ignore lines of backtrace.
+  * Better color support on Windows (install ANSICON)
+  * MiniTest is a dependency (even if you are using it for TestUnit 1.x).
+
+== 0.8.4 / 2011-11-11
+  * Now must use MiniTest 2.0+.
+
+== 0.8.3 / 2011-10-10
+  * Merge pull request #56 from codeinvain/master
+  * Merge pull request #52 from markburns/patch-2
+  * Merge pull request #51 from markburns/patch-1
+  * Merge pull request #50 from tpope/stdout_tty
+  * Switch COLORIZE to method for easier testing
+  * Don't show colors if stdout is not a tty
+  * Use global config.
+  * Autoload Test::Unit and MiniTest.
+  * Autorun uses Turn's runner classes.
+  * minitest changed Unit#run, set Unit.runner= if method exists
+  * Merge pull request #39 from dubek/fix_term_detection_for_ruby_19
+  * Merge pull request #38 from cameel/fix-minitest-run-monkeypatch-no-trace
+  * Merge pull request #36 from yalab/master
+  * Don't use ANSI codes on dumb terminals in Ruby 1.9
+  * Make Turn work with gems that monkey-patch MiniTest::Unit::TestCase.run()
+  * Fixed pretty_reporter to use 'trace' option.
+  * Fixed dot_reporter to use 'trace' option.
+  * Fixed outline_reporter to use 'trace' option.
+  * Add -t or --trace option for display all stacktrace.
+  * missing #skip! method in TestMethod
+  * Merge branch 'master' of github.com:TwP/turn
+  * use autoload to load MiniTests emulation of TestUnit
+  * do not use color if in a VIM session
+
 == 0.8.2 / 2011-03-31
-  * Add version in code and cli option to diplay it.
+  * Add version in code and cli option to display it.
   * Fix for files lookup controller bug
   * Limit default test matching to *.rb files.
   * Show first line from the test file when showing stack traces [F. Morgan Whitney]

data/Index.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/lib/turn/version'
+
+version       Turn::VERSION  #File.read('Version.txt').strip
+
+name         'turn'
+title        'Turn'
+summary      'Test Reporters (New) -- new output formats for Testing'
+
+description "Turn provides a set of alternative runners for MiniTest, both colorful and informative."
+
+authors [
+  'Thomas Sawyer <transfire@gmail.com>',
+  'Tim Pease <tim.pease@gmail.com>'
+]
+
+requirements [
+  'ansi',
+  'minitest  4~',
+  'rake     (build)',
+  'indexer  (build)',
+  'mast     (build)'
+]
+
+resources(
+  'home' => 'http://rubygems.org/gems/turn',
+  'code' => 'http://github.com/TwP/turn'
+)
+
+copyrights [
+  '2006 Tim Pease (MIT)',
+  '2009 Thomas Sawyer (MIT)'
+]

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+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/NOTICE.md

@@ -0,0 +1,12 @@
+# Copyright Notices
+
+## MiniTest
+
+Copyright (c) Ryan Davis, Seattle.rb
+
+MIT License
+
+Turn tightly couples with MiniTest which means in some cases
+MiniTest code might be reused and modified so Turn will
+interface with MiniTest effectively.
+

data/README.md

@@ -0,0 +1,176 @@
+# TURN - MiniTest Reporters [![Build status](https://api.travis-ci.org/turn-project/turn.png)](https://travis-ci.org/turn-project/turn)
+    by Tim Pease
+    http://rubygems.org/gems/turn
+
+## DESCRIPTION
+
+TURN is a new way to view test 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.
+
+## INSTRUCTION
+
+Turn can be used 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/autorun'
+
+This will configure MiniTest to use TURN formatting for displaying test
+results. A better line to use, though, is the following:
+
+    begin; require 'turn/autorun'; 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'
+script. Now your Rails tests will use TURN formatting.
+
+<b>Note:</b> This changed in version 0.9. It used to be just `require 'turn'`,
+but because of how `bundle exec` works, it was better to require a subdirectory
+file.
+
+### Configuration
+
+You can use `Turn.config` to adjust turn configuration.
+
+Options are following:
+
+    tests           List of file names or glob patterns of tests to run. Default: ["test/**/{test,}*{,test}.rb"]
+    exclude         List of file names or globs to exclude from tests list. Default: []
+    pattern         Regexp pattern that all test names must match to be eligible to run. Default: /.*/ (all)
+    matchcase       Regexp pattern that all test cases must match to be eligible to run. Default: nil (all)
+    loadpath        Add these folders to the $LOAD_PATH. Default: ['lib']
+    requires        Libs to require when running tests. Default: []
+    format          Reporter type (:pretty, :dot, :cue, :marshal, :outline, :progress). Default: :pretty
+    live            Test against live install (i.e. Don't use loadpath option). Default: false
+    verbose         Verbose output? Default: false
+    trace           Number of backtrace lines to display. Default: set from ENV or nil (all)
+    natural         Use natural language case names.  Default: false
+    ansi            Force colorized output (requires 'ansi' gem). Default: set from ENV or nil (auto)
+
+To set option just call the desired method:
+
+    Turn.config.format = :progress
+
+Also, you can use following environment variables to adjust settings:
+
+    backtrace       Number of backtrace lines to display. Default: set from ENV or nil
+    ansi            Force colorize output (requires 'ansi' gem).
+
+Finally, you can include your own custom Reporter type (aka format). Turn will search for reporters in the `.turn/reporters/`
+directory of your local project and then in your user home directory. So for example, if you specified the following:
+
+    Turn.config.format = :cool
+
+Then Turn will look first for `./.turn/reporters/cool_reporter.rb`, then `~/.turn/reporters/cool_reporter.rb`.
+
+See source code for examples of how to write your own reporters.
+
+
+## REQUIREMENTS
+
+* ansi 1.1+ (for colorized output and progress bar output mode)
+
+
+## INSTALLATION
+
+Follow the ususal procedure:
+
+    $ gem install turn
+
+
+## TODO
+
+* Setup CI for Ruby 1.9 and 2.0
+* Support MiniTest v5.0
+* Remove indexer and mast gems from build process
+* Remove support for Ruby versions < 1.9
+* Remove support for Test::Unit
+* General code cleanup
+
+
+## LICENSE
+
+MIT License
+
+Copyright (c) 2006 Tim Pease
+Copyright (c) 2009 Thomas Sawyer
+Copyright (c) 2013 Michael Kohl, Daniel Yoon
+
+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/Release.txt

@@ -1,4 +1,24 @@
-= Turn 0.8.0
+= Release Notes
+
+== 0.9.x
+
+The main departure of the 0.9.x series form older version of Turn,
+is that the old TestUnit library (1.x series) is no longer supported.
+Turn is now a MiniTest only library.[1]
+
+Among other imporvements, the default reporter is now the Pretty reporter
+instead of the orginal Outline reporter, and MiniTest skips are finally
+supported.
+
+Big thanks to y8, Alexey Bondar and others for helpig to get this series
+up to snuff.
+
+[1] Note that the old testunit runner is still included in the package
+if it is needed, but no longer will be actively maintained and it
+must be directly required to be used.
+
+
+== 0.8.x
 
 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

data/Version.txt

@@ -1 +1 @@
-0.8.2
+0.9.7

data/bin/turn

@@ -1,4 +1,10 @@
 #!/usr/bin/env ruby
-require 'turn/command'
-Turn::Command.main(*ARGV)
+require 'turn'
+begin
+  Turn::Command.main(*ARGV)
+rescue StandardError => e
+  raise if $DEBUG
+  puts e
+  exit -1
+end
 

data/lib/turn/autoload.rb

@@ -0,0 +1,6 @@
+# This is a "dirty trick" to load `test/unit` or `minitest/unit` if sought.
+# Eventually a way to handle this more robustly (without autoreload) 
+# should be worked out. But how?
+autoload "Test",     'test/unit'
+autoload "MiniTest", 'minitest/unit'
+

data/lib/turn/autorun.rb

@@ -0,0 +1,4 @@
+require 'turn'
+
+MiniTest::Unit.autorun
+

data/lib/turn/bin.rb

@@ -1,4 +1,10 @@
 $LOAD_PATH.unshift(File.dirname(File.dirname(__FILE__)))
-require 'turn/command'
-Turn::Command.main(*ARGV)
+require 'turn'
+#begin
+  Turn::Command.main(*ARGV)
+#rescue StandardError => e
+#  raise if $DEBUG
+#  puts e
+#  exit -1
+#end
 

data/lib/turn/colorize.rb

@@ -1,3 +1,6 @@
+require 'turn/configuration'  # TODO: why is this needed here?
+
+# TODO: adapt for Ruby 1.9+?
 begin
   require 'ansi/code'
 rescue LoadError
@@ -10,56 +13,84 @@ end
 
 module Turn
 
+  # Provides a uniform interface for colorizing Turn output.
+  #
   module Colorize
 
-    COLORIZE = defined?(::ANSI::Code) && ENV.has_key?('TERM')
+    def self.included(base)
+      base.module_eval do
+        const_set :PASS,  Colorize.pass('PASS')
+        const_set :FAIL,  Colorize.fail('FAIL')
+        const_set :ERROR, Colorize.error('ERROR')
+        const_set :SKIP,  Colorize.skip('SKIP')
+      end
+    end
+
+    COLORLESS_TERMINALS = ['dumb']
+
+    # Colorize output or not?
+    def self.colorize?
+      return @colorize unless @colorize.nil?
+      @colorize ||= (
+        ansi = Turn.config.ansi?
+        ansi.nil? ? color_supported? : ansi
+      )
+    end
+
+    # Does the system support color?
+    def self.color_supported?
+      return false unless defined?(::ANSI::Code)
+      return false unless $stdout.tty?
+      return true if ENV.has_key?('TERM') && !COLORLESS_TERMINALS.include?(ENV['TERM'])
+      return true if ::RbConfig::CONFIG['host_os'] =~ /mswin|mingw/ && ENV.has_key?('ANSICON')
+      return false
+    end
 
     def self.red(string)
-      COLORIZE ? ::ANSI::Code.red{ string } : string
+      colorize? ? ::ANSI::Code.red{ string } : string
     end
 
     def self.green(string)
-      COLORIZE ? ::ANSI::Code.green{ string } : string
+      colorize? ? ::ANSI::Code.green{ string } : string
     end
 
     def self.blue(string)
-      COLORIZE ? ::ANSI::Code.blue{ string } : string
+      colorize? ? ::ANSI::Code.blue{ string } : string
     end
 
     def self.magenta(string)
-      COLORIZE ? ::ANSI::Code.magenta{ string } : string
+      colorize? ? ::ANSI::Code.magenta{ string } : string
     end
 
     def self.bold(string)
-      COLORIZE ? ::ANSI::Code.bold{ string } : string
+      colorize? ? ::ANSI::Code.bold{ string } : string
+    end
+
+    def self.mark(string)
+      colorize? ? ::ANSI::Code.yellow{ string } : string
     end
 
     def self.pass(string)
-      COLORIZE ? ::ANSI::Code.green{ string } : string
+      colorize? ? ::ANSI::Code.green{ string } : string
     end
 
     def self.fail(string)
-      COLORIZE ? ::ANSI::Code.red{ string } : string
+      colorize? ? ::ANSI::Code.red{ string } : string
     end
 
-    #def self.error(string)
-    #  COLORIZE ? ::ANSI::Code.white{ ::ANSI::Code.on_red{ string } } : string
-    #end
-
     def self.error(string)
-      COLORIZE ? ::ANSI::Code.yellow{ string } : string
+      #colorize? ? ::ANSI::Code.white_on_red{ string } : string
+      colorize? ? ::ANSI::Code.yellow{ string } : string
     end
 
     def self.skip(string)
-      COLORIZE ? ::ANSI::Code.cyan{ string } : string
+      colorize? ? ::ANSI::Code.cyan{ string } : string
     end
 
-    PASS  = pass('PASS')
-    FAIL  = fail('FAIL')
-    ERROR = error('ERROR')
-    SKIP  = skip('SKIP')
+    def colorize?
+      Colorize.colorize?
+    end
 
   end
 
 end
-