rubocop 1.66.1 → 1.72.2

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

@@ -66,14 +66,12 @@ module RuboCop
         # Assignment of self.x
 
         def on_or_asgn(node)
-          lhs, _rhs = *node
-          allow_self(lhs)
+          allow_self(node.lhs)
         end
         alias on_and_asgn on_or_asgn
 
         def on_op_asgn(node)
-          lhs, _op, _rhs = *node
-          allow_self(lhs)
+          allow_self(node.lhs)
         end
 
         # Using self.x to distinguish from local variable x
@@ -92,13 +90,11 @@ module RuboCop
         end
 
         def on_masgn(node)
-          lhs, rhs = *node
-          add_masgn_lhs_variables(rhs, lhs)
+          add_masgn_lhs_variables(node.rhs, node.lhs)
         end
 
         def on_lvasgn(node)
-          lhs, rhs = *node
-          add_lhs_to_local_variables_scopes(rhs, lhs)
+          add_lhs_to_local_variables_scopes(node.rhs, node.lhs)
         end
 
         def on_in_pattern(node)
@@ -127,12 +123,10 @@ module RuboCop
           # 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|
-            lhs, _rhs = *child_node
-
             if child_node.lvasgn_type?
-              add_lhs_to_local_variables_scopes(node.condition, lhs)
+              add_lhs_to_local_variables_scopes(node.condition, child_node.lhs)
             elsif child_node.masgn_type?
-              add_masgn_lhs_variables(node.condition, lhs)
+              add_masgn_lhs_variables(node.condition, child_node.lhs)
             end
           end
         end
@@ -181,9 +175,8 @@ module RuboCop
         def on_argument(node)
           if node.mlhs_type?
             on_args(node)
-          else
-            name, = *node
-            @local_variables_scopes[node] << name
+          elsif node.respond_to?(:name)
+            @local_variables_scopes[node] << node.name
           end
         end
 

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

@@ -21,12 +21,8 @@ module RuboCop
       #   args += foo
       #   hash.merge!(other)
       #
-      #   # bad
-      #   self.foo = foo.concat(ary)
-      #
       #   # good
       #   foo.concat(ary)
-      #   self.foo += ary
       #
       class RedundantSelfAssignment < Base
         include RangeHelp
@@ -49,19 +45,31 @@ module RuboCop
           gvasgn: :gvar
         }.freeze
 
+        # @!method redundant_self_assignment?
+        def_node_matcher :redundant_self_assignment?, <<~PATTERN
+          (call
+            %1 _
+            (call
+              (call
+                %1 %2) #method_returning_self?
+              ...))
+        PATTERN
+
+        # rubocop:disable Metrics/AbcSize
         def on_lvasgn(node)
-          lhs, rhs = *node
-          receiver, method_name, = *rhs
-          return unless receiver && method_returning_self?(method_name)
+          return unless (rhs = node.rhs)
+          return unless rhs.call_type? && method_returning_self?(rhs.method_name)
+          return unless (receiver = rhs.receiver)
 
           receiver_type = ASSIGNMENT_TYPE_TO_RECEIVER_TYPE[node.type]
-          return unless receiver.type == receiver_type && receiver.children.first == lhs
+          return unless receiver.type == receiver_type && receiver.children.first == node.lhs
 
-          message = format(MSG, method_name: method_name)
+          message = format(MSG, method_name: rhs.method_name)
           add_offense(node.loc.operator, message: message) do |corrector|
             corrector.replace(node, rhs.source)
           end
         end
+        # rubocop:enable Metrics/AbcSize
         alias on_ivasgn on_lvasgn
         alias on_cvasgn on_lvasgn
         alias on_gvasgn on_lvasgn
@@ -75,6 +83,7 @@ module RuboCop
             corrector.remove(correction_range(node))
           end
         end
+        alias on_csend on_send
 
         private
 
@@ -82,31 +91,10 @@ module RuboCop
           METHODS_RETURNING_SELF.include?(method_name)
         end
 
-        # @!method redundant_self_assignment?(node, method_name)
-        def_node_matcher :redundant_self_assignment?, <<~PATTERN
-          (send
-            (self) _
-            (send
-              (send
-                {(self) nil?} %1) #method_returning_self?
-              ...))
-        PATTERN
-
-        # @!method redundant_nonself_assignment?(node, receiver, method_name)
-        def_node_matcher :redundant_nonself_assignment?, <<~PATTERN
-          (send
-            %1 _
-            (send
-              (send
-                %1 %2) #method_returning_self?
-              ...))
-        PATTERN
-
         def redundant_assignment?(node)
