rubocop 1.90.0 → 1.92.0

data/lib/rubocop/cop/layout/line_continuation_spacing.rb

@@ -111,6 +111,12 @@ module RuboCop
           comments.map(&:source_range)
         end
 
+        def output_record_separator_ranges(ast)
+          return [] if ast.nil?
+
+          ast.each_node(:gvar).select { |gvar| gvar.source == '$\\' }.map(&:source_range)
+        end
+
         def last_line(processed_source)
           last_token = processed_source.tokens.last
 
@@ -123,7 +129,8 @@ module RuboCop
 
         def ignored_ranges
           @ignored_ranges ||= ignored_literal_ranges(processed_source.ast) +
-                              comment_ranges(processed_source.comments)
+                              comment_ranges(processed_source.comments) +
+                              output_record_separator_ranges(processed_source.ast)
         end
 
         def ignored_parent?(node)

data/lib/rubocop/cop/layout/line_end_string_concatenation_indentation.rb

@@ -87,10 +87,10 @@ module RuboCop
           return if children.empty?
 
           if style == :aligned && !always_indented?(node)
-            check_aligned(children, 1)
+            check_aligned(children, 1, children[0].loc.column)
           else
             check_indented(children)
-            check_aligned(children, 2)
+            check_aligned(children, 2, indented_column(children))
           end
         end
 
@@ -110,21 +110,37 @@ module RuboCop
           PARENT_TYPES_FOR_INDENTED.include?(dstr_node.parent&.type)
         end
 
-        def check_aligned(children, start_index)
+        def check_aligned(children, start_index, target_column)
           base_column = children[start_index - 1].loc.column
-          children[start_index..].each do |child|
-            @column_delta = base_column - child.loc.column
-            add_offense_and_correction(child, MSG_ALIGN) if @column_delta != 0
-            base_column = child.loc.column
+          same_column_runs(children[start_index..]).each do |run|
+            column = run.first.loc.column
+            if column != base_column && column != target_column
+              register_misaligned_run(run, target_column - column)
+            end
+            base_column = column
+          end
+        end
+
+        def same_column_runs(parts)
+          parts.chunk_while { |a, b| a.loc.column == b.loc.column }
+        end
+
+        def register_misaligned_run(run, column_delta)
+          @column_delta = column_delta
+          add_offense(run.first, message: MSG_ALIGN) do |corrector|
+            run.each { |child| autocorrect(corrector, child) }
           end
         end
 
         def check_indented(children)
-          @column_delta = base_column(children[0]) + configured_indentation_width -
-                          children[1].loc.column
+          @column_delta = indented_column(children) - children[1].loc.column
           add_offense_and_correction(children[1], MSG_INDENT) if @column_delta != 0
         end
 
+        def indented_column(children)
+          base_column(children[0]) + configured_indentation_width
+        end
+
         def base_column(child)
           grandparent = child.parent.parent
           if grandparent&.pair_type?

data/lib/rubocop/cop/layout/line_length.rb

@@ -72,6 +72,22 @@ module RuboCop
 
         MSG = 'Line is too long. [%<length>d/%<max>d]'
 
