Class: Rubocop::Cop::AvoidGlobalVars

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/avoid_global_vars.rb

Constant Summary collapse

MSG = 
'Do not introduce global variables.'
BUILT_IN_VARS =

predefined global variables their English aliases www.zenspider.com/Languages/Ruby/QuickRef.html

%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
  $-0 $-a $-d $-F $-i $-I $-l $-p $-v $-w
)

Instance Attribute Summary

Attributes inherited from Cop

#debug, #disabled_lines, #offences

Instance Method Summary collapse

Methods inherited from Cop

#add_offence, cop_name, #has_report?, #ignore_node, inherited, #initialize, #inspect, #name, #on_comment

Constructor Details

This class inherits a constructor from Rubocop::Cop::Cop

Instance Method Details

#check(node) ⇒ Object 



50
51
52
53
54
55
56
57
58
 
# File 'lib/rubocop/cop/avoid_global_vars.rb', line 50

def check(node)
  global_var, = *node

  unless BUILT_IN_VARS.include?(global_var.to_s)
    add_offence(:convention,
                node.loc.name.line,
                MSG)
  end
end

#on_gvar(node) ⇒ Object 



38
39
40
41
42
 
# File 'lib/rubocop/cop/avoid_global_vars.rb', line 38

def on_gvar(node)
  check(node)

  super
end

#on_gvasgn(node) ⇒ Object 



44
45
46
47
48
 
# File 'lib/rubocop/cop/avoid_global_vars.rb', line 44

def on_gvasgn(node)
  check(node)

  super
end