minitest-heat 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de79ea86107b9d5183d3353e2c4cf6b8f5f61601080e781c611f305a4e192afd
-  data.tar.gz: b3deddb67ef5fd2b069d2f3fe3edd754cb91df9322390dfdbe7845cab4ab73a0
+  metadata.gz: 5002a70b8781d74165f357718b769508a49fdb1f0de8c5321c7d2001c0e5a35c
+  data.tar.gz: 964154c41295fbbdf2ddd3d1111b917649d6e27ed9e741dabecab3701d81f3b6
 SHA512:
-  metadata.gz: ce4bf462ee43dba7da46d8455caecb242f97c03a596af283c3627d50236562eca481bc6a1fbffa025b48ecfb91692c2d2a527a9a1c55603e241335256aa20b27
-  data.tar.gz: d80070c1d120c17a4fb700980b0107b506c3046ac19463e5e89e9fa0e8ca0e3b614adde6426f1a001c6ef1492df6ce3c33af9a11d95cd63495be5eb064e26808
+  metadata.gz: de8d4e9468a3cd311517cb4c618d60c0b619f456df3f0f04a1184fd9c6f5aaa5bbb27b7790ad789f917d5f76e3f8dfb23bef247ec9010ced9b417f0c01476dc2
+  data.tar.gz: c3deb15724cf7f10656fb9ca5f2ad76079cd4c4ec3aa3a1a9eb907c246bad9197232ea43f78466456b47fa4d3414644613175390946678051f28247c92e33f69

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    minitest-heat (2.2.0)
+    minitest-heat (2.2.1)
       minitest (>= 5.22.3, < 7)
 
 GEM

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).expand_path
+        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.2.0'
+    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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minitest-heat
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Garrett Dimon