minitest-heat 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c60c717971a6a1858de4337247b8bfd37f63a63f31a1783de4ecaaad8ca5a8c
-  data.tar.gz: c491cb526bd8a243810fe88da7d15679a6c5182b256a5187db4c457bcc9b7a7a
+  metadata.gz: 7a2dd8d434e13e9719addb1a2afa9f25c751ca6e5712c752244afb1823ac4740
+  data.tar.gz: 722f33b1145d79510f9007b54663198972c1ce4461a7a79c14a7bfdeb190721e
 SHA512:
-  metadata.gz: abf3a4c476c1041f75fedfa3eac1235f134bc99bbbf1c909e6e407e461380e9028079e3ad927180d7bec4f039c54247172c9a12bee579dec5eab53b444cf3f68
-  data.tar.gz: fb7d2373153fdaaf6fe8b3a6ec693baf3e04a8fa8dc5636f75d1b0afb45e5a7b25365f3dbe44b0aa3c53bb79b8ed7b0551c3798ceaa3477ce1d9e122159e116a
+  metadata.gz: 955b848541141572e94aeff4b02586253f70db8e313af111e54b91c3e8a64c7c44c0f0f90c672f699f9296dc5f691ea04c7852eb948f6ab680173b8261512eee
+  data.tar.gz: 9c3085267bea53a6734a085c982fd8348442715036ccf2b636de9c997f3dc14662e25a709faab1b4425ffb46ceeb109f43672336fadf0bca7c4e0cbbccd0463c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    minitest-heat (0.0.10)
+    minitest-heat (0.0.11)
       minitest
 
 GEM
@@ -10,7 +10,7 @@ GEM
     ast (2.4.2)
     awesome_print (1.9.2)
     coderay (1.1.3)
-    dead_end (1.1.7)
+    dead_end (3.0.2)
     docile (1.4.0)
     method_source (1.0.0)
     minitest (5.14.4)
@@ -24,7 +24,7 @@ GEM
     rake (12.3.3)
     regexp_parser (2.1.1)
     rexml (3.2.5)
-    rubocop (1.22.1)
+    rubocop (1.22.3)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -33,9 +33,9 @@ GEM
       rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.12.0)
+    rubocop-ast (1.13.0)
       parser (>= 3.0.1.1)
