Class: RuboCop::Cop::Naming::VariableNumber

Inherits:
Base
  • Object
show all
Includes:
AllowedIdentifiers, AllowedPattern, ConfigurableNumbering
Defined in:
lib/rubocop/cop/naming/variable_number.rb

Overview

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

Additionally, ‘CheckMethodNames` and `CheckSymbols` configuration options can be used to specify whether method names and symbols should be checked. Both are enabled by default.

Examples:

EnforcedStyle: normalcase (default)

# bad
:some_sym_1
variable_1 = 1

def some_method_1; end

def some_method1(arg_1); end

# good
:some_sym1
variable1 = 1

def some_method1; end

def some_method1(arg1); end

EnforcedStyle: snake_case

# bad
:some_sym1
variable1 = 1

def some_method1; end

def some_method_1(arg1); end

# good
:some_sym_1
variable_1 = 1

def some_method_1; end

def some_method_1(arg_1); end

EnforcedStyle: non_integer

# bad
:some_sym1
:some_sym_1

variable1 = 1
variable_1 = 1

def some_method1; end

def some_method_1; end

def some_methodone(arg1); end
def some_methodone(arg_1); end

# good
:some_symone
:some_sym_one

variableone = 1
variable_one = 1

def some_methodone; end

def some_method_one; end

def some_methodone(argone); end
def some_methodone(arg_one); end

# In the following examples, we assume `EnforcedStyle: normalcase` (default).

CheckMethodNames: true (default)

# bad
def some_method_1; end

CheckMethodNames: false

# good
def some_method_1; end

CheckSymbols: true (default)

# bad
:some_sym_1

CheckSymbols: false

# good
:some_sym_1

AllowedIdentifiers: [capture3]

# good
expect(Open3).to receive(:capture3)

AllowedPatterns: [‘_vd+z’]

# good
:some_sym_v1

Constant Summary collapse

MSG = 
'Use %<style>s for %<identifier_type>s numbers.'

Constants included from ConfigurableNumbering

ConfigurableNumbering::FORMATS

Constants included from AllowedIdentifiers

AllowedIdentifiers::SIGILS

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from ConfigurableFormatting

#check_name, #class_emitter_method?, #report_opposing_styles

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_configured?, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

Methods included from AllowedIdentifiers

#allowed_identifier?, #allowed_identifiers

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, callbacks_needed, #callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#on_arg(node) ⇒ Object Also known as: on_lvasgn, on_ivasgn, on_cvasgn, on_gvasgn 



114
115
116
117
118
119
120
 
# File 'lib/rubocop/cop/naming/variable_number.rb', line 114

def on_arg(node)
  @node = node
  name, = *node
  return if allowed_identifier?(name)

  check_name(node, name, node.loc.name)
end

#on_def(node) ⇒ Object Also known as: on_defs 



126
127
128
129
130
131
 
# File 'lib/rubocop/cop/naming/variable_number.rb', line 126

def on_def(node)
  @node = node
  return if allowed_identifier?(node.method_name)

  check_name(node, node.method_name, node.loc.name) if cop_config['CheckMethodNames']
end

#on_sym(node) ⇒ Object 



134
135
136
137
138
139
 
# File 'lib/rubocop/cop/naming/variable_number.rb', line 134

def on_sym(node)
  @node = node
  return if allowed_identifier?(node.value)

  check_name(node, node.value, node) if cop_config['CheckSymbols']
end

#valid_name?(node, name, given_style = style) ⇒ Boolean

Returns:

  • (Boolean) 


110
111
112
 
# File 'lib/rubocop/cop/naming/variable_number.rb', line 110

def valid_name?(node, name, given_style = style)
  super || matches_allowed_pattern?(name)
end