rubocop 1.29.1 → 1.46.0

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

@@ -53,7 +53,8 @@ module RuboCop
                            'following the first line of a multi-line method call.'
 
         def on_send(node)
-          return if !multiple_arguments?(node) || (node.send_type? && node.method?(:[]=))
+          return if !multiple_arguments?(node) || (node.send_type? && node.method?(:[]=)) ||
+                    autocorrect_incompatible_with_other_cops?
 
           items = flattened_arguments(node)
 
@@ -64,6 +65,10 @@ module RuboCop
 
         private
 
+        def autocorrect_incompatible_with_other_cops?
+          with_first_argument_style? && enforce_hash_argument_with_separator?
+        end
+
         def flattened_arguments(node)
           if fixed_indentation?
             arguments_with_last_arg_pairs(node)
@@ -112,6 +117,10 @@ module RuboCop
           cop_config['EnforcedStyle'] == 'with_fixed_indentation'
         end
 
+        def with_first_argument_style?
+          cop_config['EnforcedStyle'] == 'with_first_argument'
+        end
+
         def base_column(node, first_argument)
           if fixed_indentation? || first_argument.nil?
             lineno = target_method_lineno(node)
@@ -131,6 +140,18 @@ module RuboCop
             node.loc.begin.line
           end
         end
+
+        def enforce_hash_argument_with_separator?
+          return false unless hash_argument_config['Enabled']
+
+          RuboCop::Cop::Layout::HashAlignment::SEPARATOR_ALIGNMENT_STYLES.any? do |style|
+            hash_argument_config[style]&.include?('separator')
+          end
+        end
+
+        def hash_argument_config
+          config.for_cop('Layout/HashAlignment')
+        end
       end
     end
   end

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

@@ -76,7 +76,7 @@ module RuboCop
         end
 
         def target_method_lineno(node)
-          node.loc.line
+          node.bracketed? ? node.loc.line : node.parent.loc.line
         end
       end
     end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks the indentation of the first line of the
+      # Checks the indentation of the first line of the
       # right-hand-side of a multi-line assignment.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks whether the end keyword of `begin` is aligned properly.
+      # Checks whether the end keyword of `begin` is aligned properly.
       #
       # Two modes are supported through the `EnforcedStyleAlignWith` configuration
       # parameter. If it's set to `start_of_line` (which is the default), the

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks whether the end keywords are aligned properly for do
+      # Checks whether the end keywords are aligned properly for do
       # end blocks.
       #
       # Three modes are supported through the `EnforcedStyleAlignWith`
@@ -22,23 +22,24 @@ module RuboCop
       #   # bad
       #
       #   foo.bar
-      #      .each do
-      #        baz
-      #          end
+      #     .each do
+      #       baz
+      #         end
       #
       #   # good
       #
-      #   variable = lambda do |i|
-      #     i
+      #   foo.bar
+      #     .each do
+      #       baz
       #   end
       #
       # @example EnforcedStyleAlignWith: start_of_block
       #   # bad
       #
       #   foo.bar
-      #      .each do
-      #        baz
-      #          end
+      #     .each do
+      #       baz
+      #         end
       #
       #   # good
       #
@@ -51,16 +52,17 @@ module RuboCop
       #   # bad
       #
       #   foo.bar
-      #      .each do
-      #        baz
-      #          end
+      #     .each do
+      #       baz
+      #         end
       #
       #   # good
       #
       #   foo.bar
       #     .each do
-      #        baz
+      #       baz
       #   end
+      #
       class BlockAlignment < Base
         include ConfigurableEnforcedStyle
         include RangeHelp
@@ -82,6 +84,8 @@ module RuboCop
           check_block_alignment(start_for_block_node(node), node)
         end
 
+        alias on_numblock on_block
+
         def style_parameter_name
           'EnforcedStyleAlignWith'
         end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks whether the end statement of a do..end block
+      # Checks whether the end statement of a do..end block
       # is on its own line.
       #
       # @example
@@ -36,24 +36,60 @@ module RuboCop
           # If the end is on its own line, there is no offense
           return if begins_its_line?(node.loc.end)
 
-          add_offense(node.loc.end, message: message(node)) do |corrector|
-            corrector.replace(delimiter_range(node), "\n#{node.loc.end.source}#{offset(node)}")
-          end
+          register_offense(node)
         end
 
+        alias on_numblock on_block
+
         private
 
+        def register_offense(node)
+          add_offense(node.loc.end, message: message(node)) do |corrector|
+            offense_range = offense_range(node)
+            replacement = replacement(node)
+
+            if (heredoc = last_heredoc_argument(node.body))
+              corrector.remove(offense_range)
+              corrector.insert_after(heredoc.loc.heredoc_end, replacement)
+            else
+              corrector.replace(offense_range, replacement)
+            end
+          end
+        end
+
         def message(node)
           format(MSG, line: node.loc.end.line, column: node.loc.end.column + 1)
         end
 
