rubocop 1.57.1 → 1.81.6

data/config/internal_affairs.yml

@@ -0,0 +1,31 @@
+# Configuration for InternalAffairs cops. This file will be
+# automatically loaded when `rubocop/cop/internal_affairs` is required.
+# Only do this when developing custom cops or a RuboCop extension.
+
+InternalAffairs/CopDescription:
+  Include:
+    - 'lib/rubocop/cop/**/*.rb'
+
+InternalAffairs/ExampleHeredocDelimiter:
+  Include:
+    - 'spec/rubocop/cop/**/*.rb'
+
+InternalAffairs/ExampleDescription:
+  Include:
+    - 'spec/rubocop/cop/**/*.rb'
+
+InternalAffairs/NodeTypeGroup:
+  Include:
+    - 'lib/rubocop/cop/**/*.rb'
+
+InternalAffairs/OnSendWithoutOnCSend:
+  Include:
+    - 'lib/rubocop/cop/**/*.rb'
+
+InternalAffairs/UndefinedConfig:
+  Include:
+    - 'lib/rubocop/cop/**/*.rb'
+
+InternalAffairs/UselessMessageAssertion:
+  Include:
+    - '**/*_spec.rb'

data/config/obsoletion.yml

@@ -31,6 +31,9 @@ renamed:
   Lint/UnneededRequireStatement: Lint/RedundantRequireStatement
   Lint/UnneededSplatExpansion: Lint/RedundantSplatExpansion
   Metrics/LineLength: Layout/LineLength
+  Naming/PredicateName:
+    new_name: Naming/PredicatePrefix
+    severity: warning
   Naming/UncommunicativeBlockParamName: Naming/BlockParameterName
   Naming/UncommunicativeMethodParamName: Naming/MethodParameterName
   Style/AccessorMethodName: Naming/AccessorMethodName
@@ -43,7 +46,9 @@ renamed:
   Style/MethodCallParentheses: Style/MethodCallWithoutArgsParentheses
   Style/MethodName: Naming/MethodName
   Style/OpMethod: Naming/BinaryOperatorParameterName
-  Style/PredicateName: Naming/PredicateName
+  Style/PredicateName:
+    new_name: Naming/PredicatePrefix
+    severity: warning
   Style/SingleSpaceBeforeFirstArg: Layout/SpaceBeforeFirstArg
   Style/UnneededCapitalW: Style/RedundantCapitalW
   Style/UnneededCondition: Style/RedundantCondition
@@ -177,10 +182,10 @@ changed_parameters:
   - cops: Naming/HeredocDelimiterNaming
     parameters: Blacklist
     alternative: ForbiddenDelimiters
-  - cops: Naming/PredicateName
+  - cops: Naming/PredicatePrefix
     parameters: NamePrefixBlacklist
     alternative: ForbiddenPrefixes
-  - cops: Naming/PredicateName
+  - cops: Naming/PredicatePrefix
     parameters: NameWhitelist
     alternative: AllowedMethods
   - cops:

data/exe/rubocop

@@ -11,13 +11,7 @@ exit exit_status if server_cli.exit?
 if RuboCop::Server.running?
   exit_status = RuboCop::Server::ClientCommand::Exec.new.run
 else
-  require 'benchmark'
   require 'rubocop'
-
-  cli = RuboCop::CLI.new
-
-  time = Benchmark.realtime { exit_status = cli.run }
-
-  puts "Finished in #{time} seconds" if cli.options[:debug] || cli.options[:display_time]
+  exit_status = RuboCop::CLI.new.run
 end
 exit exit_status

data/lib/rubocop/cached_data.rb

@@ -45,14 +45,30 @@ module RuboCop
 
     # Restore an offense object loaded from a JSON file.
     def deserialize_offenses(offenses)
-      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)
         Cop::Offense.new(o['severity'], location, o['message'], o['cop_name'], o['status'].to_sym)
       end
     end
+
+    def location_from_source_buffer(offense)
+      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
+
+    # Delay creation until needed. Some type of offenses will have no buffer associated with them
+    # and be global only. For these, trying to create the buffer will likely fail, for example
+    # because of unknown encoding comments.
+    def source_buffer
+      @source_buffer ||= begin
+        source = File.read(@filename, encoding: Encoding::UTF_8)
+        Parser::Source::Buffer.new(@filename, source: source)
+      end
+    end
   end
 end

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

