minitest-heat 0.0.4 → 0.0.8

data/lib/minitest/heat/results.rb

@@ -2,104 +2,52 @@
 
 module Minitest
   module Heat
+    # A collection of test failures
     class Results
-
-      attr_reader :test_count,
-                  :assertion_count,
-                  :success_count,
-                  :issues,
-                  :start_time,
-                  :stop_time
+      attr_reader :issues, :heat_map
 
       def initialize
-        @test_count = 0
-        @assertion_count = 0
-        @success_count = 0
-        @issues = {
-          error: [],
-          broken: [],
-          failure: [],
-          skipped: [],
-          slow: []
-        }
-        @start_time = nil
-        @stop_time = nil
-      end
-
-      def start_timer!
-        @start_time = Minitest.clock_time
-      end
-
-      def stop_timer!
-        @stop_time = Minitest.clock_time
-      end
-
-      def total_time
-        delta = @stop_time - @start_time
-
-        # Don't return 0
-        delta.zero? ? 0.1 : delta
-      end
-
-      def tests_per_second
-        (assertion_count / total_time).round(2)
+        @issues = []
+        @heat_map = Heat::Map.new
       end
 
-      def assertions_per_second
-        (assertion_count / total_time).round(2)
+      def record(issue)
+        @issues.push(issue)
+        @heat_map.add(*issue.to_hit) if issue.hit?
       end
 
       def problems?
-        errors? || brokens? || failures? || skips?
+        errors.any? || brokens.any? || failures.any?
       end
 
       def errors
-        issues.fetch(:error) { [] }
+        @errors ||= select_issues(:error)
       end
 
       def brokens
-        issues.fetch(:broken) { [] }
+        @brokens ||= select_issues(:broken)
       end
 
       def failures
-        issues.fetch(:failure) { [] }
+        @failures ||= select_issues(:failure)
       end
 
       def skips
-        issues.fetch(:skipped) { [] }
-      end
-
-      def slows
-        issues
-          .fetch(:slow) { [] }
-          .sort { |issue| issue.time }
-          .reverse
-          .take(3)
-      end
-
-      def errors?
-        errors.any?
-      end
-
-      def brokens?
-        brokens.any?
+        @skips ||= select_issues(:skipped)
       end
 
-      def failures?
-        failures.any?
+      def painfuls
+        @painfuls ||= select_issues(:painful).sort_by(&:time).reverse
       end
 
-      def skips?
-        skips.any?
+      def slows
+        @slows ||= select_issues(:slow).sort_by(&:time).reverse
       end
 
-      def record(issue)
-        @test_count += 1
-        @assertion_count += issue.result.assertions
-        @success_count += 1 if issue.result.passed?
+      private
 
-        @issues[issue.type] ||= []
-        @issues[issue.type] << issue
+      def select_issues(issue_type)
+        issues.select { |issue| issue.type == issue_type }
       end
     end
   end

data/lib/minitest/heat/source.rb

@@ -51,10 +51,15 @@ module Minitest
       #
       # @return [type] [description]
       def file_lines
-        @raw_lines ||= File.readlines("#{Dir.pwd}#{filename}", chomp: true)
+        @raw_lines ||= File.readlines(filename, chomp: true)
         @raw_lines.pop while @raw_lines.last.strip.empty?
 
         @raw_lines
+      rescue Errno::ENOENT
+        # Occasionally, for a variety of reasons, a file can't be read. In those cases, it's best to
+        # return no source code lines rather than have the test suite raise an error unrelated to
+        # the code being tested becaues that gets confusing.
+        []
       end
 
       private

