turn-again-reporter 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 743272e9560671bd13044dc51cd842bd2774b48a
-  data.tar.gz: 380c1e65d86cd26c0fe6f8b31ffa94143c94c158
+  metadata.gz: e5f99fd10fa85112b1e696162e5d67fbe02a9f1f
+  data.tar.gz: 9b94784ff8b792c65134ee6b37c7feea7f03ef95
 SHA512:
-  metadata.gz: 9527c77c41d1bd49c36ed679f6625541fc3f983f33884fed9c88bbd5cfd4a49166daceb1904f25efacd94b6ed3c90117f5892d596f1816c6d6a698056e3b6f54
-  data.tar.gz: 02700143e065b56797b32169c995c02aed5f1b6623b4d7b6438cec35c71cc20ddc2a1ffe34438c5a03e5dfea234ce612496b19e61f122d690149b3712e11eec2
+  metadata.gz: e550aa1c55ff3836f445ebe0639ad7259472dff85fa1a52f21ee6eb303ca685f5514cb523ff6c6e0463261800be05e34df1435ae7a1ade3dbc5e941d11365cd3
+  data.tar.gz: e1ab6a03166e564d9b56ef2147c5d3aa56cdf89a216daab4ca1c57f0cce8398f6c515dda3031621e566cbea7000c6564d948aaff2504313d702d0929c48f4e1e

data/README.md

@@ -21,10 +21,11 @@ require 'minitest/reporters'
 Minitest::Reporters.use! Minitest::Reporters::TurnAgainReporter.new
 ```
 
-TurnAgainReporter's initializer will pass on all existing Minitest::Reporters::Base keyword arguments, such as `color: true` but uses two of its own for some customization:
+TurnAgainReporter's initializer will pass on all existing Minitest::Reporters::BaseReporter keyword arguments, such as `color: true` but uses some of its own for some customization:
 
   1. The `indent` keyword can specify the indentation from the left of the console when running. The default is 4 to faithfully mimic turn itself.
   2. *Unlike turn*, the duration measurements in next to the test status do not include hours, because the vast majority of tests do not require a whole hour for a single test case. However, hours can be re-enabled by passing the `:hours` keyword as `true`.
+  3. The colors that correspond to the test status flags (`PASS`, `FAIL`, `ERROR`, `SKIP`) can be customized by passing in the symbol of an ansi primary color names for the options `pass_color`, `fail_color`, `error_color` and `skip_color`, respectively. Valid names for ANSI primary colors are `:black`, `:red`, `:green`, `:yellow`, `:blue`, `:magenta`, `:cyan`, and `:white`. Additionally `:no_color` can be specified if you want to turn off color only for a specific status.
 
 An example of these options:
 
@@ -32,14 +33,24 @@ An example of these options:
 
 Minitest::Reporters.use!(
   Minitest::Reporters::TurnAgainReporter.new(
-    color: true, hours: true, indent: 2
+    hours: true, indent: 2, skip_color: :yellow
   ))
 ```
 
 
 ## Demonstration tests
 
-Rake test tasks exist for demonstrating the output of this gem. The usual `rake test` task will simply run all of the demonstration files. Because this necessarily includes purposeful errors and failures, will fail. Please do not file any issues related to these intended failures. More granularly, there are tasks with the names `pass-format`, `fail-format`, `error-format` and `skip-format` which demonstrate their respective formatting.
+Rake test tasks exist for demonstrating the output of this gem. Current tasks are:
+
+- `rake pass-format`
+- `rake fail-format`
+- `rake error-format`
+- `rake skip-format`
+- `rake crazy-colors`
+- `rake indent-option`
+- `rake hours-option`
+
+The usual `rake test` task will simply run all of the demonstration files together. This is not particularly useful. Because this necessarily includes purposeful errors and failures, will fail. Please do not file any issues related to these intended failures. Furthermore, because individual demonstration tests set different configuration settings for the whole suite, subsequent runs may have different formatting depending on which demonstration gets run first (as its settings take precendent).
 
 
 ## Installation

data/Rakefile

@@ -6,22 +6,19 @@ Rake::TestTask.new do |t|
   t.test_files  = Dir[File.join(File.dirname(__FILE__), 'test/**/*test.rb')]
 end
 
