rubocop 0.76.0 → 1.50.0

data/lib/rubocop/cop/layout/{indent_first_hash_element.rb → first_hash_element_indentation.rb}

@@ -3,9 +3,9 @@
 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 AlignHash cop.
+      # other keys' indentations are handled by the HashAlignment cop.
       #
       # By default, Hash literals that are arguments in a method call with
       # parentheses, and where the opening curly brace of the hash is on the
@@ -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 IndentFirstHashElement < 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,59 +149,53 @@ 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)
           separator = first_pair.loc.operator
           key = "Enforced#{separator.is?(':') ? 'Colon' : 'HashRocket'}Style"
-          config.for_cop('Layout/AlignHash')[key] == 'separator'
+          config.for_cop('Layout/HashAlignment')[key] == 'separator'
         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

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

@@ -3,33 +3,76 @@
 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 hash.
       #
-      # @example
+      # @example AllowMultilineFinalElement: false (default)
       #
       #     # bad
       #     { a: 1,
       #       b: 2}
       #
+      #     # bad
+      #     { a: 1, b: {
+      #       c: 3
+      #     }}
+      #
       #     # good
       #     {
       #       a: 1,
       #       b: 2 }
-      class FirstHashElementLineBreak < Cop
+      #
+      #     # good
+      #     {
+      #       a: 1, b: {
+      #       c: 3
+      #     }}
+      #
+      # @example AllowMultilineFinalElement: true
+      #
+      #     # bad
+      #     { a: 1,
+      #       b: 2}
+      #
+      #     # bad
+      #     { a: 1,
+      #       b: {
+      #       c: 3
+      #     }}
+      #
+      #     # good
+      #     { a: 1, b: {
+      #       c: 3
+      #     }}
+      #
+      #     # good
+      #     {
+      #       a: 1,
+      #       b: 2 }
+      #
+      #     # good
+      #     {
+      #       a: 1, b: {
+      #       c: 3
+      #     }}
+      class FirstHashElementLineBreak < Base
         include FirstElementLineBreak
+        extend AutoCorrector
 
-        MSG = 'Add a line break before the first element of a ' \
-              'multi-line hash.'
+        MSG = 'Add a line break before the first element of a multi-line hash.'
 
         def on_hash(node)
           # node.loc.begin tells us whether the hash opens with a {
           # If it doesn't, Style/FirstMethodArgumentLineBreak will handle it
-          check_children_line_break(node, node.children) if node.loc.begin
+          return unless node.loc.begin
+
+          check_children_line_break(node, node.children, ignore_last: ignore_last_element?)
         end
 
-        def autocorrect(node)
-          EmptyLineCorrector.insert_before(node)
+        private
+
+        def ignore_last_element?
+          !!cop_config['AllowMultilineFinalElement']
         end
       end
     end

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

@@ -3,31 +3,84 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks for a line break before the first argument in a
+      # Checks for a line break before the first argument in a
       # multi-line method call.
       #
-      # @example
+      # @example AllowMultilineFinalElement: false (default)
       #
       #     # bad
       #     method(foo, bar,
       #       baz)
       #
+      #     # bad
+      #     method(foo, bar, {
+      #       baz: "a",
+      #       qux: "b",
+      #     })
+      #
       #     # good
       #     method(
       #       foo, bar,
       #       baz)
       #
+      #     # good
+      #     method(
+      #       foo, bar, {
+      #       baz: "a",
+      #       qux: "b",
+      #     })
+      #
       #     # ignored
       #     method foo, bar,
       #       baz
-      class FirstMethodArgumentLineBreak < Cop
+      #
+      # @example AllowMultilineFinalElement: true
+      #
+      #     # bad
+      #     method(foo, bar,
+      #       baz)
+      #
+      #     # bad
+      #     method(foo,
+      #       bar,
+      #       {
+      #         baz: "a",
+      #         qux: "b",
+      #       }
+      #     )
+      #
+      #     # good
+      #     method(foo, bar, {
+      #       baz: "a",
+      #       qux: "b",
+      #     })
+      #
+      #     # good
+      #     method(
+      #       foo, bar,
+      #       baz)
+      #
+      #     # good
+      #     method(
+      #       foo,
+      #       bar,
+      #       {
+      #         baz: "a",
+      #         qux: "b",
+      #       }
+      #     )
+      #
+      #     # ignored
+      #     method foo, bar,
+      #       baz
+      class FirstMethodArgumentLineBreak < Base
         include FirstElementLineBreak
+        extend AutoCorrector
 
-        MSG = 'Add a line break before the first argument of a ' \
-              'multi-line method argument list.'
+        MSG = 'Add a line break before the first argument of a multi-line method argument list.'
 
         def on_send(node)
