rubocop 1.69.2 → 1.70.0

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

@@ -5,6 +5,10 @@ module RuboCop
     # Common functionality for checking whether an AST node/token is aligned
     # with something on a preceding or following line
     module PrecedingFollowingAlignment
+      # Tokens that end with an `=`, as well as `<<`, that can be aligned together:
+      # `=`, `==`, `===`, `!=`, `<=`, `>=`, `<<` and operator assignment (`+=`, etc).
+      ASSIGNMENT_OR_COMPARISON_TOKENS = %i[tEQL tEQ tEQQ tNEQ tLEQ tGEQ tOP_ASGN tLSHFT].freeze
+
       private
 
       def allow_for_alignment?
@@ -19,16 +23,20 @@ module RuboCop
         aligned_with_adjacent_line?(range, method(:aligned_operator?))
       end
 
-      def aligned_with_preceding_assignment(token)
+      # Allows alignment with a preceding operator that ends with an `=`,
+      # including assignment and comparison operators.
+      def aligned_with_preceding_equals_operator(token)
         preceding_line_range = token.line.downto(1)
 
-        aligned_with_assignment(token, preceding_line_range)
+        aligned_with_equals_sign(token, preceding_line_range)
       end
 
-      def aligned_with_subsequent_assignment(token)
+      # Allows alignment with a subsequent operator that ends with an `=`,
+      # including assignment and comparison operators.
+      def aligned_with_subsequent_equals_operator(token)
         subsequent_line_range = token.line.upto(processed_source.lines.length)
 
-        aligned_with_assignment(token, subsequent_line_range)
+        aligned_with_equals_sign(token, subsequent_line_range)
       end
 
       def aligned_with_adjacent_line?(range, predicate)
@@ -75,11 +83,11 @@ module RuboCop
       end
 
       def aligned_token?(range, line, lineno)
-        aligned_words?(range, line) || aligned_assignment?(range, lineno)
+        aligned_words?(range, line) || aligned_equals_operator?(range, lineno)
       end
 
       def aligned_operator?(range, line, lineno)
-        aligned_identical?(range, line) || aligned_assignment?(range, lineno)
+        aligned_identical?(range, line) || aligned_equals_operator?(range, lineno)
       end
 
       def aligned_words?(range, line)
@@ -90,22 +98,24 @@ module RuboCop
         token == line[left_edge, token.length]
       end
 
-      def aligned_assignment?(range, lineno)
-        # Check that assignment is aligned with a previous assignment operator
-        # ie. an equals sign, an operator assignment, or an append operator (`<<`)
+      def aligned_equals_operator?(range, lineno)
+        # Check that the operator is aligned with a previous assignment or comparison operator
+        # ie. an equals sign, an operator assignment (eg. `+=`), a comparison (`==`, `<=`, etc.).
+        # Since append operators (`<<`) are a type of assignment, they are allowed as well,
+        # despite not ending with a literal equals character.
         line_range = processed_source.buffer.line_range(lineno)
         return false unless line_range
 
         # Find the specific token to avoid matching up to operators inside strings
-        assignment_token = processed_source.tokens_within(line_range).detect do |token|
-          token.equal_sign? || token.type == :tLSHFT
+        operator_token = processed_source.tokens_within(line_range).detect do |token|
+          ASSIGNMENT_OR_COMPARISON_TOKENS.include?(token.type)
         end
 
-        aligned_with_preceding_assignment?(range, assignment_token) ||
-          aligned_with_append_operator?(range, assignment_token)
+        aligned_with_preceding_equals?(range, operator_token) ||
+          aligned_with_append_operator?(range, operator_token)
       end
 
-      def aligned_with_preceding_assignment?(range, token)
+      def aligned_with_preceding_equals?(range, token)
         return false unless token
 
         range.source[-1] == '=' && range.last_column == token.pos.last_column
@@ -123,7 +133,7 @@ module RuboCop
         range.source == line[range.column, range.size]
       end
 
