класс Rails::Engine

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

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

Создание Engine

Если вы хотите, чтобы gem вел себя как движок, вам необходимо указать 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, движки могут получить доступ к объекту config, который содержит общие параметры конфигурации всех 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

Стек middleware

Поскольку движок теперь может быть Rack точкой входа, он также может иметь стек middleware. Использование точно такое же, как в 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

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

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

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

Миграции и данные seed

Движки могут иметь свои собственные миграции. Путь по умолчанию для миграций точно такой же, как в приложении: 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]