Ruby Packaging mini-HOWTO

Материал из ALT Linux Wiki

Перейти к: навигация, поиск
Stub.png
Данная страница находится в разработке.
Эта страница ещё не закончена. Информация, представленная здесь, может оказаться неполной или неверной.


Основные правила сборки приложений и модулей ruby изложены в Ruby Packaging Policy. Цель этого документа — объяснить на простых примерах, как следует поступать в различных ситуациях при упаковке ruby-приложений, а также показать, как можно собирать простые модули.

rubygems не рассматриваются в данном HOWTO, так как их дополнительная функциональность (например, установка нескольких версий gem’а), необходимая в некоторых случаях (shared hosting, web-приложения), конфликтует с наличием дистрибутивного пакетного менеджера. Другие дистрибутивы занимают аналогичную позицию в отношении к rubygems: позиция Debian, их рекомендации апстриму.

Для ситуаций, в которых дополнительная функциональность rubygems необходима, сам rubygems упакован и работает.

Содержание

[править] Модули, которые нельзя собирать никогда-никогда

Тут перечислены модули, которых всячески стоит избегать. Это гадкие, негодные модули, не надо их использовать.

  • RubyInline - модуль, позволяющий делать "вставки" на языке C. На самом деле в процессе работы включаемый C-код "заворачивается" в native extension, компилится и скомпилированный модуль загружается в программу.

[править] Общие принципы сборки модулей

При сборке пакета в дистрибутив используется «нативная» сборка — с помещением файлов в специальные каталоги, которые находятся в $LOAD_PATH.

Сборка включает в себя:

  • компиляцию бинарных модулей (если они есть);
  • выполнение тестов (если они есть и их выполнение возможно в hasher);
  • установку файлов в соответствующие каталоги;
  • генерацию документации в формате ri (class reference);

Модули устанавливаются в так называемый vendor dir. В ALT Linux это /usr/share/ruby/vendor_ruby/RUBY.VERSION и /usr/lib/ruby/RUBY.VERSION/ARCHITECTURE. Поскольку по умолчанию установка модулей идёт в site dir, при сборке пакета надо использовать модуль vendor_specific, вызывая интерпретатор ruby как ruby -rvendor_specific. Для этого есть макрос %ruby.

[править] Внутри тарбола

Внутри тарбола с модулем (или программой) могут находиться следующие файлы и каталоги:

  • bin/ — скрипты, будут установлены в %_bindir;
  • ext/ — компилируемые модули (при использовании setup.rb), будут установлены в %ruby_sitearchdir;
  • lib/ — pure-ruby модули, будут установлены в %ruby_sitelibdir;
  • data/ — произвольные данные(при использовании setup.rb), будут установлены в %_datadir/ИМЯМОДУЛЯ;
  • test/ — unit-тесты;

Также как правило присутствует один или несколько «сценариев сборки», о них расскажу далее.

[править] Собираем модуль

Существует несколько, различного уровня «стандартности», способов сборки модулей ruby.

Забегая вперёд, хочу сказать, что самым простым и удобным способом будет использование setup.rb, скопированного из пакета ruby-tool-setup (конечно, кроме случая когда в корне проекта находится файл extconf.rb).

[править] extconf.rb AKA MkMf

Аналог configure, использует модуль mkmf, входящий в стандартную поставку ruby. Внутри скрипта проверяется наличие необходимых заголовочных файлов и библиотек, на выходе генерится Makefile, который обрабатывается стандартным make. Используется только в тех проектах, где есть бинарные модули. Если «рядом» с extconf.rb находится файл depend, его содержимое добавляется к Makefile. Исходные тексты и заголовочные файлы бинарного модуля как правило тоже лежат «рядом» с extconf.rb.

Типичные секции %build и %install выглядят следующим образом:

%build
%ruby_configure <опции extconf.rb>
%make_build

%install
%make_install DESTDIR=%buildroot install

[править] setup.rb имени Minero Aoki

Скрипт сборки и установки общего назначения. Как правило используется для сборки и установки pure-ruby модулей. Имеет некоторое количество стандартных опций, может собирать бинарные модули, находящиеся в каталоге ext/ (как правило там присутствует extconf.rb, см. выше).

Типичные секции %build и %install выглядят следующим образом:

%build
%ruby_config <опции setup.rb>
%ruby_build

%install
%ruby_install

[править] install.rb

Иногда это самописный скрипт, иногда встречается одна из первых версий setup.rb. Как правило используется только для установки pure-ruby модулей. Стандартных макросов для поддержки install.rb нет.

[править] Rakefile и остальные случаи

Сценарий для rake. Обычно может иметь task’и build (если есть бинарные модули) и test, но последнее время не имеет task’а install. Зато использует rubygems.

Для вызова rake и rake install есть два стандартных макроса %rake и %rake_install соответственно.

Если task install не определён или вообще отсутствует установочный скрипт (в случае pure-ruby модуля), можно использовать setup.rb из пакета ruby-tool-setup примерно следующим образом:

%prep
%setup
%patch -p1
%update_setup_rb

Далее используются макросы %ruby_config, %ruby_build и %ruby_install.

