Railsにおけるレイアウトとレンダリング

Chapters

1. 概要：各要素の関係
2. レスポンスの作成
   • デフォルトでのレンダリング：アクションにおける慣例の優先
   • renderの使用
   • redirect_to の使用
   • headを使用してヘッダーのみのレスポンスを作成する
3. レイアウトの構造化
   • アセットタグヘルパー
   • yieldの理解
   • content_forメソッドの使用
   • パーシャルの使用
   • ネストされたレイアウトの使用

1 概要：各要素の関係

このガイドでは、モデル-ビュー-コントローラ（MVC）の三角形におけるコントローラとビューの相互作用に焦点を当てています。ご存知の通り、コントローラはRailsにおけるリクエストの処理全体を組織する責任を持っていますが、通常は重いコードをモデルに委譲します。しかし、ユーザーにレスポンスを返す時には、コントローラはビューに処理を引き継ぎます。この引き継ぎがこのガイドの主題です。

大まかに言えば、これはどのようなレスポンスを送信するかを決定し、それを作成するための適切なメソッドを呼び出すことを含みます。レスポンスが完全なビューである場合、Railsはビューをレイアウトでラップし、パーシャルビューを取り込むための追加の作業も行います。これらのパスは、このガイドの後半で説明します。

2 レスポンスの作成

コントローラの観点からは、HTTPレスポンスを作成する方法は3つあります：

• renderを呼び出して、ブラウザに送信するための完全なレスポンスを作成する
• redirect_toを呼び出して、ブラウザにHTTPリダイレクトステータスコードを送信する
• headを呼び出して、ブラウザに送信するためのHTTPヘッダのみからなるレスポンスを作成する

2.1 デフォルトでのレンダリング：アクションにおける慣例の優先

Railsは「慣例よりも設定」を推進していることを聞いたことがあるかもしれません。デフォルトのレンダリングは、これの優れた例です。Railsでは、デフォルトでは、有効なルートに対応する名前のビューを自動的にレンダリングするようにコントローラが設定されています。たとえば、BooksControllerクラスに次のコードがある場合：

class BooksController < ApplicationController
end

そして、ルートファイルに次のコードがある場合：

resources :books

そして、app/views/books/index.html.erbというビューファイルがある場合：

<h1>Books are coming soon!</h1>

/booksに移動すると、Railsは自動的にapp/views/books/index.html.erbをレンダリングし、「Books are coming soon!」が画面に表示されます。

ただし、まだまだ準備中の画面は最小限の有用性しかありませんので、すぐにBookモデルを作成し、BooksControllerにインデックスアクションを追加します：

class BooksController < ApplicationController
  def index
    @books = Book.all
  end
end

「慣例よりも設定」の原則に従って、インデックスアクションの最後に明示的なレンダリングがないことに注意してください。ルールは、コントローラのアクションの最後に何も明示的にレンダリングしない場合、Railsはコントローラのビューパスにあるaction_name.html.erbテンプレートを自動的に探し、それをレンダリングします。したがって、この場合、Railsはapp/views/books/index.html.erbファイルをレンダリングします。

ビューにすべての書籍のプロパティを表示したい場合、次のようなERBテンプレートを使用できます：

<h1>Listing Books</h1>

<table>
  <thead>
    <tr>
      <th>Title</th>
      <th>Content</th>
      <th colspan="3"></th>
    </tr>
  </thead>

  <tbody>
    <% @books.each do |book| %>
      <tr>
        <td><%= book.title %></td>
        <td><%= book.content %></td>
        <td><%= link_to "Show", book %></td>
        <td><%= link_to "Edit", edit_book_path(book) %></td>
        <td><%= link_to "Destroy", book, data: { turbo_method: :delete, turbo_confirm: "Are you sure?" } %></td>
      </tr>
    <% end %>
  </tbody>
</table>

<br>

<%= link_to "New book", new_book_path %>

注意：実際のレンダリングは、ActionView::Template::Handlersモジュールのネストされたクラスによって行われます。このガイドではそのプロセスには詳しく触れませんが、ビューのファイル拡張子はテンプレートハンドラの選択を制御するため、重要なことを知っておく必要があります。

2.2 renderの使用

ほとんどの場合、コントローラのrenderメソッドが、ブラウザで使用するためにアプリケーションのコンテンツをレンダリングするための重要な役割を果たします。renderの動作をカスタマイズする方法はさまざまあります。Railsテンプレートのデフォルトビューをレンダリングしたり、特定のテンプレートやファイル、インラインコード、何もレンダリングしないようにしたりできます。テキスト、JSON、XMLをレンダリングすることもできます。レンダリングされるレスポンスのコンテンツタイプやHTTPステータスも指定できます。

2.2.1 アクションのビューをレンダリングする

同じコントローラ内の別のテンプレートに対応するビューをレンダリングしたい場合は、renderを使用してビューの名前を指定することができます。

def update
  @book = Book.find(params[:id])
  if @book.update(book_params)
    redirect_to(@book)
  else
    render "edit"
  end
end

updateの呼び出しが失敗した場合、このコントローラ内のupdateアクションは、同じコントローラに属するedit.html.erbテンプレートをレンダリングします。

もし好みであれば、文字列の代わりにシンボルを使用してレンダリングするアクションを指定することもできます。

def update
  @book = Book.find(params[:id])
  if @book.update(book_params)
    redirect_to(@book)
  else
    render :edit, status: :unprocessable_entity
  end
end

2.2.2 別のコントローラのアクションのテンプレートをレンダリングする

