rubocop 1.24.1 → 1.64.1

data/config/obsoletion.yml

@@ -55,6 +55,8 @@ renamed:
 
 # Cops that were removed
 removed:
+  Gemspec/DateAssignment:
+    alternatives: Gemspec/DeprecatedAttributeAssignment
   Layout/SpaceAfterControlKeyword:
     alternatives: Layout/SpaceAroundKeyword
   Layout/SpaceBeforeModifierKeyword:
@@ -152,7 +154,7 @@ changed_parameters:
     alternative: EnforcedStyle
   - cops: Style/MethodCallWithArgsParentheses
     parameters: IgnoredMethodPatterns
-    alternative: IgnoredPatterns
+    alternative: AllowedPatterns
   - cops:
       - Performance/Count
       - Performance/Detect
@@ -185,12 +187,48 @@ changed_parameters:
       - Metrics/BlockLength
       - Metrics/MethodLength
     parameters: ExcludedMethods
-    alternative: IgnoredMethods
+    alternatives:
+      - AllowedMethods
+      - AllowedPatterns
     severity: warning
   - cops: Lint/Debugger
     parameters: DebuggerReceivers
     reason: "`DebuggerReceivers` is no longer necessary, method receivers should be specified in `DebuggerMethods` instead."
     severity: warning
+  - cops:
+      - Layout/IndentationWidth
+      - Layout/LineLength
+      - Lint/UnreachableLoop
+      - Naming/MethodName
+      - Style/MethodCallWithArgsParentheses
+    parameters: IgnoredPatterns
+    alternative: AllowedPatterns
+    severity: warning
+  - cops:
+      - Lint/AmbiguousBlockAssociation
+      - Lint/NumberConversion
+      - Metrics/AbcSize
+      - Metrics/BlockLength
+      - Metrics/CyclomaticComplexity
+      - Metrics/MethodLength
+      - Metrics/PerceivedComplexity
+      - Style/BlockDelimiters
+      - Style/ClassEqualityComparison
+      - Style/FormatStringToken
+      - Style/MethodCallWithArgsParentheses
+      - Style/MethodCallWithoutArgsParentheses
+      - Style/NumericPredicate
+      - Style/SymbolLiteral
+    parameters: IgnoredMethods
+    alternatives:
+      - AllowedMethods
+      - AllowedPatterns
+    severity: warning
+  - cops: Style/ArgumentsForwarding
+    parameters: AllowOnlyRestArgument
+    reason: "`AllowOnlyRestArgument` has no effect with TargetRubyVersion >= 3.2."
+    severity: warning
+    minimum_ruby_version: 3.2
 
 # Enforced styles that have been removed or replaced
 changed_enforced_styles:

data/exe/rubocop

@@ -3,13 +3,21 @@
 
 $LOAD_PATH.unshift("#{__dir__}/../lib")
 
-require 'rubocop'
-require 'benchmark'
+require 'rubocop/server'
+server_cli = RuboCop::Server::CLI.new
+exit_status = server_cli.run
+exit exit_status if server_cli.exit?
 
-cli = RuboCop::CLI.new
-result = 0
+if RuboCop::Server.running?
+  exit_status = RuboCop::Server::ClientCommand::Exec.new.run
+else
+  require 'benchmark'
+  require 'rubocop'
 
-time = Benchmark.realtime { result = cli.run }
+  cli = RuboCop::CLI.new
 
-puts "Finished in #{time} seconds" if cli.options[:debug] || cli.options[:display_time]
-exit result
+  time = Benchmark.realtime { exit_status = cli.run }
+
+  puts "Finished in #{time} seconds" if cli.options[:debug] || cli.options[:display_time]
+end
+exit exit_status

data/lib/rubocop/arguments_env.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # This is a class that reads optional command line arguments to rubocop from environment variable.
+  # @api private
+  class ArgumentsEnv
+    def self.read_as_arguments
+      if (arguments = ENV.fetch('RUBOCOP_OPTS', '')).empty?
+        []
+      else
+        require 'shellwords'
+
+        Shellwords.split(arguments)
+      end
+    end
+  end
+end