data/lib/minitest/heat/timer.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Minitest
+  module Heat
+    # Provides a timer to keep track of the full test suite duration and provide convenient methods
+    #   for calculating tests/second and assertions/second
+    class Timer
+      attr_reader :test_count, :assertion_count, :start_time, :stop_time
+
+      # Creates an instance of a timer to be used for the duration of a test suite run
+      #
+      # @return [self]
+      def initialize
+        @test_count = 0
+        @assertion_count = 0
+
+        @start_time = nil
+        @stop_time = nil
+      end
+
+      # Records the start time for the full test suite using `Minitest.clock_time`
+      #
+      # @return [Float] the Minitest.clock_time
+      def start!
+        @start_time = Minitest.clock_time
+      end
+
+      # Records the stop time for the full test suite using `Minitest.clock_time`
+      #
+      # @return [Float] the Minitest.clock_time
+      def stop!
+        @stop_time = Minitest.clock_time
+      end
+
+      # Calculates the total time take for the full test suite to run while ensuring it never
+      #   returns a zero that would be problematic as a denomitor in calculating average times
+      #
+      # @return [Float] the clocktime duration of the test suite run in seconds
+      def total_time
+        # Don't return 0. The time can end up being 0 for a new or realy fast test suite, and
+        # dividing by 0 doesn't go well when determining average time, so this ensures it uses a
+        # close-enough-but-not-zero value.
+        delta.zero? ? 0.01 : delta
+      end
+
+      # Records the test and assertion counts for a given test outcome
+      # @param count [Integer] the number of assertions from the test
+      #
+      # @return [void]
+      def increment_counts(count)
+        @test_count += 1
+        @assertion_count += count
+      end
+
+      # Provides a nice rounded answer for about how many tests were completed per second
+      #
+      # @return [Float] the average number of tests completed per second
+      def tests_per_second
+        (test_count / total_time).round(2)
+      end
+
+      # Provides a nice rounded answer for about how many assertions were completed per second
+      #
+      # @return [Float] the average number of assertions completed per second
+      def assertions_per_second
+        (assertion_count / total_time).round(2)
+      end
+
+      private
+
+      # The total time the test suite was running.
+      #
+      # @return [Float] the time in seconds elapsed between starting the timer and stopping it
+      def delta
+        return 0 unless start_time && stop_time
+
+        stop_time - start_time
+      end
+    end
+  end
+end

data/lib/minitest/heat/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Minitest
   module Heat
-    VERSION = "0.0.4"
+    VERSION = '0.0.8'
   end
 end

data/lib/minitest/heat.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
 require_relative 'heat/backtrace'
+require_relative 'heat/hit'
 require_relative 'heat/issue'
+require_relative 'heat/line'
 require_relative 'heat/location'
 require_relative 'heat/map'
 require_relative 'heat/output'
 require_relative 'heat/results'
 require_relative 'heat/source'
+require_relative 'heat/timer'
 require_relative 'heat/version'
 
 module Minitest

data/lib/minitest/heat_plugin.rb

@@ -3,12 +3,12 @@
 require_relative 'heat_reporter'
 
 module Minitest
-  def self.plugin_heat_options(opts, options)
-    opts.on '--show-fast', "Show failures as they happen instead of waiting for the entire suite." do
+  def self.plugin_heat_options(opts, _options)
+    opts.on '--show-fast', 'Show failures as they happen instead of waiting for the entire suite.' do
       # Heat.show_fast!
     end
 
-    # TODO options.
+    # TODO: options.
     # 1. Fail Fast
     # 2. Don't worry about skips.
     # 3. Skip coverage.
@@ -18,9 +18,9 @@ module Minitest
     io = options[:io]
 
     # Clean out the existing reporters.
-    self.reporter.reporters = []
+    reporter.reporters = []
 
     # Use Reviewer as the sole reporter.
-    self.reporter << HeatReporter.new(io, options)
+    reporter << HeatReporter.new(io, options)
   end
 end

data/lib/minitest/heat_reporter.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "heat"
+require_relative 'heat'
 
 module Minitest
   # Custom minitest reporter to proactively identify likely culprits in test failures by focusing on
@@ -29,49 +29,52 @@ module Minitest
   # Pulls from minitest-color as well:
   #   https://github.com/teoljungberg/minitest-color/blob/master/lib/minitest/color_plugin.rb
   class HeatReporter < AbstractReporter
-
     attr_reader :output,
                 :options,
-                :results,
-                :map
+                :timer,
+                :results
 
     def initialize(io = $stdout, options = {})
-      @output = Heat::Output.new(io)
       @options = options
 
-      @results = Heat::Results.new
-      @map = Heat::Map.new
+      @timer =    Heat::Timer.new
+      @results =  Heat::Results.new
+      @output =   Heat::Output.new(io)
     end
 
     # Starts reporting on the run.
     def start
-      output.puts
-      output.puts
-      @results.start_timer!
+      timer.start!
+
+      # A couple of blank lines to create some breathing room
+      output.newline
+      output.newline
     end
 
     # About to start running a test. This allows a reporter to show that it is starting or that we
     # are in the middle of a test run.
-    def prerecord(klass, name)
-    end
+    def prerecord(klass, name); end
 
     # Records the data from a result.
+    #
     # Minitest::Result source:
     #   https://github.com/seattlerb/minitest/blob/f4f57afaeb3a11bd0b86ab0757704cb78db96cf4/lib/minitest.rb#L504
     def record(result)
