rubocop 1.75.1 → 1.77.0

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

@@ -49,6 +49,7 @@ module RuboCop
           empty_parentheses?(node) ||
             first_arg_begins_with_hash_literal?(node) ||
             rescue?(node) ||
+            in_pattern_matching_in_method_argument?(node) ||
             allowed_pin_operator?(node) ||
             allowed_expression?(node)
         end
@@ -78,7 +79,7 @@ module RuboCop
           ancestor = node.ancestors.first
           return false unless ancestor
 
-          !ancestor.type?(:begin, :def, :any_block)
+          !ancestor.type?(:begin, :any_def, :any_block)
         end
 
         def allowed_ternary?(node)
@@ -98,7 +99,7 @@ module RuboCop
           return false unless node.type?(:send, :super, :yield)
 
           node.arguments.one? && !node.parenthesized? &&
-            !node.arithmetic_operation? && node.first_argument.begin_type?
+            !node.operator_method? && node.first_argument.begin_type?
         end
 
         def multiline_control_flow_statements?(node)
@@ -122,6 +123,13 @@ module RuboCop
           hash_literal && first_argument?(node) && !parentheses?(hash_literal) && !parenthesized
         end
 
+        def in_pattern_matching_in_method_argument?(begin_node)
+          return false unless begin_node.parent&.call_type?
+          return false unless (node = begin_node.children.first)
+
+          target_ruby_version <= 2.7 ? node.match_pattern_type? : node.match_pattern_p_type?
+        end
+
         def method_chain_begins_with_hash_literal(node)
           return if node.nil?
           return node if node.hash_type?
@@ -134,7 +142,9 @@ module RuboCop
           node = begin_node.children.first
 
           if (message = find_offense_message(begin_node, node))
-            begin_node = begin_node.parent if node.range_type?
+            if node.range_type? && !argument_of_parenthesized_method_call?(begin_node, node)
+              begin_node = begin_node.parent
+            end
 
             return offense(begin_node, message)
           end
@@ -154,7 +164,11 @@ module RuboCop
           if node.lambda_or_proc? && (node.braces? || node.send_node.lambda_literal?)
             return 'an expression'
           end
+          if disallowed_one_line_pattern_matching?(begin_node, node)
+            return 'a one-line pattern matching'
+          end
           return 'an interpolated expression' if interpolation?(begin_node)
+          return 'a method argument' if argument_of_parenthesized_method_call?(begin_node, node)
 
           return if begin_node.chained?
 
@@ -177,6 +191,21 @@ module RuboCop
         # @!method interpolation?(node)
         def_node_matcher :interpolation?, '[^begin ^^dstr]'
 
+        def argument_of_parenthesized_method_call?(begin_node, node)
+          if node.basic_conditional? || node.rescue_type? || method_call_parentheses_required?(node)
+            return false
+          end
+          return false unless (parent = begin_node.parent)
+
+          parent.call_type? && parent.parenthesized? && parent.receiver != begin_node
+        end
+
+        def method_call_parentheses_required?(node)
+          return false unless node.call_type?
+
+          (node.receiver.nil? || node.loc.dot) && node.arguments.any?
+        end
+
         def allow_in_multiline_conditions?
           !!config.for_enabled_cop('Style/ParenthesesAroundCondition')['AllowInMultilineConditions']
         end
@@ -225,6 +254,15 @@ module RuboCop
           end
         end
 
+        def disallowed_one_line_pattern_matching?(begin_node, node)
+          if (parent = begin_node.parent)
+            return false if parent.any_def_type? && parent.endless?
+            return false if parent.assignment?
+          end
+
+          node.any_match_pattern_type? && node.each_ancestor.none?(&:operator_keyword?)
+        end
+
         def raised_to_power_negative_numeric?(begin_node, node)
           return false unless node.numeric_type?
 

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

@@ -67,6 +67,9 @@ module RuboCop
 
         def on_or_asgn(node)
           allow_self(node.lhs)
+
+          lhs_name = node.lhs.lvasgn_type? ? node.lhs.name : node.lhs
+          add_lhs_to_local_variables_scopes(node.rhs, lhs_name)
         end
         alias on_and_asgn on_or_asgn
 
