rubocop 1.71.1 → 1.92.0

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

@@ -37,6 +37,16 @@ module RuboCop
       #   x&.foo      # raises NoMethodError
       #   ----
       #
+      #   Additionally, when a method chain is converted, a `NoMethodError` that
+      #   the original code raised for an intermediate `nil` value is suppressed:
+      #
+      #   [source,ruby]
+      #   ----
+      #   x = Struct.new(:foo).new(nil)
+      #   x && x.foo.bar  # raises NoMethodError
+      #   x&.foo&.bar     # returns nil
+      #   ----
+      #
       # @example
       #   # bad
       #   foo.bar if foo
@@ -86,6 +96,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
@@ -138,6 +152,7 @@ module RuboCop
         # @!method strip_begin(node)
         def_node_matcher :strip_begin, '{ (begin $!begin) $!(begin) }'
 
+        # rubocop:disable-next Metrics/AbcSize
         def on_if(node)
           return if allowed_if_condition?(node)
 
@@ -146,10 +161,12 @@ 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)]
 
           report_offense(node, method_chain, method_call, *removal_ranges) do |corrector|
+            corrector.replace(receiver, checked_variable.source) if checked_variable.csend_type?
             corrector.insert_before(method_call.loc.dot, '&') unless method_call.safe_navigation?
           end
         end
@@ -174,12 +191,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 +217,6 @@ module RuboCop
           end
         end
 
-        private
-
         def find_method_chain(node)
           return node unless node&.parent&.call_type?
 
@@ -227,10 +249,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 +270,20 @@ module RuboCop
           end
         end
 
+        def dotless_operator_call?(method_call)
+          return true if dotless_operator_method?(method_call)
+
+          method_call = method_call.parent while method_call.parent.send_type?
+
+          dotless_operator_method?(method_call)
+        end
+
+        def dotless_operator_method?(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 +342,29 @@ 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?)
+          return false unless left.call_type? && right.call_type?
+
+          # Compare receiver and method name, but ignore the difference between
+          # safe navigation method call (`&.`) and dot method call (`.`).
+          left_receiver, left_method, *left_args = left.children
+          right_receiver, right_method, *right_args = right.children
+
+          left_method == right_method &&
+            matching_nodes?(left_receiver, right_receiver) &&
+            left_args == right_args
+        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 +373,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 nil_methods.include?(ancestor.method_name)
-            break false if ancestor == method_chain
+          method.each_ancestor(:send) do |ancestor|
+            return true unless config.cop_enabled?('Lint/SafeNavigationChain')
+            return true if unsafe_method?(node, ancestor)
+            return true if nil_methods.include?(ancestor.method_name)
+            return false if ancestor == method_chain
           end
+          false
         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
 
@@ -361,9 +418,8 @@ module RuboCop
                                                  start_method,
                                                  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?
+            break unless ancestor.type?(:call, :any_block)
+            next if !ancestor.send_type? || ancestor.operator_method?
 
             corrector.insert_before(ancestor.loc.dot, '&')
 

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

@@ -7,6 +7,10 @@ module RuboCop
       # `shuffle.last`, and `shuffle[]` and change them to use
       # `sample` instead.
       #
+      # NOTE: An offense involving a `random:` argument is registered but not autocorrected:
+      # `shuffle` and `sample` consume the given generator differently, so for a seeded generator
+      # the correction would select different elements.
+      #
       # @example
       #   # bad
       #   [1, 2, 3].shuffle.first
@@ -45,10 +49,12 @@ module RuboCop
             range = source_range(shuffle_node, node)
             message = message(shuffle_arg, method, method_args, range)
 
-            add_offense(range, message: message) do |corrector|
-              corrector.replace(
-                source_range(shuffle_node, node), correction(shuffle_arg, method, method_args)
-              )
+            if shuffle_arg.empty?
+              add_offense(range, message: message) do |corrector|
+                corrector.replace(range, correction(shuffle_arg, method, method_args))
+              end
+            else
+              add_offense(range, message: message)
             end
           end
         end
@@ -92,22 +98,22 @@ module RuboCop
           second.int_type? ? second.to_a.first : :unknown
         end
 
-        # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         def range_size(range_node)
-          vals = range_node.to_a
-          return :unknown unless vals.all? { |val| val.nil? || val.int_type? }
-
-          low, high = vals.map { |val| val.nil? ? 0 : val.children[0] }
-          return :unknown unless low.zero? && high >= 0
+          low, high = range_node.to_a
+          # An endless range takes the rest of the collection, whatever its size.
+          return :unknown unless zero_or_beginless?(low) && high&.int_type? && high.value >= 0
 
           case range_node.type
           when :erange
-            (low...high).size
+            high.value
           when :irange
