rubocop 1.81.7 → 1.82.0

data/lib/rubocop/cop/style/method_call_with_args_parentheses.rb

@@ -9,17 +9,20 @@ module RuboCop
       # In the default style (require_parentheses), macro methods are allowed.
       # Additional methods can be added to the `AllowedMethods` or
       # `AllowedPatterns` list. These options are valid only in the default
-      # style. Macros can be included by either setting `IgnoreMacros` to false
-      # or adding specific macros to the `IncludedMacros` list.
+      # style. Macros can be included by either setting `IgnoreMacros` to false,
+      # adding specific macros to the `IncludedMacros` list, or using
+      # `IncludedMacroPatterns` for pattern-based matching.
       #
       # Precedence of options is as follows:
       #
       # 1. `AllowedMethods`
       # 2. `AllowedPatterns`
       # 3. `IncludedMacros`
+      # 4. `IncludedMacroPatterns`
       #
-      # If a method is listed in both `IncludedMacros` and `AllowedMethods`,
-      # then the latter takes precedence (that is, the method is allowed).
+      # If a method is listed in both `IncludedMacros`/`IncludedMacroPatterns`
+      # and `AllowedMethods`, then the latter takes precedence (that is, the
+      # method is allowed).
       #
       # In the alternative style (omit_parentheses), there are three additional
       # options.
@@ -148,6 +151,16 @@ module RuboCop
       #   # still enforces parentheses on other methods
       #   array.delete(e)
       #
+      # @example IncludedMacroPatterns: ["^assert", "^refute"]
+      #
+      #   # bad
+      #   assert_equal 'test', x
+      #   refute_nil value
+      #
+      #   # good
+      #   assert_equal('test', x)
+      #   refute_nil(value)
+      #
       # @example AllowParenthesesInMultilineCall: false (default)
       #
       #   # bad

data/lib/rubocop/cop/style/module_member_existence_check.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Checks for usage of `Module` methods returning arrays that can be replaced
+      # with equivalent predicates.
+      #
+      # Calling a method returning an array then checking if an element is inside
+      # it is much slower than using an equivalent predicate method. For example,
+      # `instance_methods.include?` will return an array of all public and protected
+      # instance methods in the module, then check if a given method is inside that
+      # array, while `method_defined?` will do direct method lookup, which is much
+      # faster and consumes less memory.
+      #
+      # @example
+      #   # bad
+      #   Array.instance_methods.include?(:size)
+      #   Array.instance_methods.member?(:size)
+      #   Array.instance_methods(true).include?(:size)
+      #
+      #   Array.instance_methods(false).include?(:find)
+      #
+      #   # good
+      #   Array.method_defined?(:size)
+      #
+      #   Array.method_defined?(:find, false)
+      #
+      class ModuleMemberExistenceCheck < Base
+        extend AutoCorrector
+
+        MSG = 'Use `%<replacement>s` instead.'
+
+        RESTRICT_ON_SEND = %i[instance_methods].freeze
+
+        # @!method instance_methods_inclusion?(node)
+        def_node_matcher :instance_methods_inclusion?, <<~PATTERN
+          (call
+            (call _ :instance_methods _?)
+            {:include? :member?}
+            _)
+        PATTERN
+
+        def on_send(node) # rubocop:disable Metrics/AbcSize
+          return unless (parent = node.parent)
+          return unless instance_methods_inclusion?(parent)
+          return unless simple_method_argument?(node) && simple_method_argument?(parent)
+
+          offense_range = node.location.selector.join(parent.source_range.end)
+          replacement =
+            if node.first_argument.nil? || node.first_argument.true_type?
+              "method_defined?(#{parent.first_argument.source})"
+            else
+              "method_defined?(#{parent.first_argument.source}, #{node.first_argument.source})"
+            end
+
+          add_offense(offense_range, message: format(MSG, replacement: replacement)) do |corrector|
+            corrector.replace(offense_range, replacement)
+          end
+        end
+        alias on_csend on_send
+
+        private
+
+        def simple_method_argument?(node)
+          return false if node.splat_argument? || node.block_argument?
+          return false if node.first_argument&.hash_type?
+
+          true
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/style/multiline_method_signature.rb

