rubocop 1.65.1 → 1.75.6

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

@@ -17,9 +17,14 @@ module RuboCop
       # `foo&.bar` can start returning `nil` as well as what the method
       # returns.
       #
-      # The default for `MaxChainLength` is `2`
+      # The default for `MaxChainLength` is `2`.
       # We have limited the cop to not register an offense for method chains
-      # that exceed this option is set.
+      # 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
@@ -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,127 @@ 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)
+            ) do |corrector|
+              corrector.replace(rhs_receiver, lhs_receiver.source)
+            end
+            ignore_node(node)
+          end
+        end
+
+        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)
+
+            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 !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 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 +283,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 +298,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,17 +307,27 @@ 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
 
-          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(: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 +338,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 +378,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

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # Looks for places where an subset of an Enumerable (array,
+      # Looks for places where a subset of an Enumerable (array,
       # range, set, etc.; see note below) is calculated based on a `Regexp`
       # match, and suggests `grep` or `grep_v` instead.
       #
@@ -27,7 +27,7 @@ module RuboCop
       #   so the correction may not be actually equivalent.
       #
       # @example
-      #   # bad (select or find_all)
+      #   # bad (select, filter, or find_all)
       #   array.select { |x| x.match? /regexp/ }
       #   array.select { |x| /regexp/.match?(x) }
       #   array.select { |x| x =~ /regexp/ }
@@ -47,9 +47,11 @@ module RuboCop
         include RangeHelp
 
         MSG = 'Prefer `%<replacement>s` to `%<original_method>s` with a regexp match.'
-        RESTRICT_ON_SEND = %i[select find_all reject].freeze
-        REPLACEMENTS = { select: 'grep', find_all: 'grep', reject: 'grep_v' }.freeze
-        OPPOSITE_REPLACEMENTS = { select: 'grep_v', find_all: 'grep_v', reject: 'grep' }.freeze
+        RESTRICT_ON_SEND = %i[select filter find_all reject].freeze
+        REPLACEMENTS = { select: 'grep', filter: 'grep', find_all: 'grep', reject: 'grep_v' }.freeze
+        OPPOSITE_REPLACEMENTS = {
+          select: 'grep_v', filter: 'grep_v', find_all: 'grep_v', reject: 'grep'
+        }.freeze
         REGEXP_METHODS = %i[match? =~ !~].to_set.freeze
 
         # @!method regexp_match?(node)
@@ -57,6 +59,7 @@ module RuboCop
           {
             (block call (args (arg $_)) ${(send _ %REGEXP_METHODS _) match-with-lvasgn})
             (numblock call $1 ${(send _ %REGEXP_METHODS _) match-with-lvasgn})
+            (itblock call $_ ${(send _ %REGEXP_METHODS _) match-with-lvasgn})
           }
         PATTERN
 
@@ -84,8 +87,9 @@ module RuboCop
           }
         PATTERN
 
-        # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+        # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         def on_send(node)
+          return if target_ruby_version < 2.6 && node.method?(:filter)
           return unless (block_node = node.block_node)
           return if block_node.body&.begin_type?
           return if receiver_allowed?(block_node.receiver)
@@ -99,7 +103,7 @@ module RuboCop
 
           register_offense(node, block_node, regexp, replacement)
         end
-        # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+        # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         alias on_csend on_send
 
         private
@@ -134,6 +138,7 @@ module RuboCop
           return unless (block_arg_name, regexp_method_send_node = regexp_match?(block_node))
 
           block_arg_name = :"_#{block_arg_name}" if block_node.numblock_type?
+
           return unless calls_lvar?(regexp_method_send_node, block_arg_name)
 
           regexp_method_send_node
@@ -147,7 +152,8 @@ module RuboCop
           return node.child_nodes.first if node.match_with_lvasgn_type?
 
           if node.receiver.lvar_type? &&
-             (block.numblock_type? || node.receiver.source == block.first_argument.source)
+             (block.type?(:numblock, :itblock) ||
+              node.receiver.source == block.first_argument.source)
             node.first_argument
           elsif node.first_argument.lvar_type?
             node.receiver

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

@@ -37,33 +37,29 @@ module RuboCop
         private
 
         def check(node, var_type)
-          var_name, rhs = *node
-          return unless rhs
+          return unless (rhs = node.expression)
 
-          if rhs.send_type?
-            check_send_node(node, rhs, var_name, var_type)
+          if rhs.send_type? && rhs.arguments.one?
+            check_send_node(node, rhs, node.name, var_type)
           elsif rhs.operator_keyword?
-            check_boolean_node(node, rhs, var_name, var_type)
+            check_boolean_node(node, rhs, node.name, var_type)
           end
         end
 
         def check_send_node(node, rhs, var_name, var_type)
-          receiver, method_name, *_args = *rhs
-          return unless OPS.include?(method_name)
+          return unless OPS.include?(rhs.method_name)
 
           target_node = s(var_type, var_name)
