rubocop 1.75.8 → 1.81.7

data/lib/rubocop/pending_cops_reporter.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # Reports information about pending cops that are not explicitly configured.
+  #
+  # This class is responsible for displaying warnings when new cops have been added to RuboCop
+  # but have not yet been enabled or disabled in the user's configuration.
+  # It provides a centralized way to determine whether such warnings should be shown,
+  # based on global flags or configuration settings.
+  class PendingCopsReporter
+    class << self
+      PENDING_BANNER = <<~BANNER
+        The following cops were added to RuboCop, but are not configured. Please set Enabled to either `true` or `false` in your `.rubocop.yml` file.
+
+        Please also note that you can opt-in to new cops by default by adding this to your config:
+          AllCops:
+            NewCops: enable
+      BANNER
+
+      attr_accessor :disable_pending_cops, :enable_pending_cops
+
+      def warn_if_needed(config)
+        return if possible_new_cops?(config)
+
+        pending_cops = pending_cops_only_qualified(config.pending_cops)
+        warn_on_pending_cops(pending_cops) unless pending_cops.empty?
+      end
+
+      private
+
+      def pending_cops_only_qualified(pending_cops)
+        pending_cops.select { |cop| Cop::Registry.qualified_cop?(cop.name) }
+      end
+
+      def possible_new_cops?(config)
+        disable_pending_cops || enable_pending_cops ||
+          config.disabled_new_cops? || config.enabled_new_cops?
+      end
+
+      def warn_on_pending_cops(pending_cops)
+        warn Rainbow(PENDING_BANNER).yellow
+
+        pending_cops.each { |cop| warn_pending_cop cop }
+
+        warn Rainbow('For more information: https://docs.rubocop.org/rubocop/versioning.html').yellow
+      end
+
+      def warn_pending_cop(cop)
+        version = cop.metadata['VersionAdded'] || 'N/A'
+
+        warn Rainbow("#{cop.name}: # new in #{version}").yellow
+        warn Rainbow('  Enabled: true').yellow
+      end
+    end
+  end
+end

data/lib/rubocop/result_cache.rb

@@ -9,7 +9,7 @@ module RuboCop
   # Provides functionality for caching RuboCop runs.
   # @api private
   class ResultCache
