Class: RuboCop::Cop::Cop

Inherits:

Object

Object
RuboCop::Cop::Cop

show all

Extended by:: NodePattern::Macros, AST::Sexp

Includes:: AST::Sexp, AutocorrectLogic, IgnoredNode, Util

Defined in:: lib/rubocop/cop/cop.rb,
lib/rubocop/rspec/cop_helper.rb

Overview

Monkey-patch Cop for tests to provide easy access to messages and highlights.

Direct Known Subclasses

Defined Under Namespace

Classes: Correction

Constant Summary

Constants included from Util

Util::LITERAL_REGEX

Class Attribute Summary collapse

.registry ⇒ Object readonly

Returns the value of attribute registry.

Instance Attribute Summary collapse

#config ⇒ Object readonly

Returns the value of attribute config.
#corrections ⇒ Object readonly

Returns the value of attribute corrections.
#offenses ⇒ Object readonly

Returns the value of attribute offenses.
#processed_source ⇒ Object

TODO: Bad design.

Class Method Summary collapse

.all ⇒ Object
.autocorrect_incompatible_with ⇒ Array<RuboCop::Cop::Cop>

List of cops that should not try to autocorrect at the same time as this cop.
.badge ⇒ Object
.cop_name ⇒ Object
.department ⇒ Object
.inherited(subclass) ⇒ Object
.lint? ⇒ Boolean
.match?(given_names) ⇒ Boolean

Returns true if the cop name or the cop namespace matches any of the given names.
.qualified_cop_name(name, origin) ⇒ Object

Instance Method Summary collapse

#add_offense(node, location: :expression, message: nil, severity: nil) ⇒ Object
#config_to_allow_offenses ⇒ Object
#config_to_allow_offenses=(hash) ⇒ Object
#cop_config ⇒ Object
#cop_name ⇒ Object (also: #name)
#correct(node) ⇒ Object
#disable_uncorrectable(node) ⇒ Object
#duplicate_location?(location) ⇒ Boolean
#excluded_file?(file) ⇒ Boolean
#external_dependency_checksum ⇒ Object

This method should be overridden when a cop's behavior depends on state that lives outside of these locations:.
#find_location(node, loc) ⇒ Object
#highlights ⇒ Object
#initialize(config = nil, options = nil) ⇒ Cop constructor

A new instance of Cop.
#join_force?(_force_class) ⇒ Boolean
#message(_node = nil) ⇒ Object
#messages ⇒ Object
#parse(source, path = nil) ⇒ Object
#reason_to_not_correct(node) ⇒ Object
#relevant_file?(file) ⇒ Boolean
#target_rails_version ⇒ Object
#target_ruby_version ⇒ Object

Constructor Details

#initialize(config = nil, options = nil) ⇒ `Cop`

Returns a new instance of Cop.

# File 'lib/rubocop/cop/cop.rb', line 100

def initialize(config = nil, options = nil)
  @config = config || Config.new
  @options = options || { debug: false }

  @offenses = []
  @corrections = []
  @corrected_nodes = {}
  @corrected_nodes.compare_by_identity
  @processed_source = nil
end

Class Attribute Details

.registry ⇒ `Object` (readonly)

Returns the value of attribute registry


50
51
52

# File 'lib/rubocop/cop/cop.rb', line 50

def registry
  @registry
end

Instance Attribute Details

#config ⇒ `Object` (readonly)

Returns the value of attribute config


44
45
46

# File 'lib/rubocop/cop/cop.rb', line 44

def config
  @config
end

#corrections ⇒ `Object` (readonly)

Returns the value of attribute corrections


44
45
46

# File 'lib/rubocop/cop/cop.rb', line 44

def corrections
  @corrections
end

#offenses ⇒ `Object` (readonly)

Returns the value of attribute offenses


44
45
46

# File 'lib/rubocop/cop/cop.rb', line 44

def offenses
  @offenses
end

#processed_source ⇒ `Object`

TODO: Bad design.


45
46
47

# File 'lib/rubocop/cop/cop.rb', line 45

def processed_source
  @processed_source
end

Class Method Details

.all ⇒ `Object`


53
54
55

# File 'lib/rubocop/cop/cop.rb', line 53

def self.all
  registry.without_department(:Test).cops
end

.autocorrect_incompatible_with ⇒ `Array<RuboCop::Cop::Cop>`

List of cops that should not try to autocorrect at the same time as this cop

Returns:

(Array<RuboCop::Cop::Cop>)


96
97
98

# File 'lib/rubocop/cop/cop.rb', line 96

def self.autocorrect_incompatible_with
  []
end

.badge ⇒ `Object`


65
66
67

# File 'lib/rubocop/cop/cop.rb', line 65

def self.badge
  @badge ||= Badge.for(name)
end

.cop_name ⇒ `Object`


69
70
71

# File 'lib/rubocop/cop/cop.rb', line 69

def self.cop_name
  badge.to_s
end

.department ⇒ `Object`


73
74
75

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

def self.department
  badge.department
end

.inherited(subclass) ⇒ `Object`


61
62
63

# File 'lib/rubocop/cop/cop.rb', line 61