-      def aligned_with_assignment(token, line_range)
+      def aligned_with_equals_sign(token, line_range)
         token_line_indent    = processed_source.line_indentation(token.line)
         assignment_lines     = relevant_assignment_lines(line_range)
         relevant_line_number = assignment_lines[1]
@@ -135,7 +145,7 @@ module RuboCop
         return :none if relevant_indent < token_line_indent
         return :none unless processed_source.lines[relevant_line_number - 1]
 
-        aligned_assignment?(token.pos, relevant_line_number) ? :yes : :no
+        aligned_equals_operator?(token.pos, relevant_line_number) ? :yes : :no
       end
 
       def assignment_lines

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

@@ -36,7 +36,7 @@ module RuboCop
       end
 
       def space_required_after?(token)
-        (token.left_curly_brace? || token.type == :tLAMBEG) && space_required_after_lcurly?
+        token.left_curly_brace? && space_required_after_lcurly?
       end
 
       def space_required_after_lcurly?

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

@@ -96,7 +96,7 @@ module RuboCop
       end
 
       def max_line_length
-        return unless config.for_cop('Layout/LineLength')['Enabled']
+        return unless config.cop_enabled?('Layout/LineLength')
 
         config.for_cop('Layout/LineLength')['Max']
       end

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

@@ -26,7 +26,7 @@ module RuboCop
       end
 
       def string_literals_config
-        config.for_cop('Style/StringLiterals')
+        config.for_enabled_cop('Style/StringLiterals')
       end
     end
   end

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

@@ -138,7 +138,7 @@ module RuboCop
         def use_block_argument_as_local_variable?(node, last_argument)
           return false if node.body.nil?
 
-          node.body.each_descendant(:lvar, :lvasgn).any? do |lvar|
+          node.body.each_node(:lvar, :lvasgn).any? do |lvar|
             !lvar.parent.block_pass_type? && lvar.node_parts[0].to_s == last_argument
           end
         end

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

@@ -112,6 +112,26 @@ module RuboCop
       #     private attr :quux
       #
       #   end
+      #
+      # @example AllowModifiersOnAliasMethod: true (default)
+      #   # good
+      #   class Foo
+      #
+      #     public alias_method :bar, :foo
+      #     protected alias_method :baz, :foo
+      #     private alias_method :qux, :foo
+      #
+      #   end
+      #
+      # @example AllowModifiersOnAliasMethod: false
+      #   # bad
+      #   class Foo
+      #
+      #     public alias_method :bar, :foo
+      #     protected alias_method :baz, :foo
+      #     private alias_method :qux, :foo
+      #
+      #   end
       class AccessModifierDeclarations < Base
         extend AutoCorrector
 
@@ -145,6 +165,12 @@ module RuboCop
             (send nil? {:attr :attr_reader :attr_writer :attr_accessor} _+))
         PATTERN
 
+        # @!method access_modifier_with_alias_method?, <<~PATTERN
+        def_node_matcher :access_modifier_with_alias_method?, <<~PATTERN
+          (send nil? {:private :protected :public :module_function}
+            (send nil? :alias_method _ _))
+        PATTERN
+
         def on_send(node)
           return if allowed?(node)
 
@@ -164,7 +190,8 @@ module RuboCop
           !node.access_modifier? ||
             ALLOWED_NODE_TYPES.include?(node.parent&.type) ||
             allow_modifiers_on_symbols?(node) ||
-            allow_modifiers_on_attrs?(node)
+            allow_modifiers_on_attrs?(node) ||
+            allow_modifiers_on_alias_method?(node)
         end
 
         def autocorrect(corrector, node)
@@ -194,6 +221,10 @@ module RuboCop
           cop_config['AllowModifiersOnAttrs'] && access_modifier_with_attr?(node)
         end
 
+        def allow_modifiers_on_alias_method?(node)
+          cop_config['AllowModifiersOnAliasMethod'] && access_modifier_with_alias_method?(node)
+        end
+
         def offense?(node)
           (group_style? && access_modifier_is_inlined?(node) &&
             !node.parent&.if_type? && !right_siblings_same_inline_method?(node)) ||

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