data/lib/rubocop/arguments_file.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # This is a class that reads optional command line arguments to rubocop from .rubocop file.
+  # @api private
+  class ArgumentsFile
+    def self.read_as_arguments
+      if File.exist?('.rubocop') && !File.directory?('.rubocop')
+        require 'shellwords'
+
+        File.read('.rubocop').shellsplit
+      else
+        []
+      end
+    end
+  end
+end

data/lib/rubocop/cache_config.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # This class represents the cache config of the caching RuboCop runs.
+  # @api private
+  class CacheConfig
+    def self.root_dir
+      root = ENV.fetch('RUBOCOP_CACHE_ROOT', nil)
+      root ||= yield
+      root ||= if ENV.key?('XDG_CACHE_HOME')
+                 # Include user ID in the path to make sure the user has write
+                 # access.
+                 File.join(ENV.fetch('XDG_CACHE_HOME'), Process.uid.to_s)
+               else
+                 # On FreeBSD, the /home path is a symbolic link to /usr/home
+                 # and the $HOME environment variable returns the /home path.
+                 #
+                 # As $HOME is a built-in environment variable, FreeBSD users
+                 # always get a warning message.
+                 #
+                 # To avoid raising warn log messages on FreeBSD, we retrieve
+                 # the real path of the home folder.
+                 File.join(File.realpath(Dir.home), '.cache')
+               end
+
+      File.join(root, 'rubocop_cache')
+    end
+  end
+end

data/lib/rubocop/cached_data.rb

@@ -48,11 +48,19 @@ module RuboCop
       source_buffer = Parser::Source::Buffer.new(@filename)
       source_buffer.source = File.read(@filename, encoding: Encoding::UTF_8)
       offenses.map! do |o|
-        location = Parser::Source::Range.new(source_buffer,
-                                             o['location']['begin_pos'],
-                                             o['location']['end_pos'])
+        location = location_from_source_buffer(o, source_buffer)
         Cop::Offense.new(o['severity'], location, o['message'], o['cop_name'], o['status'].to_sym)
       end
     end
+
+    def location_from_source_buffer(offense, source_buffer)
+      begin_pos = offense['location']['begin_pos']
+      end_pos = offense['location']['end_pos']
+      if begin_pos.zero? && end_pos.zero?
+        Cop::Offense::NO_LOCATION
+      else
+        Parser::Source::Range.new(source_buffer, begin_pos, end_pos)
+      end
+    end
   end
 end

data/lib/rubocop/cli/command/{auto_genenerate_config.rb → auto_generate_config.rb}

