Class: RuboCop::Cop::Style::SpecialGlobalVars

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

Overview

This cop looks for uses of Perl-style global variables.

Examples:

EnforcedStyle: use_english_names (default)

# good
puts $LOAD_PATH
puts $LOADED_FEATURES
puts $PROGRAM_NAME
puts $ERROR_INFO
puts $ERROR_POSITION
puts $FIELD_SEPARATOR # or $FS
puts $OUTPUT_FIELD_SEPARATOR # or $OFS
puts $INPUT_RECORD_SEPARATOR # or $RS
puts $OUTPUT_RECORD_SEPARATOR # or $ORS
puts $INPUT_LINE_NUMBER # or $NR
puts $LAST_READ_LINE
puts $DEFAULT_OUTPUT
puts $DEFAULT_INPUT
puts $PROCESS_ID # or $PID
puts $CHILD_STATUS
puts $LAST_MATCH_INFO
puts $IGNORECASE
puts $ARGV # or ARGV
puts $MATCH
puts $PREMATCH
puts $POSTMATCH
puts $LAST_PAREN_MATCH

EnforcedStyle: use_perl_names

# good
puts $:
puts $"
puts $0
puts $!
puts $@
puts $;
puts $,
puts $/
puts $\
puts $.
puts $_
puts $>
puts $<
puts $$
puts $?
puts $~
puts $=
puts $*
puts $&
puts $`
puts $'
puts $+

Constant Summary collapse

MSG_BOTH =
'Prefer `%<prefer>s` from the stdlib \'English\' ' \
'module (don\'t forget to require it) or `%<regular>s` over ' \
'`%<global>s`.'.freeze
MSG_ENGLISH =
'Prefer `%<prefer>s` from the stdlib \'English\' ' \
'module (don\'t forget to require it) over `%<global>s`.'.freeze
MSG_REGULAR =
'Prefer `%<prefer>s` over `%<global>s`.'.freeze
ENGLISH_VARS =

rubocop:disable Style/MutableConstant

{ # rubocop:disable Style/MutableConstant
  :$: => [:$LOAD_PATH],
  :$" => [:$LOADED_FEATURES],
  :$0 => [:$PROGRAM_NAME],
  :$! => [:$ERROR_INFO],
  :$@ => [:$ERROR_POSITION],
  :$; => %i[$FIELD_SEPARATOR $FS],
  :$, => %i[$OUTPUT_FIELD_SEPARATOR $OFS],
  :$/ => %i[$INPUT_RECORD_SEPARATOR $RS],
  :$\ => %i[$OUTPUT_RECORD_SEPARATOR $ORS],
  :$. => %i[$INPUT_LINE_NUMBER $NR],
  :$_ => [:$LAST_READ_LINE],
  :$> => [:$DEFAULT_OUTPUT],
  :$< => [:$DEFAULT_INPUT],
  :$$ => %i[$PROCESS_ID $PID],
  :$? => [:$CHILD_STATUS],
  :$~ => [:$LAST_MATCH_INFO],
  :$= => [:$IGNORECASE],
  :$* => %i[$ARGV ARGV],
  :$& => [:$MATCH],
  :$` => [:$PREMATCH],
  :$' => [:$POSTMATCH],
  :$+ => [:$LAST_PAREN_MATCH]
}
PERL_VARS =
Hash[ENGLISH_VARS.flat_map { |k, vs| vs.map { |v| [v, [k]] } }]
NON_ENGLISH_VARS =

Anything not in this set is provided by the English library.

Set.new(%i[
  $LOAD_PATH
  $LOADED_FEATURES
  $PROGRAM_NAME
  ARGV
]).freeze

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from ConfigurableEnforcedStyle

#alternative_style, #alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AST::Sexp

#s

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens

Methods included from PathUtil

absolute?, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object



139
140
141
142
143
144
145
146
147
148
149
150
# File 'lib/rubocop/cop/style/special_global_vars.rb', line 139

def autocorrect(node)
  lambda do |corrector|
    global_var, = *node

    while node.parent && node.parent.begin_type? &&
          node.parent.children.one?
      node = node.parent
    end

    corrector.replace(node.source_range, replacement(node, global_var))
  end
end

#message(node) ⇒ Object



127
128
129
130
131
132
133
134
135
136
137
# File 'lib/rubocop/cop/style/special_global_vars.rb', line 127

def message(node)
  global_var, = *node

  if style == :use_english_names
    format_english_message(global_var)
  else
    format(MSG_REGULAR,
           prefer: preferred_names(global_var).first,
           global: global_var)
  end
end

#on_gvar(node) ⇒ Object



114
115
116
117
118
119
120
121
122
123
124
125
# File 'lib/rubocop/cop/style/special_global_vars.rb', line 114

def on_gvar(node)
  global_var, = *node

  return unless (preferred = preferred_names(global_var))

  if preferred.include?(global_var)
    correct_style_detected
  else
    opposite_style_detected
    add_offense(node)
  end
end