Class: RuboCop::Cop::Lint::DeprecatedConstants

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

Overview

This cop checks for deprecated constants.

It has `DeprecatedConstants` config. If there is an alternative method, you can set alternative value as `Alternative`. And you can set the deprecated version as `DeprecatedVersion`. These options can be omitted if they are not needed.

DeprecatedConstants:
  'DEPRECATED_CONSTANT':
    Alternative: 'alternative_value'
    DeprecatedVersion: 'deprecated_version'

By default, `NIL`, `TRUE`, `FALSE` and `Random::DEFAULT` are configured.

Examples:


# bad
NIL
TRUE
FALSE
Random::DEFAULT # Return value of Ruby 2 is `Random` instance, Ruby 3.0 is `Random` class.

# good
nil
true
false
Random.new # `::DEFAULT` has been deprecated in Ruby 3, `.new` is compatible with Ruby 2.

Constant Summary collapse

SUGGEST_GOOD_MSG =
'Use `%<good>s` instead of `%<bad>s`%<deprecated_message>s.'
DO_NOT_USE_MSG =
'Do not use `%<bad>s`%<deprecated_message>s.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#add_global_offense, #add_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, joining_forces, lint?, match?, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #ready, #relevant_file?, 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?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from 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_const(node) ⇒ Object


39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# File 'lib/rubocop/cop/lint/deprecated_constants.rb', line 39

def on_const(node)
  # FIXME: Workaround for "`undefined method `expression' for nil:NilClass`" when processing
  #        `__ENCODING__`. It is better to be able to work without this condition.
  #        Maybe further investigation of RuboCop AST will lead to an essential solution.
  return unless node.loc

  constant = node.absolute? ? constant_name(node, node.short_name.to_s) : node.source
  return unless (deprecated_constant = deprecated_constants[constant])

  alternative = deprecated_constant['Alternative']
  version = deprecated_constant['DeprecatedVersion']

  add_offense(node, message: message(alternative, node.source, version)) do |corrector|
    corrector.replace(node, alternative)
  end
end