rubocop 1.50.2 → 1.68.0

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

@@ -29,6 +29,11 @@ module RuboCop
       #       MyDebugger.debug_this
       # ----
       #
+      # Some gems also ship files that will start a debugging session when required,
+      # for example `require 'debug/start'` from `ruby/debug`. These requires can
+      # be configured through `DebuggerRequires`. It has the same structure as
+      # `DebuggerMethods`, which you can read about above.
+      #
       # @example
       #
       #   # bad (ok during development)
@@ -39,8 +44,6 @@ module RuboCop
       #     do_something
       #   end
       #
-      # @example
-      #
       #   # bad (ok during development)
       #
       #   # using byebug
@@ -49,8 +52,6 @@ module RuboCop
       #     do_something
       #   end
       #
-      # @example
-      #
       #   # good
       #
       #   def some_method
@@ -64,16 +65,20 @@ module RuboCop
       #   def some_method
       #     my_debugger
       #   end
+      #
+      # @example DebuggerRequires: [my_debugger/start]
+      #
+      #   # bad (ok during development)
+      #
+      #   require 'my_debugger/start'
       class Debugger < Base
         MSG = 'Remove debugger entry point `%<source>s`.'
+        BLOCK_TYPES = %i[block numblock kwbegin].freeze
 
         def on_send(node)
-          return unless debugger_method?(node)
-
-          # Basically, debugger methods are not used as a method argument without arguments.
-          return if node.arguments.empty? && node.each_ancestor(:send, :csend).any?
+          return if assumed_usage_context?(node)
 
-          add_offense(node)
+          add_offense(node) if debugger_method?(node) || debugger_require?(node)
         end
 
         private
@@ -89,12 +94,36 @@ module RuboCop
           end
         end
 
+        def debugger_requires
+          @debugger_requires ||= begin
+            config = cop_config.fetch('DebuggerRequires', [])
+            config.is_a?(Array) ? config : config.values.flatten
+          end
+        end
+
         def debugger_method?(send_node)
-          return if send_node.parent&.send_type? && send_node.parent.receiver == send_node
+          return false if send_node.parent&.send_type? && send_node.parent.receiver == send_node
 
           debugger_methods.include?(chained_method_name(send_node))
         end
 
+        def debugger_require?(send_node)
+          return false unless send_node.method?(:require) && send_node.arguments.one?
+          return false unless (argument = send_node.first_argument).str_type?
+
+          debugger_requires.include?(argument.value)
+        end
+
+        def assumed_usage_context?(node)
+          # Basically, debugger methods are not used as a method argument without arguments.
+          return false unless node.arguments.empty? && node.each_ancestor(:send, :csend).any?
+          return true if assumed_argument?(node)
+
+          node.each_ancestor.none? do |ancestor|
+            BLOCK_TYPES.include?(ancestor.type) || ancestor.lambda_or_proc?
+          end
+        end
+
         def chained_method_name(send_node)
           chained_method_name = send_node.method_name.to_s
           receiver = send_node.receiver
@@ -105,6 +134,12 @@ module RuboCop
           end
           chained_method_name
         end
+
+        def assumed_argument?(node)
+          parent = node.parent
+
+          parent.call_type? || parent.literal? || parent.pair_type?
+        end
       end
     end
   end

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

