rubocop 1.17.0 → 1.18.4

data/lib/rubocop/cop/corrector.rb

@@ -32,7 +32,7 @@ module RuboCop
 
       # Removes `size` characters prior to the source range.
       #
-      # @param [Parser::Source::Range, Rubocop::AST::Node] range or node
+      # @param [Parser::Source::Range, RuboCop::AST::Node] range or node
       # @param [Integer] size
       def remove_preceding(node_or_range, size)
         range = to_range(node_or_range)
@@ -44,7 +44,7 @@ module RuboCop
       # If `size` is greater than the size of `range`, the removed region can
       # overrun the end of `range`.
       #
-      # @param [Parser::Source::Range, Rubocop::AST::Node] range or node
+      # @param [Parser::Source::Range, RuboCop::AST::Node] range or node
       # @param [Integer] size
       def remove_leading(node_or_range, size)
         range = to_range(node_or_range)
@@ -56,7 +56,7 @@ module RuboCop
       # If `size` is greater than the size of `range`, the removed region can
       # overrun the beginning of `range`.
       #
-      # @param [Parser::Source::Range, Rubocop::AST::Node] range or node
+      # @param [Parser::Source::Range, RuboCop::AST::Node] range or node
       # @param [Integer] size
       def remove_trailing(node_or_range, size)
         range = to_range(node_or_range)
@@ -90,7 +90,7 @@ module RuboCop
                 else
                   raise TypeError,
                         'Expected a Parser::Source::Range, Comment or ' \
-                        "Rubocop::AST::Node, got #{node_or_range.class}"
+                        "RuboCop::AST::Node, got #{node_or_range.class}"
                 end
         validate_buffer(range.source_buffer)
         range

data/lib/rubocop/cop/generator.rb

@@ -104,7 +104,7 @@ module RuboCop
 
       CONFIGURATION_ADDED_MESSAGE =
         '[modify] A configuration for the cop is added into ' \
-          '%<configuration_file_path>s.'
+        '%<configuration_file_path>s.'
 
       def initialize(name, github_user, output: $stdout)
         @badge = Badge.parse(name)

data/lib/rubocop/cop/internal_affairs/node_matcher_directive.rb

@@ -25,7 +25,7 @@ module RuboCop
 
         MSG = 'Preceed `%<method>s` with a `@!method` YARD directive.'
         MSG_WRONG_NAME = '`@!method` YARD directive has invalid method name, ' \
-          'use `%<expected>s` instead of `%<actual>s`.'
+                         'use `%<expected>s` instead of `%<actual>s`.'
         MSG_TOO_MANY = 'Multiple `@!method` YARD directives found for this matcher.'
 
         RESTRICT_ON_SEND = %i[def_node_matcher def_node_search].to_set.freeze

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

@@ -50,7 +50,7 @@ module RuboCop
         ALIGN_PARAMS_MSG = 'Align the arguments of a method call if they span more than one line.'
 
         FIXED_INDENT_MSG = 'Use one level of indentation for arguments ' \
-          'following the first line of a multi-line method call.'
+                           'following the first line of a multi-line method call.'
 
         def on_send(node)
           first_arg = node.first_argument

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

@@ -38,10 +38,10 @@ module RuboCop
         extend AutoCorrector
 
         ALIGN_ELEMENTS_MSG = 'Align the elements of an array literal ' \
-          'if they span more than one line.'
+                             'if they span more than one line.'
 
         FIXED_INDENT_MSG = 'Use one level of indentation for elements ' \
-          'following the first line of a multi-line array.'
+                           'following the first line of a multi-line array.'
 
         def on_array(node)
           return if node.children.size < 2

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

@@ -210,7 +210,7 @@ module RuboCop
 
         def format_source_line_column(source_line_column)
           "`#{source_line_column[:source]}` at #{source_line_column[:line]}, " \
-          "#{source_line_column[:column]}"
+            "#{source_line_column[:column]}"
         end
 
         def compute_start_col(ancestor_node, node)

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

