Class: Liquid::Template
- Inherits:
-
Object
- Object
- Liquid::Template
- Defined in:
- lib/liquid/template.rb
Overview
Templates are central to liquid. Interpretating templates is a two step process. First you compile the source code you got. During compile time some extensive error checking is performed. your code should expect to get some SyntaxErrors.
After you have a compiled template you can then render
it. You can use a compiled template over and over again and keep it cached.
Example:
template = Liquid::Template.parse(source)
template.render('user_name' => 'bob')
Constant Summary collapse
- @@file_system =
BlankFileSystem.new
Instance Attribute Summary collapse
-
#resource_limits ⇒ Object
Returns the value of attribute resource_limits.
-
#root ⇒ Object
Returns the value of attribute root.
Class Method Summary collapse
- .file_system ⇒ Object
- .file_system=(obj) ⇒ Object
-
.parse(source) ⇒ Object
creates a new
Template
object from liquid source code. -
.register_filter(mod) ⇒ Object
Pass a module with filter methods which should be available to all liquid views.
- .register_tag(name, klass) ⇒ Object
- .tags ⇒ Object
Instance Method Summary collapse
- #assigns ⇒ Object
- #errors ⇒ Object
-
#initialize ⇒ Template
constructor
creates a new
Template
from an array of tokens. - #instance_assigns ⇒ Object
-
#parse(source) ⇒ Object
Parse source code.
- #registers ⇒ Object
-
#render(*args) ⇒ Object
Render takes a hash with local variables.
- #render!(*args) ⇒ Object
Constructor Details
#initialize ⇒ Template
creates a new Template
from an array of tokens. Use Template.parse
instead
52 53 54 |
# File 'lib/liquid/template.rb', line 52 def initialize @resource_limits = {} end |
Instance Attribute Details
#resource_limits ⇒ Object
Returns the value of attribute resource_limits.
17 18 19 |
# File 'lib/liquid/template.rb', line 17 def resource_limits @resource_limits end |
#root ⇒ Object
Returns the value of attribute root.
17 18 19 |
# File 'lib/liquid/template.rb', line 17 def root @root end |
Class Method Details
.file_system ⇒ Object
21 22 23 |
# File 'lib/liquid/template.rb', line 21 def file_system @@file_system end |
.file_system=(obj) ⇒ Object
25 26 27 |
# File 'lib/liquid/template.rb', line 25 def file_system=(obj) @@file_system = obj end |
.parse(source) ⇒ Object
creates a new Template
object from liquid source code
44 45 46 47 48 |
# File 'lib/liquid/template.rb', line 44 def parse(source) template = Template.new template.parse(source) template end |
.register_filter(mod) ⇒ Object
Pass a module with filter methods which should be available to all liquid views. Good for registering the standard library
39 40 41 |
# File 'lib/liquid/template.rb', line 39 def register_filter(mod) Strainer.global_filter(mod) end |
.register_tag(name, klass) ⇒ Object
29 30 31 |
# File 'lib/liquid/template.rb', line 29 def register_tag(name, klass) [name.to_s] = klass end |
.tags ⇒ Object
33 34 35 |
# File 'lib/liquid/template.rb', line 33 def @tags ||= {} end |
Instance Method Details
#assigns ⇒ Object
67 68 69 |
# File 'lib/liquid/template.rb', line 67 def assigns @assigns ||= {} end |
#errors ⇒ Object
75 76 77 |
# File 'lib/liquid/template.rb', line 75 def errors @errors ||= [] end |
#instance_assigns ⇒ Object
71 72 73 |
# File 'lib/liquid/template.rb', line 71 def instance_assigns @instance_assigns ||= {} end |
#parse(source) ⇒ Object
Parse source code. Returns self for easy chaining
58 59 60 61 |
# File 'lib/liquid/template.rb', line 58 def parse(source) @root = Document.new(tokenize(source)) self end |
#registers ⇒ Object
63 64 65 |
# File 'lib/liquid/template.rb', line 63 def registers @registers ||= {} end |
#render(*args) ⇒ Object
Render takes a hash with local variables.
if you use the same filters over and over again consider registering them globally with Template.register_filter
Following options can be passed:
* <tt>filters</tt> : array with local filters
* <tt>registers</tt> : hash with register variables. Those can be accessed from
filters and tags and might be useful to integrate liquid more with its host application
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 |
# File 'lib/liquid/template.rb', line 90 def render(*args) return '' if @root.nil? context = case args.first when Liquid::Context args.shift when Liquid::Drop drop = args.shift drop.context = Context.new([drop, assigns], instance_assigns, registers, @rethrow_errors, @resource_limits) when Hash Context.new([args.shift, assigns], instance_assigns, registers, @rethrow_errors, @resource_limits) when nil Context.new(assigns, instance_assigns, registers, @rethrow_errors, @resource_limits) else raise ArgumentError, "Expect Hash or Liquid::Context as parameter" end case args.last when Hash = args.pop if [:registers].is_a?(Hash) self.registers.merge!([:registers]) end if [:filters] context.add_filters([:filters]) end when Module context.add_filters(args.pop) when Array context.add_filters(args.pop) end begin # render the nodelist. # for performance reasons we get an array back here. join will make a string out of it. result = @root.render(context) result.respond_to?(:join) ? result.join : result rescue Liquid::MemoryError => e context.handle_error(e) ensure @errors = context.errors end end |
#render!(*args) ⇒ Object
137 138 139 |
# File 'lib/liquid/template.rb', line 137 def render!(*args) @rethrow_errors = true; render(*args) end |