-    NON_CHANGING = %i[color format formatters out debug fail_level
+    NON_CHANGING = %i[color format formatters out debug display_time fail_level
                       fix_layout autocorrect safe_autocorrect autocorrect_all
                       cache fail_fast stdin parallel].freeze
 
@@ -198,20 +198,22 @@ module RuboCop
     end
 
     def rubocop_extra_features
-      lib_root = File.join(File.dirname(__FILE__), '..')
-      exe_root = File.join(lib_root, '..', 'exe')
+      @rubocop_extra_features ||= begin
+        lib_root = File.join(File.dirname(__FILE__), '..')
+        exe_root = File.join(lib_root, '..', 'exe')
 
-      # Make sure to use an absolute path to prevent errors on Windows
-      # when traversing the relative paths with symlinks.
-      exe_root = File.absolute_path(exe_root)
+        # Make sure to use an absolute path to prevent errors on Windows
+        # when traversing the relative paths with symlinks.
+        exe_root = File.absolute_path(exe_root)
 
-      # These are all the files we have `require`d plus everything in the
-      # exe directory. A change to any of them could affect the cop output
-      # so we include them in the cache hash.
-      source_files = $LOADED_FEATURES + Find.find(exe_root).to_a
-      source_files -= ResultCache.rubocop_required_features # Rely on gem versions
+        # These are all the files we have `require`d plus everything in the
+        # exe directory. A change to any of them could affect the cop output
+        # so we include them in the cache hash.
+        source_files = $LOADED_FEATURES + Find.find(exe_root).to_a
+        source_files -= ResultCache.rubocop_required_features # Rely on gem versions
 
-      source_files
+        source_files
+      end
     end
 
     # Return a hash of the options given at invocation, minus the ones that have

data/lib/rubocop/rspec/expect_offense.rb

@@ -72,9 +72,15 @@ module RuboCop
     #
     #   expect_no_corrections
     #
-    # If your code has variables of different lengths, you can use `%{foo}`,
-    # `^{foo}`, and `_{foo}` to format your template; you can also abbreviate
-    # offense messages with `[...]`:
+    # If your code has variables of different lengths, you can use the
+    # following markers to format your template by passing the variables as a
+    # keyword arguments:
+    #
+    # - `%{foo}`: Interpolates `foo`
+    # - `^{foo}`: Inserts `'^' * foo.size` for dynamic offense range length
+    # - `_{foo}`: Inserts `' ' * foo.size` for dynamic offense range indentation
+    #
+    # You can also abbreviate offense messages with `[...]`.
     #
     #   %w[raise fail].each do |keyword|
     #     expect_offense(<<~RUBY, keyword: keyword)

data/lib/rubocop/runner.rb

@@ -273,7 +273,8 @@ module RuboCop
     end
 
     def do_inspection_loop(file)
-      processed_source = get_processed_source(file)
+      # We can reuse the prism result since the source did not change yet.
+      processed_source = get_processed_source(file, @prism_result)
       # This variable is 2d array used to track corrected offenses after each
       # inspection iteration. This is used to output meaningful infinite loop
       # error message.
@@ -295,7 +296,8 @@ module RuboCop
         # loop if we find any.
         break unless updated_source_file
 
-        processed_source = get_processed_source(file)
+        # Autocorrect has happened, don't use the prism result since it is stale.
+        processed_source = get_processed_source(file, nil)
       end
 
       # Return summary of corrected offenses after all iterations
@@ -482,7 +484,7 @@ module RuboCop
     end
 
     # rubocop:disable Metrics/MethodLength
-    def get_processed_source(file)
+    def get_processed_source(file, prism_result)
       config = @config_store.for_file(file)
       ruby_version = config.target_ruby_version
       parser_engine = config.parser_engine
@@ -493,7 +495,7 @@ module RuboCop
                              ruby_version,
                              file,
                              parser_engine: parser_engine,
-                             prism_result: @prism_result
+                             prism_result: prism_result
                            )
                          else
                            begin

data/lib/rubocop/server/cache.rb

@@ -46,12 +46,14 @@ module RuboCop
         end
 
         # rubocop:disable Metrics/AbcSize
-        def restart_key
+        def restart_key(args_config_file_path: nil)
           lockfile_path = LOCKFILE_NAMES.map do |lockfile_name|
             Pathname(project_dir).join(lockfile_name)
           end.find(&:exist?)
           version_data = lockfile_path&.read || RuboCop::Version::STRING
-          config_data = Pathname(ConfigFinder.find_config_path(Dir.pwd)).read
+          config_data = Pathname(
+            args_config_file_path || ConfigFinder.find_config_path(Dir.pwd)
+          ).read
           yaml = load_erb_templated_yaml(config_data)
 
           inherit_from_data = inherit_from_data(yaml)

data/lib/rubocop/server/client_command/base.rb

@@ -38,6 +38,16 @@ module RuboCop
             warn 'RuboCop server is not running.' unless running
           end
         end
+
+        class << self
+          def args_config_file_path
+            first_args_config_key_index = ARGV.index { |value| ['-c', '--config'].include?(value) }
+
+            return if first_args_config_key_index.nil?
+
+            ARGV[first_args_config_key_index + 1]
+          end
+        end
       end
     end
   end

data/lib/rubocop/server/client_command/exec.rb

@@ -41,7 +41,8 @@ module RuboCop
         end
 
         def incompatible_version?
-          Cache.version_path.read != Cache.restart_key
+          Cache.version_path.read !=
+            Cache.restart_key(args_config_file_path: self.class.args_config_file_path)
         end
 
         def stderr

data/lib/rubocop/server/client_command/start.rb

