class Bunto::Renderer
Attributes
Public Class Methods
# File lib/bunto/renderer.rb, line 8 def initialize(site, document, site_payload = nil) @site = site @document = document @payload = site_payload end
Public Instance Methods
Convert the given content using the converters which match this renderer's document.
content - the raw, unconverted content
Returns the converted content.
# File lib/bunto/renderer.rb, line 106 def convert(content) converters.reduce(content) do |output, converter| begin converter.convert output rescue => e Bunto.logger.error "Conversion error:", "#{converter.class} encountered an error while "\ "converting '#{document.relative_path}':" Bunto.logger.error("", e.to_s) raise e end end end
Determine which converters to use based on this document's extension.
Returns an array of Converter
instances.
# File lib/bunto/renderer.rb, line 37 def converters @converters ||= site.converters.select { |c| c.matches(document.extname) }.sort end
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/bunto/renderer.rb, line 148 def invalid_layout?(layout) !document.data["layout"].nil? && layout.nil? && !(document.is_a? Bunto::Excerpt) end
The list of layouts registered for this Renderer
. It can be written with layouts=(new_layouts)
Falls back to site.layouts if no layouts are registered.
Returns a Hash of String => Bunto::Layout
identified as basename without the extension name.
# File lib/bunto/renderer.rb, line 29 def layouts @layouts || site.layouts end
Determine the extname the outputted file should have
Returns the output extname including the leading period.
# File lib/bunto/renderer.rb, line 44 def output_ext @output_ext ||= (permalink_ext || converter_output_ext) end
Fetches the payload used in Liquid rendering. It can be written with payload=(new_payload)
Falls back to site.site_payload if no payload is set.
Returns a Bunto::Drops::UnifiedPayloadDrop
# File lib/bunto/renderer.rb, line 19 def payload @payload ||= site.site_payload end
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/bunto/renderer.rb, line 158 def place_in_layouts(content, payload, info) output = content.dup layout = layouts[document.data["layout"]] Bunto.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 = layouts[layout.data["layout"]]) break if used.include?(layout) used << layout end end output end
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/bunto/renderer.rb, line 128 def render_liquid(content, payload, info, path = nil) template = site.liquid_renderer.file(path).parse(content) template.warnings.each do |e| Bunto.logger.warn "Liquid Warning:", LiquidRenderer.format_error(e, path || document.relative_path) end template.render!(payload, info) # rubocop: disable RescueException rescue Exception => e Bunto.logger.error "Liquid Exception:", LiquidRenderer.format_error(e, path || document.relative_path) raise e end
DAT RENDER THO
# File lib/bunto/renderer.rb, line 52 def run Bunto.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 Bunto.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? Bunto.logger.debug "Rendering Liquid:", document.relative_path output = render_liquid(output, payload, info, document.path) end Bunto.logger.debug "Rendering Markup:", document.relative_path output = convert(output) document.content = output if document.place_in_layout? Bunto.logger.debug "Rendering Layout:", document.relative_path place_in_layouts( output, payload, info ) else output end end
Private Instance Methods
# File lib/bunto/renderer.rb, line 208 def converter_output_ext if output_exts.size == 1 output_exts.last else output_exts[-2] end end
# File lib/bunto/renderer.rb, line 216 def output_exts @output_exts ||= converters.map do |c| c.output_ext(document.extname) end.compact end
# File lib/bunto/renderer.rb, line 201 def permalink_ext if document.permalink && !document.permalink.end_with?("/") permalink_ext = File.extname(document.permalink) permalink_ext unless permalink_ext.empty? end end