minitest-reporters 0.7.1 → 0.8.0

data/README.md

@@ -10,14 +10,18 @@ Death to haphazard monkey-patching! Extend MiniTest through simple hooks.
 
 In your `test_helper.rb` file, add the following lines:
 
-    require 'minitest/reporters'
-    MiniTest::Unit.runner = MiniTest::SuiteRunner.new
-    MiniTest::Unit.runner.reporters << MiniTest::Reporters::ProgressReporter.new
+    require "minitest/reporters"
+    MiniTest::Reporters.use!
 
-Now, just run your tests; the reporter you specified will be used and make your
-output look absolutely gorgeous! If you feel the need 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?
+
+    MiniTest::Reporters.use! MiniTest::Reporters::SpecReporter.new
+
+Want to use multiple reporters?
+
+    MiniTest::Reporters.use! [MiniTest::Reporters::SpecReporter.new, MiniTest::Reporters::GuardReporter.new]
 
 The following reporters are provided:
 
@@ -28,29 +32,8 @@ The following reporters are provided:
     MiniTest::Reporters::RubyMineReporter # => Reporter designed for RubyMine IDE and TeamCity CI server; see below
     MiniTest::Reporters::GuardReporter # => Integrates with guard-minitest to provide on-screen notifications
 
-I really like `ProgressReporter` for my everyday terminal usage, but I like
-using `RubyMateReporter` when I'm executing test suites from TextMate. My usual
-set up looks like this:
-
-    require 'minitest/reporters'
-    MiniTest::Unit.runner = MiniTest::SuiteRunner.new
-    if ENV['TM_PID']
-      MiniTest::Unit.runner.reporters << MiniTest::Reporters::RubyMateReporter.new
-    else
-      MiniTest::Unit.runner.reporters << MiniTest::Reporters::ProgressReporter.new
-    end
-
-If you prefer integration with RubyMine test runner or TeamCity CI server you'll need:
-
-    if ENV["RM_INFO"] || ENV["TEAMCITY_VERSION"]
-      MiniTest::Unit.runner.reporters << MiniTest::Reporters::RubyMineReporter.new
-    else
-      ...
-    end
-
 ## TODO ##
 
-* Make the boilerplate code look prettier. Something like a one-line require for the general use-case would be nice.
 * Add some example images of the reporters.
 
 ## Note on Patches/Pull Requests ##

data/lib/minitest/reporter.rb

@@ -1,7 +1,7 @@
 module MiniTest
   module Reporter
     def runner
-      MiniTest::Unit.runner
+      Unit.runner
     end
     
     def output
@@ -30,4 +30,4 @@ module MiniTest
     def failure(suite, test, test_runner); end
     def error(suite, test, test_runner); end
   end
-end
+end

data/lib/minitest/reporters.rb

@@ -16,5 +16,21 @@ module MiniTest
     autoload :RubyMineReporter, "minitest/reporters/rubymine_reporter"
     autoload :GuardReporter, "minitest/reporters/guard_reporter"
     autoload :JUnitReporter, "minitest/reporters/junit_reporter"
+
+    def self.use!(console_reporters = ProgressReporter.new, env = ENV)
+      runner = SuiteRunner.new
+      runner.reporters = choose_reporters(console_reporters, env)
+      Unit.runner = runner
+    end
+
+    def self.choose_reporters(console_reporters, env)
+      if env["TM_PID"]
+        [RubyMateReporter.new]
+      elsif env["RM_INFO"] || env["TEAMCITY_VERSION"]
+        [RubyMineReporter.new]
+      else
+        Array(console_reporters)
+      end
+    end
   end
 end

data/lib/minitest/reporters/default_reporter.rb

@@ -8,9 +8,9 @@ module MiniTest
     #
     # @see https://github.com/seattlerb/minitest MiniTest
     class DefaultReporter
-      include MiniTest::Reporter
+      include Reporter
 
-      def initialize(backtrace_filter = MiniTest::BacktraceFilter.default_filter)
+      def initialize(backtrace_filter = BacktraceFilter.default_filter)
         @backtrace_filter = backtrace_filter
       end
 

data/lib/minitest/reporters/guard_reporter.rb

@@ -1,15 +1,14 @@
 begin
-  require 'guard/minitest/notifier'
+  require "guard/minitest/notifier"
 rescue LoadError
