rubocop 1.65.0 → 1.66.1

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

@@ -17,8 +17,6 @@ module RuboCop
       #     end
       #   end
       #
-      # @example
-      #
       #   # good
       #
       #   def foo
@@ -26,8 +24,6 @@ module RuboCop
       #     bar.call
       #   end
       #
-      # @example
-      #
       #   # good
       #
       #   # `class_eval`, `instance_eval`, `module_eval`, `class_exec`, `instance_exec`, and
@@ -47,8 +43,6 @@ module RuboCop
       #     end
       #   end
       #
-      # @example
-      #
       #   # good
       #
       #   def foo

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

@@ -8,16 +8,12 @@ module RuboCop
       # @example
       #
       #   # bad
-      #
       #   result = (1..4).reduce(0) do |acc, i|
       #     next if i.odd?
       #     acc + i
       #   end
       #
-      # @example
-      #
       #   # good
-      #
       #   result = (1..4).reduce(0) do |acc, i|
       #     next acc if i.odd?
       #     acc + i

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

@@ -11,17 +11,13 @@ module RuboCop
       # @example
       #
       #   # bad
-      #
       #   @some_variable ||= begin
       #     return some_value if some_condition_is_met
       #
       #     do_something
       #   end
       #
-      # @example
-      #
       #   # good
-      #
       #   @some_variable ||= begin
       #     if some_condition_is_met
       #       some_value
@@ -31,7 +27,6 @@ module RuboCop
       #   end
       #
       #   # good
-      #
       #   some_variable = if some_condition_is_met
       #                     return if another_condition_is_met
       #

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

@@ -22,13 +22,9 @@ module RuboCop
       # @example
       #
       #   # bad
-      #
       #   %w('foo', "bar")
       #
-      # @example
-      #
       #   # good
-      #
       #   %w(foo bar)
       class PercentStringArray < Base
         include PercentLiteral

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

@@ -12,13 +12,9 @@ module RuboCop
       # @example
       #
       #   # bad
-      #
       #   %i(:foo, :bar)
       #
-      # @example
-      #
       #   # good
-      #
       #   %i(foo bar)
       class PercentSymbolArray < Base
         include PercentLiteral

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

@@ -9,16 +9,12 @@ module RuboCop
       # @example
       #
       #   # bad
-      #
       #   rand 1
       #   Kernel.rand(-1)
       #   rand 1.0
       #   rand(-1.0)
       #
-      # @example
-      #
       #   # good
-      #
       #   0 # just use 0 instead
       class RandOne < Base
         MSG = '`%<method>s` always returns `0`. Perhaps you meant `rand(2)` or `rand`?'

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

@@ -14,14 +14,16 @@ module RuboCop
       #
       # When comment enables all cops at once `rubocop:enable all`
       # that cop checks whether any cop was actually enabled.
+      #
       # @example
+      #
       #   # bad
       #   foo = 1
       #   # rubocop:enable Layout/LineLength
       #
       #   # good
       #   foo = 1
-      # @example
+      #
       #   # bad
       #   # rubocop:disable Style/StringLiterals
       #   foo = "1"

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # Checks for unneeded usages of splat expansion
+      # Checks for unneeded usages of splat expansion.
       #
       # @example
       #

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

@@ -9,16 +9,12 @@ module RuboCop
       # @example
       #
       #   # bad
-      #
       #   "result is #{something.to_s}"
       #   print something.to_s
       #   puts something.to_s
       #   warn something.to_s
       #
-      # @example
-      #
       #   # good
-      #
       #   "result is #{something}"
       #   print something
       #   puts something

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

@@ -15,15 +15,11 @@ module RuboCop
       # @example
       #
       #   # bad
-      #
       #   if day.is? :tuesday && month == :jan
       #     # ...
       #   end
       #
-      # @example
-      #
       #   # good
-      #
       #   if day.is?(:tuesday) && month == :jan
       #     # ...
       #   end

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

@@ -8,17 +8,13 @@ module RuboCop
       # @example
       #
       #   # bad
-      #
       #   begin
       #     do_something
       #   rescue Exception
       #     handle_exception
       #   end
       #
-      # @example
-      #
       #   # good
-      #
       #   begin
       #     do_something
       #   rescue ArgumentError

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

@@ -19,8 +19,6 @@ module RuboCop
       #     return 42
       #   end
       #
-      # @example
-      #
       #   # good
       #   def initialize
       #     foo

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