@@ -289,12 +289,16 @@ module RuboCop
           (node.first_line - 1).downto(1) do |annotation_line|
             break unless (comment = processed_source.comment_at_line(annotation_line))
 
-            first_comment = comment
+            first_comment = comment if whole_line_comment_at_line?(annotation_line)
           end
 
           start_line_position(first_comment || node)
         end
 
+        def whole_line_comment_at_line?(line)
+          /\A\s*#/.match?(processed_source.lines[line - 1])
+        end
+
         def start_line_position(node)
           buffer.line_range(node.loc.line).begin_pos - 1
         end

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

@@ -155,7 +155,13 @@ module RuboCop
         end
 
         def all_elements_aligned?(elements)
-          elements.map { |e| e.loc.column }.uniq.count == 1
+          elements.flat_map do |e|
+            if e.hash_type?
+              e.each_pair.map { |pair| pair.loc.column }
+            else
+              e.loc.column
+            end
+          end.uniq.count == 1
         end
 
         def first_argument_line(elements)

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

@@ -37,7 +37,7 @@ module RuboCop
         extend AutoCorrector
 
         MSG = 'Incorrect indentation detected (column %<column>d ' \
-          'instead of %<correct_comment_indentation>d).'
+              'instead of %<correct_comment_indentation>d).'
 
         def on_new_investigation
           processed_source.comments.each { |comment| check(comment) }

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

@@ -167,7 +167,8 @@ module RuboCop
         def alignment_node_for_variable_style(node)
           return node.parent if node.case_type? && node.argument?
 
-          assignment = node.ancestors.find(&:assignment_or_similar?)
+          assignment = assignment_or_operator_method(node)
+
           if assignment && !line_break_before_keyword?(assignment.source_range, node)
             assignment
           else
@@ -177,6 +178,12 @@ module RuboCop
             node
           end
         end
+
+        def assignment_or_operator_method(node)
+          node.ancestors.find do |ancestor|
+            ancestor.assignment_or_similar? || ancestor.send_type? && ancestor.operator_method?
+          end
+        end
       end
     end
   end

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

@@ -154,7 +154,7 @@ module RuboCop
 
         def on_send(node)
           return if style != :consistent && enforce_first_argument_with_fixed_indentation?
-          return if !node.arguments? || bare_operator?(node)
+          return if !node.arguments? || bare_operator?(node) || node.setter_method?
 
           indent = base_indentation(node) + configured_indentation_width
 

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

@@ -161,10 +161,10 @@ module RuboCop
             'Indent the right bracket the same as the left bracket.'
           elsif style == :special_inside_parentheses && left_parenthesis
             'Indent the right bracket the same as the first position ' \
-            'after the preceding left parenthesis.'
+              'after the preceding left parenthesis.'
           else
             'Indent the right bracket the same as the start of the line' \
-            ' where the left bracket is.'
+              ' where the left bracket is.'
           end
         end
       end

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

@@ -178,10 +178,10 @@ module RuboCop
             'Indent the right brace the same as the left brace.'
           elsif style == :special_inside_parentheses && left_parenthesis
             'Indent the right brace the same as the first position ' \
-            'after the preceding left parenthesis.'
+              'after the preceding left parenthesis.'
           else
             'Indent the right brace the same as the start of the line ' \
-            'where the left brace is.'
+              'where the left brace is.'
           end
         end
 

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

@@ -48,7 +48,7 @@ module RuboCop
         extend AutoCorrector
 
         MSG = 'Use %<configured_indentation_width>d spaces for indentation ' \
-             'in method args, relative to %<base_description>s.'
+              'in method args, relative to %<base_description>s.'
 
         def on_def(node)
           return if node.arguments.empty?

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

@@ -180,14 +180,15 @@ module RuboCop
         include RangeHelp
         extend AutoCorrector
 
