gettalong-webgen 0.5.8.20090507 → 0.5.9.20090620

data/lib/webgen/sourcehandler/base.rb

@@ -19,7 +19,7 @@ module Webgen::SourceHandler
   #
   # The paths that are handled by a source handler are specified via path patterns (see
   # below). During a webgen run the #create_node method for each source paths that matches a
-  # specified path pattern is called. And when it is time to write out the node, the the #content
+  # specified path pattern is called. And when it is time to write out the node, the #content
   # method is called to retrieve the rendered content.
   #
   # A source handler must not take any parameters on initialization and when this module is not
@@ -35,6 +35,7 @@ module Webgen::SourceHandler
   # It also provides other utility methods:
   # * #page_from_path
   # * #content
+  # * #parent_node
   #
   # == Nodes Created for Paths
   #
@@ -109,10 +110,11 @@ module Webgen::SourceHandler
   #   class SimpleCopy
   #
   #     include Webgen::SourceHandler::Base
+  #     include Webgen::WebsiteAccess
   #
-  #     def create_node(parent, path)
+  #     def create_node(path)
   #       path.ext += '.copied'
-  #       super(parent, path)
+  #       super(path)
   #     end
   #
   #     def content(node)
@@ -181,9 +183,7 @@ module Webgen::SourceHandler
       if OutputPathHelpers.public_instance_methods(false).map(&:to_s).include?(method)
         name = send(method, parent, path, use_lang_part)
         name += '/'  if path.path =~ /\/$/ && name !~ /\/$/
-        if (node = node_exists?(parent, path, name)) && node.lang == path.meta_info['lang']
-          name = node.path
-        elsif node
+        if (node = node_exists?(path, name)) && node.lang != path.meta_info['lang']
           name = send(method, parent, path, (path.meta_info['lang'].nil? ? false : true))
           name += '/'  if path.path =~ /\/$/ && name !~ /\/$/
         end
@@ -193,24 +193,38 @@ module Webgen::SourceHandler
       end
     end
 
-    # Check if the node alcn and output path which would be created by #create_node exists. The
+    # Check if the node alcn and output path which would be created by #create_node exist. The
     # +output_path+ to check for can individually be set.
-    def node_exists?(parent, path, output_path = self.output_path(parent, path))
-      parent.tree[Webgen::Node.absolute_name(parent, path.lcn, :alcn)] || (!path.meta_info['no_output'] && parent.tree[output_path, :path])
+    def node_exists?(path, output_path = self.output_path(parent_node(path), path))
+      Webgen::WebsiteAccess.website.tree[path.alcn] || (!path.meta_info['no_output'] && Webgen::WebsiteAccess.website.tree[output_path, :path])
     end
 
-    # Create a node under +parent+ from +path+ if it does not already exists or needs to be
-    # re-initialized. The found node or the newly created node is returned afterwards. +nil+ is
-    # returned if no node can be created (e.g. when <tt>path.meta_info['draft']</tt> is set). Some
-    # additional node information like <tt>:src</tt> and <tt>:processor</tt> is set and the meta
-    # information is checked for validness. The created/re-initialized node is yielded if a block is
-    # given.
-    def create_node(parent, path, output_path = self.output_path(parent, path))
+    # Create a node from +path+ if it does not already exists or re-initalize an already existing
+    # node. The found node or the newly created node is returned afterwards. +nil+ is returned if no
+    # node can be created (e.g. when <tt>path.meta_info['draft']</tt> is set).
+    #
+    # The +options+ parameter can be used for providing the optional parameters:
+    #
+    # [<tt>:parent</tt>] The parent node under which the new node should be created. If this is not
+    #                    specified (the usual case), the parent node is determined by the
+    #                    #parent_node method.
+    #
+    # [<tt>:output_path</tt>] The output path that should be used for the node. If this is not
+    #                         specified (the usual case), the output path is determined via the
+    #                         #output_path method.
+    #
+    # Some additional node information like <tt>:src</tt> and <tt>:processor</tt> is set and the
+    # meta information is checked for validness. The created/re-initialized node is yielded if a
+    # block is given.
+    def create_node(path, options = {})
       return nil if path.meta_info['draft']
-      node = node_exists?(parent, path, output_path)
+      parent = options[:parent] || parent_node(path)
+      output_path = options[:output_path] || self.output_path(parent, path)
+      node = node_exists?(path, output_path)
+
       if node && (node.node_info[:src] != path.source_path || node.node_info[:processor] != self.class.name)
