rubocop 0.80.0 → 1.42.0

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

@@ -2,14 +2,16 @@
 
 module RuboCop
   module Cop
-    # rubocop:disable Layout/LineLength
     module Layout
-      # This cop checks the indentation of the first argument in a method call.
-      # Arguments after the first one are checked by Layout/ArgumentAlignment,
+      # Checks the indentation of the first argument in a method call.
+      # Arguments after the first one are checked by `Layout/ArgumentAlignment`,
       # not by this cop.
       #
-      # For indenting the first parameter of method *definitions*, check out
-      # Layout/FirstParameterIndentation.
+      # For indenting the first parameter of method _definitions_, check out
+      # `Layout/FirstParameterIndentation`.
+      #
+      # This cop will respect `Layout/ArgumentAlignment` and will not work when
+      # `EnforcedStyle: with_fixed_indentation` is specified for `Layout/ArgumentAlignment`.
       #
       # @example
       #
@@ -35,9 +37,10 @@ module RuboCop
       #   nested_first_param),
       #   second_param
       #
-      # @example EnforcedStyle: consistent
-      #   # The first argument should always be indented one step more than the
-      #   # preceding line.
+      # @example EnforcedStyle: special_for_inner_method_call_in_parentheses (default)
+      #   # Same as `special_for_inner_method_call` except that the special rule
+      #   # only applies if the outer method call encloses its arguments in
+      #   # parentheses.
       #
       #   # good
       #   some_method(
@@ -49,7 +52,7 @@ module RuboCop
       #   second_param)
       #
       #   foo = some_method(nested_call(
-      #     nested_first_param),
+      #                       nested_first_param),
       #   second_param)
       #
       #   foo = some_method(
@@ -61,9 +64,9 @@ module RuboCop
       #     nested_first_param),
       #   second_param
       #
-      # @example EnforcedStyle: consistent_relative_to_receiver
-      #   # The first argument should always be indented one level relative to
-      #   # the parent that is receiving the argument
+      # @example EnforcedStyle: consistent
+      #   # The first argument should always be indented one step more than the
+      #   # preceding line.
       #
       #   # good
       #   some_method(
@@ -71,27 +74,25 @@ module RuboCop
       #   second_param)
       #
       #   foo = some_method(
-      #           first_param,
+      #     first_param,
       #   second_param)
       #
       #   foo = some_method(nested_call(
-      #                       nested_first_param),
+      #     nested_first_param),
       #   second_param)
       #
       #   foo = some_method(
-      #           nested_call(
-      #             nested_first_param),
+      #     nested_call(
+      #       nested_first_param),
       #   second_param)
       #
       #   some_method nested_call(
-      #                 nested_first_param),
-      #   second_params
+      #     nested_first_param),
+      #   second_param
       #
-      # @example EnforcedStyle: special_for_inner_method_call
-      #   # The first argument should normally be indented one step more than
-      #   # the preceding line, but if it's a argument for a method call that
-      #   # is itself a argument in a method call, then the inner argument
-      #   # should be indented relative to the inner method.
+      # @example EnforcedStyle: consistent_relative_to_receiver
+      #   # The first argument should always be indented one level relative to
+      #   # the parent that is receiving the argument
       #
       #   # good
       #   some_method(
@@ -99,7 +100,7 @@ module RuboCop
       #   second_param)
       #
       #   foo = some_method(
-      #     first_param,
+      #           first_param,
       #   second_param)
       #
       #   foo = some_method(nested_call(
@@ -107,18 +108,19 @@ module RuboCop
       #   second_param)
       #
       #   foo = some_method(
-      #     nested_call(
-      #       nested_first_param),
+      #           nested_call(
+      #             nested_first_param),
       #   second_param)
       #
       #   some_method nested_call(
       #                 nested_first_param),
-      #   second_param
+      #   second_params
       #
