class ERB

要約

eRuby スクリプトを処理するクラス。

従来 ERbLight と呼ばれていたもので、標準出力への印字が文字列の挿入とならない点が eruby と異なります。

• https://magazine.rubyist.net/articles/0017/0017-BundledLibraries.html

使い方

ERB クラスを使うためには require 'erb' する必要があります。

require 'erb'

ERB.new($<.read).run

trim_mode

trim_mode は整形の挙動を変更するオプションです。次の振舞いを指定できます。

• 改行の扱い
• %ではじまる行の扱い (ERB 2.0 から追加されました)

trim_mode に指定できる値は次の通りです。

• ERb-1.4.x 互換の指定方法
  • nil, 0: そのまま変換
  • 1: 行末が%>のとき改行を出力しない
  • 2: 行頭が<%で行末が%>のとき改行を出力しない
• 2.0 からの指定方法
  • nil, "": そのまま変換
  • ">": 1と同じ
  • "<>": 2と同じ
  • "-": 行末が-%>のとき改行を出力しない。また、行頭が<%-のとき行頭の空白文字を削除する
  • "%": %ではじまる行を<%..%>とみなして変換する。この行の改行は出力しない
  • "%>", ">%": 1と"%"の両方を行なう
  • "%<>", "<>%": 2と"%"の両方を行なう
  • "%-": "-"と"%"の両方を行なう

# スクリプト
<% 3.times do |n| %>
% n = 0
* <%= n%>
<% end %>
  
# trim_mode = nil, '', 0
  
% n = 0
* 0
  
% n = 0
* 1
  
% n = 0
* 2
  
# trim_mode = 1, '>'
% n = 0
* 0% n = 0
* 1% n = 0
* 2
  
# trim_mode = 2, '<>'
% n = 0
* 0
% n = 0
* 1
% n = 0
* 2
  
# trim_mode = '%'
  
* 0
  
* 0
  
* 0
  
# trim_mode = '%>', '>%'
* 0* 0* 0
  
# trim_mode = '%<>', '<>%'
* 0
* 0
* 0
  
# スクリプト
<% 3.times do |n| -%>
% n = 0
  <%- m = 0 %>*
* <%= n%>
<% end -%>
  
# trim_mode = '%-'
*
* 0
*
* 0
*
* 0
  
# スクリプト
<% 3.times do |n| %>
% n = 0
  <%- m = 0 %>*
* <%= n%>
<% end %>
  
# trim_mode = '%'
  
  *
* 0
  
  *
* 0
  
  *
* 0

エンコーディング

ERB は入力した文字列と同じエンコーディングの文字列を返すのがデフォルトの動作ですが、以下のようにマジックコメントを指定すると、ERB によって生成される文字列のエンコーディングを指定できます。

# -*- coding: UTF-8 -*-
require 'erb'
  
template = ERB.new <<EOF
<%#-*- coding: Big5 -*-%>
  __ENCODING__ is <%= __ENCODING__ %>.
EOF
puts template.result # => __ENCODING__ is Big5

目次

特異メソッド

• new
• version

インスタンスメソッド

• def_class
• def_method
• def_module
• filename
• filename=
• result
• result_with_hash
• run
• set_eoutvar
• src

特異メソッド

new(str, safe_level=NOT_GIVEN, trim_mode=NOT_GIVEN, eoutvar=NOT_GIVEN, trim_mode: nil, eoutvar: '_erbout') -> ERB[permalink][rdoc][edit]

eRubyスクリプト から ERB オブジェクトを生成して返します。

[PARAM] str:

eRubyスクリプトを表す文字列

[PARAM] safe_level:

eRubyスクリプトが実行されるときのセーフレベル

[PARAM] trim_mode:

整形の挙動を変更するオプション

[PARAM] eoutvar:

eRubyスクリプトの中で出力をためていく変数の名前を表す文字列。eRuby スクリプトの中でさらに ERB を使うときに変更します。通常は指定する必要はありません。

Ruby 2.6.0 から位置引数での safe_level, trim_mode, eoutvar の指定は非推奨です。 Ruby 3.2 で削除されました。 trim_mode と eoutvar の指定はキーワード引数に移行してください。

例

require "erb"

# build data class
class Listings
  PRODUCT = { :name => "Chicken Fried Steak",
              :desc => "A well messages pattie, breaded and fried.",
              :cost => 9.95 }

  attr_reader :product, :price

  def initialize( product = "", price = "" )
    @product = product
    @price = price
  end

  def build
    b = binding
    # create and run templates, filling member data variables
    ERB.new(<<~'END_PRODUCT', eoutvar: "@product").result b
      <%= PRODUCT[:name] %>
      <%= PRODUCT[:desc] %>
    END_PRODUCT
    ERB.new(<<~'END_PRICE', eoutvar: "@price").result b
      <%= PRODUCT[:name] %> -- <%= PRODUCT[:cost] %>
      <%= PRODUCT[:desc] %>
    END_PRICE
  end
end

# setup template data
listings = Listings.new
listings.build

puts listings.product + "\n" + listings.price

# Chicken Fried Steak
# A well messages pattie, breaded and fried.
# 
# Chicken Fried Steak -- 9.95
# A well messages pattie, breaded and fried.

version -> String[permalink][rdoc][edit]

