webgen 0.5.6 → 0.5.7

data/lib/webgen/common.rb

@@ -1,10 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+require 'pathname'
+
 module Webgen
 
-  # Namespace for classes that provide common functionality.
+  # Namespace for classes and methods that provide common functionality.
   module Common
 
     autoload :Sitemap, 'webgen/common/sitemap'
 
+    # Make the given +path+ absolute by prepending the absolute path +base+ if necessary. Also
+    # resolves all '..'  and '.' references in +path+.
+    def self.absolute_path(path, base)
+      raise(ArgumentError, 'base has to be an absolute path') unless base =~ /\//
+      Pathname.new(path =~ /^\// ? path : File.join(base, path)).cleanpath.to_s
+    end
+
   end
 
 end

data/lib/webgen/common/sitemap.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'webgen/tag'
 require 'webgen/websiteaccess'
 
@@ -31,10 +33,7 @@ module Webgen::Common
     def recursive_create(parent, node, lang, in_sitemap = true)
       mnode = Webgen::Tag::Menu::MenuNode.new(parent, node)
       node.children.map do |n|
-        sub_in_sitemap = ((option('common.sitemap.used_kinds').empty? || option('common.sitemap.used_kinds').include?(n['kind'])) &&
-                          (option('common.sitemap.any_lang') || n.lang.nil? || n.lang == lang) &&
-                          (!option('common.sitemap.honor_in_menu') || n['in_menu']) &&
-                          (parent.nil? || node.routing_node(lang) != n))
+        sub_in_sitemap = in_sitemap?(n, lang)
         [(!n.children.empty? || sub_in_sitemap ? n : nil), sub_in_sitemap]
       end.each do |n, sub_in_sitemap|
         next if n.nil?
@@ -44,6 +43,15 @@ module Webgen::Common
       (mnode.children.empty? && !in_sitemap ? nil : mnode)
     end
 
+    # Return +true+ if the +child+ of the +node+ is in the sitemap for the language +lang+.
+    def in_sitemap?(child, lang, allow_index_file = false)
+      ((option('common.sitemap.used_kinds').empty? || option('common.sitemap.used_kinds').include?(child['kind']) ||
+        (child.routing_node(lang, false) != child && in_sitemap?(child.routing_node(lang), lang, true))) &&
+       (option('common.sitemap.any_lang') || child.lang.nil? || child.lang == lang) &&
+       (!option('common.sitemap.honor_in_menu') || child['in_menu']) &&
+       (allow_index_file || child.parent == child.tree.root || child.parent.routing_node(lang) != child))
+    end
+
     # Retrieve the configuration option value for +name+. The value is taken from the current
     # configuration options hash if +name+ is specified there or from the website configuration
     # otherwise.

data/lib/webgen/configuration.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'facets/symbol/to_proc'
 
 module Webgen

data/lib/webgen/contentprocessor.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen
 
   # Namespace for all content processors.

data/lib/webgen/contentprocessor/blocks.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen::ContentProcessor
 
   # Replaces special xml tags with the rendered content of a node.
@@ -5,7 +7,8 @@ module Webgen::ContentProcessor
 
     include Webgen::Loggable
 
-    BLOCK_RE = /<webgen:block\s+name=('|")(\w+)\1\s*(?:\schain=('|")([^'"]+)\3\s*)?\s*\/>/
+    BLOCK_RE = /<webgen:block\s*?((?:\s\w+=('|")[^'"]+\2)+)\s*\/>/
+    BLOCK_ATTR_RE = /(\w+)=('|")([^'"]+)\2/
 
     # Replace that webgen:block xml tags with the rendered content of a node.
     def call(context)
@@ -13,11 +16,12 @@ module Webgen::ContentProcessor
       new_chain = (chain.length > 1 ? chain[1..-1] : chain)
 
       context.content.gsub!(BLOCK_RE) do |match|
-        block_name = $2
-        if $4.nil?
-          used_chain = new_chain
+        attr = {}
+        match.scan(BLOCK_ATTR_RE) {|name, sep, content| attr[name] = content}
+        if attr['chain'].nil?
+          used_chain = new_chain.dup
         else
-          paths = $4.split(';')
+          paths = attr['chain'].split(';')
           used_chain = paths.collect do |path|
             temp_node = context.ref_node.resolve(path.strip, context.dest_node.lang)
             log(:error) { "Could not resolve <#{path.strip}> in <#{context.ref_node.absolute_lcn}> in '#{match.to_s}'" } if temp_node.nil?
@@ -26,14 +30,24 @@ module Webgen::ContentProcessor
           next match if used_chain.length != paths.length
           dest_node = context.content_node
         end
+
+        if attr['node'] == 'first'
+          used_chain.shift while used_chain.length > 0 && !used_chain.first.node_info[:page].blocks.has_key?(attr['name'])
+        end
         block_node = used_chain.first
 
-        if !block_node.node_info[:page].blocks.has_key?(block_name)
-          raise "Node <#{block_node.absolute_lcn}> has no block named '#{block_name}'"
+        if !block_node || !block_node.node_info[:page].blocks.has_key?(attr['name'])
+          if attr['notfound'] == 'ignore'
+            next ''
+          elsif block_node
+            raise "Node <#{block_node.absolute_lcn}> has no block named '#{attr['name']}'"
+          else
+            raise "No node in the chain has a block named '#{attr['name']}'"
+          end
         end
 
         context.dest_node.node_info[:used_nodes] << block_node.absolute_lcn
-        tmp_context = block_node.node_info[:page].blocks[block_name].render(context.clone(:chain => used_chain, :dest_node => dest_node))
+        tmp_context = block_node.node_info[:page].blocks[attr['name']].render(context.clone(:chain => used_chain, :dest_node => dest_node))
         tmp_context.content
       end
       context

data/lib/webgen/contentprocessor/builder.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen::ContentProcessor
 
   # Processes content that is valid Ruby to build an XML tree. This is done by using the +builder+

data/lib/webgen/contentprocessor/context.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen::ContentProcessor
 
   # The context object that is passed to the +call+ method of a content processor.

data/lib/webgen/contentprocessor/erb.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen::ContentProcessor
 
   # Processes embedded Ruby statements.

data/lib/webgen/contentprocessor/erubis.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen::ContentProcessor
 
   # Processes embedded Ruby statements with the +erubis+ library.

data/lib/webgen/contentprocessor/fragments.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen::ContentProcessor
 
   # Uses the HTML headers h1, h2, ..., h6 to generate nested fragment nodes.

data/lib/webgen/contentprocessor/haml.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen::ContentProcessor
 
   # Processes content in Haml markup using the +haml+ library.

data/lib/webgen/contentprocessor/maruku.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen::ContentProcessor
 
   # Processes content in Markdown format using the +maruku+ library.

data/lib/webgen/contentprocessor/rdiscount.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen::ContentProcessor
 
   # Processes content in Markdown markup with the fast +rdiscount+ library.

data/lib/webgen/contentprocessor/rdoc.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen::ContentProcessor
 
   # Converts content in RDoc markup (the native Ruby documentation format) to HTML. Needs the newer

data/lib/webgen/contentprocessor/redcloth.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen::ContentProcessor
 
   # Processes content in Textile format using the +redcloth+ library.

data/lib/webgen/contentprocessor/sass.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen::ContentProcessor
 
   # Processes content in Sass markup (used for writing CSS files) using the +haml+ library.

data/lib/webgen/contentprocessor/tags.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'yaml'
 require 'strscan'
 require 'webgen/tag'

data/lib/webgen/coreext.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 # :nodoc:
 class Array
 

data/lib/webgen/default_config.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 website = Webgen::WebsiteAccess.website
 config = website.config
 
@@ -44,7 +46,7 @@ config.sources [['/', "Webgen::Source::FileSystem", 'src']], :doc => 'One or mor
 
 # All things regarding source handler
 config.sourcehandler.patterns({
-                                'Webgen::SourceHandler::Copy' => ['**/*.css', '**/*.js', '**/*.html', '**/*.gif', '**/*.jpg', '**/*.png'],
+                                'Webgen::SourceHandler::Copy' => ['**/*.css', '**/*.js', '**/*.html', '**/*.gif', '**/*.jpg', '**/*.png', '**/*.ico'],
                                 'Webgen::SourceHandler::Directory' => ['**/'],
                                 'Webgen::SourceHandler::Metainfo' => ['**/metainfo', '**/*.metainfo'],
                                 'Webgen::SourceHandler::Template' => ['**/*.template'],
@@ -175,6 +177,7 @@ config.tag.langbar.separator(' | ', :doc => 'Separates the languages from each o
 config.tag.langbar.show_single_lang(true, :doc => 'Should the link be shown although the page is only available in one language?')
 config.tag.langbar.show_own_lang(true, :doc => 'Should the link to the currently displayed language page be shown?')
 config.tag.langbar.lang_names({}, :doc => 'A map from language code to language names')
+config.tag.langbar.process_output(false, :doc => 'The content of the language bar will be scanned for tags if true.')
 
 config.tag.includefile.filename(nil, :doc => 'The name of the file which should be included (relative to the website).', :mandatory => 'default')
 config.tag.includefile.process_output(true, :doc => 'The file content will be scanned for tags if true.')

data/lib/webgen/languages.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen
 
   # Describes a human language which is uniquely identfied by a three letter code and, optionally,

data/lib/webgen/loggable.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'webgen/websiteaccess'
 
 module Webgen

data/lib/webgen/logger.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'stringio'
 require 'logger'
 

data/lib/webgen/node.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'webgen/websiteaccess'
 require 'webgen/loggable'
 require 'webgen/path'
@@ -75,13 +77,13 @@ module Webgen
 
     # Re-initializes an already initialized node and resets it to its pristine state.
     def reinit(path, meta_info = {})
-      old_path = @path
+      old_path = @path if defined?(@path)
       @path = path.freeze
       @lang = Webgen::LanguageManager.language_for_code(meta_info.delete('lang'))
       @lang = nil unless is_file?
       @meta_info = meta_info
       @flags = Set.new([:dirty, :created])
-      if @tree
+      if defined?(@tree)
         @tree.node_access[:path].delete(old_path) if old_path
         @tree.register_path(self)
         self.node_info.clear
@@ -129,13 +131,15 @@ module Webgen
       @flags.include?(key)
     end
 
-    # Flag the node with the +keys+. See #flagged for valid keys.
+    # Flag the node with the +keys+ and dispatch the message <tt>:node_flagged</tt> with +self+ and
+    # +keys+ as arguments. See #flagged for valid keys.
     def flag(*keys)
       @flags += keys
       website.blackboard.dispatch_msg(:node_flagged, self, keys)
     end
 
-    # Remove the flags +keys+ from the node.
+    # Remove the flags +keys+ from the node and dispatch the message <tt>:node_unflagged</tt> with
+    # +self+ and +keys+ as arguments.
     def unflag(*keys)
       @flags.subtract(keys)
       website.blackboard.dispatch_msg(:node_unflagged, self, keys)
@@ -143,6 +147,10 @@ module Webgen
 
     # Return +true+ if the node has changed since the last webgen run. If it has changed, +dirty+ is
     # set to +true+.
+    #
+    # Sends the message <tt>:node_changed?</tt> with +self+ as argument unless the node is already
+    # dirty. A listener to this message should set the flag <tt>:dirty</tt> on the passed node if he
+    # thinks it is dirty.
     def changed?
       if_not_checked(:node) do
         flag(:dirty) if meta_info_changed? ||
@@ -153,6 +161,11 @@ module Webgen
     end
 
     # Return +true+ if the meta information of the node has changed.
+    #
+    # Sends the message <tt>:node_meta_info_changed?</tt> with +self+ as argument unless the meta
+    # information of the node is already dirty. A listener to this message should set the flag
+    # <tt>:dirt_meta_info</tt> on the passed node if he thinks that the node's meta information is
+    # dirty.
     def meta_info_changed?
       if_not_checked(:meta_info) do
         flag(:dirty_meta_info) if node_info[:used_meta_info_nodes].any? do |n|
@@ -271,8 +284,9 @@ module Webgen
 
     # Return the routing node in language +lang+ which is the node that is used when routing to this
     # node. The returned node can differ from the node itself in case of a directory where the
-    # routing node is the directory index node.
-    def routing_node(lang)
+    # routing node is the directory index node. If +show_warning+ is +true+ and this node is a
+    # directory node, then a warning is logged if no associated index file is found.
+    def routing_node(lang, log_warning = true)
       if !is_directory?
         self
       else
@@ -288,12 +302,12 @@ module Webgen
           if index_node
             vcache[key] = index_node
             log(:info) { "Directory index path for <#{absolute_lcn}> => <#{index_node.absolute_lcn}>" }
-          else
+          elsif log_warning
             vcache[key] = self
             log(:warn) { "No directory index path found for directory <#{absolute_lcn}>" }
           end
         end
-        vcache[key]
+        vcache[key] || self
       end
     end
 

data/lib/webgen/output.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen
 
   # Namespace for all classes that know how to write out node content.
@@ -14,7 +16,7 @@ module Webgen
   #   Delete the given output path.
   # <tt>write(path, data, type)</tt>::
   #   Write the data to the given output path. The parameter +type+ specifies the type of the
-  #   to be written path: +:file+ or +:directory+.
+  #   to be written path: <tt>:file</tt> or <tt>:directory</tt>.
   # <tt>read(path)</tt>:
   #   Return the content of the given path if it exists or raise an error otherwise.
   #

data/lib/webgen/output/filesystem.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'fileutils'
 
 module Webgen::Output

data/lib/webgen/page.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'yaml'
 
 module Webgen

data/lib/webgen/path.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'webgen/languages'
 
 module Webgen
@@ -73,7 +75,7 @@ module Webgen
     # the content of the path.
     def initialize(path, source_path = path, &ioblock)
       @meta_info = {}
-      @io = SourceIO.new(&ioblock) if block_given?
+      @io = block_given? ? SourceIO.new(&ioblock) : nil
       @source_path = source_path
       analyse(path)
     end

data/lib/webgen/source.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen
 
   # Namespace for all classes that provide source paths.

data/lib/webgen/source/filesystem.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'pathname'
 require 'webgen/websiteaccess'
 require 'webgen/path'
@@ -45,12 +47,13 @@ module Webgen
 
     # Return all paths under #root which match #glob.
     def paths
-      @paths ||= Dir.glob(File.join(@root, @glob), File::FNM_DOTMATCH|File::FNM_CASEFOLD).to_set.collect! do |f|
+      @paths ||= Dir.glob(File.join(@root, @glob), File::FNM_DOTMATCH|File::FNM_CASEFOLD).to_set.collect do |f|
+        next unless File.exists?(f) # handle invalid links
         temp = Pathname.new(f.sub(/^#{Regexp.escape(@root)}\/?/, '/')).cleanpath.to_s
         temp += '/' if File.directory?(f) && temp[-1] != ?/
         path = Path.new(temp, f)
         path
-      end
+      end.compact
     end
 
   end

data/lib/webgen/source/resource.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'webgen/websiteaccess'
 require 'webgen/source'
 

data/lib/webgen/source/stacked.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen::Source
 
   # This source class is used to stack several sources together.