-      # @example EnforcedStyle: special_for_inner_method_call_in_parentheses (default)
-      #   # Same as `special_for_inner_method_call` except that the special rule
-      #   # only applies if the outer method call encloses its arguments in
-      #   # parentheses.
+      # @example EnforcedStyle: special_for_inner_method_call
+      #   # The first argument should normally be indented one step more than
+      #   # the preceding line, but if it's a argument for a method call that
+      #   # is itself a argument in a method call, then the inner argument
+      #   # should be indented relative to the inner method.
       #
       #   # good
       #   some_method(
@@ -139,38 +141,45 @@ module RuboCop
       #   second_param)
       #
       #   some_method nested_call(
-      #     nested_first_param),
+      #                 nested_first_param),
       #   second_param
       #
-      class FirstArgumentIndentation < Cop
-        # rubocop:enable Layout/LineLength
+      class FirstArgumentIndentation < Base
         include Alignment
         include ConfigurableEnforcedStyle
         include RangeHelp
+        extend AutoCorrector
 
         MSG = 'Indent the first argument one step more than %<base>s.'
 
         def on_send(node)
-          return if !node.arguments? || node.operator_method?
+          return if style != :consistent && enforce_first_argument_with_fixed_indentation? &&
+                    !enable_layout_first_method_argument_line_break?
+          return if !node.arguments? || bare_operator?(node) || node.setter_method?
 
           indent = base_indentation(node) + configured_indentation_width
 
           check_alignment([node.first_argument], indent)
         end
         alias on_csend on_send
+        alias on_super on_send
 
-        def autocorrect(node)
-          AlignmentCorrector.correct(processed_source, node, column_delta)
+        private
+
+        def autocorrect(corrector, node)
+          AlignmentCorrector.correct(corrector, processed_source, node, column_delta)
         end
 
-        private
+        def bare_operator?(node)
+          node.operator_method? && !node.dot?
+        end
 
         def message(arg_node)
           return 'Bad indentation of the first argument.' unless arg_node
 
           send_node = arg_node.parent
           text = base_range(send_node, arg_node).source.strip
-          base = if text !~ /\n/ && special_inner_call_indentation?(send_node)
+          base = if !/\n/.match?(text) && special_inner_call_indentation?(send_node)
                    "`#{text}`"
                  elsif comment_line?(text.lines.reverse_each.first)
                    'the start of the previous line (not counting the comment)'
@@ -204,13 +213,19 @@ module RuboCop
           node.source_range.begin_pos > parent.source_range.begin_pos
         end
 
+        # @!method eligible_method_call?(node)
         def_node_matcher :eligible_method_call?, <<~PATTERN
           (send _ !:[]= ...)
         PATTERN
 
         def base_range(send_node, arg_node)
-          range_between(send_node.source_range.begin_pos,
-                        arg_node.source_range.begin_pos)
+          parent = send_node.parent
+          start_node = if parent && (parent.splat_type? || parent.kwsplat_type?)
+                         send_node.parent
+                       else
+                         send_node
+                       end
+          range_between(start_node.source_range.begin_pos, arg_node.source_range.begin_pos)
         end
 
         # Returns the column of the given range. For single line ranges, this
@@ -243,6 +258,24 @@ module RuboCop
             .select { |c| begins_its_line?(c.loc.expression) }
             .map { |c| c.loc.line }
         end
+
+        def on_new_investigation
+          @comment_lines = nil
+        end
+
+        def enforce_first_argument_with_fixed_indentation?
+          return false unless argument_alignment_config['Enabled']
+
+          argument_alignment_config['EnforcedStyle'] == 'with_fixed_indentation'
+        end
+
+        def enable_layout_first_method_argument_line_break?
+          config.for_cop('Layout/FirstMethodArgumentLineBreak')['Enabled']
+        end
+
+        def argument_alignment_config
+          config.for_cop('Layout/ArgumentAlignment')
+        end
       end
     end
   end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks the indentation of the first element in an array literal
+      # Checks the indentation of the first element in an array literal
       # where the opening bracket and the first element are on separate lines.
       # The other elements' indentations are handled by the ArrayAlignment cop.
       #
@@ -79,10 +79,11 @@ module RuboCop
       #   and_now_for_something = [
       #                             :completely_different
       #                           ]
