minitest-heat 0.0.1 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 949b2b45d4b42493bc74bc98571eefbbde523ef18a70077cc32bf944e30cc172
-  data.tar.gz: e716f191d2053ed286ed8e342e0578fe9bc97ad818d4ca89dbf199003d6b64d0
+  metadata.gz: c760c15a45811d5773dee18e32aadc063ed61c3eb04447c637719d5d3d46178a
+  data.tar.gz: 90c345c56cbd2589719eef8a0264a5973f77a8104c91149f4e4ad2320067a49a
 SHA512:
-  metadata.gz: f662e4944204010df9e2f29ab49959b978f7b0c54e5beb9ece51e80bf8830d7c6cf988f5834dbfc3b44037f6303ac5a82817132810a508ff1fa7064e19800a74
-  data.tar.gz: 292ecef2bd8473f74937356d8c68171801d4eb50e67849d76160fb24c9ee61838183c3c385240425ad1587c4cedf7375e292f806d593706915175cd489702520
+  metadata.gz: 47be296804a2171023bfcdb5c4192376698349bd76c4c3a2991d9accd9f631b88d2ffb867d821f2479c41bd6fd2cf919af325ecde975f98ee4592277b3b09432
+  data.tar.gz: 79a180260e9a1d8c55d898883f13969f2576ceb6450dc9e080050e55674c73fc7979202a2c8a78542958491fce91fee2a3cb1b66fd2705edc4a8d432f5e28fcc

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    minitest-heat (0.0.1)
+    minitest-heat (0.0.5)
       minitest
 
 GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.3)
+    dead_end (1.1.7)
     docile (1.4.0)
     method_source (1.0.0)
     minitest (5.14.4)
@@ -26,6 +27,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  dead_end
   minitest (~> 5.0)
   minitest-heat!
   pry

data/lib/minitest/heat/backtrace.rb

@@ -6,11 +6,23 @@ module Minitest
     class Backtrace
       Line = Struct.new(:path, :file, :number, :container, :mtime, keyword_init: true) do
         def to_s
-          "#{path}/#{file}:#{line} in `#{container}` #{age_in_seconds}"
+          "#{location} in `#{container}`"
         end
 
-        def to_file
-          "#{path}/#{file}"
+        def pathname
+          Pathname("#{path}/#{file}")
+        end
+
+        def location
+          "#{pathname.to_s}:#{number}"
+        end
+
+        def short_pathname
+          pathname.delete_prefix(Dir.pwd)
+        end
+
+        def short_location
+          "#{pathname.basename.to_s}:#{number}"
         end
 
         def age_in_seconds
@@ -18,6 +30,16 @@ module Minitest
         end
       end
 
+      UNREADABLE_FILE_ATTRIBUTES = {
+        path: '(Unknown Path)',
+        file: '(Unknown File)',
+        number: '(Unknown Line Number)',
+        container: '(Unknown Method)',
+        mtime: '(Unknown Modification Time)'
+      }
+
+      UNREADABLE_LINE = Line.new(UNREADABLE_FILE_ATTRIBUTES)
+
       attr_reader :raw_backtrace
 
       def initialize(raw_backtrace)
@@ -29,37 +51,45 @@ module Minitest
       end
 
       def final_location
-        parsed.first
+        parsed_lines.first
       end
 
       def final_project_location
-        project.first
+        project_lines.first
+      end
+
+      def freshest_project_location
+        recently_modified_lines.first
+      end
+
+      def final_source_code_location
+        source_code_lines.first
       end
 
       def final_test_location
-        tests.first
+        test_lines.first
       end
 
-      def freshest_project_location
-        recently_modified.first
+      def project_lines
+        @project_lines ||= parsed_lines.select { |line| line[:path].include?(Dir.pwd) }
       end
 
-      def project
-        @project ||= parsed.select { |line| line[:path].include?(Dir.pwd) }
+      def recently_modified_lines
+        @recently_modified_lines ||= project_lines.sort_by { |line| line[:mtime] }.reverse
       end
 
-      def tests
-        @tests ||= project.select { |line| test_file?(line) }
+      def test_lines
+        @tests_lines ||= project_lines.select { |line| test_file?(line) }
       end
 
-      def recently_modified
-        @recently_modified ||= project.sort_by { |line| line[:mtime] }.reverse
+      def source_code_lines
+        @source_code_lines ||= project_lines - test_lines
       end
 
-      def parsed
+      def parsed_lines
         return [] if raw_backtrace.nil?
 
