minitest-heat 0.0.5 → 0.0.9

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,48 +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
 
@@ -78,25 +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)
-      output.heat_map(map)
+      # 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)
+
+      # 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.5
+  version: 0.0.9
 platform: ruby
 authors:
 - Garrett Dimon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-13 00:00:00.000000000 Z
+date: 2021-10-26 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,19 +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/location.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
@@ -128,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.

data/lib/minitest/heat/output/location.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Minitest
-  module Heat
-    class Output
-      class Location
-        attr_accessor :location
-
-        def initialize(location)
-          @location = location
-        end
-
-        def tokens
-        end
-
-        private
-      end
-    end
-  end
-end