-        def delimiter_range(node)
+        def last_heredoc_argument(node)
+          return unless node&.call_type?
+          return unless (arguments = node&.arguments)
+
+          heredoc = arguments.reverse.detect { |arg| arg.str_type? && arg.heredoc? }
+          return heredoc if heredoc
+
+          last_heredoc_argument(node.children.first)
+        end
+
+        def offense_range(node)
           Parser::Source::Range.new(
             node.loc.expression.source_buffer,
             node.children.compact.last.loc.expression.end_pos,
-            node.loc.expression.end_pos
+            end_of_method_chain(node).loc.expression.end_pos
           )
         end
+
+        def replacement(node)
+          end_with_method_chain = node.loc.end.join(end_of_method_chain(node).loc.expression.end)
+
+          "\n#{end_with_method_chain.source.strip}"
+        end
+
+        def end_of_method_chain(node)
+          return node unless node.parent&.call_type?
+
+          end_of_method_chain(node.parent)
+        end
       end
     end
   end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks how the `when` and ``in``s of a `case` expression
+      # Checks how the `when` and ``in``s of a `case` expression
       # are indented in relation to its `case` or `end` keyword.
       #
       # It will register a separate offense for each misaligned `when` and `in`.

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

@@ -132,25 +132,20 @@ module RuboCop
       #     end
       #   end
       #
-      # @see https://rubystyle.guide#consistent-classes
       class ClassStructure < Base
         include VisibilityHelp
+        include CommentsHelp
         extend AutoCorrector
 
         HUMANIZED_NODE_TYPE = {
           casgn: :constants,
-          defs: :class_methods,
+          defs: :public_class_methods,
           def: :public_methods,
           sclass: :class_singleton
         }.freeze
 
         MSG = '`%<category>s` is supposed to appear before `%<previous>s`.'
 
-        # @!method dynamic_constant?(node)
-        def_node_matcher :dynamic_constant?, <<~PATTERN
-          (casgn nil? _ (send ...))
-        PATTERN
-
         # Validates code style on class declaration.
         # Add offense when find a node out of expected order.
         def on_class(class_node)
@@ -169,7 +164,7 @@ module RuboCop
 
         # Autocorrect by swapping between two nodes autocorrecting them
         def autocorrect(corrector, node)
-          previous = node.left_siblings.find do |sibling|
+          previous = node.left_siblings.reverse.find do |sibling|
             !ignore_for_autocorrect?(node, sibling)
           end
           return unless previous
@@ -222,7 +217,7 @@ module RuboCop
         def walk_over_nested_class_definition(class_node)
           class_elements(class_node).each do |node|
             classification = classify(node)
-            next if ignore?(classification)
+            next if ignore?(node, classification)
 
             yield node, classification
           end
@@ -240,17 +235,20 @@ module RuboCop
           end
         end
 
-        def ignore?(classification)
+        def ignore?(node, classification)
           classification.nil? ||
             classification.to_s.end_with?('=') ||
-            expected_order.index(classification).nil?
+            expected_order.index(classification).nil? ||
+            private_constant?(node)
         end
 
         def ignore_for_autocorrect?(node, sibling)
           classification = classify(node)
           sibling_class = classify(sibling)
 
-          ignore?(sibling_class) || classification == sibling_class || dynamic_constant?(node)
+          ignore?(sibling, sibling_class) ||
+            classification == sibling_class ||
+            dynamic_constant?(node)
         end
 
         def humanize_node(node)
@@ -262,19 +260,28 @@ module RuboCop
           HUMANIZED_NODE_TYPE[node.type] || node.type
         end
 
-        def source_range_with_comment(node)
-          begin_pos, end_pos =
-            if (node.def_type? && !node.method?(:initialize)) ||
-               (node.send_type? && node.def_modifier?)
-              start_node = find_visibility_start(node) || node
-              end_node = find_visibility_end(node) || node
-              [begin_pos_with_comment(start_node),
-               end_position_for(end_node) + 1]
-            else
-              [begin_pos_with_comment(node), end_position_for(node)]
-            end
+        def dynamic_constant?(node)
+          return false unless node.casgn_type? && node.namespace.nil?
+
+          expression = node.expression
+          expression.send_type? &&
+            !(expression.method?(:freeze) && expression.receiver&.recursive_basic_literal?)
+        end
+
+        def private_constant?(node)
+          return false unless node.casgn_type? && node.namespace.nil?
+          return false unless (parent = node.parent)
+
+          parent.each_child_node(:send) do |child_node|
+            return true if marked_as_private_constant?(child_node, node.name)
+          end
+          false
+        end
+
+        def marked_as_private_constant?(node, name)
+          return false unless node.method?(:private_constant)
 
