rubocop 1.71.1 → 1.92.1

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

@@ -0,0 +1,270 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Checks for consecutive calls to `select`/`filter`/`find_all` and `reject`
+      # on the same receiver with the same block body, where `partition` could be
+      # used instead. Also detects two `select` or two `reject` calls where one
+      # block negates the other with `!`. Using `partition` reduces two collection
+      # traversals to one.
+      #
+      # @safety
+      #   This cop is unsafe because:
+      #
+      #   * `Hash#select` and `Hash#reject` return hashes, but `Hash#partition`
+      #     returns nested arrays.
+      #   * When the receiver has side effects, calling it once (with `partition`)
+      #     versus twice (with `select` + `reject`) may produce different results.
+      #   * Custom classes may override `select`/`reject` without providing a
+      #     compatible `partition` method.
+      #
+      # @example
+      #   # bad
+      #   positives = array.select { |x| x > 0 }
+      #   negatives = array.reject { |x| x > 0 }
+      #
+      #   # bad
+      #   positives = array.filter { |x| x > 0 }
+      #   negatives = array.reject { |x| x > 0 }
+      #
+      #   # bad
+      #   negatives = array.reject { |x| x > 0 }
+      #   positives = array.select { |x| x > 0 }
+      #
+      #   # bad
+      #   positives = array.select(&:positive?)
+      #   negatives = array.reject(&:positive?)
+      #
+      #   # bad
+      #   positives = array.select(&:positive?)
+      #   negatives = array.reject { |x| x.positive? }
+      #
+      #   # bad
+      #   positives = array.select { |x| x.positive? }
+      #   non_positives = array.select { |x| !x.positive? }
+      #
+      #   # good
+      #   positives, negatives = array.partition { |x| x > 0 }
+      #
+      #   # good
+      #   positives, non_positives = array.partition { |x| x.positive? }
+      #
+      #   # good
+      #   positives, negatives = array.partition(&:positive?)
+      #
+      class PartitionInsteadOfDoubleSelect < Base
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = 'Use `partition` instead of consecutive `%<first>s` and `%<second>s` calls.'
+
+        SELECT_METHODS = %i[select filter find_all].freeze
+        CANDIDATE_METHODS = (SELECT_METHODS + %i[reject]).to_set.freeze
+        RESTRICT_ON_SEND = (SELECT_METHODS + %i[reject]).freeze
+
+        # @!method symbol_proc_method?(node)
+        def_node_matcher :symbol_proc_method?, <<~PATTERN
+          (block _ (args (arg _name)) (send (lvar _name) $_method_name))
+        PATTERN
+
+        def on_block(node)
+          return unless CANDIDATE_METHODS.include?(node.method_name)
+
+          find_and_register_offense(node)
+        end
+        alias on_numblock on_block
+        alias on_itblock on_block
+
+        def on_send(node)
+          return unless node.last_argument&.block_pass_type?
+
+          find_and_register_offense(node)
+        end
+        alias on_csend on_send
+
+        private
+
+        def find_and_register_offense(node)
+          container = node_container(node)
+          return unless container
+
+          sibling_container = container.left_sibling
+          sibling = find_matching_candidate(node, sibling_container)
+          return unless sibling
+
+          register_offense(node, sibling, container, sibling_container)
+        end
+
+        def node_container(node)
+          parent = node.parent
+          if parent&.begin_type?
+            node
+          elsif parent&.assignment? && parent.parent&.begin_type?
+            parent
+          end
+        end
+
+        def find_matching_candidate(node, sibling_container)
+          return unless sibling_container
+
+          sibling = extract_candidate(sibling_container)
+          return unless sibling
+          return unless node.receiver == sibling.receiver
+          return unless matching_pair?(node, sibling)
+
+          sibling
+        end
+
+        def matching_pair?(node, sibling)
+          (complementary_pair?(node, sibling) && equivalent_predicate?(node, sibling)) ||
+            (node.method?(sibling.method_name) && negated_predicate?(node, sibling))
+        end
+
+        def extract_candidate(container)
+          extract_block(container) || extract_block_pass_send(container)
+        end
+
+        def extract_block(container)
+          if container.any_block_type?
+            container
+          elsif container.assignment?
+            rhs = container.children.last
+            rhs if rhs&.any_block_type?
+          end
+        end
+
+        def extract_block_pass_send(container)
+          node = container.assignment? ? container.children.last : container
+          return unless node&.type?(:call)
+          return unless node.last_argument&.block_pass_type?
+
+          node
+        end
+
+        def complementary_pair?(node1, node2)
+          m1 = node1.method_name
+          m2 = node2.method_name
+          (SELECT_METHODS.include?(m1) && m2 == :reject) ||
+            (m1 == :reject && SELECT_METHODS.include?(m2))
+        end
+
+        def equivalent_predicate?(node1, node2)
+          if node1.any_block_type? && node2.any_block_type?
+            same_block_contents?(node1, node2)
+          elsif node1.any_block_type?
+            block_matches_block_pass?(node1, node2)
+          elsif node2.any_block_type?
+            block_matches_block_pass?(node2, node1)
+          else
+            node1.last_argument == node2.last_argument
+          end
+        end
+
+        def same_block_contents?(block1, block2)
+          return false unless block1.type == block2.type
+
+          if block1.block_type?
+            block1.arguments == block2.arguments &&
+              block1.body == block2.body
+          else
+            block1.body == block2.body
+          end
+        end
+
+        def block_matches_block_pass?(block_node, send_node)
+          method_name = symbol_proc_method?(block_node)
+          return false unless method_name
+
+          sym_node = send_node.last_argument.children.first
+          sym_node.sym_type? && sym_node.children.first == method_name
+        end
+
+        def negated_predicate?(node1, node2)
+          return false unless node1.any_block_type? && node2.any_block_type?
+          return false unless node1.type == node2.type
+          return false if node1.block_type? && node1.arguments != node2.arguments
+
+          negated_body?(node1.body, node2.body) || negated_body?(node2.body, node1.body)
+        end
+
+        def negated_body?(body1, body2)
+          body1&.send_type? && body1.method?(:!) && body1.receiver == body2
+        end
+
+        def register_offense(node, sibling, container, sibling_container)
+          message = format(MSG, first: sibling.method_name, second: node.method_name)
+
+          add_offense(container, message: message) do |corrector|
+            next unless both_lvasgn?(container, sibling_container)
+
+            autocorrect(corrector, node, sibling, container, sibling_container)
+          end
+        end
+
+        def both_lvasgn?(container, sibling_container)
+          container.lvasgn_type? && sibling_container.lvasgn_type?
+        end
+
+        def autocorrect(corrector, node, sibling, container, sibling_container)
+          if complementary_pair?(node, sibling)
+            select_var, reject_var =
+              complementary_variable_order(sibling, container, sibling_container)
+            partition_node = select_node_for(sibling, container)
+          else
+            select_var, reject_var, partition_node =
+              negation_partition_args(node, sibling, container, sibling_container)
+          end
+
+          partition_call = build_partition_call(partition_node)
+          replacement = "#{select_var}, #{reject_var} = #{partition_call}"
+
+          corrector.replace(sibling_container, replacement)
+          range = range_by_whole_lines(container.source_range, include_final_newline: true)
+          corrector.remove(range)
+        end
+
+        def complementary_variable_order(sibling, container, sibling_container)
+          if SELECT_METHODS.include?(sibling.method_name)
+            [sibling_container.children.first, container.children.first]
+          else
+            [container.children.first, sibling_container.children.first]
+          end
+        end
+
+        def negation_partition_args(node, sibling, container, sibling_container)
+          node_is_negated = negated_body?(node.body, sibling.body)
+          is_select = SELECT_METHODS.include?(node.method_name)
+          # For select: non-negated is truthy (first). For reject: negated is truthy (first).
+          node_is_truthy = is_select != node_is_negated
+          partition_node = node_is_negated ? sibling : node
+
+          if node_is_truthy
+            [container.children.first, sibling_container.children.first, partition_node]
+          else
+            [sibling_container.children.first, container.children.first, partition_node]
+          end
+        end
+
+        def select_node_for(sibling, container)
+          if SELECT_METHODS.include?(sibling.method_name)
+            sibling
+          else
+            container.children.last
+          end
+        end
+
+        def build_partition_call(node)
+          source = node.source
+          send_node = node.any_block_type? ? node.send_node : node
+          selector = send_node.loc.selector
+          offset = node.source_range.begin_pos
+          method_start = selector.begin_pos - offset
+          method_end = selector.end_pos - offset
+
+          "#{source[0...method_start]}partition#{source[method_end..]}"
+        end
+      end
+    end
+  end
+end

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

