minitest-heat 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 887dc01f3a08341f1e88cb24b539d0843cdce81fdb49246fbce8af875ff00d3f
-  data.tar.gz: 875d197ab5c65c2cb85b192201375be653ba30da2fc91896b4a3e61702cacefd
+  metadata.gz: e19adf67c01638e6cf3c53f5840c1d0a1fa82b3d41b3a8f1965d9ae24735e606
+  data.tar.gz: 3b8ced671f3aafaa3beaea45a0222ace34a8d37f3a0ea50b5085231d24e916cb
 SHA512:
-  metadata.gz: 6ef73c9df5b91b5950cc444f6ea7a18ccd867bda4fbdb015b8d713eaebe91b925a2cfb48b596a43a0d36af023dcb04f5c8ec0803602ab27bf709372fe6f9b0f3
-  data.tar.gz: d338944e9d32e8ec326cce9dbe861c5b8bec408bb455e4e984d45567ef9d9c5af9154f4475c2862ddc43778c95d8e58f12beef8757aa37f6b76d91da1b17a4c5
+  metadata.gz: 81c762ce455b684275d490f57839c4b1090ad7d0c723b4df479094a5aba5a722ffe74ef16e9b16ca549795c6cba95e863f7b2ff4b71476def525857c7c4dbffc
+  data.tar.gz: 889ebfb98b36a7d7c2877f89b89aabf39c610ae220badb85587c1a29bf99f5651a60107dec3c892364099974cbce7c8fc7eb2bccbbb9180ecae1578307f7e76c

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: garrettdimon

data/.github/workflows/main.yml

