Class: RuboCop::Cop::Lint::DeprecatedConstants
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
::RuboCop::Cop::AutoCorrector ,
::RuboCop::Cop::Base ,
::RuboCop::ExcludeLimit ,
NodePattern::Macros,
RuboCop::AST::Sexp
|
|
Instance Chain:
self,
::RuboCop::Cop::Base ,
::RuboCop::Cop::AutocorrectLogic ,
::RuboCop::Cop::IgnoredNode ,
::RuboCop::Util ,
RuboCop::AST::Sexp
|
|
Inherits: |
RuboCop::Cop::Base
|
Defined in: | lib/rubocop/cop/lint/deprecated_constants.rb |
Overview
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
, `Net::HTTPServerException, Random::DEFAULT
,
Struct::Group
, and Struct::Passwd
are configured.
Constant Summary
-
DO_NOT_USE_MSG =
# File 'lib/rubocop/cop/lint/deprecated_constants.rb', line 44'Do not use `%<bad>s`%<deprecated_message>s.'
-
SUGGEST_GOOD_MSG =
# File 'lib/rubocop/cop/lint/deprecated_constants.rb', line 43'Use `%<good>s` instead of `%<bad>s`%<deprecated_message>s.'
::RuboCop::Cop::Base
- Inherited
Class Attribute Summary
::RuboCop::Cop::AutoCorrector
- Extended
::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 |
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 a 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
::RuboCop::Cop::Base
- Inherited
::RuboCop::Cop::AutocorrectLogic
- Included
Instance Method Summary
- #on_const(node)
- #constant_name(node, nested_constant_name) private
- #deprecated_constants private
- #message(good, bad, deprecated_version) private
::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 |
#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
#disable_offense, #disable_offense_at_end_of_line, #disable_offense_before_and_after, #disable_offense_with_eol_or_surround_comment, #heredoc_range, #max_line_length, #multiline_ranges, #multiline_string?, | |
#range_by_lines | Expand the given range to include all of any lines it covers. |
#range_of_first_line, #range_overlaps_offense?, #string_continuation?, #surrounding_heredoc?, #surrounding_percent_array? |
::RuboCop::Cop::IgnoredNode
- Included
Constructor Details
This class inherits a constructor from RuboCop::Cop::Base
Instance Method Details
#constant_name(node, nested_constant_name) (private)
[ GitHub ]# File 'lib/rubocop/cop/lint/deprecated_constants.rb', line 66
def constant_name(node, nested_constant_name) return nested_constant_name.to_s unless node.namespace.const_type? constant_name(node.namespace, "#{node.namespace.short_name}::#{nested_constant_name}") end
#deprecated_constants (private)
[ GitHub ]# File 'lib/rubocop/cop/lint/deprecated_constants.rb', line 82
def deprecated_constants cop_config.fetch('DeprecatedConstants', {}) end
#message(good, bad, deprecated_version) (private)
[ GitHub ]# File 'lib/rubocop/cop/lint/deprecated_constants.rb', line 72
def (good, bad, deprecated_version) = ", deprecated since Ruby #{deprecated_version}" if deprecated_version if good format(SUGGEST_GOOD_MSG, good: good, bad: bad, deprecated_message: ) else format(DO_NOT_USE_MSG, bad: bad, deprecated_message: ) end end
#on_const(node)
[ GitHub ]# File 'lib/rubocop/cop/lint/deprecated_constants.rb', line 46
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) : node.source return unless (deprecated_constant = deprecated_constants[constant]) alternative = deprecated_constant['Alternative'] version = deprecated_constant['DeprecatedVersion'] return if target_ruby_version < version.to_f add_offense(node, message: (alternative, node.source, version)) do |corrector| corrector.replace(node, alternative) end end