minitest-heat 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf4115aeb375e2fef72d98e7f706dc023ae1e61fa9d1fc3e8f490797a31e2ae0
-  data.tar.gz: ba968646ff2b12fa2891b47fb58d2d98330d117c2a038e29f1caef449bfbd857
+  metadata.gz: e19adf67c01638e6cf3c53f5840c1d0a1fa82b3d41b3a8f1965d9ae24735e606
+  data.tar.gz: 3b8ced671f3aafaa3beaea45a0222ace34a8d37f3a0ea50b5085231d24e916cb
 SHA512:
-  metadata.gz: 67a7e17e10fe0f75f5a5cad93bd97a7f4f87e136e6dfe6f338b0e8df0e80f83533d8e70b07e218fc0431e3e7c5bbdc2d14f71c8c3d32a98d846f276cb573f225
-  data.tar.gz: 2a0cb94a433fe5b69bef58cd4fe24393adaad5bf69e76120b9296a3f8224b2e9a55da10e176bb0fa13e228e3aa57f0836d61fe0ca8116bd973681cc7e458912f
+  metadata.gz: 81c762ce455b684275d490f57839c4b1090ad7d0c723b4df479094a5aba5a722ffe74ef16e9b16ca549795c6cba95e863f7b2ff4b71476def525857c7c4dbffc
+  data.tar.gz: 889ebfb98b36a7d7c2877f89b89aabf39c610ae220badb85587c1a29bf99f5651a60107dec3c892364099974cbce7c8fc7eb2bccbbb9180ecae1578307f7e76c

data/.github/workflows/main.yml

@@ -10,7 +10,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest]
-        ruby: [2.5.9, 2.6.9, 2.7.5, 3.0.3, 3.1.0-preview1]
+        ruby: [2.7.6, 3.0.4, 3.1.2, 3.2.0-preview2]
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 Nothing at the moment.
 
+## [1.2.0] - 2022-10-31
+
+Mainly some improvements to make test failures more resilient and improve the formatting when there are issues.
+
+- Don't consider binstubs project files when colorizing the stacktrace.
+- Switch debugging from Pry to debug
+- Ensure overly-long exception messages are truncated to reduce excessive scrolling
+- Make backtrace display smarter about how many lines to display
+- Fix bug that was incorrectly deleting the bin directory
+- Prepare for better handling of "stack level too deep" traces
+
 ## [1.1.0] - 2021-12-09
 
 The biggest update is that the slow thresholds are now configurable.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    minitest-heat (1.1.0)
+    minitest-heat (1.2.0)
       minitest
 
 GEM
@@ -9,33 +9,38 @@ GEM
   specs:
     ast (2.4.2)
     awesome_print (1.9.2)
-    coderay (1.1.3)
-    dead_end (3.0.2)
+    dead_end (4.0.0)
+    debug (1.6.2)
+      irb (>= 1.3.6)
+      reline (>= 0.3.1)
     docile (1.4.0)
-    method_source (1.0.0)
-    minitest (5.14.4)
-    parallel (1.21.0)
-    parser (3.0.2.0)
+    io-console (0.5.11)
+    irb (1.4.1)
+      reline (>= 0.3.0)
+    json (2.6.2)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.2.1)
       ast (~> 2.4.1)