@@ -85,10 +85,6 @@ module RuboCop
         def definition_width(node)
           node.source_range.begin.join(node.arguments.source_range.end).length
         end
-
-        def max_line_length
-          config.for_cop('Layout/LineLength')['Max'] || 120
-        end
       end
     end
   end

data/lib/rubocop/cop/style/parallel_assignment.rb

@@ -14,7 +14,7 @@ module RuboCop
       #
       #   # good
       #   one, two = *foo
-      #   a, b = foo()
+      #   a, b = foo
       #   a, b = b, a
       #
       #   a = 1
@@ -223,7 +223,7 @@ module RuboCop
             # __FILE__ is treated as a StrNode but has no begin
             if node.str_type? && loc.respond_to?(:begin) && loc.begin.nil?
               "'#{node.source}'"
-            elsif node.sym_type? && loc.begin.nil?
+            elsif node.sym_type? && !node.loc?(:begin)
               ":#{node.source}"
             else
               node.source

data/lib/rubocop/cop/style/redundant_argument.rb

@@ -37,6 +37,7 @@ module RuboCop
       #   array.sum(0)
       #   exit(true)
       #   exit!(false)
+      #   string.to_i(10)
       #   string.split(" ")
       #   "first\nsecond".split(" ")
       #   string.chomp("\n")
@@ -49,6 +50,7 @@ module RuboCop
       #   array.sum
       #   exit
       #   exit!
+      #   string.to_i
       #   string.split
       #   "first second".split
       #   string.chomp

data/lib/rubocop/cop/style/redundant_percent_q.rb

@@ -80,8 +80,7 @@ module RuboCop
         end
 
         def string_literal?(node)
-          node.loc.respond_to?(:begin) && node.loc.respond_to?(:end) &&
-            node.loc.begin && node.loc.end
+          node.loc?(:begin) && node.loc?(:end)
         end
 
         def start_with_percent_q_variant?(string)

data/lib/rubocop/cop/style/redundant_regexp_argument.rb

@@ -75,6 +75,11 @@ module RuboCop
             new_argument.gsub!('\"', '"')
             quote = "'"
           elsif new_argument.include?("\\'")
