Чтение онлайн

Некоторые теги используются только внутри блока комментариев, например:

• 

— включить содержимое указанного файла в документацию. При этом будут сформированы подходящие отступы;

• 

— задать заголовок документа;

• 

— задать начальную страницу документации.

Дополнительную информацию вы найдете в книге «Programming Ruby» или в любом онлайновом справочном руководстве.

У пользователя должно быть ощущение «коробочного продукта». Как пользователи мы готовы подписаться под этим тезисом обеими руками, но как разработчики не любим заниматься вопросами создания пакетов и установки.

К счастью, в Ruby все это не так болезненно, как в некоторых других языках и средах. Вы обязательно должны знать о библиотеке

и системе RubyGems — «родных» для Ruby инструментах создания пакетов и развертывания.

Автором библиотеки

является Минеро Аоки (Minero Aoki). Он же разработал библиотеку , которая сейчас используется реже.

Кто-то скажет, что по мере развития системы RubyGems все это становится не актуальным. А кто-то возразит, что у gem-пакетов есть свои проблемы (технические, политические и пр.). А кто-то считает, что «добропорядочный гражданин» должен включать

даже в gem-пакет (упрощая задачу перепакетирования, например для создания Linux-дистрибутива). Решать вам.

Половина дела будет сделана, если вы скопируете все файлы в нужные места. Вы должны организовать свой архив простым и разумным образом (создав каталоги с предопределенными именами).

Предположим, что дистрибутив содержит единственный пакет в архиве (наиболее распространенный случай). Тогда дерево каталогов организуется примерно так (причем файл

помещается на верхний уровень).

Пустые каталоги можно опускать. Ниже описано назначение каждого каталога:

• 

—программы на Ruby;

• 

— расширения Ruby (написанные на С);

• 

— имя расширения (на том же уровне могут располагаться и другие расширения); в каталоге каждого расширения должен находиться либо файл , либо ;

• 

— команды;

• 

— файлы данных;

• 

— конфигурационные файлы;

• 

— страницы руководства;

• 

— автономные тесты и другие тестовые программы.

В общем случае эти файлы никак не обрабатываются, а просто копируются в нужное место. Но для специализированной настройки предусмотрены места подключения к каждому этапу процесса.

Три основных этапа — это

, и , вызываемые пользователем именно в таком порядке (на последнем шаге могут потребоваться полномочия root или, по крайней мере, выполнение ).

Для подключения к этапу вы просто помещаете в нужный каталог написанную на Ruby программу с известным именем. Например, если необходимо перед обработкой сделать что-то нестандартное с файлом

, следует создать файл и поместить в него произвольный код.

Имя файла формируется следующим образом: префикс

или , дефис, имя задачи. Определены следующие имена задач: , , , , и .

В библиотеке

есть понятия каталога исходных файлов, или исходного каталога (source directory) и каталога объектных файлов, или объектного каталога (object directory). Как правило, вы должны читать из исходного каталога и записывать в текущий каталог.

Существует «API для подключения» (hook API), упрощающий решение ряда задач. Приведем некоторые определенные в нем методы:

• 

— принимает в качестве параметра ключ и возвращает ассоциированное с ним значение (например, возвращает путь, определенный с помощью конфигурационного параметра);

• 

— устанавливает значение конфигурационного параметра;

• 

— то же, что ;

• 

— текущий исходный каталог;

• 

— текущий объектный каталог;

• 

— список всех файлов в каталоге с путем (относительно текущего исходного каталога).

На верхнем уровне может находиться файл

. Если он есть, то в нем задаются некоторые глобальные конфигурационные параметры. Для этой цели имеется специальный «metaconfig API» — небольшой набор вспомогательных методов, в частности:

•

— определяет конфигурационный параметр, являющийся путем; задаются имя и значение по умолчанию. При вызове с флагом --help эта информация печатается;

•

— аналог , но описывается булевский параметр.

Дополнительную информацию по этим API можно найти в актуальной онлайновой документации.