rubocop 1.26.1 → 1.32.0

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for `raise` or `fail` statements which are
+      # Checks for `raise` or `fail` statements which are
       # raising `Exception` class.
       #
       # You can specify a module name that will be an implicit namespace
@@ -15,7 +15,7 @@ module RuboCop
       #
       # @safety
       #   This cop is unsafe because it will change the exception class being
-      #   raised, which is a change in behaviour.
+      #   raised, which is a change in behavior.
       #
       # @example
       #   # bad

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for `rand(1)` calls.
+      # Checks for `rand(1)` calls.
       # Such calls always return `0`.
       #
       # @example

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

@@ -6,7 +6,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop detects instances of rubocop:disable comments that can be
+      # Detects instances of rubocop:disable comments that can be
       # removed without causing any offenses to be reported. It's implemented
       # as a cop in that it inherits from the Cop base class and calls
       # add_offense. The unusual part of its implementation is that it doesn't
@@ -71,16 +71,16 @@ module RuboCop
              processed_source.comment_config.comment_only_line?(directive_comment_range.line) &&
              directive_comment_range.begin_pos == line_comment_range.begin_pos
             # When the previous line is blank, it should be retained
-            range_with_surrounding_space(range: directive_comment_range, side: :right)
+            range_with_surrounding_space(directive_comment_range, side: :right)
           else
             # Eat the entire comment, the preceding space, and the preceding
             # newline if there is one.
             original_begin = directive_comment_range.begin_pos
             range = range_with_surrounding_space(
-              range: directive_comment_range, side: :left, newlines: true
+              directive_comment_range, side: :left, newlines: true
             )
 
