класс Rails::Railtie

Railtie — это ядро фреймворка Rails и предоставляет несколько крючков для расширения Rails и/или изменения процесса инициализации.

Каждый основной компонент Rails (Action Mailer, Action Controller, Action View и Active Record) является Railtie. Каждый из них отвечает за собственную инициализацию. Это делает сам Rails свободным от каких-либо крючков компонентов, позволяя использовать другие компоненты вместо любых из предустановленных значений Rails.

Разработка расширения Rails не требует реализации Railtie, но если вам нужно взаимодействовать с фреймворком Rails во время или после запуска, то Railtie необходим.

Например, расширение, выполняющее любое из следующих действий, потребует Railtie:

• создание инициализаторов

• настройка фреймворка Rails для приложения, например, установка генератора

• добавление ключей config.* в среду

• настройка подписчика с помощью ActiveSupport::Notifications

• добавление задач rake

Создание вашего Railtie

Чтобы расширить Rails с помощью Railtie, создайте класс Railtie, который наследуется от Rails::Railtie в пространстве имен вашего расширения. Этот класс должен загружаться во время процесса запуска Rails.

Следующий пример демонстрирует расширение, которое может быть использовано с Rails или без него.

# lib/my_gem/railtie.rb
module MyGem
  class Railtie < Rails::Railtie
  end
end

# lib/my_gem.rb
require 'my_gem/railtie' if defined?(Rails)

Инициализаторы

Чтобы добавить шаг инициализации из вашего Railtie в процесс запуска Rails, вам просто нужно создать блок инициализатора:

class MyRailtie < Rails::Railtie
  initializer "my_railtie.configure_rails_initialization" do
    # some initialization behavior
  end
end

Если указано, блок также может получать объект приложения, в случае необходимости доступа к некоторым конфигурациям, специфичным для приложения, таким как middleware:

class MyRailtie < Rails::Railtie
  initializer "my_railtie.configure_rails_initialization" do |app|
    app.middleware.use MyRailtie::Middleware
  end
end

Наконец, вы также можете передать :before и :after в качестве параметров инициализатора, если вы хотите связать его с конкретным шагом в процессе инициализации.

Конфигурация

Внутри класса Railtie вы можете получить доступ к объекту config, который содержит конфигурацию, общую для всех railtie и приложения:

class MyRailtie < Rails::Railtie
  # Customize the ORM
  config.app_generators.orm :my_railtie_orm

  # Add a to_prepare block which is executed once in production
  # and before each request in development
  config.to_prepare do
    MyRailtie.setup!
  end
end

Загрузка задач rake и генераторов

Если ваш railtie содержит задачи rake, вы можете указать Rails на их загрузку с помощью метода ::rake_tasks:

class MyRailtie < Rails::Railtie
  rake_tasks do
    load "path/to/my_railtie.tasks"
  end
end

По умолчанию Rails загружает генераторы из вашего пути загрузки. Однако, если вы хотите разместить свои генераторы в другом месте, вы можете указать в своем Railtie блок, который загрузит их во время обычного поиска генераторов:

class MyRailtie < Rails::Railtie
  generators do
    require "path/to/my_railtie_generator"
  end
end

Приложение и Двигатель

Двигатель Rails::Engine — это не что иное, как Railtie с некоторыми уже заданными инициализаторами. И поскольку Rails::Application — это движок, эту же конфигурацию можно использовать в обоих случаях.

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