minitest-reporters 0.10.2 → 0.11.0

data/.gitignore

@@ -3,6 +3,7 @@ rdoc
 pkg
 test/tmp
 test/version_tmp
+test/reports
 tmp
 pkg
 *.gem
@@ -19,4 +20,4 @@ _yardoc
 doc/
 
 # Gem-specific
-Gemfile.lock
+Gemfile.lock

data/Rakefile

@@ -1,11 +1,34 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
+require "bundler/gem_tasks"
+require "rake/testtask"
 
 task :default => :test
-
-require 'rake/testtask'
 Rake::TestTask.new do |t|
-  t.ruby_opts += ['-rubygems']
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-end
+  t.pattern = "test/unit/**/*_test.rb"
+  t.verbose = true
+end
+
+Rake::TestTask.new("test:gallery") do |t|
+  t.pattern = "test/gallery/**/*_test.rb"
+  t.verbose = true
+end
+
+# The RubyMine reporter must be tested separately inside of RubyMine, and hence
+# is not run in the gallery. The JUnit reporter writes to `test/reports` instead
+# of having meaningful output. The guard reporter requires Guard, and I'm not
+# really all that intersted in setting it up for automated testing for such a
+# simple reporter.
+task :gallery do
+  [
+    "DefaultReporter",
+    "JUnitReporter",
+    "ProgressReporter",
+    "RubyMateReporter",
+    "SpecReporter"
+  ].each do |reporter|
+    puts "Running gallery tests using #{reporter}..."
+    sh "rake test:gallery REPORTER=#{reporter}" do
+      # Ignore failures. They're expected when you are running the gallery
+      # test suite.
+    end
+  end
+end

data/lib/minitest/reporters/default_reporter.rb

@@ -10,8 +10,23 @@ module MiniTest
     class DefaultReporter
       include Reporter
 
-      def initialize(backtrace_filter = BacktraceFilter.default_filter)
-        @backtrace_filter = backtrace_filter
+      def initialize(options = {})
+        if options.is_a?(Hash)
+          @backtrace_filter = options.fetch(:backtrace_filter, BacktraceFilter.default_filter)
+          @detailed_skip = options.fetch(:detailed_skip, true)
+          @color = options.fetch(:color) do
+            output.tty? && (
+              ENV["TERM"] == "screen" ||
+              ENV["TERM"] =~ /term(?:-(?:256)?color)?\z/ ||
+              ENV["EMACS"] == "t"
+            )
+          end
+        else
+          warn "Please use :backtrace_filter => filter instead of passing in the filter directly."
+          @backtrace_filter = options
+          @detailed_skip = true
+          @color = false
+        end
       end
 
       def before_suites(suites, type)
@@ -25,46 +40,75 @@ module MiniTest
       end
 
       def pass(suite, test, test_runner)
-        after_test('.')
+        after_test(green { '.' })
       end
 
       def skip(suite, test, test_runner)
-        after_test('S')
+        after_test(yellow { 'S' })
       end
 
       def failure(suite, test, test_runner)
-        after_test('F')
+        after_test(red { 'F' })
       end
 
       def error(suite, test, test_runner)
-        after_test('E')
+        after_test(red { 'E' })
       end
 
       def after_suites(suites, type)
         time = Time.now - runner.suites_start_time
+        status_line = colored_for(suite_result) do
+          "Finished %ss in %.6fs, %.4f tests/s, %.4f assertions/s." %
+            [type, time, runner.test_count / time, runner.assertion_count / time]
+        end
 
         puts
         puts
-        puts "Finished #{type}s in %.6fs, %.4f tests/s, %.4f assertions/s." %
-          [time, runner.test_count / time, runner.assertion_count / time]
+        puts status_line
 
-        i = 0
         runner.test_results.each do |suite, tests|
           tests.each do |test, test_runner|
-            message = message_for(test_runner)
-            if message
-              i += 1
-              puts "\n%3d) %s" % [i, message]
+            if message = message_for(test_runner)
+              puts
+              print(colored_for(test_runner.result) { message })
             end
           end
         end
 
         puts
-        puts status
+        puts(colored_for(suite_result) { status })
       end
 
       private
 
+      def green(&block)
+        @color ? ANSI::Code.green(&block) : yield
+      end
+
+      def yellow(&block)
+        @color ? ANSI::Code.yellow(&block) : yield
+      end
+
+      def red(&block)
+        @color ? ANSI::Code.red(&block) : yield
+      end
+
+      def colored_for(result, &block)
+        case result
+        when :failure, :error; red(&block)
+        when :skip; yellow(&block)
+        else green(&block)
+        end
+      end
+
+      def suite_result
+        if runner.failures > 0; :failure
+        elsif runner.errors > 0; :error
+        elsif runner.skips > 0; :skip
+        else :pass
+        end
+      end
+
       def after_test(result)
         time = Time.now - runner.test_start_time
 
@@ -91,7 +135,10 @@ module MiniTest
 
         case test_runner.result
         when :pass then nil
