minitest-heat 2.1.1 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc5068c6b1be1b2c9b8c7022da1df9ec2e03aa6c1aac37f579925973d55f8efb
-  data.tar.gz: f492675d598fd4cd51aeb04af25db4a12d3bc3d5b4c2bfbfc0c53e7f0dc44c61
+  metadata.gz: 5002a70b8781d74165f357718b769508a49fdb1f0de8c5321c7d2001c0e5a35c
+  data.tar.gz: 964154c41295fbbdf2ddd3d1111b917649d6e27ed9e741dabecab3701d81f3b6
 SHA512:
-  metadata.gz: 51f03b1d83f8ab6cd0b2ee95bb3e5308750cfe44ac2aa6095101e2e61dcae3a1f4176cd5c5d7d23ab844011ac162bf08ac3b2c79edeae2e310dba13b83cdf35d
-  data.tar.gz: 0b3e98d2e537e1b2df31f0800fab55bf72030be73f70eb823f7cd6799a8dd8c83daebc2692cfcd653017b3a21542a4de5215398456658f89131f7d132052b038
+  metadata.gz: de8d4e9468a3cd311517cb4c618d60c0b619f456df3f0f04a1184fd9c6f5aaa5bbb27b7790ad789f917d5f76e3f8dfb23bef247ec9010ced9b417f0c01476dc2
+  data.tar.gz: c3deb15724cf7f10656fb9ca5f2ad76079cd4c4ec3aa3a1a9eb907c246bad9197232ea43f78466456b47fa4d3414644613175390946678051f28247c92e33f69

data/.github/workflows/main.yml

@@ -27,11 +27,21 @@ jobs:
       run: bundle exec bundle-audit check
 
   test:
-    name: Test (Ruby ${{ matrix.ruby }})
+    name: Test (Ruby ${{ matrix.ruby }}, Minitest ${{ matrix.minitest }})
     strategy:
       fail-fast: false
       matrix:
         ruby: ['3.2', '3.3', '3.4', '4.0']
+        minitest: ['~> 5.0', '~> 6.0']
+        include:
+        - ruby: '3.2'
+          minitest: '= 5.22.3'
+        - ruby: '3.2'
+          minitest: '= 6.0.0'
+    env:
+      MINITEST_VERSION: ${{ matrix.minitest }}
+      BUNDLE_FROZEN: 'false'
+      BUNDLE_DEPLOYMENT: 'false'
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
@@ -40,10 +50,37 @@ jobs:
       with:
         ruby-version: ${{ matrix.ruby }}
         bundler: '2.7.2'
-        bundler-cache: true
+        bundler-cache: false
+    - name: Resolve selected Minitest
+      run: |
+        bundle lock --update minitest
+        bundle install
+    - name: Verify selected Minitest
+      run: |
+        bundle exec ruby -rminitest -e '
+          version = Gem.loaded_specs.fetch("minitest").version
+          abort "Wrong Minitest: #{version}" unless Gem::Requirement.new(ENV.fetch("MINITEST_VERSION")).satisfied_by?(version)
+          puts "Ruby #{RUBY_VERSION}, Minitest #{version}"
+        '
     - name: Run tests
       run: bundle exec rake test
 
+  required-tests:
+    # Keep the names required by the repository rules while gating on every
+    # supported Ruby/Minitest combination, including the version boundaries.
+    name: Test (Ruby ${{ matrix.ruby }})
+    needs: test
+    if: ${{ always() }}
+    strategy:
+      matrix:
+        ruby: ['3.2', '3.3', '3.4', '4.0']
+    runs-on: ubuntu-latest
+    env:
+      TEST_RESULT: ${{ needs.test.result }}
+    steps:
+    - name: Require the complete compatibility matrix to pass
+      run: test "$TEST_RESULT" = success
+
   changelog:
     name: Changelog
     runs-on: ubuntu-latest

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 ## [Unreleased]
 
