ループHTML変数の一覧と使用例(template_variable_handler)

template_variable_handlerとは

template_variable_handlerはフォルダー、パーツ、レイアウトなどで使用できるテンプレートを提供する機能です。基本的な動きはSS::TemplateVariableというモジュールに記述しています。モデルでtemplate_variable_handlerというメソッドを使用することで、テンプレートで使用したい記述と、それに対して実行するメソッドを配列にしてインスタンス変数に格納します。

extend ActiveSupport::Concern
include SS::TemplateVariable

included do
  template_variable_handler(:name, :template_variable_handler_name)
end

def template_variable_handler_name(name, issuer)
  ERB::Util.html_escape self.send(name)
end

template_variable_handlerによって実行するメソッドはSymbol, Stringの他、Procで記述することが可能です。

included do
  template_variable_handler(:index_name) { |name, issuer| template_variable_handler_name(:name_for_index, issuer) }
end

テンプレートを対応するメソッドの返り値に置換するにはrender_templateというメソッドを使用します。例えば、ループHTMLの値を返すrender_loop_htmlというメソッドはrender_templateを使用しているため、ループHTML内であればテンプレートを使用することが可能です。

def render_loop_html(item, opts = {})
  item = item.becomes_with_route rescue item
  item.render_template(opts[:html] || loop_html, self)
end

render_templateはtemplate_variable_handlerによって格納された配列の集合をもとに置換を実行します。find_template_variable_handlerでSymbolやString, Procに対する動作を実行した後、対応するメソッドをcallすることでレンダリングしています。template_variable_getがfalseを返した場合、テンプレートの記述をレンダリングします。

def render_template(template, *args)
  return '' if template.blank?
  template.gsub(/\#\{(.*?)\}/) do |m|
    str = template_variable_get($1, *args) rescue false
    str == false ? m : str
  end
end

def template_variable_get(name, *args)
  handler = find_template_variable_handler(name)
  return unless handler

  handler.call(name, *args)
rescue => e
  Rails.logger.error("#{e.class} (#{e.message}):\n  #{e.backtrace.join("\n  ")}")
  false
end

テンプレートの使用例

テンプレートはループHTMLなどに#{name}のように記述することで使用できます。標準機能のフォルダーリストでは、以下のように使用しています。

<article class="item-#{class} #{current}">
  <header>
    <h2><a href="#{url}">#{name}</a></h2>
  </header>
</article>

new, current

#{new}, #{current}は条件を満たすときに#{new}, #{current}を表示するテンプレートです。このテンプレートはclassを追加してスタイルシートを適用したい場合などに使用します。#{new}は該当するコンテンツの更新日時がリスト表示のアドオンで設定した期間が経過するまでの間、#{new}を表示するテンプレートです。#{current}は該当するコンテンツが現在のコンテンツと同じ場合に#{current}を表示するテンプレートです。使用例を以下に記述します。

<article class="item-#{class} #{new} #{current}">
  <header>
  <time datetime="#{date.iso}">#{date.long}</time>
  <h2><a href="#{url}">#{index_name}</a></h2>
  </header>
</article>

子リスト表示

#{child_items}は子リストを表示する特殊なテンプレートです。#{child_items}は子リスト表示というアドオンで返り値を設定します。以下に使用例を記述します。

<!-- リスト表示のループHTML -->
<article class="item-#{class} #{current}">
  <header>
    <h2><a href="#{url}">#{name}</a></h2>
    #{child_items}
  </header>
</article>

<!-- 子リスト表示のループHTML -->
<h2><a href="#{url}">#{name}</a></h2>

使用できるテンプレート

template_variable_handlerによって使用できるテンプレートを以下に記述します。

Ckan::Addon::ItemList

Cms::Addon::Body

Cms::Addon::Meta

Cms::Addon::Tag

Cms::ChildList

Cms::GroupPermission

Cms::Model::Node

Cms::Model::Page

Cms::Reference::Member

Cms::TemplateVariable

Event::Addon::Date

Jmaxml::Renderer::CommentHandler

Jmaxml::Renderer::ControlHandler

Jmaxml::Renderer::EarthquakeHandler

Jmaxml::Renderer::HeadHandler

Jmaxml::Renderer::VolcanoHandler

Member::Addon::Blog::Body

Member::Addon::Blog::PageSetting

Member::Addon::Photo::Body

Opendata::AppTemplateVariables

Opendata::DatasetTemplateVariables

Opendata::IdeaTemplateVariables

Sys::Addon::Body

Member::Renderer::GroupInvitation

Member::Renderer::MemberInvitation

Rss::Renderer::AnpiMail