rubocop 1.65.1 → 1.75.6

data/lib/rubocop.rb

@@ -9,9 +9,9 @@ require 'fileutils'
 before_us = $LOADED_FEATURES.dup
 require 'rainbow'
 
-require 'forwardable'
 require 'regexp_parser'
 require 'set'
+require 'stringio'
 require 'unicode/display_width'
 
 # we have to require RuboCop's version, before rubocop-ast's
@@ -75,15 +75,19 @@ require_relative 'rubocop/cop/mixin/allowed_identifiers'
 require_relative 'rubocop/cop/mixin/allowed_methods'
 require_relative 'rubocop/cop/mixin/allowed_pattern'
 require_relative 'rubocop/cop/mixin/allowed_receivers'
+require_relative 'rubocop/cop/mixin/forbidden_identifiers'
+require_relative 'rubocop/cop/mixin/forbidden_pattern'
 require_relative 'rubocop/cop/mixin/auto_corrector' # rubocop:todo Naming/InclusiveLanguage
 require_relative 'rubocop/cop/mixin/check_assignment'
 require_relative 'rubocop/cop/mixin/check_line_breakable'
+require_relative 'rubocop/cop/mixin/check_single_line_suitability'
 require_relative 'rubocop/cop/mixin/configurable_max'
 require_relative 'rubocop/cop/mixin/code_length' # relies on configurable_max
 require_relative 'rubocop/cop/mixin/configurable_enforced_style'
 require_relative 'rubocop/cop/mixin/configurable_formatting'
 require_relative 'rubocop/cop/mixin/configurable_naming'
 require_relative 'rubocop/cop/mixin/configurable_numbering'
+require_relative 'rubocop/cop/mixin/dig_help'
 require_relative 'rubocop/cop/mixin/documentation_comment'
 require_relative 'rubocop/cop/mixin/duplication'
 require_relative 'rubocop/cop/mixin/range_help'
@@ -91,12 +95,14 @@ require_relative 'rubocop/cop/mixin/annotation_comment' # relies on range
 require_relative 'rubocop/cop/mixin/empty_lines_around_body' # relies on range
 require_relative 'rubocop/cop/mixin/empty_parameter'
 require_relative 'rubocop/cop/mixin/end_keyword_alignment'
+require_relative 'rubocop/cop/mixin/endless_method_rewriter'
 require_relative 'rubocop/cop/mixin/enforce_superclass'
 require_relative 'rubocop/cop/mixin/first_element_line_break'
 require_relative 'rubocop/cop/mixin/frozen_string_literal'
 require_relative 'rubocop/cop/mixin/gem_declaration'
 require_relative 'rubocop/cop/mixin/gemspec_help'
 require_relative 'rubocop/cop/mixin/hash_alignment_styles'
+require_relative 'rubocop/cop/mixin/hash_subset'
 require_relative 'rubocop/cop/mixin/hash_transform_method'
 require_relative 'rubocop/cop/mixin/integer_node'
 require_relative 'rubocop/cop/mixin/interpolation'
@@ -144,7 +150,6 @@ require_relative 'rubocop/cop/mixin/comments_help' # relies on visibility_help
 require_relative 'rubocop/cop/mixin/def_node' # relies on visibility_help
 
 require_relative 'rubocop/cop/utils/format_string'
-require_relative 'rubocop/cop/utils/regexp_ranges'
 
 require_relative 'rubocop/cop/migration/department_name'
 
@@ -290,6 +295,7 @@ require_relative 'rubocop/cop/lint/ambiguous_operator'
 require_relative 'rubocop/cop/lint/ambiguous_operator_precedence'
 require_relative 'rubocop/cop/lint/ambiguous_range'
 require_relative 'rubocop/cop/lint/ambiguous_regexp_literal'
+require_relative 'rubocop/cop/lint/array_literal_in_regexp'
 require_relative 'rubocop/cop/lint/assignment_in_condition'
 require_relative 'rubocop/cop/lint/big_decimal_new'
 require_relative 'rubocop/cop/lint/binary_operator_with_identical_operands'