+## [2.2.1] - 2026-09-24
+
+### Fixed
+- Display failures normally when a relevant source line contains non-ASCII text under a non-UTF-8 locale (such as `LC_ALL=C` or an unrecognized `LC_ALL`), or contains bytes that aren't valid UTF-8, instead of reporting that Heat couldn't display the failure. Source files are read as UTF-8 and invalid bytes are replaced, so a file that declares a non-UTF-8 encoding shows `�` for characters that aren't valid UTF-8.
+- Under a non-UTF-8 locale, report failures whose messages include non-ASCII text read at runtime (such as command output or file contents) instead of losing them, and keep `--heat-json` output valid when they occur.
+- Under a non-UTF-8 locale, report every failure in a project whose path contains non-ASCII characters, including errors that Minitest's own reporter can't display in that situation.
+
+## [2.2.0] - 2026-09-16
+
+### Added
+- Support Minitest 6 with explicit plugin activation (`Minitest.load :heat`) and compatible test filtering, while retaining automatic discovery on Minitest 5.
+
+### Changed
+- Require Minitest `>= 5.22.3, < 7` and test both major versions in CI. Applications using older Minitest versions must upgrade Minitest before upgrading Heat.
+
+### Fixed
+- Install only one Heat reporter when the plugin is loaded repeatedly, preserving valid JSON output.
+- Normalize relative result paths so test exceptions retain their classification and failure locations when invoked with relative filenames.
+- Return an unsuccessful exit status when Heat cannot record a result, and keep JSON output valid by sending reporter diagnostics to stderr.
+- Return an unsuccessful exit status when an explicit test filter matches no tests, consistent with Minitest; unfiltered empty runs remain successful.
+- Preserve namespaced method names and handle current Ruby quoting in backtrace details.
+- Tests classified as broken now cause an unsuccessful process exit instead of incorrectly reporting success to test runners and CI.
+- JSON output explicitly loads the time library so timestamp formatting works on Ruby 3.2 and 3.3 without relying on another dependency to load it.
+- Updated locked development dependencies for security advisories affecting concurrent-ruby, erb, and json.
+
 ## [2.1.1] - 2026-02-01
 
 ### Changed

data/Gemfile

@@ -5,6 +5,8 @@ source 'https://rubygems.org'
 # Runtime dependencies in minitest-heat.gemspec
 gemspec
 
+gem 'minitest', ENV.fetch('MINITEST_VERSION') if ENV['MINITEST_VERSION']
+
 # Development dependencies
 gem 'bundler-audit', '>= 0.9'
 gem 'debug'

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    minitest-heat (2.1.1)
-      minitest
+    minitest-heat (2.2.1)
+      minitest (>= 5.22.3, < 7)
 
 GEM
   remote: https://rubygems.org/
@@ -12,7 +12,7 @@ GEM
     bundler-audit (0.9.3)
       bundler (>= 1.2.0)
       thor (~> 1.0)
-    concurrent-ruby (1.3.6)
+    concurrent-ruby (1.3.8)
     date (3.5.1)
     debug (1.11.1)
       irb (~> 1.10)
@@ -47,7 +47,7 @@ GEM
       dry-inflector (~> 1.0)
       dry-logic (~> 1.4)
       zeitwerk (~> 2.6)
-    erb (6.0.1)
+    erb (6.0.7)
     erubi (1.13.1)
     flay (2.14.2)
       erubi (~> 1.10)
@@ -63,7 +63,7 @@ GEM
       pp (>= 0.6.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    json (2.18.0)
+    json (2.21.2)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.7.0)

data/README.md

@@ -20,12 +20,22 @@ Or install it yourself as:
 
     $ gem install minitest-heat
 
-And depending on your usage, you may need to require Minitest Heat in your test suite:
+Heat supports Ruby 3.2 and newer with Minitest `>= 5.22.3, < 7`.
+
+Minitest 5 discovers Heat automatically when the gem is available and plugin loading
+is enabled. Existing Minitest 5 setups do not need to change.
+
+Minitest 6 requires explicit plugin activation. Add this to your `test_helper.rb`:
 
 ```ruby
-require 'minitest/heat'
+require 'minitest/autorun'
+Minitest.load :heat
 ```
 
+`require 'minitest/heat'` loads Heat's library and configuration API; it does not
+activate the reporter on Minitest 6. Loading the Heat plugin more than once installs
+only one reporter.
+
 ## Prioritizing Your Work
 
 Minitest Heat surfaces the most impactful problems first so you can fix what matters without scrolling through noise.
