класс Rails::Engine

Rails::Engine позволяет обернуть конкретное приложение Rails или подмножество функциональности и поделиться им с другими приложениями или внутри более крупного упакованного приложения. Каждый Rails::Application представляет собой просто движок, что позволяет просто делиться функциями и приложениями.

Любой Rails::Engine также является Rails::Railtie, поэтому те же методы (например, rake_tasks и generators) и параметры конфигурации, доступные в railtie, также могут использоваться в движках.

Создание движка

Если вы хотите, чтобы драгоценный камень вел себя как движок, вы должны указать Engine где-то внутри папки lib вашего плагина (аналогично тому, как мы указываем Railtie):

# lib/my_engine.rb
module MyEngine
  class Engine < Rails::Engine
  end
end

Затем убедитесь, что этот файл загружается вверху вашего config/application.rb (или в вашем Gemfile), и он автоматически загрузит модели, контроллеры и помощники внутри app, загрузит маршруты в config/routes.rb, загрузит локали в config/locales/*, и загрузит задачи в lib/tasks/*.

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

Помимо конфигурации Railtie, которая используется во всем приложении, в движке вы можете получить доступ к autoload_paths, eager_load_paths и autoload_once_paths, которые, в отличие от Railtie, ограничены текущим движком.

class MyEngine < Rails::Engine
  # Add a load path for this specific Engine
  config.autoload_paths << File.expand_path("lib/some/path", __dir__)

  initializer "my_engine.add_middleware" do |app|
    app.middleware.use MyEngine::Middleware
  end
end

Генераторы

Вы можете настроить генераторы для движков с помощью метода config.generators:

class MyEngine < Rails::Engine
  config.generators do |g|
    g.orm             :active_record
    g.template_engine :erb
    g.test_framework  :test_unit
  end
end

Вы также можете настроить генераторы для приложения с помощью config.app_generators:

class MyEngine < Rails::Engine
  # note that you can also pass block to app_generators in the same way you
  # can pass it to generators method
  config.app_generators.orm :datamapper
end

Приложения и движки имеют гибкую конфигурацию путей, что означает, что вам не нужно размещать контроллеры в app/controllers, а в любом месте, которое вам удобно.

Например, предположим, что вы хотите разместить свои контроллеры в lib/controllers. Вы можете установить это в качестве параметра:

class MyEngine < Rails::Engine
  paths["app/controllers"] = "lib/controllers"
end

Вы также можете загружать контроллеры из app/controllers и lib/controllers:

class MyEngine < Rails::Engine
  paths["app/controllers"] << "lib/controllers"
end

Доступные пути в движке:

class MyEngine < Rails::Engine
  paths["app"]                 # => ["app"]
  paths["app/controllers"]     # => ["app/controllers"]
  paths["app/helpers"]         # => ["app/helpers"]
  paths["app/models"]          # => ["app/models"]
  paths["app/views"]           # => ["app/views"]
  paths["lib"]                 # => ["lib"]
  paths["lib/tasks"]           # => ["lib/tasks"]
  paths["config"]              # => ["config"]
  paths["config/initializers"] # => ["config/initializers"]
  paths["config/locales"]      # => ["config/locales"]
  paths["config/routes.rb"]    # => ["config/routes.rb"]
end

Класс Application добавляет еще несколько путей в этот набор. И, как и в вашем Application, все папки в app автоматически добавляются в путь загрузки. Если у вас, например, есть папка app/services, она будет добавлена по умолчанию.

Точка входа

Движок также может быть приложением Rack. Это может быть полезно, если у вас есть приложение Rack, которое вы хотите обернуть с помощью Engine и предоставить некоторые функции Engine.

Для этого используйте метод endpoint:

module MyEngine
  class Engine < Rails::Engine
    endpoint MyRackApplication
  end
end

Теперь вы можете смонтировать свой движок в маршрутах приложения так:

Rails.application.routes.draw do
  mount MyEngine::Engine => "/engine"
end

Стек промежуточного ПО

Поскольку движок теперь может быть точкой входа Rack, он также может иметь стек промежуточного ПО. Использование точно такое же, как и в Application:

module MyEngine
  class Engine < Rails::Engine
    middleware.use SomeMiddleware
  end
end

Маршруты

Если вы не укажете точку входа, маршруты будут использоваться в качестве точки входа по умолчанию. Вы можете использовать их так же, как вы используете маршруты приложения:

# ENGINE/config/routes.rb
MyEngine::Engine.routes.draw do
  get "/" => "posts#index"
end

Приоритет монтирования

Обратите внимание, что теперь в вашем приложении может быть более одного маршрутизатора, и лучше избегать передачи запросов через множество маршрутизаторов. Рассмотрите такую ситуацию:

Rails.application.routes.draw do
  mount MyEngine::Engine => "/blog"
  get "/blog/omg" => "main#omg"
end

MyEngine смонтирован в /blog, а /blog/omg указывает на контроллер приложения. В такой ситуации запросы к /blog/omg пройдут через MyEngine, и если такого маршрута нет в маршрутах Engine, он будет передан в main#omg. Гораздо лучше поменять это:

Rails.application.routes.draw do
  get "/blog/omg" => "main#omg"
  mount MyEngine::Engine => "/blog"
end

Теперь Engine получит только запросы, которые не были обработаны Application.

Имя движка

Есть места, где используется имя движка:

• маршруты: когда вы монтируете движок с mount(MyEngine::Engine => '/my_engine'), он используется в качестве параметра :as по умолчанию

• задача rake для установки миграций my_engine:install:migrations

Имя движка устанавливается по умолчанию на основе имени класса. Для MyEngine::Engine он будет my_engine_engine. Вы можете изменить его вручную, используя метод engine_name:

module MyEngine
  class Engine < Rails::Engine
    engine_name "my_engine"
  end
end

Изолированный движок

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

Однако иногда вы хотите изолировать свой движок от приложения, особенно если ваш движок имеет свой собственный маршрутизатор. Для этого просто вызовите isolate_namespace. Этот метод требует передачи модуля, где все ваши контроллеры, помощники и модели должны быть вложены:

module MyEngine
  class Engine < Rails::Engine
    isolate_namespace MyEngine
  end
end

С таким движком все, что находится внутри модуля MyEngine, будет изолировано от приложения.

Рассмотрим этот контроллер:

module MyEngine
  class FooController < ActionController::Base
  end
end

Если движок MyEngine помечен как изолированный, FooController имеет доступ только к помощникам из MyEngine, а url_helpers из MyEngine::Engine.routes.

Следующее, что меняется в изолированных движках, — это поведение маршрутов. Обычно, когда вы именованно группируете свои контроллеры, вам также нужно именованно группировать связанные маршруты. С изолированным движком пространство имен движка автоматически применяется, поэтому вам не нужно явно указывать его в своих маршрутах:

MyEngine::Engine.routes.draw do
  resources :articles
end

Если MyEngine изолирован, вышеуказанные маршруты будут указывать на MyEngine::ArticlesController. Вам также не нужно использовать более длинные вспомогательные функции URL, такие как my_engine_articles_path. Вместо этого вы должны просто использовать articles_path, как вы это делаете со своим основным приложением.

Чтобы согласовать это поведение с другими частями фреймворка, изолированные движки также влияют на ActiveModel::Naming. В обычном приложении Rails, когда вы используете именованно группируемую модель, такую как Namespace::Article, ActiveModel::Naming сгенерирует имена с префиксом «пространство имен». В изолированном движке префикс будет опущен в вспомогательных функциях URL и полях форм для удобства.

polymorphic_url(MyEngine::Article.new)
# => "articles_path" # not "my_engine_articles_path"

form_for(MyEngine::Article.new) do
  text_field :title # => <input type="text" name="article[title]" id="article_title" />
end

Кроме того, изолированный движок установит своё имя в соответствии со своим пространством имён, поэтому MyEngine::Engine.engine_name вернёт «my_engine». Он также установит MyEngine.table_name_prefix в «my_engine_», что означает, например, что MyEngine::Article по умолчанию будет использовать таблицу базы данных my_engine_articles.

Использование маршрутов движка вне движка

Поскольку вы можете теперь монтировать движок внутри маршрутов приложения, вы не имеете прямого доступа к Engine's url_helpers внутри Application. Когда вы монтируете движок в маршрутах приложения, создаётся специальная вспомогательная функция, которая позволит вам это сделать. Рассмотрим такой сценарий:

# config/routes.rb
Rails.application.routes.draw do
  mount MyEngine::Engine => "/my_engine", as: "my_engine"
  get "/foo" => "foo#index"
end

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

class FooController < ApplicationController
  def index
    my_engine.root_url # => /my_engine/
  end
end

Также есть вспомогательная функция main_app, которая предоставляет вам доступ к маршрутам приложения внутри движка:

module MyEngine
  class BarController
    def index
      main_app.foo_path # => /foo
    end
  end
end

Обратите внимание, что параметр :as для монтирования использует engine_name по умолчанию, поэтому большую часть времени вы можете его просто опустить.

Наконец, если вы хотите сгенерировать URL для маршрута движка с помощью polymorphic_url, вам также нужно передать вспомогательную функцию движка. Предположим, что вы хотите создать форму, указывающую на один из маршрутов движка. Всё, что вам нужно сделать, это передать вспомогательную функцию как первый элемент в массиве с атрибутами для URL:

form_for([my_engine, @user])

Этот код будет использовать my_engine.user_path(@user) для генерации правильного маршрута.

Вспомогательные функции изолированного движка

Иногда вы можете захотеть изолировать движок, но использовать помощников, которые для него определены. Если вы хотите поделиться лишь несколькими конкретными помощниками, вы можете добавить их в помощников приложения в ApplicationController:

class ApplicationController < ActionController::Base
  helper MyEngine::SharedEngineHelper
end

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

class ApplicationController < ActionController::Base
  helper MyEngine::Engine.helpers
end

Он включит все вспомогательные функции из каталога движка. Обратите внимание, что это не включает помощников, определённых в контроллерах с помощью helper_method или других подобных решений, будут включены только помощники, определённые в каталоге helpers.

Миграции и данные для инициализации

Движки могут иметь собственные миграции. Путь по умолчанию для миграций точно такой же, как и в приложении: db/migrate

Для использования миграций движка в приложении вы можете использовать задачу rake ниже, которая копирует их в каталог приложения:

rake ENGINE_NAME:install:migrations

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

Если у вашего движка есть миграции, вы также можете подготовить данные для базы данных в файле db/seeds.rb. Вы можете загрузить эти данные, используя метод load_seed, например.

MyEngine::Engine.load_seed

Приоритет загрузки

Для изменения приоритета движка вы можете использовать config.railties_order в основном приложении. Это повлияет на приоритет загрузки представлений, помощников, активов и всех других файлов, относящихся к движку или приложению.

# load Blog::Engine with highest priority, followed by application and other railties
config.railties_order = [Blog::Engine, :main_app, :all]