minitest-heat 2.1.0 → 2.2.0

data/lib/minitest/heat/hit.rb

@@ -7,6 +7,7 @@ module Minitest
     # 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 and line numbers
     class Hit
+      # Represents a single occurrence of an issue at a specific line
       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
@@ -62,23 +63,17 @@ module Minitest
       #   the most problematic across the various issue types
       #
       # @return [Integer] the problem weight for the file
-      def weight
-        issues.sum { |type, values| values.size * WEIGHTS.fetch(type, 0) }
-      end
+      def weight = issues.sum { |type, values| values.size * WEIGHTS.fetch(type, 0) }
 
       # The total issue count for the file across all issue types. Includes duplicates if they exist
       #
       # @return [Integer] the sum of the counts for all line numbers for all issue types
-      def count
-        issues.sum { |_type, values| values.size }
-      end
+      def count = issues.sum { |_type, values| values.size }
 
       # The full set of unique line numbers across all issue types
       #
       # @return [Array<Integer>] the full set of unique offending line numbers for the hit
-      def line_numbers
-        issues.values.flatten.uniq.sort
-      end
+      def line_numbers = issues.values.flatten.uniq.sort
 
       # Generates a hash representation for JSON serialization
       #
@@ -93,9 +88,7 @@ module Minitest
 
       private
 
-      def relative_path
-        pathname.to_s.delete_prefix("#{Dir.pwd}/")
-      end
+      def relative_path = pathname.to_s.delete_prefix("#{Dir.pwd}/")
 
       def lines_summary
         line_numbers.map do |line_num|

data/lib/minitest/heat/issue.rb

@@ -90,7 +90,7 @@ module Minitest
       #   painfully slow and should get more attention.
       #
       # @return [Symbol] issue type for classifying issues and reporting
-      def type # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      def type # rubocop:disable Metrics/PerceivedComplexity
         if error? && in_test?
           :broken
         elsif error?
@@ -112,88 +112,66 @@ module Minitest
       #   (Because slow tests still pass and wouldn't otherwise be considered an issue.)
       #
       # @return [Boolean] true if the test did not pass or if it was slow
-      def hit?
-        !passed? || slow? || painful?
-      end
+      def hit? = !passed? || slow? || painful?
 
       # The number, in seconds, for a test to be considered "slow"
       #
       # @return [Float] number of seconds after which a test is considered slow
-      def slow_threshold
-        Minitest::Heat.configuration.slow_threshold
-      end
+      def slow_threshold = Minitest::Heat.configuration.slow_threshold
 
       # The number, in seconds, for a test to be considered "painfully slow"
       #
       # @return [Float] number of seconds after which a test is considered painfully slow
-      def painfully_slow_threshold
-        Minitest::Heat.configuration.painfully_slow_threshold
-      end
+      def painfully_slow_threshold = Minitest::Heat.configuration.painfully_slow_threshold
 
       # Determines if a test should be considered slow by comparing it to the low end definition of
       #   what is considered slow.
       #
       # @return [Boolean] true if the test took longer to run than `slow_threshold`
-      def slow?
-        execution_time >= slow_threshold && execution_time < painfully_slow_threshold
-      end
+      def slow? = execution_time >= slow_threshold && execution_time < painfully_slow_threshold
 
       # Determines if a test should be considered painfully slow by comparing it to the high end
       #   definition of what is considered slow.
       #
       # @return [Boolean] true if the test took longer to run than `painfully_slow_threshold`
-      def painful?
-        execution_time >= painfully_slow_threshold
-      end
+      def painful? = execution_time >= painfully_slow_threshold
 
       # 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 locations of the stacktrace was a test file
-      def in_test?
-        locations.broken_test?
-      end
+      def in_test? = locations.broken_test?
 
       # Determines if the issue is an exception that was raised from directly within the project
       #   codebase.
       #
       # @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?
-        locations.proper_failure?
-      end
+      def in_source? = locations.proper_failure?
 
       # Was the result a pass? i.e. Skips aren't passes or failures. Slows are still passes. So this
       #   is purely a measure of whether the test explicitly passed all assertions
       #
       # @return [Boolean] false for errors, failures, or skips, true for passes (including slows)
-      def passed?
-        passed
-      end
+      def passed? = passed
 
       # Was there an exception that triggered a failure?
       #
       # @return [Boolean] true if there's an exception
-      def error?
-        error
-      end
+      def error? = error
 
       # Was the test skipped?
       #
       # @return [Boolean] true if the test was explicitly skipped, false otherwise
-      def skipped?
-        skipped
-      end
+      def skipped? = skipped
 
       # The more nuanced detail of the failure. If it's an error, digs into the exception. Otherwise
       #   uses the message from the result
       #
       # @return [String] a more detailed explanation of the issue