@@ -145,6 +155,24 @@ FORCE_SLOWS=true       # No errors or skipped tests, just slow tests
 
 So to see the full context of a test suite, `IMPLODE=true bundle exec rake` will work its magic.
 
+### Testing Minitest compatibility
+
+The development lockfile retains Minitest 5.27.0. To select another supported version
+in a disposable checkout, use the same runner as CI:
+
+```sh
+export MINITEST_VERSION='~> 6.0'
+export BUNDLE_FROZEN=false BUNDLE_DEPLOYMENT=false
+bundle lock --update minitest
+bundle install
+CI=true bundle exec rake test
+```
+
+Use `~> 5.0` for the latest Minitest 5, or `= 5.22.3` / `= 6.0.0` for the supported
+boundaries. These commands update that checkout's lockfile; do not commit those
+version-selection changes. CI tests the latest 5.x and 6.x on Ruby 3.2–4.0 and both
+Minitest boundaries on Ruby 3.2. All compatibility jobs must pass before release.
+
 ## Contributing
 Bug reports and pull requests are welcome on GitHub at https://github.com/garrettdimon/minitest-heat. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/minitest-heat/blob/master/CODE_OF_CONDUCT.md).
 

data/favicon.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100">
+  <text y="0.9em" font-size="90">🔥</text>
+</svg>

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

@@ -12,8 +12,8 @@ module Minitest
         def self.read(raw_text)
           return nil if raw_text.nil? || raw_text.empty?
 
