rubocop 1.53.0 → 1.90.0

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

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
-require 'tsort'
-
 module RuboCop
   module Cop
     module Style
       # Checks for simple usages of parallel assignment.
+      # Parallel assignment is less readable than individual
+      # assignments and makes it harder to follow what each
+      # variable is being set to.
+      #
       # This will only complain when the number of variables
       # being assigned matched the number of assigning variables.
       #
@@ -16,7 +18,7 @@ module RuboCop
       #
       #   # good
       #   one, two = *foo
-      #   a, b = foo()
+      #   a, b = foo
       #   a, b = b, a
       #
       #   a = 1
@@ -28,28 +30,28 @@ module RuboCop
 
         MSG = 'Do not use parallel assignment.'
 
-        def on_masgn(node)
-          lhs, rhs = *node
-          lhs_elements = *lhs
+        def on_masgn(node) # rubocop:disable Metrics/AbcSize
+          return if part_of_ignored_node?(node)
+
+          rhs = node.rhs
           rhs = rhs.body if rhs.rescue_type?
           rhs_elements = Array(rhs).compact # edge case for one constant
 
-          return if allowed_lhs?(lhs) || allowed_rhs?(rhs) ||
-                    allowed_masign?(lhs_elements, rhs_elements)
+          return if allowed_lhs?(node.assignments) || allowed_rhs?(rhs) ||
+                    allowed_masign?(node.assignments, rhs_elements) || contains_heredoc?(rhs)
 
           range = node.source_range.begin.join(rhs.source_range.end)
 
           add_offense(range) do |corrector|
-            autocorrect(corrector, node, lhs, rhs)
+            autocorrect(corrector, node, rhs)
           end
+          ignore_node(node)
         end
 
         private
 
-        def autocorrect(corrector, node, lhs, rhs)
-          left_elements = *lhs
-          right_elements = Array(rhs).compact
-          order = find_valid_order(left_elements, right_elements)
+        def autocorrect(corrector, node, rhs)
+          order = find_valid_order(node.assignments, Array(rhs).compact)
           correction = assignment_corrector(node, rhs, order)
 
           corrector.replace(correction.correction_range, correction.correction)
@@ -61,9 +63,7 @@ module RuboCop
                               add_self_to_getters(rhs_elements))
         end
 
-        def allowed_lhs?(node)
-          elements = *node
-
+        def allowed_lhs?(elements)
           # Account for edge cases using one variable with a comma
           # E.g.: `foo, = *bar`
           elements.one? || elements.any?(&:splat_type?)
@@ -74,11 +74,14 @@ module RuboCop
           elements = Array(node).compact
 
           # Account for edge case of `Constant::CONSTANT`
-          !node.array_type? || return_of_method_call?(node) || elements.any?(&:splat_type?)
+          !node.array_type? || elements.any?(&:splat_type?)
         end
 
-        def return_of_method_call?(node)
-          node.block_type? || node.send_type?
+        # Autocorrection splits the assignment into single assignments on
+        # consecutive lines, which would put following assignments into the
+        # heredoc body unless the heredoc bodies were moved along.
+        def contains_heredoc?(node)
+          node.each_descendant(:any_str).any?(&:heredoc?)
         end
 
         def assignment_corrector(node, rhs, order)
@@ -100,15 +103,9 @@ module RuboCop
         def find_valid_order(left_elements, right_elements)
           # arrange left_elements in an order such that no corresponding right
           # element refers to a left element earlier in the sequence
-          # this can be done using an algorithm called a "topological sort"
-          # fortunately for us, Ruby's stdlib contains an implementation
           assignments = left_elements.zip(right_elements)
 
-          begin
-            AssignmentSorter.new(assignments).tsort
-          rescue TSort::Cyclic
-            nil
-          end
+          AssignmentSorter.new(assignments).tsort
         end
 
         # Converts (send nil :something) nodes to (send (:self) :something).
@@ -123,10 +120,9 @@ module RuboCop
         # @!method implicit_self_getter?(node)
         def_node_matcher :implicit_self_getter?, '(send nil? $_)'
 
-        # Helper class necessitated by silly design of TSort prior to Ruby 2.1
-        # Newer versions have a better API, but that doesn't help us
+        # Topologically sorts the assignments with Kahn's algorithm.
+        # https://en.wikipedia.org/wiki/Topological_sorting#Kahn's_algorithm
         class AssignmentSorter
-          include TSort
           extend RuboCop::NodePattern::Macros
 
           # @!method var_name(node)
@@ -142,21 +138,39 @@ module RuboCop
             @assignments = assignments
           end
 
