minitest-reporters 0.14.24 → 1.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58d931f0048a34745fe468c31728f2d665b9f269
-  data.tar.gz: 1b8037b1afda1bc3535e88d3ffde9aecc2a98c2b
+  metadata.gz: 6a4b6d764247a5143cb75e59c7f421ffe3a0d6bb
+  data.tar.gz: 1202b2149bafac15280beaa41b16380032952ef1
 SHA512:
-  metadata.gz: 9b06f69f55a81ac3cb53447bbebd5d984ab8474aa71b37b185cda55ac84c3a6a30cabe68b24af4f733881ca4705573429db75949e02efbb81ca8c6ac92cd7dd4
-  data.tar.gz: c6bbd884a420a4d55808623b4080e084e53cb52b79819d5b5657b06a1c8dc10418062f953d990e2beae3df17c85e5e768483ddc00f2bf8b7ce58bf509792f79f
+  metadata.gz: 8b070ec5fba6d3dbf4167b4fda5cbb3c2196ae3e8e68a9c90de21b69974e2a2d2ce9653f03137983d46042b2afd5e222565a2e90f7147b4055e907637592712f
+  data.tar.gz: 376e26b5042f5c6ea2b4705fd4788f0cb72bc4cb5315d3ba07b5eb16985016cea9c00ee098c13367efdd18f4d9391b9b5b554011314596c558b0b4ec8cdf2d0f

data/README.md

@@ -1,6 +1,6 @@
-# minitest-reporters - create customizable MiniTest output formats [![Build Status](https://secure.travis-ci.org/axskern/minitest-reporters.png)](http://travis-ci.org/axskern/minitest-reporters)
+# minitest-reporters - create customizable Minitest output formats [![Build Status](https://secure.travis-ci.org/axskern/minitest-reporters.png)](http://travis-ci.org/axskern/minitest-reporters)
 
-Death to haphazard monkey-patching! Extend MiniTest through simple hooks.
+Death to haphazard monkey-patching! Extend Minitest through simple hooks.
 
 ## Installation ##
 
@@ -12,45 +12,44 @@ In your `test_helper.rb` file, add the following lines:
 
 ```ruby
 require "minitest/reporters"
-MiniTest::Reporters.use!
+Minitest::Reporters.use!
 ```
 
-This will swap out the MiniTest runner to the custom one used by minitest-reporters and use the correct reporters for Textmate, Rubymine, and the console. If you would like to write your own reporter, just `include MiniTest::Reporter` and override the methods you'd like. Take a look at the provided reporters for examples.
+This will swap out the Minitest runner to the custom one used by minitest-reporters and use the correct reporters for Textmate, Rubymine, and the console. If you would like to write your own reporter, just `include Minitest::Reporter` and override the methods you'd like. Take a look at the provided reporters for examples.
 
 Don't like the default progress bar reporter?
 
 ```ruby
-MiniTest::Reporters.use! MiniTest::Reporters::SpecReporter.new
+Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
 ```
 
 Want to use multiple reporters?
 
 ```ruby
-MiniTest::Reporters.use! [MiniTest::Reporters::SpecReporter.new, MiniTest::Reporters::GuardReporter.new]
+Minitest::Reporters.use! [Minitest::Reporters::SpecReporter.new, Minitest::Reporters::JUnitReporter]
 ```
 
 The following reporters are provided:
 
 ```ruby
-MiniTest::Reporters::DefaultReporter  # => Redgreen-capable version of standard MiniTest reporter
-MiniTest::Reporters::SpecReporter     # => Turn-like output that reads like a spec
-MiniTest::Reporters::ProgressReporter # => Fuubar-like output with a progress bar
-MiniTest::Reporters::RubyMateReporter # => Simple reporter designed for RubyMate
-MiniTest::Reporters::RubyMineReporter # => Reporter designed for RubyMine IDE and TeamCity CI server
-MiniTest::Reporters::GuardReporter    # => Integrates with guard-minitest to provide on-screen notifications
-MiniTest::Reporters::JUnitReporter    # => JUnit test reporter designed for JetBrains TeamCity
+Minitest::Reporters::DefaultReporter  # => Redgreen-capable version of standard Minitest reporter
+Minitest::Reporters::SpecReporter     # => Turn-like output that reads like a spec
+Minitest::Reporters::ProgressReporter # => Fuubar-like output with a progress bar
+Minitest::Reporters::RubyMateReporter # => Simple reporter designed for RubyMate
+Minitest::Reporters::RubyMineReporter # => Reporter designed for RubyMine IDE and TeamCity CI server
+Minitest::Reporters::JUnitReporter    # => JUnit test reporter designed for JetBrains TeamCity
 ```
 
 Options can be passed to these reporters at construction-time, e.g. to force
 color output from `DefaultReporter`:
 
 ```ruby
-MiniTest::Reporters.use! [MiniTest::Reporters::SpecReporter.new(:color => true)]
+Minitest::Reporters.use! [Minitest::Reporters::SpecReporter.new(:color => true)]
 ```
 
 ## Caveats ##
 
