class RuboCop::Cop::Style::SpecialGlobalVars

puts $*
puts $=
puts $~
puts $?
puts $$
puts $<
puts $>
puts $_
puts $.
puts $<br>puts $/
puts $,
puts $;
puts $@
puts $!
puts $0
puts $“
puts $:
puts ARGV
puts $PROGRAM_NAME
puts $LOADED_FEATURES
puts $LOAD_PATH
# Like ‘use_perl_names` but allows builtin global vars.
# good
@example EnforcedStyle: use_builtin_english_names
puts $*
puts $=
puts $~
puts $?
puts $$
puts $<
puts $>
puts $_
puts $.
puts $<br>puts $/
puts $,
puts $;
puts $@
puts $!
puts $0
puts $”
puts $:
# good
@example EnforcedStyle: use_perl_names
puts $ARGV # or ARGV
puts $IGNORECASE
puts $LAST_MATCH_INFO
puts $CHILD_STATUS
puts $PROCESS_ID # or $PID
puts $DEFAULT_INPUT
puts $DEFAULT_OUTPUT
puts $LAST_READ_LINE
puts $INPUT_LINE_NUMBER # or $NR
puts $OUTPUT_RECORD_SEPARATOR # or $ORS
puts $INPUT_RECORD_SEPARATOR # or $RS
puts $OUTPUT_FIELD_SEPARATOR # or $OFS
puts $FIELD_SEPARATOR # or $FS
puts $ERROR_POSITION
puts $ERROR_INFO
puts $PROGRAM_NAME
puts $LOADED_FEATURES
puts $LOAD_PATH
require ’English’ # or this could be in another file.
# good
@example EnforcedStyle: use_english_names (default)
true, replacing perl-style variables with english variables will break.
Autocorrection is marked as unsafe because if ‘RequireEnglish` is not
@safety
enabled by RequireEnglish config.
will add a require statement to the top of the file if
Correcting to global variables in the ’English’ library
Looks for uses of Perl-style global variables.

def add_require_english?

def add_require_english?
  cop_config['RequireEnglish']
end

def autocorrect(corrector, node, global_var)

def autocorrect(corrector, node, global_var)
  node = node.parent while node.parent&.begin_type? && node.parent.children.one?
  if should_require_english?(global_var)
    ensure_required(corrector, node, LIBRARY_NAME)
    @required_english = true
  end
  corrector.replace(node, replacement(node, global_var))
end

def english_name_replacement(preferred_name, node)

def english_name_replacement(preferred_name, node)
  return "\#{#{preferred_name}}" if node.begin_type?
  "{#{preferred_name}}"
end

def format_english_message(global_var)

def format_english_message(global_var)
  regular, english = ENGLISH_VARS[global_var].partition do |var|
    NON_ENGLISH_VARS.include? var
  end
  format_message(english, regular, global_var)
end

def format_list(items)

For now, we assume that lists are 2 items or less. Easy grammar!

def format_list(items)
  items.join('` or `')
end

def format_message(english, regular, global)

def format_message(english, regular, global)
  if regular.empty?
    format(MSG_ENGLISH, prefer: format_list(english), global: global)
  elsif english.empty?
    format(MSG_REGULAR, prefer: format_list(regular), global: global)
  else
    format(MSG_BOTH,
           prefer: format_list(english),
           regular: format_list(regular),
           global: global)
  end
end

def matching_styles(global)

def matching_styles(global)
  STYLE_VARS_MAP.filter_map do |style, vars|
    style if vars.values.flatten(1).include? global
  end
end

def message(global_var)

def message(global_var)
  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

def on_gvar(node)

def on_gvar(node)
  global_var = node.name
  return unless (preferred = preferred_names(global_var))
  if preferred.include?(global_var)
    correct_style_detected
  else
    style_detected(matching_styles(global_var))
    add_offense(node, message: message(global_var)) do |corrector|
      autocorrect(corrector, node, global_var)
    end
  end
end

def on_new_investigation

def on_new_investigation
  super
  @required_english = false
end

def preferred_names(global)

def preferred_names(global)
  vars = STYLE_VARS_MAP.fetch(style) do
    raise ArgumentError, "Invalid style: #{style.inspect}"
  end
  vars[global]
end

def replacement(node, global_var)

def replacement(node, global_var)
  parent_type = node.parent&.type
  preferred_name = preferred_names(global_var).first
  return preferred_name.to_s unless %i[dstr xstr regexp].include?(parent_type)
  return english_name_replacement(preferred_name, node) if style == :use_english_names
  "##{preferred_name}"
end

def should_require_english?(global_var)

def should_require_english?(global_var)
  style == :use_english_names &&
    add_require_english? &&
    !@required_english &&
    !NON_ENGLISH_VARS.include?(preferred_names(global_var).first)
end

Modules

Classes