@@ -4,6 +4,8 @@ module RuboCop
   module Cop
     module Style
       # Enforces the consistent usage of `%`-literal delimiters.
+      # Using consistent delimiters across the codebase reduces
+      # cognitive load when reading `%`-literals.
       #
       # Specify the 'default' key to set all preferred delimiters at once. You
       # can continue to specify individual preferred delimiters to override the
@@ -84,10 +86,21 @@ module RuboCop
         end
 
         def include_same_character_as_used_for_delimiter?(node, type)
-          return false unless %w[%w %i].include?(type)
-
           used_delimiters = matchpairs(begin_source(node)[-1])
-          contains_delimiter?(node, used_delimiters)
+          return contains_delimiter?(node, used_delimiters) if %w[%w %i].include?(type)
+          return false unless %w[%q %s %r].include?(type)
+
+          contains_escaped_delimiter?(node, used_delimiters)
+        end
+
+        # Without interpolation an escaped delimiter means something different
+        # once the delimiters change (`%q!it\!s!` is `"it!s"`, but `%q(it\!s)`
+        # is `"it\\!s"`). For a regexp the match stays the same, but its source
+        # changes. Interpolating literals read `\!` as `!` with any delimiter.
+        def contains_escaped_delimiter?(node, delimiters)
+          body = node.loc.begin.end.join(node.loc.end.begin).source
+
+          body.scan(/\\./m).any? { |escape| delimiters.include?(escape[1]) }
         end
 
         def contains_delimiter?(node, delimiters)
