minitest-reporters 1.1.6 → 1.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6db7f6637aba345b2c1243184ea555e733820bd
-  data.tar.gz: b2e10ea9d1a39f4bc08ff1c9c1a3b51e8a83bdd7
+  metadata.gz: 47b21650aa917c323c0dda549bbf596f3146f390
+  data.tar.gz: 178821e133b2c7472df9a37c800f681078f3c636
 SHA512:
-  metadata.gz: 74d908229793593e956ffc86ade1ff4fab5f3763bd8cd942917e7f5bf0b3c83fe8780f41761e9410e582f76ca4abf4bdf24ccdd3dc4b0041fb9dc8b8579c6fb9
-  data.tar.gz: 552b49c0f730980fdc976c8a814a5b18d662723fa7c2d6841d8875d676611f825053a8bc04a62ecaf55110f252808416f7ebd7c57d9e7e4e142d25150e9996a3
+  metadata.gz: d9014a80d115ad6531f6933c891ae9fc910442ca3a759e7432ff145f72829240ca1fca5f9aac9ebd0b57b52e6a629131ab900f9991faed835f15653e57c82360
+  data.tar.gz: fa0b84409d297219122aea2b5f55496127e250ac28400faffd4a38439fd44cbbc9d8a319f4905cd3ae744e6384b6a70eae3b45292ade68651b9df67ffe639dab

data/README.md

@@ -45,6 +45,7 @@ Minitest::Reporters::ProgressReporter # => Fuubar-like output with a progress ba
 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