@@ -10,13 +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 = '(skipped because a list of cops is passed to the `--only` flag)'
+        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
@@ -28,12 +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)
+            skip_line_length_cop(PHASE_1_SKIPPED_ONLY_COPS)
           else
             run_line_length_cop
           end
@@ -64,6 +70,10 @@ module RuboCop
           @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.
@@ -73,7 +83,7 @@ module RuboCop
           execute_runner
           @options.delete(:only)
           @config_store = ConfigStore.new
-          @config_store.options_config = @options[:config] if @options[:config]
+          @config_store.apply_options!(@options)
           # Save the todo configuration of the LineLength cop.
           File.read(AUTO_GENERATED_FILE).lines.drop_while { |line| line.start_with?('#') }.join
         end
@@ -89,7 +99,7 @@ module RuboCop
 
         def reset_config_and_auto_gen_file
           @config_store = ConfigStore.new
-          @config_store.options_config = @options[:config] if @options[:config]
+          @config_store.apply_options!(@options)
           File.open(AUTO_GENERATED_FILE, 'w') {} # create or truncate if exists
           add_inheritance_from_auto_generated_file(@options[:config])
         end
@@ -125,28 +135,31 @@ module RuboCop
 
         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?
+          return AUTO_GENERATED_FILE unless @options[:config]
 
-          base = Pathname.new('.')
-          config_dir = Pathname.new(File.dirname(@options[:config]))
+          base = Pathname.new(Dir.pwd)
+          config_dir = Pathname.new(@options[:config]).realpath.dirname
 
-          "#{base.relative_path_from(config_dir)}/#{AUTO_GENERATED_FILE}"
-        end
+          # Don't have the path start with `/`
+          return AUTO_GENERATED_FILE if config_dir == base
 
-        def options_config_in_root?
-          File.dirname(@options[:config]) == '.'
+          "#{base.relative_path_from(config_dir)}/#{AUTO_GENERATED_FILE}"
         end
       end
     end

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

@@ -71,14 +71,14 @@ module RuboCop
 
           warn Rainbow("\n#{pluralize(errors.size, 'error')} occurred:").red
 
-          errors.each { |error| warn error }
+          errors.each { |error| warn Rainbow(error).red }
 
-          warn <<~WARNING
+          warn Rainbow(<<~WARNING.strip).yellow
             Errors are usually caused by RuboCop bugs.
-            Please, report your problems to RuboCop's issue tracker.
+            Please, update to the latest RuboCop version if not already in use, and report a bug if the issue still occurs on this version.
             #{bug_tracker_uri}
             Mention the following information in the issue report:
-            #{RuboCop::Version.version(debug: true)}
+            #{RuboCop::Version.verbose}
           WARNING
         end
 

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

@@ -1,17 +1,17 @@
 # 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
+      class LSP < Base
         self.command_name = :lsp
 
         def run
-          RuboCop::Lsp::Server.new(@config_store).start
+          # Load on demand, `languge-server-protocol` is heavy to require.
+          require_relative '../../lsp/server'
+          RuboCop::LSP::Server.new(@config_store).start
         end
       end
     end

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

@@ -9,11 +9,31 @@ module RuboCop
       class ShowCops < Base
         self.command_name = :show_cops
 
+        ExactMatcher = Struct.new(:pattern) do
+          def match?(name)
+            name == pattern
+          end
+        end
+
+        WildcardMatcher = Struct.new(:pattern) do
+          def match?(name)
+            File.fnmatch(pattern, name, File::FNM_PATHNAME)
+          end
+        end
+
         def initialize(env)
           super
 
           # Load the configs so the require()s are done for custom cops
           @config = @config_store.for(Dir.pwd)
+
+          @cop_matchers = @options[:show_cops].map do |pattern|
+            if pattern.include?('*')
+              WildcardMatcher.new(pattern)
+            else
+              ExactMatcher.new(pattern)
+            end
+          end
         end
 
         def run
@@ -24,7 +44,7 @@ module RuboCop
 
         def print_available_cops
           registry = Cop::Registry.global
-          show_all = @options[:show_cops].empty?
+          show_all = @cop_matchers.empty?
 
           puts "# Available cops (#{registry.length}) + config for #{Dir.pwd}: " if show_all
 
@@ -56,7 +76,9 @@ module RuboCop
 
         def selected_cops_of_department(cops, department)
           cops_of_department(cops, department).select do |cop|
-            @options[:show_cops].include?(cop.cop_name)
+            @cop_matchers.any? do |matcher|
+              matcher.match?(cop.cop_name)
+            end
           end
         end
 

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