-  puts "You need guard-minitest to use this reporter"
+  puts "You need guard-minitest to use this reporter."
   exit 1
 end
 
 module MiniTest
   module Reporters
-
     class GuardReporter
-      include MiniTest::Reporter
+      include Reporter
 
       def after_suites(*args)
         duration = Time.now - runner.start_time

data/lib/minitest/reporters/junit_reporter.rb

@@ -10,9 +10,9 @@ module MiniTest
     # Also inspired by Marc Seeger's attempt at producing a JUnitReporter (see https://github.com/rb2k/minitest-reporters/commit/e13d95b5f884453a9c77f62bc5cba3fa1df30ef5)
     # Also inspired by minitest-ci (see https://github.com/bhenderson/minitest-ci)
     class JUnitReporter
-      include MiniTest::Reporter
+      include Reporter
 
-      def initialize(reports_dir = "test/reports", backtrace_filter = MiniTest::BacktraceFilter.default_filter)
+      def initialize(reports_dir = "test/reports", backtrace_filter = BacktraceFilter.default_filter)
         @backtrace_filter = backtrace_filter
         @reports_path = File.join(Dir.getwd, reports_dir)
         p "Emptying #{@reports_path}"

data/lib/minitest/reporters/progress_reporter.rb

@@ -11,13 +11,20 @@ module MiniTest
     # @see https://github.com/jeffkreeftmeijer/fuubar Fuubar
     # @see https://gist.github.com/356945 paydro's monkey-patch
     class ProgressReporter
-      include MiniTest::Reporter
+      include Reporter
       include ANSI::Code
 
       INFO_PADDING = 2
 
-      def initialize(backtrace_filter = MiniTest::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)
+        else
+          warn "Please use :backtrace_filter => filter instead of passing in the filter directly."
+          @backtrace_filter = options
+          @detailed_skip = true
+        end
       end
 
       def before_suites(suites, type)
@@ -44,10 +51,14 @@ module MiniTest
 
       def skip(suite, test, test_runner)
         @color = YELLOW unless @color == RED
-        print(yellow { 'SKIP' })
-        print_test_with_time(suite, test)
-        puts
-        puts
+
+        if @detailed_skip
+          print(yellow { 'SKIP' })
+          print_test_with_time(suite, test)
+          puts
+          puts
+        end
+
         increment
       end
 

data/lib/minitest/reporters/ruby_mate_reporter.rb

@@ -5,11 +5,11 @@ module MiniTest
   module Reporters
     # Simple reporter designed for RubyMate.
     class RubyMateReporter
-      include MiniTest::Reporter
+      include Reporter
 
       INFO_PADDING = 2
 
-      def initialize(backtrace_filter = MiniTest::BacktraceFilter.default_filter)
+      def initialize(backtrace_filter = BacktraceFilter.default_filter)
         @backtrace_filter = backtrace_filter
       end
 

data/lib/minitest/reporters/rubymine_reporter.rb

@@ -27,7 +27,7 @@ rescue LoadError
   # delegate to default reporter
   module MiniTest
     module Reporters
-      class RubyMineReporter < MiniTest::Reporters::DefaultReporter
+      class RubyMineReporter < DefaultReporter
       end
     end
   end
@@ -35,7 +35,7 @@ else
   module MiniTest
     module Reporters
       class RubyMineReporter
-        include MiniTest::Reporter
+        include Reporter
         include ANSI::Code
 
         include ::Rake::TeamCity::RunnerCommon

data/lib/minitest/reporters/spec_reporter.rb

@@ -9,14 +9,14 @@ module MiniTest
     # @see https://github.com/TwP/turn turn
     # @see https://gist.github.com/356945 paydro's monkey-patch
     class SpecReporter
-      include MiniTest::Reporter
+      include Reporter
       include ANSI::Code
 
       TEST_PADDING = 2
       INFO_PADDING = 8
       MARK_SIZE    = 5
 
-      def initialize(backtrace_filter = MiniTest::BacktraceFilter.default_filter)
+      def initialize(backtrace_filter = BacktraceFilter.default_filter)
         @backtrace_filter = backtrace_filter
       end
 

data/lib/minitest/reporters/version.rb

@@ -1,5 +1,5 @@
 module MiniTest
   module Reporters