-If you are using minitest-reporters with ActiveSupport 3.x, make sure that you require ActiveSupport before invoking `MiniTest::Reporters.use!`. Minitest-reporters fixes incompatibilities caused by monkey patches in ActiveSupport 3.x. ActiveSupport 4.x is unaffected.
+If you are using minitest-reporters with ActiveSupport 3.x, make sure that you require ActiveSupport before invoking `Minitest::Reporters.use!`. Minitest-reporters fixes incompatibilities caused by monkey patches in ActiveSupport 3.x. ActiveSupport 4.x is unaffected.
 
 ## Note on Patches/Pull Requests ##
 

data/Rakefile

@@ -21,9 +21,6 @@ end
 
 # - RubyMineReporter must be tested separately inside of RubyMine
 # - JUnitReporter normally writes to `test/reports` instead of stdout
-# - GuardReporter requires Guard, and I'm not
-#   really all that interested in setting it up for automated testing for such a
-#   simple reporter.
 task :gallery do
   unless rubymine_home
     warn "To see RubyMineReporter supply RUBYMINE_HOME= or git clone git://git.jetbrains.org/idea/contrib.git ../rubymine-contrib"
@@ -36,8 +33,7 @@ task :gallery do
     "ProgressReporter",
     "RubyMateReporter",
     "SpecReporter",
-    "RubyMineReporter",
-    "GuardReporter"
+    "RubyMineReporter"
   ].each do |reporter|
     puts
     puts "-" * 72

data/lib/minitest/extensible_backtrace_filter.rb

@@ -1,12 +1,12 @@
-module MiniTest
+module Minitest
   # Filters backtraces of exceptions that may arise when running tests.
   class ExtensibleBacktraceFilter
     # Returns the default filter.
     #
-    # The default filter will filter out all MiniTest and minitest-reporters
+    # The default filter will filter out all Minitest and minitest-reporters
     # lines.
     #
-    # @return [MiniTest::ExtensibleBacktraceFilter]
+    # @return [Minitest::ExtensibleBacktraceFilter]
     def self.default_filter
       unless defined? @default_filter
         filter = self.new
@@ -48,7 +48,7 @@ module MiniTest
     #
     # @param [Array] backtrace the backtrace to filter
     # @return [Array] the filtered backtrace
-    # @note This logic is based off of MiniTest's #filter_backtrace.
+    # @note This logic is based off of Minitest's #filter_backtrace.
     def filter(backtrace)
       result = []
       return result unless backtrace

data/lib/minitest/minitest_reporter_plugin.rb

@@ -0,0 +1,29 @@
+module Minitest
+  class << self
+    def plugin_minitest_reporter_init(options)
+      if defined?(Minitest::Reporters) && Minitest::Reporters.reporters
+        reporter.reporters = Minitest::Reporters.reporters + guard_reporter
+        reporter.reporters.each do |reporter|
+          reporter.io = options[:io]
+          reporter.add_defaults(options.merge(:total_count => total_count(options)))
+        end
+      end
+    end
+
+    private
+
+    # stolen from minitest self.run
+    def total_count(options)
+      filter = options[:filter] || '/./'
+      filter = Regexp.new $1 if filter =~ /\/(.*)\//
+
+      Minitest::Runnable.runnables.map(&:runnable_methods).flatten.find_all { |m|
+        filter === m || filter === "#{self}##{m}"
+      }.size
+    end
+
+    def guard_reporter
+      Array(reporter.reporters.detect { |r| r.class.name == "Guard::Minitest::Reporter" })
+    end
+  end
+end

data/lib/minitest/old_activesupport_fix.rb

@@ -3,7 +3,7 @@ require "active_support/testing/setup_and_teardown"
 module ActiveSupport
   module Testing
     module SetupAndTeardown
-      module ForMiniTest
+      module ForMinitest
         remove_method :run
 
         def before_setup

data/lib/minitest/relative_position.rb

@@ -1,4 +1,4 @@
-module MiniTest
+module Minitest
   module RelativePosition
     TEST_PADDING = 2
     TEST_SIZE = 63
@@ -11,7 +11,7 @@ module MiniTest
       puts pad(line, INFO_PADDING)
     end
 
-    def pad(str, size)
+    def pad(str, size = INFO_PADDING)
       ' ' * size + str
     end
 

data/lib/minitest/reporters/base_reporter.rb