-          Parser::Source::Range.new(buffer, begin_pos, end_pos)
+          node.arguments.any? { |arg| (arg.sym_type? || arg.str_type?) && arg.value == name }
         end
 
         def end_position_for(node)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks the indentation of hanging closing parentheses in
+      # Checks the indentation of hanging closing parentheses in
       # method calls, method definitions, and grouped expressions. A hanging
       # closing parenthesis means `)` preceded by a line break.
       #
@@ -144,7 +144,7 @@ module RuboCop
         def expected_column(left_paren, elements)
           if line_break_after_left_paren?(left_paren, elements)
             source_indent = processed_source.line_indentation(first_argument_line(elements))
-            new_indent    = source_indent - indentation_width
+            new_indent    = source_indent - configured_indentation_width
 
             new_indent.negative? ? 0 : new_indent
           elsif all_elements_aligned?(elements)
@@ -157,7 +157,7 @@ module RuboCop
         def all_elements_aligned?(elements)
           elements.flat_map do |e|
             if e.hash_type?
-              e.each_pair.map { |pair| pair.loc.column }
+              e.each_child_node.map { |child| child.loc.column }
             else
               e.loc.column
             end
@@ -184,10 +184,6 @@ module RuboCop
           end
         end
 
-        def indentation_width
-          @config.for_cop('Layout/IndentationWidth')['Width'] || 2
-        end
-
         def line_break_after_left_paren?(left_paren, elements)
           elements.first && elements.first.loc.line > left_paren.line
         end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks the indentation of comments.
+      # Checks the indentation of comments.
       #
       # @example
       #   # bad
@@ -154,7 +154,9 @@ module RuboCop
         end
 
         def less_indented?(line)
-          /^\s*(end\b|[)}\]])/.match?(line)
+          rule = config.for_cop('Layout/AccessModifierIndentation')['EnforcedStyle'] == 'outdent'
+          access_modifier = 'private|protected|public'
+          /\A\s*(end\b|[)}\]])/.match?(line) || (rule && /\A\s*(#{access_modifier})\b/.match?(line))
         end
 
         def two_alternatives?(line)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks for conditions that are not on the same line as
+      # Checks for conditions that are not on the same line as
       # if/while/until.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks whether the end keywords of method definitions are
+      # Checks whether the end keywords of method definitions are
       # aligned properly.
       #
       # Two modes are supported through the EnforcedStyleAlignWith configuration

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks the . position in multi-line method calls.
+      # Checks the . position in multi-line method calls.
       #
       # @example EnforcedStyle: leading (default)
       #   # bad

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks the alignment of else keywords. Normally they should
+      # Checks the alignment of else keywords. Normally they should
       # be aligned with an if/unless/while/until/begin/def/rescue keyword, but there
       # are special cases when they should follow the same rules as the
       # alignment of end.

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks empty comment.
+      # Checks empty comment.
       #
       # @example
       #   # bad
@@ -97,7 +97,7 @@ module RuboCop
         def autocorrect(corrector, node)
           previous_token = previous_token(node)
           range = if previous_token && same_line?(node, previous_token)
-                    range_with_surrounding_space(range: node.loc.expression, newlines: false)
+                    range_with_surrounding_space(node.loc.expression, newlines: false)
                   else
                     range_by_whole_lines(node.loc.expression, include_final_newline: true)
                   end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop enforces empty line after guard clause
+      # Enforces empty line after guard clause
       #
       # @example
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop enforces empty line after multiline condition.
+      # Enforces empty line after multiline condition.
       #
       # @example
       #   # bad

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks whether class/module/method definitions are
+      # Checks whether class/module/method definitions are
       # separated by one or more empty lines.
       #
       # `NumberOfEmptyLines` can be an integer (default is 1) or

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks for two or more consecutive blank lines.
+      # Checks for two or more consecutive blank lines.
       #
       # @example
       #
@@ -27,6 +27,8 @@ module RuboCop
 
         def on_new_investigation
           return if processed_source.tokens.empty?
+          # Quick check if we possibly have consecutive blank lines.
+          return unless processed_source.raw_source.include?("\n\n\n")
 
           lines = Set.new
           processed_source.each_token { |token| lines << token.line }

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

@@ -80,8 +80,11 @@ module RuboCop
           @block_line = node.source_range.first_line
         end
 
-        def on_send(node)
-          return unless node.bare_access_modifier? && !node.parent&.block_type?
+        alias on_numblock on_block
+
+        def on_send(node) # rubocop:disable Metrics/CyclomaticComplexity
+          return unless node.bare_access_modifier? &&
+                        !(node.parent&.block_type? || node.parent&.numblock_type?)
           return if expected_empty_lines?(node)
 
           message = message(node)

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

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

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
@@ -32,6 +32,8 @@ module RuboCop
 
           check(node, node.body, adjusted_first_line: first_line)
         end
+
+        alias on_numblock on_block
       end
     end
   end

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