-      class FirstArrayElementIndentation < Cop
+      class FirstArrayElementIndentation < Base
         include Alignment
         include ConfigurableEnforcedStyle
         include MultilineElementIndentation
+        extend AutoCorrector
 
         MSG = 'Use %<configured_indentation_width>d spaces for indentation ' \
               'in an array, relative to %<base_description>s.'
@@ -98,12 +99,12 @@ module RuboCop
         end
         alias on_csend on_send
 
-        def autocorrect(node)
-          AlignmentCorrector.correct(processed_source, node, @column_delta)
-        end
-
         private
 
+        def autocorrect(corrector, node)
+          AlignmentCorrector.correct(corrector, processed_source, node, @column_delta)
+        end
+
         def brace_alignment_style
           :align_brackets
         end
@@ -114,41 +115,38 @@ module RuboCop
           left_bracket = array_node.loc.begin
           first_elem = array_node.values.first
           if first_elem
-            return if first_elem.source_range.line == left_bracket.line
+            return if same_line?(first_elem, left_bracket)
 
             check_first(first_elem, left_bracket, left_parenthesis, 0)
           end
 
-          check_right_bracket(array_node.loc.end, left_bracket,
-                              left_parenthesis)
+          check_right_bracket(array_node.loc.end, first_elem, left_bracket, left_parenthesis)
         end
 
-        def check_right_bracket(right_bracket, left_bracket, left_parenthesis)
+        def check_right_bracket(right_bracket, first_elem, left_bracket, left_parenthesis)
           # if the right bracket is on the same line as the last value, accept
-          return if right_bracket.source_line[0...right_bracket.column] =~ /\S/
+          return if /\S/.match?(right_bracket.source_line[0...right_bracket.column])
 
-          expected_column = base_column(left_bracket, left_parenthesis)
+          expected_column, indent_base_type = indent_base(left_bracket, first_elem,
+                                                          left_parenthesis)
           @column_delta = expected_column - right_bracket.column
           return if @column_delta.zero?
 
-          msg = if style == :align_brackets
-                  '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.'
-                else
-                  'Indent the right bracket the same as the start of the line' \
-                  ' where the left bracket is.'
-                end
-          add_offense(right_bracket, location: right_bracket, message: msg)
+          msg = message_for_right_bracket(indent_base_type)
+          add_offense(right_bracket, message: msg) do |corrector|
+            autocorrect(corrector, right_bracket)
+          end
         end
 
         # Returns the description of what the correct indentation is based on.
-        def base_description(left_parenthesis)
-          if style == :align_brackets
+        def base_description(indent_base_type)
+          case indent_base_type
+          when :left_brace_or_bracket
             'the position of the opening bracket'
-          elsif left_parenthesis && style == :special_inside_parentheses
+          when :first_column_after_left_parenthesis
             'the first position after the preceding left parenthesis'
+          when :parent_hash_key
+            'the parent hash key'
           else
             'the start of the line where the left square bracket is'
           end
@@ -161,6 +159,21 @@ module RuboCop
             base_description: base_description
           )
         end
+
+        def message_for_right_bracket(indent_base_type)
+          case indent_base_type
+          when :left_brace_or_bracket
+            'Indent the right bracket the same as the left bracket.'
+          when :first_column_after_left_parenthesis
+            'Indent the right bracket the same as the first position ' \
+            'after the preceding left parenthesis.'
+          when :parent_hash_key
+            'Indent the right bracket the same as the parent hash key.' \
+          else
+            'Indent the right bracket the same as the start of the line ' \
+            'where the left bracket is.'
+          end
+        end
       end
     end
   end

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

@@ -3,41 +3,73 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks for a line break before the first element in a
+      # Checks for a line break before the first element in a
       # multi-line array.
       #
-      # @example
+      # @example AllowMultilineFinalElement: false (default)
       #
       #     # bad
       #     [ :a,
       #       :b]
       #