-    pry (0.14.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (12.3.3)
-    regexp_parser (2.1.1)
+    regexp_parser (2.5.0)
+    reline (0.3.1)
+      io-console (~> 0.5)
     rexml (3.2.5)
-    rubocop (1.22.3)
+    rubocop (1.36.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.12.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.13.0)
-      parser (>= 3.0.1.1)
-    rubocop-minitest (0.15.2)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    rubocop-minitest (0.22.1)
       rubocop (>= 0.90, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
@@ -45,18 +50,19 @@ GEM
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.3)
-    unicode-display_width (2.1.0)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (2.3.0)
 
 PLATFORMS
-  ruby
+  arm64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
   awesome_print
   dead_end
+  debug
   minitest (~> 5.0)
   minitest-heat!
-  pry
   rake (~> 12.0)
   rubocop
   rubocop-minitest
@@ -64,4 +70,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   2.2.30
+   2.3.22

data/README.md

@@ -1,7 +1,7 @@
-# 🔥 Minitest::Heat 🔥
-Minitest::Heat helps you identify problems faster so you can more efficiently resolve test failures. It does this through a few different methods.
+# 🔥 Minitest Heat 🔥
+Minitest Heat helps you identify problems faster so you can more efficiently resolve test failures by generating a heat map that shows where failures are concentrated.
 
-For a more detailed explanation of Minitest Heat with screenshots, [head over the wiki for the full story](https://github.com/garrettdimon/minitest-heat/wiki).
+For a more detailed explanation of Minitest Heat with screenshots, [head over to the wiki for the full story](https://github.com/garrettdimon/minitest-heat/wiki).
 
 Or for some additional insight about priorities and how it works, this [Twitter thread](https://twitter.com/garrettdimon/status/1432703746526560266) is a good read.
 

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Minitest
+  module Heat
+    class Backtrace
+      # Determines an optimal line count for backtrace locations in order to have relevant
+      #   information but keep the backtrace as compact as possible
+      class LineCount
+        DEFAULT_LINE_COUNT = 20
+
+        attr_accessor :locations
+
+        def initialize(locations)
+          @locations = locations
+        end
+
+        def earliest_project_location
+          locations.rindex { |element| element.project_file? }
+        end
+
+        def max_location
+          locations.size - 1
+        end
+
+        def limit
+          [
+            DEFAULT_LINE_COUNT,
+            earliest_project_location,
+            max_location
+          ].compact.min
+        end
+      end
+    end
+  end
+end

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

@@ -11,7 +11,7 @@ module Minitest
         # 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("'")
+          raw_container = raw_container&.delete_prefix('in `')&.delete_suffix("'")
 
           ::Minitest::Heat::Location.new(
             pathname: raw_pathname,

data/lib/minitest/heat/backtrace.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'backtrace/line_count'
 require_relative 'backtrace/line_parser'
 
 module Minitest

data/lib/minitest/heat/configuration.rb

@@ -6,12 +6,17 @@ module Minitest
   module Heat
     # For managing configuration options on how Minitest Heat should handle results
     class Configuration
+      DEFAULTS = {
+        slow_threshold:           1.0,
+        painfully_slow_threshold: 3.0
+      }.freeze
+
       attr_accessor :slow_threshold,
                     :painfully_slow_threshold
 
       def initialize
-        @slow_threshold = 1.0
-        @painfully_slow_threshold = 3.0
+        @slow_threshold           = DEFAULTS[:slow_threshold]
+        @painfully_slow_threshold = DEFAULTS[:painfully_slow_threshold]
       end
     end
   end

data/lib/minitest/heat/issue.rb

@@ -10,12 +10,12 @@ module Minitest
 
       TYPES = %i[error broken failure skipped painful slow].freeze
 
-      # Long-term, these could be configurable so that people can determine their own thresholds of
-      # pain for slow tests
-      SLOW_THRESHOLDS = {
-        slow: 1.0,
-        painful: 3.0
-      }.freeze
+      # # Long-term, these could be configurable so that people can determine their own thresholds of
+      # # pain for slow tests
+      # SLOW_THRESHOLDS = {
+      #   slow: 1.0,
+      #   painful: 3.0
+      # }.freeze
 
       attr_reader :assertions,
                   :locations,
@@ -120,14 +120,14 @@ module Minitest
       #
       # @return [Float] number of seconds after which a test is considered slow
       def slow_threshold
-        Minitest::Heat.configuration.slow_threshold || SLOW_THRESHOLDS[:slow]
+        Minitest::Heat.configuration.slow_threshold
       end
 
       # 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 || SLOW_THRESHOLDS[:painful]
+        Minitest::Heat.configuration.painfully_slow_threshold
       end
 
       # Determines if a test should be considered slow by comparing it to the low end definition of
@@ -200,7 +200,13 @@ module Minitest
       #
       # @return [String] the first line of the exception message
       def first_line_of_exception_message
-        message.split("\n")[0]
+        text = message.split("\n")[0]
+
+        text.size > exception_message_limit ? "#{text[0..exception_message_limit]}..." : text
+      end
+
+      def exception_message_limit
+        200
       end
     end
   end

data/lib/minitest/heat/location.rb

@@ -133,7 +133,7 @@ module Minitest
       #
       # @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?
+        path.include?(project_root_dir) && !bundled_file? && !binstub_file?
       end
 
       # Determines if the file is in the project `vendor/bundle` directory.
@@ -143,6 +143,15 @@ module Minitest
         path.include?("#{project_root_dir}/vendor/bundle")
       end
 
+      # 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
+
       # 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`
@@ -154,7 +163,7 @@ module Minitest
       #
       # @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? && !bundled_file?
+        project_file? && !test_file?
       end
 
       # A safe interface to getting the last modified time for the file in question

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

@@ -5,7 +5,6 @@ module Minitest
     class Output
       # Builds the collection of tokens for displaying a backtrace when an exception occurs
       class Backtrace
-        DEFAULT_LINE_COUNT = 10
         DEFAULT_INDENTATION_SPACES = 2
 
         attr_accessor :locations, :backtrace
@@ -25,14 +24,14 @@ module Minitest
         #
         # @return [Integer] the number of lines to limit the backtrace to
         def line_count
-          # Defined as a method instead of using the constant directlyr in order to easily support
+          # 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.
-          DEFAULT_LINE_COUNT
+          ::Minitest::Heat::Backtrace::LineCount.new(backtrace.locations).limit
         end
 
         # A subset of parsed lines from the backtrace.
@@ -49,7 +48,7 @@ module Minitest
           #   it could display the entire backtrace without filtering anything.
           # - It could scan the backtrace to the first appearance of project files and then display
           #   all of the lines that occurred after that instance
-          # - It coudl filter the lines differently whether the issue originated from a test or from
+          # - It could filter the lines differently whether the issue originated from a test or from
           #   the source code.
           # - It could allow supporting a "compact" or "robust" reporter style so that someone on
           #   a smaller screen could easily reduce the information shown so that the results could

data/lib/minitest/heat/version.rb

@@ -2,6 +2,6 @@
 
 module Minitest
   module Heat
-    VERSION = '1.1.0'
+    VERSION = '1.2.0'
   end
 end

data/minitest-heat.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'Presents test results in a visual manner to guide you to where to look first.'
   spec.homepage      = 'https://github.com/garrettdimon/minitest-heat'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.9')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.6')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['bug_tracker_uri'] = 'https://github.com/garrettdimon/minitest-heat/issues'
@@ -34,7 +34,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'awesome_print'
   spec.add_development_dependency 'dead_end'
-  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'debug'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-minitest'
   spec.add_development_dependency 'rubocop-rake'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest-heat
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Garrett Dimon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-09 00:00:00.000000000 Z
+date: 2022-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -146,6 +146,7 @@ files:
 - bin/setup
 - lib/minitest/heat.rb
 - lib/minitest/heat/backtrace.rb
+- lib/minitest/heat/backtrace/line_count.rb
 - lib/minitest/heat/backtrace/line_parser.rb
 - lib/minitest/heat/configuration.rb
 - lib/minitest/heat/hit.rb
@@ -186,14 +187,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.9
+      version: 2.7.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.22
 signing_key:
 specification_version: 4
 summary: Presents test results in a visual manner to guide you to where to look first.