rubocop 1.19.0 → 1.33.0

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

@@ -70,18 +70,39 @@ module RuboCop
         def on_send(node)
           return unless node.attribute_accessor?
           return if next_line_empty?(node.last_line)
+          return if next_line_empty_or_enable_directive_comment?(node.last_line)
 
           next_line_node = next_line_node(node)
           return unless require_empty_line?(next_line_node)
 
-          add_offense(node) do |corrector|
-            range = range_by_whole_lines(node.source_range)
+          add_offense(node) { |corrector| autocorrect(corrector, node) }
+        end
+
+        private
 
-            corrector.insert_after(range, "\n")
+        def autocorrect(corrector, node)
+          node_range = range_by_whole_lines(node.source_range)
+
+          next_line = node_range.last_line + 1
+          if next_line_enable_directive_comment?(next_line)
+            node_range = processed_source.comment_at_line(next_line)
           end
+
+          corrector.insert_after(node_range, "\n")
         end
 
-        private
+        def next_line_empty_or_enable_directive_comment?(line)
+          return true if next_line_empty?(line)
+
+          next_line = line + 1
+          next_line_enable_directive_comment?(next_line) && next_line_empty?(next_line)
+        end
+
+        def next_line_enable_directive_comment?(line)
+          return false unless (comment = processed_source.comment_at_line(line))
+
+          DirectiveComment.new(comment).enabled?
+        end
 
         def next_line_empty?(line)
           processed_source[line].nil? || processed_source[line].blank?

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

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

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

@@ -3,23 +3,23 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks if empty lines around the bodies of blocks match
+      # Checks if empty lines around the bodies of blocks match
       # the configuration.
       #
-      # @example EnforcedStyle: empty_lines
+      # @example EnforcedStyle: no_empty_lines (default)
       #   # good
       #
       #   foo do |bar|
-      #
       #     # ...
-      #
       #   end
       #
-      # @example EnforcedStyle: no_empty_lines (default)
+      # @example EnforcedStyle: empty_lines
       #   # good
       #
       #   foo do |bar|
+      #
       #     # ...
+      #
       #   end
       class EmptyLinesAroundBlockBody < Base
         include EmptyLinesAroundBody

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

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

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`
@@ -65,21 +65,24 @@ module RuboCop
         MSG = 'Extra empty line detected %<location>s the `%<keyword>s`.'
 
         def on_def(node)
-          check_body(node.body)
+          check_body(node.body, node.loc.line)
         end
         alias on_defs on_def
 
         def on_kwbegin(node)
           body, = *node
-          check_body(body)
+          check_body(body, node.loc.line)
         end
 
         private
 
-        def check_body(node)
-          locations = keyword_locations(node)
+        def check_body(body, line_of_def_or_kwbegin)
+          locations = keyword_locations(body)
+
           locations.each do |loc|
             line = loc.line
+            next if line == line_of_def_or_kwbegin || last_rescue_and_end_on_same_line(body)
+
             keyword = loc.source
             # below the keyword
             check_line(style, line, message('after', keyword), &:empty?)
@@ -88,6 +91,10 @@ module RuboCop
           end
         end
 
+        def last_rescue_and_end_on_same_line(body)
+          body.rescue_type? && body.resbody_branches.last.loc.line == body.parent.loc.end.line
+        end
+
         def message(location, keyword)
           format(MSG, location: location, keyword: keyword)
         end

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:
@@ -165,8 +165,7 @@ module RuboCop
         end
 
         def alignment_node_for_variable_style(node)
-          return node.parent if node.case_type? && node.argument? &&
-                                node.loc.line == node.parent.loc.line
+          return node.parent if node.case_type? && node.argument? && same_line?(node, node.parent)
 
           assignment = assignment_or_operator_method(node)
 
@@ -182,7 +181,7 @@ module RuboCop
 
         def assignment_or_operator_method(node)
           node.ancestors.find do |ancestor|
-            ancestor.assignment_or_similar? || ancestor.send_type? && ancestor.operator_method?
+            ancestor.assignment_or_similar? || (ancestor.send_type? && ancestor.operator_method?)
           end
         end
       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

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
       #

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
@@ -267,6 +268,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.
       #
@@ -115,34 +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 /\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_colmn_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_colmn_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,7 +3,7 @@
 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

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
@@ -116,7 +149,7 @@ 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)
@@ -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_colmn_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_colmn_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,7 +3,7 @@
 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

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

@@ -3,7 +3,7 @@
 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