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::BASIC_LITERALS, Util::EQUALS_ASGN_NODES, Util::LITERALS, 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

#check_name, #class_emitter_method?, #valid_name?

Methods included from ConfigurableEnforcedStyle

#alternative_style, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #parameter_name, #style, #style_detected, #unexpected_style_detected

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, non_rails, qualified_cop_name, rails?, #reference_url, #relevant_file?, #style_guide_url

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #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, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#on_arg(node) ⇒ Object 



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

def on_arg(node)
  name, = *node
  check_name(node, name, node.loc.name)
end

#on_cvasgn(node) ⇒ Object 



21
22
23
24
 
# File 'lib/rubocop/cop/style/variable_name.rb', line 21

def on_cvasgn(node)
  name, = *node
  check_name(node, name, node.loc.name)
end

#on_ivasgn(node) ⇒ Object 



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

def on_ivasgn(node)
  name, = *node
  check_name(node, name, node.loc.name)
end

#on_lvasgn(node) ⇒ Object 



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

def on_lvasgn(node)
  name, = *node
  check_name(node, name, node.loc.name)
end