class RuboCop::Cop::Style::CommentAnnotation

# OPTIMIZE does not work
# good
# Optimize does not work
# bad
# FIXME does not work
# good
# fixme does not work
# bad
# TODO make better
# good
# TODO: make better
# bad
@example RequireColon: false
# OPTIMIZE: does not work
# good
# Optimize does not work
# bad
# FIXME: does not work
# good
# fixme: does not work
# bad
# TODO: make better
# good
# TODO:make better
# bad
# TODO: make better
# good
# TODO make better
# bad
@example RequireColon: true (default)
annotation.
incorrect registering of keywords (eg. ‘review`) inside a paragraph as an
if an annotation keyword starts another line. This is done to prevent
comment), only the first line will be able to register an offense, even
NOTE: With a multiline comment block (where each line is only a
configuration. Keywords are allowed to be single words or phrases.
Annotation keywords can be specified by overriding the cop’s ‘Keywords`
to guidelines.
Checks that comment annotation keywords are written according

def annotation_range(annotation) 

def annotation_range(annotation)
  range_between(*annotation.bounds)
end

def correct_offense(corrector, range, keyword) 

def correct_offense(corrector, range, keyword)
  return corrector.replace(range, "#{keyword.upcase}: ") if requires_colon?
  corrector.replace(range, "#{keyword.upcase} ")
end

def first_comment_line?(comments, index) 

def first_comment_line?(comments, index)
  index.zero? || comments[index - 1].loc.line < comments[index].loc.line - 1
end

def inline_comment?(comment) 

def inline_comment?(comment)
  !comment_line?(comment.source_range.source_line)
end

def keywords 

def keywords
  cop_config['Keywords']
end

def on_new_investigation 

def on_new_investigation
  processed_source.comments.each_with_index do |comment, index|
    next unless first_comment_line?(processed_source.comments, index) ||
                inline_comment?(comment)
    annotation = AnnotationComment.new(comment, keywords)
    next unless annotation.annotation? && !annotation.correct?(colon: requires_colon?)
    register_offense(annotation)
  end
end

def register_offense(annotation) 

def register_offense(annotation)
  range = annotation_range(annotation)
  message = if annotation.note
              requires_colon? ? MSG_COLON_STYLE : MSG_SPACE_STYLE
            else
              MISSING_NOTE
            end
  add_offense(range, message: format(message, keyword: annotation.keyword)) do |corrector|
    next if annotation.note.nil?
    correct_offense(corrector, range, annotation.keyword)
  end
end

def requires_colon? 

def requires_colon?
  cop_config['RequireColon']
end