-    rubocop-minitest (0.15.1)
+    rubocop-minitest (0.15.2)
       rubocop (>= 0.90, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
@@ -64,4 +64,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   2.1.4
+   2.2.30

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Minitest
+  module Heat
+    class Backtrace
+      # Represents a line from a backtrace to provide more convenient access to information about
+      #   the relevant file and line number for displaying in test results
+      module LineParser
+        # Parses a line from a backtrace in order to convert it to usable components
+        def self.read(raw_text)
+          raw_pathname, raw_line_number, raw_container = raw_text.split(':')
+          raw_container = raw_container.delete_prefix('in `').delete_suffix("'")
+
+          ::Minitest::Heat::Location.new(
+            pathname: raw_pathname,
+            line_number: raw_line_number,
+            container: raw_container
+          )
+        end
+      end
+    end
+  end
+end

data/lib/minitest/heat/backtrace.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'backtrace/line'
+require_relative 'backtrace/line_parser'
 
 module Minitest
   module Heat
@@ -9,7 +9,7 @@ module Minitest
       attr_reader :raw_backtrace
 
       # Creates a more flexible backtrace data structure by parsing the lines of the backtrace to
-      #   extract individual elements for investigating the offending files and line numbers
+      #   extract specific subsets of lines for investigating the offending files and line numbers
       # @param raw_backtrace [Array] the array of lines from the backtrace
       #
       # @return [self]
@@ -24,80 +24,42 @@ module Minitest
         raw_backtrace.empty?
       end
 
-      # The final location exposed in the backtrace. Could be a line from the project or from a
-      #   dependency or the Ruby core libraries
+      # All lines of the backtrace converted to Backtrace::LineParser's
       #
-      # @return [Line] the final location from the backtrace parsed as a Backtrace::Line
-      def final_location
-        parsed_entries.first
-      end
-
-      # The final location from within the project exposed in the backtrace. Could be test files or
-      #   source code files
-      #
-      # @return [Line] the final project location from the backtrace parsed as a Backtrace::Line
-      def final_project_location
-        project_entries.first
-      end
-
-      # The most recently modified location from within the project
-      #
-      # @return [Line] the most recently modified project location from the backtrace parsed as a
-      #   Backtrace::Line
-      def freshest_project_location
-        recently_modified_entries.first
-      end
+      # @return [Line] the full set of backtrace lines parsed as Backtrace::LineParser instances
+      def locations
+        return [] if raw_backtrace.nil?
 
-      # The final location from within the project source code (i.e. excluding tests)
-      #
-      # @return [Line] the final source code location from the backtrace parsed as a Backtrace::Line
-      def final_source_code_location
-        source_code_entries.first
+        @locations ||= raw_backtrace.map { |entry| Backtrace::LineParser.read(entry) }
       end
 
-      # The final location from within the project's tests (i.e. excluding source code)
+      # All entries from the backtrace within the project and sorted with the most recently modified
+      #   files at the beginning
       #
-      # @return [Line] the final test location from the backtrace parsed as a Backtrace::Line
-      def final_test_location
-        test_entries.first
+      # @return [Line] the sorted backtrace lines from the project parsed as Backtrace::LineParser's
+      def recently_modified_locations
+        @recently_modified_locations ||= project_locations.sort_by(&:mtime).reverse
       end
 
       # All entries from the backtrace that are files within the project
       #
-      # @return [Line] the backtrace lines from within the project parsed as Backtrace::Line's
-      def project_entries
-        @project_entries ||= parsed_entries.select { |entry| entry.path.to_s.include?(Dir.pwd) }
-      end
-
-      # All entries from the backtrace within the project and sorted with the most recently modified
-      #   files at the beginning
-      #
-      # @return [Line] the sorted backtrace lines from the project parsed as Backtrace::Line's
-      def recently_modified_entries
-        @recently_modified_entries ||= project_entries.sort_by(&:mtime).reverse
+      # @return [Line] the backtrace lines from within the project parsed as Backtrace::LineParser's
+      def project_locations
+        @project_locations ||= locations.select(&:project_file?)
       end
 
       # All entries from the backtrace within the project tests
       #
-      # @return [Line] the backtrace lines from within the project tests parsed as Backtrace::Line's
-      def test_entries
-        @test_entries ||= project_entries.select(&:test_file?)
+      # @return [Line] the backtrace lines from within the project tests parsed as Backtrace::LineParser's
+      def test_locations
+        @test_locations ||= project_locations.select(&:test_file?)
       end
 
       # All source code entries from the backtrace (i.e. excluding tests)
       #
-      # @return [Line] the backtrace lines from within the source code parsed as Backtrace::Line's
-      def source_code_entries
-        @source_code_entries ||= project_entries - test_entries
-      end
-
-      # All lines of the backtrace converted to Backtrace::Line's
-      #
-      # @return [Line] the full set of backtrace lines parsed as Backtrace::Line instances
-      def parsed_entries
-        return [] if raw_backtrace.nil?
-
-        @parsed_entries ||= raw_backtrace.map { |entry| Backtrace::Line.parse_backtrace(entry) }
+      # @return [Line] the backtrace lines from within the source code parsed as Backtrace::LineParser's
+      def source_code_locations
+        @source_code_locations ||= project_locations.select(&:source_code_file?)
       end
     end
   end

data/lib/minitest/heat/hit.rb

@@ -5,8 +5,10 @@ require 'forwardable'
 module Minitest
   module Heat
     # Kind of like an issue, but instead of focusing on a failing test, it covers all issues for a
-    #   given file to build a heat map of the affected files
+    #   given file to build a heat map of the affected files and line numbers
     class Hit
+      Trace = Struct.new(:type, :line_number, :locations)
+
       # So we can sort hot spots by liklihood of being the most important spot to check out before
       #   trying to fix something. These are ranked based on the possibility they represent ripple
       #   effects where fixing one problem could potentially fix multiple other failures.
@@ -23,7 +25,7 @@ module Minitest
         slow: 0
       }.freeze
 
-      attr_reader :pathname, :issues
+      attr_reader :pathname, :issues, :lines
 
       # Creates an instance of a Hit for the given pathname. It must be the full pathname to
       #   uniquely identify the file or we could run into collisions that muddy the water and
@@ -34,16 +36,26 @@ module Minitest
       def initialize(pathname)
         @pathname = Pathname(pathname)
         @issues = {}
