test-map 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ce3e91a8ab0098bedae3516d60ec4591513a5bd31507b143373627e3bd96ad3
-  data.tar.gz: 736396db3f44850d11fdeb3a0a0bca2bed9ecdb5f551439eed75aad59613b79c
+  metadata.gz: 502e7e183acdd6b0f2576ad014d920a1c00b4233f08cdfaf57243ed4814b1c1b
+  data.tar.gz: 4d50c652f8ffa46c485ab2da15c5ddd5da022cd856aac394375679f07ea083b8
 SHA512:
-  metadata.gz: d80393696fdf9dfad334535bd560ddf4e93731d99ba77993a31c3243d8902f7cf30001cf56c2fe37b4ffa6ba5ad450329dd466ef2aa4119316e3344c0ce0c834
-  data.tar.gz: b0a20a539dec75bf6c27e47dc50c47dabd70cf68096fa83730950ede937c1445ddd8ed763814bf02b4040c2bcd47e32431379c9c78cde4e7ebc03ce2b7c912dc
+  metadata.gz: 60480addcb32f9528c65895488190f4a7c01623b437e9818ff81e85f081b4e884e8fc3afb5684b4105b2eb52010ae1f1e182e2fbae0574a690c2404b86af3314
+  data.tar.gz: 61ce5a7bb1bd602f018e6e64b141bdfddbf52bbd61c72794796823d04b8b0a225f1748a6d66afe1d0540bfd85e31d34ed3cc3dd9c368ad543a2ecacfe0f898a5

data/CHANGELOG.md

@@ -6,6 +6,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 0.4.0 - 2026-03-07
+
+Extend reporting and cache handling for minitest and rspec. Add caches at
+processing and profiling events. Optimize execution by reducing excessive
+calls and calculations.
+
 ## 0.3.0 - 2026-03-01
 
 Introduce test cache and remove changes runner. Removed `test:changes` Rake

data/README.md

