123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Style::RedundantConstantBase

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:
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/style/redundant_constant_base.rb

Overview

Avoid redundant :: prefix on constant.

How Ruby searches constant is a bit complicated, and it can often be difficult to understand from the code whether the :: is intended or not. Where Module.nesting is empty, there is no need to prepend ::, so it would be nice to consistently avoid such meaningless :: prefix to avoid confusion.

Note
This cop is disabled if Lint/ConstantResolution cop is enabled to prevent conflicting rules. Because it respects user configurations that want to enable Lint/ConstantResolution cop which is disabled by default.

Examples:

# bad
::Const

# good
Const

# bad
class << self
  ::Const
end

# good
class << self
  Const
end

# good
class A
  ::Const
end

# good
module A
  ::Const
end

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

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

#lint_constant_resolution_cop_enabled?Boolean (readonly, private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/redundant_constant_base.rb', line 59

def lint_constant_resolution_cop_enabled?
  lint_constant_resolution_config.fetch('Enabled', false)
end

Instance Method Details

#bad?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/redundant_constant_base.rb', line 67

def bad?(node)
  module_nesting_ancestors_of(node).none?
end

#lint_constant_resolution_config (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/redundant_constant_base.rb', line 63

def lint_constant_resolution_config
  config.for_cop('Lint/ConstantResolution')
end

#module_nesting_ancestors_of(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/redundant_constant_base.rb', line 71

def module_nesting_ancestors_of(node)
  node.each_ancestor(:class, :module).reject do |ancestor|
    ancestor.class_type? && used_in_super_class_part?(node, class_node: ancestor)
  end
end

#on_cbase(node)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/redundant_constant_base.rb', line 48

def on_cbase(node)
  return if lint_constant_resolution_cop_enabled?
  return unless bad?(node)

  add_offense(node) do |corrector|
    corrector.remove(node)
  end
end

#used_in_super_class_part?(node, class_node:) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/redundant_constant_base.rb', line 77

def used_in_super_class_part?(node, class_node:)
  class_node.parent_class&.each_descendant(:cbase)&.any? do |descendant|
    descendant.equal?(node)
  end
end