rubocop 1.10.0 → 1.14.0

data/lib/rubocop/name_similarity.rb

@@ -16,7 +16,7 @@ module RuboCop
       # DidYouMean::SpellChecker is not available in all versions of Ruby, and
       # even on versions where it *is* available (>= 2.3), it is not always
       # required correctly. So we do a feature check first.
-      # See: https://github.com/rubocop-hq/rubocop/issues/7979
+      # See: https://github.com/rubocop/rubocop/issues/7979
       return [] unless defined?(DidYouMean::SpellChecker)
 
       names = names.dup

data/lib/rubocop/options.rb

@@ -112,9 +112,7 @@ module RuboCop
         @options.replace(ConfigRegeneration.new.options.merge(@options))
       end
 
-      option(opts, '--exclude-limit COUNT') do
-        @validator.validate_exclude_limit_option
-      end
+      option(opts, '--exclude-limit COUNT') { @validator.validate_exclude_limit_option }
 
       option(opts, '--disable-uncorrectable')
 
@@ -161,9 +159,7 @@ module RuboCop
 
     def add_cache_options(opts)
       option(opts, '-C', '--cache FLAG')
-      option(opts, '--cache-root DIR') do
-        @validator.validate_cache_enabled_for_cache_root
-      end
+      option(opts, '--cache-root DIR') { @validator.validate_cache_enabled_for_cache_root }
     end
 
     # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
@@ -173,16 +169,12 @@ module RuboCop
       option(opts, '-D', '--[no-]display-cop-names')
       option(opts, '-E', '--extra-details')
       option(opts, '-S', '--display-style-guide')
-      option(opts, '-a', '--auto-correct') do
-        @options[:safe_auto_correct] = true
-      end
+      option(opts, '-a', '--auto-correct') { @options[:safe_auto_correct] = true }
       option(opts, '--safe-auto-correct') do
         warn '--safe-auto-correct is deprecated; use --auto-correct'
         @options[:safe_auto_correct] = @options[:auto_correct] = true
       end
-      option(opts, '-A', '--auto-correct-all') do
-        @options[:auto_correct] = true
-      end
+      option(opts, '-A', '--auto-correct-all') { @options[:auto_correct] = true }
       option(opts, '--disable-pending-cops')
       option(opts, '--enable-pending-cops')
       option(opts, '--ignore-disable-comments')
@@ -194,7 +186,7 @@ module RuboCop
 
       option(opts, '-v', '--version')
       option(opts, '-V', '--verbose-version')
-      option(opts, '-P', '--parallel')
+      option(opts, '-P', '--[no-]parallel')
     end
     # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
@@ -229,8 +221,7 @@ module RuboCop
     # e.g. [..., '--auto-correct', ...] to :auto_correct.
     def long_opt_symbol(args)
       long_opt = args.find { |arg| arg.start_with?('--') }
-      long_opt[2..-1].sub('[no-]', '').sub(/ .*/, '')
-                     .tr('-', '_').gsub(/[\[\]]/, '').to_sym
+      long_opt[2..-1].sub('[no-]', '').sub(/ .*/, '').tr('-', '_').gsub(/[\[\]]/, '').to_sym
     end
 
     def require_feature(file)
@@ -286,16 +277,13 @@ module RuboCop
     end
 
     def validate_cop_options
-      %i[only except].each do |opt|
-        OptionsValidator.validate_cop_list(@options[opt])
-      end
+      %i[only except].each { |opt| OptionsValidator.validate_cop_list(@options[opt]) }
     end
 
     # rubocop:disable Metrics/AbcSize
     def validate_compatibility # rubocop:disable Metrics/MethodLength
       if only_includes_redundant_disable?
-        raise OptionArgumentError, 'Lint/RedundantCopDisableDirective cannot ' \
-                                   'be used with --only.'
+        raise OptionArgumentError, 'Lint/RedundantCopDisableDirective cannot be used with --only.'
       end
       raise OptionArgumentError, 'Syntax checking cannot be turned off.' if except_syntax?
       unless boolean_or_empty_cache?
@@ -313,8 +301,7 @@ module RuboCop
 
       return if incompatible_options.size <= 1
 
