webgen 0.3.2 → 0.3.3

data/doc/src/meta.info

@@ -1,22 +1,17 @@
-index.page:
-  en:
-    menuOrder: 1
+index.html:
+  menuOrder: 1
 
-download.page:
-  en:
-    menuOrder: 3
+download.html:
+  menuOrder: 3
 
-features.page:
-  en:
-    menuOrder: 5
+features.html:
+  menuOrder: 5
 
-api.page:
-  en:
-    dest: rdoc/index.html
-    title: API Reference
-    menuOrder: 7
-    inMenu: true
+api.html:
+  dest: rdoc/index.html
+  title: API Reference
+  menuOrder: 7
+  inMenu: true
 
-documentation/index.page:
-  en:
-    menuOrder: 9
+documentation/index.html:
+  menuOrder: 9

data/install.rb

@@ -3,7 +3,7 @@ require 'rpa/install'
 
 class Install_webgen < RPA::Install::FullInstaller
   name 'webgen'
-  version '0.3.2-1'
+  version '0.3.3-1'
   classification Application
   build do
     installdocs %w[COPYING ChangeLog TODO]

data/lib/webgen/configuration.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: configuration.rb 229 2005-03-17 09:20:12Z thomas $
+# $Id: configuration.rb 259 2005-04-21 10:37:47Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,12 +20,10 @@
 #++
 #
 
-require 'yaml'
-require 'ostruct'
 require 'find'
 require 'tsort'
 require 'webgen/node'
-require 'webgen/logging'
+require 'webgen/plugin'
 
 # Helper class for calculating plugin dependencies.
 class Dependency < Hash
@@ -37,168 +35,28 @@ class Dependency < Hash
   end
 end
 
-class OpenStruct
-  public :table #:nodoc:#
-end
-
 module Webgen
 
-  VERSION = [0, 3, 2]
+  VERSION = [0, 3, 3]
   SUMMARY = "Webgen is a templated based static website generator."
   DESCRIPTION = "Webgen is a web page generator implemented in Ruby. " \
   "It is used to generate static web pages from templates and page " \
   "description files."
 
