webgen 0.3.6 → 0.3.7

data/lib/webgen/plugins/{contenthandler/defaultcontenthandler.rb → contenthandlers/default.rb}

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: defaultcontenthandler.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: default.rb 349 2005-09-02 09:28:06Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner

data/lib/webgen/plugins/{contenthandler → contenthandlers}/html.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: html.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: html.rb 349 2005-09-02 09:28:06Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,7 +20,7 @@
 #++
 #
 
-require 'webgen/plugins/contenthandler/defaultcontenthandler'
+require 'webgen/plugins/contenthandlers/default'
 
 module ContentHandlers
 

data/lib/webgen/plugins/{contenthandler → contenthandlers}/markdown.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: markdown.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: markdown.rb 349 2005-09-02 09:28:06Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -23,7 +23,7 @@
 
 begin
   require 'bluecloth'
-  require 'webgen/plugins/contenthandler/defaultcontenthandler'
+  require 'webgen/plugins/contenthandlers/default'
 
   module ContentHandlers
 

data/lib/webgen/plugins/{contenthandler → contenthandlers}/rdoc.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: rdoc.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: rdoc.rb 349 2005-09-02 09:28:06Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -22,7 +22,7 @@
 
 require 'rdoc/markup/simple_markup'
 require 'rdoc/markup/simple_markup/to_html'
-require 'webgen/plugins/contenthandler/defaultcontenthandler'
+require 'webgen/plugins/contenthandlers/default'
 
 module ContentHandlers
 

data/lib/webgen/plugins/{contenthandler → contenthandlers}/textile.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: textile.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: textile.rb 349 2005-09-02 09:28:06Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -22,7 +22,7 @@
 
 begin
   require 'redcloth'
-  require 'webgen/plugins/contenthandler/defaultcontenthandler'
+  require 'webgen/plugins/contenthandlers/default'
 
   module ContentHandlers
 

data/lib/webgen/{configuration.rb → plugins/coreplugins/configuration.rb}

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: configuration.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: configuration.rb 349 2005-09-02 09:28:06Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -22,6 +22,7 @@
 
 require 'find'
 require 'tsort'
+require 'cmdparse'
 require 'webgen/node'
 require 'webgen/plugin'
 
@@ -37,14 +38,18 @@ end
 
 module Webgen
 
-  VERSION = [0, 3, 6]
+  VERSION = [0, 3, 7]
   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."
 
+end
+
+module CorePlugins
+
   # Responsible for loading the other plugin files and holds the basic configuration options.
-  class Configuration < Plugin
+  class Configuration < Webgen::Plugin
 
     summary "Responsible for loading plugins and holding general parameters"
 
@@ -52,6 +57,10 @@ module Webgen
     add_param 'outDirectory', 'output', 'The directory to which the output files are written.'
     add_param 'lang', 'en', 'The default language.'
 
+    # Returns the +CommandParser+ object used for parsing the command line. You can add site
+    # specific commands to it by calling the Configuration#add_cmdparser_command method!
+    attr_accessor :cmdparser
+
     # Returns the data directory of webgen.
     def self.data_dir
       unless defined?( @@data_dir )
@@ -74,9 +83,13 @@ module Webgen
       @@data_dir
     end
 
+    def add_cmdparser_command( command )
+      @cmdparser.add_command( command ) if @cmdparser
+    end
+
     # Does all the initialisation stuff
     def init_all
-      load_plugins( File.dirname( __FILE__) + '/plugins', File.dirname( __FILE__).sub(/webgen$/, '') )
+      load_plugins( File.dirname( __FILE__).sub( /coreplugins$/,'' ), File.dirname( __FILE__).sub(/webgen\/plugins\/coreplugins$/, '') )
       load_plugins( 'plugin', '' )
       init_plugins
     end
@@ -85,29 +98,36 @@ module Webgen
     # 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 )