-      def summary
-        # When there's an exception, use the first line from the exception message. Otherwise,  the
-        #   message represents explanation for a test failure, and should be used in full
-        error? ? first_line_of_exception_message : message
-      end
+      # When there's an exception, use the first line from the exception message. Otherwise,  the
+      #   message represents explanation for a test failure, and should be used in full
+      def summary = error? ? first_line_of_exception_message : message
 
       # Returns the first line of an exception message when the issue is from a proper exception
       #   failure since exception messages can be long and cumbersome.
@@ -207,9 +185,7 @@ module Minitest
         text.size > exception_message_limit ? "#{text[0..exception_message_limit]}..." : text
       end
 
-      def exception_message_limit
-        200
-      end
+      def exception_message_limit = 200
 
       # Generates a hash representation for JSON serialization
       #

data/lib/minitest/heat/location.rb

@@ -30,19 +30,12 @@ module Minitest
       # Generates a formatted string describing the line of code similar to the original backtrace
       #
       # @return [String] a consistently-formatted, human-readable string about the line of code
-      def to_s
-        "#{absolute_path}#{filename}:#{line_number} in `#{container}`"
-      end
+      def to_s = "#{absolute_path}#{filename}:#{line_number} in `#{container}`"
 
       # Generates a simplified location array with the pathname and line number
       #
       # @return [Array<Pathname, Integer>] a no-frills location pair
-      def to_a
-        [
-          pathname,
-          line_number
-        ]
-      end
+      def to_a = [pathname, line_number]
 
       # Generates a hash representation for JSON serialization
       #
@@ -58,23 +51,24 @@ module Minitest
       # A short relative pathname and line number pair
       #
       # @return [String] the short filename/line number combo. ex. `dir/file.rb:23`
-      def short
-        "#{relative_filename}:#{line_number}"
-      end
+      def short = "#{relative_filename}:#{line_number}"
+
+      # Determine if the file exists on disk
+      #
+      # @return [Boolean] true if the file exists
+      def file_exists? = pathname.exist?
 
       # Determine if there is a file and text at the given line number
       #
       # @return [Boolean] true if the file exists and has text at the given line number
-      def exists?
-        pathname.exist? && source_code.lines.any?
-      end
+      def exists? = file_exists? && source_code.lines.any?
 
       # 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 [Pathname] a pathname instance for the relevant file
       def pathname
-        Pathname(raw_pathname)
+        Pathname(raw_pathname).expand_path
       rescue ArgumentError
         Pathname(Dir.pwd)
       end
@@ -83,33 +77,21 @@ module Minitest
       #
       # @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
+      def path = file_exists? ? pathname.dirname.to_s : UNRECOGNIZED
 
-      def absolute_path
-        pathname.exist? ? "#{path}/" : UNRECOGNIZED
-      end
+      def absolute_path = file_exists? ? "#{path}/" : UNRECOGNIZED
 
-      def relative_path
-        pathname.exist? ? absolute_path.delete_prefix("#{project_root_dir}/") : UNRECOGNIZED
-      end
+      def relative_path = file_exists? ? absolute_path.delete_prefix("#{project_root_dir}/") : UNRECOGNIZED
 
       # A safe interface for getting a string representing the filename portion of the file
       #
       # @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 filename = file_exists? ? pathname.basename.to_s : UNRECOGNIZED
 
-      def absolute_filename
-        pathname.exist? ? pathname.to_s : UNRECOGNIZED
-      end
+      def absolute_filename = file_exists? ? pathname.to_s : UNRECOGNIZED
 
-      def relative_filename
-        pathname.exist? ? pathname.to_s.delete_prefix("#{project_root_dir}/") : UNRECOGNIZED
-      end
+      def relative_filename = file_exists? ? pathname.to_s.delete_prefix("#{project_root_dir}/") : UNRECOGNIZED
 
       # Line number identifying the specific line in the file
       #
@@ -124,9 +106,7 @@ module Minitest
       # The containing method or block details for the location
       #
       # @return [String] the containing method of the line of code
-      def container
-        raw_container.nil? ? '(Unknown Container)' : String(raw_container)
-      end
+      def container = raw_container.nil? ? '(Unknown Container)' : String(raw_container)
 
       # 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
@@ -145,65 +125,47 @@ module Minitest
       # Determines if a given file is from the project directory
       #
       # @return [Boolean] true if the file is in the project (source code or test) but not vendored
-      def project_file?
-        path.include?(project_root_dir) && !bundled_file? && !binstub_file?
-      end
+      def project_file? = path.include?(project_root_dir) && !bundled_file? && !binstub_file?
 
       # Determines if the file is in the project `vendor/bundle` directory.
       #
       # @return [Boolean] true if the file is in `<project_root>/vendor/bundle