@@ -297,7 +303,9 @@ require_relative 'rubocop/cop/lint/boolean_symbol'
 require_relative 'rubocop/cop/lint/circular_argument_reference'
 require_relative 'rubocop/cop/lint/constant_definition_in_block'
 require_relative 'rubocop/cop/lint/constant_overwritten_in_rescue'
+require_relative 'rubocop/cop/lint/constant_reassignment'
 require_relative 'rubocop/cop/lint/constant_resolution'
+require_relative 'rubocop/cop/lint/cop_directive_syntax'
 require_relative 'rubocop/cop/lint/debugger'
 require_relative 'rubocop/cop/lint/deprecated_class_methods'
 require_relative 'rubocop/cop/lint/deprecated_constants'
@@ -313,6 +321,7 @@ require_relative 'rubocop/cop/lint/duplicate_methods'
 require_relative 'rubocop/cop/lint/duplicate_regexp_character_class_element'
 require_relative 'rubocop/cop/lint/duplicate_require'
 require_relative 'rubocop/cop/lint/duplicate_rescue_exception'
+require_relative 'rubocop/cop/lint/duplicate_set_element'
 require_relative 'rubocop/cop/lint/each_with_object_argument'
 require_relative 'rubocop/cop/lint/else_layout'
 require_relative 'rubocop/cop/lint/empty_block'
@@ -325,12 +334,14 @@ require_relative 'rubocop/cop/lint/empty_in_pattern'
 require_relative 'rubocop/cop/lint/empty_interpolation'
 require_relative 'rubocop/cop/lint/empty_when'
 require_relative 'rubocop/cop/lint/ensure_return'
+require_relative 'rubocop/cop/lint/shared_mutable_default'
 require_relative 'rubocop/cop/lint/erb_new_arguments'
 require_relative 'rubocop/cop/lint/flip_flop'
 require_relative 'rubocop/cop/lint/float_comparison'
 require_relative 'rubocop/cop/lint/float_out_of_range'
 require_relative 'rubocop/cop/lint/format_parameter_mismatch'
 require_relative 'rubocop/cop/lint/hash_compare_by_identity'
+require_relative 'rubocop/cop/lint/hash_new_with_keyword_arguments_as_default'
 require_relative 'rubocop/cop/lint/heredoc_method_call_position'
 require_relative 'rubocop/cop/lint/identity_comparison'
 require_relative 'rubocop/cop/lint/implicit_string_concatenation'
@@ -358,6 +369,7 @@ require_relative 'rubocop/cop/lint/non_deterministic_require_order'
 require_relative 'rubocop/cop/lint/non_local_exit_from_iterator'
 require_relative 'rubocop/cop/lint/number_conversion'
 require_relative 'rubocop/cop/lint/numbered_parameter_assignment'
+require_relative 'rubocop/cop/lint/numeric_operation_with_constant_result'
 require_relative 'rubocop/cop/lint/or_assignment_to_constant'
 require_relative 'rubocop/cop/lint/ordered_magic_comments'
 require_relative 'rubocop/cop/lint/out_of_range_regexp_ref'
@@ -374,6 +386,7 @@ require_relative 'rubocop/cop/lint/redundant_require_statement'
 require_relative 'rubocop/cop/lint/redundant_safe_navigation'
 require_relative 'rubocop/cop/lint/redundant_splat_expansion'
 require_relative 'rubocop/cop/lint/redundant_string_coercion'
+require_relative 'rubocop/cop/lint/redundant_type_conversion'
 require_relative 'rubocop/cop/lint/redundant_with_index'
 require_relative 'rubocop/cop/lint/redundant_with_object'
 require_relative 'rubocop/cop/lint/refinement_import_methods'
@@ -395,6 +408,7 @@ require_relative 'rubocop/cop/lint/shadowed_exception'
 require_relative 'rubocop/cop/lint/shadowing_outer_local_variable'
 require_relative 'rubocop/cop/lint/struct_new_override'
 require_relative 'rubocop/cop/lint/suppressed_exception'
