rubocop 1.68.0 → 1.69.1

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

@@ -32,6 +32,22 @@ module RuboCop
       class UnreachableCode < Base
         MSG = 'Unreachable code detected.'
 
+        def initialize(config = nil, options = nil)
+          super
+          @redefined = []
+          @instance_eval_count = 0
+        end
+
+        def on_block(node)
+          @instance_eval_count += 1 if instance_eval_block?(node)
+        end
+
+        alias on_numblock on_block
+
+        def after_block(node)
+          @instance_eval_count -= 1 if instance_eval_block?(node)
+        end
+
         def on_begin(node)
           expressions = *node
 
@@ -46,19 +62,23 @@ module RuboCop
 
         private
 
+        def redefinable_flow_method?(method)
+          %i[raise fail throw exit exit! abort].include? method
+        end
+
         # @!method flow_command?(node)
         def_node_matcher :flow_command?, <<~PATTERN
           {
             return next break retry redo
             (send
              {nil? (const {nil? cbase} :Kernel)}
-             {:raise :fail :throw :exit :exit! :abort}
+             #redefinable_flow_method?
              ...)
           }
         PATTERN
 
         def flow_expression?(node)
-          return true if flow_command?(node)
+          return report_on_flow_command?(node) if flow_command?(node)
 
           case node.type
           when :begin, :kwbegin
@@ -68,6 +88,8 @@ module RuboCop
             check_if(node)
           when :case, :case_match
             check_case(node)
+          when :def
+            register_redefinition(node)
           else
             false
           end
@@ -88,6 +110,33 @@ module RuboCop
 
           branches.all? { |branch| branch.body && flow_expression?(branch.body) }
         end
+
+        def register_redefinition(node)
+          @redefined << node.method_name if redefinable_flow_method? node.method_name
+          false
+        end
+
+        def instance_eval_block?(node)
+          node.block_type? && node.method?(:instance_eval)
+        end
+
+        def report_on_flow_command?(node)
+          return true unless node.send_type?
+
+          # By the contract of this function, this case means that
+          # the method is called on `Kernel` in which case we
+          # always want to report a warning.
+          return true if node.receiver
+
+          # Inside an `instance_eval` we have no way to tell the
+          # type of `self` just by looking at the AST, so we can't
+          # tell if the give function that's called has been
+          # redefined or not, so to avoid false positives, we silence
+          # the warning.
+          return false if @instance_eval_count.positive?
+
+          !@redefined.include? node.method_name
+        end
       end
     end
   end

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

@@ -39,6 +39,8 @@ module RuboCop
       #   end
       #
       # @example IgnoreNotImplementedMethods: true (default)
+      #   # with default value of `NotImplementedExceptions: ['NotImplementedError']`
+      #
       #   # good
       #   def do_something(unused)
       #     raise NotImplementedError
@@ -48,6 +50,14 @@ module RuboCop
       #     fail "TODO"
       #   end
       #
+      # @example IgnoreNotImplementedMethods: true
+      #   # with `NotImplementedExceptions: ['AbstractMethodError']`
+      #
+      #   # good
+      #   def do_something(unused)
+      #     raise AbstractMethodError
+      #   end
+      #
       # @example IgnoreNotImplementedMethods: false
       #   # bad
       #   def do_something(unused)
@@ -57,14 +67,13 @@ module RuboCop
       #   def do_something_else(unused)
       #     fail "TODO"
       #   end
-      #
       class UnusedMethodArgument < Base
         include UnusedArgument
         extend AutoCorrector
 
         # @!method not_implemented?(node)
         def_node_matcher :not_implemented?, <<~PATTERN