-      def bundled_file?
-        path.include?("#{project_root_dir}/vendor/bundle")
-      end
+      def bundled_file? = path.include?("#{project_root_dir}/vendor/bundle")
 
       # Determines if the file is in the project `bin` directory. With binstub'd gems, they'll
       #   appear to be source code because the code is located in the project directory. This helps
       #   make sure the backtraces don't think that's the case
       #
       # @return [Boolean] true if the file is in `<project_root>/bin
-      def binstub_file?
-        path.include?("#{project_root_dir}/bin")
-      end
+      def binstub_file? = path.include?("#{project_root_dir}/bin")
 
       # Determines if a given file follows the standard approaching to naming test files.
       #
       # @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
+      def test_file? = filename.to_s.start_with?('test_') || filename.to_s.end_with?('_test.rb')
 
       # Determines if a given file is a non-test file from the project directory
       #
       # @return [Boolean] true if the file is in the project but not a test file or vendored file
-      def source_code_file?
-        project_file? && !test_file?
-      end
+      def source_code_file? = project_file? && !test_file?
 
       # A safe interface to getting the last modified time for the file in question
       #
       # @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
+      def mtime = file_exists? ? pathname.mtime : UNKNOWN_MODIFICATION_TIME
 
       # A safe interface to getting the number of seconds since the file was modified
       #
       # @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
+      def age_in_seconds = file_exists? ? seconds_ago : UNKNOWN_MODIFICATION_SECONDS
 
       private
 
-      def project_root_dir
-        Dir.pwd
-      end
+      def project_root_dir = Dir.pwd
 
-      def seconds_ago
-        (Time.now - mtime).to_i
-      end
+      def seconds_ago = (Time.now - mtime).to_i
     end
   end
 end

data/lib/minitest/heat/locations.rb

@@ -28,27 +28,21 @@ module Minitest
       #   test failure
       #
       # @return [String] ex. 'path/to/file.rb:12'
-      def to_s
-        "#{most_relevant.absolute_filename}:#{most_relevant.line_number}"
-      end
+      def to_s = "#{most_relevant.absolute_filename}:#{most_relevant.line_number}"
 
       # 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 final file in the backtrace is the same as the test location file
-      def broken_test?
-        !test_failure.nil? && test_failure == final
-      end
+      def broken_test? = !test_failure.nil? && test_failure == final
 
       # 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.nil? && !broken_test?
-      end
+      def proper_failure? = !source_code.nil? && !broken_test?
 
       # 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
@@ -64,9 +58,7 @@ module Minitest
         ].compact.first
       end
 
-      def freshest
-        backtrace.recently_modified_locations.first
-      end
+      def freshest = backtrace.recently_modified_locations.first
 
       # Returns the final test location based on the backtrace if present. Otherwise falls back to
       #   the test location which represents the test definition. The `test_definition` attribute
@@ -74,32 +66,24 @@ module Minitest
       #   line from within the test where the problem occurred
       #
       # @return [Location] the final location from the test files
-      def test_failure
-        backtrace.test_locations.any? ? backtrace.test_locations.first : test_definition
-      end
+      def test_failure = backtrace.test_locations.any? ? backtrace.test_locations.first : test_definition
 
       # Returns the final source code location based on the backtrace
       #
       # @return [Location] the final location from the source code files
-      def source_code
-        backtrace.source_code_locations.first
-      end
+      def source_code = backtrace.source_code_locations.first
 
       # 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
-        backtrace.project_locations.any? ? backtrace.project_locations.first : test_definition
-      end
+      def project = backtrace.project_locations.any? ? backtrace.project_locations.first : test_definition
 
       # 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
-        backtrace.locations.any? ? backtrace.locations.first : test_definition
-      end
+      def final = backtrace.locations.any? ? backtrace.locations.first : test_definition
     end
   end
 end

data/lib/minitest/heat/map.rb

@@ -26,25 +26,19 @@ module Minitest
       # 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
+      def file_hits = hot_files.take(MAXIMUM_FILES_TO_SHOW)
 
       # Generates a hash representation for JSON serialization
       #
       # @return [Array<Hash>] array of hit hashes sorted by weight (highest first)
-      def to_h
-        hot_files.map(&:to_h)
-      end
+      def to_h = hot_files.map(&:to_h)
 
       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
+      def hot_files = hits.values.sort_by(&:weight).reverse
     end
   end
 end

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

@@ -23,16 +23,14 @@ module Minitest
         # Determines the number of lines to display from the backtrace.
         #
         # @return [Integer] the number of lines to limit the backtrace to