@@ -17,6 +17,55 @@ Add test-map to your Gemfile.
 $ bundle add test-map
 ```
 
+Require test-map in your test helper or spec helper.
+
+```ruby
+# filename: test/test_helper.rb
+require 'test_map'
+```
+
+## Example Run
+
+Running the testsuite, test-map creates a mapping of tests to their code files,
+as well as a test-file result cache. Running the testsuite again, all
+successfully run tests are cached and skipped. Chaning a file, **only tests
+that need to be run are executed**.
+
+```sh
+# Running the testsuite for the first time, all tests are executed and mapped
+ > be rake
+Run options: --seed 10112
+
+# Running:
+
+.......................................................
+
+Finished in 0.042190s, 1303.6402 runs/s, 1730.2861 assertions/s.
+55 runs, 73 assertions, 0 failures, 0 errors, 0 skips, 0 cached
+
+# Running again without changes, all tests are cached and skipped
+ > be rake
+Run options: --seed 40581
+
+# Running:
+
+CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
+
+Finished in 0.007902s, 6960.1126 runs/s, 0.0000 assertions/s.
+55 runs, 0 assertions, 0 failures, 0 errors, 0 skips, 55 cached
+
+# Change a file and rerun the testsuite
+ > be rake
+Run options: --seed 47682
+
+# Running:
+
+CCCCCCCCCC...CCCCCCCCCCCC.....CCCCCCCCCCCCCCCCCCCCCCCCC
+
+Finished in 0.014029s, 3920.3764 runs/s, 570.2366 assertions/s.
+55 runs, 8 assertions, 0 failures, 0 errors, 0 skips, 47 cached
+```
+
 ### Minitest
 
 Include test-map in your test helper.

data/lib/test_map/cache.rb

@@ -12,13 +12,16 @@ module TestMap
       @cache_file = cache_file
       @map_file = map_file
       @root = root
+      @global_files_changed = nil
+      @current_checksums = {}
+      @file_exists_cache = {}
     end
 
     def fresh?(test_file)
       return false unless cached_checksums
       return false if global_files_changed?
 
-      files_to_check = [test_file] + source_files_for(test_file)
+      files_to_check = [test_file].concat(source_files_for(test_file))
       files_to_check.all? { |f| file_exist?(f) && current_checksum(f) == cached_checksums[f] }
     end
 
@@ -37,7 +40,9 @@ module TestMap
     end
 
     def global_files_changed?
-      GLOBAL_FILES.any? do |f|
+      return @global_files_changed unless @global_files_changed.nil?
+
+      @global_files_changed = GLOBAL_FILES.any? do |f|
         file_exist?(f) && current_checksum(f) != cached_checksums[f]
       end
     end
@@ -60,10 +65,14 @@ module TestMap
     end
 
     def current_checksum(file)
-      Digest::SHA256.file(File.join(@root, file)).hexdigest
+      @current_checksums[file] ||= Digest::SHA256.file(File.join(@root, file)).hexdigest
     end
 
-    def file_exist?(file) = File.exist?(File.join(@root, file))
+    def file_exist?(file)
+      return @file_exists_cache[file] if @file_exists_cache.key?(file)
+
+      @file_exists_cache[file] = File.exist?(File.join(@root, file))
+    end
 
     def collect_tracked_files(results)
       sources = results.keys

data/lib/test_map/event.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module TestMap
+  # Publish/subscribe event bus. No overhead when no subscribers.
+  #
+  # Topics use `type.action` format, e.g. `cache.create`, `map.create`.
+  #
+  # Block form measures elapsed time and passes it to subscribers:
+  #   Event.publish('cache.create') { write_cache }
+  #
+  # Fire-and-forget form for simple notifications:
+  #   Event.publish('cache.found', test_file:)
+  module Event
+    @subscribers = {}
+
+    class << self
+      def subscribe(topic, &block)
+        (@subscribers[topic] ||= []) << block
+      end
+
+      def publish(topic, **payload, &block)
+        listeners = @subscribers[topic]
+        return notify(listeners, topic, **payload) unless block
+        return yield unless listeners
+
+        publish_with_timing(listeners, topic, **payload, &block)
+      end
+
+      def reset
+        @subscribers = {}
+      end
+
+      private
+
+      def notify(listeners, topic, **payload)
+        listeners&.each { |cb| cb.call(topic, **payload) }
+      end
+
+      def publish_with_timing(listeners, topic, **payload)
+        start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        result = yield
+        elapsed = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start
+        listeners.each { |cb| cb.call(topic, elapsed:, **payload) }
+        result
+      end
+    end
+  end
+end

data/lib/test_map/file_recorder.rb

@@ -26,8 +26,9 @@ module TestMap
     def results
       raise NotTracedError.default unless @trace
 
-      @files.filter { _1.start_with? Dir.pwd }
-            .map { _1.sub("#{Dir.pwd}/", '') }
+      cwd = "#{Dir.pwd}/"
+      @files.filter { _1.start_with? cwd }
+            .map { _1.sub(cwd, '') }
             .then { Filter.call _1 }
     end
   end

data/lib/test_map/plugins/minitest/cache_reporter.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module TestMap
+  module Plugins
+    module Minitest
+      # Reporter that tracks cached test count and appends it to the summary.
+      class CacheReporter < ::Minitest::StatisticsReporter
+        attr_accessor :cached, :composite
+
+        def initialize(io = $stdout, options = {}, composite: nil)
+          super(io, options)
+          self.cached = 0
+          self.composite = composite
+        end
+
+        def record(result)
+          super
+          self.cached += 1 if result.failure.is_a?(TestMap::CachedSkip)
+        end
+
+        def report
+          super
+          return unless composite
+
+          summary_reporter = composite.reporters.find { |r| r.is_a?(::Minitest::SummaryReporter) }
+          return unless summary_reporter
+
+          summary_reporter.results.reject! { |r| r.failure.is_a?(TestMap::CachedSkip) }
+          summary_reporter.skips -= cached if summary_reporter.skips
+          patch_summary(summary_reporter)
+        end
+
+        private
+
+        def patch_summary(summary_reporter)
+          cached_count = cached
+          original_summary = summary_reporter.method(:summary)
+
+          summary_reporter.define_singleton_method(:summary) do
+            "#{original_summary.call}, #{cached_count} cached"
+          end
+        end
+      end
+    end
+  end
+end
+
+module Minitest # :nodoc:
+  def self.plugin_test_map_cache_init(options)
+    cache_reporter = TestMap::Plugins::Minitest::CacheReporter.new(options[:io], options, composite: reporter)
+    reporter.reporters.unshift(cache_reporter)
+  end
+end

data/lib/test_map/plugins/minitest.rb

@@ -1,5 +1,22 @@
 # frozen_string_literal: true
 
+module TestMap
+  # CachedSkip is raised to skip tests whose files haven't changed.
+  # Subclasses Minitest::Skip so Minitest treats it as a skip, but the
+  # custom reporter can distinguish it and show `C` instead of `S`.
+  class CachedSkip < Minitest::Skip
+    def initialize(msg = 'test-map: cached')
+      super
+    end
+
+    def result_label
+      'Cached'
+    end
+  end
+end
+
+require_relative 'minitest/cache_reporter'
+
 module TestMap
   module Plugins
     # Minitest plugin for TestMap.
@@ -9,6 +26,11 @@ module TestMap
         TestMap.suite_passed = true
 
         ::Minitest.after_run { write_results }
+        install_cache_reporter
+      end
+
+      def self.install_cache_reporter
+        ::Minitest.extensions << 'test_map_cache'
       end
 
       def self.write_results
@@ -32,22 +54,18 @@ module TestMap
         end
       end
 
-      def after_setup
+      def before_setup
         test_file = resolve_test_file
-        if test_file && TestMap.cache.fresh?(test_file)
-          @_test_map_skipped = true
-          skip 'test-map: cached'
-        else
-          @recorder = FileRecorder.new.tap(&:trace)
-        end
+        raise TestMap::CachedSkip if test_file && TestMap.cache.fresh?(test_file)
 
+        @recorder = FileRecorder.new.tap(&:trace)
         super
       end
 
       def before_teardown
         super
 
-        return if @_test_map_skipped || !@recorder
+        return unless @recorder
 
         @recorder.stop
         TestMap.reporter.add @recorder.results

data/lib/test_map/plugins/rspec/cache_formatter.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'rspec/core/formatters/progress_formatter'
+
+module TestMap
+  module Plugins
+    module RSpec
+      # Formatter that shows `C` for cached tests instead of `*` (pending).
+      # Extends ProgressFormatter so it can serve as the default formatter.
+      # Adjusts the summary to show cached count and filters cached tests
+      # from the pending output.
+      class CacheFormatter < ::RSpec::Core::Formatters::ProgressFormatter
+        CACHED_MESSAGE = 'test-map: cached'
+
+        ::RSpec::Core::Formatters.register self,
+                                           :example_passed, :example_pending, :example_failed,
+                                           :start_dump, :dump_summary, :dump_pending
+
+        def initialize(output)
+          super
+          @cached_count = 0
+        end
+
+        def example_pending(notification)
+          if cached?(notification.example)
+            @cached_count += 1
+            output.print ::RSpec::Core::Formatters::ConsoleCodes.wrap('c', :cyan)
+          else
+            super
+          end
+        end
+
+        def dump_pending(notification)
+          examples = notification.pending_examples
+          cached = examples.select { |ex| cached?(ex) }
+          return if examples.size == cached.size
+
+          cached.each { |ex| examples.delete(ex) }
+          super
+          cached.each { |ex| examples.push(ex) }
+        end
+
+        def dump_summary(summary)
+          if @cached_count.positive?
+            cached_count = @cached_count
+            original_totals_line = summary.method(:totals_line)
+            summary.define_singleton_method(:totals_line) do
+              "#{original_totals_line.call}, #{cached_count} cached"
+            end
+          end
+          super
+        end
+
+        private
+
+        def cached?(example)
+          example.execution_result.pending_message == CACHED_MESSAGE
+        end
+      end
+    end
+  end
+end

data/lib/test_map/plugins/rspec.rb

@@ -1,14 +1,49 @@
 # frozen_string_literal: true
 
+require_relative 'rspec/cache_formatter'
+
 TestMap.logger.info 'Loading RSpec plugin'
 TestMap.suite_passed = true
 
+module TestMap
+  module Plugins
+    # RSpec integration for TestMap.
+    module RSpec
+      def self.write_results
+        out_file = "#{Dir.pwd}/#{Config.config[:out_file]}"
+        reporter_results = TestMap.reporter.results
+
+        # All tests were cache-skipped, existing files are still valid
+        return if reporter_results.empty?
+
+        full_results = merge_results(out_file, reporter_results)
+        File.write(out_file, full_results.to_yaml)
+        TestMap.cache.write(full_results) if TestMap.suite_passed
+      end
+
+      # Merge with existing map to preserve mappings for cache-skipped tests
+      def self.merge_results(out_file, reporter_results)
+        if File.exist?(out_file)
+          TestMap.reporter.merge(reporter_results, YAML.safe_load_file(out_file))
+        else
+          reporter_results
+        end
+      end
+    end
+  end
+end
+
 RSpec.configure do |config|
-  config.around(:example) do |example|
-    test_file = example.metadata[:file_path].sub("#{Dir.pwd}/", '').sub(%r{^\./}, '')
+  config.default_formatter = TestMap::Plugins::RSpec::CacheFormatter
 
-    if TestMap.cache.fresh?(test_file)
-      skip 'test-map: cached'
+  config.before(:context) do
+    test_file = self.class.metadata[:file_path].sub("#{Dir.pwd}/", '').sub(%r{^\./}, '')
+    skip TestMap::Plugins::RSpec::CacheFormatter::CACHED_MESSAGE if TestMap.cache.fresh?(test_file)
+  end
+
+  config.around(:example) do |example|
+    if example.metadata[:skip]
+      example.run
     else
       recorder = TestMap::FileRecorder.new
       recorder.trace { example.run }
@@ -18,21 +53,5 @@ RSpec.configure do |config|
     end
   end
 
-  config.after(:suite) do
-    out_file = "#{Dir.pwd}/#{TestMap::Config.config[:out_file]}"
-    reporter_results = TestMap.reporter.results
-
-    # All tests were cache-skipped, existing files are still valid
-    next if reporter_results.empty?
-
-    # Merge with existing map to preserve mappings for cache-skipped tests
-    full_results = if File.exist?(out_file)
-                     TestMap.reporter.merge(reporter_results, YAML.safe_load_file(out_file))
-                   else
-                     reporter_results
-                   end
-
-    File.write(out_file, full_results.to_yaml)
-    TestMap.cache.write(full_results) if TestMap.suite_passed
-  end
+  config.after(:suite) { TestMap::Plugins::RSpec.write_results }
 end

data/lib/test_map/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TestMap
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/test_map.rb

@@ -9,6 +9,7 @@ require_relative 'test_map/file_recorder'
 require_relative 'test_map/natural_mapping'
 require_relative 'test_map/mapping'
 require_relative 'test_map/cache'
+require_relative 'test_map/event'
 
 # TestMap records associated files to test execution.
 module TestMap

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-map
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Christoph Lipautz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-01 00:00:00.000000000 Z
+date: 2026-03-07 00:00:00.000000000 Z
 dependencies: []
 description: |
   Track files that are covered by test files to execute only the necessary
@@ -28,12 +28,15 @@ files:
 - lib/test_map/cache.rb
 - lib/test_map/config.rb
 - lib/test_map/errors.rb
+- lib/test_map/event.rb
 - lib/test_map/file_recorder.rb
 - lib/test_map/filter.rb
 - lib/test_map/mapping.rb
 - lib/test_map/natural_mapping.rb
 - lib/test_map/plugins/minitest.rb
+- lib/test_map/plugins/minitest/cache_reporter.rb
 - lib/test_map/plugins/rspec.rb
+- lib/test_map/plugins/rspec/cache_formatter.rb
 - lib/test_map/report.rb
 - lib/test_map/version.rb
 homepage: https://github.com/unused/test-map