Очень часто в Rakefile включена поддержка создания .gem. Поскольку rubygems использовать при сборке пакетов нельзя, следует воспользоваться рецептом из Debian.

[править] Запускаем тесты

С осени 2009 года наш rpm поддерживает секцию %check, все тесты имеет смысл вынести в нее:

%check
%ruby_test_unit -Ilib:test test

По какой-то причине у меня (Участник:ТимурБатыршин) такая конструкция не заработала, и я воспользовался другой:

%check
for test in $(find test/ -name '*_test.rb'); do
        ruby -Ilib $test || exit 1
done

[править] l10n при помощи ruby-gettext

Существует специальный модуль ruby-gettext который обеспечивает локализацию сообщений, совместимую с gettext. Если локализация используется, в каталоге с исходниками есть файлы вида po/ЯЗЫК/ИМЯ-ПАКЕТА.po. При сборке файлы *.po надо скомпилить в ЯЗЫК.mo, это делается следующим хуком для setup.rb:

=begin
  post-setup.rb
 
  Copyright (C) 2001-2006 Masao Mutoh
  This program is licenced under the same licence as Ruby. 
=end
 
require 'gettext/utils'
 
begin
  GetText.create_mofiles
rescue
  puts "GetText.create_mofiles failed."
end

Этот код надо поместить в файл post-setup.rb и положить в корень проекта, рядом с setup.rb. Скомпилированные файлы локализации будут помещены в data/locale/, после чего setup.rb установит их в /usr/share/locale/. Для упаковки этих фалов в пакет можно пользоваться макросом %find_lang.

[править] Пакуем документацию

Документация в формате RI генерируется при помощи утилиты rdoc, находящейся в пакете ruby-tool-rdoc. Для этого существует стандартный макрос %rdoc предназначенный для использования в секции %install (обычно одной из последних строк). В качестве аргументов этого макроса перечисляются файлы и каталоги с исходниками и при необходимости другие опции утилиты rdoc.

Для pure-ruby модулей как правило используется конструкция:

%rdoc lib/

Если присутствуют бинарные модули:

%rdoc *.c lib/

Документацию желательно паковать в подпакет %name-doc. При этом паковать следует только документацию для основных классов модуля, описание расширений сторонних классов паковать не нужно.

[править] Складываем файлы в пакеты

Pure-ruby модули помещаются в %ruby_sitelibdir, бинарные модули в %ruby_sitearchdir, документация в формате RI в %ruby_ri_sitedir (при этом файл %ruby_ri_sitedir/created.rid упаковывать не нужно).

[править] Добро пожаловать в реальный мир

В теории всё выглядит красиво, однако на практике среднего размера модуль представляет собой «нечто», что может работать в любой помойке. Однако мы делаем не помойку, поэтому местечковые хаки нам не нужны.

[править] Не загрязняем $LOAD_PATH ($:)

Очень часто в коде можно увидеть конструкции вида:

$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')

Эта конструкция добавляет в $LOAD_PATH некоторый путь. Сделано это для того, чтобы модуль (или исполняемый скрипт) можно было использовать из любого места. Поскольку в нашем случае все файлы пакуются в стандартные места, подобные конструкции не нужны. В большинстве случаев такие конструкции можно безболезненно удалить.

[править] Используем существующие модули и размаскируем зависимости

Поскольку наша помойка не является «любой», её ТТХ нам известны. Например, известно что это Linux, есть Iconv и так далее. Поэтому специфичный код, предназначенный для работы на других платформах в наших пакетах не нужен (а иногда бывает и вреден, поскольку даже «мёртвый» код может порождать зависимости, которые в некоторых случаях превращаются в unmet’ы).

Также мы можем превратить опциональную зависимость в явную. Пример:

begin
  require 'iconv'
rescue LoadError
  module Iconv
    # Далее следует некоторый код, который в результате предоставляет API
    # похожий на API модуля iconv, возможно урезанный функционально.
  end
end

В данном случае всю эту сложную конструкцию можно заменить на одну строку require 'iconv'. Как бонус мы получаем зависимость на ruby(iconv) и полную функциональность данного модуля.

Реальные примеры можно посмотреть в пакете ruby-gettext.

[править] Отрываем rubygems

В реальной жизни можно встретить множество вариантов использования rubygems. Вот самые распространённые:

Пример 1:

require 'rubygems'
require 'some/module'
require 'some/other/module'

Пример 2:

begin
  require 'rubygems'
  require 'some/module'
  require 'some/other/module'
rescue LoadError
  require 'some/module'
  require 'some/other/module'
end

Пример 3:

begin
  require 'some/module'
  require 'some/other/module'
rescue LoadError
  require 'rubygems'
  require 'some/module'
  require 'some/other/module'
end

Все эти три примера можно привести к одному виду:

require 'some/module'
require 'some/other/module'

Этим мы убираем зависимость на rubygems и размаскируем скрытые зависимости. Таким образом наш модуль автоматически получает зависимсти на ruby(some/module) и ruby(some/other/module).

[править] Файлы специального вида (темплейты и плагины)