アクションコードを含むコントローラとは異なるコントローラのテンプレートをレンダリングしたい場合は、renderを使用してレンダリングするテンプレートの完全なパス（app/viewsに対する相対パス）を指定することもできます。たとえば、app/controllers/adminに存在するAdminProductsControllerでコードを実行している場合、次のようにしてapp/views/productsのテンプレートの結果をレンダリングすることができます。

render "products/show"

スラッシュ文字が文字列に埋め込まれているため、Railsはこのビューが別のコントローラに属していることを認識します。明示的にする場合は、templateオプションを使用することもできます（Rails 2.2以前では必須でした）。

render template: "products/show"

2.2.3 まとめ

上記の2つのレンダリング方法（同じコントローラ内の別のアクションのテンプレートをレンダリングし、異なるコントローラの別のアクションのテンプレートをレンダリングする）は、実際には同じ操作のバリエーションです。

実際には、BooksControllerクラスのupdateアクション内で、本が正常に更新されない場合にedit.html.erbテンプレートをviews/booksディレクトリにレンダリングするため、次のすべてのレンダリング呼び出しは同じ結果をもたらします。

render :edit
render action: :edit
render "edit"
render action: "edit"
render "books/edit"
render template: "books/edit"

どれを使用するかはスタイルと慣習の問題ですが、書いているコードに合理的な最もシンプルなものを使用することが原則です。

2.2.4 renderと:inlineの使用

renderメソッドは、メソッド呼び出しの一部としてERBを提供するために、ビューを完全に使用しないこともできます。これは完全に有効な方法です。

render inline: "<% products.each do |p| %><p><%= p.name %></p><% end %>"

警告：このオプションを使用する良い理由はほとんどありません。コントローラにERBを混ぜ込むことは、RailsのMVC指向に反するものであり、他の開発者がプロジェクトのロジックを追うのが難しくなります。代わりに別のerbビューを使用してください。

デフォルトでは、インラインレンダリングはERBを使用します。:typeオプションを使用して代わりにBuilderを使用するように強制することもできます。

render inline: "xml.p {'Horrid coding practice!'}", type: :builder

2.2.5 テキストのレンダリング

renderの:plainオプションを使用して、ブラウザにマークアップのないプレーンテキストを送信することができます。

render plain: "OK"

注意: :plainオプションを使用すると、テキストは現在のレイアウトを使用せずにレンダリングされます。テキストを現在のレイアウトに配置するには、layout: trueオプションを追加し、レイアウトファイルの拡張子に.text.erbを使用する必要があります。

2.2.6 HTMLのレンダリング

renderの:htmlオプションを使用して、HTML文字列をブラウザに送信することができます。

render html: helpers.tag.strong('Not Found')

注意: html:オプションを使用する場合、HTMLエンティティは、文字列がhtml_safe対応のAPIと組み合わされていない場合にエスケープされます。

2.2.7 JSONのレンダリング

JSONは、多くのAjaxライブラリで使用されるJavaScriptデータ形式です。Railsには、オブジェクトをJSONに変換し、そのJSONをブラウザにレンダリングするための組み込みサポートがあります。

render json: @product

2.2.8 XMLのレンダリング

Railsには、オブジェクトをXMLに変換し、そのXMLを呼び出し元にレンダリングするための組み込みサポートもあります。

render xml: @product

2.2.9 バニラJavaScriptのレンダリング

RailsはバニラJavaScriptをレンダリングすることもできます。

render js: "alert('Hello Rails');"

これにより、指定された文字列がtext/javascriptのMIMEタイプでブラウザに送信されます。

2.2.10 生のボディのレンダリング

renderのbodyオプションを使用して、コンテンツタイプを設定せずに生のコンテンツをブラウザに送信することができます。

render body: "raw"

2.2.11 生のファイルのレンダリング

Railsは絶対パスから生のファイルをレンダリングすることができます。これは、エラーページなどの静的ファイルを条件付きでレンダリングするのに便利です。

render file: "#{Rails.root}/public/404.html", layout: false

これは生のファイルをレンダリングします（ERBや他のハンドラはサポートされていません）。デフォルトでは、現在のレイアウト内でレンダリングされます。

2.2.12 オブジェクトのレンダリング

Railsは、:render_inに応答するオブジェクトをレンダリングすることができます。

render MyRenderable.new

これは、提供されたオブジェクトに対して現在のビューコンテキストでrender_inを呼び出します。

また、renderのrenderableオプションを使用してオブジェクトを指定することもできます。

render renderable: MyRenderable.new

2.2.13 renderのオプション

renderメソッドへの呼び出しは、一般的に6つのオプションを受け入れます。

• :content_type
• :layout
• :location
• :status
• :formats
• :variants

2.2.13.1 :content_typeオプション

デフォルトでは、Railsはレンダリング操作の結果をtext/htmlのMIMEコンテンツタイプで提供します（:jsonオプションを使用する場合はapplication/json、:xmlオプションの場合はapplication/xml）。これを変更したい場合は、:content_typeオプションを設定することができます。

render template: "feed", content_type: "application/rss"

2.2.13.2 :layoutオプション

renderのほとんどのオプションでは、レンダリングされたコンテンツは現在のレイアウトの一部として表示されます。レイアウトについては、このガイドの後のセクションで詳しく説明します。

layoutオプションを使用して、現在のアクションのレイアウトとして特定のファイルを使用するようRailsに指示することができます。

render layout: "special_layout"

また、Railsにレイアウトを使用せずにレンダリングするよう指示することもできます。

render layout: false

2.2.13.3 :locationオプション

locationオプションを使用して、HTTPのLocationヘッダーを設定することができます。

