Class: RuboCop::Cop::InternalAffairs::CopEnabled

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Defined in:
lib/rubocop/cop/internal_affairs/cop_enabled.rb

Overview

Use ‘config.cop_enabled?(’Department/CopName’)‘ instead of traversing the config hash.

Examples:

# `for_cop(...)['Enabled']

# bad
config.for_cop('Department/CopName')['Enabled']

# good
config.cop_enabled?('Department/CopName')
# when keeping a cop's config in a local and then checking the `Enabled` key

# bad
cop_config = config.for_cop('Department/CopName')
cop_config['Enabled'] && cop_config['Foo']

# good
config.for_enabled_cop('Department/CopName')['Foo']

Constant Summary collapse

MSG = 
'Use `%<replacement>s` instead of `%<source>s`.'
MSG_HASH = 
'Consider replacing uses of `%<hash_name>s` with `config.for_enabled_cop`.'
RESTRICT_ON_SEND = 
[:[]].freeze

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_gem_version, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

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

Methods included from RuboCop::Cop::IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#config_enabled_lookup?(node) ⇒ Object

[View source]

46
47
48
49
50
 
# File 'lib/rubocop/cop/internal_affairs/cop_enabled.rb', line 46

def_node_matcher :config_enabled_lookup?, <<~PATTERN
  (send
    {(lvar $_) (ivar $_) (send nil? $_)} :[]
    (str "Enabled"))
PATTERN

#for_cop_enabled?(node) ⇒ Object

[View source]

37
38
39
40
41
42
43
 
# File 'lib/rubocop/cop/internal_affairs/cop_enabled.rb', line 37

def_node_matcher :for_cop_enabled?, <<~PATTERN
  (send
    (send
      ${(send nil? :config) (ivar :@config)} :for_cop
      $(str _)) :[]
    (str "Enabled"))
PATTERN

#on_send(node) ⇒ Object

[View source]

52
53
54
55
56
57
58
59
60
 
# File 'lib/rubocop/cop/internal_affairs/cop_enabled.rb', line 52

def on_send(node)
  if (config_var, cop_name = for_cop_enabled?(node))
    handle_for_cop(node, config_var, cop_name)
  elsif (config_var = config_enabled_lookup?(node))
    return unless config_var.end_with?('_config')

    handle_hash(node, config_var)
  end
end