-  # Base class for all plugins.
-  class Plugin
-
-    # Holds the plugin data from each and every plugin.
-    @@config = {}
-
-    def self.inherited( klass )
-      (@@config[klass] = OpenStruct.new).klass = klass
-      @@config[klass].plugin = klass.name.split( /::/ ).last
-    end
-
-    ['extension', 'summary', 'description'].each do |name|
-      self.module_eval "def self.#{name}( obj ); @@config[self].#{name} = obj; end"
-    end
-
-    # Return plugin data
-    def self.config
-      @@config
-    end
-
-    # Add a dependency to the plugin. Dependencies are instantiated before the plugin gets
-    # instantiated.
-    def self.depends_on( *dep )
-      dep.each {|d| (@@config[self].dependencies ||= []) << d}
-    end
-
-    # Shortcut for getting the plugin with the name +name+.
-    def self.[]( name )
-      pair = @@config.find {|k,v| v.plugin == name }
-      self.logger.warn { "Could not retrieve plugin '#{name}' as such a plugin does not exist!" } if pair.nil?
-      pair[1].obj unless pair.nil?
-    end
-
-    # Add a parameter for the current class. Has to be used by subclasses to define their parameters!
-    #
-    # Arguments:
-    # +name+:: the name of the parameter
-    # +default+:: the default value of the parameter
-    # +description+:: a small description of the parameter
-    def self.add_param( name, default, description )
-      self.logger.debug { "Adding parameter '#{name}' for plugin class '#{self.name}'" }
-      data = OpenStruct.new( :name => name, :value => default, :default => default, :description => description )
-      (@@config[self].params ||= {})[name] = data
-    end
-
-    # Set parameter +name+ for +plugin+ to +value+.
-    def self.set_param( plugin, name, value )
-      found = catch( :found ) do
-        item = @@config.find {|k,v| v.plugin == plugin }[1]
-        item.klass.ancestor_classes.each do |k|
-          item = @@config[k]
-          if !item.nil? && !item.params.nil? && item.params.has_key?( name )
-            item.params[name].value = value
-            logger.debug { "Setting parameter '#{name}' for plugin '#{plugin}' to #{value.inspect}" }
-            throw :found, true
-          end
-        end
-      end
-      logger.error { "Cannot set undefined parameter '#{name}' for plugin '#{plugin}'" } unless found
-    end
-
-    # Return parameter +name+.
-    def []( name )
-      self.class.ancestor_classes.each do |klass|
-        data = @@config[klass]
-        return data.params[name].value unless data.params.nil? || data.params[name].nil?
-      end
-      logger.error { "Referencing invalid configuration value '#{name}' in class #{self.class.name}" }
-      return nil
-    end
-
-    # Set parameter +name+.
-    def []=( name, value )
-      self.class.set_param( @@config[self.class].plugin, name, value )
-    end
-    alias get_param []
-
-    # Checks if the plugin has a parameter +name+.
-    def has_param?( name )
-      self.class.ancestor_classes.any? do |klass|
-        !@@config[klass].params.nil? && @@config[klass].params.has_key?( name )
-      end
-    end
-
-    # Defines a new *handler class. The methods creates two methods based on the parameter +name+:
-    # - klass.register_[name]
-    # - object.get_[name]
-    def self.define_handler( name )
-      s = "def self.register_#{name}( param )
-        self.logger.info { \"Registering class \#{self.name} for handling '\#{param}'\" }
-        (Webgen::Plugin.config[#{self.name}].#{name}s ||= {})[param] = self
-        Webgen::Plugin.config[self].registered_#{name} = param
-      end\n"
-      s += "def get_#{name}( param )
-        if Webgen::Plugin.config[#{self.name}].#{name}s.has_key?( param )
-          Webgen::Plugin.config[Webgen::Plugin.config[#{self.name}].#{name}s[param]].obj
-        else
-          self.logger.error { \"Invalid #{name} specified: \#{param}! Using #{self.name}!\" }
-           Webgen::Plugin.config[#{self.name}].obj
-        end
-      end"
-      module_eval s
-    end
-
-    #######
-    private
-    #######
-
-    # Return the ancestor classes for the object's class which are sub classes from Plugin.
-    def self.ancestor_classes
-      self.ancestors.delete_if {|c| c.instance_of?( Module ) }[0..-3]
-    end
-
-  end
-
-
   # Responsible for loading the other plugin files and holds the basic configuration options.
   class Configuration < Plugin
 
-    summary "Responsible for loading the configuration data"
+    summary "Responsible for loading plugins and holding general parameters"
 
     add_param 'srcDirectory', 'src', 'The directory from which the source files are read.'
     add_param 'outDirectory', 'output', 'The directory to which the output files are written.'
-    add_param 'verbosityLevel', 2, 'The level of verbosity for the output of messages on the standard output.'
     add_param 'lang', 'en', 'The default language.'
-    add_param 'configfile', 'config.yaml', 'The file from which extra configuration data is taken.'
-    add_param 'logfile', 'webgen.log', 'The name of the log file if the log should be written to a file.'
 
     # Does all the initialisation stuff
-    def init_all( data )
-      data.each {|k,v| Plugin['Configuration'][k] = v}
-      logger.level = get_param( 'verbosityLevel' )
-
+    def init_all
       load_plugins( File.dirname( __FILE__) + '/plugins', File.dirname( __FILE__).sub(/webgen$/, '') )
-      parse_config_file
-
-      data.each {|k,v| Plugin['Configuration'][k] = v}
-      logger.level = get_param( 'verbosityLevel' )
+      load_plugins( 'plugin', '' )
       init_plugins
-      Plugin['ExtensionLoader'].parse_config_file
-    end
-
-    # Parse config file and load the configuration values.
-    def parse_config_file
-      if File.exists?( get_param( 'configfile' ) )
-        @pluginData = YAML::load( File.new( get_param( 'configfile' ) ) )
-        @pluginData.each {|plugin, params| params.each {|name,value| Plugin.set_param( plugin, name, value ) } }
-      else
-        logger.info { "Config file <#{get_param( 'configfile' )}> does not exist, not extra configuration data read." }
-      end
     end
 
     # Load all plugins in the given +path+. Before +require+ is actually called the path is
@@ -224,11 +82,6 @@ module Webgen
       end
     end
 
-    # Set the log device to the logfile.
-    def set_log_dev_to_logfile
-      logger.set_log_dev( File.open( get_param( 'logfile' ), 'a' ) )
-    end
-
   end
 
   # Initialize single configuration instance

data/lib/webgen/logging.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: logging.rb 203 2005-02-21 18:42:04Z thomas $
+# $Id: logging.rb 259 2005-04-21 10:37:47Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -21,19 +21,16 @@
 #
 
 require 'logger'
+require 'webgen/plugin'
 
 module Webgen
 
   class Logger < ::Logger
 
-    def initialize( dev )
-      super( dev )
+    def initialize( dev, files, size, level )
+      super( dev, files, size )
       self.datetime_format = "%Y-%m-%d %H:%M:%S"
-      self.level = Logger::ERROR
-    end
-
-    def set_log_dev( dev )
-      @logdev = LogDevice.new( dev )
+      self.level = level
     end
 
     def format_message( severity, timestamp, msg, progname )
@@ -56,10 +53,14 @@ end
 
 class Object
 
-  LOGGER = Webgen::Logger.new( STDERR )
+  @@logger = Webgen::Logger.new( STDERR, 0, 0, Logger::ERROR )
+
+  def self.set_logger( logger )
+    @@logger = logger
+  end
 
   def logger
-    LOGGER
+    @@logger
   end
 
 end
@@ -71,3 +72,30 @@ class Module
   end
 
 end
+
+module Webgen
+
+  class Logging < Plugin
+
+    summary "Plugin for configuring the logger"
+
+    add_param 'maxLogFiles', 10, 'The maximum number of log files'
+    add_param 'maxLogSize', 1024*1024, 'The maximum size of the log files'
+    add_param 'verbosityLevel', 2, 'The level of verbosity for the output of logging messages (0=DEBUG, 1=INFO, 2=WARNING 3=ERROR).',
+       lambda {|p,o,n| logger.level = n }
+    add_param 'logToFile', false, 'Specifies if the log messages should be put to the logfile',
+       (lambda do |p, o, n|
+          dev = STDERR
+          if n
+            Dir.mkdir( 'log' ) unless File.exists?( 'log' )
+            dev = 'log/webgen.log'
+          end
+          Object.set_logger( Webgen::Logger.new( dev, get_param( 'maxLogFiles' ), get_param( 'maxLogSize' ), get_param( 'verbosityLevel') ) )
+        end)
+
+  end
+
+  # Initialize single logging instance
+  Plugin.config[Logging].obj = Logging.new
+
+end

data/lib/webgen/node.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: node.rb 220 2005-03-12 15:41:05Z thomas $
+# $Id: node.rb 258 2005-04-21 10:35:28Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,7 +20,6 @@
 #++
 #
 
-require 'webgen/logging'
 require 'util/composite'
 
 class Node
@@ -86,7 +85,7 @@ class Node
   def node_for_string( destString )
     node = get_node_for_string( destString )
     if node.nil?
-      self.logger.warn { "Could not get destination node '#{destString}' for <#{metainfo['src']}>" }
+      self.logger.warn { "Could not get destination node '#{destString}' for <#{recursive_value( 'src' )}>" }
     end
     node
   end
@@ -139,11 +138,32 @@ class Node
       node = self.parent_dir || self
     end
 
-    destString.split( '/' ).each do |element|
-      return nil if node.nil?
+    startElement = node
+    elements = destString.split( '/' )
+
+    elements.each do |element|
+      break if node.nil?
       case element
       when '..' then node = node.parent
-      else node = node.find do |child| /^#{element}\/?$/ =~ child['dest'] end
+      else node = node.find {|child| /^#{element}\/?$/ =~ child['dest'] }
+      end
+    end
+
+    # try extended search where child['dest'] can have slashes
+    if node.nil?
+      node = startElement
+      elements.each_with_index do |element, index|
+        break if node.nil?
+        temp = node.find {|child| /^#{elements[index..-1].join( '/' )}\/?$/ =~ child['dest']}
+        if temp.nil?
+          case element
+          when '..' then node = node.parent
+          else node = node.find {|child| /^#{element}\/?$/ =~ child['dest'] }
+          end
+        else
+          node = temp
+          break
+        end
       end
     end
 

data/lib/webgen/plugin.rb

@@ -0,0 +1,168 @@
+#
+#--
+#
+# $Id: plugin.rb 259 2005-04-21 10:37:47Z thomas $
+#
+# webgen: template based static website generator
+# Copyright (C) 2004 Thomas Leitner
+#
+# This program is free software; you can redistribute it and/or modify it under the terms of the GNU
+# General Public License as published by the Free Software Foundation; either version 2 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
+# even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with this program; if not,
+# write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+#
+#++
+#
+
+require 'yaml'
+require 'ostruct'
+
+class OpenStruct
+  public :table #:nodoc:#
+end
+
+module Webgen
+
+  # Base class for all plugins.
+  class Plugin
+
+    # Holds the plugin data from each and every plugin.
+    @@config = {}
+    @@configFileData = ( File.exists?( 'config.yaml' ) ? YAML::load( File.new( 'config.yaml' ) ) : {} )
+
+    def self.inherited( klass )
+      (@@config[klass] = OpenStruct.new).klass = klass
+      @@config[klass].plugin = klass.name.split( /::/ ).last
+    end
+
+    ['summary', 'description'].each do |name|
+      self.module_eval "def self.#{name}( obj ); @@config[self].#{name} = obj; end"
+    end
+
+    # Return plugin data
+    def self.config
+      @@config
+    end
+
+    # Add a dependency to the plugin. Dependencies are instantiated before the plugin gets
+    # instantiated.
+    def self.depends_on( *dep )
+      dep.each {|d| (@@config[self].dependencies ||= []) << d}
+    end
+
+    # Shortcut for getting the plugin with the name +name+.
+    def self.[]( name )
+      pair = @@config.find {|k,v| v.plugin == name }
+      self.logger.warn { "Could not retrieve plugin '#{name}' as such a plugin does not exist!" } if pair.nil?
+      pair[1].obj unless pair.nil?
+    end
+
+    # Add a parameter for the current class. Has to be used by subclasses to define their parameters!
+    #
+    # Arguments:
+    # +name+:: the name of the parameter
+    # +default+:: the default value of the parameter
+    # +description+:: a small description of the parameter
+    # +changeHandler+:: optional, method/proc which is invoked every time the parameter is changed.
+    #                   Handler signature: changeHandler( paramName, oldValue, newValue )
+    def self.add_param( name, default, description, changeHandler = nil )
+      self.logger.debug { "Adding parameter '#{name}' for plugin class '#{self.name}'" }
+      if @@configFileData.kind_of?( Hash ) && @@configFileData.has_key?( @@config[self].plugin ) \
+        && @@configFileData[@@config[self].plugin].has_key?( name )
+        curval = @@configFileData[@@config[self].plugin][name]
+      else
+        curval = default
+      end
+      data = OpenStruct.new( :name => name, :value => curval, :default => default, :description => description, :changeHandler => changeHandler )
+      (@@config[self].params ||= {})[name] = data
+      changeHandler.call( name, default, curval ) if changeHandler
+    end
+
+    # Set parameter +name+ for +plugin+ to +value+.
+    def self.set_param( plugin, name, value )
+      found = catch( :found ) do
+        item = @@config.find {|k,v| v.plugin == plugin }[1]
+        item.klass.ancestor_classes.each do |k|
+          item = @@config[k]
+          if !item.nil? && !item.params.nil? && item.params.has_key?( name )
+            oldvalue = item.params[name].value
+            item.params[name].value = value
+            item.params[name].changeHandler.call( name, oldvalue, value ) if item.params[name].changeHandler
+            logger.debug { "Set parameter '#{name}' for plugin '#{plugin}' to #{value.inspect}" }
+            throw :found, true
+          end
+        end
+      end
+      logger.error { "Cannot set undefined parameter '#{name}' for plugin '#{plugin}'" } unless found
+    end
+
+    def self.get_param( name )
+      ancestor_classes.each do |klass|
+        data = @@config[klass]
+        return data.params[name].value unless data.params.nil? || data.params[name].nil?
+      end
+      logger.error { "Referencing invalid configuration value '#{name}' in class #{self.class.name}" }
+      return nil
+    end
+
+    # Return parameter +name+.
+    def []( name )
+      self.class.get_param( name )
+    end
+    alias get_param []
+
+    # Set parameter +name+.
+    def []=( name, value )
+      self.class.set_param( @@config[self.class].plugin, name, value )
+    end
+
+    # Checks if the plugin has a parameter +name+.
+    def has_param?( name )
+      self.class.ancestor_classes.any? do |klass|
+        !@@config[klass].params.nil? && @@config[klass].params.has_key?( name )
+      end
+    end
+
+    # Defines a new *handler class. The methods creates two methods based on the parameter +name+:
+    # - klass.register_[name]
+    # - object.get_[name]
+    def self.define_handler( name )
+      s = "def self.register_#{name}( param )
+        self.logger.info { \"Registering class \#{self.name} for handling '\#{param}'\" }
+        (Webgen::Plugin.config[#{self.name}].#{name}s ||= {})[param] = self
+        Webgen::Plugin.config[self].registered_#{name} = param
+      end\n"
+      s += "def get_#{name}( param )
+        if Webgen::Plugin.config[#{self.name}].#{name}s.has_key?( param )
+          Webgen::Plugin.config[Webgen::Plugin.config[#{self.name}].#{name}s[param]].obj
+        else
+          self.logger.error { \"Invalid #{name} specified: \#{param}! Using #{self.name}!\" }
+           Webgen::Plugin.config[#{self.name}].obj
+        end
+      end"
+      module_eval s
+    end
+
+    #######
+    private
+    #######
+
+    # Return the ancestor classes for the object's class which are sub classes from Plugin.
+    def self.ancestor_classes
+      self.ancestors.delete_if {|c| c.instance_of?( Module ) }[0..-3]
+    end
+
+  end
+
+  require 'webgen/logging'
+  require 'webgen/configuration'
+
+end
+
+