rubocop 1.64.1 → 1.65.1

data/lib/rubocop/cop/lint/useless_assignment.rb

@@ -28,16 +28,12 @@ module RuboCop
       # @example
       #
       #   # bad
-      #
       #   def some_method
       #     some_var = 1
       #     do_something
       #   end
       #
-      # @example
-      #
       #   # good
-      #
       #   def some_method
       #     some_var = 1
       #     do_something(some_var)
@@ -61,7 +57,7 @@ module RuboCop
         def check_for_unused_assignments(variable)
           return if variable.should_be_unused?
 
-          variable.assignments.each do |assignment|
+          variable.assignments.reverse_each do |assignment|
             next if assignment.used? || part_of_ignored_node?(assignment.node)
 
             message = message_for_useless_assignment(assignment)

data/lib/rubocop/cop/lint/useless_else_without_rescue.rb

@@ -10,17 +10,13 @@ module RuboCop
       # @example
       #
       #   # bad
-      #
       #   begin
       #     do_something
       #   else
       #     do_something_else # This will never be run.
       #   end
       #
-      # @example
-      #
       #   # good
-      #
       #   begin
       #     do_something
       #   rescue

data/lib/rubocop/cop/lint/useless_setter_call.rb

@@ -17,16 +17,12 @@ module RuboCop
       # @example
       #
       #   # bad
-      #
       #   def something
       #     x = Something.new
       #     x.attr = 5
       #   end
       #
-      # @example
-      #
       #   # good
-      #
       #   def something
       #     x = Something.new
       #     x.attr = 5

data/lib/rubocop/cop/lint/void.rb

@@ -111,6 +111,8 @@ module RuboCop
         end
 
         def check_expression(expr)
+          expr = expr.body if expr.if_type? && expr.modifier_form?
+
           check_literal(expr)
           check_var(expr)
           check_self(expr)
@@ -121,6 +123,7 @@ module RuboCop
         end
 
         def check_void_op(node, &block)
+          node = node.children.first while node.begin_type?
           return unless node.send_type? && OPERATORS.include?(node.method_name)
           return if block && yield(node)
 
@@ -211,6 +214,8 @@ module RuboCop
         end
 
         def autocorrect_void_expression(corrector, node)
+          return if node.parent.if_type? && node.parent.modifier_form?
+
           corrector.remove(range_with_surrounding_space(range: node.source_range, side: :left))
         end
 

data/lib/rubocop/cop/metrics/block_nesting.rb

@@ -3,12 +3,12 @@
 module RuboCop
   module Cop
     module Metrics
-      # Checks for excessive nesting of conditional and looping
-      # constructs.
+      # Checks for excessive nesting of conditional and looping constructs.
       #
-      # You can configure if blocks are considered using the `CountBlocks`
-      # option. When set to `false` (the default) blocks are not counted
-      # towards the nesting level. Set to `true` to count blocks as well.
+      # You can configure if blocks are considered using the `CountBlocks` and `CountModifierForms`
+      # options. When both are set to `false` (the default) blocks and modifier forms are not
+      # counted towards the nesting level. Set them to `true` to include these in the nesting level
+      # calculation as well.
       #
       # The maximum level of nesting allowed is configurable.
       class BlockNesting < Base
@@ -27,7 +27,7 @@ module RuboCop
 
         def check_nesting_level(node, max, current_level)
           if consider_node?(node)
-            current_level += 1 unless node.if_type? && node.elsif?
+            current_level += 1 if count_if_block?(node)
             if current_level > max
               self.max = current_level
               unless part_of_ignored_node?(node)
@@ -41,6 +41,14 @@ module RuboCop
           end
         end
 
+        def count_if_block?(node)
+          return true unless node.if_type?
+          return false if node.elsif?
+          return count_modifier_forms? if node.modifier_form?
+
+          true
+        end
+
         def consider_node?(node)
           return true if NESTING_BLOCKS.include?(node.type)
 
@@ -52,7 +60,11 @@ module RuboCop
         end
 
         def count_blocks?
-          cop_config['CountBlocks']
+          cop_config.fetch('CountBlocks', false)
+        end
+
+        def count_modifier_forms?
+          cop_config.fetch('CountModifierForms', false)
         end
       end
     end

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

@@ -65,8 +65,12 @@ module RuboCop
         inner.begin_pos >= outer.begin_pos && inner.end_pos <= outer.end_pos
       end
 
-      # @deprecated Use processed_source.comment_at_line(line)
+      # @deprecated Use processed_source.line_with_comment?(line)
       def end_of_line_comment(line)
+        warn Rainbow(<<~WARNING).yellow, uplevel: 1
+          `end_of_line_comment` is deprecated. Use `processed_source.line_with_comment?` instead.
+        WARNING
+
         processed_source.line_with_comment?(line)
       end
 

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

