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_]+$/

Instance Attribute Summary

Attributes inherited from Cop

#autocorrect, #debug, #disabled_lines, #offences

Instance Method Summary collapse

Methods inherited from Cop

#add_offence, #autocorrect_action, cop_name, cop_type, #do_autocorrect, #ignore_node, inherited, #initialize, #inspect, lint?, #name, rails?, style?

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
26
27
 
# 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 line
  # NewClass = something_that_returns_a_class
  unless value && value.type == :send
    if const_name !~ SNAKE_CASE
      add_offence(:convention, node.loc.name, MSG)
    end
  end

  super
end