RTFM по созданию ruby gem
Как вы наверно знаете – недавно вышел очередной релиз Ruby on Rails (3.2), в котором сделаны первые шаги в уходе от плагинов, размещаемых в vendor/plugins – в этом релизе они стали deprecated, а в 4й версии фрэймворка от них откажутся окончательно. Наверняка у многих из вас есть свои наработки, которыми бы вы хотели поделиться с коллегами и самое время научиться писать gem-ы, которые могут быть использованы в других проектах. Давайте рассмотрим процесс создания gem-а.
Первым делом создаем “каркас” для нашего будущего gem-а:
alec$ bundle gem super_gem
create super_gem/Gemfile
create super_gem/Rakefile
create super_gem/LICENSE
create super_gem/README.md
create super_gem/.gitignore
create super_gem/super_gem.gemspec
create super_gem/lib/super_gem.rb
create super_gem/lib/super_gem/version.rb
Initializating git repo in /Users/alec/Temp/super_gemгде super_gem это название нашего будущего расширения.
Большинство файлов вам наверняка знакомы, поэтому рассмотрим super_gem.gemspec, в котором описываются параметры нашего расширения:
gem.authors = ["Alexey Poimtsev"] # Имя автора/авторов
gem.email = ["alec@alec-c4.com"] # Его/их email
gem.description = %q{TODO: Write a gem description} # краткое и
gem.summary = %q{TODO: Write a gem summary} # расширенное описание
gem.homepage = "" # url страницы проекта
# Кусок кода, описывающий какие файлы включаются в проект, название гема и его версия
gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
gem.files = `git ls-files`.split("\n")
gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
gem.name = "super_gem"
gem.require_paths = ["lib"]
gem.version = SuperGem::VERSIONВерсия прописывается в файле lib/super_gem/version.rb (спасибо, кэп :))
Также можно (и даже нужно) прописать зависимости для разработки и продуктива, например такие
gem.add_development_dependency "rspec"
gem.add_runtime_dependency "rails"Теперь давайте создадим проект, который будет помогать нам тестировать gem:
$ rails new super_gem_exampleи в его Gemfile пропишем путь к нашему расширению:
gem 'super_gem', :path => '../super_gem'в параметре path мы прописываем путь к проекту гема.
К процессу разработки функционала мы вернемся чуть позже, а сейчас я ненадолго отвлекусь, чтобы рассказать вам, что нам надо делать, когда гем уже будет готов. Первым делом давайте зарегистрируемся на rubygems.org, на котором будут публиковаться наши расширения. Для того, чтобы выполнить сборку достаточно выполнить команду
$ rake buildиз директории gem-проекта и в pkg/super_gem-0.0.1.gem появится наш свежесобранные гем. Его мы можем опубликовать с помощью команды
$ gem push pkg/super_gem-0.0.1.gemа если мы случайно отправили не ту сборку, ее всегда можно удалить с помощью команды gem yank (для этого нам понадобится установить gemcutter). Опубликованный gem появляется на rubygems.org и мы можем даже посмотреть статистику его скачиваний и порадоваться его востребованности (ведь мы же не будем писаться всякий ненужный хлам, правда? :))
А теперь немного сниппетов, которые помогут вам при разработке гема:
1. Расширение функционала контроллеров
module SuperGem
module ControllerMethods
def super_method
lot_of_code()
end
end
end
if defined? ActionController
ActionController::Base.class_eval do
include SuperGem::ControllerMethods
end
end2. По аналогии – View-хэлперы
module SuperGem
module ViewMethods
def super_method
lot_of_code()
end
end
end
if defined? ActionView
ActionView::Base.class_eval do
include SuperGem::ViewMethods
end
end3. Модели
в lib/super_gem.rb
ActiveRecord::Base.extend(SuperGem::ActiveRecordExtension)и в файле с методами:
module SuperGem
module ActiveRecordExtension
def super_method
lot_of_code()
end
end
endВроде несложно :) Если что-то вспомню или у вас будет интересный сниппет – присылайте и я его опубликую :)
Также рекомендую прочитать статью Mountable Engines in Rails 3.1 – она поможет вам разобраться как использовать rails engines в вашем геме.
