minitest-heat 0.0.9 → 0.0.10

data/lib/minitest/heat/location.rb

@@ -22,10 +22,10 @@ module Minitest
         end
       end
 
-      attr_reader :test_location, :backtrace
+      attr_reader :test_definition_location, :backtrace
 
-      def initialize(test_location, backtrace = [])
-        @test_location = TestDefinition.new(*test_location)
+      def initialize(test_definition_location, backtrace = [])
+        @test_definition_location = TestDefinition.new(*test_definition_location)
         @backtrace = Backtrace.new(backtrace)
       end
 
@@ -45,9 +45,9 @@ module Minitest
       #   test, and it raises an exception, then it's really a broken test rather than a proper
       #   faiure.
       #
-      # @return [Boolean] true if most relevant file is the same as the test location file
+      # @return [Boolean] true if final file in the backtrace is the same as the test location file
       def broken_test?
-        !test_file.nil? && test_file == most_relevant_file
+        !test_file.nil? && test_file == final_file
       end
 
       # Knows if the failure occurred in the actual project source code—as opposed to the test or
@@ -59,6 +59,15 @@ module Minitest
         !source_code_file.nil? && !broken_test?
       end
 
+
+
+      # The final location of the stacktrace regardless of whether it's from within the project
+      #
+      # @return [String] the relative path to the file from the project root
+      def final_file
+        Pathname(final_location.pathname)
+      end
+
       # The file most likely to be the source of the underlying problem. Often, the most recent
       #   backtrace files will be a gem or external library that's failing indirectly as a result
       #   of a problem with local source code (not always, but frequently). In that case, the best
@@ -69,78 +78,76 @@ module Minitest
         Pathname(most_relevant_location.pathname)
       end
 
-      # The line number of the `most_relevant_file` where the failure originated
+      # The final location from the stacktrace that is a test file
       #
-      # @return [Integer] line number
-      def most_relevant_failure_line
-        most_relevant_location.line_number
+      # @return [String, nil] the relative path to the file from the project root
+      def test_file
+        Pathname(final_test_location.pathname)
       end
 
-      # The final location of the stacktrace regardless of whether it's from within the project
+      # The final location from the stacktrace that is within the project directory
       #
-      # @return [String] the relative path to the file from the project root
-      def final_file
-        Pathname(final_location.pathname)
-      end
+      # @return [String, nil] the relative path to the file from the project root
+      def source_code_file
+        return nil if final_source_code_location.nil?
 
-      # The line number of the `final_file` where the failure originated
-      #
-      # @return [Integer] line number
-      def final_failure_line
-        final_location.line_number
+        Pathname(final_source_code_location.pathname)
       end
 
-      # The final location of the stacktrace regardless of whether it's from within the project
+      # The final location of the stacktrace from within the project (source code or test code)
       #
       # @return [String] the relative path to the file from the project root
       def project_file
-        broken_test? ? test_file : source_code_file
+        return nil if project_location.nil?
+
+        Pathname(project_location.pathname)
       end
 
-      # The line number of the `project_file` where the failure originated
+
+      # The line number of the `final_file` where the failure originated
       #
       # @return [Integer] line number
-      def project_failure_line
-        broken_test? ? test_failure_line || test_definition_line : source_code_failure_line
+      def final_failure_line
+        final_location.line_number
       end
 
-      # The final location from the stacktrace that is within the project directory
+      # The line number of the `most_relevant_file` where the failure originated
       #
-      # @return [String, nil] the relative path to the file from the project root
-      def source_code_file
-        return nil unless backtrace.source_code_entries.any?
-
-        backtrace.final_source_code_location.pathname
+      # @return [Integer] line number
+      def most_relevant_failure_line
+        most_relevant_location.line_number
       end
 
-      # The line number of the `source_code_file` where the failure originated
+      # The line number of the `test_file` where the test is defined
       #
       # @return [Integer] line number
-      def source_code_failure_line
-        return nil unless backtrace.source_code_entries.any?
-
-        backtrace.final_source_code_location.line_number
+      def test_definition_line
+        test_definition_location.line_number
       end
 
-      # The final location from the stacktrace that is within the project's test directory
+      # The line number from within the `test_file` test definition where the failure occurred
       #
