Class: Nanoc::Layout

Inherits:

Object

• Object
• Nanoc::Layout

show all

Extended by:

Memoization

Defined in:

lib/nanoc/base/source_data/layout.rb

Overview

Instance Attribute Summary (collapse)

• - (Hash) attributes readonly

  This layout’s attributes.

• - (String) identifier

  This layout’s identifier, starting and ending with a slash.

• - (String) raw_content readonly

  The raw content of this layout.

Instance Method Summary (collapse)

• - (Object) ==(other)
• - (Object) [](key)

  Requests the attribute with the given key.

• - (String) checksum

  The checksum for this object.

• - (Boolean) eql?(other)
• - (void) freeze

  Prevents all further modifications to the layout.

• - (Object) hash
• - (Layout) initialize(raw_content, attributes, identifier, params = nil) constructor

  Creates a new layout.

• - (Object) inspect
• - (Object) marshal_dump
• - (Object) marshal_load(source)
• - (Object) mtime deprecated Deprecated.

  Access the modification time using layout[:mtime] instead.

• - (Object) reference private

  Returns an object that can be used for uniquely identifying objects.

• - (Symbol) type private

  Returns the type of this object.

Methods included from Memoization

memoize

36
37
38
39
40
41
42
43
44
45

# File 'lib/nanoc/base/source_data/layout.rb', line 36

def initialize(raw_content, attributes, identifier, params = nil)
  @raw_content  = raw_content
  @attributes   = attributes.symbolize_keys_recursively
  @identifier   = identifier.cleaned_identifier.freeze

  # Set mtime
  params ||= {}
  params = { :mtime => params } if params.is_a?(Time)
  @attributes.merge(:mtime => params[:mtime]) if params[:mtime]
end

15
16
17

# File 'lib/nanoc/base/source_data/layout.rb', line 15

def attributes
  @attributes
end

19
20
21

# File 'lib/nanoc/base/source_data/layout.rb', line 19

def identifier
  @identifier
end

12
13
14

# File 'lib/nanoc/base/source_data/layout.rb', line 12

def raw_content
  @raw_content
end

105
106
107

# File 'lib/nanoc/base/source_data/layout.rb', line 105

def ==(other)
  self.eql?(other)
end

52
53
54

# File 'lib/nanoc/base/source_data/layout.rb', line 52

def [](key)
  @attributes[key]
end

90
91
92
93
94

# File 'lib/nanoc/base/source_data/layout.rb', line 90

def checksum
  attributes = @attributes.dup
  attributes.delete(:file)
  @raw_content.checksum + ',' + attributes.checksum
end

101
102
103

# File 'lib/nanoc/base/source_data/layout.rb', line 101

def eql?(other)
  self.class == other.class && identifier == other.identifier
end

69
70
71
72
73

# File 'lib/nanoc/base/source_data/layout.rb', line 69

def freeze
  attributes.freeze_recursively
  identifier.freeze
  raw_content.freeze
end

97
98
99

# File 'lib/nanoc/base/source_data/layout.rb', line 97

def hash
  self.class.hash ^ identifier.hash
end

84
85
86

# File 'lib/nanoc/base/source_data/layout.rb', line 84

def inspect
  "<#{self.class} identifier=\"#{identifier}\">"
end

109
110
111
112
113
114
115

# File 'lib/nanoc/base/source_data/layout.rb', line 109

def marshal_dump
  [
    @raw_content,
    @attributes,
    @identifier
  ]
end

117
118
119
120
121

# File 'lib/nanoc/base/source_data/layout.rb', line 117

def marshal_load(source)
  @raw_content,
  @attributes,
  @identifier = *source
end

124
125
126

# File 'lib/nanoc/base/source_data/layout.rb', line 124

def mtime
  self[:mtime]
end

80
81
82

# File 'lib/nanoc/base/source_data/layout.rb', line 80

def reference
  [ type, identifier ]
end

62
63
64

# File 'lib/nanoc/base/source_data/layout.rb', line 62

def type
  :layout
end