+            # Add a backslash before single quotes preceded by an even number of backslashes.
+            # An even number (including zero) of backslashes before a quote means the quote itself
+            # is not escaped.
+            # Otherwise an odd number means the quote is already escaped so this doesn't touch it.
+            new_argument.gsub!(/(?<!\\)((?:\\\\)*)'/) { "#{::Regexp.last_match(1)}\\'" }
             quote = "'"
           elsif new_argument.include?('\'')
             new_argument.gsub!("'", "\\\\'")

data/lib/rubocop/cop/style/redundant_sort.rb

@@ -26,17 +26,17 @@ module RuboCop
       #
       #   [source,ruby]
       #   ----
-      #     class MyString < String; end
-      #     strings = [MyString.new('test'), 'test']
-      #     strings.sort.last.class   #=> String
-      #     strings.max.class         #=> MyString
+      #   class MyString < String; end
+      #   strings = [MyString.new('test'), 'test']
+      #   strings.sort.last.class #=> String
+      #   strings.max.class       #=> MyString
       #   ----
       #
       #   [source,ruby]
       #   ----
-      #     words = %w(dog horse mouse)
-      #     words.sort_by { |word| word.length }.last   #=> 'mouse'
-      #     words.max_by { |word| word.length }         #=> 'horse'
+      #   words = %w(dog horse mouse)
+      #   words.sort_by { |word| word.length }.last #=> 'mouse'
+      #   words.max_by { |word| word.length }       #=> 'horse'
       #   ----
       #
       # @example

data/lib/rubocop/cop/style/super_arguments.rb

@@ -109,7 +109,7 @@ module RuboCop
 
           def_args.zip(super_args).each do |def_arg, super_arg|
             next if positional_arg_same?(def_arg, super_arg)
-            next if positional_rest_arg_same(def_arg, super_arg)
+            next if positional_rest_arg_same?(def_arg, super_arg)
             next if keyword_arg_same?(def_arg, super_arg)
             next if keyword_rest_arg_same?(def_arg, super_arg)
             next if block_arg_same?(def_node, super_node, def_arg, super_arg)
@@ -147,7 +147,7 @@ module RuboCop
           def_arg.name == super_arg.children.first
         end
 
-        def positional_rest_arg_same(def_arg, super_arg)
+        def positional_rest_arg_same?(def_arg, super_arg)
           return false unless def_arg.restarg_type?
           # anonymous forwarding
           return true if def_arg.name.nil? && super_arg.forwarded_restarg_type?

data/lib/rubocop/cop/style/trailing_underscore_variable.rb

@@ -7,26 +7,26 @@ module RuboCop
       #
       # @example
       #   # bad
-      #   a, b, _ = foo()
-      #   a, b, _, = foo()
-      #   a, _, _ = foo()
-      #   a, _, _, = foo()
+      #   a, b, _ = foo
+      #   a, b, _, = foo
+      #   a, _, _ = foo
+      #   a, _, _, = foo
       #
       #   # good
-      #   a, b, = foo()
-      #   a, = foo()
-      #   *a, b, _ = foo()
+      #   a, b, = foo
+      #   a, = foo
+      #   *a, b, _ = foo
       #   # => We need to know to not include 2 variables in a
-      #   a, *b, _ = foo()
-      #   # => The correction `a, *b, = foo()` is a syntax error
+      #   a, *b, _ = foo
+      #   # => The correction `a, *b, = foo` is a syntax error
       #
       # @example AllowNamedUnderscoreVariables: true (default)
       #   # good
-      #   a, b, _something = foo()
+      #   a, b, _something = foo
       #
       # @example AllowNamedUnderscoreVariables: false
       #   # bad
-      #   a, b, _something = foo()
+      #   a, b, _something = foo
       #
       class TrailingUnderscoreVariable < Base
         include SurroundingSpace

data/lib/rubocop/cop/util.rb

@@ -117,10 +117,9 @@ module RuboCop
       # with calls chained to the end of it.
       def first_part_of_call_chain(node)
         while node
-          case node.type
-          when :send
+          if node.call_type?
             node = node.receiver
-          when :block
+          elsif node.any_block_type?
             node = node.send_node
           else
             break

data/lib/rubocop/directive_comment.rb

@@ -14,11 +14,17 @@ module RuboCop
     # @api private
     COP_NAME_PATTERN = '([A-Za-z]\w+/)*(?:[A-Za-z]\w+)'
     # @api private
+    COP_NAME_PATTERN_NC = '(?:[A-Za-z]\w+/)*[A-Za-z]\w+'
+    # @api private
+    COP_NAMES_PATTERN_NC = "(?:#{COP_NAME_PATTERN_NC} , )*#{COP_NAME_PATTERN_NC}"
+    # @api private
     COP_NAMES_PATTERN = "(?:#{COP_NAME_PATTERN} , )*#{COP_NAME_PATTERN}"
     # @api private
     COPS_PATTERN = "(all|#{COP_NAMES_PATTERN})"
     # @api private
-    AVAILABLE_MODES = %w[disable enable todo].freeze
+    PUSH_POP_ARGS_PATTERN = "([+\\-]#{COP_NAME_PATTERN_NC}(?:\\s+[+\\-]#{COP_NAME_PATTERN_NC})*)"
+    # @api private
+    AVAILABLE_MODES = %w[disable enable todo push pop].freeze
     # @api private
     DIRECTIVE_MARKER_PATTERN = '# rubocop : '
     # @api private
@@ -27,7 +33,7 @@ module RuboCop
     DIRECTIVE_HEADER_PATTERN = "#{DIRECTIVE_MARKER_PATTERN}((?:#{AVAILABLE_MODES.join('|')}))\\b"
     # @api private
     DIRECTIVE_COMMENT_REGEXP = Regexp.new(
-      "#{DIRECTIVE_HEADER_PATTERN} #{COPS_PATTERN}"
+      "#{DIRECTIVE_HEADER_PATTERN}(?:\\s+#{COPS_PATTERN}|\\s+#{PUSH_POP_ARGS_PATTERN})?"
         .gsub(' ', '\s*')
     )
     # @api private
@@ -58,6 +64,7 @@ module RuboCop
     # Checks if the comment is malformed as a `# rubocop:` directive
     def malformed?
       return true if !start_with_marker? || @match_data.nil?
+      return true if missing_cop_name?
 
       tail = @match_data.post_match.lstrip
       !(tail.empty? || tail.start_with?(TRAILING_COMMENT_MARKER))
@@ -65,6 +72,8 @@ module RuboCop
 
     # Checks if the directive comment is missing a cop name
     def missing_cop_name?
+      return false if push? || pop?
+
       MALFORMED_DIRECTIVE_WITHOUT_COP_NAME_REGEXP.match?(comment.text)
     end
 
@@ -88,7 +97,13 @@ module RuboCop
 
     # Returns match captures to directive comment pattern
     def match_captures
-      @match_captures ||= @match_data&.captures
+      @match_captures ||= @match_data && begin
+        captures = @match_data.captures
+        mode = captures[0]
+        # COPS_PATTERN is at captures[1], PUSH_POP_ARGS_PATTERN is at captures[4]
+        cops = captures[1] || captures[4]
+        [mode, cops]
+      end
     end
 
     # Checks if this directive disables cops
@@ -101,6 +116,21 @@ module RuboCop
       mode == 'enable'
     end
 
+    # Checks if this directive is a push
+    def push?
+      mode == 'push'
+    end
+
+    # Checks if this directive is a pop
+    def pop?
+      mode == 'pop'
+    end
+
+    # Returns the push arguments as a hash of cop names with their operations
+    def push_args
+      @push_args ||= parse_push_args
+    end
+
     # Checks if this directive enables all cops
     def enabled_all?
       !disabled? && all_cops?
@@ -176,5 +206,18 @@ module RuboCop
     def exclude_lint_department_cops(cops)
       cops - [LINT_REDUNDANT_DIRECTIVE_COP, LINT_SYNTAX_COP]
     end
+
+    def parse_push_args
+      return {} unless push? && cops
+
+      args = {}
+      cops.split.each do |cop_spec|
+        op = cop_spec[0]
+        cop_name = cop_spec[1..]
+        args[op] ||= []
+        args[op] << cop_name
+      end
+      args
+    end
   end
 end

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -27,6 +27,7 @@ module RuboCop
         References
         Safe
         SafeAutoCorrect
+        Severity
         StyleGuide
         VersionAdded
         VersionChanged

data/lib/rubocop/lsp/diagnostic.rb

@@ -16,8 +16,8 @@ module RuboCop
     # Diagnostic for Language Server Protocol of RuboCop.
     # @api private
     class Diagnostic
-      def initialize(position_encoding, offense, uri, cop_class)
-        @position_encoding = position_encoding
+      def initialize(document_encoding, offense, uri, cop_class)
+        @document_encoding = document_encoding
         @offense = offense
         @uri = uri
         @cop_class = cop_class
@@ -149,7 +149,7 @@ module RuboCop
 
         eol = LanguageServer::Protocol::Interface::Position.new(
           line: @offense.line - 1,
-          character: to_position_character
+          character: to_position_character(@offense.source_line.length)
         )
 
         # TODO: fails for multiline strings - may be preferable to use block
@@ -162,6 +162,15 @@ module RuboCop
         [inline_comment]
       end
 
+      def to_position_character(utf8_index)
+        str = @offense.source_line[0, utf8_index]
+        if @document_encoding == Encoding::UTF_16LE || @document_encoding.nil?
+          str.length + str.b.count("\xf0-\xff".b)
+        else
+          str.length
+        end
+      end
+
       def correctable?
         !@offense.corrector.nil?
       end
@@ -171,20 +180,6 @@ module RuboCop
         uri.scheme = 'file' if uri.scheme.nil?
         uri
       end
-
-      def to_position_character(utf8_index = nil)
-        str = utf8_index ? @offense.source_line[0, utf8_index] : @offense.source_line
-        case @position_encoding
-        when 'utf-8', Encoding::UTF_8
-          str.bytesize
-        when 'utf-32', Encoding::UTF_32
-          str.size
-        else # 'utf-16'
-          # utf-16 is default position encoding on LSP
-          # https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/
-          str.size + str.count("\u{10000}-\u{10FFFF}")
-        end
-      end
     end
   end
 end

data/lib/rubocop/lsp/routes.rb

@@ -15,7 +15,7 @@ module RuboCop
   module LSP
     # Routes for Language Server Protocol of RuboCop.
     # @api private
-    class Routes # rubocop:disable Metrics/ClassLength
+    class Routes
       CONFIGURATION_FILE_PATTERNS = [
         RuboCop::ConfigFinder::DOTFILE,
         RuboCop::CLI::Command::AutoGenerateConfig::AUTO_GENERATED_FILE
@@ -42,7 +42,6 @@ module RuboCop
 
       handle 'initialize' do |request|
         initialization_options = extract_initialization_options_from(request)
-        @position_encoding = initialization_options[:position_encoding]
 
         @server.configure(initialization_options)
 
@@ -54,8 +53,7 @@ module RuboCop
               text_document_sync: LanguageServer::Protocol::Interface::TextDocumentSyncOptions.new(
                 change: LanguageServer::Protocol::Constant::TextDocumentSyncKind::INCREMENTAL,
                 open_close: true
-              ),
-              position_encoding: @position_encoding
+              )
             )
           )
         )
