1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
|
require 'erb'
module ActionView #:nodoc:
class ActionViewError < StandardError #:nodoc:
end
# Action View templates can be written in two ways. If the template file has a +.rhtml+ extension then it uses a mixture of ERb
# (included in Ruby) and HTML. If the template file has a +.rxml+ extension then Jim Weirich's Builder::XmlMarkup library is used.
#
# = ERb
#
# You trigger ERb by using embeddings such as <% %> and <%= %>. The difference is whether you want output or not. Consider the
# following loop for names:
#
# <b>Names of all the people</b>
# <% for person in @people %>
# Name: <%= person.name %><br/>
# <% end %>
#
# The loop is setup in regular embedding tags (<% %>) and the name is written using the output embedding tag (<%= %>). Note that this
# is not just a usage suggestion. Regular output functions like print or puts won't work with ERb templates. So this would be wrong:
#
# Hi, Mr. <% puts "Frodo" %>
#
# (If you absolutely must write from within a function, you can use the TextHelper#concat)
#
# == Using sub templates
#
# Using sub templates allows you to sidestep tedious replication and extract common display structures in shared templates. The
# classic example is the use of a header and footer (even though the Action Pack-way would be to use Layouts):
#
# <%= render "shared/header" %>
# Something really specific and terrific
# <%= render "shared/footer" %>
#
# As you see, we use the output embeddings for the render methods. The render call itself will just return a string holding the
# result of the rendering. The output embedding writes it to the current template.
#
# But you don't have to restrict yourself to static includes. Templates can share variables amongst themselves by using instance
# variables defined in using the regular embedding tags. Like this:
#
# <% @page_title = "A Wonderful Hello" %>
# <%= render "shared/header" %>
#
# Now the header can pick up on the @page_title variable and use it for outputting a title tag:
#
# <title><%= @page_title %></title>
#
# == Passing local variables to sub templates
#
# You can pass local variables to sub templates by using a hash with the variable names as keys and the objects as values:
#
# <%= render "shared/header", { "headline" => "Welcome", "person" => person } %>
#
# These can now be accessed in shared/header with:
#
# Headline: <%= headline %>
# First name: <%= person.first_name %>
#
# == Template caching
#
# The parsing of ERb templates are cached by default, but the reading of them are not. This means that the application by default
# will reflect changes to the templates immediatly. If you'd like to sacrifice that immediacy for the speed gain given by also
# caching the loading of templates (reading from the file system), you can turn that on with
# <tt>ActionView::Base.cache_template_loading = true</tt>.
#
# == Builder
#
# Builder templates are a more programmatic alternative to ERb. They are especially useful for generating XML content. An +XmlMarkup+ object
# named +xml+ is automatically made available to templates with a +.rxml+ extension.
#
# Here are some basic examples:
#
# xml.em("emphasized") # => <em>emphasized</em>
# xml.em { xml.b("emp & bold") } # => <em><b>emph & bold</b></em>
# xml.a("A Link", "href"=>"http://onestepback.org") # => <a href="http://onestepback.org">A Link</a>
# xm.target("name"=>"compile", "option"=>"fast") # => <target option="fast" name="compile"\>
# # NOTE: order of attributes is not specified.
#
# Any method with a block will be treated as an XML markup tag with nested markup in the block. For example, the following:
#
# xml.div {
# xml.h1(@person.name)
# xml.p(@person.bio)
# }
#
# would produce something like:
#
# <div>
# <h1>David Heinemeier Hansson</h1>
# <p>A product of Danish Design during the Winter of '79...</p>
# </div>
#
# A full-length RSS example actually used on Basecamp:
#
# xml.rss("version" => "2.0", "xmlns:dc" => "http://purl.org/dc/elements/1.1/") do
# xml.channel do
# xml.title(@feed_title)
# xml.link(@url)
# xml.description "Basecamp: Recent items"
# xml.language "en-us"
# xml.ttl "40"
#
# for item in @recent_items
# xml.item do
# xml.title(item_title(item))
# xml.description(item_description(item)) if item_description(item)
# xml.pubDate(item_pubDate(item))
# xml.guid(@person.firm.account.url + @recent_items.url(item))
# xml.link(@person.firm.account.url + @recent_items.url(item))
#
# xml.tag!("dc:creator", item.author_name) if item_has_creator?(item)
# end
# end
# end
# end
#
# More builder documentation can be found at http://builder.rubyforge.org.
class Base
include ERB::Util
attr_reader :first_render
attr_accessor :base_path, :assigns, :template_extension
attr_accessor :controller
attr_reader :logger, :params, :response, :session, :headers, :flash
# Turn on to cache the reading of templates from the file system.
# Doing so means that you have to restart the server when changing
# templates, but it will save checking whether the file has changed
# on disk.
@@cache_template_loading = false
cattr_accessor :cache_template_loading
# Specify trim mode for the ERB compiler. Defaults to '-'.
# See ERB documentation for suitable values.
@@erb_trim_mode = '-'
cattr_accessor :erb_trim_mode
@@compiled_templates = {}
@@template_count = 0
@@loaded_templates = {}
@@template_handlers = {}
def self.load_helpers(helper_dir)#:nodoc:
Dir.foreach(helper_dir) do |helper_file|
next unless helper_file =~ /_helper.rb$/
require helper_dir + helper_file
helper_module_name = helper_file.capitalize.gsub(/_([a-z])/) { |m| $1.capitalize }[0..-4]
class_eval("include ActionView::Helpers::#{helper_module_name}") if Helpers.const_defined?(helper_module_name)
end
end
def self.register_template_handler(extension, klass)
@@template_handlers[extension] = klass
end
def initialize(base_path = nil, assigns_for_first_render = {}, controller = nil)#:nodoc:
@base_path, @assigns = base_path, assigns_for_first_render
@assigns_added = nil
@controller = controller
@logger = controller && controller.logger
end
# Renders the template present at <tt>template_path</tt>. If <tt>use_full_path</tt> is set to true,
# it's relative to the template_root, otherwise it's absolute. The hash in <tt>local_assigns</tt>
# is made available as local variables.
def render_file(template_path, use_full_path = true, local_assigns = {})
@first_render = template_path if @first_render.nil?
if use_full_path
template_extension = pick_template_extension(template_path)
template_file_name = full_template_path(template_path, template_extension)
else
template_file_name = template_path
template_extension = template_path.split('.').last
end
template_source = read_template_file(template_file_name, template_extension)
begin
render_template(template_extension, template_source, template_file_name, local_assigns)
rescue Exception => e
if TemplateError === e
e.sub_template_of(template_file_name)
raise e
else
raise TemplateError.new(@base_path, template_file_name, @assigns, template_source, e)
end
end
end
# Renders the template present at <tt>template_path</tt> (relative to the template_root).
# The hash in <tt>local_assigns</tt> is made available as local variables.
def render(options = {}, old_local_assigns = {})
if options.is_a?(String)
render_file(options, true, old_local_assigns)
elsif options.is_a?(Hash)
options[:locals] ||= {}
options[:use_full_path] = options[:use_full_path].nil? ? true : options[:use_full_path]
if options[:file]
render_file(options[:file], options[:use_full_path], options[:locals])
elsif options[:partial] && options[:collection]
render_partial_collection(options[:partial], options[:collection], options[:spacer_template], options[:locals])
elsif options[:partial]
render_partial(options[:partial], options[:object], options[:locals])
elsif options[:inline]
render_template(options[:type] || :rhtml, options[:inline], nil, options[:locals] || {})
end
end
end
# Renders the +template+ which is given as a string as either rhtml or rxml depending on <tt>template_extension</tt>.
# The hash in <tt>local_assigns</tt> is made available as local variables.
def render_template(template_extension, template, file_name = nil, local_assigns = {})
if handler = @@template_handlers[template_extension]
delegate_render(handler, template, local_assigns)
elsif template_extension == 'rxml'
rxml_render(template_extension, template, file_name, local_assigns)
else
rhtml_render(template_extension, template, file_name, local_assigns)
end
end
def pick_template_extension(template_path)#:nodoc:
if match = delegate_template_exists?(template_path)
match.first
elsif erb_template_exists?(template_path)
'rhtml'
elsif builder_template_exists?(template_path)
'rxml'
else
raise ActionViewError, "No rhtml, rxml, or delegate template found for #{template_path}"
end
end
def delegate_template_exists?(template_path)#:nodoc:
@@template_handlers.find { |k,| template_exists?(template_path, k) }
end
def erb_template_exists?(template_path)#:nodoc:
template_exists?(template_path, 'rhtml')
end
def builder_template_exists?(template_path)#:nodoc:
template_exists?(template_path, 'rxml')
end
def file_exists?(template_path)#:nodoc:
erb_template_exists?(template_path) || builder_template_exists?(template_path) || delegate_template_exists?(template_path)
end
# Returns true is the file may be rendered implicitly.
def file_public?(template_path)#:nodoc:
template_path.split('/').last[0,1] != '_'
end
private
def full_template_path(template_path, extension)
"#{@base_path}/#{template_path}.#{extension}"
end
def template_exists?(template_path, extension)
fp = full_template_path(template_path, extension)
(@@cache_template_loading && @@loaded_templates.has_key?(fp)) || FileTest.exists?(fp)
end
def read_template_file(template_path, extension)
info = @@loaded_templates[template_path]
# info is either the template source code, or the its compile time, or nil
# if nil, we need to read it from the file system
# if it is a time, we need to reread it if it has changed on disk
# if @@cache_template_loading is true, we will never reread
unless read_file = info.nil?
read_file = !@@cache_template_loading && info.is_a?(Time) && info < File.stat(template_path).mtime
end
if read_file
info = @@loaded_templates[template_path] = File.read(template_path)
@@compiled_templates[template_path] = nil
end
info
end
def evaluate_assigns(local_assigns = {})
unless @assigns_added
@assigns.each { |key, value| instance_variable_set("@#{key}", value) }
@assigns_added = true
end
saved_locals = {}
local_assigns.each do |key, value|
varstr = "@_#{key}_"
saved_locals[varstr] = instance_variable_get(varstr)
instance_variable_set(varstr, value)
unless self.respond_to?(key)
self.class.class_eval("def #{key}; #{varstr}; end")
self.class.class_eval("def #{key}=(v); #{varstr} = v; end")
end
end
saved_locals
end
def compile_template(extension, template, file_name)
cache_name = file_name || template
unless @@compiled_templates[cache_name]
case extension
when :rhtml
t_name = 'run_html_'
t_arg = ''
t_code = ERB.new(template, nil, @@erb_trim_mode).src
when :rxml
t_name = 'run_xml_'
t_arg = '(xml)'
t_code = template
end
if file_name
i = file_name.index(@base_path)
l = @base_path.length
s_file_name = i ? file_name[i+l+1,file_name.length-l-1] : file_name
s_file_name.sub!(/(.rhtml|.rxml)$/,'')
s_file_name.tr!('/:-', '_')
s_file_name.gsub!(/[^a-zA-Z0-9_]/){|s| s[0].to_s}
t_name += s_file_name
else
@@template_count += 1
t_name += @@template_count.to_s
end
t_def = "def #{t_name}#{t_arg}; #{t_code}; end"
self.class.class_eval(t_def) rescue raise ActionViewError, "ERROR defining #{t_name}: #{t_def}"
@@compiled_templates[cache_name] = t_name.intern
@@loaded_templates[cache_name] = Time.now if file_name
logger.debug "Compiled template #{cache_name}\n ==> #{t_name}" if logger
end
@@compiled_templates[cache_name]
end
def rhtml_render(extension, template, file_name, local_assigns)
render_sym = compile_template(:rhtml, template, file_name)
saved_locals = evaluate_assigns(local_assigns)
result = self.send(render_sym)
saved_locals.each { |k,v| instance_variable_set(k, v) }
result
end
def rxml_render(extension, template, file_name, local_assigns)
@controller.headers["Content-Type"] ||= 'text/xml'
render_sym = compile_template(:rxml, template, file_name)
saved_locals = evaluate_assigns(local_assigns)
result = self.send(render_sym, Builder::XmlMarkup.new(:indent => 2))
saved_locals.each { |k,v| instance_variable_set(k, v) }
result
end
def delegate_render(handler, template, local_assigns)
handler.new(self).render(template, local_assigns)
end
def assign_variables_from_controller
@assigns.each { |key, value| instance_variable_set("@#{key}", value) }
end
end
end
require 'action_view/template_error'
|