render xml: photo, location: photo_url(photo)

2.2.13.4 :statusオプション

Railsは自動的に正しいHTTPステータスコードを持つレスポンスを生成します（ほとんどの場合、これは200 OKです）。これを変更するためには、:statusオプションを使用できます。

render status: 500
render status: :forbidden

Railsは、下記に示す数値ステータスコードと対応するシンボルの両方を理解します。

注意：非コンテンツのステータスコード（100-199、204、205、または304）と一緒にコンテンツをレンダリングしようとすると、レスポンスから削除されます。

2.2.13.5 :formatsオプション

Railsは、リクエストで指定されたフォーマット（またはデフォルトで:html）を使用します。シンボルまたは配列を使用して:formatsオプションを渡すことで、これを変更できます。

render formats: :xml
render formats: [:json, :xml]

指定されたフォーマットのテンプレートが存在しない場合、ActionView::MissingTemplateエラーが発生します。

2.2.13.6 :variantsオプション

これにより、Railsは同じフォーマットのテンプレートのバリエーションを探します。 シンボルまたは配列を使用して、variantsオプションでバリアントのリストを指定できます。

使用例は次のとおりです。

# HomeController#indexで呼び出される
render variants: [:mobile, :desktop]

このバリアントのセットでは、Railsは次のセットのテンプレートを探し、最初に存在するものを使用します。

• app/views/home/index.html+mobile.erb
• app/views/home/index.html+desktop.erb
• app/views/home/index.html.erb

指定されたフォーマットのテンプレートが存在しない場合、ActionView::MissingTemplateエラーが発生します。

レンダリング呼び出しでバリアントを設定する代わりに、コントローラアクションのリクエストオブジェクトに設定することもできます。

def index
  request.variant = determine_variant
end

private
  def determine_variant
    variant = nil
    # 使用するバリアントを決定するためのコード
    variant = :mobile if session[:use_mobile]

    variant
  end

2.2.14 レイアウトの検索

現在のレイアウトを見つけるために、Railsはコントローラと同じベース名のファイルをapp/views/layoutsで検索します。たとえば、PhotosControllerクラスからアクションをレンダリングすると、app/views/layouts/photos.html.erb（またはapp/views/layouts/photos.builder）が使用されます。そのようなコントローラ固有のレイアウトが存在しない場合、Railsはapp/views/layouts/application.html.erbまたはapp/views/layouts/application.builderを使用します。.erbのレイアウトが存在しない場合、.builderのレイアウトが存在する場合はそれを使用します。Railsはまた、個々のコントローラとアクションに特定のレイアウトをより正確に割り当てるためのいくつかの方法も提供しています。

2.2.14.1 コントローラに対するレイアウトの指定

layout宣言を使用して、コントローラ内でデフォルトのレイアウトの規則をオーバーライドできます。例：

class ProductsController < ApplicationController
  layout "inventory"
  #...
end

この宣言により、ProductsControllerによってレンダリングされるすべてのビューは、そのレイアウトとしてapp/views/layouts/inventory.html.erbを使用します。

アプリケーション全体に特定のレイアウトを割り当てるには、ApplicationControllerクラスでlayout宣言を使用します。

class ApplicationController < ActionController::Base
  layout "main"
  #...
end

この宣言により、アプリケーション全体のすべてのビューは、そのレイアウトとしてapp/views/layouts/main.html.erbを使用します。

2.2.14.2 実行時にレイアウトを選択する

シンボルを使用して、レイアウトの選択をリクエストが処理されるまで延期することができます。

class ProductsController < ApplicationController
  layout :products_layout

  def show
    @product = Product.find(params[:id])
  end

  private
    def products_layout
      @current_user.special? ? "special" : "products"
    end
end

これにより、現在のユーザが特別なユーザである場合、製品を表示するときに特別なレイアウトが表示されます。

Procなどのインラインメソッドを使用して、レイアウトを決定することもできます。たとえば、Procオブジェクトを渡す場合、Procに与えられるブロックにはcontrollerインスタンスが与えられるため、現在のリクエストに基づいてレイアウトを決定できます。

class ProductsController < ApplicationController
  layout Proc.new { |controller| controller.request.xhr? ? "popup" : "application" }
end

2.2.14.3 条件付きレイアウト

コントローラレベルで指定されたレイアウトは、:onlyおよび:exceptオプションをサポートしています。これらのオプションは、コントローラ内のメソッド名またはメソッド名の配列を取ります。

class ProductsController < ApplicationController
  layout "product", except: [:index, :rss]
end

この宣言により、rssおよびindexメソッド以外のすべてにproductレイアウトが使用されます。

2.2.14.4 レイアウトの継承

レイアウトの宣言は階層的に下方向に伝播し、より具体的なレイアウトの宣言が常に一般的なものを上書きします。例：

• application_controller.rb

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

  Copy

• articles_controller.rb

  class ArticlesController < ApplicationController
  end
  

  Copy

• special_articles_controller.rb

  class SpecialArticlesController < ArticlesController
    layout "special"
  end
  

  Copy

• old_articles_controller.rb

  class OldArticlesController < SpecialArticlesController
    layout false
  
    def show
      @article = Article.find(params[:id])
    end
  
    def index
      @old_articles = Article.older
      render layout: "old"
    end
    # ...
  end
  

  Copy

このアプリケーションでは：

• 一般的には、ビューはmainレイアウトでレンダリングされます
• ArticlesController#indexはmainレイアウトを使用します
• SpecialArticlesController#indexはspecialレイアウトを使用します
• OldArticlesController#showはレイアウトを使用しません
• OldArticlesController#indexはoldレイアウトを使用します ##### テンプレートの継承

