Provides a context in which compilation and routing rules can be executed. It provides access to the item representation that is being compiled or routed.
The following variables will be available in this rules context:
`rep` ({Nanoc3::ItemRep}) - The current item rep
`item` ({Nanoc3::Item}) - The current item
`site` ({Nanoc3::Site}) - The site
`config` ({Hash}) - The site configuration
`items` ({Array}<{Nanoc3::Item}>) - A list of all items
`layouts` ({Array}<{Nanoc3::Layout}>) - A list of all layouts
Creates a new rule context for the given iterm representation.
@param [Nanoc3::ItemRep] rep The item representation for which to create a new rule context.
# File lib/nanoc3/base/rule_context.rb, line 21 def initialize(rep) item = rep.item site = item.site config = site.config items = site.items layouts = site.layouts super({ :rep => rep, :item => item, :site => site, :config => config, :items => items, :layouts => layouts }) end
Filters the current representation (calls {Nanoc3::ItemRep#filter} with the given arguments on the rep).
@param [Symbol] filter_name The name of the filter to run the item representations’ content through
@param [Hash] filter_args The filter arguments that should be passed to the filter’s run method
@return [void]
# File lib/nanoc3/base/rule_context.rb, line 50 def filter(filter_name, filter_args={}) rep.filter(filter_name, filter_args) end
Layouts the current representation (calls {Nanoc3::ItemRep#layout} with the given arguments on the rep).
@param [String] layout_identifier The identifier of the layout the item should be laid out with
@return [void]
# File lib/nanoc3/base/rule_context.rb, line 63 def layout(layout_identifier) rep.layout(layout_identifier) end
Creates a snapshot of the current compiled item content. Calls {Nanoc3::ItemRep#snapshot} with the given arguments on the rep.
@param [Symbol] snapshot_name The name of the snapshot to create
@return [void]
# File lib/nanoc3/base/rule_context.rb, line 75 def snapshot(snapshot_name) rep.snapshot(snapshot_name) end
Generated with the Darkfish Rdoc Generator 2.