Contents

# encoding: utf-8

module Nanoc3

  # A Nanoc3::Layout represents a layout in a nanoc site. It has content,
  # attributes (for determining which filter to use for laying out an item),
  # an identifier (because layouts are organised hierarchically), and a
  # modification time (to speed up compilation).
  class Layout

    # The Nanoc3::Site this layout belongs to.
    attr_accessor :site

    # The raw content of this layout.
    attr_reader :raw_content

    # A hash containing this layout's attributes.
    attr_reader :attributes

    # This layout's identifier, starting and ending with a slash.
    attr_accessor :identifier

    # The time when this layout was last modified.
    attr_reader :mtime

    # Creates a new layout.
    #
    # +content+:: The raw content of this layout.
    #
    # +attributes+:: A hash containing this layout's attributes.
    #
    # +identifier+:: This layout's identifier.
    #
    # +mtime+:: The time when this layout was last modified.
    def initialize(raw_content, attributes, identifier, mtime=nil)
      @raw_content  = raw_content
      @attributes   = attributes.symbolize_keys
      @identifier   = identifier.cleaned_identifier
      @mtime        = mtime
    end

    # Requests the attribute with the given key.
    def [](key)
      @attributes[key]
    end

    def inspect
      "<#{self.class}:0x#{self.object_id.to_s(16)} identifier=#{self.identifier}>"
    end

  end

end

Version data entries

10 entries across 10 versions & 1 rubygems

Version	Path
nanoc3-3.0.9	lib/nanoc3/base/layout.rb
nanoc3-3.0.8	lib/nanoc3/base/layout.rb
nanoc3-3.0.7	lib/nanoc3/base/layout.rb
nanoc3-3.0.6	lib/nanoc3/base/layout.rb
nanoc3-3.0.5	lib/nanoc3/base/layout.rb
nanoc3-3.0.4	lib/nanoc3/base/layout.rb
nanoc3-3.0.3	lib/nanoc3/base/layout.rb
nanoc3-3.0.2	lib/nanoc3/base/layout.rb
nanoc3-3.0.1	lib/nanoc3/base/layout.rb
nanoc3-3.0.0	lib/nanoc3/base/layout.rb