Хочу представить вам полезный модуль для работы с другими модулями.
Опять из книжки
На этот раз Дэвида Флэнагана
/**
* Module.js: Функции для работы с модулями и пространствами имен
*
* Этот модуль содержит функции для работы с модулями, которые
* совместимы с модулями из архива JSAN.
* Данный модуль определяет пространство имен Module.
*/
// Убедиться, что данный модуль еще не загружен
var Module;
if (Module && (typeof Module != "object" || Module.NAME))
throw new Error("Пространство имен 'Module' уже существует");
// Создать собственное пространство имен
Module = {};
// Далее располагается метаинформация об этом пространстве имен
Module.NAME = "Module"; // Название этого пространства имен
Module.VERSION = 0.1; // Версия этого пространства имен
// Далее следует список общедоступных символов, которые будут
// экспортироваться этим пространством имен.
// Эта информация интересна тем, кто будет пользоваться модулем
Module.EXPORT = ["require", "importSymbols"];
// Далее следует перечень символов, которые также будут экспортироваться.
// Но они, как правило, используются только авторами модулей
// и обычно не импортируются.
Module.EXPORT_OK = ["createNamespace", "isDefined",
"registerInitializationFunction",
"runInitializationFunctions",
"modules", "globalNamespace"];
// Начинается добавление символов в пространство имен
Module.globalNamespace = this; // Так мы всегда ссылаемся
// на глобальную область видимости
Module.modules = { "Module": Module };// Соответствие Module [name] >namespace.
/**
* Данная функция создает и возвращает объект пространства имен с заданным
* именем и выполняет проверку на наличие конфликта между этим именем
* и именами из любых ранее загруженных модулей.
* Если какой либо компонент пространства имен уже существует
* и не является объектом, генерируется исключение.
*
* В качестве значения свойства NAME устанавливается имя этого пространства имен.
* Если был задан аргумент version, устанавливает свойство пространство имен VERSION.
*
* Отображение нового пространства имен добавляется в объект Module.modules
*/
Module.createNamespace = function(name, version) {
// Проверить корректность имени. Оно должно существовать и не должно
// начинаться или заканчиваться символом точки или содержать в строке
// два символа точки подряд.
if (!name) throw new Error("Module.createNamespace(): не указано имя");
if (name.charAt(0) == '.' ||
name.charAt(name.length 1) == '.' ||
name.indexOf("..") != 1)
throw new Error("Module.createNamespace(): неверное имя: " + name);
// Разбить имя по символам точки и создать иерархию объектов
var parts = name.split('.');
// Для каждого компонента пространства имен следует создать объект
// либо убедиться, что объект с таким именем уже существует.
var container = Module.globalNamespace;
for(var i = 0; i < parts.length; i++) {
var part = parts[i];
// Если свойства или контейнера с таким именем не существует,
// создать пустой объект.
if (!container[part]) container[part] = {};
else if (typeof container[part] != "object") {
// Если свойство уже существует, убедиться, что это объект
var n = parts.slice(0,i).join('.');
throw new Error(n + " уже существует, но не является объектом");
}
container = container[part];
}
// Последний контейнер, который был рассмотрен последним, – это то, что нам нужно.
var namespace = container;
// Было бы ошибкой определить одно и то же пространство имен дважды,
// но нет никакого криминала, если объект уже существует и у него
// не определено свойство NAME.
if (namespace.NAME) throw new Error("Модуль "+name+" уже определен ");
// Инициализировать поля с именем и версией пространства имен
namespace.NAME = name;
if (version) namespace.VERSION = version;
// Зарегистрировать это пространство имен в списке модулей
Module.modules[name] = namespace;
// Вернуть объект пространства имен вызывающей программе
return namespace;
}
/**
* Проверить, был ли определен модуль с заданным именем.
* Вернуть true, если определен, и false – в противном случае.
*/
Module.isDefined = function(name) {
return name in Module.modules;
};
/**
* Эта функция возбуждает исключение, если модуль с таким именем не определен
* или его версия меньше указанной. Если пространство имен существует
* и имеет допустимый номер версии, эта функция просто возвращает управление,
* не предпринимая никаких действий. Эта функция может стать источником
* фатальной ошибки, если модуль, требуемый вашему программному коду, отсутствует.
*/
Module.require = function(name, version) {
if (!(name in Module.modules)) {
throw new Error("Модуль " + name + " не определен");
}
// Если версия не указана, проверка не выполняется
if (!version) return;
var n = Module.modules[name];
// Если номер версии модуля ниже, чем требуется, или пространство
// имен не объявляет версию, генерируется исключение.
if (!n.VERSION || n.VERSION < version)
throw new Error("Модуль " + name + " имеет версию " +
n.VERSION + " требуется версия " + version +
" или выше.");
};
/**
* Данная функция импортирует символы из заданного модуля. По умолчанию
* импорт производится в глобальное пространство имен, однако с помощью
* второго аргумента можно определить иное место назначения.
*
* Если никакие символы явно не указываются, будут импортированы символы
* из массива EXPORT модуля. Если этот массив, а также массив EXPORT_OK
* не определен, будут импортированы все символы модуля from.
*
* Чтобы импортировать явно указанный набор символов, их имена должны
* передаваться в виде аргументов вслед за именем модуля и именем
* пространства имен, куда производится импорт. Если модуль содержит
* определение массива EXPORT или EXPORT_OK, импортированы будут только
* те символы, которые перечислены в одном из этих массивов.
*/
Module.importSymbols = function(from) {
// Убедиться, что модуль корректно задан. Функция ожидает получить объект
// пространства имен модуля, но также допускается строка с именем модуля
if (typeof from == "string") from = Module.modules[from];
if (!from || typeof from != "object")
throw new Error("Module.importSymbols(): " +
"требуется указать объект пространства имен");
// Вслед за аргументом с источником импортируемых символов может
// следовать объект пространства имен, куда производится импорт,
// а также имена импортируемых символов.
var to = Module.globalNamespace; // Место назначения по умолчанию
var symbols = []; // По умолчанию нет символов
var firstsymbol = 1; // Индекс первого аргумента с именем символа
// Проверить, задано ли пространство имен места назначения
if (arguments.length > 1 && typeof arguments[1] == "object") {
if (arguments[1] != null) to = arguments[1];
firstsymbol = 2;
}
// Получить список явно указанных символов
for(var a = firstsymbol; a < arguments.length; a++)
symbols.push(arguments[a]);
// Если ни одного символа не было передано, импортировать набор символов,
// определяемых модулем умолчанию, или просто импортировать все символы.
if (symbols.length == 0) {
// Если в модуле определен массив EXPORT, импортировать символы из этого массива.
if (from.EXPORT) {
for(var i = 0; i < from.EXPORT.length; i++) {
var s = from.EXPORT[i];
to[s] = from[s];
}
return;
}
// Иначе, если массив EXPORT_OK в модуле не определен,
// импортировать все символы из пространства имен модуля
else if (!from.EXPORT_OK) {
for(s in from) to[s] = from[s];
return;
}
}
// В этой точке имеется массив импортируемых символов, определенных явно.
// Если пространство имен определяет массивы EXPORT и/или EXPORT_OK,
// прежде чем импортировать символы, убедиться, что каждый из них
// присутствует в этих массивах. Генерировать исключение, если запрошенный
// символ не определен или не предназначен для экспорта.
var allowed;
if (from.EXPORT || from.EXPORT_OK) {
allowed = {};
// Скопировать допустимые символы из массивов в свойства объекта.
// Это даст возможность более эффективно проверить допустимость импорта символа.
if (from.EXPORT)
for(var i = 0; i < from.EXPORT.length; i++)
allowed[from.EXPORT[i]] = true;
if (from.EXPORT_OK)
for(var i = 0; i < from.EXPORT_OK.length; i++)
allowed[from.EXPORT_OK[i]] = true;
}
// Импортировать символы
for(var i = 0; i < symbols.length; i++) {
var s = symbols[i]; // Имя импортируемого символа
if (!(s in from)) // Проверить его наличие
throw new Error("Module.importSymbols(): символ " + s + " не определен ");
if (allowed && !(s in allowed)) // Убедиться, что это общедоступный символ
throw new Error("Module.importSymbols(): символ " + s +
" не является общедоступным " +
"и не может быть импортирован.");
to[s] = from[s]; // Импортировать символ
}
};
// Эта функция используется модулями для регистрации одной
// или более функций инициализации.
}