+        @lines = {}
       end
 
       # Adds a record of a given issue type for the line number
       # @param type [Symbol] one of Issue::TYPES
       # @param line_number [Integer,String] the line number to record the issue on
+      # @param backtrace: nil [Array<Location>] the project locations from the backtrace
       #
-      # @return [type] [description]
-      def log(type, line_number)
-        @issues[type] ||= []
-        @issues[type] << Integer(line_number)
+      # @return [void]
+      def log(type, line_number, backtrace: [])
+        line_number = Integer(line_number)
+        issue_type = type.to_sym
+
+        # Store issues by issue type with an array of line numbers
+        @issues[issue_type] ||= []
+        @issues[issue_type] << line_number
+
+        # Store issues by line number with an array of Traces
+        @lines[line_number.to_s] ||= []
+        @lines[line_number.to_s] << Trace.new(issue_type, line_number, backtrace)
       end
 
       # Calcuates an approximate weight to serve as a proxy for which files are most likely to be

data/lib/minitest/heat/issue.rb

@@ -18,7 +18,7 @@ module Minitest
       }.freeze
 
       attr_reader :assertions,
-                  :location,
+                  :locations,
                   :message,
                   :test_class,
                   :test_identifier,
@@ -27,7 +27,7 @@ module Minitest
                   :error,
                   :skipped
 
-      def_delegators :@location, :backtrace, :test_definition_line, :test_failure_line
+      def_delegators :@locations, :backtrace, :test_definition_line, :test_failure_line
 
       # Extracts the necessary data from result.
       # @param result [Minitest::Result] the instance of Minitest::Result to examine
@@ -39,7 +39,7 @@ module Minitest
 
         new(
           assertions: result.assertions,
-          location: result.source_location,
+          test_location: result.source_location,
           test_class: result.klass,
           test_identifier: result.name,
           execution_time: result.time,
@@ -47,7 +47,7 @@ module Minitest
           error: result.error?,
           skipped: result.skipped?,
           message: exception&.message,
-          backtrace: exception&.backtrace,
+          backtrace: exception&.backtrace
         )
       end
 
@@ -57,7 +57,7 @@ module Minitest
       # @param assertions: 1 [Integer] the number of assertions in the result
       # @param message: nil [String] exception if there is one
       # @param backtrace: [] [Array<String>] the array of backtrace lines from an exception
-      # @param location: nil [String] the location identifier for a test
+      # @param test_location: nil [Array<String, Integer>] the locations identifier for a test
       # @param test_class: nil [String] the class name for the test result's containing class
       # @param test_identifier: nil [String] the name of the test
       # @param execution_time: nil [Float] the time it took to run the test
@@ -66,11 +66,11 @@ module Minitest
       # @param skipped: false [Boolean] true if the test was skipped
       #
       # @return [type] [description]
-      def initialize(assertions: 1, location: ['unknown', 1], backtrace: [], execution_time: 0.0, message: nil, test_class: nil, test_identifier: nil, passed: false, error: false, skipped: false)
+      def initialize(assertions: 1, test_location: ['Unrecognized Test File', 1], backtrace: [], execution_time: 0.0, message: nil, test_class: nil, test_identifier: nil, passed: false, error: false, skipped: false)
         @message = message
 
         @assertions = Integer(assertions)
-        @location = Location.new(location, backtrace)
+        @locations = Locations.new(test_location, backtrace)
 
         @test_class = test_class
         @test_identifier = test_identifier
@@ -135,18 +135,18 @@ module Minitest
       # Determines if the issue is an exception that was raised from directly within a test
       #   definition. In these cases, it's more likely to be a quick fix.
       #
-      # @return [Boolean] true if the final location of the stacktrace was a test file
+      # @return [Boolean] true if the final locations of the stacktrace was a test file
       def in_test?
-        location.broken_test?
+        locations.broken_test?
       end
 
       # Determines if the issue is an exception that was raised from directly within the project
       #   codebase.
       #
-      # @return [Boolean] true if the final location of the stacktrace was a file from the project
+      # @return [Boolean] true if the final locations of the stacktrace was a file from the project
       #   (as opposed to a dependency or Ruby library)
       def in_source?
-        location.proper_failure?
+        locations.proper_failure?
       end
 
       # Was the result a pass? i.e. Skips aren't passes or failures. Slows are still passes. So this

data/lib/minitest/heat/location.rb

@@ -2,197 +2,178 @@
 
 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
