Class: Rubocop::Cop::Style::VariableName

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

Overview

This cop makes sure that all variables use the configured style, snake_case or camelCase, for their names.

Constant Summary

Constants included from ConfigurableNaming

ConfigurableNaming::CAMEL_CASE, ConfigurableNaming::SNAKE_CASE

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 included from ConfigurableNaming

#after_dot, #check, #matches_config?

Methods included from ConfigurableEnforcedStyle

#alternative_style, #both_styles_detected, #correct_style_detected, #opposite_style_detected, #parameter_name, #style, #unrecognized_style_detected

Methods inherited from Cop

#add_offense, all, #autocorrect?, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #debug?, #display_cop_names?, #exclude_file?, #include_file?, inherited, #initialize, lint?, non_rails, rails?, #relevant_file?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

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

Methods included from PathUtil

match_path?, relative_path

Constructor Details

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

Instance Method Details

#message(style) ⇒ Object 



38
39
40
 
# File 'lib/rubocop/cop/style/variable_name.rb', line 38

def message(style)
  format('Use %s for variables.', style)
end

#name_of_setter(send_node) ⇒ Object 



30
31
32
33
34
35
36
 
# File 'lib/rubocop/cop/style/variable_name.rb', line 30

def name_of_setter(send_node)
  receiver, method_name = *send_node
  return unless receiver && receiver.type == :self
  return unless method_name.to_s.end_with?('=')
  after_dot(send_node, method_name.length - '='.length,
            Regexp.escape(receiver.loc.expression.source))
end

#name_of_variable(vasgn_node) ⇒ Object 



23
24
25
26
27
28
 
# File 'lib/rubocop/cop/style/variable_name.rb', line 23

def name_of_variable(vasgn_node)
  expr = vasgn_node.loc.expression
  name = vasgn_node.children.first
  Parser::Source::Range.new(expr.source_buffer, expr.begin_pos,
                            expr.begin_pos + name.length)
end

#on_ivasgn(node) ⇒ Object 



15
16
17
 
# File 'lib/rubocop/cop/style/variable_name.rb', line 15

def on_ivasgn(node)
  check(node, name_of_variable(node))
end

#on_lvasgn(node) ⇒ Object 



11
12
13
 
# File 'lib/rubocop/cop/style/variable_name.rb', line 11

def on_lvasgn(node)
  check(node, name_of_variable(node))
end

#on_send(node) ⇒ Object 



19
20
21
 
# File 'lib/rubocop/cop/style/variable_name.rb', line 19

def on_send(node)
  check(node, name_of_setter(node))
end