-      # @return [String, nil] the relative path to the file from the project root
-      def test_file
-        Pathname(test_location.pathname)
+      # @return [Integer] line number
+      def test_failure_line
+        final_test_location.line_number
       end
 
-      # The line number of the `test_file` where the test is defined
+      # The line number of the `source_code_file` where the failure originated
       #
       # @return [Integer] line number
-      def test_definition_line
-        test_location.line_number
+      def source_code_failure_line
+        final_source_code_location&.line_number
       end
 
-      # The line number from within the `test_file` test definition where the failure occurred
+      # The line number of the `project_file` where the failure originated
       #
       # @return [Integer] line number
-      def test_failure_line
-        backtrace.final_test_location&.line_number || test_definition_line
+      def project_failure_line
+        if !broken_test? && !source_code_file.nil?
+          source_code_failure_line
+        else
+          test_failure_line
+        end
       end
 
       # The line number from within the `test_file` test definition where the failure occurred
@@ -148,7 +155,7 @@ module Minitest
       # @return [Location] the last location from the backtrace or the test location if a backtrace
       #   was not passed to the initializer
       def final_location
-        backtrace? ? backtrace.final_location : test_location
+        backtrace.parsed_entries.any? ? backtrace.final_location : test_definition_location
       end
 
       # The file most likely to be the source of the underlying problem. Often, the most recent
@@ -159,22 +166,33 @@ module Minitest
       # @return [Array] file and line number of the most likely source of the problem
       def most_relevant_location
         [
-          source_code_location,
-          test_location,
+          final_source_code_location,
+          final_test_location,
           final_location
         ].compact.first
       end
 
-      def project_location
-        source_code_location || test_location
+      # Returns the final test location based on the backtrace if present. Otherwise falls back to
+      #   the test location which represents the test definition.
+      #
+      # @return [Location] the final location from the test files
+      def final_test_location
+        backtrace.final_test_location || test_definition_location
       end
 
-      def source_code_location
+      # Returns the final source code location based on the backtrace
+      #
+      # @return [Location] the final location from the source code files
+      def final_source_code_location
         backtrace.final_source_code_location
       end
 
-      def backtrace?
-        backtrace.parsed_entries.any?
+      # Returns the final project location based on the backtrace if present. Otherwise falls back
+      #   to the test location which represents the test definition.
+      #
+      # @return [Location] the final location from the project files
+      def project_location
+        backtrace.final_project_location || test_definition_location
       end
     end
   end

data/lib/minitest/heat/map.rb

@@ -2,6 +2,7 @@
 
 module Minitest
   module Heat
+    # Structured approach to collecting the locations of issues for generating a heat map
     class Map
       MAXIMUM_FILES_TO_SHOW = 5
 
@@ -11,18 +12,30 @@ module Minitest
         @hits = {}
       end
 
+      # Records a hit to the list of files and issue types
+      # @param filename [String] the unique path and file name for recordings hits
+      # @param line_number [Integer] the line number where the issue was encountered
+      # @param type [Symbol] the type of issue that was encountered (i.e. :failure, :error, etc.)
+      #
+      # @return [void]
       def add(filename, line_number, type)
         @hits[filename] ||= Hit.new(filename)
 
-        @hits[filename].log(type, line_number)
+        @hits[filename].log(type.to_sym, line_number)
       end
 
+      # Returns a subset of affected files to keep the list from being overwhelming
+      #
+      # @return [Array] the list of files and the line numbers for each encountered issue type
       def file_hits
         hot_files.take(MAXIMUM_FILES_TO_SHOW)
       end
 
       private
 
+      # Sorts the files by hit "weight" so that the most problematic files are at the beginning
+      #
+      # @return [Array] the collection of files that encountred issues
       def hot_files
         hits.values.sort_by(&:weight).reverse
       end

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

@@ -23,13 +23,9 @@ module Minitest
           # Iterate over the selected lines from the backtrace
           backtrace_entries.each do |backtrace_entry|
             # Get the source code for the line from the backtrace
-            parts = [
-              indentation_token,
-              path_token(backtrace_entry),
-              *file_and_line_number_tokens(backtrace_entry),
-              source_code_line_token(backtrace_entry.source_code)
-            ]
+            parts = backtrace_line_tokens(backtrace_entry)
 