@@ -12,15 +12,11 @@ module RuboCop
       # @example
       #
       #   # bad
-      #
       #   x&.foo.bar
       #   x&.foo + bar
       #   x&.foo[bar]
       #
-      # @example
-      #
       #   # good
-      #
       #   x&.foo&.bar
       #   x&.foo || bar
       class SafeNavigationChain < Base

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

@@ -12,17 +12,16 @@ module RuboCop
       # because `Ractor` should not access outer variables.
       # eg. following style is encouraged:
       #
-      #   [source,ruby]
-      #   ----
-      #   worker_id, pipe = env
-      #   Ractor.new(worker_id, pipe) do |worker_id, pipe|
-      #   end
-      #   ----
+      # [source,ruby]
+      # ----
+      # worker_id, pipe = env
+      # Ractor.new(worker_id, pipe) do |worker_id, pipe|
+      # end
+      # ----
       #
       # @example
       #
       #   # bad
-      #
       #   def some_method
       #     foo = 1
       #
@@ -31,10 +30,7 @@ module RuboCop
       #     end
       #   end
       #
-      # @example
-      #
       #   # good
-      #
       #   def some_method
       #     foo = 1
       #

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

@@ -8,14 +8,10 @@ module RuboCop
       # @example
       #
       #   # bad
-      #
       #   1.is_a?(Fixnum)
       #   1.is_a?(Bignum)
       #
-      # @example
-      #
       #   # good
-      #
       #   1.is_a?(Integer)
       class UnifiedInteger < Base
         extend AutoCorrector

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

@@ -10,14 +10,12 @@ module RuboCop
       # @example
       #
       #   # bad
-      #
       #   def some_method
       #     return
       #     do_something
       #   end
       #
       #   # bad
-      #
       #   def some_method
       #     if cond
       #       return
@@ -27,10 +25,7 @@ module RuboCop
       #     do_something
       #   end
       #
-      # @example
-      #
       #   # good
-      #
       #   def some_method
       #     do_something
       #   end

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

@@ -16,28 +16,23 @@ module RuboCop
       # reassignments and properly handles varied cases such as branch, loop,
       # rescue, ensure, etc.
       #
+      # This cop's autocorrection avoids cases like `a ||= 1` because removing assignment from
+      # operator assignment can cause NameError if this assignment has been used to declare
+      # a local variable. For example, replacing `a ||= 1` with `a || 1` may cause
+      # "undefined local variable or method `a' for main:Object (NameError)".
+      #
       # NOTE: Given the assignment `foo = 1, bar = 2`, removing unused variables
       # can lead to a syntax error, so this case is not autocorrected.
       #
-      # @safety
-      #   This cop's autocorrection is unsafe because removing assignment from
-      #   operator assignment can cause NameError if this assignment has been used to declare
-      #   local variable. For example, replacing `a ||= 1` to `a || 1` may cause
-      #   "undefined local variable or method `a' for main:Object (NameError)".
-      #
       # @example
       #
       #   # bad
-      #
       #   def some_method
       #     some_var = 1
       #     do_something
       #   end
       #
-      # @example
-      #
       #   # good
-      #
       #   def some_method
       #     some_var = 1
       #     do_something(some_var)
@@ -57,24 +52,32 @@ module RuboCop
           scope.variables.each_value { |variable| check_for_unused_assignments(variable) }
         end
 
-        # rubocop:disable Metrics/AbcSize
+        # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
         def check_for_unused_assignments(variable)
           return if variable.should_be_unused?
 
-          variable.assignments.each do |assignment|
-            next if assignment.used? || part_of_ignored_node?(assignment.node)
+          variable.assignments.reverse_each do |assignment|
+            assignment_node = assignment.node
+            next if assignment.used? || part_of_ignored_node?(assignment_node)
 
             message = message_for_useless_assignment(assignment)
             range = offense_range(assignment)
 
             add_offense(range, message: message) do |corrector|
-              autocorrect(corrector, assignment) unless sequential_assignment?(assignment.node)
+              # In cases like `x = 1, y = 2`, where removing a variable would cause a syntax error,
+              # and where changing `x ||= 1` to `x = 1` would cause `NameError`,
+              # the autocorrect will be skipped, even if the variable is unused.
+              if sequential_assignment?(assignment_node) || assignment_node.parent&.or_asgn_type?
+                next
+              end
+
+              autocorrect(corrector, assignment)
             end
 