-        log(:warn) { "Node already exists: source = #{path.source_path} | path = #{node.path} | alcn = #{node.absolute_lcn}"}
-        return node
+        log(:warn) { "Node already exists: source = #{path.source_path} | path = #{node.path} | alcn = #{node.alcn}"}
+        return node #TODO: think! should nil be returned?
       elsif !node
         node = Webgen::Node.new(parent, output_path, path.cn, path.meta_info)
       elsif node.flagged?(:reinit)
@@ -218,7 +232,11 @@ module Webgen::SourceHandler
       else
         return node
       end
-      node['modified_at'] = Time.now unless node['modified_at'].kind_of?(Time)
+
+      if !node['modified_at'].kind_of?(Time)
+        log(:warn) { "Meta information 'modified_at' set to current time in <#{node.alcn}> since its value '#{node['modified_at']}' was of type #{node['modified_at'].class}" } unless node['modified_at'].nil?
+        node['modified_at'] = Time.now
+      end
       node.node_info[:src] = path.source_path
       node.node_info[:creation_path] = path.path
       node.node_info[:processor] = self.class.name
@@ -226,7 +244,10 @@ module Webgen::SourceHandler
       node
     end
 
-    # Return the content of the given +node+. This default +content+ method just returns +nil+.
+    # Return the content of the given +node+. If the return value is not +nil+ then the node gets
+    # written, otherwise it is ignored.
+    #
+    # This default +content+ method just returns +nil+.
     def content(node)
       nil
     end
@@ -243,6 +264,15 @@ module Webgen::SourceHandler
       page
     end
 
+    # Return the parent node for the given +path+.
+    def parent_node(path)
+      parent_dir = (path.parent_path == '' ? '' : Webgen::Path.new(path.parent_path).alcn)
+      if !(parent = Webgen::WebsiteAccess.website.tree[parent_dir])
+        raise "The needed parent path <#{parent_dir}> for <#{path.path}> does not exist"
+      end
+      parent
+    end
+
   end
 
 end

data/lib/webgen/sourcehandler/copy.rb

@@ -9,9 +9,9 @@ module Webgen::SourceHandler
     include Webgen::WebsiteAccess
     include Base
 
-    # Create the node for +parent+ and +path+. If the +path+ has the name of a content processor as
-    # the first part in the extension, it is preprocessed.
-    def create_node(parent, path)
+    # Create the node for +path+. If the +path+ has the name of a content processor as the first
+    # part in the extension, it is preprocessed.
+    def create_node(path)
       if path.ext.index('.')
         processor, *rest = path.ext.split('.')
         if website.blackboard.invoke(:content_processor_names).include?(processor)
@@ -20,7 +20,7 @@ module Webgen::SourceHandler
           processor = nil
         end
       end
-      super(parent, path) do |node|
+      super(path) do |node|
         node.node_info[:preprocessor] = processor
       end
     end

data/lib/webgen/sourcehandler/directory.rb