@@ -123,11 +126,11 @@ module RuboCop
         def on_if(node)
           # Allow conditional nodes to use `self` in the condition if that variable
           # name is used in an `lvasgn` or `masgn` within the `if`.
-          node.child_nodes.each do |child_node|
-            if child_node.lvasgn_type?
-              add_lhs_to_local_variables_scopes(node.condition, child_node.lhs)
-            elsif child_node.masgn_type?
-              add_masgn_lhs_variables(node.condition, child_node.lhs)
+          node.each_descendant(:lvasgn, :masgn) do |descendant_node|
+            if descendant_node.lvasgn_type?
+              add_lhs_to_local_variables_scopes(node.condition, descendant_node.lhs)
+            else
+              add_masgn_lhs_variables(node.condition, descendant_node.lhs)
             end
           end
         end

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

@@ -155,7 +155,7 @@ module RuboCop
         end
 
         def preferred_delimiters
-          config.for_cop('Style/PercentLiteralDelimiters') ['PreferredDelimiters']['%r'].chars
+          config.for_cop('Style/PercentLiteralDelimiters')['PreferredDelimiters']['%r'].chars
         end
 
         def allowed_omit_parentheses_with_percent_r_literal?(node)

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

@@ -47,7 +47,7 @@ module RuboCop
 
         def on_return(node)
           # Check Lint/NonLocalExitFromIterator first before this cop
-          node.each_ancestor(:block, :def, :defs) do |n|
+          node.each_ancestor(:block, :any_def) do |n|
             break if scoped_node?(n)
 
             send_node, args_node, _body_node = *n
@@ -83,7 +83,7 @@ module RuboCop
         end
 
         def scoped_node?(node)
-          node.type?(:def, :defs) || node.lambda?
+          node.any_def_type? || node.lambda?
         end
 
         # @!method chained_send?(node)

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

@@ -86,6 +86,10 @@ module RuboCop
       #   foo.baz = bar if foo
       #   foo.baz + bar if foo
       #   foo.bar > 2 if foo
+      #
+      #   foo ? foo[index] : nil    # Ignored `foo&.[](index)` due to unclear readability benefit.
+      #   foo ? foo[idx] = v : nil  # Ignored `foo&.[]=(idx, v)` due to unclear readability benefit.
+      #   foo ? foo * 42 : nil      # Ignored `foo&.*(42)` due to unclear readability benefit.
       class SafeNavigation < Base # rubocop:disable Metrics/ClassLength
         include NilMethods
         include RangeHelp
@@ -146,6 +150,7 @@ module RuboCop
 
           body = extract_if_body(node)
           method_call = receiver.parent
+          return if dotless_operator_call?(method_call) || method_call.double_colon?
 
           removal_ranges = [begin_range(node, body), end_range(node, body)]
 
@@ -174,12 +179,19 @@ module RuboCop
               range_with_surrounding_space(range: lhs.source_range, side: :right),
               range_with_surrounding_space(range: lhs_operator_range, side: :right),
               offense_range: range_between(lhs.source_range.begin_pos, rhs.source_range.end_pos)
-            )
+            ) do |corrector|
+              corrector.replace(rhs_receiver, lhs_receiver.source)
+            end
+            ignore_node(node)
           end
         end
 
+        private
+
         def report_offense(node, rhs, rhs_receiver, *removal_ranges, offense_range: node)
           add_offense(offense_range) do |corrector|
+            next if ignored_node?(node)
+
             # If the RHS is an `or` we cannot safely autocorrect because in order to remove
             # the non-nil check we need to add safe-navs to all clauses where the receiver is used
             next if and_with_rhs_or?(node)
@@ -193,8 +205,6 @@ module RuboCop
           end
         end
 
-        private
-
         def find_method_chain(node)
           return node unless node&.parent&.call_type?
 
@@ -227,10 +237,10 @@ module RuboCop
         end
 
         def offending_node?(node, lhs_receiver, rhs, rhs_receiver) # rubocop:disable Metrics/CyclomaticComplexity
