Class: RuboCop::Cop::Style::VariableNumber

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

Overview

This cop makes sure that all numbered variables use the configured style, snake_case, normalcase or non_integer, for their numbering.

Examples:

"EnforcedStyle => 'snake_case'"

# bad

variable1 = 1

# good

variable_1 = 1
"EnforcedStyle => 'normalcase'"

# bad

variable_1 = 1

# good

variable1 = 1
"EnforcedStyle => 'non_integer'"

#bad

variable1 = 1

variable_1 = 1

#good

variableone = 1

variable_one = 1

Constant Summary

Constants included from ConfigurableNumbering

ConfigurableNumbering::FORMATS

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from ConfigurableFormatting

#check_name, #class_emitter_method?, #report_opposing_styles, #valid_name?

Methods included from ConfigurableEnforcedStyle

#alternative_style, #alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

Methods inherited from Cop

#add_offense, all, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

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, comment_line?, compatible_external_encoding_for?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, hard_to_type?, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path

Constructor Details

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

Instance Method Details

#on_arg(node) ⇒ Object 



65
66
67
68
 
# File 'lib/rubocop/cop/style/variable_number.rb', line 65

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

#on_cvasgn(node) ⇒ Object 



60
61
62
63
 
# File 'lib/rubocop/cop/style/variable_number.rb', line 60

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

#on_ivasgn(node) ⇒ Object 



55
56
57
58
 
# File 'lib/rubocop/cop/style/variable_number.rb', line 55

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

#on_lvasgn(node) ⇒ Object 



50
51
52
53
 
# File 'lib/rubocop/cop/style/variable_number.rb', line 50

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