123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Naming::VariableName

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::ConfigurableNaming, ::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_name.rb

Overview

Checks that the configured style (snake_case or camelCase) is used for all variable names. This includes local variables, instance variables, class variables, method arguments (positional, keyword, rest or block), and block arguments.

The cop can also be configured to forbid using specific names for variables, using ForbiddenIdentifiers or ForbiddenPatterns. In addition to the above, this applies to global variables as well.

Method definitions and method calls are not affected by this cop.

Examples:

EnforcedStyle: snake_case (default)

# bad
fooBar = 1

# good
foo_bar = 1

EnforcedStyle: camelCase

# bad
foo_bar = 1

# good
fooBar = 1

AllowedIdentifiers: ['fooBar']

# good (with EnforcedStyle: snake_case)
fooBar = 1

AllowedPatterns: ['_v\d+\z']

# good (with EnforcedStyle: camelCase)
release_v1 = true

ForbiddenIdentifiers: ['fooBar']

# bad (in all cases)
fooBar = 1
@fooBar = 1
@@fooBar = 1
$fooBar = 1

ForbiddenPatterns: ['_v\d+\z']

# bad (in all cases)
release_v1 = true
@release_v1 = true
@@release_v1 = true
$release_v1 = true

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::ConfigurableNaming - 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::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, #ignored_line?, #matches_allowed_pattern?, #matches_ignored_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

#forbidden_identifiers (private)

[ GitHub ] 

  


# File 'lib/rubocop/cop/naming/variable_name.rb', line 99



def forbidden_identifiers
  cop_config.fetch('ForbiddenIdentifiers', [])
end


  








  

    #forbidden_name?(name)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/variable_name.rb', line 111



def forbidden_name?(name)
  name = name.to_s.delete(SIGILS)

  (forbidden_identifiers.any? && forbidden_identifiers.include?(name)) ||
    (forbidden_patterns.any? && matches_forbidden_pattern?(name))
end


  








  

    #forbidden_patterns   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/variable_name.rb', line 103



def forbidden_patterns
  cop_config.fetch('ForbiddenPatterns', [])
end


  








  

    #matches_forbidden_pattern?(name)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/variable_name.rb', line 107



def matches_forbidden_pattern?(name)
  forbidden_patterns.any? { |pattern| Regexp.new(pattern).match?(name) }
end


  








  

    #message(style)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/variable_name.rb', line 95



def message(style)
  format(MSG, style: style)
end


  








  

    #on_arg(node)  
  



  

    


Alias for #on_lvasgn.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/variable_name.rb', line 76



alias on_arg       on_lvasgn


  








  

    #on_blockarg(node)  
  



  

    


Alias for #on_lvasgn.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/variable_name.rb', line 82



alias on_blockarg  on_lvasgn


  








  

    #on_cvasgn(node)  
  



  

    


Alias for #on_lvasgn.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/variable_name.rb', line 75



alias on_cvasgn    on_lvasgn


  








  

    #on_gvasgn(node)  
  



  

    


Only forbidden names are checked for global variable assignment



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/variable_name.rb', line 86



def on_gvasgn(node)
  return unless (name = node.name)
  return unless forbidden_name?(name)

  register_forbidden_name(node)
end


  








  

    #on_ivasgn(node)  
  



  

    


Alias for #on_lvasgn.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/variable_name.rb', line 74



alias on_ivasgn    on_lvasgn


  








  

    #on_kwarg(node)  
  



  

    


Alias for #on_lvasgn.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/variable_name.rb', line 80



alias on_kwarg     on_lvasgn


  








  

    #on_kwoptarg(node)  
  



  

    


Alias for #on_lvasgn.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/variable_name.rb', line 79



alias on_kwoptarg  on_lvasgn


  








  

    #on_kwrestarg(node)  
  



  

    


Alias for #on_lvasgn.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/variable_name.rb', line 81



alias on_kwrestarg on_lvasgn


  








  

    #on_lvar(node)  
  



  

    


Alias for #on_lvasgn.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/variable_name.rb', line 83



alias on_lvar      on_lvasgn


  








  

    #on_lvasgn(node)  
    Also known as: #on_ivasgn, #on_cvasgn, #on_arg, #on_optarg, #on_restarg, #on_kwoptarg, #on_kwarg, #on_kwrestarg, #on_blockarg, #on_lvar
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/variable_name.rb', line 64



def on_lvasgn(node)
  return unless (name = node.name)
  return if allowed_identifier?(name)

  if forbidden_name?(name)
    register_forbidden_name(node)
  else
    check_name(node, name, node.loc.name)
  end
end


  








  

    #on_optarg(node)  
  



  

    


Alias for #on_lvasgn.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/variable_name.rb', line 77



alias on_optarg    on_lvasgn


  








  

    #on_restarg(node)  
  



  

    


Alias for #on_lvasgn.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/variable_name.rb', line 78



alias on_restarg   on_lvasgn


  








  

    #register_forbidden_name(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/variable_name.rb', line 118



def register_forbidden_name(node)
  message = format(MSG_FORBIDDEN, identifier: node.name)
  add_offense(node.loc.name, message: message)
end


  








  

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



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/naming/variable_name.rb', line 60



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