minitest-heat 0.0.14 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4009f20d5e5d4d92d8e0796e853df4da059e3ec7a6b49cae98a8ce71352316fd
-  data.tar.gz: adf5692ab8af5f08ec97607f43ac8f454ad91fb62d15d9f867ee354d920a7a45
+  metadata.gz: 887dc01f3a08341f1e88cb24b539d0843cdce81fdb49246fbce8af875ff00d3f
+  data.tar.gz: 875d197ab5c65c2cb85b192201375be653ba30da2fc91896b4a3e61702cacefd
 SHA512:
-  metadata.gz: 8e0d422fbc88d79598464f1640ffb7b6ea3e8ab7324e85f9a059a61f1d14e6c8792f277525dadf6cf81ee493168708dd0eb1a3f9b836b7efd0af3e73b959f25b
-  data.tar.gz: dfa2aa6267e1c026da29b93e1e7ab73f4a1fc65d9d1132228efff315622b742ebe40074eec7a639e6246b7bad27f14a31feee647c9c1274b77d8a57b8d8ed22b
+  metadata.gz: 6ef73c9df5b91b5950cc444f6ea7a18ccd867bda4fbdb015b8d713eaebe91b925a2cfb48b596a43a0d36af023dcb04f5c8ec0803602ab27bf709372fe6f9b0f3
+  data.tar.gz: d338944e9d32e8ec326cce9dbe861c5b8bec408bb455e4e984d45567ef9d9c5af9154f4475c2862ddc43778c95d8e58f12beef8757aa37f6b76d91da1b17a4c5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    minitest-heat (0.0.14)
+    minitest-heat (1.0.0)
       minitest
 
 GEM

data/README.md

@@ -1,4 +1,4 @@
-# Minitest::Heat
+# 🔥 Minitest::Heat 🔥
 Minitest::Heat helps you identify problems faster so you can more efficiently resolve test failures. It does this through a few different methods.
 
 It collects failures and inspects backtraces to identify patterns and provide a heat map summary of the files and line numbers that most frequently appear to be the causes of issues.

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

@@ -38,7 +38,7 @@ module Minitest
               break unless traces.any?
 
               # A short summary explaining the details that will follow
-              @tokens << [[:muted, "  Issues on Line #{line_number} initially triggered from these locations:"]]
+              @tokens << [[:default, "  Line #{line_number}"], [:muted, ' issues triggered from:']]
 
               # The last relevant location for each error's backtrace
               @tokens += origination_sources(traces)
@@ -51,23 +51,27 @@ module Minitest
         private
 
         def origination_sources(traces)
-          # 1. Sort the traces by the most recent line number so they're displayed in numeric order
-          # 2. Get the final relevant location from the trace
+          # 1. Only pull the traces that have proper locations
+          # 2. Sort the traces by the most recent line number so they're displayed in numeric order
+          # 3. Get the final relevant location from the trace
           traces.
+            select  { |trace| trace.locations.any? }.
             sort_by { |trace| trace.locations.last.line_number }.
             map     { |trace| origination_location_token(trace) }
         end
 
         def file_summary_tokens(hit)
           pathname_tokens = pathname(hit)
-          line_number_list_tokens = sorted_line_number_list(hit)
+          line_number_list_tokens = line_number_tokens_for_hit(hit)
 
           [*pathname_tokens, *line_number_list_tokens]
         end
 
         def origination_location_token(trace)
           # The earliest project line from the backtrace—this is probabyl wholly incorrect in terms
