Class: RuboCop::Cop::Cop

Inherits:
Base
  • Object
show all
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.

Defined Under Namespace

Classes: Correction

Constant Summary

Constants inherited from Base

Base::RESTRICT_ON_SEND

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary collapse

Attributes inherited from Base

#config, #processed_source

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#add_global_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, lint?, match?, #message, #on_other_file, #ready, #relevant_file?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from AutocorrectLogic

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

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

add_parentheses, args_begin, args_end, begins_its_line?, comment_line?, comment_lines?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, hidden_dir?, hidden_file?, hidden_file_in_not_hidden_dir?, match_path?, maybe_hidden_file?, relative_path, smart_path

Constructor Details

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

Instance Attribute Details

#offensesObject (readonly)

Returns the value of attribute offenses


12
13
14
# File 'lib/rubocop/cop/cop.rb', line 12

def offenses
  @offenses
end

Class Method Details

.allObject

Deprecated.

Use Registry.all


91
92
93
# File 'lib/rubocop/cop/cop.rb', line 91

def self.all
  Registry.all
end

.joining_forcesObject


54
55
56
57
58
59
60
61
# File 'lib/rubocop/cop/cop.rb', line 54

def self.joining_forces
  return unless method_defined?(:join_force?)

  cop = new
  Force.all.select do |force_class|
    cop.join_force?(force_class)
  end
end

.qualified_cop_name(name, origin) ⇒ Object

Deprecated.

Use Registry.qualified_cop_name


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

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

.registryObject

Deprecated.

Use Registry.global


86
87
88
# File 'lib/rubocop/cop/cop.rb', line 86

def self.registry
  Registry.global
end

.support_autocorrect?Boolean

Returns:

  • (Boolean)

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

def self.support_autocorrect?
  method_defined?(:autocorrect)
end

Instance Method Details

#add_offense(node_or_range, location: :expression, message: nil, severity: nil, &block) ⇒ Object


27
28
29
30
31
32
33
34
35
36
37
# File 'lib/rubocop/cop/cop.rb', line 27

def add_offense(node_or_range, location: :expression, message: nil, severity: nil, &block)
  @v0_argument = node_or_range
  range = find_location(node_or_range, location)
  if block.nil? && !autocorrect?
    super(range, message: message, severity: severity)
  else
    super(range, message: message, severity: severity) do |corrector|
      emulate_v0_callsequence(corrector, &block)
    end
  end
end

#correctionsObject

Deprecated.

64
65
66
67
68
69
# File 'lib/rubocop/cop/cop.rb', line 64

def corrections
  # warn 'Cop#corrections is deprecated' TODO
  return [] unless @last_corrector

  Legacy::CorrectionsProxy.new(@last_corrector)
end

#find_location(node, loc) ⇒ Object


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

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

#highlightsObject


69
70
71
# File 'lib/rubocop/rspec/cop_helper.rb', line 69

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

#messagesObject


65
66
67
# File 'lib/rubocop/rspec/cop_helper.rb', line 65

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

#on_investigation_endObject

Called after all on_… have been called


78
79
80
81
# File 'lib/rubocop/cop/cop.rb', line 78

def on_investigation_end
  investigate_post_walk(processed_source) if respond_to?(:investigate_post_walk)
  super
end

#on_new_investigationObject

Called before all on_… have been called


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

def on_new_investigation
  investigate(processed_source) if respond_to?(:investigate)
  super
end

#parse(source, path = nil) ⇒ Object

Deprecated.

Open issue if there's a valid use case to include this in Base


102
103
104
# File 'lib/rubocop/cop/cop.rb', line 102

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

#support_autocorrect?Boolean

Deprecated.

Use class method

Returns:

  • (Boolean)

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

def support_autocorrect?
  # warn 'deprecated, use cop.class.support_autocorrect?' TODO
  self.class.support_autocorrect?
end