rubocop 1.29.1 → 1.46.0

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks if empty lines exist around the bodies of `begin`
+      # Checks if empty lines exist around the bodies of `begin`
       # sections. This cop doesn't check empty lines at `begin` body
       # beginning/end and around method definition body.
       # `Style/EmptyLinesAroundBeginBody` or `Style/EmptyLinesAroundMethodBody`

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks if empty lines exist around the bodies of methods.
+      # Checks if empty lines exist around the bodies of methods.
       #
       # @example
       #

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

@@ -3,9 +3,18 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks if empty lines around the bodies of modules match
+      # Checks if empty lines around the bodies of modules match
       # the configuration.
       #
+      # @example EnforcedStyle: no_empty_lines (default)
+      #   # good
+      #
+      #   module Foo
+      #     def bar
+      #       # ...
+      #     end
+      #   end
+      #
       # @example EnforcedStyle: empty_lines
       #   # good
       #
@@ -35,15 +44,6 @@ module RuboCop
       #     def bar; end
       #
       #   end
-      #
-      # @example EnforcedStyle: no_empty_lines (default)
-      #   # good
-      #
-      #   module Foo
-      #     def bar
-      #       # ...
-      #     end
-      #   end
       class EmptyLinesAroundModuleBody < Base
         include EmptyLinesAroundBody
         extend AutoCorrector

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks whether the end keywords are aligned properly.
+      # Checks whether the end keywords are aligned properly.
       #
       # Three modes are supported through the `EnforcedStyleAlignWith`
       # configuration parameter:
@@ -82,6 +82,10 @@ module RuboCop
           check_other_alignment(node)
         end
 
+        def on_sclass(node)
+          check_other_alignment(node)
+        end
+
         def on_module(node)
           check_other_alignment(node)
         end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks for Windows-style line endings in the source code.
+      # Checks for Windows-style line endings in the source code.
       #
       # @example EnforcedStyle: native (default)
       #   # The `native` style means that CR+LF (Carriage Return + Line Feed) is
@@ -22,20 +22,20 @@ module RuboCop
       #   # all platforms.
       #
       #   # bad
-      #   puts 'Hello' # Return character is CR+LF on all platfoms.
+      #   puts 'Hello' # Return character is CR+LF on all platforms.
       #
       #   # good
-      #   puts 'Hello' # Return character is LF on all platfoms.
+      #   puts 'Hello' # Return character is LF on all platforms.
       #
       # @example EnforcedStyle: crlf
       #   # The `crlf` style means that CR+LF (Carriage Return + Line Feed) is
       #   # enforced on all platforms.
       #
       #   # bad
-      #   puts 'Hello' # Return character is LF on all platfoms.
+      #   puts 'Hello' # Return character is LF on all platforms.
       #
       #   # good
-      #   puts 'Hello' # Return character is CR+LF on all platfoms.
+      #   puts 'Hello' # Return character is CR+LF on all platforms.
       #
       class EndOfLine < Base
         include ConfigurableEnforcedStyle

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks for extra/unnecessary whitespace.
+      # Checks for extra/unnecessary whitespace.
       #
       # @example
       #
@@ -119,12 +119,16 @@ module RuboCop
         def ignored_ranges(ast)
           return [] unless ast
 
-          @ignored_ranges ||= on_node(:pair, ast).map do |pair|
-            next if pair.parent.single_line?
+          @ignored_ranges ||= begin
+            ranges = []
+            on_node(:pair, ast) do |pair|
+              next if pair.parent.single_line?
 
-            key, value = *pair
-            key.source_range.end_pos...value.source_range.begin_pos
-          end.compact
+              key, value = *pair
+              ranges << (key.source_range.end_pos...value.source_range.begin_pos)
+            end
+            ranges
+          end
         end
 
         def force_equal_sign_alignment?

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks the indentation of the first argument in a method call.
+      # 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.
       #
