minitest-heat 2.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b840b58e068cbca8670479e03202c33c1ca6084ac72c1b84b862f57098a375d
-  data.tar.gz: ec29ff00bc92f9d1983d988a742f47272354f7137e50e1b67ff10da2b237a486
+  metadata.gz: fc5068c6b1be1b2c9b8c7022da1df9ec2e03aa6c1aac37f579925973d55f8efb
+  data.tar.gz: f492675d598fd4cd51aeb04af25db4a12d3bc3d5b4c2bfbfc0c53e7f0dc44c61
 SHA512:
-  metadata.gz: b6b68ad844a22dd0b583e0def4bd57dac55bf4e7752e0f96df9db64c7d40edaf794c7cdd5e49261af1212e47e74e8fbfdd7c783ad1c8a2aaadc073b3b7435f74
-  data.tar.gz: 56de30c8534a10ac407aed531e1db3affbf419a760b39bb2d22aae8f2431c80ea08cced84b64691d377386d852acd3b758d9d8c8069490354165f97b557b115f
+  metadata.gz: 51f03b1d83f8ab6cd0b2ee95bb3e5308750cfe44ac2aa6095101e2e61dcae3a1f4176cd5c5d7d23ab844011ac162bf08ac3b2c79edeae2e310dba13b83cdf35d
+  data.tar.gz: 0b3e98d2e537e1b2df31f0800fab55bf72030be73f70eb823f7cd6799a8dd8c83daebc2692cfcd653017b3a21542a4de5215398456658f89131f7d132052b038

data/.flayignore

@@ -0,0 +1 @@
+./test/**/*.rb

data/.reek.yml

@@ -0,0 +1,87 @@
+# Reek configuration for minitest-heat
+# https://github.com/troessner/reek/blob/master/docs/defaults.reek.yml
+
+detectors:
+  # --- Disabled: conflicts with standard Ruby patterns ---
+
+  # Flags attr_accessor as a writable attribute. Standard Ruby; no value suppressing.
+  Attribute:
+    enabled: false
+
+  # Flags keyword arguments like `clear_screen: false`. Idiomatic Ruby.
+  BooleanParameter:
+    enabled: false
+
+  # Flags branching on method arguments. Appropriate for configuration and options.
+  ControlParameter:
+    enabled: false
+
+  # Issue#initialize wraps Minitest::Result data — all parameters are necessary.
+  # Map#add takes pathname, line_number, type, and backtrace — all distinct inputs.
+  LongParameterList:
+    max_params: 4
+    exclude:
+      - 'Minitest::Heat::Issue#initialize'
+
+  # --- Threshold adjustments: defaults are too aggressive ---
+
+  # Default max_calls (1) flags every repeated method call. Raise to 3 so only
+  # genuine duplication is flagged, not incidental reuse.
+  DuplicateMethodCall:
+    max_calls: 3
+
+  # Guard clauses like `file_exists?` and mode checks like `json_output?` are
+  # repeated across public methods by design, not duplication.
+  RepeatedConditional:
+    enabled: false
+
+  # Default max_statements (5) flags nearly every non-trivial method. 12 keeps
+  # the check useful while allowing token-building methods that are linear and clear.
+  TooManyStatements:
+    max_statements: 12
+
+  # Location is a comprehensive value object with many accessors.
+  # 30 keeps the check useful for genuinely bloated classes.
+  TooManyMethods:
+    max_methods: 30
+
+  # Flags nil checks (`nil?`, `!x`). Legitimate for optional settings and
+  # backtrace data where nil is a normal value.
+  NilCheck:
+    enabled: false
+
+  # Output classes format data from domain objects — accessing their attributes
+  # is the entire purpose, not a design flaw.
+  FeatureEnvy:
+    enabled: false
+
+  # Flags private methods that don't reference instance state. These methods
+  # logically belong to their class even without direct instance access.
+  UtilityFunction:
+    enabled: false
+
+  # ManualDispatch is legitimate for duck-typing checks (respond_to? + send).
+  ManualDispatch:
+    enabled: false
+
+  # Nested iterators are common in token-building code where lines contain tokens.
+  # Two levels deep is readable and appropriate for this codebase.
+  NestedIterators:
+    max_allowed_nesting: 2
+
+  # Issue wraps a Minitest::Result with classification; 9 ivars reflect the data it needs.
+  # Source has 5 ivars for file reading context — all necessary.
+  TooManyInstanceVariables:
+    max_instance_variables: 9
+
+  # Timer.start! and Timer.stop! are mutating operations with no safe equivalent.
+  # The bang convention here signals state mutation, not a safe/unsafe pair.
+  MissingSafeMethod:
+    enabled: false
+
+  # RuboCop enforces `e` for rescue variables (Naming/RescuedExceptionsVariableName).
+  # Allow `e` to avoid conflicts between the two tools.
+  UncommunicativeVariableName:
+    accept:
+      - e
+      - i