-Rake::TestTask.new("pass-format") do |t|
-  t.libs        << "test"
-  t.test_files  = [File.join(File.dirname(__FILE__), 'test/integration/pass_format_test.rb')]
-end
-
-Rake::TestTask.new("fail-format") do |t|
-  t.libs        << "test"
-  t.test_files  = [File.join(File.dirname(__FILE__), 'test/integration/fail_format_test.rb')]
-end
+demonstrations = [
+  ["pass-format",   "pass_format_test.rb"   ],
+  ["fail-format",   "fail_format_test.rb"   ],
+  ["error-format",  "error_format_test.rb"  ],
+  ["skip-format",   "skip_format_test.rb"   ],
+  ["crazy-colors",  "color_options_test.rb" ],
+  ["indent-option", "indent_option_test.rb" ],
+  ["hours-option",  "hours_option_test.rb"  ],
+]
 
-Rake::TestTask.new("error-format") do |t|
-  t.libs        << "test"
-  t.test_files  = [File.join(File.dirname(__FILE__), 'test/integration/error_format_test.rb')]
-end
-
-Rake::TestTask.new("skip-format") do |t|
-  t.libs        << "test"
-  t.test_files  = [File.join(File.dirname(__FILE__), 'test/integration/skip_format_test.rb')]
+demonstrations.each do |task_name, test_file|
+  Rake::TestTask.new(task_name) do |t|
+    t.libs        << "test"
+    t.test_files  = [File.join(File.dirname(__FILE__), "test/integration/#{test_file}")]
+  end
 end

data/lib/minitest/reporters/turn_again_reporter.rb

@@ -27,30 +27,81 @@ module Minitest
       include ANSI::Code
       include RelativePosition
 
-      attr_reader :hours, :indent
+      attr_reader :hours, :indent,
+                  :pass_color, :fail_color, :error_color, :skip_color
 
       def initialize(options = {})
-        @hours  = !!options.fetch(:hours, false)
-        @indent =   options.fetch(:indent, 4)
+        options       = option_defaults.merge(options)
+        @hours        = !!options.fetch(:hours)
+        @indent       = options.fetch(:indent)
+        @pass_color   = options.fetch(:pass_color)
+        @fail_color   = options.fetch(:fail_color)
+        @error_color  = options.fetch(:error_color)
+        @skip_color   = options.fetch(:skip_color)
         super(options)
       end
 
+
+      def option_defaults
+        { hours:        false,
+          indent:       4,
+          pass_color:   :green,
+          fail_color:   :red,
+          error_color:  :yellow,
+          skip_color:   :cyan,
+        }
+      end
+
+
       def start
         super
         puts('Started with run options %s' % options[:args])
         puts
       end
 
+
       def report
         super
+
+        passed = count - (failures + errors + skips)
+
         puts('Finished in %.5fs' % total_time)
-        print('%d tests, %d assertions, ' % [count, assertions])
-        color = failures.zero? && errors.zero? ? :green : :red
-        print(send(color) { '%d failures, %d errors, ' } % [failures, errors])
-        print(yellow { '%d skips' } % skips)
         puts
+        print(bold { '%d tests' } % count)
+        print(', ')
+        print(send(report_passed_color)    { '%d passed' }   % passed)
+        print(', ')
+        print(send(report_failures_color)  { '%d failures' } % failures)
+        print(', ')
+        print(send(report_errors_color)    { '%d errors' }   % errors)
+        print(', ')
+        print(send(report_skips_color)     { '%d skips' }    % skips)
+        print(', ')
+        print('%d assertions' % assertions)
+        puts
+      end
+
+
+      def print_colored_status(test)
+        print_status = -> { pad_mark( result(test).to_s.upcase ) }
+        if test.passed?
+          print(send(pass_color,  &print_status))
+        elsif test.skipped?
+          print(send(skip_color,  &print_status))
+        elsif test.error?
+          print(send(error_color, &print_status))
+        else
+          print(send(fail_color,  &print_status))
+        end
       end
 
+      ##
+      # To match the interface of printing of colors via methods with blocks.
+      def no_color(&block)
+        block.call
+      end
+
+
       def record(test)
         super
         print (' ' * indent)
