rubocop 0.82.0 → 1.18.4

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

@@ -46,8 +46,9 @@ module RuboCop
       #         Hi
       #       EOS
       #
-      class ClosingHeredocIndentation < Cop
+      class ClosingHeredocIndentation < Base
         include Heredoc
+        extend AutoCorrector
 
         SIMPLE_HEREDOC = '<<'
         MSG = '`%<closing>s` is not aligned with `%<opening>s`.'
@@ -59,11 +60,8 @@ module RuboCop
                     opening_indentation(node) == closing_indentation(node) ||
                     argument_indentation_correct?(node)
 
-          add_offense(node, location: :heredoc_end)
-        end
-
-        def autocorrect(node)
-          lambda do |corrector|
+          message = message(node)
+          add_offense(node.loc.heredoc_end, message: message) do |corrector|
             corrector.replace(node.loc.heredoc_end, indented_end(node))
           end
         end

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

@@ -68,8 +68,9 @@ module RuboCop
       #   )
       #
       #
-      class ClosingParenthesisIndentation < Cop
+      class ClosingParenthesisIndentation < Base
         include Alignment
+        extend AutoCorrector
 
         MSG_INDENT = 'Indent `)` to column %<expected>d (not %<actual>d)'
 
@@ -89,12 +90,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 check(node, elements)
           if elements.empty?
             check_for_no_elements(node)
@@ -115,11 +116,10 @@ module RuboCop
 
           return if @column_delta.zero?
 
-          add_offense(right_paren,
-                      location: right_paren,
-                      message:  message(correct_column,
-                                        left_paren,
-                                        right_paren))
+          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)
@@ -135,17 +135,15 @@ module RuboCop
           # select the first one of candidates to determine a specification.
           correct_column = candidates.first
           @column_delta = correct_column - right_paren.column
-          add_offense(right_paren,
-                      location: right_paren,
-                      message:  message(correct_column,
-                                        left_paren,
-                                        right_paren))
+          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))
+            source_indent = processed_source.line_indentation(first_argument_line(elements))
             new_indent    = source_indent - indentation_width
 
             new_indent.negative? ? 0 : new_indent
@@ -157,17 +155,17 @@ module RuboCop
         end
 
         def all_elements_aligned?(elements)
-          elements
-            .map { |e| e.loc.column }
-            .uniq
-            .count == 1
+          elements.flat_map do |e|
+            if e.hash_type?
+              e.each_pair.map { |pair| pair.loc.column }
+            else
+              e.loc.column
+            end
+          end.uniq.count == 1
         end
 
         def first_argument_line(elements)
-          elements
-            .first
-            .loc
-            .first_line
+          elements.first.loc.first_line
         end
 
         def correct_column_candidates(node, left_paren)
@@ -182,11 +180,7 @@ module RuboCop
           if correct_column == left_paren.column
             MSG_ALIGN
           else
-            format(
-              MSG_INDENT,
-              expected: correct_column,
-              actual: right_paren.column
-            )
+            format(MSG_INDENT, expected: correct_column, actual: right_paren.column)
           end
         end
 

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

@@ -32,29 +32,30 @@ module RuboCop
       #     true
       #   end
       #
-      class CommentIndentation < Cop
+      class CommentIndentation < Base
         include Alignment
+        extend AutoCorrector
 
         MSG = 'Incorrect indentation detected (column %<column>d ' \
-          'instead of %<correct_comment_indentation>d).'
+              'instead of %<correct_comment_indentation>d).'
 
-        def investigate(processed_source)
-          processed_source.each_comment { |comment| check(comment) }
-        end
-
-        def autocorrect(comment)
-          corrections = autocorrect_preceding_comments(comment) <<
-                        autocorrect_one(comment)
-          ->(corrector) { corrections.each { |corr| corr.call(corrector) } }
+        def on_new_investigation
+          processed_source.comments.each { |comment| check(comment) }
         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(comment)
+        def autocorrect_preceding_comments(corrector, comment)
           comments = processed_source.comments
           index = comments.index(comment)
 
@@ -62,7 +63,7 @@ module RuboCop
             .reverse_each
             .each_cons(2)
             .take_while { |below, above| should_correct?(above, below) }
-            .map { |_, above| autocorrect_one(above) }
+            .map { |_, above| autocorrect_one(corrector, above) }
         end
 
         def should_correct?(preceding_comment, reference_comment)
@@ -71,8 +72,8 @@ module RuboCop
           loc.line == ref_loc.line - 1 && loc.column == ref_loc.column
         end
 
-        def autocorrect_one(comment)
-          AlignmentCorrector.correct(processed_source, comment, @column_delta)
+        def autocorrect_one(corrector, comment)
+          AlignmentCorrector.correct(corrector, processed_source, comment, @column_delta)
         end
 
         def check(comment)
@@ -93,23 +94,18 @@ module RuboCop
             return if column == correct_comment_indentation
           end
 
-          add_offense(
-            comment,
-            message: message(column, correct_comment_indentation)
-          )
+          add_offense(comment, message: message(column, correct_comment_indentation)) do |corrector|
+            autocorrect(corrector, comment)
+          end
         end
 
         def message(column, correct_comment_indentation)
-          format(
-            MSG,
-            column: column,
-            correct_comment_indentation: 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]
-          own_line =~ /\A\s*#/
+          /\A\s*#/.match?(own_line)
         end
 
         def line_after_comment(comment)
@@ -129,11 +125,11 @@ module RuboCop
         end
 
         def less_indented?(line)
