Class: Webgen::PathHandler::Sitemap

Inherits:
Object
  • Object
show all
Includes:
Base, PageUtils
Defined in:
lib/webgen/path_handler/sitemap.rb

Overview

Path handler for creating an XML sitemap based on the specification of sitemaps.org.

Defined Under Namespace

Classes: Node

Constant Summary collapse

MANDATORY_INFOS =

The mandatory keys that need to be set in a sitemap file.

%W[entries]

Constants included from Base

Base::DEST_PATH_PARENT_SEGMENTS, Base::DEST_PATH_SEGMENTS

Instance Method Summary collapse

Methods included from PageUtils

#create_node, #parse_meta_info!

Methods included from Base

#initialize, #parse_meta_info!

Instance Method Details

#content(node) ⇒ Object

Return the rendered feed represented by node.



56
57
58
59
60
 
# File 'lib/webgen/path_handler/sitemap.rb', line 56

def content(node)
  context = Webgen::Context.new(@website)
  context.render_block(:name => "sitemap", :node => 'first',
                       :chain => [node, node.resolve("/templates/sitemap.template", node.lang, true), node].compact)
end

#create_nodes(path, blocks) ⇒ Object

Create an XML sitemap from path.



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/webgen/path_handler/sitemap.rb', line 34

def create_nodes(path, blocks)
  if MANDATORY_INFOS.any? {|t| path.meta_info[t].nil?}
    raise Webgen::NodeCreationError.new("At least one of #{MANDATORY_INFOS.join('/')} is missing",
                                        "path_handler.sitemap", path)
  end

  if @website.config['website.base_url'].empty?
    raise Webgen::NodeCreationError.new("The configuration option 'website.base_url' needs to be set",
                                        "path_handler.sitemap", path)
  end

  path.ext = 'xml'
  path['node_class'] = Node.to_s
  create_node(path) do |node|
    set_blocks(node, blocks)
    node.node_info[:entries] = {:flatten => true, :not => {:mi => {'no_output' => true}}, :and => node['entries']}
    @website.ext.item_tracker.add(node, :nodes, :node_finder_option_set,
                                  {:opts => node.node_info[:entries], :ref_alcn => node.alcn}, :meta_info)
  end
end