@@ -15,7 +15,13 @@ module RuboCop
       end
 
       # @deprecated Use allowed_method? instead
-      alias ignored_method? allowed_method?
+      def ignored_method?
+        warn Rainbow(<<~WARNING).yellow, uplevel: 1
+          `ignored_method?` is deprecated. Use `allowed_method?` instead.
+        WARNING
+
+        allowed_method?
+      end
 
       # @api public
       def allowed_methods

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

@@ -18,14 +18,26 @@ module RuboCop
       end
 
       # @deprecated Use allowed_line? instead
-      alias ignored_line? allowed_line?
+      def ignored_line?
+        warn Rainbow(<<~WARNING).yellow, uplevel: 1
+          `ignored_line?` is deprecated. Use `allowed_line?` instead.
+        WARNING
+
+        allowed_line?
+      end
 
       def matches_allowed_pattern?(line)
         allowed_patterns.any? { |pattern| Regexp.new(pattern).match?(line) }
       end
 
-      # @deprecated Use matches_allowed_pattern?? instead
-      alias matches_ignored_pattern? matches_allowed_pattern?
+      # @deprecated Use matches_allowed_pattern? instead
+      def matches_ignored_pattern?
+        warn Rainbow(<<~WARNING).yellow, uplevel: 1
+          `matches_ignored_pattern?` is deprecated. Use `matches_allowed_pattern?` instead.
+        WARNING
+
+        matches_allowed_pattern?
+      end
 
       def allowed_patterns
         # Since there could be a pattern specified in the default config, merge the two

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

@@ -4,11 +4,15 @@ module RuboCop
   module Cop
     # Handles `Max` configuration parameters, especially setting them to an
     # appropriate value with --auto-gen-config.
-    # @deprecated Use `exclude_limit ParameterName` instead.
+    # @deprecated Use `exclude_limit <ParameterName>` instead.
     module ConfigurableMax
       private
 
       def max=(value)
+        warn Rainbow(<<~WARNING).yellow, uplevel: 1
+          `max=` is deprecated. Use `exclude_limit <ParameterName>` instead.
+        WARNING
+
         cfg = config_to_allow_offenses
         cfg[:exclude_limit] ||= {}
         current_max = cfg[:exclude_limit][max_parameter_name]

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

@@ -18,6 +18,10 @@ module RuboCop
 
       # @deprecated Use ResbodyNode#exceptions instead
       def rescued_exceptions(resbody)
+        warn Rainbow(<<~WARNING).yellow, uplevel: 1
+          `rescued_exceptions` is deprecated. Use `ResbodyNode#exceptions` instead.
+        WARNING
+
         rescue_group, = *resbody
         if rescue_group
           rescue_group.values

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

@@ -3,59 +3,75 @@
 module RuboCop
   module Cop
     module Naming
-      # Checks that predicate methods names end with a question mark and
+      # Checks that predicate method names end with a question mark and
       # do not start with a forbidden prefix.
       #
-      # A method is determined to be a predicate method if its name starts
-      # with one of the prefixes defined in the `NamePrefix` configuration.
-      # You can change what prefixes are considered by changing this option.
-      # Any method name that starts with one of these prefixes is required by
-      # the cop to end with a `?`. Other methods can be allowed by adding to
-      # the `AllowedMethods` configuration.
+      # A method is determined to be a predicate method if its name starts with
+      # one of the prefixes listed in the `NamePrefix` configuration. The list
+      # defaults to `is_`, `has_`, and `have_` but may be overridden.
       #
-      # NOTE: The `is_a?` method is allowed by default.
+      # Predicate methods must end with a question mark.
       #
-      # If `ForbiddenPrefixes` is set, methods that start with the configured
-      # prefixes will not be allowed and will be removed by autocorrection.
+      # When `ForbiddenPrefixes` is also set (as it is by default), predicate
+      # methods which begin with a forbidden prefix are not allowed, even if
+      # they end with a `?`. These methods should be changed to remove the
+      # prefix.
       #
-      # In other words, if `ForbiddenPrefixes` is empty, a method named `is_foo`
-      # will register an offense only due to the lack of question mark (and will be
-      # autocorrected to `is_foo?`). If `ForbiddenPrefixes` contains `is_`,
-      # `is_foo` will register an offense both because the ? is missing and because of
-      # the `is_` prefix, and will be corrected to `foo?`.
-      #
-      # NOTE: `ForbiddenPrefixes` is only applied to prefixes in `NamePrefix`;
-      # a prefix in the former but not the latter will not be considered by
-      # this cop.
-      #
-      # @example
+      # @example NamePrefix: ['is_', 'has_', 'have_'] (default)
       #   # bad
       #   def is_even(value)
       #   end
       #
-      #   def is_even?(value)
+      #   # When ForbiddenPrefixes: ['is_', 'has_', 'have_'] (default)
+      #   # good
+      #   def even?(value)
       #   end
       #
