Class: RuboCop::Cop::Style::CommentIndentation

Inherits:
Cop
  • Object
show all
Includes:
AutocorrectAlignment
Defined in:
lib/rubocop/cop/style/comment_indentation.rb

Overview

This cops checks the indentation of comments.

Constant Summary collapse

MSG = 
'Incorrect indentation detected (column %d instead of %d).'

Constants included from Util

Util::ASGN_NODES, Util::EQUALS_ASGN_NODES, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from AutocorrectAlignment

#autocorrect, #check_alignment, #start_of_line?

Methods inherited from Cop

#add_offense, all, #autocorrect?, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #debug?, #display_cop_names?, inherited, #initialize, #join_force?, lint?, #message, non_rails, qualified_cop_name, rails?, #relevant_file?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, command?, comment_line?, const_name, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_space, source_range, strip_quotes

Methods included from PathUtil

match_path?, relative_path

Constructor Details

This class inherits a constructor from RuboCop::Cop::Cop

Instance Method Details

#investigate(processed_source) ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/rubocop/cop/style/comment_indentation.rb', line 12

def investigate(processed_source)
  processed_source.comments.each do |comment|
    lines = processed_source.lines
    own_line = lines[comment.loc.line - 1]
    next unless own_line =~ /\A\s*#/

    next_line =
      lines[comment.loc.line..-1].find { |line| !line.blank? }

    correct_comment_indentation = correct_indentation(next_line)
    column = comment.loc.column

    @column_delta = correct_comment_indentation - column
    next if @column_delta == 0

    if two_alternatives?(next_line)
      correct_comment_indentation +=
        IndentationWidth::CORRECT_INDENTATION # Try the other
      # We keep @column_delta unchanged so that autocorrect changes to
      # the preferred style of aligning the comment with the keyword.
    end

    next if column == correct_comment_indentation
    add_offense(comment, comment.loc.expression,
                format(MSG, column, correct_comment_indentation))
  end
end