class Liquid::Template

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')

Attributes

default_exception_renderer[RW]
default_resource_limits[RW]
error_mode[RW]

Sets how strict the parser should be. :lax acts like liquid 2.5 and silently ignores malformed tags in most cases. :warn is the default and will give deprecation warnings when invalid syntax is used. :strict will enforce correct syntax.

file_system[RW]
tags[RW]
profiler[R]
resource_limits[R]
root[RW]
warnings[R]

Public Class Methods

new() click to toggle source
# File lib/liquid/template.rb, line 101
def initialize
  @rethrow_errors  = false
  @resource_limits = ResourceLimits.new(Template.default_resource_limits)
end
parse(source, options = {}) click to toggle source

creates a new Template object from liquid source code To enable profiling, pass in profile: true as an option. See Liquid::Profiler for more information

# File lib/liquid/template.rb, line 96
def parse(source, options = {})
  new.parse(source, options)
end
register_filter(mod) click to toggle source

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 85
def register_filter(mod)
  StrainerFactory.add_global_filter(mod)
end
register_tag(name, klass) click to toggle source
# File lib/liquid/template.rb, line 79
def register_tag(name, klass)
  tags[name.to_s] = klass
end

Public Instance Methods

assigns() click to toggle source
# File lib/liquid/template.rb, line 119
def assigns
  @assigns ||= {}
end
errors() click to toggle source
# File lib/liquid/template.rb, line 127
def errors
  @errors ||= []
end
instance_assigns() click to toggle source
# File lib/liquid/template.rb, line 123
def instance_assigns
  @instance_assigns ||= {}
end
parse(source, options = {}) click to toggle source

Parse source code. Returns self for easy chaining

# File lib/liquid/template.rb, line 108
def parse(source, options = {})
  parse_context = configure_options(options)
  tokenizer     = parse_context.new_tokenizer(source, start_line_number: @line_numbers && 1)
  @root         = Document.parse(tokenizer, parse_context)
  self
end
registers() click to toggle source
# File lib/liquid/template.rb, line 115
def registers
  @registers ||= {}
end
render(*args) click to toggle source

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

if profiling was enabled in Template#parse then the resulting profiling information will be available via Template#profiler

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 145
def render(*args)
  return '' if @root.nil?

  context = case args.first
  when Liquid::Context
    c = args.shift

    if @rethrow_errors
      c.exception_renderer = Liquid::RAISE_EXCEPTION_LAMBDA
    end

    c
  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, "Expected Hash or Liquid::Context as parameter"
  end

  output = nil

  context_register = context.registers.is_a?(StaticRegisters) ? context.registers.static : context.registers

  case args.last
  when Hash
    options = args.pop
    output  = options[:output] if options[:output]

    options[:registers]&.each do |key, register|
      context_register[key] = register
    end

    apply_options_to_context(context, options)
  when Module, Array
    context.add_filters(args.pop)
  end

  # Retrying a render resets resource usage
  context.resource_limits.reset

  if @profiling && context.profiler.nil?
    @profiler = context.profiler = Liquid::Profiler.new
  end

  begin
    # render the nodelist.
    @root.render_to_output_buffer(context, output || +'')
  rescue Liquid::MemoryError => e
    context.handle_error(e)
  ensure
    @errors = context.errors
  end
end
render!(*args) click to toggle source
# File lib/liquid/template.rb, line 203
def render!(*args)
  @rethrow_errors = true
  render(*args)
end
render_to_output_buffer(context, output) click to toggle source
# File lib/liquid/template.rb, line 208
def render_to_output_buffer(context, output)
  render(context, output: output)
end

Private Instance Methods

apply_options_to_context(context, options) click to toggle source
# File lib/liquid/template.rb, line 227
def apply_options_to_context(context, options)
  context.add_filters(options[:filters]) if options[:filters]
  context.global_filter      = options[:global_filter] if options[:global_filter]
  context.exception_renderer = options[:exception_renderer] if options[:exception_renderer]
  context.strict_variables   = options[:strict_variables] if options[:strict_variables]
  context.strict_filters     = options[:strict_filters] if options[:strict_filters]
end
configure_options(options) click to toggle source
# File lib/liquid/template.rb, line 214
def configure_options(options)
  if (profiling = options[:profile])
    raise "Profiler not loaded, require 'liquid/profiler' first" unless defined?(Liquid::Profiler)
  end

  @options      = options
  @profiling    = profiling
  @line_numbers = options[:line_numbers] || @profiling
  parse_context = options.is_a?(ParseContext) ? options : ParseContext.new(options)
  @warnings     = parse_context.warnings
  parse_context
end