+        # A trailing backslash, or a trailing unicode, hex, octal, meta or control escape whose
+        # payload may be incomplete. An even run of backslashes is complete on its own.
+        # Meta and control prefixes chain (`\M-\C-x`, `\c\M-x`), so a whole chain is one escape,
+        # and a braced unicode escape may hold several space-separated codepoints.
+        ESCAPE_SEQUENCE_TAIL = /
+          (?<!\\)(?:\\\\)*
+          (
+            \\(?:(?:[MC]-|c)\\)*
+            (?:u\{[\da-f\x20]*|u[\da-f]{0,4}|x[\da-f]{0,2}|[0-7]{0,3}|[MC]-?|c)?
+          )\z
+        /xi.freeze
+
+        def self.autocorrect_incompatible_with
+          [Style::MethodCallWithArgsParentheses]
+        end
+
         def on_block(node)
           check_for_breakable_block(node)
         end
@@ -104,6 +120,11 @@ module RuboCop
         alias on_defs on_def
 
         def on_new_investigation
+          @breakable_range_by_line_index = {}
+          @breakable_string_delimiters = {}
+          @endless_methods_by_line = {}
+          @heredocs = nil
+
           return unless processed_source.raw_source.include?(';')
 
           check_for_breakable_semicolons(processed_source)
@@ -209,6 +230,8 @@ module RuboCop
           return if receiver_contains_heredoc?(block_node)
 
           line_index = block_node.loc.line - 1
+          return if breakable_string_delimiters[line_index]
+
           range = breakable_block_range(block_node)
           pos = range.begin_pos + 1
 
@@ -277,7 +300,8 @@ module RuboCop
           return if source_range.last_column < max
           return unless (pos = breakable_string_range(node))
 
-          pos.end_pos unless pos.end_pos == source_range.begin_pos
+          content_begin_pos = node.loc?(:begin) ? node.loc.begin.end_pos : source_range.begin_pos
+          pos.end_pos if pos.end_pos > content_begin_pos
         end
 
         # Locate where to break a string that is too long, ensuring that escape characters
@@ -288,21 +312,55 @@ module RuboCop
           source_range = node.source_range
           relevant_substr = largest_possible_string(node)
 
-          if (space_pos = relevant_substr.rindex(/\s/))
-            source_range.resize(space_pos + 1)
-          elsif (escape_pos = relevant_substr.rindex(/\\(u[\da-f]{0,4}|x[\da-f]{0,2})?\z/))
+          if (space_pos = breakable_space_position(node, relevant_substr))
+            # A space can separate codepoints inside a braced unicode escape.
+            escape_pos = escape_sequence_start(relevant_substr[0..space_pos])
+            source_range.resize(escape_pos || (space_pos + 1))
+          elsif (escape_pos = escape_sequence_start(relevant_substr))
             source_range.resize(escape_pos)
           else
-            adjustment = max - source_range.last_column - 3
-            return if adjustment.abs > source_range.size
-
-            source_range.adjust(end_pos: adjustment)
+            breakable_string_range_at_limit(source_range)
           end
         end
 
+        def breakable_space_position(node, substr)
+          limit = string_content_length(node) - 1
+          space_pos = substr.rindex(/\s/)
+          space_pos = substr[0, limit].rindex(/\s/) if space_pos && space_pos + 1 > limit
+          space_pos
+        end
+
+        def escape_sequence_start(text)
+          text.match(ESCAPE_SEQUENCE_TAIL)&.begin(1)
+        end
+
+        def breakable_string_range_at_limit(source_range)
+          adjustment = max - source_range.last_column - 3
+          return if adjustment.abs > source_range.size
+
+          cut = source_range.adjust(end_pos: adjustment)
+          escape_pos = escape_sequence_start(cut.source)
+          escape_pos ? source_range.resize(escape_pos) : cut
+        end
+
+        def string_content_length(node)
+          content_end = node.loc?(:end) ? node.loc.end.begin_pos : node.source_range.end_pos
+
+          content_end - node.source_range.begin_pos
+        end
+
         def breakable_dstr_begin_position(node)
           source_range = node.source_range
-          source_range.begin_pos if source_range.column < max && source_range.last_column >= max
+          return unless source_range.column < max && source_range.last_column >= max
+          return if opens_string?(node)
+
+          source_range.begin_pos
+        end
+
+        def opens_string?(begin_node)
+          quote = begin_node.parent.loc.begin
+
+          quote && quote.end_pos == begin_node.source_range.begin_pos
         end
 
         def breakable_range_by_line_index
@@ -493,16 +551,10 @@ module RuboCop
           # `Max` - end delimiter (quote) - continuation characters (space and slash)
           max_length = max - 3
           # Offset by the string's starting column so the broken line actually fits
-          # within `Max`. When on the same line as its parent, use the column difference;
-          # otherwise the string is indented on its own line, so subtract that indentation.
-          # (Without this, an indented string under a multi-line parent never shortens
-          # below `Max` and the autocorrect loops, inserting empty `"" \` fragments.)
-          max_length -= if same_line?(node, node.parent)
-                          column_offset_between(node.loc, node.parent.loc)
-                        else
-                          node.loc.column
-                        end
-          node.source[0...(max_length)]
+          # within `Max`, whatever precedes the string on its line.
+          max_length -= node.loc.column
+
+          node.source[0, [max_length, 0].max]
         end
       end
     end

data/lib/rubocop/cop/layout/multiline_array_brace_layout.rb

@@ -106,6 +106,18 @@ module RuboCop
         ALWAYS_SAME_LINE_MESSAGE = 'The closing array brace must be on the ' \
                                    'same line as the last array element.'
 
+        # Moving the closing bracket after a hash literal or method call element while
+        # `Layout/MultilineHashBraceLayout` or `Layout/MultilineMethodCallBraceLayout` moves
+        # that element's closing brace in the same pass places the bracket after whatever
+        # follows the moved brace, such as a comment.
+        # Moving it while `Style/ConcatArrayLiterals` removes the brackets in the same pass
+        # leaves the bracket behind.
+        def self.autocorrect_incompatible_with
+          [
+            Layout::MultilineHashBraceLayout, Layout::MultilineMethodCallBraceLayout, Style::ConcatArrayLiterals
+          ]
+        end
+
         def on_array(node)
           check_brace_layout(node)
         end

data/lib/rubocop/cop/layout/multiline_block_layout.rb

@@ -56,6 +56,13 @@ module RuboCop
         ARG_MSG = 'Block argument expression is not on the same line as the block start.'
         PIPE_SIZE = '|'.length
 
+        # `Style/Lambda` moves the block arguments of `lambda` into `->(...)`, and
+        # `Style/ItBlockParameter` and `Style/HashEachMethods` remove some or all of them,
+        # in the same pass, while this cop moves them next to the block start.
+        def self.autocorrect_incompatible_with
+          [Style::HashEachMethods, Style::ItBlockParameter, Style::Lambda]
+        end
+
         def on_block(node)
           return if node.single_line?
 
@@ -155,7 +162,7 @@ module RuboCop
         end
 
         def include_trailing_comma?(args)
-          arg_count = args.each_descendant(:arg).to_a.size
+          arg_count = args.each_descendant.count(&:argument_type?)
           arg_count == 1 && args.source.include?(',')
         end
       end

data/lib/rubocop/cop/layout/multiline_hash_brace_layout.rb

@@ -106,6 +106,13 @@ module RuboCop
         ALWAYS_SAME_LINE_MESSAGE = 'Closing hash brace must be on the same ' \
                                    'line as the last hash element.'
 
+        # Moving the closing brace while `Style/HashAsLastArrayItem` or
+        # `Style/RedundantDoubleSplatHashBraces` removes the braces in the same pass leaves
+        # the brace behind.
+        def self.autocorrect_incompatible_with
+          [Style::HashAsLastArrayItem, Style::RedundantDoubleSplatHashBraces]
+        end
+
         def on_hash(node)
           check_brace_layout(node)
         end

data/lib/rubocop/cop/layout/multiline_method_call_brace_layout.rb

@@ -106,6 +106,12 @@ module RuboCop
         ALWAYS_SAME_LINE_MESSAGE = 'Closing method call brace must be on ' \
                                    'the same line as the last argument.'
 
+        # Moving the closing parenthesis and removing it under `omit_parentheses` in the same pass
+        # leaves the moved parenthesis behind.
+        def self.autocorrect_incompatible_with
+          [Style::MethodCallWithArgsParentheses]
+        end
+
         def on_send(node)
           check_brace_layout(node)
         end

data/lib/rubocop/cop/layout/multiline_method_call_indentation.rb

@@ -73,14 +73,28 @@ module RuboCop
         end
 
         def find_pair_ancestor(node)
+          child = node
           node.each_ancestor do |ancestor|
             return ancestor if ancestor.pair_type?
             break if grouped_expression?(ancestor) || inside_arg_list_parentheses?(node, ancestor)
+            break if inside_body?(ancestor, child)
+
+            child = ancestor
           end
 
           nil
         end
 
+        # A block, `begin`, `if` or loop body is a separate set of statements, so
+        # a method chain in it is not the value of a hash pair the body is nested in.
+        # The send node of a block is still part of the value.
+        def inside_body?(ancestor, child)
+          return !child.equal?(ancestor.send_node) if ancestor.any_block_type?
+          return !ancestor.ternary? if ancestor.if_type?
+
+          ancestor.type?(:kwbegin, :while, :until, :for)
+        end
+
         def unwrap_block_node(node)
           node&.any_block_type? ? node.send_node : node
         end

data/lib/rubocop/cop/layout/multiline_method_definition_brace_layout.rb

@@ -118,6 +118,10 @@ module RuboCop
         ALWAYS_SAME_LINE_MESSAGE = 'Closing method definition brace must be ' \
                                    'on the same line as the last parameter.'
 
+        def self.autocorrect_incompatible_with
+          [Style::MultilineMethodSignature]
+        end
+
         def on_def(node)
           check_brace_layout(node.arguments)
         end

data/lib/rubocop/cop/layout/redundant_line_break.rb

@@ -54,6 +54,11 @@ module RuboCop
 
         MSG = 'Redundant line break detected.'
 
+        def on_new_investigation
+          super
+          @offense_line_ranges = []
+        end
+
         def on_lvasgn(node)
           super unless end_with_percent_blank_string?(processed_source)
         end
@@ -77,12 +82,15 @@ module RuboCop
         end
 
         def check_assignment(node, _rhs)
-          return unless offense?(node)
+          return unless offense?(node) && !part_of_ignored_node?(node)
 
           register_offense(node)
         end
 
         def register_offense(node)
+          line_range = joined_line_range(node)
+          return if too_long_as_single_line?(line_range)
+
           # The exact single-line correction is verified to parse equivalently
           # before the offense is registered, so a join that would change how
           # the code parses is never reported or offered.
@@ -92,6 +100,19 @@ module RuboCop
             corrector.replace(node, to_single_line(node.source).strip)
           end
           ignore_node(node)
+          @offense_line_ranges.reject! { |range| line_range.cover?(range) }
+          @offense_line_ranges << line_range
+        end
+
+        # Offenses registered in the same pass that share a line with `node`
+        # get joined onto that line too, so the combined line has to fit.
+        def joined_line_range(node)
+          sharing_ranges = @offense_line_ranges.select do |range|
+            range.begin <= node.last_line && node.first_line <= range.end
+          end
+          lines = [node.first_line, node.last_line, *sharing_ranges.flat_map(&:minmax)]
+
+          lines.min..lines.max
         end
 
         def apply_reparse_correction(corrector, node)

data/lib/rubocop/cop/layout/rescue_ensure_alignment.rb

@@ -22,6 +22,7 @@ module RuboCop
       #     puts 'error'
       #   end
       class RescueEnsureAlignment < Base
+        include Alignment
         include RangeHelp
         include EndKeywordAlignment
         extend AutoCorrector
@@ -74,9 +75,10 @@ module RuboCop
           # Some inline node is sitting before current node.
           return nil unless whitespace.source.strip.empty?
 
-          new_column = alignment_location.column
+          indentation = alignment_indentation(alignment_location)
+          return nil if indentation.nil?
 
-          corrector.replace(whitespace, ' ' * new_column)
+          corrector.replace(whitespace, indentation)
         end
 
         def format_message(alignment_node, alignment_loc, kw_loc)
@@ -91,6 +93,17 @@ module RuboCop
           )
         end
 
