rubocop 1.26.1 → 1.32.0

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,7 +3,7 @@
 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,
@@ -11,7 +11,7 @@ module RuboCop
       #
       # NOTE: Block methods that are used with `Enumerable`s are considered to be loops.
       #
-      # `IgnoredPatterns` can be used to match against the block receiver in order to allow
+      # `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
       # `Enumerable` context).
       #
@@ -79,12 +79,12 @@ module RuboCop
       #   # bad
       #   2.times { raise ArgumentError }
       #
-      # @example IgnoredPatterns: [/(exactly|at_least|at_most)\(\d+\)\.times/] (default)
+      # @example AllowedPatterns: [/(exactly|at_least|at_most)\(\d+\)\.times/] (default)
       #
       #   # good
       #   exactly(2).times { raise StandardError }
       class UnreachableLoop < Base
-        include IgnoredPattern
+        include AllowedPattern
 
         MSG = 'This loop will have at most one iteration.'
         CONTINUE_KEYWORDS = %i[next redo].freeze
@@ -107,7 +107,7 @@ module RuboCop
           return false unless node.block_type?
 
           send_node = node.send_node
-          return false if matches_ignored_pattern?(send_node.source)
+          return false if matches_allowed_pattern?(send_node.source)
 
           send_node.enumerable_method? || send_node.enumerator_method? || send_node.method?(:loop)
         end

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
@@ -64,7 +64,7 @@ module RuboCop
 
         # @!method not_implemented?(node)
         def_node_matcher :not_implemented?, <<~PATTERN
