класс Rails::Engine

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

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

Создание Engine

Если вы хотите, чтобы драгоценность вела себя как движок, вам нужно указать 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/*/.

Configuration

Как и railtie, движки могут получить доступ к объекту конфигурации, который содержит общую конфигурацию всех railtie и приложения. Кроме того, каждый движок может получить доступ к autoload_paths, eager_load_paths и autoload_once_paths настройкам, которые ограничены этим движком.

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

Generators

Вы можете настроить генераторы для движков с помощью метода 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.

Для этого используйте метод 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.

Engine имя

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

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

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

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

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

Изолированный Engine

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

Однако иногда вы хотите изолировать свой движок от приложения, особенно если у вашего движка есть свой маршрутизатор. Для этого вам просто нужно вызвать 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 будет генерировать имена с префиксом «namespace». В изолированном движке префикс будет опущен в помощниках 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

Поскольку вы теперь можете монтировать движок внутри маршрутов приложения, у вас нет прямого доступа к 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, переданный в mount, принимает 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]