rubocop 1.9.1 → 1.13.0

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,11 @@ module RuboCop
         end
 
         def all_elements_aligned?(elements)
-          elements
-            .map { |e| e.loc.column }
-            .uniq
-            .count == 1
+          elements.map { |e| e.loc.column }.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 +174,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).'
 
-        def investigate(processed_source)
+        def on_new_investigation
           processed_source.comments.each { |comment| check(comment) }
         end
 
-        def autocorrect(comment)
-          corrections = autocorrect_preceding_comments(comment) <<
-                        autocorrect_one(comment)
-          ->(corrector) { corrections.each { |corr| corr.call(corrector) } }
-        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,18 +94,13 @@ 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)

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

@@ -51,12 +51,8 @@ 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.

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

@@ -35,9 +35,7 @@ module RuboCop
           dot = node.loc.dot
           message = message(dot)
 
-          add_offense(dot, message: message) do |corrector|
-            autocorrect(corrector, dot, node)
-          end
+          add_offense(dot, message: message) { |corrector| autocorrect(corrector, dot, node) }
         end
         alias on_csend on_send
 

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

@@ -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)
@@ -140,7 +139,9 @@ 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)

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

@@ -75,9 +75,7 @@ module RuboCop
             processed_source.comments.each do |comment|
               next unless empty_comment_only?(comment_text(comment))
 
-              add_offense(comment) do |corrector|
-                autocorrect(corrector, comment)
-              end
+              add_offense(comment) { |corrector| autocorrect(corrector, comment) }
             end
           end
         end
@@ -99,19 +97,16 @@ module RuboCop
         def autocorrect(corrector, node)
           previous_token = previous_token(node)
           range = if previous_token && node.loc.line == previous_token.line
-                    range_with_surrounding_space(range: node.loc.expression,
-                                                 newlines: false)
+                    range_with_surrounding_space(range: node.loc.expression, newlines: false)
                   else
-                    range_by_whole_lines(node.loc.expression,
-                                         include_final_newline: true)
+                    range_by_whole_lines(node.loc.expression, include_final_newline: true)
                   end
 
           corrector.remove(range)
         end
 
         def concat_consecutive_comments(comments)
-          consecutive_comments =
-            comments.chunk_while { |i, j| i.loc.line.succ == j.loc.line }
+          consecutive_comments = comments.chunk_while { |i, j| i.loc.line.succ == j.loc.line }
 
           consecutive_comments.map do |chunk|
             joined_text = chunk.map { |c| comment_text(c) }.join
@@ -142,9 +137,7 @@ module RuboCop
         end
 
         def current_token(comment)
-          processed_source.find_token do |token|
-            token.pos == comment.loc.expression
-          end
+          processed_source.find_token { |token| token.pos == comment.loc.expression }
         end
 
         def previous_token(node)

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

@@ -47,18 +47,15 @@ module RuboCop
 
           if node.modifier_form? && last_argument_is_heredoc?(node)
             heredoc_node = last_heredoc_argument(node)
-
-            return if next_line_empty?(heredoc_line(node, heredoc_node))
+            return if next_line_empty_or_enable_directive_comment?(heredoc_line(node, heredoc_node))
 
             add_offense(heredoc_node.loc.heredoc_end) do |corrector|
               autocorrect(corrector, heredoc_node)
             end
           else
-            return if next_line_empty?(node.last_line)
+            return if next_line_empty_or_enable_directive_comment?(node.last_line)
 
-            add_offense(offense_location(node)) do |corrector|
-              autocorrect(corrector, node)
-            end
+            add_offense(offense_location(node)) { |corrector| autocorrect(corrector, node) }
           end
         end
 
@@ -71,6 +68,11 @@ module RuboCop
                          range_by_whole_lines(node.source_range)
                        end
 
+          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
 
@@ -85,10 +87,23 @@ module RuboCop
           node.if_branch&.guard_clause?
         end
 
+        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_empty?(line)
           processed_source[line].blank?
         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_rescue_or_ensure?(node)
           parent = node.parent
           parent.nil? || parent.rescue_type? || parent.ensure_type?
