class RuboCop::Cop::Naming::VariableName

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

@example EnforcedStyle: snake_case (default)

# bad
fooBar = 1

# good
foo_bar = 1

@example EnforcedStyle: camelCase

# bad
foo_bar = 1

# good
fooBar = 1

@example AllowedIdentifiers: [‘fooBar’]

# good (with EnforcedStyle: snake_case)
fooBar = 1

@example AllowedPatterns: [‘_vd+z’]

# good (with EnforcedStyle: camelCase)
:release_v1

Constants

MSG

Public Instance Methods

on_arg(node)
Alias for: on_lvasgn
on_blockarg(node)
Alias for: on_lvasgn
on_cvasgn(node)
Alias for: on_lvasgn
on_ivasgn(node)
Alias for: on_lvasgn
on_kwarg(node)
Alias for: on_lvasgn
on_kwoptarg(node)
Alias for: on_lvasgn
on_kwrestarg(node)
Alias for: on_lvasgn
on_lvar(node)
Alias for: on_lvasgn
on_lvasgn(node) click to toggle source
# File lib/rubocop/cop/naming/variable_name.rb, line 42
def on_lvasgn(node)
  name, = *node
  return unless name
  return if allowed_identifier?(name)

  check_name(node, name, node.loc.name)
end
on_optarg(node)
Alias for: on_lvasgn
on_restarg(node)
Alias for: on_lvasgn
valid_name?(node, name, given_style = style) click to toggle source
Calls superclass method
# File lib/rubocop/cop/naming/variable_name.rb, line 38
def valid_name?(node, name, given_style = style)
  super || matches_allowed_pattern?(name)
end

Private Instance Methods

message(style) click to toggle source
# File lib/rubocop/cop/naming/variable_name.rb, line 62
def message(style)
  format(MSG, style: style)
end