class Webgen::PathHandler::Virtual

Handles files which contain specifications for “virtual” nodes, ie. nodes that don't have real source paths.

This can be used, for example, to provide multiple links to the same node or links to external URLs.

Public Instance Methods

create_nodes(path, blocks) click to toggle source

Create all virtual nodes which are specified in path.

# File lib/webgen/path_handler/virtual.rb, line 21
def create_nodes(path, blocks)
  if path.meta_info.delete(:virtual)
    create_node(path)
  else
    read_entries(blocks) do |key, meta_info|
      meta_info['modified_at'] = path.meta_info['modified_at']
      meta_info['no_output'] = true

      key = Webgen::Path.append(path.parent_path, key)
      parent_path = create_directories(File.dirname(key), 'modified_at' => meta_info['modified_at'])

      dest_path = meta_info.delete('dest_path') || key
      dest_path = if Webgen::Path.absolute?(dest_path)
                    dest_path
                  elsif dest_path =~ /^\//
                    "webgen:#{dest_path}"
                  else
                    "webgen:#{File.join(parent_path, dest_path)}"
                  end
      meta_info['dest_path'] = dest_path
      entry_path = Webgen::Path.new(key, meta_info)

      if key =~ /\/$/
        entry_path['handler'] = 'directory'
        @website.ext.path_handler.create_secondary_nodes(entry_path)
      else
        entry_path[:virtual] = true
        entry_path['handler'] = 'virtual'
        entry_path['node_class'] ||= Webgen::PathHandler::Base::Node.to_s
        @website.ext.path_handler.create_secondary_nodes(entry_path)
      end
    end

    nil
  end
end

Private Instance Methods

create_directories(directory, mi) click to toggle source

Create the needed parent directories for a virtual node.

# File lib/webgen/path_handler/virtual.rb, line 81
def create_directories(directory, mi)
  mi.merge!('no_output' => true, 'handler' => 'directory')
  directory.sub(/^\//, '').split('/').inject('/') do |parent_path, dir|
    parent_path = File.join(parent_path, dir) + '/'
    path = Webgen::Path.new(parent_path, mi)
    if !@website.tree[path.alcn]
      @website.ext.path_handler.create_secondary_nodes(path)
    end
    parent_path
  end
end

read_entries(blocks) { |key, meta_info| ... } click to toggle source

Read all entries from all blocks and yield the found path as well as the meta info hash for each entry.

# File lib/webgen/path_handler/virtual.rb, line 64
def read_entries(blocks)
  blocks.each do |name, content|
    begin
      data = YAML::load(content)
    rescue RuntimeError, ArgumentError, SyntaxError, YAML::SyntaxError => e
      raise RuntimeError, "Problem parsing block '#{name}' (it needs to contain a YAML hash): #{e.message}", e.backtrace
    end
    raise "Structure of block '#{name}' is invalid, it has to be a Hash" unless data.kind_of?(Hash)
    data.each do |key, meta_info|
      meta_info ||= {}
      raise "Each path key value needs to be a Hash, found a #{meta_info.class} for '#{key}'" unless meta_info.kind_of?(Hash)
      yield(key, meta_info)
    end
  end
end