+Minitest::Reporters::MeanTimeReporter # => Produces a report summary showing the slowest running tests
 ```
 
 Options can be passed to these reporters at construction-time, e.g. to force

data/lib/minitest/reporters/ansi.rb

@@ -4,6 +4,7 @@ module Minitest
       module Code
 
         def self.color?
+          return false if ENV['MINITEST_REPORTERS_MONO']
           color_terminal = ENV['TERM'].to_s.downcase.include?("color")
           $stdout.tty? || color_terminal
         end

data/lib/minitest/reporters/mean_time_reporter.rb

@@ -23,6 +23,9 @@ module Minitest
     #
     class MeanTimeReporter < Minitest::Reporters::DefaultReporter
 
+      class InvalidOrder < StandardError; end
+      class InvalidSortColumn < StandardError; end
+
       # Reset the statistics file for this reporter. Called via a rake task:
       #
       #     rake reset_statistics
@@ -37,6 +40,13 @@ module Minitest
       #   by description. Defaults to '/tmp/minitest_reporters_previous_run'.
       # @option report_filename [String] Contains the parsed results for the
       #   last test run. Defaults to '/tmp/minitest_reporters_report'.
+      # @option show_count [Fixnum] The number of tests to show in the report
+      #   summary at the end of the test run. Default is 15.
+      # @option sort_column [Symbol] One of :avg (default), :min, :max, :last.
+      #   Determines the column by which the report summary is sorted.
+      # @option order [Symbol] One of :desc (default), or :asc. By default the
+      #   report summary is listed slowest to fastest (:desc). :asc will order
+      #   the report summary as fastest to slowest.
       # @return [Minitest::Reporters::MeanTimeReporter]
       def initialize(options = {})
         super
@@ -94,7 +104,9 @@ module Minitest
       #   run.
       def defaults
         {
+          order:                  :desc,
           show_count:             15,
+          sort_column:            :avg,
           previous_runs_filename: '/tmp/minitest_reporters_previous_run',
           report_filename:        '/tmp/minitest_reporters_report',
         }
@@ -104,7 +116,9 @@ module Minitest
       #
       # @return [String]
       def report_title
-        "\n\e[4mMinitest Reporters: Mean Time Report\e[24m (Samples: #{samples})\n"
+        "\n\e[4mMinitest Reporters: Mean Time Report\e[24m " \
+        "(Samples: #{samples}, Order: #{sort_column.inspect} " \
+        "#{order.inspect})\n"
       end
 
       # The report itself. Displays statistics about all runs, ideal for use
@@ -113,22 +127,43 @@ module Minitest
       #
       # @return [String]
       def report_body
+        order_sorted_body.each_with_object([]) do |result, obj|
+          rating = rate(result[:last], result[:min], result[:max])
+
+          obj << "#{avg_label} #{result[:avg]} " \
+                 "#{min_label} #{result[:min]} " \
+                 "#{max_label} #{result[:max]} " \
+                 "#{run_label(rating)} #{result[:last]} " \
+                 "#{des_label} #{result[:desc]}\n"
+        end.join
+      end
+
+      # @return [String] All of the column-sorted results sorted by the :order
+      #   option. (Defaults to :desc).
+      def order_sorted_body
+        if desc?
+          column_sorted_body.reverse
+
+        elsif asc?
+          column_sorted_body
+
+        end
+      end
+
+      # @return [Array<Hash<Symbol => String>>] All of the results sorted by
+      #   the :sort_column option. (Defaults to :avg).
+      def column_sorted_body
         previous_run.each_with_object([]) do |(description, timings), obj|
           size = Array(timings).size
           sum  = Array(timings).inject { |total, x| total + x }
-          avg  = (sum / size).round(9).to_s.ljust(12)
-          min  = Array(timings).min.round(9).to_s.ljust(12)
-          max  = Array(timings).max.round(9).to_s.ljust(12)
-          run  = Array(timings).last.round(9).to_s.ljust(12)
-
-          rating = rate(run, min, max)
-
-          obj << "#{avg_label} #{avg} " \
-                 "#{min_label} #{min} " \
-                 "#{max_label} #{max} " \
-                 "#{run_label(rating)} #{run} " \
-                 "#{des_label} #{description}\n"
-        end.sort.reverse.join
+          obj << {
+            avg:  (sum / size).round(9).to_s.ljust(12),
+            min:  Array(timings).min.round(9).to_s.ljust(12),
+            max:  Array(timings).max.round(9).to_s.ljust(12),
+            last: Array(timings).last.round(9).to_s.ljust(12),
+            desc: description,
+          }
+        end.sort_by { |k| k[sort_column] }
       end
 
       # @return [Hash]
@@ -215,9 +250,11 @@ module Minitest
       end
 
       # Creates a new report file in the 'report_filename'. This file contains
-      # a line for each test of the following example format:
+      # a line for each test of the following example format: (this is a single
+      # line despite explicit wrapping)
       #
-      # Avg: 0.0555555 Min: 0.0498765 Max: 0.0612345 Last: 0.0499421 Description: The test name
+      # Avg: 0.0555555 Min: 0.0498765 Max: 0.0612345 Last: 0.0499421
+      # Description: The test name
       #
       # Note however the timings are to 9 decimal places, and padded to 12
       # characters and each label is coloured, Avg (yellow), Min (green),
@@ -288,6 +325,48 @@ module Minitest
         end
       end
 
+      # @return [Boolean] Whether the given :order option is :asc.
+      def asc?
+        order == :asc
+      end
+
+      # @return [Boolean] Whether the given :order option is :desc (default).
+      def desc?
+        order == :desc
+      end
+
+      # @raise [Minitest::Reporters::MeanTimeReporter::InvalidOrder]
+      #   When the given :order option is invalid.
+      # @return [Symbol] The :order option, or by default; :desc.
+      def order
+        orders = [:desc, :asc]
+
+        if orders.include?(options[:order])
+          options[:order]
+
+        else
+          fail Minitest::Reporters::MeanTimeReporter::InvalidOrder,
+               "`:order` option must be one of #{orders.inspect}."
+
+        end
+      end
+
+      # @raise [Minitest::Reporters::MeanTimeReporter::InvalidSortColumn]
+      #   When the given :sort_column option is invalid.
+      # @return [Symbol] The :sort_column option, or by default; :avg.
+      def sort_column
+        sort_columns = [:avg, :min, :max, :last]
+
+        if sort_columns.include?(options[:sort_column])
+          options[:sort_column]
+
+        else
+          fail Minitest::Reporters::MeanTimeReporter::InvalidSortColumn,
+               "`:sort_column` option must be one of #{sort_columns.inspect}."
+
+        end
+      end
+
     end
   end
 end

data/lib/minitest/reporters/version.rb

@@ -1,5 +1,5 @@
 module Minitest
   module Reporters
-    VERSION = '1.1.6'
+    VERSION = '1.1.7'
   end
 end

data/test/test_helper.rb

@@ -2,6 +2,7 @@ require "bundler/setup"
 require "minitest/autorun"
 require "minitest/reporters"
 
+ENV['MINITEST_REPORTERS_MONO'] = 'yes'
 module MinitestReportersTest
   class TestCase < Minitest::Test
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest-reporters
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 1.1.7
 platform: ruby
 authors:
 - Alexander Kern
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-24 00:00:00.000000000 Z
+date: 2015-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest