Class Nanoc3::RuleContext
In: lib/nanoc3/base/rule_context.rb
Parent: Context

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:

Methods

filter   layout   new   snapshot  

Public Class methods

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.

Public Instance methods

Filters the current representation (calls {Nanoc3::ItemRep#filter} with the given arguments on the rep).

@see Nanoc3::ItemRep#filter

@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]

Layouts the current representation (calls {Nanoc3::ItemRep#layout} with the given arguments on the rep).

@see Nanoc3::ItemRep#layout

@param [String] layout_identifier The identifier of the layout the item should be laid out with

@return [void]

Creates a snapshot of the current compiled item content. Calls {Nanoc3::ItemRep#snapshot} with the given arguments on the rep.

@see Nanoc3::ItemRep#snapshot

@param [Symbol] snapshot_name The name of the snapshot to create

@return [void]

[Validate]