[XP Script] Global Variable Standard Check

Code:
#==============================================================================

# ** Global Variable Standard Check

#  Is your project global friendly?

#------------------------------------------------------------------------------

# ? Yeyinde, 2007

#------------------------------------------------------------------------------

#  This script aims to teach scripters to limit their global variable usage to

#  $game_* and $data_* globals.  Certain variables like $scene and $DEBUG are

#  permitted.  What it does is scan for new globals intoduced every graphical

#  update.  If a bad global is introduced, it warns the user that there are

#  globals that should not be in-use.

#==============================================================================



#==============================================================================

# ** ALLOWED_GLOBALS constant

#------------------------------------------------------------------------------

#  Encrypted so you don't tamper to get your bad variables in the array

#==============================================================================

ALLOWED_GLOBALS = "JC1hICRzdGRpbiAkLiAkS0NPREUgJC1sICQsICRgICQtdyAkLUkgJD8gJD4g

JCEgJD0gJC1GICRTQUZFICQtcCAkJiAkLXYgJDogJCQgJHN0ZGVyciAkQCAk

QlRFU1QgJCogJDwgJC0wICQrICQ7ICQtZCAkIiAkLWkgJGRlZmVyciAkfiAk

VkVSQk9TRSAkc3Rkb3V0ICRfICQtSyAkUkdTU19TQ1JJUFRTICQwICQvICQn

ICRERUJVRyAkTE9BRF9QQVRIICRGSUxFTkFNRSAkZGVmb3V0ICRcICRzY2Vu

ZQ=="



#==============================================================================

# ** Graphics Module

#------------------------------------------------------------------------------

#  Contains the inner graphical handling processes of RMXP

#==============================================================================



module Graphics

class << self

  #---------------------------------------------------------------------------

  # * Alias Stack Check

  #---------------------------------------------------------------------------

  unless self.public_method_defined?(:global_check_update)

    #-------------------------------------------------------------------------

    # * Create Alias (update -> global_check_update)

    #-------------------------------------------------------------------------

    alias_method :global_check_update, :update

  end

  #---------------------------------------------------------------------------

  # * Frame Update

  #   This method MUST be called every frame to prevent a lockup

  #---------------------------------------------------------------------------

  def update

    # Run original method

    global_check_update

    # Preform a global check

    Kernel.check_globals

  end

end

end



#==============================================================================

# ** Kernel Module

#------------------------------------------------------------------------------

#  Hold base functions shared by all objects.  Mixed in the Object class.

#==============================================================================



module Kernel

  #---------------------------------------------------------------------------

  # * Bad Global Class Variable

  #---------------------------------------------------------------------------

  @@current_bad_globals = []

  #---------------------------------------------------------------------------

  # * check global variables for bad names

  #---------------------------------------------------------------------------

  def check_globals

    # create a blank array

    bad_globals = []

    # iterate over all global variables

    global_variables.each do |global|

      # if variable name does not have $data_, $game_ in it or is not in the

      # encrypted array(created from splitting the encrypted constant)

      unless (global.include?('$data_') || global.include?('$game_') ||

          ALLOWED_GLOBALS.unpack("m")[0].split(' ').include?(global))

        # append to the array

        bad_globals << global

      end

    end

    # if the current bad variables do not match the new ones

    unless @@current_bad_globals === bad_globals

      globals = bad_globals.dup

      globals.delete_if {|global| @@current_bad_globals.include?(global)}

      # Display a message and list all bad variables

      print "The following global variable(s) have been flagged because they do not meet naming standards:



#{globals.join(', ')}



(#{globals.size} found)"

    end

    # set current variables to new ones

    @@current_bad_globals = bad_globals

  end

  #---------------------------------------------------------------------------

  # * retrieve current bad global variables

  #---------------------------------------------------------------------------

  def bad_globals

    return @@current_bad_globals

  end

  # Allow methods to be called with Kernel extension

  module_function :check_globals, :bad_globals

end