erb.rbのリビジョン情報を返します。

インスタンスメソッド

def_class(superklass=Object, methodname='erb') -> Class[permalink][rdoc][edit]

変換した Ruby スクリプトをメソッドとして定義した無名のクラスを返します。

[PARAM] superklass:

無名クラスのスーパークラス

[PARAM] methodname:

メソッド名

例

require "erb"

class MyBaseClass
  def initialize(arg1, arg2)
    @arg1 = arg1
    @arg2 = arg2
  end
end

erb = ERB.new(<<~ERB)
  arg1: <%= @arg1 %>
  arg2: <%= @arg2 %>
ERB

MySubClass = erb.def_class(MyBaseClass, :render)

print MySubClass.new("foo", 123).render()
# => arg1: foo
#    arg2: 123

def_method(mod, methodname, fname='(ERB)') -> nil[permalink][rdoc][edit]

変換した Ruby スクリプトをメソッドとして定義します。

定義先のモジュールは mod で指定し、メソッド名は methodname で指定します。 fname はスクリプトを定義する際のファイル名です。主にエラー時に活躍します。

[PARAM] mod:

メソッドを定義するモジュール（またはクラス）

[PARAM] methodname:

メソッド名

[PARAM] fname:

スクリプトを定義する際のファイル名

例

require "erb"

class MyClass
end

erb = ERB.new(<<~ERB)
  arg1: <%= arg1 %>
  arg2: <%= arg2 %>
ERB

erb.def_method(MyClass, "m(arg1, arg2)")

print MyClass.new.m("foo", 123)
# => arg1: foo
#    arg2: 123

def_module(methodname='erb') -> Module[permalink][rdoc][edit]

変換した Ruby スクリプトをメソッドとして定義した無名のモジュールを返します。

[PARAM] methodname:

メソッド名

例

require "erb"

erb = ERB.new(<<~ERB)
  arg1: <%= arg1 %>
  arg2: <%= arg2 %>
ERB

MyModule = erb.def_module("render(arg1, arg2)")

class MyClass
  include MyModule
end

print MyClass.new.render("foo", 123)
# => arg1: foo
#    arg2: 123

filename -> String[permalink][rdoc][edit]

エラーメッセージを表示する際のファイル名を取得します。

例

require 'erb'
filename = 'example.rhtml'
erb = ERB.new(File.read(filename))
p erb.filename # => nil
erb.filename = filename
p erb.filename # =>"example.rhtml"

filename= -> String[permalink][rdoc][edit]

エラーメッセージを表示する際のファイル名を設定します。

filename を設定しておくことにより、エラーが発生した eRuby スクリプトの特定が容易になります。filename を設定していない場合は、エラー発生箇所は「 (ERB) 」という出力となります。

例

require 'erb'
filename = 'example.rhtml'
erb = ERB.new(File.read(filename))
p erb.filename # => nil
erb.filename = filename
p erb.filename # =>"example.rhtml"

result(b=TOPLEVEL_BINDING) -> String[permalink][rdoc][edit]

ERB を b の binding で実行し、結果の文字列を返します。

[PARAM] b:

eRubyスクリプトが実行されるときのbinding

例

require 'erb'
erb = ERB.new("test <%= test1 %>\ntest <%= test2 %>\n")
test1 = "foo"
test2 = "bar"
puts erb.result
# test foo
# test bar

[SEE_ALSO] ERB#result_with_hash

result_with_hash(hash) -> StringRuby 2.5.0 から[permalink][rdoc][edit]

ERB をハッシュオブジェクトで指定されたローカル変数を持つ新しいトップレベルバインディングで実行し、結果の文字列を返します。

[PARAM] hash:

ローカル変数名をキーにしたハッシュ

[SEE_ALSO] ERB#result

run(b=TOPLEVEL_BINDING) -> nil[permalink][rdoc][edit]

ERB を b の binding で実行し、結果を標準出力へ印字します。

[PARAM] b:

eRubyスクリプトが実行されるときのbinding

例

require 'erb'
erb = ERB.new("test <%= test1 %>\ntest <%= test2 %>\n")
test1 = "foo"
test2 = "bar"
erb.run
# test foo
# test bar

set_eoutvar(compiler, eoutvar = '_erbout') -> Array[permalink][rdoc][edit]

ERBの中でeRubyスクリプトの出力をためていく変数を設定します。

ERBでeRubyスクリプトの出力をためていく変数を設定するために使用します。この設定は ERB#new でも行えるため、通常はそちらを使用した方がより容易です。本メソッドを使用するためには、引数にて指定する eRuby コンパイラを事前に生成しておく必要があります。

[PARAM] compiler:

eRubyコンパイラ

[PARAM] eoutvar:

eRubyスクリプトの中で出力をためていく変数

src -> String[permalink][rdoc][edit]

変換した Ruby スクリプトを取得します。

例

require 'erb'
erb = ERB.new("test1<%= @arg1%>\ntest2<%= @arg2%>\n\n")
puts erb.src

# #coding:UTF-8
# _erbout = +''; _erbout.<< "test1".freeze; _erbout.<<(( @arg1).to_s); _erbout.<< "\ntest2".freeze
# ; _erbout.<<(( @arg2).to_s); _erbout.<< "\n\n".freeze
#
# ; _erbout