+      #     # bad
+      #     [ :a, {
+      #       :b => :c
+      #     }]
+      #
+      #     # good
+      #     [:a, :b]
+      #
+      #     # good
+      #     [
+      #       :a,
+      #       :b]
+      #
+      #     # good
+      #     [
+      #       :a, {
+      #       :b => :c
+      #     }]
+      #
+      # @example AllowMultilineFinalElement: true
+      #
+      #     # bad
+      #     [ :a,
+      #       :b]
+      #
+      #     # good
+      #     [ :a, {
+      #       :b => :c
+      #     }]
+      #
       #     # good
       #     [
       #       :a,
       #       :b]
       #
-      class FirstArrayElementLineBreak < Cop
+      #     # good
+      #     [:a, :b]
+      class FirstArrayElementLineBreak < Base
         include FirstElementLineBreak
+        extend AutoCorrector
 
-        MSG = 'Add a line break before the first element of a ' \
-              'multi-line array.'
+        MSG = 'Add a line break before the first element of a multi-line array.'
 
         def on_array(node)
           return if !node.loc.begin && !assignment_on_same_line?(node)
 
-          check_children_line_break(node, node.children)
-        end
-
-        def autocorrect(node)
-          EmptyLineCorrector.insert_before(node)
+          check_children_line_break(node, node.children, ignore_last: ignore_last_element?)
         end
 
         private
 
         def assignment_on_same_line?(node)
           source = node.source_range.source_line[0...node.loc.column]
-          source =~ /\s*\=\s*$/
+          /\s*=\s*$/.match?(source)
+        end
+
+        def ignore_last_element?
+          !!cop_config['AllowMultilineFinalElement']
         end
       end
     end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks the indentation of the first key in a hash literal
+      # Checks the indentation of the first key in a hash literal
       # where the opening brace and the first key are on separate lines. The
       # other keys' indentations are handled by the HashAlignment cop.
       #
@@ -32,6 +32,14 @@ module RuboCop
       #   and_in_a_method_call({
       #     no: :difference
       #                        })
+      #   takes_multi_pairs_hash(x: {
+      #     a: 1,
+      #     b: 2
+      #   },
+      #                          y: {
+      #                            c: 1,
+      #                            d: 2
+      #                          })
       #
       #   # good
       #   special_inside_parentheses
@@ -41,6 +49,14 @@ module RuboCop
       #   but_in_a_method_call({
       #                          its_like: :this
       #                        })
+      #   takes_multi_pairs_hash(x: {
+      #                            a: 1,
+      #                            b: 2
+      #                          },
+      #                          y: {
+      #                            c: 1,
+      #                            d: 2
+      #                          })
       #
       # @example EnforcedStyle: consistent
       #   # The `consistent` style enforces that the first key in a hash
@@ -64,6 +80,7 @@ module RuboCop
       #     no: :difference
       #   })
       #
+      #
       # @example EnforcedStyle: align_braces
       #   # The `align_brackets` style enforces that the opening and closing
       #   # braces are indented to the same position.
@@ -72,15 +89,32 @@ module RuboCop
       #   and_now_for_something = {
       #                             completely: :different
       #   }
+      #   takes_multi_pairs_hash(x: {
+      #     a: 1,
+      #     b: 2
+      #   },
+      #                           y: {
+      #                                c: 1,
+      #                                d: 2
+      #                              })
       #
       #   # good
       #   and_now_for_something = {
       #                             completely: :different
       #                           }
-      class FirstHashElementIndentation < Cop
+      #   takes_multi_pairs_hash(x: {
+      #                               a: 1,
+      #                               b: 2
+      #                             },
+      #                          y: {
+      #                               c: 1,
+      #                               d: 2
+      #                             })
+      class FirstHashElementIndentation < Base
         include Alignment
         include ConfigurableEnforcedStyle
         include MultilineElementIndentation
+        extend AutoCorrector
 
         MSG = 'Use %<configured_indentation_width>d spaces for indentation ' \
               'in a hash, relative to %<base_description>s.'
@@ -90,18 +124,20 @@ module RuboCop
         end
 
         def on_send(node)
+          return if enforce_first_argument_with_fixed_indentation?
+
           each_argument_node(node, :hash) do |hash_node, left_parenthesis|
             check(hash_node, left_parenthesis)
           end
         end
         alias on_csend on_send
 
