rubocop 1.42.0 → 1.64.1

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

@@ -8,7 +8,7 @@ module RuboCop
       #
       # Note: When ``Layout/LineLength``'s `AllowHeredoc` is false (not default),
       #       this cop does not add any offenses for long here documents to
-      #       avoid `Layout/LineLength`'s offenses.
+      #       avoid ``Layout/LineLength``'s offenses.
       #
       # @example
       #   # bad
@@ -22,8 +22,12 @@ module RuboCop
       #   RUBY
       #
       class HeredocIndentation < Base
+        include Alignment
         include Heredoc
         extend AutoCorrector
+        extend TargetRubyVersion
+
+        minimum_target_ruby_version 2.3
 
         TYPE_MSG = 'Use %<indentation_width>d spaces for indentation in a ' \
                    'heredoc by using `<<~` instead of `%<current_indent_type>s`.'
@@ -37,7 +41,7 @@ module RuboCop
           heredoc_indent_type = heredoc_indent_type(node)
 
           if heredoc_indent_type == '~'
-            expected_indent_level = base_indent_level(node) + indentation_width
+            expected_indent_level = base_indent_level(node) + configured_indentation_width
             return if expected_indent_level == body_indent_level
           else
             return unless body_indent_level.zero?
@@ -66,9 +70,9 @@ module RuboCop
           current_indent_type = "<<#{heredoc_indent_type}"
 
           if current_indent_type == '<<~'
-            width_message(indentation_width)
+            width_message(configured_indentation_width)
           else
-            type_message(indentation_width, current_indent_type)
+            type_message(configured_indentation_width, current_indent_type)
           end
         end
 
@@ -89,7 +93,7 @@ module RuboCop
 
           body = heredoc_body(node)
 
-          expected_indent = base_indent_level(node) + indentation_width
+          expected_indent = base_indent_level(node) + configured_indentation_width
           actual_indent = indent_level(body)
           increase_indent_level = expected_indent - actual_indent
 
@@ -114,7 +118,7 @@ module RuboCop
         end
 
         def adjust_minus(corrector, node)
-          heredoc_beginning = node.loc.expression.source
+          heredoc_beginning = node.source
           corrected = heredoc_beginning.sub(/<<-?/, '<<~')
           corrector.replace(node, corrected)
         end
@@ -122,7 +126,7 @@ module RuboCop
         def indented_body(node)
           body = heredoc_body(node)
           body_indent_level = indent_level(body)
