rubocop 1.68.0 → 1.69.0

data/lib/rubocop/cop/mixin/check_single_line_suitability.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # Checks for code on multiple lines that could be rewritten on a single line
+    # without changing semantics or exceeding the `Max` parameter of `Layout/LineLength`.
+    module CheckSingleLineSuitability
+      def suitable_as_single_line?(node)
+        !too_long?(node) &&
+          !comment_within?(node) &&
+          safe_to_split?(node)
+      end
+
+      private
+
+      def too_long?(node)
+        lines = processed_source.lines[(node.first_line - 1)...node.last_line]
+        to_single_line(lines.join("\n")).length > max_line_length
+      end
+
+      def to_single_line(source)
+        source
+          .gsub(/" *\\\n\s*'/, %q(" + ')) # Double quote, backslash, and then single quote
+          .gsub(/' *\\\n\s*"/, %q(' + ")) # Single quote, backslash, and then double quote
+          .gsub(/(["']) *\\\n\s*\1/, '')  # Double or single quote, backslash, then same quote
+          .gsub(/\n\s*(?=(&)?\.\w)/, '')  # Extra space within method chaining which includes `&.`
+          .gsub(/\s*\\?\n\s*/, ' ')       # Any other line break, with or without backslash
+      end
+
+      def max_line_length
+        config.for_cop('Layout/LineLength')['Max']
+      end
+
+      def comment_within?(node)
+        comment_line_numbers = processed_source.comments.map { |comment| comment.loc.line }
+
+        comment_line_numbers.any? do |comment_line_number|
+          comment_line_number >= node.first_line && comment_line_number <= node.last_line
+        end
+      end
+
+      def safe_to_split?(node)
+        node.each_descendant(:if, :case, :kwbegin, :def, :defs).none? &&
+          node.each_descendant(:dstr, :str).none? { |n| n.heredoc? || n.value.include?("\n") } &&
+          node.each_descendant(:begin, :sym).none? { |b| !b.single_line? }
+      end
+    end
+  end
+end

data/lib/rubocop/cop/mixin/dig_help.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # Help methods for working with `Enumerable#dig` in cops.
+    # Used by `Style::DigChain` and `Style::SingleArgumentDig`
+    module DigHelp
+      extend NodePattern::Macros
+
+      # @!method dig?(node)
+      def_node_matcher :dig?, <<~PATTERN
+        (call _ :dig !{hash block_pass}+)
+      PATTERN
+
+      # @!method single_argument_dig?(node)
+      def_node_matcher :single_argument_dig?, <<~PATTERN
+        (send _ :dig $!splat)
+      PATTERN
+
+      private
+
+      def dig_chain_enabled?
+        @config.for_cop('Style/DigChain')['Enabled']
+      end
+    end
+  end
+end

data/lib/rubocop/cop/mixin/multiline_expression_indentation.rb

@@ -121,12 +121,10 @@ module RuboCop
 
       def indented_keyword_expression(node)
         if node.for_type?
-          expression = node.collection
+          node.collection
         else
-          expression, = *node
+          node.children.first
         end
-
-        expression
       end
 
       def argument_in_method_call(node, kind) # rubocop:todo Metrics/CyclomaticComplexity
@@ -187,12 +185,10 @@ module RuboCop
 
       def assignment_rhs(node)
         case node.type
-        when :casgn   then _scope, _lhs, rhs = *node
-        when :op_asgn then _lhs, _op, rhs = *node
-        when :send, :csend then rhs = node.last_argument
-        else               _lhs, rhs = *node
+        when :casgn, :op_asgn then node.rhs
+        when :send, :csend    then node.last_argument
+        else                       node.children.last
         end
-        rhs
       end
 
       def not_for_this_cop?(node)

data/lib/rubocop/cop/mixin/range_help.rb

@@ -56,7 +56,6 @@ module RuboCop
                                        range: NOT_GIVEN, side: :both, newlines: true,
                                        whitespace: false, continuations: false,
                                        buffer: @processed_source.buffer)
-
         range = range_positional unless range_positional == NOT_GIVEN
 
         src = buffer.source

data/lib/rubocop/cop/mixin/target_ruby_version.rb

@@ -8,12 +8,28 @@ module RuboCop
         @minimum_target_ruby_version
       end
 
+      def required_maximum_ruby_version
+        @maximum_target_ruby_version
+      end
+
       def minimum_target_ruby_version(version)
         @minimum_target_ruby_version = version
       end
 
+      def maximum_target_ruby_version(version)
+        @maximum_target_ruby_version = version
+      end
+
       def support_target_ruby_version?(version)
-        required_minimum_ruby_version <= version
+        # By default, no minimum or maximum versions of ruby are required
+        # to run any cop. In order to do a simple numerical comparison of
+        # the requested version against any requirements, we use 0 and
+        # Infinity as the default values to indicate no minimum (0) and no
+        # maximum (Infinity).
+        min = required_minimum_ruby_version || 0
+        max = required_maximum_ruby_version || Float::INFINITY
+
+        min <= version && max >= version
       end
     end
   end

data/lib/rubocop/cop/naming/constant_name.rb

@@ -31,12 +31,11 @@ module RuboCop
         PATTERN
 
         def on_casgn(node)
-          if node.parent&.or_asgn_type?
-            lhs, value = *node.parent
-            _scope, const_name = *lhs
-          else
-            _scope, const_name, value = *node
-          end
+          value = if node.parent&.or_asgn_type?
+                    node.parent.expression
+                  else
+                    node.expression
+                  end
 
           # We cannot know the result of method calls like
           # NewClass = something_that_returns_a_class
@@ -46,7 +45,7 @@ module RuboCop
           # SomeClass = Class.new(...)
           # SomeClass = Struct.new(...)
           return if allowed_assignment?(value)
-          return if SNAKE_CASE.match?(const_name)
+          return if SNAKE_CASE.match?(node.name)
 
           add_offense(node.loc.name)
         end

data/lib/rubocop/cop/naming/file_name.rb

@@ -37,8 +37,6 @@ module RuboCop
       #
       #   anything/using_snake_case.rake
       class FileName < Base
-        include RangeHelp
-
         MSG_SNAKE_CASE = 'The name of this source file (`%<basename>s`) should use snake_case.'
         MSG_NO_DEFINITION = '`%<basename>s` should define a class or module called `%<namespace>s`.'
         MSG_REGEX = '`%<basename>s` should match `%<regex>s`.'

data/lib/rubocop/cop/naming/memoized_instance_variable_name.rb

@@ -155,6 +155,7 @@ module RuboCop
         UNDERSCORE_REQUIRED = 'Memoized variable `%<var>s` does not start ' \
                               'with `_`. Use `@%<suggested_var>s` instead.'
         DYNAMIC_DEFINE_METHODS = %i[define_method define_singleton_method].to_set.freeze
+        INITIALIZE_METHODS = %i[initialize initialize_clone initialize_copy initialize_dup].freeze
 
         # @!method method_definition?(node)
         def_node_matcher :method_definition?, <<~PATTERN
@@ -168,7 +169,7 @@ module RuboCop
         # rubocop:disable Metrics/AbcSize
         # rubocop:disable Metrics/MethodLength
         def on_or_asgn(node)
-          lhs, _value = *node
+          lhs = node.lhs
           return unless lhs.ivasgn_type?
 
           method_node, method_name = find_definition(node)
@@ -181,8 +182,8 @@ module RuboCop
 
           suggested_var = suggested_var(method_name)
           msg = format(
-            message(lhs.children.first.to_s),
-            var: lhs.children.first.to_s,
+            message(lhs.name),
+            var: lhs.name,
             suggested_var: suggested_var,
             method: method_name
           )
@@ -209,14 +210,13 @@ module RuboCop
           method_node, method_name = find_definition(node)
           return false unless method_node
 
-          var_name = arg.children.first
-          defined_memoized?(method_node.body, var_name) do |defined_ivar, return_ivar, ivar_assign|
+          defined_memoized?(method_node.body, arg.name) do |defined_ivar, return_ivar, ivar_assign|
             return false if matches?(method_name, ivar_assign)
 
             suggested_var = suggested_var(method_name)
             msg = format(
-              message(var_name.to_s),
-              var: var_name.to_s,
+              message(arg.name),
+              var: arg.name,
               suggested_var: suggested_var,
               method: method_name
             )
@@ -251,11 +251,10 @@ module RuboCop
         end
 
         def matches?(method_name, ivar_assign)
-          return true if ivar_assign.nil? || method_name == :initialize
+          return true if ivar_assign.nil? || INITIALIZE_METHODS.include?(method_name)
 
-          method_name = method_name.to_s.delete('!?')
-          variable = ivar_assign.children.first
-          variable_name = variable.to_s.sub('@', '')
+          method_name = method_name.to_s.delete('!?=')
+          variable_name = ivar_assign.name.to_s.sub('@', '')
 
           variable_name_candidates(method_name).include?(variable_name)
         end
@@ -269,7 +268,7 @@ module RuboCop
         end
 
         def suggested_var(method_name)
-          suggestion = method_name.to_s.delete('!?')
+          suggestion = method_name.to_s.delete('!?=')
 
           style == :required ? "_#{suggestion}" : suggestion
         end

data/lib/rubocop/cop/naming/rescued_exceptions_variable_name.rb

@@ -109,7 +109,7 @@ module RuboCop
               variable_name_matches?(lvasgn_node, name)
             end
           else
-            node.children.first == name
+            node.name == name
           end
         end
 
@@ -141,12 +141,7 @@ module RuboCop
         # Further `lvar` nodes will not be corrected though since they now refer to a
         # different variable.
         def correct_reassignment(corrector, node, offending_name, preferred_name)
-          if node.lvasgn_type?
-            correct_node(corrector, node.child_nodes.first, offending_name, preferred_name)
-          elsif node.masgn_type?
-            # With multiple assign, the assignments are in an array as the last child
-            correct_node(corrector, node.children.last, offending_name, preferred_name)
-          end
+          correct_node(corrector, node.rhs, offending_name, preferred_name)
         end
 
         def preferred_name(variable_name)
@@ -159,10 +154,7 @@ module RuboCop
         end
 
         def variable_name(node)
-          asgn_node = node.exception_variable
-          return unless asgn_node
-
-          asgn_node.children.last
+          node.exception_variable&.name
         end
 
         def message(node)

data/lib/rubocop/cop/naming/variable_name.rb

@@ -40,11 +40,10 @@ module RuboCop
         end
 
         def on_lvasgn(node)
-          name, = *node
-          return unless name
-          return if allowed_identifier?(name)
+          return unless node.name
+          return if allowed_identifier?(node.name)
 
-          check_name(node, name, node.loc.name)
+          check_name(node, node.name, node.loc.name)
         end
         alias on_ivasgn    on_lvasgn
         alias on_cvasgn    on_lvasgn

data/lib/rubocop/cop/naming/variable_number.rb

@@ -113,10 +113,9 @@ module RuboCop
 
         def on_arg(node)
           @node = node
-          name, = *node
-          return if allowed_identifier?(name)
+          return if allowed_identifier?(node.name)
 
-          check_name(node, name, node.loc.name)
+          check_name(node, node.name, node.loc.name)
         end
         alias on_lvasgn on_arg
         alias on_ivasgn on_arg

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

@@ -70,6 +70,7 @@ module RuboCop
       #     private :bar, :baz
       #     private *%i[qux quux]
       #     private *METHOD_NAMES
+      #     private *private_methods
       #
       #   end
       #
@@ -80,6 +81,7 @@ module RuboCop
       #     private :bar, :baz
       #     private *%i[qux quux]
       #     private *METHOD_NAMES
+      #     private *private_methods
       #
       #   end
       #
@@ -133,21 +135,18 @@ module RuboCop
         # @!method access_modifier_with_symbol?(node)
         def_node_matcher :access_modifier_with_symbol?, <<~PATTERN
           (send nil? {:private :protected :public :module_function}
-            {(sym _) (splat {#percent_symbol_array? const})}
+            {(sym _)+ (splat {#percent_symbol_array? const send})}
           )
         PATTERN
 
         # @!method access_modifier_with_attr?(node)
         def_node_matcher :access_modifier_with_attr?, <<~PATTERN
           (send nil? {:private :protected :public :module_function}
-            (send nil? {:attr :attr_reader :attr_writer :attr_accessor} _))
+            (send nil? {:attr :attr_reader :attr_writer :attr_accessor} _+))
         PATTERN
 
         def on_send(node)
-          return unless node.access_modifier?
-          return if ALLOWED_NODE_TYPES.include?(node.parent&.type)
-          return if allow_modifiers_on_symbols?(node)
-          return if allow_modifiers_on_attrs?(node)
+          return if allowed?(node)
 
           if offense?(node)
             add_offense(node.loc.selector) do |corrector|
@@ -161,15 +160,22 @@ module RuboCop
 
         private
 
+        def allowed?(node)
+          !node.access_modifier? ||
+            ALLOWED_NODE_TYPES.include?(node.parent&.type) ||
+            allow_modifiers_on_symbols?(node) ||
+            allow_modifiers_on_attrs?(node)
+        end
+
         def autocorrect(corrector, node)
           case style
           when :group
-            def_node = find_corresponding_def_node(node)
-            return unless def_node
+            def_nodes = find_corresponding_def_nodes(node)
+            return unless def_nodes.any?
 
-            replace_def(corrector, node, def_node)
+            replace_defs(corrector, node, def_nodes)
           when :inline
-            remove_node(corrector, node)
+            remove_nodes(corrector, node)
             select_grouped_def_nodes(node).each do |grouped_def_node|
               insert_inline_modifier(corrector, grouped_def_node, node.method_name)
             end
@@ -194,6 +200,13 @@ module RuboCop
             (inline_style? && access_modifier_is_not_inlined?(node))
         end
 
+        def correctable_group_offense?(node)
+          return false unless group_style?
+          return false if allowed?(node)
+
+          access_modifier_is_inlined?(node) && find_corresponding_def_nodes(node).any?
+        end
+
         def group_style?
           style == :group
         end
@@ -212,7 +225,11 @@ module RuboCop
 
         def right_siblings_same_inline_method?(node)
           node.right_siblings.any? do |sibling|
-            sibling.send_type? && sibling.method?(node.method_name) && !sibling.arguments.empty?
+            sibling.send_type? &&
+              correctable_group_offense?(sibling) &&
+              sibling.method?(node.method_name) &&
+              !sibling.arguments.empty? &&
+              find_corresponding_def_nodes(sibling).any?
           end
         end
 
@@ -226,14 +243,22 @@ module RuboCop
           end
         end
 
-        def find_corresponding_def_node(node)
+        def find_corresponding_def_nodes(node)
           if access_modifier_with_symbol?(node)
-            method_name = node.first_argument.respond_to?(:value) && node.first_argument.value
-            node.parent.each_child_node(:def).find do |child|
-              child.method?(method_name)
+            method_names = node.arguments.filter_map do |argument|
+              next unless argument.sym_type?
+
+              argument.respond_to?(:value) && argument.value
+            end
+
+            def_nodes = node.parent.each_child_node(:def).select do |child|
+              method_names.include?(child.method_name)
             end
+
+            # If there isn't a `def` node for each symbol, we will skip autocorrection.
+            def_nodes.size == method_names.size ? def_nodes : []
           else
-            node.first_argument
+            [node.first_argument]
           end
         end
 
@@ -251,8 +276,8 @@ module RuboCop
           end.select(&:def_type?)
         end
 
-        def replace_def(corrector, node, def_node)
-          source = def_source(node, def_node)
+        def replace_defs(corrector, node, def_nodes)
+          source = def_source(node, def_nodes)
           argument_less_modifier_node = find_argument_less_modifier_node(node)
           if argument_less_modifier_node
             corrector.insert_after(argument_less_modifier_node, "\n\n#{source}")
@@ -264,20 +289,24 @@ module RuboCop
             return
           end
 
-          remove_node(corrector, def_node)
-          remove_node(corrector, node)
+          remove_nodes(corrector, *def_nodes, node)
         end
 
         def insert_inline_modifier(corrector, node, modifier_name)
           corrector.insert_before(node, "#{modifier_name} ")
         end
 
-        def remove_node(corrector, node)
-          corrector.remove(range_with_comments_and_lines(node))
+        def remove_nodes(corrector, *nodes)
+          nodes.each do |node|
+            corrector.remove(range_with_comments_and_lines(node))
+          end
         end
 
-        def def_source(node, def_node)
-          [*processed_source.ast_with_comments[node].map(&:text), def_node.source].join("\n")
+        def def_source(node, def_nodes)
+          [
+            *processed_source.ast_with_comments[node].map(&:text),
+            *def_nodes.map(&:source)
+          ].join("\n")
         end
       end
     end

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

@@ -61,7 +61,7 @@ module RuboCop
         private
 
         def modifier_form?(operation)
-          return true if operation.and_type? || operation.or_type?
+          return true if operation.operator_keyword?
 
           operation.modifier_form?
         end

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

@@ -28,6 +28,7 @@ module RuboCop
       #   # bad
       #   (array1 & array2).any?
       #   (array1 & array2).empty?
+      #   (array1 & array2).none?
       #
       #   # good
       #   array1.intersect?(array2)
@@ -57,7 +58,7 @@ module RuboCop
           (send
             (begin
               (send $(...) :& $(...))
-            ) ${:any? :empty?}
+            ) ${:any? :empty? :none?}
           )
         PATTERN
 
@@ -66,18 +67,18 @@ module RuboCop
           (send
             (begin
               (send $(...) :& $(...))
-            ) ${:present? :any? :blank? :empty?}
+            ) ${:present? :any? :blank? :empty? :none?}
           )
         PATTERN
 
         MSG = 'Use `%<negated>s%<receiver>s.intersect?(%<argument>s)` ' \
               'instead of `(%<receiver>s & %<argument>s).%<method_name>s`.'
         STRAIGHT_METHODS = %i[present? any?].freeze
-        NEGATED_METHODS = %i[blank? empty?].freeze
+        NEGATED_METHODS = %i[blank? empty? none?].freeze
         RESTRICT_ON_SEND = (STRAIGHT_METHODS + NEGATED_METHODS).freeze
 
         def on_send(node)
-          return if (parent = node.parent) && (parent.block_type? || parent.numblock_type?)
+          return if node.block_literal?
           return unless (receiver, argument, method_name = bad_intersection_check?(node))
 
           message = message(receiver.source, argument.source, method_name)

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

@@ -71,7 +71,7 @@ module RuboCop
         PATTERN
 
         def on_send(node)
-          return unless node.receiver.begin_type?
+          return unless node.receiver&.begin_type?
           return unless (preferred_method = preferred_method(node))
 
           bit_operation = node.receiver.children.first

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

@@ -481,7 +481,7 @@ module RuboCop
         end
 
         def conditional?(node)
-          node.if_type? || node.or_type? || node.and_type?
+          node.if_type? || node.operator_keyword?
         end
 
         def array_or_range?(node)

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

@@ -106,7 +106,7 @@ module RuboCop
           when :or
             find_target(node.lhs)
           when :match_with_lvasgn
-            lhs, rhs = *node
+            lhs, rhs = *node # rubocop:disable InternalAffairs/NodeDestructuring
             if lhs.regexp_type?
               rhs
             elsif rhs.regexp_type?
@@ -172,7 +172,7 @@ module RuboCop
               return collect_conditions(node.lhs, target, conditions) &&
                      collect_conditions(node.rhs, target, conditions)
             when :match_with_lvasgn
-              lhs, rhs = *node
+              lhs, rhs = *node # rubocop:disable InternalAffairs/NodeDestructuring
               condition_from_binary_op(lhs, rhs, target)
             when :send
               condition_from_send_node(node, target)
@@ -191,8 +191,7 @@ module RuboCop
           when :=~, :match, :match?
             condition_from_match_node(node, target)
           when :===
-            lhs, _method, rhs = *node
-            lhs if rhs == target
+            node.receiver if node.first_argument == target
           when :include?, :cover?
             condition_from_include_or_cover_node(node, target)
           end
@@ -200,14 +199,12 @@ module RuboCop
         # rubocop:enable Metrics/CyclomaticComplexity
 
         def condition_from_equality_node(node, target)
-          lhs, _method, rhs = *node
-          condition = condition_from_binary_op(lhs, rhs, target)
+          condition = condition_from_binary_op(node.receiver, node.first_argument, target)
           condition if condition && !class_reference?(condition)
         end
 
         def condition_from_match_node(node, target)
-          lhs, _method, rhs = *node
-          condition_from_binary_op(lhs, rhs, target)
+          condition_from_binary_op(node.receiver, node.first_argument, target)
         end
 
         def condition_from_include_or_cover_node(node, target)
@@ -263,11 +260,11 @@ module RuboCop
         def regexp_with_working_captures?(node)
           case node.type
           when :match_with_lvasgn
-            lhs, _rhs = *node
+            lhs, _rhs = *node # rubocop:disable InternalAffairs/NodeDestructuring
             node.loc.selector.source == '=~' && regexp_with_named_captures?(lhs)
           when :send
-            lhs, method, rhs = *node
-            method == :match && [lhs, rhs].any? { |n| regexp_with_named_captures?(n) }
+            node.method?(:match) &&
+              [node.receiver, node.first_argument].any? { |n| regexp_with_named_captures?(n) }
           end
         end
 

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

@@ -57,6 +57,9 @@ module RuboCop
 
         REGEXP = /(?<keyword>\S+).*#/.freeze
 
+        SUBCLASS_DEFINITION = /\A\s*class\s+\w+\s*<\s*\w+/.freeze
+        METHOD_DEFINITION = /\A\s*def\s/.freeze
+
         def on_new_investigation
           processed_source.comments.each do |comment|
             next unless offensive?(comment) && (match = source_line(comment).match(REGEXP))
@@ -93,7 +96,14 @@ module RuboCop
         end
 
         def rbs_inline_annotation?(line, comment)
-          comment.text.start_with?('#:') && line.start_with?(/\A\s*def\s/)
+          case line
+          when SUBCLASS_DEFINITION
+            comment.text.start_with?(/#\[.+\]/)
+          when METHOD_DEFINITION
+            comment.text.start_with?('#:')
+          else
+            false
+          end
         end
       end
     end