レイアウトの継承ロジックと同様に、テンプレートやパーシャルが通常のパスで見つからない場合、コントローラは継承チェーン内のテンプレートやパーシャルをレンダリングするために探します。例えば：

# app/controllers/application_controller.rb
class ApplicationController < ActionController::Base
end

# app/controllers/admin_controller.rb
class AdminController < ApplicationController
end

# app/controllers/admin/products_controller.rb
class Admin::ProductsController < AdminController
  def index
  end
end

admin/products#index アクションの探索順序は次のようになります：

• app/views/admin/products/
• app/views/admin/
• app/views/application/

これにより、app/views/application/ は共有パーシャルのための素晴らしい場所となります。これらは次のように ERB 内でレンダリングされます：

<%# app/views/admin/products/index.html.erb %>
<%= render @products || "empty_list" %>

<%# app/views/application/_empty_list.html.erb %>
このリストにはまだアイテムがありません。<em>yet</em>。

2.2.15 二重レンダーエラーの回避

ほとんどの Rails 開発者は、いずれは「Can only render or redirect once per action」というエラーメッセージを見ることになるでしょう。これは面倒ですが、比較的簡単に修正できます。通常、これは render の動作を理解していないために発生します。

例えば、次のコードはこのエラーを引き起こします：

def show
  @book = Book.find(params[:id])
  if @book.special?
    render action: "special_show"
  end
  render action: "regular_show"
end

@book.special? が true に評価されると、Rails は @book 変数を special_show ビューに出力するためのレンダリングプロセスを開始します。しかし、これは show アクションの残りのコードの実行を停止しないため、Rails はアクションの末尾に達すると regular_show ビューをレンダリングし、エラーをスローします。解決策は簡単です：単一のコードパスで render または redirect を1回だけ呼び出すことを確認してください。return が役立つことがあります。以下はメソッドの修正バージョンです：

def show
  @book = Book.find(params[:id])
  if @book.special?
    render action: "special_show"
    return
  end
  render action: "regular_show"
end

注意点として、ActionController によって暗黙のレンダリングが行われ、render が呼び出されたかどうかを検出するため、次のコードはエラーなしで動作します：

def show
  @book = Book.find(params[:id])
  if @book.special?
    render action: "special_show"
  end
end

これにより、special? が設定された本は special_show テンプレートでレンダリングされ、他の本はデフォルトの show テンプレートでレンダリングされます。

2.3 redirect_to の使用

HTTP リクエストに対するレスポンスを返す別の方法として、redirect_to を使用することもできます。先ほど見たように、render は Rails にレスポンスを構築するためにどのビュー（または他のアセット）を使用するかを伝えます。redirect_to メソッドはまったく異なることを行います：ブラウザに別の URL に対して新しいリクエストを送信するように指示します。例えば、次の呼び出しでコード内のどこからでもアプリケーション内の写真のインデックスにリダイレクトできます：

redirect_to photos_url

redirect_back を使用して、ユーザーを直前のページに戻すこともできます。この場所は、ブラウザによって設定される保証がない HTTP_REFERER ヘッダから取得されますので、この場合に使用する fallback_location を指定する必要があります。

redirect_back(fallback_location: root_path)

注意：redirect_to と redirect_back はメソッドの実行から直ちに中断して戻るのではなく、単に HTTP レスポンスを設定します。それらの後にある文は実行されます。必要に応じて、明示的な return や他の中断メカニズムによって中断することができます。

2.3.1 異なるリダイレクトステータスコードの取得

Rails は redirect_to を呼び出すときに HTTP ステータスコード 302（一時的なリダイレクト）を使用します。もし異なるステータスコード、例えば 301（恒久的なリダイレクト）を使用したい場合は、:status オプションを使用できます：

redirect_to photos_path, status: 301

render の :status オプションと同様に、redirect_to の :status は数値とシンボルの両方のヘッダ指定を受け入れます。

2.3.2 render と redirect_to の違い

経験の浅い開発者は、redirect_to を goto コマンドのようなものと考え、Rails コード内での実行を一つの場所から別の場所に移動するものとして考えることがあります。これは正しくありません。コードの実行は停止し、ブラウザからの新しいリクエストを待ちます。ただし、HTTP 302 ステータスコードを送り返すことで、ブラウザに次にどのリクエストを行うべきかを伝えているだけです。

違いを確認するために、次のアクションを考えてみましょう：

def index
  @books = Book.all
end

def show
  @book = Book.find_by(id: params[:id])
  if @book.nil?
    render action: "index"
  end
end

この形式のコードでは、@book 変数が nil の場合に問題が発生する可能性があります。render :action はターゲットアクション内のコードを実行しないため、おそらく index ビューで必要とされる @books 変数を設定するものは何もありません。これを修正する方法の一つは、レンダリングではなくリダイレクトすることです： ```ruby def index @books = Book.all end

def show @book = Book.find_by(id: params[:id]) if @book.nil? redirect_to action: :index end end ```

このコードでは、ブラウザはインデックスページのために新しいリクエストを行い、indexメソッドのコードが実行され、すべてが正常に動作します。

このコードの唯一の欠点は、ブラウザへの往復が必要であることです。ブラウザは/books/1というshowアクションをリクエストし、コントローラは本が存在しないことを検出し、コントローラはブラウザに対して302リダイレクトレスポンスを送信して/books/に移動するよう指示します。ブラウザはこれに従い、新しいリクエストをコントローラに送信してindexアクションを要求します。コントローラはデータベースからすべての本を取得し、インデックステンプレートをレンダリングしてブラウザに送信し、ブラウザはそれを画面に表示します。

