rubocop 1.29.1 → 1.36.0

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

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,10 +3,18 @@
 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.
       #
+      # An exception is considered shadowed if it is rescued after its
+      # ancestor is, or if it and its ancestor are both rescued in the
+      # same `rescue` statement. In both cases, the more specific rescue is
+      # unnecessary because it is covered by rescuing the less specific
+      # exception. (ie. `rescue Exception, StandardError` has the same behavior
+      # whether `StandardError` is included or not, because all ``StandardError``s
+      # are rescued by `rescue Exception`).
+      #
       # @example
       #
       #   # bad
@@ -19,6 +27,13 @@ module RuboCop
       #     handle_standard_error
       #   end
       #
+      #   # bad
+      #   begin
+      #     something
+      #   rescue Exception, StandardError
+      #     handle_error
+      #   end
+      #
       #   # good
       #
       #   begin

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".
@@ -64,12 +64,33 @@ module RuboCop
         end
 
         def same_conditions_node_different_branch?(variable, outer_local_variable)
-          variable_node = variable.scope.node.parent
+          variable_node = variable_node(variable)
           return false unless variable_node.conditional?
 
-          outer_local_variable_node = outer_local_variable.scope.node
+          outer_local_variable_node =
+            find_conditional_node_from_ascendant(outer_local_variable.declaration_node)
+          return true unless outer_local_variable_node
 
-          outer_local_variable_node.conditional? && variable_node == outer_local_variable_node
+          outer_local_variable_node.conditional? &&
+            (variable_node == outer_local_variable_node ||
+              variable_node == outer_local_variable_node.else_branch)
+        end
+
+        def variable_node(variable)
+          parent_node = variable.scope.node.parent
+
+          if parent_node.when_type?
+            parent_node.parent
+          else
+            parent_node
+          end
+        end
+
+        def find_conditional_node_from_ascendant(node)
+          return unless (parent = node.parent)
+          return parent if parent.conditional?
+
+          find_conditional_node_from_ascendant(parent)
         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,7 +3,7 @@
 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

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

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for a block that is known to need more positional
+      # Checks for a block that is known to need more positional
       # block arguments than are given (by default this is configured for
       # `Enumerable` methods needing 2 arguments). Optional arguments are allowed,
       # although they don't generally make sense as the default value will

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for using Fixnum or Bignum constant.
+      # Checks for using Fixnum or Bignum constant.
       #
       # @example
       #
@@ -33,6 +33,8 @@ module RuboCop
           return unless klass
 
           add_offense(node, message: format(MSG, klass: klass)) do |corrector|
+            next if target_ruby_version <= 2.3
+
             corrector.replace(node.loc.name, 'Integer')
           end
         end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for unreachable code.
+      # Checks for unreachable code.
       # The check are based on the presence of flow of control
       # statement in non-final position in `begin` (implicit) blocks.
       #

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

@@ -3,13 +3,13 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for loops that will have at most one iteration.
+      # Checks for loops that will have at most one iteration.
       #
       # A loop that can never reach the second iteration is a possible error in the code.
       # In rare cases where only one iteration (or at most one iteration) is intended behavior,
       # the code should be refactored to use `if` conditionals.
       #
-      # NOTE: Block methods that are used with `Enumerable`s are considered to be loops.
+      # NOTE: Block methods that are used with ``Enumerable``s are considered to be loops.
       #
       # `AllowedPatterns` can be used to match against the block receiver in order to allow
       # code that would otherwise be registered as an offense (eg. `times` used not in an
@@ -101,10 +101,14 @@ module RuboCop
           check(node) if loop_method?(node)
         end
 
+        def on_numblock(node)
+          check(node) if loop_method?(node)
+        end
+
         private
 
         def loop_method?(node)
-          return false unless node.block_type?
+          return false unless node.block_type? || node.numblock_type?
 
           send_node = node.send_node
           return false if matches_allowed_pattern?(send_node.source)
@@ -179,6 +183,8 @@ module RuboCop
 
         def preceded_by_continue_statement?(break_statement)
           break_statement.left_siblings.any? do |sibling|
+            # Numblocks have the arguments count as a number in the AST.
+            next if sibling.is_a?(Integer)
             next if sibling.loop_keyword? || loop_method?(sibling)
 
             sibling.each_descendant(*CONTINUE_KEYWORDS).any?

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for unused block arguments.
+      # Checks for unused block arguments.
       #
       # @example
       #   # bad

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for unused method arguments.
+      # Checks for unused method arguments.
       #
       # @example
       #   # bad

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop identifies places where `URI.escape` can be replaced by
+      # Identifies places where `URI.escape` can be replaced by
       # `CGI.escape`, `URI.encode_www_form`, or `URI.encode_www_form_component`
       # depending on your specific use case.
       # Also this cop identifies places where `URI.unescape` can be replaced by

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop identifies places where `URI.regexp` is obsolete and should
+      # Identifies places where `URI.regexp` is obsolete and should
       # not be used. Instead, use `URI::DEFAULT_PARSER.make_regexp`.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for redundant access modifiers, including those with no
