rubocop-grantbirki 1.75.2

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

@@ -0,0 +1,193 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # 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.
+      #
+      # @example
+      #
+      #   # bad
+      #   some_method(
+      #     a,
+      #     b
+      #     )
+      #
+      #   some_method(
+      #     a, b
+      #     )
+      #
+      #   some_method(a, b, c
+      #     )
+      #
+      #   some_method(a,
+      #               b,
+      #               c
+      #     )
+      #
+      #   some_method(a,
+      #     x: 1,
+      #     y: 2
+      #     )
+      #
+      #   # Scenario 1: When First Parameter Is On Its Own Line
+      #
+      #   # good: when first param is on a new line, right paren is *always*
+      #   #       outdented by IndentationWidth
+      #   some_method(
+      #     a,
+      #     b
+      #   )
+      #
+      #   # good
+      #   some_method(
+      #     a, b
+      #   )
+      #
+      #   # Scenario 2: When First Parameter Is On The Same Line
+      #
+      #   # good: when all other params are also on the same line, outdent
+      #   #       right paren by IndentationWidth
+      #   some_method(a, b, c
+      #              )
+      #
+      #   # good: when all other params are on multiple lines, but are lined
+      #   #       up, align right paren with left paren
+      #   some_method(a,
+      #               b,
+      #               c
+      #              )
+      #
+      #   # good: when other params are not lined up on multiple lines, outdent
+      #   #       right paren by IndentationWidth
+      #   some_method(a,
+      #     x: 1,
+      #     y: 2
+      #   )
+      #
+      #
+      class ClosingParenthesisIndentation < Base
+        include Alignment
+        extend AutoCorrector
+
+        MSG_INDENT = 'Indent `)` to column %<expected>d (not %<actual>d)'
+
+        MSG_ALIGN = 'Align `)` with `(`.'
+
+        def on_send(node)
+          check(node, node.arguments)
+        end
+        alias on_csend on_send
+
+        def on_begin(node)
+          check(node, node.children)
+        end
+
+        def on_def(node)
+          check(node.arguments, node.arguments)
+        end
+        alias on_defs on_def
+
+        private
+
+        def autocorrect(corrector, node)
+          AlignmentCorrector.correct(corrector, processed_source, node, @column_delta)
+        end
+
+        def check(node, elements)
+          if elements.empty?
+            check_for_no_elements(node)
+          else
+            check_for_elements(node, elements)
+          end
+        end
+
+        def check_for_elements(node, elements)
+          left_paren  = node.loc.begin
+          right_paren = node.loc.end
+
+          return unless right_paren && begins_its_line?(right_paren)
+
+          correct_column = expected_column(left_paren, elements)
+
+          @column_delta = correct_column - right_paren.column
+
+          return if @column_delta.zero?
+
+          message = message(correct_column, left_paren, right_paren)
+          add_offense(right_paren, message: message) do |corrector|
+            autocorrect(corrector, right_paren)
+          end
+        end
+
+        def check_for_no_elements(node)
+          left_paren = node.loc.begin
+          right_paren = node.loc.end
+          return unless right_paren && begins_its_line?(right_paren)
+
+          candidates = correct_column_candidates(node, left_paren)
+
+          return if candidates.include?(right_paren.column)
+
+          # Although there are multiple choices for a correct column,
+          # select the first one of candidates to determine a specification.
+          correct_column = candidates.first
+          @column_delta = correct_column - right_paren.column
+          message = message(correct_column, left_paren, right_paren)
+          add_offense(right_paren, message: message) do |corrector|
+            autocorrect(corrector, right_paren)
+          end
+        end
+
+        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 - configured_indentation_width
+
+            new_indent.negative? ? 0 : new_indent
+          elsif all_elements_aligned?(elements)
+            left_paren.column
+          else
+            processed_source.line_indentation(first_argument_line(elements))
+          end
+        end
+
+        def all_elements_aligned?(elements)
+          if elements.first.hash_type?
+            elements.first.each_child_node.map { |child| child.loc.column }
+          else
+            elements.flat_map do |e|
+              e.loc.column
+            end
+          end.uniq.count == 1
+        end
+
+        def first_argument_line(elements)
+          elements.first.loc.first_line
+        end
+
+        def correct_column_candidates(node, left_paren)
+          [
+            processed_source.line_indentation(left_paren.line),
+            left_paren.column,
+            node.loc.column
+          ]
+        end
+
+        def message(correct_column, left_paren, right_paren)
+          if correct_column == left_paren.column
+            MSG_ALIGN
+          else
+            format(MSG_INDENT, expected: correct_column, actual: right_paren.column)
+          end
+        end
+
+        def line_break_after_left_paren?(left_paren, elements)
+          elements.first && elements.first.loc.line > left_paren.line
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # Checks the indentation of comments.
+      #
+      # @example
+      #   # bad
+      #     # comment here
+      #   def method_name
+      #   end
+      #
+      #     # comment here
+      #   a = 'hello'
+      #
+      #   # yet another comment
+      #     if true
+      #       true
+      #     end
+      #
+      #   # good
+      #   # comment here
+      #   def method_name
+      #   end
+      #
+      #   # comment here
+      #   a = 'hello'
+      #
+      #   # yet another comment
+      #   if true
+      #     true
+      #   end
+      #
+      # @example AllowForAlignment: false (default)
+      #   # bad
+      #   a = 1 # A really long comment
+      #         # spanning two lines.
+      #
+      #   # good
+      #   # A really long comment spanning one line.
+      #   a = 1
+      #
+      # @example AllowForAlignment: true
+      #   # good
+      #   a = 1 # A really long comment
+      #         # spanning two lines.
+      class CommentIndentation < Base
+        include Alignment
+        extend AutoCorrector
+
+        MSG = 'Incorrect indentation detected (column %<column>d ' \
+              'instead of %<correct_comment_indentation>d).'
+
+        def on_new_investigation
+          processed_source.comments.each_with_index { |comment, ix| check(comment, ix) }
+        end
+
+        private
+
+        def autocorrect(corrector, comment)
+          autocorrect_preceding_comments(corrector, comment)
+
+          autocorrect_one(corrector, comment)
+        end
+
+        # Corrects all comment lines that occur immediately before the given
+        # comment and have the same indentation. This is to avoid a long chain
+        # of correcting, saving the file, parsing and inspecting again, and
+        # then correcting one more line, and so on.
+        def autocorrect_preceding_comments(corrector, comment)
+          comments = processed_source.comments
+          index = comments.index(comment)
+
+          comments[0..index]
+            .reverse_each
+            .each_cons(2)
+            .take_while { |below, above| should_correct?(above, below) }
+            .map { |_, above| autocorrect_one(corrector, above) }
+        end
+
+        def should_correct?(preceding_comment, reference_comment)
+          loc = preceding_comment.loc
+          ref_loc = reference_comment.loc
+          loc.line == ref_loc.line - 1 && loc.column == ref_loc.column
+        end
+
+        def autocorrect_one(corrector, comment)
+          AlignmentCorrector.correct(corrector, processed_source, comment, @column_delta)
+        end
+
+        def check(comment, comment_index)
+          return unless own_line_comment?(comment)
+
+          next_line = line_after_comment(comment)
+          correct_comment_indentation = correct_indentation(next_line)
+          column = comment.loc.column
+
+          @column_delta = correct_comment_indentation - column
+          return if @column_delta.zero?
+
+          if two_alternatives?(next_line)
+            # Try the other
+            correct_comment_indentation += configured_indentation_width
+            # We keep @column_delta unchanged so that autocorrect changes to
+            # the preferred style of aligning the comment with the keyword.
+            return if column == correct_comment_indentation
+          end
+
+          return if correctly_aligned_with_preceding_comment?(comment_index, column)
+
+          add_offense(comment, message: message(column, correct_comment_indentation)) do |corrector|
+            autocorrect(corrector, comment)
+          end
+        end
+
+        # Returns true if:
+        # a) the cop is configured to allow extra indentation for alignment, and
+        # b) the currently inspected comment is aligned with the nearest preceding end-of-line
+        #    comment.
+        def correctly_aligned_with_preceding_comment?(comment_index, column)
+          return false unless cop_config['AllowForAlignment']
+
+          processed_source.comments[0...comment_index].reverse_each do |other_comment|
+            return other_comment.loc.column == column unless own_line_comment?(other_comment)
+          end
+
+          false
+        end
+
+        def message(column, correct_comment_indentation)
+          format(MSG, column: column, correct_comment_indentation: correct_comment_indentation)
+        end
+
+        def own_line_comment?(comment)
+          own_line = processed_source.lines[comment.loc.line - 1]
+          /\A\s*#/.match?(own_line)
+        end
+
+        def line_after_comment(comment)
+          lines = processed_source.lines
+          lines[comment.loc.line..].find { |line| !line.blank? }
+        end
+
+        def correct_indentation(next_line)
+          return 0 unless next_line
+
+          indentation_of_next_line = next_line =~ /\S/
+          indentation_of_next_line + if less_indented?(next_line)
+                                       configured_indentation_width
+                                     else
+                                       0
+                                     end
+        end
+
+        def less_indented?(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)
+          /^\s*(else|elsif|when|in|rescue|ensure)\b/.match?(line)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # Checks for conditions that are not on the same line as
+      # if/while/until.
+      #
+      # @example
+      #
+      #   # bad
+      #   if
+      #     some_condition
+      #     do_something
+      #   end
+      #
+      #   # good
+      #   if some_condition
+      #     do_something
+      #   end
+      class ConditionPosition < Base
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = 'Place the condition on the same line as `%<keyword>s`.'
+
+        def on_if(node)
+          return if node.ternary?
+
+          check(node)
+        end
+
+        def on_while(node)
+          check(node)
+        end
+        alias on_until on_while
+
+        private
+
+        def check(node)
+          return if node.modifier_form? || node.single_line_condition?
+
+          condition = node.condition
+          message = message(condition)
+
+          add_offense(condition, message: message) do |corrector|
+            range = range_by_whole_lines(condition.source_range, include_final_newline: true)
+
+            corrector.insert_after(condition.parent.loc.keyword, " #{condition.source}")
+            corrector.remove(range)
+          end
+        end
+
+        def message(condition)
+          format(MSG, keyword: condition.parent.keyword)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # Checks whether the end keywords of method definitions are
+      # aligned properly.
+      #
+      # Two modes are supported through the EnforcedStyleAlignWith configuration
+      # parameter. If it's set to `start_of_line` (which is the default), the
+      # `end` shall be aligned with the start of the line where the `def`
+      # keyword is. If it's set to `def`, the `end` shall be aligned with the
+      # `def` keyword.
+      #
+      # @example EnforcedStyleAlignWith: start_of_line (default)
+      #   # bad
+      #
+      #   private def foo
+      #               end
+      #
+      #   # good
+      #
+      #   private def foo
+      #   end
+      #
+      # @example EnforcedStyleAlignWith: def
+      #   # bad
+      #
+      #   private def foo
+      #               end
+      #
+      #   # good
+      #
+      #   private def foo
+      #           end
+      class DefEndAlignment < Base
+        include EndKeywordAlignment
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = '`end` at %d, %d is not aligned with `%s` at %d, %d.'
+
+        def on_def(node)
+          check_end_kw_in_node(node)
+        end
+        alias on_defs on_def
+
+        def on_send(node)
+          return unless node.def_modifier?
+
+          method_def = node.each_descendant(:any_def).first
+          expr = node.source_range
+
+          line_start = range_between(expr.begin_pos, method_def.loc.keyword.end_pos)
+          align_with = { def: method_def.loc.keyword, start_of_line: line_start }
+
+          check_end_kw_alignment(method_def, align_with)
+          ignore_node(method_def) # Don't check the same `end` again.
+        end
+
+        private
+
+        def autocorrect(corrector, node)
+          if style == :start_of_line && node.parent&.send_type?
+            AlignmentCorrector.align_end(corrector, processed_source, node, node.parent)
+          else
+            AlignmentCorrector.align_end(corrector, processed_source, node, node)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # Checks the . position in multi-line method calls.
+      #
+      # @example EnforcedStyle: leading (default)
+      #   # bad
+      #   something.
+      #     method
+      #
+      #   # good
+      #   something
+      #     .method
+      #
+      # @example EnforcedStyle: trailing
+      #   # bad
+      #   something
+      #     .method
+      #
+      #   # good
+      #   something.
+      #     method
+      class DotPosition < Base
+        include ConfigurableEnforcedStyle
+        include RangeHelp
+        extend AutoCorrector
+
+        def self.autocorrect_incompatible_with
+          [Style::RedundantSelf]
+        end
+
+        def on_send(node)
+          return unless node.dot? || node.safe_navigation?
+
+          return correct_style_detected if proper_dot_position?(node)
+
+          opposite_style_detected
+          dot = node.loc.dot
+          message = message(dot)
+
+          add_offense(dot, message: message) { |corrector| autocorrect(corrector, dot, node) }
+        end
+        alias on_csend on_send
+
+        private
+
+        def autocorrect(corrector, dot, node)
+          dot_range = if processed_source[dot.line - 1].strip == '.'
+                        range_by_whole_lines(dot, include_final_newline: true)
+                      else
+                        dot
+                      end
+          corrector.remove(dot_range)
+          case style
+          when :leading
+            corrector.insert_before(selector_range(node), dot.source)
+          when :trailing
+            corrector.insert_after(node.receiver, dot.source)
+          end
+        end
+
+        def message(dot)
+          "Place the #{dot.source} on the " +
+            case style
+            when :leading
+              'next line, together with the method name.'
+            when :trailing
+              'previous line, together with the method call receiver.'
+            end
+        end
+
+        def proper_dot_position?(node)
+          selector_range = selector_range(node)
+
+          return true if same_line?(selector_range, end_range(node.receiver))
+
+          selector_line = selector_range.line
+          receiver_line = receiver_end_line(node.receiver)
+          dot_line = node.loc.dot.line
+
+          # don't register an offense if there is a line comment between the
+          # dot and the selector otherwise, we might break the code while
+          # "correcting" it (even if there is just an extra blank line, treat
+          # it the same)
+          # Also, in the case of a heredoc, the receiver will end after the dot,
+          # because the heredoc body is on subsequent lines, so use the highest
+          # line to compare to.
+          return true if line_between?(selector_line, [receiver_line, dot_line].max)
+
+          correct_dot_position_style?(dot_line, selector_line)
+        end
+
+        def line_between?(first_line, second_line)
+          (first_line - second_line) > 1
+        end
+
+        def correct_dot_position_style?(dot_line, selector_line)
+          case style
+          when :leading then dot_line == selector_line
+          when :trailing then dot_line != selector_line
+          end
+        end
+
+        def receiver_end_line(node)
+          if (line = last_heredoc_line(node))
+            line
+          else
+            node.source_range.end.line
+          end
+        end
+
+        def last_heredoc_line(node)
+          if node.send_type?
+            node.arguments.select { |arg| heredoc?(arg) }.map { |arg| arg.loc.heredoc_end.line }.max
+          elsif heredoc?(node)
+            node.loc.heredoc_end.line
+          end
+        end
+
+        def heredoc?(node)
+          node.type?(:str, :dstr) && node.heredoc?
+        end
+
+        def end_range(node)
+          node.source_range.end
+        end
+
+        def selector_range(node)
+          return node unless node.call_type?
+
+          # l.(1) has no selector, so we use the opening parenthesis instead
+          node.loc.selector || node.loc.begin
+        end
+      end
+    end
+  end
+end