123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Naming::ConstantName

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::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/naming/constant_name.rb

Overview

Checks whether constant names are written using SCREAMING_SNAKE_CASE.

To avoid false positives, it ignores cases in which we cannot know for certain the type of value that would be assigned to a constant.

Examples:

# bad
InchInCm = 2.54
INCHinCM = 2.54
Inch_In_Cm = 2.54

# good
INCH_IN_CM = 2.54

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.
.builtin?

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

Cops (other than builtin) are encouraged to implement this.
.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

#active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #processed_source, #target_satisfies_all_gem_version_requirements?

::RuboCop::Cop::AutocorrectLogic - Included

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

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, #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, #max_line_length,
#range_by_lines

Expand the given range to include all of any lines it covers.
#range_of_first_line, #surrounding_heredoc, #surrounding_percent_array

::RuboCop::Cop::IgnoredNode - Included

#ignore_node, #ignored_node?, #part_of_ignored_node?, #ignored_nodes

Constructor Details

This class inherits a constructor from RuboCop::Cop::Base

Instance Method Details

#allowed_assignment?(value) ⇒ Boolean (private)

[ GitHub ] 

  


# File 'lib/rubocop/cop/naming/constant_name.rb', line 56



def allowed_assignment?(value)
  (value && %i[block const casgn].include?(value.type)) ||
    allowed_method_call_on_rhs?(value) ||
    class_or_struct_return_method?(value) ||
    allowed_conditional_expression_on_rhs?(value)
end


  








  

    #allowed_conditional_expression_on_rhs?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/constant_name.rb', line 73



def allowed_conditional_expression_on_rhs?(node)
  node&.if_type? && contains_constant?(node)
end


  








  

    #allowed_method_call_on_rhs?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/constant_name.rb', line 63



def allowed_method_call_on_rhs?(node)
  node&.send_type? && (node.receiver.nil? || !literal_receiver?(node))
end


  








  

    #class_or_struct_return_method?(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/constant_name.rb', line 27



def_node_matcher :class_or_struct_return_method?, <<~PATTERN
  (send
    (const _ {:Class :Struct}) :new
    ...)
PATTERN


  








  

    #contains_constant?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/constant_name.rb', line 77



def contains_constant?(node)
  node.branches.compact.any?(&:const_type?)
end


  








  

    #literal_receiver?(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/constant_name.rb', line 68



def_node_matcher :literal_receiver?, <<~PATTERN
  {(send literal? ...)
   (send (begin literal?) ...)}
PATTERN


  








  

    #on_casgn(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/constant_name.rb', line 33



def on_casgn(node)
  if node.parent&.or_asgn_type?
    lhs, value = *node.parent
    _scope, const_name = *lhs
  else
    _scope, const_name, value = *node
  end

  # We cannot know the result of method calls like
  # NewClass = something_that_returns_a_class
  # It's also ok to assign a class constant another class constant,
  # `Class.new(...)` or `Struct.new(...)`
  # SomeClass = SomeOtherClass
  # SomeClass = Class.new(...)
  # SomeClass = Struct.new(...)
  return if allowed_assignment?(value)
  return if SNAKE_CASE.match?(const_name)

  add_offense(node.loc.name)
end