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

Constant Summary

@@file_system =
BlankFileSystem.new

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeTemplate



109
110
111
# File 'lib/liquid/template.rb', line 109

def initialize
  @resource_limits = ResourceLimits.new(self.class.default_resource_limits)
end

Class Attribute Details

.error_modeObject



82
83
84
# File 'lib/liquid/template.rb', line 82

def error_mode
  @error_mode || :lax
end

.taint_modeObject



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

def taint_mode
  @taint_mode || :lax
end

Instance Attribute Details

#profilerObject (readonly)

Returns the value of attribute profiler



51
52
53
# File 'lib/liquid/template.rb', line 51

def profiler
  @profiler
end

#resource_limitsObject (readonly)

Returns the value of attribute resource_limits



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

def resource_limits
  @resource_limits
end

#rootObject

Returns the value of attribute root



16
17
18
# File 'lib/liquid/template.rb', line 16

def root
  @root
end

#warningsObject (readonly)

Returns the value of attribute warnings



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

def warnings
  @warnings
end

Class Method Details

.default_resource_limitsObject



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

def default_resource_limits
  @default_resource_limits ||= {}
end

.file_systemObject



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

def file_system
  @@file_system
end

.file_system=(obj) ⇒ Object



70
71
72
# File 'lib/liquid/template.rb', line 70

def file_system=(obj)
  @@file_system = obj
end

.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



103
104
105
106
# File 'lib/liquid/template.rb', line 103

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



92
93
94
# File 'lib/liquid/template.rb', line 92

def register_filter(mod)
  Strainer.global_filter(mod)
end

.register_tag(name, klass) ⇒ Object



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

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

.tagsObject



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

def tags
  @tags ||= TagRegistry.new
end

Instance Method Details

#assignsObject



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

def assigns
  @assigns ||= {}
end

#errorsObject



137
138
139
# File 'lib/liquid/template.rb', line 137

def errors
  @errors ||= []
end

#instance_assignsObject



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

def instance_assigns
  @instance_assigns ||= {}
end

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

Parse source code. Returns self for easy chaining



115
116
117
118
119
120
121
122
123
# File 'lib/liquid/template.rb', line 115

def parse(source, options = {})
  @options = options
  @profiling = options[:profile]
  @line_numbers = options[:line_numbers] || @profiling
  parse_context = options.is_a?(ParseContext) ? options : ParseContext.new(options)
  @root = Document.parse(tokenize(source), parse_context)
  @warnings = parse_context.warnings
  self
end

#registersObject



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

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


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

def render(*args)
  return ''.freeze if @root.nil?

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

    if @rethrow_errors
      c.exception_handler = ->(e) { raise }
    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

  case args.last
  when Hash
    options = args.pop

    registers.merge!(options[:registers]) if options[:registers].is_a?(Hash)

    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

  begin
    # render the nodelist.
    # for performance reasons we get an array back here. join will make a string out of it.
    result = with_profiling(context) do
      @root.render(context)
    end
    result.respond_to?(:join) ? result.join : result
  rescue Liquid::MemoryError => e
    context.handle_error(e)
  ensure
    @errors = context.errors
  end
end

#render!(*args) ⇒ Object



206
207
208
209
# File 'lib/liquid/template.rb', line 206

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