Class: RuboCop::Cop::Cop

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

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



40
41
42

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

def registry
  @registry
end

Instance Attribute Details

#config ⇒ `Object` (readonly)

Returns the value of attribute config



34
35
36

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

def config
  @config
end

#corrections ⇒ `Object` (readonly)

Returns the value of attribute corrections



34
35
36

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

def corrections
  @corrections
end

#offenses ⇒ `Object` (readonly)

Returns the value of attribute offenses



34
35
36

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

def offenses
  @offenses
end

#processed_source ⇒ `Object`

TODO: Bad design.



35
36
37

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

def processed_source
  @processed_source
end

Class Method Details

.all ⇒ `Object`



43
44
45

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

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



90
91
92

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

def self.autocorrect_incompatible_with
  []
end

.badge ⇒ `Object`



59
60
61

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

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

.cop_name ⇒ `Object`



63
64
65

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

def self.cop_name
  badge.to_s
end

.department ⇒ `Object`



67
68
69

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

def self.department
  badge.department
end

.inherited(subclass) ⇒ `Object`



55
56
57

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

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

.lint? ⇒ `Boolean`



71
72
73

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

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.

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

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

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

.non_rails ⇒ `Object`



51
52
53

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

def self.non_rails
  registry.without_department(:Rails)
end

.qualified_cop_name(name, origin) ⇒ `Object`



47
48
49

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

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`

rubocop:disable Metrics/CyclomaticComplexity

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

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

  return if duplicate_location?(loc)

  severity = custom_severity || severity || default_severity

  message ||= message(node)
  message = annotate(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 160

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 165

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 109

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



182
183
184

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

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

#correct(node) ⇒ `Object`

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

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

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

  @corrections << correction
  :corrected
end

#duplicate_location?(location) ⇒ `Boolean`



143
144
145

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

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

#excluded_file?(file) ⇒ `Boolean`



193
194
195

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

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

#find_location(node, loc) ⇒ `Object`

rubocop:enable Metrics/CyclomaticComplexity

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

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`



83
84
85

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

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

#join_force?(_force_class) ⇒ `Boolean`



105
106
107

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

def join_force?(_force_class)
  false
end

#message(_node = nil) ⇒ `Object`



116
117
118

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

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

#messages ⇒ `Object`



79
80
81

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

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

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



178
179
180

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

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

#relevant_file?(file) ⇒ `Boolean`

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

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

#target_rails_version ⇒ `Object`



174
175
176

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

def target_rails_version
  @config.target_rails_version
end

#target_ruby_version ⇒ `Object`



170
171
172

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

def target_ruby_version
  @config.target_ruby_version
end

Class: RuboCop::Cop::Cop

Overview

Direct Known Subclasses

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

Methods included from AST::Sexp

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

.non_rails ⇒ Object

.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

#duplicate_location?(location) ⇒ Boolean

#excluded_file?(file) ⇒ Boolean

#find_location(node, loc) ⇒ Object

#highlights ⇒ Object

#join_force?(_force_class) ⇒ Boolean

#message(_node = nil) ⇒ Object

#messages ⇒ Object

#parse(source, path = nil) ⇒ Object

#relevant_file?(file) ⇒ Boolean

#target_rails_version ⇒ Object

#target_ruby_version ⇒ Object

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