webgen 0.5.2 → 0.5.3

data/lib/webgen/cli/webgui_command.rb

@@ -20,7 +20,8 @@ module Webgen::CLI
       $:.shift
       require 'ramaze'
       Ramaze::Log.loggers = []
-      def Ramaze.shutdown; end
+      def Ramaze.shutdown; # :nodoc:
+      end
 
       acquire Webgen.data_dir/:webgui/:controller/'*'
       Ramaze::Global.setup do |g|

data/lib/webgen/common.rb

@@ -0,0 +1,10 @@
+module Webgen
+
+  # Namespace for classes that provide common functionality.
+  module Common
+
+    autoload :Sitemap, 'webgen/common/sitemap'
+
+  end
+
+end

data/lib/webgen/common/sitemap.rb

@@ -0,0 +1,76 @@
+require 'webgen/tag/menu'
+require 'webgen/websiteaccess'
+
+module Webgen::Common
+
+  # This class provides functionality for creating sitemaps and checking if a sitemap has changed.
+  class Sitemap
+
+    include Webgen::WebsiteAccess
+
+    def initialize #:nodoc:
+      website.blackboard.add_listener(:node_changed?, method(:node_changed?))
+    end
+
+    # Return the sitemap tree as Webgen::Tag::Menu::MenuNode created for the +node+ in the language
+    # +lang+ using the provided +options+ which can be any configuration option starting with
+    # <tt>common.sitemap</tt>.
+    def create_sitemap(node, lang, options)
+      @options = options
+      tree = recursive_create(nil, node.tree.root, lang).sort!
+      @options = nil
+      (node.node_info[:common_sitemap] ||= {})[[options.to_a.sort, lang]] = tree.to_lcn_list
+      tree
+    end
+
+    #######
+    private
+    #######
+
+    # Recursively create the sitemap.
+    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))
+        [(!n.children.empty? || sub_in_sitemap ? n : nil), sub_in_sitemap]
+      end.each do |n, sub_in_sitemap|
+        next if n.nil?
+        sub_node = recursive_create(mnode, n, lang, sub_in_sitemap)
+        mnode.children << sub_node unless sub_node.nil?
+      end
+      (mnode.children.empty? && !in_sitemap ? nil : mnode)
+    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.
+    def option(name)
+      (@options && @options.has_key?(name) ? @options[name] : website.config[name])
+    end
+
+    # Check if the sitemaps for +node+ have changed.
+    def node_changed?(node)
+      return if !node.node_info[:common_sitemap]
+
+      node.node_info[:common_sitemap].each do |(options, lang), cached_tree|
+        @options = options.to_hash
+        tree = recursive_create(nil, node.tree.root, lang).sort!.to_lcn_list
+        @options = nil
+
+        if (tree != cached_tree) ||
+            (tree.flatten.any? do |alcn|
+               (n = node.tree[alcn]) && (r = n.routing_node(lang)) && r.meta_info_changed?
+             end)
+          node.dirty = true
+          break
+        end
+      end
+    end
+
+
+  end
+
+end

data/lib/webgen/configuration.rb

@@ -6,7 +6,9 @@ module Webgen
   #
   #   config.my.new.config 'value', :doc => 'some', :meta => 'info'
   #
-  # and later accessed or set using the accessor methods #[] and #[]=.
+  # and later accessed or set using the accessor methods #[] and #[]= or a configuration
+  # helper. These helpers are defined in the Helpers module and provide easier access to complex
+  # configuration options.
   class Configuration
 
     # Helper class for providing an easy method to define configuration options.
@@ -32,6 +34,67 @@ module Webgen
 
     end
 