-          {(send nil? :raise (const {nil? cbase} :NotImplementedError) ...)
+          {(send nil? :raise #allowed_exception_class? ...)
            (send nil? :fail ...)}
         PATTERN
 
@@ -115,6 +124,13 @@ module RuboCop
 
           message
         end
+
+        def allowed_exception_class?(node)
+          return false unless node.const_type?
+
+          allowed_class_names = Array(cop_config.fetch('NotImplementedExceptions', []))
+          allowed_class_names.include?(node.const_name)
+        end
       end
     end
   end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Lint
+      # Checks for calls to `defined?` with strings or symbols as the argument.
+      # Such calls will always return `'expression'`, you probably meant to
+      # check for the existence of a constant, method, or variable instead.
+      #
+      # `defined?` is part of the Ruby syntax and doesn't behave like normal methods.
+      # You can safely pass in what you are checking for directly, without encountering
+      # a `NameError`.
+      #
+      # When interpolation is used, oftentimes it is not possible to write the
+      # code with `defined?`. In these cases, switch to one of the more specific methods:
+      #
+      # * `class_variable_defined?`
+      # * `const_defined?`
+      # * `method_defined?`
+      # * `instance_variable_defined?`
+      # * `binding.local_variable_defined?`
+      #
+      # @example
+      #
+      #   # bad
+      #   defined?('FooBar')
+      #   defined?(:FooBar)
+      #   defined?(:foo_bar)
+      #   defined?('foo_bar')
+      #
+      #   # good
+      #   defined?(FooBar)
+      #   defined?(foo_bar)
+      #
+      #   # bad - interpolation
+      #   bar = 'Bar'
+      #   defined?("Foo::#{bar}::Baz")
+      #
+      #   # good
+      #   bar = 'Bar'
+      #   defined?(Foo) && Foo.const_defined?(bar) && Foo.const_get(bar).const_defined?(:Baz)
+      class UselessDefined < Base
+        MSG = 'Calling `defined?` with a %<type>s argument will always return a truthy value.'
+        TYPES = { str: 'string', dstr: 'string', sym: 'symbol', dsym: 'symbol' }.freeze
+
+        def on_defined?(node)
+          # NOTE: `defined?` always takes one argument. Anything else is a syntax error.
+          return unless (type = TYPES[node.first_argument.type])
+
+          add_offense(node, message: format(MSG, type: type))
+        end
+      end
+    end
+  end
+end

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

@@ -25,8 +25,12 @@ module RuboCop
       #     do_something_else
       #   end
       class UselessElseWithoutRescue < Base
+        extend TargetRubyVersion
+
         MSG = '`else` without `rescue` is useless.'
 
+        maximum_target_ruby_version 2.5
+
         def on_new_investigation
           processed_source.diagnostics.each do |diagnostic|
             next unless diagnostic.reason == :useless_else

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

@@ -75,7 +75,7 @@ module RuboCop
         def use_exception_variable_in_ensure?(resbody_node)
           return false unless (exception_variable = resbody_node.exception_variable)
           return false unless (ensure_node = resbody_node.each_ancestor(:ensure).first)
-          return false unless (ensure_body = ensure_node.body)
+          return false unless (ensure_body = ensure_node.branch)
 
           ensure_body.each_descendant(:lvar).map(&:source).include?(exception_variable.source)
         end

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

@@ -102,24 +102,18 @@ module RuboCop
             when :op_asgn
               process_binary_operator_assignment(node)
             when *ASSIGNMENT_TYPES
-              _, rhs_node = *node
-              process_assignment(node, rhs_node) if rhs_node
+              process_assignment(node, node.rhs) if node.rhs
             end
           end
 
           def process_multiple_assignment(masgn_node)
-            mlhs_node, mrhs_node = *masgn_node
-
-            mlhs_node.children.each_with_index do |lhs_node, index|
+            masgn_node.assignments.each_with_index do |lhs_node, index|
               next unless ASSIGNMENT_TYPES.include?(lhs_node.type)
 
-              lhs_variable_name, = *lhs_node
-              rhs_node = mrhs_node.children[index]
-
-              if mrhs_node.array_type? && rhs_node
-                process_assignment(lhs_variable_name, rhs_node)
+              if masgn_node.rhs.array_type? && (rhs_node = masgn_node.rhs.children[index])
+                process_assignment(lhs_node, rhs_node)
               else
-                @local[lhs_variable_name] = true
+                @local[lhs_node.name] = true
               end
             end
 
@@ -127,33 +121,28 @@ module RuboCop
           end
 
           def process_logical_operator_assignment(asgn_node)
-            lhs_node, rhs_node = *asgn_node
-            return unless ASSIGNMENT_TYPES.include?(lhs_node.type)
+            return unless ASSIGNMENT_TYPES.include?(asgn_node.lhs.type)
 
-            process_assignment(lhs_node, rhs_node)
+            process_assignment(asgn_node.lhs, asgn_node.rhs)
 
             throw :skip_children
           end
 
           def process_binary_operator_assignment(op_asgn_node)
-            lhs_node, = *op_asgn_node
+            lhs_node = op_asgn_node.lhs
             return unless ASSIGNMENT_TYPES.include?(lhs_node.type)
 
-            lhs_variable_name, = *lhs_node
-            @local[lhs_variable_name] = true
+            @local[lhs_node.name] = true
 
             throw :skip_children
           end
 
           def process_assignment(asgn_node, rhs_node)
-            lhs_variable_name, = *asgn_node
-
-            @local[lhs_variable_name] = if rhs_node.variable?
-                                          rhs_variable_name, = *rhs_node
-                                          @local[rhs_variable_name]
-                                        else
-                                          constructor?(rhs_node)
-                                        end
+            @local[asgn_node.name] = if rhs_node.variable?
+                                       @local[rhs_node.name]
+                                     else
+                                       constructor?(rhs_node)
+                                     end
           end
 
           def constructor?(node)

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

@@ -126,7 +126,7 @@ module RuboCop
 
         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 unless node.call_type? && OPERATORS.include?(node.method_name)
           return if block && yield(node)
 
           add_offense(node.loc.selector,
@@ -196,7 +196,7 @@ module RuboCop
         end
 
         def check_ensure(node)
-          return unless (body = node.body)
+          return unless (body = node.branch)
           # NOTE: the `begin` node case is already handled via `on_begin`
           return if body.begin_type?
 
@@ -219,6 +219,7 @@ module RuboCop
           if node.arguments.empty?
             corrector.replace(node, node.receiver.source)
           else
+            corrector.remove(node.loc.dot) if node.loc.dot
             corrector.replace(
               range_with_surrounding_space(range: node.loc.selector, side: :both,
                                            newlines: false),

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

@@ -53,13 +53,13 @@ module RuboCop
         def on_casgn(node)
           parent = node.parent
 
-          if parent&.assignment?
-            block_node = parent.children[1]
-          elsif parent&.parent&.masgn_type?
-            block_node = parent.parent.children[1]
-          else
-            _scope, _name, block_node = *node
-          end
+          block_node = if parent&.assignment?
+                         parent.expression
+                       elsif parent&.parent&.masgn_type?
+                         parent.parent.expression
+                       else
+                         node.expression
+                       end
 
           return unless block_node.respond_to?(:class_definition?) && block_node.class_definition?
 

data/lib/rubocop/cop/metrics/utils/abc_size_calculator.rb

@@ -95,7 +95,7 @@ module RuboCop
           def compound_assignment(node)
             # Methods setter cannot be detected for multiple assignments
             # and shorthand assigns, so we'll count them here instead
-            children = node.masgn_type? ? node.children[0].children : node.children
+            children = node.masgn_type? ? node.assignments : node.children
 
             will_be_miscounted = children.count do |child|
               child.respond_to?(:setter_method?) && !child.setter_method?

data/lib/rubocop/cop/metrics/utils/code_length_calculator.rb

@@ -9,7 +9,7 @@ module RuboCop
           extend NodePattern::Macros
           include Util
 
-          FOLDABLE_TYPES = %i[array hash heredoc send csend].freeze
+          FOLDABLE_TYPES = %i[array hash heredoc method_call].freeze
           CLASSLIKE_TYPES = %i[class module].freeze
           private_constant :FOLDABLE_TYPES, :CLASSLIKE_TYPES
 
@@ -148,8 +148,7 @@ module RuboCop
             when :class, :module, :sclass, :block, :numblock, :def, :defs
               node.body
             when :casgn
-              _scope, _name, value = *node
-              extract_body(value)
+              extract_body(node.expression)
             else
               node
             end

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

@@ -17,9 +17,7 @@ module RuboCop
       alias on_and_asgn on_lvasgn
 
       def on_send(node)
-        rhs = extract_rhs(node)
-
-        return unless rhs
+        return unless (rhs = extract_rhs(node))
 
         check_assignment(node, rhs)
       end
@@ -27,17 +25,11 @@ module RuboCop
       module_function
 
       def extract_rhs(node)
-        if node.casgn_type?
-          _scope, _lhs, rhs = *node
-        elsif node.op_asgn_type?
-          _lhs, _op, rhs = *node
-        elsif node.call_type?
-          rhs = node.last_argument
+        if node.call_type?
+          node.last_argument
         elsif node.assignment?
-          _lhs, rhs = *node
+          node.expression
         end
-
-        rhs
       end
     end
   end

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/accessor_method_name.rb

@@ -3,13 +3,13 @@
 module RuboCop
   module Cop
     module Naming
-      # Makes sure that accessor methods are named properly. Applies
-      # to both instance and class methods.
+      # Avoid prefixing accessor method names with `get_` or `set_`.
+      # Applies to both instance and class methods.
       #
-      # NOTE: Offenses are only registered for methods with the expected
-      # arity. Getters (`get_attribute`) must have no arguments to be
-      # registered, and setters (`set_attribute(value)`) must have exactly
-      # one.
+      # NOTE: Method names starting with `get_` or `set_` only register an offense
+      # when the methods match the expected arity for getters and setters respectively.
+      # Getters (`get_attribute`) must have no arguments to be registered,
+      # and setters (`set_attribute(value)`) must have exactly one.
       #
       # @example
       #   # bad

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`.'