123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Style::ConstantVisibility

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/style/constant_visibility.rb

Overview

Checks that constants defined in classes and modules have an explicit visibility declaration. By default, Ruby makes all class- and module constants public, which litters the public API of the class or module. Explicitly declaring a visibility makes intent more clear, and prevents outside actors from touching private state.

Examples:

# bad
class Foo
  BAR = 42
  BAZ = 43
end

# good
class Foo
  BAR = 42
  private_constant :BAR

  BAZ = 43
  public_constant :BAZ
end

IgnoreModules: false (default)

# bad
class Foo
  MyClass = Struct.new()
end

# good
class Foo
  MyClass = Struct.new()
  public_constant :MyClass
end

IgnoreModules: true

# good
class Foo
  MyClass = Struct.new()
end

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

Class Attribute Summary

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

#ignore_modules?Boolean (readonly, private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/constant_visibility.rb', line 62

def ignore_modules?
  cop_config.fetch('IgnoreModules', false)
end

Instance Method Details

#class_or_module_scope?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/constant_visibility.rb', line 76

def class_or_module_scope?(node)
  return false unless node.parent

  case node.parent.type
  when :begin
    class_or_module_scope?(node.parent)
  when :class, :module
    true
  end
end

#match_name?(name, constant_name) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/constant_visibility.rb', line 100

def match_name?(name, constant_name)
  name.to_sym == constant_name.to_sym
end

#message(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/constant_visibility.rb', line 70

def message(node)
  _namespace, constant_name, _value = *node

  format(MSG, constant_name: constant_name)
end

#module?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/constant_visibility.rb', line 66

def module?(node)
  node.children.last.class_constructor?
end

#on_casgn(node)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/constant_visibility.rb', line 51

def on_casgn(node)
  return unless class_or_module_scope?(node)
  return if visibility_declaration?(node)
  return if ignore_modules? && module?(node)

  message = message(node)
  add_offense(node, message: message)
end

#visibility_declaration?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/constant_visibility.rb', line 87

def visibility_declaration?(node)
  _namespace, constant_name, _value = *node

  node.parent.each_child_node(:send).any? do |child|
    visibility_declaration_for?(child, constant_name)
  end
end

#visibility_declaration_for?(node, const_name) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/constant_visibility.rb', line 96

def_node_matcher :visibility_declaration_for?, <<~PATTERN
  (send nil? {:public_constant :private_constant} ({sym str} #match_name?(%1)))
PATTERN