Class: RuboCop::Cop::Style::ConstantName

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/style/constant_name.rb

Overview

This cop 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.

Constant Summary collapse

MSG = 
'Use SCREAMING_SNAKE_CASE for constants.'
SNAKE_CASE = 
/^[\dA-Z_]+$/

Constants included from Util

Util::ASGN_NODES, Util::EQUALS_ASGN_NODES, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, #autocorrect?, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, cop_name_with_namespace, cop_type, #debug?, #display_cop_names?, inherited, #initialize, #join_force?, lint?, #message, non_rails, qualified_cop_name, rails?, #relevant_file?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, command?, comment_line?, const_name, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#on_casgn(node) ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/rubocop/cop/style/constant_name.rb', line 15

def on_casgn(node)
  _scope, const_name, value = *node

  # 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
  # SomeClass = SomeOtherClass
  return if value && [:send, :block, :const].include?(value.type)

  add_offense(node, :name) if const_name !~ SNAKE_CASE
end