-          receiver_name = node.method_name.to_s[0...-1].to_sym
+          receiver_name = node.method_name.to_s.delete_suffix('=').to_sym
 
-          redundant_self_assignment?(node, receiver_name) ||
-            redundant_nonself_assignment?(node, node.receiver, receiver_name)
+          redundant_self_assignment?(node, node.receiver, receiver_name)
         end
 
         def correction_range(node)

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

@@ -23,7 +23,6 @@ module RuboCop
       #   foo = bar unless condition
       #
       class RedundantSelfAssignmentBranch < Base
-        include RangeHelp
         extend AutoCorrector
 
         MSG = 'Remove the self-assignment branch.'
@@ -34,16 +33,17 @@ module RuboCop
         PATTERN
 
         def on_lvasgn(node)
-          variable, expression = *node
+          expression = node.expression
+
           return unless use_if_and_else_branch?(expression)
 
           if_branch = expression.if_branch
           else_branch = expression.else_branch
           return if inconvertible_to_modifier?(if_branch, else_branch)
 
-          if self_assign?(variable, if_branch)
+          if self_assign?(node.name, if_branch)
             register_offense(expression, if_branch, else_branch, 'unless')
-          elsif self_assign?(variable, else_branch)
+          elsif self_assign?(node.name, else_branch)
             register_offense(expression, else_branch, if_branch, 'if')
           end
         end

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

@@ -93,9 +93,9 @@ module RuboCop
             (call $(call _ $:sort_by _) ${:last :first})
             (send $(send _ $:sort_by _) ${:[] :at :slice} {(int 0) (int -1)})
 
-            (call ({block numblock} $(call _ ${:sort_by :sort}) ...) ${:last :first})
+            (call (any_block $(call _ ${:sort_by :sort}) ...) ${:last :first})
             (call
-              ({block numblock} $(call _ ${:sort_by :sort}) ...)
+              (any_block $(call _ ${:sort_by :sort}) ...)
               ${:[] :at :slice} {(int 0) (int -1)}
             )
           }
@@ -201,7 +201,7 @@ module RuboCop
         def with_logical_operator?(node)
           return false unless (parent = node.parent)
 
-          parent.or_type? || parent.and_type?
+          parent.operator_keyword?
         end
       end
     end

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

@@ -41,7 +41,7 @@ module RuboCop
         MSG = 'Redundant escape of %<char>s inside string literal.'
 
         def on_str(node)
-          return if node.parent&.regexp_type? || node.parent&.xstr_type? || node.character_literal?
+          return if node.parent&.type?(:regexp, :xstr) || node.character_literal?
 
           str_contents_range = str_contents_range(node)
 
@@ -147,7 +147,7 @@ module RuboCop
         end
 
         def heredoc?(node)
-          (node.str_type? || node.dstr_type?) && node.heredoc?
+          node.type?(:str, :dstr) && node.heredoc?
         end
 
         def delimiter?(node, char)

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

@@ -103,7 +103,7 @@ module RuboCop
             next unless sibling.is_a?(AST::Node)
 
             sibling = sibling_node(sibling)
-            break unless sibling&.send_type? && sibling&.method?(node.method_name)
+            break unless sibling&.send_type? && sibling.method?(node.method_name)
             break unless sibling.arguments? && !sibling.receiver
             break unless in_same_section?(sibling, node)
             break unless node.first_argument.str_type? && sibling.first_argument.str_type?

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

@@ -68,17 +68,16 @@ module RuboCop
         end
 
         def correct_rescue_block(corrector, node, parenthesized)
-          operation, rescue_modifier, = *node
-          *_, rescue_args = *rescue_modifier
+          operation = node.body
 
           node_indentation, node_offset = indentation_and_offset(node, parenthesized)
 
           corrector.remove(range_between(operation.source_range.end_pos, node.source_range.end_pos))
           corrector.insert_before(operation, "begin\n#{node_indentation}")
-          corrector.insert_after(operation, <<~RESCUE_CLAUSE.chop)
+          corrector.insert_after(heredoc_end(operation) || operation, <<~RESCUE_CLAUSE.chop)
 
             #{node_offset}rescue
-            #{node_indentation}#{rescue_args.source}
+            #{node_indentation}#{node.resbody_branches.first.body.source}
             #{node_offset}end
           RESCUE_CLAUSE
         end
@@ -92,6 +91,18 @@ module RuboCop
           end
           [node_indentation, node_offset]
         end