+      #   # When ForbiddenPrefixes: []
       #   # good
-      #   def even?(value)
+      #   def is_even?(value)
       #   end
       #
+      # @example NamePrefix: ['seems_to_be_']
       #   # bad
-      #   def has_value
+      #   def seems_to_be_even(value)
       #   end
       #
-      #   def has_value?
+      #   # When ForbiddenPrefixes: ['seems_to_be_']
+      #   # good
+      #   def even?(value)
       #   end
       #
+      #   # When ForbiddenPrefixes: []
       #   # good
-      #   def value?
+      #   def seems_to_be_even?(value)
       #   end
       #
       # @example AllowedMethods: ['is_a?'] (default)
+      #   # Despite starting with the `is_` prefix, this method is allowed
       #   # good
       #   def is_a?(value)
       #   end
       #
+      # @example AllowedMethods: ['is_even?']
+      #   # good
+      #   def is_even?(value)
+      #   end
+      #
+      # @example MethodDefinitionMacros: ['define_method', 'define_singleton_method'] (default)
+      #   # bad
+      #   define_method(:is_even) { |value| }
+      #
+      #   # good
+      #   define_method(:even?) { |value| }
+      #
+      # @example MethodDefinitionMacros: ['def_node_matcher']
+      #   # bad
+      #   def_node_matcher(:is_even) { |value| }
+      #
+      #   # good
+      #   # def_node_matcher(:even?) { |value| }
+      #
       class PredicateName < Base
         include AllowedMethods
 
@@ -93,6 +109,16 @@ module RuboCop
         end
         alias on_defs on_def
 
+        def validate_config
+          forbidden_prefixes.each do |forbidden_prefix|
+            next if predicate_prefixes.include?(forbidden_prefix)
+
+            raise ValidationError, <<~MSG.chomp
+              The `Naming/PredicateName` cop is misconfigured. Prefix #{forbidden_prefix} must be included in NamePrefix because it is included in ForbiddenPrefixes.
+            MSG
+          end
+        end
+
         private
 
         def allowed_method_name?(method_name, prefix)

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

@@ -113,13 +113,21 @@ module RuboCop
           end
         end
 
+        # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
         def correct_node(corrector, node, offending_name, preferred_name)
           return unless node
 
           node.each_node(:lvar, :lvasgn, :masgn) do |child_node|
             next unless variable_name_matches?(child_node, offending_name)
 
-            corrector.replace(child_node, preferred_name) if child_node.lvar_type?
+            if child_node.lvar_type?
+              parent_node = child_node.parent
+              if parent_node.respond_to?(:value_omission?) && parent_node.value_omission?
+                corrector.insert_after(parent_node.loc.operator, " #{preferred_name}")
+              else
+                corrector.replace(child_node, preferred_name)
+              end
+            end
 
             if child_node.masgn_type? || child_node.lvasgn_type?
               correct_reassignment(corrector, child_node, offending_name, preferred_name)
@@ -127,6 +135,7 @@ module RuboCop
             end
           end
         end
+        # rubocop:enable Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
 
         # If the exception variable is reassigned, that assignment needs to be corrected.
         # Further `lvar` nodes will not be corrected though since they now refer to a

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

@@ -148,7 +148,7 @@ module RuboCop
 
           restarg, kwrestarg, blockarg = extract_forwardable_args(node.arguments)
           forwardable_args = redundant_forwardable_named_args(restarg, kwrestarg, blockarg)