-        @parsed ||= raw_backtrace.map { |line| parse(line) }
+        @parsed_lines ||= raw_backtrace.map { |line| parse(line) }
       end
 
       private
@@ -83,6 +113,8 @@ module Minitest
           container: reduce_container(parts[2]),
           mtime: pathname.exist? ? pathname.mtime : nil
         }
+      rescue
+        UNREADABLE_FILE_ATTRIBUTES
       end
 
       def test_file?(line)

data/lib/minitest/heat/issue.rb

@@ -8,7 +8,20 @@ module Minitest
     class Issue
       extend Forwardable
 
-      SLOW_THRESHOLD = 0.5
+      SLOW_THRESHOLDS = {
+        slow: 1.0,
+        painful: 3.0
+      }
+
+      MARKERS = {
+        success:  '·',
+        slow:     '–',
+        painful:  '—',
+        broken:   'B',
+        error:    'E',
+        skipped:  'S',
+        failure:  'F',
+      }
 
       SHARED_SYMBOLS = {
         spacer: ' · ',
@@ -27,10 +40,14 @@ module Minitest
         @location = Location.new(result.source_location, @failure&.backtrace)
       end
 
+      def short_location
+        location.to_s.delete_prefix(Dir.pwd)
+      end
+
       def to_hit
         [
-          location.source_file,
-          location.source_failure_line,
+          location.project_file.to_s,
+          location.project_failure_line,
           type
         ]
       end
@@ -52,6 +69,8 @@ module Minitest
           :skipped
         elsif !passed?
           :failure
+        elsif painful?
+          :painful
         elsif slow?
           :slow
         else
@@ -59,20 +78,28 @@ module Minitest
         end
       end
 
+      def hit?
+        !passed? || slow?
+      end
+
       def slow?
-        time > SLOW_THRESHOLD
+        time >= SLOW_THRESHOLDS[:slow]
+      end
+
+      def painful?
+        time >= SLOW_THRESHOLDS[:painful]
       end
 
       def in_test?
-        location.failure_in_test?
+        location.broken_test?
       end
 
       def in_source?
-        location.failure_in_source?
+        location.proper_failure?
       end
 
       def test_class
-        result.klass.delete_prefix('Minitest::')
+        result.klass
       end
 
       def test_identifier
@@ -100,7 +127,7 @@ module Minitest
           # 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'
+          'Test Error'
         elsif error? || !passed?
           failure.result_label
         elsif slow?
@@ -111,14 +138,7 @@ module Minitest
       end
 
       def marker
-        case type
-        when :broken then  'B'
-        when :error then   'E'
-        when :skipped then 'S'
-        when :failure then 'F'
-        when :slow then    'S'
-        else               '.'
-        end
+        MARKERS.fetch(type.to_sym)
       end
 
       def summary

data/lib/minitest/heat/location.rb

@@ -2,6 +2,17 @@
 
 module Minitest
   module Heat
+    # Convenience methods for determining the file and line number where the problem occurred.
+    #   There are several layers of specificity to help make it easy to communicate the relative
+    #   location of the failure:
+    #   - 'final' represents the final line of the backtrace regardless of where it is
+    #   - 'test' represents the last line from the project's tests. It is further differentiated by
+    #     the line where the test is defined and the actual line of code in the test that geneated
+    #     the failure or exception
+    #   - 'source_code' represents the last line from the project's source code
+    #   - 'project' represents the last source line, but falls back to the last test line
+    #   - 'most_relevant' represents the most specific file to investigate starting with the source
+    #     code and then looking to the test code with final line of the backtrace as a fallback
     class Location
       attr_reader :test_location, :backtrace
 
@@ -10,52 +21,152 @@ module Minitest
         @backtrace = Backtrace.new(backtrace)
       end
 
+      # Prints the pathname and line number of the location most likely to be the source of the
+      #   test failure
+      #
+      # @return [String] ex. 'path/to/file.rb:12'
       def to_s
-        "#{source_file}:#{source_failure_line}"
+        "#{most_relevant_file}:#{most_relevant_failure_line}"
       end
 
-      def failure_in_test?
-        !test_file.nil? && test_file == source_file
+      def local?
+        broken_test? || proper_failure?
       end
 
-      def failure_in_source?
-        !failure_in_test?
+      # Knows if the failure is contained within the test. For example, if there's bad code in a
+      #   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
+      def broken_test?
+        !test_file.nil? && test_file == most_relevant_file
       end
 
+      # Knows if the failure occurred in the actual project source code—as opposed to the test or
+      #   an external piece of code like a gem.
+      #
+      # @return [Boolean] true if there's a non-test project file in the stacktrace but it's not
+      #   a result of a broken test
+      def proper_failure?
+        !source_code_file.nil? && !broken_test?
+      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
+      #   first place to focus is on the code you control.
+      #
+      # @return [String] the relative path to the file from the project root
+      def most_relevant_file
+        Pathname(most_relevant_location[0])
+      end
+
+      # The line number of the `most_relevant_file` where the failure originated
+      #
+      # @return [Integer] line number
+      def most_relevant_failure_line
+        most_relevant_location[1]
+      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[0])
+      end
+
+      # The line number of the `final_file` where the failure originated
+      #
+      # @return [Integer] line number
+      def final_failure_line
+        final_location[1]
+      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 project_file
+        broken_test? ? test_file : source_code_file
+      end
+
+      # The line number of the `project_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
+      end
+
+      # The final location from the stacktrace that is within the project directory
+      #
+      # @return [String, nil] the relative path to the file from the project root
+      def source_code_file
+        return nil unless backtrace.source_code_lines.any?
+
+        backtrace.final_source_code_location.pathname
+      end
+
+      # The line number of the `source_code_file` where the failure originated
+      #
+      # @return [Integer] line number
+      def source_code_failure_line
+        return nil unless backtrace.source_code_lines.any?
+
+        backtrace.final_source_code_location.number
+      end
+
+      # The final location from the stacktrace that is within the project's test directory
+      #
+      # @return [String, nil] the relative path to the file from the project root
       def test_file