-          return unless receiver == target_node
+          return unless rhs.receiver == target_node
 
-          add_offense(node, message: format(MSG, method: method_name)) do |corrector|
+          add_offense(node, message: format(MSG, method: rhs.method_name)) do |corrector|
             autocorrect(corrector, node)
           end
         end
 
         def check_boolean_node(node, rhs, var_name, var_type)
-          first_operand, _second_operand = *rhs
-
           target_node = s(var_type, var_name)
-          return unless first_operand == target_node
+          return unless rhs.lhs == target_node
 
           operator = rhs.loc.operator.source
           add_offense(node, message: format(MSG, method: operator)) do |corrector|
@@ -72,7 +68,7 @@ module RuboCop
         end
 
         def autocorrect(corrector, node)
-          _var_name, rhs = *node
+          rhs = node.expression
 
           if rhs.send_type?
             autocorrect_send_node(corrector, node, rhs)
@@ -82,13 +78,11 @@ module RuboCop
         end
 
         def autocorrect_send_node(corrector, node, rhs)
-          _receiver, method_name, args = *rhs
-          apply_autocorrect(corrector, node, rhs, method_name.to_s, args)
+          apply_autocorrect(corrector, node, rhs, rhs.method_name, rhs.first_argument)
         end
 
         def autocorrect_boolean_node(corrector, node, rhs)
-          _first_operand, second_operand = *rhs
-          apply_autocorrect(corrector, node, rhs, rhs.loc.operator.source, second_operand)
+          apply_autocorrect(corrector, node, rhs, rhs.loc.operator.source, rhs.rhs)
         end
 
         def apply_autocorrect(corrector, node, rhs, operator, new_rhs)

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

@@ -141,7 +141,7 @@ module RuboCop
 
         def expressions_per_line(exprs)
           # create a map matching lines to the number of expressions on them
-          exprs_lines = exprs.map(&:first_line)
+          exprs_lines = exprs.map(&:last_line)
           exprs_lines.group_by(&:itself)
         end
 
@@ -164,7 +164,7 @@ module RuboCop
 
           ast = processed_source.ast
           @range_nodes = ast.range_type? ? [ast] : []
-          @range_nodes.concat(ast.each_descendant(:irange, :erange).to_a)
+          @range_nodes.concat(ast.each_descendant(:range).to_a)
         end
       end
     end

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

@@ -68,7 +68,7 @@ module RuboCop
         def on_send(node)
           return if allow_send? && !node.method?(:public_send)
           return unless (first_argument = node.first_argument)
-          return unless STATIC_METHOD_NAME_NODE_TYPES.include?(first_argument.type)
+          return unless first_argument.type?(*STATIC_METHOD_NAME_NODE_TYPES)
 
           offense_range = offense_range(node)
           method_name = first_argument.value
@@ -83,6 +83,7 @@ module RuboCop
             end
           end
         end
+        alias on_csend on_send
         # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
         private

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

@@ -122,10 +122,9 @@ module RuboCop
         def on_rescue(node)
           return unless style == :semantic
 
-          begin_node, *rescue_nodes, _else_node = *node
-          check_scope(:raise, begin_node)
+          check_scope(:raise, node.body)
 
-          rescue_nodes.each do |rescue_node|
+          node.resbody_branches.each do |rescue_node|
             check_scope(:fail, rescue_node)
             allow(:raise, rescue_node)
           end

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

@@ -33,22 +33,19 @@ module RuboCop
       #
       class SingleArgumentDig < Base
         extend AutoCorrector
+        include DigHelp
 
         MSG = 'Use `%<receiver>s[%<argument>s]` instead of `%<original>s`.'
         RESTRICT_ON_SEND = %i[dig].freeze
         IGNORED_ARGUMENT_TYPES = %i[block_pass forwarded_restarg forwarded_args hash].freeze
 
-        # @!method single_argument_dig?(node)
-        def_node_matcher :single_argument_dig?, <<~PATTERN
-          (send _ :dig $!splat)
-        PATTERN
-
         def on_send(node)
           return unless node.receiver
 
           expression = single_argument_dig?(node)
           return unless expression
           return if IGNORED_ARGUMENT_TYPES.include?(expression.type)
+          return if ignore_dig_chain?(node)
 
           receiver = node.receiver.source
           argument = expression.source
@@ -63,6 +60,13 @@ module RuboCop
 
           ignore_node(node)
         end
+
+        private
+
+        def ignore_dig_chain?(node)
+          dig_chain_enabled? &&
+            (dig?(node.receiver) || dig?(node.parent))
+        end
       end
     end
   end

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

@@ -10,7 +10,7 @@ module RuboCop
       # parameters.
       #
       # Configuration option: Methods
-      # Should be set to use this cop. Array of hashes, where each key is the
+      # Should be set to use this cop. `Array` of hashes, where each key is the
       # method name and value - array of argument names.
       #
       # @example Methods: [{reduce: %w[a b]}]