webgen 0.3.0

data/install.rb

@@ -0,0 +1,19 @@
+
+require 'rpa/install'
+
+class Install_webgen < RPA::Install::FullInstaller
+  name 'webgen'
+  version '0.3.0-1'
+  classification Application
+  build do
+    installdocs %w[COPYING ChangeLog TODO]
+    installdocs 'docs'
+    installrdoc %w[README] + Dir['lib/**/*.rb']
+    installdata
+  end
+  description <<-EOF
+Webgen is a templated based static website generator.
+
+Webgen is a web page generator implemented in Ruby. It is used to generate static web pages from templates and page description files.
+  EOF
+end

data/lib/util/composite.rb

@@ -0,0 +1,101 @@
+#
+#--
+#
+# $Id: composite.rb 203 2005-02-21 18:42:04Z 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
+#
+#++
+#
+
+
+# Module Composite
+#
+# Implementation of the Composite pattern.
+#
+# Usage example:
+#
+#  class Test
+#    include Composite
+#  end
+#
+#  t = Test.new
+#  t.add_child("Hello")
+#  t.add_child("Lester")
+#  t.each do |child| print child end
+#
+
+
+module Composite
+
+  include Enumerable
+
+
+  # Returns the array of children
+  def children
+    @children = [] unless defined? @children
+    @children
+  end
+
+
+  # Adds all objects in the array
+  def add_children( array )
+    if array.kind_of? Array
+      @children = [] unless defined? @children
+      @children.concat array
+    else
+      raise ArgumentError, "Parameter must be array"
+    end
+  end
+
+
+  # Deletes all children
+  def del_children
+    @children = []
+  end
+
+
+  # Adds the child
+  def add_child( child )
+    @children = [] unless defined? @children
+    @children.push child unless @children.include? child
+  end
+
+
+  # Depending on the type of argument one of these actions is taken
+  #
+  # [+Numeric+] the child at the specified position is deleted
+  # [+else+]    the specified child is deleted
+  def del_child( child )
+    if child.kind_of? Numeric
+      @children.delete_at child if defined? @children
+    else
+      @children.delete child if defined? @children
+    end
+  end
+
+
+  # Iterates over all childrenldren
+  def each   # :yields: child
+    children.each do |child| yield child end if defined? @children
+  end
+
+
+  # Checks if there are any children
+  def has_children?
+    defined?( @children ) && children.length > 0
+  end
+
+end

data/lib/util/listener.rb

@@ -0,0 +1,105 @@
+#
+#--
+#
+# $Id: listener.rb 203 2005-02-21 18:42:04Z 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
+#
+#++
+#
+
+# Module Listener
+#
+# Implementation of the listener pattern. The including class defines messages to which other
+# classes can listen.
+#
+# Usage example:
+#
+#  class Test
+#    include Listener
+#
+#    def initialize
+#      add_msg_name :test
+#    end
+#
+#    def invoke( *param )
+#      dispatch_msg( :test, *param )
+#    end
+#
+#  end
+#
+#  t = Test.new
+#  t.add_msg_listener( :test ) do |*param|
+#    print param.inspect
+#  end
+#  t.invoke 'hello'
+#  t.invoke 'lester', ['tsd', 4, 'test']
+#
+module Listener
+
+
+  # Adds a new message listener for the object. The message +msgName+
+  # will be dispatched to either the given +callableObject+ (has to respond
+  # to +call+) or the given block. If both are specified the +callableObject+
+  # is used.
+  def add_msg_listener( msgName, callableObject = nil, &block )
+    return unless defined?( @msgNames ) && @msgNames.has_key?( msgName )
+
+    if !callableObject.nil?
+      raise NoMethodError, "listener needs to respond to 'call'" unless callableObject.respond_to? :call
+      @msgNames[msgName].push callableObject
+    elsif !block.nil?
+      @msgNames[msgName].push block
+    else
+      raise "you have to provide a callback object or a block"
+    end
+  end
+
+
+  # Removes the given object from the dispatcher queue of the message +msgName+.
+  def del_msg_listener( msgName, object )
+    @msgNames[msgName].delete object if defined? @msgNames
+  end
+
+
+  #######
+  private
+  #######
+
+
+  # Adds a new message target called +msgName+
+  def add_msg_name( msgName )
+    @msgNames = {}  unless defined? @msgNames
+    @msgNames[msgName] = [] unless @msgNames.has_key? msgName
+  end
+
+
+  # Deletes the message target +msgName+.
+  def del_msg_name( msgName )
+    @msgNames.delete msgName if defined? @msgNames
+  end
+
+
+  # Dispatches the message +msgName+ to all listeners for this message,
+  # providing the given arguments
+  def dispatch_msg( msgName, *args )
+    if defined? @msgNames and @msgNames.has_key? msgName
+      @msgNames[msgName].each do |obj|
+        obj.call( *args )
+      end
+    end
+  end
+
+end

