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
Public Class Methods
Source
# File lib/liquid/template.rb, line 42 def default_exception_renderer Environment.default.exception_renderer end
Source
# File lib/liquid/template.rb, line 37 def default_exception_renderer=(renderer) Deprecations.warn("Template.default_exception_renderer=", "Environment#exception_renderer=") Environment.default.exception_renderer = renderer end
Source
# File lib/liquid/template.rb, line 76 def default_resource_limits Environment.default.default_resource_limits end
Source
# File lib/liquid/template.rb, line 33 def error_mode Environment.default.error_mode end
Source
# File lib/liquid/template.rb, line 28 def error_mode=(mode) Deprecations.warn("Template.error_mode=", "Environment#error_mode=") Environment.default.error_mode = mode end
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.
Source
# File lib/liquid/template.rb, line 51 def file_system Environment.default.file_system end
Source
# File lib/liquid/template.rb, line 46 def file_system=(file_system) Deprecations.warn("Template.file_system=", "Environment#file_system=") Environment.default.file_system = file_system end
Source
# File lib/liquid/template.rb, line 89 def initialize(environment: Environment.default) @environment = environment @rethrow_errors = false @resource_limits = ResourceLimits.new(environment.default_resource_limits) end
Source
# File lib/liquid/template.rb, line 83 def parse(source, options = {}) environment = options[:environment] || Environment.default new(environment: environment).parse(source, options) end
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
Source
# File lib/liquid/template.rb, line 66 def register_filter(mod) Deprecations.warn("Template.register_filter", "Environment#register_filter") Environment.default.register_filter(mod) end
Pass a module with filter methods which should be available to all liquid views. Good for registering the standard library
Source
# File lib/liquid/template.rb, line 59 def register_tag(name, klass) Deprecations.warn("Template.register_tag", "Environment#register_tag") Environment.default.register_tag(name, klass) end
Private Class Methods
Source
# File lib/liquid/template.rb, line 71 def default_resource_limits=(limits) Deprecations.warn("Template.default_resource_limits=", "Environment#default_resource_limits=") Environment.default.default_resource_limits = limits end
Public Instance Methods
Source
# File lib/liquid/template.rb, line 118 def instance_assigns @instance_assigns ||= {} end
Source
# File lib/liquid/template.rb, line 97 def parse(source, options = {}) parse_context = configure_options(options) source = source.to_s.to_str unless source.valid_encoding? raise TemplateEncodingError, parse_context.locale.t("errors.syntax.invalid_template_encoding") end tokenizer = parse_context.new_tokenizer(source, start_line_number: @line_numbers && 1) @root = Document.parse(tokenizer, parse_context) self end
Parse source code. Returns self for easy chaining
Source
# File lib/liquid/template.rb, line 140 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, {}, @environment) when Hash Context.new([args.shift, assigns], instance_assigns, registers, @rethrow_errors, @resource_limits, {}, @environment) when nil Context.new(assigns, instance_assigns, registers, @rethrow_errors, @resource_limits, {}, @environment) else raise ArgumentError, "Expected Hash or Liquid::Context as parameter" end output = nil case args.last when Hash options = args.pop output = options[:output] if options[:output] static_registers = context.registers.static options[:registers]&.each do |key, register| static_registers[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 context.template_name ||= name 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
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
Source
# File lib/liquid/template.rb, line 199 def render!(*args) @rethrow_errors = true render(*args) end
Source
# File lib/liquid/template.rb, line 204 def render_to_output_buffer(context, output) render(context, output: output) end
Private Instance Methods
Source
# File lib/liquid/template.rb, line 229 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
Source
# File lib/liquid/template.rb, line 210 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 = if options.is_a?(ParseContext) options else opts = options.key?(:environment) ? options : options.merge(environment: @environment) ParseContext.new(opts) end @warnings = parse_context.warnings parse_context end