+    # This module provides methods for setting more complex configuration options. It is mixed into
+    # Webgen::Configuration so that it methods can be used. Detailed information on the use of the
+    # methods can be found in the "User Manual" in the "Configuration File" section.
+    #
+    # All public methods defined in this module are available for direct use in the
+    # configuration file, e.g. the method named +default_meta_info+ can be used like this:
+    #
+    #   default_meta_info:
+    #     Webgen::SourceHandler::Page:
+    #       in_menu : true
+    #       :action : replace
+    #
+    # All methods have to take exactly one argument, a Hash.
+    #
+    # The special key <tt>:action</tt> should be used for specifying how the configuration option
+    # should be set:
+    #
+    #   replace::  Replace the configuration option with the new values.
+    #   modify::   Replace old values with new values and add missing ones (useful for hashes and
+    #              normally the default value)
+    module Helpers
+
+      # Set the default meta information for source handlers.
+      def default_meta_info(args)
+        args.each do |sh_name, mi|
+          raise ArgumentError, 'Invalid argument for configuration helper default_meta_info' unless mi.kind_of?(Hash)
+          action = mi.delete(:action) || 'modify'
+          mi_hash = (self['sourcehandler.default_meta_info'][complete_source_handler_name(sh_name)] ||= {})
+          case action
+          when 'replace' then mi_hash.replace(mi)
+          else mi_hash.update(mi)
+          end
+        end
+      end
+
+
+      # Set the path patterns used by source handlers.
+      def patterns(args)
+        args.each do |sh_name, data|
+          pattern_arr = (self['sourcehandler.patterns'][complete_source_handler_name(sh_name)] ||= [])
+          case data
+          when Array then pattern_arr.replace(data)
+          when Hash
+            (data['del'] || []).each {|pat| pattern_arr.delete(pat)}
+            (data['add'] || []).each {|pat| pattern_arr << pat}
+          else
+            raise ArgumentError, 'Invalid argument for configuration helper patterns'
+          end
+        end
+      end
+
+      # Complete +sh_name+ by checking if a source handler called
+      # <tt>Webgen::SourceHandler::SH_NAME</tt> exists.
+      def complete_source_handler_name(sh_name)
+        (Webgen::SourceHandler.constants.include?(sh_name) ? 'Webgen::SourceHandler::' + sh_name : sh_name)
+      end
+      private :complete_source_handler_name
+    end
+
+    include Helpers
+
     # The hash which stores the meta info for the configuration options.
     attr_reader :meta_info
 

data/lib/webgen/contentprocessor.rb

@@ -36,7 +36,7 @@ module Webgen
   #         context.content.gsub!(/#{context.content_node['replace_key']}:([\w\/.]+)/ ) do |match|
   #           link_node = context.ref_node.resolve($1, context.content_node.lang)
   #           if link_node
-  #             context.dest_node.link_to(link_node)
+  #             context.dest_node.link_to(link_node, :lang => context.content_node.lang)
   #           else
   #             match
   #           end

data/lib/webgen/contentprocessor/builder.rb

@@ -18,7 +18,7 @@ module Webgen::ContentProcessor
       context.content = xml.target!
       context
     rescue Exception => e
-      raise RuntimeError, "Error using Builder to generate XML: #{e.message}", e.backtrace
+      raise RuntimeError, "Error using Builder in <#{context.ref_node.absolute_lcn}> to generate XML: #{e.message}", e.backtrace
     end
 
   end

data/lib/webgen/contentprocessor/erb.rb

@@ -16,7 +16,7 @@ module Webgen::ContentProcessor
       context.content = erb.result(binding)
       context
     rescue Exception => e
-      raise RuntimeError, "Erb processing failed: #{e.message}", e.backtrace
+      raise RuntimeError, "Erb processing failed in <#{context.ref_node.absolute_lcn}>: #{e.message}", e.backtrace
     end
 
   end

data/lib/webgen/contentprocessor/haml.rb

@@ -17,7 +17,7 @@ module Webgen::ContentProcessor
         render(Object.new, locals)
       context
     rescue Exception => e
-      raise RuntimeError, "Error converting Haml markup to HTML: #{e.message}", e.backtrace
+      raise RuntimeError, "Error converting Haml markup to HTML in <#{context.ref_node.absolute_lcn}>: #{e.message}", e.backtrace
     end
 
   end

data/lib/webgen/contentprocessor/maruku.rb

@@ -10,7 +10,7 @@ module Webgen::ContentProcessor
       context.content = ::Maruku.new(context.content, :on_error => :raise).to_html
       context
     rescue Exception => e
-      raise RuntimeError, "Maruku to HTML conversion failed: #{e.message}", e.backtrace
+      raise RuntimeError, "Maruku to HTML conversion failed for <#{context.ref_node.absolute_lcn}>: #{e.message}", e.backtrace
     end
 
   end

data/lib/webgen/contentprocessor/sass.rb

@@ -10,7 +10,7 @@ module Webgen::ContentProcessor
       context.content = ::Sass::Engine.new(context.content, :filename => context.ref_node.absolute_lcn).render
       context
     rescue Exception => e