@@ -99,6 +112,8 @@ module RuboCop
         def string_source(node)
           if node.is_a?(String)
             node.scrub
+          elsif node.is_a?(Symbol)
+            node.to_s
           elsif node.respond_to?(:type) && node.type?(:str, :sym)
             node.source
           end

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

@@ -45,7 +45,7 @@ module RuboCop
           # Report offense only if changing case doesn't change semantics,
           # i.e., if the string would become dynamic or has special characters.
           ast = parse(corrected(node.source)).ast
-          return if node.children != ast.children
+          return if node.children != ast&.children
 
           add_offense(node.loc.begin) do |corrector|
             corrector.replace(node, corrected(node.source))

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

@@ -5,7 +5,7 @@ module RuboCop
     module Style
       # Looks for uses of Perl-style regexp match
       # backreferences and their English versions like
-      # $1, $2, $&, &+, $MATCH, $PREMATCH, etc.
+      # $1, $2, $&, $MATCH, $PREMATCH, etc.
       #
       # @example
       #   # bad
@@ -69,6 +69,10 @@ module RuboCop
         # @return [String, nil]
         def preferred_expression_to(node)
           first = node.to_a.first
+          # NOTE: `$+` / `$LAST_PAREN_MATCH` is deliberately not converted. It
+          # refers to the last group that actually matched, which has no concise
+          # `Regexp.last_match` equivalent (`Regexp.last_match(-1)` is the last
+          # group in the pattern, which may be `nil`).
           case first
           when ::Integer
             "Regexp.last_match(#{first})"
@@ -78,8 +82,6 @@ module RuboCop
             'Regexp.last_match.pre_match'
           when :$', :$POSTMATCH
             'Regexp.last_match.post_match'
