123456789_123456789_123456789_123456789_123456789_

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

Overview

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.

Examples:

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

# good
FOO = 2
foo = 2
$stdin.read

Constant Summary

  • BUILT_IN_VARS =

    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
    %w[
      $: $LOAD_PATH
      $" $LOADED_FEATURES
      $0 $PROGRAM_NAME
      $! $ERROR_INFO
      $@ $ERROR_POSITION
      $; $FS $FIELD_SEPARATOR
      $, $OFS $OUTPUT_FIELD_SEPARATOR
      $/ $RS $INPUT_RECORD_SEPARATOR
      $\\ $ORS $OUTPUT_RECORD_SEPARATOR
      $. $NR $INPUT_LINE_NUMBER
      $_ $LAST_READ_LINE
      $> $DEFAULT_OUTPUT
      $< $DEFAULT_INPUT
      $$ $PID $PROCESS_ID
      $? $CHILD_STATUS
      $~ $LAST_MATCH_INFO
      $= $IGNORECASE
      $* $ARGV
      $& $MATCH
      $` $PREMATCH
      $' $POSTMATCH
      $+ $LAST_PAREN_MATCH
      $stdin $stdout $stderr
      $DEBUG $FILENAME $VERBOSE $SAFE
      $-0 $-a $-d $-F $-i $-I $-l $-p $-v $-w
      $CLASSPATH $JRUBY_VERSION $JRUBY_REVISION $ENV_JAVA
    ].map(&:to_sym)
  • MSG =
    # File 'lib/rubocop/cop/style/global_vars.rb', line 23
    'Do not introduce global variables.'

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

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 an 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

Instance Method Summary

::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_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

::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)
end

#check(node)

[ 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)
end

#on_gvar(node)

[ GitHub ]

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

def on_gvar(node)
  check(node)
end

#on_gvasgn(node)

[ GitHub ]

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

def on_gvasgn(node)
  check(node)
end

#user_vars

[ GitHub ]

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

def user_vars
  cop_config['AllowedVariables'].map(&:to_sym)
end