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

class ERB

クラス・モジュールの継承リスト: ERB < Object < Kernel < BasicObject

要約

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(str, safe_level=nil, trim_mode=nil, eoutvar='_erbout') -> ERB`	eRubyスクリプトから ERB オブジェクトを生成して返します。
`version -> String`	erb.rbのリビジョン情報を返します。

インスタンスメソッド

定義	説明
`def_class(superklass=Object, methodname='erb') -> Class`	変換した Ruby スクリプトをメソッドとして定義した無名のクラスを返します。
`def_method(mod, methodname, fname='(ERB)') -> nil`	変換した Ruby スクリプトをメソッドとして定義します。
`def_module(methodname='erb') -> Module`	変換した Ruby スクリプトをメソッドとして定義した無名のモジュールを返します。
`filename -> String`	エラーメッセージを表示する際のファイル名を取得します。
`filename= -> String`	エラーメッセージを表示する際のファイル名を設定します。
`result(b=TOPLEVEL_BINDING) -> String`	ERB を b の binding で実行し、結果の文字列を返します。
`result_with_hash(hash) -> String`	ERB をハッシュオブジェクトで指定されたローカル変数を持つ新しいトップレベルバインディングで実行し、結果の文字列を返します。
`run(b=TOPLEVEL_BINDING) -> nil`	ERB を b の binding で実行し、結果を標準出力へ印字します。
`set_eoutvar(compiler, eoutvar = '_erbout') -> Array`	ERBの中でeRubyスクリプトの出力をためていく変数を設定します。
`src -> String`	変換した Ruby スクリプトを取得します。

継承したメソッド

! != __id__ __send__ instance_eval instance_exec method_missing singleton_method_added singleton_method_removed singleton_method_undefined !~ <=> == === =~ _dump class clone define_singleton_method display enum_for eql? equal? extend freeze frozen? hash initialize initialize_copy inspect instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? itself marshal_dump marshal_load method methods nil? object_id pretty_inspect pretty_print pretty_print_cycle pretty_print_inspect pretty_print_instance_variables private_methods protected_methods psych_to_yaml public_method public_methods public_send remove_instance_variable respond_to? respond_to_missing? send singleton_class singleton_method singleton_methods taint tainted? tap to_a to_ary to_hash to_int to_io to_proc to_regexp to_s to_str trust untaint untrust untrusted? yield_self .yaml_tag ::ARGF ::ARGV ::DATA ::ENV ::FALSE ::NIL ::RUBY_COPYRIGHT ::RUBY_DESCRIPTION ::RUBY_ENGINE ::RUBY_ENGINE_VERSION ::RUBY_PATCHLEVEL ::RUBY_PLATFORM ::RUBY_RELEASE_DATE ::RUBY_REVISION ::RUBY_VERSION ::SCRIPT_LINES__ ::STDERR ::STDIN ::STDOUT ::TOPLEVEL_BINDING ::TRUE