@@ -0,0 +1,88 @@
+module Minitest
+  module Reporters
+    class BaseReporter < Minitest::StatisticsReporter
+      attr_accessor :total_count
+      attr_accessor :tests
+
+      def initialize(options={})
+        super($stdout, options)
+        self.tests = []
+      end
+
+      def add_defaults(defaults)
+        self.options = defaults.merge(options)
+      end
+
+      # called by our own before hooks
+      def before_test(test)
+        last_test = tests.last
+        if last_test.class != test.class
+          after_suite(test.class) if last_test
+          before_suite(test.class)
+        end
+      end
+
+      def record(test)
+        super
+        tests << test
+      end
+
+      # called by our own after hooks
+      def after_test(test)
+      end
+
+      def report
+        super
+        after_suite(tests.last.class)
+      end
+
+      protected
+
+      def after_suite(test)
+      end
+
+      def before_suite(test)
+      end
+
+      def result(test)
+        if test.error?
+          :error
+        elsif test.failure
+          :fail
+        elsif test.skipped?
+          :skip
+        else
+          :pass
+        end
+      end
+
+      def total_time
+        super || Time.now - start_time
+      end
+
+      def total_count
+        options[:total_count]
+      end
+
+      def filter_backtrace(backtrace)
+        Minitest.filter_backtrace(backtrace)
+      end
+
+      def puts(*args)
+        io.puts(*args)
+      end
+
+      def print(*args)
+        io.print(*args)
+      end
+
+      def print_info(e, name=true)
+        print "#{e.exception.class.to_s}: " if name
+        e.message.each_line { |line| print_with_info_padding(line) }
+
+        trace = filter_backtrace(e.backtrace)
+        trace.each { |line| print_with_info_padding(line) }
+      end
+    end
+  end
+end

data/lib/minitest/reporters/default_reporter.rb

@@ -1,111 +1,81 @@
 require 'ansi/code'
 
-module MiniTest
+module Minitest
   module Reporters
-    # A reporter identical to the standard MiniTest reporter except with more
+    # A reporter identical to the standard Minitest reporter except with more
     # colors.
     #
-    # Based upon Ryan Davis of Seattle.rb's MiniTest (MIT License).
+    # Based upon Ryan Davis of Seattle.rb's Minitest (MIT License).
     #
-    # @see https://github.com/seattlerb/minitest MiniTest
-    class DefaultReporter
-      include Reporter
+    # @see https://github.com/seattlerb/minitest Minitest
+    class DefaultReporter < BaseReporter
       include RelativePosition
 
       def initialize(options = {})
+        super
         @detailed_skip = options.fetch(:detailed_skip, true)
         @slow_count = options.fetch(:slow_count, 0)
         @slow_suite_count = options.fetch(:slow_suite_count, 0)
         @fast_fail = options.fetch(:fast_fail, false)
-        @test_times = []
-        @suite_times = []
-        @color = options.fetch(:color) do
-          output.tty? && (
-            ENV["TERM"] =~ /^screen|color/ ||
-            ENV["EMACS"] == "t"
-          )
-        end
+        @options = options
       end
 
-      def before_suites(suites, type)
+      def start
+        super
         puts
-        puts "# Running #{type}s:"
+        puts "# Running tests:"
         puts
       end
 
-      def before_test(suite, test)
-        @test_name = "#{suite}##{test}"
-        print "#{@test_name} = " if verbose?
+      def before_test(test)
+        super
+        print "\n#{test.class}##{test.name} " if options[:verbose]
       end
 
-      def pass(suite, test, test_runner)
-        test_result(green('.'))
-      end
+      def record(test)
+        super
 
-      def skip(suite, test, test_runner)
-        test_result(yellow('S'))
-      end
+        print "#{"%.2f" % test.time} = " if options[:verbose]
 
-      def failure(suite, test, test_runner)
-        if @fast_fail
-          puts
-          puts suite.name
-          print pad_test(test)
-          print(red(pad_mark('FAIL')))
-          puts
-          print_info(test_runner.exception, false)
-        else
-          test_result(red('F'))
-        end
-      end
+        print(if test.passed?
+          green('.')
+        elsif test.skipped?
+          yellow('S')
+        elsif test.failure
+          red('F')
+        end)
 
-      def error(suite, test, test_runner)
-        if @fast_fail
-          puts
-          puts suite.name
-          print pad_test(test)
-          print(red(pad_mark('ERROR')))
+        if @fast_fail && (test.skipped? || test.failure)
           puts
-          print_info(test_runner.exception)
-        else
-          test_result(red('E'))
+          print_failure(test)
         end
       end
 