@@ -127,7 +127,7 @@ module RuboCop
         end
 
         def correct_other(node, corrector)
-          return if node.source_range.begin.is?('(')
+          return if node.parenthesized_call?
 
           corrector.wrap(node, '(', ')')
         end

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

@@ -540,10 +540,7 @@ module RuboCop
         end
 
         def explicit_block_name?
-          block_forwarding_config = config.for_cop('Naming/BlockForwarding')
-          return false unless block_forwarding_config['Enabled']
-
-          block_forwarding_config['EnforcedStyle'] == 'explicit'
+          config.for_enabled_cop('Naming/BlockForwarding')['EnforcedStyle'] == 'explicit'
         end
       end
     end

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

@@ -126,9 +126,12 @@ module RuboCop
         end
 
         def unindent(corrector, node)
-          return if node.body.children.last.nil?
+          return unless node.body.children.last
 
-          column_delta = configured_indentation_width - leading_spaces(node.body.children.last).size
+          last_child_leading_spaces = leading_spaces(node.body.children.last)
+          return if leading_spaces(node).size == last_child_leading_spaces.size
+
+          column_delta = configured_indentation_width - last_child_leading_spaces.size
           return if column_delta.zero?
 
           AlignmentCorrector.correct(corrector, processed_source, node, column_delta)

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

@@ -53,8 +53,7 @@ module RuboCop
           (block
             (call
               (begin
-                (${irange erange}
-                  (int $_) (int $_)))
+                ($range (int $_) (int $_)))
               :each)
             (args ...)
             ...)
@@ -65,8 +64,7 @@ module RuboCop
           (block
             (call
               (begin
-                ({irange erange}
-                  (int 0) (int _)))
+                (range (int 0) (int _)))
               :each)
             (args ...)
             ...)
@@ -77,8 +75,7 @@ module RuboCop
           (block
             (call
               (begin
-                ({irange erange}
-                  (int _) (int _)))
+                (range (int _) (int _)))
               :each)
             (args)
             ...)

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

@@ -131,6 +131,8 @@ module RuboCop
         extend AutoCorrector
 
         MSG = 'Redundant `else`-clause.'
+        NIL_STYLES = %i[nil both].freeze
+        EMPTY_STYLES = %i[empty both].freeze
 
         def on_normal_if_unless(node)
           check(node)
@@ -150,11 +152,11 @@ module RuboCop
         end
 
         def nil_style?
-          style == :nil || style == :both
+          NIL_STYLES.include?(style)
         end
 
         def empty_style?
-          style == :empty || style == :both
+          EMPTY_STYLES.include?(style)
         end
 
         def empty_check(node)

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

@@ -136,7 +136,7 @@ module RuboCop
         def frozen_strings?
           return true if frozen_string_literals_enabled?
 
-          frozen_string_cop_enabled = config.for_cop('Style/FrozenStringLiteralComment')['Enabled']
+          frozen_string_cop_enabled = config.cop_enabled?('Style/FrozenStringLiteralComment')
           frozen_string_cop_enabled &&
             !frozen_string_literals_disabled? &&
             string_literals_frozen_by_default?.nil?

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

@@ -109,7 +109,7 @@ module RuboCop
         end
 
         def max_line_length
-          return unless config.for_cop('Layout/LineLength')['Enabled']
+          return unless config.cop_enabled?('Layout/LineLength')
 
           config.for_cop('Layout/LineLength')['Max']
         end

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

@@ -40,15 +40,8 @@ module RuboCop
         def on_send(node)
           return unless (receiver = node.receiver)
           return unless (regexp = exact_regexp_match(node))
