actionview

`yield :foo`と`content_for :foo`の使い分け

56 views Post

17 May, 2025 03:26 +00:00

動機

Rails 8.0.2でrails newをして生成されたapp/views/layouts/application.html.erbでは、以下のようにyield :fooとcontent_for :fooが混在していました。

<html>
  <head>
    <title><%= content_for(:title) || "Sample" %></title>
（中略）
    <%= yield :head %>

content_forのAPIドキュメントによれば yield :fooとcontent_for :fooの働きが等価となる場合もあるのですが、このapplication.html.erbの例のように、片方に統一されず両方を利用しているケースがあったので、 yield :fooとcontent_for :fooの使い分けについて調べる事にしました。

結論

基本的には、yield :fooを使う。ただし、以下の2つのケースではcontent_for :fooを使う。
ケース1：ヘルパーメソッドの中では、yieldは利用できないので、content_for :fooを使う。
ケース2：ビュー側で設定されているかどうかに応じて挙動を切り替えるコードを短く書くときにはcontent_for :fooを使う。

詳細

yieldはヘルパーメソッドの中では利用できない

content_forのAPIドキュメントに書かれている通り、 content_forは以下の例のようにヘルパーメソッド内で利用可能ですが、yieldは利用できません。

module StorageHelper
  def stored_content
    content_for(:storage) || "Your storage is empty"
  end
end

yieldとcontent_forでは、設定されていないときの戻り値が異なる

ビュー側で以下のように:fooに対して設定が行われていた場合、

<% content_for :foo do %>
  Foo
<% end %>

yield :fooとcontent_for :fooの戻り値は、この例ではどちらも" Foo\n"であり、同じになります。

しかし、ビュー側で前述のような記述がなく:fooに対して設定が行われていなかった場合、 yield :fooの戻り値が空文字列（""）であるのに対し、content_for :fooの戻り値はnilであり、戻り値が異なります。

設定されていない場合にcontent_for :fooがnilを戻す性質を利用することで、<title><%= content_for(:title) || "Sample" %></title>のような設定されているかどうかに応じて挙動を切り替えるコードを短く書くことができます。

captureを使ってform_withのようにblockを活用したヘルパーメソッドを作る

1514 views Post

@wakairo

18 Apr, 2024 02:01 +00:00

Last edited

18 Apr, 2024 02:14 +00:00

背景

Railsのactionviewのヘルパー関数には、form_withのように、blockを活用して入れ子のHTML要素を記述できる便利なヘルパーメソッドがあります。具体的には、以下のような記述（Railsガイドより引用）が出来るヘルパーメソッドです。

<%= form_with url: "/search", method: :get do |form| %>
  <%= form.label :query, "Search for:" %>
  <%= form.text_field :query %>
  <%= form.submit "Search" %>
<% end %>

blockを用いてHTML要素の入れ子を出力できるこのようなヘルパーメソッドの自作に関する話です。

作り方

actionviewのcaptureというヘルパーメソッドを用いると、form_withのように、blockを使ってHTML要素の入れ子を記述できるヘルパーメソッドを自作できます。

ちなみに、このcaptureは、Railsガイドを読んでも、RailsのAPIドキュメントを読んでも、いまいち使い道が分かっていなかったのですが、このような自作ヘルパーで使うというのが1つの使い道のようです。

自作ヘルパーメソッドの実装例

def some_helper(content=nil, &block)
  object_passed_to_block = 'hello, capture'
  content = capture(object_passed_to_block, &block) if block
  tag.div(content, class: 'some-class')
end

自作ヘルパーメソッドの利用例

ERBから利用

<%= some_helper do |object| %>
  <p><%= object %></p>
<% end %>

出力結果

<div class="some-class">
  <p>hello, capture</p>
</div>

Rubyのコード内から利用

some_helper do |object|
  tag.p(object)
end

出力結果

<div class="some-class"><p>hello, capture</p></div>

Rubyのコード内からblockなしで利用

some_helper('123')

出力結果

<div class="some-class">123</div>