-        when :skip then "Skipped:\n#{test}(#{suite}) [#{location(e)}]:\n#{e.message}\n"
+        when :skip
+          if @detailed_skip
+            "Skipped:\n#{test}(#{suite}) [#{location(e)}]:\n#{e.message}\n"
+          end
         when :failure then "Failure:\n#{test}(#{suite}) [#{location(e)}]:\n#{e.message}\n"
         when :error
           bt = @backtrace_filter.filter(test_runner.exception.backtrace).join "\n    "

data/lib/minitest/reporters/version.rb

@@ -1,5 +1,5 @@
 module MiniTest
   module Reporters
-    VERSION = "0.10.2"
+    VERSION = "0.11.0"
   end
 end

data/test/gallery/bad_test.rb

@@ -0,0 +1,25 @@
+require_relative "../test_helper"
+
+module MiniTestReportersTest
+  class BadTest < TestCase
+    def test_a
+      assert_equal 1, 2
+    end
+
+    def test_b
+      assert false # simple failure
+    end
+
+    def test_b
+      assert_equal "ab\nc", "ab\nd" # some nice diff
+    end
+
+    def test_boom
+      raise "A random exception"
+    end
+
+    def test_long_method_name
+      skip
+    end
+  end
+end

data/test/gallery/good_test.rb

@@ -0,0 +1,14 @@
+require_relative "../test_helper"
+
+module MiniTestReportersTest
+  class GoodTest < TestCase
+    def test_a
+      assert_equal 1, 1
+      assert 1
+    end
+
+    def test_b
+      assert_equal 2, 2
+    end
+  end
+end

data/test/test_helper.rb

@@ -1,7 +1,7 @@
-require 'bundler/setup'
-require 'minitest/autorun'
-require 'rr'
-require 'minitest/reporters'
+require "bundler/setup"
+require "minitest/autorun"
+require "rr"
+require "minitest/reporters"
 
 module MiniTestReportersTest
   class TestCase < MiniTest::Unit::TestCase
@@ -10,15 +10,12 @@ module MiniTestReportersTest
 end
 
 # Testing the built-in reporters using automated unit testing would be extremely
-# brittle. Consequently, there are no unit tests for them. Instead, uncomment
-# the reporter that you'd like to test and run the full test suite. Make sure to
-# try them with skipped, failing, and error tests as well!
+# brittle. Consequently, there are no unit tests for them.  If you'd like to run
+# all the reporters sequentially on a fake test suite, run `rake gallery`.
 
-MiniTest::Reporters.use!
-# MiniTest::Reporters.use! MiniTest::Reporters::DefaultReporter.new
-# MiniTest::Reporters.use! MiniTest::Reporters::SpecReporter.new
-# MiniTest::Reporters.use! MiniTest::Reporters::ProgressReporter.new(:detailed_skip => false)
-# MiniTest::Reporters.use! MiniTest::Reporters::RubyMateReporter.new
-# MiniTest::Reporters.use! MiniTest::Reporters::RubyMineReporter.new
-# MiniTest::Reporters.use! MiniTest::Reporters::GuardReporter.new
-# MiniTest::Reporters.use! MiniTest::Reporters::JUnitReporter.new
+if ENV["REPORTER"]
+  reporter_klass = MiniTest::Reporters.const_get(ENV["REPORTER"])
+  MiniTest::Reporters.use! [reporter_klass.new]
+else
+  MiniTest::Reporters.use!
+end

data/test/{minitest → unit/minitest}/backtrace_filter_test.rb

@@ -1,4 +1,4 @@
-require "test_helper"
+require_relative "../../test_helper"
 
 module MiniTestReportersTest
   class BacktraceFilterTest < TestCase

data/test/{minitest → unit/minitest}/reporter_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require_relative "../../test_helper"
 
 module MiniTestReportersTest
   class ReporterTest < TestCase

data/test/{minitest → unit/minitest}/reporters_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require_relative "../../test_helper"
 
 module MiniTestReportersTest
   class ReportersTest < TestCase

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minitest-reporters
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.11.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-31 00:00:00.000000000 Z
+date: 2012-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -158,10 +158,12 @@ files:
 - lib/minitest/reporters/version.rb
 - lib/minitest/test_runner.rb
 - minitest-reporters.gemspec
-- test/minitest/backtrace_filter_test.rb
-- test/minitest/reporter_test.rb
-- test/minitest/reporters_test.rb
+- test/gallery/bad_test.rb
+- test/gallery/good_test.rb
 - test/test_helper.rb
+- test/unit/minitest/backtrace_filter_test.rb
+- test/unit/minitest/reporter_test.rb
+- test/unit/minitest/reporters_test.rb
 homepage: https://github.com/CapnKernul/minitest-reporters
 licenses: []
 post_install_message: 
@@ -187,8 +189,10 @@ signing_key:
 specification_version: 3
 summary: Create customizable MiniTest output formats
 test_files:
-- test/minitest/backtrace_filter_test.rb
-- test/minitest/reporter_test.rb
-- test/minitest/reporters_test.rb
+- test/gallery/bad_test.rb
+- test/gallery/good_test.rb
 - test/test_helper.rb
+- test/unit/minitest/backtrace_filter_test.rb
+- test/unit/minitest/reporter_test.rb
+- test/unit/minitest/reporters_test.rb
 has_rdoc: