webgen 0.3.2 → 0.3.3

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: backing.rb 214 2005-02-27 13:40:27Z thomas $
+# $Id: backing.rb 256 2005-04-14 01:13:57Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -26,36 +26,7 @@ require 'webgen/plugins/filehandler/page'
 
 module FileHandlers
 
-  # Handles page description backing files. Backing files are files that specify meta information
-  # for other files. They are written in YAML and have a very easy structure:
-  #
-  #    filename1.html:
-  #      lang1:
-  #        metainfo1: value1
-  #        metainfo2: value2
-  #      lang2:
-  #        metainfo21: value21
-  #
-  #    dir1/../dir1/filenam2.html:
-  #      lang1:
-  #        title: New titel by backing file
-  #
-  #    /index.html:
-  #      lang1:
-  #        title: YES!!!
-  #
-  # As you can see, you can use relative and absoulte paths in the filenames. However, you cannot
-  # specify meta information for files which are in one of the parent directories of the backing
-  # file. These backing files are very useful if you are using page description files which do not
-  # support meta information, e.g. HTML fragment files.
-  #
-  # Using backing files you can add virtual files and directories. If the file specified in the
-  # entry does not exist, a virtual page node for that entry will be created. This will also create
-  # the whole directory tree this virtual node is in. This allows you, for example, to add external
-  # items to the menu. You need to specify the +dest+ meta information which points to the actual
-  # location of the referenced page. If the virtual page references an external page, you have to
-  # add the +external+ meta information (i.e. set +external+ to +true+).
-  class BackingFileHandler < DefaultHandler
+  class BackingFileHandler < DefaultFileHandler
 
     summary "Handles backing files for page file"
     extension 'info'
@@ -94,7 +65,7 @@ module FileHandlers
 
     def valid_content( data )
       data.kind_of?( Hash ) \
-      && data.all? {|k,v| v.kind_of?( Hash ) && v.all? {|k1,v1| v1.kind_of?( Hash )} }
+      && data.all? {|k,v| v.kind_of?( Hash ) }
     end
 
     def process_backing_file( dirNode )
@@ -104,13 +75,8 @@ module FileHandlers
         backingFile['content'].each do |filename, data|
           if dirNode.node_for_string?( filename )
             backedFile = dirNode.node_for_string( filename )
-            data.each do |language, fileData|
-              langFile = Webgen::Plugin['PageHandler'].get_lang_node( backedFile, language )
-              next unless langFile['lang'] == language
-
-              self.logger.info { "Setting meta info data on file <#{langFile.recursive_value( 'dest' )}>" }
-              langFile.metainfo.update( fileData )
-            end
+            self.logger.info { "Setting meta info data on file <#{backedFile.recursive_value( 'dest' )}>" }
+            backedFile.metainfo.update( data )
           else
             add_virtual_node( dirNode, filename, data )
           end
@@ -124,23 +90,12 @@ module FileHandlers
       filename = File.basename( path )
       dirNode = create_path( dirname, dirNode )
 
-      data.each do |language, filedata|
-        self.logger.debug { "Trying to create virtual node for '#{filename}'..." }
-        filedata['lang'] = language
-
-        handler = VirtualPageHandler.new
-        pageNode = handler.create_node_from_data( '', filename, dirNode )
-        unless pageNode.nil?
-          pageNode['processor'] = Webgen::Plugin['VirtualPageHandler']
-          self.logger.debug { "Adding virtual page node <#{pageNode.recursive_value( 'src', false )}> to directory <#{dirNode.recursive_value( 'src' )}>" }
-          dirNode.add_child( pageNode )
-        end
-        pageNode ||= Webgen::Plugin['VirtualPageHandler'].get_page_node( filename, dirNode ) #TODO
-        node = Webgen::Plugin['VirtualPageHandler'].get_lang_node( pageNode, language )
-        node.metainfo.update( filedata )
-        self.logger.info { "Created virtual node <#{node.recursive_value( 'src' )}> (#{language}) in <#{dirNode.recursive_value( 'dest' )}> " \
-          "referencing '#{node['dest']}'" }
-      end
+      self.logger.debug { "Trying to create virtual node for '#{filename}'..." }
+      pageNode = Webgen::Plugin['VirtualPageHandler'].create_node_from_data( '', filename, dirNode )
+      dirNode.add_child( pageNode )
+      pageNode.metainfo.update( data )
+      self.logger.info { "Created virtual node <#{pageNode.recursive_value( 'src' )}> (#{pageNode['lang']}) in <#{dirNode.recursive_value( 'dest' )}> " \
+        "referencing '#{pageNode['dest']}'" }
     end
 
 

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: directory.rb 224 2005-03-16 15:26:33Z thomas $
+# $Id: directory.rb 256 2005-04-14 01:13:57Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -25,7 +25,7 @@ require 'webgen/plugins/filehandler/filehandler'
 module FileHandlers
 
   # Handles directories.
