Module Nanoc::ItemRep::Private
In: lib/nanoc/base/result_data/item_rep.rb

Contains all private methods. Mixed into {Nanoc::ItemRep}.

Methods

Constants

TMP_TEXT_ITEMS_DIR = 'tmp/text_items'

External Aliases

compiled -> compiled?

Attributes

assigns  [RW]  @return [Hash] A hash containing the assigns that will be used in the
  next filter or layout operation. The keys (symbols) will be made
  available during the next operation.
compiled  [RW]  @return [Boolean] true if this representation has already been
  compiled during the current or last compilation session; false
  otherwise

@api private

content  [RW]  @return [Hash<Symbol,String>] A hash containing the content at all
  snapshots. The keys correspond with the snapshot names, and the
  values with the content.

@api private

paths  [RW]  @return [Hash<Symbol,String>] A hash containing the paths for all
  snapshots. The keys correspond with the snapshot names, and the
  values with the path.

@api private

raw_paths  [RW]  @return [Hash<Symbol,String>] A hash containing the raw paths (paths
  including the path to the output directory and the filename) for all
  snapshots. The keys correspond with the snapshot names, and the
  values with the path.

@api private

temporary_filenames  [R]  @return [Hash<Symbol,String>] A hash containing the paths to the
  temporary _files_ that filters write binary content to. This is only
  used when the item representation is binary. The keys correspond
  with the snapshot names, and the values with the filename. When
  writing the item representation, the file corresponding with the
  requested snapshot (usually `:last`) will be copied from
  `filenames[snapshot]` to `raw_paths[snapshot]`.

@api private

Public Instance methods

Resets the compilation progress for this item representation. This is necessary when an unmet dependency is detected during compilation.

@api private

@return [void]

Returns the type of this object. Will always return `:item_rep`, because this is an item rep. For layouts, this method returns `:layout`.

@api private

@return [Symbol] :item_rep

Writes the item rep‘s compiled content to the rep‘s output file.

This method will send two notifications: one before writing the item representation, and one after. These notifications can be used for generating diffs, for example.

@api private

@param [Symbol, nil] snapshot The name of the snapshot to write.

@return [void]

[Validate]