Rivalry2

HTML Diff

0 added 0 removed

Original 2026-01-01

Modified 2026-02-26

1 Bundler появился в Ruby значительно позже RubyGems. Из-за этого устройство библиотек (гемов) и проектов немного отличается. В этом уроке мы немного заглянем внутрь гемов, чтобы понять принципы их работы. Изучим команду bundle gem, которая создает структуру для нового гема и которая, с небольшими модификациями, подходит для своих проектов. Она в себя уже включает настроенный линтер, тесты и интеграцию с Github Actions.

2 Для работы прикладных проектов в Ruby ничего кроме Bundler не нужно. Достаточно создатьGemfile, указать зависимости и подключить Bundler в своем коде. Дальше можно не отвлекаться и писать прикладной код.

3 Для гемов все чуть сложнее. У гемов есть метаданные, например, версия, имя, описание и т.п. У гемов есть зависимости, которые должны учитываться RubyGems при установке. Для всего этого нужен специальный файл, называемый спецификацией гема. Кроме того, у гемов есть определенные соглашения по организации кода, которые важны для удобной работы c require.

4 Гем можно создать полностью руками, но лучше воспользоваться готовой командой bundle gem, которая сделает все сама. Ниже мы пройдемся по всем этапам создания гема и изучим организацию кода внутри. Все это поможет понять работу Ruby и научит эффективно организовывать разработку как гемов, так и своих проектов.

5 <h2>bundle gem</h2>

6 Начнем с генерации. Для этого запустим команду bundle gem, которая задаст несколько вопросов и затем создаст директорию с названием гема и нужными файлами внутри.

7 <h2>Спецификация</h2>

8 Спецификация гема описывается Ruby кодом. Внутри нее что-то уже заполнено автоматически, но есть места где стоитTODO. Их нужно заполнить, иначе с кодом не получится работать, он начнет просить заполнения.

9 Для работы с гемом нужно сделать две вещи:

10 <ol><li>Заполнитьsummaryиdescription. Для простоты просто сотритеTODO.</li>

11 <li>Все остальныеTODOзакомментировать включаяhomepage_uri, который ссылается наhomepage</li>

12 </ol><h2>Зависимости</h2>

13 RubyGems в своей работе опирается только на спецификацию гема. Сюда входят и зависимости. То есть все что нужно для работы гема, должно быть указано в gemspec-файле:

14 Здесь же указывались и зависимости для разработки, но с появлением Bundler это изменилось. Все зависимости, необходимые во время разработки и тестирования, переехали в Gemfile.

15 И чтобы не дублировать зависимости самого гема, в Bundler добавили функцию gemspec (в примере выше), которая подтягивает рантайм-зависимости из спецификации в Gemfile.

16 Следующий шаг в разработке гема - установка зависимостей. Для этого выполняется команда bin/setup:

17 После установки зависимостей можно начинать разрабатывать, запускать линтер, тесты и другие команды. Начнем с линтера. У Rubocop есть свой исполняемый файлrubocop. Каким образом его запустить? Правильный способ через командуbundle exec. Эта команда запускает исполняемые файлы из зависимостей текущего проекта игнорируя глобально установленные программы.

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

19 <h2>Rake</h2>

20 Еще один важный элемент экосистемы Ruby - Rake. Rake это Ruby + Make, фреймворк для описания и запуска разнообразных задач связанных с проектом. Список доступных задач можно посмотреть через утилиту rake:

21 Эти задачи не встроены в rake, они добавлены, во время генерации гема, в файлRakefile.

22 Часть задач подгружается из гемов, но некоторые описаны прямо здесь, например запуск тестов. Rubocop тоже присутствует здесь, то есть линтер можно запускать и так:

23 Rake важная часть экосистемы Ruby. Практически ни один проект не обходится без него. Например, в Rails из коробки идет несколько десятков таких команд. Плюс всегда можно написать свои.

24 <h2>Структура проекта</h2>

25 Код гема находится в директорииlibи организован определенным образом:

26 Внутриlibлежит Ruby-файл и директория по имени гема. Ruby-файл hexletgem.rb содержит входной модуль в гем, в нашем случае он называется Hexletgem:

27 Именно через этот модуль пользователи гема будут получать доступ к его содержимому. Это важное соглашение, которое позволяет интуитивным образом понимать, как можно взаимодействовать с гемом после его включения в проект:

28 Директорияlib/hexletgemсодержит файлversion.rbв котором указана версия гема:

29 Все остальные файлы с кодом располагают рядом с этим файлом, внутри директорииhexletgemи ее поддиректориях.

30 <h2>Превращение гема в проект</h2>

31 Генерация гема создает удобную структуру не только для разработки гемов, но и для прикладных проектов. Для готовности нужно сделать два шага:

32 <ol><li>Удалить файл с версией</li>

33 <li>Удалитьgemspec-файл</li>

34 </ol>