test-map 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a6119ac2cd9cbbed7ab386e84db91d4af55abb17839e4eaed8e2db66aed8f10
-  data.tar.gz: 454388e46781b590ecc38d8b5bab9d6395f8b5db48c8b7f1241533fc519995c4
+  metadata.gz: cd8d77a4693229a3bdc64882a2771830090f7b04ae977df9eec5386e3ffc16e3
+  data.tar.gz: dc04407d47b77d1b5a6418072c8e380a327417a82fe27a21f31e1020d7b6b2aa
 SHA512:
-  metadata.gz: 8165ebf293a69de809d2c04cb496836d44b722ae52870bd13cb15688493066e65c7d9daa422bd62a86fd87cec871bfbe7acfec9ffdea26b44091e6d84b2d8936
-  data.tar.gz: 62f784cfb4a6968c8ccd481477cef3e4d5eec0dbcaa04bfec295514ea8b5ae1bc667c8f99d46d6aabf4c888bec3d23a4fce00a2bbbddd5b8cc6396a381121f68
+  metadata.gz: d80247e944cecd9b3c06b48b63bae9052589f97713496f674dc9ad23524ebfe6e8bb0720d38a90d0ba9b0874cb33c6a9422d6cd9bf3c49c2f8db252c26dde011
+  data.tar.gz: 1690f86016ea54148386896023ba40e22210e2559c8d7dd175c7b728c458a9e2abdfdaa7f3a73997cbb4da446186e51033313a35df8c3e7e158a1a8cd8359f5a

data/CHANGELOG.md

@@ -6,6 +6,11 @@ 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/).
 
-## [Unreleased] - yyyy-mm-dd
+## 0.2.0 - 2024-10-25
+
+Provide explicit Test Task via Rake for Minitest, Rspec, and Rails. Extend
+documentation.
+
+## 0.1.0 - 2024-09-22
 
 Initial release.

data/README.md

@@ -19,20 +19,6 @@ Add test-map to your Gemfile.
 $ bundle add test-map
 ```
 
-On demand you can adapt the configuration to your needs.
-
-```ruby
-TestMap::Configure.configure do |config|
-  config.logger = Logger.new($stdout) # default logs to dev/null
-  config.out_file = 'my-test-map.yml' # default is .test-map.yml
-  # defaults to [%r{^(vendor|test|spec)/}] }
-  config.exclude_patterns = [%r{^(libraries|testsuite)/}]
-  # register a custom rule to match new files; must implement `call(file)`;
-  # defaults to nil
-  config.natural_mapping = ->(file) { file.sub(%r{^library/}, 'test/') }
-end
-```
-
 ### Minitest
 
 Include test-map in your test helper. Typically you want to include it
@@ -53,6 +39,25 @@ $ TEST_MAP=1 bundle exec ruby -Itest test/models/user_test.rb
 $ TEST_MAP=1 bundle exec rake test
 ```
 
