webgen 0.3.8 → 0.4.0

data/lib/webgen/plugins/menustyles/partial.rb

@@ -1,95 +0,0 @@
-#
-#--
-#
-# $Id: partial.rb 369 2005-12-24 11:37:40Z 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 'webgen/plugins/menustyles/default'
-
-module MenuStyles
-
-  class PartialMenuStyle < MenuStyles::DefaultMenuStyle
-
-    summary "Builds a partial menu"
-    description "Creates a menu that only shows the menu levels under the current page"
-
-    register_menu_style 'partial'
-
-    add_param 'subtreeLevel', 1, \
-    'Specifies how many levels should be shown. The number specifies ' \
-    'the maximum depth the menu will have.'
-    add_param 'dropdown', false, 'Specifies if the menu should be a drop-down menu'
-
-    CSS = "
-/* START Webgen partial menu style */
-.webgen-menu-partial-dropdown > ul {
-  display: none;
-}
-
-.webgen-menu-partial-dropdown:hover > ul {
-  display: block;
-}
-/* STOP Webgen partial menu style */
-"
-
-    def internal_build_menu( srcNode, menuTree )
-      unless defined?( @css_added )
-        Webgen::Plugin['ResourceManager'].append_data( 'webgen-css', CSS )
-        @css_added = true
-      end
-      styles = ['webgen-menu-partial',
-                (get_param( 'dropdown' ) ? 'webgen-menu-partial-dropdown' : ''),
-                get_param( 'divClass' )]
-
-      "<div class=\"#{styles.join(' ')}\">#{submenu( srcNode, menuTree, 1 )}</div>"
-    end
-
-    #######
-    private
-    #######
-
-    def submenu( srcNode, node, level )
-      if node.nil? || level - srcNode.level >= get_param( 'subtreeLevel' ) || \
-        (level >= srcNode.level && !node['node'].in_subtree?( srcNode ))
-        return ''
-      end
-
-      out = ''
-      if get_param( 'dropdown' ) && level == srcNode.level
-        style, link = menu_item_details( srcNode, node['node'] )
-        out << "#{link}"
-      end
-
-      out << "<ul>" if level >= srcNode.level
-      node.each do |child|
-        menu = child['node']['int:directory?'] ? submenu( srcNode, child, level + 1 ) : ''
-        style, link = menu_item_details( srcNode, child['node'] )
-
-        out << "<li #{style}>#{link}" if level >= srcNode.level
-        out << menu
-        out << "</li>" if level >= srcNode.level
-      end
-      out << "</ul>" if level >= srcNode.level
-
-      return out
-    end
-
-  end
-
-end

data/lib/webgen/plugins/tags/tags.rb