-          return false if lhs_receiver != rhs_receiver || rhs_receiver.nil?
+          return false if !matching_nodes?(lhs_receiver, rhs_receiver) || rhs_receiver.nil?
           return false if use_var_only_in_unless_modifier?(node, lhs_receiver)
           return false if chain_length(rhs, rhs_receiver) > max_chain_length
-          return false if unsafe_method_used?(rhs, rhs_receiver.parent)
+          return false if unsafe_method_used?(node, rhs, rhs_receiver.parent)
           return false if rhs.send_type? && rhs.method?(:empty?)
 
           true
@@ -248,6 +258,12 @@ module RuboCop
           end
         end
 
+        def dotless_operator_call?(method_call)
+          return false if method_call.loc.dot
+
+          method_call.method?(:[]) || method_call.method?(:[]=) || method_call.operator_method?
+        end
+
         def handle_comments(corrector, node, method_call)
           comments = comments(node)
           return if comments.empty?
@@ -306,11 +322,21 @@ module RuboCop
 
           receiver = method_chain.receiver
 
-          return receiver if receiver == checked_variable
+          return receiver if matching_nodes?(receiver, checked_variable)
 
           find_matching_receiver_invocation(receiver, checked_variable)
         end
 
+        def matching_nodes?(left, right)
+          left == right || matching_call_nodes?(left, right)
+        end
+
+        def matching_call_nodes?(left, right)
+          return false unless left && right.respond_to?(:call_type?)
+
+          left.call_type? && right.call_type? && left.children == right.children
+        end
+
         def chain_length(method_chain, method)
           method.each_ancestor(:call).inject(0) do |total, ancestor|
             break total + 1 if ancestor == method_chain
@@ -319,21 +345,24 @@ module RuboCop
           end
         end
 
-        def unsafe_method_used?(method_chain, method)
-          return true if unsafe_method?(method)
+        def unsafe_method_used?(node, method_chain, method)
+          return true if unsafe_method?(node, method)
 
           method.each_ancestor(:send).any? do |ancestor|
             break true unless config.cop_enabled?('Lint/SafeNavigationChain')
 
-            break true if unsafe_method?(ancestor)
+            break true if unsafe_method?(node, ancestor)
             break true if nil_methods.include?(ancestor.method_name)
             break false if ancestor == method_chain
           end
         end
 
-        def unsafe_method?(send_node)
-          negated?(send_node) ||
-            send_node.assignment? ||
+        def unsafe_method?(node, send_node)
+          return true if negated?(send_node)
+
+          return false if node.respond_to?(:ternary?) && node.ternary?
+
+          send_node.assignment? ||
             (!send_node.dot? && !send_node.safe_navigation?)
         end
 
@@ -362,8 +391,7 @@ module RuboCop
                                                  method_chain)
           start_method.each_ancestor do |ancestor|
             break unless %i[send block].include?(ancestor.type)
-            next unless ancestor.send_type?
-            next if ancestor.safe_navigation?
+            next if !ancestor.send_type? || ancestor.operator_method?
 
             corrector.insert_before(ancestor.loc.dot, '&')
 

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

@@ -115,8 +115,9 @@ module RuboCop
         end
 
         def correct_node(corrector, node)
-          corrector.replace(node.loc.keyword, 'if') if node.unless?
+          corrector.replace(node.loc.keyword, 'if') if node.unless? && !part_of_ignored_node?(node)
           corrector.replace(node.condition, chainable_condition(node))
+          ignore_node(node)
         end
 
         def correct_for_guard_condition_style(corrector, node, if_branch)
@@ -185,8 +186,10 @@ module RuboCop
         end
 
         def add_parentheses?(node)
-          node.assignment? || (node.operator_keyword? && !node.and_type?) ||
-            (node.call_type? && node.arguments.any? && !node.parenthesized?)
+          return true if node.assignment? || (node.operator_keyword? && !node.and_type?)
+          return false unless node.call_type?
+
+          (node.arguments.any? && !node.parenthesized?) || node.prefix_not?
         end
 
         def parenthesized_method_arguments(node)

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