@@ -0,0 +1,23 @@
+name: Ruby
+
+on: [push,pull_request]
+
+env:
+  CI: true
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: [2.7.6, 3.0.4, 3.1.2, 3.2.0-preview2]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run Tests
+      run: bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+## [Unreleased]
+
+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.
+
+- Configurable Thresholds
+- Fixed a bug where `vendor/bundle` gem files were considered project source code files
+- Set up [GitHub Actions](https://github.com/garrettdimon/minitest-heat/actions) to ensure tests are run on Ubuntu latest and macOs for the [latest Ruby versions](https://github.com/garrettdimon/minitest-heat/blob/main/.github/workflows/main.yml)
+- Fixed some tests that were accidentally left path-dependent and couldn't pass on other machines
+
+## [1.0.0] - 2021-12-01
+
+Initial release.
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    minitest-heat (1.0.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,39 +1,9 @@
-# 🔥 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.
 
-It collects failures and inspects backtraces to identify patterns and provide a heat map summary of the files and line numbers that most frequently appear to be the causes of issues.
+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).
 
-![Example Heat Map Displayed by Minitest Heat](https://raw.githubusercontent.com/garrettdimon/minitest-heat/main/examples/map.png)
-
-It suppresses less critical issues like skips or slows when there are legitimate failures. It won't display information about slow tests unless all tests are passing (meaning no errors, failures, or skips)
-
-It presents failures differently depending on the context of failure. For instance, it treats exceptions differently based on whether they arose directly from a test or from source code. It also treats extremely slow tests differently from moderately slow tests.
-
-Markers get some nuance so that slow tests receive different markers than standard passing tests, and exception-triggered failures get different markers for source-code triggered exceptions (E) and test-triggered exceptions ('B' for 'Broken Test').
-
-![Example Markers Displayed by Minitest Heat](https://raw.githubusercontent.com/garrettdimon/minitest-heat/main/examples/markers.png)
-
-It also formats the failure details and backtraces to make them more scannable by emphasizing the project-relates lines from the backtrace.
-
-It intelligently recognizes when an exception was raised from a test defintion vs. when an exception is genuinely triggered from the source code in order to help focus on fixing deeper exceptions first.
-
-![Example Exceptions Displayed by Minitest Heat](https://raw.githubusercontent.com/garrettdimon/minitest-heat/main/examples/exceptions.png)
-
-Failures are displayed ina  fairly predictable manner but formatted to show the source code from the test so you can see the assertion that failed in addition to the summary of values that didn't satisfy the assertion.
-
-![Example Failures Displayed by Minitest Heat](https://raw.githubusercontent.com/garrettdimon/minitest-heat/main/examples/failures.png)
-
-Skipped tests are displayed in a simple manner as well so that it's easy to see the source of the skipped test as well as the reason it was skipped.
-
-![Example Skips Displayed by Minitest Heat](https://raw.githubusercontent.com/garrettdimon/minitest-heat/main/examples/skips.png)
-
-Slow tests get slightly more informative labels to indicate that they did pass, but they could use performance improvements. Tests that are particularly slow are called out with a little more emphasis so it's easier to focus on really slow tests first as they frequently represent the most potential for performance gains.
-
-![Example Slows Displayed by Minitest Heat](https://raw.githubusercontent.com/garrettdimon/minitest-heat/main/examples/slows.png)
-
-It also always displays the most significant issues at the bottom of the list in order to reduce the need to scroll up through the test failures. As you fix issues, the list becomes shorter, and the less significant issues will make there way to the bottom and be visible without scrolling.
-
-For some additional insight about priorities and how it works, this [Twitter thread](https://twitter.com/garrettdimon/status/1432703746526560266) is currently the best place to start.
+Or for some additional insight about priorities and how it works, this [Twitter thread](https://twitter.com/garrettdimon/status/1432703746526560266) is a good read.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -57,7 +27,18 @@ require 'minitest/heat'
 ```
 
 ## Configuration
-Minitest Heat doesn't currently offer a significant set of configuration options, but it will eventually support customizing the thresholds for "Slow" and "Painfully Slow". By default, it considers anything over 1.0s to be 'slow' and anything over 3.0s to be 'painfully slow'.
+Minitest Heat doesn't currently offer a significant set of configuration options, but the thresholds for "Slow" and "Painfully Slow" tests can be adjusted. By default, it considers anything over 1.0s to be 'slow' and anything over 3.0s to be 'painfully slow'.
+
+You can add a configuration block to your `test_helper.rb` file after the `require 'minitest/heat'` line.
+
+For example:
+
+```ruby
+Minitest::Heat.configure do |config|
+  config.slow_threshold = 0.01
+  config.painfully_slow_threshold = 0.5
+end
+```
 
 ## Development
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+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           = DEFAULTS[:slow_threshold]
+        @painfully_slow_threshold = DEFAULTS[:painfully_slow_threshold]
+      end
+    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,18 +120,14 @@ module Minitest
       #
       # @return [Float] number of seconds after which a test is considered slow
       def slow_threshold
-        # Using a method here so that this can eventually be configurable such that the constant is
-        # only a fallback value if it's not specified anywhere else
-        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
-        # Using a method here so that this can eventually be configurable such that the constant is
-        # only a fallback value if it's not specified anywhere else
-        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
@@ -204,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

@@ -131,9 +131,25 @@ 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)
+      # @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)
+        path.include?(project_root_dir) && !bundled_file? && !binstub_file?
+      end
+
+      # 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
+
+      # 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.
@@ -145,7 +161,7 @@ module Minitest
 
       # 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
+      # @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

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.0.0'
+    VERSION = '1.2.0'
   end
 end

data/lib/minitest/heat.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'heat/configuration'
 require_relative 'heat/backtrace'
 require_relative 'heat/hit'
 require_relative 'heat/issue'
@@ -32,5 +33,20 @@ module Minitest
   # Pulls from minitest-color as well:
   #   https://github.com/teoljungberg/minitest-color/blob/master/lib/minitest/color_plugin.rb
   module Heat
+    class << self
+      attr_writer :configuration
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.reset
+      @configuration = Configuration.new
+    end
+
+    def self.configure
+      yield(configuration)
+    end
   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.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Garrett Dimon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-01 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:
     - - ">="
@@ -130,9 +130,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -141,15 +144,11 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- examples/exceptions.png
-- examples/failures.png
-- examples/map.png
-- examples/markers.png
-- examples/skips.png
-- examples/slows.png
 - 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
 - lib/minitest/heat/issue.rb
 - lib/minitest/heat/location.rb
@@ -188,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.