webgen 0.3.0 → 0.3.1

data/doc/src/meta.info

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

data/install.rb

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

data/lib/webgen/configuration.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: configuration.rb 203 2005-02-21 18:42:04Z thomas $
+# $Id: configuration.rb 217 2005-03-11 15:15:54Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -37,10 +37,13 @@ class Dependency < Hash
   end
 end
 
+class OpenStruct
+  public :table #:nodoc:#
+end
 
 module Webgen
 
-  VERSION = [0, 3, 0]
+  VERSION = [0, 3, 1]
   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 " \
@@ -53,12 +56,12 @@ module Webgen
     @@config = {}
 
     def self.inherited( klass )
-      (@@config[klass.name] = OpenStruct.new).klass = klass
-      @@config[klass.name].plugin = klass.name.split( /::/ ).last
+      (@@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].#{name} = obj; end"
+      self.module_eval "def self.#{name}( obj ); @@config[self].#{name} = obj; end"
     end
 
     # Return plugin data
@@ -69,7 +72,7 @@ module Webgen
     # 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}
+      dep.each {|d| (@@config[self].dependencies ||= []) << d}
     end
 
     # Shortcut for getting the plugin with the name +name+.
@@ -88,7 +91,7 @@ module Webgen
     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
+      (@@config[self].params ||= {})[name] = data
     end
 
     # Set parameter +name+ for +plugin+ to +value+.
@@ -96,7 +99,7 @@ module Webgen
       found = catch( :found ) do
         item = @@config.find {|k,v| v.plugin == plugin }[1]
         item.klass.ancestor_classes.each do |k|
-          item = @@config[k.name]
+          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}" }
@@ -110,7 +113,7 @@ module Webgen
     # Return parameter +name+.
     def []( name )
       self.class.ancestor_classes.each do |klass|
-        data = @@config[klass.name]
+        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}" }
@@ -119,17 +122,37 @@ module Webgen
 
     # Set parameter +name+.
     def []=( name, value )
-      self.class.set_param( @@config[self.class.name].plugin, 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.name].params.nil? && @@config[klass.name].params.has_key?( name )
+        !@@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
     #######
@@ -209,7 +232,7 @@ module Webgen
   end
 
   # Initialize single configuration instance
-  Plugin.config[Configuration.name].obj = Configuration.new
+  Plugin.config[Configuration].obj = Configuration.new
 
 end
 

data/lib/webgen/node.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: node.rb 203 2005-02-21 18:42:04Z thomas $
+# $Id: node.rb 220 2005-03-12 15:41:05Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -114,6 +114,13 @@ class Node
     /^#{node.recursive_value( 'dest' )}/ =~ recursive_value( 'dest' )
   end
 
+  # Returns the parent directory for this node. This function ignores virtual directories.
+  def parent_dir
+    node = self.parent
+    node = node.parent while !node.nil? && node['virtual']
+    node
+  end
+
   # Returns the root node for +node+.
   def self.root( node )
     node = node.parent until node.parent.nil?
@@ -129,8 +136,7 @@ class Node
       node = Node.root( self )
       destString = destString[1..-1]
     else
-      node = self.parent || self
-      node = node.parent while !node.nil? && node['virtual']
+      node = self.parent_dir || self
     end
 
     destString.split( '/' ).each do |element|

data/lib/webgen/plugins/contenthandler/defaultcontenthandler.rb

@@ -0,0 +1,39 @@
+#
+#--
+#
+# $Id: defaultcontenthandler.rb 214 2005-02-27 13:40:27Z 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 ContentHandlers
+
+  class DefaultContentHandler < Webgen::Plugin
+
+    summary "Base class for all content handlers"
+
+    define_handler 'format'
+
+    # Format the given +content+. Should be overridden in subclass!
+    def format_content( content )
+      content
+    end
+
+  end
+
+end

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: html.rb 203 2005-02-21 18:42:04Z thomas $
+# $Id: html.rb 212 2005-02-27 12:02:27Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,19 +20,16 @@
 #++
 #
 
-require 'webgen/plugins/filehandler/pagehandler/page'
+require 'webgen/plugins/contenthandler/defaultcontenthandler'
 
 module ContentHandlers
 
   # Handles HTML content. Assumes that the content is already valid HTML.
-  class HTMLHandler < ContentHandler
+  class HTMLContentHandler < DefaultContentHandler
 
     summary "Handles HTML formatted content"
-    depends_on "PageHandler"
 
-    def initialize
-      register_format( 'html' )
-    end
+    register_format( 'html' )
 
     def format_content( txt )
       txt

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: markdown.rb 203 2005-02-21 18:42:04Z thomas $
+# $Id: markdown.rb 212 2005-02-27 12:02:27Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -23,19 +23,16 @@
 
 begin
   require 'bluecloth'
-  require 'webgen/plugins/filehandler/pagehandler/page'
+  require 'webgen/plugins/contenthandler/defaultcontenthandler'
 
   module ContentHandlers
 
     # Handles text formatted in Markdown format using BlueCloth.