@@ -37,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(
@@ -51,7 +52,7 @@ module RuboCop
       #   second_param)
       #
       #   foo = some_method(nested_call(
-      #     nested_first_param),
+      #                       nested_first_param),
       #   second_param)
       #
       #   foo = some_method(
@@ -63,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(
@@ -73,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(
@@ -101,7 +100,7 @@ module RuboCop
       #   second_param)
       #
       #   foo = some_method(
-      #     first_param,
+      #           first_param,
       #   second_param)
       #
       #   foo = some_method(nested_call(
@@ -109,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(
@@ -141,7 +141,7 @@ module RuboCop
       #   second_param)
       #
       #   some_method nested_call(
-      #     nested_first_param),
+      #                 nested_first_param),
       #   second_param
       #
       class FirstArgumentIndentation < Base
@@ -153,7 +153,8 @@ module RuboCop
         MSG = 'Indent the first argument one step more than %<base>s.'
 
         def on_send(node)
-          return if style != :consistent && enforce_first_argument_with_fixed_indentation?
+          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
@@ -161,6 +162,7 @@ module RuboCop
           check_alignment([node.first_argument], indent)
         end
         alias on_csend on_send
+        alias on_super on_send
 
         private
 
@@ -177,7 +179,7 @@ module RuboCop
 
           send_node = arg_node.parent
           text = base_range(send_node, arg_node).source.strip
-          base = if !/\n/.match?(text) && special_inner_call_indentation?(send_node)
+          base = if !text.include?("\n") && 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)'
@@ -267,6 +269,10 @@ module RuboCop
           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

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.
       #
@@ -120,29 +120,33 @@ module RuboCop
             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 /\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 = msg(left_parenthesis)
+          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
@@ -156,15 +160,18 @@ module RuboCop
           )
         end
 
-        def msg(left_parenthesis)
-          if style == :align_brackets
+        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.'
-          elsif style == :special_inside_parentheses && left_parenthesis
+          when :first_column_after_left_parenthesis
             'Indent the right bracket the same as the first position ' \
-              'after the preceding left parenthesis.'
+            '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.'
+            'Indent the right bracket the same as the start of the line ' \
+            'where the left bracket is.'
           end
         end
       end

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

@@ -3,20 +3,52 @@
 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]
       #
+      #     # good
+      #     [:a, :b]
       class FirstArrayElementLineBreak < Base
         include FirstElementLineBreak
         extend AutoCorrector
@@ -26,7 +58,7 @@ module RuboCop
         def on_array(node)
           return if !node.loc.begin && !assignment_on_same_line?(node)
 
-          check_children_line_break(node, node.children)
+          check_children_line_break(node, node.children, ignore_last: ignore_last_element?)
         end
 
         private
@@ -35,6 +67,10 @@ module RuboCop
           source = node.source_range.source_line[0...node.loc.column]
           /\s*=\s*$/.match?(source)
         end
+
+        def ignore_last_element?
+          !!cop_config['AllowMultilineFinalElement']
+        end
       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,11 +89,27 @@ 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
       #                           }
+      #   takes_multi_pairs_hash(x: {
+      #                               a: 1,
+      #                               b: 2
+      #                             },
+      #                          y: {
+      #                               c: 1,
+      #                               d: 2
+      #                             })
       class FirstHashElementIndentation < Base
         include Alignment
         include ConfigurableEnforcedStyle
@@ -125,18 +158,18 @@ module RuboCop
             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 /\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?
 
-          message = message_for_right_brace(left_parenthesis)
+          message = message_for_right_brace(indent_base_type)
           add_offense(right_brace, message: message) do |corrector|
             autocorrect(corrector, right_brace)
           end
@@ -155,11 +188,14 @@ module RuboCop
         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
@@ -173,15 +209,18 @@ module RuboCop
           )
         end
 
-        def message_for_right_brace(left_parenthesis)
-          if style == :align_braces
+        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.'
-          elsif style == :special_inside_parentheses && left_parenthesis
+          when :first_column_after_left_parenthesis
             'Indent the right brace the same as the first position ' \
-              'after the preceding left parenthesis.'
+            '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.'
+            'where the left brace is.'
           end
         end
 

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

@@ -3,19 +3,58 @@
 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 }
+      #
+      #     # 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
@@ -25,7 +64,15 @@ module RuboCop
         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
+
+        private
+
+        def ignore_last_element?
+          !!cop_config['AllowMultilineFinalElement']
         end
       end
     end