Class: Rubocop::Cop::Style::GlobalVars
- Defined in:
- lib/rubocop/cop/style/global_vars.rb
Overview
This cops looks for uses of global variables. It does not report offences 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.
Constant Summary collapse
- MSG =
'Do not introduce global variables.'
- BUILT_IN_VARS =
predefined global variables their English aliases http://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 $SAFE $-0 $-a $-d $-F $-i $-I $-l $-p $-v $-w $CLASSPATH $JRUBY_VERSION $JRUBY_REVISION $ENV_JAVA ).map(&:to_sym)
Constants inherited from Cop
Instance Attribute Summary
Attributes inherited from Cop
#config, #corrections, #offences, #processed_source
Instance Method Summary collapse
- #allowed_var?(global_var) ⇒ Boolean
- #check(node) ⇒ Object
- #on_gvar(node) ⇒ Object
- #on_gvasgn(node) ⇒ Object
- #user_vars ⇒ Object
Methods inherited from Cop
#add_offence, all, #autocorrect?, #convention, #cop_config, cop_name, #cop_name, cop_type, #debug?, #ignore_node, inherited, #initialize, lint?, #message, non_rails, rails?, style?, #support_autocorrect?, #warning
Constructor Details
This class inherits a constructor from Rubocop::Cop::Cop
Instance Method Details
#allowed_var?(global_var) ⇒ Boolean
54 55 56 |
# File 'lib/rubocop/cop/style/global_vars.rb', line 54 def allowed_var?(global_var) BUILT_IN_VARS.include?(global_var) || user_vars.include?(global_var) end |
#check(node) ⇒ Object
66 67 68 69 70 |
# File 'lib/rubocop/cop/style/global_vars.rb', line 66 def check(node) global_var, = *node convention(node, :name) unless allowed_var?(global_var) end |
#on_gvar(node) ⇒ Object
58 59 60 |
# File 'lib/rubocop/cop/style/global_vars.rb', line 58 def on_gvar(node) check(node) end |
#on_gvasgn(node) ⇒ Object
62 63 64 |
# File 'lib/rubocop/cop/style/global_vars.rb', line 62 def on_gvasgn(node) check(node) end |
#user_vars ⇒ Object
46 47 48 49 50 51 52 |
# File 'lib/rubocop/cop/style/global_vars.rb', line 46 def user_vars if cop_config['AllowedVariables'] cop_config['AllowedVariables'].map(&:to_sym) else [] end end |