-          def tsort_each_node(&block)
-            @assignments.each(&block)
+          def tsort
+            dependencies = @assignments.to_h do |assignment|
+              [assignment, dependencies_for_assignment(assignment)]
+            end
+            result = []
+
+            while (matched_node, = dependencies.find { |_node, edges| edges.empty? })
+              dependencies.delete(matched_node)
+              result.push(matched_node)
+
+              dependencies.each do |node, edges|
+                dependencies[node].delete(matched_node) if edges.include?(matched_node)
+              end
+            end
+            # Cyclic dependency
+            return nil if dependencies.any?
+
+            result
           end
 
-          def tsort_each_child(assignment)
-            # yield all the assignments which must come after `assignment`
-            # (due to dependencies on the previous value of the assigned var)
+          # Returns all the assignments which must come after `assignment`
+          # (due to dependencies on the previous value of the assigned var)
+          def dependencies_for_assignment(assignment)
             my_lhs, _my_rhs = *assignment
 
-            @assignments.each do |other|
-              _other_lhs, other_rhs = *other
+            @assignments.filter_map do |other|
+              # Exclude self, there are no dependencies in cases such as `a, b = a, b`.
+              next if other == assignment
 
+              _other_lhs, other_rhs = *other
               next unless dependency?(my_lhs, other_rhs)
 
-              yield other
+              other
             end
           end
 
@@ -170,9 +184,8 @@ module RuboCop
           def accesses?(rhs, lhs)
             if lhs.method?(:[]=)
               # FIXME: Workaround `rubocop:disable` comment for JRuby.
-              # rubocop:disable Performance/RedundantEqualityComparisonBlock
+              # rubocop:disable-next Performance/RedundantEqualityComparisonBlock
               matching_calls(rhs, lhs.receiver, :[]).any? { |args| args == lhs.arguments }
-              # rubocop:enable Performance/RedundantEqualityComparisonBlock
             else
               access_method = lhs.method_name.to_s.chop.to_sym
               matching_calls(rhs, lhs.receiver, access_method).any?
@@ -211,21 +224,31 @@ module RuboCop
           protected
 
           def assignment
-            @new_elements.map { |lhs, rhs| "#{lhs.source} = #{source(rhs)}" }
+            @new_elements.map { |lhs, rhs| "#{lhs.source} = #{source(rhs, rhs.loc)}" }
           end
 
           private
 
-          def source(node)
-            if node.str_type? && node.loc.begin.nil?
-              "'#{node.source}'"
-            elsif node.sym_type? && node.loc.begin.nil?
-              ":#{node.source}"
+          def source(node, loc)
+            # __FILE__ is treated as a StrNode but has no begin
+            if node.str_type? && loc.respond_to?(:begin) && loc.begin.nil?
+              # `%w` elements have no per-element delimiter, so the value must be
+              # quoted and escaped to stay valid (e.g. `%w(it's)` -> `'it\'s'`).
+              quote(node.value)
+            elsif node.sym_type? && !node.loc?(:begin)
+              # `%i` elements have no per-element delimiter, so a symbol that needs
+              # quoting must be emitted as `:"..."` (e.g. `%i(foo-bar)` -> `:"foo-bar"`),
+              # otherwise `:foo-bar` would parse as `:foo.-(bar)`.
+              node.value.inspect
             else
               node.source
             end
           end
 
+          def quote(string)
+            "'#{string.gsub(/[\\']/) { |char| "\\#{char}" }}'"
+          end
+
           def extract_sources(node)
             node.children.map(&:source)
           end
@@ -289,9 +312,7 @@ module RuboCop
           private
 
           def modifier_range(node)
-            Parser::Source::Range.new(node.source_range.source_buffer,
-                                      node.loc.keyword.begin_pos,
-                                      node.source_range.end_pos)
+            node.loc.keyword.join(node.source_range.end)
           end
         end
       end

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

@@ -81,6 +81,7 @@ module RuboCop
           cond = node.condition
 
           control_op_condition(cond) do |first_child, rest_children|
+            return if require_parentheses?(node, first_child)
             return if semicolon_separated_expressions?(first_child, rest_children)
             return if modifier_op?(first_child)
             return if parens_allowed?(cond)
@@ -92,6 +93,13 @@ module RuboCop
           end
         end
 
+        def require_parentheses?(node, condition_body)
+          return false unless node.type?(:while, :until)
+          return false unless condition_body.any_block_type?
+
+          condition_body.send_node.block_literal? && condition_body.keywords?
+        end
+
         def semicolon_separated_expressions?(first_exp, rest_exps)
           return false unless (second_exp = rest_exps.first)
 

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
@@ -99,7 +101,9 @@ module RuboCop
         def string_source(node)
           if node.is_a?(String)
             node.scrub
-          elsif node.respond_to?(:type) && (node.str_type? || node.sym_type?)
+          elsif node.is_a?(Symbol)
+            node.to_s
+          elsif node.respond_to?(:type) && node.type?(:str, :sym)
             node.source
           end
         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