-            ignore_node(assignment.node) if chained_assignment?(assignment.node)
+            ignore_node(assignment_node) if chained_assignment?(assignment_node)
           end
         end
-        # rubocop:enable Metrics/AbcSize
+        # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 
         def message_for_useless_assignment(assignment)
           variable = assignment.variable

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_numeric_operation.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Lint
+      # Certain numeric operations have no impact, being:
+      # Adding or subtracting 0, multiplying or dividing by 1 or raising to the power of 1.
+      # These are probably leftover from debugging, or are mistakes.
+      #
+      # @example
+      #
+      #   # bad
+      #   x + 0
+      #   x - 0
+      #   x * 1
+      #   x / 1
+      #   x ** 1
+      #
+      #   # good
+      #   x
+      #
+      #   # bad
+      #   x += 0
+      #   x -= 0
+      #   x *= 1
+      #   x /= 1
+      #   x **= 1
+      #
+      #   # good
+      #   x = x
+      #
+      class UselessNumericOperation < Base
+        extend AutoCorrector
+        MSG = 'Do not apply inconsequential numeric operations to variables.'
+        RESTRICT_ON_SEND = %i[+ - * / **].freeze
+
+        # @!method useless_operation?(node)
+        def_node_matcher :useless_operation?, '(send (send nil? $_) $_ (int $_))'
+
+        # @!method useless_abbreviated_assignment?(node)
+        def_node_matcher :useless_abbreviated_assignment?, '(op-asgn (lvasgn $_) $_ (int $_))'
+
+        def on_send(node)
+          return unless useless_operation?(node)
+
+          variable, operation, number = useless_operation?(node)
+          return unless useless?(operation, number)
+
+          add_offense(node) do |corrector|
+            corrector.replace(node, variable)
+          end
+        end
+
+        def on_op_asgn(node)
+          return unless useless_abbreviated_assignment?(node)
+
+          variable, operation, number = useless_abbreviated_assignment?(node)
+          return unless useless?(operation, number)
+
+          add_offense(node) do |corrector|
+            corrector.replace(node, "#{variable} = #{variable}")
+          end
+        end
+
+        private
+
+        def useless?(operation, number)
+          if number.zero?
+            true if %i[+ -].include?(operation)
+          elsif number == 1
+            true if %i[* / **].include?(operation)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -66,7 +66,6 @@ module RuboCop
         BINARY_OPERATORS = %i[* / % + - == === != < > <= >= <=>].freeze
         UNARY_OPERATORS = %i[+@ -@ ~ !].freeze
         OPERATORS = (BINARY_OPERATORS + UNARY_OPERATORS).freeze
