Add wildcard pattern support for paths in rubycritic.yml (#476)

Author: rishijain

.reek.yml

@@ -93,9 +93,11 @@ detectors:
   DuplicateMethodCall:
     exclude:
     - RubyCritic::Analyser::Churn#run
+    - RubyCritic::Configuration#set
     - Parser::AST::Node#module_name
   TooManyStatements:
     exclude:
+    - RubyCritic::Configuration#find_directories
     - RubyCritic::RakeTask#initialize
     - RubyCritic::Analyser::Complexity#run
     - RubyCritic::Analyser::Coverage#synchronize_resultset
@@ -119,15 +121,18 @@ detectors:
     - RubyCritic::ViewHelpers#smell_location_path
     - RubyCritic::Generator::HtmlReport#create_directories_and_files
     - RubyCritic::SourceLocator#deduplicate_symlinks
+    - RubyCritic::Configuration#setup_paths_for_targets
   NestedIterators:
     exclude:
     - Parser::AST::Node#recursive_children
     - RubyCritic::Analyser::FlaySmells#run
     - RubyCritic::Cli::Options::Argv#parse
     - RubyCritic::Generator::HtmlReport#create_directories_and_files
     - RubyCritic::AnalysedModulesCollection#initialize
+    - RubyCritic::Configuration#find_directories
   UtilityFunction:
     exclude:
+    - RubyCritic::Configuration#find_directories
     - RubyCritic::Analyser::Coverage#resultset_path
     - RubyCritic::Analyser::Coverage#resultset_writelock
     - RubyCritic::Analyser::FlaySmells#cost

.rubocop.yml

@@ -92,3 +92,11 @@ Lint/StructNewOverride:
 Metrics/AbcSize:
   Exclude:
     - 'lib/rubycritic/configuration.rb'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/rubycritic/configuration.rb'
+
+Style/RedundantAssignment:
+  Exclude:
+    - 'lib/rubycritic/configuration.rb'

CHANGELOG.md

@@ -26,6 +26,8 @@
 * [CHANGE] Fix some typos (by [@jbampton][])
 * [FEATURE] Add coverage_path configuration option (by [@exoego][])
 
+* [CHANGE] Add support for wildcard entries to the paths option in rubycritic.yml (by [@rishiain][])
+
 # v4.9.0 / 2023-10-18 [(commits)](https://github.com/whitesmith/rubycritic/compare/v4.8.1...v4.9.0)
 
 * [CHANGE] Bump aruba, cucumber, fakefs, flog, mdl, minitest, and rubocop dependencies (by [@faisal][])

README.md

@@ -154,6 +154,7 @@ minimum_score: 95 # default is 0
 paths: # Files to analyse. Churn calculation is scoped to these files when using Git SCM.
   - 'app/controllers/'
   - 'app/models/'
+  - 'lib/**'  # Wildcard patterns are supported (excludes tmp directories automatically)
 ```
 
 ### Analyzer Configuration

lib/rubycritic/configuration.rb

@@ -21,11 +21,16 @@ def set(options)
       self.no_browser = options[:no_browser]
       self.coverage_path = options[:coverage_path]
       self.threshold_score = options[:threshold_score].to_i
+      setup_paths_for_targets(options) if options[:paths]
       setup_analysis_targets(options)
       setup_version_control(options)
       setup_formats(options)
     end
 
+    def setup_paths_for_targets(options)
+      options[:paths] = find_directories(options[:paths])
+    end
+
     def setup_analysis_targets(options)
       self.paths = options[:paths] || ['.']
       self.ruby_extensions = options[:ruby_extensions] || %w[.rb .rake .thor]
@@ -51,6 +56,20 @@ def source_control_present?
       source_control_system &&
         !source_control_system.is_a?(SourceControlSystem::Double)
     end
+
+    private
+
+    def find_directories(paths)
+      expanded_paths = paths.flat_map do |path|
+        if path.include?('**')
+          search_pattern = File.join(path)
+          Dir.glob(search_pattern).select { |tmp_path| File.directory?(tmp_path) && !tmp_path.start_with?('tmp') }
+        else
+          path
+        end
+      end
+      expanded_paths
+    end
   end
 
   module Config

test/lib/rubycritic/configuration_test.rb

@@ -40,4 +40,89 @@
       _(RubyCritic::Config.formats).must_equal [:html]
     end
   end
+
+  describe '#setup_paths_for_targets' do
+    let(:config) { RubyCritic::Configuration.new }
+
+    it 'processes paths without wildcards correctly' do
+      options = { paths: ['lib', 'app/models'] }
+      config.setup_paths_for_targets(options)
+
+      _(options[:paths]).must_equal ['lib', 'app/models']
+    end
+
+    it 'expands wildcard patterns to matching directories' do
+      # Create temporary directory structure for testing
+      Dir.mktmpdir do |tmpdir|
+        Dir.chdir(tmpdir) do
+          FileUtils.mkdir_p('src/controllers')
+          FileUtils.mkdir_p('src/admin/app')
+          FileUtils.mkdir_p('src/admin/lib')
+          FileUtils.mkdir_p('src/customer/app')
+          FileUtils.mkdir_p('src/models')
+          FileUtils.mkdir_p('src/views')
+          FileUtils.mkdir_p('lib/tasks')
+
+          options = { paths: ['src/**/app'] }
+          config.setup_paths_for_targets(options)
+          expected = ['src/admin/app', 'src/customer/app']
+
+          _(options[:paths].sort).must_equal expected.sort
+        end
+      end
+    end
+
+    it 'excludes tmp directories from wildcard expansion' do
+      # Create temporary directory structure for testing
+      Dir.mktmpdir do |tmpdir|
+        Dir.chdir(tmpdir) do
+          FileUtils.mkdir_p('src/models')
+          FileUtils.mkdir_p('app/models')
+          FileUtils.mkdir_p('tmp/cache')
+          FileUtils.mkdir_p('tmp/logs')
+
+          options = { paths: ['**'] }
+          config.setup_paths_for_targets(options)
+
+          _(options[:paths]).wont_include 'tmp/cache'
+          _(options[:paths]).wont_include 'tmp/logs'
+          _(options[:paths]).wont_include 'tmp'
+          _(options[:paths]).must_include 'src'
+          _(options[:paths]).must_include 'app'
+        end
+      end
+    end
+
+    it 'handles mixed wildcard and non-wildcard paths' do
+      # Create temporary directory structure for testing
+      Dir.mktmpdir do |tmpdir|
+        Dir.chdir(tmpdir) do
+          FileUtils.mkdir_p('app/models')
+          FileUtils.mkdir_p('app/controllers')
+          FileUtils.mkdir_p('lib/tasks')
+          FileUtils.mkdir_p('spec/support')
+
+          options = { paths: ['app/**', 'lib', 'spec/support'] }
+          config.setup_paths_for_targets(options)
+
+          _(options[:paths]).must_include 'app/models'
+          _(options[:paths]).must_include 'app/controllers'
+          _(options[:paths]).must_include 'lib'
+          _(options[:paths]).must_include 'spec/support'
+        end
+      end
+    end
+
+    it 'processes empty wildcard results correctly' do
+      # Create temporary directory structure for testing
+      Dir.mktmpdir do |tmpdir|
+        Dir.chdir(tmpdir) do
+          options = { paths: ['nonexistent/**'] }
+          config.setup_paths_for_targets(options)
+
+          _(options[:paths]).must_equal []
+        end
+      end
+    end
+  end
 end