class Jekyll::Renderer

Attributes

document[R]
payload[R]
site[R]

Public Class Methods

new(site, document, site_payload = nil) click to toggle source
# File lib/jekyll/renderer.rb, line 6
def initialize(site, document, site_payload = nil)
  @site     = site
  @document = document
  @payload  = site_payload || site.site_payload
end

Public Instance Methods

convert(content) click to toggle source

Convert the given content using the converters which match this renderer's document.

content - the raw, unconverted content

Returns the converted content.

# File lib/jekyll/renderer.rb, line 85
def convert(content)
  converters.reduce(content) do |output, converter|
    begin
      converter.convert output
    rescue => e
      Jekyll.logger.error "Conversion error:",
        "#{converter.class} encountered an error while "             "converting '#{document.relative_path}':"
      Jekyll.logger.error("", e.to_s)
      raise e
    end
  end
end
converters() click to toggle source

Determine which converters to use based on this document's extension.

Returns an array of Converter instances.

# File lib/jekyll/renderer.rb, line 16
def converters
  @converters ||= site.converters.select { |c| c.matches(document.extname) }
end
invalid_layout?(layout) click to toggle source

Checks if the layout specified in the document actually exists

layout - the layout to check

Returns true if the layout is invalid, false if otherwise

# File lib/jekyll/renderer.rb, line 127
def invalid_layout?(layout)
  !document.data["layout"].nil? && layout.nil?
end
output_ext() click to toggle source

Determine the extname the outputted file should have

Returns the output extname including the leading period.

# File lib/jekyll/renderer.rb, line 23
def output_ext
  @output_ext ||= (permalink_ext || converter_output_ext)
end
place_in_layouts(content, payload, info) click to toggle source

Render layouts and place given content inside.

content - the content to be placed in the layout

Returns the content placed in the Liquid-rendered layouts

# File lib/jekyll/renderer.rb, line 137
def place_in_layouts(content, payload, info)
  output = content.dup
  layout = site.layouts[document.data["layout"]]

  Jekyll.logger.warn(
    "Build Warning:",
    "Layout '#{document.data["layout"]}' requested in "         "#{document.relative_path} does not exist."
  ) if invalid_layout? layout

  used = Set.new([layout])

  # Reset the payload layout data to ensure it starts fresh for each page.
  payload["layout"] = nil

  while layout
    payload["content"] = output
    payload["layout"]  = Utils.deep_merge_hashes(layout.data, payload["layout"] || {})

    output = render_liquid(
      layout.content,
      payload,
      info,
      layout.relative_path
    )

    # Add layout to dependency tree
    site.regenerator.add_dependency(
      site.in_source_dir(document.path),
      site.in_source_dir(layout.path)
    ) if document.write?

    if (layout = site.layouts[layout.data["layout"]])
      break if used.include?(layout)
      used << layout
    end
  end

  output
end
render_liquid(content, payload, info, path = nil) click to toggle source

Render the given content with the payload and info

content - payload - info - path - (optional) the path to the file, for use in ex

Returns the content, rendered by Liquid.

# File lib/jekyll/renderer.rb, line 107
def render_liquid(content, payload, info, path = nil)
  template = site.liquid_renderer.file(path).parse(content)
  template.warnings.each do |e|
    Jekyll.logger.warn "Liquid Warning:",
      LiquidRenderer.format_error(e, path || document.relative_path)
  end
  template.render!(payload, info)
# rubocop: disable RescueException
rescue Exception => e
  Jekyll.logger.error "Liquid Exception:",
    LiquidRenderer.format_error(e, path || document.relative_path)
  raise e
end
run() click to toggle source

DAT RENDER THO

# File lib/jekyll/renderer.rb, line 31
def run
  Jekyll.logger.debug "Rendering:", document.relative_path

  payload["page"] = document.to_liquid

  if document.respond_to? :pager
    payload["paginator"] = document.pager.to_liquid
  end

  if document.is_a?(Document) && document.collection.label == "posts"
    payload["site"]["related_posts"] = document.related_posts
  else
    payload["site"]["related_posts"] = nil
  end

  # render and transform content (this becomes the final content of the object)
  payload["highlighter_prefix"] = converters.first.highlighter_prefix
  payload["highlighter_suffix"] = converters.first.highlighter_suffix

  Jekyll.logger.debug "Pre-Render Hooks:", document.relative_path
  document.trigger_hooks(:pre_render, payload)

  info = {
    :registers => { :site => site, :page => payload["page"] }
  }

  output = document.content

  if document.render_with_liquid?
    Jekyll.logger.debug "Rendering Liquid:", document.relative_path
    output = render_liquid(output, payload, info, document.path)
  end

  Jekyll.logger.debug "Rendering Markup:", document.relative_path
  output = convert(output)
  document.content = output

  if document.place_in_layout?
    Jekyll.logger.debug "Rendering Layout:", document.relative_path
    place_in_layouts(
      output,
      payload,
      info
    )
  else
    output
  end
end

Private Instance Methods

converter_output_ext() click to toggle source
# File lib/jekyll/renderer.rb, line 187
def converter_output_ext
  if output_exts.size == 1
    output_exts.last
  else
    output_exts[-2]
  end
end
output_exts() click to toggle source
# File lib/jekyll/renderer.rb, line 195
def output_exts
  @output_exts ||= converters.map do |c|
    c.output_ext(document.extname)
  end.compact
end