+
+        def heredoc_end(node)
+          return unless node.call_type?
+
+          heredoc = node.arguments.reverse.find do |argument|
+            argument.respond_to?(:heredoc?) && argument.heredoc?
+          end
+
+          return unless heredoc
+
+          heredoc.loc.heredoc_end
+        end
       end
     end
   end

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

@@ -83,7 +83,7 @@ module RuboCop
         end
 
         def scoped_node?(node)
-          node.def_type? || node.defs_type? || node.lambda?
+          node.type?(:def, :defs) || node.lambda?
         end
 
         # @!method chained_send?(node)

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

@@ -3,7 +3,8 @@
 module RuboCop
   module Cop
     module Style
-      # Checks if `return` or `return nil` is used in predicate method definitions.
+      # Checks for predicate method definitions that return `nil`.
+      # A predicate method should only return a boolean value.
       #
       # @safety
       #   Autocorrection is marked as unsafe because the change of the return value
@@ -31,6 +32,24 @@ module RuboCop
       #     do_something?
       #   end
       #
+      #   # bad
+      #   def foo?
+      #     if condition
+      #       nil
+      #     else
+      #       true
+      #     end
+      #   end
+      #
+      #   # good
+      #   def foo?
+      #     if condition
+      #       false
+      #     else
+      #       true
+      #     end
+      #   end
+      #
       # @example AllowedMethods: ['foo?']
       #   # good
       #   def foo?
@@ -64,24 +83,25 @@ module RuboCop
           return if allowed_method?(node.method_name) || matches_allowed_pattern?(node.method_name)
           return unless (body = node.body)
 
-          body.each_descendant(:return) do |return_node|
-            register_offense(return_node, 'return false') if return_nil?(return_node)
-          end
-
-          return unless (nil_node = nil_node_at_the_end_of_method_body(body))
+          body.each_descendant(:return) { |return_node| handle_return(return_node) }
 
-          register_offense(nil_node, 'false')
+          handle_implicit_return_values(body)
         end
         alias on_defs on_def
 
         private
 
-        def nil_node_at_the_end_of_method_body(body)
-          return body if body.nil_type?
-          return unless body.begin_type?
-          return unless (last_child = body.children.last)
+        def last_node_of_type(node, type)
+          return unless node
+          return node if node_type?(node, type)
+          return unless node.begin_type?
+          return unless (last_child = node.children.last)
+
+          last_child if last_child.is_a?(AST::Node) && node_type?(last_child, type)
+        end
 
-          last_child if last_child.is_a?(AST::Node) && last_child.nil_type?
+        def node_type?(node, type)
+          node.type == type.to_sym
         end
 
         def register_offense(offense_node, replacement)
@@ -89,6 +109,28 @@ module RuboCop
             corrector.replace(offense_node, replacement)
           end
         end
+
+        def handle_implicit_return_values(node)
+          handle_if(last_node_of_type(node, :if))
+          handle_nil(last_node_of_type(node, :nil))
+        end
+
+        def handle_return(return_node)
+          register_offense(return_node, 'return false') if return_nil?(return_node)
+        end
+
+        def handle_nil(nil_node)
+          return unless nil_node
+
+          register_offense(nil_node, 'false')
+        end
+
+        def handle_if(if_node)
+          return unless if_node
+
+          handle_implicit_return_values(if_node.if_branch)
+          handle_implicit_return_values(if_node.else_branch)
+        end
       end
     end
   end

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

@@ -21,6 +21,11 @@ module RuboCop
       # We have limited the cop to not register an offense for method chains
       # that exceed this option's value.
       #
+      # NOTE: This cop will recognize offenses but not autocorrect code when the
+      # right hand side (RHS) of the `&&` statement is an `||` statement
+      # (eg. `foo && (foo.bar? || foo.baz?)`). It can be corrected
+      # manually by removing the `foo &&` and adding `&.` to each `foo` on the RHS.
+      #
       # @safety
       #   Autocorrection is unsafe because if a value is `false`, the resulting
       #   code will have different behavior or raise an error.
@@ -81,7 +86,7 @@ module RuboCop
       #   foo.baz = bar if foo
       #   foo.baz + bar if foo
       #   foo.bar > 2 if foo
-      class SafeNavigation < Base
+      class SafeNavigation < Base # rubocop:disable Metrics/ClassLength
         include NilMethods
         include RangeHelp
         extend AutoCorrector
@@ -121,50 +126,122 @@ module RuboCop
           }
         PATTERN
 
+        # @!method and_with_rhs_or?(node)
+        def_node_matcher :and_with_rhs_or?, '(and _ {or (begin or)})'
+
         # @!method not_nil_check?(node)
         def_node_matcher :not_nil_check?, '(send (send $_ :nil?) :!)'
 