@@ -34,7 +34,7 @@ module RuboCop
               exit 0
             end
 
-            Cache.write_version_file(Cache.restart_key)
+            write_version_file
 
             host = ENV.fetch('RUBOCOP_SERVER_HOST', '127.0.0.1')
             port = ENV.fetch('RUBOCOP_SERVER_PORT', 0)
@@ -42,6 +42,16 @@ module RuboCop
             Server::Core.new.start(host, port, detach: @detach)
           end
         end
+
+        private
+
+        def write_version_file
+          Cache.write_version_file(
+            Cache.restart_key(
+              args_config_file_path: self.class.args_config_file_path
+            )
+          )
+        end
       end
     end
   end

data/lib/rubocop/target_finder.rb

@@ -42,14 +42,12 @@ module RuboCop
       # Support Windows: Backslashes from command-line -> forward slashes
       base_dir = base_dir.gsub(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR
       all_files = find_files(base_dir, File::FNM_DOTMATCH)
-      # use file.include? for performance optimization
-      hidden_files = all_files.select { |file| file.include?(HIDDEN_PATH_SUBSTRING) }.sort
       base_dir_config = @config_store.for(base_dir)
 
-      target_files = if base_dir.include?(HIDDEN_PATH_SUBSTRING)
+      target_files = if hidden_path?(base_dir)
                        all_files.select { |file| ruby_file?(file) }
                      else
-                       all_files.select { |file| to_inspect?(file, hidden_files, base_dir_config) }
+                       all_files.select { |file| to_inspect?(file, base_dir_config) }
                      end
 
       target_files.sort_by!(&order)
@@ -74,18 +72,20 @@ module RuboCop
 
     private
 
-    def to_inspect?(file, hidden_files, base_dir_config)
+    def to_inspect?(file, base_dir_config)
       return false if base_dir_config.file_to_exclude?(file)
-      return true if !hidden_files.bsearch do |hidden_file|
-        file <=> hidden_file
-      end && ruby_file?(file)
+      return true if !hidden_path?(file) && ruby_file?(file)
 
       base_dir_config.file_to_include?(file)
     end
 
+    def hidden_path?(path)
+      path.include?(HIDDEN_PATH_SUBSTRING)
+    end
+
     def wanted_dir_patterns(base_dir, exclude_pattern, flags)
       # Escape glob characters in base_dir to avoid unwanted behavior.
-      base_dir = base_dir.gsub(/[\\\{\}\[\]\*\?]/) do |reserved_glob_character|
+      base_dir = base_dir.gsub(/[\\{}\[\]*?]/) do |reserved_glob_character|
         "\\#{reserved_glob_character}"
       end
 

data/lib/rubocop/target_ruby.rb

@@ -110,8 +110,17 @@ module RuboCop
       end
 
       def version_from_gemspec_file(file)
+        # When using parser_prism, we need to use a Ruby version that Prism supports (3.3+)
+        # for parsing the gemspec file. This doesn't affect the detected Ruby version,
+        # it's just for the parsing step.
+        ruby_version_for_parsing = if @config.parser_engine == :parser_prism
+                                     3.3
+                                   else
+                                     DEFAULT_VERSION
+                                   end
+
         processed_source = ProcessedSource.from_file(
-          file, DEFAULT_VERSION, parser_engine: @config.parser_engine
+          file, ruby_version_for_parsing, parser_engine: @config.parser_engine
         )
         return unless processed_source.valid_syntax?
 

data/lib/rubocop/version.rb

@@ -3,7 +3,7 @@
 module RuboCop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '1.75.8'
+    STRING = '1.81.7'
 
     MSG = '%<version>s (using %<parser_version>s, ' \
           'rubocop-ast %<rubocop_ast_version>s, ' \

data/lib/rubocop.rb

@@ -180,6 +180,7 @@ require_relative 'rubocop/cop/bundler/insecure_protocol_source'
 require_relative 'rubocop/cop/bundler/ordered_gems'
 
 require_relative 'rubocop/cop/gemspec/add_runtime_dependency'
+require_relative 'rubocop/cop/gemspec/attribute_assignment'
 require_relative 'rubocop/cop/gemspec/dependency_version'
 require_relative 'rubocop/cop/gemspec/deprecated_attribute_assignment'
 require_relative 'rubocop/cop/gemspec/development_dependencies'
@@ -210,6 +211,7 @@ require_relative 'rubocop/cop/layout/empty_line_after_guard_clause'
 require_relative 'rubocop/cop/layout/empty_line_after_magic_comment'
 require_relative 'rubocop/cop/layout/empty_line_after_multiline_condition'
 require_relative 'rubocop/cop/layout/empty_line_between_defs'
+require_relative 'rubocop/cop/layout/empty_lines_after_module_inclusion'
 require_relative 'rubocop/cop/layout/empty_lines_around_access_modifier'
 require_relative 'rubocop/cop/layout/empty_lines_around_arguments'
 require_relative 'rubocop/cop/layout/empty_lines_around_attribute_accessor'
@@ -289,6 +291,7 @@ require_relative 'rubocop/cop/layout/space_inside_string_interpolation'
 require_relative 'rubocop/cop/layout/trailing_empty_lines'
 require_relative 'rubocop/cop/layout/trailing_whitespace'
 
+require_relative 'rubocop/cop/lint/utils/nil_receiver_checker'
 require_relative 'rubocop/cop/lint/ambiguous_assignment'
 require_relative 'rubocop/cop/lint/ambiguous_block_association'
 require_relative 'rubocop/cop/lint/ambiguous_operator'
@@ -430,10 +433,12 @@ require_relative 'rubocop/cop/lint/uri_regexp'
 require_relative 'rubocop/cop/lint/useless_access_modifier'
 require_relative 'rubocop/cop/lint/useless_assignment'
 require_relative 'rubocop/cop/lint/useless_constant_scoping'
+require_relative 'rubocop/cop/lint/useless_default_value_argument'
 require_relative 'rubocop/cop/lint/useless_defined'
 require_relative 'rubocop/cop/lint/useless_else_without_rescue'
 require_relative 'rubocop/cop/lint/useless_method_definition'
 require_relative 'rubocop/cop/lint/useless_numeric_operation'
+require_relative 'rubocop/cop/lint/useless_or'
 require_relative 'rubocop/cop/lint/useless_rescue'
 require_relative 'rubocop/cop/lint/useless_ruby2_keywords'
 require_relative 'rubocop/cop/lint/useless_setter_call'
@@ -469,7 +474,8 @@ require_relative 'rubocop/cop/naming/memoized_instance_variable_name'
 require_relative 'rubocop/cop/naming/method_name'
 require_relative 'rubocop/cop/naming/method_parameter_name'
 require_relative 'rubocop/cop/naming/binary_operator_parameter_name'
-require_relative 'rubocop/cop/naming/predicate_name'
+require_relative 'rubocop/cop/naming/predicate_method'
+require_relative 'rubocop/cop/naming/predicate_prefix'
 require_relative 'rubocop/cop/naming/rescued_exceptions_variable_name'
 require_relative 'rubocop/cop/naming/variable_name'
 require_relative 'rubocop/cop/naming/variable_number'
@@ -483,6 +489,7 @@ require_relative 'rubocop/cop/style/arguments_forwarding'
 require_relative 'rubocop/cop/style/array_coercion'
 require_relative 'rubocop/cop/style/array_first_last'
 require_relative 'rubocop/cop/style/array_intersect'
+require_relative 'rubocop/cop/style/array_intersect_with_single_element'
 require_relative 'rubocop/cop/style/array_join'
 require_relative 'rubocop/cop/style/ascii_comments'
 require_relative 'rubocop/cop/style/attr'
@@ -504,6 +511,7 @@ require_relative 'rubocop/cop/style/class_methods_definitions'
 require_relative 'rubocop/cop/style/class_vars'
 require_relative 'rubocop/cop/style/collection_compact'
 require_relative 'rubocop/cop/style/collection_methods'
+require_relative 'rubocop/cop/style/collection_querying'
 require_relative 'rubocop/cop/style/colon_method_call'
 require_relative 'rubocop/cop/style/colon_method_definition'
 require_relative 'rubocop/cop/style/combinable_defined'
@@ -538,6 +546,7 @@ require_relative 'rubocop/cop/style/empty_heredoc'
 require_relative 'rubocop/cop/style/empty_lambda_parameter'
 require_relative 'rubocop/cop/style/empty_literal'
 require_relative 'rubocop/cop/style/empty_method'
+require_relative 'rubocop/cop/style/empty_string_inside_interpolation'
 require_relative 'rubocop/cop/style/endless_method'
 require_relative 'rubocop/cop/style/encoding'
 require_relative 'rubocop/cop/style/end_block'
@@ -604,6 +613,7 @@ require_relative 'rubocop/cop/style/numbered_parameters'
 require_relative 'rubocop/cop/style/open_struct_use'
 require_relative 'rubocop/cop/style/operator_method_call'
 require_relative 'rubocop/cop/style/redundant_array_constructor'
+require_relative 'rubocop/cop/style/redundant_array_flatten'
 require_relative 'rubocop/cop/style/redundant_assignment'
 require_relative 'rubocop/cop/style/redundant_constant_base'
 require_relative 'rubocop/cop/style/redundant_current_directory_in_path'
@@ -805,6 +815,7 @@ require_relative 'rubocop/options'
 require_relative 'rubocop/remote_config'
 require_relative 'rubocop/target_ruby'
 require_relative 'rubocop/yaml_duplication_checker'
+require_relative 'rubocop/pending_cops_reporter'
 
 # rubocop:enable Style/RequireOrder
 

data/lib/ruby_lsp/rubocop/addon.rb

@@ -8,7 +8,10 @@ module RubyLsp
   module RuboCop
     # A Ruby LSP add-on for RuboCop.
     class Addon < RubyLsp::Addon
-      def initializer
+      RESTART_WATCHERS = %w[.rubocop.yml .rubocop_todo.yml .rubocop].freeze
+
+      def initialize
+        super
         @runtime_adapter = nil
       end
 
@@ -16,12 +19,16 @@ module RubyLsp
         'RuboCop'
       end
 
+      def version
+        ::RuboCop::Version::STRING
+      end
+
       def activate(global_state, message_queue)
         ::RuboCop::LSP::Logger.log(
           "Activating RuboCop LSP addon #{::RuboCop::Version::STRING}.", prefix: '[RuboCop]'
         )
 
-        @runtime_adapter = RuntimeAdapter.new
+        @runtime_adapter = RuntimeAdapter.new(message_queue)
         global_state.register_formatter('rubocop', @runtime_adapter)
         register_additional_file_watchers(global_state, message_queue)
 
@@ -34,7 +41,7 @@ module RubyLsp
         @runtime_adapter = nil
       end
 
-      # rubocop:disable Layout/LineLength, Metrics/MethodLength
+      # rubocop:disable Metrics/MethodLength
       def register_additional_file_watchers(global_state, message_queue)
         return unless global_state.supports_watching_files
 
@@ -49,7 +56,7 @@ module RubyLsp
                 register_options: Interface::DidChangeWatchedFilesRegistrationOptions.new(
                   watchers: [
                     Interface::FileSystemWatcher.new(
-                      glob_pattern: '**/.rubocop{,_todo}.yml',
+                      glob_pattern: "**/{#{RESTART_WATCHERS.join(',')}}",
                       kind: Constant::WatchKind::CREATE | Constant::WatchKind::CHANGE | Constant::WatchKind::DELETE
                     )
                   ]
@@ -59,16 +66,24 @@ module RubyLsp
           )
         )
       end