-        MESSAGES = { KeyAlignment => 'Align the keys of a hash literal if ' \
-                      'they span more than one line.',
-                     SeparatorAlignment => 'Align the separators of a hash ' \
-                       'literal if they span more than one line.',
-                     TableAlignment => 'Align the keys and values of a hash ' \
-                       'literal if they span more than one line.',
-                     KeywordSplatAlignment => 'Align keyword splats with the ' \
-                       'rest of the hash if it spans more than one line.' }.freeze
+        MESSAGES = {
+          KeyAlignment => 'Align the keys of a hash literal if they span more than one line.',
+          SeparatorAlignment => 'Align the separators of a hash literal if they span more than ' \
+                                'one line.',
+          TableAlignment => 'Align the keys and values of a hash literal if they span more than ' \
+                            'one line.',
+          KeywordSplatAlignment => 'Align keyword splats with the rest of the hash if it spans ' \
+                                   'more than one line.'
+        }.freeze
 
         def on_send(node)
           return if double_splat?(node)
@@ -212,18 +213,18 @@ module RuboCop
           check_pairs(node)
         end
 
-        attr_accessor :offences_by, :column_deltas
+        attr_accessor :offenses_by, :column_deltas
 
         private
 
         def autocorrect_incompatible_with_other_cops?(node)
           enforce_first_argument_with_fixed_indentation? &&
             node.pairs.any? &&
-            node.parent&.call_type? && node.parent.loc.line == node.pairs.first.loc.line
+            node.parent&.call_type? && node.parent.loc.selector&.line == node.pairs.first.loc.line
         end
 
         def reset!
-          self.offences_by = {}
+          self.offenses_by = {}
           self.column_deltas = Hash.new { |hash, key| hash[key] = {} }
         end
 
@@ -247,33 +248,33 @@ module RuboCop
             end
           end
 
-          add_offences
+          add_offenses
         end
 
-        def add_offences
-          kwsplat_offences = offences_by.delete(KeywordSplatAlignment)
-          register_offences_with_format(kwsplat_offences, KeywordSplatAlignment)
+        def add_offenses
+          kwsplat_offenses = offenses_by.delete(KeywordSplatAlignment)
+          register_offenses_with_format(kwsplat_offenses, KeywordSplatAlignment)
 
-          format, offences = offences_by.min_by { |_, v| v.length }
-          register_offences_with_format(offences, format)
+          format, offenses = offenses_by.min_by { |_, v| v.length }
+          register_offenses_with_format(offenses, format)
         end
 
-        def register_offences_with_format(offences, format)
-          (offences || []).each do |offence|
-            add_offense(offence, message: MESSAGES[format]) do |corrector|
-              delta = column_deltas[alignment_for(offence).first.class][offence]
+        def register_offenses_with_format(offenses, format)
+          (offenses || []).each do |offense|
+            add_offense(offense, message: MESSAGES[format]) do |corrector|
+              delta = column_deltas[alignment_for(offense).first.class][offense]
 
-              correct_node(corrector, offence, delta) unless delta.nil?
+              correct_node(corrector, offense, delta) unless delta.nil?
             end
           end
         end
 
         def check_delta(delta, node:, alignment:)
-          offences_by[alignment.class] ||= []
+          offenses_by[alignment.class] ||= []
           return if good_alignment? delta
 
           column_deltas[alignment.class][node] = delta
-          offences_by[alignment.class].push(node)
+          offenses_by[alignment.class].push(node)
         end
 
         def ignore_hash_argument?(node)

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

@@ -55,7 +55,7 @@ module RuboCop
         extend AutoCorrector
 
         MSG = 'Put the closing parenthesis for a method call with a ' \
-        'HEREDOC parameter on the same line as the HEREDOC opening.'
+              'HEREDOC parameter on the same line as the HEREDOC opening.'
 
         def self.autocorrect_incompatible_with
           [Style::TrailingCommaInArguments]

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

@@ -43,7 +43,7 @@ module RuboCop
           str_ranges = string_literal_ranges(processed_source.ast)
 
           processed_source.lines.each.with_index(1) do |line, lineno|