@@ -10,12 +10,17 @@ module RuboCop
 
         AUTO_GENERATED_FILE = '.rubocop_todo.yml'
         YAML_OPTIONAL_DOC_START = /\A---(\s+#|\s*\z)/.freeze
+        PLACEHOLDER = '###rubocop:inherit_here'
 
         PHASE_1 = 'Phase 1 of 2: run Layout/LineLength cop'
         PHASE_2 = 'Phase 2 of 2: run all cops'
 
         PHASE_1_OVERRIDDEN = '(skipped because the default Layout/LineLength:Max is overridden)'
         PHASE_1_DISABLED = '(skipped because Layout/LineLength is disabled)'
+        PHASE_1_SKIPPED_ONLY_COPS =
+          '(skipped because a list of cops is passed to the `--only` flag)'
+        PHASE_1_SKIPPED_ONLY_EXCLUDE =
+          '(skipped because only excludes will be generated due to `--auto-gen-only-exclude` flag)'
 
         def run
           add_formatter
@@ -27,10 +32,14 @@ module RuboCop
         private
 
         def maybe_run_line_length_cop
-          if !line_length_enabled?(@config_store.for_pwd)
+          if only_exclude?
+            skip_line_length_cop(PHASE_1_SKIPPED_ONLY_EXCLUDE)
+          elsif !line_length_enabled?(@config_store.for_pwd)
             skip_line_length_cop(PHASE_1_DISABLED)
           elsif !same_max_line_length?(@config_store.for_pwd, ConfigLoader.default_configuration)
             skip_line_length_cop(PHASE_1_OVERRIDDEN)
+          elsif options_has_only_flag?
+            skip_line_length_cop(PHASE_1_SKIPPED_ONLY_COPS)
           else
             run_line_length_cop
           end
@@ -57,6 +66,14 @@ module RuboCop
           config.for_cop('Layout/LineLength')
         end
 
+        def options_has_only_flag?
+          @options[:only]
+        end
+
+        def only_exclude?
+          @options[:auto_gen_only_exclude]
+        end
+
         # Do an initial run with only Layout/LineLength so that cops that
         # depend on Layout/LineLength:Max get the correct value for that
         # parameter.
@@ -66,6 +83,7 @@ module RuboCop
           execute_runner
           @options.delete(:only)
           @config_store = ConfigStore.new
+          @config_store.options_config = @options[:config] if @options[:config]
           # Save the todo configuration of the LineLength cop.
           File.read(AUTO_GENERATED_FILE).lines.drop_while { |line| line.start_with?('#') }.join
         end
@@ -95,36 +113,54 @@ module RuboCop
         end
 
         def add_inheritance_from_auto_generated_file(config_file)
-          file_string = " #{AUTO_GENERATED_FILE}"
+          file_string = " #{relative_path_to_todo_from_options_config}"
 
-          config_file ||= ConfigLoader::DOTFILE
+          config_file ||= ConfigFinder::DOTFILE
 
           if File.exist?(config_file)
             files = Array(ConfigLoader.load_yaml_configuration(config_file)['inherit_from'])
 
-            return if files.include?(AUTO_GENERATED_FILE)
+            return if files.include?(relative_path_to_todo_from_options_config)
 
-            files.unshift(AUTO_GENERATED_FILE)
+            files.unshift(relative_path_to_todo_from_options_config)
             file_string = "\n  - #{files.join("\n  - ")}" if files.size > 1
             rubocop_yml_contents = existing_configuration(config_file)
           end
 
           write_config_file(config_file, file_string, rubocop_yml_contents)
 
-          puts "Added inheritance from `#{AUTO_GENERATED_FILE}` in `#{ConfigLoader::DOTFILE}`."
+          puts "Added inheritance from `#{relative_path_to_todo_from_options_config}` " \
+               "in `#{ConfigFinder::DOTFILE}`."
         end
 
         def existing_configuration(config_file)
           File.read(config_file, encoding: Encoding::UTF_8)
-              .sub(/^inherit_from: *[^\n]+/, '')
-              .sub(/^inherit_from: *(\n *- *[^\n]+)+/, '')
+              .sub(/^inherit_from: *[^\n]+/, PLACEHOLDER)
+              .sub(/^inherit_from: *(\n *- *[^\n]+)+/, PLACEHOLDER)
         end
 
         def write_config_file(file_name, file_string, rubocop_yml_contents)
           lines = /\S/.match?(rubocop_yml_contents) ? rubocop_yml_contents.split("\n", -1) : []
-          doc_start_index = lines.index { |line| YAML_OPTIONAL_DOC_START.match?(line) } || -1
-          lines.insert(doc_start_index + 1, "inherit_from:#{file_string}\n")
-          File.write(file_name, lines.join("\n"))
+          unless rubocop_yml_contents&.include?(PLACEHOLDER)
+            doc_start_index = lines.index { |line| YAML_OPTIONAL_DOC_START.match?(line) } || -1
+            lines.insert(doc_start_index + 1, PLACEHOLDER)
+          end
+          File.write(file_name, lines.join("\n")
+                                     .sub(/#{PLACEHOLDER}\n*/o, "inherit_from:#{file_string}\n\n")
+                                     .sub(/\n\n+\Z/, "\n"))
+        end
+
+        def relative_path_to_todo_from_options_config
+          return AUTO_GENERATED_FILE if !@options[:config] || options_config_in_root?
+
+          base = Pathname.new('.')
+          config_dir = Pathname.new(File.dirname(@options[:config]))
+
+          "#{base.relative_path_from(config_dir)}/#{AUTO_GENERATED_FILE}"
+        end
+
+        def options_config_in_root?
+          File.dirname(@options[:config]) == '.'
         end
       end
     end

data/lib/rubocop/cli/command/execute_runner.rb

@@ -41,13 +41,13 @@ module RuboCop
 
         def with_redirect
           if @options[:stderr]
-            orig_stdout = $stdout.dup
-            $stdout.reopen($stderr)
-
-            result = yield
-
-            $stdout.reopen(orig_stdout)
-            result
+            orig_stdout = $stdout
+            begin
+              $stdout = $stderr
+              yield
+            ensure
+              $stdout = orig_stdout
+            end
           else
             yield
           end
@@ -76,20 +76,25 @@ module RuboCop
           warn <<~WARNING
             Errors are usually caused by RuboCop bugs.
             Please, report your problems to RuboCop's issue tracker.
-            #{Gem.loaded_specs['rubocop'].metadata['bug_tracker_uri']}
-
+            #{bug_tracker_uri}
             Mention the following information in the issue report:
             #{RuboCop::Version.version(debug: true)}
           WARNING
         end
 
+        def bug_tracker_uri
+          return unless Gem.loaded_specs.key?('rubocop')
+
+          "#{Gem.loaded_specs['rubocop'].metadata['bug_tracker_uri']}\n"
+        end
+
         def maybe_print_corrected_source
           # Integration tools (like RubyMine) expect to have only the JSON result
           # when specifying JSON format. Similar HTML and JUnit are targeted as well.
           # See: https://github.com/rubocop/rubocop/issues/8673
           return if INTEGRATION_FORMATTERS.include?(@options[:format])
 
-          return unless @options[:stdin] && @options[:auto_correct]
+          return unless @options[:stdin] && @options[:autocorrect]
 
           (@options[:stderr] ? $stderr : $stdout).puts '=' * 20
           print @options[:stdin]

data/lib/rubocop/cli/command/init_dotfile.rb

@@ -6,7 +6,7 @@ module RuboCop
       # Generate a .rubocop.yml file in the current directory.
       # @api private
       class InitDotfile < Base
-        DOTFILE = ConfigLoader::DOTFILE
+        DOTFILE = ConfigFinder::DOTFILE
 
         self.command_name = :init
 

data/lib/rubocop/cli/command/lsp.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative '../../lsp/server'
+
+module RuboCop
+  class CLI
+    module Command
+      # Start Language Server Protocol of RuboCop.
+      # @api private
+      class LSP < Base
+        self.command_name = :lsp
+
+        def run
+          RuboCop::LSP::Server.new(@config_store).start
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cli/command/show_cops.rb

@@ -47,7 +47,7 @@ module RuboCop
 
         def print_cop_details(cops)
           cops.each do |cop|
-            puts '# Supports --auto-correct' if cop.support_autocorrect?
+            puts '# Supports --autocorrect' if cop.support_autocorrect?
             puts "#{cop.cop_name}:"
             puts config_lines(cop)
             puts

data/lib/rubocop/cli/command/show_docs_url.rb

@@ -26,10 +26,10 @@ module RuboCop
 
           cops_array.each do |cop_name|
             cop = registry_hash[cop_name]
-
             next if cop.empty?
 
-            puts Cop::Documentation.url_for(cop.first, @config)
+            url = Cop::Documentation.url_for(cop.first, @config)
+            puts url if url
           end
 
           puts

data/lib/rubocop/cli/command/suggest_extensions.rb

@@ -17,20 +17,10 @@ module RuboCop
         def run
           return if skip? || extensions.none?
 
-          puts
-          puts 'Tip: Based on detected gems, the following '\
-               'RuboCop extension libraries might be helpful:'
+          print_install_suggestions if not_installed_extensions.any?
+          print_load_suggestions if installed_and_not_loaded_extensions.any?
 
-          extensions.sort.each do |extension|
-            puts "  * #{extension} (https://rubygems.org/gems/#{extension})"
-          end
-
-          puts
-          puts 'You can opt out of this message by adding the following to your config '\
-               '(see https://docs.rubocop.org/rubocop/extensions.html#extension-suggestions '\
-               'for more options):'
-          puts '  AllCops:'
-          puts '    SuggestExtensions: false'
+          print_opt_out_instruction
 
           puts if @options[:display_time]
         end
@@ -42,21 +32,76 @@ module RuboCop
           # 1. On CI
           # 2. When given RuboCop options that it doesn't make sense for
           # 3. For all formatters except specified in `INCLUDED_FORMATTERS'`
-          ENV['CI'] ||
+          ENV.fetch('CI', nil) ||
             @options[:only] || @options[:debug] || @options[:list_target_files] ||
             @options[:out] || @options[:stdin] ||
             !INCLUDED_FORMATTERS.include?(current_formatter)
         end
 
+        def print_install_suggestions
+          puts
+          puts 'Tip: Based on detected gems, the following ' \
+               'RuboCop extension libraries might be helpful:'
+
+          not_installed_extensions.sort.each do |extension|
+            puts "  * #{extension} (https://rubygems.org/gems/#{extension})"
+          end
+        end
+
+        def print_load_suggestions
+          puts
+          puts 'The following RuboCop extension libraries are installed but not loaded in config:'
+
+          installed_and_not_loaded_extensions.sort.each do |extension|
+            puts "  * #{extension}"
+          end
+        end
+
+        def print_opt_out_instruction
+          puts
+          puts 'You can opt out of this message by adding the following to your config ' \
+               '(see https://docs.rubocop.org/rubocop/extensions.html#extension-suggestions ' \
+               'for more options):'
+          puts '  AllCops:'
+          puts '    SuggestExtensions: false'
+        end
+
         def current_formatter
           @options[:format] || @config_store.for_pwd.for_all_cops['DefaultFormatter'] || 'p'
         end
 
-        def extensions
+        def all_extensions
           return [] unless lockfile.dependencies.any?
 
-          extensions = @config_store.for_pwd.for_all_cops['SuggestExtensions'] || {}
-          extensions.select { |_, v| (Array(v) & dependent_gems).any? }.keys - installed_gems
+          extensions = @config_store.for_pwd.for_all_cops['SuggestExtensions']
+          case extensions
+          when true
+            extensions = ConfigLoader.default_configuration.for_all_cops['SuggestExtensions']
+          when false, nil
+            extensions = {}
+          end
+
+          extensions.select { |_, v| (Array(v) & dependent_gems).any? }.keys
+        end
+
+        def extensions
+          not_installed_extensions + installed_and_not_loaded_extensions
+        end
+
+        def installed_extensions
+          all_extensions & installed_gems
+        end
+
+        def not_installed_extensions
+          all_extensions - installed_gems
+        end
+
+        def loaded_extensions
+          @config_store.for_pwd.loaded_features.to_a
+        end
+
+        def installed_and_not_loaded_extensions
+          installed_extensions - loaded_extensions
         end
 
         def lockfile

data/lib/rubocop/cli.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'fileutils'
+
 module RuboCop
   # The CLI is a class responsible of handling all the command line interface
   # logic.
@@ -7,14 +9,15 @@ module RuboCop
     STATUS_SUCCESS     = 0
     STATUS_OFFENSES    = 1
     STATUS_ERROR       = 2
-    STATUS_INTERRUPTED = 128 + Signal.list['INT']
+    STATUS_INTERRUPTED = Signal.list['INT'] + 128
     DEFAULT_PARALLEL_OPTIONS = %i[
-      color debug display_style_guide display_time display_only_fail_level_offenses
-      display_only_failed except extra_details fail_level fix_layout format
+      color config debug display_style_guide display_time display_only_fail_level_offenses
+      display_only_failed editor_mode except extra_details fail_level fix_layout format
       ignore_disable_comments lint only only_guide_cops require safe
+      autocorrect safe_autocorrect autocorrect_all
     ].freeze
 
-    class Finished < RuntimeError; end
+    class Finished < StandardError; end
 
     attr_reader :options, :config_store
 
@@ -37,14 +40,16 @@ module RuboCop
       @options, paths = Options.new.parse(args)
       @env = Environment.new(@options, @config_store, paths)
 
-      if @options[:init]
-        run_command(:init)
-      else
-        act_on_options
-        validate_options_vs_config
-        parallel_by_default!
-        apply_default_formatter
-        execute_runners
+      profile_if_needed do
+        if @options[:init]
+          run_command(:init)
+        else
+          act_on_options
+          validate_options_vs_config
+          parallel_by_default!
+          apply_default_formatter
+          execute_runners
+        end
       end
     rescue ConfigNotFoundError, IncorrectCopNameError, OptionArgumentError => e
       warn e.message
@@ -52,6 +57,10 @@ module RuboCop
     rescue RuboCop::Error => e
       warn Rainbow("Error: #{e.message}").red
       STATUS_ERROR
+    rescue Interrupt
+      warn ''
+      warn 'Exiting...'
+      STATUS_INTERRUPTED
     rescue Finished
       STATUS_SUCCESS
     rescue OptionParser::InvalidOption => e
@@ -67,6 +76,48 @@ module RuboCop
 
     private
 
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    def profile_if_needed
+      return yield unless @options[:profile]
+
+      return STATUS_ERROR unless require_gem('stackprof')
+
+      with_memory = @options[:memory]
+      if with_memory
+        return STATUS_ERROR unless require_gem('memory_profiler')
+
+        MemoryProfiler.start
+      end
+
+      tmp_dir = File.join(ConfigFinder.project_root, 'tmp')
+      FileUtils.mkdir_p(tmp_dir)
+      cpu_profile_file = File.join(tmp_dir, 'rubocop-stackprof.dump')
+      status = nil
+
+      StackProf.run(out: cpu_profile_file) do
+        status = yield
+      end
+      puts "Profile report generated at #{cpu_profile_file}"
+
+      if with_memory
+        puts 'Building memory report...'
+        report = MemoryProfiler.stop
+        memory_profile_file = File.join(tmp_dir, 'rubocop-memory_profiler.txt')
+        report.pretty_print(to_file: memory_profile_file, scale_bytes: true)
+        puts "Memory report generated at #{memory_profile_file}"
+      end
+      status
+    end
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+
+    def require_gem(name)
+      require name
+      true
+    rescue LoadError
+      warn("You don't have #{name} installed. Add it to your Gemfile and run `bundle install`")
+      false
+    end
+
     def run_command(name)
       @env.run(name)
     end
@@ -104,6 +155,7 @@ module RuboCop
 
     def act_on_options
       set_options_to_config_loader
+      handle_editor_mode
 
       @config_store.options_config = @options[:config] if @options[:config]
       @config_store.force_default_config! if @options[:force_default_config]
@@ -124,16 +176,24 @@ module RuboCop
       ConfigLoader.disable_pending_cops = @options[:disable_pending_cops]
       ConfigLoader.enable_pending_cops = @options[:enable_pending_cops]
       ConfigLoader.ignore_parent_exclusion = @options[:ignore_parent_exclusion]
+      ConfigLoader.ignore_unrecognized_cops = @options[:ignore_unrecognized_cops]
+    end
+
+    def handle_editor_mode
+      RuboCop::LSP.enable if @options[:editor_mode]
     end
 
+    # rubocop:disable Metrics/CyclomaticComplexity
     def handle_exiting_options
       return unless Options::EXITING_OPTIONS.any? { |o| @options.key? o }
 
       run_command(:version) if @options[:version] || @options[:verbose_version]
       run_command(:show_cops) if @options[:show_cops]
       run_command(:show_docs_url) if @options[:show_docs_url]
+      run_command(:lsp) if @options[:lsp]
       raise Finished
     end
+    # rubocop:enable Metrics/CyclomaticComplexity
 
     def apply_default_formatter
       # This must be done after the options have already been processed,