@@ -137,8 +152,7 @@ module RuboCop
 
         def heredoc_line(node, heredoc_node)
           heredoc_body = heredoc_node.loc.heredoc_body
-          num_of_heredoc_lines =
-            heredoc_body.last_line - heredoc_body.first_line
+          num_of_heredoc_lines = heredoc_body.last_line - heredoc_body.first_line
 
           node.last_line + num_of_heredoc_lines + END_OF_HEREDOC_LINE
         end

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

@@ -111,8 +111,7 @@ module RuboCop
 
           return if line_count_allowed?(count)
           return if multiple_blank_lines_groups?(*nodes)
-          return if nodes.all?(&:single_line?) &&
-                    cop_config['AllowAdjacentOneLineDefs']
+          return if nodes.all?(&:single_line?) && cop_config['AllowAdjacentOneLineDefs']
 
           correction_node = nodes.last
           location = correction_node.loc.keyword.join(correction_node.loc.name)
@@ -160,10 +159,7 @@ module RuboCop
         def message(node, count: nil)
           type = node_type(node)
 
-          format(MSG,
-                 type: type,
-                 expected: expected_lines,
-                 actual: count)
+          format(MSG, type: type, expected: expected_lines, actual: count)
         end
 
         def expected_lines

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

@@ -29,9 +29,7 @@ module RuboCop
           return if processed_source.tokens.empty?
 
           lines = Set.new
-          processed_source.each_token do |token|
-            lines << token.line
-          end
+          processed_source.each_token { |token| lines << token.line }
 
           each_extra_empty_line(lines.sort) do |range|
             add_offense(range) do |corrector|

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

@@ -46,8 +46,7 @@ module RuboCop
         extend AutoCorrector
 
         MSG_AFTER = 'Keep a blank line after `%<modifier>s`.'
-        MSG_BEFORE_AND_AFTER = 'Keep a blank line before and after ' \
-                               '`%<modifier>s`.'
+        MSG_BEFORE_AND_AFTER = 'Keep a blank line before and after `%<modifier>s`.'
 
         MSG_BEFORE_FOR_ONLY_BEFORE = 'Keep a blank line before `%<modifier>s`.'
         MSG_AFTER_FOR_ONLY_BEFORE = 'Remove a blank line after `%<modifier>s`.'
@@ -73,10 +72,8 @@ module RuboCop
         end
 
         def on_sclass(node)
-          @class_or_module_def_first_line =
-            node.identifier.source_range.first_line
-          @class_or_module_def_last_line =
-            node.source_range.last_line
+          @class_or_module_def_first_line = node.identifier.source_range.first_line
+          @class_or_module_def_last_line = node.source_range.last_line
         end
 
         def on_block(node)
@@ -133,19 +130,14 @@ module RuboCop
         end
 
         def previous_line_ignoring_comments(processed_source, send_line)
-          processed_source[0..send_line - 2].reverse.find do |line|
-            !comment_line?(line)
-          end
+          processed_source[0..send_line - 2].reverse.find { |line| !comment_line?(line) }
         end
 
         def previous_line_empty?(send_line)
-          previous_line = previous_line_ignoring_comments(processed_source,
-                                                          send_line)
+          previous_line = previous_line_ignoring_comments(processed_source, send_line)
           return true unless previous_line
 
-          block_start?(send_line) ||
-            class_def?(send_line) ||
-            previous_line.blank?
+          block_start?(send_line) || class_def?(send_line) || previous_line.blank?
         end
 
         def next_line_empty?(last_send_line)
@@ -155,8 +147,7 @@ module RuboCop
         end
 
         def empty_lines_around?(node)
-          previous_line_empty?(node.first_line) &&
-            next_line_empty?(node.last_line)
+          previous_line_empty?(node.first_line) && next_line_empty?(node.last_line)
         end
 
         def class_def?(line)
@@ -193,8 +184,7 @@ module RuboCop
         def message_for_around_style(node)
           send_line = node.first_line
 
-          if block_start?(send_line) ||
-             class_def?(send_line)
+          if block_start?(send_line) || class_def?(send_line)
             format(MSG_AFTER, modifier: node.loc.selector.source)
           else
             format(MSG_BEFORE_AND_AFTER, modifier: node.loc.selector.source)