rubocop 1.9.1 → 1.22.3

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

@@ -87,6 +87,7 @@ module RuboCop
         include IgnoredPattern
 
         MSG = 'This loop will have at most one iteration.'
+        CONTINUE_KEYWORDS = %i[next redo].freeze
 
         def on_while(node)
           check(node)
@@ -116,7 +117,10 @@ module RuboCop
           break_statement = statements.find { |statement| break_statement?(statement) }
           return unless break_statement
 
-          add_offense(node) unless preceded_by_continue_statement?(break_statement)
+          unless preceded_by_continue_statement?(break_statement) ||
+                 conditional_continue_keyword?(break_statement)
+            add_offense(node)
+          end
         end
 
         def statements(node)
@@ -131,6 +135,7 @@ module RuboCop
           end
         end
 
+        # @!method break_command?(node)
         def_node_matcher :break_command?, <<~PATTERN
           {
             return break
@@ -161,8 +166,7 @@ module RuboCop
         def check_if(node)
           if_branch = node.if_branch
           else_branch = node.else_branch
-          if_branch && else_branch &&
-            break_statement?(if_branch) && break_statement?(else_branch)
+          if_branch && else_branch && break_statement?(if_branch) && break_statement?(else_branch)
         end
 
         def check_case(node)
@@ -170,18 +174,22 @@ module RuboCop
           return false unless else_branch
           return false unless break_statement?(else_branch)
 
-          node.when_branches.all? do |branch|
-            branch.body && break_statement?(branch.body)
-          end
+          node.when_branches.all? { |branch| branch.body && break_statement?(branch.body) }
         end
 
         def preceded_by_continue_statement?(break_statement)
           break_statement.left_siblings.any? do |sibling|
             next if sibling.loop_keyword? || loop_method?(sibling)
 
-            sibling.each_descendant(:next, :redo).any?
+            sibling.each_descendant(*CONTINUE_KEYWORDS).any?
           end
         end
+
+        def conditional_continue_keyword?(break_statement)
+          or_node = break_statement.each_descendant(:or).to_a.last
+
+          or_node && CONTINUE_KEYWORDS.include?(or_node.rhs.type)
+        end
       end
     end
   end

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

@@ -68,19 +68,22 @@ module RuboCop
 
         def check_argument(variable)
           return if allowed_block?(variable) ||
-                    allowed_keyword_argument?(variable)
+                    allowed_keyword_argument?(variable) ||
+                    used_block_local?(variable)
 
           super
         end
 
+        def used_block_local?(variable)
+          variable.explicit_block_local_variable? && !variable.assignments.empty?
+        end
+
         def allowed_block?(variable)
-          !variable.block_argument? ||
-            (ignore_empty_blocks? && empty_block?(variable))
+          !variable.block_argument? || (ignore_empty_blocks? && empty_block?(variable))
         end
 
         def allowed_keyword_argument?(variable)
-          variable.keyword_argument? &&
-            allow_unused_keyword_arguments?
+          variable.keyword_argument? && allow_unused_keyword_arguments?
         end
 
         def message(variable)
@@ -115,8 +118,7 @@ module RuboCop
         end
 
         def message_for_normal_block(variable, all_arguments)
-          if all_arguments.none?(&:referenced?) &&
-             !define_method_call?(variable)
+          if all_arguments.none?(&:referenced?) && !define_method_call?(variable)
             if all_arguments.count > 1
               "You can omit all the arguments if you don't care about them."
             else
@@ -141,7 +143,7 @@ module RuboCop
 
         def message_for_underscore_prefix(variable)
           "If it's necessary, use `_` or `_#{variable.name}` " \
-          "as an argument name to indicate that it won't be used."
+            "as an argument name to indicate that it won't be used."
         end
 
         def define_method_call?(variable)

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

@@ -62,6 +62,7 @@ module RuboCop
         include UnusedArgument
         extend AutoCorrector
 
+        # @!method not_implemented?(node)
         def_node_matcher :not_implemented?, <<~PATTERN
           {(send nil? :raise (const {nil? cbase} :NotImplementedError))
            (send nil? :fail ...)}
@@ -79,17 +80,15 @@ module RuboCop
 
         def check_argument(variable)
           return unless variable.method_argument?
-          return if variable.keyword_argument? &&
-                    cop_config['AllowUnusedKeywordArguments']
+          return if variable.keyword_argument? && cop_config['AllowUnusedKeywordArguments']
           return if ignored_method?(variable.scope.node.body)
 
           super
         end
 
         def ignored_method?(body)
-          cop_config['IgnoreEmptyMethods'] && body.nil? ||
-            cop_config['IgnoreNotImplementedMethods'] &&
-              not_implemented?(body)
+          (cop_config['IgnoreEmptyMethods'] && body.nil?) ||
+            (cop_config['IgnoreNotImplementedMethods'] && not_implemented?(body))
         end
 
         def message(variable)

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

@@ -47,6 +47,7 @@ module RuboCop
         METHOD_NAMES = %i[escape encode unescape decode].freeze
         RESTRICT_ON_SEND = METHOD_NAMES
 
+        # @!method uri_escape_unescape?(node)
         def_node_matcher :uri_escape_unescape?, <<~PATTERN
           (send
             (const ${nil? cbase} :URI) ${:#{METHOD_NAMES.join(' :')}}

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

@@ -150,18 +150,22 @@ module RuboCop
           corrector.remove(range)
         end
 
+        # @!method static_method_definition?(node)
         def_node_matcher :static_method_definition?, <<~PATTERN
           {def (send nil? {:attr :attr_reader :attr_writer :attr_accessor} ...)}
         PATTERN
 
+        # @!method dynamic_method_definition?(node)
         def_node_matcher :dynamic_method_definition?, <<~PATTERN
           {(send nil? :define_method ...) (block (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}) ...)
         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 ...) ...)
         PATTERN
@@ -179,8 +183,7 @@ module RuboCop
         end
 
         def access_modifier?(node)
-          node.bare_access_modifier? ||
-            node.method?(:private_class_method)
+          node.bare_access_modifier? || node.method?(:private_class_method)
         end
 
         def check_scope(node)
@@ -260,8 +263,7 @@ module RuboCop
         end
 
         def start_of_new_scope?(child)
-          child.module_type? || child.class_type? ||
-            child.sclass_type? || eval_call?(child)
+          child.module_type? || child.class_type? || child.sclass_type? || eval_call?(child)
         end
 
         def eval_call?(child)

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

@@ -38,9 +38,7 @@ module RuboCop
         end
 
         def after_leaving_scope(scope, _variable_table)
-          scope.variables.each_value do |variable|
-            check_for_unused_assignments(variable)
-          end
+          scope.variables.each_value { |variable| check_for_unused_assignments(variable) }
         end
 
         def check_for_unused_assignments(variable)
@@ -64,8 +62,7 @@ module RuboCop
         def message_for_useless_assignment(assignment)
           variable = assignment.variable
 
-          format(MSG, variable: variable.name) +
-            message_specification(assignment, variable).to_s
+          format(MSG, variable: variable.name) + message_specification(assignment, variable).to_s
         end
 
         def message_specification(assignment, variable)
@@ -85,17 +82,15 @@ module RuboCop
 
         def operator_assignment_message(scope, assignment)
           return_value_node = return_value_node_of_scope(scope)
-          return unless assignment.meta_assignment_node
-                                  .equal?(return_value_node)
+          return unless assignment.meta_assignment_node.equal?(return_value_node)
 
           " Use `#{assignment.operator.sub(/=$/, '')}` " \
-          "instead of `#{assignment.operator}`."
+            "instead of `#{assignment.operator}`."
         end
 
         def similar_name_message(variable)
           variable_like_names = collect_variable_like_names(variable.scope)
-          similar_name = NameSimilarity.find_similar_name(variable.name,
-                                                          variable_like_names)
+          similar_name = NameSimilarity.find_similar_name(variable.name, variable_like_names)
           " Did you mean `#{similar_name}`?" if similar_name
         end
 

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

@@ -6,8 +6,9 @@ module RuboCop
       # This cop checks for useless method definitions, specifically: empty constructors
       # and methods just delegating to `super`.
       #
-      # This cop is marked as unsafe as it can trigger false positives for cases when
-      # an empty constructor just overrides the parent constructor, which is bad anyway.
+      # @safety
+      #   This cop is unsafe as it can register false positives for cases when an empty
+      #   constructor just overrides the parent constructor, which is bad anyway.
       #
       # @example
       #   # bad

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

@@ -5,11 +5,14 @@ module RuboCop
     module Lint
       # This cop checks for setter call to local variable as the final
       # expression of a function definition.
-      # Its auto-correction is marked as unsafe because return value will be changed.
       #
-      # NOTE: There are edge cases in which the local variable references a
-      # value that is also accessible outside the local scope. This is not
-      # detected by the cop, and it can yield a false positive.
+      # @safety
+      #   There are edge cases in which the local variable references a
+      #   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
+      #   return value will be changed.
       #
       # @example
       #
@@ -56,6 +59,7 @@ module RuboCop
 
         private
 
+        # @!method setter_call_to_local_variable?(node)
         def_node_matcher :setter_call_to_local_variable?, <<~PATTERN
           [(send (lvar _) ...) setter_method?]
         PATTERN
@@ -89,9 +93,7 @@ module RuboCop
             catch(:skip_children) do
               yield node
 
-              node.each_child_node do |child_node|
-                scan(child_node, &block)
-              end
+              node.each_child_node { |child_node| scan(child_node, &block) }
             end
           end
 

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

@@ -7,8 +7,9 @@ module RuboCop
       # (when the integer <= 0) or that will only ever yield once
       # (`1.times`).
       #
-      # This cop is marked as unsafe as `times` returns its receiver, which
-      # is *usually* OK, but might change behavior.
+      # @safety
+      #   This cop is unsafe as `times` returns its receiver, which is
+      #   *usually* OK, but might change behavior.
       #
       # @example
       #   # bad
@@ -27,14 +28,17 @@ module RuboCop
         MSG = 'Useless call to `%<count>i.times` detected.'
         RESTRICT_ON_SEND = %i[times].freeze
 
+        # @!method times_call?(node)
         def_node_matcher :times_call?, <<~PATTERN
           (send (int $_) :times (block-pass (sym $_))?)
         PATTERN
 
+        # @!method block_arg(node)
         def_node_matcher :block_arg, <<~PATTERN
           (block _ (args (arg $_)) ...)
         PATTERN
 
+        # @!method block_reassigns_arg?(node)
         def_node_search :block_reassigns_arg?, <<~PATTERN
           (lvasgn %)
         PATTERN
@@ -62,7 +66,7 @@ module RuboCop
         private
 
         def never_process?(count, node)
-          count < 1 || node.block_type? && node.body.nil?
+          count < 1 || (node.block_type? && node.body.nil?)
         end
 
         def remove_node(corrector, node)
@@ -78,7 +82,7 @@ module RuboCop
           return if block_reassigns_arg?(node, block_arg)
 
           source = node.body.source
-          source.gsub!(/\b#{block_arg}\b/, '1') if block_arg
+          source.gsub!(/\b#{block_arg}\b/, '0') if block_arg
 
           corrector.replace(node, fix_indentation(source, node.loc.column...node.body.loc.column))
         end

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

@@ -46,8 +46,7 @@ module RuboCop
         LIT_MSG = 'Literal `%<lit>s` used in void context.'
         SELF_MSG = '`self` used in void context.'
         DEFINED_MSG = '`%<defined>s` used in void context.'
-        NONMUTATING_MSG = 'Method `#%<method>s` used in void context. ' \
-          'Did you mean `#%<method>s!`?'
+        NONMUTATING_MSG = 'Method `#%<method>s` used in void context. Did you mean `#%<method>s!`?'
 
         BINARY_OPERATORS = %i[* / % + - == === != < > <= >= <=>].freeze
         UNARY_OPERATORS = %i[+@ -@ ~ !].freeze
@@ -78,9 +77,7 @@ module RuboCop
         def check_begin(node)
           expressions = *node
           expressions.pop unless in_void_context?(node)
-          expressions.each do |expr|
-            check_expression(expr)
-          end
+          expressions.each { |expr| check_expression(expr) }
         end
 
         def check_expression(expr)
@@ -107,7 +104,7 @@ module RuboCop
         end
 
         def check_literal(node)
-          return if !node.literal? || node.xstr_type?
+          return if !node.literal? || node.xstr_type? || node.range_type?
 
           add_offense(node, message: format(LIT_MSG, lit: node.source))
         end
@@ -125,13 +122,9 @@ module RuboCop
         end
 
         def check_nonmutating(node)
-          unless node.send_type? &&
-                 NONMUTATING_METHODS.include?(node.method_name)
-            return
-          end
+          return unless node.send_type? && NONMUTATING_METHODS.include?(node.method_name)
 
-          add_offense(node, message: format(NONMUTATING_MSG,
-                                            method: node.method_name))
+          add_offense(node, message: format(NONMUTATING_MSG, method: node.method_name))
         end
 
         def in_void_context?(node)

data/lib/rubocop/cop/message_annotator.rb

@@ -96,9 +96,7 @@ module RuboCop
       end
 
       def display_style_guide?
-        (options[:display_style_guide] ||
-         config.for_all_cops['DisplayStyleGuide']) &&
-          !urls.empty?
+        (options[:display_style_guide] || config.for_all_cops['DisplayStyleGuide']) && !urls.empty?
       end
 
       def reference_urls

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

@@ -8,6 +8,12 @@ module RuboCop
       # (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric
       # and https://en.wikipedia.org/wiki/ABC_Software_Metric.
       #
+      # Interpreting ABC size:
+      #
+      # * <= 17 satisfactory
+      # * 18..30 unsatisfactory
+      # * > 30 dangerous
+      #
       # You can have repeated "attributes" calls count as a single "branch".
       # For this purpose, attributes are any method with no argument; no attempt
       # is meant to distinguish actual `attr_reader` from other methods.

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

@@ -12,10 +12,7 @@ module RuboCop
       #
       # The maximum level of nesting allowed is configurable.
       class BlockNesting < Base
-        NESTING_BLOCKS = %i[
-          case if while while_post
-          until until_post for resbody
-        ].freeze
+        NESTING_BLOCKS = %i[case if while while_post until until_post for resbody].freeze
 
         exclude_limit 'Max'
 
@@ -34,9 +31,7 @@ module RuboCop
             if current_level > max
               self.max = current_level
               unless part_of_ignored_node?(node)
-                add_offense(node, message: message(max)) do
-                  ignore_node(node)
-                end
+                add_offense(node, message: message(max)) { ignore_node(node) }
               end
             end
           end

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

@@ -57,9 +57,7 @@ module RuboCop
         private
 
         def message(length, max_length)
-          format('Class has too many lines. [%<length>d/%<max>d]',
-                 length: length,
-                 max: max_length)
+          format('Class has too many lines. [%<length>d/%<max>d]', length: length, max: max_length)
         end
       end
     end

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

@@ -33,8 +33,7 @@ module RuboCop
         include MethodComplexity
         include Utils::IteratingBlock
 
-        MSG = 'Cyclomatic complexity for %<method>s is too high. ' \
-              '[%<complexity>d/%<max>d]'
+        MSG = 'Cyclomatic complexity for %<method>s is too high. [%<complexity>d/%<max>d]'
         COUNTED_NODES = %i[if while until for csend block block_pass
                            rescue when and or or_asgn and_asgn].freeze
 

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

@@ -37,21 +37,18 @@ module RuboCop
         end
 
         def on_casgn(node)
-          module_definition?(node) do
-            check_code_length(node)
-          end
+          module_definition?(node) { check_code_length(node) }
         end
 
         private
 
+        # @!method module_definition?(node)
         def_node_matcher :module_definition?, <<~PATTERN
           (casgn nil? _ (block (send (const {nil? cbase} :Module) :new) ...))
         PATTERN
 
         def message(length, max_length)
-          format('Module has too many lines. [%<length>d/%<max>d]',
-                 length: length,
-                 max: max_length)
+          format('Module has too many lines. [%<length>d/%<max>d]', length: length, max: max_length)
         end
       end
     end

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

@@ -9,6 +9,9 @@ module RuboCop
       # Keyword arguments can optionally be excluded from the total count,
       # as they add less complexity than positional or optional parameters.
       #
+      # NOTE: Explicit block argument `&block` is not counted to prevent
+      #       erroneous change that is avoided by making block argument implicit.
+      #
       # @example Max: 3
       #   # good
       #   def foo(a, b, c = 1)
@@ -54,8 +57,7 @@ module RuboCop
         exclude_limit 'Max'
         exclude_limit 'MaxOptionalParameters'
 
-        MSG = 'Avoid parameter lists longer than %<max>d parameters. ' \
-              '[%<count>d/%<max>d]'
+        MSG = 'Avoid parameter lists longer than %<max>d parameters. [%<count>d/%<max>d]'
         OPTIONAL_PARAMETERS_MSG = 'Method has too many optional parameters. [%<count>d/%<max>d]'
 
         NAMED_KEYWORD_TYPES = %i[kwoptarg kwarg].freeze
@@ -71,9 +73,7 @@ module RuboCop
             count: optargs.count
           )
 
-          add_offense(node, message: message) do
-            self.max_optional_parameters = optargs.count
-          end
+          add_offense(node, message: message) { self.max_optional_parameters = optargs.count }
         end
         alias on_defs on_def
 
@@ -90,15 +90,16 @@ module RuboCop
 
         private
 
+        # @!method argument_to_lambda_or_proc?(node)
         def_node_matcher :argument_to_lambda_or_proc?, <<~PATTERN
           ^lambda_or_proc?
         PATTERN
 
         def args_count(node)
           if count_keyword_args?
-            node.children.size
+            node.children.count { |a| !a.blockarg_type? }
           else
-            node.children.count { |a| !NAMED_KEYWORD_TYPES.include?(a.type) }
+            node.children.count { |a| !NAMED_KEYWORD_TYPES.include?(a.type) && !a.blockarg_type? }
           end
         end
 

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

@@ -27,8 +27,7 @@ module RuboCop
       #     end                           # ===
       #   end                             # 7 complexity points
       class PerceivedComplexity < CyclomaticComplexity
-        MSG = 'Perceived complexity for %<method>s is too high. ' \
-              '[%<complexity>d/%<max>d]'
+        MSG = 'Perceived complexity for %<method>s is too high. [%<complexity>d/%<max>d]'
 
         COUNTED_NODES = (CyclomaticComplexity::COUNTED_NODES - [:when] + [:case]).freeze
 
@@ -46,7 +45,7 @@ module RuboCop
             else
               # Otherwise, the case node gets 0.8 complexity points and each
               # when gets 0.2.
-              (0.8 + 0.2 * nb_branches).round
+              (0.8 + (0.2 * nb_branches)).round
             end
           when :if
             node.else? && !node.elsif? ? 2 : 1

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

@@ -43,12 +43,10 @@ module RuboCop
           end
 
           def calculate
-            visit_depth_last(@node) do |child|
-              calculate_node(child)
-            end
+            visit_depth_last(@node) { |child| calculate_node(child) }
 
             [
-              Math.sqrt(@assignment**2 + @branch**2 + @condition**2).round(2),
+              Math.sqrt((@assignment**2) + (@branch**2) + (@condition**2)).round(2),
               "<#{@assignment}, #{@branch}, #{@condition}>"
             ]
           end
@@ -68,9 +66,7 @@ module RuboCop
           end
 
           def else_branch?(node)
-            %i[case if].include?(node.type) &&
-              node.else? &&
-              node.loc.else.is?('else')
+            %i[case if].include?(node.type) && node.else? && node.loc.else.is?('else')
           end
 
           private
@@ -125,7 +121,8 @@ module RuboCop
           end
 
           def capturing_variable?(name)
-            name && !/^_/.match?(name)
+            # TODO: Remove `Symbol#to_s` after supporting only Ruby >= 2.7.
+            name && !name.to_s.start_with?('_')
           end
 
           def branch?(node)

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

@@ -26,10 +26,12 @@ module RuboCop
             return length if @foldable_types.empty?
 
             each_top_level_descendant(@node, @foldable_types) do |descendant|
-              if foldable_node?(descendant)
-                descendant_length = code_length(descendant)
-                length = length - descendant_length + 1
-              end
+              next unless foldable_node?(descendant)
+
+              descendant_length = code_length(descendant)
+              length = length - descendant_length + 1
+              # Subtract 2 length of opening and closing brace if method argument omits hash braces.
+              length -= 2 if descendant.hash_type? && !descendant.braces?
             end
 
             length
@@ -48,7 +50,7 @@ module RuboCop
                 ->(node) { heredoc_node?(node) }
               else
                 raise ArgumentError, "Unknown foldable type: #{type.inspect}. "\
-                  "Valid foldable types are: #{FOLDABLE_TYPES.join(', ')}."
+                                     "Valid foldable types are: #{FOLDABLE_TYPES.join(', ')}."
               end
             end
           end
@@ -145,7 +147,7 @@ module RuboCop
 
           # Returns true for lines that shall not be included in the count.
           def irrelevant_line?(source_line)
-            source_line.blank? || !count_comments? && comment_line?(source_line)
+            source_line.blank? || (!count_comments? && comment_line?(source_line))
           end
 
           def count_comments?

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

@@ -32,10 +32,7 @@ module RuboCop
             return unless discount_repeated_attributes
 
             self_attributes = {} # Share hash for `(send nil? :foo)` and `(send (self) :foo)`
-            @known_attributes = {
-              s(:self) => self_attributes,
-              nil => self_attributes
-            }
+            @known_attributes = { s(:self) => self_attributes, nil => self_attributes }
             # example after running `obj = foo.bar; obj.baz.qux`
             # { nil => {foo: {bar: {}}},
             #   s(self) => same hash ^,
@@ -60,6 +57,7 @@ module RuboCop
 
           private
 
+          # @!method attribute_call?(node)
           def_node_matcher :attribute_call?, <<~PATTERN
             ( {csend send} _receiver _method # and no parameters
             )
@@ -90,6 +88,7 @@ module RuboCop
             end
           end
 
+          # @!method root_node?(node)
           def_node_matcher :root_node?, <<~PATTERN
             { nil? | self               # e.g. receiver of `my_method` or `self.my_attr`
             | lvar | ivar | cvar | gvar # e.g. receiver of `var.my_method`
@@ -112,9 +111,7 @@ module RuboCop
               return yield nil
             end
 
-            calls.fetch(value) do
-              yield [calls, value]
-            end
+            calls.fetch(value) { yield [calls, value] }
           end
 
           VAR_SETTER_TO_GETTER = {