-        def line_count
-          # Defined as a method instead of using the constant directly in order to easily support
-          # adding options for controlling how many lines are displayed from a backtrace.
-          #
-          # For example, instead of a fixed number, the backtrace could dynamically calculate how
-          # many lines it should displaye in order to get to the origination point. Or it could have
-          # a default, but inteligently go back further if the backtrace meets some criteria for
-          # displaying more lines.
-          ::Minitest::Heat::Backtrace::LineCount.new(backtrace.locations).limit
-        end
+        # Defined as a method instead of using the constant directly in order to easily support
+        # adding options for controlling how many lines are displayed from a backtrace.
+        #
+        # For example, instead of a fixed number, the backtrace could dynamically calculate how
+        # many lines it should displaye in order to get to the origination point. Or it could have
+        # a default, but inteligently go back further if the backtrace meets some criteria for
+        # displaying more lines.
+        def line_count = ::Minitest::Heat::Backtrace::LineCount.new(backtrace.locations).limit
 
         # A subset of parsed lines from the backtrace.
         #
@@ -69,16 +67,14 @@ module Minitest
             *file_and_line_number_tokens(location),
             containining_element_token(location),
             source_code_line_token(location),
-            most_recently_modified_token(location),
+            most_recently_modified_token(location)
           ].compact
         end
 
         # Determines if all lines to be displayed are from within the project directory
         #
         # @return [Boolean] true if all lines of the backtrace being displayed are from the project
-        def all_backtrace_from_project?
-          backtrace_locations.all?(&:project_file?)
-        end
+        def all_backtrace_from_project? = backtrace_locations.all?(&:project_file?)
 
         # Determines if the file referenced by a backtrace line is the most recently modified file
         #   of all the files referenced in the visible backtrace locations.
@@ -87,16 +83,12 @@ module Minitest
         #
         # @return [<type>] <description>
         #
-        def most_recently_modified?(location)
-          # If there's more than one line being displayed (otherwise, with one line, of course it's
-          # the most recently modified because there_aren't any others) and the current line is the
-          # same as the freshest location in the backtrace
-          backtrace_locations.size > 1 && location == locations.freshest
-        end
+        # If there's more than one line being displayed (otherwise, with one line, of course it's
+        # the most recently modified because there_aren't any others) and the current line is the
+        # same as the freshest location in the backtrace
+        def most_recently_modified?(location) = backtrace_locations.size > 1 && location == locations.freshest
 
-        def indentation_token
-          [:default, ' ' * indentation]
-        end
+        def indentation_token = [:default, ' ' * indentation]
 
         def path_token(location)
           # If the line is a project file, help it stand out from the backtrace noise
@@ -145,9 +137,7 @@ module Minitest
         #   option that would reduce the space used.
         #
         # @return [type] [description]
-        def indentation
-          DEFAULT_INDENTATION_SPACES
-        end
+        def indentation = DEFAULT_INDENTATION_SPACES
       end
     end
   end

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

@@ -4,7 +4,7 @@ module Minitest
   module Heat
     class Output
       # Formats issues to output based on the issue type
-      class Issue # rubocop:disable Metrics/ClassLength
+      class Issue
         attr_accessor :issue, :locations
 
         def initialize(issue)

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

@@ -19,7 +19,7 @@ module Minitest
             next unless relevant_issue_types?(hit)
 
             # Add a new line
-            @tokens << [[:muted, ""]]
+            @tokens << [[:muted, '']]
 
             # Build the summary line for the file
             @tokens << file_summary_tokens(hit)
@@ -54,10 +54,10 @@ module Minitest
           # 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) }
+          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)
@@ -80,7 +80,7 @@ module Minitest
             [:muted, ':'],
             [:default, location.line_number],
             [:muted, " in #{location.container}"],
-            [:muted, " #{Output::SYMBOLS[:arrow]} `#{location.source_code.line.strip}`"],
+            [:muted, " #{Output::SYMBOLS[:arrow]} `#{location.source_code.line.strip}`"]
           ]
         end
 
@@ -160,7 +160,7 @@ module Minitest
         def line_number_token(style, line_number, frequency)
           if frequency > 1
             [
-              [style, "#{line_number}"],
+              [style, line_number.to_s],
               [:muted, "✕#{frequency} "]
             ]
           else

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

@@ -33,19 +33,13 @@ module Minitest
           @issue_type = issue_type
         end
 
-        def token
-          [style, symbol]
-        end
+        def token = [style, symbol]
 
         private
 
-        def style
-          STYLES.fetch(issue_type, :default)
-        end
+        def style = STYLES.fetch(issue_type, :default)
 
-        def symbol
-          SYMBOLS.fetch(issue_type, '?')
-        end
+        def symbol = SYMBOLS.fetch(issue_type, '?')
       end
     end
   end