-          args = node.arguments
+          args = node.arguments.dup
 
           # If there is a trailing hash arg without explicit braces, like this:
           #
@@ -35,19 +88,18 @@ module RuboCop
           #
           # ...then each key/value pair is treated as a method 'argument'
           # when determining where line breaks should appear.
-          if (last_arg = args.last)
-            if last_arg.hash_type? && !last_arg.braces?
-              args = args.concat(args.pop.children)
-            end
-          end
+          last_arg = args.last
+          args.concat(args.pop.children) if last_arg&.hash_type? && !last_arg&.braces?
 
-          check_method_line_break(node, args)
+          check_method_line_break(node, args, ignore_last: ignore_last_element?)
         end
         alias on_csend on_send
         alias on_super on_send
 
-        def autocorrect(node)
-          EmptyLineCorrector.insert_before(node)
+        private
+
+        def ignore_last_element?
+          !!cop_config['AllowMultilineFinalElement']
         end
       end
     end

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

@@ -3,10 +3,10 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks for a line break before the first parameter in a
+      # Checks for a line break before the first parameter in a
       # multi-line method parameter definition.
       #
-      # @example
+      # @example AllowMultilineFinalElement: false (default)
       #
       #     # bad
       #     def method(foo, bar,
@@ -14,6 +14,13 @@ module RuboCop
       #       do_something
       #     end
       #
+      #     # bad
+      #     def method(foo, bar, baz = {
+      #       :a => "b",
+      #     })
+      #       do_something
+      #     end
+      #
       #     # good
       #     def method(
       #         foo, bar,
@@ -21,24 +28,63 @@ module RuboCop
       #       do_something
       #     end
       #
+      #     # good
+      #     def method(
+      #       foo, bar, baz = {
+      #       :a => "b",
+      #     })
+      #       do_something
+      #     end
+      #
       #     # ignored
       #     def method foo,
       #         bar
       #       do_something
       #     end
-      class FirstMethodParameterLineBreak < Cop
+      #
+      # @example AllowMultilineFinalElement: true
+      #
+      #     # bad
+      #     def method(foo, bar,
+      #         baz)
+      #       do_something
+      #     end
+      #
+      #     # good
+      #     def method(foo, bar, baz = {
+      #       :a => "b",
+      #     })
+      #       do_something
+      #     end
+      #
+      #     # good
+      #     def method(
+      #         foo, bar,
+      #         baz)
+      #       do_something
+      #     end
+      #
+      #     # ignored
+      #     def method foo,
+      #         bar
+      #       do_something
+      #     end
+      #
+      class FirstMethodParameterLineBreak < Base
         include FirstElementLineBreak
+        extend AutoCorrector
 
-        MSG = 'Add a line break before the first parameter of a ' \
-              'multi-line method parameter list.'
+        MSG = 'Add a line break before the first parameter of a multi-line method parameter list.'
 
         def on_def(node)
-          check_method_line_break(node, node.arguments)
+          check_method_line_break(node, node.arguments, ignore_last: ignore_last_element?)
         end
         alias on_defs on_def
 
-        def autocorrect(node)
-          EmptyLineCorrector.insert_before(node)
+        private
+
+        def ignore_last_element?
+          !!cop_config['AllowMultilineFinalElement']
         end
       end
     end

data/lib/rubocop/cop/layout/{indent_first_parameter.rb → first_parameter_indentation.rb}

@@ -3,13 +3,13 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks the indentation of the first parameter in a method
+      # Checks the indentation of the first parameter in a method
       # definition. Parameters after the first one are checked by
-      # Layout/AlignParameters, not by this cop.
+      # Layout/ParameterAlignment, not by this cop.
       #
-      # For indenting the first argument of method *calls*, check out
-      # Layout/IndentFirstArgument, which supports options related to
-      # nesting that are irrelevant for method *definitions*.
+      # For indenting the first argument of method _calls_, check out
+      # Layout/FirstArgumentIndentation, which supports options related to
+      # nesting that are irrelevant for method _definitions_.
       #
       # @example
       #
@@ -41,13 +41,14 @@ module RuboCop
       #   second_param)
       #     123
       #   end
-      class IndentFirstParameter < Cop
+      class FirstParameterIndentation < Base
         include Alignment
         include ConfigurableEnforcedStyle
         include MultilineElementIndentation
+        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?
@@ -57,12 +58,12 @@ module RuboCop
         end
         alias on_defs on_def
 
-        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_parentheses
         end
@@ -73,7 +74,7 @@ module RuboCop
           left_parenthesis = def_node.arguments.loc.begin
           first_elem = def_node.arguments.first
           return unless first_elem
-          return if first_elem.source_range.line == left_parenthesis.line
+          return if same_line?(first_elem, left_parenthesis)
 
           check_first(first_elem, left_parenthesis, nil, 0)
         end