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

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `::RuboCop::Cop::AutoCorrector`, `::RuboCop::Cop::Base`, `::RuboCop::ExcludeLimit`, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain: self, `::RuboCop::Cop::RangeHelp`, `::RuboCop::Cop::Base`, `::RuboCop::Cop::AutocorrectLogic`, `::RuboCop::Cop::IgnoredNode`, `::RuboCop::Util`, RuboCop::AST::Sexp
Inherits:	RuboCop::Cop::Base Object RuboCop::Cop::Base RuboCop::Cop::Style::CommentAnnotation
Defined in:	lib/rubocop/cop/style/comment_annotation.rb

Overview

Checks that comment annotation keywords are written according to guidelines.

Annotation keywords can be specified by overriding the cop’s Keywords configuration. Keywords are allowed to be single words or phrases.

Note	With a multiline comment block (where each line is only a comment), only the first line will be able to register an offense, even if an annotation keyword starts another line. This is done to prevent incorrect registering of keywords (eg. `review`) inside a paragraph as an annotation.

Examples:

RequireColon: true (default)

# bad
# TODO make better

# good
# TODO: make better

# bad
# TODO:make better

# good
# TODO: make better

# bad
# fixme: does not work

# good
# FIXME: does not work

# bad
# Optimize does not work

# good
# OPTIMIZE: does not work

RequireColon: false

# bad
# TODO: make better

# good
# TODO make better

# bad
# fixme does not work

# good
# FIXME does not work

# bad
# Optimize does not work

# good
# OPTIMIZE does not work

Constant Summary

MISSING_NOTE =
# File 'lib/rubocop/cop/style/comment_annotation.rb', line 71
```
'Annotation comment, with keyword `%<keyword>s`, is missing a note.'
```

MSG_COLON_STYLE =
# File 'lib/rubocop/cop/style/comment_annotation.rb', line 65

'Annotation keywords like `%<keyword>s` should be all ' \
'upper case, followed by a colon, and a space, ' \
'then a note describing the problem.'

MSG_SPACE_STYLE =
# File 'lib/rubocop/cop/style/comment_annotation.rb', line 68

'Annotation keywords like `%<keyword>s` should be all ' \
'upper case, followed by a space, ' \
'then a note describing the problem.'

`::RuboCop::Cop::Base` - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

`::RuboCop::Cop::RangeHelp` - Included

BYTE_ORDER_MARK, NOT_GIVEN

Class Attribute Summary

`::RuboCop::Cop::AutoCorrector` - Extended

support_autocorrect?

`::RuboCop::Cop::Base` - Inherited

.gem_requirements, .lint?,
.support_autocorrect?	Returns if class supports autocorrect.
.support_multiple_source?	Override if your cop should be called repeatedly for multiple investigations Between calls to #on_new_investigation and `on_investigation_end`, the result of `processed_source` will remain constant.

Class Method Summary

`::RuboCop::Cop::Base` - Inherited

.autocorrect_incompatible_with	List of cops that should not try to autocorrect at the same time as this cop.
.badge	Naming.
.callbacks_needed, .cop_name, .department,
.documentation_url	Returns a url to view this cops documentation online.
.exclude_from_registry	Call for abstract Cop classes.
.inherited,
.joining_forces	Override and return the Force class(es) you need to join.
.match?	Returns true if the cop name or the cop namespace matches any of the given names.
.new,
.requires_gem	Register a version requirement for the given gem name.
.restrict_on_send

`::RuboCop::ExcludeLimit` - Extended

exclude_limit	Sets up a configuration option to have an exclude limit tracked.
transform

Instance Attribute Summary

#requires_colon? ⇒ Boolean readonly private

`::RuboCop::Cop::Base` - Inherited

#active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #processed_source, #string_literals_frozen_by_default?, #target_satisfies_all_gem_version_requirements?

`::RuboCop::Cop::AutocorrectLogic` - Included

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Instance Method Summary

#on_new_investigation
#annotation_range(annotation) private
#correct_offense(corrector, range, keyword) private
#first_comment_line?(comments, index) ⇒ Boolean private
#inline_comment?(comment) ⇒ Boolean private
#keywords private
#register_offense(annotation) private

`::RuboCop::Cop::RangeHelp` - Included

#add_range, #column_offset_between,
#contents_range	A range containing only the contents of a literal with delimiters (e.g.
#directions,
#effective_column	Returns the column attribute of the range, except if the range is on the first line and there’s a byte order mark at the beginning of that line, in which case 1 is subtracted from the column value.
#final_pos, #move_pos, #move_pos_str, #range_between, #range_by_whole_lines, #range_with_comments, #range_with_comments_and_lines, #range_with_surrounding_comma, #range_with_surrounding_space, #source_range

