123456789_123456789_123456789_123456789_123456789_

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

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
self, ::RuboCop::Cop::AllowedPattern, ::RuboCop::Cop::ConfigurableNumbering, ::RuboCop::Cop::ConfigurableFormatting, ::RuboCop::Cop::ConfigurableEnforcedStyle, ::RuboCop::Cop::AllowedIdentifiers, ::RuboCop::Cop::Base, ::RuboCop::Cop::AutocorrectLogic, ::RuboCop::Cop::IgnoredNode, ::RuboCop::Util, RuboCop::AST::Sexp
Inherits: RuboCop::Cop::Base
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: ['_v\d+\z']

# good
:some_sym_v1

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::AllowedIdentifiers - Included

SIGILS

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

SYMBOL_TO_STRING_CACHE

::RuboCop::Cop::ConfigurableNumbering - Included

FORMATS

Class Attribute Summary

::RuboCop::Cop::Base - Inherited

.gem_requirements, .lint?,
.support_autocorrect?

Returns if class supports autocorrect.
.support_multiple_source?

Override if your cop should be called repeatedly for multiple investigations Between calls to on_new_investigation and on_investigation_end, the result of processed_source will remain constant.

Class Method Summary

::RuboCop::Cop::Base - Inherited

.autocorrect_incompatible_with

List of cops that should not try to autocorrect at the same time as this cop.
.badge

Naming.
.callbacks_needed, .cop_name, .department,
.documentation_url

Returns a url to view this cops documentation online.
.exclude_from_registry

Call for abstract Cop classes.
.inherited,
.joining_forces

Override and return the Force class(es) you need to join.
.match?

Returns true if the cop name or the cop namespace matches any of the given names.
.new,
.requires_gem

Register a version requirement for the given gem name.
.restrict_on_send

::RuboCop::ExcludeLimit - Extended

exclude_limit

Sets up a configuration option to have an exclude limit tracked.
transform

Instance Attribute Summary

::RuboCop::Cop::AllowedPattern - Included

#ignored_line?, #matches_ignored_pattern?

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

#detected_style, #detected_style=, #no_acceptable_style?, #style_configured?

::RuboCop::Cop::Base - Inherited

#active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #processed_source, #string_literals_frozen_by_default?, #target_satisfies_all_gem_version_requirements?

::RuboCop::Cop::AutocorrectLogic - Included

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

Instance Method Summary

::RuboCop::Cop::AllowedPattern - Included

#allowed_line?, #allowed_patterns, #cop_config_deprecated_methods_values, #cop_config_patterns_values, #matches_allowed_pattern?

::RuboCop::Cop::ConfigurableFormatting - Included

#check_name,
#class_emitter_method?

A class emitter method is a singleton method in a class/module, where the method has the same name as a class defined in the class/module.
#report_opposing_styles, #valid_name?

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

#alternative_style, #alternative_styles, #ambiguous_style_detected,
#conflicting_styles_detected

Alias for ConfigurableEnforcedStyle#no_acceptable_style!.
#correct_style_detected, #no_acceptable_style!, #opposite_style_detected, #style, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected,
#unrecognized_style_detected

Alias for ConfigurableEnforcedStyle#no_acceptable_style!.

::RuboCop::Cop::AllowedIdentifiers - Included

#allowed_identifier?, #allowed_identifiers

::RuboCop::Cop::Base - Inherited

#add_global_offense

Adds an offense that has no particular location.
#add_offense

Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense.
#begin_investigation

Called before any investigation.
#callbacks_needed,
#cop_config

Configuration Helpers.
#cop_name, #excluded_file?,
#external_dependency_checksum

This method should be overridden when a cop’s behavior depends on state that lives outside of these locations:
#inspect,
#message

Gets called if no message is specified when calling add_offense or add_global_offense Cops are discouraged to override this; instead pass your message directly.
#name

Alias for Base#cop_name.
#offenses,
#on_investigation_end

Called after all on_…​
#on_new_investigation

Called before all on_…​
#on_other_file

Called instead of all on_…​
#parse

There should be very limited reasons for a Cop to do it’s own parsing.
#parser_engine,
#ready

Called between investigations.
#relevant_file?,
#target_gem_version

Returns a gems locked versions (i.e.
#target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction,
#callback_argument

Reserved for Cop::Cop.
#complete_investigation

Called to complete an investigation.
#correct, #current_corrector,
#current_offense_locations

Reserved for Commissioner:
#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range,
#reset_investigation

Actually private methods.
#use_corrector

::RuboCop::Cop::AutocorrectLogic - Included

#disable_offense, #disable_offense_at_end_of_line, #disable_offense_before_and_after, #disable_offense_with_eol_or_surround_comment, #heredoc_range, #max_line_length, #multiline_ranges, #multiline_string?,
#range_by_lines

Expand the given range to include all of any lines it covers.
#range_of_first_line, #range_overlaps_offense?, #string_continuation?, #surrounding_heredoc?, #surrounding_percent_array?

::RuboCop::Cop::IgnoredNode - Included

#ignore_node, #ignored_node?, #part_of_ignored_node?, #ignored_nodes

Constructor Details

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

Instance Method Details

#message(style) (private)

[ GitHub ] 

  


# File 'lib/rubocop/cop/naming/variable_number.rb', line 142



def message(style)
  identifier_type =
    case @node.type
    when :def, :defs then 'method name'
    when :sym        then 'symbol'
    else                  'variable'
    end

  format(MSG, style: style, identifier_type: identifier_type)
end


  








  

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

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/variable_number.rb', line 114



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

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


  








  

    #on_cvasgn(node)  
  



  

    


Alias for #on_arg.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/variable_number.rb', line 122



alias on_cvasgn on_arg


  








  

    #on_def(node)  
    Also known as: #on_defs
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/variable_number.rb', line 125



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_defs(node)  
  



  

    


Alias for #on_def.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/variable_number.rb', line 131



alias on_defs on_def


  








  

    #on_gvasgn(node)  
  



  

    


Alias for #on_arg.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/variable_number.rb', line 123



alias on_gvasgn on_arg


  








  

    #on_ivasgn(node)  
  



  

    


Alias for #on_arg.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/variable_number.rb', line 121



alias on_ivasgn on_arg


  








  

    #on_lvasgn(node)  
  



  

    


Alias for #on_arg.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/variable_number.rb', line 120



alias on_lvasgn on_arg


  








  

    #on_sym(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/variable_number.rb', line 133



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 
  



  

    
  





  


  [ GitHub ]


  

  


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



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