-          send_nodes = node.each_descendant(:send, :csend, :super).to_a
+          send_nodes = node.each_descendant(:send, :csend, :super, :yield).to_a
 
           send_classifications = classify_send_nodes(
             node, send_nodes, non_splat_or_block_pass_lvar_references(node.body), forwardable_args

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

@@ -28,8 +28,6 @@ module RuboCop
       #   # good (without parentheses it's a syntax error)
       #   def foo() do_something end
       #
-      # @example
-      #
       #   # bad
       #   def Baz.foo()
       #     do_something

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

@@ -16,7 +16,6 @@ module RuboCop
       #   # good
       #   5.times { }
       #
-      # @example
       #   # bad
       #   (0...10).each {}
       #

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

@@ -17,6 +17,18 @@ module RuboCop
       # will not attempt to automatically add a binding, or add filename and
       # line values.
       #
+      # NOTE: This cop works only when a string literal is given as a code string.
+      # No offense is reported if a string variable is given as below:
+      #
+      # [source,ruby]
+      # ----
+      # code = <<-RUBY
+      #   def do_something
+      #   end
+      # RUBY
+      # eval code # not checked.
+      # ----
+      #
       # @example
       #   # bad
       #   eval <<-RUBY
@@ -42,17 +54,6 @@ module RuboCop
       #     end
       #   RUBY
       #
-      # This cop works only when a string literal is given as a code string.
-      # No offense is reported if a string variable is given as below:
-      #
-      # @example
-      #   # not checked
-      #   code = <<-RUBY
-      #     def do_something
-      #     end
-      #   RUBY
-      #   eval code
-      #
       class EvalWithLocation < Base
         extend AutoCorrector
 

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

@@ -6,8 +6,7 @@ module RuboCop
       # Favor `File.(bin)read` convenience methods.
       #
       # @example
-      #   ## text mode
-      #   # bad
+      #   # bad - text mode
       #   File.open(filename).read
       #   File.open(filename, &:read)
       #   File.open(filename) { |f| f.read }
@@ -23,9 +22,7 @@ module RuboCop
       #   # good
       #   File.read(filename)
       #
-      # @example
-      #   ## binary mode
-      #   # bad
+      #   # bad - binary mode
       #   File.open(filename, 'rb').read
       #   File.open(filename, 'rb', &:read)
       #   File.open(filename, 'rb') do |f|

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

@@ -17,8 +17,7 @@ module RuboCop
       # ----
       #
       # @example
-      #   ## text mode
-      #   # bad
+      #   # bad - text mode
       #   File.open(filename, 'w').write(content)
       #   File.open(filename, 'w') do |f|
       #     f.write(content)
@@ -27,9 +26,7 @@ module RuboCop
       #   # good
       #   File.write(filename, content)
       #
-      # @example
-      #   ## binary mode
-      #   # bad
+      #   # bad - binary mode
       #   File.open(filename, 'wb').write(content)
       #   File.open(filename, 'wb') do |f|
       #     f.write(content)

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

@@ -44,7 +44,9 @@ module RuboCop
         PATTERN
 
         def on_const(node)
-          const_name = node.children[1]
+          return if namespaced?(node)
+
+          const_name = node.short_name
           return unless STD_STREAMS.include?(const_name)
 
           gvar_name = gvar_name(const_name).to_sym
@@ -61,6 +63,10 @@ module RuboCop
           format(MSG, gvar_name: gvar_name(const_name), const_name: const_name)
         end
 
+        def namespaced?(node)
+          !node.namespace.nil? && (node.relative? || !node.namespace.cbase_type?)
+        end
+
         def gvar_name(const_name)
           "$#{const_name.to_s.downcase}"
         end

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

@@ -23,9 +23,9 @@ module RuboCop
       #   {foo: 1, bar: 2, baz: 3}.reject {|k, v| k == :bar }
       #   {foo: 1, bar: 2, baz: 3}.select {|k, v| k != :bar }
       #   {foo: 1, bar: 2, baz: 3}.filter {|k, v| k != :bar }
-      #   {foo: 1, bar: 2, baz: 3}.reject {|k, v| %i[foo bar].include?(k) }
-      #   {foo: 1, bar: 2, baz: 3}.select {|k, v| !%i[foo bar].include?(k) }
-      #   {foo: 1, bar: 2, baz: 3}.filter {|k, v| !%i[foo bar].include?(k) }
+      #   {foo: 1, bar: 2, baz: 3}.reject {|k, v| %i[bar].include?(k) }
+      #   {foo: 1, bar: 2, baz: 3}.select {|k, v| !%i[bar].include?(k) }
+      #   {foo: 1, bar: 2, baz: 3}.filter {|k, v| !%i[bar].include?(k) }
       #
       #   # good
       #   {foo: 1, bar: 2, baz: 3}.except(:bar)
@@ -73,8 +73,9 @@ module RuboCop
         PATTERN
 
         def on_send(node)
+          method_name = node.method_name
           block = node.parent
-          return unless bad_method?(block) && semantically_except_method?(node, block)
+          return unless bad_method?(method_name, block) && semantically_except_method?(node, block)
 
           except_key = except_key(block)
           return if except_key.nil? || !safe_to_register_offense?(block, except_key)
@@ -91,7 +92,7 @@ module RuboCop
         private
 
         # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-        def bad_method?(block)
+        def bad_method?(method_name, 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
@@ -103,6 +104,8 @@ module RuboCop
             end
           else
             bad_method_with_poro?(block) do |key_arg, send_node|
+              return false if method_name == :reject && block.body.method?(:!)
+
               !send_node.method?(:include?) || send_node.first_argument&.source == key_arg.source
             end
           end

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

@@ -44,7 +44,6 @@ module RuboCop
       #   # good
       #   foo == bar
       #
-      # @example
       #   # bad
       #   if foo.do_something?
       #     true

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

@@ -72,8 +72,8 @@ module RuboCop
 
         private
 
-        def invertible?(node)
-          case node.type
+        def invertible?(node) # rubocop:disable Metrics/CyclomaticComplexity
+          case node&.type
           when :begin
             invertible?(node.children.first)
           when :send