+            # If it's the most recently modified file in the trace, add the token for that
             parts << file_freshness(backtrace_entry) if most_recently_modified?(backtrace_entry)
 
             @tokens << parts
@@ -57,6 +53,15 @@ module Minitest
 
         private
 
+        def backtrace_line_tokens(backtrace_entry)
+          [
+            indentation_token,
+            path_token(backtrace_entry),
+            *file_and_line_number_tokens(backtrace_entry),
+            source_code_line_token(backtrace_entry.source_code)
+          ]
+        end
+
         def all_backtrace_entries_from_project?
           backtrace_entries.all? { |line| line.path.to_s.include?(project_root_dir) }
         end
@@ -123,7 +128,7 @@ module Minitest
         end
 
         def style_for(path)
-          style = path.to_s.include?(Dir.pwd) ? :default : :muted
+          path.to_s.include?(Dir.pwd) ? :default : :muted
         end
       end
     end

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

@@ -3,7 +3,8 @@
 module Minitest
   module Heat
     class Output
-      class Issue
+      # Formats issues to output based on the issue type
+      class Issue # rubocop:disable Metrics/ClassLength
         attr_accessor :issue
 
         def initialize(issue)
@@ -77,11 +78,43 @@ module Minitest
         end
 
         def headline_tokens
-          [[issue.type, issue.label], spacer_token, [:default, issue.test_name]]
+          [[issue.type, label(issue)], spacer_token, [:default, test_name(issue)]]
+        end
+
+        def test_name(issue)
+          test_prefix = 'test_'
+          identifier = issue.test_identifier
+
+          if identifier.start_with?(test_prefix)
+            identifier.delete_prefix(test_prefix).gsub('_', ' ').capitalize
+          else
+            identifier
+          end
+        end
+
+        def label(issue)
+          if issue.error? && issue.in_test?
+            # When the exception came out of the test itself, that's a different kind of exception
+            # that really only indicates there's a problem with the code in the test. It's kind of
+            # between an error and a test.
+            'Broken Test'
+          elsif issue.error?
+            'Error'
+          elsif issue.skipped?
+            'Skipped'
+          elsif issue.painful?
+            'Passed but Very Slow'
+          elsif issue.slow?
+            'Passed but Slow'
+          elsif !issue.passed?
+            'Failure'
+          else
+            'Success'
+          end
         end
 
         def test_name_and_class_tokens
-          [[:default, issue.test_class], *test_location_tokens ]
+          [[:default, issue.test_class], *test_location_tokens]
         end
 
         def backtrace_tokens
@@ -107,12 +140,12 @@ module Minitest
         end
 
         def summary_tokens
-          [[:italicized, issue.summary.delete_suffix("---------------")]]
+          [[:italicized, issue.summary.delete_suffix('---------------').strip]]
         end
 
         def slowness_summary_tokens
           [
-            [:bold, issue.slowness],
+            [:bold, slowness(issue)],
             spacer_token,
             [:default, issue.location.test_file.to_s.delete_prefix(Dir.pwd)],
             [:muted, ':'],
@@ -120,6 +153,10 @@ module Minitest
           ]
         end
 
+        def slowness(issue)
+          "#{issue.execution_time.round(2)}s"
+        end
+
         def newline_tokens
           []
         end
@@ -155,7 +192,6 @@ module Minitest
         def arrow_token
           Output::TOKENS[:muted_arrow]
         end
-
       end
     end
   end

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

@@ -3,6 +3,7 @@
 module Minitest
   module Heat
     class Output
+      # Generates the tokens to output the resulting heat map
       class Map
         attr_accessor :results
 
@@ -34,8 +35,10 @@ module Minitest
         end
 
         def relevant_issue_types
+          # These are always relevant.
           issue_types = %i[error broken failure]
 
+          # These are only relevant if there aren't more serious isues.
           issue_types << :skipped unless results.problems?
           issue_types << :painful unless results.problems? || results.skips.any?
           issue_types << :slow    unless results.problems? || results.skips.any?
@@ -44,7 +47,7 @@ module Minitest
         end
 
         def pathname(file)