data/.reviewer.yml

@@ -0,0 +1,87 @@
+---
+# Review gem dependencies for security issues
+bundle_audit:
+  name: Bundle Audit
+  description: Review gem dependencies for security issues
+  tags: [security, dependencies, ruby]
+  commands:
+    install: bundle exec gem install bundler-audit
+    prepare: bundle exec bundle-audit update
+    review: bundle exec bundle-audit check --no-update
+
+# Review Ruby syntax and formatting for consistency
+rubocop:
+  name: RuboCop
+  description: Review Ruby syntax and formatting for consistency
+  tags: [ruby, syntax]
+  commands:
+    install: bundle exec gem install rubocop
+    review: bundle exec rubocop --parallel
+    format: bundle exec rubocop --auto-correct
+  files:
+    flag: ''
+    separator: ' '
+    pattern: '*.rb'
+
+# Examine Ruby classes for code smells
+reek:
+  disabled: true
+  name: Reek
+  description: Examine Ruby classes for code smells
+  tags: [ruby, quality]
+  links:
+    home: https://github.com/troessner/reek
+    install: https://github.com/troessner/reek#quickstart
+  max_exit_status: 2
+  commands:
+    install: bundle exec gem install reek
+    review: bundle exec reek --config .reek.yml lib/
+  files:
+    flag: ''
+    separator: ' '
+    pattern: '*.rb'
+
+# Reports most tortured ruby code in a pain report
+flog:
+  disabled: true
+  name: Flog
+  description: Reports your most tortured ruby code in an easy to read pain report.
+  tags: [ruby, quality]
+  links:
+    home: https://ruby.sadi.st/Flog.html
+    install: https://ruby.sadi.st/Flog.html
+  commands:
+    install: bundle exec gem install flog
+    review: bundle exec flog -g lib
+  flags:
+    threshold: 10
+    group:
+    methods-only:
+
+# Review ruby code for structural similarities
+flay:
+  disabled: true
+  name: Flay
+  description: Review ruby code for structural similarities and refactoring opportunities.
+  tags: [ruby, quality]
+  links:
+    home: https://ruby.sadi.st/Flay.html
+    install: https://ruby.sadi.st/Flay.html
+  commands:
+    install: bundle exec gem install flay
+    review: bundle exec flay ./lib
+  flags:
+    liberal:
+    summary:
+
+# Unit tests and coverage
+tests:
+  name: Minitest
+  description: Unit tests and coverage
+  tags: [ruby, tests]
+  commands:
+    review: bundle exec rake test
+  files:
+    review: bundle exec ruby -Itest
+    pattern: '*_test.rb'
+    map_to_tests: minitest

data/.reviewer_history.yml

@@ -0,0 +1,42 @@
+---
+:bundle_audit:
+  :last_status: :passed
+  :last_prepared_at: '2026-02-01 10:15:13 -0700'
+  bundle exec bundle-audit update:
+  - 0.94
+  bundle exec bundle-audit check --no-update:
+  - 0.2
+  - 0.15
+  - 0.23
+  - 0.21
+  - 0.29
+  :last_failed_files:
+:rubocop:
+  :last_status: :passed
+  :last_failed_files:
+  bundle exec rubocop --parallel:
+  - 1.4
+  - 1.11
+  - 1.76
+:tests:
+  :last_status: :passed
+  :last_failed_files:
+  bundle exec rake test:
+  - 0.54
+  - 0.5
+  - 0.66
+:reek:
+  :last_status: :passed
+  :last_failed_files:
+  bundle exec reek --config .reek.yml lib/:
+  - 0.91
+:flog:
+  :last_status: :passed
+  :last_failed_files:
+  bundle exec flog -g lib --threshold 10 --group --methods-only:
+  - 0.38
+:flay:
+  :last_status: :passed
+  :last_failed_files:
+  bundle exec flay ./lib --liberal --summary:
+  - 0.36