-            next unless (range = find_offence(line, lineno))
+            next unless (range = find_offense(line, lineno))
             next if in_string_literal?(str_ranges, range)
 
             add_offense(range) { |corrector| autocorrect(corrector, range) }
@@ -60,7 +60,7 @@ module RuboCop
           end
         end
 
-        def find_offence(line, lineno)
+        def find_offense(line, lineno)
           match = if style == :spaces
                     line.match(/\A\s*\t+/)
                   else

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

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # This cop checks the indentation of the next line after a line that ends with a string
+      # literal and a backslash.
+      #
+      # If `EnforcedStyle: aligned` is set, the concatenated string parts shall be aligned with the
+      # first part. There are some exceptions, such as implicit return values, where the
+      # concatenated string parts shall be indented regardless of `EnforcedStyle` configuration.
+      #
+      # If `EnforcedStyle: indented` is set, it's the second line that shall be indented one step
+      # more than the first line. Lines 3 and forward shall be aligned with line 2. Here too there
+      # are exceptions. Values in a hash literal are always aligned.
+      #
+      # @example
+      #   # bad
+      #   def some_method
+      #     'x' \
+      #     'y' \
+      #     'z'
+      #   end
+      #
+      #   my_hash = {
+      #     first: 'a message' \
+      #       'in two parts'
+      #   }
+      #
+      #   # good
+      #   def some_method
+      #     'x' \
+      #       'y' \
+      #       'z'
+      #   end
+      #
+      #   my_hash = {
+      #     first: 'a message' \
+      #            'in two parts'
+      #   }
+      #
+      # @example EnforcedStyle: aligned (default)
+      #   # bad
+      #   puts 'x' \
+      #     'y'
+      #
+      #   # good
+      #   puts 'x' \
+      #        'y'
+      #
+      # @example EnforcedStyle: indented
+      #   # bad
+      #   result = 'x' \
+      #            'y'
+      #
+      #   # good
+      #   result = 'x' \
+      #     'y'
+      #
+      class LineEndStringConcatenationIndentation < Base
+        include ConfigurableEnforcedStyle
+        include Alignment
+        extend AutoCorrector
+
+        MSG_ALIGN = 'Align parts of a string concatenated with backslash.'
+        MSG_INDENT = 'Indent the first part of a string concatenated with backslash.'
+        PARENT_TYPES_FOR_INDENTED = [nil, :block, :begin, :def, :defs, :if].freeze
+
+        def on_dstr(node)
+          return unless strings_concatenated_with_backslash?(node)
+
+          children = node.children
+          if style == :aligned && !always_indented?(node) || always_aligned?(node)
+            check_aligned(children, 1)
+          else
+            check_indented(children)
+            check_aligned(children, 2)
+          end
+        end
+
+        def autocorrect(corrector, node)
+          AlignmentCorrector.correct(corrector, processed_source, node, @column_delta)
+        end
+
+        private
+
+        def strings_concatenated_with_backslash?(dstr_node)
+          dstr_node.multiline? &&
+            dstr_node.children.all? { |c| c.str_type? || c.dstr_type? } &&
+            dstr_node.children.none?(&:multiline?)
+        end
+
+        def always_indented?(dstr_node)
+          PARENT_TYPES_FOR_INDENTED.include?(dstr_node.parent&.type)
+        end
+
+        def always_aligned?(dstr_node)
+          dstr_node.parent&.pair_type?
+        end
+
+        def check_aligned(children, start_index)
+          base_column = children[start_index - 1].loc.column
+          children[start_index..-1].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
+          end
+        end
+
+        def check_indented(children)
+          base_column = children[0].source_range.source_line =~ /\S/
+          @column_delta = base_column + configured_indentation_width - children[1].loc.column
+          add_offense_and_correction(children[1], MSG_INDENT) if @column_delta != 0
+        end
+
+        def add_offense_and_correction(node, message)
+          add_offense(node, message: message) { |corrector| autocorrect(corrector, node) }
+        end
+      end
+    end
+  end
+end