-            range_with_surrounding_space(range: range,
+            range_with_surrounding_space(range,
                                          side: :right,
                                          # Special for a comment that
                                          # begins the file: remove
@@ -94,13 +94,13 @@ module RuboCop
           # is NOT being removed?
           if ends_its_line?(ranges.last) && trailing_range?(ranges, range)
             # Eat the comma on the left.
-            range = range_with_surrounding_space(range: range, side: :left)
+            range = range_with_surrounding_space(range, side: :left)
             range = range_with_surrounding_comma(range, :left)
           end
 
           range = range_with_surrounding_comma(range, :right)
           # Eat following spaces up to EOL, but not the newline itself.
-          range_with_surrounding_space(range: range, side: :right, newlines: false)
+          range_with_surrounding_space(range, side: :right, newlines: false)
         end
 
         def each_redundant_disable(&block)

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

@@ -9,7 +9,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop detects instances of rubocop:enable comments that can be
+      # Detects instances of rubocop:enable comments that can be
       # removed.
       #
       # When comment enables all cops at once `rubocop:enable all`
@@ -60,7 +60,7 @@ module RuboCop
               message: format(MSG, cop: all_or_name(name))
             ) do |corrector|
               if directive.match?(cop_names)
-                corrector.remove(range_with_surrounding_space(range: directive.range, side: :right))
+                corrector.remove(range_with_surrounding_space(directive.range, side: :right))
               else
                 corrector.remove(range_with_comma(comment, name))
               end

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

@@ -24,6 +24,9 @@ module RuboCop
       class RedundantRequireStatement < Base
         include RangeHelp
         extend AutoCorrector
+        extend TargetRubyVersion
+
+        minimum_target_ruby_version 2.2
 
         MSG = 'Remove unnecessary `require` statement.'
         RESTRICT_ON_SEND = %i[require].freeze
@@ -38,7 +41,7 @@ module RuboCop
           return unless unnecessary_require_statement?(node)
 
           add_offense(node) do |corrector|
-            range = range_with_surrounding_space(range: node.loc.expression, side: :right)
+            range = range_with_surrounding_space(node.loc.expression, side: :right)
 
             corrector.remove(range)
           end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for redundant safe navigation calls.
+      # Checks for redundant safe navigation calls.
       # `instance_of?`, `kind_of?`, `is_a?`, `eql?`, `respond_to?`, and `equal?` methods
       # are checked by default. These are customizable with `AllowedMethods` option.
       #
@@ -11,9 +11,9 @@ module RuboCop
       # because `NilClass` has methods like `respond_to?` and `is_a?`.
       #
       # @safety
-      #   This cop is unsafe, because auto-correction can change the return type of
+      #   This cop is unsafe, because autocorrection can change the return type of
       #   the expression. An offending expression that previously could return `nil`
-      #   will be auto-corrected to never return `nil`.
+      #   will be autocorrected to never return `nil`.
       #
       # @example
       #   # bad
@@ -35,6 +35,13 @@ module RuboCop
       #   # good - without `&.` this will always return `true`
       #   foo&.respond_to?(:to_a)
       #
+      # @example AllowedMethods: [foo?]
+      #   # bad
+      #   do_something if attrs&.foo?(:[])
+      #
+      #   # good
+      #   do_something if attrs&.bar?(:[])
+      #
       class RedundantSafeNavigation < Base
         include AllowedMethods
         include RangeHelp

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

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

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for string conversion in string interpolation,
+      # Checks for string conversion in string interpolation,
       # which is redundant.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for redundant `with_index`.
+      # Checks for redundant `with_index`.
       #
       # @example
       #   # bad

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for redundant `with_object`.
+      # Checks for redundant `with_object`.
       #
       # @example
       #   # bad

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Lint
+      # Checks if `include` or `prepend` is called in `refine` block.
+      # These methods are deprecated and should be replaced with `Refinement#import_methods`.
+      #
+      # It emulates deprecation warnings in Ruby 3.1.
+      #
+      # @safety
+      #   This cop's autocorrection is unsafe because `include M` will affect the included class
+      #   if any changes are made to module `M`.
+      #   On the other hand, `import_methods M` uses a snapshot of method definitions,
+      #   thus it will not be affected if module `M` changes.
+      #
+      # @example
+      #
+      #   # bad
+      #   refine Foo do
+      #     include Bar
+      #   end
+      #
+      #   # bad
+      #   refine Foo do
+      #     prepend Bar
+      #   end
+      #
+      #   # good
+      #   refine Foo do
+      #     import_methods Bar
+      #   end
+      #
+      class RefinementImportMethods < Base
+        extend TargetRubyVersion
+
+        MSG = 'Use `import_methods` instead of `%<current>s` because it is deprecated in Ruby 3.1.'
+        RESTRICT_ON_SEND = %i[include prepend].freeze
+
+        minimum_target_ruby_version 3.1
+
+        def on_send(node)
+          return if node.receiver
+          return unless node.parent.block_type? && node.parent.method?(:refine)
+
+          add_offense(node.loc.selector, message: format(MSG, current: node.method_name))
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for regexp literals used as `match-current-line`.
+      # Checks for regexp literals used as `match-current-line`.
       # If a regexp literal is in condition, the regexp matches `$_` implicitly.
       #
       # @example
@@ -19,8 +19,8 @@ module RuboCop
       class RegexpAsCondition < Base
         extend AutoCorrector
 
-        MSG = 'Do not use regexp literal as a condition.' \
-              ' The regexp literal matches `$_` implicitly.'
+        MSG = 'Do not use regexp literal as a condition. ' \
+              'The regexp literal matches `$_` implicitly.'
 
         def on_match_current_line(node)
           add_offense(node) { |corrector| corrector.replace(node, "#{node.source} =~ $_") }

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for expressions where there is a call to a predicate
+      # Checks for expressions where there is a call to a predicate
       # method with at least one argument, where no parentheses are used around
       # the parameter list, and a boolean operator, && or ||, is used in the
       # last argument.

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Lint
+      # Checks that a range literal is enclosed in parentheses when the end of the range is
+      # at a line break.
+      #
+      # NOTE: The following is maybe intended for `(42..)`. But, compatible is `42..do_something`.
+      # So, this cop does not provide autocorrection because it is left to user.
+      #
+      # [source,ruby]
+      # ----
+      # case condition
+      # when 42..
+      #   do_something
+      # end
+      # ----
+      #
+      # @example
+      #
+      #   # bad - Represents `(1..42)`, not endless range.
+      #   1..
+      #   42
+      #
+      #   # good - It's incompatible, but your intentions when using endless range may be:
+      #   (1..)
+      #   42
+      #
+      #   # good
+      #   1..42
+      #
+      #   # good
+      #   (1..42)
+      #
+      #   # good
+      #   (1..
+      #   42)
+      #
+      class RequireRangeParentheses < Base
+        MSG = 'Wrap the endless range literal `%<range>s` to avoid precedence ambiguity.'
+
+        def on_irange(node)
+          return if node.parent&.begin_type?
+          return unless node.begin && node.end
+          return if same_line?(node.begin, node.end)
+
+          message = format(MSG, range: "#{node.begin.source}#{node.loc.operator.source}")
+
+          add_offense(node, message: message)
+        end
+
+        alias on_erange on_irange
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for `rescue` blocks targeting the Exception class.
+      # Checks for `rescue` blocks targeting the Exception class.
       #
       # @example
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for the use of a return with a value in a context
+      # Checks for the use of a return with a value in a context
       # where the value will be ignored. (initialize and setter methods)
       #
       # @example
@@ -40,12 +40,12 @@ module RuboCop
           context_node = non_void_context(return_node)
 
           return unless context_node&.def_type?
+          return unless context_node&.void_context?
 
-          method_name = method_name(context_node)
-
-          return unless method_name && void_context_method?(method_name)
-
-          add_offense(return_node.loc.keyword, message: format(message, method: method_name))
+          add_offense(
+            return_node.loc.keyword,
+            message: format(message, method: context_node.method_name)
+          )
         end
 
         private
@@ -53,18 +53,6 @@ module RuboCop
         def non_void_context(return_node)
           return_node.each_ancestor(:block, :def, :defs).first
         end
-
-        def method_name(context_node)
-          context_node.children.first
-        end
-
-        def void_context_method?(method_name)
-          method_name == :initialize || setter_method?(method_name)
-        end
-
-        def setter_method?(method_name)
-          method_name.to_s.end_with?('=') && !AST::Node::COMPARISON_OPERATORS.include?(method_name)
-        end
       end
     end
   end

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

@@ -25,6 +25,10 @@ module RuboCop
       #   x&.foo || bar
       class SafeNavigationChain < Base
         include NilMethods
+        extend AutoCorrector
+        extend TargetRubyVersion
+
+        minimum_target_ruby_version 2.3
 
         MSG = 'Do not chain ordinary method call after safe navigation operator.'
 
@@ -45,12 +49,45 @@ module RuboCop
               Parser::Source::Range.new(node.source_range.source_buffer,
                                         safe_nav.source_range.end_pos,
                                         method_chain.source_range.end_pos)
-            add_offense(location)
+            add_offense(location) do |corrector|
+              autocorrect(corrector, offense_range: location, send_node: method_chain)
+            end
           end
         end
 
         private
 
+        # @param [Parser::Source::Range] offense_range
+        # @param [RuboCop::AST::SendNode] send_node
+        # @return [String]
+        def add_safe_navigation_operator(offense_range:, send_node:)
+          source = \
+            if send_node.method?(:[]) || send_node.method?(:[]=)
+              format(
+                '%<method_name>s(%<arguments>s)',
+                arguments: send_node.arguments.map(&:source).join(', '),
+                method_name: send_node.method_name
+              )
+            else
+              offense_range.source.dup
+            end
+          source.prepend('.') unless send_node.dot?
+          source.prepend('&')
+        end
+
+        # @param [RuboCop::Cop::Corrector] corrector
+        # @param [Parser::Source::Range] offense_range
+        # @param [RuboCop::AST::SendNode] send_node
+        def autocorrect(corrector, offense_range:, send_node:)
+          corrector.replace(
+            offense_range,
+            add_safe_navigation_operator(
+              offense_range: offense_range,
+              send_node: send_node
+            )
+          )
+        end
+
         def method_chain(node)
           chain = node
           chain = chain.parent if chain.send_type? && chain.parent&.call_type?

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop check to make sure that if safe navigation is used for a method
+      # Check to make sure that if safe navigation is used for a method
       # call in an `&&` or `||` condition that safe navigation is used for all
       # method calls on that same object.
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks to make sure safe navigation isn't used with `empty?` in
+      # Checks to make sure safe navigation isn't used with `empty?` in
       # a conditional.
       #
       # While the safe navigation operator is generally a good idea, when

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks if a file which has a shebang line as
+      # Checks if a file which has a shebang line as
       # its first line is granted execute permission.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for self-assignments.
+      # Checks for self-assignments.
       #
       # @example
       #   # bad

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for shadowed arguments.
+      # Checks for shadowed arguments.
       #
       # This cop has `IgnoreImplicitReferences` configuration option.
       # It means argument shadowing is used in order to pass parameters

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for a rescued exception that get shadowed by a
+      # Checks for a rescued exception that get shadowed by a
       # less specific exception being rescued before a more specific
       # exception is rescued.
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for the use of local variable names from an outer scope
+      # Checks for the use of local variable names from an outer scope
       # in block arguments or block-local variables. This mirrors the warning
       # given by `ruby -cw` prior to Ruby 2.6:
       # "shadowing outer local variable - foo".
@@ -57,10 +57,20 @@ module RuboCop
 
           outer_local_variable = variable_table.find_variable(variable.name)
           return unless outer_local_variable
+          return if same_conditions_node_different_branch?(variable, outer_local_variable)
 
           message = format(MSG, variable: variable.name)
           add_offense(variable.declaration_node, message: message)
         end
+
+        def same_conditions_node_different_branch?(variable, outer_local_variable)
+          variable_node = variable.scope.node.parent
+          return false unless variable_node.conditional?
+
+          outer_local_variable_node = outer_local_variable.scope.node
+
+          outer_local_variable_node.conditional? && variable_node == outer_local_variable_node
+        end
       end
     end
   end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks unexpected overrides of the `Struct` built-in methods
+      # Checks unexpected overrides of the `Struct` built-in methods
       # via `Struct.new`.
       #
       # @example
@@ -22,8 +22,8 @@ module RuboCop
       #   g.count #=> 2
       #
       class StructNewOverride < Base
-        MSG = '`%<member_name>s` member overrides `Struct#%<method_name>s`' \
-              ' and it may be unexpected.'
+        MSG = '`%<member_name>s` member overrides `Struct#%<method_name>s` ' \
+              'and it may be unexpected.'
         RESTRICT_ON_SEND = %i[new].freeze
 
         STRUCT_METHOD_NAMES = Struct.instance_methods

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for `rescue` blocks with no body.
+      # Checks for `rescue` blocks with no body.
       #
       # @example
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for uses of literal strings converted to
+      # Checks for uses of literal strings converted to
       # a symbol where a literal symbol could be used instead.
       #
       # There are two possible styles for this cop.

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

@@ -3,14 +3,13 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop repacks Parser's diagnostics/errors
+      # Repacks Parser's diagnostics/errors
       # into RuboCop's offenses.
       class Syntax < Base
         def on_other_file
           add_offense_from_error(processed_source.parser_error) if processed_source.parser_error
           processed_source.diagnostics.each do |diagnostic|
-            add_offense_from_diagnostic(diagnostic,
-                                        processed_source.ruby_version)
+            add_offense_from_diagnostic(diagnostic, processed_source.ruby_version)
           end
           super
         end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop ensures that `to_enum`/`enum_for`, called for the current method,
+      # Ensures that `to_enum`/`enum_for`, called for the current method,
       # has correct arguments.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks to make sure `#to_json` includes an optional argument.
+      # Checks to make sure `#to_json` includes an optional argument.
       # When overriding `#to_json`, callers may invoke JSON
       # generation via `JSON.generate(your_obj)`.  Since `JSON#generate` allows
       # for an optional argument, your method should too.

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for top level return with arguments. If there is a
+      # Checks for top level return with arguments. If there is a
       # top-level return statement with an argument, then the argument is
       # always ignored. This is detected automatically since Ruby 2.7.
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for trailing commas in attribute declarations, such as
+      # Checks for trailing commas in attribute declarations, such as
       # `#attr_reader`. Leaving a trailing comma will nullify the next method
       # definition by overriding it with a getter method.
       #
@@ -45,7 +45,7 @@ module RuboCop
 
         def trailing_comma_range(node)
           range_with_surrounding_space(
-            range: node.arguments[-2].source_range,
+            node.arguments[-2].source_range,
             side: :right
           ).end.resize(1)
         end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for "triple quotes" (strings delimited by any odd number
+      # Checks for "triple quotes" (strings delimited by any odd number
       # of quotes greater than 1).
       #
       # Ruby allows multiple strings to be implicitly concatenated by just

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for underscore-prefixed variables that are actually
+      # Checks for underscore-prefixed variables that are actually
       # used.
       #
       # Since block keyword arguments cannot be arbitrarily named at call