@@ -97,7 +97,13 @@ module RuboCop
         end
 
         def loaded_extensions
-          @config_store.for_pwd.loaded_features.to_a
+          rubocop_config = @config_store.for_pwd
+
+          plugin_names = rubocop_config.loaded_plugins.map do |plugin|
+            plugin.about.name
+          end
+
+          plugin_names + rubocop_config.loaded_features.to_a
         end
 
         def installed_and_not_loaded_extensions

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

@@ -9,8 +9,8 @@ module RuboCop
         self.command_name = :version
 
         def run
-          puts RuboCop::Version.version(debug: false) if @options[:version]
-          puts RuboCop::Version.version(debug: true, env: env) if @options[:verbose_version]
+          puts RuboCop::Version::STRING if @options[:version]
+          puts RuboCop::Version.verbose(env: env) if @options[:verbose_version]
         end
       end
     end

data/lib/rubocop/cli.rb

@@ -12,7 +12,7 @@ module RuboCop
     STATUS_INTERRUPTED = Signal.list['INT'] + 128
     DEFAULT_PARALLEL_OPTIONS = %i[
       color config debug display_style_guide display_time display_only_fail_level_offenses
-      display_only_failed except extra_details fail_level fix_layout format
+      display_only_failed editor_mode except extra_details fail_level fix_layout format formatters
       ignore_disable_comments lint only only_guide_cops require safe
       autocorrect safe_autocorrect autocorrect_all
     ].freeze
@@ -37,6 +37,8 @@ module RuboCop
     #
     # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     def run(args = ARGV)
+      time_start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
       @options, paths = Options.new.parse(args)
       @env = Environment.new(@options, @config_store, paths)
 
@@ -48,15 +50,20 @@ module RuboCop
           validate_options_vs_config
           parallel_by_default!
           apply_default_formatter
+          report_pending_cops
           execute_runners
         end
       end
     rescue ConfigNotFoundError, IncorrectCopNameError, OptionArgumentError => e
-      warn e.message
+      warn Rainbow(e.message).red
       STATUS_ERROR
     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 +74,9 @@ module RuboCop
       warn e.message
       warn e.backtrace
       STATUS_ERROR
+    ensure
+      elapsed_time = Process.clock_gettime(Process::CLOCK_MONOTONIC) - time_start
+      puts "Finished in #{elapsed_time} seconds" if @options[:debug] || @options[:display_time]
     end
     # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
@@ -151,9 +161,10 @@ module RuboCop
 
     def act_on_options
       set_options_to_config_loader
+      set_options_to_pending_cops_reporter
+      handle_editor_mode
 
-      @config_store.options_config = @options[:config] if @options[:config]
-      @config_store.force_default_config! if @options[:force_default_config]
+      @config_store.apply_options!(@options)
 
       handle_exiting_options
 
@@ -174,6 +185,15 @@ module RuboCop
       ConfigLoader.ignore_unrecognized_cops = @options[:ignore_unrecognized_cops]
     end
 
+    def set_options_to_pending_cops_reporter
+      PendingCopsReporter.disable_pending_cops = @options[:disable_pending_cops]
+      PendingCopsReporter.enable_pending_cops = @options[:enable_pending_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 }
@@ -199,5 +219,9 @@ module RuboCop
         [[formatter, @options[:output_path]]]
       end
     end
+
+    def report_pending_cops
+      PendingCopsReporter.warn_if_needed(@config_store.for_pwd)
+    end
   end
 end

data/lib/rubocop/comment_config.rb

@@ -4,7 +4,7 @@ module RuboCop
   # This class parses the special `rubocop:disable` comments in a source
   # and provides a way to check if each cop is enabled at arbitrary line.
   class CommentConfig
-    extend Forwardable
+    extend SimpleForwardable
 
     CONFIG_DISABLED_LINE_RANGE_MIN = -Float::INFINITY
 
@@ -87,7 +87,7 @@ module RuboCop
           next unless directive.enabled?
           next if directive.all_cops?
 
-          cops.merge(directive.cop_names)
+          cops.merge(directive.raw_cop_names)
         end
         cops
       end
@@ -205,7 +205,7 @@ module RuboCop
       directive.cop_names.each do |name|
         if directive.disabled?
           names[name] += 1
-        elsif (names[name]).positive?
+        elsif names[name].positive?
           names[name] -= 1
         else
           extras[directive.comment] << name