-        def autocorrect(node)
-          AlignmentCorrector.correct(processed_source, node, @column_delta)
-        end
-
         private
 
+        def autocorrect(corrector, node)
+          AlignmentCorrector.correct(corrector, processed_source, node, @column_delta)
+        end
+
         def brace_alignment_style
           :align_braces
         end
@@ -113,37 +149,30 @@ module RuboCop
           first_pair = hash_node.pairs.first
 
           if first_pair
-            return if first_pair.first_line == left_brace.line
+            return if same_line?(first_pair, left_brace)
 
             if separator_style?(first_pair)
-              check_based_on_longest_key(hash_node, left_brace,
-                                         left_parenthesis)
+              check_based_on_longest_key(hash_node, left_brace, left_parenthesis)
             else
               check_first(first_pair, left_brace, left_parenthesis, 0)
             end
           end
 
-          check_right_brace(hash_node.loc.end, left_brace, left_parenthesis)
+          check_right_brace(hash_node.loc.end, first_pair, left_brace, left_parenthesis)
         end
 
-        def check_right_brace(right_brace, left_brace, left_parenthesis)
+        def check_right_brace(right_brace, first_pair, left_brace, left_parenthesis)
           # if the right brace is on the same line as the last value, accept
-          return if right_brace.source_line[0...right_brace.column] =~ /\S/
+          return if /\S/.match?(right_brace.source_line[0...right_brace.column])
 
-          expected_column = base_column(left_brace, left_parenthesis)
+          expected_column, indent_base_type = indent_base(left_brace, first_pair, left_parenthesis)
           @column_delta = expected_column - right_brace.column
           return if @column_delta.zero?
 
-          msg = if style == :align_braces
-                  '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.'
-                else
-                  'Indent the right brace the same as the start of the line ' \
-                  'where the left brace is.'
-                end
-          add_offense(right_brace, location: right_brace, message: msg)
+          message = message_for_right_brace(indent_base_type)
+          add_offense(right_brace, message: message) do |corrector|
+            autocorrect(corrector, right_brace)
+          end
         end
 
         def separator_style?(first_pair)
@@ -153,19 +182,20 @@ module RuboCop
         end
 
         def check_based_on_longest_key(hash_node, left_brace, left_parenthesis)
-          key_lengths = hash_node.keys.map do |key|
-            key.source_range.length
-          end
+          key_lengths = hash_node.keys.map { |key| key.source_range.length }
           check_first(hash_node.pairs.first, left_brace, left_parenthesis,
                       key_lengths.max - key_lengths.first)
         end
 
         # Returns the description of what the correct indentation is based on.
-        def base_description(left_parenthesis)
-          if style == :align_braces
+        def base_description(indent_base_type)
+          case indent_base_type
+          when :left_brace_or_bracket
             'the position of the opening brace'
-          elsif left_parenthesis && style == :special_inside_parentheses
+          when :first_column_after_left_parenthesis
             'the first position after the preceding left parenthesis'
+          when :parent_hash_key
+            'the parent hash key'
           else
             'the start of the line where the left curly brace is'
           end
@@ -178,6 +208,31 @@ module RuboCop
             base_description: base_description
           )
         end
+
+        def message_for_right_brace(indent_base_type)
+          case indent_base_type
+          when :left_brace_or_bracket
+            'Indent the right brace the same as the left brace.'
+          when :first_column_after_left_parenthesis
+            'Indent the right brace the same as the first position ' \
+            'after the preceding left parenthesis.'
+          when :parent_hash_key
+            'Indent the right brace the same as the parent hash key.'
+          else
+            'Indent the right brace the same as the start of the line ' \
+            'where the left brace is.'
+          end
+        end
+
+        def enforce_first_argument_with_fixed_indentation?
+          return false unless argument_alignment_config['Enabled']
+
+          argument_alignment_config['EnforcedStyle'] == 'with_fixed_indentation'
+        end
+
+        def argument_alignment_config
+          config.for_cop('Layout/ArgumentAlignment')
+        end
       end
     end
   end