+    # Consistent structure for extracting information about a given location. In addition to the
+    #   pathname to the file and the line number in the file, it can also include information about
+    #   the containing method or block and retrieve source code for the location.
     class Location
-      TestDefinition = Struct.new(:pathname, :line_number) do
-        def initialize(pathname, line_number)
-          @pathname = Pathname(pathname)
-          @line_number = Integer(line_number)
-          super
-        end
-      end
+      UNRECOGNIZED = '(Unrecognized File)'
+      UNKNOWN_MODIFICATION_TIME = Time.at(0)
+      UNKNOWN_MODIFICATION_SECONDS = -1
 
-      attr_reader :test_definition_location, :backtrace
+      attr_accessor :raw_pathname, :raw_line_number, :raw_container
 
-      def initialize(test_definition_location, backtrace = [])
-        @test_definition_location = TestDefinition.new(*test_definition_location)
-        @backtrace = Backtrace.new(backtrace)
+      # Initialize a new Location
+      #
+      # @param [Pathname, String] pathname: the pathname to the file
+      # @param [Integer] line_number: the line number of the location within the file
+      # @param [String] container: nil the containing method or block for the issue
+      #
+      # @return [self]
+      def initialize(pathname:, line_number:, container: nil)
+        @raw_pathname = pathname
+        @raw_line_number = line_number
+        @raw_container = container
       end
 
-      # Prints the pathname and line number of the location most likely to be the source of the
-      #   test failure
+      # Generates a formatted string describing the line of code similar to the original backtrace
       #
-      # @return [String] ex. 'path/to/file.rb:12'
+      # @return [String] a consistently-formatted, human-readable string about the line of code
       def to_s
-        "#{most_relevant_file}:#{most_relevant_failure_line}"
-      end
-
-      def local?
-        broken_test? || proper_failure?
+        "#{absolute_path}#{filename}:#{line_number} in `#{container}`"
       end
 
-      # 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.
+      # Generates a simplified location array with the pathname and line number
       #
-      # @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 == final_file
+      # @return [Array<Pathname, Integer>] a no-frills location pair
+      def to_a
+        [
+          pathname,
+          line_number
+        ]
       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.
+      # A short relative pathname and line number pair
       #
-      # @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?
+      # @return [String] the short filename/line number combo. ex. `dir/file.rb:23`
+      def short
+        "#{relative_filename}:#{line_number}"
       end
 
-
-
-      # The final location of the stacktrace regardless of whether it's from within the project
+      # Determine if there is a file and text at the given line number
       #
-      # @return [String] the relative path to the file from the project root
-      def final_file
-        Pathname(final_location.pathname)
+      # @return [Boolean] true if the file exists and has text at the given line number
+      def exists?
+        pathname.exist? && source_code.lines.any?
       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.
+      # The pathanme for the location. Written to be safe and fallbackto the project directory if
+      #   an exception is raised ocnverting the value to a pathname
       #
-      # @return [String] the relative path to the file from the project root
-      def most_relevant_file
-        Pathname(most_relevant_location.pathname)
+      # @return [Pathname] a pathname instance for the relevant file
+      def pathname
+        Pathname(raw_pathname)
+      rescue ArgumentError
+        Pathname(Dir.pwd)
       end
 
-      # The final location from the stacktrace that is a test file
+      # A safe interface to getting a string representing the path portion of the file
       #
-      # @return [String, nil] the relative path to the file from the project root
-      def test_file
-        Pathname(final_test_location.pathname)
+      # @return [String] either the path/directory portion of the file name or '(Unrecognized File)'
+      #   if the offending file can't be found for some reason
+      def path
+        pathname.exist? ? pathname.dirname.to_s : UNRECOGNIZED
       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 if final_source_code_location.nil?
+      def absolute_path
+        pathname.exist? ? "#{path}/" : UNRECOGNIZED
+      end
 
-        Pathname(final_source_code_location.pathname)
+      def relative_path
+        pathname.exist? ? absolute_path.delete_prefix("#{project_root_dir}/") : UNRECOGNIZED
       end
 
-      # The final location of the stacktrace from within the project (source code or test code)
+      # A safe interface for getting a string representing the filename portion of the file
       #
-      # @return [String] the relative path to the file from the project root
-      def project_file
-        return nil if project_location.nil?
-
-        Pathname(project_location.pathname)
+      # @return [String] either the filename portion of the file or '(Unrecognized File)'
+      #   if the offending file can't be found for some reason
+      def filename
+        pathname.exist? ? pathname.basename.to_s : UNRECOGNIZED
       end
 
