class Liquid::Include

Include allows templates to relate with other templates

Simply include another template:

{% include 'product' %}

Include a template with a local variable:

{% include 'product' with products[0] %}

Include a template for a collection:

{% include 'product' for products %}

Constants

Syntax

Public Class Methods

new(tag_name, markup, tokens) click to toggle source
Calls superclass method Liquid::Tag.new
# File lib/liquid/tags/include.rb, line 20
def initialize(tag_name, markup, tokens)
  if markup =~ Syntax

    @template_name = $1
    @variable_name = $3
    @attributes    = {}

    markup.scan(TagAttributes) do |key, value|
      @attributes[key] = value
    end

  else
    raise SyntaxError.new("Error in tag 'include' - Valid syntax: include '[template]' (with|for) [object|collection]")
  end

  super
end

Public Instance Methods

parse(tokens) click to toggle source
# File lib/liquid/tags/include.rb, line 38
def parse(tokens)
end
render(context) click to toggle source
# File lib/liquid/tags/include.rb, line 41
def render(context)
  partial = load_cached_partial(context)
  variable = context[@variable_name || @template_name[1..-2]]

  context.stack do
    @attributes.each do |key, value|
      context[key] = context[value]
    end

    if variable.is_a?(Array)
      variable.collect do |var|
        context[@template_name[1..-2]] = var
        partial.render(context)
      end
    else
      context[@template_name[1..-2]] = variable
      partial.render(context)
    end
  end
end

Private Instance Methods

load_cached_partial(context) click to toggle source
# File lib/liquid/tags/include.rb, line 63
def load_cached_partial(context)
  cached_partials = context.registers[:cached_partials] || {}
  template_name = context[@template_name]

  if cached = cached_partials[template_name]
    return cached
  end
  source = read_template_from_file_system(context)
  partial = Liquid::Template.parse(source)
  cached_partials[template_name] = partial
  context.registers[:cached_partials] = cached_partials
  partial
end
read_template_from_file_system(context) click to toggle source
# File lib/liquid/tags/include.rb, line 77
def read_template_from_file_system(context)
  file_system = context.registers[:file_system] || Liquid::Template.file_system

  # make read_template_file call backwards-compatible.
  case file_system.method(:read_template_file).arity
  when 1
    file_system.read_template_file(context[@template_name])
  when 2
    file_system.read_template_file(context[@template_name], context)
  else
    raise ArgumentError, "file_system.read_template_file expects two parameters: (template_name, context)"
  end
end