-      # rubocop:enable Layout/LineLength, Metrics/MethodLength
+      # rubocop:enable Metrics/MethodLength
 
       def workspace_did_change_watched_files(changes)
-        return unless changes.any? { |change| change[:uri].end_with?('.rubocop.yml') }
+        if (changed_config_file = changed_config_file(changes))
+          @runtime_adapter.reload_config
+
+          ::RuboCop::LSP::Logger.log(<<~MESSAGE, prefix: '[RuboCop]')
+            Re-initialized RuboCop LSP addon #{::RuboCop::Version::STRING} due to #{changed_config_file} change.
+          MESSAGE
+        end
+      end
 
-        @runtime_adapter = RuntimeAdapter.new
+      private
 
-        ::RuboCop::LSP::Logger.log(<<~MESSAGE, prefix: '[RuboCop]')
-          Re-initialized RuboCop LSP addon #{::RuboCop::Version::STRING} due to .rubocop.yml file change.
-        MESSAGE
+      def changed_config_file(changes)
+        RESTART_WATCHERS.find do |file_name|
+          changes.any? { |change| change[:uri].end_with?(file_name) }
+        end
       end
     end
   end

data/lib/ruby_lsp/rubocop/runtime_adapter.rb

@@ -7,30 +7,45 @@ module RubyLsp
     # Provides an adapter to bridge RuboCop's built-in LSP runtime with Ruby LSP's add-on.
     # @api private
     class RuntimeAdapter
