minitest-reporters 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d48a1b9514a04f37696269c76dd53fb7dd13f68
-  data.tar.gz: ff6ac4545a2139480ef0647d9fa2dc4f430d4752
+  metadata.gz: 846ef0a08df37769401f230f5de0ecbb833eef54
+  data.tar.gz: 1fd0f582c07365a9524cfd5bfe2462f62fbe67a6
 SHA512:
-  metadata.gz: 865d4f7ec731d03dd6aa91829f8f449e8597824c2b740ba0a264e80142ef3bc8ef1cdee661e9625f4fc29863601911dc9e0093e0ff872a6581fbea791d307263
-  data.tar.gz: fcea708363825277b50760957a29100dfe23cc5abff914c78712675cc72a3149aa7226ff4fbb367c33c4a569f3921c14c55fb588afdc02d6ec0a077222274df0
+  metadata.gz: 3ca327e55a81401732fe28cd64b67e7a03e1a4242714556465bed2e9302e95f6c44bbbcc05772bc266e163138913e11f8b039c55e1ea24f8b070db34c33bf219
+  data.tar.gz: 2e765106869fb020d41269e54f170649d3ddc6e657e9f597e429281018ccdb8650ed732911378213d7d9d583318de29b83ca1621a5cf04f97bdfd5bcd9ddc732

data/Rakefile

@@ -35,7 +35,8 @@ task :gallery do
     "RubyMateReporter",
     "SpecReporter",
     "RubyMineReporter",
-    "HtmlReporter"
+    "HtmlReporter",
+    "MeanTimeReporter",
   ].each do |reporter|
     puts
     puts "-" * 72
@@ -50,3 +51,10 @@ task :gallery do
     sh "cat test/reports/*" if reporter == "JUnitReporter"
   end
 end
+
+task :reset_statistics do
+  require 'minitest/reporters/mean_time_reporter'
+  Minitest::Reporters::MeanTimeReporter.reset_statistics!
+  puts "The mean time reporter statistics have been reset."
+  exit 0
+end

data/lib/minitest/reporters/mean_time_reporter.rb

