test_file_finder 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 753b9d59524b70621af97db8e7167594fb4fa58e50cd0e48883791ad99f41ddf
-  data.tar.gz: 2ae423a1fd377e425372eed3a362c234f715ef6626c5a67e475021a149a08809
+  metadata.gz: 42ce8ef84263c84c281c4e0002f011ce595841daeca4d5da6689a7a34edca1d7
+  data.tar.gz: 755701aacdd1fd4af7810366daf3e3c8a10d75a6bea3b749e9f2c1d375b78f76
 SHA512:
-  metadata.gz: 3b668ecff7ea38f8dae220e69b3b45e7a35287cd93662e2f77c98342a118c41dacad758f48c450950c7a346f0bd6b3f0e71af261faa132dc0e2d2714840be9bc
-  data.tar.gz: 27e0652756e2c9b59f31a1bda9f8a630ee986aa099f8a84697df65400e2fc4f3308d079e7941ad75380f2fb4d2bb0bfecb331b21ce3d9355858e0eb1c10391bc
+  metadata.gz: 600e982684b54d6b4c35fbdd613df7c6cb595dac85acddc3dc8cef300b882ee100565fa2eac362dfde1cc8cdca645a6c2dd5347f97411f7d06bb749e0520a946
+  data.tar.gz: 510046d569019470b0fbcf6ec24e007de694b3d6611a78fe58ff979db81208c66e7fe68ae0dfe071f78334a57f3ea68756c337f726bedd59722bb038000bc6b0

data/.gitlab-ci.yml

@@ -6,9 +6,10 @@ stages:
 variables:
   BUNDLE_FROZEN: "true"
 
-rspec:
+.default-test-job:
+  image: "ruby:${RUBY_VERSION}"
   stage: test
-  image: "ruby:$RUBY_VERSION"
+  needs: []
   cache:
     paths:
       - vendor/ruby
@@ -17,18 +18,25 @@ rspec:
     - gem install bundler -v 2.4.13
     - bundle config set --local path "vendor/ruby/$RUBY_VERSION"
     - bundle install
-  script:
-    - bundle exec rspec
-    - bundle exec rspec feature
   parallel:
     matrix:
       - RUBY_VERSION:
-        - "2.7"
         - "3.0"
         - "3.1"
         - "3.2"
 
+rspec:
+  extends: .default-test-job
+  script:
+    - bundle exec rspec
+    - bundle exec rspec feature
+
+rubocop:
+  extends: .default-test-job
+  script:
+    - bundle exec rubocop --extra-details .
+
 include:
   - template: 'Workflows/MergeRequest-Pipelines.gitlab-ci.yml'
-  - project: 'gitlab-org/quality/pipeline-common'
-    file: '/ci/gem-release.yml'
+  - component: gitlab.com/gitlab-org/components/gem-release/gem-release@~latest
+  - component: gitlab.com/gitlab-org/components/danger-review/danger-review@~latest

data/.rubocop.yml

@@ -0,0 +1,21 @@
+inherit_gem:
+  gitlab-styles:
+    - rubocop-default.yml
+
+require:
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: disable
+
+# Disables Rails cops.
+Rails:
+  Enabled: false
+
+# Disables Rails-related cops
+CodeReuse/ActiveRecord:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 20

data/Dangerfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'gitlab-dangerfiles'
+
+Gitlab::Dangerfiles.for_project(self, &:import_defaults)

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in test_file_finder.gemspec

data/Gemfile.lock

@@ -1,25 +1,114 @@
 PATH
   remote: .
   specs:
-    test_file_finder (0.2.1)
+    test_file_finder (0.3.0)
       faraday (>= 1.0, < 3.0, != 2.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
     addressable (2.8.4)
       public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.7)
     byebug (11.1.3)
+    claide (1.1.0)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    colored2 (3.1.2)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    cork (0.3.0)
+      colored2 (~> 3.1)
     crack (0.4.5)
       rexml