data/.rubocop.yml

@@ -7,14 +7,26 @@ AllCops:
   Exclude:
     - 'bin/**/*'
     - 'test/files/source.rb' # An example test file for reading source code
+    - 'test/minitest/contrived_*' # Intentional failures for testing the reporter
 
 # Let's aim for 80, but we don't need to be nagged if we judiciously go over.
 Layout/LineLength:
   Enabled: false
 
-# One case statement in a single method isn't complex.
+# One case statement in a single method isn't complex. Issue classification
+# methods use cascading conditionals that are clear and linear.
 Metrics/CyclomaticComplexity:
-  AllowedMethods: ['case']
+  AllowedMethods: ['case', 'type', 'issue_label']
+
+# Issue#initialize wraps Minitest::Result with keyword args — all are needed.
+# build_issue test helper mirrors those parameters.
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+
+# Classification and token-building methods are linear with many branches.
+# 20 is reasonable for this codebase.
+Metrics/AbcSize:
+  Max: 20
 
 # Development dependencies in gemspec is fine for this gem
 Gemspec/DevelopmentDependencies:
@@ -25,5 +37,24 @@ Metrics/MethodLength:
   CountAsOne: ['array', 'hash', 'heredoc']
   Max: 15
 
+# Test classes naturally grow with coverage (see test/.rubocop.yml for higher limit)
+Metrics/ClassLength:
+  CountAsOne: ['array', 'hash', 'heredoc']
+  Max: 150
+
+Metrics/ModuleLength:
+  CountAsOne: ['array', 'hash', 'heredoc']
+  Max: 150
+
+# Fasterer prefers yield over block.call for performance
+Style/ExplicitBlockArgument:
+  Enabled: false
+
+# Fasterer prefers fetch with block over second argument for performance
+Style/RedundantFetchBlock:
+  Enabled: false
+
+# Compact style (Minitest::Heat::IssueTest) is standard for this project.
+# Nested style breaks when intermediary names are classes, not modules (e.g. Backtrace).
 Style/ClassAndModuleChildren:
   Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 ## [Unreleased]
 
+## [2.1.1] - 2026-02-01
+
+### Changed
+- Converted ~90 single-expression methods to Ruby 3.0+ endless method syntax
+- Moved dev dependencies from gemspec to Gemfile; changed `add_runtime_dependency` to `add_dependency`
+- Moved constants above `private` in Output::Token for conventional ordering
+- Replaced inline rubocop disables with targeted reek annotations
+- Switched to leading-dot method chains, symbol-to-proc where applicable, and minor style fixes
+- Removed unnecessary `begin`/`end` block in Output#print_tokens rescue
+- Cleaned up test suite: removed redundant tests, fixed silent-pass conditionals, replaced fragile mutation-based setup with fresh instances, added ensure-based cleanup for filesystem tests
+
+## [2.1.0] - 2026-01-30
+
+### Added
+- `inherently_slow_paths` configuration option to exclude directories (e.g. `test/system`, `test/integration`) from slow test reporting. Tests in listed paths still run and report errors and failures — they just aren't flagged as slow or painfully slow. ([#5](https://github.com/garrettdimon/minitest-heat/issues/5))
+
+## [2.0.0] - 2026-01-29
+
 ### Breaking
 - Require Ruby >= 3.2 (dropped 3.1 support)
 
@@ -57,4 +75,3 @@ The biggest update is that the slow thresholds are now configurable.
 ## [1.0.0] - 2021-12-01
 
 Initial release.
-

data/Gemfile

@@ -2,9 +2,19 @@
 
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in minitest-heat.gemspec
+# Runtime dependencies in minitest-heat.gemspec
 gemspec
 
+# Development dependencies
 gem 'bundler-audit', '>= 0.9'