+        trimmedFile = file.gsub(/^#{trimpath}/, '')
+        Find.prune unless File.directory?( file ) || ( (/.rb$/ =~ file) && !$".include?( trimmedFile ) )
+        if File.file?( file )
+          self.logger.debug { "Loading plugin file <#{file}>..." }
+          require trimmedFile
+        end
       end
     end
 
     # Instantiate the plugins in the correct order, except the classes which have a constant
-    # +VIRTUAL+.
+    # +VIRTUAL+, and add CommandPlugin instance to the global CommandParser.
     def init_plugins
       dep = Dependency.new
-      Plugin.config.each {|k,data| dep[data.plugin] = data.dependencies || []}
-      self.logger.debug { "Dependencies: #{dep.inspect}" }
+      Webgen::Plugin.config.each {|k,data| dep[data.plugin] = data.dependencies || []}
       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' )
+        data = Webgen::Plugin.config.find {|k,v| v.plugin == plugin }[1]
+        unless data.klass.const_defined?( 'VIRTUAL' ) || data.obj
+          self.logger.debug { "Creating plugin of class #{data.klass.name}" }
+          data.obj ||= data.klass.new
+        end
+      end
+      Webgen::Plugin.config.keys.find_all {|klass| klass.ancestors.include?( Webgen::CommandPlugin )}.each do |cmdKlass|
+        add_cmdparser_command( Webgen::Plugin.config[cmdKlass].obj )
       end
     end
 
   end
 
   # Initialize single configuration instance
-  Plugin.config[Configuration].obj = Configuration.new
+  Webgen::Plugin.config[Configuration].obj = Configuration.new
 
 end
 

data/lib/webgen/{logging.rb → plugins/coreplugins/logging.rb}

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: logging.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: logging.rb 350 2005-09-02 09:44:23Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -73,9 +73,9 @@ class Module
 
 end
 
-module Webgen
+module CorePlugins
 
-  class Logging < Plugin
+  class Logging < Webgen::Plugin
 
     summary "Plugin for configuring the logger"
 
@@ -96,6 +96,6 @@ module Webgen
   end
 
   # Initialize single logging instance
-  Plugin.config[Logging].obj = Logging.new
+  Webgen::Plugin.config[Logging].obj = Logging.new
 
 end

data/lib/webgen/plugins/{resourcemanager.rb → coreplugins/resourcemanager.rb}

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: resourcemanager.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: resourcemanager.rb 350 2005-09-02 09:44:23Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -23,11 +23,11 @@
 require 'rbconfig'
 require 'fileutils'
 require 'webgen/plugins/tags/tags'
-require 'webgen/plugins/filehandler/filehandler'
+require 'webgen/plugins/filehandlers/filehandler'
 
-module Webgen
+module CorePlugins
 
-  class ResourceManager < Plugin
+  class ResourceManager < Webgen::Plugin
 
     class Resource
 
@@ -131,9 +131,9 @@ module Webgen
     attr_reader :data_dir
 
     def initialize
-      Plugin.config[self.class].resources = {}
-      Plugin['FileHandler'].add_msg_listener( :AFTER_ALL_WRITTEN, method( :write_resources ) )
-      define_webgen_resources unless Webgen::Configuration.data_dir.empty?
+      Webgen::Plugin.config[self.class].resources = {}
+      Webgen::Plugin['FileHandler'].add_msg_listener( :AFTER_ALL_WRITTEN, method( :write_resources ) )
+      define_webgen_resources unless CorePlugins::Configuration.data_dir.empty?
       define_user_resources
     end
 
@@ -160,7 +160,7 @@ module Webgen
 
     # Returns the requested resource.
     def get_resource( name )
-      Plugin.config[self.class].resources[name]
+      Webgen::Plugin.config[self.class].resources[name]
     end
 
 
@@ -178,28 +178,56 @@ module Webgen
     #######
 
     def define_resource( name, res )
-      if Plugin.config[self.class].resources.has_key?( name )
+      if Webgen::Plugin.config[self.class].resources.has_key?( name )
         logger.error { "Resource #{name} already defined, not using new definition (#{res.inspect})" }
       else
         logger.info { "Adding resource #{name} to pool (#{res.inspect})" }
-        Plugin.config[self.class].resources[name] = res
+        Webgen::Plugin.config[self.class].resources[name] = res
       end
     end
 
     def define_webgen_resources
-      define_file_resource( 'webgen-logo', File.join( Webgen::Configuration.data_dir, 'images', 'webgen_logo.png' ),
+      define_file_resource( 'webgen-logo', File.join( CorePlugins::Configuration.data_dir, 'resources', 'images', 'webgen_logo.png' ),
                             '/images/webgen-logo.png' ).predefined = "The logo of webgen as seen on the homepage."
-      define_file_resource( 'webgen-generated', File.join( Webgen::Configuration.data_dir, 'images', 'generated_by_webgen.png' ),
+      define_file_resource( 'webgen-generated', File.join( CorePlugins::Configuration.data_dir, 'resources', 'images', 'generated_by_webgen.png' ),
                             '/images/webgen-generated-by.png' ).predefined = "A 88x31 image for use on web sites that were generated by webgen."
-      define_file_resource( 'w3c-valid-css', File.join( Webgen::Configuration.data_dir, 'images', 'valid-css.gif' ),
+      define_file_resource( 'w3c-valid-css', File.join( CorePlugins::Configuration.data_dir, 'resources', 'images', 'valid-css.gif' ),
                             '/images/w3c-valid-css.gif' ).predefined = 'The W3C image for valid css.'
-      define_file_resource( 'w3c-valid-xhtml11', File.join( Webgen::Configuration.data_dir, 'images', 'valid-xhtml11.png' ),
+      define_file_resource( 'w3c-valid-xhtml11', File.join( CorePlugins::Configuration.data_dir, 'resources', 'images', 'valid-xhtml11.png' ),
                             '/images/w3c-valid-xhtml11.png' ).predefined = "The W3C image for valid XHTML1.1"
 
+      define_webgen_emoticons
+      define_webgen_icons
+
       define_memory_resource( 'webgen-css', '/css/webgen.css' ).predefined = "Plugins use this resource for their CSS styles."
       define_memory_resource( 'webgen-javascript', '/css/webgen.js' ).predefined = "Plugins use this resource for their Javascript fragments."
     end
 
+    def define_webgen_emoticons
+      Dir[File.join( CorePlugins::Configuration.data_dir, 'resources', 'emoticons', '*/')].each do |pack_dir|
+        pack = File.basename( pack_dir )
+        Dir[File.join( pack_dir, '*' )].each do |smiley_file|
+          smiley = File.basename( smiley_file, '.*' )
+          res = define_file_resource( "webgen-emoticons-#{pack}-#{smiley}",
+                                      smiley_file,
+                                      "/images/emoticons/#{pack}-#{File.basename(smiley_file)}" )
+          res.predefined = "Emoticon from pack '#{pack}' for '#{smiley}'"
+        end
+      end
+    end
+
+    def define_webgen_icons
+      base_dir = File.join( CorePlugins::Configuration.data_dir, 'resources', 'icons' )
+      Dir[File.join( base_dir, '**/*')].each do |icon|
+        dirs = File.dirname( icon ).sub( /^#{base_dir}/, '' ).split( '/' ).join( '-' )
+        dirs += '-' if dirs.length > 0
+        res = define_file_resource( "webgen-icons-#{dirs}#{File.basename( icon, '.*' )}",
+                                    icon,
+                                    "/images/icons/#{dirs}#{File.basename(icon)}" )
+        res.predefined = "Icon named #{File.basename(icon)}"
+      end
+    end
+
     def define_user_resources
       p = get_param( 'resources' )
       if !p.kind_of?( Array ) || p.find {|h| !h.kind_of?( Array ) || h.length != 3}
@@ -211,7 +239,7 @@ module Webgen
 
 
     def write_resources
-      Plugin.config[self.class].resources.each do |name, res|
+      Webgen::Plugin.config[self.class].resources.each do |name, res|
         if res.write_resource?
           begin
             FileUtils.makedirs( File.dirname( res.dest_path ) )
@@ -239,15 +267,9 @@ module Tags
     add_param 'name', nil, 'The name of the resource'
     add_param 'insert', :path, 'What should be returned by the tag: the path to the resource (value :path) ' \
     'or the data (value :data)'
-
     set_mandatory 'name', true
 
-    depends_on 'Tags'
-
-    def initialize
-      super
-      register_tag( 'resource' )
-    end
+    tag 'resource'
 
     def process_tag( tag, node, refNode )
       result = ''

data/lib/webgen/plugins/{filehandler → filehandlers}/backing.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: backing.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: backing.rb 350 2005-09-02 09:44:23Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,9 +20,9 @@
 #++
 #
 
-require 'webgen/plugins/filehandler/filehandler'
-require 'webgen/plugins/filehandler/directory'
-require 'webgen/plugins/filehandler/page'
+require 'webgen/plugins/filehandlers/filehandler'
+require 'webgen/plugins/filehandlers/directory'
+require 'webgen/plugins/filehandlers/page'
 
 module FileHandlers
 
@@ -94,7 +94,7 @@ module FileHandlers
       dirNode = create_path( dirname, dirNode )
 
       self.logger.debug { "Trying to create virtual node for '#{filename}'..." }
-      pageNode = Webgen::Plugin['VirtualPageHandler'].create_node_from_data( '', filename, dirNode )
+      pageNode = Webgen::Plugin['VirtualPageFileHandler'].create_node_from_data( '', filename, dirNode )
       dirNode.add_child( pageNode )
       pageNode.metainfo.update( data )
       pageNode['int:virtualNode'] = true
@@ -120,8 +120,8 @@ module FileHandlers
           node = node.find {|child| /^#{element}\/?$/ =~ child['src'] }
         end
         if node.nil?
-          node = FileHandlers::DirHandler::DirNode.new( parent, element )
-          node['processor'] = Webgen::Plugin['VirtualDirHandler']
+          node = FileHandlers::DirectoryHandler::DirNode.new( parent, element )
+          node['processor'] = Webgen::Plugin['VirtualDirectoryHandler']
           parent.add_child( node )
           self.logger.info { "Created virtual directory <#{node.recursive_value( 'dest' )}>" }
         end
@@ -135,10 +135,10 @@ module FileHandlers
 
 
   # Handles virtual directories, that is, directories that do not exist in the source tree.
-  class VirtualDirHandler < DirHandler
+  class VirtualDirectoryHandler < DirectoryHandler
 
     summary "Handles virtual directories"
-    depends_on "DirHandler"
+    depends_on "DirectoryHandler"
 
     def write_node( node )
     end
@@ -146,10 +146,10 @@ module FileHandlers
   end
 
   # Handles virtual pages, that is, pages that do not exist in the source tree.
-  class VirtualPageHandler < PageHandler
+  class VirtualPageFileHandler < PageFileHandler
 
     summary "Handles virtual pages"
-    depends_on "PageHandler"
+    depends_on "PageFileHandler"
 
     def write_node( node )
     end

data/lib/webgen/plugins/{filehandler/filecopy.rb → filehandlers/copy.rb}

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: filecopy.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: copy.rb 350 2005-09-02 09:44:23Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -21,13 +21,13 @@
 #
 
 require 'fileutils'
-require 'webgen/plugins/filehandler/filehandler'
+require 'webgen/plugins/filehandlers/filehandler'
 
 module FileHandlers
 
   # A simple file handler which copies files with a specific extension from the source to the output
   # directory. The extensions of the files to copy are customizable.
-  class FileCopyHandler < DefaultFileHandler
+  class CopyFileHandler < DefaultFileHandler
 
     summary "Copies files from source to destination without modification"
     add_param 'paths', ['**/*.css', '**/*.jpg', '**/*.png', '**/*.gif'], \

data/lib/webgen/plugins/{filehandler → filehandlers}/directory.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: directory.rb 334 2005-08-23 19:11:53Z thomas $
+# $Id: directory.rb 349 2005-09-02 09:28:06Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,12 +20,12 @@
 #++
 #
 
-require 'webgen/plugins/filehandler/filehandler'
+require 'webgen/plugins/filehandlers/filehandler'
 
 module FileHandlers
 
   # Handles directories.
-  class DirHandler < DefaultFileHandler
+  class DirectoryHandler < DefaultFileHandler
 
     # Specialized node describing a directory.
     class DirNode < Node
@@ -34,7 +34,7 @@ module FileHandlers
         super( parent )
         self['title'] = name
         self['src'] = self['dest'] = name + '/'
-        self['processor'] = Webgen::Plugin['DirHandler']
+        self['processor'] = Webgen::Plugin['DirectoryHandler']
         self['int:directory?'] = true
       end
 
@@ -44,13 +44,18 @@ module FileHandlers
       end
 
       def process_dir_index
-        node = node_for_string( Webgen::Plugin['DirHandler']['indexFile'] )
-        if node
-          self.logger.info { "Directory index file for <#{self.recursive_value( 'src' )}> => <#{node.recursive_value( 'src', false )}>" }
-          self['indexFile'] = node
-        else
-          self.logger.warn { "No directory index file found for directory <#{self.recursive_value( 'src' )}>" }
+        indexFile = Webgen::Plugin['DirectoryHandler']['indexFile']
+        if indexFile.nil?
           self['indexFile'] = nil
+        else
+          node = node_for_string( indexFile )
+          if node
+            self.logger.info { "Directory index file for <#{self.recursive_value( 'src' )}> => <#{node.recursive_value( 'src', false )}>" }
+            self['indexFile'] = node
+          else
+            self.logger.warn { "No directory index file found for directory <#{self.recursive_value( 'src' )}>" }
+            self['indexFile'] = nil
+          end
         end
       end