Ruby 2.1.0 リファレンスマニュアル > ライブラリ一覧 > erbライブラリ > ERBクラス

class ERB

クラスの継承リスト: ERB < Object < Kernel < BasicObject

要約

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

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

• http://magazine.rubyist.net/?0017-BundledLibraries

使い方

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 run set_eoutvar src

特異メソッド

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

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

[PARAM] str:

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

[PARAM] safe_level:

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

[PARAM] trim_mode:

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

[PARAM] eoutvar:

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

version -> String[permalink][rdoc]

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

インスタンスメソッド

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

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

[PARAM] superklass:

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

[PARAM] methodname:

メソッド名

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

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

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

[PARAM] mod:

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

[PARAM] methodname:

メソッド名

[PARAM] fname:

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

例:

erb = ERB.new(script)
erb.def_method(MyClass, 'foo(bar)', 'foo.erb')

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

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

[PARAM] methodname:

メソッド名

filename -> String[permalink][rdoc]

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

filename= -> String[permalink][rdoc]

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

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

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

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

[PARAM] b:

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

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

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

[PARAM] b:

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

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

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

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

[PARAM] compiler:

eRubyコンパイラ

[PARAM] eoutvar:

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

src -> String[permalink][rdoc]

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