-          raw_pathname, raw_line_number, raw_container = raw_text.to_s.split(':')
-          raw_container = raw_container&.delete_prefix('in `')&.delete_suffix("'")
+          raw_pathname, raw_line_number, raw_container = raw_text.to_s.split(':', 3)
+          raw_container = raw_container&.sub(/\Ain [`']/, '')&.delete_suffix("'")
 
           ::Minitest::Heat::Location.new(
             pathname: raw_pathname,

data/lib/minitest/heat/hit.rb

@@ -88,7 +88,7 @@ module Minitest
 
       private
 
-      def relative_path = pathname.to_s.delete_prefix("#{Dir.pwd}/")
+      def relative_path = pathname.to_s.delete_prefix("#{Heat.project_root}/")
 
       def lines_summary
         line_numbers.map do |line_num|

data/lib/minitest/heat/issue.rb

@@ -35,7 +35,9 @@ module Minitest
       # @return [Issue] the instance of the issue to use for examining the result
       def self.from_result(result)
         # Not all results are failures, so we use the safe navigation operator
-        exception = result.failure&.exception
+        failure = result.failure
+        unexpected = failure.is_a?(Minitest::UnexpectedError)
+        exception = unexpected ? failure.error : failure&.exception
 
         new(
           assertions: result.assertions,
@@ -46,11 +48,33 @@ module Minitest
           passed: result.passed?,
           error: result.error?,
           skipped: result.skipped?,
-          message: exception&.message,
+          message: unexpected ? unexpected_error_message(exception) : exception&.message,
           backtrace: exception&.backtrace
         )
       end
 
+      # Matches the format of `Minitest::UnexpectedError#message` without calling it. Minitest
+      #   builds that message with a binary regular expression, which raises when the project path
+      #   and the backtrace contain non-ASCII characters under a non-UTF-8 locale.
+      # @param error [Exception] the exception wrapped by the unexpected error
+      #
+      # @return [String] the exception class, message, and filtered backtrace
+      def self.unexpected_error_message(error)
+        lines = (error.backtrace || []).map { |line| Heat.utf8(line) }
+        backtrace = Minitest.filter_backtrace(lines).map { |line| line.gsub(minitest_base_pattern, '') }
+
+        "#{error.class}: #{Heat.utf8(error.message)}\n    #{backtrace.join("\n    ")}"
+      end
+
+      # Minitest's pattern for the directory it loaded from, rebuilt as UTF-8 so it can match
+      #   UTF-8 backtraces. Reusing it strips the same prefix as Minitest even if a test changes
+      #   the working directory.
+      #
+      # @return [Regexp] the UTF-8 equivalent of `Minitest::UnexpectedError::BASE_RE`
+      def self.minitest_base_pattern
+        @minitest_base_pattern ||= Regexp.new(Heat.utf8(Minitest::UnexpectedError::BASE_RE.source))
+      end
+
       # Creates an instance of Issue. In general, the `from_result` approach will be more convenient
       #   for standard usage, but for lower-level purposes like testing, the initializer provides3
       #   more fine-grained control
@@ -67,10 +91,10 @@ module Minitest
       #
       # @return [type] [description]
       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
+        @message = Heat.utf8(message)
 
         @assertions = Integer(assertions)
-        @locations = Locations.new(test_location, backtrace)
+        @locations = Locations.new(test_location, backtrace&.map { |line| Heat.utf8(line) })
 
         @test_class = test_class
         @test_identifier = test_identifier

data/lib/minitest/heat/location.rb

@@ -68,9 +68,9 @@ module Minitest
       #
       # @return [Pathname] a pathname instance for the relevant file
       def pathname
-        Pathname(raw_pathname)
+        Pathname(Heat.utf8(File.expand_path(raw_pathname)))
       rescue ArgumentError
-        Pathname(Dir.pwd)
+        Pathname(Heat.project_root)
       end
 
       # A safe interface to getting a string representing the path portion of the file
@@ -163,7 +163,7 @@ module Minitest
 
       private
 
-      def project_root_dir = Dir.pwd
+      def project_root_dir = Heat.project_root
 
       def seconds_ago = (Time.now - mtime).to_i
     end

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

@@ -102,7 +102,7 @@ module Minitest
         end
 
         def file_and_line_number_tokens(location)
-          style = location.to_s.include?(Dir.pwd) ? :bold : :muted
+          style = location.to_s.include?(Heat.project_root) ? :bold : :muted
           [
             [style, location.filename],
             [:muted, ':'],

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

@@ -118,7 +118,7 @@ module Minitest
         end
 
         def pathname(hit)
-          directory = hit.pathname.dirname.to_s.delete_prefix("#{Dir.pwd}/")
+          directory = hit.pathname.dirname.to_s.delete_prefix("#{Heat.project_root}/")
           filename = hit.pathname.basename.to_s
 
           [

data/lib/minitest/heat/source.rb

@@ -44,14 +44,19 @@ module Minitest
 
       # Reads (and chomps) the lines of the target file
       #
-      # @return [type] [description]
+      # Ruby labels file contents with the locale's encoding, which is US-ASCII under `LC_ALL=C` or
+      # an unrecognized locale. Ruby source is UTF-8 by default, so lines are read as UTF-8
+      # regardless of locale, and bytes that aren't valid UTF-8 are replaced so that displaying
+      # them can't raise.
+      #
+      # @return [Array<String>] the chomped lines of the file as valid UTF-8
       def file_lines
-        @raw_lines ||= File.readlines(filename, chomp: true)
+        @raw_lines ||= File.readlines(filename, chomp: true, mode: 'rb').map { |line| Heat.utf8(line) }
         # Remove trailing empty lines, checking for nil/empty safely
         @raw_lines.pop while @raw_lines.any? && @raw_lines.last&.strip.to_s.empty?
 
         @raw_lines
-      rescue Errno::ENOENT, Errno::EACCES, Errno::EISDIR, IOError, Encoding::UndefinedConversionError
+      rescue Errno::ENOENT, Errno::EACCES, Errno::EISDIR, IOError
         # Occasionally, for a variety of reasons, a file can't be read. In those cases, it's best to
         # return no source code lines rather than have the test suite raise an error unrelated to
         # the code being tested because that gets confusing.

data/lib/minitest/heat/version.rb

@@ -2,6 +2,6 @@
 
 module Minitest
   module Heat
-    VERSION = '2.1.1'
+    VERSION = '2.2.1'
   end
 end

data/lib/minitest/heat.rb

@@ -48,5 +48,30 @@ module Minitest
     def self.configure
       yield(configuration)
     end
+
+    # Ruby labels text from outside Ruby source (paths, file contents, command output) with the
+    # locale's encoding, which is US-ASCII or binary under `LC_ALL=C` or an unrecognized locale.
+    # That text is overwhelmingly UTF-8, so unlabeled bytes are read as UTF-8 and text in any other
+    # encoding is converted. Anything that isn't valid UTF-8 is replaced so that comparing,
+    # displaying or serializing the text can't raise.
+    #
+    # @param text [String, nil] text from outside Ruby source
+    #
+    # @return [String, nil] valid UTF-8 text
+    def self.utf8(text)
+      return text unless text.is_a?(String)
+
+      case text.encoding
+      when Encoding::UTF_8, Encoding::US_ASCII, Encoding::BINARY
+        String.new(text, encoding: Encoding::UTF_8).scrub
+      else
+        text.encode(Encoding::UTF_8, invalid: :replace, undef: :replace)
+      end
+    end
+
+    # The directory the tests run from, which identifies project files
+    #
+    # @return [String] the current working directory as UTF-8
+    def self.project_root = utf8(Dir.pwd)
   end
 end

data/lib/minitest/heat_plugin.rb

@@ -11,6 +11,8 @@ module Minitest
   end
 
   def self.plugin_heat_init(options)
+    return if reporter.reporters.any? { |existing| existing.is_a?(HeatReporter) }
+
     io = options.fetch(:io, $stdout)
 
     reporter.reporters.reject! do |reporter|

data/lib/minitest/heat_reporter.rb

@@ -38,6 +38,7 @@ module Minitest
       super()
 
       @options = options
+      @recording_error = false
 
       @timer =    Heat::Timer.new
       @results =  Heat::Results.new
@@ -77,23 +78,25 @@ module Minitest
       # Show the marker (skip for JSON output)
       output.marker(issue.type) unless json_output?
     rescue StandardError => e
+      @recording_error = true
       display_exception_guidance(e)
     end
 
     def display_exception_guidance(exception)
-      output.newline
-      puts 'Sorry, but Minitest Heat encountered an exception recording an issue. Disabling Minitest Heat will get you back on track.'
-      puts 'Please use the following exception details to submit an issue at https://github.com/garrettdimon/minitest-heat/issues'
-      puts "#{exception.message}:"
+      warn ''
+      warn 'Sorry, but Minitest Heat encountered an exception recording an issue. Disabling Minitest Heat will get you back on track.'
+      warn 'Please use the following exception details to submit an issue at https://github.com/garrettdimon/minitest-heat/issues'
+      warn "#{exception.message}:"
       exception.backtrace.each do |line|
-        puts "  #{line}"
+        warn "  #{line}"
       end
-      output.newline
+      warn ''
     end
 
     # Outputs the summary of the run.
     def report
       timer.stop!
+      warn "Nothing ran for filter: #{test_filter}" if empty_filtered_run?
 
       if json_output?
         output_json
@@ -108,19 +111,24 @@ module Minitest
     def json_output? = options[:heat_json]
 
     # Did this run pass?
-    def passed? = results.errors.empty? && results.failures.empty?
+    def passed? = !@recording_error && !results.problems? && !empty_filtered_run?
 
     private
 
+    def test_filter = options[:include] || options[:filter]
+
+    def empty_filtered_run? = test_filter && timer.test_count.zero?
+
     def output_json
       require 'json'
+      require 'time'
       output.stream.puts JSON.pretty_generate(json_results)
     end
 
     def json_results
       {
         version: '1.0',
-        status: results.problems? ? 'failed' : 'passed',
+        status: passed? ? 'passed' : 'failed',
         timestamp: Time.now.iso8601,
         statistics: results.statistics,
         timing: timer.to_h,

data/minitest-heat.gemspec

@@ -31,5 +31,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'minitest'
+  spec.add_dependency 'minitest', '>= 5.22.3', '< 7'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minitest-heat
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.1
 platform: ruby
 authors:
 - Garrett Dimon
@@ -15,14 +15,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.22.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.22.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 description: Presents test results in a visual manner to guide you to where to look
   first.
 email:
@@ -50,6 +56,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- favicon.svg
 - lib/minitest/heat.rb
 - lib/minitest/heat/backtrace.rb
 - lib/minitest/heat/backtrace/line_count.rb