-      raise OptionArgumentError, 'Incompatible cli options: ' \
-                                 "#{incompatible_options.inspect}"
+      raise OptionArgumentError, "Incompatible cli options: #{incompatible_options.inspect}"
     end
     # rubocop:enable Metrics/AbcSize
 
@@ -326,8 +313,7 @@ module RuboCop
       %i[exclude_limit offense_counts auto_gen_timestamp
          auto_gen_only_exclude].each do |option|
         if @options.key?(option)
-          raise OptionArgumentError,
-                format(message, flag: option.to_s.tr('_', '-'))
+          raise OptionArgumentError, format(message, flag: option.to_s.tr('_', '-'))
         end
       end
     end
@@ -357,27 +343,29 @@ module RuboCop
                                    'false is not allowed.'
       end
 
-      validate_parallel_with_combo_option
+      disable_parallel_when_invalid_combo
     end
 
-    def validate_parallel_with_combo_option
+    def disable_parallel_when_invalid_combo
       combos = {
-        auto_gen_config: '-P/--parallel uses caching to speed up execution, ' \
-                         'while --auto-gen-config needs a non-cached run, ' \
-                         'so they cannot be combined.',
-        fail_fast: '-P/--parallel cannot be combined with -F/--fail-fast.',
-        auto_correct: '-P/--parallel cannot be combined with --auto-correct.'
+        auto_gen_config: '--auto-gen-config',
+        fail_fast: '-F/--fail-fast.',
+        auto_correct: '--auto-correct.'
       }
 
-      combos.each do |key, msg|
-        raise OptionArgumentError, msg if @options.key?(key)
-      end
+      invalid_combos = combos.select { |key, _flag| @options.key?(key) }
+
+      return if invalid_combos.empty?
+
+      @options.delete(:parallel)
+
+      puts '-P/--parallel is being ignored because ' \
+           "it is not compatible with #{invalid_combos.values.join(', ')}"
     end
 
     def only_includes_redundant_disable?
       @options.key?(:only) &&
-        (@options[:only] & %w[Lint/RedundantCopDisableDirective
-                              RedundantCopDisableDirective]).any?
+        (@options[:only] & %w[Lint/RedundantCopDisableDirective RedundantCopDisableDirective]).any?
     end
 
     def display_only_fail_level_offenses_with_autocorrect?
@@ -385,8 +373,7 @@ module RuboCop
     end
 
     def except_syntax?
-      @options.key?(:except) &&
-        (@options[:except] & %w[Lint/Syntax Syntax]).any?
+      @options.key?(:except) && (@options[:except] & %w[Lint/Syntax Syntax]).any?
     end
 
     def boolean_or_empty_cache?
@@ -408,8 +395,7 @@ module RuboCop
     def validate_cache_enabled_for_cache_root
       return unless @options[:cache] == 'false'
 
-      raise OptionArgumentError, '--cache-root can not be used with ' \
-                                  '--cache false'
+      raise OptionArgumentError, '--cache-root can not be used with --cache false'
     end
   end
 
@@ -512,7 +498,7 @@ module RuboCop
       version:                          'Display version.',
       verbose_version:                  'Display verbose version.',
       parallel:                         ['Use available CPUs to execute inspection in',
-                                         'parallel.'],
+                                         'parallel. Default is false.'],
       stdin:                            ['Pipe source from STDIN, using FILE in offense',
                                          'reports. This is useful for editor integration.'],
       init:                             'Generate a .rubocop.yml file in the current directory.'

data/lib/rubocop/path_util.rb

@@ -77,9 +77,7 @@ module RuboCop
     end
 
     def hidden_dir?(path)
-      File.dirname(path).split(File::SEPARATOR).any? do |dir|
-        dir.start_with?('.')
-      end
+      File.dirname(path).split(File::SEPARATOR).any? { |dir| dir.start_with?('.') }
     end
   end
 end

data/lib/rubocop/rake_task.rb

@@ -68,6 +68,9 @@ module RuboCop
           RakeFileUtils.verbose(verbose) do
             yield(*[self, task_args].slice(0, task_block.arity)) if task_block
             options = full_options.unshift('--auto-correct-all')
