Class: RuboCop::Cop::Style::CommentAnnotation

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

Overview

This cop checks that comment annotation keywords are written according to guidelines.

Constant Summary collapse

MSG = 
'Annotation keywords like `%s` should be all upper case, ' \
'followed by a colon, and a space, ' \
'then a note describing the problem.'.freeze
MISSING_NOTE = 
'Annotation comment, with keyword `%s`, ' \
'is missing a note.'.freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search_body

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, comment_line?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path

Constructor Details

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

Instance Method Details

#investigate(processed_source) ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/rubocop/cop/style/comment_annotation.rb', line 18

def investigate(processed_source)
  processed_source.comments.each_with_index do |comment, ix|
    next unless first_comment_line?(processed_source.comments, ix)

    margin, first_word, colon, space, note = split_comment(comment)
    next unless annotation?(comment) &&
                !correct_annotation?(first_word, colon, space, note)

    length = first_word.length + colon.to_s.length + space.to_s.length
    add_offense(comment, annotation_range(comment, margin, length),
                format(note ? MSG : MISSING_NOTE, first_word))
  end
end