+require_relative 'rubocop/cop/lint/suppressed_exception_in_number_conversion'
 require_relative 'rubocop/cop/lint/symbol_conversion'
 require_relative 'rubocop/cop/lint/syntax'
 require_relative 'rubocop/cop/lint/to_enum_arguments'
@@ -403,6 +417,7 @@ require_relative 'rubocop/cop/lint/top_level_return_with_argument'
 require_relative 'rubocop/cop/lint/trailing_comma_in_attribute_declaration'
 require_relative 'rubocop/cop/lint/triple_quotes'
 require_relative 'rubocop/cop/lint/underscore_prefixed_variable_name'
+require_relative 'rubocop/cop/lint/unescaped_bracket_in_regexp'
 require_relative 'rubocop/cop/lint/unexpected_block_arity'
 require_relative 'rubocop/cop/lint/unified_integer'
 require_relative 'rubocop/cop/lint/unmodified_reduce_accumulator'
@@ -414,8 +429,11 @@ require_relative 'rubocop/cop/lint/uri_escape_unescape'
 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_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_rescue'
 require_relative 'rubocop/cop/lint/useless_ruby2_keywords'
 require_relative 'rubocop/cop/lint/useless_setter_call'
@@ -459,6 +477,7 @@ require_relative 'rubocop/cop/naming/variable_number'
 require_relative 'rubocop/cop/style/access_modifier_declarations'
 require_relative 'rubocop/cop/style/accessor_grouping'
 require_relative 'rubocop/cop/style/alias'
+require_relative 'rubocop/cop/style/ambiguous_endless_method_definition'
 require_relative 'rubocop/cop/style/and_or'
 require_relative 'rubocop/cop/style/arguments_forwarding'
 require_relative 'rubocop/cop/style/array_coercion'
@@ -471,6 +490,7 @@ require_relative 'rubocop/cop/style/auto_resource_cleanup'
 require_relative 'rubocop/cop/style/bare_percent_literals'
 require_relative 'rubocop/cop/style/begin_block'
 require_relative 'rubocop/cop/style/bisected_attr_accessor'
+require_relative 'rubocop/cop/style/bitwise_predicate'
 require_relative 'rubocop/cop/style/block_comments'
 require_relative 'rubocop/cop/style/block_delimiters'
 require_relative 'rubocop/cop/style/case_equality'
@@ -486,10 +506,12 @@ require_relative 'rubocop/cop/style/collection_compact'
 require_relative 'rubocop/cop/style/collection_methods'
 require_relative 'rubocop/cop/style/colon_method_call'
 require_relative 'rubocop/cop/style/colon_method_definition'
+require_relative 'rubocop/cop/style/combinable_defined'
 require_relative 'rubocop/cop/style/combinable_loops'
 require_relative 'rubocop/cop/style/command_literal'
 require_relative 'rubocop/cop/style/comment_annotation'
 require_relative 'rubocop/cop/style/commented_keyword'
+require_relative 'rubocop/cop/style/comparable_between'
 require_relative 'rubocop/cop/style/comparable_clamp'
 require_relative 'rubocop/cop/style/concat_array_literals'
 require_relative 'rubocop/cop/style/conditional_assignment'
@@ -498,6 +520,7 @@ require_relative 'rubocop/cop/style/copyright'
 require_relative 'rubocop/cop/style/data_inheritance'
 require_relative 'rubocop/cop/style/date_time'
 require_relative 'rubocop/cop/style/def_with_parentheses'
+require_relative 'rubocop/cop/style/dig_chain'
 require_relative 'rubocop/cop/style/dir'
 require_relative 'rubocop/cop/style/dir_empty'
 require_relative 'rubocop/cop/style/disable_cops_within_source_code_directive'
@@ -527,7 +550,9 @@ require_relative 'rubocop/cop/style/explicit_block_argument'
 require_relative 'rubocop/cop/style/exponential_notation'
 require_relative 'rubocop/cop/style/fetch_env_var'
 require_relative 'rubocop/cop/style/file_empty'