def self.inherited(subclass)
  registry.enlist(subclass)
end

.lint? ⇒ `Boolean`

Returns:

(Boolean)


77
78
79

# File 'lib/rubocop/cop/cop.rb', line 77

def self.lint?
  department == :Lint
end

.match?(given_names) ⇒ `Boolean`

Returns true if the cop name or the cop namespace matches any of the given names.

Returns:

(Boolean)

# File 'lib/rubocop/cop/cop.rb', line 83

def self.match?(given_names)
  return false unless given_names

  given_names.include?(cop_name) ||
    given_names.include?(department.to_s)
end

.qualified_cop_name(name, origin) ⇒ `Object`


57
58
59

# File 'lib/rubocop/cop/cop.rb', line 57

def self.qualified_cop_name(name, origin)
  registry.qualified_cop_name(name, origin)
end

Instance Method Details

#add_offense(node, location: :expression, message: nil, severity: nil) ⇒ `Object`

# File 'lib/rubocop/cop/cop.rb', line 126

def add_offense(node, location: :expression, message: nil, severity: nil)
  loc = find_location(node, location)

  return if duplicate_location?(loc)

  severity = find_severity(node, severity)
  message = find_message(node, message)

  status = enabled_line?(loc.line) ? correct(node) : :disabled

  @offenses << Offense.new(severity, loc, message, name, status)
  yield if block_given? && status != :disabled
end

#config_to_allow_offenses ⇒ `Object`

# File 'lib/rubocop/cop/cop.rb', line 185

def config_to_allow_offenses
  Formatter::DisabledConfigFormatter
    .config_to_allow_offenses[cop_name] ||= {}
end

#config_to_allow_offenses=(hash) ⇒ `Object`

# File 'lib/rubocop/cop/cop.rb', line 190

def config_to_allow_offenses=(hash)
  Formatter::DisabledConfigFormatter.config_to_allow_offenses[cop_name] =
    hash
end

#cop_config ⇒ `Object`

# File 'lib/rubocop/cop/cop.rb', line 115

def cop_config
  # Use department configuration as basis, but let individual cop
  # configuration override.
  @cop_config ||= @config.for_cop(self.class.department.to_s)
                         .merge(@config.for_cop(self))
end

#cop_name ⇒ `Object` Also known as: name


207
208
209

# File 'lib/rubocop/cop/cop.rb', line 207

def cop_name
  @cop_name ||= self.class.cop_name
end

#correct(node) ⇒ `Object`

# File 'lib/rubocop/cop/cop.rb', line 149

def correct(node)
  reason = reason_to_not_correct(node)
  return reason if reason

  @corrected_nodes[node] = true
  if support_autocorrect?
    correction = autocorrect(node)
    return :uncorrected unless correction

    @corrections << Correction.new(correction, node, self)
    :corrected
  elsif disable_uncorrectable?
    disable_uncorrectable(node)
    :corrected_with_todo
  end
end

#disable_uncorrectable(node) ⇒ `Object`

# File 'lib/rubocop/cop/cop.rb', line 174

def disable_uncorrectable(node)
  return unless node

  @disabled_lines ||= {}
  line = node.location.line
  return if @disabled_lines.key?(line)

  @disabled_lines[line] = true
  @corrections << Correction.new(disable_offense(node), node, self)
end

#duplicate_location?(location) ⇒ `Boolean`

Returns:

(Boolean)


145
146
147

# File 'lib/rubocop/cop/cop.rb', line 145

def duplicate_location?(location)
  @offenses.any? { |o| o.location == location }
end

#excluded_file?(file) ⇒ `Boolean`

Returns:

(Boolean)


218
219
220

# File 'lib/rubocop/cop/cop.rb', line 218

def excluded_file?(file)
  !relevant_file?(file)
end

#external_dependency_checksum ⇒ `Object`

This method should be overridden when a cop's behavior depends on state that lives outside of these locations:

(1) the file under inspection
(2) the cop's source code
(3) the config (eg a .rubocop.yml file)

For example, some cops may want to look at other parts of the codebase being inspected to find violations. A cop may use the presence or absence of file `foo.rb` to determine whether a certain violation exists in `bar.rb`.

Overriding this method allows the cop to indicate to RuboCop's ResultCache system when those external dependencies change, ie when the ResultCache should be invalidated.


237
238
239

# File 'lib/rubocop/cop/cop.rb', line 237

def external_dependency_checksum
  nil
end

#find_location(node, loc) ⇒ `Object`

# File 'lib/rubocop/cop/cop.rb', line 140

def find_location(node, loc)
  # Location can be provided as a symbol, e.g.: `:keyword`
  loc.is_a?(Symbol) ? node.loc.public_send(loc) : loc
end

#highlights ⇒ `Object`


87
88
89

# File 'lib/rubocop/rspec/cop_helper.rb', line 87

def highlights
  offenses.sort.map { |o| o.location.source }
end

#join_force?(_force_class) ⇒ `Boolean`

Returns:

(Boolean)


111
112
113

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

def join_force?(_force_class)
  false
end

#message(_node = nil) ⇒ `Object`


122
123
124