+    danger (9.4.1)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (>= 0.9.0, < 3.0)
+      faraday-http-cache (~> 2.0)
+      git (~> 1.13)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.0)
+      no_proxy_fix
+      octokit (>= 6.0)
+      terminal-table (>= 1, < 4)
+    danger-gitlab (8.0.0)
+      danger
+      gitlab (~> 4.2, >= 4.2.0)
     diff-lcs (1.5.0)
+    drb (2.2.1)
     faraday (2.7.10)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
+    faraday-http-cache (2.5.0)
+      faraday (>= 0.8)
     faraday-net_http (3.0.2)
+    git (1.18.0)
+      addressable (~> 2.8)
+      rchardet (~> 1.8)
+    gitlab (4.19.0)
+      httparty (~> 0.20)
+      terminal-table (>= 1.5.1)
+    gitlab-dangerfiles (4.6.0)
+      danger (>= 9.3.0)
+      danger-gitlab (>= 8.0.0)
+      rake (~> 13.0)
+    gitlab-styles (11.0.0)
+      rubocop (~> 1.57.1)
+      rubocop-graphql (~> 0.18)
+      rubocop-performance (~> 1.15)
+      rubocop-rails (~> 2.17)
+      rubocop-rspec (~> 2.22)
     hashdiff (1.0.1)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.14.4)
+      concurrent-ruby (~> 1.0)
+    json (2.7.1)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    language_server-protocol (3.17.0.3)
+    lefthook (1.6.5)
+    mini_mime (1.1.5)
+    minitest (5.22.3)
+    multi_xml (0.6.0)
+    mutex_m (0.2.0)
+    nap (1.1.0)
+    no_proxy_fix (0.1.2)
+    octokit (8.0.0)
+      faraday (>= 1, < 3)
+      sawyer (~> 0.9)
+    open4 (1.3.4)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
     public_suffix (5.0.1)
-    rake (10.5.0)
+    racc (1.7.3)
+    rack (3.0.8)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    rchardet (1.8.0)
+    regexp_parser (2.9.0)
     rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -34,7 +123,48 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
+    rubocop (1.57.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.2)
+      parser (>= 3.3.0.4)
+    rubocop-capybara (2.20.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.25.1)
+      rubocop (~> 1.41)
+    rubocop-graphql (0.19.0)
+      rubocop (>= 0.87, < 2)
+    rubocop-performance (1.19.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.22.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.27.1)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
+    sawyer (0.9.2)
+      addressable (>= 2.3.5)
+      faraday (>= 0.17.3, < 3)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
     webmock (3.18.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
@@ -46,8 +176,12 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.1)
   byebug
-  rake (~> 10.0)
+  gitlab-dangerfiles (~> 4.6.0)
+  gitlab-styles (~> 11.0)
+  lefthook (~> 1.6)
+  rake (~> 13.0)
   rspec (~> 3.0)
+  rubocop-rake (~> 0.6)
   test_file_finder!
   webmock (~> 3.18)
 

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2011-2024 GitLab B.V.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the “Software”), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -48,7 +48,9 @@ $ rspec $(tff $(git diff --name-only master..head))
 
 `TestFileFinder` can be used with an optional YAML mapping file to specify the mapping from a `source` file to a `test` file. Both, `source` and `test` can be lists to map multiple files.
 
-The mapping file is a yaml file containing to entries to match file patterns to its test files. The patterns may include capturing groups to be used to identify the test file. To refer to a captured value in the test file, use the `%s` placeholder. For example:
+The mapping file is a yaml file containing to entries to match source file patterns to its test files.
+
+The source file pattern may be an exact file path or a regular expression. The regular expression may include capturing groups to be used to identify the test file. To refer to a captured value in the test file, use the `%s` placeholder. For example:
 
 ```yaml
 mapping:
@@ -67,6 +69,32 @@ mapping:
       - 'ee/spec/%s%s_spec.rb'
 ```
 