-          line =~ /^\s*(end\b|[)}\]])/
+          /^\s*(end\b|[)}\]])/.match?(line)
         end
 
         def two_alternatives?(line)
-          line =~ /^\s*(else|elsif|when|rescue|ensure)\b/
+          /^\s*(else|elsif|when|rescue|ensure)\b/.match?(line)
         end
       end
     end

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

@@ -22,7 +22,10 @@ module RuboCop
       #   if some_condition
       #     do_something
       #   end
-      class ConditionPosition < Cop
+      class ConditionPosition < Base
+        include RangeHelp
+        extend AutoCorrector
+
         MSG = 'Place the condition on the same line as `%<keyword>s`.'
 
         def on_if(node)
@@ -34,21 +37,26 @@ module RuboCop
         def on_while(node)
           check(node)
         end
-
-        def on_until(node)
-          check(node)
-        end
+        alias on_until on_while
 
         private
 
         def check(node)
           return if node.modifier_form? || node.single_line_condition?
 
-          add_offense(node.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(node)
-          format(MSG, keyword: node.parent.keyword)
+        def message(condition)
+          format(MSG, keyword: condition.parent.keyword)
         end
       end
     end

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

@@ -33,9 +33,10 @@ module RuboCop
       #
       #   private def foo
       #           end
-      class DefEndAlignment < Cop
+      class DefEndAlignment < Base
         include EndKeywordAlignment
         include RangeHelp
+        extend AutoCorrector
 
         MSG = '`end` at %d, %d is not aligned with `%s` at %d, %d.'
 
@@ -50,22 +51,20 @@ module RuboCop
           method_def = node.each_descendant(:def, :defs).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
-          }
+          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
 
-        def autocorrect(node)
+        private
+
+        def autocorrect(corrector, node)
           if style == :start_of_line && node.parent && node.parent.send_type?
-            AlignmentCorrector.align_end(processed_source, node, node.parent)
+            AlignmentCorrector.align_end(corrector, processed_source, node, node.parent)
           else
-            AlignmentCorrector.align_end(processed_source, node, node)
+            AlignmentCorrector.align_end(corrector, processed_source, node, node)
           end
         end
       end

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

@@ -22,38 +22,43 @@ module RuboCop
       #   # good
       #   something.
       #     method
-      class DotPosition < Cop
+      class DotPosition < Base
         include ConfigurableEnforcedStyle
+        include RangeHelp
+        extend AutoCorrector
 
         def on_send(node)
           return unless node.dot? || ampersand_dot?(node)
 
-          if proper_dot_position?(node)
-            correct_style_detected
-          else
-            add_offense(node, location: :dot) { opposite_style_detected }
-          end
+          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
 
-        def autocorrect(node)
-          lambda do |corrector|
-            dot = node.loc.dot.source
-            corrector.remove(node.loc.dot)
-            case style
-            when :leading
-              corrector.insert_before(selector_range(node), dot)
-            when :trailing
-              corrector.insert_after(node.receiver, dot)
-            end
+        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
 
-        private
-
-        def message(node)
-          dot = node.loc.dot.source
-          "Place the #{dot} on the " +
+        def message(dot)
+          "Place the #{dot.source} on the " +
             case style
             when :leading
               'next line, together with the method name.'

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

@@ -4,7 +4,7 @@ module RuboCop
   module Cop
     module Layout
       # This cop checks the alignment of else keywords. Normally they should
-      # be aligned with an if/unless/while/until/begin/def keyword, but there
+      # 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.
       #
@@ -29,10 +29,11 @@ module RuboCop
       #   else
       #     code
       #   end
-      class ElseAlignment < Cop
+      class ElseAlignment < Base
         include EndKeywordAlignment
         include Alignment
         include CheckAssignment
+        extend AutoCorrector
 
         MSG = 'Align `%<else_range>s` with `%<base_range>s`.'
 
@@ -62,17 +63,15 @@ module RuboCop
         def on_case_match(node)
           return unless node.else?
 
-          check_alignment(
-            node.in_pattern_branches.last.loc.keyword, node.loc.else
-          )
-        end
-
-        def autocorrect(node)
-          AlignmentCorrector.correct(processed_source, node, column_delta)
+          check_alignment(node.in_pattern_branches.last.loc.keyword, node.loc.else)
         end
 
         private
 
+        def autocorrect(corrector, node)
+          AlignmentCorrector.correct(corrector, processed_source, node, column_delta)
+        end
+
         def check_nested(node, base)
           on_if(node, base)
           ignore_node(node)
@@ -93,7 +92,13 @@ module RuboCop
           case parent.type
           when :def, :defs then base_for_method_definition(parent)
           when :kwbegin then parent.loc.begin
-          when :block then parent.send_node.source_range
+          when :block
+            assignment_node = assignment_node(parent)
+            if same_line?(parent, assignment_node)
+              assignment_node.source_range
+            else
+              parent.send_node.source_range
+            end
           else node.loc.keyword
           end
         end
@@ -134,7 +139,16 @@ module RuboCop
             else_range: else_range.source,
             base_range: base_range.source[/^\S*/]
           )
-          add_offense(else_range, location: else_range, message: message)
+          add_offense(else_range, message: message) do |corrector|
+            autocorrect(corrector, else_range)
+          end
+        end
+
+        def assignment_node(node)
+          assignment_node = node.ancestors.first
+          return unless assignment_node&.assignment?
+
+          assignment_node
         end
       end
     end