-      def after_suite(suite)
-        time = Time.now - runner.suite_start_time
-        @suite_times << [suite.name, time]
-      end
-
-      def after_suites(suites, type)
-        time = Time.now - runner.suites_start_time
-        status_line = "Finished %ss in %.6fs, %.4f tests/s, %.4f assertions/s." %
-          [type, time, runner.test_count / time, runner.assertion_count / time]
+      def report
+        super
+        status_line = "Finished tests in %.6fs, %.4f tests/s, %.4f assertions/s." %
+          [total_time, count / total_time, assertions / total_time]
 
         puts
         puts
         puts colored_for(suite_result, status_line)
 
         unless @fast_fail
-          runner.test_results.each do |suite, tests|
-            tests.each do |test, test_runner|
-              if message = message_for(test_runner)
-                puts
-                print colored_for(test_runner.result, message)
-              end
-            end
+          tests.reject(&:passed?).each do |test|
+            puts
+            print_failure(test)
           end
         end
 
         if @slow_count > 0
-          slow_tests = @test_times.sort_by { |x| x[1] }.reverse.take(@slow_count)
+          slow_tests = tests.sort_by(&:time).reverse.take(@slow_count)
 
           puts
           puts "Slowest tests:"
           puts
 
-          slow_tests.each do |slow_test|
-            puts "%.6fs %s" % [slow_test[1], slow_test[0]]
+          slow_tests.each do |test|
+            puts "%.6fs %s" % [test.time, "#{test.name}##{test.class}"]
           end
         end
 
@@ -126,23 +96,37 @@ module MiniTest
         puts
       end
 
+      def print_failure(test)
+        puts colored_for(result(test), message_for(test))
+      end
+
       private
 
+      def color?
+        return @color if defined?(@color)
+        @color = @options.fetch(:color) do
+          io.tty? && (
+            ENV["TERM"] =~ /^screen|color/ ||
+            ENV["EMACS"] == "t"
+          )
+        end
+      end
+
       def green(string)
-        @color ? ANSI::Code.green(string) : string
+        color? ? ANSI::Code.green(string) : string
       end
 
       def yellow(string)
-        @color ? ANSI::Code.yellow(string) : string
+        color? ? ANSI::Code.yellow(string) : string
       end
 
       def red(string)
-        @color ? ANSI::Code.red(string) : string
+        color? ? ANSI::Code.red(string) : string
       end
 
       def colored_for(result, string)
         case result
-        when :failure, :error; red(string)
+        when :fail, :error; red(string)
         when :skip; yellow(string)
         else green(string)
         end
@@ -150,22 +134,13 @@ module MiniTest
 
       def suite_result
         case
-        when runner.failures > 0; :failure
-        when runner.errors > 0; :error
-        when runner.skips > 0; :skip
+        when failures > 0; :fail
+        when errors > 0; :error
+        when skips > 0; :skip
         else :pass
         end
       end
 
-      def test_result(result)
-        time = Time.now - (runner.test_start_time || Time.now)
-        @test_times << [@test_name, time]
-
-        print '%.2f s = ' % time if verbose?
-        print result
-        puts if verbose?
-      end
-
       def location(exception)
         last_before_assertion = ''
 
@@ -177,33 +152,24 @@ module MiniTest
         last_before_assertion.sub(/:in .*$/, '')
       end
 
-      def message_for(test_runner)
-        suite = test_runner.suite
-        test = test_runner.test
-        e = test_runner.exception
+      def message_for(test)
+        e = test.failure
 
-        case test_runner.result
-        when :pass then nil
-        when :skip
+        if test.skipped?
           if @detailed_skip
-            "Skipped:\n#{test}(#{suite}) [#{location(e)}]:\n#{e.message}\n"
+            "Skipped:\n#{test.class}##{test.name} [#{location(e)}]:\n#{e.message}"
           end
-        when :failure then "Failure:\n#{test}(#{suite}) [#{location(e)}]:\n#{e.message}\n"
-        when :error
-          bt = filter_backtrace(test_runner.exception.backtrace).join "\n    "
-          "Error:\n#{test}(#{suite}):\n#{e.class}: #{e.message}\n    #{bt}\n"
+        elsif test.error?
+          bt = filter_backtrace(e.backtrace).join "\n    "
+          "Error:\n#{test.class}##{test.name}:\n#{e.class}: #{e.message}\n    #{bt}"
+        else
+          "Failure:\n#{test.class}##{test.name}:\n#{e.class}: #{e.message}"
         end
       end
 
       def result_line
         '%d tests, %d assertions, %d failures, %d errors, %d skips' %
-          [runner.test_count, runner.assertion_count, runner.failures, runner.errors, runner.skips]
-      end
-
-      def print_info(e, name = true)
-        print "#{e.exception.class.to_s}: " if name
-        e.message.each_line { |line| print_with_info_padding(line) }
-        filter_backtrace(e.backtrace).each { |line| print_with_info_padding(line) }
+          [count, assertions, failures, errors, skips]
       end
     end
   end