-          directory = "#{file.pathname.dirname.to_s.delete_prefix(Dir.pwd)}/"
+          directory = "#{file.pathname.dirname.to_s.delete_prefix(Dir.pwd)}/".delete_prefix('/')
           filename = file.pathname.basename.to_s
 
           [
@@ -57,18 +60,29 @@ module Minitest
         def hit_line_numbers(file, issue_type)
           numbers = []
           line_numbers_for_issue_type = file.issues.fetch(issue_type) { [] }
-          line_numbers_for_issue_type.sort.map do |line_number|
+          line_numbers_for_issue_type.map do |line_number|
             numbers << [issue_type, "#{line_number} "]
           end
+
           numbers
         end
 
         def line_numbers(file)
           line_number_tokens = []
+
+          # Merge the hits for all issue types into one list
           relevant_issue_types.each do |issue_type|
             line_number_tokens += hit_line_numbers(file, issue_type)
           end
-          line_number_tokens.compact.sort_by { |number_token| number_token[1] }
+
+          # Sort the collected group of line number hits so they're in order
+          line_number_tokens.compact.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

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

@@ -2,8 +2,8 @@
 
 module Minitest
   module Heat
-    # Friendly API for printing nicely-formatted output to the console
     class Output
+      # Friendly API for printing consistent markers for the various issue types
       class Marker
         SYMBOLS = {
           success: '·',
@@ -12,7 +12,8 @@ module Minitest
           broken: 'B',
           error: 'E',
           skipped: 'S',
-          failure: 'F'
+          failure: 'F',
+          reporter: '✖'
         }.freeze
 
         STYLES = {
@@ -22,7 +23,8 @@ module Minitest
           broken: :error,
           error: :error,
           skipped: :skipped,
-          failure: :failure
+          failure: :failure,
+          reporter: :error
         }.freeze
 
         attr_accessor :issue_type

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

@@ -3,6 +3,7 @@
 module Minitest
   module Heat
     class Output
+      # Generates the output tokens to display the results summary
       class Results
         extend Forwardable
 
@@ -90,7 +91,7 @@ module Minitest
         end
 
         def test_count_token
-          [:default, "#{pluralize(timer.test_count, 'test')}"]
+          [:default, pluralize(timer.test_count, 'test').to_s]
         end
 
         def tests_performance_token
@@ -98,7 +99,7 @@ module Minitest
         end
 
         def assertions_count_token
-          [:default, "#{pluralize(timer.assertion_count, 'assertion')}"]
+          [:default, pluralize(timer.assertion_count, 'assertion').to_s]
         end
 
         def assertions_performance_token

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

@@ -3,7 +3,7 @@
 module Minitest
   module Heat
     class Output
-      # Builds the collection of tokens representing a specific set of source code lines
+      # Generates the tokens representing a specific set of source code lines
       class SourceCode
         DEFAULT_LINE_COUNT = 3
         DEFAULT_INDENTATION_SPACES = 2

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

@@ -2,8 +2,9 @@
 
 module Minitest
   module Heat
-    # Friendly API for printing nicely-formatted output to the console
     class Output
+      # Provides a convenient interface for creating console-friendly output while ensuring
+      #   consistency in the applied styles.
       class Token
         class InvalidStyle < ArgumentError; end
 

data/lib/minitest/heat/output.rb

@@ -15,14 +15,14 @@ module Minitest
       SYMBOLS = {
         middot: '·',
         arrow: '➜',
-        lead: '|',
+        lead: '|'
       }.freeze
 
       TOKENS = {
-        spacer:      [:muted, " #{SYMBOLS[:middot]} "],
+        spacer: [:muted, " #{SYMBOLS[:middot]} "],
         muted_arrow: [:muted, " #{SYMBOLS[:arrow]} "],
-        muted_lead:  [:muted, "#{SYMBOLS[:lead]} "],
-      }
+        muted_lead: [:muted, "#{SYMBOLS[:lead]} "]
+      }.freeze
 
       attr_reader :stream
 
@@ -42,8 +42,30 @@ module Minitest
       end
       alias newline puts
 