+      # Convert a Minitest Result into an "issue" to more consistently expose the data needed to
+      # adjust the failure output to the type of failure
       issue = Heat::Issue.new(result)
 
-      @results.record(issue)
-
-      @map.add(*issue.to_hit) if issue.hit?
+      timer.increment_counts(issue.result.assertions)
+      results.record(issue)
 
-      output.marker(issue.marker)
+      output.marker(issue.type)
     end
 
     # Outputs the summary of the run.
     def report
-      @results.stop_timer!
+      timer.stop!
 
+      # A couple of blank lines to create some breathing room
       output.newline
       output.newline
 
@@ -79,26 +82,45 @@ module Minitest
       #   pressing issues are displayed at the bottom of the report in order to reduce scrolling.
       #   This way, as you fix issues, the list gets shorter, and eventually the least critical
       #   issues will be displayed without scrolling once more problematic issues are resolved.
-      if results.failures.empty? && results.brokens.empty? && results.errors.empty? && results.skips.empty?
-        results.slows.each { |issue| output.issue_details(issue) }
-      end
+      %i[slows painfuls skips failures brokens errors].each do |issue_category|
+        next unless show?(issue_category)
 
-      if results.failures.empty? && results.brokens.empty? && results.errors.empty?
-        results.skips.each { |issue| output.issue_details(issue) }
+        results.send(issue_category).each { |issue| output.issue_details(issue) }
       end
 
-      results.failures.each { |issue| output.issue_details(issue) }
-      results.brokens.each { |issue| output.issue_details(issue) }
-      results.errors.each { |issue| output.issue_details(issue) }
+      # Display a short summary of the total issue counts fore ach category as well as performance
+      # details for the test suite as a whole
+      output.compact_summary(results, timer)
 
-      output.compact_summary(results)
+      # If there were issues, shows a short heat map summary of which files and lines were the most
+      # common sources of issues
+      output.heat_map(results)
 
-      output.heat_map(map)
+      # A blank line to create some breathing room
+      output.newline
     end
 
     # Did this run pass?
     def passed?
       results.errors.empty? && results.failures.empty?
     end
+
+    private
+
+    def no_problems?
+      !results.problems?
+    end
+
+    def no_problems_or_skips?
+      !results.problems? && !results.skips.any?
+    end
+
+    def show?(issue_category)
+      case issue_category
+      when :skips            then no_problems?
+      when :painfuls, :slows then no_problems_or_skips?
+      else true
+      end
+    end
   end
 end

data/minitest-heat.gemspec

@@ -21,8 +21,6 @@ Gem::Specification.new do |spec|
   spec.metadata['source_code_uri'] = 'https://github.com/garrettdimon/minitest-heat'
   spec.metadata['wiki_uri'] = 'https://github.com/garrettdimon/minitest-heat/wiki'
 
-
-
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
@@ -34,7 +32,11 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'minitest'
 
+  spec.add_development_dependency 'awesome_print'
   spec.add_development_dependency 'dead_end'
   spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-minitest'
+  spec.add_development_dependency 'rubocop-rake'
   spec.add_development_dependency 'simplecov'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest-heat
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.8
 platform: ruby
 authors:
 - Garrett Dimon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-31 00:00:00.000000000 Z
+date: 2021-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: dead_end
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +131,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -86,12 +143,22 @@ files:
 - bin/setup
 - lib/minitest/heat.rb
 - lib/minitest/heat/backtrace.rb
+- lib/minitest/heat/hit.rb
 - lib/minitest/heat/issue.rb
+- lib/minitest/heat/line.rb
 - lib/minitest/heat/location.rb
 - lib/minitest/heat/map.rb
 - lib/minitest/heat/output.rb
+- lib/minitest/heat/output/backtrace.rb
+- lib/minitest/heat/output/issue.rb
+- lib/minitest/heat/output/map.rb
+- lib/minitest/heat/output/marker.rb
+- lib/minitest/heat/output/results.rb
+- lib/minitest/heat/output/source_code.rb
+- lib/minitest/heat/output/token.rb
 - lib/minitest/heat/results.rb
 - lib/minitest/heat/source.rb
+- lib/minitest/heat/timer.rb
 - lib/minitest/heat/version.rb
 - lib/minitest/heat_plugin.rb
 - lib/minitest/heat_reporter.rb
@@ -121,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Presents test results in a visual manner to guide you to where to look first.