+The patterns may include named captures in test files and referenced by its
+name in source files. For example:
+
+```yaml
+mapping:
+  # maps `lib/api/issues.rb` to `spec/requests/api/issues/issues_spec.rb`
+  - source: 'lib/api/(?<name>.*)\.rb'
+    test: 'spec/requests/api/%{name}/%{name}_spec.rb'
+```
+
+Numbered and named captures cannot be mixed in a single pattern.
+
+A test file containing metacharacters like `*`, `{}`, `[]`, or `?` is
+considered a file name pattern and [globbing is used to match](https://rubyapi.org/o/dir#method-c-glob)
+the resulting test files.
+
+For example:
+
+```yaml
+mapping:
+  # maps `lib/api/issues.rb` to tests following this pattern
+  # `spec/requests/api/issues/*_spec.rb`
+  - source: 'lib/api/(.*)\.rb'
+    test: 'spec/requests/api/%s/*_spec.rb'
+```
+
 Command line example:
 
 ```bash

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/exe/tff

@@ -1,17 +1,18 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require 'test_file_finder'
 
 options = TestFileFinder::OptionParser.parse!(ARGV)
 
 TestFileFinder::FileFinder.new(paths: ARGV).tap do |file_finder|
-  if options.json
-    file_finder.use TestFileFinder::MappingStrategies::DirectMatching.load_json(options.json)
-  end
-  if options.mapping_file
-    file_finder.use TestFileFinder::MappingStrategies::PatternMatching.load(options.mapping_file)
-  end
+  file_finder.use TestFileFinder::MappingStrategies::DirectMatching.load_json(options.json) if options.json
+
+  file_finder.use TestFileFinder::MappingStrategies::PatternMatching.load(options.mapping_file) if options.mapping_file
+
   if options.project_path && options.merge_request_iid
-    file_finder.use TestFileFinder::MappingStrategies::GitlabMergeRequestRspecFailure.new(project_path: options.project_path, merge_request_iid: options.merge_request_iid)
+    file_finder.use TestFileFinder::MappingStrategies::GitlabMergeRequestRspecFailure.new(
+      project_path: options.project_path, merge_request_iid: options.merge_request_iid)
   end
 
   if file_finder.strategies.empty?

data/feature/tff_exe_spec.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 RSpec.describe 'tff exe' do
-  subject { `ruby -Ilib ../exe/tff #{options} #{files}` }
+  subject(:output) { `ruby -Ilib ../exe/tff #{options} #{files}` }
 
   around do |example|
     Dir.chdir(File.join(__dir__, '../fixtures')) do
@@ -8,11 +10,11 @@ RSpec.describe 'tff exe' do
   end
 
   context 'without any mapping' do
-    let(:options) {}
+    let(:options) { nil }
     let(:files) { 'app/models/test_file_finder_gem_executable_widget.rb' }
 
     it 'prints matching test files using default rails mapping' do
-      expect(subject).to eq <<~OUTPUT
+      expect(output).to eq <<~OUTPUT
         spec/models/test_file_finder_gem_executable_widget_spec.rb
       OUTPUT
     end
@@ -23,11 +25,11 @@ RSpec.describe 'tff exe' do
 
     context 'with multiple sources' do
       ['db/schema.rb', 'db/migrate/001_init.rb'].each do |file|
-        context "for file #{file}" do
+        context "with file #{file}" do
           let(:files) { file }
 
           it 'prints matching test files using given yaml mapping' do
-            expect(subject).to eq <<~OUTPUT
+            expect(output).to eq <<~OUTPUT
               spec/db/schema_spec.rb
             OUTPUT
           end
@@ -39,7 +41,7 @@ RSpec.describe 'tff exe' do
       let(:files) { 'spec/models/project_spec.rb' }
 
       it 'prints matching test files using given yaml mapping' do
-        expect(subject).to eq <<~OUTPUT
+        expect(output).to eq <<~OUTPUT
           spec/models/project_spec.rb
           spec/smoke_spec.rb
         OUTPUT
@@ -48,11 +50,11 @@ RSpec.describe 'tff exe' do
 
     context 'with multiple sources and tests' do
       ['views/main.html.haml', 'assets/application.css'].each do |file|
-        context "for file #{file}" do
+        context "with file #{file}" do
           let(:files) { file }
 
           it 'prints matching test files using given yaml mapping' do
-            expect(subject).to eq <<~OUTPUT
+            expect(output).to eq <<~OUTPUT
               spec/views/main_spec.rb
               features/smoke.feature
             OUTPUT
@@ -60,6 +62,16 @@ RSpec.describe 'tff exe' do
         end
       end
     end
+
+    context 'with named captures' do
+      let(:files) { 'lib/api/issues.rb' }
+
+      it 'prints matching test files using given yaml mapping' do
+        expect(output).to eq <<~OUTPUT
+          spec/requests/api/issues/issues_spec.rb
+        OUTPUT
+      end
+    end
   end
 
   context 'with a yaml mapping and json mapping' do
@@ -67,7 +79,7 @@ RSpec.describe 'tff exe' do
     let(:files) { 'db/schema.rb app/models/project.rb ' }
 
     it 'prints matching test files using both yaml and json mappings' do
-      expect(subject).to eq <<~OUTPUT
+      expect(output).to eq <<~OUTPUT
         spec/models/project_spec.rb
         spec/controllers/projects_controller_spec.rb
         spec/db/schema_spec.rb
@@ -80,7 +92,7 @@ RSpec.describe 'tff exe' do
     let(:files) { 'app/models/test_file_finder_gem_executable_widget.rb app/models/project.rb' }
 
     it 'prints matching test files using json mapping' do
-      expect(subject).to eq <<~OUTPUT
+      expect(output).to eq <<~OUTPUT
         spec/models/project_spec.rb
         spec/controllers/projects_controller_spec.rb
       OUTPUT

data/fixtures/lib/api/issues.rb

@@ -0,0 +1 @@
+# frozen_string_literal: true

data/fixtures/mapping.yml

@@ -7,7 +7,7 @@ mapping:
       - 'db/schema\.rb'
       - 'db/migrate/(.+)\.rb'
     test: 'spec/db/schema_spec.rb'
-  - source: 'spec/(.+)_spec.rb'
+  - source: 'spec/(.+)_spec\.rb'
     test:
       - 'spec/%s_spec.rb'
       - 'spec/smoke_spec.rb'
@@ -17,3 +17,7 @@ mapping:
     test:
       - 'spec/views/main_spec.rb'
       - 'features/smoke.feature'
+  - source: '(?<ee>ee/)?lib/api/(?<name>.*)\.rb'
+    test:
+      - '%{ee}spec/requests/api/%{name}_spec.rb'
+      - '%{ee}spec/requests/api/%{name}/%{name}_spec.rb'

data/fixtures/spec/controllers/projects_controller_spec.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 test projects controller spec

data/fixtures/spec/db/schema_spec.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 test schema spec

data/fixtures/spec/models/project_spec.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 test project spec

data/fixtures/spec/models/test_file_finder_gem_executable_widget_spec.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 existing specs

data/fixtures/spec/requests/api/issues/issues_spec.rb

@@ -0,0 +1 @@
+# frozen_string_literal: true

data/fixtures/spec/smoke_spec.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 smoke specs

data/fixtures/spec/views/main_spec.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 main page specs

data/lefthook.yml

@@ -0,0 +1,18 @@
+# Lefthook configuration. For more information, see:
+# https://github.com/evilmartians/lefthook/blob/master/docs/configuration.md
+
+pre-push:
+  parallel: true
+  commands:
+    # Run all tests (warn if there are any missing tools required for tests).
+    # Run undercover, looking for missing test coverage
+    rspec:
+      files: git diff --name-only --diff-filter=d $(git merge-base origin/master HEAD)..HEAD
+      run: bundle exec rspec -f progress
+      glob: '*.rb'
+
+    # Run ruby linting
+    rubocop:
+      files: git diff --name-only --diff-filter=d $(git merge-base origin/master HEAD)..HEAD
+      glob: '*.{rb,rake}'
+      run: bundle exec rubocop --parallel --force-exclusion {files}

data/lib/test_file_finder/file_finder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'set'
 
 module TestFileFinder
@@ -22,7 +24,18 @@ module TestFileFinder
     attr_reader :paths
 
     def search
-      file_path_guesses.select { |path| File.exist?(path) }
+      file_name_patterns, plain_guesses = file_path_guesses.partition(&file_name_pattern?)
+
+      file_name_patterns.flat_map { |pattern| Dir.glob(pattern) } +
+        plain_guesses.select { |path| File.exist?(path) }
+    end
+
+    # Returns true if a test file name contains metacharacter like *, {, [, ?
+    # which indicates a file name pattern.
+    #
+    # See https://rubyapi.org/o/dir#method-c-glob
+    def file_name_pattern?
+      proc { |guess| guess.match?(/[*{\[?]/) }
     end
 
     def file_path_guesses

data/lib/test_file_finder/mapping.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'set'
 require 'yaml'
 require 'test_file_finder/mapping_strategies'

data/lib/test_file_finder/mapping_strategies/direct_matching.rb

@@ -1,31 +1,58 @@
+# frozen_string_literal: true
+
 require 'json'
 
 module TestFileFinder
   module MappingStrategies
     class DirectMatching
-      JSON_ERROR_MESSAGE = 'json file should contain a json object, with array of test files as the values'.freeze
+      JSON_ERROR_MESSAGE = 'json file should contain a json object, with array of test files as the values'
+
+      attr_reader :map, :limit_percentage, :limit_min
 
-      def self.load_json(json_file)
+      def self.load_json(json_file, **kwargs)
         map = JSON.parse(File.read(json_file))
 
-        validate(map)
+        validate_map(map)
+        validate_params(**kwargs)
 
-        new.tap do |strategy|
-          strategy.map = map
-        end
+        new(map, **kwargs)
       end
 
-      def self.validate(map)
-        return if map.is_a?(Hash) && map.values.all? { |value| value.is_a?(Array) }
+      def self.validate_map(map)
+        return if map.is_a?(Hash) && map.values.all?(Array)
 
         raise InvalidMappingFileError, JSON_ERROR_MESSAGE
       end
 
-      attr_accessor :map
+      def self.validate_params(limit_percentage: nil, limit_min: nil)
+        return if limit_percentage.nil?
+
+        limit_percentage_valid = limit_percentage.is_a?(Integer) && (1..100).cover?(limit_percentage)
+        raise "Invalid value for limit_percentage: should be an integer between 1 and 100" unless limit_percentage_valid
+
+        limit_min_valid = limit_min.nil? || (limit_min.is_a?(Integer) && limit_min.positive?)
+        return if limit_min_valid
+
+        raise "Invalid value for limit_min: should be an integer strictly greater than zero"
+      end
+
+      def initialize(map, limit_percentage: nil, limit_min: nil)
+        @map              = map
+        @limit_percentage = limit_percentage
+        @limit_min        = limit_min
+      end
 
       def match(files)
         Array(files).inject(Set.new) do |result, file|
           test_files = @map.fetch(file, [])
+
+          if limit_percentage
+            sample_size = (limit_percentage * test_files.count).round
+            sample_size = limit_min if limit_min && sample_size <= limit_min
+
+            test_files = test_files.sample(sample_size)
+          end
+
           result.merge(test_files)
         end.to_a
       end

data/lib/test_file_finder/mapping_strategies/gitlab_merge_request_rspec_failure.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 require 'json'
 require 'set'
@@ -15,7 +17,7 @@ module TestFileFinder
     #
     # It returns file names of rspec failures in the pipeline.
     class GitlabMergeRequestRspecFailure
-      TEST_REPORTS_URL_TEMPLATE = 'https://gitlab.com/%{project_path}/-/merge_requests/%{merge_request_iid}/test_reports.json'.freeze
+      TEST_REPORTS_URL_TEMPLATE = 'https://gitlab.com/%{project_path}/-/merge_requests/%{merge_request_iid}/test_reports.json'
 
       attr_reader :project_path, :merge_request_iid
 
@@ -53,21 +55,22 @@ module TestFileFinder
       def rspec_file(failure)
         file = failure['file'].sub('./', '')
 
-        if file.end_with?('spec.rb')
-          yield file
-        end
+        yield(file) if file.end_with?('spec.rb')
       end
 
       def merge_request_test_reports
-        test_reports_url = format(TEST_REPORTS_URL_TEMPLATE, { project_path: project_path, merge_request_iid: merge_request_iid })
+        test_reports_url = format(TEST_REPORTS_URL_TEMPLATE,
+          { project_path: project_path, merge_request_iid: merge_request_iid })
 
-        response = Faraday.get(test_reports_url, {}, {'Accept' => 'application/json'})
+        response = Faraday.get(test_reports_url, {}, { 'Accept' => 'application/json' })
 
-        if response.status == 204
-          raise TestFileFinder::TestReportError, "Test report for merge request #{merge_request_iid} is not ready, please try again later."
-        elsif response.status == 400
+        case response.status
+        when 204
+          raise TestFileFinder::TestReportError,
+            "Test report for merge request #{merge_request_iid} is not ready, please try again later."
+        when 400
           raise TestFileFinder::TestReportError, "The project #{project_path} does not have test reports configured."
-        elsif response.status == 500
+        when 500
           raise TestFileFinder::TestReportError, 'Unable to retrieve test report, please try again later.'
         end
 

data/lib/test_file_finder/mapping_strategies/pattern_matching.rb

@@ -1,46 +1,53 @@
+# frozen_string_literal: true
+
 module TestFileFinder
   module MappingStrategies
     class PatternMatching
       attr_reader :pattern_matchers
 
       def self.load(mapping_file)
-        content = File.read(mapping_file)
-        maps = YAML.load(content)['mapping']
+        maps = YAML.safe_load_file(mapping_file)['mapping']
 
         validate(maps)
 
-        new do |mapping|
-          maps.each do |map|
-            Array(map['source']).each do |source|
-              Array(map['test']).each do |test|
-                mapping.relate(source, test)
-              end
-            end
-          end
-        end
+        new(maps)
       end
 
-      def self.validate(maps)
-        raise InvalidMappingFileError, 'missing `mapping` in test mapping file' if maps.nil?
-        raise InvalidMappingFileError, 'missing `source` or `test` in test mapping file' if maps.any? { |map| incomplete?(map) }
+      def self.default_rails_mapping
+        mapping = new
+        mapping.relate(%r{^app/(.+)\.rb$}, 'spec/%s_spec.rb')
+        mapping.relate(%r{^lib/(.+)\.rb$}, 'spec/lib/%s_spec.rb')
+        mapping.relate(%r{^spec/(.+)_spec\.rb$}, 'spec/%s_spec.rb')
+        mapping
       end
 
-      def self.incomplete?(map)
-        map['source'].nil? || map['test'].nil?
+      def self.validate(maps = nil)
+        raise InvalidMappingFileError, 'missing `mapping` in test mapping file' if maps.nil?
+
+        return if maps.all? { |map| complete?(map) }
+
+        raise InvalidMappingFileError, 'missing `source` or `test` in test mapping file'
       end
 
-      def self.default_rails_mapping
-        new do |mapping|
-          mapping.relate(%r{^app/(.+)\.rb$}, 'spec/%s_spec.rb')
-          mapping.relate(%r{^lib/(.+)\.rb$}, 'spec/lib/%s_spec.rb')
-          mapping.relate(%r{^spec/(.+)_spec.rb$}, 'spec/%s_spec.rb')
-        end
+      def self.complete?(map)
+        !map['source'].nil? && !map['test'].nil?
       end
 
-      def initialize
+      def initialize(maps = nil)
         @pattern_matchers = []
 
-        yield self if block_given?
+        # Useful for the .default_rails_mapping class method
+        #
+        # We don't have a file to use, but we still need an instance to be returned
+        return unless maps
+
+        maps.each do |map|
+          Array(map['source']).each do |source|
+            Array(map['test']).each do |test|
+              relate(source, test)
+            end
+          end
+        end
       end
 
       def relate(source, test)
@@ -57,13 +64,29 @@ module TestFileFinder
       private
 
       def pattern_matcher_for(source, test)
-        regexp = %r{^#{source}$}
+        regexp = /^#{source}$/
+
+        if regexp.named_captures.any?
+          pattern_matcher_with_named_captures_for(regexp, test)
+        else
+          pattern_matcher_with_numbered_captures_for(regexp, test)
+        end
+      end
 
+      def pattern_matcher_with_named_captures_for(regexp, test)
         proc do |files|
           Array(files).flat_map do |file|
-            if (match = regexp.match(file))
-              test % match.captures
-            end
+            match = regexp.match(file)
+            format(test, match.named_captures.transform_keys(&:to_sym)) if match
+          end.compact
+        end
+      end
+
+      def pattern_matcher_with_numbered_captures_for(regexp, test)
+        proc do |files|
+          Array(files).flat_map do |file|
+            match = regexp.match(file)
+            format(test, *match.captures) if match
           end.compact
         end
       end

data/lib/test_file_finder/mapping_strategies.rb

@@ -1,9 +1,9 @@
-require 'test_file_finder/mapping_strategies/direct_matching'
-require 'test_file_finder/mapping_strategies/gitlab_merge_request_rspec_failure'
-require 'test_file_finder/mapping_strategies/pattern_matching'
+# frozen_string_literal: true
 
 module TestFileFinder
   module MappingStrategies
-
+    autoload :DirectMatching, 'test_file_finder/mapping_strategies/direct_matching'
+    autoload :PatternMatching, 'test_file_finder/mapping_strategies/pattern_matching'
+    autoload :GitlabMergeRequestRspecFailure, 'test_file_finder/mapping_strategies/gitlab_merge_request_rspec_failure'
   end
 end

data/lib/test_file_finder/option_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'optparse'
 
 module TestFileFinder
@@ -21,7 +23,8 @@ module TestFileFinder
             options.json = json
           end
 
-          opts.on('--project-path PROJECT_PATH', String, 'Path of GitLab project, e.g `gitlab-org/gitlab`') do |project_path|
+          opts.on('--project-path PROJECT_PATH', String,
+            'Path of GitLab project, e.g `gitlab-org/gitlab`') do |project_path|
             options.project_path = project_path
           end
 

data/lib/test_file_finder/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TestFileFinder
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/lib/test_file_finder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_file_finder/file_finder'
 require 'test_file_finder/mapping'
 require 'test_file_finder/mapping_strategies'
@@ -5,7 +7,7 @@ require 'test_file_finder/option_parser'
 require 'test_file_finder/version'
 
 module TestFileFinder
-  class Error < StandardError; end
+  Error = Class.new(StandardError)
 
   InvalidMappingFileError = Class.new(Error)
   TestReportError = Class.new(Error)

data/test_file_finder.gemspec

@@ -1,32 +1,34 @@
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'test_file_finder/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'test_file_finder'
-  spec.version       = TestFileFinder::VERSION
-  spec.authors       = ['GitLab']
-  spec.email         = ['rubygems-committee@gitlab.com']
+  spec.name                  = 'test_file_finder'
+  spec.version               = TestFileFinder::VERSION
+  spec.licenses              = ['MIT']
+  spec.authors               = ['GitLab']
+  spec.email                 = ['rubygems-committee@gitlab.com']
+  spec.required_ruby_version = '>= 3.0'
 
-  spec.summary       = %q{Guesses spec file paths given input file paths.}
-  spec.description   = %q{A command-line tool for guessing which spec files are relavant to a passed-in set of file paths.}
+  spec.summary       = %q(Guesses spec file paths given input file paths.)
+  spec.description   = %q(Command-line tool for guessing which spec files are relevant to a set of input file paths.)
   spec.homepage      = 'https://gitlab.com/gitlab-org/ruby/gems/test_file_finder'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-
-    spec.metadata['homepage_uri'] = spec.homepage
-    spec.metadata['source_code_uri'] = 'https://gitlab.com/gitlab-org/ruby/gems/test_file_finder'
-    spec.metadata['changelog_uri'] = 'https://gitlab.com/gitlab-org/ruby/gems/test_file_finder/-/blob/master/CHANGELOG.md'
-  else
-    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
-  end
+  raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.' unless spec.respond_to?(:metadata)
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://gitlab.com/gitlab-org/ruby/gems/test_file_finder'
+  spec.metadata['changelog_uri'] = 'https://gitlab.com/gitlab-org/ruby/gems/test_file_finder/-/blob/master/CHANGELOG.md'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = 'exe'
@@ -37,7 +39,11 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'byebug'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'gitlab-dangerfiles', '~> 4.6.0'
+  spec.add_development_dependency 'gitlab-styles', '~> 11.0'
+  spec.add_development_dependency 'lefthook', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.6'
   spec.add_development_dependency 'webmock', '~> 3.18'
 end

data/tests.yml

@@ -1,5 +1,5 @@
 mapping:
-  - source: lib/(.+).rb
+  - source: lib/(.+)\.rb
     test: spec/lib/%s_spec.rb
-  - source: spec/spec_helper.rb
+  - source: spec/spec_helper\.rb
     test: spec

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test_file_finder
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - GitLab
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-30 00:00:00.000000000 Z
+date: 2024-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -64,20 +64,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: gitlab-dangerfiles
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.0
+- !ruby/object:Gem::Dependency
+  name: gitlab-styles
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: lefthook
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -92,6 +134,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -106,8 +162,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.18'
-description: A command-line tool for guessing which spec files are relavant to a passed-in
-  set of file paths.
+description: Command-line tool for guessing which spec files are relevant to a set
+  of input file paths.
 email:
 - rubygems-committee@gitlab.com
 executables:
@@ -119,8 +175,11 @@ files:
 - ".gitlab-ci.yml"
 - ".gitlab/merge_request_templates/Release.md"
 - ".rspec"
+- ".rubocop.yml"
+- Dangerfile
 - Gemfile
 - Gemfile.lock
+- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
@@ -129,15 +188,18 @@ files:
 - exe/tff
 - feature/tff_exe_spec.rb
 - fixtures/features/smoke.feature
+- fixtures/lib/api/issues.rb
 - fixtures/mapping.json
 - fixtures/mapping.yml
 - fixtures/spec/controllers/projects_controller_spec.rb
 - fixtures/spec/db/schema_spec.rb
 - fixtures/spec/models/project_spec.rb
 - fixtures/spec/models/test_file_finder_gem_executable_widget_spec.rb
+- fixtures/spec/requests/api/issues/issues_spec.rb
 - fixtures/spec/smoke_spec.rb
 - fixtures/spec/views/main_spec.rb
 - fixtures/test_reports.json
+- lefthook.yml
 - lib/test_file_finder.rb
 - lib/test_file_finder/file_finder.rb
 - lib/test_file_finder/mapping.rb
@@ -150,13 +212,14 @@ files:
 - test_file_finder.gemspec
 - tests.yml
 homepage: https://gitlab.com/gitlab-org/ruby/gems/test_file_finder
-licenses: []
+licenses:
+- MIT
 metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://gitlab.com/gitlab-org/ruby/gems/test_file_finder
   source_code_uri: https://gitlab.com/gitlab-org/ruby/gems/test_file_finder
   changelog_uri: https://gitlab.com/gitlab-org/ruby/gems/test_file_finder/-/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -164,15 +227,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Guesses spec file paths given input file paths.
 test_files: []