Class: Nanoc3::ItemRepProxy

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/nanoc3/base/compilation/item_rep_proxy.rb

Overview

Represents an item representation, but provides an interface that is easier to use when writing compilation and routing rules. It is also responsible for fetching the necessary information from the compiler, such as assigns.

The API provided by item representation proxies allows layout identifiers to be given as literals instead of as references to Layout.

Instance Method Summary collapse

Constructor Details

#initialize(item_rep, compiler) ⇒ ItemRepProxy

Returns a new instance of ItemRepProxy.

Parameters:

  • item_rep (Nanoc3::ItemRep) —

    The item representation that this proxy should behave like

  • compiler (Nanoc3::Compiler) —

    The compiler that will provide the necessary compilation-related functionality.



24
25
26
27
 
# File 'lib/nanoc3/base/compilation/item_rep_proxy.rb', line 24

def initialize(item_rep, compiler)
  @item_rep = item_rep
  @compiler = compiler
end

Instance Method Details

#filter(name, args = {}) ⇒ void

This method returns an undefined value.

Runs the item content through the given filter with the given arguments. This method will replace the content of the ‘:last` snapshot with the filtered content of the last snapshot.

This method is supposed to be called only in a compilation rule block (see CompilerDSL#compile).

Parameters:

  • filter_name (Symbol) —

    The name of the filter to run the item representations’ content through

  • filter_args (Hash) —

    The filter arguments that should be passed to the filter’s #run method

See Also:



45
46
47
48
 
# File 'lib/nanoc3/base/compilation/item_rep_proxy.rb', line 45

def filter(name, args={})
  set_assigns
  @item_rep.filter(name, args)
end

#is_proxy? ⇒ true

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns true because this item is already a proxy, and therefore doesn’t need to be wrapped anymore.

Returns:

  • (true)

See Also:



80
81
82
 
# File 'lib/nanoc3/base/compilation/item_rep_proxy.rb', line 80

def is_proxy?
  true
end

#layout(layout_identifier) ⇒ void

This method returns an undefined value.

Lays out the item using the given layout. This method will replace the content of the ‘:last` snapshot with the laid out content of the last snapshot.

This method is supposed to be called only in a compilation rule block (see CompilerDSL#compile).

Parameters:

  • layout_identifier (String) —

    The identifier of the layout to use

See Also:



62
63
64
65
66
67
68
69
 
# File 'lib/nanoc3/base/compilation/item_rep_proxy.rb', line 62

def layout(layout_identifier)
  set_assigns

  layout = layout_with_identifier(layout_identifier)
  filter_name, filter_args = @compiler.rules_collection.filter_for_layout(layout)

  @item_rep.layout(layout, filter_name, filter_args)
end