-          when :$+, :$LAST_PAREN_MATCH
-            'Regexp.last_match(-1)'
           end
         end
 

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Looks for uses of `any?`, `all?`, `none?`, or `one?` with a block
+      # containing only an `is_a?`, `kind_of?`, or `instance_of?` check, and
+      # suggests using the predicate method with the class argument directly.
+      #
+      # @safety
+      #   This cop is unsafe because `instance_of?` checks for an exact class
+      #   match, while the pattern argument uses `===` which also matches
+      #   subclasses. For `is_a?` and `kind_of?`, the behavior is equivalent.
+      #
+      # @example
+      #   # bad
+      #   array.any? { |x| x.is_a?(Integer) }
+      #   array.all? { |x| x.kind_of?(String) }
+      #   array.none? { |x| x.is_a?(Float) }
+      #   array.one? { |x| x.instance_of?(Symbol) }
+      #
+      #   # good
+      #   array.any?(Integer)
+      #   array.all?(String)
+      #   array.none?(Float)
+      #   array.one?(Symbol)
+      class PredicateWithKind < Base
+        extend AutoCorrector
+        include RangeHelp
+
+        MSG = 'Prefer `%<replacement>s` to `%<original>s` with a kind check.'
+        RESTRICT_ON_SEND = %i[any? all? none? one?].freeze
+        KIND_METHODS = %i[is_a? kind_of? instance_of?].to_set.freeze
+
+        # @!method kind_check?(node)
+        def_node_matcher :kind_check?, <<~PATTERN
+          {
+            (block call (args (arg $_)) $(send (lvar _) %KIND_METHODS _))
+            (numblock call $1 $(send (lvar _) %KIND_METHODS _))
+            (itblock call $_ $(send (lvar _) %KIND_METHODS _))
+          }
+        PATTERN
+
+        # @!method kind_call?(node, name)
+        def_node_matcher :kind_call?, <<~PATTERN
+          (send (lvar %1) %KIND_METHODS _)
+        PATTERN
+
+        def on_send(node)
+          return unless (block_node = node.block_node)
+          return if block_node.body&.begin_type?
+          return unless (kind_check_node = extract_send_node(block_node))
+
+          klass = kind_check_node.first_argument
+          replacement = "#{node.method_name}(#{klass.source})"
+
+          register_offense(node, block_node, klass, replacement)
+        end
+        alias on_csend on_send
+
+        private
+
+        def extract_send_node(block_node)
+          return unless (block_arg_name, kind_check_node = kind_check?(block_node))
+
+          block_arg_name = :"_#{block_arg_name}" if block_node.numblock_type?
+          block_arg_name = :it if block_node.type?(:itblock)
+
+          kind_check_node if kind_call?(kind_check_node, block_arg_name)
+        end
+
+        def register_offense(node, block_node, klass, replacement)
+          original = "#{node.method_name} { ... }"
+          message = format(MSG, replacement: replacement, original: original)
+
+          add_offense(block_node, message: message) do |corrector|
+            range = range_between(node.loc.selector.begin_pos, block_node.loc.end.end_pos)
+            corrector.replace(range, "#{node.method_name}(#{klass.source})")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -14,22 +14,22 @@ module RuboCop
       #   is a `Hash` or responds to the replacement methods.
       #
       # @example EnforcedStyle: short (default)
-      #  # bad
-      #  Hash#has_key?
-      #  Hash#has_value?
+      #   # bad
+      #   Hash#has_key?
+      #   Hash#has_value?
       #
-      #  # good
-      #  Hash#key?
-      #  Hash#value?
+      #   # good
+      #   Hash#key?
+      #   Hash#value?
       #
       # @example EnforcedStyle: verbose
-      #  # bad
-      #  Hash#key?
-      #  Hash#value?
+      #   # bad
+      #   Hash#key?
+      #   Hash#value?
       #