+require_relative 'rubocop/cop/style/file_null'
 require_relative 'rubocop/cop/style/file_read'
+require_relative 'rubocop/cop/style/file_touch'
 require_relative 'rubocop/cop/style/file_write'
 require_relative 'rubocop/cop/style/float_division'
 require_relative 'rubocop/cop/style/for'
@@ -541,7 +566,9 @@ require_relative 'rubocop/cop/style/hash_as_last_array_item'
 require_relative 'rubocop/cop/style/hash_conversion'
 require_relative 'rubocop/cop/style/hash_each_methods'
 require_relative 'rubocop/cop/style/hash_except'
+require_relative 'rubocop/cop/style/hash_fetch_chain'
 require_relative 'rubocop/cop/style/hash_like_case'
+require_relative 'rubocop/cop/style/hash_slice'
 require_relative 'rubocop/cop/style/hash_syntax'
 require_relative 'rubocop/cop/style/hash_transform_keys'
 require_relative 'rubocop/cop/style/hash_transform_values'
@@ -558,6 +585,9 @@ require_relative 'rubocop/cop/style/inverse_methods'
 require_relative 'rubocop/cop/style/inline_comment'
 require_relative 'rubocop/cop/style/invertible_unless_condition'
 require_relative 'rubocop/cop/style/ip_addresses'
+require_relative 'rubocop/cop/style/it_assignment'
+require_relative 'rubocop/cop/style/it_block_parameter'
+require_relative 'rubocop/cop/style/keyword_arguments_merging'
 require_relative 'rubocop/cop/style/keyword_parameters_order'
 require_relative 'rubocop/cop/style/lambda'
 require_relative 'rubocop/cop/style/lambda_call'
@@ -582,14 +612,17 @@ require_relative 'rubocop/cop/style/redundant_each'
 require_relative 'rubocop/cop/style/redundant_fetch_block'
 require_relative 'rubocop/cop/style/redundant_file_extension_in_require'
 require_relative 'rubocop/cop/style/redundant_filter_chain'
+require_relative 'rubocop/cop/style/redundant_format'
 require_relative 'rubocop/cop/style/redundant_heredoc_delimiter_quotes'
 require_relative 'rubocop/cop/style/redundant_initialize'
+require_relative 'rubocop/cop/style/redundant_interpolation_unfreeze'
 require_relative 'rubocop/cop/style/redundant_line_continuation'
 require_relative 'rubocop/cop/style/redundant_regexp_argument'
 require_relative 'rubocop/cop/style/redundant_regexp_constructor'
 require_relative 'rubocop/cop/style/redundant_self_assignment'
 require_relative 'rubocop/cop/style/redundant_self_assignment_branch'
 require_relative 'rubocop/cop/style/require_order'
+require_relative 'rubocop/cop/style/safe_navigation_chain_length'
 require_relative 'rubocop/cop/style/single_line_do_end_block'
 require_relative 'rubocop/cop/style/sole_nested_conditional'
 require_relative 'rubocop/cop/style/static_class'
@@ -749,6 +782,7 @@ require_relative 'rubocop/config_store'
 require_relative 'rubocop/config_validator'
 require_relative 'rubocop/feature_loader'
 require_relative 'rubocop/lockfile'
+require_relative 'rubocop/lsp'
 require_relative 'rubocop/target_finder'
 require_relative 'rubocop/directive_comment'
 require_relative 'rubocop/comment_config'