+            # `parallel` will automatically be removed from the options internally.
+            # This is a nice to have to suppress the warning message
+            # about parallel and auto-corrent not being compatible.
             options.delete('--parallel')
             run_cli(verbose, options)
           end

data/lib/rubocop/remote_config.rb

@@ -46,11 +46,9 @@ module RuboCop
       http.use_ssl = uri.instance_of?(URI::HTTPS)
 
       generate_request(uri) do |request|
-        begin
-          handle_response(http.request(request), limit, &block)
-        rescue SocketError => e
-          handle_response(e, limit, &block)
-        end
+        handle_response(http.request(request), limit, &block)
+      rescue SocketError => e
+        handle_response(e, limit, &block)
       end
     end
 
@@ -72,8 +70,7 @@ module RuboCop
         begin
           response.error!
         rescue StandardError => e
-          message = "#{e.message} while downloading remote config"\
-            " file #{uri}"
+          message = "#{e.message} while downloading remote config file #{uri}"
           raise e, message
         end
       end

data/lib/rubocop/result_cache.rb

@@ -39,8 +39,7 @@ module RuboCop
       private
 
       def requires_file_removal?(file_count, config_store)
-        file_count > 1 &&
-          file_count > config_store.for_pwd.for_all_cops['MaxFilesInCache']
+        file_count > 1 && file_count > config_store.for_pwd.for_all_cops['MaxFilesInCache']
       end
 
       def remove_oldest_files(files, dirs, cache_root, verbose)
@@ -108,7 +107,7 @@ module RuboCop
 
     def load
       puts "Loading cache from #{@path}" if debug?
-      @cached_data.from_json(IO.read(@path, encoding: Encoding::UTF_8))
+      @cached_data.from_json(File.read(@path, encoding: Encoding::UTF_8))
     end
 
     def save(offenses)
@@ -117,8 +116,7 @@ module RuboCop
       begin
         FileUtils.mkdir_p(dir)
       rescue Errno::EACCES, Errno::EROFS => e
-        warn "Couldn't create cache directory. Continuing without cache."\
-             "\n  #{e.message}"
+        warn "Couldn't create cache directory. Continuing without cache.\n  #{e.message}"
         return
       end
 
@@ -159,9 +157,7 @@ module RuboCop
     def file_checksum(file, config_store)
       digester = Digest::SHA1.new
       mode = File.stat(file).mode
-      digester.update(
-        "#{file}#{mode}#{config_store.for_file(file).signature}"
-      )
+      digester.update("#{file}#{mode}#{config_store.for_file(file).signature}")
       digester.file(file)
       digester.hexdigest
     rescue Errno::ENOENT
@@ -224,10 +220,7 @@ module RuboCop
     # This context is for anything that's not (1) the RuboCop executable
     # checksum or (2) the inspected file checksum.
     def context_checksum(team, options)
-      Digest::SHA1.hexdigest([
-        team_checksum(team),
-        relevant_options_digest(options)
-      ].join)
+      Digest::SHA1.hexdigest([team_checksum(team), relevant_options_digest(options)].join)
     end
   end
 end

data/lib/rubocop/rspec/cop_helper.rb

@@ -6,7 +6,7 @@ require 'tempfile'
 module CopHelper
   extend RSpec::SharedContext
 
-  let(:ruby_version) { 2.4 }
+  let(:ruby_version) { 2.5 }
   let(:rails_version) { false }
 
   def inspect_source(source, file = nil)

data/lib/rubocop/rspec/expect_offense.rb

@@ -118,8 +118,7 @@ module RuboCop
 
         @processed_source = parse_processed_source(source, file)
         @offenses = _investigate(cop, @processed_source)
-        actual_annotations =
-          expected_annotations.with_offense_annotations(@offenses)
+        actual_annotations = expected_annotations.with_offense_annotations(@offenses)
 
         expect(actual_annotations).to eq(expected_annotations), ''
         expect(@offenses.map(&:severity).uniq).to eq([severity]) if severity
@@ -152,8 +151,7 @@ module RuboCop
           end
 
           # Prepare for next loop
-          @processed_source = parse_source(corrected_source,
-                                           @processed_source.path)
+          @processed_source = parse_source(corrected_source, @processed_source.path)
           _investigate(cop, @processed_source)
         end
 
