Class Nanoc::RuleContext
In: lib/nanoc/base/compilation/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:

@api private

Methods

filter   layout   new   snapshot  

Public Class methods

@option params [Nanoc::ItemRep] :rep The item representation that will

  be processed in this rule context

@option params [Nanoc::Compiler] :compiler The compiler that is being

  used to compile the site

@raise [ArgumentError] if the `:rep` or the `:compiler` option is

  missing

Public Instance methods

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

@see Nanoc::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 {Nanoc::ItemRep#layout} with the given arguments on the rep).

@see Nanoc::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 {Nanoc::ItemRep#snapshot} with the given arguments on the rep.

@see Nanoc::ItemRep#snapshot

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

@return [void]

[Validate]