`::RuboCop::Cop::Base` - Inherited

#add_global_offense	Adds an offense that has no particular location.
#add_offense	Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense.
#begin_investigation	Called before any investigation.
#callbacks_needed,
#cop_config	Configuration Helpers.
#cop_name, #excluded_file?,
#external_dependency_checksum	This method should be overridden when a cop’s behavior depends on state that lives outside of these locations:
#inspect,
#message	Gets called if no message is specified when calling `add_offense` or `add_global_offense` Cops are discouraged to override this; instead pass your message directly.
#name	Alias for Base#cop_name.
#offenses,
#on_investigation_end	Called after all on_…
#on_new_investigation	Called before all on_…
#on_other_file	Called instead of all on_…
#parse	There should be very limited reasons for a Cop to do it’s own parsing.
#parser_engine,
#ready	Called between investigations.
#relevant_file?, #target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction,
#callback_argument	Reserved for Cop::Cop.
#complete_investigation	Called to complete an investigation.
#correct, #current_corrector,
#current_offense_locations	Reserved for Commissioner:
#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range,
#reset_investigation	Actually private methods.
#use_corrector

`::RuboCop::Cop::AutocorrectLogic` - Included

#disable_offense, #disable_offense_at_end_of_line, #disable_offense_before_and_after, #disable_offense_with_eol_or_surround_comment, #max_line_length,
#range_by_lines	Expand the given range to include all of any lines it covers.
#range_of_first_line, #range_overlaps_offense?, #string_continuation, #string_continuation?, #surrounding_heredoc, #surrounding_percent_array

`::RuboCop::Cop::IgnoredNode` - Included

#ignore_node, #ignored_node?, #part_of_ignored_node?, #ignored_nodes

Constructor Details

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

Instance Attribute Details

#requires_colon? ⇒ `Boolean` (readonly, private)

[ GitHub ]

# File 'lib/rubocop/cop/style/comment_annotation.rb', line 120


def requires_colon?
  cop_config['RequireColon']
end

Instance Method Details

#annotation_range(annotation) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/comment_annotation.rb', line 110


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

#correct_offense(corrector, range, keyword) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/comment_annotation.rb', line 114


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

  corrector.replace(range, "#{keyword.upcase} ")
end

#first_comment_line?(comments, index) ⇒ `Boolean` (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/comment_annotation.rb', line 102


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

#inline_comment?(comment) ⇒ `Boolean` (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/comment_annotation.rb', line 106


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

#keywords (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/comment_annotation.rb', line 124


def keywords
  cop_config['Keywords']
end

#on_new_investigation

[ GitHub ]

# File 'lib/rubocop/cop/style/comment_annotation.rb', line 73


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

#register_offense(annotation) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/comment_annotation.rb', line 87


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

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

Overview

Constant Summary

::RuboCop::Cop::Base - Inherited

::RuboCop::Cop::RangeHelp - Included

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

::RuboCop::Cop::Base - Inherited

Class Method Summary

::RuboCop::Cop::Base - Inherited

::RuboCop::ExcludeLimit - Extended

Instance Attribute Summary

::RuboCop::Cop::Base - Inherited

::RuboCop::Cop::AutocorrectLogic - Included

Instance Method Summary

::RuboCop::Cop::RangeHelp - Included

::RuboCop::Cop::Base - Inherited

::RuboCop::Cop::AutocorrectLogic - Included

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

Instance Attribute Details

#requires_colon? ⇒ Boolean (readonly, private)

Instance Method Details

#annotation_range(annotation) (private)

#correct_offense(corrector, range, keyword) (private)

#first_comment_line?(comments, index) ⇒ Boolean (private)

#inline_comment?(comment) ⇒ Boolean (private)

#keywords (private)

#on_new_investigation

#register_offense(annotation) (private)

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::Cop::RangeHelp` - Included

`::RuboCop::Cop::AutoCorrector` - Extended

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::ExcludeLimit` - Extended

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::Cop::AutocorrectLogic` - Included

`::RuboCop::Cop::RangeHelp` - Included

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::Cop::AutocorrectLogic` - Included

`::RuboCop::Cop::IgnoredNode` - Included

#requires_colon? ⇒ `Boolean` (readonly, private)

#first_comment_line?(comments, index) ⇒ `Boolean` (private)

#inline_comment?(comment) ⇒ `Boolean` (private)