Модуль ActionView::Layouts

Макеты изменяют обычный шаблон включения общих заголовков и футеров во многих шаблонах, чтобы изолировать изменения в повторяющихся настройках. Шаблон включения имеет страницы, которые выглядят так:

<%= render "shared/header" %>
Hello World
<%= render "shared/footer" %>

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

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

// The header part of this layout
<%= yield %>
// The footer part of this layout

И затем у вас есть страницы с контентом, которые выглядят так:

hello world

При отрисовке страница с контентом вычисляется и вставляется в макет, как в этом примере:

// The header part of this layout
hello world
// The footer part of this layout

Доступ к общим переменным

Макеты имеют доступ к переменным, указанным на страницах с контентом, и наоборот. Это позволяет вам иметь макеты со ссылками, которые не материализуются до момента отрисовки:

<h1><%= @page_title %></h1>
<%= yield %>

…и страницы с контентом, которые выполняют эти ссылки во время отрисовки:

<% @page_title = "Welcome" %>
Off-world colonies offers you a chance to start a new life

Результат после отрисовки:

<h1>Welcome</h1>
Off-world colonies offers you a chance to start a new life

Назначение макета

Вы можете указать макет декларативно (используя метод класса layout) или присвоить ему то же имя, что и у вашего контроллера, и поместить его в app/views/layouts. Если подкласс не имеет указанного макета, он наследует свой макет с помощью обычного наследования Ruby.

Например, если у вас есть PostsController и шаблон с именем app/views/layouts/posts.html.erb, этот шаблон будет использоваться для всех действий в PostsController и контроллеров, наследующих от PostsController.

Если вы используете модуль, например Weblog::PostsController, вам потребуется шаблон с именем app/views/layouts/weblog/posts.html.erb.

Поскольку все ваши контроллеры наследуют от ApplicationController, они будут использовать app/views/layouts/application.html.erb, если другой макет не указан или не предоставлен.

Примеры наследования

class BankController < ActionController::Base
  # bank.html.erb exists

class ExchangeController < BankController
  # exchange.html.erb exists

class CurrencyController < BankController

class InformationController < BankController
  layout "information"

class TellerController < InformationController
  # teller.html.erb exists

class EmployeeController < InformationController
  # employee.html.erb exists
  layout nil

class VaultController < BankController
  layout :access_level_layout

class TillController < BankController
  layout false

В этих примерах у нас есть три сценария неявного поиска:

• BankController использует макет «bank».

• ExchangeController использует макет «exchange».

• CurrencyController наследует макет от BankController.

Однако, когда макет устанавливается явно, явно установленный макет имеет приоритет:

• InformationController использует макет «information», который был установлен явно.

• TellerController также использует макет «information», потому что родительский класс явно его установил.

• EmployeeController использует макет «employee», потому что он установил макет в nil, сбросив настройки родителя.

• VaultController динамически выбирает макет, вызывая метод access_level_layout.

• TillController не использует макет вообще.

Типы макетов

Макеты — это по сути обычные шаблоны, но имя этого шаблона не нужно указывать статически. Иногда вы хотите чередовать макеты в зависимости от информации во время выполнения, например, от того, вошел ли кто-то в систему или нет. Это можно сделать, указав ссылку на метод как символ или используя встроенный метод (как процедуру).

Ссылка на метод — предпочтительный подход к переменным макетам и используется так:

class WeblogController < ActionController::Base
  layout :writers_and_readers

  def index
    # fetching posts
  end

  private
    def writers_and_readers
      logged_in? ? "writer_layout" : "reader_layout"
    end
end

Теперь, когда обрабатывается новый запрос для действия index, макет будет отличаться в зависимости от того, вошел ли пользователь в систему или нет.

Если вы хотите использовать встроенный метод, например, процедуру, сделайте следующее:

class WeblogController < ActionController::Base
  layout proc { |controller| controller.logged_in? ? "writer_layout" : "reader_layout" }
end

Если аргумент не передается в процедуру, она вычисляется в контексте текущего контроллера.

class WeblogController < ActionController::Base
  layout proc { logged_in? ? "writer_layout" : "reader_layout" }
end

Конечно, наиболее распространенный способ указания макета — по-прежнему просто как имя обычного шаблона:

class WeblogController < ActionController::Base
  layout "weblog_standard"
end

Шаблон будет всегда искаться в папке app/views/layouts/. Но вы можете также указать папку layouts напрямую. layout "layouts/demo" эквивалентно layout "demo".

Установка макета на nil заставляет его искать в файловой системе и переходить к поведению родителя, если его нет. Установка на nil полезна для повторного включения поиска шаблонов, перезаписывая предыдущую конфигурацию, заданную в родителе:

class ApplicationController < ActionController::Base
  layout "application"
end

class PostsController < ApplicationController
  # Will use "application" layout
end

class CommentsController < ApplicationController
  # Will search for "comments" layout and fallback "application" layout
  layout nil
end

Условные макеты

Если у вас есть макет, который по умолчанию применяется ко всем действиям контроллера, у вас все еще есть возможность отобразить данное действие или набор действий без макета или ограничить макет только одним действием или набором действий. Опции :only и :except могут передаваться в вызов макета. Например:

class WeblogController < ActionController::Base
  layout "weblog_standard", except: :rss

  # ...

end

Это назначит «weblog_standard» в качестве макета WeblogController для всех действий, кроме действия rss, которое будет отображено напрямую без обёртки макета вокруг рендеринга.

Оба условия :only и :except могут принимать любое количество ссылок на методы, поэтому #except: [ :rss, :text_only ] допустимо, как и except: :rss.

Использование другого макета в вызове отображения действия

Если большинство ваших действий используют один и тот же макет, имеет смысл определить макет на уровне контроллера, как описано выше. Иногда у вас будут исключения, когда одно действие хочет использовать другой макет, чем остальные действия контроллера. Вы можете сделать это, передав опцию :layout в вызов render. Например:

class WeblogController < ActionController::Base
  layout "weblog_standard"

  def help
    render action: "help", layout: "help"
  end
end

Это переопределит макет «weblog_standard» на уровне контроллера и отобразит действие help с макетом «help» вместо него.