@@ -186,26 +184,14 @@ module RuboCop
 
       def extract_initialization_options_from(request)
         safe_autocorrect = request.dig(:params, :initializationOptions, :safeAutocorrect)
-        position_encodings = request.dig(:params, :capabilities, :general, :positionEncodings)
 
         {
           safe_autocorrect: safe_autocorrect.nil? || safe_autocorrect == true,
           lint_mode: request.dig(:params, :initializationOptions, :lintMode) == true,
-          layout_mode: request.dig(:params, :initializationOptions, :layoutMode) == true,
-          position_encoding: position_encoding(position_encodings)
+          layout_mode: request.dig(:params, :initializationOptions, :layoutMode) == true
         }
       end
 
-      def position_encoding(position_encodings)
-        if position_encodings&.include?('utf-8')
-          'utf-8'
-        elsif position_encodings&.include?('utf-32')
-          'utf-32'
-        else
-          'utf-16'
-        end
-      end
-
       def format_file(file_uri, command: nil)
         unless (text = @text_cache[file_uri])
           Logger.log("Format request arrived before text synchronized; skipping: `#{file_uri}'")
@@ -233,8 +219,7 @@ module RuboCop
           method: 'textDocument/publishDiagnostics',
           params: {
             uri: file_uri,
-            diagnostics: @server.offenses(convert_file_uri_to_path(file_uri),
-                                          text, @position_encoding)
+            diagnostics: @server.offenses(convert_file_uri_to_path(file_uri), text)
           }
         }
       end
