Class: Liquid::Template

Inherits:
Object
  • Object
show all
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')

Defined Under Namespace

Classes: TagRegistry

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Template

Returns a new instance of Template.



101
102
103
104
 
# File 'lib/liquid/template.rb', line 101

def initialize
  @rethrow_errors  = false
  @resource_limits = ResourceLimits.new(Template.default_resource_limits)
end

Class Attribute Details

.default_exception_renderer ⇒ Object

Returns the value of attribute default_exception_renderer.



67
68
69
 
# File 'lib/liquid/template.rb', line 67

def default_exception_renderer
  @default_exception_renderer
end

.default_resource_limits ⇒ Object

Returns the value of attribute default_resource_limits.



89
90
91
 
# File 'lib/liquid/template.rb', line 89

def default_resource_limits
  @default_resource_limits
end

.error_mode ⇒ Object

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.



64
65
66
 
# File 'lib/liquid/template.rb', line 64

def error_mode
  @error_mode
end

.file_system ⇒ Object

Returns the value of attribute file_system.



72
73
74
 
# File 'lib/liquid/template.rb', line 72

def file_system
  @file_system
end

.tags ⇒ Object

Returns the value of attribute tags.



75
76
77
 
# File 'lib/liquid/template.rb', line 75

def tags
  @tags
end

Instance Attribute Details

#name ⇒ Object

Returns the value of attribute name.



18
19
20
 
# File 'lib/liquid/template.rb', line 18

def name
  @name
end

#profiler ⇒ Object (readonly)

Returns the value of attribute profiler.



57
58
59
 
# File 'lib/liquid/template.rb', line 57

def profiler
  @profiler
end

#resource_limits ⇒ Object (readonly)

Returns the value of attribute resource_limits.



19
20
21
 
# File 'lib/liquid/template.rb', line 19

def resource_limits
  @resource_limits
end

#root ⇒ Object

Returns the value of attribute root.



18
19
20
 
# File 'lib/liquid/template.rb', line 18

def root
  @root
end

#warnings ⇒ Object (readonly)

Returns the value of attribute warnings.



19
20
21
 
# File 'lib/liquid/template.rb', line 19

def warnings
  @warnings
end

Class Method Details

.parse(source, options = {}) ⇒ Object

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



96
97
98
 
# File 'lib/liquid/template.rb', line 96

def parse(source, options = {})
  new.parse(source, options)
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



85
86
87
 
# File 'lib/liquid/template.rb', line 85

def register_filter(mod)
  StrainerFactory.add_global_filter(mod)
end

.register_tag(name, klass) ⇒ Object 



79
80
81
 
# File 'lib/liquid/template.rb', line 79

def register_tag(name, klass)
  tags[name.to_s] = klass
end

Instance Method Details

#assigns ⇒ Object 



125
126
127
 
# File 'lib/liquid/template.rb', line 125

def assigns
  @assigns ||= {}
end

#errors ⇒ Object 



133
134
135
 
# File 'lib/liquid/template.rb', line 133

def errors
  @errors ||= []
end

#instance_assigns ⇒ Object 



129
130
131
 
# File 'lib/liquid/template.rb', line 129

def instance_assigns
  @instance_assigns ||= {}
end

#parse(source, options = {}) ⇒ Object

Parse source code. Returns self for easy chaining



108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/liquid/template.rb', line 108

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

#registers ⇒ Object 



121
122
123
 
# File 'lib/liquid/template.rb', line 121

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

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



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
 
# File 'lib/liquid/template.rb', line 151

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

  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!(*args) ⇒ Object 



210
211
212
213
 
# File 'lib/liquid/template.rb', line 210

def render!(*args)
  @rethrow_errors = true
  render(*args)
end

#render_to_output_buffer(context, output) ⇒ Object 



215
216
217
 
# File 'lib/liquid/template.rb', line 215

def render_to_output_buffer(context, output)
  render(context, output: output)
end