Class: RuboCop::Cop::Style::CommentedKeyword
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
|
Defined in: | lib/rubocop/cop/style/commented_keyword.rb |
Overview
Checks for comments put on the same line as some keywords.
These keywords are: class
, module
, def
, begin
, end
.
Note that some comments
(:nodoc:
, :yields:
, rubocop:disable
and rubocop:todo
)
and RBS::Inline annotation comments are allowed.
Autocorrection removes comments from end
keyword and keeps comments
for class
, module
, def
and begin
above the keyword.
Constant Summary
-
ALLOWED_COMMENTS =
Internal use only
# File 'lib/rubocop/cop/style/commented_keyword.rb', line 54%w[:nodoc: :yields:].freeze
-
ALLOWED_COMMENT_REGEXES =
# File 'lib/rubocop/cop/style/commented_keyword.rb', line 55(ALLOWED_COMMENTS.map { |c| /#\s*#{c}/ } + [DirectiveComment::DIRECTIVE_COMMENT_REGEXP]).freeze
-
KEYWORDS =
# File 'lib/rubocop/cop/style/commented_keyword.rb', line 51%w[begin class def end module].freeze
-
KEYWORD_REGEXES =
# File 'lib/rubocop/cop/style/commented_keyword.rb', line 52KEYWORDS.map { |w| /^\s*#{w}\s/ }.freeze
-
METHOD_DEFINITION =
# File 'lib/rubocop/cop/style/commented_keyword.rb', line 61/\A\s*def\s/.freeze
-
MSG =
# File 'lib/rubocop/cop/style/commented_keyword.rb', line 49'Do not place comments on the same line as the `%<keyword>s` keyword.'
-
REGEXP =
# File 'lib/rubocop/cop/style/commented_keyword.rb', line 58/(?<keyword>\S+).*#/.freeze
-
SUBCLASS_DEFINITION =
# File 'lib/rubocop/cop/style/commented_keyword.rb', line 60/\A\s*class\s+\w+\s*<\s*\w+/.freeze
::RuboCop::Cop::Base
- Inherited
EMPTY_OFFENSES, RESTRICT_ON_SEND
::RuboCop::Cop::RangeHelp
- Included
Class Attribute Summary
::RuboCop::Cop::AutoCorrector
- Extended
::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 |
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
::RuboCop::Cop::Base
- Inherited
::RuboCop::Cop::AutocorrectLogic
- Included
Instance Method Summary
- #on_new_investigation
- #offensive?(comment) ⇒ Boolean private
- #rbs_inline_annotation?(line, comment) ⇒ Boolean private
- #register_offense(comment, matched_keyword) private
- #source_line(comment) 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 |
#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
Constructor Details
This class inherits a constructor from RuboCop::Cop::Base
Instance Method Details
#offensive?(comment) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/commented_keyword.rb', line 86
def offensive?(comment) line = source_line(comment) return false if rbs_inline_annotation?(line, comment) KEYWORD_REGEXES.any? { |r| r.match?(line) } && ALLOWED_COMMENT_REGEXES.none? { |r| r.match?(line) } end
#on_new_investigation
[ GitHub ]# File 'lib/rubocop/cop/style/commented_keyword.rb', line 63
def on_new_investigation processed_source.comments.each do |comment| next unless offensive?(comment) && (match = source_line(comment).match(REGEXP)) register_offense(comment, match[:keyword]) end end
#rbs_inline_annotation?(line, comment) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/commented_keyword.rb', line 98
def rbs_inline_annotation?(line, comment) case line when SUBCLASS_DEFINITION comment.text.start_with?(/#\[.+\]/) when METHOD_DEFINITION comment.text.start_with?('#:') else false end end
#register_offense(comment, matched_keyword) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/commented_keyword.rb', line 73
def register_offense(comment, matched_keyword) add_offense(comment, message: format(MSG, keyword: matched_keyword)) do |corrector| range = range_with_surrounding_space(comment.source_range, newlines: false) corrector.remove(range) unless matched_keyword == 'end' corrector.insert_before( range.source_buffer.line_range(comment.loc.line), "#{comment.text}\n" ) end end end
#source_line(comment) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/commented_keyword.rb', line 94
def source_line(comment) comment.source_range.source_line end