@@ -244,8 +229,9 @@ module RuboCop
 
         start_pos = text_pos(orig_text, range[:start])
         end_pos = text_pos(orig_text, range[:end])
-        orig_text[start_pos...end_pos] = text
-        orig_text
+        text_bin = orig_text.b
+        text_bin[start_pos...end_pos] = text.b
+        text_bin.force_encoding(orig_text.encoding)
       end
 
       def text_pos(text, range)
@@ -254,27 +240,14 @@ module RuboCop
         pos = 0
         text.each_line.with_index do |l, i|
           if i == line
-            pos += line_pos(l, char)
+            pos += l.encode('utf-16be').b[0, char * 2].encode('utf-8', 'utf-16be').bytesize
             return pos
           end
-          pos += l.size
+          pos += l.bytesize
         end
         pos
       end
 
-      def line_pos(line, char)
-        case @position_encoding
-        when 'utf-8'
-          line.byteslice(0, char).size
-        when 'utf-32'
-          char
-        else # 'utf-16'
-          # utf-16 is default position encoding on LSP
-          # https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/
-          line.encode('utf-16be').byteslice(0, char * 2).size
-        end
-      end
-
       def convert_file_uri_to_path(uri)
         URI.decode_www_form_component(uri.delete_prefix('file://'))
       end

data/lib/rubocop/lsp/runtime.rb