+      def absolute_filename
+        pathname.exist? ? pathname.to_s : UNRECOGNIZED
+      end
 
-      # The line number of the `final_file` where the failure originated
-      #
-      # @return [Integer] line number
-      def final_failure_line
-        final_location.line_number
+      def relative_filename
+        pathname.exist? ? pathname.to_s.delete_prefix("#{project_root_dir}/") : UNRECOGNIZED
       end
 
-      # The line number of the `most_relevant_file` where the failure originated
+      # Line number identifying the specific line in the file
       #
-      # @return [Integer] line number
-      def most_relevant_failure_line
-        most_relevant_location.line_number
+      # @return [Integer] line number for the file
+      #
+      def line_number
+        Integer(raw_line_number)
+      rescue ArgumentError
+        1
       end
 
-      # The line number of the `test_file` where the test is defined
+      # The containing method or block details for the location
       #
-      # @return [Integer] line number
-      def test_definition_line
-        test_definition_location.line_number
+      # @return [String] the containing method of the line of code
+      def container
+        raw_container.nil? ? '(Unknown Container)' : String(raw_container)
       end
 
-      # The line number from within the `test_file` test definition where the failure occurred
+      # Looks up the source code for the location. Can return multiple lines of source code from
+      #   the surrounding lines of code for the primary line
+      #
+      # @param [Integer] max_line_count: 1 the maximum number of lines to return from the source
       #
-      # @return [Integer] line number
-      def test_failure_line
-        final_test_location.line_number
+      # @return [Source] an instance of Source for accessing lines and their line numbers
+      def source_code(max_line_count: 1)
+        Minitest::Heat::Source.new(
+          pathname.to_s,
+          line_number: line_number,
+          max_line_count: max_line_count
+        )
       end
 
-      # The line number of the `source_code_file` where the failure originated
+      # Determines if a given file is from the project directory
       #
-      # @return [Integer] line number
-      def source_code_failure_line
-        final_source_code_location&.line_number
+      # @return [Boolean] true if the file is in the project (source code or test)
+      def project_file?
+        path.include?(project_root_dir)
       end
 
-      # The line number of the `project_file` where the failure originated
+      # Determines if a given file follows the standard approaching to naming test files.
       #
-      # @return [Integer] line number
-      def project_failure_line
-        if !broken_test? && !source_code_file.nil?
-          source_code_failure_line
-        else
-          test_failure_line
-        end
+      # @return [Boolean] true if the file name starts with `test_` or ends with `_test.rb`
+      def test_file?
+        filename.to_s.start_with?('test_') || filename.to_s.end_with?('_test.rb')
       end
 
-      # The line number from within the `test_file` test definition where the failure occurred
+      # Determines if a given file is a non-test file from the project directory
       #
-      # @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.parsed_entries.any? ? backtrace.final_location : test_definition_location
+      # @return [Boolean] true if the file is in the project but not a test file
+      def source_code_file?
+        project_file? && !test_file?
       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.
+      # A safe interface to getting the last modified time for the file in question
       #
-      # @return [Array] file and line number of the most likely source of the problem
-      def most_relevant_location
-        [
-          final_source_code_location,
-          final_test_location,
-          final_location
-        ].compact.first
+      # @return [Time] the timestamp for when the file in question was last modified or `Time.at(0)`
+      #   if the offending file can't be found for some reason
+      def mtime
+        pathname.exist? ? pathname.mtime : UNKNOWN_MODIFICATION_TIME
       end
 
-      # Returns the final test location based on the backtrace if present. Otherwise falls back to
-      #   the test location which represents the test definition.
+      # A safe interface to getting the number of seconds since the file was modified
       #
-      # @return [Location] the final location from the test files
-      def final_test_location
-        backtrace.final_test_location || test_definition_location
+      # @return [Integer] the number of seconds since the file was modified or `-1` if the offending
+      #   file can't be found for some reason
+      def age_in_seconds
+        pathname.exist? ? seconds_ago : UNKNOWN_MODIFICATION_SECONDS
       end
 
-      # 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
+      private
+
+      def project_root_dir
+        Dir.pwd
       end
 
-      # 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
+      def seconds_ago
+        (Time.now - mtime).to_i
       end
     end
   end