小規模なアプリケーションでは、この追加の待ち時間は問題にならないかもしれませんが、レスポンス時間が心配な場合は考慮する必要があります。次に、矛盾した例を使用して、この問題を処理する方法を示します。

def index
  @books = Book.all
end

def show
  @book = Book.find_by(id: params[:id])
  if @book.nil?
    @books = Book.all
    flash.now[:alert] = "本が見つかりませんでした"
    render "index"
  end
end

これにより、指定されたIDの本が存在しないことが検出され、モデル内のすべての本を含む@booksインスタンス変数が作成され、直接index.html.erbテンプレートがレンダリングされ、ユーザーに何が起こったかを伝えるフラッシュアラートメッセージがブラウザに返されます。

2.4 headを使用してヘッダーのみのレスポンスを作成する

headメソッドは、ヘッダーのみを含むレスポンスをブラウザに送信するために使用できます。headメソッドは、HTTPステータスコードを表す数値またはシンボル（参照表を参照）を受け入れます。オプション引数は、ヘッダー名と値のハッシュとして解釈されます。たとえば、エラーヘッダーのみを返すことができます。

head :bad_request

これにより、次のヘッダーが生成されます。

HTTP/1.1 400 Bad Request
Connection: close
Date: Sun, 24 Jan 2010 12:15:53 GMT
Transfer-Encoding: chunked
Content-Type: text/html; charset=utf-8
X-Runtime: 0.013483
Set-Cookie: _blog_session=...snip...; path=/; HttpOnly
Cache-Control: no-cache

または、他のHTTPヘッダーを使用して他の情報を伝えることもできます。

head :created, location: photo_path(@photo)

これにより、次のヘッダーが生成されます。

HTTP/1.1 201 Created
Connection: close
Date: Sun, 24 Jan 2010 12:16:44 GMT
Transfer-Encoding: chunked
Location: /photos/1
Content-Type: text/html; charset=utf-8
X-Runtime: 0.083496
Set-Cookie: _blog_session=...snip...; path=/; HttpOnly
Cache-Control: no-cache

3 レイアウトの構造化

Railsがビューをレスポンスとしてレンダリングする際、現在のレイアウトとビューを組み合わせるために、このガイドで説明した現在のレイアウトを見つけるためのルールを使用します。レイアウト内では、次の3つのツールを使用して、異なる出力のビットを組み合わせて全体のレスポンスを形成することができます。

• アセットタグ
• yieldとcontent_for
• パーシャル

3.1 アセットタグヘルパー

アセットタグヘルパーは、ビューをフィード、JavaScript、スタイルシート、画像、ビデオ、オーディオにリンクするためのHTMLを生成するためのメソッドを提供します。Railsには6つのアセットタグヘルパーがあります。

• auto_discovery_link_tag
• javascript_include_tag
• stylesheet_link_tag
• image_tag
• video_tag
• audio_tag

これらのタグは、レイアウトや他のビューで使用できますが、auto_discovery_link_tag、javascript_include_tag、stylesheet_link_tagは、レイアウトの<head>セクションで最も一般的に使用されます。

警告: アセットタグヘルパーは、指定された場所にアセットが存在するかどうかを検証しません。単にあなたが何をしているかを前提としてリンクを生成します。

3.1.1 auto_discovery_link_tagを使用してフィードにリンクする

auto_discovery_link_tagヘルパーは、ほとんどのブラウザとフィードリーダーがRSS、Atom、またはJSONフィードの存在を検出するために使用できるHTMLを生成します。リンクのタイプ（:rss、:atom、または:json）、url_forに渡されるオプションのハッシュ、およびタグのオプションのハッシュを取ります。

<%= auto_discovery_link_tag(:rss, {action: "feed"},
  {title: "RSSフィード"}) %>

auto_discovery_link_tagには、次の3つのタグオプションがあります。

• :relはリンクのrel値を指定します。デフォルト値は「alternate」です。
• :typeは明示的なMIMEタイプを指定します。Railsは適切なMIMEタイプを自動的に生成します。
• :titleはリンクのタイトルを指定します。デフォルト値は大文字の:type値です。たとえば、「ATOM」または「RSS」です。 #### javascript_include_tagを使用してJavaScriptファイルにリンクする

javascript_include_tagヘルパーは、指定されたソースごとにHTMLのscriptタグを返します。

Asset Pipelineが有効なRailsを使用している場合、このヘルパーはpublic/javascriptsではなく/assets/javascripts/へのリンクを生成します。このリンクはAsset Pipelineによって提供されます。

RailsアプリケーションまたはRailsエンジン内のJavaScriptファイルは、app/assets、lib/assets、またはvendor/assetsのいずれかの場所に配置されます。これらの場所についての詳細は、Asset PipelineガイドのAsset Organizationセクションで説明されています。

ドキュメントルートに対するフルパスまたはURLを指定することもできます。たとえば、app/assets、lib/assets、またはvendor/assetsのいずれかのディレクトリ内にあるJavaScriptファイルにリンクするには、次のようにします。

<%= javascript_include_tag "main" %>

Railsは次のようなscriptタグを出力します。

<script src='/assets/main.js'></script>

このアセットへのリクエストは、Sprockets gemによって提供されます。

app/assets/javascripts/main.jsとapp/assets/javascripts/columns.jsのような複数のファイルを同時に含めるには、次のようにします。

<%= javascript_include_tag "main", "columns" %>

app/assets/javascripts/main.jsとapp/assets/javascripts/photos/columns.jsを含めるには、次のようにします。