-      #  # good
-      #  Hash#has_key?
-      #  Hash#has_value?
+      #   # good
+      #   Hash#has_key?
+      #   Hash#has_value?
       class PreferredHashMethods < Base
         include ConfigurableEnforcedStyle
         extend AutoCorrector

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

@@ -3,8 +3,9 @@
 module RuboCop
   module Cop
     module Style
-      # Checks for uses of Proc.new where Kernel#proc
-      # would be more appropriate.
+      # Checks for uses of `Proc.new` where `Kernel#proc`
+      # would be more appropriate. `proc` is the shorter and
+      # more idiomatic way to create procs in Ruby.
       #
       # @example
       #   # bad
@@ -30,6 +31,7 @@ module RuboCop
         end
 
         alias on_numblock on_block
+        alias on_itblock on_block
       end
     end
   end

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

@@ -3,15 +3,15 @@
 module RuboCop
   module Cop
     module Style
-      # Checks the args passed to `fail` and `raise`. For exploded
-      # style (default), it recommends passing the exception class and message
-      # to `raise`, rather than construct an instance of the error. It will
-      # still allow passing just a message, or the construction of an error
-      # with more than one argument.
+      # Checks the args passed to `fail` and `raise`.
       #
-      # The exploded style works identically, but with the addition that it
-      # will also suggest constructing error objects when the exception is
-      # passed multiple arguments.
+      # Exploded style (default) enforces passing the exception class and message
+      # arguments separately, rather than constructing an instance of the error.
+      #
+      # Compact style enforces constructing an error instance.
+      #
+      # Both styles allow passing just a message, or an error instance when there is more
+      # than one argument.
       #
       # The exploded style has an `AllowedCompactTypes` configuration
       # option that takes an `Array` of exception name Strings.
@@ -51,7 +51,7 @@ module RuboCop
         EXPLODED_MSG = 'Provide an exception class and message as arguments to `%<method>s`.'
         COMPACT_MSG = 'Provide an exception object as an argument to `%<method>s`.'
         ACCEPTABLE_ARG_TYPES = %i[
-          hash forwarded_restarg splat forwarded_restarg forwarded_args
+          hash forwarded_restarg splat forwarded_kwrestarg forwarded_args
         ].freeze
 
         RESTRICT_ON_SEND = %i[raise fail].freeze
@@ -101,10 +101,7 @@ module RuboCop
             return if exception.send_type? && exception.first_argument&.hash_type?
 
             add_offense(node, message: format(COMPACT_MSG, method: node.method_name)) do |corrector|
-              replacement = correction_exploded_to_compact(node)
-
-              corrector.replace(node, replacement)
-              opposite_style_detected
+              replace_raise(corrector, node, correction_exploded_to_compact(node))
             end
           else
             correct_style_detected
@@ -121,13 +118,22 @@ module RuboCop
           return if allowed_non_exploded_type?(first_arg)
 
           add_offense(node, message: format(EXPLODED_MSG, method: node.method_name)) do |corrector|
-            replacement = correction_compact_to_exploded(node)
-
-            corrector.replace(node, replacement)
-            opposite_style_detected
+            replace_raise(corrector, node, correction_compact_to_exploded(node))
           end
         end
 
+        def replace_raise(corrector, node, replacement)
+          opposite_style_detected
+          return if inside_corrected_raise?(node)
+
+          corrector.replace(node, replacement)
+          ignore_node(node)
+        end
+
+        def inside_corrected_raise?(node)
+          node.each_ancestor(:send).any? { |ancestor| ignored_node?(ancestor) }
+        end
+
         def use_new_method?(first_arg)
           first_arg.send_type? && first_arg.receiver && first_arg.method?(:new)
         end
@@ -152,7 +158,11 @@ module RuboCop
         end
 
         def requires_parens?(parent)
-          parent.operator_keyword? || (parent.if_type? && parent.ternary?)
+          return true if parent.operator_keyword?
+          return true if parent.type?(:call, :super, :yield, :array, :pair)
+          return true if parent.any_def_type? && parent.endless?
+
+          parent.if_type? && parent.ternary?
         end
       end
     end