Class | Nanoc::Rule |
In: |
lib/nanoc/base/compilation/rule.rb
|
Parent: | Object |
Contains the processing information for a item.
identifier_regex | [R] |
@return [Regexp] The regex that determines which items this rule can be
applied to. This rule can be applied to items with a identifier matching this regex. |
rep_name | [R] |
@return [Symbol] The name of the representation that will be compiled
using this rule |
snapshot_name | [R] |
@return [Symbol] The name of the snapshot this rule will apply to.
Ignored for compilation rules, but used for routing rules. @since 3.2.0 |
Creates a new item compilation rule with the given identifier regex, compiler and block. The block will be called during compilation with the item rep as its argument.
@param [Regexp] identifier_regex A regular expression that will be used
to determine whether this rule is applicable to certain items.
@param [String, Symbol] rep_name The name of the item representation
where this rule can be applied to
@param [Proc] block A block that will be called when matching items are
compiled
@option params [Symbol, nil] :snapshot (nil) The name of the snapshot
this rule will apply to. Ignored for compilation rules, but used for routing rules.
@param [Nanoc::Item] item The item to check
@return [Boolean] true if this rule can be applied to the given item
rep, false otherwise
Applies this rule to the given item rep.
@param [Nanoc::ItemRep] rep The item representation where this rule
should be applied to
@option params [Nanoc::Compiler] :compiler The compiler
@raise [ArgumentError] if no compiler is passed
@return [void]