@@ -44,14 +44,14 @@ module RuboCop
         @runner.formatted_source
       end
 
-      def offenses(path, text, position_encoding, prism_result: nil)
+      def offenses(path, text, document_encoding = nil, prism_result: nil)
         diagnostic_options = {}
         diagnostic_options[:only] = config_only_options if @lint_mode || @layout_mode
 
         @runner.run(path, text, diagnostic_options, prism_result: prism_result)
         @runner.offenses.map do |offense|
           Diagnostic.new(
-            position_encoding, offense, path, @cop_registry[offense.cop_name]&.first
+            document_encoding, offense, path, @cop_registry[offense.cop_name]&.first
           ).to_lsp_diagnostic(@runner.config_for_working_directory)
         end
       end

data/lib/rubocop/lsp/server.rb

@@ -51,8 +51,8 @@ module RuboCop
         @runtime.format(path, text, command: command)
       end
 
-      def offenses(path, text, position_encoding)
-        @runtime.offenses(path, text, position_encoding)
+      def offenses(path, text)
+        @runtime.offenses(path, text)
       end
 
       def configure(options)

data/lib/rubocop/magic_comment.rb

@@ -11,6 +11,7 @@ module RuboCop
     KEYWORDS = {
       encoding: '(?:en)?coding',
       frozen_string_literal: 'frozen[_-]string[_-]literal',
+      rbs_inline: 'rbs_inline',
       shareable_constant_value: 'shareable[_-]constant[_-]value',
       typed: 'typed'
     }.freeze
@@ -36,6 +37,7 @@ module RuboCop
     def any?
       frozen_string_literal_specified? ||
         encoding_specified? ||
+        rbs_inline_specified? ||
         shareable_constant_value_specified? ||
         typed_specified?
     end
@@ -60,6 +62,10 @@ module RuboCop
       [true, false].include?(frozen_string_literal)
     end
 
+    def valid_rbs_inline_value?
+      %w[enabled disabled].include?(extract_rbs_inline_value)
+    end
+
     def valid_shareable_constant_value?
       %w[none literal experimental_everything experimental_copy].include?(shareable_constant_value)
     end
@@ -105,6 +111,10 @@ module RuboCop
       specified?(encoding)
     end
 
+    def rbs_inline_specified?
+      valid_rbs_inline_value?
+    end
+
     # Was the Sorbet `typed` sigil specified?
     #
     # @return [Boolean]
@@ -203,6 +213,9 @@ module RuboCop
         match(KEYWORDS[:frozen_string_literal])
       end
 
+      # Emacs comments cannot specify RBS::inline behavior.
+      def extract_rbs_inline_value; end
+
       def extract_shareable_constant_value
         match(KEYWORDS[:shareable_constant_value])
       end
@@ -242,6 +255,9 @@ module RuboCop
       # Vim comments cannot specify frozen string literal behavior.
       def frozen_string_literal; end
 
+      # Vim comments cannot specify RBS::inline behavior.
+      def extract_rbs_inline_value; end
+
       # Vim comments cannot specify shareable constant values behavior.
       def shareable_constant_value; end
 
@@ -296,6 +312,10 @@ module RuboCop
         extract(/\A\s*#\s*#{KEYWORDS[:frozen_string_literal]}:\s*#{TOKEN}\s*\z/io)
       end
 
+      def extract_rbs_inline_value
+        extract(/\A\s*#\s*#{KEYWORDS[:rbs_inline]}:\s*#{TOKEN}\s*\z/io)
+      end
+
       def extract_shareable_constant_value
         extract(/\A\s*#\s*#{KEYWORDS[:shareable_constant_value]}:\s*#{TOKEN}\s*\z/io)
       end

data/lib/rubocop/rake_task.rb

@@ -75,7 +75,7 @@ module RuboCop
     def setup_subtasks(name, *args, &task_block) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       namespace(name) do
         # rubocop:todo Naming/InclusiveLanguage
-        task(:auto_correct, *args) do
+        task(:auto_correct, *args) do |_, task_args|
           require 'rainbow'
           warn Rainbow(
             'rubocop:auto_correct task is deprecated; ' \