Repository navigation
Expand file tree
/
Copy pathmustache.rb
More file actions
299 lines (262 loc) · 8.37 KB
/
Copy pathmustache.rb
File metadata and controls
299 lines (262 loc) · 8.37 KB
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
require 'mustache/template'
require 'mustache/context'
# Mustache is the base class from which your Mustache subclasses
# should inherit (though it can be used on its own).
#
# The typical Mustache workflow is as follows:
#
# * Create a Mustache subclass: class Stats < Mustache
# * Create a template: stats.mustache
# * Instantiate an instance: view = Stats.new
# * Render that instance: view.render
#
# You can skip the instantiation by calling `Stats.render` directly.
#
# While Mustache will do its best to load and render a template for
# you, this process is completely customizable using a few options.
#
# All settings can be overriden at the class level.
#
# For example, going with the above example, we can use
# `Stats.template_path = "/usr/local/templates"` to specify the path
# Mustache uses to find templates.
#
# Here are the available options:
#
# * template_path
#
# The `template_path` setting determines the path Mustache uses when
# looking for a template. By default it is "."
# Setting it to /usr/local/templates, for example, means (given all
# other settings are default) a Mustache subclass `Stats` will try to
# load /usr/local/templates/stats.mustache
#
# * template_extension
#
# The `template_extension` is the extension Mustache uses when looking
# for template files. By default it is "mustache"
#
# * template_file
#
# You can tell Mustache exactly which template to us with this
# setting. It can be a relative or absolute path.
#
# * template
#
# Sometimes you want Mustache to render a string, not a file. In those
# cases you may set the `template` setting. For example:
#
# >> Mustache.render("Hello {{planet}}", :planet => "World!")
# => "Hello World!"
#
# The `template` setting is also available on instances.
#
# view = Mustache.new
# view.template = "Hi, {{person}}!"
# view[:person] = 'Mom'
# view.render # => Hi, mom!
#
# * view_namespace
#
# To make life easy on those developing Mustache plugins for web frameworks or
# other libraries, Mustache will attempt to load view classes (i.e. Mustache
# subclasses) using the `view_class` class method. The `view_namespace` tells
# Mustache under which constant view classes live. By default it is `Object`.
#
# * view_path
#
# Similar to `template_path`, the `view_path` option tells Mustache where to look
# for files containing view classes when using the `view_class` method.
#
class Mustache
# Helper method for quickly instantiating and rendering a view.
def self.render(*args)
new.render(*args)
end
# Alias for `render`
def self.to_html(*args)
render(*args)
end
# Alias for `render`
def self.to_text(*args)
render(*args)
end
# The template path informs your Mustache subclass where to look for its
# corresponding template. By default it's the current directory (".")
def self.template_path
@template_path ||= '.'
end
def self.template_path=(path)
@template_path = File.expand_path(path)
@template = nil
end
# Alias for `template_path`
def self.path
template_path
end
# Alias for `template_path`
def self.path=(path)
self.template_path = path
end
# A Mustache template's default extension is 'mustache'
def self.template_extension
@template_extension ||= 'mustache'
end
def self.template_extension=(template_extension)
@template_extension = template_extension
@template = nil
end
# The template file is the absolute path of the file Mustache will
# use as its template. By default it's ./class_name.mustache
def self.template_file
@template_file || "#{path}/#{underscore}.#{template_extension}"
end
def self.template_file=(template_file)
@template_file = template_file
@template = nil
end
# The template is the actual string Mustache uses as its template.
# There is a bit of magic here: what we get back is actually a
# Mustache::Template object here, but you can still safely use
# `template=` with a string.
def self.template
@template ||= templateify(File.read(template_file))
end
def self.template=(template)
@template = templateify(template)
end
# The constant under which Mustache will look for views. By default it's
# `Object`, but it might be nice to set it to something like `Hurl::Views` if
# your app's main namespace is `Hurl`.
def self.view_namespace
@view_namespace || Object
end
def self.view_namespace=(namespace)
@view_namespace = namespace
end
# Mustache searches the view path for .rb files to require when asked to find a
# view class. Defaults to "."
def self.view_path
@view_path ||= '.'
end
def self.view_path=(path)
@view_path = path
end
# When given a symbol or string representing a class, will try to produce an
# appropriate view class.
# e.g.
# Mustache.view_namespace = Hurl::Views
# Mustache.view_class(:Partial) # => Hurl::Views::Partial
def self.view_class(name)
if name != classify(name.to_s)
name = classify(name.to_s)
end
# Emptiness begets emptiness.
if name.to_s == ''
return Mustache
end
file_name = underscore(name)
namespace = view_namespace
if namespace.const_defined?(:Views) && namespace::Views.const_defined?(name)
namespace::Views.const_get(name)
elsif namespace.const_defined?(name)
namespace.const_get(name)
elsif File.exists?(file = "#{view_path}/#{file_name}.rb")
require "#{file}".chomp('.rb')
if namespace.const_defined?(:Views)
namespace::Views.const_get(name)
else
namespace.const_get(name)
end
else
Mustache
end
rescue NameError
Mustache
end
# Should an exception be raised when we cannot find a corresponding method
# or key in the current context? By default this is false to emulate ctemplate's
# behavior, but it may be useful to enable when debugging or developing.
#
# If set to true and there is a context miss, `Mustache::ContextMiss` will
# be raised.
def self.raise_on_context_miss?
@raise_on_context_miss
end
def self.raise_on_context_miss=(boolean)
@raise_on_context_miss = boolean
end
# Has this template already been compiled? Compilation is somewhat
# expensive so it may be useful to check this before attempting it.
def self.compiled?
@template.is_a? Template
end
# Has this instance or its class already compiled a template?
def compiled?
(@template && @template.is_a?(Template)) || self.class.compiled?
end
# template_partial => TemplatePartial
def self.classify(underscored)
underscored.split(/[-_]/).map do |part|
part[0] = part[0].chr.upcase; part
end.join
end
# TemplatePartial => template_partial
# Takes a string but defaults to using the current class' name.
def self.underscore(classified = name)
classified = name if classified.to_s.empty?
classified = superclass.name if classified.to_s.empty?
string = classified.dup.split('::').last
string[0] = string[0].chr.downcase
string.gsub(/[A-Z]/) { |s| "_#{s.downcase}"}
end
# Turns a string into a Mustache::Template. If passed a Template,
# returns it.
def self.templateify(obj)
if obj.is_a?(Template)
obj
else
Template.new(obj.to_s, template_path, template_extension)
end
end
def templateify(obj)
self.class.templateify(obj)
end
# The template can be set at the instance level.
def template
@template ||= self.class.template
end
def template=(template)
@template = templateify(template)
end
# Instance level version of `Mustache.raise_on_context_miss?`
def raise_on_context_miss?
self.class.raise_on_context_miss? || @raise_on_context_miss
end
attr_writer :raise_on_context_miss
# A helper method which gives access to the context at a given time.
# Kind of a hack for now, but useful when you're in an iterating section
# and want access to the hash currently being iterated over.
def context
@context ||= Context.new(self)
end
# Context accessors.
#
# view = Mustache.new
# view[:name] = "Jon"
# view.template = "Hi, {{name}}!"
# view.render # => "Hi, Jon!"
def [](key)
context[key.to_sym]
end
def []=(key, value)
context[key.to_sym] = value
end
# Parses our fancy pants template file and returns normal file with
# all special {{tags}} and {{#sections}}replaced{{/sections}}.
def render(data = template, ctx = {})
templateify(data).render(context.update(ctx))
end
alias_method :to_html, :render
alias_method :to_text, :render
end