-    class MarkdownHandler < ContentHandler
+    class MarkdownContentHandler < DefaultContentHandler
 
       summary "Handles content formatted in Markdown format using BlueCloth"
-      depends_on "PageHandler"
 
-      def initialize
-        register_format( 'markdown' )
-      end
+      register_format( 'markdown' )
 
       def format_content( txt )
         BlueCloth.new( txt ).to_html

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: rdoc.rb 203 2005-02-21 18:42:04Z thomas $
+# $Id: rdoc.rb 212 2005-02-27 12:02:27Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -22,18 +22,18 @@
 
 require 'rdoc/markup/simple_markup'
 require 'rdoc/markup/simple_markup/to_html'
-require 'webgen/plugins/filehandler/pagehandler/page'
+require 'webgen/plugins/contenthandler/defaultcontenthandler'
 
 module ContentHandlers
 
   # Handles text in RDoc format.
-  class RDocHandler < ContentHandler
+  class RDocContentHandler < DefaultContentHandler
 
     summary "Handles content in RDOC format"
-    depends_on "PageHandler"
+
+    register_format( 'rdoc' )
 
     def initialize
-      register_format( 'rdoc' )
       @processor = SM::SimpleMarkup.new
       @formatter = SM::ToHtml.new
     end

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: textile.rb 203 2005-02-21 18:42:04Z thomas $
+# $Id: textile.rb 212 2005-02-27 12:02:27Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -22,19 +22,16 @@
 
 begin
   require 'redcloth'
-  require 'webgen/plugins/filehandler/pagehandler/page'
+  require 'webgen/plugins/contenthandler/defaultcontenthandler'
 
   module ContentHandlers
 
     # Handles content in Textile format using RedCloth.
-    class TextileHandler < ContentHandler
+    class TextileContentHandler < DefaultContentHandler
 
       summary "Handles content in Textile format using RedCloth"
-      depends_on "PageHandler"
 
-      def initialize
-        register_format( 'textile' )
-      end
+      register_format( 'textile' )
 
       def format_content( txt )
         RedCloth.new( txt ).to_html

data/lib/webgen/plugins/filehandler/backing.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: backing.rb 203 2005-02-21 18:42:04Z thomas $
+# $Id: backing.rb 214 2005-02-27 13:40:27Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -22,7 +22,7 @@
 
 require 'webgen/plugins/filehandler/filehandler'
 require 'webgen/plugins/filehandler/directory'
-require 'webgen/plugins/filehandler/pagehandler/page'
+require 'webgen/plugins/filehandler/page'
 
 module FileHandlers
 
@@ -98,7 +98,7 @@ module FileHandlers
     end
 
     def process_backing_file( dirNode )
-      backingFiles = dirNode.find_all {|child| /\.#{Webgen::Plugin.config[self.class.name].extension}$/ =~ child['src'] }
+      backingFiles = dirNode.find_all {|child| /\.#{Webgen::Plugin.config[self.class].extension}$/ =~ child['src'] }
 
       backingFiles.each do |backingFile|
         backingFile['content'].each do |filename, data|
@@ -158,7 +158,7 @@ module FileHandlers
         when '..'
           node = node.parent
         else
-          node = node.find do |child| /^#{element}\/?$/ =~ child['src'] end
+          node = node.find {|child| /^#{element}\/?$/ =~ child['src'] }
         end
         if node.nil?
           node = FileHandlers::DirHandler::DirNode.new( parent, element )

data/lib/webgen/plugins/filehandler/directory.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: directory.rb 203 2005-02-21 18:42:04Z thomas $
+# $Id: directory.rb 224 2005-03-16 15:26:33Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -58,13 +58,16 @@ module FileHandlers
 
     summary "Handles directories"
     extension :dir
-    add_param 'indexFile', 'index.html', 'The default file name for the directory index file.'
+    add_param 'indexFile', 'index.page', 'The default file name for the directory index file.'
     depends_on 'FileHandler'
 
 
     # Return a new DirNode.
     def create_node( path, parent )
-      DirNode.new( parent, File.basename( path ) )
+      unless parent && node = parent.find {|child| /^#{File.basename( path )}\/$/ =~ child['src'] }
+        node = DirNode.new( parent, File.basename( path ) )
+      end
+      node
     end
 
     # Create the directory (and all its parent directories if necessary).
@@ -91,6 +94,25 @@ module FileHandlers
       super( lang_node, refNode, title )
     end
 
+    # Recursively create a given path
+    def recursive_create_path( path, parent )
+      p = parent
+      node = nil
+      path.split( File::SEPARATOR ).each do |pathname|
+        case pathname
+        when '.' then
+          # do nothing
+        when '..' then
+          p = p.parent
+        else
+          node = create_node( pathname, p )
+          p.add_child( node ) unless p.nil? || node.nil?
+          p = node
+        end
+      end
+      node
+    end
+
   end
 
 end