Class: RuboCop::Cop::InternalAffairs::InheritDeprecatedCopClass

Inherits:
Base
  • Object
show all
Defined in:
lib/rubocop/cop/internal_affairs/inherit_deprecated_cop_class.rb

Overview

‘RuboCop::Cop::Cop` is deprecated and will be removed in RuboCop 2.0. Your custom cop class should inherit from `RuboCop::Cop::Base` instead of `RuboCop::Cop::Cop`.

See “v1 Upgrade Notes” for more details: docs.rubocop.org/rubocop/v1_upgrade_notes.html

Examples:

# bad
class Foo < Cop
end

# good
class Foo < Base
end

Constant Summary collapse

MSG = 
'Use `Base` instead of `Cop`.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

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_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

#on_class(node) ⇒ Object 



25
26
27
28
29
30
 
# File 'lib/rubocop/cop/internal_affairs/inherit_deprecated_cop_class.rb', line 25

def on_class(node)
  return unless (parent_class = node.parent_class)
  return unless parent_class.children.last == :Cop

  add_offense(parent_class)
end