-          # of what would be the most helpful line to display, but it's a start.
+          # of what would be the most helpful line to display, but it's a start. Otherwise, the
+          # logic will need to compare all traces for the issue and find the unique origination
+          # lines
           location = trace.locations.last
 
           [
@@ -137,8 +141,10 @@ module Minitest
             line_numbers_for_issue_type = hit.issues.fetch(issue_type) { [] }
 
             # Build the list of tokens representing styled line numbers
-            line_numbers_for_issue_type.each do |line_number|
-              line_number_tokens << line_number_token(issue_type, line_number)
+            line_numbers_for_issue_type.uniq.sort.each do |line_number|
+              frequency = line_numbers_for_issue_type.count(line_number)
+
+              line_number_tokens += line_number_token(issue_type, line_number, frequency)
             end
           end
 
@@ -151,27 +157,34 @@ module Minitest
         # @param line_number [Integer] the affected line number
         #
         # @return [Array<Symbol,Integer>] array token representing the line number and issue type
-        def line_number_token(style, line_number)
-          [style, "#{line_number} "]
-        end
-
-        # Sorts line number tokens so that line numbers are displayed in order regardless of their
-        #   underlying issue type
-        #
-        # @param hit [Hit] the instance of the hit file details to build the heat map entry
-        #
-        # @return [Array] the arrays representing the line number tokens to display next to a file
-        #   name in the heat map. ex [[:error, 12], [:falure, 13]]
-        def sorted_line_number_list(hit)
-          # Sort the collected group of line number hits so they're in order
-          line_number_tokens_for_hit(hit).sort do |a, b|
-            # Ensure the line numbers are integers for sorting (otherwise '100' comes before '12')
-            first_line_number = Integer(a[1].strip)
-            second_line_number = Integer(b[1].strip)
-
-            first_line_number <=> second_line_number
+        def line_number_token(style, line_number, frequency)
+          if frequency > 1
+            [
+              [style, "#{line_number}"],
+              [:muted, "✕#{frequency} "]
+            ]
+          else
+            [[style, "#{line_number} "]]
           end
         end
+
+        # # Sorts line number tokens so that line numbers are displayed in order regardless of their
+        # #   underlying issue type
+        # #
+        # # @param hit [Hit] the instance of the hit file details to build the heat map entry
+        # #
+        # # @return [Array] the arrays representing the line number tokens to display next to a file
+        # #   name in the heat map. ex [[:error, 12], [:falure, 13]]
+        # def sorted_line_number_list(hit)
+        #   # Sort the collected group of line number hits so they're in order
+        #   line_number_tokens_for_hit(hit).sort do |a, b|
+        #     # Ensure the line numbers are integers for sorting (otherwise '100' comes before '12')
+        #     first_line_number = Integer(a[1].strip)
+        #     second_line_number = Integer(b[1].strip)
+
+        #     first_line_number <=> second_line_number
+        #   end
+        # end
       end
     end
   end

data/lib/minitest/heat/output.rb

@@ -57,7 +57,11 @@ module Minitest
           # suppress them until the more critical issues are resolved.
           next unless show?(issue_category, results)
 
-          results.send(issue_category).each { |issue| issue_details(issue) }
+          issues = results.send(issue_category)
+
+          issues
+            .sort_by { |issue| issue.locations.most_relevant.to_a }
+            .each { |issue| issue_details(issue) }
         end
       rescue StandardError => e
         message = "Sorry, but Minitest Heat couldn't display the details of any failures."

data/lib/minitest/heat/results.rb

@@ -30,8 +30,20 @@ module Minitest
         # For heat map purposes, only the project backtrace lines are interesting
         pathname, line_number = issue.locations.project.to_a
 
-        # Backtrace is only relevant for exception-generating issues, not slows, skips, or failures
-        backtrace = issue.error? ? issue.locations.backtrace.project_locations : []
+        # A backtrace is only relevant for exception-generating issues (i.e. errors), not slows or skips
+        # However, while assertion failures won't have a backtrace, there can still be repeated line
+        # numbers if the tests reference a shared method with an assertion in it. So in those cases,
+        # the backtrace is simply the test definition
+        backtrace = if issue.error?
+          # With errors, we have a backtrace
+          issue.locations.backtrace.project_locations
+        else
+          # With failures, the test definition is the most granular backtrace equivalent
+          location = issue.locations.test_definition
+          location.raw_container = issue.test_identifier
+
+          [location]
+        end
 
         @heat_map.add(pathname, line_number, issue.type, backtrace: backtrace)
       end

data/lib/minitest/heat/version.rb

@@ -2,6 +2,6 @@
 
 module Minitest
   module Heat
-    VERSION = '0.0.14'
+    VERSION = '1.0.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest-heat
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 1.0.0
 platform: ruby
 authors:
 - Garrett Dimon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-29 00:00:00.000000000 Z
+date: 2021-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest