Class: Nanoc3::Item

Inherits:

Object

• Object
• Nanoc3::Item

show all

Defined in:

lib/nanoc3/base/item.rb

Overview

Instance Attribute Summary (collapse)

• - (Hash) attributes

  This item's attributes.

• - (Array<Nanoc3::Item>) children

  The child items of this item.

• - (String) identifier

  A string that uniquely identifies an item in a site.

• - (Time) mtime readonly

  The time when this item was last modified.

• - (Boolean) outdated_due_to_dependencies (also: #outdated_due_to_dependencies?)

  dependencies are outdated.

• - (Nanoc3::Item^?) parent

  nil even for non-root items.

• - (String) raw_content readonly

  available for textual items).

• - (String) raw_filename readonly

  item’s content (only available for binary items).

• - (Array<Nanoc3::ItemRep>) reps readonly

  This item’s list of item reps.

• - (Nanoc3::Site) site

  The site this item belongs to.

Instance Method Summary (collapse)

• - (Object) [](key)

  Requests the attribute with the given key.

• - (Object) []=(key, value)

  Sets the attribute with the given key to the given value.

• - (Boolean) binary?

  True if the item is binary; false if it is not.

• - (String) compiled_content(params = {})

  Returns the compiled content from a given representation and a given snapshot.

• - (Item) initialize(raw_content_or_raw_filename, attributes, identifier, params_or_mtime = nil) constructor

  Creates a new item with the given content or filename, attributes and identifier.

• - (Object) inspect
• - (Boolean) outdated?

  Determines whether this item (or rather, its reps) is outdated and should be recompiled (or rather, its reps should be recompiled).

• - (String) path(params = {})

  Returns the path from a given representation.

• - (Nanoc3::ItemRep) rep_named(rep_name)

  Returns the rep with the given name.

78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

# File 'lib/nanoc3/base/item.rb', line 78

def initialize(raw_content_or_raw_filename, attributes, identifier, params_or_mtime=nil)
  # Get params and mtime
  # TODO [in nanoc 4.0] clean this up
  if params_or_mtime.nil? || params_or_mtime.is_a?(Time)
    params = {}
    @mtime = params_or_mtime
  elsif params_or_mtime.is_a?(Hash)
    params = params_or_mtime
    @mtime = params[:mtime]
  end

  # Get type and raw content or raw filename
  @is_binary = params.has_key?(:binary) ? params[:binary] : false
  if @is_binary
    @raw_filename = raw_content_or_raw_filename
  else
    @raw_content  = raw_content_or_raw_filename
  end

  # Get rest of params
  @attributes   = attributes.symbolize_keys
  @identifier   = identifier.cleaned_identifier.freeze

  @parent       = nil
  @children     = []

  @reps         = []
end

14
15
16

# File 'lib/nanoc3/base/item.rb', line 14

def attributes
  @attributes
end

48
49
50

# File 'lib/nanoc3/base/item.rb', line 48

def children
  @children
end

27
28
29

# File 'lib/nanoc3/base/item.rb', line 27

def identifier
  @identifier
end

30
31
32

# File 'lib/nanoc3/base/item.rb', line 30

def mtime
  @mtime
end

52
53
54

# File 'lib/nanoc3/base/item.rb', line 52

def outdated_due_to_dependencies
  @outdated_due_to_dependencies
end

45
46
47

# File 'lib/nanoc3/base/item.rb', line 45

def parent
  @parent
end

37
38
39

# File 'lib/nanoc3/base/item.rb', line 37

def raw_content
  @raw_content
end

41
42
43

# File 'lib/nanoc3/base/item.rb', line 41

def raw_filename
  @raw_filename
end

33
34
35

# File 'lib/nanoc3/base/item.rb', line 33

def reps
  @reps
end

11
12
13

# File 'lib/nanoc3/base/item.rb', line 11

def site
  @site
end

175
176
177
178
179
180

# File 'lib/nanoc3/base/item.rb', line 175

def [](key)
  Nanoc3::NotificationCenter.post(:visit_started, self)
  Nanoc3::NotificationCenter.post(:visit_ended,   self)

  @attributes[key]
end

187
188
189

# File 'lib/nanoc3/base/item.rb', line 187

def []=(key, value)
  @attributes[key] = value
end

192
193
194

# File 'lib/nanoc3/base/item.rb', line 192

def binary?
  !!@is_binary
end

134
135
136
137
138
139
140
141
142
143
144
145

# File 'lib/nanoc3/base/item.rb', line 134

def compiled_content(params={})
  # Get rep
  rep_name = params[:rep] || :default
  rep = reps.find { |r| r.name == rep_name }
  if rep.nil?
    raise Nanoc3::Errors::Generic,
      "No rep named #{rep_name.inspect} was found."
  end

  # Get rep's content
  rep.compiled_content(params)
end

204
205
206

# File 'lib/nanoc3/base/item.rb', line 204

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

200
201
202

# File 'lib/nanoc3/base/item.rb', line 200

def outdated?
  @reps.any? { |r| r.outdated? }
end

156
157
158
159
160
161
162
163
164
165
166
167
168

# File 'lib/nanoc3/base/item.rb', line 156

def path(params={})
  rep_name = params[:rep] || :default

  # Get rep
  rep = reps.find { |r| r.name == rep_name }
  if rep.nil?
    raise Nanoc3::Errors::Generic,
      "No rep named #{rep_name.inspect} was found."
  end

  # Get rep's path
  rep.path
end

112
113
114

# File 'lib/nanoc3/base/item.rb', line 112

def rep_named(rep_name)
  @reps.find { |r| r.name == rep_name }
end