@@ -178,8 +176,7 @@ module RuboCop
         offenses = inspect_source(source, file)
 
         expected_annotations = AnnotatedSource.parse(source)
-        actual_annotations =
-          expected_annotations.with_offense_annotations(offenses)
+        actual_annotations = expected_annotations.with_offense_annotations(offenses)
         expect(actual_annotations.to_s).to eq(source)
       end
 
@@ -246,9 +243,7 @@ module RuboCop
         end
 
         def ==(other)
-          other.is_a?(self.class) &&
-            other.lines == lines &&
-            match_annotations?(other)
+          other.is_a?(self.class) && other.lines == lines && match_annotations?(other)
         end
 
         # Dirty hack: expectations with [...] are rewritten when they match

data/lib/rubocop/rspec/shared_contexts.rb

@@ -27,9 +27,7 @@ RSpec.shared_context 'isolated environment', :isolated_environment do
       begin
         FileUtils.mkdir_p(working_dir)
 
-        Dir.chdir(working_dir) do
-          example.run
-        end
+        Dir.chdir(working_dir) { example.run }
       ensure
         ENV['HOME'] = original_home
         ENV['XDG_CONFIG_HOME'] = original_xdg_config_home
@@ -41,9 +39,7 @@ RSpec.shared_context 'isolated environment', :isolated_environment do
 end
 
 RSpec.shared_context 'maintain registry', :restore_registry do
-  around(:each) do |example|
-    RuboCop::Cop::Registry.with_temporary_global { example.run }
-  end
+  around(:each) { |example| RuboCop::Cop::Registry.with_temporary_global { example.run } }
 
   def stub_cop_class(name, inherit: RuboCop::Cop::Base, &block)
     klass = Class.new(inherit, &block)
@@ -100,15 +96,12 @@ RSpec.shared_context 'config', :config do # rubocop:disable Metrics/BlockLength
   end
 
   let(:config) do
-    hash = { 'AllCops' => all_cops_config,
-             cop_class.cop_name => cur_cop_config }.merge!(other_cops)
+    hash = { 'AllCops' => all_cops_config, cop_class.cop_name => cur_cop_config }.merge!(other_cops)
 
     RuboCop::Config.new(hash, "#{Dir.pwd}/.rubocop.yml")
   end
 
-  let(:cop) do
-    cop_class.new(config, cop_options)
-  end
+  let(:cop) { cop_class.new(config, cop_options) }
 end
 
 RSpec.shared_context 'mock console output' do
@@ -123,10 +116,6 @@ RSpec.shared_context 'mock console output' do
   end
 end
 
-RSpec.shared_context 'ruby 2.4', :ruby24 do
-  let(:ruby_version) { 2.4 }
-end
-
 RSpec.shared_context 'ruby 2.5', :ruby25 do
   let(:ruby_version) { 2.5 }
 end
@@ -142,3 +131,7 @@ end
 RSpec.shared_context 'ruby 3.0', :ruby30 do
   let(:ruby_version) { 3.0 }
 end
+
+RSpec.shared_context 'ruby 3.1', :ruby31 do
+  let(:ruby_version) { 3.1 }
+end

data/lib/rubocop/runner.rb

@@ -112,9 +112,7 @@ module RuboCop
     end
 
     def list_files(paths)
-      paths.each do |path|
-        puts PathUtil.relative_path(path)
-      end
+      paths.each { |path| puts PathUtil.relative_path(path) }
     end
 
     def process_file(file)
@@ -193,11 +191,10 @@ module RuboCop
 
     def redundant_cop_disable_directive(file)
       config = @config_store.for_file(file)
-      if config.for_cop(Cop::Lint::RedundantCopDisableDirective)
-               .fetch('Enabled')
-        cop = Cop::Lint::RedundantCopDisableDirective.new(config, @options)
-        yield cop if cop.relevant_file?(file)
-      end
+      return unless config.for_cop(Cop::Lint::RedundantCopDisableDirective).fetch('Enabled')
+
+      cop = Cop::Lint::RedundantCopDisableDirective.new(config, @options)
+      yield cop if cop.relevant_file?(file)
     end
 
     def filtered_run?
@@ -206,9 +203,7 @@ module RuboCop
 
     def file_started(file)
       puts "Scanning #{file}" if @options[:debug]
