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

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

Overview

This cops 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.

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
  [email protected] $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 included from Util

Util::ASGN_NODES, Util::EQUALS_ASGN_NODES, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, #autocorrect?, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_name_with_namespace, cop_type, #debug?, #display_cop_names?, inherited, #initialize, #join_force?, lint?, #message, non_rails, qualified_cop_name, rails?, #relevant_file?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, command?, comment_line?, const_name, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#allowed_var?(global_var) ⇒ Boolean

Returns:

  • (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

  add_offense(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_varsObject


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