Methods

Included Modules

Class/Module Index [+]

Quicksearch

Nanoc3::Helpers::Rendering

Provides functionality for rendering layouts as partials.

Public Instance Methods

render(identifier, other_assigns={}, &block) click to toggle source

Returns a string containing the rendered given layout.

@param [String] identifier The identifier of the layout that should be rendered

@param [Hash] other_assigns A hash containing assigns that will be made available as instance variables in the partial

@example Rendering a head and a foot partial around some text

<%= render 'head' %> - MIDDLE - <%= render 'foot' %>
# => "HEAD - MIDDLE - FOOT"

@example Rendering a head partial with a custom title

# The 'head' layout
<h1><%= @title %></h1>

# The item/layout where the partial is rendered
<%= render 'head', :title => 'Foo' %>
# => "<h1>Foo</h1>"

@raise [Nanoc3::Errors::UnknownLayout] if the given layout does not exist

@return [String] The rendered partial

# File lib/nanoc3/helpers/rendering.rb, line 35
def render(identifier, other_assigns={}, &block)
  # Find layout
  layout = @site.layouts.find { |l| l.identifier == identifier.cleaned_identifier }
  raise Nanoc3::Errors::UnknownLayout.new(identifier.cleaned_identifier) if layout.nil?

  # Capture content, if any
  captured_content = block_given? ? capture(&block) : nil

  # Get assigns
  assigns = {
    :content    => captured_content,
    :item       => @item,
    :item_rep   => @item_rep,
    :items      => @items,
    :layout     => layout,
    :layouts    => @layouts,
    :config     => @config,
    :site       => @site
  }.merge(other_assigns)

  # Get filter name
  filter_name, filter_args = @site.compiler.filter_for_layout(layout)
  raise Nanoc3::Errors::CannotDetermineFilter.new(layout.identifier) if filter_name.nil?

  # Get filter class
  filter_class = Nanoc3::Filter.named(filter_name)
  raise Nanoc3::Errors::UnknownFilter.new(filter_name) if filter_class.nil?

  # Create filter
  filter = filter_class.new(assigns)

  # Layout
  @site.compiler.stack.push(layout)
  result = filter.run(layout.raw_content, filter_args)
  @site.compiler.stack.pop

  # Append to erbout if we have a block
  if block_given?
    erbout = eval('_erbout', block.binding)
    erbout << result
  end

  # Done
  result
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.