class RuboCop::Cop::Style::SpecialGlobalVars

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

Constants

ENGLISH_VARS
MSG_BOTH
MSG_ENGLISH
MSG_REGULAR
NON_ENGLISH_VARS

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

PERL_VARS

Public Instance Methods

autocorrect(node) click to toggle source
# File lib/rubocop/cop/style/special_global_vars.rb, line 100
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) click to toggle source
# File lib/rubocop/cop/style/special_global_vars.rb, line 74
def message(node)
  global_var, = *node

  if style == :use_english_names
    regular, english = ENGLISH_VARS[global_var].partition do |var|
      NON_ENGLISH_VARS.include? var
    end

    # For now, we assume that lists are 2 items or less. Easy grammar!
    regular_msg = regular.join('` or `')
    english_msg = english.join('` or `')

    if !regular.empty? && !english.empty?
      format(MSG_BOTH, english_msg, regular_msg, global_var)
    elsif !regular.empty?
      format(MSG_REGULAR, regular_msg, global_var)
    elsif !english.empty?
      format(MSG_ENGLISH, english_msg, global_var)
    else
      raise 'Bug in SpecialGlobalVars - global var w/o preferred vars!'
    end
  else
    format(MSG_REGULAR, preferred_names(global_var).first, global_var)
  end
end
on_gvar(node) click to toggle source
# File lib/rubocop/cop/style/special_global_vars.rb, line 61
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, :expression)
  end
end

Private Instance Methods

english_name_replacement(preferred_name, node) click to toggle source
# File lib/rubocop/cop/style/special_global_vars.rb, line 138
def english_name_replacement(preferred_name, node)
  return "\#{#{preferred_name}}" if node.begin_type?

  "{#{preferred_name}}"
end
preferred_names(global) click to toggle source
# File lib/rubocop/cop/style/special_global_vars.rb, line 130
def preferred_names(global)
  if style == :use_english_names
    ENGLISH_VARS[global]
  else
    PERL_VARS[global]
  end
end
replacement(node, global_var) click to toggle source
# File lib/rubocop/cop/style/special_global_vars.rb, line 115
def replacement(node, global_var)
  parent_type = node.parent && node.parent.type
  preferred_name = preferred_names(global_var).first

  unless [:dstr, :xstr, :regexp].include?(parent_type)
    return preferred_name.to_s
  end

  if style == :use_english_names
    return english_name_replacement(preferred_name, node)
  end

  "##{preferred_name}"
end