@@ -51,7 +51,6 @@ module RuboCop
       #   Pathname.new('/') + 'test'
       #
       class StringConcatenation < Base
-        include RangeHelp
         extend AutoCorrector
 
         MSG = 'Prefer string interpolation to string concatenation.'
@@ -147,7 +146,7 @@ module RuboCop
             when :str
               adjust_str(part)
             when :dstr
-              part.children.all?(&:str_type?) ? adjust_str(part) : contents_range(part).source
+              part.children.all?(&:str_type?) ? adjust_str(part) : part.value
             else
               "\#{#{part.source}}"
             end

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

@@ -3,7 +3,8 @@
 module RuboCop
   module Cop
     module Style
-      # Checks for inheritance from Struct.new.
+      # Checks for inheritance from `Struct.new`. Inheriting from `Struct.new`
+      # adds a superfluous level in inheritance tree.
       #
       # @safety
       #   Autocorrection is unsafe because it will change the inheritance
@@ -17,12 +18,18 @@ module RuboCop
       #     end
       #   end
       #
+      #   Person.ancestors
+      #   # => [Person, #<Class:0x000000010b4e14a0>, Struct, (...)]
+      #
       #   # good
       #   Person = Struct.new(:first_name, :last_name) do
       #     def age
       #       42
       #     end
       #   end
+      #
+      #   Person.ancestors
+      #   # => [Person, Struct, (...)]
       class StructInheritance < Base
         include RangeHelp
         extend AutoCorrector

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

@@ -68,7 +68,6 @@ module RuboCop
       class SuperArguments < Base
         extend AutoCorrector
 
-        DEF_TYPES = %i[def defs].freeze
         ASSIGN_TYPES = %i[or_asgn lvasgn].freeze
 
         MSG = 'Call `super` without arguments and parentheses when the signature is identical.'
@@ -100,7 +99,7 @@ module RuboCop
             # `super` used within the block is always allowed.
             break if node.any_block_type? && !block_sends_to_super?(super_node, node)
 
-            break node if DEF_TYPES.include?(node.type)
+            break node if node.any_def_type?
           end
         end
 

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

@@ -270,7 +270,7 @@ module RuboCop
         end
 
         def allow_if_method_has_argument?(send_node)
-          !!cop_config.fetch('AllowMethodsWithArguments', false) && !send_node.arguments.count.zero?
+          !!cop_config.fetch('AllowMethodsWithArguments', false) && send_node.arguments.any?
         end
 
         def allow_comments?

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

@@ -79,10 +79,16 @@ module RuboCop
       #   # bad
       #   method(1, 2,)
       #
+      #   # bad
+      #   object[1, 2,]
+      #
       #   # good
       #   method(1, 2)
       #
       #   # good
+      #   object[1, 2]
+      #
+      #   # good
       #   method(
       #     1,
       #     2
@@ -96,7 +102,7 @@ module RuboCop
         end
 
         def on_send(node)