-            (low..high).size
+            high.value + 1
           end
         end
-        # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+        def zero_or_beginless?(low)
+          low.nil? || (low.int_type? && low.value.zero?)
+        end
 
         def source_range(shuffle_node, node)
           shuffle_node.loc.selector.join(node.source_range.end)

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

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Looks for places where a subset of an Enumerable (array,
+      # range, set, etc.; see note below) is calculated based on a class type
+      # check, and suggests `grep` or `grep_v` instead.
+      #
+      # NOTE: Hashes do not behave as you may expect with `grep`, which
+      # means that `hash.grep` is not equivalent to `hash.select`. Although
+      # RuboCop is limited by static analysis, this cop attempts to avoid
+      # registering an offense when the receiver is a hash (hash literal,
+      # `Hash.new`, `Hash#[]`, or `to_h`/`to_hash`).
+      #
+      # @safety
+      #   Autocorrection is marked as unsafe because the cop cannot guarantee
+      #   that the receiver is actually an array by static analysis, so the
+      #   correction may not be actually equivalent.
+      #
+      # @example
+      #   # bad (select or find_all)
+      #   array.select { |x| x.is_a?(Foo) }
+      #   array.select { |x| x.kind_of?(Foo) }
+      #
+      #   # bad (reject)
+      #   array.reject { |x| x.is_a?(Foo) }
+      #
+      #   # bad (negative form)
+      #   array.reject { |x| !x.is_a?(Foo) }
+      #
+      #   # good
+      #   array.grep(Foo)
+      #   array.grep_v(Foo)
+      class SelectByKind < Base
+        extend AutoCorrector
+        include RangeHelp
+
+        MSG = 'Prefer `%<replacement>s` to `%<original_method>s` with a kind check.'
+        RESTRICT_ON_SEND = %i[select filter find_all reject].freeze
+        SELECT_METHODS = %i[select filter find_all].freeze
+        CLASS_CHECK_METHODS = %i[is_a? kind_of?].to_set.freeze
+
+        # @!method class_check?(node)
+        def_node_matcher :class_check?, <<~PATTERN
+          {
+            (block call (args (arg $_)) ${(send (lvar _) %CLASS_CHECK_METHODS _)})
+            (block call (args (arg $_)) ${(send (send (lvar _) %CLASS_CHECK_METHODS _) :!)})
+            (numblock call $1 ${(send (lvar _) %CLASS_CHECK_METHODS _)})
+            (numblock call $1 ${(send (send (lvar _) %CLASS_CHECK_METHODS _) :!)})
+            (itblock call $_ ${(send (lvar _) %CLASS_CHECK_METHODS _)})
+            (itblock call $_ ${(send (send (lvar _) %CLASS_CHECK_METHODS _) :!)})
+          }
+        PATTERN
+
+        # Returns true if a node appears to return a hash
+        # @!method creates_hash?(node)
+        def_node_matcher :creates_hash?, <<~PATTERN
+          {
+            (call (const _ :Hash) {:new :[]} ...)
+            (block (call (const _ :Hash) :new ...) ...)
+            (call _ { :to_h :to_hash } ...)
+          }
+        PATTERN
+
+        # @!method env_const?(node)
+        def_node_matcher :env_const?, <<~PATTERN
+          (const {nil? cbase} :ENV)
+        PATTERN
+
+        # @!method calls_lvar?(node, name)
+        def_node_matcher :calls_lvar?, <<~PATTERN
+          (send (lvar %1) %CLASS_CHECK_METHODS _)
+        PATTERN
+
+        # @!method negated_calls_lvar?(node, name)
+        def_node_matcher :negated_calls_lvar?, <<~PATTERN
+          (send (send (lvar %1) %CLASS_CHECK_METHODS _) :!)
+        PATTERN
+
+        def on_send(node)
+          return unless (block_node = node.block_node)
+          return if block_node.body&.begin_type?
+          return if receiver_allowed?(block_node.receiver)
+          return unless (class_check_send_node = extract_send_node(block_node))
+
+          replacement = replacement(class_check_send_node, node)
+          class_constant = find_class_constant(class_check_send_node)
+
+          register_offense(node, block_node, class_constant, replacement)
+        end
+        alias on_csend on_send
+
+        private
+
+        def receiver_allowed?(node)
+          return false unless node
+
+          node.hash_type? || creates_hash?(node) || env_const?(node)
+        end
+
+        def replacement(class_check_send_node, node)
+          negated = negated?(class_check_send_node)
+
+          method_name = node.method_name
+
+          if SELECT_METHODS.include?(method_name)
+            negated ? 'grep_v' : 'grep'
+          else # reject
+            negated ? 'grep' : 'grep_v'
+          end
+        end
+
+        def register_offense(node, block_node, class_constant, replacement)
+          message = format(MSG, replacement: replacement, original_method: node.method_name)
+
+          add_offense(block_node, message: message) do |corrector|
+            if class_constant
+              range = range_between(node.loc.selector.begin_pos, block_node.loc.end.end_pos)
+              corrector.replace(range, "#{replacement}(#{class_constant.source})")
+            end
+          end
+        end
+
+        def extract_send_node(block_node)
+          return unless (block_arg_name, class_check_send_node = class_check?(block_node))
+
+          block_arg_name = :"_#{block_arg_name}" if block_node.numblock_type?
+          block_arg_name = :it if block_node.type?(:itblock)
+
+          inner_node = unwrap_negation(class_check_send_node)
+
+          if calls_lvar?(inner_node, block_arg_name) ||
+             negated_calls_lvar?(class_check_send_node, block_arg_name)
+            class_check_send_node
+          end
+        end
+
+        def negated?(class_check_send_node)
+          class_check_send_node.send_type? && class_check_send_node.method?(:!)
+        end
+
+        def unwrap_negation(node)
+          if node.send_type? && node.method?(:!)
+            node.receiver
+          else
+            node
+          end
+        end
+
+        def find_class_constant(node)
+          inner_node = unwrap_negation(node)
+          inner_node.first_argument if inner_node.send_type?
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Looks for places where a subset of an Enumerable (array,
+      # range, set, etc.; see note below) is calculated based on a range
+      # check, and suggests `grep` or `grep_v` instead.
+      #
+      # NOTE: Hashes do not behave as you may expect with `grep`, which
+      # means that `hash.grep` is not equivalent to `hash.select`. Although
+      # RuboCop is limited by static analysis, this cop attempts to avoid
+      # registering an offense when the receiver is a hash (hash literal,
+      # `Hash.new`, `Hash#[]`, or `to_h`/`to_hash`).
+      #
+      # @safety
+      #   Autocorrection is marked as unsafe because the cop cannot guarantee
+      #   that the receiver is actually an array by static analysis, so the
+      #   correction may not be actually equivalent.
+      #
+      # @example
+      #   # bad (select or find_all)
+      #   array.select { |x| x.between?(1, 10) }
+      #   array.select { |x| (1..10).cover?(x) }
+      #   array.select { |x| (1..10).include?(x) }
+      #
+      #   # bad (reject)
+      #   array.reject { |x| x.between?(1, 10) }
+      #
+      #   # bad (find or detect)
+      #   array.find { |x| x.between?(1, 10) }
+      #   array.detect { |x| (1..10).cover?(x) }
+      #
+      #   # bad (negative form)
+      #   array.reject { |x| !x.between?(1, 10) }
+      #   array.find { |x| !(1..10).cover?(x) }
+      #
+      #   # good
+      #   array.grep(1..10)
+      #   array.grep_v(1..10)
+      #   array.grep(1..10).first
+      #   array.grep_v(1..10).first
+      class SelectByRange < Base
+        extend AutoCorrector
+        include RangeHelp
+
+        MSG = 'Prefer `%<replacement>s` to `%<original_method>s` with a range check.'
+        RESTRICT_ON_SEND = %i[select filter find_all reject find detect].freeze
+        SELECT_METHODS = %i[select filter find_all].freeze
+        FIND_METHODS = %i[find detect].freeze
+
+        # @!method range_check?(node)
+        # Matches: x.between?(min, max) or (min..max).cover?(x) or (min..max).include?(x)
+        def_node_matcher :range_check?, <<~PATTERN
+          {
+            (block call (args (arg $_)) ${(send (lvar _) :between? _ _)})
+            (block call (args (arg $_)) ${(send {range (begin range)} {:cover? :include?} (lvar _))})
+            (block call (args (arg $_)) ${(send (send (lvar _) :between? _ _) :!)})
+            (block call (args (arg $_)) ${(send (send {range (begin range)} {:cover? :include?} (lvar _)) :!)})
+            (block call (args (arg $_)) ${(send (begin (send (lvar _) :between? _ _)) :!)})
+            (block call (args (arg $_)) ${(send (begin (send {range (begin range)} {:cover? :include?} (lvar _))) :!)})
+            (numblock call $1 ${(send (lvar _) :between? _ _)})
+            (numblock call $1 ${(send {range (begin range)} {:cover? :include?} (lvar _))})
+            (numblock call $1 ${(send (send (lvar _) :between? _ _) :!)})
+            (numblock call $1 ${(send (send {range (begin range)} {:cover? :include?} (lvar _)) :!)})
+            (numblock call $1 ${(send (begin (send (lvar _) :between? _ _)) :!)})
+            (numblock call $1 ${(send (begin (send {range (begin range)} {:cover? :include?} (lvar _))) :!)})
+            (itblock call $_ ${(send (lvar _) :between? _ _)})
+            (itblock call $_ ${(send {range (begin range)} {:cover? :include?} (lvar _))})
+            (itblock call $_ ${(send (send (lvar _) :between? _ _) :!)})
+            (itblock call $_ ${(send (send {range (begin range)} {:cover? :include?} (lvar _)) :!)})
+            (itblock call $_ ${(send (begin (send (lvar _) :between? _ _)) :!)})
+            (itblock call $_ ${(send (begin (send {range (begin range)} {:cover? :include?} (lvar _))) :!)})
+          }
+        PATTERN
+
+        # Returns true if a node appears to return a hash
+        # @!method creates_hash?(node)
+        def_node_matcher :creates_hash?, <<~PATTERN
+          {
+            (call (const _ :Hash) {:new :[]} ...)
+            (block (call (const _ :Hash) :new ...) ...)
+            (call _ { :to_h :to_hash } ...)
+          }
+        PATTERN
+
+        # @!method env_const?(node)
+        def_node_matcher :env_const?, <<~PATTERN
+          (const {nil? cbase} :ENV)
+        PATTERN
+
+        # @!method between_call?(node, name)
+        def_node_matcher :between_call?, <<~PATTERN
+          (send (lvar %1) :between? _ _)
+        PATTERN
+
+        # @!method range_cover_call?(node, name)
+        def_node_matcher :range_cover_call?, <<~PATTERN
+          (send {range (begin range)} {:cover? :include?} (lvar %1))
+        PATTERN
+
+        def on_send(node)
+          return unless (block_node = node.block_node)
+          return if block_node.body&.begin_type?
+          return if receiver_allowed?(block_node.receiver)
+          return unless (range_check_send_node = extract_send_node(block_node))
+
+          replacement = replacement(range_check_send_node, node)
+          range_literal = find_range(range_check_send_node)
+
+          register_offense(node, block_node, range_literal, replacement)
+        end
+        alias on_csend on_send
+
+        private
+
+        def receiver_allowed?(node)
+          return false unless node
+
+          node.hash_type? || creates_hash?(node) || env_const?(node)
+        end
+
+        def replacement(range_check_send_node, node)
+          negated = negated?(range_check_send_node)
+          method_name = node.method_name
+
+          if SELECT_METHODS.include?(method_name)
+            negated ? 'grep_v' : 'grep'
+          elsif FIND_METHODS.include?(method_name)
+            negated ? 'grep_v(...).first' : 'grep(...).first'
+          else # reject
+            negated ? 'grep' : 'grep_v'
+          end
+        end
+
+        def register_offense(node, block_node, range_literal, replacement)
+          message = format(MSG, replacement: replacement, original_method: node.method_name)
+
+          add_offense(block_node, message: message) do |corrector|
+            if range_literal
+              range = range_between(node.loc.selector.begin_pos, block_node.loc.end.end_pos)
+              grep_method = replacement.include?('grep_v') ? 'grep_v' : 'grep'
+              suffix = replacement.include?('.first') ? '.first' : ''
+              corrector.replace(range, "#{grep_method}(#{range_literal})#{suffix}")
+            end
+          end
+        end
+
+        def extract_send_node(block_node)
+          return unless (block_arg_name, range_check_send_node = range_check?(block_node))
+
+          block_arg_name = :"_#{block_arg_name}" if block_node.numblock_type?
+          block_arg_name = :it if block_node.type?(:itblock)
+
+          inner_node = unwrap_negation(range_check_send_node)
+
+          range_check_send_node if calls_lvar_in_range_check?(inner_node, block_arg_name)
+        end
+
+        def calls_lvar_in_range_check?(node, block_arg_name)
+          between_call?(node, block_arg_name) || range_cover_call?(node, block_arg_name)
+        end
+
+        def negated?(range_check_send_node)
+          range_check_send_node.send_type? && range_check_send_node.method?(:!)
+        end
+
+        def unwrap_negation(node)
+          if node.send_type? && node.method?(:!)
+            receiver = node.receiver
+            receiver = receiver.children.first if receiver.begin_type?
+            receiver
+          else
+            node
+          end
+        end
+
+        def find_range(node)
+          inner = unwrap_negation(node)
+
+          if inner.method?(:between?)
+            # x.between?(min, max) -> min..max
+            min = inner.first_argument.source
+            max = inner.arguments[1].source
+            "#{min}..#{max}"
+          else
+            # (min..max).cover?(x) or (min..max).include?(x)
+            receiver = inner.receiver
+            # Unwrap begin node from parentheses
+            receiver = receiver.children.first if receiver.begin_type?
+            receiver.source
+          end
+        end
+      end
+    end
+  end
+end