-  class DirHandler < DefaultHandler
+  class DirHandler < DefaultFileHandler
 
     # Specialized node describing a directory.
     class DirNode < Node
@@ -43,7 +43,7 @@ module FileHandlers
       end
 
       def process_dir_index
-        node = Webgen::Plugin['PageHandler'].get_page_node( Webgen::Plugin['DirHandler']['indexFile'], self )
+        node = Webgen::Plugin['PageHandler'].get_page_node_by_name( self, 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
@@ -58,7 +58,7 @@ module FileHandlers
 
     summary "Handles directories"
     extension :dir
-    add_param 'indexFile', 'index.page', 'The default file name for the directory index file.'
+    add_param 'indexFile', 'index.html', 'The default file name for the directory index file.'
     depends_on 'FileHandler'
 
 
@@ -76,12 +76,12 @@ module FileHandlers
       FileUtils.makedirs( name ) unless File.exists?( name )
     end
 
-    # Return the language node for the directory +node+ using the specified language +lang+. If an
+    # Return the page node for the directory +node+ using the specified language +lang+. If an
     # index file is specified, then the its correct language node is returned, else +node+ is
     # returned.
-    def get_lang_node( node, lang = node['lang'] )
+    def get_page_node_for_lang( node, lang )
       if node['indexFile']
-        node['indexFile']['processor'].get_lang_node( node['indexFile'], lang )
+        node['indexFile']['processor'].get_page_node_for_lang( node['indexFile'], lang )
       else
         node
       end
@@ -89,7 +89,7 @@ module FileHandlers
 
     # Get the HTML link for the directory +node+.
     def get_html_link( node, refNode, title = nil )
-      lang_node = get_lang_node( node, refNode['lang'] )
+      lang_node = get_page_node_for_lang( node, refNode['lang'] )
       title ||=  lang_node['directoryName'] || node['directoryName']
       super( lang_node, refNode, title )
     end

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: filecopy.rb 210 2005-02-26 13:42:55Z thomas $
+# $Id: filecopy.rb 249 2005-04-13 19:23:51Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -27,7 +27,7 @@ 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 < DefaultHandler
+  class FileCopyHandler < DefaultFileHandler
 
     summary "Copies files from source to destination without modification"
     add_param 'types', ['css', 'jpg', 'png', 'gif'], \

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: filehandler.rb 222 2005-03-13 16:30:40Z thomas $
+# $Id: filehandler.rb 256 2005-04-14 01:13:57Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -156,7 +156,7 @@ module FileHandlers
   end
 
   # The default handler which is the super class of all file handlers.
-  class DefaultHandler < Webgen::Plugin
+  class DefaultFileHandler < Webgen::Plugin
 
     VIRTUAL = true
 
@@ -166,6 +166,9 @@ module FileHandlers
       extension( Webgen::Plugin.config[self.class].extension ) if Webgen::Plugin.config[self.class].extension
     end
 
+    # Specify the extension which should be handled by the class.
+    def self.extension( ext ); @@config[self].extension = ext; end
+
     # Register the file extension specified by a subclass.
     def extension( ext )
       self.logger.info { "Registering file handler #{self.class.name} (#{self.object_id}) with extension '#{ext}'" }
@@ -187,13 +190,6 @@ module FileHandlers
       raise "Not implemented"
     end
 
-    # Returns the language node for the given +node+. The default implementation returns the node
-    # itself. You can optionally specify the language of the node which should be returned. If not
-    # specified the language of the node is used.
-    def get_lang_node( node, lang = node['lang'] )
-      node
-    end
-
     # Returns a HTML link for the given +node+ relative to +refNode+. You can optionally specify the
     # title for the link. If not specified, the title of the node is used.
     def get_html_link( node, refNode, title = node['title'] )

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: page.rb 224 2005-03-16 15:26:33Z thomas $
+# $Id: page.rb 256 2005-04-14 01:13:57Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -27,21 +27,9 @@ module FileHandlers
 
   # Super class for all page description files. Provides helper methods so that writing new plugins
   # for page description files is easy.
-  class PageHandler < DefaultHandler
-
-    # Specialized node describing a page. A page node itself is virtual, it has sub nodes which
-    # describe the page files in all available languages.
-    class PageNode < Node
-
-      def initialize( parent, basename )
-        super( parent )
-        self['page:basename'] = self['title'] = basename
-        self['src'] = self['dest'] = basename
-        self['virtual'] = true
-        self['processor'] = Webgen::Plugin['PageHandler']
-      end
+  class PageHandler < DefaultFileHandler
 
-    end
+    class PageNode < Node; end;
 
     summary "Class for processing page files"
     extension 'page'
@@ -65,7 +53,6 @@ module FileHandlers
 
     def write_node( node )
       # do nothing if page base node
-      return unless node['virtual'].nil?
       templateNode = Webgen::Plugin['TemplateFileHandler'].get_template_for_node( node )
 
       outstring = templateNode['content'].dup
@@ -82,28 +69,26 @@ module FileHandlers
       end
     end
 
-    def page_node_exists?( basename, dirNode )
-      dirNode.find {|node| node['page:basename'] == basename}
+    def get_page_node_by_name( dirNode, name )
+      dirNode.find {|node| node['page:name'] == name}
     end
-    alias :get_page_node :page_node_exists?
 
-    def lang_node_exists?( pageNode, lang )
-      langNode = pageNode.find {|child| child['lang'] == lang }
-      return !langNode.nil?
-    end
-
-    def get_lang_node( node, lang = node['lang'] )
-      node = node.parent unless node['page:basename']
-      langNode = node.find {|child| child['lang'] == lang} ||
-                 node.find {|child| child['lang'] == Webgen::Plugin['Configuration']['lang']}
-      if langNode.nil?
-        langNode = node.children[0]
-        self.logger.warn do
-          "No input file in language '#{lang}' nor the default language (#{Webgen::Plugin['Configuration']['lang']}) found," +
-          "using first available input file for <#{node['title']}>"
+    # Returns the page node for the given language. +node+ has to be a page node!
+    def get_page_node_for_lang( node, lang )
+      dirNode = node.parent
+      pageNode = dirNode.find {|child| child['page:name'] == node['page:name'] && child['lang'] == lang}
+      if pageNode.nil?
+        self.logger.info { "No page node in language '#{lang}' for page '#{node['title']}' found, trying default language" }
+        pageNode = dirNode.find {|child| child['page:name'] == node['page:name'] && child['lang'] == Webgen::Plugin['Configuration']['lang']}
+        if pageNode.nil?
+          self.logger.warn do
+            "No page node in default language (#{Webgen::Plugin['Configuration']['lang']}) " + \
+            "for page '#{node['title']}' found, using supplied page node"
+          end
+          pageNode = node
         end
       end
-      langNode
+      pageNode
     end
 
     #######
@@ -111,32 +96,26 @@ module FileHandlers
     #######
 
     def create_node_internally( data, analysed, parent )
-      pageNodeExisted = get_page_node( analysed.baseName, parent )
-      pageNode = pageNodeExisted || PageNode.new( parent, analysed.baseName )
-
       lang = data['lang'] || analysed.lang
 
-      if lang_node_exists?( pageNode, lang )
-        pageNodeExisted = false
+      if node = parent.find {|node| node['page:commonName'] == analysed.name && node['lang'] == lang }
         logger.warn do
           "Two input files in the same language for one page, " + \
-          "using <#{get_lang_node( pageNode, lang ).recursive_value( 'src' )}> " + \
-          "instead of <#{analysed.srcName}>"
+          "using <#{node.recursive_value( 'src' )}> instead of <#{analysed.srcName}>"
         end
       else
-        node = Node.new( pageNode )
+        node = PageNode.new( parent )
         node.metainfo = data
-        node['node:isLangNode'] = true
         node['lang'] ||= analysed.lang
         node['title'] ||= analysed.title
         node['menuOrder'] ||= analysed.menuOrder
         node['src'] = analysed.srcName
-        node['dest'] = create_output_name( analysed, node.metainfo )
+        node['dest'] = create_output_name( analysed, node['outputNameStyle'] || get_param( 'outputNameStyle' ) )
+        node['page:name'] = create_output_name( analysed, node['outputNameStyle'] || get_param( 'outputNameStyle' ), true )
         node['processor'] = self
-        pageNode.add_child( node )
       end
 
-      return ( pageNodeExisted ? nil : pageNode )
+      return node
     end
 
     def parse_data( data, srcName )
@@ -170,7 +149,6 @@ module FileHandlers
 
       self.logger.info { "Using default language for file <#{srcName}>" } if matchData[3].nil?
       analysed.lang      = matchData[3] || Webgen::Plugin['Configuration']['lang']
-      analysed.baseName  = matchData[2] + '.page'
       analysed.srcName   = srcName
       analysed.useLangPart  = ( !get_param( 'defaultLangInFilename' ) && Webgen::Plugin['Configuration']['lang'] == analysed.lang ? false : true )
       analysed.name      = matchData[2]
@@ -182,38 +160,21 @@ module FileHandlers
       analysed
     end
 
-    def create_output_name( analysed, data )
-      def process_array( array, analysed )
-        array.collect do |part|
-          case part
-          when String
-            part
-          when :name
-            analysed.name
-          when :lang
-            analysed.useLangPart ? analysed.lang : ''
-          when Array
-            part.include?( :lang ) && !analysed.useLangPart ? '' : process_array( part, analysed )
-          else
-            ''
-          end
-        end.join( '' )
-      end
-      process_array( data['outputNameStyle'] || get_param( 'outputNameStyle' ), analysed )
-    end
-
-  end
-
-end
-
-module HTMLValidators
-
-  class HTMLValidator < Webgen::Plugin
-
-    summary "Base class for all HTML validators"
-
-    # Should be overridden in subclass!
-    def validate_file( filename )
+    def create_output_name( analysed, data, omitLangPart = false )
+      data.collect do |part|
+        case part
+        when String
+          part
+        when :name
+          analysed.name
+        when :lang
+          analysed.useLangPart && !omitLangPart ? analysed.lang : ''
+        when Array
+          part.include?( :lang ) && (!analysed.useLangPart || omitLangPart) ? '' : create_output_name( analysed, part, omitLangPart )
+        else
+          ''
+        end
+      end.join( '' )
     end
 
   end

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: picturegallery.rb 221 2005-03-12 17:14:11Z thomas $
+# $Id: picturegallery.rb 249 2005-04-13 19:23:51Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -26,7 +26,7 @@ require 'webgen/plugins/filehandler/page'
 
 module FileHandlers
 
-  class PictureGalleryFileHandler < DefaultHandler
+  class PictureGalleryFileHandler < DefaultFileHandler
 
     summary "Handles picture gallery files for page file"
     extension 'gallery'
@@ -182,7 +182,7 @@ module FileHandlers
 
     end
 
-    class ThumbnailWriter < DefaultHandler
+    class ThumbnailWriter < DefaultFileHandler
 
       summary "Writes out thumbnails with RMagick"
       add_param "thumbnailSize", "100x100", "The size of the thumbnails"

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: template.rb 203 2005-02-21 18:42:04Z thomas $
+# $Id: template.rb 249 2005-04-13 19:23:51Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -25,7 +25,7 @@ require 'webgen/plugins/filehandler/filehandler'
 module FileHandlers
 
   # Handles template files. Template files are generic files which specify the layout.
-  class TemplateFileHandler < DefaultHandler
+  class TemplateFileHandler < DefaultFileHandler
 
     summary "Represents the template files for the page generation in the tree"
     extension 'template'