erubis-bmp 2.7.0.bmp
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGES.txt +828 -0
- data/MIT-LICENSE +20 -0
- data/README.txt +10 -0
- data/benchmark/bench.rb +313 -0
- data/benchmark/bench_context.yaml +141 -0
- data/benchmark/mybench2.rb +266 -0
- data/benchmark/pibench.rb +163 -0
- data/benchmark/templates/_footer.html +4 -0
- data/benchmark/templates/_header.html +52 -0
- data/benchmark/templates/bench_erb.rhtml +29 -0
- data/benchmark/templates/bench_erubis.rhtml +29 -0
- data/benchmark/templates/bench_eruby.rhtml +29 -0
- data/bin/erubis +10 -0
- data/contrib/erubis-run.rb +132 -0
- data/doc/Rookbook.yaml +106 -0
- data/doc/docstyle.css +209 -0
- data/doc/users-guide.html +3551 -0
- data/doc/users-guide.txt +3631 -0
- data/examples/basic/Makefile +58 -0
- data/examples/basic/example.ec +42 -0
- data/examples/basic/example.ecpp +33 -0
- data/examples/basic/example.ejava +45 -0
- data/examples/basic/example.ejs +16 -0
- data/examples/basic/example.eperl +16 -0
- data/examples/basic/example.ephp +17 -0
- data/examples/basic/example.eruby +15 -0
- data/examples/basic/example.escheme +26 -0
- data/examples/pi-xhtml/ExamplePage.xhtml +80 -0
- data/examples/pi-xhtml/Makefile +17 -0
- data/examples/pi-xhtml/my/User.java +19 -0
- data/examples/pi-xhtml/my/Util.java +54 -0
- data/examples/pi/Makefile +54 -0
- data/examples/pi/example.ec +42 -0
- data/examples/pi/example.ejava +45 -0
- data/examples/pi/example.ejs +16 -0
- data/examples/pi/example.eperl +16 -0
- data/examples/pi/example.ephp +17 -0
- data/examples/pi/example.eruby +15 -0
- data/examples/pi/example.escheme +26 -0
- data/lib/erubis.rb +73 -0
- data/lib/erubis/context.rb +83 -0
- data/lib/erubis/converter.rb +357 -0
- data/lib/erubis/engine.rb +120 -0
- data/lib/erubis/engine/ec.rb +117 -0
- data/lib/erubis/engine/ecpp.rb +113 -0
- data/lib/erubis/engine/ejava.rb +110 -0
- data/lib/erubis/engine/ejavascript.rb +119 -0
- data/lib/erubis/engine/enhanced.rb +126 -0
- data/lib/erubis/engine/eperl.rb +95 -0
- data/lib/erubis/engine/ephp.rb +99 -0
- data/lib/erubis/engine/eruby.rb +125 -0
- data/lib/erubis/engine/escheme.rb +114 -0
- data/lib/erubis/engine/optimized.rb +127 -0
- data/lib/erubis/enhancer.rb +723 -0
- data/lib/erubis/error.rb +23 -0
- data/lib/erubis/evaluator.rb +88 -0
- data/lib/erubis/generator.rb +85 -0
- data/lib/erubis/helper.rb +47 -0
- data/lib/erubis/helpers/rails_form_helper.rb +197 -0
- data/lib/erubis/helpers/rails_helper.rb +353 -0
- data/lib/erubis/local-setting.rb +9 -0
- data/lib/erubis/main.rb +516 -0
- data/lib/erubis/preprocessing.rb +58 -0
- data/lib/erubis/tiny.rb +144 -0
- data/lib/erubis/util.rb +22 -0
- data/setup.rb +1331 -0
- data/test/Rookbook.yaml +42 -0
- data/test/assert-text-equal.rb +44 -0
- data/test/test-engines.rb +425 -0
- data/test/test-enhancers.rb +646 -0
- data/test/test-erubis.rb +887 -0
- data/test/test-index-cgi.rb +191 -0
- data/test/test-main.rb +752 -0
- data/test/test-users-guide.rb +73 -0
- data/test/test.rb +45 -0
- data/test/testutil.rb +111 -0
- metadata +121 -0
|
@@ -0,0 +1,3551 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta http-equiv="Content-Type" content="text/html">
|
|
5
|
+
<title>Erubis Users' Guide</title>
|
|
6
|
+
<meta name="generator" content="kwaser">
|
|
7
|
+
<meta http-equiv="Content-Style-Type" content="text/css">
|
|
8
|
+
<link rel="stylesheet" href="docstyle.css" type="text/css">
|
|
9
|
+
</head>
|
|
10
|
+
<body>
|
|
11
|
+
|
|
12
|
+
<blockquote>
|
|
13
|
+
<div class="mainbody">
|
|
14
|
+
|
|
15
|
+
<div align="left"><h1>Erubis Users' Guide</h1></div>
|
|
16
|
+
<p>release: $Release$
|
|
17
|
+
</p>
|
|
18
|
+
<a name="preface"></a>
|
|
19
|
+
<h2 class="section1">Preface</h2>
|
|
20
|
+
<p>Erubis is an implementation of eRuby.
|
|
21
|
+
It has the following features.
|
|
22
|
+
</p>
|
|
23
|
+
<ul type="disc">
|
|
24
|
+
<li>Very fast, almost three times faster than ERB and about ten percent faster than eruby (implemented in C)
|
|
25
|
+
</li>
|
|
26
|
+
<li>File caching of converted Ruby script support
|
|
27
|
+
</li>
|
|
28
|
+
<li>Auto escaping support
|
|
29
|
+
</li>
|
|
30
|
+
<li>Auto trimming spaces around '<% %>'
|
|
31
|
+
</li>
|
|
32
|
+
<li>Embedded pattern changeable (default '<% %>')
|
|
33
|
+
</li>
|
|
34
|
+
<li>Enable to handle Processing Instructions (PI) as embedded pattern (ex. '<?rb ... ?>')
|
|
35
|
+
</li>
|
|
36
|
+
<li>Multi-language support (Ruby/PHP/C/Java/Scheme/Perl/Javascript)
|
|
37
|
+
</li>
|
|
38
|
+
<li>Context object available and easy to combine eRuby template with YAML datafile
|
|
39
|
+
</li>
|
|
40
|
+
<li>Print statement available
|
|
41
|
+
</li>
|
|
42
|
+
<li>Easy to expand and customize in subclass
|
|
43
|
+
</li>
|
|
44
|
+
<li><a href="#rails">Ruby on Rails support</a>
|
|
45
|
+
</li>
|
|
46
|
+
<li>mod_ruby support|#topcs-modruby
|
|
47
|
+
</li>
|
|
48
|
+
</ul>
|
|
49
|
+
<p>Erubis is implemented in pure Ruby. It requires Ruby 1.8 or higher.
|
|
50
|
+
Erubis now supports Ruby 1.9.
|
|
51
|
+
</p>
|
|
52
|
+
<a name="toc"></a>
|
|
53
|
+
<h3 class="section2">Table of Contents</h3>
|
|
54
|
+
<ul>
|
|
55
|
+
<li><a href="#preface">Preface</a>
|
|
56
|
+
<ul>
|
|
57
|
+
<li><a href="#toc">Table of Contents</a>
|
|
58
|
+
</li>
|
|
59
|
+
</ul>
|
|
60
|
+
</li>
|
|
61
|
+
<li><a href="#install">Installation</a>
|
|
62
|
+
</li>
|
|
63
|
+
<li><a href="#tutorial">Tutorial</a>
|
|
64
|
+
<ul>
|
|
65
|
+
<li><a href="#tut-basic">Basic Example</a>
|
|
66
|
+
</li>
|
|
67
|
+
<li><a href="#tut-trim">Trimming Spaces</a>
|
|
68
|
+
</li>
|
|
69
|
+
<li><a href="#tut-escape">Escape</a>
|
|
70
|
+
</li>
|
|
71
|
+
<li><a href="#tut-pattern">Embedded Pattern</a>
|
|
72
|
+
</li>
|
|
73
|
+
<li><a href="#tut-context">Context Object</a>
|
|
74
|
+
</li>
|
|
75
|
+
<li><a href="#tut-datafile">Context Data File</a>
|
|
76
|
+
</li>
|
|
77
|
+
<li><a href="#tut-datastr">Context Data String</a>
|
|
78
|
+
</li>
|
|
79
|
+
<li><a href="#tut-preamble">Preamble and Postamble</a>
|
|
80
|
+
</li>
|
|
81
|
+
<li><a href="#tut-pi">Processing Instruction (PI) Converter</a>
|
|
82
|
+
</li>
|
|
83
|
+
<li><a href="#tut-notext">Retrieve Ruby Code</a>
|
|
84
|
+
</li>
|
|
85
|
+
</ul>
|
|
86
|
+
</li>
|
|
87
|
+
<li><a href="#enhancer">Enhancer</a>
|
|
88
|
+
<ul>
|
|
89
|
+
<li><a href="#escape-enhancer">EscapeEnhancer</a>
|
|
90
|
+
</li>
|
|
91
|
+
<li><a href="#stdout-enhancer">StdoutEnhancer</a>
|
|
92
|
+
</li>
|
|
93
|
+
<li><a href="#printout-enhancer">PrintOutEnhancer</a>
|
|
94
|
+
</li>
|
|
95
|
+
<li><a href="#printenabled-enhancer">PrintEnabledEnhancer</a>
|
|
96
|
+
</li>
|
|
97
|
+
<li><a href="#array-enhancer">ArrayEnhancer</a>
|
|
98
|
+
</li>
|
|
99
|
+
<li><a href="#arraybuffer-enhancer">ArrayBufferEnhancer</a>
|
|
100
|
+
</li>
|
|
101
|
+
<li><a href="#stringbuffer-enhancer">StringBufferEnhancer</a>
|
|
102
|
+
</li>
|
|
103
|
+
<li><a href="#erbout-enhancer">ErboutEnhancer</a>
|
|
104
|
+
</li>
|
|
105
|
+
<li><a href="#notext-enhancer">NoTextEnhancer</a>
|
|
106
|
+
</li>
|
|
107
|
+
<li><a href="#nocode-enhancer">NoCodeEnhancer</a>
|
|
108
|
+
</li>
|
|
109
|
+
<li><a href="#simplify-enhancer">SimplifyEnhancer</a>
|
|
110
|
+
</li>
|
|
111
|
+
<li><a href="#bipattern-enhancer">BiPatternEnhancer</a>
|
|
112
|
+
</li>
|
|
113
|
+
<li><a href="#percentline-enhancer">PercentLineEnhancer</a>
|
|
114
|
+
</li>
|
|
115
|
+
<li><a href="#prefixedline-enhancer">PrefixedLineEnhancer</a>
|
|
116
|
+
</li>
|
|
117
|
+
<li><a href="#headerfooter-enhancer">HeaderFooterEnhancer</a>
|
|
118
|
+
</li>
|
|
119
|
+
<li><a href="#interpolation-enhancer">InterpolationEnhancer</a>
|
|
120
|
+
</li>
|
|
121
|
+
<li><a href="#deleteindent-enhancer">DeleteIndentEnhancer</a>
|
|
122
|
+
</li>
|
|
123
|
+
</ul>
|
|
124
|
+
</li>
|
|
125
|
+
<li><a href="#lang">Multi-Language Support</a>
|
|
126
|
+
<ul>
|
|
127
|
+
<li><a href="#lang-php">PHP</a>
|
|
128
|
+
</li>
|
|
129
|
+
<li><a href="#lang-c">C</a>
|
|
130
|
+
</li>
|
|
131
|
+
<li><a href="#lang-cpp">C++</a>
|
|
132
|
+
</li>
|
|
133
|
+
<li><a href="#lang-java">Java</a>
|
|
134
|
+
</li>
|
|
135
|
+
<li><a href="#lang-scheme">Scheme</a>
|
|
136
|
+
</li>
|
|
137
|
+
<li><a href="#lang-perl">Perl</a>
|
|
138
|
+
</li>
|
|
139
|
+
<li><a href="#lang-javascript">JavaScript</a>
|
|
140
|
+
</li>
|
|
141
|
+
</ul>
|
|
142
|
+
</li>
|
|
143
|
+
<li><a href="#rails">Ruby on Rails Support</a>
|
|
144
|
+
<ul>
|
|
145
|
+
<li><a href="#rails-settings">Settings</a>
|
|
146
|
+
</li>
|
|
147
|
+
<li><a href="#rails-preprocessing">Preprosessing</a>
|
|
148
|
+
</li>
|
|
149
|
+
<li><a href="#rails-formhelpers">Form Helpers for Preprocessing</a>
|
|
150
|
+
</li>
|
|
151
|
+
<li><a href="#rails-others">Others</a>
|
|
152
|
+
</li>
|
|
153
|
+
</ul>
|
|
154
|
+
</li>
|
|
155
|
+
<li><a href="#topics">Other Topics</a>
|
|
156
|
+
<ul>
|
|
157
|
+
<li><a href="#topics-fasteruby"><code>Erubis::FastEruby</code> Class</a>
|
|
158
|
+
</li>
|
|
159
|
+
<li><a href="#topics-bufvar"><code>:bufvar</code> Option</a>
|
|
160
|
+
</li>
|
|
161
|
+
<li><a href="#topics-trimspaces">'<%= =%>' and '<%= -%>'</a>
|
|
162
|
+
</li>
|
|
163
|
+
<li><a href="#topics-doublepercent">'<%% %>' and '<%%= %>'</a>
|
|
164
|
+
</li>
|
|
165
|
+
<li><a href="#topics-context-vs-binding">evaluate(context) v.s. result(binding)</a>
|
|
166
|
+
</li>
|
|
167
|
+
<li><a href="#topics-fasteruby">Class Erubis::FastEruby</a>
|
|
168
|
+
</li>
|
|
169
|
+
<li><a href="#topics-syntax">Syntax Checking</a>
|
|
170
|
+
</li>
|
|
171
|
+
<li><a href="#topics-caching">File Caching</a>
|
|
172
|
+
</li>
|
|
173
|
+
<li><a href="#topics-tinyeruby">Erubis::TinyEruby class</a>
|
|
174
|
+
</li>
|
|
175
|
+
<li><a href="#topics-php">NoTextEnhancer and NoCodeEnhancer in PHP</a>
|
|
176
|
+
</li>
|
|
177
|
+
<li><a href="#topcs-modruby">Helper Class for mod_ruby</a>
|
|
178
|
+
</li>
|
|
179
|
+
<li><a href="#topics-index-cgi">Helper CGI Script for Apache</a>
|
|
180
|
+
</li>
|
|
181
|
+
<li><a href="#topics-defmethod">Define method</a>
|
|
182
|
+
</li>
|
|
183
|
+
<li><a href="#topics-benchmark">Benchmark</a>
|
|
184
|
+
</li>
|
|
185
|
+
</ul>
|
|
186
|
+
</li>
|
|
187
|
+
<li><a href="#command">Command Reference</a>
|
|
188
|
+
<ul>
|
|
189
|
+
<li><a href="#command-usage">Usage</a>
|
|
190
|
+
</li>
|
|
191
|
+
<li><a href="#command-options">Options</a>
|
|
192
|
+
</li>
|
|
193
|
+
<li><a href="#command-props">Properties</a>
|
|
194
|
+
</li>
|
|
195
|
+
</ul>
|
|
196
|
+
</li>
|
|
197
|
+
</ul>
|
|
198
|
+
<br>
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
<br>
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
<a name="install"></a>
|
|
205
|
+
<h2 class="section1">Installation</h2>
|
|
206
|
+
<ul type="disc">
|
|
207
|
+
<li>If you have installed RubyGems, just type <code>gem install --remote erubis</code>.
|
|
208
|
+
<pre class="terminal">$ sudo gem install --remote erubis
|
|
209
|
+
</pre>
|
|
210
|
+
</li>
|
|
211
|
+
</ul>
|
|
212
|
+
<ul type="disc">
|
|
213
|
+
<li>Else install <a href="http://rubyforge.org/projects/erubis/">abstract</a> at first,
|
|
214
|
+
and download erubis_X.X.X.tar.bz2 and install it by setup.rb.
|
|
215
|
+
<pre class="terminal">$ tar xjf abstract_X.X.X.tar.bz2
|
|
216
|
+
$ cd abstract_X.X.X/
|
|
217
|
+
$ sudo ruby setup.rb
|
|
218
|
+
$ cd ..
|
|
219
|
+
$ tar xjf erubis_X.X.X.tar.bz2
|
|
220
|
+
$ cd erubis_X.X.X/
|
|
221
|
+
$ sudo ruby setup.rb
|
|
222
|
+
</pre>
|
|
223
|
+
</li>
|
|
224
|
+
</ul>
|
|
225
|
+
<ul type="disc">
|
|
226
|
+
<li>(Optional) 'contrib/inline-require' enables you to merge 'lib/**/*.rb' into 'bin/erubis'.
|
|
227
|
+
<pre class="terminal">$ tar xjf erubis_X.X.X.tar.bz2
|
|
228
|
+
$ cd erubis_X.X.X/
|
|
229
|
+
$ unset RUBYLIB
|
|
230
|
+
$ contrib/inline-require -I lib bin/erubis > contrib/erubis
|
|
231
|
+
</pre>
|
|
232
|
+
</li>
|
|
233
|
+
</ul>
|
|
234
|
+
<br>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
<a name="tutorial"></a>
|
|
238
|
+
<h2 class="section1">Tutorial</h2>
|
|
239
|
+
<a name="tut-basic"></a>
|
|
240
|
+
<h3 class="section2">Basic Example</h3>
|
|
241
|
+
<p>Here is a basic example of Erubis.
|
|
242
|
+
</p>
|
|
243
|
+
<a name="example1.eruby"></a>
|
|
244
|
+
<div class="program_caption">
|
|
245
|
+
example1.eruby</div>
|
|
246
|
+
<pre class="program"><ul>
|
|
247
|
+
<strong><% for item in list %></strong>
|
|
248
|
+
<li><strong><%= item %></strong></li>
|
|
249
|
+
<strong><% end %></strong>
|
|
250
|
+
<strong><%# here is ignored because starting with '#' %></strong>
|
|
251
|
+
</ul>
|
|
252
|
+
</pre>
|
|
253
|
+
<a name="example1.rb"></a>
|
|
254
|
+
<div class="program_caption">
|
|
255
|
+
example1.rb</div>
|
|
256
|
+
<pre class="program">require 'erubis'
|
|
257
|
+
input = File.read('example1.eruby')
|
|
258
|
+
eruby = <strong>Erubis::Eruby.new(input)</strong> # create Eruby object
|
|
259
|
+
|
|
260
|
+
puts "---------- script source ---"
|
|
261
|
+
puts <strong>eruby.src</strong> # print script source
|
|
262
|
+
|
|
263
|
+
puts "---------- result ----------"
|
|
264
|
+
list = ['aaa', 'bbb', 'ccc']
|
|
265
|
+
puts <strong>eruby.result(binding())</strong> # get result
|
|
266
|
+
## or puts eruby.result(<strong>:list=>list</strong>) # or pass Hash instead of Binding
|
|
267
|
+
|
|
268
|
+
## # or
|
|
269
|
+
## eruby = Erubis::Eruby.new
|
|
270
|
+
## input = File.read('example1.eruby')
|
|
271
|
+
## src = eruby.convert(input)
|
|
272
|
+
## eval src
|
|
273
|
+
</pre>
|
|
274
|
+
<a name="example1.result"></a>
|
|
275
|
+
<div class="terminal_caption">
|
|
276
|
+
output</div>
|
|
277
|
+
<pre class="terminal">$ ruby example1.rb
|
|
278
|
+
---------- script source ---
|
|
279
|
+
_buf = ''; _buf << '<ul>
|
|
280
|
+
'; for item in list
|
|
281
|
+
_buf << ' <li>'; _buf << ( item ).to_s; _buf << '</li>
|
|
282
|
+
'; end
|
|
283
|
+
|
|
284
|
+
_buf << '</ul>
|
|
285
|
+
';
|
|
286
|
+
_buf.to_s
|
|
287
|
+
---------- result ----------
|
|
288
|
+
<ul>
|
|
289
|
+
<li>aaa</li>
|
|
290
|
+
<li>bbb</li>
|
|
291
|
+
<li>ccc</li>
|
|
292
|
+
</ul>
|
|
293
|
+
</pre>
|
|
294
|
+
<p>Erubis has command 'erubis'. Command-line option '-x' shows the compiled source code of eRuby script.
|
|
295
|
+
</p>
|
|
296
|
+
<a name="example1_x.result"></a>
|
|
297
|
+
<div class="terminal_caption">
|
|
298
|
+
example of command-line option '-x'</div>
|
|
299
|
+
<pre class="terminal">$ erubis <strong>-x</strong> example1.eruby
|
|
300
|
+
_buf = ''; _buf << '<ul>
|
|
301
|
+
'; for item in list
|
|
302
|
+
_buf << ' <li>'; _buf << ( item ).to_s; _buf << '</li>
|
|
303
|
+
'; end
|
|
304
|
+
|
|
305
|
+
_buf << '</ul>
|
|
306
|
+
';
|
|
307
|
+
_buf.to_s
|
|
308
|
+
</pre>
|
|
309
|
+
<br>
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
<a name="tut-trim"></a>
|
|
313
|
+
<h3 class="section2">Trimming Spaces</h3>
|
|
314
|
+
<p>Erubis deletes spaces around '<% %>' automatically, while it leaves spaces around '<%= %>'.
|
|
315
|
+
</p>
|
|
316
|
+
<a name="example2.eruby.comment_filter"></a>
|
|
317
|
+
<div class="program_caption">
|
|
318
|
+
example2.eruby</div>
|
|
319
|
+
<pre class="program"><ul>
|
|
320
|
+
<% for item in list %> # trimmed
|
|
321
|
+
<li>
|
|
322
|
+
<%= item %> # not trimmed
|
|
323
|
+
</li>
|
|
324
|
+
<% end %> # trimmed
|
|
325
|
+
</ul>
|
|
326
|
+
</pre>
|
|
327
|
+
<a name="example2_x.result"></a>
|
|
328
|
+
<div class="terminal_caption">
|
|
329
|
+
compiled source code</div>
|
|
330
|
+
<pre class="terminal">$ erubis -x example2.eruby
|
|
331
|
+
_buf = ''; _buf << '<ul>
|
|
332
|
+
'; for item in list
|
|
333
|
+
_buf << ' <li>
|
|
334
|
+
'; _buf << ( item ).to_s; _buf << '
|
|
335
|
+
'; _buf << ' </li>
|
|
336
|
+
'; end
|
|
337
|
+
_buf << '</ul>
|
|
338
|
+
';
|
|
339
|
+
_buf.to_s
|
|
340
|
+
</pre>
|
|
341
|
+
<p>If you want leave spaces around '<% %>', add command-line property '--trim=false'.
|
|
342
|
+
</p>
|
|
343
|
+
<a name="example2_trim.result"></a>
|
|
344
|
+
<div class="terminal_caption">
|
|
345
|
+
compiled source code with command-line property '--trim=false'</div>
|
|
346
|
+
<pre class="terminal">$ erubis -x <strong>--trim=false</strong> example2.eruby
|
|
347
|
+
_buf = ''; _buf << '<ul>
|
|
348
|
+
'; _buf << ' '; for item in list ; _buf << '
|
|
349
|
+
'; _buf << ' <li>
|
|
350
|
+
'; _buf << ( item ).to_s; _buf << '
|
|
351
|
+
'; _buf << ' </li>
|
|
352
|
+
'; _buf << ' '; end ; _buf << '
|
|
353
|
+
'; _buf << '</ul>
|
|
354
|
+
';
|
|
355
|
+
_buf.to_s
|
|
356
|
+
</pre>
|
|
357
|
+
<p>Or add option <code>:trim=>false</code> to Erubis::Eruby.new().
|
|
358
|
+
</p>
|
|
359
|
+
<a name="example2.rb"></a>
|
|
360
|
+
<div class="program_caption">
|
|
361
|
+
example2.rb</div>
|
|
362
|
+
<pre class="program">require 'erubis'
|
|
363
|
+
input = File.read('example2.eruby')
|
|
364
|
+
eruby = Erubis::Eruby.new(input<strong>, :trim=>false</strong>)
|
|
365
|
+
|
|
366
|
+
puts "----- script source ---"
|
|
367
|
+
puts eruby.src # print script source
|
|
368
|
+
|
|
369
|
+
puts "----- result ----------"
|
|
370
|
+
list = ['aaa', 'bbb', 'ccc']
|
|
371
|
+
puts eruby.result(binding()) # get result
|
|
372
|
+
</pre>
|
|
373
|
+
<a name="example2.result"></a>
|
|
374
|
+
<div class="terminal_caption">
|
|
375
|
+
output</div>
|
|
376
|
+
<pre class="terminal">$ ruby example2.rb
|
|
377
|
+
----- script source ---
|
|
378
|
+
_buf = ''; _buf << '<ul>
|
|
379
|
+
'; <strong>_buf << ' ';</strong> for item in list ; _buf << '
|
|
380
|
+
'; _buf << ' <li>
|
|
381
|
+
'; _buf << ( item ).to_s; _buf << '
|
|
382
|
+
'; _buf << ' </li>
|
|
383
|
+
'; <strong>_buf << ' ';</strong> end ; _buf << '
|
|
384
|
+
'; _buf << '</ul>
|
|
385
|
+
';
|
|
386
|
+
_buf.to_s
|
|
387
|
+
----- result ----------
|
|
388
|
+
<ul>
|
|
389
|
+
|
|
390
|
+
<li>
|
|
391
|
+
aaa
|
|
392
|
+
</li>
|
|
393
|
+
|
|
394
|
+
<li>
|
|
395
|
+
bbb
|
|
396
|
+
</li>
|
|
397
|
+
|
|
398
|
+
<li>
|
|
399
|
+
ccc
|
|
400
|
+
</li>
|
|
401
|
+
|
|
402
|
+
</ul>
|
|
403
|
+
</pre>
|
|
404
|
+
<br>
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
<a name="tut-escape"></a>
|
|
408
|
+
<h3 class="section2">Escape</h3>
|
|
409
|
+
<p>Erubis has ability to escape (sanitize) expression.
|
|
410
|
+
Erubis::Eruby class act as the following:
|
|
411
|
+
</p>
|
|
412
|
+
<ul type="disc">
|
|
413
|
+
<li><code><%= <em>expr</em> %></code> - not escaped.
|
|
414
|
+
</li>
|
|
415
|
+
<li><code><%== <em>expr</em> %></code> - escaped.
|
|
416
|
+
</li>
|
|
417
|
+
<li><code><%=== <em>expr</em> %></code> - out to $stderr.
|
|
418
|
+
</li>
|
|
419
|
+
<li><code><%==== <em>expr</em> %></code> - ignored.
|
|
420
|
+
</li>
|
|
421
|
+
</ul>
|
|
422
|
+
<p>Erubis::EscapedEruby<sup>(<a href="#fnref:1" name="fnlink:1">*1</a>)</sup> class handle '<%= %>' as escaped and '<%== %>' as not escaped.
|
|
423
|
+
It means that using Erubis::EscapedEruby you can escape expression by default.
|
|
424
|
+
Also Erubis::XmlEruby class (which is equivalent to Erubis::EscapedEruby) is provided for compatibility with Erubis 1.1.
|
|
425
|
+
</p>
|
|
426
|
+
<a name="example3.eruby"></a>
|
|
427
|
+
<div class="program_caption">
|
|
428
|
+
example3.eruby</div>
|
|
429
|
+
<pre class="program"><% for item in list %>
|
|
430
|
+
<p><strong><%=</strong> item <strong>%></strong></p>
|
|
431
|
+
<p><strong><%==</strong> item <strong>%></strong></p>
|
|
432
|
+
<p><strong><%===</strong> item <strong>%></strong></p>
|
|
433
|
+
|
|
434
|
+
<% end %>
|
|
435
|
+
</pre>
|
|
436
|
+
<a name="example3.rb"></a>
|
|
437
|
+
<div class="program_caption">
|
|
438
|
+
example3.rb</div>
|
|
439
|
+
<pre class="program">require 'erubis'
|
|
440
|
+
input = File.read('example3.eruby')
|
|
441
|
+
eruby = Erubis::<strong>EscapedEruby</strong>.new(input) # or Erubis::XmlEruby
|
|
442
|
+
|
|
443
|
+
puts "----- script source ---"
|
|
444
|
+
puts eruby.src # print script source
|
|
445
|
+
|
|
446
|
+
puts "----- result ----------"
|
|
447
|
+
<strong>list = ['<aaa>', 'b&b', '"ccc"']</strong>
|
|
448
|
+
puts eruby.result(binding()) # get result
|
|
449
|
+
</pre>
|
|
450
|
+
<a name="example3.result.split_filter"></a>
|
|
451
|
+
<div class="terminal_caption">
|
|
452
|
+
output</div>
|
|
453
|
+
<pre class="terminal">$ ruby example3.rb 2> stderr.log
|
|
454
|
+
----- script source ---
|
|
455
|
+
_buf = ''; for item in list
|
|
456
|
+
_buf << ' <p>'; <strong>_buf << Erubis::XmlHelper.escape_xml( item )</strong>; _buf << '</p>
|
|
457
|
+
<p>'; <strong>_buf << ( item ).to_s</strong>; _buf << '</p>
|
|
458
|
+
<p>'; <strong>$stderr.puts("*** debug: item=#{(item).inspect}")</strong>; _buf << '</p>
|
|
459
|
+
|
|
460
|
+
'; end
|
|
461
|
+
_buf.to_s
|
|
462
|
+
----- result ----------
|
|
463
|
+
<p><strong>&lt;aaa&gt;</strong></p>
|
|
464
|
+
<p><aaa></p>
|
|
465
|
+
<p></p>
|
|
466
|
+
|
|
467
|
+
<p><strong>b&amp;b</strong></p>
|
|
468
|
+
<p>b&b</p>
|
|
469
|
+
<p></p>
|
|
470
|
+
|
|
471
|
+
<p><strong>&quot;ccc&quot;</strong></p>
|
|
472
|
+
<p>"ccc"</p>
|
|
473
|
+
<p></p>
|
|
474
|
+
|
|
475
|
+
$ cat stderr.log
|
|
476
|
+
*** debug: item="<aaa>"
|
|
477
|
+
*** debug: item="b&b"
|
|
478
|
+
*** debug: item="\"ccc\""
|
|
479
|
+
</pre>
|
|
480
|
+
<p>The command-line option '-e' will do the same action as Erubis::EscapedEruby.
|
|
481
|
+
This option is available for any language.
|
|
482
|
+
</p>
|
|
483
|
+
<a name="example3_e.result"></a>
|
|
484
|
+
<pre class="terminal">$ erubis -l ruby <strong>-e</strong> example3.eruby
|
|
485
|
+
_buf = ''; for item in list
|
|
486
|
+
_buf << ' <p>'; _buf << Erubis::XmlHelper.escape_xml( item ); _buf << '</p>
|
|
487
|
+
<p>'; _buf << ( item ).to_s; _buf << '</p>
|
|
488
|
+
<p>'; $stderr.puts("*** debug: item=#{(item).inspect}"); _buf << '</p>
|
|
489
|
+
|
|
490
|
+
'; end
|
|
491
|
+
_buf.to_s
|
|
492
|
+
</pre>
|
|
493
|
+
<p>Escaping function (default 'Erubis::XmlHelper.escape_xml()') can be changed by command-line property '--escapefunc=xxx' or by overriding Erubis::Eruby#escaped_expr() in subclass.
|
|
494
|
+
</p>
|
|
495
|
+
<div class="program_caption">
|
|
496
|
+
example to override Erubis::Eruby#escaped_expr()</div>
|
|
497
|
+
<pre class="program">class CGIEruby < Erubis::Eruby
|
|
498
|
+
def <strong>escaped_expr(code)</strong>
|
|
499
|
+
return "CGI.escapeHTML((#{code.strip}).to_s)"
|
|
500
|
+
#return "h(#{code.strip})"
|
|
501
|
+
end
|
|
502
|
+
end
|
|
503
|
+
|
|
504
|
+
class LatexEruby < Erubi::Eruby
|
|
505
|
+
def <strong>escaped_expr(code)</strong>
|
|
506
|
+
return "(#{code}).gsub(/[%\\]/,'\\\\\&')"
|
|
507
|
+
end
|
|
508
|
+
end
|
|
509
|
+
</pre>
|
|
510
|
+
<div class="footnote">
|
|
511
|
+
<dl compact>
|
|
512
|
+
<dt>(<a name="fnref:1" href="#fnlink:1">*1</a>)</dt>
|
|
513
|
+
<dd>Erubis::EscapedEruby class includes Erubis::EscapeEnhancer which swtches the action of '<%= %>' and '<%== %>'.</dd>
|
|
514
|
+
</dl>
|
|
515
|
+
</div>
|
|
516
|
+
<br>
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
<a name="tut-pattern"></a>
|
|
520
|
+
<h3 class="section2">Embedded Pattern</h3>
|
|
521
|
+
<p>You can change embedded pattern '<code><% %></code>' to another by command-line option '-p' or option '<code>:pattern=>...</code>' of Erubis::Eruby.new().
|
|
522
|
+
</p>
|
|
523
|
+
<a name="example4.eruby"></a>
|
|
524
|
+
<div class="program_caption">
|
|
525
|
+
example4.eruby</div>
|
|
526
|
+
<pre class="program"><strong><!--%</strong> for item in list <strong>%--></strong>
|
|
527
|
+
<p><strong><!--%=</strong> item <strong>%--></strong></p>
|
|
528
|
+
<strong><!--%</strong> end <strong>%--></strong>
|
|
529
|
+
</pre>
|
|
530
|
+
<a name="example4_x.result"></a>
|
|
531
|
+
<div class="terminal_caption">
|
|
532
|
+
compiled source code with command-line option '-p'</div>
|
|
533
|
+
<pre class="terminal">$ erubis -x <strong>-p '<!--% %-->'</strong> example4.eruby
|
|
534
|
+
_buf = ''; for item in list
|
|
535
|
+
_buf << ' <p>'; _buf << ( item ).to_s; _buf << '</p>
|
|
536
|
+
'; end
|
|
537
|
+
_buf.to_s
|
|
538
|
+
</pre>
|
|
539
|
+
<a name="example4.rb"></a>
|
|
540
|
+
<div class="program_caption">
|
|
541
|
+
example4.rb</div>
|
|
542
|
+
<pre class="program">require 'erubis'
|
|
543
|
+
input = File.read('example4.eruby')
|
|
544
|
+
eruby = Erubis::Eruby.new(input<strong>, :pattern=>'<!--% %-->'</strong>)
|
|
545
|
+
# or '<(?:!--)?% %(?:--)?>'
|
|
546
|
+
|
|
547
|
+
puts "---------- script source ---"
|
|
548
|
+
puts eruby.src # print script source
|
|
549
|
+
|
|
550
|
+
puts "---------- result ----------"
|
|
551
|
+
list = ['aaa', 'bbb', 'ccc']
|
|
552
|
+
puts eruby.result(binding()) # get result
|
|
553
|
+
</pre>
|
|
554
|
+
<a name="example4.result"></a>
|
|
555
|
+
<div class="terminal_caption">
|
|
556
|
+
output</div>
|
|
557
|
+
<pre class="terminal">$ ruby example4.rb
|
|
558
|
+
---------- script source ---
|
|
559
|
+
_buf = ''; for item in list
|
|
560
|
+
_buf << ' <p>'; _buf << ( item ).to_s; _buf << '</p>
|
|
561
|
+
'; end
|
|
562
|
+
_buf.to_s
|
|
563
|
+
---------- result ----------
|
|
564
|
+
<p>aaa</p>
|
|
565
|
+
<p>bbb</p>
|
|
566
|
+
<p>ccc</p>
|
|
567
|
+
</pre>
|
|
568
|
+
<p>It is able to specify regular expression with :pattern option.
|
|
569
|
+
Notice that you must use '<code>(?: )</code>' instead of '<code>( )</code>' for grouping.
|
|
570
|
+
For example, '<code><(!--)?% %(--)?></code>' will not work while '<code><(?:!--)?% %(?:--)?></code>' will work.
|
|
571
|
+
</p>
|
|
572
|
+
<br>
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
<a name="tut-context"></a>
|
|
576
|
+
<h3 class="section2">Context Object</h3>
|
|
577
|
+
<p>Context object is a set of data which are used in eRuby script.
|
|
578
|
+
Using context object makes clear which data to be used.
|
|
579
|
+
In Erubis, Hash object and Erubis::Context object are available as context object.
|
|
580
|
+
</p>
|
|
581
|
+
<p>Context data can be accessible via instance variables in eRuby script.
|
|
582
|
+
</p>
|
|
583
|
+
<a name="example5.eruby"></a>
|
|
584
|
+
<div class="program_caption">
|
|
585
|
+
example5.eruby</div>
|
|
586
|
+
<pre class="program"><span><%= <strong>@val</strong> %></span>
|
|
587
|
+
<ul>
|
|
588
|
+
<% for item in <strong>@list</strong> %>
|
|
589
|
+
<li><%= item %></li>
|
|
590
|
+
<% end %>
|
|
591
|
+
</ul>
|
|
592
|
+
</pre>
|
|
593
|
+
<a name="example5.rb"></a>
|
|
594
|
+
<div class="program_caption">
|
|
595
|
+
example5.rb</div>
|
|
596
|
+
<pre class="program">require 'erubis'
|
|
597
|
+
input = File.read('example5.eruby')
|
|
598
|
+
eruby = Erubis::Eruby.new(input) # create Eruby object
|
|
599
|
+
|
|
600
|
+
## create context object
|
|
601
|
+
## (key means var name, which may be string or symbol.)
|
|
602
|
+
<strong>context = {
|
|
603
|
+
:val => 'Erubis Example',
|
|
604
|
+
'list' => ['aaa', 'bbb', 'ccc'],
|
|
605
|
+
}</strong>
|
|
606
|
+
## or
|
|
607
|
+
# context = Erubis::Context.new()
|
|
608
|
+
# context['val'] = 'Erubis Example'
|
|
609
|
+
# context[:list] = ['aaa', 'bbb', 'ccc'],
|
|
610
|
+
|
|
611
|
+
puts <strong>eruby.evaluate(context)</strong> # get result
|
|
612
|
+
</pre>
|
|
613
|
+
<a name="example5.result"></a>
|
|
614
|
+
<div class="terminal_caption">
|
|
615
|
+
output</div>
|
|
616
|
+
<pre class="terminal">$ ruby example5.rb
|
|
617
|
+
<span>Erubis Example</span>
|
|
618
|
+
<ul>
|
|
619
|
+
<li>aaa</li>
|
|
620
|
+
<li>bbb</li>
|
|
621
|
+
<li>ccc</li>
|
|
622
|
+
</ul>
|
|
623
|
+
</pre>
|
|
624
|
+
<p>The difference between Erubis#result(binding) and Erubis#evaluate(context) is that the former invokes 'eval @src, binding' and the latter invokes 'context.instance_eval @src'.
|
|
625
|
+
This means that data is passed into eRuby script via local variables when Eruby::binding() is called, or passed via instance variables when Eruby::evaluate() is called.
|
|
626
|
+
</p>
|
|
627
|
+
<p>Here is the definition of Erubis#result() and Erubis#evaluate().
|
|
628
|
+
</p>
|
|
629
|
+
<div class="program_caption">
|
|
630
|
+
definition of result(binding) and evaluate(context)</div>
|
|
631
|
+
<pre class="program">def result(_binding=TOPLEVEL_BINDING)
|
|
632
|
+
if _binding.is_a?(Hash)
|
|
633
|
+
# load hash data as local variable
|
|
634
|
+
_h = _binding
|
|
635
|
+
_binding = binding()
|
|
636
|
+
eval _h.collect{|k,v| "#{k} = _h[#{k.inspect}];"}.join, _binding
|
|
637
|
+
end
|
|
638
|
+
return <strong>eval(@src, _binding)</strong>
|
|
639
|
+
end
|
|
640
|
+
|
|
641
|
+
def evaluate(_context=Erubis::Context.new)
|
|
642
|
+
if _context.is_a?(Hash)
|
|
643
|
+
# convert hash object to Context object
|
|
644
|
+
_hash = _context
|
|
645
|
+
_context = Erubis::Context.new
|
|
646
|
+
_hash.each {|k, v| _context[k] = v }
|
|
647
|
+
end
|
|
648
|
+
return <strong>_context.instance_eval(@src)</strong>
|
|
649
|
+
end
|
|
650
|
+
</pre>
|
|
651
|
+
<p>instance_eval() is defined at Object class so it is able to use any object as a context object as well as Hash or Erubis::Context.
|
|
652
|
+
</p>
|
|
653
|
+
<a name="example6.rb"></a>
|
|
654
|
+
<div class="program_caption">
|
|
655
|
+
example6.rb</div>
|
|
656
|
+
<pre class="program">class MyData
|
|
657
|
+
attr_accessor :val, :list
|
|
658
|
+
end
|
|
659
|
+
|
|
660
|
+
## any object can be a context object
|
|
661
|
+
<strong>mydata = MyData.new</strong>
|
|
662
|
+
<strong>mydata.val = 'Erubis Example'</strong>
|
|
663
|
+
<strong>mydata.list = ['aaa', 'bbb', 'ccc']</strong>
|
|
664
|
+
|
|
665
|
+
require 'erubis'
|
|
666
|
+
eruby = Erubis::Eruby.new(File.read('example5.eruby'))
|
|
667
|
+
puts eruby.evaluate(<strong>mydata</strong>)
|
|
668
|
+
</pre>
|
|
669
|
+
<a name="example6.result"></a>
|
|
670
|
+
<div class="terminal_caption">
|
|
671
|
+
output</div>
|
|
672
|
+
<pre class="terminal">$ ruby example6.rb
|
|
673
|
+
<span>Erubis Example</span>
|
|
674
|
+
<ul>
|
|
675
|
+
<li>aaa</li>
|
|
676
|
+
<li>bbb</li>
|
|
677
|
+
<li>ccc</li>
|
|
678
|
+
</ul>
|
|
679
|
+
</pre>
|
|
680
|
+
<p>It is recommended to use 'Erubis::Eruby#evaluate(context)' rather than 'Erubis::Eruby#result(binding())' because the latter has some problems.
|
|
681
|
+
See <a href="#topics-context-vs-binding">evaluate(context) v.s. result(binding)</a> section for details.
|
|
682
|
+
</p>
|
|
683
|
+
<br>
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
<a name="tut-datafile"></a>
|
|
687
|
+
<h3 class="section2">Context Data File</h3>
|
|
688
|
+
<p>Command-line option '-f' specifies context data file.
|
|
689
|
+
Erubis load context data file and use it as context data.
|
|
690
|
+
Context data file can be YAML file ('*.yaml' or '*.yml') or Ruby script ('*.rb').
|
|
691
|
+
</p>
|
|
692
|
+
<a name="example7.eruby"></a>
|
|
693
|
+
<div class="program_caption">
|
|
694
|
+
example7.eruby</div>
|
|
695
|
+
<pre class="program"><h1><%= <strong>@title</strong> %></h1>
|
|
696
|
+
<ul>
|
|
697
|
+
<% for user in <strong>@users</strong> %>
|
|
698
|
+
<li>
|
|
699
|
+
<a href="mailto:<%= user['mail']%>"><%= user['name'] %></a>
|
|
700
|
+
</li>
|
|
701
|
+
<% end %>
|
|
702
|
+
</ul>
|
|
703
|
+
</pre>
|
|
704
|
+
<a name="context.yaml"></a>
|
|
705
|
+
<div class="program_caption">
|
|
706
|
+
context.yaml</div>
|
|
707
|
+
<pre class="program"><strong>title:</strong> Users List
|
|
708
|
+
<strong>users:</strong>
|
|
709
|
+
- name: foo
|
|
710
|
+
mail: foo@mail.com
|
|
711
|
+
- name: bar
|
|
712
|
+
mail: bar@mail.net
|
|
713
|
+
- name: baz
|
|
714
|
+
mail: baz@mail.org
|
|
715
|
+
</pre>
|
|
716
|
+
<a name="context.rb"></a>
|
|
717
|
+
<div class="program_caption">
|
|
718
|
+
context.rb</div>
|
|
719
|
+
<pre class="program">@title = 'Users List'
|
|
720
|
+
@users = [
|
|
721
|
+
{ 'name'=>'foo', 'mail'=>'foo@mail.com' },
|
|
722
|
+
{ 'name'=>'bar', 'mail'=>'bar@mail.net' },
|
|
723
|
+
{ 'name'=>'baz', 'mail'=>'baz@mail.org' },
|
|
724
|
+
]
|
|
725
|
+
</pre>
|
|
726
|
+
<a name="example7.result.split_filter"></a>
|
|
727
|
+
<div class="terminal_caption">
|
|
728
|
+
example of command-line option '-f'</div>
|
|
729
|
+
<pre class="terminal">$ erubis <strong>-f context.yaml</strong> example7.eruby
|
|
730
|
+
<h1>Users List</h1>
|
|
731
|
+
<ul>
|
|
732
|
+
<li>
|
|
733
|
+
<a href="mailto:foo@mail.com">foo</a>
|
|
734
|
+
</li>
|
|
735
|
+
<li>
|
|
736
|
+
<a href="mailto:bar@mail.net">bar</a>
|
|
737
|
+
</li>
|
|
738
|
+
<li>
|
|
739
|
+
<a href="mailto:baz@mail.org">baz</a>
|
|
740
|
+
</li>
|
|
741
|
+
</ul>
|
|
742
|
+
$ erubis <strong>-f context.rb</strong> example7.eruby
|
|
743
|
+
<h1>Users List</h1>
|
|
744
|
+
<ul>
|
|
745
|
+
<li>
|
|
746
|
+
<a href="mailto:foo@mail.com">foo</a>
|
|
747
|
+
</li>
|
|
748
|
+
<li>
|
|
749
|
+
<a href="mailto:bar@mail.net">bar</a>
|
|
750
|
+
</li>
|
|
751
|
+
<li>
|
|
752
|
+
<a href="mailto:baz@mail.org">baz</a>
|
|
753
|
+
</li>
|
|
754
|
+
</ul>
|
|
755
|
+
</pre>
|
|
756
|
+
<p>Command-line option '-S' converts keys of mapping in YAML data file from string into symbol.
|
|
757
|
+
Command-line option '-B' invokes 'Erubis::Eruby#result(binding())' instead of 'Erubis::Eruby#evaluate(context)'.
|
|
758
|
+
</p>
|
|
759
|
+
<br>
|
|
760
|
+
|
|
761
|
+
|
|
762
|
+
<a name="tut-datastr"></a>
|
|
763
|
+
<h3 class="section2">Context Data String</h3>
|
|
764
|
+
<p>Command-line option '-c <em>str</em>' enables you to specify context data in command-line.
|
|
765
|
+
<em>str</em> can be YAML flow-style or Ruby code.
|
|
766
|
+
</p>
|
|
767
|
+
<a name="example8.eruby"></a>
|
|
768
|
+
<div class="program_caption">
|
|
769
|
+
example8.eruby</div>
|
|
770
|
+
<pre class="program"><h1><%= @title %></h1>
|
|
771
|
+
<ul>
|
|
772
|
+
<% for item in @list %>
|
|
773
|
+
<li><%= item %></li>
|
|
774
|
+
<% end %>
|
|
775
|
+
</ul>
|
|
776
|
+
</pre>
|
|
777
|
+
<a name="example8_yaml.result"></a>
|
|
778
|
+
<div class="terminal_caption">
|
|
779
|
+
example of YAML flow style</div>
|
|
780
|
+
<pre class="terminal">$ erubis <strong>-c '{title: Example, list: [AAA, BBB, CCC]}'</strong> example8.eruby
|
|
781
|
+
<h1>Example</h1>
|
|
782
|
+
<ul>
|
|
783
|
+
<li>AAA</li>
|
|
784
|
+
<li>BBB</li>
|
|
785
|
+
<li>CCC</li>
|
|
786
|
+
</ul>
|
|
787
|
+
</pre>
|
|
788
|
+
<a name="example8_ruby.result"></a>
|
|
789
|
+
<div class="terminal_caption">
|
|
790
|
+
example of Ruby code</div>
|
|
791
|
+
<pre class="terminal">$ erubis <strong>-c '@title="Example"; @list=%w[AAA BBB CCC]'</strong> example8.eruby
|
|
792
|
+
<h1>Example</h1>
|
|
793
|
+
<ul>
|
|
794
|
+
<li>AAA</li>
|
|
795
|
+
<li>BBB</li>
|
|
796
|
+
<li>CCC</li>
|
|
797
|
+
</ul>
|
|
798
|
+
</pre>
|
|
799
|
+
<br>
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
<a name="tut-preamble"></a>
|
|
803
|
+
<h3 class="section2">Preamble and Postamble</h3>
|
|
804
|
+
<p>The first line ('_buf = '';') in the compiled source code is called preamble
|
|
805
|
+
and the last line ('_buf.to_s') is called postamble.
|
|
806
|
+
</p>
|
|
807
|
+
<p>Command-line option '-b' skips the output of preamble and postamble.
|
|
808
|
+
</p>
|
|
809
|
+
<a name="example9.eruby"></a>
|
|
810
|
+
<div class="program_caption">
|
|
811
|
+
example9.eruby</div>
|
|
812
|
+
<pre class="program"><% for item in @list %>
|
|
813
|
+
<b><%= item %></b>
|
|
814
|
+
<% end %>
|
|
815
|
+
</pre>
|
|
816
|
+
<a name="example9.result.split_filter"></a>
|
|
817
|
+
<div class="terminal_caption">
|
|
818
|
+
compiled source code with and without command-line option '-b'</div>
|
|
819
|
+
<pre class="terminal">$ erubis -x example9.eruby
|
|
820
|
+
<strong>_buf = '';</strong> for item in @list
|
|
821
|
+
_buf << ' <b>'; _buf << ( item ).to_s; _buf << '</b>
|
|
822
|
+
'; end
|
|
823
|
+
<strong>_buf.to_s</strong>
|
|
824
|
+
$ erubis -x <strong>-b</strong> example9.eruby
|
|
825
|
+
for item in @list
|
|
826
|
+
_buf << ' <b>'; _buf << ( item ).to_s; _buf << '</b>
|
|
827
|
+
'; end
|
|
828
|
+
</pre>
|
|
829
|
+
<p>Erubis::Eruby.new option '<code>:preamble=>false</code>' and '<code>:postamble=>false</code>' also suppress output of preamble or postamle.
|
|
830
|
+
</p>
|
|
831
|
+
<a name="example9.rb"></a>
|
|
832
|
+
<div class="program_caption">
|
|
833
|
+
example9.rb</div>
|
|
834
|
+
<pre class="program">require 'erubis'
|
|
835
|
+
input = File.read('example9.eruby')
|
|
836
|
+
eruby1 = Erubis::Eruby.new(input)
|
|
837
|
+
eruby2 = Erubis::Eruby.new(input, <strong>:preamble=>false, :postamble=>false</strong>)
|
|
838
|
+
|
|
839
|
+
puts eruby1.src # print preamble and postamble
|
|
840
|
+
puts "--------------"
|
|
841
|
+
puts eruby2.src # don't print preamble and postamble
|
|
842
|
+
</pre>
|
|
843
|
+
<a name="example9.result"></a>
|
|
844
|
+
<div class="terminal_caption">
|
|
845
|
+
output</div>
|
|
846
|
+
<pre class="terminal">$ ruby example9.rb
|
|
847
|
+
_buf = ''; for item in @list
|
|
848
|
+
_buf << ' <b>'; _buf << ( item ).to_s; _buf << '</b>
|
|
849
|
+
'; end
|
|
850
|
+
_buf.to_s
|
|
851
|
+
--------------
|
|
852
|
+
for item in @list
|
|
853
|
+
_buf << ' <b>'; _buf << ( item ).to_s; _buf << '</b>
|
|
854
|
+
'; end
|
|
855
|
+
</pre>
|
|
856
|
+
<br>
|
|
857
|
+
|
|
858
|
+
|
|
859
|
+
<a name="tut-pi"></a>
|
|
860
|
+
<h3 class="section2">Processing Instruction (PI) Converter</h3>
|
|
861
|
+
<p>Erubis can parse Processing Instructions (PI) as embedded pattern.
|
|
862
|
+
</p>
|
|
863
|
+
<ul type="disc">
|
|
864
|
+
<li>'<code><?rb <em>...</em> ?></code>' represents Ruby statement.
|
|
865
|
+
</li>
|
|
866
|
+
<li>'<code>@{<em>...</em>}@</code>' represents escaped expression value.
|
|
867
|
+
</li>
|
|
868
|
+
<li>'<code>@!{<em>...</em>}@</code>' represents normal expression value.
|
|
869
|
+
</li>
|
|
870
|
+
<li>'<code>@!!{<em>...</em>}@</code>' prints expression value to standard output.
|
|
871
|
+
</li>
|
|
872
|
+
<li>(experimental) '<code><%= <em>...</em> %></code>' is also available to print expression value.
|
|
873
|
+
</li>
|
|
874
|
+
</ul>
|
|
875
|
+
<p>This is more useful than basic embedded pattern ('<code><% ... ></code>') because PI doesn't break XML or HTML at all.
|
|
876
|
+
For example the following XHTML file is well-formed and HTML validator got no errors on this example.
|
|
877
|
+
</p>
|
|
878
|
+
<a name="example10.xhtml"></a>
|
|
879
|
+
<div class="program_caption">
|
|
880
|
+
example10.xhtml</div>
|
|
881
|
+
<pre class="program"><?xml version="1.0" ?>
|
|
882
|
+
<strong><?rb
|
|
883
|
+
lang = 'en'
|
|
884
|
+
list = ['<aaa>', 'b&b', '"ccc"']
|
|
885
|
+
?></strong>
|
|
886
|
+
<html lang="<strong>@!{lang}@</strong>">
|
|
887
|
+
<body>
|
|
888
|
+
<ul>
|
|
889
|
+
<strong><?rb for item in list ?></strong>
|
|
890
|
+
<li><strong>@{item}@</strong></li>
|
|
891
|
+
<strong><?rb end ?></strong>
|
|
892
|
+
</ul>
|
|
893
|
+
</body>
|
|
894
|
+
</html>
|
|
895
|
+
</pre>
|
|
896
|
+
<p>If the command-line property '--pi=<em>name</em>' is specified, erubis command parses input with PI converter.
|
|
897
|
+
If <em>name</em> is omitted then the following name is used according to '-l <em>lang</em>'.
|
|
898
|
+
</p>
|
|
899
|
+
<div align="center">
|
|
900
|
+
<table class="table1" border="1" cellspacing="0">
|
|
901
|
+
<tr class="tr1">
|
|
902
|
+
<th class="th1">'-l' option</th>
|
|
903
|
+
<th class="th1">PI name</th>
|
|
904
|
+
</tr>
|
|
905
|
+
<tr class="tr1">
|
|
906
|
+
<td class="td1">-l ruby</td>
|
|
907
|
+
<td class="td1"><?rb ... ?></td>
|
|
908
|
+
</tr>
|
|
909
|
+
<tr class="tr1">
|
|
910
|
+
<td class="td1">-l php</td>
|
|
911
|
+
<td class="td1"><?php ... ?></td>
|
|
912
|
+
</tr>
|
|
913
|
+
<tr class="tr1">
|
|
914
|
+
<td class="td1">-l perl</td>
|
|
915
|
+
<td class="td1"><?perl ... ?></td>
|
|
916
|
+
</tr>
|
|
917
|
+
<tr class="tr1">
|
|
918
|
+
<td class="td1">-l java</td>
|
|
919
|
+
<td class="td1"><?java ... ?></td>
|
|
920
|
+
</tr>
|
|
921
|
+
<tr class="tr1">
|
|
922
|
+
<td class="td1">-l javascript</td>
|
|
923
|
+
<td class="td1"><?js ... ?></td>
|
|
924
|
+
</tr>
|
|
925
|
+
<tr class="tr1">
|
|
926
|
+
<td class="td1">-l scheme</td>
|
|
927
|
+
<td class="td1"><?scheme ... ?></td>
|
|
928
|
+
</tr>
|
|
929
|
+
</table>
|
|
930
|
+
</div>
|
|
931
|
+
<a name="example10_x.result"></a>
|
|
932
|
+
<div class="terminal_caption">
|
|
933
|
+
output</div>
|
|
934
|
+
<pre class="terminal">$ erubis -x <strong>--pi</strong> example10.xhtml
|
|
935
|
+
_buf = ''; _buf << '<?xml version="1.0" ?>
|
|
936
|
+
';
|
|
937
|
+
lang = 'en'
|
|
938
|
+
list = ['<aaa>', 'b&b', '"ccc"']
|
|
939
|
+
|
|
940
|
+
_buf << '<html lang="'; _buf << (lang).to_s; _buf << '">
|
|
941
|
+
<body>
|
|
942
|
+
<ul>
|
|
943
|
+
'; for item in list
|
|
944
|
+
_buf << ' <li>'; _buf << Erubis::XmlHelper.escape_xml(item); _buf << '</li>
|
|
945
|
+
'; end
|
|
946
|
+
_buf << ' </ul>
|
|
947
|
+
</body>
|
|
948
|
+
</html>
|
|
949
|
+
';
|
|
950
|
+
_buf.to_s
|
|
951
|
+
</pre>
|
|
952
|
+
<p>Expression character can be changeable by command-line property '--embchar=<em>char</em>. Default is '<code>@</code>'.
|
|
953
|
+
</p>
|
|
954
|
+
<p>Use Erubis::PI::Eruby instead of Erubis::Eruby if you want to use PI as embedded pattern.
|
|
955
|
+
</p>
|
|
956
|
+
<a name="example10.rb"></a>
|
|
957
|
+
<div class="program_caption">
|
|
958
|
+
example10.rb</div>
|
|
959
|
+
<pre class="program">require 'erubis'
|
|
960
|
+
input = File.read('example10.xhtml')
|
|
961
|
+
eruby = Erubis::PI::Eruby.new(input)
|
|
962
|
+
print eruby.src
|
|
963
|
+
</pre>
|
|
964
|
+
<a name="example10.result"></a>
|
|
965
|
+
<div class="terminal_caption">
|
|
966
|
+
output</div>
|
|
967
|
+
<pre class="terminal">$ ruby example10.rb
|
|
968
|
+
_buf = ''; _buf << '<?xml version="1.0" ?>
|
|
969
|
+
';
|
|
970
|
+
lang = 'en'
|
|
971
|
+
list = ['<aaa>', 'b&b', '"ccc"']
|
|
972
|
+
|
|
973
|
+
_buf << '<html lang="'; _buf << (lang).to_s; _buf << '">
|
|
974
|
+
<body>
|
|
975
|
+
<ul>
|
|
976
|
+
'; for item in list
|
|
977
|
+
_buf << ' <li>'; _buf << Erubis::XmlHelper.escape_xml(item); _buf << '</li>
|
|
978
|
+
'; end
|
|
979
|
+
_buf << ' </ul>
|
|
980
|
+
</body>
|
|
981
|
+
</html>
|
|
982
|
+
';
|
|
983
|
+
_buf.to_s
|
|
984
|
+
</pre>
|
|
985
|
+
<p><strong>(experimental)</strong> Erubis supports '<%= ... %>' pattern with PI pattern.
|
|
986
|
+
</p>
|
|
987
|
+
<div class="program_caption">
|
|
988
|
+
example of Rails view template</div>
|
|
989
|
+
<pre class="program"><table>
|
|
990
|
+
<tr>
|
|
991
|
+
<?rb for item in @list ?>
|
|
992
|
+
<td>@{item.id}@</td>
|
|
993
|
+
<td>@{item.name}@</td>
|
|
994
|
+
<td>
|
|
995
|
+
<strong><%=</strong> link_to 'Destroy', {:action=>'destroy', :id=>item.id},
|
|
996
|
+
:confirm=>'Are you OK?' <strong>%></strong>
|
|
997
|
+
</td>
|
|
998
|
+
<?rb end ?>
|
|
999
|
+
</tr>
|
|
1000
|
+
</table>
|
|
1001
|
+
</pre>
|
|
1002
|
+
<br>
|
|
1003
|
+
|
|
1004
|
+
|
|
1005
|
+
<a name="tut-notext"></a>
|
|
1006
|
+
<h3 class="section2">Retrieve Ruby Code</h3>
|
|
1007
|
+
<p>Similar to '-x', ommand-line option '-X' shows converted Ruby source code.
|
|
1008
|
+
The difference between '-x' and 'X' is that the former converts text part but the latter ignores it.
|
|
1009
|
+
It means that you can retrieve Ruby code from eRuby script by '-X' option.
|
|
1010
|
+
</p>
|
|
1011
|
+
<p>For example, see the following eRuby script.
|
|
1012
|
+
This is some complex, so it is difficult to grasp the program code.
|
|
1013
|
+
</p>
|
|
1014
|
+
<a name="example11.rhtml"></a>
|
|
1015
|
+
<div class="program_caption">
|
|
1016
|
+
example11.rhtml</div>
|
|
1017
|
+
<pre class="program"><?xml version="1.0" encoding="UTF-8"?>
|
|
1018
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
1019
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
1020
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
1021
|
+
<body>
|
|
1022
|
+
<h3>List</h3>
|
|
1023
|
+
<% if @list.nil? || @list.empty? %>
|
|
1024
|
+
<p>not found.</p>
|
|
1025
|
+
<% else %>
|
|
1026
|
+
<table>
|
|
1027
|
+
<tbody>
|
|
1028
|
+
<% @list.each_with_index do |item, i| %>
|
|
1029
|
+
<tr bgcolor="<%= i % 2 == 0 ? '#FCC' : '#CCF' %>">
|
|
1030
|
+
<td><%= item %></td>
|
|
1031
|
+
</tr>
|
|
1032
|
+
<% end %>
|
|
1033
|
+
</tbody>
|
|
1034
|
+
</table>
|
|
1035
|
+
<% end %>
|
|
1036
|
+
</body>
|
|
1037
|
+
</html>
|
|
1038
|
+
</pre>
|
|
1039
|
+
<p>Command-line option '-X' extracts only the ruby code from eRuby script.
|
|
1040
|
+
</p>
|
|
1041
|
+
<a name="example11.result"></a>
|
|
1042
|
+
<div class="terminal_caption">
|
|
1043
|
+
result</div>
|
|
1044
|
+
<pre class="terminal">$ erubis <strong>-X</strong> example11.rhtml
|
|
1045
|
+
_buf = '';
|
|
1046
|
+
|
|
1047
|
+
|
|
1048
|
+
|
|
1049
|
+
|
|
1050
|
+
|
|
1051
|
+
if @list.nil? || @list.empty?
|
|
1052
|
+
|
|
1053
|
+
else
|
|
1054
|
+
|
|
1055
|
+
|
|
1056
|
+
@list.each_with_index do |item, i|
|
|
1057
|
+
_buf << ( i % 2 == 0 ? '#FCC' : '#CCF' ).to_s;
|
|
1058
|
+
_buf << ( item ).to_s;
|
|
1059
|
+
|
|
1060
|
+
end
|
|
1061
|
+
|
|
1062
|
+
|
|
1063
|
+
end
|
|
1064
|
+
|
|
1065
|
+
|
|
1066
|
+
_buf.to_s
|
|
1067
|
+
</pre>
|
|
1068
|
+
<p>Command-line option '-C' (<strong>c</strong>mpact) deletes empty lines.
|
|
1069
|
+
</p>
|
|
1070
|
+
<a name="example11_C.result"></a>
|
|
1071
|
+
<div class="terminal_caption">
|
|
1072
|
+
result</div>
|
|
1073
|
+
<pre class="terminal">$ erubis <strong>-XC</strong> example11.rhtml
|
|
1074
|
+
_buf = '';
|
|
1075
|
+
if @list.nil? || @list.empty?
|
|
1076
|
+
else
|
|
1077
|
+
@list.each_with_index do |item, i|
|
|
1078
|
+
_buf << ( i % 2 == 0 ? '#FCC' : '#CCF' ).to_s;
|
|
1079
|
+
_buf << ( item ).to_s;
|
|
1080
|
+
end
|
|
1081
|
+
end
|
|
1082
|
+
_buf.to_s
|
|
1083
|
+
</pre>
|
|
1084
|
+
<p>Option '-U' (<strong>u</strong>nique) converts empty lines into a line.
|
|
1085
|
+
</p>
|
|
1086
|
+
<a name="example11_U.result"></a>
|
|
1087
|
+
<div class="terminal_caption">
|
|
1088
|
+
result</div>
|
|
1089
|
+
<pre class="terminal">$ erubis <strong>-XU</strong> example11.rhtml
|
|
1090
|
+
_buf = '';
|
|
1091
|
+
|
|
1092
|
+
if @list.nil? || @list.empty?
|
|
1093
|
+
|
|
1094
|
+
else
|
|
1095
|
+
|
|
1096
|
+
@list.each_with_index do |item, i|
|
|
1097
|
+
_buf << ( i % 2 == 0 ? '#FCC' : '#CCF' ).to_s;
|
|
1098
|
+
_buf << ( item ).to_s;
|
|
1099
|
+
|
|
1100
|
+
end
|
|
1101
|
+
|
|
1102
|
+
end
|
|
1103
|
+
|
|
1104
|
+
_buf.to_s
|
|
1105
|
+
</pre>
|
|
1106
|
+
<p>Option '-N' (<strong>n</strong>umber) adds line number.
|
|
1107
|
+
It is available with '-C' or '-U'.
|
|
1108
|
+
</p>
|
|
1109
|
+
<a name="example11_N.result"></a>
|
|
1110
|
+
<div class="terminal_caption">
|
|
1111
|
+
result</div>
|
|
1112
|
+
<pre class="terminal">$ erubis <strong>-XNU</strong> example11.rhtml
|
|
1113
|
+
1: _buf = '';
|
|
1114
|
+
|
|
1115
|
+
7: if @list.nil? || @list.empty?
|
|
1116
|
+
|
|
1117
|
+
9: else
|
|
1118
|
+
|
|
1119
|
+
12: @list.each_with_index do |item, i|
|
|
1120
|
+
13: _buf << ( i % 2 == 0 ? '#FCC' : '#CCF' ).to_s;
|
|
1121
|
+
14: _buf << ( item ).to_s;
|
|
1122
|
+
|
|
1123
|
+
16: end
|
|
1124
|
+
|
|
1125
|
+
19: end
|
|
1126
|
+
|
|
1127
|
+
22: _buf.to_s
|
|
1128
|
+
</pre>
|
|
1129
|
+
<p>Command-line option '-X' is available with PHP script.
|
|
1130
|
+
</p>
|
|
1131
|
+
<a name="example11.php"></a>
|
|
1132
|
+
<div class="program_caption">
|
|
1133
|
+
example11.php</div>
|
|
1134
|
+
<pre class="program"><?xml version="1.0"?>
|
|
1135
|
+
<html>
|
|
1136
|
+
<body>
|
|
1137
|
+
<h3>List</h3>
|
|
1138
|
+
<?php if (!$list) { ?>
|
|
1139
|
+
<p>not found.</p>
|
|
1140
|
+
<?php } else { ?>
|
|
1141
|
+
<table>
|
|
1142
|
+
<tbody>
|
|
1143
|
+
<?php $i = 0; ?>
|
|
1144
|
+
<?php foreach ($list as $item) { ?>
|
|
1145
|
+
<tr bgcolor="<?php echo ++$i % 2 == 1 ? '#FCC' : '#CCF'; ?>">
|
|
1146
|
+
<td><?php echo $item; ?></td>
|
|
1147
|
+
</tr>
|
|
1148
|
+
<?php } ?>
|
|
1149
|
+
</tbody>
|
|
1150
|
+
</table>
|
|
1151
|
+
<?php } ?>
|
|
1152
|
+
</body>
|
|
1153
|
+
</html>
|
|
1154
|
+
</pre>
|
|
1155
|
+
<a name="example11_php.result"></a>
|
|
1156
|
+
<div class="terminal_caption">
|
|
1157
|
+
result</div>
|
|
1158
|
+
<pre class="terminal">$ erubis -XNU <strong>-l php</strong> <strong>--pi=php</strong> --trim=false example11.php
|
|
1159
|
+
|
|
1160
|
+
5: <?php if (!$list) { ?>
|
|
1161
|
+
|
|
1162
|
+
7: <?php } else { ?>
|
|
1163
|
+
|
|
1164
|
+
10: <?php $i = 0; ?>
|
|
1165
|
+
11: <?php foreach ($list as $item) { ?>
|
|
1166
|
+
12: <?php echo ++$i % 2 == 1 ? '#FCC' : '#CCF'; ?>
|
|
1167
|
+
13: <?php echo $item; ?>
|
|
1168
|
+
|
|
1169
|
+
15: <?php } ?>
|
|
1170
|
+
|
|
1171
|
+
18: <?php } ?>
|
|
1172
|
+
|
|
1173
|
+
</pre>
|
|
1174
|
+
<br>
|
|
1175
|
+
|
|
1176
|
+
|
|
1177
|
+
<br>
|
|
1178
|
+
|
|
1179
|
+
|
|
1180
|
+
<a name="enhancer"></a>
|
|
1181
|
+
<h2 class="section1">Enhancer</h2>
|
|
1182
|
+
<p>Enhancer is a module to add a certain feature into Erubis::Eruby class.
|
|
1183
|
+
Enhancer may be language-independent or only for Erubis::Eruby class.
|
|
1184
|
+
</p>
|
|
1185
|
+
<p>To use enhancers, define subclass and include them.
|
|
1186
|
+
The folloing is an example to use <a href="#escape-enhancer">EscapeEnhancer</a>, <a href="#percentline-enhancer">PercentLineEnhancer</a>, and <a href="#bipattern-enhancer">BiPatternEnhancer</a>.
|
|
1187
|
+
</p>
|
|
1188
|
+
<pre class="program">class MyEruby < Erubis::Eruby
|
|
1189
|
+
include EscapeEnhancer
|
|
1190
|
+
include PercentLineEnhancer
|
|
1191
|
+
include BiPatternEnhancer
|
|
1192
|
+
end
|
|
1193
|
+
</pre>
|
|
1194
|
+
<p>You can specify enhancers in command-line with option '-E'.
|
|
1195
|
+
The following is an example to use some enhancers in command-line.
|
|
1196
|
+
</p>
|
|
1197
|
+
<pre class="terminal">$ erubis -xE Escape,PercentLine,BiPattern example.eruby
|
|
1198
|
+
</pre>
|
|
1199
|
+
<p>The following is the list of enhancers.
|
|
1200
|
+
</p>
|
|
1201
|
+
<dl class="dl1">
|
|
1202
|
+
<dt class="dt1">
|
|
1203
|
+
<a href="#escape-enhancer">EscapeEnhander</a> (language-independent)</dt>
|
|
1204
|
+
<dd class="dd1">
|
|
1205
|
+
Switch '<%= %>' to escaped and '<%== %>' to unescaped.
|
|
1206
|
+
</dd>
|
|
1207
|
+
<dt class="dt1">
|
|
1208
|
+
<a href="#stdout-enhancer">StdoutEnhancer</a> (only for Eruby)</dt>
|
|
1209
|
+
<dd class="dd1">
|
|
1210
|
+
Use $stdout instead of array buffer.
|
|
1211
|
+
</dd>
|
|
1212
|
+
<dt class="dt1">
|
|
1213
|
+
<a href="#printout-enhancer">PrintOutEnhancer</a> (only for Eruby)</dt>
|
|
1214
|
+
<dd class="dd1">
|
|
1215
|
+
Use "print(...)" statement insead of "_buf << ...".
|
|
1216
|
+
</dd>
|
|
1217
|
+
<dt class="dt1">
|
|
1218
|
+
<a href="#printenabled-enhancer">PrintEnabledEnhancer</a> (only for Eruby)</dt>
|
|
1219
|
+
<dd class="dd1">
|
|
1220
|
+
Enable to use print() in '<% ... %>'.
|
|
1221
|
+
</dd>
|
|
1222
|
+
<dt class="dt1">
|
|
1223
|
+
<a href="#array-enhancer">ArrayEnhancer</a> (only for Eruby)</dt>
|
|
1224
|
+
<dd class="dd1">
|
|
1225
|
+
Return array of string instead of returning string.
|
|
1226
|
+
</dd>
|
|
1227
|
+
<dt class="dt1">
|
|
1228
|
+
<a href="#arraybuffer-enhancer">ArrayBufferEnhancer</a> (only for Eruby)</dt>
|
|
1229
|
+
<dd class="dd1">
|
|
1230
|
+
Use array buffer. It is a little slower than StringBufferEnhancer.
|
|
1231
|
+
</dd>
|
|
1232
|
+
<dt class="dt1">
|
|
1233
|
+
<a href="#stringbuffer-enhancer">StringBufferEnhancer</a> (only for Eruby)</dt>
|
|
1234
|
+
<dd class="dd1">
|
|
1235
|
+
Use string buffer. This is included in Erubis::Eruby by default.
|
|
1236
|
+
</dd>
|
|
1237
|
+
<dt class="dt1">
|
|
1238
|
+
<a href="#erbout-enhancer">ErboutEnhancer</a> (only for Eruby)</dt>
|
|
1239
|
+
<dd class="dd1">
|
|
1240
|
+
Set '_erbout = _buf = "";' to be compatible with ERB.
|
|
1241
|
+
</dd>
|
|
1242
|
+
<dt class="dt1">
|
|
1243
|
+
<a href="#notext-enhancer">NoTextEnhancer</a> (language-independent)</dt>
|
|
1244
|
+
<dd class="dd1">
|
|
1245
|
+
Print embedded code only and ignore normal text.
|
|
1246
|
+
</dd>
|
|
1247
|
+
<dt class="dt1">
|
|
1248
|
+
<a href="#nocode-enhancer">NoCodeEnhancer</a> (language-independent)</dt>
|
|
1249
|
+
<dd class="dd1">
|
|
1250
|
+
Print normal text only and ignore code.
|
|
1251
|
+
</dd>
|
|
1252
|
+
<dt class="dt1">
|
|
1253
|
+
<a href="#simplify-enhancer">SimplifyEnhancer</a> (language-independent)</dt>
|
|
1254
|
+
<dd class="dd1">
|
|
1255
|
+
Make compile faster but don't trim spaces around '<% %>'.
|
|
1256
|
+
</dd>
|
|
1257
|
+
<dt class="dt1">
|
|
1258
|
+
<a href="#bipattern-enhancer">BiPatternEnhancer</a> (language-independent)</dt>
|
|
1259
|
+
<dd class="dd1">
|
|
1260
|
+
[experimental] Enable to use another embedded pattern with '<% %>'.
|
|
1261
|
+
</dd>
|
|
1262
|
+
<dt class="dt1">
|
|
1263
|
+
<a href="#percentline-enhancer">PercentLineEnhancer</a> (language-independent)</dt>
|
|
1264
|
+
<dd class="dd1">
|
|
1265
|
+
Regard lines starting with '%' as Ruby code. This is for compatibility with eruby and ERB.
|
|
1266
|
+
</dd>
|
|
1267
|
+
<dt class="dt1">
|
|
1268
|
+
<a href="#headerfooter-enhancer">HeaderFooterEnhancer</a> (language-independent)</dt>
|
|
1269
|
+
<dd class="dd1">
|
|
1270
|
+
[experimental] Enable you to add header and footer in eRuby script.
|
|
1271
|
+
</dd>
|
|
1272
|
+
<dt class="dt1">
|
|
1273
|
+
<a href="#interpolation-enhancer">InterpolationEnhancer</a> (only for Eruby)</dt>
|
|
1274
|
+
<dd class="dd1">
|
|
1275
|
+
[experimental] convert '<p><%= text %></p>' into '_buf << %Q`<p>#{text}</p>`'.
|
|
1276
|
+
</dd>
|
|
1277
|
+
<dt class="dt1">
|
|
1278
|
+
<a href="#deleteindent-enhancer">DeleteIndentEnhancer</a> (language-independent)</dt>
|
|
1279
|
+
<dd class="dd1">
|
|
1280
|
+
[experimental] delete indentation of HTML file and eliminate page size.
|
|
1281
|
+
</dd>
|
|
1282
|
+
</dl>
|
|
1283
|
+
<p>If you required 'erubis/engine/enhanced', Eruby subclasses which include each enhancers are defined.
|
|
1284
|
+
For example, class BiPatternEruby includes BiPatternEnhancer.
|
|
1285
|
+
</p>
|
|
1286
|
+
<a name="escape-enhancer"></a>
|
|
1287
|
+
<h3 class="section2">EscapeEnhancer</h3>
|
|
1288
|
+
<p>EscapeEnhancer switches '<%= ... %>' to escaped and '<%== ... %>' to unescaped.
|
|
1289
|
+
</p>
|
|
1290
|
+
<a name="example.eruby"></a>
|
|
1291
|
+
<div class="program_caption">
|
|
1292
|
+
example.eruby</div>
|
|
1293
|
+
<pre class="program"><div>
|
|
1294
|
+
<% for item in list %>
|
|
1295
|
+
<p><%= item %></p>
|
|
1296
|
+
<p><%== item %></p>
|
|
1297
|
+
<% end %>
|
|
1298
|
+
</div>
|
|
1299
|
+
</pre>
|
|
1300
|
+
<a name="escape_example.result"></a>
|
|
1301
|
+
<div class="terminal_caption">
|
|
1302
|
+
compiled source code</div>
|
|
1303
|
+
<pre class="terminal">$ erubis -xE Escape example.eruby
|
|
1304
|
+
_buf = ''; _buf << '<div>
|
|
1305
|
+
'; for item in list
|
|
1306
|
+
_buf << ' <p>'; <strong>_buf << Erubis::XmlHelper.escape_xml( item );</strong> _buf << '</p>
|
|
1307
|
+
<p>'; <strong>_buf << ( item ).to_s;</strong> _buf << '</p>
|
|
1308
|
+
'; end
|
|
1309
|
+
_buf << '</div>
|
|
1310
|
+
';
|
|
1311
|
+
_buf.to_s
|
|
1312
|
+
</pre>
|
|
1313
|
+
<p>EscapeEnhancer is language-independent.
|
|
1314
|
+
</p>
|
|
1315
|
+
<br>
|
|
1316
|
+
|
|
1317
|
+
|
|
1318
|
+
<a name="stdout-enhancer"></a>
|
|
1319
|
+
<h3 class="section2">StdoutEnhancer</h3>
|
|
1320
|
+
<p>StdoutEnhancer use $sdtdout instead of array buffer.
|
|
1321
|
+
Therefore, you can use 'print' statement in embedded ruby code.
|
|
1322
|
+
</p>
|
|
1323
|
+
<a name="stdout_exmple.result"></a>
|
|
1324
|
+
<div class="terminal_caption">
|
|
1325
|
+
compiled source code</div>
|
|
1326
|
+
<pre class="terminal">$ erubis -xE Stdout example.eruby
|
|
1327
|
+
<strong>_buf = $stdout;</strong> _buf << '<div>
|
|
1328
|
+
'; for item in list
|
|
1329
|
+
_buf << ' <p>'; _buf << ( item ).to_s; _buf << '</p>
|
|
1330
|
+
<p>'; _buf << Erubis::XmlHelper.escape_xml( item ); _buf << '</p>
|
|
1331
|
+
'; end
|
|
1332
|
+
_buf << '</div>
|
|
1333
|
+
';
|
|
1334
|
+
<strong>''</strong>
|
|
1335
|
+
</pre>
|
|
1336
|
+
<p>StdoutEnhancer is only for Eruby.
|
|
1337
|
+
</p>
|
|
1338
|
+
<br>
|
|
1339
|
+
|
|
1340
|
+
|
|
1341
|
+
<a name="printout-enhancer"></a>
|
|
1342
|
+
<h3 class="section2">PrintOutEnhancer</h3>
|
|
1343
|
+
<p>PrintOutEnhancer makes compiled source code to use 'print(...)' instead of '_buf << ...'.
|
|
1344
|
+
</p>
|
|
1345
|
+
<a name="printstatement_example.result"></a>
|
|
1346
|
+
<div class="terminal_caption">
|
|
1347
|
+
compiled source code</div>
|
|
1348
|
+
<pre class="terminal">$ erubis -xE PrintOut example.eruby
|
|
1349
|
+
<strong>print</strong> '<div>
|
|
1350
|
+
'; for item in list
|
|
1351
|
+
<strong>print</strong> ' <p>'; <strong>print</strong>(( item ).to_s); <strong>print</strong> '</p>
|
|
1352
|
+
<p>'; <strong>print</strong> Erubis::XmlHelper.escape_xml( item ); <strong>print</strong> '</p>
|
|
1353
|
+
'; end
|
|
1354
|
+
<strong>print</strong> '</div>
|
|
1355
|
+
';
|
|
1356
|
+
</pre>
|
|
1357
|
+
<p>PrintOutEnhancer is only for Eruby.
|
|
1358
|
+
</p>
|
|
1359
|
+
<br>
|
|
1360
|
+
|
|
1361
|
+
|
|
1362
|
+
<a name="printenabled-enhancer"></a>
|
|
1363
|
+
<h3 class="section2">PrintEnabledEnhancer</h3>
|
|
1364
|
+
<p>PrintEnabledEnhancer enables you to use print() method in '<% ... %>'.
|
|
1365
|
+
</p>
|
|
1366
|
+
<a name="printenabled-example.eruby"></a>
|
|
1367
|
+
<div class="program_caption">
|
|
1368
|
+
printenabled-example.eruby</div>
|
|
1369
|
+
<pre class="program"><% for item in @list %>
|
|
1370
|
+
<b><strong><% print item %></strong></b>
|
|
1371
|
+
<% end %>
|
|
1372
|
+
</pre>
|
|
1373
|
+
<a name="printenabled-example.rb"></a>
|
|
1374
|
+
<div class="program_caption">
|
|
1375
|
+
printenabled-example.rb</div>
|
|
1376
|
+
<pre class="program">require 'erubis'
|
|
1377
|
+
class PrintEnabledEruby < Erubis::Eruby
|
|
1378
|
+
include Erubis::PrintEnabledEnhancer
|
|
1379
|
+
end
|
|
1380
|
+
input = File.read('printenabled-example.eruby')
|
|
1381
|
+
eruby = PrintEnabledEruby.new(input)
|
|
1382
|
+
list = ['aaa', 'bbb', 'ccc']
|
|
1383
|
+
print eruby.evaluate(:list=>list)
|
|
1384
|
+
</pre>
|
|
1385
|
+
<a name="printenable_example.result"></a>
|
|
1386
|
+
<div class="terminal_caption">
|
|
1387
|
+
output result</div>
|
|
1388
|
+
<pre class="terminal">$ ruby printenabled-example.rb
|
|
1389
|
+
<b>aaa</b>
|
|
1390
|
+
<b>bbb</b>
|
|
1391
|
+
<b>ccc</b>
|
|
1392
|
+
</pre>
|
|
1393
|
+
<p>Notice to use Eruby#evaluate() and not to use Eruby#result(),
|
|
1394
|
+
because print() method in '<% ... %>' invokes not Kernel#print() but PrintEnabledEnhancer#print().
|
|
1395
|
+
</p>
|
|
1396
|
+
<p>PrintEnabledEnhancer is only for Eruby.
|
|
1397
|
+
</p>
|
|
1398
|
+
<br>
|
|
1399
|
+
|
|
1400
|
+
|
|
1401
|
+
<a name="array-enhancer"></a>
|
|
1402
|
+
<h3 class="section2">ArrayEnhancer</h3>
|
|
1403
|
+
<p>ArrayEnhancer makes Eruby to return an array of strings.
|
|
1404
|
+
</p>
|
|
1405
|
+
<a name="array_example.result"></a>
|
|
1406
|
+
<div class="terminal_caption">
|
|
1407
|
+
compiled source code</div>
|
|
1408
|
+
<pre class="terminal">$ erubis -xE Array example.eruby
|
|
1409
|
+
<strong>_buf = [];</strong> _buf << '<div>
|
|
1410
|
+
'; for item in list
|
|
1411
|
+
_buf << ' <p>'; _buf << ( item ).to_s; _buf << '</p>
|
|
1412
|
+
<p>'; _buf << Erubis::XmlHelper.escape_xml( item ); _buf << '</p>
|
|
1413
|
+
'; end
|
|
1414
|
+
_buf << '</div>
|
|
1415
|
+
';
|
|
1416
|
+
<strong>_buf</strong>
|
|
1417
|
+
</pre>
|
|
1418
|
+
<p>ArrayEnhancer is only for Eruby.
|
|
1419
|
+
</p>
|
|
1420
|
+
<br>
|
|
1421
|
+
|
|
1422
|
+
|
|
1423
|
+
<a name="arraybuffer-enhancer"></a>
|
|
1424
|
+
<h3 class="section2">ArrayBufferEnhancer</h3>
|
|
1425
|
+
<p>ArrayBufferEnhancer makes Eruby to use array buffer.
|
|
1426
|
+
Array buffer is a litte slower than String buffer.
|
|
1427
|
+
</p>
|
|
1428
|
+
<p>ArrayBufferEnhancer is only for Eruby.
|
|
1429
|
+
</p>
|
|
1430
|
+
<a name="arraybuffer_example.result"></a>
|
|
1431
|
+
<div class="terminal_caption">
|
|
1432
|
+
compiled source code</div>
|
|
1433
|
+
<pre class="terminal">$ erubis -xE ArrayBuffer example.eruby
|
|
1434
|
+
<strong>_buf = [];</strong> _buf << '<div>
|
|
1435
|
+
'; for item in list
|
|
1436
|
+
_buf << ' <p>'; _buf << ( item ).to_s; _buf << '</p>
|
|
1437
|
+
<p>'; _buf << Erubis::XmlHelper.escape_xml( item ); _buf << '</p>
|
|
1438
|
+
'; end
|
|
1439
|
+
_buf << '</div>
|
|
1440
|
+
';
|
|
1441
|
+
<strong>_buf.join</strong>
|
|
1442
|
+
</pre>
|
|
1443
|
+
<br>
|
|
1444
|
+
|
|
1445
|
+
|
|
1446
|
+
<a name="stringbuffer-enhancer"></a>
|
|
1447
|
+
<h3 class="section2">StringBufferEnhancer</h3>
|
|
1448
|
+
<p>StringBufferEnhancer makes Eruby to use string buffer.
|
|
1449
|
+
String buffer is a little faster than array buffer.
|
|
1450
|
+
Erubis::Eruby includes this enhancer by default.
|
|
1451
|
+
</p>
|
|
1452
|
+
<a name="stringbuffer_example.result"></a>
|
|
1453
|
+
<div class="terminal_caption">
|
|
1454
|
+
compiled source code</div>
|
|
1455
|
+
<pre class="terminal">$ erubis -xE StringBuffer example.eruby
|
|
1456
|
+
<strong>_buf = '';</strong> _buf << '<div>
|
|
1457
|
+
'; for item in list
|
|
1458
|
+
_buf << ' <p>'; _buf << ( item ).to_s; _buf << '</p>
|
|
1459
|
+
<p>'; _buf << Erubis::XmlHelper.escape_xml( item ); _buf << '</p>
|
|
1460
|
+
'; end
|
|
1461
|
+
_buf << '</div>
|
|
1462
|
+
';
|
|
1463
|
+
<strong>_buf.to_s</strong>
|
|
1464
|
+
</pre>
|
|
1465
|
+
<p>StringBufferEnhancer is only for Eruby.
|
|
1466
|
+
</p>
|
|
1467
|
+
<br>
|
|
1468
|
+
|
|
1469
|
+
|
|
1470
|
+
<a name="erbout-enhancer"></a>
|
|
1471
|
+
<h3 class="section2">ErboutEnhancer</h3>
|
|
1472
|
+
<p>ErboutEnhancer makes Eruby to be compatible with ERB.
|
|
1473
|
+
This is useful especially for Ruby on Rails.
|
|
1474
|
+
</p>
|
|
1475
|
+
<div class="terminal_caption">
|
|
1476
|
+
compiled source code</div>
|
|
1477
|
+
<pre class="terminal">$ erubis -xE Erbout example.eruby
|
|
1478
|
+
<strong>_erbout = _buf = '';</strong> _buf << '<div>
|
|
1479
|
+
'; for item in list
|
|
1480
|
+
_buf << ' <p>'; _buf << ( item ).to_s; _buf << '</p>
|
|
1481
|
+
<p>'; _buf << Erubis::XmlHelper.escape_xml( item ); _buf << '</p>
|
|
1482
|
+
'; end
|
|
1483
|
+
_buf << '</div>
|
|
1484
|
+
';
|
|
1485
|
+
_buf.to_s
|
|
1486
|
+
</pre>
|
|
1487
|
+
<p>ErboutEnhancer is only for Eruby.
|
|
1488
|
+
</p>
|
|
1489
|
+
<br>
|
|
1490
|
+
|
|
1491
|
+
|
|
1492
|
+
<a name="notext-enhancer"></a>
|
|
1493
|
+
<h3 class="section2">NoTextEnhancer</h3>
|
|
1494
|
+
<p>NoTextEnhancer suppress output of text and prints only embedded code.
|
|
1495
|
+
This is useful especially when debugging a complex eRuby script.
|
|
1496
|
+
</p>
|
|
1497
|
+
<a name="notext-example.eruby"></a>
|
|
1498
|
+
<div class="program_caption">
|
|
1499
|
+
notext-example.eruby</div>
|
|
1500
|
+
<pre class="program"><h3>List</h3>
|
|
1501
|
+
<% if !@list || @list.empty? %>
|
|
1502
|
+
<p>not found.</p>
|
|
1503
|
+
<% else %>
|
|
1504
|
+
<table>
|
|
1505
|
+
<tbody>
|
|
1506
|
+
<% @list.each_with_index do |item, i| %>
|
|
1507
|
+
<tr bgcolor="<%= i%2 == 0 ? '#FFCCCC' : '#CCCCFF' %>">
|
|
1508
|
+
<td><%= item %></td>
|
|
1509
|
+
</tr>
|
|
1510
|
+
<% end %>
|
|
1511
|
+
</tbody>
|
|
1512
|
+
</table>
|
|
1513
|
+
<% end %>
|
|
1514
|
+
</pre>
|
|
1515
|
+
<a name="notext_example.result"></a>
|
|
1516
|
+
<div class="terminal_caption">
|
|
1517
|
+
output example of NoTextEnhancer</div>
|
|
1518
|
+
<pre class="terminal">$ erubis -xE NoText notext-example.eruby
|
|
1519
|
+
_buf = '';
|
|
1520
|
+
if !@list || @list.empty?
|
|
1521
|
+
|
|
1522
|
+
else
|
|
1523
|
+
|
|
1524
|
+
|
|
1525
|
+
@list.each_with_index do |item, i|
|
|
1526
|
+
_buf << ( i%2 == 0 ? '#FFCCCC' : '#CCCCFF' ).to_s;
|
|
1527
|
+
_buf << ( item ).to_s;
|
|
1528
|
+
|
|
1529
|
+
end
|
|
1530
|
+
|
|
1531
|
+
|
|
1532
|
+
end
|
|
1533
|
+
_buf.to_s
|
|
1534
|
+
</pre>
|
|
1535
|
+
<p>NoTextEnhancer is language-independent. It is useful even if you are PHP user, see <a href="#topics-php">this section</a>.
|
|
1536
|
+
</p>
|
|
1537
|
+
<br>
|
|
1538
|
+
|
|
1539
|
+
|
|
1540
|
+
<a name="nocode-enhancer"></a>
|
|
1541
|
+
<h3 class="section2">NoCodeEnhancer</h3>
|
|
1542
|
+
<p>NoCodeEnhancer suppress output of embedded code and prints only normal text.
|
|
1543
|
+
This is useful especially when validating HTML tags.
|
|
1544
|
+
</p>
|
|
1545
|
+
<a name="nocode-example.eruby"></a>
|
|
1546
|
+
<div class="program_caption">
|
|
1547
|
+
nocode-example.eruby</div>
|
|
1548
|
+
<pre class="program"><h3>List</h3>
|
|
1549
|
+
<% if !@list || @list.empty? %>
|
|
1550
|
+
<p>not found.</p>
|
|
1551
|
+
<% else %>
|
|
1552
|
+
<table>
|
|
1553
|
+
<tbody>
|
|
1554
|
+
<% @list.each_with_index do |item, i| %>
|
|
1555
|
+
<tr bgcolor="<%= i%2 == 0 ? '#FFCCCC' : '#CCCCFF' %>">
|
|
1556
|
+
<td><%= item %></td>
|
|
1557
|
+
</tr>
|
|
1558
|
+
<% end %>
|
|
1559
|
+
</tbody>
|
|
1560
|
+
</table>
|
|
1561
|
+
<% end %>
|
|
1562
|
+
</pre>
|
|
1563
|
+
<a name="nocode_example.result"></a>
|
|
1564
|
+
<div class="terminal_caption">
|
|
1565
|
+
output example of NoCodeEnhancer</div>
|
|
1566
|
+
<pre class="terminal">$ erubis -xE NoCode notext-example.eruby
|
|
1567
|
+
<h3>List</h3>
|
|
1568
|
+
|
|
1569
|
+
<p>not found.</p>
|
|
1570
|
+
|
|
1571
|
+
<table>
|
|
1572
|
+
<tbody>
|
|
1573
|
+
|
|
1574
|
+
<tr bgcolor="">
|
|
1575
|
+
<td></td>
|
|
1576
|
+
</tr>
|
|
1577
|
+
|
|
1578
|
+
</tbody>
|
|
1579
|
+
</table>
|
|
1580
|
+
|
|
1581
|
+
</pre>
|
|
1582
|
+
<p>NoCodeEnhancer is language-independent. It is useful even if you are PHP user, see <a href="#topics-php">this section</a>.
|
|
1583
|
+
</p>
|
|
1584
|
+
<br>
|
|
1585
|
+
|
|
1586
|
+
|
|
1587
|
+
<a name="simplify-enhancer"></a>
|
|
1588
|
+
<h3 class="section2">SimplifyEnhancer</h3>
|
|
1589
|
+
<p>SimplifyEnhancer makes compiling a little faster but don't trim spaces around '<% %>'.
|
|
1590
|
+
</p>
|
|
1591
|
+
<a name="simplify_example.result"></a>
|
|
1592
|
+
<div class="terminal_caption">
|
|
1593
|
+
compiled source code</div>
|
|
1594
|
+
<pre class="terminal">$ erubis -xE Simplify example.eruby
|
|
1595
|
+
_buf = ''; _buf << '<div>
|
|
1596
|
+
'; for item in list ; _buf << '
|
|
1597
|
+
<p>'; _buf << ( item ).to_s; _buf << '</p>
|
|
1598
|
+
<p>'; _buf << Erubis::XmlHelper.escape_xml( item ); _buf << '</p>
|
|
1599
|
+
'; end ; _buf << '
|
|
1600
|
+
</div>
|
|
1601
|
+
';
|
|
1602
|
+
_buf.to_s
|
|
1603
|
+
</pre>
|
|
1604
|
+
<p>SimplifyEnhancer is language-independent.
|
|
1605
|
+
</p>
|
|
1606
|
+
<br>
|
|
1607
|
+
|
|
1608
|
+
|
|
1609
|
+
<a name="bipattern-enhancer"></a>
|
|
1610
|
+
<h3 class="section2">BiPatternEnhancer</h3>
|
|
1611
|
+
<p>BiPatternEnhancer enables to use another embedded pattern with '<% %>'.
|
|
1612
|
+
By Default, '[= ... =]' is available for expression.
|
|
1613
|
+
You can specify pattern by :bipattern property.
|
|
1614
|
+
</p>
|
|
1615
|
+
<a name="bipattern-example.rhtml"></a>
|
|
1616
|
+
<div class="program_caption">
|
|
1617
|
+
bipattern-example.rhtml</div>
|
|
1618
|
+
<pre class="program"><% for item in list %>
|
|
1619
|
+
<b><strong>[= item =]</strong></b>
|
|
1620
|
+
<b><strong>[== item =]</strong></b>
|
|
1621
|
+
<% end %>
|
|
1622
|
+
</pre>
|
|
1623
|
+
<a name="bipattern_example.result"></a>
|
|
1624
|
+
<div class="terminal_caption">
|
|
1625
|
+
compiled source code</div>
|
|
1626
|
+
<pre class="terminal">$ erubis -xE BiPattern bipattern-example.rhtml
|
|
1627
|
+
_buf = ''; for item in list
|
|
1628
|
+
_buf << ' <b>'; <strong>_buf << ( item ).to_s;</strong> _buf << '</b>
|
|
1629
|
+
<b>'; <strong>_buf << Erubis::XmlHelper.escape_xml( item );</strong> _buf << '</b>
|
|
1630
|
+
'; end
|
|
1631
|
+
_buf.to_s
|
|
1632
|
+
</pre>
|
|
1633
|
+
<p>BiPatternEnhancer is language-independent.
|
|
1634
|
+
</p>
|
|
1635
|
+
<br>
|
|
1636
|
+
|
|
1637
|
+
|
|
1638
|
+
<a name="percentline-enhancer"></a>
|
|
1639
|
+
<h3 class="section2">PercentLineEnhancer</h3>
|
|
1640
|
+
<p>PercentLineEnhancer regards lines starting with '%' as Ruby code.
|
|
1641
|
+
This is for compatibility with eruby and ERB.
|
|
1642
|
+
</p>
|
|
1643
|
+
<a name="percentline-example.rhtml"></a>
|
|
1644
|
+
<div class="program_caption">
|
|
1645
|
+
percentline-example.rhtml</div>
|
|
1646
|
+
<pre class="program"><ul>
|
|
1647
|
+
<strong>% for item in list</strong>
|
|
1648
|
+
<li><%= item %></li>
|
|
1649
|
+
<strong>% end</strong>
|
|
1650
|
+
</ul>
|
|
1651
|
+
<strong>%% lines with '%%'</strong>
|
|
1652
|
+
</pre>
|
|
1653
|
+
<a name="percentline_example.result"></a>
|
|
1654
|
+
<div class="terminal_caption">
|
|
1655
|
+
compiled source code</div>
|
|
1656
|
+
<pre class="terminal">$ erubis -xE PercentLine percentline-example.rhtml
|
|
1657
|
+
_buf = ''; _buf << '<ul>
|
|
1658
|
+
'; <strong>for item in list</strong>
|
|
1659
|
+
_buf << ' <li>'; _buf << ( item ).to_s; _buf << '</li>
|
|
1660
|
+
'; <strong>end</strong>
|
|
1661
|
+
_buf << '</ul>
|
|
1662
|
+
<strong>% lines with \'%%\'</strong>
|
|
1663
|
+
';
|
|
1664
|
+
_buf.to_s
|
|
1665
|
+
</pre>
|
|
1666
|
+
<p>PercentLineEnhancer is language-independent.
|
|
1667
|
+
</p>
|
|
1668
|
+
<br>
|
|
1669
|
+
|
|
1670
|
+
|
|
1671
|
+
<a name="prefixedline-enhancer"></a>
|
|
1672
|
+
<h3 class="section2">PrefixedLineEnhancer</h3>
|
|
1673
|
+
<p>PrefixedlineEnhancer regards lines starting with '%' as Ruby code.
|
|
1674
|
+
It is similar to <a href="#percentline-enhancer">PercentLineEnhancer</a>, but there are some differences.
|
|
1675
|
+
</p>
|
|
1676
|
+
<ul type="disc">
|
|
1677
|
+
<li>PrefixedlineEnhancer allows to indent lines starting with '%', but PercentLineEnhancer doesn't.
|
|
1678
|
+
</li>
|
|
1679
|
+
<li>PrefixedlineEnhancer allows to change prefixed character (default '%'), but PercentLineEnhancer doesn't.
|
|
1680
|
+
</li>
|
|
1681
|
+
</ul>
|
|
1682
|
+
<a name="prefixedline-example.rhtml"></a>
|
|
1683
|
+
<div class="program_caption">
|
|
1684
|
+
prefixedline-example.rhtml</div>
|
|
1685
|
+
<pre class="program"><ul>
|
|
1686
|
+
<strong>! for item in list</strong>
|
|
1687
|
+
<li><%= item %></li>
|
|
1688
|
+
<strong>! end</strong>
|
|
1689
|
+
</ul>
|
|
1690
|
+
<strong>!! lines with '!!'</strong>
|
|
1691
|
+
</pre>
|
|
1692
|
+
<a name="prefixedline-example.rb"></a>
|
|
1693
|
+
<div class="program_caption">
|
|
1694
|
+
prefixedline-example.rb</div>
|
|
1695
|
+
<pre class="program">require 'erubis'
|
|
1696
|
+
|
|
1697
|
+
class PrefixedLineEruby < Erubis::Eruby
|
|
1698
|
+
include Erubis::PrefixedLineEnhancer
|
|
1699
|
+
end
|
|
1700
|
+
|
|
1701
|
+
input = File.read('prefixedline-example.rhtml')
|
|
1702
|
+
eruby = PrefixedLineEruby.new(input, :prefixchar=>'!') # default '%'
|
|
1703
|
+
print eruby.src
|
|
1704
|
+
</pre>
|
|
1705
|
+
<a name="prefixedline_example.result"></a>
|
|
1706
|
+
<div class="terminal_caption">
|
|
1707
|
+
compiled source code</div>
|
|
1708
|
+
<pre class="terminal">$ ruby prefixedline-example.rb
|
|
1709
|
+
_buf = ''; _buf << '<ul>
|
|
1710
|
+
'; <strong>for item in list</strong>
|
|
1711
|
+
_buf << ' <li>'; _buf << ( item ).to_s; _buf << '</li>
|
|
1712
|
+
'; <strong>end</strong>
|
|
1713
|
+
_buf << '</ul>
|
|
1714
|
+
<strong>! lines with \'!!\'</strong>
|
|
1715
|
+
';
|
|
1716
|
+
_buf.to_s
|
|
1717
|
+
</pre>
|
|
1718
|
+
<p>PrefixedLineEnhancer is language-independent.
|
|
1719
|
+
</p>
|
|
1720
|
+
<br>
|
|
1721
|
+
|
|
1722
|
+
|
|
1723
|
+
<a name="headerfooter-enhancer"></a>
|
|
1724
|
+
<h3 class="section2">HeaderFooterEnhancer</h3>
|
|
1725
|
+
<p>[experimental]
|
|
1726
|
+
</p>
|
|
1727
|
+
<p>HeaderFooterEnhancer enables you to add header and footer in eRuby script.
|
|
1728
|
+
</p>
|
|
1729
|
+
<a name="headerfooter-example.eruby"></a>
|
|
1730
|
+
<div class="program_caption">
|
|
1731
|
+
headerfooter-example.eruby</div>
|
|
1732
|
+
<pre class="program"><strong><!--#header:</strong>
|
|
1733
|
+
<strong>def list_items(items)</strong>
|
|
1734
|
+
<strong>#--></strong>
|
|
1735
|
+
<% for item in items %>
|
|
1736
|
+
<b><%= item %></b>
|
|
1737
|
+
<% end %>
|
|
1738
|
+
<strong><!--#footer:</strong>
|
|
1739
|
+
<strong>end</strong>
|
|
1740
|
+
<strong>#--></strong>
|
|
1741
|
+
</pre>
|
|
1742
|
+
<a name="headerfooter_example.result"></a>
|
|
1743
|
+
<div class="terminal_caption">
|
|
1744
|
+
compiled source code</div>
|
|
1745
|
+
<pre class="terminal">$ erubis -xE HeaderFooter headerfooter-example.eruby
|
|
1746
|
+
|
|
1747
|
+
<strong>def list_items(items)</strong>
|
|
1748
|
+
|
|
1749
|
+
_buf = ''; for item in items
|
|
1750
|
+
_buf << ' <b>'; _buf << ( item ).to_s; _buf << '</b>
|
|
1751
|
+
'; end
|
|
1752
|
+
_buf.to_s
|
|
1753
|
+
|
|
1754
|
+
<strong>end</strong>
|
|
1755
|
+
|
|
1756
|
+
</pre>
|
|
1757
|
+
<p>Compare to the following:
|
|
1758
|
+
</p>
|
|
1759
|
+
<a name="normal-eruby-test.eruby"></a>
|
|
1760
|
+
<div class="program_caption">
|
|
1761
|
+
normal-eruby-test.eruby</div>
|
|
1762
|
+
<pre class="program"><strong><%</strong>
|
|
1763
|
+
<strong>def list_items(items)</strong>
|
|
1764
|
+
<strong>%></strong>
|
|
1765
|
+
<% for item in items %>
|
|
1766
|
+
<li><%= item %></li>
|
|
1767
|
+
<% end %>
|
|
1768
|
+
<strong><%</strong>
|
|
1769
|
+
<strong>end</strong>
|
|
1770
|
+
<strong>%></strong>
|
|
1771
|
+
</pre>
|
|
1772
|
+
<a name="normal_eruby_test.result"></a>
|
|
1773
|
+
<div class="terminal_caption">
|
|
1774
|
+
compiled source code</div>
|
|
1775
|
+
<pre class="terminal">$ erubis -x normal-eruby-test.eruby
|
|
1776
|
+
_buf = '';
|
|
1777
|
+
<strong>def list_items(items)</strong>
|
|
1778
|
+
|
|
1779
|
+
for item in items
|
|
1780
|
+
_buf << '<li>'; _buf << ( item ).to_s; _buf << '</li>
|
|
1781
|
+
'; end
|
|
1782
|
+
|
|
1783
|
+
<strong>end</strong>
|
|
1784
|
+
|
|
1785
|
+
_buf.to_s
|
|
1786
|
+
</pre>
|
|
1787
|
+
<p>Header and footer can be in any position in eRuby script,
|
|
1788
|
+
that is, header is no need to be in the head of eRuby script.
|
|
1789
|
+
</p>
|
|
1790
|
+
<a name="headerfooter-example2.rhtml"></a>
|
|
1791
|
+
<div class="program_caption">
|
|
1792
|
+
headerfooter-example2.rhtml</div>
|
|
1793
|
+
<pre class="program"><?xml version="1.0"?>
|
|
1794
|
+
<html>
|
|
1795
|
+
<strong><!--#header:</strong>
|
|
1796
|
+
<strong>def page(list)</strong>
|
|
1797
|
+
<strong>#--></strong>
|
|
1798
|
+
:
|
|
1799
|
+
<strong><!--#footer:</strong>
|
|
1800
|
+
<strong>end</strong>
|
|
1801
|
+
<strong>#--></strong>
|
|
1802
|
+
</html>
|
|
1803
|
+
</pre>
|
|
1804
|
+
<a name="headerfooter_example2.result"></a>
|
|
1805
|
+
<div class="terminal_caption">
|
|
1806
|
+
compiled source code</div>
|
|
1807
|
+
<pre class="terminal">$ erubis -xE HeaderFooter headerfooter-example2.rhtml
|
|
1808
|
+
|
|
1809
|
+
<strong>def page(list)</strong>
|
|
1810
|
+
|
|
1811
|
+
_buf = ''; _buf << '<?xml version="1.0"?>
|
|
1812
|
+
<html>
|
|
1813
|
+
'; _buf << ' :
|
|
1814
|
+
'; _buf << '</html>
|
|
1815
|
+
';
|
|
1816
|
+
_buf.to_s
|
|
1817
|
+
|
|
1818
|
+
<strong>end</strong>
|
|
1819
|
+
|
|
1820
|
+
</pre>
|
|
1821
|
+
<p>HeaderFooterEnhancer is experimental and is language-independent.
|
|
1822
|
+
</p>
|
|
1823
|
+
<br>
|
|
1824
|
+
|
|
1825
|
+
|
|
1826
|
+
<a name="interpolation-enhancer"></a>
|
|
1827
|
+
<h3 class="section2">InterpolationEnhancer</h3>
|
|
1828
|
+
<p>[experimental]
|
|
1829
|
+
</p>
|
|
1830
|
+
<p>InterpolationEnhancer converts "<h1><%= title %></h1>" into
|
|
1831
|
+
"_buf << %Q`<h1>#{ title }</h1>`".
|
|
1832
|
+
This makes Eruby a litter faster because method call of String#<< are eliminated
|
|
1833
|
+
by expression interpolations.
|
|
1834
|
+
</p>
|
|
1835
|
+
<div class="program_caption">
|
|
1836
|
+
InterpolationEnhancer elmininates method call of String#<<.</div>
|
|
1837
|
+
<pre class="program">## Assume that input is '<a href="<%=url%>"><%=name%></a>'.
|
|
1838
|
+
## Eruby convert input into the following code. String#<< is called 5 times.
|
|
1839
|
+
_buf << '<a href="'; _buf << (url).to_s; _buf << '">'; _buf << (name).to_s; _buf << '</a>';
|
|
1840
|
+
|
|
1841
|
+
## If InterpolationEnhancer is used, String#<< is called only once.
|
|
1842
|
+
_buf << %Q`<a href="#{url}">#{name}</a>`;
|
|
1843
|
+
</pre>
|
|
1844
|
+
<a name="interpolation_example.result"></a>
|
|
1845
|
+
<div class="terminal_caption">
|
|
1846
|
+
compiled source code</div>
|
|
1847
|
+
<pre class="terminal">$ erubis -xE Interpolation example.eruby
|
|
1848
|
+
_buf = ''; _buf << <strong>%Q`</strong><div>\n<strong>`</strong>
|
|
1849
|
+
for item in list
|
|
1850
|
+
_buf << <strong>%Q`</strong> <p><strong>#{ item }</strong></p>
|
|
1851
|
+
<p><strong>#{Erubis::XmlHelper.escape_xml( item )}</strong></p>\n<strong>`</strong>
|
|
1852
|
+
end
|
|
1853
|
+
_buf << <strong>%Q`</strong></div>\n<strong>`</strong>
|
|
1854
|
+
_buf.to_s
|
|
1855
|
+
</pre>
|
|
1856
|
+
<p>Erubis provides Erubis::FastEruby class which includes InterpolationEnhancer.
|
|
1857
|
+
You can use Erubis::FastEruby class instead of Erubis::Eruby class.
|
|
1858
|
+
</p>
|
|
1859
|
+
<p>InterpolationEnhancer is only for Eruby.
|
|
1860
|
+
</p>
|
|
1861
|
+
<br>
|
|
1862
|
+
|
|
1863
|
+
|
|
1864
|
+
<a name="deleteindent-enhancer"></a>
|
|
1865
|
+
<h3 class="section2">DeleteIndentEnhancer</h3>
|
|
1866
|
+
<p>[experimental]
|
|
1867
|
+
DeleteIndentEnhancer deletes indentation of HTML file.
|
|
1868
|
+
</p>
|
|
1869
|
+
<a name="interpolation_example.result"></a>
|
|
1870
|
+
<div class="terminal_caption">
|
|
1871
|
+
compiled source code</div>
|
|
1872
|
+
<pre class="terminal">$ erubis -xE DeleteIndent example.eruby
|
|
1873
|
+
_buf = ''; _buf << '<div>
|
|
1874
|
+
'; for item in list
|
|
1875
|
+
_buf << '<p>'; _buf << ( item ).to_s; _buf << '</p>
|
|
1876
|
+
<p>'; _buf << Erubis::XmlHelper.escape_xml( item ); _buf << '</p>
|
|
1877
|
+
'; end
|
|
1878
|
+
_buf << '</div>
|
|
1879
|
+
';
|
|
1880
|
+
_buf.to_s
|
|
1881
|
+
</pre>
|
|
1882
|
+
<p>Notice that DeleteIndentEnhancer isn't intelligent.
|
|
1883
|
+
It deletes indentations even if they are in <PRE></PRE>.
|
|
1884
|
+
</p>
|
|
1885
|
+
<p>DeleteIndentEnhancer is language-independent.
|
|
1886
|
+
</p>
|
|
1887
|
+
<br>
|
|
1888
|
+
|
|
1889
|
+
|
|
1890
|
+
<br>
|
|
1891
|
+
|
|
1892
|
+
|
|
1893
|
+
<a name="lang"></a>
|
|
1894
|
+
<h2 class="section1">Multi-Language Support</h2>
|
|
1895
|
+
<p>Erubis supports the following languages<sup>(<a href="#fnref:2" name="fnlink:2">*2</a>)</sup>:
|
|
1896
|
+
</p>
|
|
1897
|
+
<ul type="disc">
|
|
1898
|
+
<li>Ruby
|
|
1899
|
+
</li>
|
|
1900
|
+
<li><a href="#lang-php">PHP</a>
|
|
1901
|
+
</li>
|
|
1902
|
+
<li><a href="#lang-c">C</a>
|
|
1903
|
+
</li>
|
|
1904
|
+
<li><a href="#lang-java">Java</a>
|
|
1905
|
+
</li>
|
|
1906
|
+
<li><a href="#lang-scheme">Scheme</a>
|
|
1907
|
+
</li>
|
|
1908
|
+
<li><a href="#lang-perl">Perl</a>
|
|
1909
|
+
</li>
|
|
1910
|
+
<li><a href="#lang-javascript">JavaScript</a>
|
|
1911
|
+
</li>
|
|
1912
|
+
</ul>
|
|
1913
|
+
<div class="footnote">
|
|
1914
|
+
<dl compact>
|
|
1915
|
+
<dt>(<a name="fnref:2" href="#fnlink:2">*2</a>)</dt>
|
|
1916
|
+
<dd>If you need template engine in pure PHP/Perl/JavaScript, try <a href="http://www.kuwata-lab.com/tenjin/">Tenjin</a> (<a href="http://www.kuwata-lab.com/tenjin/">http://www.kuwata-lab.com/tenjin/</a>). Tenjin is a very fast and full-featured template engine implemented in pure PHP/Perl/JavaScript.</dd>
|
|
1917
|
+
</dl>
|
|
1918
|
+
</div>
|
|
1919
|
+
<a name="lang-php"></a>
|
|
1920
|
+
<h3 class="section2">PHP</h3>
|
|
1921
|
+
<a name="example.ephp"></a>
|
|
1922
|
+
<div class="program_caption">
|
|
1923
|
+
example.ephp</div>
|
|
1924
|
+
<pre class="program"><?xml version="1.0"?>
|
|
1925
|
+
<html>
|
|
1926
|
+
<body>
|
|
1927
|
+
<p>Hello <strong><%= $user %></strong>!</p>
|
|
1928
|
+
<table>
|
|
1929
|
+
<tbody>
|
|
1930
|
+
<strong><% $i = 0; %></strong>
|
|
1931
|
+
<strong><% foreach ($list as $item) { %></strong>
|
|
1932
|
+
<strong><% $i++; %></strong>
|
|
1933
|
+
<tr bgcolor=<strong>"<%= $i % 2 == 0 ? '#FFCCCC' : '#CCCCFF' %>"</strong>>
|
|
1934
|
+
<td><strong><%= $i %></strong></td>
|
|
1935
|
+
<td><strong><%== $item %></strong></td>
|
|
1936
|
+
</tr>
|
|
1937
|
+
<strong><% } %></strong>
|
|
1938
|
+
</tbody>
|
|
1939
|
+
</table>
|
|
1940
|
+
</body>
|
|
1941
|
+
</html>
|
|
1942
|
+
</pre>
|
|
1943
|
+
<a name="example_php.result"></a>
|
|
1944
|
+
<div class="terminal_caption">
|
|
1945
|
+
compiled source code</div>
|
|
1946
|
+
<pre class="terminal">$ erubis -l php example.ephp
|
|
1947
|
+
<<?php ?>?xml version="1.0"?>
|
|
1948
|
+
<html>
|
|
1949
|
+
<body>
|
|
1950
|
+
<p>Hello <?php echo $user; ?>!</p>
|
|
1951
|
+
<table>
|
|
1952
|
+
<tbody>
|
|
1953
|
+
<?php $i = 0; ?>
|
|
1954
|
+
<?php foreach ($list as $item) { ?>
|
|
1955
|
+
<?php $i++; ?>
|
|
1956
|
+
<tr bgcolor="<?php echo $i % 2 == 0 ? '#FFCCCC' : '#CCCCFF'; ?>">
|
|
1957
|
+
<td><?php echo $i; ?></td>
|
|
1958
|
+
<td><?php echo htmlspecialchars($item); ?></td>
|
|
1959
|
+
</tr>
|
|
1960
|
+
<?php } ?>
|
|
1961
|
+
</tbody>
|
|
1962
|
+
</table>
|
|
1963
|
+
</body>
|
|
1964
|
+
</html>
|
|
1965
|
+
</pre>
|
|
1966
|
+
<br>
|
|
1967
|
+
|
|
1968
|
+
|
|
1969
|
+
<a name="lang-c"></a>
|
|
1970
|
+
<h3 class="section2">C</h3>
|
|
1971
|
+
<a name="example.ec"></a>
|
|
1972
|
+
<div class="program_caption">
|
|
1973
|
+
example.ec</div>
|
|
1974
|
+
<pre class="program"><strong><%
|
|
1975
|
+
#include <stdio.h>
|
|
1976
|
+
|
|
1977
|
+
int main(int argc, char *argv[])
|
|
1978
|
+
{
|
|
1979
|
+
int i;
|
|
1980
|
+
|
|
1981
|
+
%></strong>
|
|
1982
|
+
<html>
|
|
1983
|
+
<body>
|
|
1984
|
+
<p>Hello <strong><%= "%s", argv[0] %></strong>!</p>
|
|
1985
|
+
<table>
|
|
1986
|
+
<tbody>
|
|
1987
|
+
<strong><% for (i = 1; i < argc; i++) { %></strong>
|
|
1988
|
+
<tr bgcolor="<strong><%= i % 2 == 0 ? "#FFCCCC" : "#CCCCFF" %></strong>">
|
|
1989
|
+
<td><strong><%= "%d", i %></strong></td>
|
|
1990
|
+
<td><strong><%= "%s", argv[i] %></strong></td>
|
|
1991
|
+
</tr>
|
|
1992
|
+
<strong><% } %></strong>
|
|
1993
|
+
</tbody>
|
|
1994
|
+
</table>
|
|
1995
|
+
</body>
|
|
1996
|
+
</html>
|
|
1997
|
+
<strong><%
|
|
1998
|
+
return 0;
|
|
1999
|
+
}
|
|
2000
|
+
%></strong>
|
|
2001
|
+
</pre>
|
|
2002
|
+
<a name="example_c.result"></a>
|
|
2003
|
+
<div class="terminal_caption">
|
|
2004
|
+
compiled source code</div>
|
|
2005
|
+
<pre class="terminal">$ erubis -l c example.ec
|
|
2006
|
+
#line 1 "example.ec"
|
|
2007
|
+
|
|
2008
|
+
#include <stdio.h>
|
|
2009
|
+
|
|
2010
|
+
int main(int argc, char *argv[])
|
|
2011
|
+
{
|
|
2012
|
+
int i;
|
|
2013
|
+
|
|
2014
|
+
|
|
2015
|
+
fputs("<html>\n"
|
|
2016
|
+
" <body>\n"
|
|
2017
|
+
" <p>Hello ", stdout); fprintf(stdout, "%s", argv[0]); fputs("!</p>\n"
|
|
2018
|
+
" <table>\n"
|
|
2019
|
+
" <tbody>\n", stdout);
|
|
2020
|
+
for (i = 1; i < argc; i++) {
|
|
2021
|
+
fputs(" <tr bgcolor=\"", stdout); fprintf(stdout, i % 2 == 0 ? "#FFCCCC" : "#CCCCFF"); fputs("\">\n"
|
|
2022
|
+
" <td>", stdout); fprintf(stdout, "%d", i); fputs("</td>\n"
|
|
2023
|
+
" <td>", stdout); fprintf(stdout, "%s", argv[i]); fputs("</td>\n"
|
|
2024
|
+
" </tr>\n", stdout);
|
|
2025
|
+
}
|
|
2026
|
+
fputs(" </tbody>\n"
|
|
2027
|
+
" </table>\n"
|
|
2028
|
+
" </body>\n"
|
|
2029
|
+
"</html>\n", stdout);
|
|
2030
|
+
|
|
2031
|
+
return 0;
|
|
2032
|
+
}
|
|
2033
|
+
|
|
2034
|
+
</pre>
|
|
2035
|
+
<br>
|
|
2036
|
+
|
|
2037
|
+
|
|
2038
|
+
<a name="lang-cpp"></a>
|
|
2039
|
+
<h3 class="section2">C++</h3>
|
|
2040
|
+
<a name="example.ecpp"></a>
|
|
2041
|
+
<div class="program_caption">
|
|
2042
|
+
example.ecpp</div>
|
|
2043
|
+
<pre class="program"><strong><%
|
|
2044
|
+
#include <string>
|
|
2045
|
+
#include <iostream>
|
|
2046
|
+
#include <sstream>
|
|
2047
|
+
|
|
2048
|
+
int main(int argc, char *argv[])
|
|
2049
|
+
{
|
|
2050
|
+
std::stringstream _buf;
|
|
2051
|
+
%></strong>
|
|
2052
|
+
<html>
|
|
2053
|
+
<body>
|
|
2054
|
+
<p>Hello <strong><%= argv[0] %></strong>!</p>
|
|
2055
|
+
<table>
|
|
2056
|
+
<tbody>
|
|
2057
|
+
<strong><% for (int i = 1; i < argc; i++) { %></strong>
|
|
2058
|
+
<tr bgcolor="<strong><%= i % 2 == 0 ? "#FFCCCC" : "#CCCCFF" %></strong>">
|
|
2059
|
+
<td><strong><%= i %></strong></td>
|
|
2060
|
+
<td><strong><%= argv[i] %></strong></td>
|
|
2061
|
+
</tr>
|
|
2062
|
+
<strong><% } %></strong>
|
|
2063
|
+
</tbody>
|
|
2064
|
+
</table>
|
|
2065
|
+
</body>
|
|
2066
|
+
</html>
|
|
2067
|
+
<strong><%
|
|
2068
|
+
std::string output = _buf.str();
|
|
2069
|
+
std::cout << output;
|
|
2070
|
+
return 0;
|
|
2071
|
+
}
|
|
2072
|
+
%></strong>
|
|
2073
|
+
</pre>
|
|
2074
|
+
<a name="example_c.result"></a>
|
|
2075
|
+
<div class="terminal_caption">
|
|
2076
|
+
compiled source code</div>
|
|
2077
|
+
<pre class="terminal">$ erubis -l cpp example.ecpp
|
|
2078
|
+
#line 1 "example.ecpp"
|
|
2079
|
+
|
|
2080
|
+
#include <string>
|
|
2081
|
+
#include <iostream>
|
|
2082
|
+
#include <sstream>
|
|
2083
|
+
|
|
2084
|
+
int main(int argc, char *argv[])
|
|
2085
|
+
{
|
|
2086
|
+
std::stringstream _buf;
|
|
2087
|
+
|
|
2088
|
+
_buf << "<html>\n"
|
|
2089
|
+
" <body>\n"
|
|
2090
|
+
" <p>Hello "; _buf << (argv[0]); _buf << "!</p>\n"
|
|
2091
|
+
" <table>\n"
|
|
2092
|
+
" <tbody>\n";
|
|
2093
|
+
for (int i = 1; i < argc; i++) {
|
|
2094
|
+
_buf << " <tr bgcolor=\""; _buf << (i % 2 == 0 ? "#FFCCCC" : "#CCCCFF"); _buf << "\">\n"
|
|
2095
|
+
" <td>"; _buf << (i); _buf << "</td>\n"
|
|
2096
|
+
" <td>"; _buf << (argv[i]); _buf << "</td>\n"
|
|
2097
|
+
" </tr>\n";
|
|
2098
|
+
}
|
|
2099
|
+
_buf << " </tbody>\n"
|
|
2100
|
+
" </table>\n"
|
|
2101
|
+
" </body>\n"
|
|
2102
|
+
"</html>\n";
|
|
2103
|
+
|
|
2104
|
+
std::string output = _buf.str();
|
|
2105
|
+
std::cout << output;
|
|
2106
|
+
return 0;
|
|
2107
|
+
}
|
|
2108
|
+
|
|
2109
|
+
</pre>
|
|
2110
|
+
<br>
|
|
2111
|
+
|
|
2112
|
+
|
|
2113
|
+
<a name="lang-java"></a>
|
|
2114
|
+
<h3 class="section2">Java</h3>
|
|
2115
|
+
<a name="Example.ejava"></a>
|
|
2116
|
+
<div class="program_caption">
|
|
2117
|
+
Example.ejava</div>
|
|
2118
|
+
<pre class="program"><strong><%
|
|
2119
|
+
import java.util.*;
|
|
2120
|
+
|
|
2121
|
+
public class Example {
|
|
2122
|
+
private String user;
|
|
2123
|
+
private String[] list;
|
|
2124
|
+
public example(String user, String[] list) {
|
|
2125
|
+
this.user = user;
|
|
2126
|
+
this.list = list;
|
|
2127
|
+
}
|
|
2128
|
+
|
|
2129
|
+
public String view() {
|
|
2130
|
+
StringBuffer _buf = new StringBuffer();
|
|
2131
|
+
%></strong>
|
|
2132
|
+
<html>
|
|
2133
|
+
<body>
|
|
2134
|
+
<p>Hello <strong><%= user %></strong>!</p>
|
|
2135
|
+
<table>
|
|
2136
|
+
<tbody>
|
|
2137
|
+
<strong><% for (int i = 0; i < list.length; i++) { %></strong>
|
|
2138
|
+
<tr bgcolor=<strong>"<%= i % 2 == 0 ? "#FFCCCC" : "#CCCCFF" %>"</strong>>
|
|
2139
|
+
<td><strong><%= i + 1 %></strong></td>
|
|
2140
|
+
<td><strong><%== list[i] %></strong></td>
|
|
2141
|
+
</tr>
|
|
2142
|
+
<strong><% } %></strong>
|
|
2143
|
+
</tbody>
|
|
2144
|
+
</table>
|
|
2145
|
+
<body>
|
|
2146
|
+
</html>
|
|
2147
|
+
<strong><%
|
|
2148
|
+
return _buf.toString();
|
|
2149
|
+
}
|
|
2150
|
+
|
|
2151
|
+
public static void main(String[] args) {
|
|
2152
|
+
String[] list = { "<aaa>", "b&b", "\"ccc\"" };
|
|
2153
|
+
Example ex = Example.new("Erubis", list);
|
|
2154
|
+
System.out.print(ex.view());
|
|
2155
|
+
}
|
|
2156
|
+
|
|
2157
|
+
public static String escape(String s) {
|
|
2158
|
+
StringBuffer sb = new StringBuffer();
|
|
2159
|
+
for (int i = 0; i < s.length(); i++) {
|
|
2160
|
+
char ch = s.charAt(i);
|
|
2161
|
+
switch (ch) {
|
|
2162
|
+
case '<': sb.append("&lt;"); break;
|
|
2163
|
+
case '>': sb.append("&gt;"); break;
|
|
2164
|
+
case '&': sb.append("&amp;"); break;
|
|
2165
|
+
case '"': sb.append("&quot;"); break;
|
|
2166
|
+
default: sb.append(ch);
|
|
2167
|
+
}
|
|
2168
|
+
}
|
|
2169
|
+
return sb.toString();
|
|
2170
|
+
}
|
|
2171
|
+
}
|
|
2172
|
+
%></strong>
|
|
2173
|
+
</pre>
|
|
2174
|
+
<a name="example_java.result"></a>
|
|
2175
|
+
<div class="terminal_caption">
|
|
2176
|
+
compiled source code</div>
|
|
2177
|
+
<pre class="terminal">$ erubis -b -l java example.ejava
|
|
2178
|
+
|
|
2179
|
+
import java.util.*;
|
|
2180
|
+
|
|
2181
|
+
public class Example {
|
|
2182
|
+
private String user;
|
|
2183
|
+
private String[] list;
|
|
2184
|
+
public example(String user, String[] list) {
|
|
2185
|
+
this.user = user;
|
|
2186
|
+
this.list = list;
|
|
2187
|
+
}
|
|
2188
|
+
|
|
2189
|
+
public String view() {
|
|
2190
|
+
StringBuffer _buf = new StringBuffer();
|
|
2191
|
+
|
|
2192
|
+
_buf.append("<html>\n"
|
|
2193
|
+
+ " <body>\n"
|
|
2194
|
+
+ " <p>Hello "); _buf.append(user); _buf.append("!</p>\n"
|
|
2195
|
+
+ " <table>\n"
|
|
2196
|
+
+ " <tbody>\n");
|
|
2197
|
+
for (int i = 0; i < list.length; i++) {
|
|
2198
|
+
_buf.append(" <tr bgcolor=\""); _buf.append(i % 2 == 0 ? "#FFCCCC" : "#CCCCFF"); _buf.append("\">\n"
|
|
2199
|
+
+ " <td>"); _buf.append(i + 1); _buf.append("</td>\n"
|
|
2200
|
+
+ " <td>"); _buf.append(escape(list[i])); _buf.append("</td>\n"
|
|
2201
|
+
+ " </tr>\n");
|
|
2202
|
+
}
|
|
2203
|
+
_buf.append(" </tbody>\n"
|
|
2204
|
+
+ " </table>\n"
|
|
2205
|
+
+ " <body>\n"
|
|
2206
|
+
+ "</html>\n");
|
|
2207
|
+
|
|
2208
|
+
return _buf.toString();
|
|
2209
|
+
}
|
|
2210
|
+
|
|
2211
|
+
public static void main(String[] args) {
|
|
2212
|
+
String[] list = { "<aaa>", "b&b", "\"ccc\"" };
|
|
2213
|
+
Example ex = Example.new("Erubis", list);
|
|
2214
|
+
System.out.print(ex.view());
|
|
2215
|
+
}
|
|
2216
|
+
|
|
2217
|
+
public static String escape(String s) {
|
|
2218
|
+
StringBuffer sb = new StringBuffer();
|
|
2219
|
+
for (int i = 0; i < s.length(); i++) {
|
|
2220
|
+
char ch = s.charAt(i);
|
|
2221
|
+
switch (ch) {
|
|
2222
|
+
case '<': sb.append("&lt;"); break;
|
|
2223
|
+
case '>': sb.append("&gt;"); break;
|
|
2224
|
+
case '&': sb.append("&amp;"); break;
|
|
2225
|
+
case '"': sb.append("&quot;"); break;
|
|
2226
|
+
default: sb.append(ch);
|
|
2227
|
+
}
|
|
2228
|
+
}
|
|
2229
|
+
return sb.toString();
|
|
2230
|
+
}
|
|
2231
|
+
}
|
|
2232
|
+
|
|
2233
|
+
</pre>
|
|
2234
|
+
<br>
|
|
2235
|
+
|
|
2236
|
+
|
|
2237
|
+
<a name="lang-scheme"></a>
|
|
2238
|
+
<h3 class="section2">Scheme</h3>
|
|
2239
|
+
<a name="example.escheme"></a>
|
|
2240
|
+
<div class="program_caption">
|
|
2241
|
+
example.escheme</div>
|
|
2242
|
+
<pre class="program"><html>
|
|
2243
|
+
<body>
|
|
2244
|
+
<strong><%
|
|
2245
|
+
(let ((user "Erubis")
|
|
2246
|
+
(items '("<aaa>" "b&b" "\"ccc\""))
|
|
2247
|
+
(i 0))
|
|
2248
|
+
%></strong>
|
|
2249
|
+
<p>Hello <strong><%= user %></strong>!</p>
|
|
2250
|
+
<table>
|
|
2251
|
+
<strong><%
|
|
2252
|
+
(for-each
|
|
2253
|
+
(lambda (item)
|
|
2254
|
+
(set! i (+ i 1))
|
|
2255
|
+
%></strong>
|
|
2256
|
+
<tr bgcolor="<strong><%= (if (= (modulo i 2) 0) "#FFCCCC" "#CCCCFF") %></strong>">
|
|
2257
|
+
<td><strong><%= i %></strong></td>
|
|
2258
|
+
<td><strong><%= item %></strong></td>
|
|
2259
|
+
</tr>
|
|
2260
|
+
<strong><%
|
|
2261
|
+
) ; lambda end
|
|
2262
|
+
items) ; for-each end
|
|
2263
|
+
%></strong>
|
|
2264
|
+
</table>
|
|
2265
|
+
<strong><%
|
|
2266
|
+
) ; let end
|
|
2267
|
+
%></strong>
|
|
2268
|
+
</body>
|
|
2269
|
+
</html>
|
|
2270
|
+
</pre>
|
|
2271
|
+
<a name="example_scheme.result"></a>
|
|
2272
|
+
<div class="terminal_caption">
|
|
2273
|
+
compiled source code</div>
|
|
2274
|
+
<pre class="terminal">$ erubis -l scheme example.escheme
|
|
2275
|
+
(let ((_buf '())) (define (_add x) (set! _buf (cons x _buf))) (_add "<html>
|
|
2276
|
+
<body>\n")
|
|
2277
|
+
|
|
2278
|
+
(let ((user "Erubis")
|
|
2279
|
+
(items '("<aaa>" "b&b" "\"ccc\""))
|
|
2280
|
+
(i 0))
|
|
2281
|
+
|
|
2282
|
+
(_add " <p>Hello ")(_add user)(_add "!</p>
|
|
2283
|
+
<table>\n")
|
|
2284
|
+
|
|
2285
|
+
(for-each
|
|
2286
|
+
(lambda (item)
|
|
2287
|
+
(set! i (+ i 1))
|
|
2288
|
+
|
|
2289
|
+
(_add " <tr bgcolor=\"")(_add (if (= (modulo i 2) 0) "#FFCCCC" "#CCCCFF"))(_add "\">
|
|
2290
|
+
<td>")(_add i)(_add "</td>
|
|
2291
|
+
<td>")(_add item)(_add "</td>
|
|
2292
|
+
</tr>\n")
|
|
2293
|
+
|
|
2294
|
+
) ; lambda end
|
|
2295
|
+
items) ; for-each end
|
|
2296
|
+
|
|
2297
|
+
(_add " </table>\n")
|
|
2298
|
+
|
|
2299
|
+
) ; let end
|
|
2300
|
+
|
|
2301
|
+
(_add " </body>
|
|
2302
|
+
</html>\n")
|
|
2303
|
+
(reverse _buf))
|
|
2304
|
+
</pre>
|
|
2305
|
+
<a name="example_scheme_display.result"></a>
|
|
2306
|
+
<div class="terminal_caption">
|
|
2307
|
+
compiled source code (with <code>--func=display</code> property)</div>
|
|
2308
|
+
<pre class="terminal">$ erubis -l scheme --func=display example.escheme
|
|
2309
|
+
(display "<html>
|
|
2310
|
+
<body>\n")
|
|
2311
|
+
|
|
2312
|
+
(let ((user "Erubis")
|
|
2313
|
+
(items '("<aaa>" "b&b" "\"ccc\""))
|
|
2314
|
+
(i 0))
|
|
2315
|
+
|
|
2316
|
+
(display " <p>Hello ")(display user)(display "!</p>
|
|
2317
|
+
<table>\n")
|
|
2318
|
+
|
|
2319
|
+
(for-each
|
|
2320
|
+
(lambda (item)
|
|
2321
|
+
(set! i (+ i 1))
|
|
2322
|
+
|
|
2323
|
+
(display " <tr bgcolor=\"")(display (if (= (modulo i 2) 0) "#FFCCCC" "#CCCCFF"))(display "\">
|
|
2324
|
+
<td>")(display i)(display "</td>
|
|
2325
|
+
<td>")(display item)(display "</td>
|
|
2326
|
+
</tr>\n")
|
|
2327
|
+
|
|
2328
|
+
) ; lambda end
|
|
2329
|
+
items) ; for-each end
|
|
2330
|
+
|
|
2331
|
+
(display " </table>\n")
|
|
2332
|
+
|
|
2333
|
+
) ; let end
|
|
2334
|
+
|
|
2335
|
+
(display " </body>
|
|
2336
|
+
</html>\n")
|
|
2337
|
+
</pre>
|
|
2338
|
+
<br>
|
|
2339
|
+
|
|
2340
|
+
|
|
2341
|
+
<a name="lang-perl"></a>
|
|
2342
|
+
<h3 class="section2">Perl</h3>
|
|
2343
|
+
<a name="example.eperl"></a>
|
|
2344
|
+
<div class="program_caption">
|
|
2345
|
+
example.eperl</div>
|
|
2346
|
+
<pre class="program"><strong><%
|
|
2347
|
+
my $user = 'Erubis';
|
|
2348
|
+
my @list = ('<aaa>', 'b&b', '"ccc"');
|
|
2349
|
+
%></strong>
|
|
2350
|
+
<html>
|
|
2351
|
+
<body>
|
|
2352
|
+
<p>Hello <strong><%= $user %></strong>!</p>
|
|
2353
|
+
<table>
|
|
2354
|
+
<strong><% $i = 0; %></strong>
|
|
2355
|
+
<strong><% for $item (@list) { %></strong>
|
|
2356
|
+
<tr bgcolor=<strong><%= ++$i % 2 == 0 ? '#FFCCCC' : '#CCCCFF' %></strong>">
|
|
2357
|
+
<td><strong><%= $i %></strong></td>
|
|
2358
|
+
<td><strong><%= $item %></strong></td>
|
|
2359
|
+
</tr>
|
|
2360
|
+
<strong><% } %></strong>
|
|
2361
|
+
</table>
|
|
2362
|
+
</body>
|
|
2363
|
+
</html>
|
|
2364
|
+
</pre>
|
|
2365
|
+
<a name="example_perl.result"></a>
|
|
2366
|
+
<div class="terminal_caption">
|
|
2367
|
+
compiled source code</div>
|
|
2368
|
+
<pre class="terminal">$ erubis -l perl example.eperl
|
|
2369
|
+
use HTML::Entities;
|
|
2370
|
+
my $user = 'Erubis';
|
|
2371
|
+
my @list = ('<aaa>', 'b&b', '"ccc"');
|
|
2372
|
+
|
|
2373
|
+
print('<html>
|
|
2374
|
+
<body>
|
|
2375
|
+
<p>Hello '); print($user); print('!</p>
|
|
2376
|
+
<table>
|
|
2377
|
+
'); $i = 0;
|
|
2378
|
+
for $item (@list) {
|
|
2379
|
+
print(' <tr bgcolor='); print(++$i % 2 == 0 ? '#FFCCCC' : '#CCCCFF'); print('">
|
|
2380
|
+
<td>'); print($i); print('</td>
|
|
2381
|
+
<td>'); print($item); print('</td>
|
|
2382
|
+
</tr>
|
|
2383
|
+
'); }
|
|
2384
|
+
print(' </table>
|
|
2385
|
+
</body>
|
|
2386
|
+
</html>
|
|
2387
|
+
');
|
|
2388
|
+
</pre>
|
|
2389
|
+
<br>
|
|
2390
|
+
|
|
2391
|
+
|
|
2392
|
+
<a name="lang-javascript"></a>
|
|
2393
|
+
<h3 class="section2">JavaScript</h3>
|
|
2394
|
+
<a name="example.ejs"></a>
|
|
2395
|
+
<div class="program_caption">
|
|
2396
|
+
example.ejs</div>
|
|
2397
|
+
<pre class="program"><strong><%
|
|
2398
|
+
var user = 'Erubis';
|
|
2399
|
+
var list = ['<aaa>', 'b&b', '"ccc"'];
|
|
2400
|
+
%></strong>
|
|
2401
|
+
<html>
|
|
2402
|
+
<body>
|
|
2403
|
+
<p>Hello <strong><%= user %></strong>!</p>
|
|
2404
|
+
<table>
|
|
2405
|
+
<tbody>
|
|
2406
|
+
<strong><% var i; %></strong>
|
|
2407
|
+
<strong><% for (i = 0; i < list.length; i++) { %></strong>
|
|
2408
|
+
<tr bgcolor="<strong><%= i % 2 == 0 ? '#FFCCCC' : '#CCCCFF' %></strong>">
|
|
2409
|
+
<td><strong><%= i + 1 %></strong></td>
|
|
2410
|
+
<td><strong><%= list[i] %></strong></td>
|
|
2411
|
+
</tr>
|
|
2412
|
+
<strong><% } %></strong>
|
|
2413
|
+
</tbody>
|
|
2414
|
+
</table>
|
|
2415
|
+
</body>
|
|
2416
|
+
</html>
|
|
2417
|
+
</pre>
|
|
2418
|
+
<a name="example_js.result"></a>
|
|
2419
|
+
<div class="terminal_caption">
|
|
2420
|
+
compiled source code</div>
|
|
2421
|
+
<pre class="terminal">$ erubis -l js example.ejs
|
|
2422
|
+
var _buf = [];
|
|
2423
|
+
var user = 'Erubis';
|
|
2424
|
+
var list = ['<aaa>', 'b&b', '"ccc"'];
|
|
2425
|
+
|
|
2426
|
+
_buf.push("<html>\n\
|
|
2427
|
+
<body>\n\
|
|
2428
|
+
<p>Hello "); _buf.push(user); _buf.push("!</p>\n\
|
|
2429
|
+
<table>\n\
|
|
2430
|
+
<tbody>\n");
|
|
2431
|
+
var i;
|
|
2432
|
+
for (i = 0; i < list.length; i++) {
|
|
2433
|
+
_buf.push(" <tr bgcolor=\""); _buf.push(i % 2 == 0 ? '#FFCCCC' : '#CCCCFF'); _buf.push("\">\n\
|
|
2434
|
+
<td>"); _buf.push(i + 1); _buf.push("</td>\n\
|
|
2435
|
+
<td>"); _buf.push(list[i]); _buf.push("</td>\n\
|
|
2436
|
+
</tr>\n");
|
|
2437
|
+
}
|
|
2438
|
+
_buf.push(" </tbody>\n\
|
|
2439
|
+
</table>\n\
|
|
2440
|
+
</body>\n\
|
|
2441
|
+
</html>\n");
|
|
2442
|
+
document.write(_buf.join(""));
|
|
2443
|
+
</pre>
|
|
2444
|
+
<p>If command-line option '<code>--docwrite=false</code>' is specified,
|
|
2445
|
+
'<code>_buf.join("");</code>' is used instead of '<code>document.write(_buf.join(""));</code>'.
|
|
2446
|
+
This is useful when passing converted source code to eval() function in JavaScript.
|
|
2447
|
+
</p>
|
|
2448
|
+
<p>You can pass <code>:docwrite=>false</code> to Erubis::Ejavascript.new() in your Ruby script.
|
|
2449
|
+
</p>
|
|
2450
|
+
<pre class="program">s = File.read('example.jshtml')
|
|
2451
|
+
engine = Erubis::Ejavascript.new(s, <code>:docwrite=>false</code>)
|
|
2452
|
+
</pre>
|
|
2453
|
+
<p>If you want to specify any JavaScript code, use '--postamble=...'.
|
|
2454
|
+
</p>
|
|
2455
|
+
<p>Notice that default value of 'docwrite' property will be false in the future release.
|
|
2456
|
+
</p>
|
|
2457
|
+
<br>
|
|
2458
|
+
|
|
2459
|
+
|
|
2460
|
+
<br>
|
|
2461
|
+
|
|
2462
|
+
|
|
2463
|
+
<a name="rails"></a>
|
|
2464
|
+
<h2 class="section1">Ruby on Rails Support</h2>
|
|
2465
|
+
<p><span style="color:#FF0000">NOTICE: Rails 3 adopts Erubis as default default engine. You don't need to do anything at all when using Rails 3. This section is for Rails 2.</span>
|
|
2466
|
+
</p>
|
|
2467
|
+
<p>Erubis supports Ruby on Rails.
|
|
2468
|
+
This section describes how to use Erubis with Ruby on Rails.
|
|
2469
|
+
</p>
|
|
2470
|
+
<a name="rails-settings"></a>
|
|
2471
|
+
<h3 class="section2">Settings</h3>
|
|
2472
|
+
<p>Add the following code to your 'config/environment.rb' and restart web server.
|
|
2473
|
+
This replaces ERB in Rails by Erubis entirely.
|
|
2474
|
+
</p>
|
|
2475
|
+
<div class="program_caption">
|
|
2476
|
+
config/environment.rb</div>
|
|
2477
|
+
<pre class="program">require 'erubis/helpers/rails_helper'
|
|
2478
|
+
#Erubis::Helpers::RailsHelper.engine_class = Erubis::Eruby # or Erubis::FastEruby
|
|
2479
|
+
#Erubis::Helpers::RailsHelper.init_properties = {}
|
|
2480
|
+
#Erubis::Helpers::RailsHelper.show_src = nil
|
|
2481
|
+
#Erubis::Helpers::RailsHelper.preprocessing = false
|
|
2482
|
+
</pre>
|
|
2483
|
+
<p>Options:
|
|
2484
|
+
</p>
|
|
2485
|
+
<dl class="dl2">
|
|
2486
|
+
<dt class="dt2">
|
|
2487
|
+
Erubis::Helpers::RailsHelper.engine_class (=Erubis::Eruby)</dt>
|
|
2488
|
+
<dd class="dd2">
|
|
2489
|
+
<p> Erubis engine class (default Erubis::Eruby).
|
|
2490
|
+
</p>
|
|
2491
|
+
</dd>
|
|
2492
|
+
<dt class="dt2">
|
|
2493
|
+
Erubis::Helpers::RailsHelper.init_properties (={})</dt>
|
|
2494
|
+
<dd class="dd2">
|
|
2495
|
+
<p> Optional arguments for Erubis::Eruby#initialize() method (default {}).
|
|
2496
|
+
</p>
|
|
2497
|
+
</dd>
|
|
2498
|
+
<dt class="dt2">
|
|
2499
|
+
Erubis::Helpers::RailsHelper.show_src (=nil)</dt>
|
|
2500
|
+
<dd class="dd2">
|
|
2501
|
+
<p> Whether to print converted Ruby code into log file.
|
|
2502
|
+
If true, Erubis prints coverted code into log file.
|
|
2503
|
+
If false, Erubis doesn't.
|
|
2504
|
+
If nil, Erubis prints when ENV['RAILS_ENV'] == 'development'.
|
|
2505
|
+
Default is nil.
|
|
2506
|
+
</p>
|
|
2507
|
+
</dd>
|
|
2508
|
+
<dt class="dt2">
|
|
2509
|
+
Erubis::Helpers::RailsHelper.preprocessing (=false)</dt>
|
|
2510
|
+
<dd class="dd2">
|
|
2511
|
+
<p> Enable preprocessing if true (default false).
|
|
2512
|
+
</p>
|
|
2513
|
+
</dd>
|
|
2514
|
+
</dl>
|
|
2515
|
+
<br>
|
|
2516
|
+
|
|
2517
|
+
|
|
2518
|
+
<a name="rails-preprocessing"></a>
|
|
2519
|
+
<h3 class="section2">Preprosessing</h3>
|
|
2520
|
+
<p>Erubis supports preprocessing of template files.
|
|
2521
|
+
Preprocessing make your Ruby on Rails application about 20-40 percent faster.
|
|
2522
|
+
To enable preprocessing, set Erubis::Helpers::RailsHelper.preprocessing to true in your 'environment.rb' file.
|
|
2523
|
+
</p>
|
|
2524
|
+
<p>For example, assume the following template.
|
|
2525
|
+
This is slow because link_to() method is called every time when template is rendered.
|
|
2526
|
+
</p>
|
|
2527
|
+
<pre class="program"><%= link_to 'Create', :action=>'create' %>
|
|
2528
|
+
</pre>
|
|
2529
|
+
<p>The following is faster than the above, but not flexible because url is fixed.
|
|
2530
|
+
</p>
|
|
2531
|
+
<pre class="program"><a href="/users/create">Create</a>
|
|
2532
|
+
</pre>
|
|
2533
|
+
<p>Preprocessing solves this problem.
|
|
2534
|
+
If you use '[%= %]' instead of '<%= %>', preprocessor evaluate it only once when template is loaded.
|
|
2535
|
+
</p>
|
|
2536
|
+
<pre class="program"><strong>[%= link_to 'Create', :action=>'create'%]</strong>
|
|
2537
|
+
</pre>
|
|
2538
|
+
<p>The above is evaluated by preprocessor and replaced to the following code automatically.
|
|
2539
|
+
</p>
|
|
2540
|
+
<pre class="program"><a href="/users/create">Create</a>
|
|
2541
|
+
</pre>
|
|
2542
|
+
<p>Notice that this is done only once when template file is loaded.
|
|
2543
|
+
It means that link_to() method is not called when template is rendered.
|
|
2544
|
+
</p>
|
|
2545
|
+
<p>If link_to() method have variable arguments, use <code>_?()</code> helper method.
|
|
2546
|
+
</p>
|
|
2547
|
+
<pre class="program"><% for user in @users %>
|
|
2548
|
+
[%= link_to <strong>_?('user.name')</strong>, :action=>'show', :id=><strong>_?('user.id')</strong> %]
|
|
2549
|
+
<% end %>
|
|
2550
|
+
</pre>
|
|
2551
|
+
<p>The above is evaluated by preprocessor when template is loaded and expanded into the following code.
|
|
2552
|
+
This will be much faster because link_to() method is not called when rendering.
|
|
2553
|
+
</p>
|
|
2554
|
+
<pre class="program"><% for user in @users %>
|
|
2555
|
+
<a href="/users/show/<strong><%=user.id%></strong>"><strong><%=user.name%></strong></a>
|
|
2556
|
+
<% end %>
|
|
2557
|
+
</pre>
|
|
2558
|
+
<p>Preprocessing statement (<code>[% %]</code>) is also available as well as preprocessing expression (<code>[%= %]</code>).
|
|
2559
|
+
</p>
|
|
2560
|
+
<pre class="program"><select name="state">
|
|
2561
|
+
<option value="">-</option>
|
|
2562
|
+
<strong>[% for code in states.keys.sort %]</strong>
|
|
2563
|
+
<option value="<strong>[%= code %]</strong>"><strong>[%= states[code] %]</strong></option>
|
|
2564
|
+
<strong>[% end %]</strong>
|
|
2565
|
+
</select>
|
|
2566
|
+
</pre>
|
|
2567
|
+
<p>The above will be evaluated by preprocessor and expanded into the following when template is loaded.
|
|
2568
|
+
In the result, rendering speed will be much faster because for-loop is not executed when rendering.
|
|
2569
|
+
</p>
|
|
2570
|
+
<pre class="program"><select name="state">
|
|
2571
|
+
<option value="">-</option>
|
|
2572
|
+
<option value="AK">Alaska</option>
|
|
2573
|
+
<option value="AL">Alabama</option>
|
|
2574
|
+
<option value="AR">Arkansas</option>
|
|
2575
|
+
<option value="AS">American Samoa</option>
|
|
2576
|
+
<option value="AZ">Arizona</option>
|
|
2577
|
+
<option value="CA">California</option>
|
|
2578
|
+
<option value="CO">Colorado</option>
|
|
2579
|
+
....
|
|
2580
|
+
</select>
|
|
2581
|
+
</pre>
|
|
2582
|
+
<p>Notice that it is not recommended to use preprocessing with tag helpers,
|
|
2583
|
+
because tag helpers generate different html code when form parameter has errors or not.
|
|
2584
|
+
</p>
|
|
2585
|
+
<p>Helper methods of Ruby on Rails are divided into two groups.
|
|
2586
|
+
</p>
|
|
2587
|
+
<ul type="disc">
|
|
2588
|
+
<li>link_to() or _() (method of gettext package) are not need to call for every time
|
|
2589
|
+
as template is rendered because it returns same value when same arguments are passed.
|
|
2590
|
+
These methods can be got faster by preprocessing.
|
|
2591
|
+
</li>
|
|
2592
|
+
<li>Tag helper methods should be called for every time as template is rendered
|
|
2593
|
+
because it may return differrent value even if the same arguments are passed.
|
|
2594
|
+
Preprocessing is not available with these methods.
|
|
2595
|
+
</li>
|
|
2596
|
+
</ul>
|
|
2597
|
+
<p>In Ruby on Rails 2.0, <code>_?('user_id')</code> is OK but <code>_?('user.id')</code> is NG
|
|
2598
|
+
because the latter contains period ('.') character.
|
|
2599
|
+
</p>
|
|
2600
|
+
<pre class="program"><!-- NG in Rails 2.0, because _?('') contains period -->
|
|
2601
|
+
[%= link_to 'Edit', edit_user_path(<strong>_?('@user.id')</strong>) %]
|
|
2602
|
+
[%= link_to 'Show', <strong>@user</strong> %]
|
|
2603
|
+
[%= link_to 'Delete', <strong>@user</strong>, :confirm=>'OK?', :method=>:delete %]
|
|
2604
|
+
|
|
2605
|
+
<!-- OK in Rails 2.0 -->
|
|
2606
|
+
<strong><%= user_id = @user.id %></strong>
|
|
2607
|
+
[%= link_to 'Edit', edit_user_path(<strong>_?('user_id')</strong>) %]
|
|
2608
|
+
[%= link_to 'Show', <strong>:action=>'show', :id=>_?('user_id')</strong> %]
|
|
2609
|
+
[%= link_to 'Delete', <strong>{:action=>'destroy', :id=>_?('user_id')}</strong>,
|
|
2610
|
+
{:confirm=>'OK?', :method=>:delete} %]
|
|
2611
|
+
</pre>
|
|
2612
|
+
<br>
|
|
2613
|
+
|
|
2614
|
+
|
|
2615
|
+
<a name="rails-formhelpers"></a>
|
|
2616
|
+
<h3 class="section2">Form Helpers for Preprocessing</h3>
|
|
2617
|
+
<p><strong>(Experimental)</strong>
|
|
2618
|
+
</p>
|
|
2619
|
+
<p>Erubis provides form helper methods for preprocessing.
|
|
2620
|
+
These are defined in 'erubis/helpers/rails_form_helper.rb'.
|
|
2621
|
+
If you want to use it, require it and include Erubis::Helpers::RailsFormHelper in 'app/helpers/applition_helper.rb'
|
|
2622
|
+
</p>
|
|
2623
|
+
<div class="program_caption">
|
|
2624
|
+
app/helpers/xxx_helper.rb</div>
|
|
2625
|
+
<pre class="program">require 'erubis/helpers/rails_form_helper'
|
|
2626
|
+
module ApplicationHelper
|
|
2627
|
+
include Erubis::Helpers::RailsFormHelper
|
|
2628
|
+
end
|
|
2629
|
+
</pre>
|
|
2630
|
+
<p>Form helper methods defined in Erubis::Helpers::RailsFormHelper are named as 'pp_xxxx'
|
|
2631
|
+
('pp' represents preprocessing).
|
|
2632
|
+
</p>
|
|
2633
|
+
<p>Assume the following view template:
|
|
2634
|
+
</p>
|
|
2635
|
+
<div class="program_caption">
|
|
2636
|
+
_form.rhtml</div>
|
|
2637
|
+
<pre class="program"> <p>
|
|
2638
|
+
Name: <%= text_field :user, :name %>
|
|
2639
|
+
</p>
|
|
2640
|
+
<p>
|
|
2641
|
+
Name: <strong>[%= pp_text_field :user, :name %]</strong>
|
|
2642
|
+
</p>
|
|
2643
|
+
</pre>
|
|
2644
|
+
<p>Erubis preprocessor converts it to the following eRuby string:
|
|
2645
|
+
</p>
|
|
2646
|
+
<div class="program_caption">
|
|
2647
|
+
preprocessed</div>
|
|
2648
|
+
<pre class="program"> <p>
|
|
2649
|
+
Name: <%= text_field :user, :name %>
|
|
2650
|
+
</p>
|
|
2651
|
+
<p>
|
|
2652
|
+
Name: <strong><input id="stock_name" name="stock[name]" size="30" type="text" value="<%=h @stock.name%>" /></strong>
|
|
2653
|
+
</p>
|
|
2654
|
+
</pre>
|
|
2655
|
+
<p>Erubis converts it to the following Ruby code:
|
|
2656
|
+
</p>
|
|
2657
|
+
<div class="program_caption">
|
|
2658
|
+
Ruby code</div>
|
|
2659
|
+
<pre class="program"> _buf << ' <p>
|
|
2660
|
+
Name: '; _buf << ( text_field :stock, :name ).to_s; _buf << '
|
|
2661
|
+
'; _buf << ' </p>
|
|
2662
|
+
<p>
|
|
2663
|
+
Name: <input id="stock_name" name="stock[name]" size="30" type="text" value="'; _buf << (h @stock.name).to_s; _buf << '" />
|
|
2664
|
+
</p>
|
|
2665
|
+
';
|
|
2666
|
+
</pre>
|
|
2667
|
+
<p>The above Ruby code shows that text_field() is called everytime when rendering,
|
|
2668
|
+
but pp_text_field() is called only once when template is loaded.
|
|
2669
|
+
This means that pp_text_field() with preprocessing makes view layer very fast.
|
|
2670
|
+
</p>
|
|
2671
|
+
<p>Module Erubis::Helpers::RailsFormHelper defines the following form helper methods.
|
|
2672
|
+
</p>
|
|
2673
|
+
<ul type="disc">
|
|
2674
|
+
<li>pp_render_partial(basename)
|
|
2675
|
+
</li>
|
|
2676
|
+
<li>pp_form_tag(url_for_options={}, options={}, *parameters_for_url, &block)
|
|
2677
|
+
</li>
|
|
2678
|
+
<li>pp_text_field(object_name, method, options={})
|
|
2679
|
+
</li>
|
|
2680
|
+
<li>pp_password_field(object_name, method, options={})
|
|
2681
|
+
</li>
|
|
2682
|
+
<li>pp_hidden_field(object_name, method, options={})
|
|
2683
|
+
</li>
|
|
2684
|
+
<li>pp_file_field(object_name, method, options={})
|
|
2685
|
+
</li>
|
|
2686
|
+
<li>pp_text_area(object_name, method, options={})
|
|
2687
|
+
</li>
|
|
2688
|
+
<li>pp_check_box(object_name, method, options={}, checked_value="1", unchecked_value="0")
|
|
2689
|
+
</li>
|
|
2690
|
+
<li>pp_radio_button(object_name, method, tag_value, options={})
|
|
2691
|
+
</li>
|
|
2692
|
+
<li>pp_select(object, method, collection, options={}, html_options={})
|
|
2693
|
+
</li>
|
|
2694
|
+
<li>pp_collection_select(object, method, collection, value_method, text_method, options={}, html_options={})
|
|
2695
|
+
</li>
|
|
2696
|
+
<li>pp_country_select(object, method, priority_countries=nil, options={}, html_options={})
|
|
2697
|
+
</li>
|
|
2698
|
+
<li>pp_time_zone_select(object, method, priority_zones=nil, options={}, html_options={})
|
|
2699
|
+
</li>
|
|
2700
|
+
<li>pp_submit_tag(value="Save changes", options={})
|
|
2701
|
+
</li>
|
|
2702
|
+
<li>pp_image_submit_tag(source, options={})
|
|
2703
|
+
</li>
|
|
2704
|
+
</ul>
|
|
2705
|
+
<p>Notice that pp_form_for() is not provided.
|
|
2706
|
+
</p>
|
|
2707
|
+
<p><span style="color:#FF0000">CAUTION:</span> These are experimental and may not work in Ruby on Rails 2.0.
|
|
2708
|
+
</p>
|
|
2709
|
+
<br>
|
|
2710
|
+
|
|
2711
|
+
|
|
2712
|
+
<a name="rails-others"></a>
|
|
2713
|
+
<h3 class="section2">Others</h3>
|
|
2714
|
+
<ul type="disc">
|
|
2715
|
+
<li>ActionView::Helpers::CaptureHelper#capture() and ActionView::Helpers::Texthelper#concat() are available.
|
|
2716
|
+
</li>
|
|
2717
|
+
</ul>
|
|
2718
|
+
<ul type="disc">
|
|
2719
|
+
<li>Form helper methods are not tested in Ruby on Rails 2.0.
|
|
2720
|
+
</li>
|
|
2721
|
+
</ul>
|
|
2722
|
+
<ul type="disc">
|
|
2723
|
+
<li>ERB::Util.h() is redefined if you require 'erubis/helpers/rails_helper.rb'.
|
|
2724
|
+
Original definition of ERB::Util.h() is the following and it is slow
|
|
2725
|
+
because it scans string four times.
|
|
2726
|
+
<pre class="program"> def html_escape(s)
|
|
2727
|
+
s.to_s.gsub(/&/, "&amp;").gsub(/\"/, "&quot;").gsub(/>/, "&gt;").gsub(/</, "&lt;")
|
|
2728
|
+
end
|
|
2729
|
+
alias h html_escape
|
|
2730
|
+
</pre>
|
|
2731
|
+
<p> New definition in 'erubis/helpers/rails_helper.rb' is faster than the above
|
|
2732
|
+
because it scans string only once.
|
|
2733
|
+
</p>
|
|
2734
|
+
<pre class="program"> ESCAPE_TABLE = { '&'=>'&amp;', '<'=>'&lt;', '>'=>'&gt;', '"'=>'&quot;', "'"=>'&#039;', }
|
|
2735
|
+
def h(value)
|
|
2736
|
+
value.to_s.gsub(/[&<>"]/) { |s| ESCAPE_TABLE[s] }
|
|
2737
|
+
end
|
|
2738
|
+
</pre>
|
|
2739
|
+
<p> Notice that the new definition may be slow if string contains
|
|
2740
|
+
many '< > & "' characters because block is call many time.
|
|
2741
|
+
You should use ERB::Util.html_hscape() if string contains a lot of '< > & "'
|
|
2742
|
+
characters.
|
|
2743
|
+
</p>
|
|
2744
|
+
</li>
|
|
2745
|
+
</ul>
|
|
2746
|
+
<br>
|
|
2747
|
+
|
|
2748
|
+
|
|
2749
|
+
<br>
|
|
2750
|
+
|
|
2751
|
+
|
|
2752
|
+
<a name="topics"></a>
|
|
2753
|
+
<h2 class="section1">Other Topics</h2>
|
|
2754
|
+
<a name="topics-fasteruby"></a>
|
|
2755
|
+
<h3 class="section2"><code>Erubis::FastEruby</code> Class</h3>
|
|
2756
|
+
<p><code>Erubis::FastEruby</code> class generates more effective code than <code>Erubis::Eruby</code>.
|
|
2757
|
+
</p>
|
|
2758
|
+
<a name="fasteruby-example.rb"></a>
|
|
2759
|
+
<div class="program_caption">
|
|
2760
|
+
fasteruby-example.rb</div>
|
|
2761
|
+
<pre class="program">require 'erubis'
|
|
2762
|
+
input = File.read('example.eruby')
|
|
2763
|
+
|
|
2764
|
+
puts "----- Erubis::Eruby -----"
|
|
2765
|
+
print Erubis::Eruby.new(input).src
|
|
2766
|
+
|
|
2767
|
+
puts "----- Erubis::FastEruby -----"
|
|
2768
|
+
print <strong>Erubis::FastEruby</strong>.new(input).src
|
|
2769
|
+
</pre>
|
|
2770
|
+
<a name="fasteruby-example.result"></a>
|
|
2771
|
+
<div class="terminal_caption">
|
|
2772
|
+
result</div>
|
|
2773
|
+
<pre class="terminal">$ ruby fasteruby-example.rb
|
|
2774
|
+
----- Erubis::Eruby -----
|
|
2775
|
+
_buf = ''; _buf << '<div>
|
|
2776
|
+
'; for item in list
|
|
2777
|
+
_buf << ' <p>'; <strong>_buf << ( item ).to_s;</strong> _buf << '</p>
|
|
2778
|
+
<p>'; <strong>_buf << Erubis::XmlHelper.escape_xml( item );</strong> _buf << '</p>
|
|
2779
|
+
'; end
|
|
2780
|
+
_buf << '</div>
|
|
2781
|
+
';
|
|
2782
|
+
_buf.to_s
|
|
2783
|
+
----- Erubis::FastEruby -----
|
|
2784
|
+
_buf = ''; _buf << %Q`<div>\n`
|
|
2785
|
+
for item in list
|
|
2786
|
+
_buf << %Q` <p><strong>#{ item }</strong></p>
|
|
2787
|
+
<p><strong>#{Erubis::XmlHelper.escape_xml( item )}</strong></p>\n`
|
|
2788
|
+
end
|
|
2789
|
+
_buf << %Q`</div>\n`
|
|
2790
|
+
_buf.to_s
|
|
2791
|
+
</pre>
|
|
2792
|
+
<p>Technically, <code>Erubis::FastEruby</code> is just a subclass of <code>Erubis::Eruby</code> and includes <code><a href="#interpolation-enhancer">InterpolationEnhancer</a></code>. <code>Erubis::FastEruby</code> is faster than <code>Erubis::Eruby</code> but is not extensible compared to <code>Erubis::Eruby</code>. This is the reason why <code>Erubis::FastEruby</code> is not the default class of Erubis.
|
|
2793
|
+
</p>
|
|
2794
|
+
<br>
|
|
2795
|
+
|
|
2796
|
+
|
|
2797
|
+
<a name="topics-bufvar"></a>
|
|
2798
|
+
<h3 class="section2"><code>:bufvar</code> Option</h3>
|
|
2799
|
+
<p>Since 2.7.0, Erubis supports <code>:bufvar</code> option which allows you to change buffer variable name (default '<code>_buf</code>').
|
|
2800
|
+
</p>
|
|
2801
|
+
<a name="bufvar-example.rb"></a>
|
|
2802
|
+
<div class="program_caption">
|
|
2803
|
+
bufvar-example.rb</div>
|
|
2804
|
+
<pre class="program">require 'erubis'
|
|
2805
|
+
input = File.read('example.eruby')
|
|
2806
|
+
|
|
2807
|
+
puts "----- default -----"
|
|
2808
|
+
eruby = Erubis::FastEruby.new(input)
|
|
2809
|
+
puts eruby.src
|
|
2810
|
+
|
|
2811
|
+
puts "----- with :bufvar option -----"
|
|
2812
|
+
eruby = Erubis::FastEruby.new(input, <strong>:bufvar=>'@_out_buf'</strong>)
|
|
2813
|
+
print eruby.src
|
|
2814
|
+
</pre>
|
|
2815
|
+
<a name="bufvar-example.result"></a>
|
|
2816
|
+
<div class="terminal_caption">
|
|
2817
|
+
result</div>
|
|
2818
|
+
<pre class="terminal">$ ruby bufvar-example.rb
|
|
2819
|
+
----- default -----
|
|
2820
|
+
_buf = ''; _buf << %Q`<div>\n`
|
|
2821
|
+
for item in list
|
|
2822
|
+
_buf << %Q` <p>#{ item }</p>
|
|
2823
|
+
<p>#{Erubis::XmlHelper.escape_xml( item )}</p>\n`
|
|
2824
|
+
end
|
|
2825
|
+
_buf << %Q`</div>\n`
|
|
2826
|
+
_buf.to_s
|
|
2827
|
+
----- with :bufvar option -----
|
|
2828
|
+
<strong>@_out_buf</strong> = ''; <strong>@_out_buf</strong> << %Q`<div>\n`
|
|
2829
|
+
for item in list
|
|
2830
|
+
<strong>@_out_buf</strong> << %Q` <p>#{ item }</p>
|
|
2831
|
+
<p>#{Erubis::XmlHelper.escape_xml( item )}</p>\n`
|
|
2832
|
+
end
|
|
2833
|
+
<strong>@_out_buf</strong> << %Q`</div>\n`
|
|
2834
|
+
<strong>@_out_buf</strong>.to_s
|
|
2835
|
+
</pre>
|
|
2836
|
+
<br>
|
|
2837
|
+
|
|
2838
|
+
|
|
2839
|
+
<a name="topics-trimspaces"></a>
|
|
2840
|
+
<h3 class="section2">'<%= =%>' and '<%= -%>'</h3>
|
|
2841
|
+
<p>Since 2.6.0, '<%= -%>' remove tail spaces and newline.
|
|
2842
|
+
This is for compatibiliy with ERB when trim mode is '-'.
|
|
2843
|
+
'<%= =%>' also removes tail spaces and newlines, and this is
|
|
2844
|
+
Erubis-original enhancement (cooler than '<%= -%>', isn't it?).
|
|
2845
|
+
</p>
|
|
2846
|
+
<a name="tailnewline.rhtml.comment_filter"></a>
|
|
2847
|
+
<div class="program_caption">
|
|
2848
|
+
tailnewline.rhtml</div>
|
|
2849
|
+
<pre class="program"><div>
|
|
2850
|
+
<%= @var -%> # or <%= @var =%>
|
|
2851
|
+
</div>
|
|
2852
|
+
</pre>
|
|
2853
|
+
<div class="terminal_caption">
|
|
2854
|
+
result (version 2.5.0):</div>
|
|
2855
|
+
<pre class="terminal">$ erubis -c '{var: "AAA\n"}' tailnewline.rhtml
|
|
2856
|
+
<div>
|
|
2857
|
+
AAA
|
|
2858
|
+
|
|
2859
|
+
</div>
|
|
2860
|
+
</pre>
|
|
2861
|
+
<a name="tail_260.result"></a>
|
|
2862
|
+
<div class="terminal_caption">
|
|
2863
|
+
result (version 2.6.0):</div>
|
|
2864
|
+
<pre class="terminal">$ erubis -c '{var: "AAA\n"}' tailnewline.rhtml
|
|
2865
|
+
<div>
|
|
2866
|
+
AAA
|
|
2867
|
+
</div>
|
|
2868
|
+
</pre>
|
|
2869
|
+
<br>
|
|
2870
|
+
|
|
2871
|
+
|
|
2872
|
+
<a name="topics-doublepercent"></a>
|
|
2873
|
+
<h3 class="section2">'<%% %>' and '<%%= %>'</h3>
|
|
2874
|
+
<p>Since 2.6.0, '<%% %>' and '<%%= %>' are converted into '<% %>' and '<%= %>' respectively.
|
|
2875
|
+
This is for compatibility with ERB.
|
|
2876
|
+
</p>
|
|
2877
|
+
<div class="program_caption">
|
|
2878
|
+
doublepercent.rhtml:</div>
|
|
2879
|
+
<pre class="program"><ul>
|
|
2880
|
+
<%% for item in @list %>
|
|
2881
|
+
<li><%%= item %></li>
|
|
2882
|
+
<%% end %>
|
|
2883
|
+
</ul>
|
|
2884
|
+
</pre>
|
|
2885
|
+
<div class="terminal_caption">
|
|
2886
|
+
result:</div>
|
|
2887
|
+
<pre class="terminal">$ erubis doublepercent.rhtml
|
|
2888
|
+
<ul>
|
|
2889
|
+
<% for item in @list %>
|
|
2890
|
+
<li><%= item %></li>
|
|
2891
|
+
<% end %>
|
|
2892
|
+
</ul>
|
|
2893
|
+
</pre>
|
|
2894
|
+
<br>
|
|
2895
|
+
|
|
2896
|
+
|
|
2897
|
+
<a name="topics-context-vs-binding"></a>
|
|
2898
|
+
<h3 class="section2">evaluate(context) v.s. result(binding)</h3>
|
|
2899
|
+
<p>It is recommended to use 'Erubis::Eruby#evaluate(context)' instead of 'Erubis::Eruby#result(binding)' because Ruby's Binding object has some problems.
|
|
2900
|
+
</p>
|
|
2901
|
+
<ul type="disc">
|
|
2902
|
+
<li>It is not able to specify variables to use.
|
|
2903
|
+
Using binding() method, all of local variables are passed to templates.
|
|
2904
|
+
</li>
|
|
2905
|
+
<li>Changing local variables in templates may affect to varialbes in main program.
|
|
2906
|
+
If you assign '10' to local variable 'x' in templates, it may change variable 'x' in main program unintendedly.
|
|
2907
|
+
</li>
|
|
2908
|
+
</ul>
|
|
2909
|
+
<p>The following example shows that assignment of some values into variable 'x' in templates affect to local variable 'x' in main program unintendedly.
|
|
2910
|
+
</p>
|
|
2911
|
+
<a name="template1.rhtml"></a>
|
|
2912
|
+
<div class="program_caption">
|
|
2913
|
+
template1.rhtml (intended to be passed 'items' from main program)</div>
|
|
2914
|
+
<pre class="program"><% for <strong>x</strong> in <strong>items</strong> %>
|
|
2915
|
+
item = <%= x %>
|
|
2916
|
+
<% end %>
|
|
2917
|
+
** debug: local variables=<%= local_variables().inspect() %>
|
|
2918
|
+
</pre>
|
|
2919
|
+
<a name="main_program1.rb"></a>
|
|
2920
|
+
<div class="program_caption">
|
|
2921
|
+
main_program1.rb (intended to pass 'items' to template)</div>
|
|
2922
|
+
<pre class="program">require 'erubis'
|
|
2923
|
+
eruby = Erubis::Eruby.new(File.read('template1.rhtml'))
|
|
2924
|
+
items = ['foo', 'bar', 'baz']
|
|
2925
|
+
x = 1
|
|
2926
|
+
## local variable 'x' and 'eruby' are passed to template as well as 'items'!
|
|
2927
|
+
print <strong>eruby.result(binding())</strong>
|
|
2928
|
+
## local variable 'x' is changed unintendedly because it is changed in template!
|
|
2929
|
+
puts "** debug: x=#{x.inspect}" #=> "baz"
|
|
2930
|
+
</pre>
|
|
2931
|
+
<a name="main_program1.result"></a>
|
|
2932
|
+
<div class="terminal_caption">
|
|
2933
|
+
Result:</div>
|
|
2934
|
+
<pre class="terminal">$ ruby main_program1.rb
|
|
2935
|
+
item = foo
|
|
2936
|
+
item = bar
|
|
2937
|
+
item = baz
|
|
2938
|
+
** debug: local variables=["eruby", "items", "x", "_buf"]
|
|
2939
|
+
** debug: x="baz"
|
|
2940
|
+
</pre>
|
|
2941
|
+
<p>This problem is caused because Ruby's Binding class is poor to use in template engine.
|
|
2942
|
+
Binding class should support the following features.
|
|
2943
|
+
</p>
|
|
2944
|
+
<pre class="program">b = Binding.new # create empty Binding object
|
|
2945
|
+
b['x'] = 1 # set local variables using binding object
|
|
2946
|
+
</pre>
|
|
2947
|
+
<p>But the above features are not implemented in Ruby.
|
|
2948
|
+
</p>
|
|
2949
|
+
<p>A pragmatic solution is to use 'Erubis::Eruby#evaluate(context)' instead of 'Erubis::Eruby#result(binding)'.
|
|
2950
|
+
'evaluate(context)' uses Erubis::Context object and instance variables instead of Binding object and local variables.
|
|
2951
|
+
</p>
|
|
2952
|
+
<a name="template2.rhtml"></a>
|
|
2953
|
+
<div class="program_caption">
|
|
2954
|
+
template2.rhtml (intended to be passed '@items' from main program)</div>
|
|
2955
|
+
<pre class="program"><% for <strong>x</strong> in <strong>@items</strong> %>
|
|
2956
|
+
item = <%= x %>
|
|
2957
|
+
<% end %>
|
|
2958
|
+
** debug: local variables=<%= local_variables().inspect() %>
|
|
2959
|
+
</pre>
|
|
2960
|
+
<a name="main_program2.rb"></a>
|
|
2961
|
+
<div class="program_caption">
|
|
2962
|
+
main_program2.rb (intended to pass '@items' to template)</div>
|
|
2963
|
+
<pre class="program">require 'erubis'
|
|
2964
|
+
eruby = Erubis::Eruby.new(File.read('template2.rhtml'))
|
|
2965
|
+
items = ['foo', 'bar', 'baz']
|
|
2966
|
+
x = 1
|
|
2967
|
+
## only 'items' are passed to template
|
|
2968
|
+
print <strong>eruby.evaluate(:items=>items)</strong>
|
|
2969
|
+
## local variable 'x' is not changed!
|
|
2970
|
+
puts "** debug: x=#{x.inspect}" #=> 1
|
|
2971
|
+
</pre>
|
|
2972
|
+
<a name="main_program2.result"></a>
|
|
2973
|
+
<div class="terminal_caption">
|
|
2974
|
+
Result:</div>
|
|
2975
|
+
<pre class="terminal">$ ruby main_program2.rb
|
|
2976
|
+
item = foo
|
|
2977
|
+
item = bar
|
|
2978
|
+
item = baz
|
|
2979
|
+
** debug: local variables=["_context", "x", "_buf"]
|
|
2980
|
+
** debug: x=1
|
|
2981
|
+
</pre>
|
|
2982
|
+
<br>
|
|
2983
|
+
|
|
2984
|
+
|
|
2985
|
+
<a name="topics-fasteruby"></a>
|
|
2986
|
+
<h3 class="section2">Class Erubis::FastEruby</h3>
|
|
2987
|
+
<p>[experimental]
|
|
2988
|
+
</p>
|
|
2989
|
+
<p>Erubis provides Erubis::FastEruby class which includes <a href="#interpolation-enhancer">InterpolationEnhancer</a> and <a href="#topics-benchmark">works faster than Erubis::Eruby class</a>.
|
|
2990
|
+
If you desire more speed, try Erubis::FastEruby class.
|
|
2991
|
+
</p>
|
|
2992
|
+
<a name="fasteruby.rhtml"></a>
|
|
2993
|
+
<div class="program_caption">
|
|
2994
|
+
File 'fasteruby.rhtml':</div>
|
|
2995
|
+
<pre class="program"><html>
|
|
2996
|
+
<body>
|
|
2997
|
+
<h1><%== @title %></h1>
|
|
2998
|
+
<table>
|
|
2999
|
+
<% i = 0 %>
|
|
3000
|
+
<% for item in @list %>
|
|
3001
|
+
<% i += 1 %>
|
|
3002
|
+
<tr>
|
|
3003
|
+
<td><%= i %></td>
|
|
3004
|
+
<td><%== item %></td>
|
|
3005
|
+
</tr>
|
|
3006
|
+
<% end %>
|
|
3007
|
+
</table>
|
|
3008
|
+
</body>
|
|
3009
|
+
</html>
|
|
3010
|
+
</pre>
|
|
3011
|
+
<a name="fasteruby.rb"></a>
|
|
3012
|
+
<div class="program_caption">
|
|
3013
|
+
File 'fasteruby.rb':</div>
|
|
3014
|
+
<pre class="program">require 'erubis'
|
|
3015
|
+
input = File.read('fasteruby.rhtml')
|
|
3016
|
+
eruby = <strong>Erubis::FastEruby.new(input)</strong> # create Eruby object
|
|
3017
|
+
|
|
3018
|
+
puts "---------- script source ---"
|
|
3019
|
+
puts eruby.src
|
|
3020
|
+
|
|
3021
|
+
puts "---------- result ----------"
|
|
3022
|
+
context = { :title=>'Example', :list=>['aaa', 'bbb', 'ccc'] }
|
|
3023
|
+
output = eruby.evaluate(context)
|
|
3024
|
+
print output
|
|
3025
|
+
</pre>
|
|
3026
|
+
<a name="fasteruby.result"></a>
|
|
3027
|
+
<div class="terminal_caption">
|
|
3028
|
+
output</div>
|
|
3029
|
+
<pre class="terminal">$ ruby fasteruby.rb
|
|
3030
|
+
---------- script source ---
|
|
3031
|
+
_buf = ''; _buf << <strong>%Q`</strong><html>
|
|
3032
|
+
<body>
|
|
3033
|
+
<h1><strong>#{Erubis::XmlHelper.escape_xml( @title )}</strong></h1>
|
|
3034
|
+
<table>\n<strong>`</strong>
|
|
3035
|
+
i = 0
|
|
3036
|
+
for item in @list
|
|
3037
|
+
i += 1
|
|
3038
|
+
_buf << <strong>%Q`</strong> <tr>
|
|
3039
|
+
<td><strong>#{ i }</strong></td>
|
|
3040
|
+
<td><strong>#{Erubis::XmlHelper.escape_xml( item )}</strong></td>
|
|
3041
|
+
</tr>\n<strong>`</strong>
|
|
3042
|
+
end
|
|
3043
|
+
_buf << <strong>%Q`</strong> </table>
|
|
3044
|
+
</body>
|
|
3045
|
+
</html>\n<strong>`</strong>
|
|
3046
|
+
_buf.to_s
|
|
3047
|
+
---------- result ----------
|
|
3048
|
+
<html>
|
|
3049
|
+
<body>
|
|
3050
|
+
<h1>Example</h1>
|
|
3051
|
+
<table>
|
|
3052
|
+
<tr>
|
|
3053
|
+
<td>1</td>
|
|
3054
|
+
<td>aaa</td>
|
|
3055
|
+
</tr>
|
|
3056
|
+
<tr>
|
|
3057
|
+
<td>2</td>
|
|
3058
|
+
<td>bbb</td>
|
|
3059
|
+
</tr>
|
|
3060
|
+
<tr>
|
|
3061
|
+
<td>3</td>
|
|
3062
|
+
<td>ccc</td>
|
|
3063
|
+
</tr>
|
|
3064
|
+
</table>
|
|
3065
|
+
</body>
|
|
3066
|
+
</html>
|
|
3067
|
+
</pre>
|
|
3068
|
+
<br>
|
|
3069
|
+
|
|
3070
|
+
|
|
3071
|
+
<a name="topics-syntax"></a>
|
|
3072
|
+
<h3 class="section2">Syntax Checking</h3>
|
|
3073
|
+
<p>Command-line option '-z' checks syntax. It is similar to 'erubis -x file.rhtml | ruby -wc', but it can take several file names.
|
|
3074
|
+
</p>
|
|
3075
|
+
<div class="terminal_caption">
|
|
3076
|
+
example of command-line option '-z'</div>
|
|
3077
|
+
<pre class="terminal">$ erubis <strong>-z</strong> app/views/*/*.rhtml
|
|
3078
|
+
Syntax OK
|
|
3079
|
+
</pre>
|
|
3080
|
+
<br>
|
|
3081
|
+
|
|
3082
|
+
|
|
3083
|
+
<a name="topics-caching"></a>
|
|
3084
|
+
<h3 class="section2">File Caching</h3>
|
|
3085
|
+
<p>Erubis::Eruby.load_file(filename) convert file into Ruby script and return Eruby object.
|
|
3086
|
+
In addition, it caches converted Ruby script into cache file (filename + '.cache') if cache file is old or not exist.
|
|
3087
|
+
If cache file exists and is newer than eruby file, Erubis::Eruby.load_file() loads cache file.
|
|
3088
|
+
</p>
|
|
3089
|
+
<div class="program_caption">
|
|
3090
|
+
example of Erubis::Eruby.load_file()</div>
|
|
3091
|
+
<pre class="program">require 'erubis'
|
|
3092
|
+
filename = 'example.rhtml'
|
|
3093
|
+
eruby = <strong>Erubis::Eruby.load_file(filename)</strong>
|
|
3094
|
+
cachename = filename + '.cache'
|
|
3095
|
+
if test(?f, cachename)
|
|
3096
|
+
puts "*** cache file '#{cachename}' created."
|
|
3097
|
+
end
|
|
3098
|
+
</pre>
|
|
3099
|
+
<p>Since 2.6.0, it is able to specify cache filename.
|
|
3100
|
+
</p>
|
|
3101
|
+
<div class="program_caption">
|
|
3102
|
+
specify cache filename.</div>
|
|
3103
|
+
<pre class="program">filename = 'example.rhtml'
|
|
3104
|
+
eruby = Erubis::Eruby.load_file(filename, :cachename=>filename+'.cache')
|
|
3105
|
+
</pre>
|
|
3106
|
+
<p>Caching makes Erubis about 40-50 percent faster than no-caching.
|
|
3107
|
+
See <a href="#topics-benchmark">benchmark</a> for details.
|
|
3108
|
+
</p>
|
|
3109
|
+
<br>
|
|
3110
|
+
|
|
3111
|
+
|
|
3112
|
+
<a name="topics-tinyeruby"></a>
|
|
3113
|
+
<h3 class="section2">Erubis::TinyEruby class</h3>
|
|
3114
|
+
<p>Erubis::TinyEruby class in 'erubis/tiny.rb' is the smallest implementation of eRuby.
|
|
3115
|
+
If you don't need any enhancements of Erubis and only require simple eRuby implementation,
|
|
3116
|
+
try Erubis::TinyEruby class.
|
|
3117
|
+
</p>
|
|
3118
|
+
<br>
|
|
3119
|
+
|
|
3120
|
+
|
|
3121
|
+
<a name="topics-php"></a>
|
|
3122
|
+
<h3 class="section2">NoTextEnhancer and NoCodeEnhancer in PHP</h3>
|
|
3123
|
+
<p>NoTextEnhancer and NoCodEnahncer are quite useful not only for eRuby but also for PHP.
|
|
3124
|
+
The former "drops" HTML text and show up embedded Ruby/PHP code
|
|
3125
|
+
and the latter drops embedded Ruby/PHP code and leave HTML text.
|
|
3126
|
+
</p>
|
|
3127
|
+
<p>For example, see the following PHP script.
|
|
3128
|
+
</p>
|
|
3129
|
+
<a name="notext-example.php"></a>
|
|
3130
|
+
<div class="program_caption">
|
|
3131
|
+
notext-example.php</div>
|
|
3132
|
+
<pre class="program"><html>
|
|
3133
|
+
<body>
|
|
3134
|
+
<h3>List</h3>
|
|
3135
|
+
<?php if (!$list || count($list) == 0) { ?>
|
|
3136
|
+
<p>not found.</p>
|
|
3137
|
+
<?php } else { ?>
|
|
3138
|
+
<table>
|
|
3139
|
+
<tbody>
|
|
3140
|
+
<?php $i = 0; ?>
|
|
3141
|
+
<?php foreach ($list as $item) { ?>
|
|
3142
|
+
<tr bgcolor="<?php echo ++$i % 2 == 1 ? '#FFCCCC' : '#CCCCFF'; ?>">
|
|
3143
|
+
<td><?php echo $item; ?></td>
|
|
3144
|
+
</tr>
|
|
3145
|
+
<?php } ?>
|
|
3146
|
+
</tbody>
|
|
3147
|
+
</table>
|
|
3148
|
+
<?php } ?>
|
|
3149
|
+
</body>
|
|
3150
|
+
</html>
|
|
3151
|
+
</pre>
|
|
3152
|
+
<p>This is complex because PHP code and HTML document are mixed.
|
|
3153
|
+
NoTextEnhancer can separate PHP code from HTML document.
|
|
3154
|
+
</p>
|
|
3155
|
+
<a name="notext-php.result"></a>
|
|
3156
|
+
<div class="terminal_caption">
|
|
3157
|
+
example of using NoTextEnhancer with PHP file</div>
|
|
3158
|
+
<pre class="terminal">$ erubis -l php --pi=php -N -E NoText --trim=false notext-example.php
|
|
3159
|
+
1:
|
|
3160
|
+
2:
|
|
3161
|
+
3:
|
|
3162
|
+
4: <?php if (!$list || count($list) == 0) { ?>
|
|
3163
|
+
5:
|
|
3164
|
+
6: <?php } else { ?>
|
|
3165
|
+
7:
|
|
3166
|
+
8:
|
|
3167
|
+
9: <?php $i = 0; ?>
|
|
3168
|
+
10: <?php foreach ($list as $item) { ?>
|
|
3169
|
+
11: <?php echo ++$i % 2 == 1 ? '#FFCCCC' : '#CCCCFF'; ?>
|
|
3170
|
+
12: <?php echo $item; ?>
|
|
3171
|
+
13:
|
|
3172
|
+
14: <?php } ?>
|
|
3173
|
+
15:
|
|
3174
|
+
16:
|
|
3175
|
+
17: <?php } ?>
|
|
3176
|
+
18:
|
|
3177
|
+
19:
|
|
3178
|
+
</pre>
|
|
3179
|
+
<p>In the same way, NoCodeEnhancer can extract HTML tags.
|
|
3180
|
+
</p>
|
|
3181
|
+
<a name="nocode-php.result"></a>
|
|
3182
|
+
<div class="terminal_caption">
|
|
3183
|
+
example of using NoCodeEnhancer with PHP file</div>
|
|
3184
|
+
<pre class="terminal">$ erubis -l php --pi=php -N -E NoCode --trim=false notext-example.php
|
|
3185
|
+
1: <html>
|
|
3186
|
+
2: <body>
|
|
3187
|
+
3: <h3>List</h3>
|
|
3188
|
+
4:
|
|
3189
|
+
5: <p>not found.</p>
|
|
3190
|
+
6:
|
|
3191
|
+
7: <table>
|
|
3192
|
+
8: <tbody>
|
|
3193
|
+
9:
|
|
3194
|
+
10:
|
|
3195
|
+
11: <tr bgcolor="">
|
|
3196
|
+
12: <td></td>
|
|
3197
|
+
13: </tr>
|
|
3198
|
+
14:
|
|
3199
|
+
15: </tbody>
|
|
3200
|
+
16: </table>
|
|
3201
|
+
17:
|
|
3202
|
+
18: </body>
|
|
3203
|
+
19: </html>
|
|
3204
|
+
</pre>
|
|
3205
|
+
<br>
|
|
3206
|
+
|
|
3207
|
+
|
|
3208
|
+
<a name="topcs-modruby"></a>
|
|
3209
|
+
<h3 class="section2">Helper Class for mod_ruby</h3>
|
|
3210
|
+
<p>Thanks Andrew R Jackson, he developed 'erubis-run.rb' which enables you to use Erubis with mod_ruby.
|
|
3211
|
+
</p>
|
|
3212
|
+
<ol type="1">
|
|
3213
|
+
<li>Copy 'erubis-$Release$/contrib/erubis-run.rb' to the 'RUBYLIBDIR/apache' directory (for example '/usr/local/lib/ruby/1.8/apache') which contains 'ruby-run.rb', 'eruby-run.rb', and so on.
|
|
3214
|
+
<pre class="terminal">$ cd erubis-$Release$/
|
|
3215
|
+
$ sudo copy contrib/erubis-run.rb /usr/local/lib/ruby/1.8/apache/
|
|
3216
|
+
</pre>
|
|
3217
|
+
</li>
|
|
3218
|
+
<li>Add the following example to your 'httpd.conf' (for example '/usr/local/apache2/conf/httpd.conf')
|
|
3219
|
+
<pre class="program">LoadModule ruby_module modules/mod_ruby.so
|
|
3220
|
+
<IfModule mod_ruby.c>
|
|
3221
|
+
RubyRequire apache/ruby-run
|
|
3222
|
+
RubyRequire apache/eruby-run
|
|
3223
|
+
RubyRequire apache/erubis-run
|
|
3224
|
+
<Location /erubis>
|
|
3225
|
+
SetHandler ruby-object
|
|
3226
|
+
RubyHandler Apache::ErubisRun.instance
|
|
3227
|
+
</Location>
|
|
3228
|
+
<Files *.rhtml>
|
|
3229
|
+
SetHandler ruby-object
|
|
3230
|
+
RubyHandler Apache::ErubisRun.instance
|
|
3231
|
+
</Files>
|
|
3232
|
+
</IfModule>
|
|
3233
|
+
</pre>
|
|
3234
|
+
</li>
|
|
3235
|
+
<li>Restart Apache web server.
|
|
3236
|
+
<pre class="terminal">$ sudo /usr/local/apache2/bin/apachectl stop
|
|
3237
|
+
$ sudo /usr/local/apache2/bin/apachectl start
|
|
3238
|
+
</pre>
|
|
3239
|
+
</li>
|
|
3240
|
+
<li>Create *.rhtml file, for example:
|
|
3241
|
+
<pre class="program"><html>
|
|
3242
|
+
<body>
|
|
3243
|
+
Now is <%= Time.now %>
|
|
3244
|
+
Erubis version is <%= Erubis::VERSION %>
|
|
3245
|
+
</body>
|
|
3246
|
+
</html>
|
|
3247
|
+
</pre>
|
|
3248
|
+
</li>
|
|
3249
|
+
<li>Change mode of your directory to be writable by web server process.
|
|
3250
|
+
<pre class="terminal">$ cd /usr/local/apache2/htdocs/erubis
|
|
3251
|
+
$ sudo chgrp daemon .
|
|
3252
|
+
$ sudo chmod 775 .
|
|
3253
|
+
</pre>
|
|
3254
|
+
</li>
|
|
3255
|
+
<li>Access the *.rhtml file and you'll get the web page.
|
|
3256
|
+
</li>
|
|
3257
|
+
</ol>
|
|
3258
|
+
<p>You must set your directories to be writable by web server process, because
|
|
3259
|
+
Apache::ErubisRun calls Erubis::Eruby.load_file() internally which creates cache files
|
|
3260
|
+
in the same directory in which '*.rhtml' file exists.
|
|
3261
|
+
</p>
|
|
3262
|
+
<br>
|
|
3263
|
+
|
|
3264
|
+
|
|
3265
|
+
<a name="topics-index-cgi"></a>
|
|
3266
|
+
<h3 class="section2">Helper CGI Script for Apache</h3>
|
|
3267
|
+
<p>Erubis provides helper CGI script for Apache.
|
|
3268
|
+
Using this script, it is very easy to publish *.rhtml files as *.html.
|
|
3269
|
+
</p>
|
|
3270
|
+
<pre class="terminal">### install Erubis
|
|
3271
|
+
$ tar xzf erubis-X.X.X.tar.gz
|
|
3272
|
+
$ cd erubis-X.X.X/
|
|
3273
|
+
$ ruby setup.py install
|
|
3274
|
+
### copy files to ~/public_html
|
|
3275
|
+
$ mkdir -p ~/public_html
|
|
3276
|
+
$ cp public_html/_htaccess ~/public_html/.htaccess
|
|
3277
|
+
$ cp public_html/index.cgi ~/public_html/
|
|
3278
|
+
$ cp public_html/index.rhtml ~/public_html/
|
|
3279
|
+
### add executable permission to index.cgi
|
|
3280
|
+
$ chmod a+x ~/public_html/index.cgi
|
|
3281
|
+
### edit .htaccess
|
|
3282
|
+
$ vi ~/public_html/.htaccess
|
|
3283
|
+
### (optional) edit index.cgi to configure
|
|
3284
|
+
$ vi ~/public_html/index.cgi
|
|
3285
|
+
</pre>
|
|
3286
|
+
<p>Edit ~/public_html/.htaccess and modify user name.
|
|
3287
|
+
</p>
|
|
3288
|
+
<div class="program_caption">
|
|
3289
|
+
~/public_html/.htaccess</div>
|
|
3290
|
+
<pre class="program">## enable mod_rewrie
|
|
3291
|
+
RewriteEngine on
|
|
3292
|
+
## deny access to *.rhtml and *.cache
|
|
3293
|
+
#RewriteRule \.(rhtml|cache)$ - [R=404,L]
|
|
3294
|
+
RewriteRule \.(rhtml|cache)$ - [F,L]
|
|
3295
|
+
## rewrite only if requested file is not found
|
|
3296
|
+
RewriteCond %{SCRIPT_FILENAME} !-f
|
|
3297
|
+
## handle request to *.html and directories by index.cgi
|
|
3298
|
+
RewriteRule (\.html|/|^)$ /~<strong>username</strong>/index.cgi
|
|
3299
|
+
#RewriteRule (\.html|/|^)$ index.cgi
|
|
3300
|
+
</pre>
|
|
3301
|
+
<p>After these steps, *.rhtml will be published as *.html.
|
|
3302
|
+
For example, if you access to <code>http://<em>host</em>.<em>domain</em>/~<em>username</em>/index.html</code> (or <code>http://<em>host</em>.<em>domain</em>/~<em>username</em>/</code>), file <code>~/public_html/index.rhtml</code> will be displayed.
|
|
3303
|
+
</p>
|
|
3304
|
+
<br>
|
|
3305
|
+
|
|
3306
|
+
|
|
3307
|
+
<a name="topics-defmethod"></a>
|
|
3308
|
+
<h3 class="section2">Define method</h3>
|
|
3309
|
+
<p>Erubis::Eruby#def_method() defines instance method or singleton method.
|
|
3310
|
+
</p>
|
|
3311
|
+
<a name="def_method.rb"></a>
|
|
3312
|
+
<pre class="program">require 'erubis'
|
|
3313
|
+
s = "hello <%= name %>"
|
|
3314
|
+
eruby = Erubis::Eruby.new(s)
|
|
3315
|
+
filename = 'hello.rhtml'
|
|
3316
|
+
|
|
3317
|
+
## define instance method to Dummy class (or module)
|
|
3318
|
+
class Dummy; end
|
|
3319
|
+
<strong>eruby.def_method(Dummy, 'render(name)', filename)</strong> # filename is optional
|
|
3320
|
+
p Dummy.new.render('world') #=> "hello world"
|
|
3321
|
+
|
|
3322
|
+
## define singleton method to dummy object
|
|
3323
|
+
obj = Object.new
|
|
3324
|
+
<strong>eruby.def_method(obj, 'render(name)', filename)</strong> # filename is optional
|
|
3325
|
+
p obj.render('world') #=> "hello world"
|
|
3326
|
+
</pre>
|
|
3327
|
+
<br>
|
|
3328
|
+
|
|
3329
|
+
|
|
3330
|
+
<a name="topics-benchmark"></a>
|
|
3331
|
+
<h3 class="section2">Benchmark</h3>
|
|
3332
|
+
<p>A benchmark script is included in Erubis package at 'erubis-$Release$/benchark/' directory.
|
|
3333
|
+
Here is an example result of benchmark.
|
|
3334
|
+
</p>
|
|
3335
|
+
<div class="terminal_caption">
|
|
3336
|
+
MacOS X 10.4 Tiger, Intel CoreDuo 1.83GHz, Ruby1.8.6, eruby1.0.5, gcc4.0.1</div>
|
|
3337
|
+
<pre class="terminal">$ cd erubis-$Release$/benchmark/
|
|
3338
|
+
$ ruby bench.rb -n 10000 -m execute
|
|
3339
|
+
*** ntimes=10000, testmode=execute
|
|
3340
|
+
user system total real
|
|
3341
|
+
eruby 12.720000 0.240000 <strong>12.960000</strong> ( 12.971888)
|
|
3342
|
+
ERB 36.760000 0.350000 <strong>37.110000</strong> ( 37.112019)
|
|
3343
|
+
ERB(cached) 11.990000 0.440000 <strong>12.430000</strong> ( 12.430375)
|
|
3344
|
+
Erubis::Eruby 10.840000 0.300000 <strong>11.140000</strong> ( 11.144426)
|
|
3345
|
+
Erubis::Eruby(cached) 7.540000 0.410000 <strong>7.950000</strong> ( 7.969305)
|
|
3346
|
+
Erubis::FastEruby 10.440000 0.300000 <strong>10.740000</strong> ( 10.737808)
|
|
3347
|
+
Erubis::FastEruby(cached) 6.940000 0.410000 <strong>7.350000</strong> ( 7.353666)
|
|
3348
|
+
Erubis::TinyEruby 9.550000 0.290000 9.840000 ( 9.851729)
|
|
3349
|
+
Erubis::ArrayBufferEruby 11.010000 0.300000 11.310000 ( 11.314339)
|
|
3350
|
+
Erubis::PrintOutEruby 11.640000 0.290000 11.930000 ( 11.942141)
|
|
3351
|
+
Erubis::StdoutEruby 11.590000 0.300000 11.890000 ( 11.886512)
|
|
3352
|
+
</pre>
|
|
3353
|
+
<p>This shows that...
|
|
3354
|
+
</p>
|
|
3355
|
+
<ul type="disc">
|
|
3356
|
+
<li>Erubis::Eruby runs more than 10 percent faster than eruby.
|
|
3357
|
+
</li>
|
|
3358
|
+
<li>Erubis::Eruby runs about 3 times faster than ERB.
|
|
3359
|
+
</li>
|
|
3360
|
+
<li>Caching (by Erubis::Eruby.load_file()) makes Erubis about 40-50 percent faster.
|
|
3361
|
+
</li>
|
|
3362
|
+
<li>Erubis::FastEruby is a litte faster than Erubis::Eruby.
|
|
3363
|
+
</li>
|
|
3364
|
+
<li>Array buffer (ArrayBufferEnhancer) is a little slower than string buffer (StringBufferEnhancer which Erubis::Eruby includes)
|
|
3365
|
+
</li>
|
|
3366
|
+
<li>$stdout and print() make Erubis a little slower.
|
|
3367
|
+
</li>
|
|
3368
|
+
<li>Erubis::TinyEruby (at 'erubis/tiny.rb') is the fastest in all eRuby implementations when no caching.
|
|
3369
|
+
</li>
|
|
3370
|
+
</ul>
|
|
3371
|
+
<p>Escaping HTML characters (such as '< > & "') makes Erubis more faster than eruby and ERB,
|
|
3372
|
+
because Erubis::XmlHelper#escape_xml() works faster than CGI.escapeHTML() and ERB::Util#h().
|
|
3373
|
+
The following shows that Erubis runs more than 40 percent (when no-cached) or 90 percent (when cached) faster than eruby if HTML characters are escaped.
|
|
3374
|
+
</p>
|
|
3375
|
+
<div class="terminal_caption">
|
|
3376
|
+
When escaping HTML characters with option '-e'</div>
|
|
3377
|
+
<pre class="terminal">$ ruby bench.rb -n 10000 -m execute -ep
|
|
3378
|
+
*** ntimes=10000, testmode=execute
|
|
3379
|
+
user system total real
|
|
3380
|
+
eruby 21.700000 0.290000 <strong>21.990000</strong> ( 22.050687)
|
|
3381
|
+
ERB 45.140000 0.390000 <strong>45.530000</strong> ( 45.536976)
|
|
3382
|
+
ERB(cached) 20.340000 0.470000 <strong>20.810000</strong> ( 20.822653)
|
|
3383
|
+
Erubis::Eruby 14.830000 0.310000 <strong>15.140000</strong> ( 15.147930)
|
|
3384
|
+
Erubis::Eruby(cached) 11.090000 0.420000 <strong>11.510000</strong> ( 11.514954)
|
|
3385
|
+
Erubis::FastEruby 14.850000 0.310000 <strong>15.160000</strong> ( 15.172499)
|
|
3386
|
+
Erubis::FastEruby(cached) 10.970000 0.430000 <strong>11.400000</strong> ( 11.399605)
|
|
3387
|
+
Erubis::ArrayBufferEruby 14.970000 0.300000 15.270000 ( 15.281061)
|
|
3388
|
+
Erubis::PrintOutEruby 15.780000 0.300000 16.080000 ( 16.088289)
|
|
3389
|
+
Erubis::StdoutEruby 15.840000 0.310000 16.150000 ( 16.235338)
|
|
3390
|
+
</pre>
|
|
3391
|
+
<br>
|
|
3392
|
+
|
|
3393
|
+
|
|
3394
|
+
<br>
|
|
3395
|
+
|
|
3396
|
+
|
|
3397
|
+
<a name="command"></a>
|
|
3398
|
+
<h2 class="section1">Command Reference</h2>
|
|
3399
|
+
<a name="command-usage"></a>
|
|
3400
|
+
<h3 class="section2">Usage</h3>
|
|
3401
|
+
<p>erubis [..options..] [<em>file</em> ...]
|
|
3402
|
+
</p>
|
|
3403
|
+
<br>
|
|
3404
|
+
|
|
3405
|
+
|
|
3406
|
+
<a name="command-options"></a>
|
|
3407
|
+
<h3 class="section2">Options</h3>
|
|
3408
|
+
<dl class="dl3" compact>
|
|
3409
|
+
<dt class="dt3"><b>
|
|
3410
|
+
-h, --help </b></dt>
|
|
3411
|
+
<dd class="dd3">
|
|
3412
|
+
Help.
|
|
3413
|
+
</dd>
|
|
3414
|
+
<dt class="dt3"><b>
|
|
3415
|
+
-v </b></dt>
|
|
3416
|
+
<dd class="dd3">
|
|
3417
|
+
Release version.
|
|
3418
|
+
</dd>
|
|
3419
|
+
<dt class="dt3"><b>
|
|
3420
|
+
-x </b></dt>
|
|
3421
|
+
<dd class="dd3">
|
|
3422
|
+
Show compiled source.
|
|
3423
|
+
</dd>
|
|
3424
|
+
<dt class="dt3"><b>
|
|
3425
|
+
-X </b></dt>
|
|
3426
|
+
<dd class="dd3">
|
|
3427
|
+
Show compiled source but only Ruby code.
|
|
3428
|
+
This is equivarent to '-E NoText'.
|
|
3429
|
+
</dd>
|
|
3430
|
+
<dt class="dt3"><b>
|
|
3431
|
+
-N </b></dt>
|
|
3432
|
+
<dd class="dd3">
|
|
3433
|
+
Numbering: add line numbers. (for '-x/-X')
|
|
3434
|
+
</dd>
|
|
3435
|
+
<dt class="dt3"><b>
|
|
3436
|
+
-U </b></dt>
|
|
3437
|
+
<dd class="dd3">
|
|
3438
|
+
Unique mode: zip empty lines into a line. (for '-x/-X')
|
|
3439
|
+
</dd>
|
|
3440
|
+
<dt class="dt3"><b>
|
|
3441
|
+
-C </b></dt>
|
|
3442
|
+
<dd class="dd3">
|
|
3443
|
+
Compact: remove empty lines. (for '-x/-X')
|
|
3444
|
+
</dd>
|
|
3445
|
+
<dt class="dt3"><b>
|
|
3446
|
+
-b </b></dt>
|
|
3447
|
+
<dd class="dd3">
|
|
3448
|
+
Body only: no preamble nor postamble. (for '-x/-X')
|
|
3449
|
+
This is equivarent to '--preamble=false --postamble=false'.
|
|
3450
|
+
</dd>
|
|
3451
|
+
<dt class="dt3"><b>
|
|
3452
|
+
-z </b></dt>
|
|
3453
|
+
<dd class="dd3">
|
|
3454
|
+
Syntax checking.
|
|
3455
|
+
</dd>
|
|
3456
|
+
<dt class="dt3"><b>
|
|
3457
|
+
-e </b></dt>
|
|
3458
|
+
<dd class="dd3">
|
|
3459
|
+
Escape. This is equivarent to '-E Escape'.
|
|
3460
|
+
</dd>
|
|
3461
|
+
<dt class="dt3"><b>
|
|
3462
|
+
-p pattern </b></dt>
|
|
3463
|
+
<dd class="dd3">
|
|
3464
|
+
Embedded pattern (default '<% %>').
|
|
3465
|
+
This is equivarent to '--pattern=<em>pattern</em>'.
|
|
3466
|
+
</dd>
|
|
3467
|
+
<dt class="dt3"><b>
|
|
3468
|
+
-l lang </b></dt>
|
|
3469
|
+
<dd class="dd3">
|
|
3470
|
+
Language name.
|
|
3471
|
+
This option makes erubis command to compile script but no execute.
|
|
3472
|
+
</dd>
|
|
3473
|
+
<dt class="dt3"><b>
|
|
3474
|
+
-E enhacers </b></dt>
|
|
3475
|
+
<dd class="dd3">
|
|
3476
|
+
Enhancer name (Escape, PercentLine, ...).
|
|
3477
|
+
It is able to specify several enhancer name separating with ','
|
|
3478
|
+
(ex. -f Escape,PercentLine,HeaderFooter).
|
|
3479
|
+
</dd>
|
|
3480
|
+
<dt class="dt3"><b>
|
|
3481
|
+
-I path </b></dt>
|
|
3482
|
+
<dd class="dd3">
|
|
3483
|
+
Require library path ($:).
|
|
3484
|
+
It is able to specify several paths separating with ','
|
|
3485
|
+
(ex. -f path1,path2,path3).
|
|
3486
|
+
</dd>
|
|
3487
|
+
<dt class="dt3"><b>
|
|
3488
|
+
-K kanji </b></dt>
|
|
3489
|
+
<dd class="dd3">
|
|
3490
|
+
Kanji code (euc, sjis, utf8, or none) (default none).
|
|
3491
|
+
</dd>
|
|
3492
|
+
<dt class="dt3"><b>
|
|
3493
|
+
-f datafile </b></dt>
|
|
3494
|
+
<dd class="dd3">
|
|
3495
|
+
Context data file in YAML format ('*.yaml', '*.yml') or
|
|
3496
|
+
Ruby script ('*.rb').
|
|
3497
|
+
It is able to specify several filenames separating with ','
|
|
3498
|
+
(ex. -f file1,file2,file3).
|
|
3499
|
+
</dd>
|
|
3500
|
+
<dt class="dt3"><b>
|
|
3501
|
+
-c context </b></dt>
|
|
3502
|
+
<dd class="dd3">
|
|
3503
|
+
Context data string in YAML inline style or Ruby code.
|
|
3504
|
+
</dd>
|
|
3505
|
+
<dt class="dt3"><b>
|
|
3506
|
+
-T </b></dt>
|
|
3507
|
+
<dd class="dd3">
|
|
3508
|
+
Don't expand tab characters in YAML file.
|
|
3509
|
+
</dd>
|
|
3510
|
+
<dt class="dt3"><b>
|
|
3511
|
+
-S </b></dt>
|
|
3512
|
+
<dd class="dd3">
|
|
3513
|
+
Convert mapping key from string to symbol in YAML file.
|
|
3514
|
+
</dd>
|
|
3515
|
+
<dt class="dt3"><b>
|
|
3516
|
+
-B </b></dt>
|
|
3517
|
+
<dd class="dd3">
|
|
3518
|
+
invoke Eruby#result() instead of Eruby#evaluate()
|
|
3519
|
+
</dd>
|
|
3520
|
+
<dt class="dt3"><b>
|
|
3521
|
+
--pi[=name] </b></dt>
|
|
3522
|
+
<dd class="dd3">
|
|
3523
|
+
parse '<?name ... ?>' instead of '<% ... %>'
|
|
3524
|
+
</dd>
|
|
3525
|
+
<dt class="dt3"><b>
|
|
3526
|
+
--trim=false </b></dt>
|
|
3527
|
+
<dd class="dd3">
|
|
3528
|
+
No trimming spaces around '<% %>'.
|
|
3529
|
+
</dd>
|
|
3530
|
+
</dl>
|
|
3531
|
+
<br>
|
|
3532
|
+
|
|
3533
|
+
|
|
3534
|
+
<a name="command-props"></a>
|
|
3535
|
+
<h3 class="section2">Properties</h3>
|
|
3536
|
+
<p>Some Eruby classes can take optional properties to change it's compile option.
|
|
3537
|
+
For example, property '--indent=" "' may change indentation of compiled source code.
|
|
3538
|
+
Try 'erubis -h' for details.
|
|
3539
|
+
</p>
|
|
3540
|
+
<br>
|
|
3541
|
+
|
|
3542
|
+
|
|
3543
|
+
<br>
|
|
3544
|
+
|
|
3545
|
+
|
|
3546
|
+
|
|
3547
|
+
</div>
|
|
3548
|
+
</blockquote>
|
|
3549
|
+
|
|
3550
|
+
</body>
|
|
3551
|
+
</html>
|