@@ -0,0 +1,259 @@
+require 'minitest/reporters'
+require 'yaml'
+
+module Minitest
+  module Reporters
+
+    # This reporter creates a report providing the average (mean), minimum and
+    # maximum times for a test to run. Running this for all your tests will
+    # allow you to:
+    #
+    # 1) Identify the slowest running tests over time as potential candidates
+    #    for improvements or refactoring.
+    # 2) Identify (and fix) regressions in test run speed caused by changes to
+    #    your tests or algorithms in your code.
+    # 3) Provide an abundance of statistics to enjoy.
+    #
+    # This is achieved by creating a (configurable) 'previous runs' statistics
+    # file which is parsed at the end of each run to provide a new
+    # (configurable) report. These statistics can be reset at any time by using
+    # a simple rake task:
+    #
+    #     rake reset_statistics
+    #
+    class MeanTimeReporter < Minitest::Reporters::DefaultReporter
+
+      # Reset the statistics file for this reporter. Called via a rake task:
+      #
+      #     rake reset_statistics
+      #
+      # @return [Boolean]
+      def self.reset_statistics!
+        new.reset_statistics!
+      end
+
+      # @param options [Hash]
+      # @option previous_runs_filename [String] Contains the times for each test
+      #   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'.
+      # @return [Minitest::Reporters::MeanTimeReporter]
+      def initialize(options = {})
+        super
+
+        @all_suite_times = []
+      end
+
+      # Copies the suite times from the
+      # {Minitest::Reporters::DefaultReporter#after_suite} method, making them
+      # available to this class.
+      #
+      # @return [Hash<String => Float>]
+      def after_suite(suite)
+        super
+
+        @all_suite_times = @suite_times
+      end
+
+      # Runs the {Minitest::Reporters::DefaultReporter#report} method and then
+      # enhances it by storing the results to the 'previous_runs_filename' and
+      # outputs the parsed results to both the 'report_filename' and the
+      # terminal.
+      #
+      def report
+        super
+
+        create_or_update_previous_runs!
+
+        create_new_report!
+
+        write_to_screen!
+      end
+
+      # Resets the 'previous runs' file, essentially removing all previous
+      # statistics gathered.
+      #
+      # @return [void]
+      def reset_statistics!
+        File.open(previous_runs_filename, 'w+') { |f| f.write('') }
+      end
+
+      protected
+
+      attr_accessor :all_suite_times
+
+      private
+
+      # @return [Hash<String => Float>]
+      def current_run
+        Hash[all_suite_times]
+      end
+
+      # @return [Hash] Sets default values for the filenames used by this class,
+      #   and the number of tests to output to output to the screen after each
+      #   run.
+      def defaults
+        {
+          count:                  15,
+          previous_runs_filename: '/tmp/minitest_reporters_previous_run',
+          report_filename:        '/tmp/minitest_reporters_report',
+        }
+      end
+
+      # Added to the top of the report file and to the screen output.
+      #
+      # @return [String]
+      def report_title
+        "\n\e[4mMinitest Reporters: Mean Time Report\e[24m (Samples: #{samples})\n"
+      end
+
+      # The report itself. Displays statistics about all runs, ideal for use
+      # with the Unix 'head' command. Listed in slowest average descending
+      # order.
+      #
+      # @return [String]
+      def report_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.to_s.ljust(12)
+          max  = Array(timings).max.to_s.ljust(12)
+
+          obj << "#{avg_label} #{avg} " \
+                 "#{min_label} #{min} " \
+                 "#{max_label} #{max} " \
+                 "#{des_label} #{description}\n"
+        end.sort.reverse.join
+      end
+
+      # @return [Hash]
+      def options
+        defaults.merge!(@options)
+      end
+
+      # @return [Fixnum] The number of tests to output to output to the screen
+      #   after each run.
+      def count
+        options[:count]
+      end
+
+      # @return [Hash<String => Array<Float>]
+      def previous_run
+        @previous_run ||= YAML.load_file(previous_runs_filename)
+      end
+
+      # @return [String] The path to the file which contains all the durations
+      #   for each test run. The previous runs file is in YAML format, using the
+      #   test name for the key and an array containing the time taken to run
+      #   this test for values.
+      def previous_runs_filename
+        options[:previous_runs_filename]
+      end
+
+      # Returns a boolean indicating whether a previous runs file exists.
+      #
+      # @return [Boolean]
+      def previously_ran?
+        File.exist?(previous_runs_filename)
+      end
+
+      # @return [String] The path to the file which contains the parsed test
+      #   results. The results file contains a line for each test with the
+      #   average time of the test, the minimum time the test took to run,
+      #   the maximum time the test took to run and a description of the test
+      #   (which is the test name as emitted by Minitest).
+      def report_filename
+        options[:report_filename]
+      end
+
+      # A barbaric way to find out how many runs are in the previous runs file;
+      # this method takes the first test listed, and counts its samples
+      # trusting (naively) all runs to be the same number of samples. This will
+      # produce incorrect averages when new tests are added, so it is advised
+      # to restart the statistics by removing the 'previous runs' file. A rake
+      # task is provided to make this more convenient.
+      #
+      #    rake reset_statistics
+      #
+      # @return [Fixnum]
+      def samples
+        return 1 unless previous_run.first[1].is_a?(Array)
+
+        previous_run.first[1].size
+      end
+
+      # Creates a new 'previous runs' file, or updates the existing one with
+      # the latest timings.
+      #
+      # @return [void]
+      def create_or_update_previous_runs!
+        if previously_ran?
+          current_run.each do |description, elapsed|
+          new_times = if previous_run["#{description}"]
+                        Array(previous_run["#{description}"]) << elapsed
+
+                      else
+                        Array(elapsed)
+
+                      end
+
+            previous_run.store("#{description}", new_times)
+          end
+
+          File.write(previous_runs_filename, previous_run.to_yaml)
+
+        else
+
+          File.write(previous_runs_filename, current_run.to_yaml)
+
+        end
+      end
+
+      # Creates a new report file in the 'report_filename'. This file contains
+      # a line for each test of the following example format:
+      #
+      # Avg: 0.0555555 Min: 0.0498765 Max: 0.0612345 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),
+      # Max (red) and Description (blue). It looks pretty!
+      #
+      # @return [void]
+      def create_new_report!
+        File.write(report_filename, report_title + report_body)
+      end
+
+      # Writes a number of tests (configured via the 'count' option) to the
+      # screen after creating the report. See '#create_new_report!' for example
+      # output information.
+      #
+      # @return [void]
+      def write_to_screen!
+        puts report_title
+        puts report_body.lines.take(count)
+      end
+
+      # @return [String] A yellow 'Avg:' label.
+      def avg_label
+        "\e[33mAvg:\e[39m"
+      end
+
+      # @return [String] A blue 'Description:' label.
+      def des_label
+        "\e[34mDescription:\e[39m"
+      end
+
+      # @return [String] A red 'Max:' label.
+      def max_label
+        "\e[31mMax:\e[39m"
+      end
+
+      # @return [String] A green 'Min:' label.
+      def min_label
+        "\e[32mMin:\e[39m"
+      end
+
+    end
+  end
+end

