Class: Utopia::Content::Node

Inherits:
Object
  • Object
show all
Defined in:
lib/utopia/content/node.rb

Overview

Represents an immutable node within the content hierarchy.

Defined Under Namespace

Classes: Context

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(controller, uri_path, request_path, file_path) ⇒ Node

Initialize a node within the filesystem-backed content hierarchy.



23
24
25
26
27
28
29
 
# File 'lib/utopia/content/node.rb', line 23

def initialize(controller, uri_path, request_path, file_path)
	@controller = controller
	
	@uri_path = uri_path
	@request_path = request_path
	@file_path = file_path
end

Instance Attribute Details

#file_path ⇒ Object (readonly)

Returns the value of attribute file_path.



33
34
35
 
# File 'lib/utopia/content/node.rb', line 33

def file_path
  @file_path
end

#request_path ⇒ Object (readonly)

Returns the value of attribute request_path.



31
32
33
 
# File 'lib/utopia/content/node.rb', line 31

def request_path
  @request_path
end

#uri_path ⇒ Object (readonly)

Returns the value of attribute uri_path.



32
33
34
 
# File 'lib/utopia/content/node.rb', line 32

def uri_path
  @uri_path
end

Instance Method Details

#call(document, state) ⇒ Object

Invoked when the node is being rendered by Document.



126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/utopia/content/node.rb', line 126

def call(document, state)
	# Load the template:
	template = @controller.fetch_template(@file_path)
	
	# Evaluate the template/code:
	context = Context.new(document, state)
	markup = template.to_buffer(context)
	
	# Render the resulting markup into the document:
	document.parse_markup(markup)
end

#links(path = ".", **options, &block) ⇒ Object

Enumerate or return links relative to this node.



84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/utopia/content/node.rb', line 84

def links(path = ".", **options, &block)
	path = uri_path.dirname + Path[path]
	
	links = @controller.links(path, **options)
	
	if block_given?
		links.each(&block)
	else
		links
	end
end

#local_path(path = ".", base = nil) ⇒ Object

Resolve a content path beneath the controller root.



51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/utopia/content/node.rb', line 51

def local_path(path = ".", base = nil)
	path = Path[path]
	
	root = Pathname.new(@controller.root)
	
	if path.absolute?
		return root.join(*path.components)
	else
		base ||= uri_path.dirname
		return root.join(*(base + path).components)
	end
end

#lookup_node(path) ⇒ Object

Resolve another node relative to this node's parent.



44
45
46
 
# File 'lib/utopia/content/node.rb', line 44

def lookup_node(path)
	@controller.lookup_node(parent_path + Path[path])
end

#lookup_tag(tag) ⇒ Node

Lookup the given tag which is being rendered within the given node. Invoked by Document.

Returns:

  • (Node) —

    The node which will be used to render the tag.



121
122
123
 
# File 'lib/utopia/content/node.rb', line 121

def lookup_tag(tag)
	return @controller.lookup_tag(tag.name, self)
end

#name ⇒ Object

Return the node's URI basename.



37
38
39
 
# File 'lib/utopia/content/node.rb', line 37

def name
	@uri_path.basename
end

#parent_path ⇒ Object

Return this node's containing URI path.



76
77
78
 
# File 'lib/utopia/content/node.rb', line 76

def parent_path
	@uri_path.dirname
end

#process!(request, attributes = {}, localization: request&.localization) ⇒ Object

Process the request and return the resulting response.



143
144
145
 
# File 'lib/utopia/content/node.rb', line 143

def process!(request, attributes = {}, localization: request&.localization)
	Document.render(self, request, attributes, localization: localization).to_response
end

#related_links ⇒ Object

Return localized and indexed variants related to this node.



98
99
100
 
# File 'lib/utopia/content/node.rb', line 98

def related_links
	@controller.links(@uri_path.dirname, name: @uri_path.basename, indices: true)
end

#relative_path(path = ".") ⇒ Object

Resolve a path relative to this node's containing URI path.



67
68
69
70
71
72
 
# File 'lib/utopia/content/node.rb', line 67

def relative_path(path = ".")
	path = Path[path]
	base = uri_path.dirname
	
	return base + path
end

#sibling_links(**options) ⇒ Object

Return links that are siblings of this node.



115
116
117
 
# File 'lib/utopia/content/node.rb', line 115

def sibling_links(**options)
	return @controller.links(siblings_path, **options)
end

#siblings_path ⇒ Object

Return the directory whose links are siblings of this node.



104
105
106
107
108
109
110
 
# File 'lib/utopia/content/node.rb', line 104

def siblings_path
	if @uri_path.basename == INDEX
		@uri_path.dirname(2)
	else
		@uri_path.dirname
	end
end