-    VERSION = '0.7.1'
+    VERSION = "0.8.0"
   end
 end

data/lib/minitest/suite_runner.rb

@@ -8,7 +8,7 @@ module MiniTest
   # Based upon Ryan Davis of Seattle.rb's MiniTest (MIT License).
   # 
   # @see https://github.com/seattlerb/minitest MiniTest
-  class SuiteRunner < MiniTest::Unit
+  class SuiteRunner < Unit
     attr_accessor :suite_start_time, :test_start_time, :reporters
     
     def initialize
@@ -107,4 +107,4 @@ module MiniTest
       output.sync = old_sync if sync
     end
   end
-end
+end

data/lib/minitest/test_runner.rb

@@ -24,8 +24,8 @@ module MiniTest
     
     def puke(suite, test, exception)
       case exception
-      when MiniTest::Skip then [:skip, exception]
-      when MiniTest::Assertion then [:failure, exception]
+      when Skip then [:skip, exception]
+      when Assertion then [:failure, exception]
       else [:error, exception]
       end
     end

data/test/minitest/reporter_test.rb

@@ -46,4 +46,4 @@ module MiniTestReportersTest
       @reporter.puts('foo')
     end
   end
-end
+end

data/test/minitest/reporters_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+module MiniTestReportersTest
+  class ReportersTest < TestCase
+    test "chooses the Rubymine reporter when necessary" do
+      # Rubymine reporter complains when RubyMine libs are not available, so
+      # stub its #puts method out.
+      MiniTest::Unit.runner.output.stubs(:puts) 
+
+      reporters = Minitest::Reporters.choose_reporters [], { "RM_INFO" => "x" }
+      assert_instance_of MiniTest::Reporters::RubyMineReporter, reporters[0]
+
+      reporters = Minitest::Reporters.choose_reporters [], { "TEAMCITY_VERSION" => "x" }
+      assert_instance_of MiniTest::Reporters::RubyMineReporter, reporters[0]
+    end
+
+    test "chooses the TextMate reporter when necessary" do
+      reporters = Minitest::Reporters.choose_reporters [], {"TM_PID" => "x"}
+      assert_instance_of MiniTest::Reporters::RubyMateReporter, reporters[0]
+    end
+
+    test "chooses the console reporters when necessary" do
+      reporters = Minitest::Reporters.choose_reporters [MiniTest::Reporters::SpecReporter.new], {}
+      assert_instance_of MiniTest::Reporters::SpecReporter, reporters[0]
+    end
+  end
+end

data/test/test_helper.rb

@@ -18,21 +18,16 @@ module MiniTestReportersTest
   end
 end
 
-MiniTest::Unit.runner = MiniTest::SuiteRunner.new
-
 # 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!
-#
-# Personally, I like the progress reporter. Make sure you don't change that line
-# when you commit.
-if ENV["TM_PID"]
-  MiniTest::Unit.runner.reporters << MiniTest::Reporters::RubyMateReporter.new
-elsif ENV["RM_INFO"]
-  MiniTest::Unit.runner.reporters << MiniTest::Reporters::RubyMineReporter.new
-else
-  # MiniTest::Unit.runner.reporters << MiniTest::Reporters::DefaultReporter.new
-  # MiniTest::Unit.runner.reporters << MiniTest::Reporters::SpecReporter.new
-  MiniTest::Unit.runner.reporters << MiniTest::Reporters::ProgressReporter.new
-end
+
+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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minitest-reporters
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-17 00:00:00.000000000 Z
+date: 2012-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -175,6 +175,7 @@ files:
 - minitest-reporters.gemspec
 - test/minitest/backtrace_filter_test.rb
 - test/minitest/reporter_test.rb
+- test/minitest/reporters_test.rb
 - test/minitest/suite_runner_test.rb
 - test/minitest/test_runner_test.rb
 - test/support/fixtures/empty_test_fixture.rb
@@ -200,7 +201,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 596014274367585046
+      hash: -2178815342268569310
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -209,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 596014274367585046
+      hash: -2178815342268569310
 requirements: []
 rubyforge_project: minitest-reporters
 rubygems_version: 1.8.24
@@ -219,6 +220,7 @@ 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/minitest/suite_runner_test.rb
 - test/minitest/test_runner_test.rb
 - test/support/fixtures/empty_test_fixture.rb