Очень часто модуль (или приложение) носит с собой какие-то данные, которые обычно находятся в каталоге с gem’ом. Выглядит это приблизительно вот так:

  def mock_framework_path(framework_name)
    File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "..", "plugins", "mock_frameworks", framework_name))
  end

В таком случае этот каталог (в нашем примере «plugins») помещается в /usr/share/ИМЯМОДУЛЯ а код заменяется на такой:

  def mock_framework_path(framework_name)
    File.expand_path(File.join("/usr/share/ИМЯМОДУЛЯ/plugins/mock_frameworks", framework_name))
  end

[править] Потрошим новый пакет

При сборке нового пакета следует пробежать глазами его код на тему вышеописанных конструкций. Начать можно с grep -r по каталогам lib/ и bin/ по паттернам '__FILE__', 'ubygems', 'LoadError', '\$:', '\$LOAD_PATH'.

[править] Некоторые хитрости упаковки плагинов

Как правило любой «плагин» можно разделить на три или менее частей — «модули», «данные» и «скрипт инициализации». Обычно при загрузке «плагина» его «скрипт инициализации» загружает «модули» и в процессе работы приложения код «модулей» использует «данные». Из чего состоит «плагин», как он загружается и как работает зависит от приложения. Существует несколько довольно известных приложений, под которые написано довольно много плагинов. Некоторые из них возможно упаковать в rpm пакеты.

[править] Ruby On Rails

Ruby on Rails считает «плагином» всё, где в корне проекта есть файл init.rb. В свою очередь, «проектом» может считаться любой каталог в vendor/plugins/ и все gem’ы. В нашей сборке RoR к дефолтному списку путей поиска плагинов (состоящему только из vendor/plugins/) добавлен %_datadir/rails/plugins/.

  1. Пакет должен называться rails-plugin-ИМЯПЛАГИНА.
  2. Пакет должен иметь зависимость на ruby-railties >= 2.1.0-alt2.
  3. Сборка и установка «модулей» производится при помощи setup.rb как описано выше.
  4. Файл init.rb и всё что может понадобиться плагину (about.yml, generators, tasks и т. п.) нужно скопировать в %buildroot%_datadir/rails/plugins/ИМЯПЛАГИНА/.

Однако, бывают случаи, когда собранный таким образом плагин не работает с криками про Uninitialized constant. Скорее всего в таком плагине используется механизм автозагрузки модулей из ActiveSupport. Он не ищет модули в стандартном $LOAD_PATH, поэтому устанавливать «модули» приходится в базовый каталог «плагина», например используя опцию --rbdir=%_datadir/rails/plugins/ИМЯПЛАГИНА/lib для %ruby_config.

[править] GemPlugin

Эта система плагинов появилась из проекта mongrel, но в настоящее используется и в других проектах. Я не буду описывать принцип работы этой системы, расскажу только что нужно для того, чтобы «упакеченый» плагин можно было использовать.

  1. Пакет должен иметь зависимость на каталог %_datadir/gem_plugin.
  2. Файл lib/ИМЯПЛАГИНА/init.rb перед установкой должен быть перемещён в init.rb (в корень проекта).
  3. Сборка и установка «модулей» производится при помощи setup.rb как описано выше.
  4. Каталог resources нужно скопировать в %buildroot%_datadir/gem_plugin/ИМЯПЛАГИНА/.
  5. Файл init.rb (который перед установкой вытащили из lib/) тоже нужно скопировать в %buildroot%_datadir/gem_plugin/ИМЯПЛАГИНА/.
  6. Записать в файл %buildroot%_datadir/gem_plugin/ИМЯПЛАГИНА/dependencies.yml список зависимостей «плагина».

Файл dependencies.yml нужен для самого gem_plugin, чтобы решить какие именно плагины загружать для приложения, которое это попросило. Его можно создать посмотрев в GEM Specification, которая находится в файле Rakefile или ИМЯПЛАГИНА.gemspec:

Gem::Specification.new do |s|
  # ...
  s.add_dependency(%q<gem_plugin>, [">= 0.2.3"])
  s.add_dependency(%q<daemons>, [">= 1.0.3"])
  s.add_dependency(%q<fastthread>, [">= 1.0.1"])
  # ...
end

Нас интересуют только строки с add_dependency и только имена gem’ов. В нашем примере файл dependencies.yml должен выглядеть следующим образом:

---
- gem_plugin
- daemons
- fastthread

[править] Генератор пакетов

Я заметил, что при упаковке нового пакета мне приходится производить много одинаковых действий и заниматься копипастеньем. Поэтому я нарисовал примерный генератор git-репозитория для нового ruby-пакета.

.../mkrubypkgrepo [--arch] [--doc] [--rails] path/to/name-version.tar.gz
  • --arch: генерить спек для архитектурно-зависимого пакета
  • --doc: паковать RI документацию в %name-doc
  • --rails: генерить спек для RoR плагина

Скрипт инициализирует в текущем каталоге git репозиторий, импортирует распакованный тарболл в ветку upstream и генерирует начальный спек. После генерации как обычно обработать напильником.

 
Личные инструменты