Class/Module Index [+]

Quicksearch

Nanoc::RuleContext

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

Public Class Methods

new(params={}) click to toggle source

@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
# File lib/nanoc/base/compilation/rule_context.rb, line 27
def initialize(params={})
  rep      = params[:rep]      or raise ArgumentError, "Required :rep option is missing"
  compiler = params[:compiler] or raise ArgumentError, "Required :compiler option is missing"

  super({
    :rep      => rep,
    :item_rep => rep,
    :item     => rep.item,
    :site     => compiler.site,
    :config   => compiler.site.config,
    :items    => compiler.site.items,
    :layouts  => compiler.site.layouts
  })
end

Public Instance Methods

filter(filter_name, filter_args={}) click to toggle source

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]

# File lib/nanoc/base/compilation/rule_context.rb, line 54
def filter(filter_name, filter_args={})
  rep.filter(filter_name, filter_args)
end
layout(layout_identifier) click to toggle source

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]

# File lib/nanoc/base/compilation/rule_context.rb, line 67
def layout(layout_identifier)
  rep.layout(layout_identifier)
end
snapshot(snapshot_name) click to toggle source

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]

# File lib/nanoc/base/compilation/rule_context.rb, line 79
def snapshot(snapshot_name)
  rep.snapshot(snapshot_name)
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.