# File 'lib/rubocop/cop/cop.rb', line 122

def message(_node = nil)
  self.class::MSG
end

#messages ⇒ `Object`


83
84
85

# File 'lib/rubocop/rspec/cop_helper.rb', line 83

def messages
  offenses.sort.map(&:message)
end

#parse(source, path = nil) ⇒ `Object`


203
204
205

# File 'lib/rubocop/cop/cop.rb', line 203

def parse(source, path = nil)
  ProcessedSource.new(source, target_ruby_version, path)
end

#reason_to_not_correct(node) ⇒ `Object`

# File 'lib/rubocop/cop/cop.rb', line 166

def reason_to_not_correct(node)
  return :unsupported unless correctable?
  return :uncorrected unless autocorrect?
  return :already_corrected if @corrected_nodes.key?(node)

  nil
end

#relevant_file?(file) ⇒ `Boolean`

Returns:

(Boolean)

# File 'lib/rubocop/cop/cop.rb', line 213

def relevant_file?(file)
  file_name_matches_any?(file, 'Include', true) &&
    !file_name_matches_any?(file, 'Exclude', false)
end

#target_rails_version ⇒ `Object`


199
200
201

# File 'lib/rubocop/cop/cop.rb', line 199

def target_rails_version
  @config.target_rails_version
end

#target_ruby_version ⇒ `Object`


195
196
197

# File 'lib/rubocop/cop/cop.rb', line 195

def target_ruby_version
  @config.target_ruby_version
end

Class: RuboCop::Cop::Cop

Overview

Direct Known Subclasses

Defined Under Namespace

Constant Summary

Constants included from Util

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from AutocorrectLogic

Methods included from IgnoredNode

Methods included from Util

Methods included from PathUtil

Constructor Details

#initialize(config = nil, options = nil) ⇒ Cop

Class Attribute Details

.registry ⇒ Object (readonly)

Instance Attribute Details

#config ⇒ Object (readonly)

#corrections ⇒ Object (readonly)

#offenses ⇒ Object (readonly)

#processed_source ⇒ Object

Class Method Details

.all ⇒ Object

.autocorrect_incompatible_with ⇒ Array<RuboCop::Cop::Cop>

.badge ⇒ Object

.cop_name ⇒ Object

.department ⇒ Object

.inherited(subclass) ⇒ Object

.lint? ⇒ Boolean

.match?(given_names) ⇒ Boolean

.qualified_cop_name(name, origin) ⇒ Object

Instance Method Details

#add_offense(node, location: :expression, message: nil, severity: nil) ⇒ Object

#config_to_allow_offenses ⇒ Object

#config_to_allow_offenses=(hash) ⇒ Object

#cop_config ⇒ Object

#cop_name ⇒ Object Also known as: name

#correct(node) ⇒ Object

#disable_uncorrectable(node) ⇒ Object

#duplicate_location?(location) ⇒ Boolean

#excluded_file?(file) ⇒ Boolean

#external_dependency_checksum ⇒ Object

#find_location(node, loc) ⇒ Object

#highlights ⇒ Object

#join_force?(_force_class) ⇒ Boolean

#message(_node = nil) ⇒ Object

#messages ⇒ Object

#parse(source, path = nil) ⇒ Object

#reason_to_not_correct(node) ⇒ Object

#relevant_file?(file) ⇒ Boolean

#target_rails_version ⇒ Object

#target_ruby_version ⇒ Object

#initialize(config = nil, options = nil) ⇒ `Cop`

.registry ⇒ `Object` (readonly)

#config ⇒ `Object` (readonly)

#corrections ⇒ `Object` (readonly)

#offenses ⇒ `Object` (readonly)

#processed_source ⇒ `Object`

.all ⇒ `Object`

.autocorrect_incompatible_with ⇒ `Array<RuboCop::Cop::Cop>`

.badge ⇒ `Object`

.cop_name ⇒ `Object`

.department ⇒ `Object`

.inherited(subclass) ⇒ `Object`

.lint? ⇒ `Boolean`

.match?(given_names) ⇒ `Boolean`

.qualified_cop_name(name, origin) ⇒ `Object`

#add_offense(node, location: :expression, message: nil, severity: nil) ⇒ `Object`

#config_to_allow_offenses ⇒ `Object`

#config_to_allow_offenses=(hash) ⇒ `Object`

#cop_config ⇒ `Object`

#cop_name ⇒ `Object` Also known as: name

#correct(node) ⇒ `Object`

#disable_uncorrectable(node) ⇒ `Object`

#duplicate_location?(location) ⇒ `Boolean`

#excluded_file?(file) ⇒ `Boolean`

#external_dependency_checksum ⇒ `Object`

#find_location(node, loc) ⇒ `Object`

#highlights ⇒ `Object`

#join_force?(_force_class) ⇒ `Boolean`

#message(_node = nil) ⇒ `Object`

#messages ⇒ `Object`

#parse(source, path = nil) ⇒ `Object`

#reason_to_not_correct(node) ⇒ `Object`

#relevant_file?(file) ⇒ `Boolean`

#target_rails_version ⇒ `Object`

#target_ruby_version ⇒ `Object`