+        # A run of spaces sized to the target column would be turned back into tabs by
+        # `Layout/IndentationStyle`, generally landing on a different column, so under
+        # tabs the target line's own indentation is reused. There is nothing to reuse
+        # when the target does not start its line.
+        def alignment_indentation(location)
+          return ' ' * location.column unless using_tabs?
+          return unless begins_its_line?(location)
+
+          location.source_line[/\A\s*/]
+        end
+
         # rubocop:disable-next Metrics/AbcSize, Metrics/MethodLength
         def alignment_source(node, starting_loc)
           ending_loc =

data/lib/rubocop/cop/layout/single_line_block_chain.rb

@@ -25,13 +25,17 @@ module RuboCop
 
         MSG = 'Put method call on a separate line if chained to a single line block.'
 
+        # `Style/FloatDivision` and `Style/NilComparison` rewrite a method chained to the block
+        # in the same pass, which must not start a line of its own.
         def self.autocorrect_incompatible_with
-          [Style::MapToHash]
+          [Style::FloatDivision, Style::MapToHash, Style::NilComparison]
         end
 
         def on_send(node)
           range = offending_range(node)
-          add_offense(range) { |corrector| corrector.insert_before(range, "\n") } if range
+          return if !range || heredoc_opened_before?(node.receiver, range)
+
+          add_offense(range) { |corrector| corrector.insert_before(range, "\n") }
         end
         alias on_csend on_send
 