@@ -16,21 +16,15 @@ module Webgen::SourceHandler
     # ignored). The path +path+ is the path that lead to the creation of these directories.
     def create_directories(parent, dirname, path)
       dirname.sub(/^\//, '').split('/').each do |dir|
-        dir_path = Webgen::Path.new(File.join(parent.absolute_lcn, dir, '/'), path)
-        nodes = website.blackboard.invoke(:create_nodes, parent.tree, parent.absolute_lcn,
-                                           dir_path, self) do |dir_parent, dir_path|
-          node_exists?(dir_parent, dir_path) || create_node(dir_parent, dir_path)
+        dir_path = Webgen::Path.new(File.join(parent.alcn, dir, '/'), path)
+        nodes = website.blackboard.invoke(:create_nodes, dir_path, self) do |dir_path|
+          node_exists?(dir_path) || create_node(dir_path)
         end
         parent = nodes.first
       end
       parent
     end
 
-    # Return an empty string to signal that the directory should be written to the output.
-    def content(node)
-      ''
-    end
-
   end
 
 end

data/lib/webgen/sourcehandler/feed.rb

@@ -15,10 +15,10 @@ module Webgen::SourceHandler
       website.blackboard.add_listener(:node_changed?, method(:node_changed?))
     end
 
-    # Create atom and/or rss feed files from +parent+ and +path+.
-    def create_node(parent, path)
+    # Create atom and/or rss feed files from +path+.
+    def create_node(path)
       page = page_from_path(path)
-      path.meta_info['link'] ||= parent.absolute_lcn
+      path.meta_info['link'] ||= path.parent_path
 
       if MANDATORY_INFOS.any? {|t| path.meta_info[t].nil?}
         raise "One of #{MANDATORY_INFOS.join('/')} information missing for feed <#{path}>"
@@ -26,7 +26,7 @@ module Webgen::SourceHandler
 
       create_feed_node = lambda do |type|
         path.ext = type
-        super(parent, path) do |node|
+        super(path) do |node|
           node.node_info[:feed] = page
           node.node_info[:feed_type] = type
         end
@@ -41,74 +41,48 @@ module Webgen::SourceHandler
 
     # Return the rendered feed represented by +node+.
     def content(node)
-      website.cache[[:sourcehandler_feed, node.node_info[:src]]] = feed_entries(node).map {|n| n.absolute_lcn}
+      website.cache[[:sourcehandler_feed, node.node_info[:src]]] = feed_entries(node).map {|n| n.alcn}
+
       block_name = node.node_info[:feed_type] + '_template'
       if node.node_info[:feed].blocks.has_key?(block_name)
-        node.node_info[:feed].blocks[block_name].
-          render(Webgen::Context.new(:chain => [node])).content
+        node.node_info[:feed].blocks[block_name].render(Webgen::Context.new(:chain => [node])).content
       else
-        feed = (website.cache.volatile[:sourcehandler_feed] ||= {})[node.node_info[:src]] ||= build_feed_for(node)
-        feed.build_xml(node.node_info[:feed_type], (node.node_info[:feed_type] == 'rss' ? node['rss_version'] || 2.0 : nil))
+        chain = [node.resolve("/templates/#{node.node_info[:feed_type]}_feed.template"), node]
+        node.node_info[:used_nodes] << chain.first.alcn
+        chain.first.node_info[:page].blocks['content'].render(Webgen::Context.new(:chain => chain)).content
       end
     end
 
-    # Helper method for returning the entries for the feed node +node+.
+    # Return the entries for the feed +node+.
     def feed_entries(node)
       nr_items = (node['number_of_entries'].to_i == 0 ? 10 : node['number_of_entries'].to_i)
-      patterns = [node['entries']].flatten.map {|pat| Webgen::Common.absolute_path(pat, node.parent.absolute_lcn)}
+      patterns = [node['entries']].flatten.map {|pat| Webgen::Path.make_absolute(node.parent.alcn, pat)}
 
       node.tree.node_access[:alcn].values.
         select {|node| patterns.any? {|pat| node =~ pat} && node.node_info[:page]}.
         sort {|a,b| a['modified_at'] <=> b['modified_at']}[0, nr_items]
     end
 
+    # Return the feed link URL for the feed +node+.
+    def feed_link(node)
+      Webgen::Node.url(File.join(node['site_url'], node.tree[node['link']].path), false)
+    end
+
+    # Return the content of an +entry+ of the feed +node+.
+    def entry_content(node, entry)
+      entry.node_info[:page].blocks[node['content_block_name'] || 'content'].render(Webgen::Context.new(:chain => [entry])).content
+    end
+
     #######
     private
     #######
 
-    # Return the populated FeedTools::Feed object for +node+.
-    def build_feed_for(node)
-      require 'feed_tools'
-      require 'time'
-
-      site_url = node['site_url']
-
-      feed = FeedTools::Feed.new
-      feed.title = node['title']
-      feed.description = node['description']
-      feed.author = node['author']
-      feed.author.url = node['author_url']
-      feed.base_uri = site_url
-      feed.link = File.join(site_url, node.tree[node['link']].path)
-      feed.id = feed.link
-
-      feed.published = (node['created_at'].kind_of?(Time) ? node['created_at'] : Time.now)
-      feed.updated = Time.now
-      feed.generator = 'webgen - Webgen::SourceHandler::Feed'
-
-      node.feed_entries.each do |entry|
-        item = FeedTools::FeedItem.new
-        item.title = entry['title']
-        item.link = File.join(site_url, entry.path)
-        item.content = entry.node_info[:page].blocks[node['content_block_name'] || 'content'].render(Webgen::Context.new(:chain => [entry])).content
-        item.updated = entry['modified_at']
-        item.published = entry['created_at'] if entry['created_at'].kind_of?(Time)
-        if entry['author']
-          item.author = entry['author']
-          item.author.url = entry['author_url']
-        end
-        item.id = item.link
-        feed << item
-      end
-      feed
-    end
-
     # Check if the any of the nodes used by this feed +node+ have changed and then mark the node as
     # dirty.
     def node_changed?(node)
       return if node.node_info[:processor] != self.class.name
       entries = node.feed_entries
-      node.flag(:dirty) if entries.map {|n| n.absolute_lcn } != website.cache[[:sourcehandler_feed, node.node_info[:src]]] ||
+      node.flag(:dirty) if entries.map {|n| n.alcn } != website.cache[[:sourcehandler_feed, node.node_info[:src]]] ||
         entries.any? {|n| n.changed?}
     end
 

data/lib/webgen/sourcehandler/fragment.rb

@@ -46,18 +46,20 @@ module Webgen::SourceHandler
     end
 
     # Create nested fragment nodes under +parent+ from +sections+ (which can be created using
-    # +parse_html_headers+). +path+ is the source path that defines the fragments. The meta
-    # information +in_menu+ of the fragment nodes is set to the parameter +in_menu+ and the meta
-    # info +sort_info+ is calculated from the base +si+ value.
-    def create_fragment_nodes(sections, parent, path, in_menu, si = 1000 )
+    # +parse_html_headers+). +path+ is the source path that defines the fragments (which is not the
+    # same as the creation path for +parent+). The meta information +in_menu+ of the fragment nodes
+    # is set to the parameter +in_menu+ and the meta info +sort_info+ is calculated from the base
+    # +si+ value.
+    def create_fragment_nodes(sections, parent, path, in_menu, si = 1000)
       sections.each do |level, id, title, sub_sections|
-        node = website.blackboard.invoke(:create_nodes, parent.tree, parent.absolute_lcn,
-                                         Webgen::Path.new('#' + id, path.source_path),
-                                         self) do |cn_parent, cn_path|
+        fragment_path = parent.alcn.sub(/#.*$/, '') + '#' + id
+        node = website.blackboard.invoke(:create_nodes,
+                                         Webgen::Path.new(fragment_path, path.source_path),
+                                         self) do |cn_path|
           cn_path.meta_info['title'] = title
           cn_path.meta_info['in_menu'] = in_menu
           cn_path.meta_info['sort_info'] = si = si.succ
-          create_node(cn_parent, cn_path)
+          create_node(cn_path, :parent => parent)
         end.first
         create_fragment_nodes(sub_sections, node, path, in_menu, si.succ)
       end

data/lib/webgen/sourcehandler/memory.rb

@@ -15,23 +15,22 @@ module Webgen::SourceHandler
       end
     end
 
-    # Create a node under +parent+ for the +path+. The +source_alcn+ specified the node that creates
-    # this memory node when written. You have two options for providing the content for this node:
-    # either you set +data+ to a string (or a Webgen::Path::SourceIO object) or you provide a block
-    # which takes the created node as argument and return a string (or a Webgen::Path::SourceIO
-    # object).
-    def create_node(parent, path, source_alcn, data = nil)
-      super(parent, path) do |node|
+    # Create a node for the +path+. The +source_alcn+ specifies the node that creates this memory
+    # node when written. You have two options for providing the content for this node: either you
+    # set +data+ to a string (or a Webgen::Path::SourceIO object) or you provide a block which takes
+    # the created node as argument and returns a string (or a Webgen::Path::SourceIO object).
+    def create_node(path, source_alcn, data = nil)
+      super(path) do |node|
         node.node_info[:memory_source_alcn] = source_alcn
-        (@data ||= {})[node.absolute_lcn] = lambda { data || yield(node) }
+        (@data ||= {})[node.alcn] = lambda { data || yield(node) }
       end
     end
 
     # Return the content of the memory +node+. If the memory node was not created in this webgen
     # run, it will be flagged for reinitialization (and therefore recreation).
     def content(node)
-      if @data && @data[node.absolute_lcn]
-        @data[node.absolute_lcn].call
+      if @data && @data[node.alcn]
+        @data[node.alcn].call
       else
         node.flag(:reinit)
         nil

data/lib/webgen/sourcehandler/metainfo.rb

@@ -22,15 +22,15 @@ module Webgen::SourceHandler
       self.nodes ||= []
     end
 
-    # Create a meta info node from +parent+ and +path+.
-    def create_node(parent, path)
+    # Create a meta info node from +path+.
+    def create_node(path)
       page = page_from_path(path)
-      super(parent, path) do |node|
+      super(path) do |node|
         [[:mi_paths, 'paths'], [:mi_alcn, 'alcn']].each do |mi_key, block_name|
           node.node_info[mi_key] = {}
           if page.blocks.has_key?(block_name) && (data = YAML::load(page.blocks[block_name].content))
             data.each do |key, value|
-              key = Webgen::Common.absolute_path(key, parent.absolute_lcn)
+              key = Webgen::Path.make_absolute(path.parent_path, key)
               node.node_info[mi_key][key] = value
             end
           end
@@ -38,13 +38,13 @@ module Webgen::SourceHandler
 
         mark_all_matched_dirty(node, :no_old_data)
 
-        website.cache.permanent[[:sh_metainfo_node_mi, node.absolute_lcn]] = {
+        website.cache.permanent[[:sh_metainfo_node_mi, node.alcn]] = {
           :mi_paths => node.node_info[:mi_paths],
           :mi_alcn => node.node_info[:mi_alcn]
         }
 
         self.nodes << node unless self.nodes.include?(node)
-        self.nodes = self.nodes.sort_by {|n| n.absolute_lcn}
+        self.nodes = self.nodes.sort_by {|n| n.alcn}
       end
     end
 
@@ -62,7 +62,7 @@ module Webgen::SourceHandler
 
     # Return +true+ if any meta information for +node+ provided by +mi_node+ has changed.
     def meta_info_changed?(mi_node, node, option = nil)
-      cached = website.cache.permanent[[:sh_metainfo_node_mi, mi_node.absolute_lcn]]
+      cached = website.cache.permanent[[:sh_metainfo_node_mi, mi_node.alcn]]
       (mi_node.node_info[:mi_paths].any? do |pattern, mi|
          Webgen::Path.match(node.node_info[:creation_path], pattern) &&
            (option == :force || (!cached && option == :no_old_data) || mi != cached[:mi_paths][pattern])
@@ -87,7 +87,7 @@ module Webgen::SourceHandler
     end
 
     # Update the meta info of matched path before a node is created.
-    def before_node_created(parent, path)
+    def before_node_created(path)
       self.nodes.each do |node|
         node.node_info[:mi_paths].each do |pattern, mi|
           path.meta_info.update(mi) if Webgen::Path.match(path, pattern)
@@ -119,7 +119,7 @@ module Webgen::SourceHandler
     def before_node_deleted(node)
       return unless node.node_info[:processor] == self.class.name
       mark_all_matched_dirty(node, :force)
-      website.cache.permanent.delete([:sh_metainfo_node_mi, node.absolute_lcn])
+      website.cache.permanent.delete([:sh_metainfo_node_mi, node.alcn])
       self.nodes.delete(node)
     end
 

data/lib/webgen/sourcehandler/page.rb

@@ -12,13 +12,13 @@ module Webgen::SourceHandler
       website.blackboard.add_listener(:node_meta_info_changed?, method(:meta_info_changed?))
     end
 
-    # Create a page file from +parent+ and +path+.
-    def create_node(parent, path)
+    # Create a page file from +path+.
+    def create_node(path)
       page = page_from_path(path)
       path.meta_info['lang'] ||= website.config['website.lang']
       path.ext = 'html' if path.ext == 'page'
 
-      super(parent, path) do |node|
+      super(path) do |node|
         node.node_info[:sh_page_node_mi] = Webgen::Page.meta_info_from_data(path.io.data)
         node.node_info[:page] = page
       end
@@ -31,11 +31,11 @@ module Webgen::SourceHandler
       chain = [templates, node].flatten
 
       if chain.first.node_info[:page].blocks.has_key?(block_name)
-        node.node_info[:used_nodes] << chain.first.absolute_lcn
+        node.node_info[:used_nodes] << chain.first.alcn
         context = chain.first.node_info[:page].blocks[block_name].render(Webgen::Context.new(:chain => chain))
         context.content
       else
-        raise "Error rendering <#{node.absolute_lcn}>: no block named '#{block_name}' in <#{chain.first.absolute_lcn}>"
+        raise "Error rendering <#{node.alcn}>: no block named '#{block_name}' in <#{chain.first.alcn}>"
       end
     end
     alias_method :content, :render_node