<%= javascript_include_tag "main", "/photos/columns" %>

http://example.com/main.jsを含めるには、次のようにします。

<%= javascript_include_tag "http://example.com/main.js" %>

3.1.2 stylesheet_link_tagを使用してCSSファイルにリンクする

stylesheet_link_tagヘルパーは、指定されたソースごとにHTMLの<link>タグを返します。

Asset Pipelineが有効なRailsを使用している場合、このヘルパーは/assets/stylesheets/へのリンクを生成します。このリンクはSprockets gemによって処理されます。スタイルシートファイルは、app/assets、lib/assets、またはvendor/assetsのいずれかの場所に保存できます。

ドキュメントルートに対するフルパスまたはURLを指定することもできます。たとえば、app/assets、lib/assets、またはvendor/assetsのいずれかのディレクトリ内にあるスタイルシートファイルにリンクするには、次のようにします。

<%= stylesheet_link_tag "main" %>

app/assets/stylesheets/main.cssとapp/assets/stylesheets/columns.cssを含めるには、次のようにします。

<%= stylesheet_link_tag "main", "columns" %>

app/assets/stylesheets/main.cssとapp/assets/stylesheets/photos/columns.cssを含めるには、次のようにします。

<%= stylesheet_link_tag "main", "photos/columns" %>

http://example.com/main.cssを含めるには、次のようにします。

<%= stylesheet_link_tag "http://example.com/main.css" %>

デフォルトでは、stylesheet_link_tagはrel="stylesheet"を持つリンクを作成します。適切なオプション（:rel）を指定することで、このデフォルトを上書きすることができます。

<%= stylesheet_link_tag "main_print", media: "print" %>

3.1.3 image_tagを使用して画像にリンクする

image_tagヘルパーは、指定されたファイルに対してHTMLの<img />タグを作成します。デフォルトでは、ファイルはpublic/imagesから読み込まれます。

警告：画像の拡張子を指定する必要があることに注意してください。

<%= image_tag "header.png" %>

必要に応じて画像へのパスを指定することもできます。

<%= image_tag "icons/delete.gif" %>

追加のHTMLオプションのハッシュを指定することもできます。

<%= image_tag "icons/delete.gif", {height: 45} %>

画像がオフになっている場合に使用される代替テキストを指定することもできます。明示的にaltテキストを指定しない場合、ファイル名がデフォルトのaltテキストとして使用されます。たとえば、次の2つの画像タグは同じコードを返します。

<%= image_tag "home.gif" %>
<%= image_tag "home.gif", alt: "Home" %>

特殊なサイズタグも指定できます。形式は"{幅}x{高さ}"です。

<%= image_tag "home.gif", size: "50x20" %>

上記の特殊なタグに加えて、class、id、またはnameなどの標準的なHTMLオプションのハッシュを指定することもできます。

<%= image_tag "home.gif", alt: "Go Home",
                          id: "HomeImage",
                          class: "nav_bar" %>

3.1.4 video_tagを使用してビデオにリンクする

video_tagヘルパーは、指定されたファイルに対してHTML5の<video>タグを作成します。デフォルトでは、ファイルはpublic/videosから読み込まれます。

<%= video_tag "movie.ogg" %>

次のようになります。

<video src="/videos/movie.ogg" />

image_tagのように、パスを指定することもできます。絶対パスまたはpublic/videosディレクトリに対する相対パスです。さらに、image_tagと同様に、size: "#{width}x#{height}"オプションを指定することもできます。ビデオタグには、id、classなどのHTMLオプションも指定できます。

ビデオタグは、HTMLオプションハッシュを介して<video>のすべてのHTMLオプションもサポートしています。これには、次のものが含まれます。

• poster: "image_name.png"：ビデオが再生される前に表示する画像を提供します。
• autoplay: true：ページの読み込み時にビデオを再生します。
• loop: true：ビデオが終了したらループします。
• controls: true：ユーザーがビデオと対話するためのブラウザが提供するコントロールを表示します。
• autobuffer: true：ビデオはページの読み込み時にファイルをプリロードします。 video_tagに配列のビデオを渡すことで、複数のビデオを指定することもできます。

<%= video_tag ["trailer.ogg", "movie.ogg"] %>

これにより、以下のような出力が生成されます。

<video>
  <source src="/videos/trailer.ogg">
  <source src="/videos/movie.ogg">
</video>

3.1.5 audio_tagを使用してオーディオファイルにリンクする

audio_tagヘルパーは、指定されたファイルにHTML5の<audio>タグを作成します。デフォルトでは、ファイルはpublic/audiosからロードされます。

<%= audio_tag "music.mp3" %>

必要に応じてオーディオファイルへのパスを指定することもできます。

<%= audio_tag "music/first_song.mp3" %>

また、:id、:classなどの追加オプションのハッシュを指定することもできます。

video_tagと同様に、audio_tagには特別なオプションがあります。

• autoplay: trueは、ページの読み込み時にオーディオを再生します。
• controls: trueは、ユーザーがオーディオと対話するためのブラウザが提供するコントロールを提供します。
• autobuffer: trueは、ページの読み込み時にユーザーのためにファイルを事前にロードします。

3.2 yieldの理解

レイアウトの文脈では、yieldはビューからのコンテンツが挿入されるセクションを識別します。これを使用する最も簡単な方法は、単一のyieldを持つことで、現在レンダリングされているビューのすべての内容が挿入されます。

<html>
  <head>
  </head>
  <body>
  <%= yield %>
  </body>
</html>

また、複数のyielding領域を持つレイアウトを作成することもできます。