data/lib/webgen/configuration.rb

@@ -0,0 +1,216 @@
+#
+#--
+#
+# $Id: configuration.rb 203 2005-02-21 18:42:04Z 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'
+require 'find'
+require 'tsort'
+require 'webgen/node'
+require 'webgen/logging'
+
+# Helper class for calculating plugin dependencies.
+class Dependency < Hash
+  include TSort
+
+  alias tsort_each_node each_key
+  def tsort_each_child(node, &block)
+    fetch(node).each(&block)
+  end
+end
+
+
+module Webgen
+
+  VERSION = [0, 3, 0]
+  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.name] = OpenStruct.new).klass = klass
+      @@config[klass.name].plugin = klass.name.split( /::/ ).last
+    end
+
+    ['extension', 'summary', 'description'].each do |name|
+      self.module_eval "def self.#{name}( obj ); @@config[self.name].#{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.name].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.name].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.name]
+          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.name]
+        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.name].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.name].params.nil? && @@config[klass.name].params.has_key?( name )
+      end
+    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"
+
+    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' )
+
+      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' )
+      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
+    # trimmed: if +trimpath+ matches the beginning of the string, +trimpath+ is deleted from it.
+    def load_plugins( path, trimpath )
+      Find.find( path ) do |file|
+        Find.prune unless File.directory?( file ) || (/.rb$/ =~ file)
+        self.logger.debug { "Loading plugin file <#{file}>..." }
+        require file.gsub(/^#{trimpath}/, '') if File.file?( file )
+      end
+    end
+
+    # Instantiate the plugins in the correct order, except the classes which have a constant
+    # +VIRTUAL+.
+    def init_plugins
+      dep = Dependency.new
+      Plugin.config.each {|k,data| dep[data.plugin] = data.dependencies || []}
+      self.logger.debug { "Dependencies: #{dep.inspect}" }
+      dep.tsort.each do |plugin|
+        data = Plugin.config.find {|k,v| v.plugin == plugin }[1]
+        self.logger.debug { "Creating plugin of class #{data.klass.name}" }
+        data.obj ||= data.klass.new unless data.klass.const_defined?( 'VIRTUAL' )
+      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
+  Plugin.config[Configuration.name].obj = Configuration.new
+
+end
+
+

data/lib/webgen/logging.rb

@@ -0,0 +1,73 @@
+#
+#--
+#
+# $Id: logging.rb 203 2005-02-21 18:42:04Z 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 'logger'
+
+module Webgen
+
+  class Logger < ::Logger
+
+    def initialize( dev )
+      super( dev )
+      self.datetime_format = "%Y-%m-%d %H:%M:%S"
+      self.level = Logger::ERROR
+    end
+
+    def set_log_dev( dev )
+      @logdev = LogDevice.new( dev )
+    end
+
+    def format_message( severity, timestamp, msg, progname )
+      "%s %5s -- %s: %s\n" % [timestamp, severity, progname, msg ]
+    end
+
+    def warn( progname = nil, &block )
+      super
+      self.debug { "Call stack for last warning: #{caller[3..-1].join("\n")}" }
+    end
+
+    def error( progname = nil, &block )
+      super
+      self.debug { "Call stack for last error: #{caller[3..-1].join("\n")}" }
+    end
+
+  end
+
+end
+
+class Object
+
+  LOGGER = Webgen::Logger.new( STDERR )
+
+  def logger
+    LOGGER
+  end
+
+end
+
+class Module
+
+  def self.logger
+    Object::LOGGER
+  end
+
+end