data/lib/minitest/reporters/version.rb

@@ -1,5 +1,5 @@
 module Minitest
   module Reporters
-    VERSION = '1.1.1'
+    VERSION = '1.1.2'
   end
 end

data/test/fixtures/mean_time_test.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'minitest/reporters/mean_time_reporter'
+
+Minitest::Reporters.use! Minitest::Reporters::MeanTimeReporter.new
+
+require_relative '../gallery/good_test'

data/test/integration/reporters/mean_time_reporter_test.rb

@@ -0,0 +1,7 @@
+require_relative "../../test_helper"
+
+module MinitestReportersTest
+  class MeanTimeReporterTest < TestCase
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest-reporters
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Alexander Kern
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-22 00:00:00.000000000 Z
+date: 2015-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -110,6 +110,7 @@ files:
 - README.md
 - Rakefile
 - assets/default-reporter.png
+- assets/mean_time_reporter.png
 - assets/progress-reporter.png
 - assets/spec-reporter.png
 - lib/minitest/extensible_backtrace_filter.rb
@@ -122,6 +123,7 @@ files:
 - lib/minitest/reporters/default_reporter.rb
 - lib/minitest/reporters/html_reporter.rb
 - lib/minitest/reporters/junit_reporter.rb
+- lib/minitest/reporters/mean_time_reporter.rb
 - lib/minitest/reporters/progress_reporter.rb
 - lib/minitest/reporters/ruby_mate_reporter.rb
 - lib/minitest/reporters/rubymine_reporter.rb
@@ -130,12 +132,14 @@ files:
 - lib/minitest/templates/index.html.erb
 - minitest-reporters.gemspec
 - test/fixtures/junit_filename_bug_example_test.rb
+- test/fixtures/mean_time_test.rb
 - test/fixtures/progress_detailed_skip_test.rb
 - test/fixtures/progress_test.rb
 - test/fixtures/sample_test.rb
 - test/gallery/bad_test.rb
 - test/gallery/good_test.rb
 - test/integration/reporters/junit_reporter_test.rb
+- test/integration/reporters/mean_time_reporter_test.rb
 - test/integration/reporters/progress_reporter_test.rb
 - test/test_helper.rb
 - test/unit/minitest/extensible_backtrace_filter_test.rb
@@ -166,12 +170,14 @@ specification_version: 4
 summary: Create customizable Minitest output formats
 test_files:
 - test/fixtures/junit_filename_bug_example_test.rb
+- test/fixtures/mean_time_test.rb
 - test/fixtures/progress_detailed_skip_test.rb
 - test/fixtures/progress_test.rb
 - test/fixtures/sample_test.rb
 - test/gallery/bad_test.rb
 - test/gallery/good_test.rb
 - test/integration/reporters/junit_reporter_test.rb
+- test/integration/reporters/mean_time_reporter_test.rb
 - test/integration/reporters/progress_reporter_test.rb
 - test/test_helper.rb
 - test/unit/minitest/extensible_backtrace_filter_test.rb