+        # @!method and_inside_begin?(node)
+        def_node_matcher :and_inside_begin?, '`(begin and ...)'
+
+        # @!method strip_begin(node)
+        def_node_matcher :strip_begin, '{ (begin $!begin) $!(begin) }'
+
         def on_if(node)
           return if allowed_if_condition?(node)
 
-          check_node(node)
+          checked_variable, receiver, method_chain, _method = extract_parts_from_if(node)
+          return unless offending_node?(node, checked_variable, method_chain, receiver)
+
+          body = extract_if_body(node)
+          method_call = receiver.parent
+
+          removal_ranges = [begin_range(node, body), end_range(node, body)]
+
+          report_offense(node, method_chain, method_call, *removal_ranges) do |corrector|
+            corrector.insert_before(method_call.loc.dot, '&') unless method_call.safe_navigation?
+          end
         end
 
-        def on_and(node)
-          check_node(node)
+        def on_and(node) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+          collect_and_clauses(node).each do |(lhs, lhs_operator_range), (rhs, _rhs_operator_range)|
+            lhs_not_nil_check = not_nil_check?(lhs)
+            lhs_receiver = lhs_not_nil_check || lhs
+            rhs_receiver = find_matching_receiver_invocation(strip_begin(rhs), lhs_receiver)
+
+            next if !cop_config['ConvertCodeThatCanStartToReturnNil'] && lhs_not_nil_check
+            next unless offending_node?(node, lhs_receiver, rhs, rhs_receiver)
+
+            # Since we are evaluating every clause in potentially a complex chain of `and` nodes,
+            # we need to ensure that there isn't an object check happening
+            lhs_method_chain = find_method_chain(lhs_receiver)
+            next unless lhs_method_chain == lhs_receiver || lhs_not_nil_check
+
+            report_offense(
+              node,
+              rhs, rhs_receiver,
+              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)
+            )
+          end
+        end
+
+        def report_offense(node, rhs, rhs_receiver, *removal_ranges, offense_range: node)
+          add_offense(offense_range) do |corrector|
+            # 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)
+
+            removal_ranges.each { |range| corrector.remove(range) }
+            yield corrector if block_given?
+
+            handle_comments(corrector, node, rhs)
+
+            add_safe_nav_to_all_methods_in_chain(corrector, rhs_receiver, rhs)
+          end
         end
 
         private
 
-        def check_node(node)
-          checked_variable, receiver, method_chain, method = extract_parts(node)
-          return if receiver != checked_variable || receiver.nil?
-          return if use_var_only_in_unless_modifier?(node, checked_variable)
-          return if chain_length(method_chain, method) > max_chain_length
-          return if unsafe_method_used?(method_chain, method)
-          return if method_chain.method?(:empty?)
+        def find_method_chain(node)
+          return node unless node&.parent&.call_type?
 
-          add_offense(node) { |corrector| autocorrect(corrector, node) }
+          find_method_chain(node.parent)
         end
 
-        def use_var_only_in_unless_modifier?(node, variable)
-          node.if_type? && node.unless? && !method_called?(variable)
+        def collect_and_clauses(node)
+          # Collect the lhs, operator and rhs of all `and` nodes
+          # `and` nodes can be nested and can contain `begin` nodes
+          # This gives us a source-ordered list of clauses that is then used to look
+          # for matching receivers as well as operator locations for offense and corrections
+          node.each_descendant(:and)
+              .inject(and_parts(node)) { |nodes, and_node| concat_nodes(nodes, and_node) }
+              .sort_by { |a| a.is_a?(RuboCop::AST::Node) ? a.source_range.begin_pos : a.begin_pos }
+              .each_slice(2)
+              .each_cons(2)
         end
 
-        def autocorrect(corrector, node)
-          body = extract_body(node)
-          method_call = method_call(node)
+        def concat_nodes(nodes, and_node)
+          return nodes if and_node.each_ancestor(:block).any?
 
-          corrector.remove(begin_range(node, body))
-          corrector.remove(end_range(node, body))
-          corrector.insert_before(method_call.loc.dot, '&') unless method_call.safe_navigation?
-          handle_comments(corrector, node, method_call)
+          nodes.concat(and_parts(and_node))
+        end
 
-          add_safe_nav_to_all_methods_in_chain(corrector, method_call, body)
+        def and_parts(node)
+          parts = [node.loc.operator]
+          parts << node.rhs unless and_inside_begin?(node.rhs)
+          parts << node.lhs unless node.lhs.and_type? || and_inside_begin?(node.lhs)
+          parts
         end
 
