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')
# File lib/liquid/template.rb, line 21 def file_system @@file_system end
# File lib/liquid/template.rb, line 25 def file_system=(obj) @@file_system = obj end
creates a new Template
from an array of tokens. Use
Template.parse
instead
# File lib/liquid/template.rb, line 52 def initialize end
creates a new Template
object from liquid source code
# File lib/liquid/template.rb, line 44 def parse(source) template = Template.new template.parse(source) template end
Pass a module with filter methods which should be available to all liquid views. Good for registering the standard library
# File lib/liquid/template.rb, line 39 def register_filter(mod) Strainer.global_filter(mod) end
# File lib/liquid/template.rb, line 29 def register_tag(name, klass) tags[name.to_s] = klass end
# File lib/liquid/template.rb, line 66 def assigns @assigns ||= {} end
# File lib/liquid/template.rb, line 74 def errors @errors ||= [] end
# File lib/liquid/template.rb, line 70 def instance_assigns @instance_assigns ||= {} end
Parse source code. Returns self for easy chaining
# File lib/liquid/template.rb, line 57 def parse(source) @root = Document.new(tokenize(source)) self end
# File lib/liquid/template.rb, line 62 def registers @registers ||= {} end
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
# File lib/liquid/template.rb, line 89 def render(*args) return '' if @root.nil? context = case args.first when Liquid::Context args.shift when Hash Context.new([args.shift, assigns], instance_assigns, registers, @rethrow_errors) when nil Context.new(assigns, instance_assigns, registers, @rethrow_errors) else raise ArgumentError, "Expect Hash or Liquid::Context as parameter" end case args.last when Hash options = args.pop if options[:registers].is_a?(Hash) self.registers.merge!(options[:registers]) end if options[:filters] context.add_filters(options[: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 a array back here. join will make a string out of it result = @root.render(context) result.respond_to?(:join) ? result.join : result ensure @errors = context.errors end end
# File lib/liquid/template.rb, line 131 def render!(*args) @rethrow_errors = true; render(*args) end