-      include RubyLsp::Requests::Support::Formatter
+      def initialize(message_queue)
+        @message_queue = message_queue
+        reload_config
+      end
 
-      def initialize
-        config_store = ::RuboCop::ConfigStore.new
+      def reload_config
+        @runtime = nil
+        options, _paths = ::RuboCop::Options.new.parse([])
 
+        config_store = ::RuboCop::ConfigStore.new
+        config_store.apply_options!(options)
         @runtime = ::RuboCop::LSP::Runtime.new(config_store)
+      rescue ::RuboCop::Error => e
+        @message_queue << Notification.window_show_message(
+          "RuboCop configuration error: #{e.message}. Formatting will not be available.",
+          type: Constant::MessageType::ERROR
+        )
       end
 
       def run_diagnostic(uri, document)
-        @runtime.offenses(
-          uri_to_path(uri),
-          document.source,
-          document.encoding,
-          prism_result: prism_result(document)
-        )
+        with_error_handling do
+          @runtime.offenses(
+            uri_to_path(uri),
+            document.source,
+            document.encoding,
+            prism_result: prism_result(document)
+          )
+        end
       end
 
       def run_formatting(uri, document)
-        @runtime.format(
-          uri_to_path(uri),
-          document.source,
-          command: 'rubocop.formatAutocorrects',
-          prism_result: prism_result(document)
-        )
+        with_error_handling do
+          @runtime.format(
+            uri_to_path(uri),
+            document.source,
+            command: 'rubocop.formatAutocorrects',
+            prism_result: prism_result(document)
+          )
+        end
       end
 
       def run_range_formatting(_uri, _partial_source, _base_indentation)
@@ -43,6 +58,25 @@ module RubyLsp
 
       private
 
+      def with_error_handling
+        return unless @runtime
+
+        yield
+      rescue StandardError => e
+        ::RuboCop::LSP::Logger.log(e.full_message, prefix: '[RuboCop]')
+
+        message = if e.is_a?(::RuboCop::ErrorWithAnalyzedFileLocation)
+                    "for the #{e.cop.name} cop"
+                  else
+                    "- #{e.message}"
+                  end
+        raise Requests::Formatting::Error, <<~MSG
+          An internal error occurred #{message}.
+          Updating to a newer version of RuboCop may solve this.
+          For more details, run RuboCop on the command line.
+        MSG
+      end
+
       # duplicated from: lib/standard/lsp/routes.rb
       # modified to incorporate Ruby LSP's to_standardized_path method
       def uri_to_path(uri)