123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::InternalAffairs::UndefinedConfig

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/internal_affairs/undefined_config.rb

Overview

Looks for references to a cop configuration key that isn’t defined in config/default.yml.

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

Class Attribute Summary

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

#config_for_cop (readonly, private)

[ GitHub ]

  
# File 'lib/rubocop/cop/internal_affairs/undefined_config.rb', line 49

attr_reader :config_for_cop, :cop_class_name

#cop_class_name (readonly, private)

[ GitHub ]

  
# File 'lib/rubocop/cop/internal_affairs/undefined_config.rb', line 49

attr_reader :config_for_cop, :cop_class_name

Instance Method Details

#always_allowed?(node) ⇒ Boolean (private)

[ GitHub ]

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

def always_allowed?(node)
  ALLOWED_CONFIGURATIONS.include?(node.value)
end

#configuration_key_defined?(node) ⇒ Boolean (private)

[ GitHub ]

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

def configuration_key_defined?(node)
  config_for_cop.key?(node.value)
end

#cop_class_def(node)

[ GitHub ]

  
# File 'lib/rubocop/cop/internal_affairs/undefined_config.rb', line 16

def_node_search :cop_class_def, <<~PATTERN
  (class _
    (const {nil? (const nil? :Cop) (const (const {cbase nil?} :RuboCop) :Cop)}
      {:Base :Cop}) ...)
PATTERN

#cop_config_accessor?(node)

[ GitHub ]

  
# File 'lib/rubocop/cop/internal_affairs/undefined_config.rb', line 23

def_node_matcher :cop_config_accessor?, <<~PATTERN
  (send (send nil? :cop_config) {:[] :fetch} ${str sym}...)
PATTERN

#extract_cop_name(class_node) (private)

[ GitHub ]

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

def extract_cop_name(class_node)
  return unless class_node

  segments = [class_node].concat(
    class_node.each_ancestor(:class, :module).take_while do |n|
      n.identifier.short_name != :Cop
    end
  )

  segments.reverse_each.map { |s| s.identifier.short_name }.join('/')
end

#on_new_investigation

[ GitHub ]

  
# File 'lib/rubocop/cop/internal_affairs/undefined_config.rb', line 27

def on_new_investigation
  super
  return unless processed_source.ast

  cop_class = cop_class_def(processed_source.ast).first
  return unless (@cop_class_name = extract_cop_name(cop_class))

  @config_for_cop = RuboCop::ConfigLoader.default_configuration.for_cop(@cop_class_name)
end

#on_send(node)

[ GitHub ]

  
# File 'lib/rubocop/cop/internal_affairs/undefined_config.rb', line 37

def on_send(node)
  return unless cop_class_name
  return unless (config_name_node = cop_config_accessor?(node))
  return if always_allowed?(config_name_node)
  return if configuration_key_defined?(config_name_node)

  message = format(MSG, name: config_name_node.value, cop: cop_class_name)
  add_offense(config_name_node, message: message)
end