-        def extract_body(node)
-          if node.if_type? && node.ternary?
+        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 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 rhs.send_type? && rhs.method?(:empty?)
+
+          true
+        end
+
+        def use_var_only_in_unless_modifier?(node, variable)
+          node.if_type? && node.unless? && !method_called?(variable)
+        end
+
+        def extract_if_body(node)
+          if node.ternary?
             node.branches.find { |branch| !branch.nil_type? }
           else
             node.node_parts[1]
@@ -201,20 +278,6 @@ module RuboCop
           node.else? || node.elsif?
         end
 
-        def method_call(node)
-          _checked_variable, matching_receiver, = extract_parts(node)
-          matching_receiver.parent
-        end
-
-        def extract_parts(node)
-          case node.type
-          when :if
-            extract_parts_from_if(node)
-          when :and
-            extract_parts_from_and(node)
-          end
-        end
-
         def extract_parts_from_if(node)
           variable, receiver =
             if node.ternary?
@@ -230,16 +293,6 @@ module RuboCop
           [checked_variable, matching_receiver, receiver, method]
         end
 
-        def extract_parts_from_and(node)
-          checked_variable, rhs = *node
-          if cop_config['ConvertCodeThatCanStartToReturnNil']
-            checked_variable = not_nil_check?(checked_variable) || checked_variable
-          end
-
-          checked_variable, matching_receiver, method = extract_common_parts(rhs, checked_variable)
-          [checked_variable, matching_receiver, rhs, method]
-        end
-
         def extract_common_parts(method_chain, checked_variable)
           matching_receiver = find_matching_receiver_invocation(method_chain, checked_variable)
 
@@ -249,7 +302,7 @@ module RuboCop
         end
 
         def find_matching_receiver_invocation(method_chain, checked_variable)
-          return nil unless method_chain
+          return nil unless method_chain.respond_to?(:receiver)
 
           receiver = method_chain.receiver
 
@@ -259,7 +312,7 @@ module RuboCop
         end
 
         def chain_length(method_chain, method)
-          method.each_ancestor(:send).inject(1) do |total, ancestor|
+          method.each_ancestor(:call).inject(0) do |total, ancestor|
             break total + 1 if ancestor == method_chain
 
             total + 1
@@ -270,7 +323,7 @@ module RuboCop
           return true if unsafe_method?(method)
 
           method.each_ancestor(:send).any? do |ancestor|
-            break true unless config.for_cop('Lint/SafeNavigationChain')['Enabled']
+            break true unless config.cop_enabled?('Lint/SafeNavigationChain')
 
             break true if unsafe_method?(ancestor)
             break true if nil_methods.include?(ancestor.method_name)
@@ -310,6 +363,7 @@ module RuboCop
           start_method.each_ancestor do |ancestor|
             break unless %i[send block].include?(ancestor.type)
             next unless ancestor.send_type?
+            next if ancestor.safe_navigation?
 
             corrector.insert_before(ancestor.loc.dot, '&')
 

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Enforces safe navigation chains length to not exceed the configured maximum.
+      # The longer the chain is, the harder it becomes to track what on it could be
+      # returning `nil`.
+      #
+      # There is a potential interplay with `Style/SafeNavigation` - if both are enabled
+      # and their settings are "incompatible", one of the cops will complain about what
+      # the other proposes.
+      #
+      # E.g. if `Style/SafeNavigation` is configured with `MaxChainLength: 2` (default)
+      # and this cop is configured with `Max: 1`, then for `foo.bar.baz if foo` the former
+      # will suggest `foo&.bar&.baz`, which is an offense for the latter.
+      #
+      # @example Max: 2 (default)
+      #   # bad
+      #   user&.address&.zip&.upcase
+      #
+      #   # good
+      #   user&.address&.zip
+      #   user.address.zip if user
+      #
+      class SafeNavigationChainLength < Base
+        MSG = 'Avoid safe navigation chains longer than %<max>d calls.'
+
+        def on_csend(node)
+          safe_navigation_chains = safe_navigation_chains(node)
+          return if safe_navigation_chains.size < max
+
+          add_offense(safe_navigation_chains.last, message: format(MSG, max: max))
+        end
+
+        private
+
+        def safe_navigation_chains(node)
+          node.each_ancestor.with_object([]) do |parent, chains|
+            break chains unless parent.csend_type?
+
+            chains << parent
+          end
+        end
+
+        def max
+          cop_config['Max'] || 2
+        end
+      end
+    end
+  end
+end