+      def issues_list(results)
+        # A couple of blank lines to create some breathing room
+        newline
+        newline
+
+        # Issues start with the least critical and go up to the most critical so that the most
+        #   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.
+        %i[slows painfuls skips failures brokens errors].each do |issue_category|
+          next unless show?(issue_category, results)
+
+          results.send(issue_category).each { |issue| issue_details(issue) }
+        end
+      rescue => e
+        message = "Sorry, but Minitest Heat couldn't display the details of any failures."
+        exception_guidance(message, e)
+      end
+
       def issue_details(issue)
         print_tokens Minitest::Heat::Output::Issue.new(issue).tokens
+      rescue => e
+        message = "Sorry, but Minitest Heat couldn't display output for a failure."
+        exception_guidance(message, e)
       end
 
       def marker(issue_type)
@@ -53,15 +75,49 @@ module Minitest
       def compact_summary(results, timer)
         newline
         print_tokens ::Minitest::Heat::Output::Results.new(results, timer).tokens
+      rescue => e
+        message = "Sorry, but Minitest Heat couldn't display the summary."
+        exception_guidance(message, e)
       end
 
       def heat_map(map)
         newline
         print_tokens ::Minitest::Heat::Output::Map.new(map).tokens
+        newline
+      rescue => e
+        message = "Sorry, but Minitest Heat couldn't display the heat map."
+        exception_guidance(message, e)
+      end
+
+      def exception_guidance(message, exception)
+        newline
+        puts "#{message} Disabling Minitest Heat can get you back on track until the problem can be fixed."
+        puts "Please use the following exception details to submit an issue at https://github.com/garrettdimon/minitest-heat/issues"
+        puts "#{exception.message}:"
+        exception.backtrace.each do |line|
+          puts "  #{line}"
+        end
+        newline
       end
 
       private
 
+      def no_problems?(results)
+        !results.problems?
+      end
+
+      def no_problems_or_skips?(results)
+        !results.problems? && results.skips.none?
+      end
+
+      def show?(issue_category, results)
+        case issue_category
+        when :skips            then no_problems?(results)
+        when :painfuls, :slows then no_problems_or_skips?(results)
+        else true
+        end
+      end
+
       def style_enabled?
         stream.tty?
       end

data/lib/minitest/heat/results.rb

@@ -11,9 +11,24 @@ module Minitest
         @heat_map = Heat::Map.new
       end
 
+      # Logs an issue to the results for later reporting
+      # @param issue [Issue] the issue generated from a given test result
+      #
+      # @return [type] [description]
       def record(issue)
+        # Record everything—even if it's a success
         @issues.push(issue)
-        @heat_map.add(*issue.to_hit) if issue.hit?
+
+        # If it's not a genuine problem, we're done here, otherwise update the heat map
+        update_heat_map(issue) if issue.hit?
+      end
+
+      def update_heat_map(issue)
+        # Get the elements we need to generate a heat map entry
+        pathname    = issue.location.project_file.to_s
+        line_number = issue.location.project_failure_line.to_i
+
+        @heat_map.add(pathname, line_number, issue.type)
       end
 
       def problems?
@@ -37,11 +52,11 @@ module Minitest
       end
 
       def painfuls
-        @painfuls ||= select_issues(:painful).sort_by(&:time).reverse
+        @painfuls ||= select_issues(:painful).sort_by(&:execution_time).reverse
       end
 
       def slows
-        @slows ||= select_issues(:slow).sort_by(&:time).reverse
+        @slows ||= select_issues(:slow).sort_by(&:execution_time).reverse
       end
 
       private

data/lib/minitest/heat/version.rb

@@ -2,6 +2,6 @@
 
 module Minitest
   module Heat
-    VERSION = '0.0.9'
+    VERSION = '0.0.10'
   end
 end

data/lib/minitest/heat.rb

@@ -3,7 +3,6 @@
 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'
@@ -13,7 +12,8 @@ require_relative 'heat/timer'
 require_relative 'heat/version'
 
 module Minitest
-  # Custom minitest reporter just for Reviewer. Focuses on printing directly actionable guidance.
+  # Custom Minitest reporter focused on generating output designed around efficiently identifying
+  # issues and potential solutions
   # - Colorize the Output
   # - What files had the most errors?
   # - Show the most impacted areas first.