-        reduced_path(test_location[0])
+        Pathname(test_location[0])
       end
 
+      # The line number of the `test_file` where the test is defined
+      #
+      # @return [Integer] line number
       def test_definition_line
         test_location[1].to_s
       end
 
+      # The line number from within the `test_file` test definition where the failure occurred
+      #
+      # @return [Integer] line number
       def test_failure_line
-        @backtrace.final_test_location.number
+        backtrace.final_test_location&.number || test_definition_line
       end
 
-      def source_file
-        return test_file if backtrace.empty?
-
-        source_line = backtrace.final_project_location
-
-        reduced_path("#{source_line.path}/#{source_line.file}")
+      # The line number from within the `test_file` test definition where the failure occurred
+      #
+      # @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
       end
 
-      def source_failure_line
-        return test_definition_line if backtrace.empty?
-
-        backtrace.final_project_location.number
+      # 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
+      #   first place to focus is on the code you control.
+      #
+      # @return [Array] file and line number of the most likely source of the problem
+      def most_relevant_location
+        [
+          source_code_location,
+          test_location,
+          final_location
+        ].compact.first
       end
 
-      def project_directory_name
-        Dir.pwd.split('/').last
+      def project_location
+        source_code_location || test_location
       end
 
-      private
+      def source_code_location
+        backtrace.final_source_code_location
+      end
 
-      def reduced_path(path)
-        "/#{path.split("/#{project_directory_name}/").last}"
+      def backtrace?
+        backtrace.parsed_lines.any?
       end
     end
   end

data/lib/minitest/heat/map.rb

@@ -13,11 +13,12 @@ module Minitest
       #   test is broken (i.e. raising an exception), that's a special sort of failure that would be
       #   misleading. It doesn't represent a proper failure, but rather a test that doesn't work.
       WEIGHTS = {
-        error: 3,   # exceptions from source code have the highest liklihood of a ripple effect
-        broken: 1,  # broken tests won't have ripple effects but can't help if they can't run
-        failure: 1, # failures are kind of the whole point, and they could have ripple effects
-        skipped: 0, # skips aren't failures, but they shouldn't go ignored
-        slow: 0     # slow tests aren't failures, but they shouldn't be ignored
+        error: 3,    # exceptions from source code have the highest liklihood of a ripple effect
+        broken: 1,   # broken tests won't have ripple effects but can't help if they can't run
+        failure: 1,  # failures are kind of the whole point, and they could have ripple effects
+        skipped: 0,  # skips aren't failures, but they shouldn't go ignored
+        painful: 0,  # slow tests aren't failures, but they shouldn't be ignored
+        slow: 0,
       }
 
       def initialize
@@ -46,7 +47,7 @@ module Minitest
         files = {}
         @hits.each_pair do |filename, details|
           # Can't really be a "hot spot" with just a single issue
-          next unless details[:total] > 1
+          # next unless details[:weight] > 1
 
           files[filename] = details[:weight]
         end