-          return unless node.arguments? && node.parenthesized?
+          return unless node.arguments? && (node.parenthesized? || node.method?(:[]))
 
           check(node, node.arguments, 'parameter of %<article>s method call',
                 node.last_argument.source_range.end_pos,

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

@@ -11,7 +11,7 @@ module RuboCop
       # * `comma`: Requires a comma after the last item in an array, but only when each item is on
       # its own line.
       # * `diff_comma`: Requires a comma after the last item in an array, but only when that item is
-      # followed by an immediate newline.
+      # followed by an immediate newline, even if there is an inline comment on the same line.
       # * `no_comma`: Does not require a comma after the last item in an array
       #
       # @example EnforcedStyleForMultiline: consistent_comma

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

@@ -97,7 +97,7 @@ module RuboCop
           pipes = tokens.select { |token| token.type == :tPIPE }
           begin_pos, end_pos = pipes.map { |pipe| tokens.index(pipe) }
 
-          tokens[begin_pos + 1..end_pos - 1]
+          tokens[(begin_pos + 1)..(end_pos - 1)]
         end
       end
     end

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

@@ -11,7 +11,7 @@ module RuboCop
       # * `comma`: Requires a comma after the last item in a hash, but only when each item is on its
       # own line.
       # * `diff_comma`: Requires a comma after the last item in a hash, but only when that item is
-      # followed by an immediate newline.
+      # followed by an immediate newline, even if there is an inline comment on the same line.
       # * `no_comma`: Does not require a comma after the last item in a hash
       #
       # @example EnforcedStyleForMultiline: consistent_comma

data/lib/rubocop/cop/team.rb

@@ -279,7 +279,7 @@ module RuboCop
         @errors << message
         warn message
         if debug?
-          puts error.message, error.backtrace
+          puts error.full_message
         else
           warn 'To see the complete backtrace run rubocop -d.'
         end

data/lib/rubocop/cop/util.rb

@@ -76,7 +76,7 @@ module RuboCop
         loc = node.loc
         selector = if node.type?(:super, :yield)
                      loc.keyword
-                   elsif node.type?(:def, :defs)
+                   elsif node.any_def_type?
                      loc.name
                    else
                      loc.selector

data/lib/rubocop/cop/variable_force/assignment.rb

@@ -110,8 +110,13 @@ module RuboCop
         end
 
         def multiple_assignment_node
-          return nil unless node.parent&.mlhs_type?
-          return nil unless (grandparent_node = node.parent&.parent)
+          return nil unless (candidate_mlhs_node = node.parent)
+
+          # In `(foo, bar), *baz`, the splat node must be traversed as well.
+          candidate_mlhs_node = candidate_mlhs_node.parent if candidate_mlhs_node.splat_type?
+
+          return nil unless candidate_mlhs_node.mlhs_type?
+          return nil unless (grandparent_node = node.parent.parent)
           if (node = find_multiple_assignment_node(grandparent_node))
             return node
           end
@@ -139,7 +144,6 @@ module RuboCop
 
         def find_multiple_assignment_node(grandparent_node)
           return unless grandparent_node.type == MULTIPLE_LEFT_HAND_SIDE_TYPE
-          return if grandparent_node.children.any?(&:splat_type?)
 
           parent = grandparent_node.parent
           return parent if parent.type == MULTIPLE_ASSIGNMENT_TYPE

data/lib/rubocop/cop/variable_force/variable.rb

@@ -107,7 +107,7 @@ module RuboCop
         end
 
         def method_argument?
-          argument? && %i[def defs].include?(@scope.node.type)
+          argument? && @scope.node.any_def_type?
         end
 
         def block_argument?

data/lib/rubocop/cops_documentation_generator.rb

@@ -327,8 +327,12 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
   def print_cop_with_doc(cop) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
     cop_config = config.for_cop(cop)
     non_display_keys = %w[
-      AutoCorrect Description Enabled StyleGuide Reference Safe SafeAutoCorrect VersionAdded
-      VersionChanged
+      Enabled
+      Description
+      StyleGuide
+      Reference References
+      Safe SafeAutoCorrect AutoCorrect
+      VersionAdded VersionChanged
     ]
     parameters = cop_config.reject { |k| non_display_keys.include? k }
     description = 'No documentation'

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -164,7 +164,7 @@ module RuboCop
 
       def cop_config_params(default_cfg, cfg)
         default_cfg.keys -
-          %w[Description StyleGuide Reference Enabled Exclude Safe
+          %w[Description StyleGuide Reference References Enabled Exclude Safe
              SafeAutoCorrect VersionAdded VersionChanged VersionRemoved] -
           cfg.keys
       end
@@ -178,6 +178,7 @@ module RuboCop
           next unless value.is_a?(Array)
           next if value.empty?
 
+          value.map! { |v| v.nil? ? '~' : v } # Change nil back to ~ as in the YAML file.
           output_buffer.puts "# #{param}: #{value.uniq.join(', ')}"
         end
       end

data/lib/rubocop/formatter/fuubar_style_formatter.rb

@@ -22,7 +22,7 @@ module RuboCop
 
         @severest_offense = nil
 
-        file_phrase = target_files.count == 1 ? 'file' : 'files'
+        file_phrase = target_files.one? ? 'file' : 'files'
 
         # 185/407 files |====== 45 ======>                    |  ETA: 00:00:04
         # %c / %C       |       %w       >         %i         |       %e

data/lib/rubocop/formatter/html_formatter.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'cgi'
+require 'cgi/escape'
 require 'erb'
 
 module RuboCop

data/lib/rubocop/formatter/offense_count_formatter.rb

@@ -24,7 +24,7 @@ module RuboCop
 
         return unless output.tty?
 
-        file_phrase = target_files.count == 1 ? 'file' : 'files'
+        file_phrase = target_files.one? ? 'file' : 'files'
 
         # 185/407 files |====== 45 ======>                    |  ETA: 00:00:04
         # %c / %C       |       %w       >         %i         |       %e

data/lib/rubocop/formatter/pacman_formatter.rb

@@ -58,7 +58,7 @@ module RuboCop
         return pacdots(@total_files) unless @total_files > cols
         return pacdots(cols) unless (@total_files / cols).eql?(@repetitions)
 
-        pacdots((@total_files - (cols * @repetitions)))
+        pacdots(@total_files - (cols * @repetitions))
       end
 
       def pacdots(number)

data/lib/rubocop/lsp/diagnostic.rb

@@ -79,7 +79,7 @@ module RuboCop
         LanguageServer::Protocol::Interface::CodeDescription.new(href: doc_url)
       end
 
-      # rubocop:disable Layout/LineLength, Metrics/MethodLength
+      # rubocop:disable Metrics/MethodLength
       def autocorrect_action
         LanguageServer::Protocol::Interface::CodeAction.new(
           title: "Autocorrect #{@offense.cop_name}",
@@ -98,7 +98,7 @@ module RuboCop
           is_preferred: true
         )
       end
-      # rubocop:enable Layout/LineLength, Metrics/MethodLength
+      # rubocop:enable Metrics/MethodLength
 
       # rubocop:disable Metrics/MethodLength
       def offense_replacements
@@ -120,7 +120,7 @@ module RuboCop
       end
       # rubocop:enable Metrics/MethodLength
 
-      # rubocop:disable Layout/LineLength, Metrics/MethodLength
+      # rubocop:disable Metrics/MethodLength
       def disable_line_action
         LanguageServer::Protocol::Interface::CodeAction.new(
           title: "Disable #{@offense.cop_name} for this line",
@@ -138,7 +138,7 @@ module RuboCop
           )
         )
       end
-      # rubocop:enable Layout/LineLength, Metrics/MethodLength
+      # rubocop:enable Metrics/MethodLength
 
       def line_disable_comment
         new_text = if @offense.source_line.include?(' # rubocop:disable ')

data/lib/rubocop/magic_comment.rb

@@ -193,6 +193,10 @@ module RuboCop
       SEPARATOR = ';'
       OPERATOR  = ':'
 
+      def new_frozen_string_literal(value)
+        "# -*- frozen_string_literal: #{value} -*-"
+      end
+
       private
 
       def extract_frozen_string_literal
@@ -275,6 +279,10 @@ module RuboCop
         end
       end
 
+      def new_frozen_string_literal(value)
+        "# frozen_string_literal: #{value}"
+      end
+
       private
 
       # Extract `frozen_string_literal`.

data/lib/rubocop/rspec/cop_helper.rb

@@ -11,8 +11,8 @@ module CopHelper
     ENV['PARSER_ENGINE'] == 'parser_prism' ? 3.3 : RuboCop::TargetRuby::DEFAULT_VERSION
   end
   let(:parser_engine) do
-    # The maximum version Parser can parse is 3.4.
-    ruby_version >= 3.5 ? :parser_prism : ENV.fetch('PARSER_ENGINE', :parser_whitequark).to_sym
+    # The maximum version Parser can correctly parse is 3.3.
+    ruby_version >= 3.4 ? :parser_prism : ENV.fetch('PARSER_ENGINE', :parser_whitequark).to_sym
   end
   let(:rails_version) { false }