+      # Checks for redundant access modifiers, including those with no
       # code, those which are repeated, and leading `public` modifiers in a
       # class or module body. Conditionally-defined methods are considered as
       # always being defined, and thus access modifiers guarding such methods
@@ -31,8 +31,8 @@ module RuboCop
       #   # bad
       #   class Foo
       #     # The following is redundant (methods defined on the class'
-      #     # singleton class are not affected by the public modifier)
-      #     public
+      #     # singleton class are not affected by the private modifier)
+      #     private
       #
       #     def self.method3
       #     end
@@ -142,6 +142,8 @@ module RuboCop
           check_node(node.body)
         end
 
+        alias on_numblock on_block
+
         private
 
         def autocorrect(corrector, node)
@@ -157,17 +159,17 @@ module RuboCop
 
         # @!method dynamic_method_definition?(node)
         def_node_matcher :dynamic_method_definition?, <<~PATTERN
-          {(send nil? :define_method ...) (block (send nil? :define_method ...) ...)}
+          {(send nil? :define_method ...) ({block numblock} (send nil? :define_method ...) ...)}
         PATTERN
 
         # @!method class_or_instance_eval?(node)
         def_node_matcher :class_or_instance_eval?, <<~PATTERN
-          (block (send _ {:class_eval :instance_eval}) ...)
+          ({block numblock} (send _ {:class_eval :instance_eval}) ...)
         PATTERN
 
         # @!method class_or_module_or_struct_new_call?(node)
         def_node_matcher :class_or_module_or_struct_new_call?, <<~PATTERN
-          (block (send (const {nil? cbase} {:Class :Module :Struct}) :new ...) ...)
+          ({block numblock} (send (const {nil? cbase} {:Class :Module :Struct}) :new ...) ...)
         PATTERN
 
         def check_node(node)
@@ -277,7 +279,7 @@ module RuboCop
             matcher_name = "#{m}_block?".to_sym
             unless respond_to?(matcher_name)
               self.class.def_node_matcher matcher_name, <<~PATTERN
-                (block (send {nil? const} {:#{m}} ...) ...)
+                ({block numblock} (send {nil? const} {:#{m}} ...) ...)
               PATTERN
             end
 

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for every useless assignment to local variable in every
+      # Checks for every useless assignment to local variable in every
       # scope.
       # The basic idea for this cop was from the warning of `ruby -cw`:
       #

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Lint
+      # Checks for useless `else` in `begin..end` without `rescue`.
+      #
+      # NOTE: This syntax is no longer valid on Ruby 2.6 or higher.
+      #
+      # @example
+      #
+      #   # bad
+      #
+      #   begin
+      #     do_something
+      #   else
+      #     do_something_else # This will never be run.
+      #   end
+      #
+      # @example
+      #
+      #   # good
+      #
+      #   begin
+      #     do_something
+      #   rescue
+      #     handle_errors
+      #   else
+      #     do_something_else
+      #   end
+      class UselessElseWithoutRescue < Base
+        MSG = '`else` without `rescue` is useless.'
+
+        def on_new_investigation
+          processed_source.diagnostics.each do |diagnostic|
+            next unless diagnostic.reason == :useless_else
+
+            add_offense(diagnostic.location, severity: diagnostic.level)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for useless method definitions, specifically: empty constructors
+      # Checks for useless method definitions, specifically: empty constructors
       # and methods just delegating to `super`.
       #
       # @safety

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

@@ -3,10 +3,10 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop looks for `ruby2_keywords` calls for methods that do not need it.
+      # Looks for `ruby2_keywords` calls for methods that do not need it.
       #
       # `ruby2_keywords` should only be called on methods that accept an argument splat
-      # (`*args`) but do not explicit keyword arguments (`k:` or `k: true`) or
+      # (`\*args`) but do not explicit keyword arguments (`k:` or `k: true`) or
       # a keyword splat (`**kwargs`).
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for setter call to local variable as the final
+      # Checks for setter call to local variable as the final
       # expression of a function definition.
       #
       # @safety
@@ -11,7 +11,7 @@ module RuboCop
       #   value that is also accessible outside the local scope. This is not
       #   detected by the cop, and it can yield a false positive.
       #
-      #   As well, auto-correction is unsafe because the method's
+      #   As well, autocorrection is unsafe because the method's
       #   return value will be changed.
       #
       # @example