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

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

Overview

Makes sure that all variables use the configured style, snake_case or camelCase, for their names.

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: [‘_vd+z’]

# good (with EnforcedStyle: camelCase)
:release_v1

Constant Summary collapse

MSG = 
'Use %<style>s for variable names.'

Constants included from ConfigurableNaming

ConfigurableNaming::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_lvasgn(node) ⇒ Object Also known as: on_ivasgn, on_cvasgn, on_arg, on_optarg, on_restarg, on_kwoptarg, on_kwarg, on_kwrestarg, on_blockarg, on_lvar 



42
43
44
45
46
47
 
# File 'lib/rubocop/cop/naming/variable_name.rb', line 42

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

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

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

Returns:

  • (Boolean) 


38
39
40
 
# File 'lib/rubocop/cop/naming/variable_name.rb', line 38

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