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
Syntax

Attributes

attributes[R]
template_name_expr[R]
variable_name_expr[R]

Public Class Methods

new(tag_name, markup, options) click to toggle source
Calls superclass method Liquid::Tag::new
# File lib/liquid/tags/include.rb, line 26
def initialize(tag_name, markup, options)
  super

  if markup =~ SYNTAX

    template_name = Regexp.last_match(1)
    variable_name = Regexp.last_match(3)

    @alias_name         = Regexp.last_match(5)
    @variable_name_expr = variable_name ? parse_expression(variable_name) : nil
    @template_name_expr = parse_expression(template_name)
    @attributes         = {}

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

  else
    raise SyntaxError, options[:locale].t("errors.syntax.include")
  end
end

Public Instance Methods

parse(_tokens) click to toggle source
# File lib/liquid/tags/include.rb, line 48
def parse(_tokens)
end
render_to_output_buffer(context, output) click to toggle source
# File lib/liquid/tags/include.rb, line 51
def render_to_output_buffer(context, output)
  template_name = context.evaluate(@template_name_expr)
  raise ArgumentError, options[:locale].t("errors.argument.include") unless template_name

  partial = PartialCache.load(
    template_name,
    context: context,
    parse_context: parse_context
  )

  context_variable_name = @alias_name || template_name.split('/').last

  variable = if @variable_name_expr
    context.evaluate(@variable_name_expr)
  else
    context.find_variable(template_name, raise_on_not_found: false)
  end

  old_template_name = context.template_name
  old_partial       = context.partial
  begin
    context.template_name = template_name
    context.partial       = true
    context.stack do
      @attributes.each do |key, value|
        context[key] = context.evaluate(value)
      end

      if variable.is_a?(Array)
        variable.each do |var|
          context[context_variable_name] = var
          partial.render_to_output_buffer(context, output)
        end
      else
        context[context_variable_name] = variable
        partial.render_to_output_buffer(context, output)
      end
    end
  ensure
    context.template_name = old_template_name
    context.partial       = old_partial
  end

  output
end