Class: RuboCop::Cop::Style::GlobalVars

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/style/global_vars.rb


Looks for uses of global variables. It does not report offenses for built-in global variables. Built-in global variables are allowed by default. Additionally users can allow additional variables via the AllowedVariables option.

Note that backreferences like $1, $2, etc are not global variables.


# bad
$foo = 2
bar = $foo + 5

# good
FOO = 2
foo = 2

Constant Summary


    built-in global variables and their English aliases https://www.zenspider.com/ruby/quickref.html

    # File 'lib/rubocop/cop/style/global_vars.rb', line 27
      $: $LOAD_PATH
      $0 $PROGRAM_NAME
      $! $ERROR_INFO
      $_ $LAST_READ_LINE
      $$ $PID $PROCESS_ID
      $? $CHILD_STATUS
      $= $IGNORECASE
      $* $ARGV
      $& $MATCH
      $` $PREMATCH
      $' $POSTMATCH
      $stdin $stdout $stderr
      $-0 $-a $-d $-F $-i $-I $-l $-p $-v $-w
  • MSG =
    # File 'lib/rubocop/cop/style/global_vars.rb', line 23
    'Do not introduce global variables.'

::RuboCop::Cop::Base - Inherited


Class Attribute Summary

::RuboCop::Cop::Base - Inherited

.gem_requirements, .lint?,

Returns if class supports autocorrect.


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


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



.callbacks_needed, .cop_name, .department,

Returns an url to view this cops documentation online.


Call for abstract Cop classes.


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


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


Register a version requirement for the given gem name.


::RuboCop::ExcludeLimit - Extended


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


Instance Attribute Summary

Instance Method Summary

::RuboCop::Cop::Base - Inherited


Adds an offense that has no particular location.


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.


Called before any investigation.


Configuration Helpers.

#cop_name, #excluded_file?,

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


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.


Alias for Base#cop_name.


Called after all on_…​


Called before all on_…​


Called instead of all on_…​


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


Called between investigations.

#relevant_file?, #target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction,

Reserved for Cop::Cop.


Called to complete an investigation.

#correct, #current_corrector,

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,

Actually private methods.


::RuboCop::Cop::AutocorrectLogic - Included

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

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

Instance Method Details

#allowed_var?(global_var) ⇒ Boolean

[ GitHub ]

# File 'lib/rubocop/cop/style/global_vars.rb', line 60

def allowed_var?(global_var)
  BUILT_IN_VARS.include?(global_var) || user_vars.include?(global_var)


[ GitHub ]

# File 'lib/rubocop/cop/style/global_vars.rb', line 72

def check(node)
  global_var, = *node

  add_offense(node.loc.name) unless allowed_var?(global_var)


[ GitHub ]

# File 'lib/rubocop/cop/style/global_vars.rb', line 64

def on_gvar(node)


[ GitHub ]

# File 'lib/rubocop/cop/style/global_vars.rb', line 68

def on_gvasgn(node)


[ GitHub ]

# File 'lib/rubocop/cop/style/global_vars.rb', line 56

def user_vars