+Using the a dedicated rake task you can connect a file watcher and trigger
+tests on file changes.
+
+```ruby
+# filename: Rakefile
+require 'test_map/test_task'
+
+TestMap::TestTask.create
+```
+
+Using [entr](https://eradman.com/entrproject/) as example file watcher.
+
+```sh
+# find all ruby files | watch them, postpone first execution, clear screen
+#   with every run and on file change run test suite for the changed file
+#   (placeholder /_).
+$ find . -name "*.rb" | entr -cp bundle exec rake test:changes /_
+```
+
 ### Rspec
 
 Include test-map in your test helper. Typically you want to include it
@@ -69,8 +74,33 @@ Run your tests with the `TEST_MAP` environment variable set.
 $ TEST_MAP=1 bundle exec rspec
 ```
 
+## Configuration
+
+On demand you can adapt the configuration to your needs.
+
+```ruby
+TestMap::Config.configure do |config|
+  config[:logger] = Logger.new($stdout) # default logs to dev/null
+  config[:merge] = false # merge results (e.g. with multiple testsuites)
+  config[:out_file] = 'my-test-map.yml' # default is .test-map.yml
+  # defaults to [%r{^(vendor)/}] }
+  config[:exclude_patterns] = [%r{^(vendor|other_libraries)/}]
+  # register a custom rule to match new files; must implement `call(file)`;
+  # defaults to nil
+  config[:natural_mapping] = ->(file) { file.sub(%r{^library/}, 'test/') }
+end
+```
+
 ## Development
 
+Open list of features:
+
+- [x] Configure file exclude list (e.g. test files are not needed).
+- [ ] Auto-handle packs, packs with subdirectories.
+- [x] Demonstrate usage with file watchers.
+- [ ] Demonstrate CI pipelines with GitHub actions and GitLab CI.
+- [x] Merge results.
+
 ```sh
 $ bundle install # install dependencies
 $ bundle exec rake # run testsuite
@@ -79,5 +109,5 @@ $ bundle exec rubocop # run linter
 
 ## Contributing
 
-Bug reports and pull requests are welcome on
+Bug reports and pull requests are very welcome on
 [GitHub](https://github.com/unused/test-map).

data/lib/test_map/config.rb

@@ -11,7 +11,8 @@ module TestMap
 
     def self.default_config
       { logger: Logger.new('/dev/null'), out_file: '.test-map.yml',
-        exclude_patterns: [%r{^(vendor)/}], natural_mapping: nil }
+        exclude_patterns: [%r{^(vendor)/}], natural_mapping: nil,
+        skip_files: [%r{^(test/)}], merge: false }
     end
   end
 end

data/lib/test_map/file_recorder.rb

@@ -5,13 +5,19 @@ module TestMap
   class FileRecorder
     def initialize = @files = []
 
-    def trace
+    def trace(&block)
       raise TraceInUseError.default if @trace&.enabled?
 
       @trace = TracePoint.new(:call) do |tp|
         TestMap.logger.debug "#{tp.path}:#{tp.lineno}"
         @files << tp.path
-      end.tap(&:enable)
+      end
+
+      if block_given?
+        @trace.enable { block.call }
+      else
+        @trace.enable
+      end
     end
 
     def stop = @trace&.disable

data/lib/test_map/plugins/minitest.rb

@@ -7,8 +7,7 @@ module TestMap
       def self.included(_base)
         TestMap.logger.info 'Registering hooks for Minitest'
         ::Minitest.after_run do
-          result = TestMap.reporter.to_yaml
-          File.write "#{Dir.pwd}/#{Config.config[:out_file]}", result
+          TestMap.reporter.write "#{Dir.pwd}/#{Config.config[:out_file]}"
         end
       end
 

data/lib/test_map/plugins/rspec.rb

@@ -5,15 +5,12 @@ TestMap.logger.info 'Loading RSpec plugin'
 RSpec.configure do |config|
   config.around(:example) do |example|
     # path = example.metadata[:example_group][:file_path]
-    recorder = TestMap::FileRecorder.new.tap(&:trace)
-    example.run
-  ensure
-    recorder.stop
+    recorder = TestMap::FileRecorder.new
+    recorder.trace { example.run }
     TestMap.reporter.add recorder.results
   end
 
   config.after(:suite) do
-    result = TestMap.reporter.to_yaml
-    File.write "#{Dir.pwd}/#{TestMap::Config.config[:out_file]}", result
+    TestMap.reporter.write "#{Dir.pwd}/#{TestMap::Config.config[:out_file]}"
   end
 end

data/lib/test_map/report.rb

@@ -15,7 +15,22 @@ module TestMap
       end
     end
 
-    def results = @results.transform_values { _1.to_a.sort }.sort.to_h
+    def write(file)
+      content = if File.exist?(file) && Config.config[:merge]
+                  merge(results, YAML.safe_load_file(file)).to_yaml
+                else
+                  to_yaml
+                end
+      File.write file, content
+    end
+
+    def results = @results.transform_values { _1.to_a.uniq.sort }.sort.to_h
     def to_yaml = results.to_yaml
+
+    def merge(result, current)
+      current.merge(result) do |_key, oldval, newval|
+        (oldval + newval).uniq.sort
+      end
+    end
   end
 end

data/lib/test_map/test_task.rb

@@ -15,6 +15,13 @@ module TestMap
       @name = name
     end
 
+    # Adapter for rspec test task
+    class RailsTestTask
+      attr_accessor :files
+
+      def call = Rails::TestUnit::Runner.run_from_rake('test', files)
+    end
+
     # Adapter for minitest test task.
     class MinitestTask < Minitest::TestTask
       def call = ruby(make_test_cmd, verbose: false)
@@ -38,7 +45,8 @@ module TestMap
         desc 'Run tests for changed files'
         task :changes do
           out_file = "#{Dir.pwd}/.test-map.yml"
-          test_files = Mapping.new(out_file).lookup(*ARGV[1..])
+          args = defined?(Rails) ? ENV['TEST']&.split : ARGV[1..]
+          test_files = Mapping.new(out_file).lookup(*args)
 
           # puts "Running tests #{test_files.join(' ')}"
           test_task.files = test_files
@@ -50,7 +58,10 @@ module TestMap
     def test_task = @test_task ||= build_test_task
 
     def build_test_task
-      if defined?(Minitest)
+      if defined?(Rails)
+        return RailsTestTask.new
+      elsif defined?(Minitest)
+        require 'minitest/test_task'
         return MinitestTask.new
       elsif defined?(RSpec)
         return RSpecTask.new

data/lib/test_map/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-map
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Christoph Lipautz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-22 00:00:00.000000000 Z
+date: 2024-10-28 00:00:00.000000000 Z
 dependencies: []
 description: |
   Track files that are covered by test files to execute only the necessary
@@ -18,11 +18,11 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
-- LICENSE
+- LICENSE.txt
 - README.md
 files:
 - CHANGELOG.md
-- LICENSE
+- LICENSE.txt
 - README.md
 - lib/test_map.rb
 - lib/test_map/config.rb