-gem 'minitest', '~> 5.0'
+gem 'debug'
+gem 'flay'
+gem 'flog'
 gem 'rake', '>= 13.0'
+gem 'reek'
+gem 'reviewer'
+gem 'rubocop'
+gem 'rubocop-minitest'
+gem 'rubocop-rake'
+gem 'simplecov'
+gem 'simplecov_json_formatter'

data/Gemfile.lock

@@ -1,23 +1,63 @@
 PATH
   remote: .
   specs:
-    minitest-heat (2.0.0)
+    minitest-heat (2.1.1)
       minitest
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.3)
-    awesome_print (1.9.2)
+    bigdecimal (4.0.1)
     bundler-audit (0.9.3)
       bundler (>= 1.2.0)
       thor (~> 1.0)
+    concurrent-ruby (1.3.6)
     date (3.5.1)
     debug (1.11.1)
       irb (~> 1.10)
       reline (>= 0.3.8)
     docile (1.4.1)
+    dry-configurable (1.3.0)
+      dry-core (~> 1.1)
+      zeitwerk (~> 2.6)
+    dry-core (1.2.0)
+      concurrent-ruby (~> 1.0)
+      logger
+      zeitwerk (~> 2.6)
+    dry-inflector (1.3.1)
+    dry-initializer (3.2.0)
+    dry-logic (1.6.0)
+      bigdecimal
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.1)
+      zeitwerk (~> 2.6)
+    dry-schema (1.15.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 1.0, >= 1.0.1)
+      dry-core (~> 1.1)
+      dry-initializer (~> 3.2)
+      dry-logic (~> 1.6)
+      dry-types (~> 1.8)
+      zeitwerk (~> 2.6)
+    dry-types (1.9.0)
+      bigdecimal (>= 3.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0)
+      dry-inflector (~> 1.0)
+      dry-logic (~> 1.4)
+      zeitwerk (~> 2.6)
     erb (6.0.1)
+    erubi (1.13.1)
+    flay (2.14.2)
+      erubi (~> 1.10)
+      path_expander (~> 2.0)
+      prism (~> 1.7)
+      sexp_processor (~> 4.0)
+    flog (4.9.4)
+      path_expander (~> 2.0)
+      prism (~> 1.7)
+      sexp_processor (~> 4.8)
     io-console (0.8.2)
     irb (1.16.0)
       pp (>= 0.6.0)
@@ -26,11 +66,13 @@ GEM
     json (2.18.0)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
+    logger (1.7.0)
     minitest (5.27.0)
     parallel (1.27.0)
     parser (3.3.10.1)
       ast (~> 2.4.1)
       racc
+    path_expander (2.0.1)
     pp (0.6.3)
       prettyprint
     prettyprint (0.2.0)
@@ -45,9 +87,19 @@ GEM
       erb
       psych (>= 4.0.0)
       tsort
+    reek (6.5.0)
+      dry-schema (~> 1.13)
+      logger (~> 1.6)
+      parser (~> 3.3.0)
+      rainbow (>= 2.0, < 4.0)
+      rexml (~> 3.1)
     regexp_parser (2.11.3)
     reline (0.6.3)
       io-console (~> 0.5)
+    reviewer (0.1.5)
+      rainbow
+      slop
+    rexml (3.4.4)
     rubocop (1.84.0)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
@@ -70,30 +122,35 @@ GEM
       lint_roller (~> 1.1)
       rubocop (>= 1.72.1)
     ruby-progressbar (1.13.0)
+    sexp_processor (4.17.5)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.13.2)
     simplecov_json_formatter (0.1.4)
+    slop (4.10.1)
     stringio (3.2.0)
     thor (1.5.0)
     tsort (0.2.0)
     unicode-display_width (3.2.0)
       unicode-emoji (~> 4.1)
     unicode-emoji (4.2.0)
+    zeitwerk (2.7.4)
 
 PLATFORMS
   arm64-darwin-24
   ruby
 
 DEPENDENCIES
-  awesome_print
   bundler-audit (>= 0.9)
   debug
-  minitest (~> 5.0)
+  flay
+  flog
   minitest-heat!
   rake (>= 13.0)
+  reek
+  reviewer
   rubocop
   rubocop-minitest
   rubocop-rake