@@ -52,7 +52,7 @@ module RuboCop
         # @!method deprecated_class_method?(node)
         def_node_matcher :deprecated_class_method?, <<~PATTERN
           {
-            (send (const {cbase nil?} {:ENV}) {:clone :dup :freeze})
+            (send (const {cbase nil?} :ENV) {:clone :dup :freeze})
             (send (const {cbase nil?} {:File :Dir}) :exists? _)
             (send (const {cbase nil?} :Socket) {:gethostbyaddr :gethostbyname} ...)
             (send nil? :attr _ boolean)

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

@@ -9,28 +9,18 @@ module RuboCop
       #
       # @example
       #
-      #   # Example for OpenSSL::Cipher instantiation.
-      #
       #   # bad
       #   OpenSSL::Cipher::AES.new(128, :GCM)
       #
       #   # good
       #   OpenSSL::Cipher.new('aes-128-gcm')
       #
-      # @example
-      #
-      #   # Example for OpenSSL::Digest instantiation.
-      #
       #   # bad
       #   OpenSSL::Digest::SHA256.new
       #
       #   # good
       #   OpenSSL::Digest.new('SHA256')
       #
-      # @example
-      #
-      #   # Example for ::Digest inherited class methods.
-      #
       #   # bad
       #   OpenSSL::Digest::SHA256.digest('foo')
       #

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

@@ -15,6 +15,9 @@ module RuboCop
       # With `IgnoreConstantBranches: true`, branches are not registered
       # as offenses if they return a constant value.
       #
+      # With `IgnoreDuplicateElseBranch: true`, in conditionals with multiple branches,
+      # duplicate 'else' branches are not registered as offenses.
+      #
       # @example
       #   # bad
       #   if foo
@@ -83,21 +86,37 @@ module RuboCop
       #   else MEDIUM_SIZE
       #   end
       #
+      # @example IgnoreDuplicateElseBranch: true
+      #   # good
+      #   if foo
+      #     do_foo
+      #   elsif bar
+      #     do_bar
+      #   else
+      #     do_foo
+      #   end
+      #
       class DuplicateBranch < Base
         MSG = 'Duplicate branch body detected.'
 
         def on_branching_statement(node)
-          branches(node).each_with_object(Set.new) do |branch, previous|
-            next unless consider_branch?(branch)
+          branches = branches(node)
+          branches.each_with_object(Set.new) do |branch, previous|
+            next unless consider_branch?(branches, branch)
 
             add_offense(offense_range(branch)) unless previous.add?(branch)
           end
         end
-        alias on_if on_branching_statement
         alias on_case on_branching_statement
         alias on_case_match on_branching_statement
         alias on_rescue on_branching_statement
 
+        def on_if(node)
+          # Ignore 'elsif' nodes, because we don't want to check them separately whether
+          # the 'else' branch is duplicated. We want to check only on the outermost conditional.
+          on_branching_statement(node) unless node.elsif?
+        end
+
         private
 
         def offense_range(duplicate_branch)
@@ -118,10 +137,14 @@ module RuboCop
           node.branches.compact
         end
 
-        def consider_branch?(branch)
+        def consider_branch?(branches, branch)
           return false if ignore_literal_branches? && literal_branch?(branch)
           return false if ignore_constant_branches? && const_branch?(branch)
 
+          if ignore_duplicate_else_branches? && duplicate_else_branch?(branches, branch)
+            return false
+          end
+
           true
         end
 
@@ -133,6 +156,10 @@ module RuboCop
           cop_config.fetch('IgnoreConstantBranches', false)
         end
 
+        def ignore_duplicate_else_branches?
+          cop_config.fetch('IgnoreDuplicateElseBranch', false)
+        end
+
         def literal_branch?(branch) # rubocop:disable Metrics/CyclomaticComplexity
           return false if !branch.literal? || branch.xstr_type?
           return true if branch.basic_literal?
@@ -147,6 +174,14 @@ module RuboCop
         def const_branch?(branch)
           branch.const_type?
         end
+
+        def duplicate_else_branch?(branches, branch)
+          return false unless (parent = branch.parent)
+
+          branches.size > 2 &&
+            branch.equal?(branches.last) &&
+            parent.respond_to?(:else?) && parent.else?
+        end
       end
     end
   end

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

@@ -9,7 +9,6 @@ module RuboCop
       # @example
       #
       #   # bad
-      #
       #   case x
       #   when 'first'
       #     do_something
@@ -17,10 +16,7 @@ module RuboCop
       #     do_something_else
       #   end
       #
-      # @example
-      #
       #   # good
-      #
       #   case x
       #   when 'first'
       #     do_something
@@ -32,7 +28,7 @@ module RuboCop
 
         def on_case(case_node)
           case_node.when_branches.each_with_object(Set.new) do |when_node, previous|
-            when_node.each_condition do |condition|
+            when_node.conditions.each do |condition|
               add_offense(condition) unless previous.add?(condition)
             end
           end

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

@@ -4,19 +4,16 @@ module RuboCop
   module Cop
     module Lint
       # Checks for duplicated keys in hash literals.
+      # This cop considers both primitive types and constants for the hash keys.
       #
       # This cop mirrors a warning in Ruby 2.2.
       #
       # @example
       #
       #   # bad
-      #
       #   hash = { food: 'apple', food: 'orange' }
       #
-      # @example
-      #
       #   # good
-      #
       #   hash = { food: 'apple', other_food: 'orange' }
       class DuplicateHashKey < Base
         include Duplication
@@ -24,7 +21,7 @@ module RuboCop
         MSG = 'Duplicated key in hash literal.'
 
         def on_hash(node)
-          keys = node.keys.select(&:recursive_basic_literal?)
+          keys = node.keys.select { |key| key.recursive_basic_literal? || key.const_type? }
 
           return unless duplicates?(keys)
 

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

@@ -9,7 +9,6 @@ module RuboCop
       # @example
       #
       #   # bad
-      #
       #   def foo
       #     1
       #   end
@@ -18,20 +17,14 @@ module RuboCop
       #     2
       #   end
       #
-      # @example
-      #
       #   # bad
-      #
       #   def foo
       #     1
       #   end
       #
       #   alias foo bar
       #
-      # @example
-      #
       #   # good
-      #
       #   def foo
       #     1
       #   end
@@ -40,10 +33,7 @@ module RuboCop
       #     2
       #   end
       #
-      # @example
-      #
       #   # good
-      #
       #   def foo
       #     1
       #   end
@@ -253,7 +243,7 @@ module RuboCop
           # Assume that if a method definition is inside any block call which
           # we can't identify, it could be a DSL
           node.each_ancestor(:block).any? do |ancestor|
-            ancestor.method_name != :class_eval && !ancestor.class_constructor?
+            !ancestor.method?(:class_eval) && !ancestor.class_constructor?
           end
         end
 

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

@@ -24,6 +24,8 @@ module RuboCop
 
         MSG_REPEATED_ELEMENT = 'Duplicate element inside regexp character class'
 
+        OCTAL_DIGITS_AFTER_ESCAPE = 2
+
         def on_regexp(node)
           each_repeated_character_class_element_loc(node) do |loc|
             add_offense(loc, message: MSG_REPEATED_ELEMENT) do |corrector|
@@ -32,35 +34,57 @@ module RuboCop
           end
         end
 
-        # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
         def each_repeated_character_class_element_loc(node)
           node.parsed_tree&.each_expression do |expr|
             next if skip_expression?(expr)
 
             seen = Set.new
-            enum = expr.expressions.to_enum
-            expression_count = expr.expressions.count
+            group_expressions(node, expr.expressions) do |group|
+              group_source = group.map(&:to_s).join
 
-            expression_count.times do |current_number|
-              current_child = enum.next
-              next if within_interpolation?(node, current_child)
+              yield source_range(group) if seen.include?(group_source)
 
-              current_child_source = current_child.to_s
-              next_child = enum.peek if current_number + 1 < expression_count
+              seen << group_source
+            end
+          end
+        end
 
-              if seen.include?(current_child_source)
-                next if start_with_escaped_zero_number?(current_child_source, next_child.to_s)
+        private
 
-                yield current_child.expression
-              end
+        def group_expressions(node, expressions)
+          # Create a mutable list to simplify state tracking while we iterate.
+          expressions = expressions.to_a
 
-              seen << current_child_source
-            end
+          until expressions.empty?
+            # With we may need to compose a group of multiple expressions.
+            group = [expressions.shift]
+            next if within_interpolation?(node, group.first)
+
+            # With regexp_parser < 2.7 escaped octal sequences may be up to 3
+            # separate expressions ("\\0", "0", "1").
+            pop_octal_digits(group, expressions) if escaped_octal?(group.first.to_s)
+
+            yield(group)
           end
         end
-        # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
-        private
+        def pop_octal_digits(current_child, expressions)
+          OCTAL_DIGITS_AFTER_ESCAPE.times do
+            next_child = expressions.first
+            break unless octal?(next_child.to_s)
+
+            current_child << expressions.shift
+          end
+        end
+
+        def source_range(children)
+          return children.first.expression if children.size == 1
+
+          range_between(
+            children.first.expression.begin_pos,
+            children.last.expression.begin_pos + children.last.to_s.length
+          )
+        end
 
         def skip_expression?(expr)
           expr.type != :set || expr.token == :intersection
@@ -75,9 +99,12 @@ module RuboCop
           interpolation_locs(node).any? { |il| il.overlaps?(parse_tree_child_loc) }
         end
 
-        def start_with_escaped_zero_number?(current_child, next_child)
-          # Represents escaped code from `"\00"` (`"\u0000"`) to `"\07"` (`"\a"`).
-          current_child == '\\0' && next_child.match?(/[0-7]/)
+        def escaped_octal?(string)
+          string.length == 2 && string[0] == '\\' && octal?(string[1])
+        end
+
+        def octal?(char)
+          ('0'..'7').cover?(char)
         end
 
         def interpolation_locs(node)

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Lint
+      # Checks for duplicate literal, constant, or variable elements in Set.
+      #
+      # @example
+      #
+      #   # bad
+      #   Set[:foo, :bar, :foo]
+      #
+      #   # good
+      #   Set[:foo, :bar]
+      #
+      #   # bad
+      #   Set.new([:foo, :bar, :foo])
+      #
+      #   # good
+      #   Set.new([:foo, :bar])
+      #
+      #   # bad
+      #   [:foo, :bar, :foo].to_set
+      #
+      #   # good
+      #   [:foo, :bar].to_set
+      #
+      class DuplicateSetElement < Base
+        extend AutoCorrector
+
+        MSG = 'Remove the duplicate element in Set.'
+        RESTRICT_ON_SEND = %i[\[\] new to_set].freeze
+
+        # @!method set_init_elements(node)
+        def_node_matcher :set_init_elements, <<~PATTERN
+          {
+            (send (const {nil? cbase} :Set) :[] $...)
+            (send (const {nil? cbase} :Set) :new (array $...))
+            (call (array $...) :to_set)
+          }
+        PATTERN
+
+        def on_send(node)
+          return unless (set_elements = set_init_elements(node))
+
+          seen_elements = Set[]
+
+          set_elements.each_with_index do |set_element, index|
+            # NOTE: Skip due to the possibility of corner cases where Set elements
+            # may have changing return values if they are not literals, constants, or variables.
+            next if !set_element.literal? && !set_element.const_type? && !set_element.variable?
+
+            if seen_elements.include?(set_element)
+              register_offense(set_element, set_elements[index - 1])
+            else
+              seen_elements << set_element
+            end
+          end
+        end
+        alias on_csend on_send
+
+        private
+
+        def register_offense(current_element, prev_element)
+          add_offense(current_element) do |corrector|
+            range = prev_element.source_range.end.join(current_element.source_range.end)
+
+            corrector.remove(range)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -12,13 +12,9 @@ module RuboCop
       # @example
       #
       #   # bad
-      #
       #   sum = numbers.each_with_object(0) { |e, a| a += e }
       #
-      # @example
-      #
       #   # good
-      #
       #   num = 0
       #   sum = numbers.each_with_object(num) { |e, a| a += e }
       class EachWithObjectArgument < Base

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

@@ -21,8 +21,6 @@ module RuboCop
       #     do_that
       #   end
       #
-      # @example
-      #
       #   # good
       #
       #   # This code is compatible with the bad case. It will be autocorrected like this.

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

@@ -5,7 +5,7 @@ module RuboCop
     module Lint
       # Checks for blocks without a body.
       # Such empty blocks are typically an oversight or we should provide a comment
-      # be clearer what we're aiming for.
+      # to clarify what we're aiming for.
       #
       # Empty lambdas and procs are ignored by default.
       #

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

@@ -67,19 +67,31 @@ module RuboCop
 
         MSG = 'Avoid `%<keyword>s` branches without a body.'
 
+        # rubocop:disable Metrics/AbcSize
         def on_if(node)
           return if node.body || same_line?(node.loc.begin, node.loc.end)
           return if cop_config['AllowComments'] && contains_comments?(node)
 
-          add_offense(node, message: format(MSG, keyword: node.keyword)) do |corrector|
+          range = offense_range(node)
+
+          add_offense(range, message: format(MSG, keyword: node.keyword)) do |corrector|
             next if node.parent&.call_type?
 
             autocorrect(corrector, node)
           end
         end
+        # rubocop:enable Metrics/AbcSize
 
         private
 
+        def offense_range(node)
+          if node.loc.else
+            node.source_range.begin.join(node.loc.else.begin)
+          else
+            node.source_range
+          end
+        end
+
         def autocorrect(corrector, node)
           remove_comments(corrector, node)
           remove_empty_branch(corrector, node)
@@ -93,18 +105,27 @@ module RuboCop
           end
         end
 
+        # rubocop:disable Metrics/AbcSize
         def remove_empty_branch(corrector, node)
-          if empty_if_branch?(node) && else_branch?(node)
-            corrector.remove(branch_range(node))
-          else
-            corrector.remove(deletion_range(branch_range(node)))
-          end
+          range = if empty_if_branch?(node) && else_branch?(node)
+                    branch_range(node)
+                  elsif same_line?(node, else_kw_loc = node.loc.else)
+                    node.source_range.begin.join(else_kw_loc.begin)
+                  elsif node.parent&.loc.respond_to?(:end) &&
+                        same_line?(node, end_loc = node.parent.loc.end)
+                    node.source_range.begin.join(end_loc.begin)
+                  else
+                    deletion_range(branch_range(node))
+                  end
+
+          corrector.remove(range)
         end
+        # rubocop:enable Metrics/AbcSize
 
         def correct_other_branches(corrector, node)
           return unless require_other_branches_correction?(node)
 
-          if node.else_branch&.if_type?
+          if node.else_branch&.if_type? && !node.else_branch.modifier_form?
             # Replace an orphaned `elsif` with `if`
             corrector.replace(node.else_branch.loc.keyword, 'if')
           else
@@ -146,7 +167,7 @@ module RuboCop
             node.source_range.with(end_pos: node.condition.source_range.end_pos)
           elsif all_branches_body_missing?(node)
             if_node = node.ancestors.detect(&:if?)
-            node.source_range.with(end_pos: if_node.loc.end.end_pos)
+            node.source_range.join(if_node.loc.end.end)
           else
             node.source_range
           end

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

@@ -3,40 +3,30 @@
 module RuboCop
   module Cop
     module Lint
-      # Checks for empty `ensure` blocks
+      # Checks for empty `ensure` blocks.
       #
       # @example
       #
       #   # bad
-      #
       #   def some_method
       #     do_something
       #   ensure
       #   end
       #
-      # @example
-      #
       #   # bad
-      #
       #   begin
       #     do_something
       #   ensure
       #   end
       #
-      # @example
-      #
       #   # good
-      #
       #   def some_method
       #     do_something
       #   ensure
       #     do_something_else
       #   end
       #
-      # @example
-      #
       #   # good
-      #
       #   begin
       #     do_something
       #   ensure

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

@@ -8,13 +8,9 @@ module RuboCop
       # @example
       #
       #   # bad
-      #
       #   "result is #{}"
       #
-      # @example
-      #
       #   # good
-      #
       #   "result is #{some_result}"
       class EmptyInterpolation < Base
         include Interpolation