<html>
  <head>
  <%= yield :head %>
  </head>
  <body>
  <%= yield %>
  </body>
</html>

ビューのメインボディは常に無名のyieldにレンダリングされます。名前付きのyieldにコンテンツをレンダリングするには、content_forメソッドを使用します。

3.3 content_forメソッドの使用

content_forメソッドを使用すると、レイアウト内の名前付きのyieldブロックにコンテンツを挿入できます。たとえば、次のビューは、先ほど見たレイアウトと一緒に動作します。

<% content_for :head do %>
  <title>A simple page</title>
<% end %>

<p>Hello, Rails!</p>

このページを指定されたレイアウトにレンダリングすると、次のHTMLが生成されます。

<html>
  <head>
  <title>A simple page</title>
  </head>
  <body>
  <p>Hello, Rails!</p>
  </body>
</html>

content_forメソッドは、レイアウトにサイドバーやフッターなどの独自のコンテンツブロックを挿入する必要がある場合に非常に便利です。また、ページ固有のJavaScriptやCSSファイルをヘッダーに挿入するためのタグを挿入するのにも便利です。

3.4 パーシャルの使用

パーシャルテンプレート（通常は「パーシャル」と呼ばれます）は、レンダリングプロセスをより管理しやすいチャンクに分割するための別のデバイスです。パーシャルを使用すると、特定のレスポンスの特定の部分をレンダリングするためのコードを独自のファイルに移動できます。

3.4.1 パーシャルの命名

ビューの一部としてパーシャルをレンダリングするには、ビュー内でrenderメソッドを使用します。

<%= render "menu" %>

これにより、レンダリングされているビューのそのポイントで_menu.html.erbという名前のファイルがレンダリングされます。先頭にアンダースコアが付いていることに注意してください：パーシャルはアンダースコアなしで参照されますが、通常のビューとは異なることを区別するために先頭にアンダースコアが付けられます。これは、別のフォルダからパーシャルを取り込む場合でも同様です。

<%= render "shared/menu" %>

このコードは、app/views/shared/_menu.html.erbからパーシャルを取り込みます。

3.4.2 パーシャルを使用してビューを簡素化する

パーシャルを使用する方法の1つは、サブルーチンのように扱うことです。つまり、ビューから詳細を移動して、何が起こっているかをより簡単に把握できるようにする方法です。たとえば、次のようなビューがあるかもしれません。

<%= render "shared/ad_banner" %>

<h1>Products</h1>

<p>Here are a few of our fine products:</p>
...

<%= render "shared/footer" %>

ここでは、_ad_banner.html.erbと_footer.html.erbのパーシャルには、アプリケーションの多くのページで共有されるコンテンツが含まれているかもしれません。特定のページに集中しているときにこれらのセクションの詳細を見る必要はありません。

このガイドの前のセクションで見たように、yieldはレイアウトをきれいにするための非常に強力なツールです。それは純粋なRubyなので、ほとんどの場所で使用することができます。たとえば、いくつかの類似したリソースに対してフォームレイアウトの定義をDRYにするために使用することができます。

• users/index.html.erb

  <%= render "shared/search_filters", search: @q do |form| %>
    <p>
      Name contains: <%= form.text_field :name_contains %>
    </p>
  <% end %>
  

  Copy

• roles/index.html.erb

  <%= render "shared/search_filters", search: @q do |form| %>
    <p>
      Title contains: <%= form.text_field :title_contains %>
    </p>
  <% end %>
  

  Copy

• shared/_search_filters.html.erb

  <%= form_with model: search do |form| %>
    <h1>検索フォーム:</h1>
    <fieldset>
      <%= yield form %>
    </fieldset>
    <p>
      <%= form.submit "検索" %>
    </p>
  <% end %>
  

  Copy

3.4.3 パーシャルレイアウト

パーシャルは、ビューがレイアウトを使用できるように、独自のレイアウトファイルを使用することができます。たとえば、次のようにパーシャルを呼び出すことができます。

<%= render partial: "link_area", layout: "graybar" %>

これにより、_link_area.html.erbという名前のパーシャルが探され、_graybar.html.erbレイアウトを使用してレンダリングされます。パーシャルのレイアウトも通常のパーシャルと同じように、先頭にアンダースコアが付いている命名規則に従い、パーシャルが属するフォルダに配置されます（マスターのlayoutsフォルダではありません）。

また、:layoutなどの追加オプションを渡す場合は、明示的に:partialを指定する必要があることにも注意してください。

3.4.4 ローカル変数の渡し方

パーシャルにもローカル変数を渡すことができ、それによりさらに強力で柔軟なものにすることができます。たとえば、このテクニックを使用して、新規作成ページと編集ページの間の重複を減らしながら、少し異なるコンテンツを保持することができます。

• new.html.erb

  <h1>新しいゾーン</h1>
  <%= render partial: "form", locals: {zone: @zone} %>
  

  Copy

• edit.html.erb

  <h1>ゾーンの編集</h1>
  <%= render partial: "form", locals: {zone: @zone} %>
  

  Copy

• _form.html.erb

  <%= form_with model: zone do |form| %>
    <p>
      <b>ゾーン名</b><br>
      <%= form.text_field :name %>
    </p>
    <p>
      <%= form.submit %>
    </p>
  <% end %>
  

  Copy

同じパーシャルが両方のビューにレンダリングされますが、Action Viewのsubmitヘルパーは、新規作成アクションでは「ゾーンの作成」、編集アクションでは「ゾーンの更新」という結果を返します。

特定の場合にのみパーシャルにローカル変数を渡すには、local_assignsを使用します。