-          correct_indent_level = base_indent_level(node) + indentation_width
+          correct_indent_level = base_indent_level(node) + configured_indentation_width
           body.gsub(/^[^\S\r\n]{#{body_indent_level}}/, ' ' * correct_indent_level)
         end
 
@@ -138,7 +142,7 @@ module RuboCop
         end
 
         def base_indent_level(node)
-          base_line_num = node.loc.expression.line
+          base_line_num = node.source_range.line
           base_line = processed_source.lines[base_line_num - 1]
           indent_level(base_line)
         end
@@ -148,10 +152,6 @@ module RuboCop
           node.source[/^<<([~-])/, 1]
         end
 
-        def indentation_width
-          @config.for_cop('Layout/IndentationWidth')['Width'] || 2
-        end
-
         def heredoc_body(node)
           node.loc.heredoc_body.source
         end

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

@@ -76,7 +76,7 @@ module RuboCop
 
         def autocorrect_lambda_for_tabs(corrector, range)
           spaces = ' ' * configured_indentation_width
-          corrector.replace(range, range.source.gsub(/\t/, spaces))
+          corrector.replace(range, range.source.gsub("\t", spaces))
         end
 
         def autocorrect_lambda_for_spaces(corrector, range)

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

@@ -354,7 +354,7 @@ module RuboCop
           # Don't check indentation if the line doesn't start with the body.
           # For example, lines like "else do_something".
           first_char_pos_on_line = body_node.source_range.source_line =~ /\S/
-          return true unless body_node.loc.column == first_char_pos_on_line
+          body_node.loc.column != first_char_pos_on_line
         end
 
         def offending_range(body_node, indentation)
@@ -366,10 +366,10 @@ module RuboCop
         end
 
         def starts_with_access_modifier?(body_node)
-          return unless body_node.begin_type?
+          return false unless body_node.begin_type?
 
           starting_node = body_node.children.first
-          return unless starting_node
+          return false unless starting_node
 
           starting_node.send_type? && starting_node.bare_access_modifier?
         end

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

@@ -34,7 +34,7 @@ module RuboCop
         private
 
         def first_token
-          processed_source.find_token { |t| !t.text.start_with?('#') }
+          processed_source.tokens.find { |t| !t.text.start_with?('#') }
         end
 
         def space_before(token)

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

@@ -57,13 +57,13 @@ module RuboCop
 
         def on_new_investigation
           processed_source.comments.each do |comment|
-            next unless /\A#+[^#\s=+-]/.match?(comment.text)
+            next unless /\A(?!#\+\+|#--)(#+[^#\s=])/.match?(comment.text)
             next if comment.loc.line == 1 && allowed_on_first_line?(comment)
             next if doxygen_comment_style?(comment)
             next if gemfile_ruby_comment?(comment)
 
             add_offense(comment) do |corrector|
-              expr = comment.loc.expression
+              expr = comment.source_range
 
               corrector.insert_after(hash_mark(expr), ' ')
             end

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

@@ -51,26 +51,21 @@ module RuboCop
         private_constant :LINE_1_ENDING, :LINE_2_BEGINNING,
                          :LEADING_STYLE_OFFENSE, :TRAILING_STYLE_OFFENSE
 
-        # rubocop:disable Metrics/AbcSize
         def on_dstr(node)
           # Quick check if we possibly have line continuations.
           return unless node.source.include?('\\')
 
-          end_of_first_line = node.loc.expression.begin_pos - node.loc.expression.column
+          end_of_first_line = node.source_range.begin_pos - node.source_range.column
 
-          raw_lines(node).each_cons(2) do |raw_line_one, raw_line_two|
+          lines = raw_lines(node)
+          lines.each_cons(2).with_index(node.first_line) do |(raw_line_one, raw_line_two), line_num|
             end_of_first_line += raw_line_one.length
 
-            next unless continuation?(raw_line_one)
+            next unless continuation?(raw_line_one, line_num, node)
 
-            if enforced_style_leading?
-              investigate_leading_style(raw_line_one, raw_line_two, end_of_first_line)
-            else
-              investigate_trailing_style(raw_line_one, raw_line_two, end_of_first_line)
-            end
+            investigate(raw_line_one, raw_line_two, end_of_first_line)
           end
         end
-        # rubocop:enable Metrics/AbcSize
 
         private
 
@@ -78,6 +73,14 @@ module RuboCop
           processed_source.raw_source.lines[node.first_line - 1, line_range(node).size]
         end
 
+        def investigate(first_line, second_line, end_of_first_line)
+          if enforced_style_leading?
+            investigate_leading_style(first_line, second_line, end_of_first_line)
+          else
+            investigate_trailing_style(first_line, second_line, end_of_first_line)
+          end
+        end
+
         def investigate_leading_style(first_line, second_line, end_of_first_line)
           matches = first_line.match(LEADING_STYLE_OFFENSE)
           return if matches.nil?
@@ -100,8 +103,11 @@ module RuboCop
           end
         end
 
-        def continuation?(line)
-          line.end_with?("\\\n")
+        def continuation?(line, line_num, node)
+          return false unless line.end_with?("\\\n")
+
+          # Ensure backslash isn't part of a token spanning to the next line.
+          node.children.none? { |c| (c.first_line...c.last_line).cover?(line_num) && c.multiline? }
         end
 
         def autocorrect(corrector, offense_range, insert_pos, spaces)

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

@@ -87,25 +87,29 @@ module RuboCop
           corrector.replace(range, correction)
         end
 
-        def string_literal_ranges(ast)
+        # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+        def ignored_literal_ranges(ast)
           # which lines start inside a string literal?
           return [] if ast.nil?
 
-          ranges = Set.new
-          ast.each_node(:str, :dstr) do |str|
-            loc = str.location
+          ast.each_node(:str, :dstr, :array).with_object(Set.new) do |literal, ranges|
+            loc = literal.location
 
-            if str.heredoc?
+            if literal.array_type?
+              next unless literal.percent_literal?
+
+              ranges << loc.expression
+            elsif literal.heredoc?
               ranges << loc.heredoc_body
             elsif loc.respond_to?(:begin) && loc.begin
               ranges << loc.expression
             end
           end
-          ranges
         end
+        # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
         def comment_ranges(comments)
-          comments.map(&:loc).map(&:expression)
+          comments.map(&:source_range)
         end
 
         def last_line(processed_source)
@@ -119,7 +123,7 @@ module RuboCop
         end
 
         def ignored_ranges
-          @ignored_ranges ||= string_literal_ranges(processed_source.ast) +
+          @ignored_ranges ||= ignored_literal_ranges(processed_source.ast) +
                               comment_ranges(processed_source.comments)
         end
 

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

@@ -84,6 +84,8 @@ module RuboCop
           return unless strings_concatenated_with_backslash?(node)
 
           children = node.children
+          return if children.empty?
+
           if style == :aligned && !always_indented?(node)
             check_aligned(children, 1)
           else

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

@@ -6,7 +6,7 @@ module RuboCop
       # Ensures that each item in a multi-line array
       # starts on a separate line.
       #
-      # @example AllowMultilineFinalElement: false (default)
+      # @example
       #
       #   # bad
       #   [
@@ -14,11 +14,6 @@ module RuboCop
       #     c
       #   ]
       #
-      #   # bad
-      #   [ a, b, foo(
-      #     bar
-      #   )]
-      #
       #   # good
       #   [
       #     a,
@@ -35,34 +30,20 @@ module RuboCop
       #     )
       #   ]
       #
-      # @example AllowMultilineFinalElement: true
+      # @example AllowMultilineFinalElement: false (default)
       #
       #   # bad
-      #   [
-      #     a, b,
-      #     c
-      #   ]
-      #
-      #   # good
-      #   [ a, b, foo(
+      #   [a, b, foo(
       #     bar
       #   )]
       #
-      #   # good
-      #   [
-      #     a,
-      #     b,
-      #     c
-      #   ]
+      # @example AllowMultilineFinalElement: true
       #
       #   # good
-      #   [
-      #     a,
-      #     b,
-      #     foo(
-      #       bar
-      #     )
-      #   ]
+      #   [a, b, foo(
+      #     bar
+      #   )]
+      #
       class MultilineArrayLineBreaks < Base
         include MultilineElementLineBreaks
         extend AutoCorrector

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

@@ -6,7 +6,7 @@ module RuboCop
       # Ensures that each key in a multi-line hash
       # starts on a separate line.
       #
-      # @example AllowMultilineFinalElement: false (default)
+      # @example
       #
       #   # bad
       #   {
@@ -14,11 +14,6 @@ module RuboCop
       #     c: 3
       #   }
       #
-      #   # bad
-      #   { a: 1, b: {
-      #     c: 3,
-      #   }}
-      #
       #   # good
       #   {
       #     a: 1,
@@ -34,34 +29,20 @@ module RuboCop
       #     }
       #   }
       #
-      # @example AllowMultilineFinalElement: true
+      # @example AllowMultilineFinalElement: false (default)
       #
       #   # bad
-      #   {
-      #     a: 1, b: 2,
-      #     c: 3
-      #   }
-      #
-      #   # good
       #   { a: 1, b: {
       #     c: 3,
       #   }}
       #
-      #   # good
-      #   {
-      #     a: 1,
-      #     b: 2,
-      #     c: 3
-      #   }
-      #
+      # @example AllowMultilineFinalElement: true
       #
       #   # good
-      #   {
-      #     a: 1,
-      #     b: {
-      #       c: 3,
-      #     }
-      #   }
+      #   { a: 1, b: {
+      #     c: 3,
+      #   }}
+      #
       class MultilineHashKeyLineBreaks < Base
         include MultilineElementLineBreaks
         extend AutoCorrector

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

@@ -9,7 +9,7 @@ module RuboCop
       # NOTE: This cop does not move the first argument, if you want that to
       # be on a separate line, see `Layout/FirstMethodArgumentLineBreak`.
       #
-      # @example AllowMultilineFinalElement: false (default)
+      # @example
       #
       #   # bad
       #   foo(a, b,
@@ -31,6 +31,8 @@ module RuboCop
       #   # good
       #   foo(a, b, c)
       #
+      # @example AllowMultilineFinalElement: false (default)
+      #
       #   # good
       #   foo(
       #     a,
@@ -42,26 +44,6 @@ module RuboCop
       #
       # @example AllowMultilineFinalElement: true
       #
-      #   # bad
-      #   foo(a, b,
-      #     c
-      #   )
-      #
-      #   # good
-      #   foo(a, b, {
-      #     foo: "bar",
-      #   })
-      #
-      #   # good
-      #   foo(
-      #     a,
-      #     b,
-      #     c
-      #   )
-      #
-      #   # good
-      #   foo(a, b, c)
-      #
       #   # good
       #   foo(
       #     a,
@@ -70,6 +52,7 @@ module RuboCop
       #       foo: "bar",
       #     }
       #   )
+      #
       class MultilineMethodArgumentLineBreaks < Base
         include MultilineElementLineBreaks
         extend AutoCorrector

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

@@ -75,7 +75,7 @@ module RuboCop
         def right_hand_side(send_node)
           dot = send_node.loc.dot
           selector = send_node.loc.selector
-          if send_node.dot? && selector && same_line?(dot, selector)
+          if (send_node.dot? || send_node.safe_navigation?) && selector && same_line?(dot, selector)
             dot.join(selector)
           elsif selector
             selector
@@ -179,10 +179,10 @@ module RuboCop
         # a.b
         #  .c
         def semantic_alignment_base(node, rhs)
-          return unless rhs.source.start_with?('.')
+          return unless rhs.source.start_with?('.', '&.')
 
           node = semantic_alignment_node(node)
-          return unless node&.loc&.selector
+          return unless node&.loc&.selector && node.loc.dot
 
           node.loc.dot.join(node.loc.selector)
         end
@@ -204,6 +204,10 @@ module RuboCop
           dot_right_above = get_dot_right_above(node)
           return dot_right_above if dot_right_above
 
+          if (multiline_block_chain_node = find_multiline_block_chain_node(node))
+            return multiline_block_chain_node
+          end
+
           node = first_call_has_a_dot(node)
           return if node.loc.dot.line != node.first_line
 
@@ -219,6 +223,17 @@ module RuboCop
           end
         end
 
+        def find_multiline_block_chain_node(node)
+          return unless (block_node = node.each_descendant(:block, :numblock).first)
+          return unless block_node.multiline? && block_node.parent.call_type?
+
+          if node.receiver.call_type?
+            node.receiver
+          else
+            block_node.parent
+          end
+        end
+
         def first_call_has_a_dot(node)
           # descend to root of method chain
           node = node.receiver while node.receiver

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

@@ -9,7 +9,7 @@ module RuboCop
       # NOTE: This cop does not move the first argument, if you want that to
       # be on a separate line, see `Layout/FirstMethodParameterLineBreak`.
       #
-      # @example AllowMultilineFinalElement: false (default)
+      # @example
       #
       #   # bad
       #   def foo(a, b,
@@ -17,12 +17,6 @@ module RuboCop
       #   )
       #   end
       #
-      #   # bad
-      #   def foo(a, b = {
-      #     foo: "bar",
-      #   })
-      #   end
-      #
       #   # good
       #   def foo(
       #     a,
@@ -44,40 +38,22 @@ module RuboCop
       #   def foo(a, b, c)
       #   end
       #
-      # @example AllowMultilineFinalElement: true
+      # @example AllowMultilineFinalElement: false (default)
       #
       #   # bad
-      #   def foo(a, b,
-      #     c
-      #   )
-      #   end
-      #
-      #   # good
       #   def foo(a, b = {
       #     foo: "bar",
       #   })
       #   end
       #
-      #   # good
-      #   def foo(
-      #     a,
-      #     b,
-      #     c
-      #   )
-      #   end
+      # @example AllowMultilineFinalElement: true
       #
       #   # good
-      #   def foo(
-      #     a,
-      #     b = {
-      #       foo: "bar",
-      #     }
-      #   )
+      #   def foo(a, b = {
+      #     foo: "bar",
+      #   })
       #   end
       #
-      #   # good
-      #   def foo(a, b, c)
-      #   end
       class MultilineMethodParameterLineBreaks < Base
         include MultilineElementLineBreaks
         extend AutoCorrector

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

@@ -48,19 +48,28 @@ module RuboCop
 
         MSG = 'Redundant line break detected.'
 
+        def on_lvasgn(node)
+          super unless end_with_percent_blank_string?(processed_source)
+        end
+
         def on_send(node)
           # Include "the whole expression".
-          node = node.parent while convertible_block?(node) ||
-                                   node.parent.is_a?(RuboCop::AST::BinaryOperatorNode) ||
-                                   node.parent&.send_type?
+          node = node.parent while node.parent&.send_type? ||
+                                   convertible_block?(node) ||
+                                   node.parent.is_a?(RuboCop::AST::BinaryOperatorNode)
 
           return unless offense?(node) && !part_of_ignored_node?(node)
 
           register_offense(node)
         end
+        alias on_csend on_send
 
         private
 
+        def end_with_percent_blank_string?(processed_source)
+          processed_source.buffer.source.end_with?("%\n\n")
+        end
+
         def check_assignment(node, _rhs)
           return unless offense?(node)
 
@@ -69,15 +78,26 @@ module RuboCop
 
         def register_offense(node)
           add_offense(node) do |corrector|
-            corrector.replace(node.source_range, to_single_line(node.source).strip)
+            corrector.replace(node, to_single_line(node.source).strip)
           end
           ignore_node(node)
         end
 
         def offense?(node)
-          return false if configured_to_not_be_inspected?(node)
+          return false if !node.multiline? || too_long?(node) || !suitable_as_single_line?(node)
+          return require_backslash?(node) if node.and_type? || node.or_type?
+
+          !index_access_call_chained?(node) && !configured_to_not_be_inspected?(node)
+        end
 
-          node.multiline? && !too_long?(node) && suitable_as_single_line?(node)
+        def require_backslash?(node)
+          processed_source.lines[node.loc.operator.line - 1].end_with?('\\')
+        end
+
+        def index_access_call_chained?(node)
+          return false unless node.send_type? && node.method?(:[])
+
+          node.children.first.send_type? && node.children.first.method?(:[])
         end
 
         def configured_to_not_be_inspected?(node)
@@ -99,9 +119,9 @@ module RuboCop
 
         def suitable_as_single_line?(node)
           !comment_within?(node) &&
-            node.each_descendant(:if, :case, :kwbegin, :def).none? &&
-            node.each_descendant(:dstr, :str).none?(&:heredoc?) &&
-            node.each_descendant(:begin).none? { |b| !b.single_line? }
+            node.each_descendant(:if, :case, :kwbegin, :def, :defs).none? &&
+            node.each_descendant(:dstr, :str).none? { |n| n.heredoc? || n.value.include?("\n") } &&
+            node.each_descendant(:begin, :sym).none? { |b| !b.single_line? }
         end
 
         def convertible_block?(node)
@@ -111,7 +131,9 @@ module RuboCop
         end
 
         def comment_within?(node)
-          processed_source.comments.map(&:loc).map(&:line).any? do |comment_line_number|
+          comment_line_numbers = processed_source.comments.map { |comment| comment.loc.line }
+
+          comment_line_numbers.any? do |comment_line_number|
             comment_line_number >= node.first_line && comment_line_number <= node.last_line
           end
         end
@@ -126,7 +148,7 @@ module RuboCop
             .gsub(/" *\\\n\s*'/, %q(" + ')) # Double quote, backslash, and then single quote
             .gsub(/' *\\\n\s*"/, %q(' + ")) # Single quote, backslash, and then double quote
             .gsub(/(["']) *\\\n\s*\1/, '')  # Double or single quote, backslash, then same quote
-            .gsub(/\n\s*(?=\.\w)/, '')      # Extra space within method chaining
+            .gsub(/\n\s*(?=(&)?\.\w)/, '')  # Extra space within method chaining which includes `&.`
             .gsub(/\s*\\?\n\s*/, ' ')       # Any other line break, with or without backslash
         end