rubocop 1.26.0 → 1.36.0

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for debug calls (such as `debugger` or `binding.pry`) that should
+      # Checks for debug calls (such as `debugger` or `binding.pry`) that should
       # not be kept for production code.
       #
       # The cop can be configured using `DebuggerMethods`. By default, a number of gems
@@ -15,9 +15,19 @@ module RuboCop
       # [source,yaml]
       # ----
       # Lint/Debugger:
-      #   WebConsole: ~
+      #   DebuggerMethods:
+      #     WebConsole: ~
       # ----
       #
+      # You can also add your own methods by adding a new category:
+      #
+      # [source,yaml]
+      # ----
+      # Lint/Debugger:
+      #   DebuggerMethods:
+      #     MyDebugger:
+      #       MyDebugger.debug_this
+      # ----
       #
       # @example
       #
@@ -57,19 +67,6 @@ module RuboCop
       class Debugger < Base
         MSG = 'Remove debugger entry point `%<source>s`.'
 
-        # @!method kernel?(node)
-        def_node_matcher :kernel?, <<~PATTERN
-          (const {nil? cbase} :Kernel)
-        PATTERN
-
-        # @!method valid_receiver?(node, arg1)
-        def_node_matcher :valid_receiver?, <<~PATTERN
-          {
-            (const {nil? cbase} %1)
-            (send {nil? #kernel?} %1)
-          }
-        PATTERN
-
         def on_send(node)
           return unless debugger_method?(node)
 
@@ -91,7 +88,7 @@ module RuboCop
 
               *receiver, method_name = v.split('.')
               {
-                receiver: receiver.empty? ? nil : receiver.join.to_sym,
+                receiver: receiver.empty? ? nil : receiver.map(&:to_sym),
                 method_name: method_name.to_sym
               }
             end.compact
@@ -105,10 +102,23 @@ module RuboCop
             if method[:receiver].nil?
               send_node.receiver.nil?
             else
-              valid_receiver?(send_node.receiver, method[:receiver])
+              method[:receiver] == receiver_chain(send_node)
             end
           end
         end
+
+        def receiver_chain(send_node)
+          receivers = []
+          receiver = send_node.receiver
+
+          while receiver
+            name = receiver.send_type? ? receiver.method_name : receiver.const_name&.to_sym
+            receivers.unshift(name)
+            receiver = receiver.receiver
+          end
+
+          receivers
+        end
       end
     end
   end

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

@@ -3,27 +3,27 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for uses of the deprecated class method usages.
+      # Checks for uses of the deprecated class method usages.
       #
       # @example
       #
       #   # bad
-      #
       #   File.exists?(some_path)
       #   Dir.exists?(some_path)
       #   iterator?
       #   ENV.freeze # Calling `Env.freeze` raises `TypeError` since Ruby 2.7.
+      #   ENV.clone
+      #   ENV.dup # Calling `Env.dup` raises `TypeError` since Ruby 3.1.
       #   Socket.gethostbyname(host)
       #   Socket.gethostbyaddr(host)
       #
-      # @example
-      #
       #   # good
-      #
       #   File.exist?(some_path)
       #   Dir.exist?(some_path)
       #   block_given?
       #   ENV # `ENV.freeze` cannot prohibit changes to environment variables.
+      #   ENV.to_h
+      #   ENV.to_h # `ENV.dup` cannot dup `ENV`, use `ENV.to_h` to get a copy of `ENV` as a hash.
       #   Addrinfo.getaddrinfo(nodename, service)
       #   Addrinfo.tcp(host, port).getnameinfo
       class DeprecatedClassMethods < Base
@@ -66,7 +66,7 @@ module RuboCop
           private
 
           def delimiter
-            CLASS_METHOD_DELIMETER
+            CLASS_METHOD_DELIMITER
           end
         end
 
@@ -89,7 +89,7 @@ module RuboCop
           private
 
           def delimiter
-            instance_method? ? INSTANCE_METHOD_DELIMETER : CLASS_METHOD_DELIMETER
+            instance_method? ? INSTANCE_METHOD_DELIMITER : CLASS_METHOD_DELIMITER
           end
 
           def instance_method?
@@ -111,6 +111,12 @@ module RuboCop
           DeprecatedClassMethod.new(:freeze, class_constant: :ENV) =>
             Replacement.new(nil, class_constant: :ENV),
 
+          DeprecatedClassMethod.new(:clone, class_constant: :ENV) =>
+            Replacement.new(:to_h, class_constant: :ENV),
+
+          DeprecatedClassMethod.new(:dup, class_constant: :ENV) =>
+            Replacement.new(:to_h, class_constant: :ENV),
+
           DeprecatedClassMethod.new(:gethostbyaddr, class_constant: :Socket, correctable: false) =>
             Replacement.new(:getnameinfo, class_constant: :Addrinfo, instance_method: true),
 
@@ -120,8 +126,8 @@ module RuboCop
 
         RESTRICT_ON_SEND = DEPRECATED_METHODS_OBJECT.keys.map(&:method).freeze
 
-        CLASS_METHOD_DELIMETER = '.'
-        INSTANCE_METHOD_DELIMETER = '#'
+        CLASS_METHOD_DELIMITER = '.'
+        INSTANCE_METHOD_DELIMITER = '#'
 
         def on_send(node)
           check(node) do |deprecated|

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for deprecated constants.
+      # Checks for deprecated constants.
       #
       # It has `DeprecatedConstants` config. If there is an alternative method, you can set
       # alternative value as `Alternative`. And you can set the deprecated version as

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks constructors for disjunctive assignments (`||=`) that should
+      # Checks constructors for disjunctive assignments (`||=`) that should
       # be plain assignments.
       #
       # So far, this cop is only concerned with disjunctive assignment of

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks that there are no repeated bodies
+      # Checks that there are no repeated bodies
       # within `if/unless`, `case-when`, `case-in` and `rescue` constructs.
       #
       # With `IgnoreLiteralBranches: true`, branches are not registered

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks that there are no repeated conditions
+      # Checks that there are no repeated conditions
       # used in case 'when' expressions.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks that there are no repeated conditions used in if 'elsif'.
+      # Checks that there are no repeated conditions used in if 'elsif'.
       #
       # @example
       #   # bad

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for duplicated keys in hash literals.
+      # Checks for duplicated keys in hash literals.
       #
       # This cop mirrors a warning in Ruby 2.2.
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for duplicated instance (or singleton) method
+      # Checks for duplicated instance (or singleton) method
       # definitions.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for duplicate elements in Regexp character classes.
+      # Checks for duplicate elements in Regexp character classes.
       #
       # @example
       #

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

@@ -3,7 +3,11 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for duplicate `require`s and `require_relative`s.
+      # Checks for duplicate ``require``s and ``require_relative``s.
+      #
+      # @safety
+      #   This cop's autocorrection is unsafe because it may break the dependency order
+      #   of `require`.
       #
       # @example
       #   # bad
@@ -20,6 +24,9 @@ module RuboCop
       #   require_relative 'foo'
       #
       class DuplicateRequire < Base
+        include RangeHelp
+        extend AutoCorrector
+
         MSG = 'Duplicate `%<method>s` detected.'
         REQUIRE_METHODS = Set.new(%i[require require_relative]).freeze
         RESTRICT_ON_SEND = REQUIRE_METHODS
@@ -39,7 +46,9 @@ module RuboCop
           return unless require_call?(node)
           return if @required[node.parent].add?("#{node.method_name}#{node.first_argument}")
 
-          add_offense(node, message: format(MSG, method: node.method_name))
+          add_offense(node, message: format(MSG, method: node.method_name)) do |corrector|
+            corrector.remove(range_by_whole_lines(node.source_range, include_final_newline: true))
+          end
         end
       end
     end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks that there are no repeated exceptions
+      # Checks that there are no repeated exceptions
       # used in 'rescue' expressions.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks if each_with_object is called with an immutable
+      # Checks if each_with_object is called with an immutable
       # argument. Since the argument is the object that the given block shall
       # make calls on to build something based on the enumerable that
       # each_with_object iterates over, an immutable argument makes no sense.

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

@@ -3,11 +3,11 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for odd `else` block layout - like
+      # Checks for odd `else` block layout - like
       # having an expression on the same line as the `else` keyword,
       # which is usually a mistake.
       #
-      # Its auto-correction tweaks layout to keep the syntax. So, this auto-correction
+      # Its autocorrection tweaks layout to keep the syntax. So, this autocorrection
       # is compatible correction for bad case syntax, but if your code makes a mistake
       # with `elsif` and `else`, you will have to correct it manually.
       #
@@ -25,7 +25,7 @@ module RuboCop
       #
       #   # good
       #
-      #   # This code is compatible with the bad case. It will be auto-corrected like this.
+      #   # This code is compatible with the bad case. It will be autocorrected like this.
       #   if something
       #     # ...
       #   else

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for blocks without a body.
+      # 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.
       #
@@ -63,7 +63,7 @@ module RuboCop
       class EmptyBlock < Base
         MSG = 'Empty block detected.'
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return if node.body
           return if allow_empty_lambdas? && lambda_or_proc?(node)
           return if cop_config['AllowComments'] && allow_comment?(node)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for classes and metaclasses without a body.
+      # Checks for classes and metaclasses without a body.
       # Such empty classes and metaclasses are typically an oversight or we should provide a comment
       # to be clearer what we're aiming for.
       #

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

@@ -3,7 +3,15 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for the presence of `if`, `elsif` and `unless` branches without a body.
+      # Checks for the presence of `if`, `elsif` and `unless` branches without a body.
+      #
+      # NOTE: empty `else` branches are handled by `Style/EmptyElse`.
+      #
+      # @safety
+      #   Autocorrection for this cop is not safe. The conditions for empty branches that
+      #   the autocorrection removes may have side effects, or the logic in subsequent
+      #   branches may change due to the removal of a previous condition.
+      #
       # @example
       #   # bad
       #   if condition
@@ -53,13 +61,101 @@ module RuboCop
       #   end
       #
       class EmptyConditionalBody < Base
+        extend AutoCorrector
+        include CommentsHelp
+        include RangeHelp
+
         MSG = 'Avoid `%<keyword>s` branches without a body.'
 
         def on_if(node)
           return if node.body
-          return if cop_config['AllowComments'] && comment_lines?(node)
+          return if cop_config['AllowComments'] && contains_comments?(node)
+
+          add_offense(node, message: format(MSG, keyword: node.keyword)) do |corrector|
+            autocorrect(corrector, node)
+          end
+        end
+
+        private
+
+        def autocorrect(corrector, node)
+          remove_comments(corrector, node)
+          remove_empty_branch(corrector, node)
+          correct_other_branches(corrector, node)
+        end
+
+        def remove_comments(corrector, node)
+          comments_in_range(node).each do |comment|
+            range = range_by_whole_lines(comment.loc.expression, include_final_newline: true)
+            corrector.remove(range)
+          end
+        end
+
+        def remove_empty_branch(corrector, node)
+          corrector.remove(deletion_range(branch_range(node)))
+        end
+
+        def correct_other_branches(corrector, node)
+          return unless require_other_branches_correction?(node)
+
+          if node.else_branch.if_type?
+            # Replace an orphaned `elsif` with `if`
+            corrector.replace(node.else_branch.loc.keyword, 'if')
+          else
+            # Flip orphaned `else`
+            corrector.replace(node.loc.else, "#{node.inverse_keyword} #{node.condition.source}")
+          end
+        end
+
+        def require_other_branches_correction?(node)
+          return false unless node.if_type? && node.else_branch
+          return false if !empty_if_branch?(node) && node.elsif?
+
+          !empty_else_branch?(node)
+        end
+
+        def empty_if_branch?(node)
+          return false unless (parent = node.parent)
+          return true unless parent.if_type?
+          return true unless (if_branch = parent.if_branch)
+
+          if_branch.if_type? && !if_branch.body
+        end
+
+        def empty_else_branch?(node)
+          node.else_branch.if_type? && !node.else_branch.body
+        end
+
+        # rubocop:disable Metrics/AbcSize
+        def branch_range(node)
+          if node.loc.else
+            node.source_range.with(end_pos: node.loc.else.begin_pos - 1)
+          elsif all_branches_body_missing?(node)
+            if_node = node.ancestors.detect(&:if?)
+            node.source_range.with(end_pos: if_node.loc.end.end_pos)
+          else
+            node.source_range
+          end
+        end
+        # rubocop:enable Metrics/AbcSize
+
+        def all_branches_body_missing?(node)
+          return false unless node.parent&.if_type?
+
+          node.parent.branches.compact.empty?
+        end
+
+        def deletion_range(range)
+          # Collect a range between the start of the `if` node and the next relevant node,
+          # including final new line.
+          # Based on `RangeHelp#range_by_whole_lines` but allows the `if` to not start
+          # on the first column.
+          buffer = @processed_source.buffer
+
+          last_line = buffer.source_line(range.last_line)
+          end_offset = last_line.length - range.last_column + 1
 
-          add_offense(node, message: format(MSG, keyword: node.keyword))
+          range.adjust(end_pos: end_offset).intersect(buffer.source_range)
         end
       end
     end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for empty `ensure` blocks
+      # Checks for empty `ensure` blocks
       #
       # @example
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for the presence of empty expressions.
+      # Checks for the presence of empty expressions.
       #
       # @example
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop enforces that Ruby source files are not empty.
+      # Enforces that Ruby source files are not empty.
       #
       # @example
       #   # bad

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for the presence of `in` pattern branches without a body.
+      # Checks for the presence of `in` pattern branches without a body.
       #
       # @example
       #
@@ -44,6 +44,7 @@ module RuboCop
       #
       class EmptyInPattern < Base
         extend TargetRubyVersion
+        include CommentsHelp
 
         MSG = 'Avoid `in` branches without a body.'
 
@@ -51,7 +52,8 @@ module RuboCop
 
         def on_case_match(node)
           node.in_pattern_branches.each do |branch|
-            next if branch.body || (cop_config['AllowComments'] && comment_lines?(node))
+            next if branch.body
+            next if cop_config['AllowComments'] && contains_comments?(branch)
 
             add_offense(branch)
           end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for empty interpolation.
+      # Checks for empty interpolation.
       #
       # @example
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for the presence of `when` branches without a body.
+      # Checks for the presence of `when` branches without a body.
       #
       # @example
       #
@@ -45,12 +45,14 @@ module RuboCop
       #   end
       #
       class EmptyWhen < Base
+        include CommentsHelp
+
         MSG = 'Avoid `when` branches without a body.'
 
         def on_case(node)
           node.each_when do |when_node|
             next if when_node.body
-            next if cop_config['AllowComments'] && comment_lines?(node)
+            next if cop_config['AllowComments'] && contains_comments?(when_node)
 
             add_offense(when_node)
           end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for `return` from an `ensure` block.
+      # Checks for `return` from an `ensure` block.
       # `return` from an ensure block is a dangerous code smell as it
       # will take precedence over any exception being raised,
       # and the exception will be silently thrown away as if it were rescued.

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

@@ -6,18 +6,18 @@ module RuboCop
       #
       # This cop emulates the following Ruby warnings in Ruby 2.6.
       #
+      # [source,console]
+      # ----
       # % cat example.rb
       # ERB.new('hi', nil, '-', '@output_buffer')
       # % ruby -rerb example.rb
-      # example.rb:1: warning: Passing safe_level with the 2nd argument of
-      # ERB.new is deprecated. Do not use it, and specify other arguments as
-      # keyword arguments.
-      # example.rb:1: warning: Passing trim_mode with the 3rd argument of
-      # ERB.new is deprecated. Use keyword argument like
-      # ERB.new(str, trim_mode:...) instead.
-      # example.rb:1: warning: Passing eoutvar with the 4th argument of ERB.new
-      # is deprecated. Use keyword argument like ERB.new(str, eoutvar: ...)
-      # instead.
+      # example.rb:1: warning: Passing safe_level with the 2nd argument of ERB.new is
+      # deprecated. Do not use it, and specify other arguments as keyword arguments.
+      # example.rb:1: warning: Passing trim_mode with the 3rd argument of ERB.new is
+      # deprecated. Use keyword argument like ERB.new(str, trim_mode:...) instead.
+      # example.rb:1: warning: Passing eoutvar with the 4th argument of ERB.new is
+      # deprecated. Use keyword argument like ERB.new(str, eoutvar: ...) instead.
+      # ----
       #
       # Now non-keyword arguments other than first one are softly deprecated
       # and will be removed when Ruby 2.5 becomes EOL.
@@ -61,8 +61,8 @@ module RuboCop
       #
       class ErbNewArguments < Base
         include RangeHelp
-        extend TargetRubyVersion
         extend AutoCorrector
+        extend TargetRubyVersion
 
         minimum_target_ruby_version 2.6
 

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop looks for uses of flip-flop operator
+      # Looks for uses of flip-flop operator
       # based on the Ruby Style Guide.
       #
       # Here is the history of flip-flops in Ruby.

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for the presence of precise comparison of floating point numbers.
+      # Checks for the presence of precise comparison of floating point numbers.
       #
       # Floating point values are inherently inaccurate, and comparing them for exact equality
       # is almost never the desired semantics. Comparison via the `==/!=` operators checks

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop identifies Float literals which are, like, really really really
+      # Identifies Float literals which are, like, really really really
       # really really really really really big. Too big. No-one needs Floats
       # that big. If you need a float that big, something is wrong with you.
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for the ordering of a method call where
+      # Checks for the ordering of a method call where
       # the receiver of the call is a HEREDOC.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for implicit string concatenation of string literals
+      # Checks for implicit string concatenation of string literals
       # which are on the same line.
       #
       # @example