data/README.md

@@ -67,17 +67,22 @@ Minitest::Heat.configure do |config|
 end
 ```
 
-### Example: Rails Application
+### Inherently Slow Paths
 
-System tests and integration tests naturally run slower. You might use higher thresholds:
+System tests, integration tests, and other browser-driven tests are inherently slower than unit tests. Rather than raising your global thresholds to accommodate them, you can tell Minitest Heat which paths to exclude from slow test reporting. Tests in those directories still run and report errors and failures normally—they just aren't evaluated against the timing thresholds.
 
 ```ruby
 Minitest::Heat.configure do |config|
-  config.slow_threshold = 3.0
-  config.painfully_slow_threshold = 10.0
+  config.inherently_slow_paths = ['test/system', 'test/integration']
 end
 ```
 
+Any test whose file path starts with a listed prefix is excluded. Common paths to consider:
+
+- `test/system` — Rails system tests (browser-driven)
+- `test/integration` — Integration tests with broader scope
+- `test/e2e` — End-to-end tests
+
 ### Example: Gem Development
 
 For a gem with fast unit tests, stricter thresholds catch performance regressions early:

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

@@ -15,7 +15,7 @@ module Minitest
         end
 
         def earliest_project_location
-          locations.rindex { |element| element.project_file? }
+          locations.rindex(&:project_file?)
         end
 
         def max_location

data/lib/minitest/heat/backtrace.rb

@@ -21,9 +21,7 @@ module Minitest
       # Determines if the raw backtrace has values in it
       #
       # @return [Boolean] true if there's no backtrace or it's empty
-      def empty?
-        raw_backtrace.empty?
-      end
+      def empty? = raw_backtrace.empty?
 
       # All lines of the backtrace converted to Backtrace::LineParser's
       #
@@ -38,30 +36,22 @@ module Minitest
       #   files at the beginning
       #
       # @return [Array<Location>] the sorted backtrace lines from the project
-      def recently_modified_locations
-        @recently_modified_locations ||= project_locations.sort_by(&:mtime).reverse
-      end
+      def recently_modified_locations = (@recently_modified_locations ||= project_locations.sort_by(&:mtime).reverse)
 
       # All entries from the backtrace that are files within the project
       #
       # @return [Array<Location>] the backtrace lines from within the project
-      def project_locations
-        @project_locations ||= locations.select(&:project_file?)
-      end
+      def project_locations = (@project_locations ||= locations.select(&:project_file?))
 
       # All entries from the backtrace within the project tests
       #
       # @return [Array<Location>] the backtrace lines from within the tests
-      def test_locations
-        @test_locations ||= project_locations.select(&:test_file?)
-      end
+      def test_locations = (@test_locations ||= project_locations.select(&:test_file?))
 
       # All source code entries from the backtrace (i.e. excluding tests)
       #
       # @return [Array<Location>] the backtrace lines from within the source code
-      def source_code_locations
-        @source_code_locations ||= project_locations.select(&:source_code_file?)
-      end
+      def source_code_locations = (@source_code_locations ||= project_locations.select(&:source_code_file?))
     end
   end
 end

data/lib/minitest/heat/configuration.rb

@@ -7,16 +7,23 @@ module Minitest
     # For managing configuration options on how Minitest Heat should handle results
     class Configuration
       DEFAULTS = {
-        slow_threshold:           1.0,
-        painfully_slow_threshold: 3.0
+        slow_threshold: 1.0,
+        painfully_slow_threshold: 3.0,
+        inherently_slow_paths: []
       }.freeze
 
       attr_accessor :slow_threshold,
-                    :painfully_slow_threshold
+                    :painfully_slow_threshold,
+                    :inherently_slow_paths
 
       def initialize
-        @slow_threshold           = DEFAULTS[:slow_threshold]
+        @slow_threshold = DEFAULTS[:slow_threshold]
         @painfully_slow_threshold = DEFAULTS[:painfully_slow_threshold]
+        @inherently_slow_paths = DEFAULTS[:inherently_slow_paths].dup
+      end
+
+      def inherently_slow_path?(path)
+        inherently_slow_paths.any? { |prefix| path.start_with?(prefix) }
       end
     end
   end

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|