rubocop 1.11.0 → 1.15.0

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

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

@@ -80,8 +80,7 @@ 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

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

@@ -183,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)
@@ -264,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,8 +82,7 @@ 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}`."
@@ -94,8 +90,7 @@ module RuboCop
 
         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_setter_call.rb

@@ -90,9 +90,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/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/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,9 +37,7 @@ 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
@@ -50,9 +48,7 @@ module RuboCop
         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

@@ -54,8 +54,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 +70,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
 

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
 

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

@@ -43,9 +43,7 @@ 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),
@@ -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/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 ^,
@@ -114,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 = {

data/lib/rubocop/cop/migration/department_name.rb

@@ -11,8 +11,7 @@ module RuboCop
 
         MSG = 'Department name is missing.'
 
-        DISABLE_COMMENT_FORMAT =
-          /\A(# *rubocop *: *((dis|en)able|todo) +)(.*)/.freeze
+        DISABLE_COMMENT_FORMAT = /\A(# *rubocop *: *((dis|en)able|todo) +)(.*)/.freeze
 
         # The token that makes up a disable comment.
         # The allowed specification for comments after `# rubocop: disable` is
@@ -62,8 +61,7 @@ module RuboCop
         end
 
         def valid_content_token?(content_token)
-          /\W+/.match?(content_token) ||
-            DISABLING_COPS_CONTENT_TOKEN.match?(content_token)
+          /\W+/.match?(content_token) || DISABLING_COPS_CONTENT_TOKEN.match?(content_token)
         end
 
         def contain_unexpected_character_for_department_name?(name)
@@ -73,9 +71,7 @@ module RuboCop
         def qualified_legacy_cop_name(cop_name)
           legacy_cop_names = RuboCop::ConfigObsoletion.legacy_cop_names
 
-          legacy_cop_names.detect do |legacy_cop_name|
-            legacy_cop_name.split('/')[1] == cop_name
-          end
+          legacy_cop_names.detect { |legacy_cop_name| legacy_cop_name.split('/')[1] == cop_name }
         end
       end
     end

data/lib/rubocop/cop/mixin/alignment.rb

@@ -12,8 +12,7 @@ module RuboCop
       attr_reader :column_delta
 
       def configured_indentation_width
-        cop_config['IndentationWidth'] ||
-          config.for_cop('Layout/IndentationWidth')['Width']
+        cop_config['IndentationWidth'] || config.for_cop('Layout/IndentationWidth')['Width']
       end
 
       def indentation(node)
@@ -29,15 +28,15 @@ module RuboCop
 
         each_bad_alignment(items, base_column) do |current|
           expr = current.source_range
-          if offenses.any? { |o| within?(expr, o.location) }
+          if @current_offenses.any? { |o| within?(expr, o.location) }
             # If this offense is within a line range that is already being
             # realigned by autocorrect, we report the offense without
             # autocorrecting it. Two rewrites in the same area by the same
             # cop cannot be handled. The next iteration will find the
             # offense again and correct it.
-            add_offense(nil, location: expr)
+            register_offense(expr, nil)
           else
-            add_offense(current)
+            register_offense(current, current)
           end
         end
       end
@@ -46,8 +45,7 @@ module RuboCop
       def each_bad_alignment(items, base_column)
         prev_line = -1
         items.each do |current|
-          if current.loc.line > prev_line &&
-             begins_its_line?(current.source_range)
+          if current.loc.line > prev_line && begins_its_line?(current.source_range)
             @column_delta = base_column - display_column(current.source_range)
 
             yield current if @column_delta.nonzero?
@@ -71,6 +69,13 @@ module RuboCop
       def end_of_line_comment(line)
         processed_source.line_with_comment?(line)
       end
+
+      # @api private
+      def register_offense(offense_node, message_node)
+        add_offense(offense_node, message: message(message_node)) do |corrector|
+          autocorrect(corrector, message_node)
+        end
+      end
     end
   end
 end

data/lib/rubocop/cop/mixin/check_line_breakable.rb

@@ -70,20 +70,36 @@ module RuboCop
       def extract_first_element_over_column_limit(node, elements, max)
         line = node.first_line
 
-        # If the first argument is a hash pair but the method is not parenthesized,
-        # the argument cannot be moved to another line because it cause a syntax error.
-        elements.shift if node.send_type? && !node.parenthesized? && elements.first.pair_type?
+        # If a `send` node is not parenthesized, don't move the first element, because it
+        # can result in changed behavior or a syntax error.
+        elements = elements.drop(1) if node.send_type? && !node.parenthesized?
 
         i = 0
         i += 1 while within_column_limit?(elements[i], max, line)
+        i = shift_elements_for_heredoc_arg(node, elements, i)
+
+        return if i.nil?
         return elements.first if i.zero?
 
         elements[i - 1]
       end
 
+      # @api private
+      # If a send node contains a heredoc argument, splitting cannot happen
+      # after the heredoc or else it will cause a syntax error.
+      def shift_elements_for_heredoc_arg(node, elements, index)
+        return index unless node.send_type?
+
+        heredoc_index = elements.index { |arg| (arg.str_type? || arg.dstr_type?) && arg.heredoc? }
+        return index unless heredoc_index
+        return nil if heredoc_index.zero?
+
+        heredoc_index >= index ? index : heredoc_index + 1
+      end
+
       # @api private
       def within_column_limit?(element, max, line)
-        element && element.loc.column < max && element.loc.line == line
+        element && element.loc.column <= max && element.loc.line == line
       end
 
       # @api private