@@ -1,254 +0,0 @@
-#
-#--
-#
-# $Id: tags.rb 369 2005-12-24 11:37:40Z 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'
-
-module Tags
-
-  # This is the main class for tags. Tag plugins can register themselves by adding a new key:value
-  # pair to +tags+. The key has to be the name of the tag as specified in the page description files
-  # and the value is the plugin object itself. When the content is parsed and a tag is
-  # encountered, the registered plugin for the tag is called. If no plugin for a tag is registered
-  # but a default plugin is, the default plugin is called. Otherwise an error is raised.
-  #
-  # The default plugin can be registered by using the special key <tt>:default</tt>.
-  class Tags < Webgen::Plugin
-
-    summary "Super plugin for handling tags"
-
-    # Substitutes all references to tags in the string +content+. The +node+ parameter specifies the
-    # tree node the content of which is used. The +refNode+ parameter specifies relative to which
-    # all references should be resolved.
-    def substitute_tags( content, node, refNode )
-      if !content.kind_of?( String )
-        self.logger.error { "The content in <#{refNode.recursive_value( 'src' )}> is not a string, but a #{content.class.name}" }
-        content = content.to_s
-      end
-      return replace_tags( content ) do |tag, data|
-        self.logger.info { "Replacing tag #{tag} with data '#{data}' in <#{node.recursive_value( 'dest' )}>" }
-        processor = get_tag_processor( tag )
-        begin
-          processor.set_tag_config( YAML::load( "--- #{data}" ), refNode )
-        rescue ArgumentError => e
-          self.logger.error { "Could parse the data '#{data}' for tag #{tag} in <#{node.recursive_value( 'dest' )}>: #{e.message}" }
-        end
-        output = processor.process_tag( tag, node, refNode )
-        processor.reset_tag_config
-        output = substitute_tags( output, node, node ) if processor.processOutput
-        output
-      end
-    end
-
-    #######
-    private
-    #######
-
-    # Scans the +content+ for tags. If a tag is found, the block is called which needs to return the
-    # value for the given tag. The changed content is returned.
-    def replace_tags( content ) # :yields: tag, data
-      offset = 0;
-      while index = content.index( /(\\*)\{(\w+):/, offset )
-        bracketCount = 1;
-        length = $1.length + 1;
-        tag = $2
-        content[(index + length)..-1].each_byte do |char|
-          length += 1
-          bracketCount += 1 if char == ?{
-          bracketCount -= 1 if char == ?}
-          break if bracketCount == 0
-        end
-
-        if bracketCount > 0
-          self.logger.error { "Unbalanced curly brackets!!!" }
-          newContent = content[index, length]
-        else
-          newContent = "\\"* ( $1.length / 2 )
-          if $1.length % 2 == 1
-            newContent += content[index + $1.length, length - $1.length]
-          else
-            tagHeaderLength = $1.length + tag.length + 2
-            realContent = content[index + tagHeaderLength, length - tagHeaderLength - 1].lstrip
-            newContent += yield( tag, realContent )
-          end
-          content[index, length] = newContent
-        end
-        offset = index + newContent.length
-      end
-      content
-    end
-
-
-    # Returns the tag processor for +tag+ or throws an error if +tag+ is unkown.
-    def get_tag_processor( tag )
-      tags = DefaultTag.get_tag_plugins
-      if tags.has_key?( tag )
-        return Webgen::Plugin.config[tags[tag]].obj
-      elsif tags.has_key?( :default )
-        return Webgen::Plugin.config[tags[:default]].obj
-      else
-        self.logger.error { "No tag processor for tag '#{tag}' found" }
-        return DefaultTag.new
-      end
-    end
-
-  end
-
-
-  # Base class for all tag plugins. The base class provides a default mechanism for retrieving
-  # configuration data from either the configuration file or the tag itself.
-  class DefaultTag < Webgen::Plugin
-
-    VIRTUAL = true
-
-    summary "Base class for all tag plugins"
-    depends_on "Tags"
-
-    # +true+, if the output should be processed again
-    attr_reader :processOutput
-
-    def initialize
-      @processOutput = true
-    end
-
-    # Set the parameter +param+ as mandatory. The parameter +default+ specifies, if this parameter
-    # should be the default mandatory parameter. If only a String is supplied in a tag, its value
-    # will be assigned to the default mandatory parameter. There *should* be only one default
-    # mandatory parameter.
-    def self.set_mandatory( param, default = false )
-      if self.config[self].params.nil? || !self.config[self].params.has_key?( param )
-        self.logger.error { "Cannot set parameter #{param} as mandatory as this parameter does not exist for #{self.name}" }
-      else
-        self.config[self].params[param].mandatory = true
-        self.config[self].params[param].mandatoryDefault = default
-      end
-    end
-
-    # Register +tag+ so that it gets handled by the current class.
-    def self.tag( tag )
-      logger.info { "Registering class #{self.name} for handling the tag '#{tag}'" }
-      tags = (self.config[DefaultTag].tag_plugins ||= {})
-      logger.warn { "Tag #{tag} already associated with class #{tags[tag].name}, not using class #{self.name} for it!" } if tags[tag]
-      tags[tag] ||= self
-      self.config[self].tag = tag
-    end
-
-    # Old style API
-    def register_tag( tag )
-      self.class.tag( tag )
-    end
-
-    # Returns the registered tag plugins.
-    def self.get_tag_plugins
-      self.config[DefaultTag].tag_plugins
-    end
-
-    # Set the configuration parameters for the next #process_tag call. The configuration, if
-    # specified, is taken from the tag itself.
-    def set_tag_config( config, node )
-      @curConfig = {}
-      case config
-      when Hash
-        set_cur_config( config, node )
-
-      when String
-        set_default_mandatory_param( config )
-
-      when NilClass
-        if has_mandatory_params?
-          self.logger.error { "Mandatory parameters for tag '#{self.class.name}' in <#{node.recursive_value( 'src' )}> not specified" }
-        end
-
-      else
-        self.logger.error { "Invalid parameter for tag '#{self.class.name}' in <#{node.recursive_value( 'src' )}>" }
-      end
-
-      unless all_mandatory_params_set?
-        self.logger.error { "Not all mandatory parameters for tag '#{self.class.name}' in <#{node.recursive_value( 'src' )}> set" }
-      end
-    end
-
-
-    # Resets the tag configuration data.
-    def reset_tag_config
-      @curConfig = {}
-    end
-
-
-    # Default implementation for processing a tag.
-    #
-    # Has to be overridden by the subclass!!!
-    def process_tag( tag, node, refNode )
-      ''
-    end
-
-    #######
-    private
-    #######
-
-    # Set the current configuration taking values from +config+ which has to be a Hash.
-    def set_cur_config( config, node )
-      config.each do |key, value|
-        if has_param?( key )
-          @curConfig[key] = value
-          self.logger.debug { "Setting parameter '#{key}' for tag '#{self.class.name}' in <#{node.recursive_value( 'src' )}>" }
-        else
-          self.logger.warn { "Invalid parameter '#{key}' for tag '#{self.class.name}' in <#{node.recursive_value( 'src' )}>" }
-        end
-      end
-    end
-
-    # Set the default mandatory parameter.
-    def set_default_mandatory_param( value )
-      data = Webgen::Plugin.config[self.class]
-      key = data.params.detect {|k,v| v.mandatoryDefault} unless data.params.nil?
-      if key.nil?
-        self.logger.error { "Default mandatory parameter not specified for tag '#{self.class.name}'"}
-      else
-        @curConfig[key[0]] = value
-      end
-    end
-
-    # Check if this tag has mandatory parameters.
-    def has_mandatory_params?
-      data = Webgen::Plugin.config[self.class]
-      !data.params.nil? && data.params.any? {|k,v| v.mandatory }
-    end
-
-    # Check if all mandatory parameters have been set
-    def all_mandatory_params_set?
-      params = Webgen::Plugin.config[self.class].params
-      ( params.nil? ? true : params.all? { |k,v| !v.mandatory || @curConfig.has_key?( k ) } )
-    end
-
-    # Retrieves the parameter value for +name+. The value is taken from the current tag if the
-    # parameter is specified there or the default value set in #register_config_value is used.
-    def get_param( name )
-      if !@curConfig.nil? && @curConfig.has_key?( name )
-        return @curConfig[name]
-      else
-        super( name )
-      end
-    end
-
-  end
-
-end