class Webgen::Node

Represents a file, a directory or a fragment. A node always belongs to a Tree.

All needed meta and processing information is associated with the node itself. The meta information is available through the [] and meta_info accessors, the internal processing information through the node_info accessor.

This class is not directly used. Instead path handlers define sub-classes that provide handler specific methods. See the basic sub-class Webgen::PathHandler::Base::Node.

Attributes

acn[R]

The absolute canonical name of this node.

alcn[R]

The absolute localized canonical name of this node.

children[R]

The child nodes of this node.

cn[R]

The canonical name of this node.

dest_path[R]

The full destination path of this node.

lang[R]

The language of this node.

lcn[R]

The localized canonical name of this node.

level[R]

The level of the node. The level specifies how deep the node is in the hierarchy.

meta_info[R]

Meta information associated with the node. If you need just a value for a meta information key, use the [] method.

node_info[R]

Return the node information hash which contains information for processing the node.

parent[R]

The parent node. This is in all but one case a Node object. The one exception is that the parent of the Tree#dummy_node is a Tree object.

tree[R]

The tree to which this node belongs.

Public Class Methods

new(parent, cn, dest_path, meta_info = {}) click to toggle source

Create a new Node instance.

parent (immutable): The parent node under which this nodes should be created.
cn (immutable): The canonical name for this node. Needs to be of the form 'basename.ext' or 'basename' where basename does not contain any dots. Also, the basename must not include a language part!
dest_path (immutable): The full output path for this node. If this node is a directory, the path must have a trailing slash ('dir/'). If it is a fragment, it has to include a hash sign. This can also be an absolute path like example.com.
meta_info: A hash with meta information for the new node.

The language of a node is taken from the meta information lang and the entry is deleted from the meta information hash. The language cannot be changed afterwards! If no lang key is found, the node is unlocalized.

# File lib/webgen/node.rb, line 78
def initialize(parent, cn, dest_path, meta_info = {})
  @parent = parent
  @children = []
  @cn = cn.freeze
  @dest_path = dest_path.freeze

  @lang = Webgen::LanguageManager.language_for_code(meta_info.delete('lang'))
  @lang = nil unless is_file?

  @lcn = Webgen::Path.lcn(@cn, @lang).freeze
  @acn = (@parent.kind_of?(Webgen::Node) ? @parent.acn.sub(/#.*$/, '') + @cn : '').freeze
  @alcn = (@parent.kind_of?(Webgen::Node) ? @parent.alcn.sub(/#.*$/, '') + @lcn : '').freeze

  @meta_info = meta_info
  @node_info = {}

  @level = -1
  @tree = @parent
  (@level += 1; @tree = @tree.parent) while @tree.kind_of?(Webgen::Node)

  @tree.register_node(self)
  @parent.children << self unless @parent == @tree
end

Public Instance Methods

=~(pattern) click to toggle source

Return true if the alcn matches the pattern.

See Webgen::Path.matches_pattern? for more information.

# File lib/webgen/node.rb, line 149
def =~(pattern)
  Webgen::Path.matches_pattern?(@alcn, pattern)
end

[](key) click to toggle source

Return the meta information item for key.

# File lib/webgen/node.rb, line 103
def [](key)
  @meta_info[key]
end

is_ancestor_of?(node) click to toggle source

Check if the this node is an ancestor of node.

The check is performed using only the parent information of the involved nodes, NOT the actual alcn values!

# File lib/webgen/node.rb, line 131
def is_ancestor_of?(node)
  node = node.parent
  node = node.parent while node != tree.dummy_root && node != self
  node != tree.dummy_root
end

is_directory?() click to toggle source

Check if the node is a directory.

# File lib/webgen/node.rb, line 108
def is_directory?
  @cn[-1] == ?/ && !is_fragment?
end

is_file?() click to toggle source

Check if the node is a file.

# File lib/webgen/node.rb, line 113
def is_file?
  !is_directory? && !is_fragment?
end

is_fragment?() click to toggle source

Check if the node is a fragment.

# File lib/webgen/node.rb, line 118
def is_fragment?
  @cn[0] == ?#
end

is_root?() click to toggle source

Check if the node is the root node.

# File lib/webgen/node.rb, line 123
def is_root?
  self == tree.root
end

link_to(node, lang = @lang, attr = {}) click to toggle source

Return a HTML link from this node to the given node.

If the lang parameter is not used, it defaults to the language of the current node.

You can optionally specify additional attributes for the HTML element in the attr Hash. Also, the meta information link_attrs of the given node is used, if available, to set attributes. However, the attr parameter takes precedence over the link_attrs meta information.

If the special value 'link_text' is present in the attributes, it will be used as the link text; otherwise the title of the node will be used.

# File lib/webgen/node.rb, line 205
def link_to(node, lang = @lang, attr = {})
  rnode = node.proxy_node(lang)
  attr = (rnode['link_attrs'].kind_of?(Hash) ? rnode['link_attrs'] : {}).merge(attr)
  link_text = attr.delete('link_text') || (rnode != node && rnode['routed_title']) || node['title']

  attr['href'] = route_to(node, lang)
  attr['hreflang'] = rnode.lang.to_s if rnode.lang
  attrs = attr.collect {|name,value| "#{name.to_s}=\"#{value}\"" }.sort.unshift('').join(' ')
  "<a#{attrs}>#{link_text}</a>"
end

proxy_node(lang = @lang) click to toggle source

Return the proxy node in language lang.

This node should be used, for example, when routing to this node. The proxy node is found by using the proxy_path meta information. This meta information is usually set on directories to specify the node that should be used for the “directory index”.

If the lang parameter is not used, it defaults to the language of the current node.

# File lib/webgen/node.rb, line 190
def proxy_node(lang = @lang)
  @meta_info['proxy_path'] && resolve(@meta_info['proxy_path'], lang, true) || self
end

resolve(path, lang = @lang, msg_on_failure = false) click to toggle source

Return the node representing the given path in the given language.

The path can be absolute (i.e. starting with a slash) or relative to the current node. Relative paths are made absolute by using the alcn of the current node.

If the lang parameter is not used, it defaults to the language of the current node.

See Webgen::Tree#resolve_node for detailed information on how the correct node for the path is found and for the msg_on_failure parameter.

# File lib/webgen/node.rb, line 162
def resolve(path, lang = @lang, msg_on_failure = false)
  @tree.resolve_node(Webgen::Path.append(@alcn, path), lang, msg_on_failure)
end

route_to(node, lang = @lang) click to toggle source

Return the relative path to the given node.

If the lang parameter is not used, it defaults to the language of the current node.

# File lib/webgen/node.rb, line 169
def route_to(node, lang = @lang)
  my_url = Webgen::Path.url(@dest_path)
  pnode = node.proxy_node(lang)
  other_url = Webgen::Path.url(pnode['routing_path'] || pnode.dest_path)

  # resolve any '.' and '..' paths in the target url
  if other_url.path =~ /\/\.\.?\// && other_url.scheme == 'webgen'
    other_url = other_url.dup
    other_url.path = Pathname.new(other_url.path).cleanpath.to_s
  end
  route = my_url.route_to(other_url).to_s
  (route == '' ? File.basename(@dest_path) : route)
end

to_s() click to toggle source

Return the string representation of the node which is just the alcn.

# File lib/webgen/node.rb, line 138
def to_s
  @alcn
end

versions() click to toggle source

Return all versions of this node.

# File lib/webgen/node.rb, line 217
def versions
  tree.node_access[:alcn].select {|alcn, n| n.node_info[:path] == node_info[:path]}.
    each_with_object({}) {|(_, v), h| h[v['version']] = v}
end