-          {(send nil? :raise (const {nil? cbase} :NotImplementedError))
+          {(send nil? :raise (const {nil? cbase} :NotImplementedError) ...)
            (send nil? :fail ...)}
         PATTERN
 

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

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

@@ -3,10 +3,9 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for useless `else` in `begin..end` without `rescue`.
+      # Checks for useless `else` in `begin..end` without `rescue`.
       #
-      # NOTE: This syntax is no longer valid on Ruby 2.6 or higher and
-      # this cop is going to be removed at some point the future.
+      # NOTE: This syntax is no longer valid on Ruby 2.6 or higher.
       #
       # @example
       #

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,7 +3,7 @@
 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

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

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for uses of `Integer#times` that will never yield
+      # Checks for uses of `Integer#times` that will never yield
       # (when the integer <= 0) or that will only ever yield once
       # (`1.times`).
       #
@@ -95,7 +95,7 @@ module RuboCop
           # Cleanup indentation in a multiline block
           source_lines = source.split("\n")
 
-          source_lines[1..-1].each do |line|
+          source_lines[1..].each do |line|
             next if line.empty?
 
             line[range] = ''

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for operators, variables, literals, and nonmutating
+      # Checks for operators, variables, literals, and nonmutating
       # methods used in void context.
       #
       # @example CheckForMethodsWithNoSideEffects: false (default)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Metrics
-      # This cop checks that the ABC size of methods is not higher than the
+      # Checks that the ABC size of methods is not higher than the
       # configured maximum. The ABC size is based on assignments, branches
       # (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric
       # and https://en.wikipedia.org/wiki/ABC_Software_Metric.

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Metrics
-      # This cop checks if the length of a block exceeds some maximum value.
+      # Checks if the length of a block exceeds some maximum value.
       # Comment lines can optionally be ignored.
       # The maximum allowed length is configurable.
       # The cop can be configured to ignore blocks passed to certain methods.
@@ -15,6 +15,7 @@ module RuboCop
       #
       # NOTE: The `ExcludedMethods` configuration is deprecated and only kept
       # for backwards compatibility. Please use `IgnoredMethods` instead.
+      # By default, there are no methods to ignored.
       #
       # @example CountAsOne: ['array', 'heredoc']
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Metrics
-      # This cop checks for excessive nesting of conditional and looping
+      # Checks for excessive nesting of conditional and looping
       # constructs.
       #
       # You can configure if blocks are considered using the `CountBlocks`

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Metrics
-      # This cop checks if the length a class exceeds some maximum value.
+      # Checks if the length a class exceeds some maximum value.
       # Comment lines can optionally be ignored.
       # The maximum allowed length is configurable.
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Metrics
-      # This cop checks that the cyclomatic complexity of methods is not higher
+      # Checks that the cyclomatic complexity of methods is not higher
       # than the configured maximum. The cyclomatic complexity is the number of
       # linearly independent paths through a method. The algorithm counts
       # decision points and adds one.

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Metrics
-      # This cop checks if the length of a method exceeds some maximum value.
+      # Checks if the length of a method exceeds some maximum value.
       # Comment lines can optionally be ignored.
       # The maximum allowed length is configurable.
       #
@@ -13,6 +13,7 @@ module RuboCop
       #
       # NOTE: The `ExcludedMethods` configuration is deprecated and only kept
       # for backwards compatibility. Please use `IgnoredMethods` instead.
+      # By default, there are no methods to ignored.
       #
       # @example CountAsOne: ['array', 'heredoc']
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Metrics
-      # This cop checks if the length a module exceeds some maximum value.
+      # Checks if the length a module exceeds some maximum value.
       # Comment lines can optionally be ignored.
       # The maximum allowed length is configurable.
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Metrics
-      # This cop checks for methods with too many parameters.
+      # Checks for methods with too many parameters.
       #
       # The maximum number of parameters is configurable.
       # Keyword arguments can optionally be excluded from the total count,

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Metrics
-      # This cop tries to produce a complexity score that's a measure of the
+      # Tries to produce a complexity score that's a measure of the
       # complexity the reader experiences when looking at a method. For that
       # reason it considers `when` nodes as something that doesn't add as much
       # complexity as an `if` or a `&&`. Except if it's one of those special

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

@@ -96,13 +96,12 @@ module RuboCop
           end
 
           def compound_assignment(node)
-            # Methods setter can not be detected for multiple assignments
+            # Methods setter cannot be detected for multiple assignments
             # and shorthand assigns, so we'll count them here instead
             children = node.masgn_type? ? node.children[0].children : node.children
 
             will_be_miscounted = children.count do |child|
-              child.respond_to?(:setter_method?) &&
-                !child.setter_method?
+              child.respond_to?(:setter_method?) && !child.setter_method?
             end
             @assignment += will_be_miscounted
 

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

@@ -30,8 +30,8 @@ module RuboCop
 
               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?
+              # Subtract length of opening and closing brace if method argument omits hash braces.
+              length -= omit_length(descendant) if descendant.hash_type? && !descendant.braces?
             end
 
             length
@@ -49,7 +49,7 @@ module RuboCop
               when :heredoc
                 ->(node) { heredoc_node?(node) }
               else
-                raise ArgumentError, "Unknown foldable type: #{type.inspect}. "\
+                raise ArgumentError, "Unknown foldable type: #{type.inspect}. " \
                                      "Valid foldable types are: #{FOLDABLE_TYPES.join(', ')}."
               end
             end
@@ -153,6 +153,25 @@ module RuboCop
           def count_comments?
             @count_comments
           end
+
+          def omit_length(descendant)
+            parent = descendant.parent
+            return 0 if another_args?(parent)
+            return 0 unless parenthesized?(parent)
+
+            [
+              parent.loc.begin.end_pos != descendant.loc.expression.begin_pos,
+              parent.loc.end.begin_pos != descendant.loc.expression.end_pos
+            ].count(true)
+          end
+
+          def parenthesized?(node)
+            node.call_type? && node.parenthesized?
+          end
+
+          def another_args?(node)
+            node.call_type? && node.arguments.count > 1
+          end
         end
       end
     end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # This module encapsulates the ability to ignore certain lines when
+    # parsing.
+    module AllowedPattern
+      private
+
+      def allowed_line?(line)
+        line = if line.respond_to?(:source_line)
+                 line.source_line
+               elsif line.respond_to?(:node)
+                 line.node.source_range.source_line
+               end
+
+        matches_allowed_pattern?(line)
+      end
+
+      # @deprecated Use allowed_line? instead
+      alias ignored_line? allowed_line?
+
+      def matches_allowed_pattern?(line)
+        allowed_patterns.any? { |pattern| Regexp.new(pattern).match?(line) }
+      end
+
+      # @deprecated Use matches_allowed_pattern?? instead
+      alias matches_ignored_pattern? matches_allowed_pattern?
+
+      def allowed_patterns
+        # Since there could be a pattern specified in the default config, merge the two
+        # arrays together.
+        Array(cop_config['AllowedPatterns']).concat(Array(cop_config['IgnoredPatterns']))
+      end
+    end
+
+    # @deprecated IgnoredPattern class has been replaced with AllowedPattern.
+    IgnoredPattern = AllowedPattern
+  end
+end

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

@@ -46,6 +46,8 @@ module RuboCop
         if node.send_type?
           args = process_args(node.arguments)
           return extract_breakable_node_from_elements(node, args, max)
+        elsif node.def_type?
+          return extract_breakable_node_from_elements(node, node.arguments, max)
         elsif node.array_type? || node.hash_type?
           return extract_breakable_node_from_elements(node, node.children, max)
         end
@@ -216,6 +218,8 @@ module RuboCop
 
       # @api private
       def already_on_multiple_lines?(node)
+        return node.first_line != node.arguments.last.last_line if node.def_type?
+
         node.first_line != node.last_line
       end
     end

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

@@ -4,8 +4,6 @@ module RuboCop
   module Cop
     # Help methods for working with nodes containing comments.
     module CommentsHelp
-      include VisibilityHelp
-
       def source_range_with_comment(node)
         begin_pos = begin_pos_with_comment(node)
         end_pos = end_position_for(node)
@@ -13,6 +11,13 @@ module RuboCop
         Parser::Source::Range.new(buffer, begin_pos, end_pos)
       end
 
+      def contains_comments?(node)
+        start_line = node.source_range.line
+        end_line = find_end_line(node)
+
+        processed_source.each_comment_in_lines(start_line...end_line).any?
+      end
+
       private
 
       def end_position_for(node)
@@ -37,6 +42,23 @@ module RuboCop
       def buffer
         processed_source.buffer
       end
+
+      # Returns the end line of a node, which might be a comment and not part of the AST
+      # End line is considered either the line at which another node starts, or
+      # the line at which the parent node ends.
+      # rubocop:disable Metrics/AbcSize
+      def find_end_line(node)
+        if node.if_type? && node.loc.else
+          node.loc.else.line
+        elsif (next_sibling = node.right_sibling)
+          next_sibling.loc.line
+        elsif (parent = node.parent)
+          parent.loc.end ? parent.loc.end.line : parent.loc.line
+        else
+          node.loc.end.line
+        end
+      end
+      # rubocop:enable Metrics/AbcSize
     end
   end
 end

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

@@ -5,8 +5,7 @@ module RuboCop
     # Common functionality for checking def nodes.
     module DefNode
       extend NodePattern::Macros
-
-      NON_PUBLIC_MODIFIERS = %w[private protected].freeze
+      include VisibilityHelp
 
       private
 
@@ -15,11 +14,7 @@ module RuboCop
       end
 
       def preceding_non_public_modifier?(node)
-        stripped_source_upto(node.first_line).any? { |line| NON_PUBLIC_MODIFIERS.include?(line) }
-      end
-
-      def stripped_source_upto(index)
-        processed_source[0..index].map(&:strip)
+        node_visibility(node) != :public
       end
 
       # @!method non_public_modifier?(node)

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

@@ -29,7 +29,7 @@ module RuboCop
       # @param [Array] collection an array to return consecutive duplicates for
       # @return [Array] the consecutive duplicates
       def consecutive_duplicates(collection)
-        grouped_duplicates(collection).flat_map { |items| items[1..-1] }
+        grouped_duplicates(collection).flat_map { |items| items[1..] }
       end
 
       # Returns a hash of grouped duplicates. The key will be the first

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

@@ -17,6 +17,7 @@ module RuboCop
 
           message = OMIT_HASH_VALUE_MSG
           replacement = "#{hash_key_source}:"
+          self.config_to_allow_offenses = { 'Enabled' => false }
         else
           return unless node.value_omission?
 
@@ -24,13 +25,17 @@ module RuboCop
           replacement = "#{hash_key_source}: #{hash_key_source}"
         end
 
+        register_offense(node, message, replacement)
+      end
+
+      private
+
+      def register_offense(node, message, replacement)
         add_offense(node.value, message: message) do |corrector|
           corrector.replace(node, replacement)
         end
       end
 
-      private
-
       def ignore_hash_shorthand_syntax?(pair_node)
         target_ruby_version <= 3.0 || enforced_shorthand_syntax == 'either' ||
           !pair_node.parent.hash_type?
@@ -65,9 +70,8 @@ module RuboCop
 
       def use_modifier_form_without_parenthesized_method_call?(ancestor)
         return false if ancestor.respond_to?(:parenthesized?) && ancestor.parenthesized?
-        return false unless (parent = ancestor.parent)
 
-        parent.respond_to?(:modifier_form?) && parent.modifier_form?
+        ancestor.ancestors.any? { |node| node.respond_to?(:modifier_form?) && node.modifier_form? }
       end
 
       def without_parentheses_call_expr_follows?(ancestor)

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

@@ -25,15 +25,17 @@ module RuboCop
 
       def check_first(first, left_brace, left_parenthesis, offset)
         actual_column = first.source_range.column
-        expected_column = base_column(left_brace, left_parenthesis) +
-                          configured_indentation_width + offset
+
+        indent_base_column, indent_base_type = indent_base(left_brace, first, left_parenthesis)
+        expected_column = indent_base_column + configured_indentation_width + offset
+
         @column_delta = expected_column - actual_column
         styles = detected_styles(actual_column, offset, left_parenthesis, left_brace)
 
         if @column_delta.zero?
           check_expected_style(styles)
         else
-          incorrect_style_detected(styles, first, left_parenthesis)
+          incorrect_style_detected(styles, first, indent_base_type)
         end
       end
 
@@ -45,14 +47,34 @@ module RuboCop
         end
       end
 
-      def base_column(left_brace, left_parenthesis)
-        if style == brace_alignment_style
-          left_brace.column
-        elsif left_parenthesis && style == :special_inside_parentheses
-          left_parenthesis.column + 1
-        else
-          left_brace.source_line =~ /\S/
+      def indent_base(left_brace, first, left_parenthesis)
+        return [left_brace.column, :left_brace_or_bracket] if style == brace_alignment_style
+
+        pair = hash_pair_where_value_beginning_with(left_brace, first)
+        if pair && key_and_value_begin_on_same_line?(pair) &&
+           right_sibling_begins_on_subsequent_line?(pair)
+          return [pair.loc.column, :parent_hash_key]
         end
+
+        if left_parenthesis && style == :special_inside_parentheses
+          return [left_parenthesis.column + 1, :first_colmn_after_left_parenthesis]
+        end
+
+        [left_brace.source_line =~ /\S/, :start_of_line]
+      end
+
+      def hash_pair_where_value_beginning_with(left_brace, first)
+        return unless first && first.parent.loc.begin == left_brace
+
+        first.parent&.parent&.pair_type? ? first.parent.parent : nil
+      end
+
+      def key_and_value_begin_on_same_line?(pair)
+        same_line?(pair.key, pair.value)
+      end
+
+      def right_sibling_begins_on_subsequent_line?(pair)
+        pair.right_sibling && (pair.last_line < pair.right_sibling.first_line)
       end
 
       def detected_styles(actual_column, offset, left_parenthesis, left_brace)
@@ -73,8 +95,8 @@ module RuboCop
         styles
       end
 
-      def incorrect_style_detected(styles, first, left_parenthesis)
-        msg = message(base_description(left_parenthesis))
+      def incorrect_style_detected(styles, first, base_column_type)
+        msg = message(base_description(base_column_type))
 
         add_offense(first, message: msg) do |corrector|
           autocorrect(corrector, first)