-      raise RuntimeError, "Error converting Sass markup to CSS: #{e.message}", e.backtrace
+      raise RuntimeError, "Error converting Sass markup to CSS in <#{context.ref_node.absolute_lcn}>: #{e.message}", e.backtrace
     end
 
   end

data/lib/webgen/coreext.rb

@@ -0,0 +1,10 @@
+# :nodoc:
+class Array
+
+  def to_hash # :nodoc:
+    h = {}
+    self.each {|k,v| h[k] = v}
+    h
+  end
+
+end

data/lib/webgen/default_config.rb

@@ -49,11 +49,15 @@ config.sourcehandler.patterns({
                                 'Webgen::SourceHandler::Metainfo' => ['**/metainfo', '**/*.metainfo'],
                                 'Webgen::SourceHandler::Template' => ['**/*.template'],
                                 'Webgen::SourceHandler::Page' => ['**/*.page'],
-                                'Webgen::SourceHandler::Virtual' => ['**/virtual', '**/*.virtual']
+                                'Webgen::SourceHandler::Virtual' => ['**/virtual', '**/*.virtual'],
+                                'Webgen::SourceHandler::Feed' => ['**/*.feed'],
+                                'Webgen::SourceHandler::Sitemap' => ['**/*.sitemap']
                               }, :doc => 'Source handler to path pattern map')
 config.sourcehandler.invoke({
                               1 => ['Webgen::SourceHandler::Directory', 'Webgen::SourceHandler::Metainfo', 'Webgen::SourceHandler::Directory'],
-                              5 => ['Webgen::SourceHandler::Copy', 'Webgen::SourceHandler::Template', 'Webgen::SourceHandler::Page'],
+                              5 => ['Webgen::SourceHandler::Copy', 'Webgen::SourceHandler::Template',
+                                    'Webgen::SourceHandler::Page', 'Webgen::SourceHandler::Feed',
+                                    'Webgen::SourceHandler::Sitemap'],
                               9 => ['Webgen::SourceHandler::Virtual']
                             }, :doc => 'All source handlers listed here are used by webgen and invoked according to their priority setting')
 config.sourcehandler.casefold(true, :doc => 'Specifies whether path are considered to be case-sensitive')
@@ -65,18 +69,35 @@ config.sourcehandler.default_meta_info({
                                          :all => {
                                            'output_path_style' => [:parent, :cnbase, ['.', :lang], :ext]
                                          },
+                                         'Webgen::SourceHandler::Copy' => {
+                                           'kind' => 'asset'
+                                         },
                                          'Webgen::SourceHandler::Directory' => {
-                                           'index_path' => 'index.html'
+                                           'index_path' => 'index.html',
+                                           'kind' => 'directory'
                                          },
                                          'Webgen::SourceHandler::Page' => {
+                                           'kind' => 'page',
                                            'fragments_in_menu' => true,
                                            'blocks' => {'default' => {'pipeline' => 'erb,tags,maruku,blocks'}}
                                          },
+                                         'Webgen::SourceHandler::Fragment' => {
+                                           'kind' => 'fragment'
+                                         },
                                          'Webgen::SourceHandler::Template' => {
                                            'blocks' => {'default' => {'pipeline' => 'erb,tags,blocks'}}
                                          },
                                          'Webgen::SourceHandler::Metainfo' => {
                                            'blocks' => {1 => {'name' => 'paths'}, 2 => {'name' => 'alcn'}}
+                                         },
+                                         'Webgen::SourceHandler::Feed' => {
+                                           'rss' => true,
+                                           'atom' => true
+                                         },
+                                         'Webgen::SourceHandler::Sitemap' => {
+                                           'default_priority' => 0.5,
+                                           'default_change_freq' => 'weekly',
+                                           'common.sitemap.any_lang' => true
                                          }
                                        }, :doc => "Default meta information for all nodes and for nodes belonging to a specific source handler")
 
@@ -121,6 +142,7 @@ config.contentprocessor.tags.map({
                                    'execute_cmd' => 'Webgen::Tag::ExecuteCommand',
                                    'coderay' => 'Webgen::Tag::Coderay',
                                    'date' => 'Webgen::Tag::Date',
+                                   'sitemap' => 'Webgen::Tag::Sitemap',
                                    :default => 'Webgen::Tag::Metainfo'
                                  }, :doc => 'Tag processor name to class map')
 
