Class: RuboCop::Cop::Lint::UselessConstantScoping

Inherits:
Base
  • Object
show all
Defined in:
lib/rubocop/cop/lint/useless_constant_scoping.rb

Overview

Checks for useless constant scoping. Private constants must be defined using ‘private_constant`. Even if `private` access modifier is used, it is public scope despite its appearance.

It does not support autocorrection due to behavior change and multiple ways to fix it. Or a public constant may be intended.

Examples:


# bad
class Foo
  private
  PRIVATE_CONST = 42
end

# good
class Foo
  PRIVATE_CONST = 42
  private_constant :PRIVATE_CONST
end

# good
class Foo
  PUBLIC_CONST = 42 # If private scope is not intended.
end

Constant Summary collapse

MSG = 
'Useless `private` access modifier for constant scope.'

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_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 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_casgn(node) ⇒ Object 


40
41
42
43
44
45
 
# File 'lib/rubocop/cop/lint/useless_constant_scoping.rb', line 40

def on_casgn(node)
  return unless after_private_modifier?(node.left_siblings)
  return if private_constantize?(node.right_siblings, node.name)

  add_offense(node)
end

#private_constants(node) ⇒ Object 


36
37
38
 
# File 'lib/rubocop/cop/lint/useless_constant_scoping.rb', line 36

def_node_matcher :private_constants, <<~PATTERN
  (send nil? :private_constant $...)
PATTERN