• index.html.erb

  <%= render user.articles %>
  

  Copy

• show.html.erb

  <%= render article, full: true %>
  

  Copy

• _article.html.erb

  <h2><%= article.title %></h2>
  
  <% if local_assigns[:full] %>
    <%= simple_format article.body %>
  <% else %>
    <%= truncate article.body %>
  <% end %>
  

  Copy

これにより、すべてのローカル変数を宣言する必要なく、パーシャルを使用することができます。

すべてのパーシャルには、同じ名前のローカル変数があります（先頭のアンダースコアを除く）。このローカル コレクションが空の場合、renderはnilを返すため、代替コンテンツを提供するのは非常に簡単です。

<h1>Products</h1>
<%= render(@products) || "There are no products available." %>

3.4.5 ローカル変数

パーシャル内でカスタムのローカル変数名を使用するには、パーシャルへの呼び出しで:asオプションを指定します。

<%= render partial: "product", collection: @products, as: :item %>

この変更により、パーシャル内で@productsコレクションのインスタンスにitemローカル変数としてアクセスできます。

また、locals: {}オプションを使用してレンダリングしている任意のパーシャルに任意のローカル変数を渡すこともできます。

<%= render partial: "product", collection: @products,
           as: :item, locals: {title: "Products Page"} %>

この場合、パーシャルは値が "Products Page" のtitleローカル変数にアクセスできます。

3.4.6 カウンタ変数

Railsは、コレクションによって呼び出されるパーシャル内で利用可能なカウンタ変数も提供します。変数は、パーシャルのタイトルに続く_counterという名前になります。たとえば、コレクション@productsをレンダリングするとき、パーシャル_product.html.erbはproduct_counter変数にアクセスできます。この変数は、パーシャルが閉じているビュー内でレンダリングされた回数をインデックス化し、最初のレンダリングでは0の値から始まります。

# index.html.erb
<%= render partial: "product", collection: @products %>

# _product.html.erb
<%= product_counter %> # 最初の商品は0、2番目の商品は1...

as:オプションを使用してパーシャル名を変更した場合でも、この方法は機能します。したがって、as: :itemを行った場合、カウンタ変数はitem_counterになります。

3.4.7 スペーサーテンプレート

メインのパーシャルのインスタンス間にレンダリングするために、spacer_templateオプションを使用して2番目のパーシャルを指定することもできます。

<%= render partial: @products, spacer_template: "product_ruler" %>

Railsは、各_productパーシャルのペア間にデータを渡さずに_product_rulerパーシャルをレンダリングします。

3.4.8 コレクションパーシャルのレイアウト

コレクションをレンダリングする際に、layoutオプションを使用することもできます。

<%= render partial: "product", collection: @products, layout: "special_layout" %>

レイアウトは、コレクション内の各アイテムのパーシャルと一緒にレンダリングされます。現在のオブジェクトとobject_counter変数も、パーシャル内と同じようにレイアウトで利用できます。

3.5 ネストされたレイアウトの使用

アプリケーションには、特定のコントローラをサポートするために通常のアプリケーションレイアウトとは若干異なるレイアウトが必要な場合があります。メインのレイアウトを繰り返し編集する代わりに、ネストされたレイアウト（サブテンプレートとも呼ばれます）を使用することで、これを実現できます。以下に例を示します。

次のApplicationControllerレイアウトがあるとします。

• app/views/layouts/application.html.erb

  <html>
  <head>
    <title><%= @page_title or "Page Title" %></title>
    <%= stylesheet_link_tag "layout" %>
    <style><%= yield :stylesheets %></style>
  </head>
  <body>
    <div id="top_menu">Top menu items here</div>
    <div id="menu">Menu items here</div>
    <div id="content"><%= content_for?(:content) ? yield(:content) : yield %></div>
  </body>
  </html>
  

  Copy

NewsControllerによって生成されるページでは、トップメニューを非表示にし、右メニューを追加したいとします。

• app/views/layouts/news.html.erb

  <% content_for :stylesheets do %>
    #top_menu {display: none}
    #right_menu {float: right; background-color: yellow; color: black}
  <% end %>
  <% content_for :content do %>
    <div id="right_menu">Right menu items here</div>
    <%= content_for?(:news_content) ? yield(:news_content) : yield %>
  <% end %>
  <%= render template: "layouts/application" %>
  

  Copy

以上です。Newsビューは新しいレイアウトを使用し、トップメニューを非表示にし、"content" div内に新しい右メニューを追加します。

このテクニックを使用して、異なるサブテンプレートスキームで同様の結果を得る方法はいくつかあります。ネストのレベルに制限はありません。新しいレイアウトをNewsレイアウトに基づいて作成するために、ActionView::renderメソッドを使用することもできます。Newsレイアウトをサブテンプレート化しないことが確実な場合は、content_for?(:news_content) ? yield(:news_content) : yieldを単にyieldに置き換えることができます。

フィードバック

このガイドの品質向上にご協力ください。

タイポや事実の誤りを見つけた場合は、ぜひ貢献してください。 開始するには、ドキュメントへの貢献セクションを読んでください。

不完全なコンテンツや最新でない情報も見つかるかもしれません。 メインのドキュメントに不足しているドキュメントを追加してください。 修正済みかどうかは、まずEdge Guidesを確認してください。 スタイルと規約については、Ruby on Rails Guides Guidelinesを確認してください。

修正すべき点を見つけたが、自分で修正できない場合は、 問題を報告してください。

そして最後に、Ruby on Railsのドキュメントに関するあらゆる議論は、公式のRuby on Railsフォーラムで大歓迎です。