@@ -133,8 +155,9 @@ config.tag.menu.show_current_subtree_only(true, :doc => 'Specifies whether only
 config.tag.menu.used_nodes('all', :doc => 'Specifies the kind of nodes that should be used: all, files, or fragments')
 
 config.tag.breadcrumbtrail.separator(' / ', :doc => 'Separates the hierachy entries from each other.')
-config.tag.breadcrumbtrail.omit_last(false, :doc => 'Omits the last path component.')
 config.tag.breadcrumbtrail.omit_index_path(false, :doc => 'Omits the last path component if it is an index path.')
+config.tag.breadcrumbtrail.start_level(0, :doc => 'The level at which the breadcrumb trail starts.')
+config.tag.breadcrumbtrail.end_level(-1, :doc => 'The level at which the breadcrumb trail ends.')
 
 config.tag.langbar.separator(' | ', :doc => 'Separates the languages from each other.')
 config.tag.langbar.show_single_lang(true, :doc => 'Should the link be shown although the page is only available in one language?')
@@ -157,3 +180,11 @@ config.tag.coderay.bold_every(10, :doc => 'The interval at which the line number
 config.tag.coderay.tab_width(8, :doc => 'Number of spaces used for a tabulator')
 
 config.tag.date.format('%Y-%m-%d %H:%M:%S', :doc => 'The format of the date (same options as Ruby\'s Time#strftime)')
+
+
+# All things regarding common functionality
+website.autoload_service(:create_sitemap, 'Webgen::Common::Sitemap')
+
+config.common.sitemap.honor_in_menu(false, :doc => 'Only include pages that are also in the menu if true')
+config.common.sitemap.any_lang(false, :doc => 'Use nodes in any language if true')
+config.common.sitemap.used_kinds(['page'], :doc => 'Array of node kinds that is used for the sitemap')

data/lib/webgen/node.rb

@@ -119,6 +119,7 @@ module Webgen
     # Return +true+ if the node has changed since the last webgen run. If it has changed, +dirty+ is
     # set to +true+.
     def changed?
+      @dirty = @dirty || meta_info_changed?
       @dirty = node_info[:used_nodes].any? {|n| n != @absolute_lcn && (!tree[n] || tree[n].changed?)} unless @dirty
       website.blackboard.dispatch_msg(:node_changed?, self) unless @dirty
       @dirty
@@ -274,18 +275,23 @@ module Webgen
     # 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 <tt>:link_text</tt> is present in the attributes, it will be
-    # used as the link text; otherwise the title of the +node+ will be used. Be aware that all
-    # key-value pairs with Symbol keys are removed before the attributes are written. Therefore you
-    # always need to specify general attributes with Strings!
+    # information. Be aware that all key-value pairs with Symbol keys are removed before the
+    # attributes are written. Therefore you always need to specify general attributes with Strings!
+    #
+    # If the special value <tt>:link_text</tt> is present in the attributes, it will be used as the
+    # link text; otherwise the title of the +node+ will be used.
+    #
+    # If the special value <tt>:lang</tt> is present in the attributes, it will be used as parameter
+    # to the <tt>node.routing_node</tt> call for getting the linked-to node instead of this node's
+    # +lang+ attribute. Note: this is only useful when linking to a directory.
     def link_to(node, attr = {})
       attr = node['link_attrs'].merge(attr) if node['link_attrs'].kind_of?(Hash)
-      rnode = node.routing_node(@lang)
+      rnode = node.routing_node(attr[:lang] || @lang)
       link_text = attr[:link_text] || (rnode != node && rnode['routed_title']) || node['title']
       attr.delete_if {|k,v| k.kind_of?(Symbol)}
 
       use_link = (rnode != self || website.config['website.link_to_current_page'])
-      attr['href'] = self.route_to(node) if use_link
+      attr['href'] = self.route_to(rnode) if use_link
       attrs = attr.collect {|name,value| "#{name.to_s}=\"#{value}\"" }.sort.unshift('').join(' ')
       (use_link ? "<a#{attrs}>#{link_text}</a>" : "<span#{attrs}>#{link_text}</span>")
     end

data/lib/webgen/page.rb

@@ -44,7 +44,7 @@ module Webgen
   class Page
 
     RE_META_INFO_START = /\A---\s*(?:\n|\r|\r\n)/m
-    RE_META_INFO = /\A---\s*(?:\n|\r|\r\n).*?(?:\n|\r|\r\n)(?=---.*?(?:\n|\r|\r\n))/m
+    RE_META_INFO = /\A---\s*(?:\n|\r|\r\n).*?(?:\n|\r|\r\n)(?=---.*?(?:\n|\r|\r\n)|\Z)/m
     RE_BLOCKS_OPTIONS = /^--- *?(?: *((?:\w+:[^\s]* *)*))?$|^$/
     RE_BLOCKS_START = /^--- .*?$|^--- *$/
     RE_BLOCKS = /(?:(#{RE_BLOCKS_START})|\A)(.*?)(?:(?=#{RE_BLOCKS_START})|\Z)/m

data/lib/webgen/path.rb

@@ -169,7 +169,7 @@ module Webgen
       @directory = File.join(File.dirname(path), '/')
       matchData = FILENAME_RE.match(@basename)
 
-      @meta_info['sort_info'] = matchData[1].to_i
+      @meta_info['sort_info'] = (matchData[1].nil? ? nil : matchData[1].to_i)
       @cnbase                 = matchData[2]
       @meta_info['lang']      = Webgen::LanguageManager.language_for_code(matchData[3])
       @ext                    = (@meta_info['lang'].nil? && !matchData[3].nil? ? matchData[3].to_s + '.' : '') + matchData[4].to_s

data/lib/webgen/sourcehandler.rb

@@ -17,6 +17,8 @@ module Webgen
     autoload :Page, 'webgen/sourcehandler/page'
     autoload :Fragment, 'webgen/sourcehandler/fragment'
     autoload :Virtual, 'webgen/sourcehandler/virtual'
+    autoload :Feed, 'webgen/sourcehandler/feed'
+    autoload :Sitemap, 'webgen/sourcehandler/sitemap'
 
     # This class is used by Website to do the actual rendering of the website. It
     #
@@ -142,7 +144,7 @@ module Webgen
                  else
                    source_handler.create_node(parent, path.dup)
                  end
-        nodes.compact.each do |node|
+        nodes.flatten.compact.each do |node|
           website.blackboard.dispatch_msg(:after_node_created, node)
         end
         nodes
@@ -154,13 +156,16 @@ module Webgen
           merge(website.config['sourcehandler.default_meta_info'][sh_name] || {})
       end
 
-      # Check if the default meta information for +node+ has changed since the last run.
+      # Check if the default meta information for +node+ has changed since the last run. But don't
+      # take the node's path's +modified_at+ meta information into account since that changes on
+      # every path change.
       def meta_info_changed?(node)
         path = node.node_info[:src]
-        cached_mi = website.cache[:sourcehandler_path_mi][[path, node.node_info[:processor]]]
-        if !cached_mi || cached_mi != default_meta_info(@paths[path], node.node_info[:processor])
-          node.dirty_meta_info = true
-        end
+        old_mi = website.cache[:sourcehandler_path_mi][[path, node.node_info[:processor]]]
+        old_mi.delete('modified_at')
+        new_mi = default_meta_info(@paths[path], node.node_info[:processor])
+        new_mi.delete('modified_at')
+        node.dirty_meta_info = true if !old_mi || old_mi != new_mi
       end
 
       # Clean the +tree+ by deleting nodes which have changed or which don't have an associated

data/lib/webgen/sourcehandler/base.rb

@@ -152,11 +152,14 @@ module Webgen::SourceHandler
       parent.tree[Webgen::Node.absolute_name(parent, path.lcn, :alcn)] || (!path.meta_info['no_output'] && parent.tree[output_path, :path])
     end
 
-    # Create and return a node under +parent+ from +path+ if it does not already exists. The created
-    # node is yielded if a block is given.
+    # Create and return a node under +parent+ from +path+ if it does not already exists. Some
+    # additional node information like <tt>:src</tt> and <tt>:processor</tt> is set and the meta
+    # information is checked for validness. The created node is yielded if a block is given.
     def create_node(parent, path, output_path = self.output_path(parent, path))
+      return if path.meta_info['draft']
       if !node_exists?(parent, path, output_path)
         node = Webgen::Node.new(parent, output_path, path.cn, path.meta_info)
+        node['modified_at'] = Time.now unless node['modified_at'].kind_of?(Time)
         node.node_info[:src] = path.path
         node.node_info[:processor] = self.class.name
         yield(node) if block_given?