-      formatter_set.file_started(file,
-                                 cli_options: @options,
-                                 config_store: @config_store)
+      formatter_set.file_started(file, cli_options: @options, config_store: @config_store)
     end
 
     def file_finished(file, offenses)
@@ -372,9 +367,7 @@ module RuboCop
       @formatter_set ||= begin
         set = Formatter::FormatterSet.new(@options)
         pairs = @options[:formatters] || [['progress']]
-        pairs.each do |formatter_key, output_path|
-          set.add_formatter(formatter_key, output_path)
-        end
+        pairs.each { |formatter_key, output_path| set.add_formatter(formatter_key, output_path) }
         set
       end
     end

data/lib/rubocop/target_finder.rb

@@ -61,9 +61,7 @@ module RuboCop
       hidden_files = all_files.select { |file| file.include?(HIDDEN_PATH_SUBSTRING) }.sort
       base_dir_config = @config_store.for(base_dir)
 
-      target_files = all_files.select do |file|
-        to_inspect?(file, hidden_files, base_dir_config)
-      end
+      target_files = all_files.select { |file| to_inspect?(file, hidden_files, base_dir_config) }
 
       target_files.sort_by!(&order)
     end
@@ -96,12 +94,23 @@ module RuboCop
     end
 
     def wanted_dir_patterns(base_dir, exclude_pattern, flags)
+      base_dir = base_dir.gsub('/{}/', '/\{}/')
       dirs = Dir.glob(File.join(base_dir.gsub('/**/', '/\**/'), '*/'), flags)
                 .reject do |dir|
-                  dir.end_with?('/./', '/../') || File.fnmatch?(exclude_pattern, dir, flags)
+                  next true if dir.end_with?('/./', '/../')
+                  next true if File.fnmatch?(exclude_pattern, dir, flags)
+
+                  symlink_excluded_or_infinite_loop?(base_dir, dir, exclude_pattern, flags)
                 end
-      dirs.flat_map { |dir| wanted_dir_patterns(dir, exclude_pattern, flags) }
-          .unshift(base_dir)
+      dirs.flat_map { |dir| wanted_dir_patterns(dir, exclude_pattern, flags) }.unshift(base_dir)
+    end
+
+    def symlink_excluded_or_infinite_loop?(base_dir, current_dir, exclude_pattern, flags)
+      dir_realpath = File.realpath(current_dir)
+      File.symlink?(current_dir.chomp('/')) && (
+        File.fnmatch?(exclude_pattern, "#{dir_realpath}/", flags) ||
+        File.realpath(base_dir).start_with?(dir_realpath)
+      )
     end
 
     def combined_exclude_glob_patterns(base_dir)
@@ -117,9 +126,7 @@ module RuboCop
 
     def ruby_extensions
       @ruby_extensions ||= begin
-        ext_patterns = all_cops_include.select do |pattern|
-          pattern.start_with?('**/*.')
-        end
+        ext_patterns = all_cops_include.select { |pattern| pattern.start_with?('**/*.') }
         ext_patterns.map { |pattern| pattern.sub('**/*', '') }
       end
     end
@@ -130,16 +137,13 @@ module RuboCop
 
     def ruby_filenames
       @ruby_filenames ||= begin
-        file_patterns = all_cops_include.reject do |pattern|
-          pattern.start_with?('**/*.')
-        end
+        file_patterns = all_cops_include.reject { |pattern| pattern.start_with?('**/*.') }
         file_patterns.map { |pattern| pattern.sub('**/', '') }
       end
     end
 
     def all_cops_include
-      @all_cops_include ||=
-        @config_store.for_pwd.for_all_cops['Include'].map(&:to_s)
+      @all_cops_include ||= @config_store.for_pwd.for_all_cops['Include'].map(&:to_s)
     end
 
     def ruby_executable?(file)
@@ -162,8 +166,7 @@ module RuboCop
     end
 
     def ruby_file?(file)
-      stdin? || ruby_extension?(file) || ruby_filename?(file) ||
-        ruby_executable?(file)
+      stdin? || ruby_extension?(file) || ruby_filename?(file) || ruby_executable?(file)
     end
 
     def configured_include?(file)