123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::InternalAffairs::CopDescription

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:
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/internal_affairs/cop_description.rb

Overview

Enforces the cop description to start with a word such as verb.

Examples:

# bad
# This cop checks ....
class SomeCop < Base
  ....
end

# bad
#
# Checks ...
class SomeCop < Base
  ...
end

# good
# Checks ...
class SomeCop < Base
  ...
end

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

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 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 an 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

Instance Method Summary

::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

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

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

Instance Method Details

#comment_body(comment_line) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/internal_affairs/cop_description.rb', line 107

def comment_body(comment_line)
  comment_line.gsub(/^\s*# /, '')
end

#comment_index(node, comment_line) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/internal_affairs/cop_description.rb', line 111

def comment_index(node, comment_line)
  body = comment_body(comment_line)
  node.source.index(body)
end

#first_comment_line(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/internal_affairs/cop_description.rb', line 103

def first_comment_line(node)
  node.source.lines.find { |line| comment_line?(line) }
end

#on_class(node)

[ GitHub ]

  
# File 'lib/rubocop/cop/internal_affairs/cop_description.rb', line 42

def on_class(node)
  return unless (module_node = node.parent) && node.parent_class

  description_beginning = first_comment_line(module_node)
  return unless description_beginning

  if description_beginning.match?(EMPTY_COMMENT_LINE_REGEX)
    register_offense_for_empty_comment_line(module_node, description_beginning)
  else
    start_with_subject = description_beginning.match(COP_DESC_OFFENSE_REGEX)
    return unless start_with_subject

    register_offense_for_wrong_word(module_node, description_beginning, start_with_subject)
  end
end

#range(node, comment_line) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/internal_affairs/cop_description.rb', line 85

def range(node, comment_line)
  source_buffer = node.source_range.source_buffer

  begin_pos = node.source_range.begin_pos
  begin_pos += comment_index(node, comment_line)
  end_pos = begin_pos + comment_body(comment_line).length

  Parser::Source::Range.new(source_buffer, begin_pos, end_pos)
end

#register_offense_for_empty_comment_line(module_node, description_beginning) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/internal_affairs/cop_description.rb', line 60

def register_offense_for_empty_comment_line(module_node, description_beginning)
  range = range(module_node, description_beginning)
  add_offense(range, message: MSG_STARTS_WITH_EMPTY_COMMENT_LINE) do |corrector|
    corrector.remove(range)
  end
end

#register_offense_for_wrong_word(module_node, description_beginning, start_with_subject) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/internal_affairs/cop_description.rb', line 67

def register_offense_for_wrong_word(module_node, description_beginning, start_with_subject)
  suggestion = start_with_subject['word']&.capitalize
  range = range(module_node, description_beginning)
  suggestion_for_message = suggestion_for_message(suggestion, start_with_subject)
  message = format(MSG_STARTS_WITH_WRONG_WORD, suggestion: suggestion_for_message)

  add_offense(range, message: message) do |corrector|
    if suggestion && !start_with_subject['special']
      replace_with_suggestion(corrector, range, suggestion, description_beginning)
    end
  end
end

#relevant_file?(file) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/internal_affairs/cop_description.rb', line 116

def relevant_file?(file)
  file.match?(%r{/cop/.*\.rb\z})
end

#replace_with_suggestion(corrector, range, suggestion, description_beginning) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/internal_affairs/cop_description.rb', line 80

def replace_with_suggestion(corrector, range, suggestion, description_beginning)
  replacement = description_beginning.gsub(REPLACEMENT_REGEX, "#{suggestion} ")
  corrector.replace(range, replacement)
end

#suggestion_for_message(suggestion, match_data) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/internal_affairs/cop_description.rb', line 95

def suggestion_for_message(suggestion, match_data)
  if suggestion && !match_data['special']
    "`#{suggestion}`"
  else
    'a word such as verb'
  end
end