data/lib/ruby_lsp/rubocop/addon.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative '../../rubocop'
+require_relative '../../rubocop/lsp/logger'
+require_relative 'runtime_adapter'
+
+module RubyLsp
+  module RuboCop
+    # A Ruby LSP add-on for RuboCop.
+    class Addon < RubyLsp::Addon
+      def initializer
+        @runtime_adapter = nil
+      end
+
+      def name
+        'RuboCop'
+      end
+
+      def activate(global_state, message_queue)
+        ::RuboCop::LSP::Logger.log(
+          "Activating RuboCop LSP addon #{::RuboCop::Version::STRING}.", prefix: '[RuboCop]'
+        )
+
+        @runtime_adapter = RuntimeAdapter.new
+        global_state.register_formatter('rubocop', @runtime_adapter)
+        register_additional_file_watchers(global_state, message_queue)
+
+        ::RuboCop::LSP::Logger.log(
+          "Initialized RuboCop LSP addon #{::RuboCop::Version::STRING}.", prefix: '[RuboCop]'
+        )
+      end
+
+      def deactivate
+        @runtime_adapter = nil
+      end
+
+      # rubocop:disable Layout/LineLength, Metrics/MethodLength
+      def register_additional_file_watchers(global_state, message_queue)
+        return unless global_state.supports_watching_files
+
+        message_queue << Request.new(
+          id: 'rubocop-file-watcher',
+          method: 'client/registerCapability',
+          params: Interface::RegistrationParams.new(
+            registrations: [
+              Interface::Registration.new(
+                id: 'workspace/didChangeWatchedFilesRuboCop',
+                method: 'workspace/didChangeWatchedFiles',
+                register_options: Interface::DidChangeWatchedFilesRegistrationOptions.new(
+                  watchers: [
+                    Interface::FileSystemWatcher.new(
+                      glob_pattern: '**/.rubocop{,_todo}.yml',
+                      kind: Constant::WatchKind::CREATE | Constant::WatchKind::CHANGE | Constant::WatchKind::DELETE
+                    )
+                  ]
+                )
+              )
+            ]
+          )
+        )
+      end
+      # rubocop:enable Layout/LineLength, Metrics/MethodLength
+
+      def workspace_did_change_watched_files(changes)
+        return unless changes.any? { |change| change[:uri].end_with?('.rubocop.yml') }
+
+        @runtime_adapter = RuntimeAdapter.new
+
+        ::RuboCop::LSP::Logger.log(<<~MESSAGE, prefix: '[RuboCop]')
+          Re-initialized RuboCop LSP addon #{::RuboCop::Version::STRING} due to .rubocop.yml file change.
+        MESSAGE
+      end
+    end
+  end
+end

data/lib/ruby_lsp/rubocop/runtime_adapter.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative '../../rubocop/lsp/runtime'
+
+module RubyLsp
+  module RuboCop
+    # 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
+        config_store = ::RuboCop::ConfigStore.new
+
+        @runtime = ::RuboCop::LSP::Runtime.new(config_store)
+      end
+
+      def run_diagnostic(uri, document)
+        @runtime.offenses(
+          uri_to_path(uri),
+          document.source,
+          document.encoding,
+          prism_result: prism_result(document)
+        )
+      end
+
+      def run_formatting(uri, document)
+        @runtime.format(
+          uri_to_path(uri),
+          document.source,
+          command: 'rubocop.formatAutocorrects',
+          prism_result: prism_result(document)
+        )
+      end
+
+      def run_range_formatting(_uri, _partial_source, _base_indentation)
+        # Not yet supported. Should return the formatted version of `partial_source` which is
+        # a partial selection of the entire document. For example, it should not try to add
+        # a frozen_string_literal magic comment and all style corrections should start from
+        # the `base_indentation`.
+        nil
+      end
+
+      private
+
+      # duplicated from: lib/standard/lsp/routes.rb
+      # modified to incorporate Ruby LSP's to_standardized_path method
+      def uri_to_path(uri)
+        if uri.respond_to?(:to_standardized_path) && (standardized_path = uri.to_standardized_path)
+          standardized_path
+        else
+          uri.to_s.delete_prefix('file://')
+        end
+      end
+
+      def prism_result(document)
+        prism_result = document.parse_result
+
+        # NOTE: `prism_result` must be `Prism::ParseLexResult` compatible object.
+        # This is for compatibility parsed result unsupported.
+        prism_result.is_a?(Prism::ParseLexResult) ? prism_result : nil
+      end
+    end
+  end
+end