@@ -63,6 +67,10 @@ module RuboCop
           # l.(1) has no selector, so we use the opening parenthesis instead
           node.loc.selector || node.loc.begin
         end
+
+        def heredoc_opened_before?(receiver, range)
+          receiver.each_node(:any_str).any? { |str| str.heredoc? && str.first_line == range.line }
+        end
       end
     end
   end

data/lib/rubocop/cop/layout/space_after_not.rb

@@ -20,6 +20,7 @@ module RuboCop
 
         def on_send(node)
           return unless node.prefix_bang? && whitespace_after_operator?(node)
+          return if unary_tilde?(node.receiver)
 
           add_offense(node) do |corrector|
             corrector.remove(
@@ -33,6 +34,10 @@ module RuboCop
         def whitespace_after_operator?(node)
           node.receiver.source_range.begin_pos - node.source_range.begin_pos > 1
         end
+
+        def unary_tilde?(receiver)
+          receiver.send_type? && receiver.unary_operation? && receiver.method?(:~)
+        end
       end
     end
   end

data/lib/rubocop/cop/layout/space_around_block_parameters.rb

@@ -5,7 +5,9 @@ module RuboCop
     module Layout
       # Checks the spacing inside and after block parameters pipes. Line breaks
       # inside parameter pipes are checked by `Layout/MultilineBlockLayout` and
-      # not by this cop.
+      # not by this cop. Spaces inside a lambda's parameter parentheses are left
+      # to `Layout/SpaceInsideParens` when that cop is enabled, so the examples
+      # below apply to a lambda only when it is not.
       #
       # @example EnforcedStyleInsidePipes: no_space (default)
       #   # bad
@@ -29,12 +31,12 @@ module RuboCop
         include RangeHelp
         extend AutoCorrector
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler -- checks spacing inside a block parameter list
           arguments = node.arguments
 
           return unless node.arguments? && pipes?(arguments)
 
-          check_inside_pipes(arguments)
+          check_inside_pipes(arguments) unless checked_by_space_inside_parens?(arguments)
           check_after_closing_pipe(arguments) if node.body
           check_each_arg(arguments)
         end
@@ -53,6 +55,10 @@ module RuboCop
           'EnforcedStyleInsidePipes'
         end
 
+        def checked_by_space_inside_parens?(arguments)
+          arguments.loc.begin.source == '(' && config.cop_enabled?('Layout/SpaceInsideParens')
+        end
+
         def check_inside_pipes(arguments)
           case style
           when :no_space
@@ -142,7 +148,7 @@ module RuboCop
             if node
               corrector.insert_before(node, ' ')
             else
-              corrector.insert_after(target, ' ')
+              corrector.insert_after(range_between(space_begin_pos, space_begin_pos), ' ')
             end
           end
         end

data/lib/rubocop/cop/layout/space_around_keyword.rb

@@ -209,6 +209,7 @@ module RuboCop
           end
 
           return unless space_after_missing?(range)
+          return if block_brace_with_no_space_style?(node, range)
 
           add_offense(range, message: format(MSG_AFTER, range: range.source)) do |corrector|
             corrector.insert_after(range, ' ')
@@ -233,6 +234,15 @@ module RuboCop
           !/[\s;,#\\)}\].]/.match?(char)
         end
 
+        def block_brace_with_no_space_style?(node, range)
+          return false unless (parent = node.parent)
+          return false unless parent.any_block_type? && parent.loc.begin&.begin_pos == range.end_pos
+
+          space_before_block_braces_config = config.for_cop('Layout/SpaceBeforeBlockBraces')
+          space_before_block_braces_config.fetch('Enabled', true) &&
+            space_before_block_braces_config['EnforcedStyle'] == 'no_space'
+        end
+
         def accepted_opening_delimiter?(range, char)
           return true unless char
 

data/lib/rubocop/cop/layout/space_around_operators.rb

@@ -258,7 +258,7 @@ module RuboCop
           return false unless allow_for_alignment?
           return false unless with_space.source.start_with?(EXCESSIVE_SPACE)
 
-          return !aligned_with_operator?(operator) unless type == :assignment
+          return !aligned_with_operator?(operator) unless grouped_alignment_type?(type)
 
           token            = Token.new(operator, nil, operator.source)
           align_preceding  = aligned_with_preceding_equals_operator(token)
@@ -269,6 +269,10 @@ module RuboCop
           aligned_with_subsequent_equals_operator(token) != :yes
         end
 
+        def grouped_alignment_type?(type)
+          type == :assignment || (type == :special_asgn && force_equal_sign_alignment?)
+        end
+
         def excess_trailing_space?(right_operand, with_space)
           with_space.source.end_with?(EXCESSIVE_SPACE) &&
             (!allow_for_alignment? || !aligned_with_something?(right_operand))

data/lib/rubocop/cop/layout/space_before_block_braces.rb

@@ -49,8 +49,11 @@ module RuboCop
         MISSING_MSG = 'Space missing to the left of {.'
         DETECTED_MSG = 'Space detected to the left of {.'
 
+        # `Style/BlockDelimiters` decides whether to put a space before the `do`
+        # it writes by looking at the source before this cop removed the space,
+        # so the two corrections cannot be applied in the same pass.
         def self.autocorrect_incompatible_with
-          [Style::SymbolProc]
+          [Style::BlockDelimiters, Style::SymbolProc]
         end
 
         def on_block(node)

data/lib/rubocop/cop/layout/space_inside_array_literal_brackets.rb

@@ -117,7 +117,7 @@ module RuboCop
           elsif style == :space
             SpaceCorrector.add_space(processed_source, corrector, left, right)
           else
-            compact_corrections(corrector, tokens, left, right)
+            compact_corrections(corrector, node, tokens, left, right)
           end
         end
 
@@ -178,6 +178,8 @@ module RuboCop
             space_offenses(node, left, nil, MSG, start_ok: start_ok, end_ok: true)
           end
 
+          return if closing_bracket_kept_apart?(node, tokens, left, right)
+
           if qualifies_for_compact?(tokens, right)
             compact_offense(node, right)
           elsif !multi_dimensional_array?(tokens, right)
@@ -212,13 +214,24 @@ module RuboCop
           end
         end
 
-        def compact_corrections(corrector, tokens, left, right)
+        # A closing bracket on its own line is only collapsed when the opening
+        # bracket ends up on the first element's line, so that the brackets
+        # stay symmetrical (see `Layout/MultilineArrayBraceLayout`).
+        def closing_bracket_kept_apart?(node, tokens, left, right)
+          end_has_own_line?(right) &&
+            !multi_dimensional_array?(tokens, left, side: :left) &&
+            !same_line?(left, node.children.first)
+        end
+
+        def compact_corrections(corrector, node, tokens, left, right)
           if multi_dimensional_array?(tokens, left, side: :left)
             compact(corrector, left, :right)
           elsif !left.space_after?
             corrector.insert_after(left.pos, ' ')
           end
 
+          return if closing_bracket_kept_apart?(node, tokens, left, right)
+
           if multi_dimensional_array?(tokens, right)
             compact(corrector, right, :left)
           elsif !right.space_before?