-
-          parsed_regexp = begin
-            Regexp::Parser.parse(regexp)
-          rescue Regexp::Parser::Error
-            # Upon encountering an invalid regular expression,
-            # we aim to proceed and identify any remaining potential offenses.
-          end
-
-          return unless parsed_regexp && exact_match_pattern?(parsed_regexp)
+          return unless (parsed_regexp = parse_regexp(regexp))
+          return unless exact_match_pattern?(parsed_regexp)
 
           prefer = "#{receiver.source} #{new_method(node)} '#{parsed_regexp[1].text}'"
 

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

@@ -8,7 +8,7 @@ module RuboCop
       #
       # * `scientific` which enforces a mantissa between 1 (inclusive) and 10 (exclusive).
       # * `engineering` which enforces the exponent to be a multiple of 3 and the mantissa
-      #   to be between 0.1 (inclusive) and 10 (exclusive).
+      #   to be between 0.1 (inclusive) and 1000 (exclusive).
       # * `integral` which enforces the mantissa to always be a whole number without
       #   trailing zeroes.
       #

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

@@ -65,19 +65,23 @@ module RuboCop
 
         # @!method right_coerce?(node)
         def_node_matcher :right_coerce?, <<~PATTERN
-          (send _ :/ (send _ :to_f))
+          (send _ :/ #to_f_method?)
         PATTERN
         # @!method left_coerce?(node)
         def_node_matcher :left_coerce?, <<~PATTERN
-          (send (send _ :to_f) :/ _)
+          (send #to_f_method? :/ _)
         PATTERN
         # @!method both_coerce?(node)
         def_node_matcher :both_coerce?, <<~PATTERN
-          (send (send _ :to_f) :/ (send _ :to_f))
+          (send #to_f_method? :/ #to_f_method?)
         PATTERN
         # @!method any_coerce?(node)
         def_node_matcher :any_coerce?, <<~PATTERN
-          {(send _ :/ (send _ :to_f)) (send (send _ :to_f) :/ _)}
+          {(send _ :/ #to_f_method?) (send #to_f_method? :/ _)}
+        PATTERN
+        # @!method to_f_method?(node)
+        def_node_matcher :to_f_method?, <<~PATTERN
+          (send !nil? :to_f)
         PATTERN
 
         def on_send(node)

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

@@ -10,8 +10,10 @@ module RuboCop
       # (`Hash#except` was added in Ruby 3.0.)
       #
       # For safe detection, it is limited to commonly used string and symbol comparisons
-      # when used `==`.
-      # And do not check `Hash#delete_if` and `Hash#keep_if` to change receiver object.
+      # when using `==` or `!=`.
+      #
+      # This cop doesn't check for `Hash#delete_if` and `Hash#keep_if` because they
+      # modify the receiver.
       #
       # @safety
       #   This cop is unsafe because it cannot be guaranteed that the receiver
@@ -51,44 +53,31 @@ module RuboCop
         MSG = 'Use `%<prefer>s` instead.'
         RESTRICT_ON_SEND = %i[reject select filter].freeze
 
-        # @!method bad_method_with_poro?(node)
-        def_node_matcher :bad_method_with_poro?, <<~PATTERN
-          (block
-            (call _ _)
-            (args
-              $(arg _)
-              (arg _))
-            {
-              $(send
-                _ {:== :!= :eql? :include?} _)
-              (send
-                $(send
-                  _ {:== :!= :eql? :include?} _) :!)
-              })
-        PATTERN
+        SUBSET_METHODS = %i[== != eql? include?].freeze
+        ACTIVE_SUPPORT_SUBSET_METHODS = (SUBSET_METHODS + %i[in? exclude?]).freeze
 
-        # @!method bad_method_with_active_support?(node)
-        def_node_matcher :bad_method_with_active_support?, <<~PATTERN
+        # @!method block_with_first_arg_check?(node)
+        def_node_matcher :block_with_first_arg_check?, <<~PATTERN
           (block
-            (send _ _)
+            (call _ _)
             (args
-              $(arg _)
+              $(arg _key)
               (arg _))
             {
               $(send
-                _ {:== :!= :eql? :in? :include? :exclude?} _)
+                {(lvar _key) $_ _ | _ $_ (lvar _key)})
               (send
                 $(send
-                  _ {:== :!= :eql? :in? :include? :exclude?} _) :!)
+                  {(lvar _key) $_ _ | _ $_ (lvar _key)}) :!)
               })
         PATTERN
 
         def on_send(node)
           block = node.parent
-          return unless bad_method?(block) && semantically_except_method?(node, block)
+          return unless extracts_hash_subset?(block) && semantically_except_method?(node, block)
 
           except_key = except_key(block)
-          return if except_key.nil? || !safe_to_register_offense?(block, except_key)
+          return unless safe_to_register_offense?(block, except_key)
 
           range = offense_range(node)
           preferred_method = "except(#{except_key_source(except_key)})"
@@ -101,42 +90,40 @@ module RuboCop
 
         private
 
-        # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-        def bad_method?(block)
-          if active_support_extensions_enabled?
-            bad_method_with_active_support?(block) do |key_arg, send_node|
-              if send_node.method?(:in?) && send_node.receiver&.source != key_arg.source
-                return false
-              end
-              return true if !send_node.method?(:include?) && !send_node.method?(:exclude?)
-
-              send_node.first_argument&.source == key_arg.source
-            end
-          else
-            bad_method_with_poro?(block) do |key_arg, send_node|
-              !send_node.method?(:include?) || send_node.first_argument&.source == key_arg.source
+        def extracts_hash_subset?(block)
+          block_with_first_arg_check?(block) do |key_arg, send_node, method|
+            return false unless supported_subset_method?(method)
+
+            case method
+            when :include?, :exclude?
+              send_node.first_argument.source == key_arg.source
+            when :in?
+              send_node.receiver.source == key_arg.source
+            else
+              true
             end
           end
         end
-        # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
-        def semantically_except_method?(send, block)
-          body = block.body
+        def supported_subset_method?(method)
+          if active_support_extensions_enabled?
+            ACTIVE_SUPPORT_SUBSET_METHODS.include?(method)
+          else
+            SUBSET_METHODS.include?(method)
+          end
+        end
 
-          negated = body.method?('!')
-          body = body.receiver if negated
+        def semantically_except_method?(node, block)
+          body, negated = extract_body_if_negated(block.body)
 
-          case send.method_name
-          when :reject
-            body.method?('==') || body.method?('eql?') || included?(negated, body)
-          when :select, :filter
-            body.method?('!=') || not_included?(negated, body)
+          if node.method?('reject')
+            body.method?('==') || body.method?('eql?') || included?(body, negated)
           else
-            false
+            body.method?('!=') || not_included?(body, negated)
           end
         end
 
-        def included?(negated, body)
+        def included?(body, negated)
           if negated
             body.method?('exclude?')
           else
@@ -144,25 +131,26 @@ module RuboCop
           end
         end
 
-        def not_included?(negated, body)
-          included?(!negated, body)
+        def not_included?(body, negated)
+          included?(body, !negated)
         end
 
         def safe_to_register_offense?(block, except_key)
-          extracted = extract_body_if_negated(block.body)
-          if extracted.method?('in?') || extracted.method?('include?') ||
-             extracted.method?('exclude?')
-            return true
-          end
-          return true if block.body.method?('eql?')
+          body = block.body
 
-          except_key.sym_type? || except_key.str_type?
+          if body.method?('==') || body.method?('!=')
+            except_key.sym_type? || except_key.str_type?
+          else
+            true
+          end
         end
 
         def extract_body_if_negated(body)
-          return body unless body.method?('!')
-
-          body.receiver
+          if body.method?('!')
+            [body.receiver, true]
+          else
+            [body, false]
+          end
         end
 
         def except_key_source(key)
@@ -187,12 +175,11 @@ module RuboCop
         end
 
         def except_key(node)
-          key_argument = node.argument_list.first.source
-          body = extract_body_if_negated(node.body)
+          key_arg = node.argument_list.first.source
+          body, = extract_body_if_negated(node.body)
           lhs, _method_name, rhs = *body
-          return if [lhs, rhs].map(&:source).none?(key_argument)
 
-          [lhs, rhs].find { |operand| operand.source != key_argument }
+          lhs.source == key_arg ? rhs : lhs
         end
 
         def offense_range(node)

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

@@ -137,6 +137,7 @@ module RuboCop
         MSG_19 = 'Use the new Ruby 1.9 hash syntax.'
         MSG_NO_MIXED_KEYS = "Don't mix styles in the same hash."
         MSG_HASH_ROCKETS = 'Use hash rockets syntax.'
+        NO_MIXED_KEYS_STYLES = %i[ruby19_no_mixed_keys no_mixed_keys].freeze
 
         def on_hash(node)
           pairs = node.pairs
@@ -196,7 +197,7 @@ module RuboCop
         def autocorrect(corrector, node)
           if style == :hash_rockets || force_hash_rockets?(node.parent.pairs)
             autocorrect_hash_rockets(corrector, node)
-          elsif style == :ruby19_no_mixed_keys || style == :no_mixed_keys
+          elsif NO_MIXED_KEYS_STYLES.include?(style)
             autocorrect_no_mixed_keys(corrector, node)
           else
             autocorrect_ruby19(corrector, node)
@@ -272,7 +273,9 @@ module RuboCop
         end
 
         def argument_without_space?(node)
-          node.argument? && node.source_range.begin_pos == node.parent.loc.selector.end_pos
+          return false if !node.argument? || !node.parent.loc.selector
+
+          node.source_range.begin_pos == node.parent.loc.selector.end_pos
         end
 
         def autocorrect_hash_rockets(corrector, pair_node)

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Checks for assignments to a local `it` variable inside a block
+      # where `it` can refer to the first anonymous parameter as of Ruby 3.4.
+      #
+      # Although Ruby allows reassigning `it` in these cases, it could
+      # cause confusion if `it` is used as a block parameter elsewhere.
+      # For consistency, this also applies to numblocks and blocks with
+      # parameters, even though `it` cannot be used in those cases.
+      #
+      # @example
+      #   # bad
+      #   foo { it = 5 }
+      #   foo { |bar| it = bar }
+      #   foo { it = _2 }
+      #
+      #   # good - use a different variable name
+      #   foo { var = 5 }
+      #   foo { |bar| var = bar }
+      #   foo { bar = _2 }
+      class ItAssignment < Base
+        MSG = '`it` is the default block parameter; consider another name.'
+
+        def on_lvasgn(node)
+          return unless node.name == :it
+          return unless node.each_ancestor(:block, :numblock).any?
+
+          add_offense(node.loc.name)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb

@@ -135,17 +135,20 @@ module RuboCop
             node.parent&.class_type? && node.parent.single_line?
           end
 
-          def call_with_ambiguous_arguments?(node) # rubocop:disable Metrics/PerceivedComplexity
+          # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity
+          def call_with_ambiguous_arguments?(node)
             call_with_braced_block?(node) ||
               call_in_argument_with_block?(node) ||
               call_as_argument_or_chain?(node) ||
               call_in_match_pattern?(node) ||
               hash_literal_in_arguments?(node) ||
+              ambiguous_range_argument?(node) ||
               node.descendants.any? do |n|
                 n.forwarded_args_type? || n.block_type? || n.numblock_type? ||
                   ambiguous_literal?(n) || logical_operator?(n)
               end
           end
+          # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity
 
           def call_with_braced_block?(node)
             (node.call_type? || node.super_type?) && node.block_node&.braces?
@@ -177,6 +180,13 @@ module RuboCop
             end
           end
 
+          def ambiguous_range_argument?(node)
+            return true if (first_arg = node.first_argument)&.range_type? && first_arg.begin.nil?
+            return true if (last_arg = node.last_argument)&.range_type? && last_arg.end.nil?
+
+            false
+          end
+
           def allowed_multiline_call_with_parentheses?(node)
             cop_config['AllowParenthesesInMultilineCall'] && node.multiline?
           end