-        VOID_CONTEXT_TYPES = %i[def for block].freeze
         NONMUTATING_METHODS_WITH_BANG_VERSION = %i[capitalize chomp chop compact
                                                    delete_prefix delete_suffix downcase
                                                    encode flatten gsub lstrip merge next
@@ -86,7 +85,6 @@ module RuboCop
           check_void_op(node.body) { node.method?(:each) }
           check_expression(node.body)
         end
-
         alias on_numblock on_block
 
         def on_begin(node)
@@ -94,6 +92,10 @@ module RuboCop
         end
         alias on_kwbegin on_begin
 
+        def on_ensure(node)
+          check_ensure(node)
+        end
+
         private
 
         def check_begin(node)
@@ -193,12 +195,24 @@ module RuboCop
           end
         end
 
+        def check_ensure(node)
+          return unless (body = node.body)
+          # NOTE: the `begin` node case is already handled via `on_begin`
+          return if body.begin_type?
+
+          check_void_op(body) do
+            block_node = node.each_ancestor(:block).first
+            block_node&.method?(:each)
+          end
+
+          check_expression(body)
+        end
+
         def in_void_context?(node)
           parent = node.parent
-
           return false unless parent && parent.children.last == node
 
-          VOID_CONTEXT_TYPES.include?(parent.type) && parent.void_context?
+          parent.respond_to?(:void_context?) && parent.void_context?
         end
 
         def autocorrect_void_op(corrector, node)
@@ -231,15 +245,23 @@ module RuboCop
         def entirely_literal?(node)
           case node.type
           when :array
-            node.each_value.all? { |value| entirely_literal?(value) }
+            all_values_entirely_literal?(node)
           when :hash
-            return false unless node.each_key.all? { |key| entirely_literal?(key) }
-
-            node.each_value.all? { |value| entirely_literal?(value) }
+            all_keys_entirely_literal?(node) && all_values_entirely_literal?(node)
+          when :send, :csend
+            node.method?(:freeze) && node.receiver && entirely_literal?(node.receiver)
           else
             node.literal?
           end
         end
+
+        def all_keys_entirely_literal?(node)
+          node.each_key.all? { |key| entirely_literal?(key) }
+        end
+
+        def all_values_entirely_literal?(node)
+          node.each_value.all? { |value| entirely_literal?(value) }
+        end
       end
     end
   end

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

@@ -9,8 +9,9 @@ module RuboCop
       # The cop can be configured to ignore blocks passed to certain methods.
       #
       # You can set constructs you want to fold with `CountAsOne`.
-      # Available are: 'array', 'hash', 'heredoc', and 'method_call'. Each construct
-      # will be counted as one line regardless of its actual size.
+      #
+      # Available are: 'array', 'hash', 'heredoc', and 'method_call'.
+      # Each construct will be counted as one line regardless of its actual size.
       #
       # NOTE: This cop does not apply for `Struct` definitions.
       #
@@ -18,7 +19,7 @@ module RuboCop
       # for backwards compatibility. Please use `AllowedMethods` and `AllowedPatterns`
       # instead. By default, there are no methods to allowed.
       #
-      # @example CountAsOne: ['array', 'heredoc', 'method_call']
+      # @example CountAsOne: ['array', 'hash', 'heredoc', 'method_call']
       #
       #   something do
       #     array = [         # +1
@@ -26,7 +27,7 @@ module RuboCop
       #       2
       #     ]
       #
-      #     hash = {          # +3
+      #     hash = {          # +1
       #       key: 'value'
       #     }
       #
@@ -39,7 +40,7 @@ module RuboCop
       #       1,
       #       2
       #     )
-      #   end                 # 6 points
+      #   end                 # 4 points
       #
       class BlockLength < Base
         include CodeLength

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

@@ -8,12 +8,13 @@ module RuboCop
       # The maximum allowed length is configurable.
       #
       # You can set constructs you want to fold with `CountAsOne`.
-      # Available are: 'array', 'hash', 'heredoc', and 'method_call'. Each construct
-      # will be counted as one line regardless of its actual size.
+      #
+      # Available are: 'array', 'hash', 'heredoc', and 'method_call'.
+      # Each construct will be counted as one line regardless of its actual size.
       #
       # NOTE: This cop also applies for `Struct` definitions.
       #
-      # @example CountAsOne: ['array', 'heredoc', 'method_call']
+      # @example CountAsOne: ['array', 'hash', 'heredoc', 'method_call']
       #
       #   class Foo
       #     ARRAY = [         # +1
@@ -21,7 +22,7 @@ module RuboCop
       #       2
       #     ]
       #
-      #     HASH = {          # +3
+      #     HASH = {          # +1
       #       key: 'value'
       #     }
       #
@@ -34,7 +35,7 @@ module RuboCop
       #       1,
       #       2
       #     )
-      #   end                 # 6 points
+      #   end                 # 4 points
       #
       class ClassLength < Base
         include CodeLength

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

@@ -8,15 +8,16 @@ module RuboCop
       # The maximum allowed length is configurable.
       #
       # You can set constructs you want to fold with `CountAsOne`.
-      # Available are: 'array', 'hash', 'heredoc', and 'method_call'. Each construct
-      # will be counted as one line regardless of its actual size.
+      #
+      # Available are: 'array', 'hash', 'heredoc', and 'method_call'.
+      # Each construct will be counted as one line regardless of its actual size.
       #
       # NOTE: The `ExcludedMethods` and `IgnoredMethods` configuration is
       # deprecated and only kept for backwards compatibility.
       # Please use `AllowedMethods` and `AllowedPatterns` instead.
       # By default, there are no methods to allowed.
       #
-      # @example CountAsOne: ['array', 'heredoc', 'method_call']
+      # @example CountAsOne: ['array', 'hash', 'heredoc', 'method_call']
       #
       #   def m
       #     array = [       # +1
@@ -24,7 +25,7 @@ module RuboCop
       #       2
       #     ]
       #
-      #     hash = {        # +3
+      #     hash = {        # +1
       #       key: 'value'
       #     }
       #
@@ -37,7 +38,7 @@ module RuboCop
       #       1,
       #       2
       #     )
-      #   end               # 6 points
+      #   end               # 4 points
       #
       class MethodLength < Base
         include CodeLength