class RuboCop::Cop::Layout::CommentIndentation
# spanning two lines.
a = 1 # A really long comment
# good
@example AllowForAlignment: true
a = 1
# A really long comment spanning one line.
# good
# spanning two lines.
a = 1 # A really long comment
# bad
@example AllowForAlignment: false (default)
end
true
if true
# yet another comment
a = ‘hello’
# comment here
end
def method_name
# comment here
# good
end
true
if true
# yet another comment
a = ‘hello’
# comment here
end
def method_name
# comment here
# bad
@example
Checks the indentation of comments.
def autocorrect(corrector, comment)
def autocorrect(corrector, comment) autocorrect_preceding_comments(corrector, comment) autocorrect_one(corrector, comment) end
def autocorrect_one(corrector, comment)
def autocorrect_one(corrector, comment) AlignmentCorrector.correct(corrector, processed_source, comment, @column_delta) end
def autocorrect_preceding_comments(corrector, comment)
of correcting, saving the file, parsing and inspecting again, and
comment and have the same indentation. This is to avoid a long chain
Corrects all comment lines that occur immediately before the given
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 check(comment, comment_index)
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
def correct_indentation(next_line)
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 correctly_aligned_with_preceding_comment?(comment_index, column)
b) the currently inspected comment is aligned with the nearest preceding end-of-line
a) the cop is configured to allow extra indentation for alignment, and
Returns true if:
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 less_indented?(line)
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 line_after_comment(comment)
def line_after_comment(comment) lines = processed_source.lines lines[comment.loc.line..].find { |line| !line.blank? } end
def message(column, correct_comment_indentation)
def message(column, correct_comment_indentation) format(MSG, column: column, correct_comment_indentation: correct_comment_indentation) end
def on_new_investigation
def on_new_investigation processed_source.comments.each_with_index { |comment, ix| check(comment, ix) } end
def own_line_comment?(comment)
def own_line_comment?(comment) own_line = processed_source.lines[comment.loc.line - 1] /\A\s*#/.match?(own_line) end
def should_correct?(preceding_comment, reference_comment)
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 two_alternatives?(line)
def two_alternatives?(line) /^\s*(else|elsif|when|in|rescue|ensure)\b/.match?(line) end