@@ -64,16 +115,56 @@ module Minitest
         end
       end
 
+      ##
+      # Divergence from Minitest::Reporters::SpecReporter is that here we are
+      # printing the exception name with padding, so that it doesn't break the
+      # visual flow/alignment of all the vertical, colored test result statuses.
+      def print_info(e, name=true)
+        print_with_info_padding("#{e.exception.class.to_s}: ") if name
+        e.message.each_line { |line| print_with_info_padding(line) }
+
+        # When e is a Minitest::UnexpectedError, the filtered backtrace is already part of the message printed out
+        # by the previous line. In that case, and that case only, skip the backtrace output.
+        unless e.is_a?(MiniTest::UnexpectedError)
+          trace = filter_backtrace(e.backtrace)
+          trace.each { |line| print_with_info_padding(line) }
+        end
+      end
+
+
 protected ######################################################################
 
+
+      def report_passed_color
+        failures.zero? && errors.zero? ? pass_color : :no_color
+      end
+
+
+      def report_failures_color
+        failures.zero? ? :no_color : fail_color
+      end
+
+
+      def report_errors_color
+        errors.zero? ? :no_color : error_color
+      end
+
+
+      def report_skips_color
+        skips.zero? ? :no_color : skip_color
+      end
+
+
       def before_suite(suite)
         puts suite
       end
 
+
       def after_suite(suite)
         puts
       end
 
+
       def format_time(t)
         if hours
           ' (%02d:%02d:%06.3f) ' % [

data/lib/minitest/reporters/turn_again_reporter/version.rb

@@ -30,7 +30,7 @@ end
 module Minitest
   module Reporters
     class TurnAgainReporter < BaseReporter
-      VERSION = "1.0.2"
+      VERSION = "1.1.0"
     end
   end
 end

data/test/integration/color_options_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+Minitest::Reporters.use!(Minitest::Reporters::TurnAgainReporter.new(
+  pass_color:   :blue,
+  fail_color:   :magenta,
+  error_color:  :cyan,
+  skip_color:   :black
+))
+
+class ColorOptionsTest < Minitest::Test
+
+  def test_the_truth
+    assert(true)
+  end
+
+  def test_failing_the_truth
+    refute(true)
+  end
+
+  def test_triggering_an_error
+    Object.new.triggernomethoderror
+  end
+
+  def test_skip_color
+    skip
+  end
+
+end

data/test/integration/hours_option_test.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+Minitest::Reporters.use!(Minitest::Reporters::TurnAgainReporter.new(
+  hours: true
+))
+
+class HoursOptionTest < Minitest::Test
+
+  def test_the_truth_with_hours_in_timestamp
+    assert(true)
+  end
+
+end

data/test/integration/indent_option_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+Minitest::Reporters.use!(Minitest::Reporters::TurnAgainReporter.new(
+  indent: 12
+))
+
+class IndentOptionTest < Minitest::Test
+
+  def test_waaay_over_there
+    assert(true)
+  end
+
+
+  def test_this_is_actually_pretty_gross
+    assert(true)
+  end
+
+
+  def test_an_obscene_waste_of_space
+    assert(true)
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turn-again-reporter
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Paul Kwiatkowski
@@ -76,8 +76,11 @@ files:
 - Rakefile
 - lib/minitest/reporters/turn_again_reporter.rb
 - lib/minitest/reporters/turn_again_reporter/version.rb
+- test/integration/color_options_test.rb
 - test/integration/error_format_test.rb
 - test/integration/fail_format_test.rb
+- test/integration/hours_option_test.rb
+- test/integration/indent_option_test.rb
 - test/integration/pass_format_test.rb
 - test/integration/skip_format_test.rb
 - test/test_helper.rb
@@ -108,8 +111,11 @@ specification_version: 4
 summary: A reporter for the minitest-reporters gem that more accurately mimics the
   behavior of the turn gem.
 test_files:
+- test/integration/color_options_test.rb
 - test/integration/error_format_test.rb
 - test/integration/fail_format_test.rb
+- test/integration/hours_option_test.rb
+- test/integration/indent_option_test.rb
 - test/integration/pass_format_test.rb
 - test/integration/skip_format_test.rb
 - test/test_helper.rb