webgen 0.4.7 → 0.5.0

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

@@ -1,82 +0,0 @@
-#
-#--
-#
-# $Id: sitemap.rb 563 2006-12-29 08:59:41Z 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
-#
-#++
-#
-
-load_plugin 'webgen/plugins/tags/tag_processor'
-load_plugin 'webgen/plugins/filehandlers/page'
-
-module Tags
-
-  # Generates a sitemap. The sitemap contains the hierarchy of all pages on the web site.
-  class SitemapTag < DefaultTag
-
-    infos( :name => 'Tag/Sitemap',
-           :author => Webgen::AUTHOR,
-           :summary => 'Shows all page files of the website'
-           )
-
-    param 'levelTag', 'ul', 'The tag used for creating a new hierarchy level.'
-    param 'itemTag', 'li', 'The tag used for hierarchy items.'
-    param 'honorInMenu', true, 'Only pages for which the \'inMenu\' meta information is set are shown in ' +
-      'the sitemap if true'
-
-    register_tag 'sitemap'
-
-
-    def process_tag( tag, chain )
-      root = Node.root( chain.last )
-      output_node( root, chain.last )
-    end
-
-    #######
-    private
-    #######
-
-    def output_node( node, src_node )
-      nodes = node.select do |child|
-        child.is_directory? || (child.kind_of?( FileHandlers::PageHandler::PageNode ) && child['lang'] == src_node['lang'])
-      end
-      return '' if nodes.empty?
-
-      out = "<#{param( 'levelTag' )}>"
-      temp = ''
-      nodes.sort.each do |child|
-        next if !child.is_directory? &&
-          ((param( 'honorInMenu' ) && !child['inMenu']) ||
-           (!node['indexFile'].nil? && node['indexFile'].node_info[:pagename] == child.node_info[:pagename] && !node.parent.nil?))
-
-        subout = output_node( child, src_node )
-        link = child.link_from( src_node, :context => { :caller => self.class.plugin_name } ) if !child.is_directory? || subout != ''
-
-        temp += "<#{param( 'itemTag' )}>#{link}" if !child.is_directory? || subout != ''
-        temp += subout if child.is_directory?
-        temp += "</#{param( 'itemTag' )}>" if !child.is_directory? || subout != ''
-      end
-
-      out += temp
-      out += "</#{param( 'levelTag' )}>"
-
-      (temp == '' ? temp : out)
-    end
-
-  end
-
-end

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

@@ -1,279 +0,0 @@
-#
-#--
-#
-# $Id: tag_processor.rb 572 2006-12-31 08:19:56Z 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 class is used for processing tags. When a content string 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 defined by using the special key <tt>:default</tt>.
-  class TagProcessor < Webgen::Plugin
-
-    infos( :name => 'Core/TagProcessor',
-           :author => Webgen::AUTHOR,
-           :summary => "Plugin for processing tags"
-           )
-
-    # Processes the given +content+ using the nodes in +chain+ which should be an array of nodes.
-    # The first node is the main template (from which the +content+ was retrieved, the +ref_node+),
-    # then comes the sub template, the sub sub template and so on until the last node which is the
-    # current node (the +node+) that is the reason for the whole processing.
-    #
-    # After having processed all nodes, the method returns the result as string, ie. the rendered
-    # content.
-    def process( content, chain )
-      if !content.kind_of?( String )
-        log(:warn) { "The content in <#{chain.first.node_info[:src]}> is not a string, but a #{content.class.name}" }
-        content = content.to_s
-      end
-
-      return replace_tags( content, chain.first ) do |tag, tag_data|
-        log(:debug) { "Replacing tag #{tag} with data '#{tag_data}' in <#{chain.first.full_path}>" }
-
-        result = ''
-        processor = processor_for_tag( tag )
-        if !processor.nil?
-          begin
-            processor.set_tag_config( YAML::load( "--- #{tag_data}" ), chain.first )
-          rescue ArgumentError => e
-            log(:error) { "Could not parse the data '#{tag_data}' for tag #{tag} in <#{node.nod_info[:src]}>: #{e.message}" }
-          end
-          result, tag_chain = processor.process_tag( tag, chain )
-          processor.reset_tag_config
-
-          result = process( result, tag_chain || chain ) if processor.process_output?
-        end
-
-        result
-      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, node ) # :yields: tag, data
-      offset = 0;
-      content = content.dup
-      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
-          log(:error) { "Unbalanced curly brackets in <#{node.node_info[:src]}>!!!" }
-          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 ).to_s
-          end
-          content[index, length] = newContent
-        end
-        offset = index + newContent.length
-      end
-      content
-    end
-
-
-    # Returns the tag processor for +tag+ or +nil+ if +tag+ is unknown.
-    def processor_for_tag( tag )
-      tags = registered_tags
-      if tags.has_key?( tag )
-        tags[tag]
-      elsif tags.has_key?( :default )
-        tags[:default]
-      else
-        log(:error) { "No tag processor for tag '#{tag}' found" }
-      end
-    end
-
-    # Returns a hash of the registered tag plugins with the tag name as key.
-    def registered_tags
-      if !defined?( @registered_tags_cache ) || @cached_plugins_hash != @plugin_manager.plugins.keys.hash
-        @registered_tags_cache = {}
-        @plugin_manager.plugins.each do |name, plugin|
-          if plugin.kind_of?( DefaultTag )
-            #TOOD write log message if duplicate tag name
-            plugin.tags.each {|tag| @registered_tags_cache[tag] = plugin }
-          end
-        end
-        @cached_plugins_hash = @plugin_manager.plugins.keys.hash
-      end
-      @registered_tags_cache
-    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
-
-    infos( :name => 'Tag/Default',
-           :summary => "Base plugin for all tag plugins",
-           :author => Webgen::AUTHOR,
-           :instantiate => false
-           )
-
-    def initialize( plugin_manager )
-      super
-      @process_output = true
-      @cur_config = {}
-      @tags = []
-    end
-
-    # Returns +true+ if the output should be processed again
-    def process_output?
-      @process_output
-    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.params.nil? || !self.config.params.has_key?( param )
-        $stderr.puts( "Cannot set parameter #{param} as mandatory as this parameter does not exist for #{self.name}" ) if $VERBOSE
-      else
-        self.config.params[param].mandatory = true
-        self.config.params[param].mandatory_default = default
-      end
-    end
-
-    # Register +tag+ so that it gets processed by the current class.
-    def self.register_tag( tag )
-      (self.config.infos[:tags] ||= [] ) << tag
-    end
-
-    # See DefaultTag.register_tag
-    def register_tag( tag )
-      @tags << tag
-    end
-
-    # Returns all registered tags for the plugin.
-    def tags
-      (self.class.config.infos[:tags] || []) + @tags
-    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 )
-      @cur_config = {}
-      case config
-      when Hash
-        set_cur_config( config, node )
-
-      when String
-        set_default_mandatory_param( config, node )
-
-      when NilClass
-
-      else
-        log(:error) { "Invalid parameter type (#{config.class}) for tag '#{self.class.plugin_name}' in <#{node.node_info[:src]}>" }
-      end
-
-      unless all_mandatory_params_set?
-        log(:error) { "Not all mandatory parameters for tag '#{self.class.plugin_name}' in <#{node.node_info[:src]}> set" }
-      end
-    end
-
-    # Resets the tag configuration data.
-    def reset_tag_config
-      @cur_config = {}
-    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 param( name, plugin = nil )
-      if @cur_config.has_key?( name ) && plugin.nil?
-        return @cur_config[name]
-      else
-        super( name, plugin )
-      end
-    end
-
-    # Default implementation for processing a tag. The parameter +tag+ specifies the name of the tag
-    # which should be processed (useful for tag plugins which process different tags).
-    #
-    # The +node_chain+ parameter holds all relevant nodes. The first node in the chain is always the
-    # node in which the tag was found (a template )and the last node is the current node, i.e. the
-    # page node which triggered all this. The nodes between are other template nodes.
-    #
-    # The method has to return the result of the tag processing and, optionally, a modified chain
-    # (as second result). The second value is currently only returned by the block tag.
-    #
-    # Has to be overridden by subclasses!!!
-    def process_tag( tag, node_chain )
-      raise NotImplementedError
-    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 self.class.config.params.has_key?( key )
-          @cur_config[key] = value
-          log(:debug) { "Setting parameter '#{key}' to '#{value}' for tag '#{self.class.plugin_name}' in <#{node.node_info[:src]}>" }
-        else
-          log(:warn) { "Invalid parameter '#{key}' for tag '#{self.class.plugin_name}' in <#{node.node_info[:src]}>" }
-        end
-      end
-    end
-
-    # Set the default mandatory parameter.
-    def set_default_mandatory_param( value, node )
-      param_name, param_value = self.class.config.params.find {|k,v| v.mandatory_default} unless self.class.config.params.nil?
-      if param_name.nil?
-        log(:error) { "No default mandatory parameter specified for tag '#{self.class.plugin_name}' but set in <#{node.node_info[:src]}>"}
-      else
-        @cur_config[param_name] = value
-      end
-    end
-
-    # Check if all mandatory parameters have been set
-    def all_mandatory_params_set?
-      params = self.class.config.params
-      ( params.nil? ? true : params.all? { |k,v| !v.mandatory || @cur_config.has_key?( k ) || !v.default.nil? } )
-    end
-
-  end
-
-end

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

@@ -1,62 +0,0 @@
-#
-#--
-#
-# $Id: wikilink.rb 563 2006-12-29 08:59:41Z 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
-#
-#++
-#
-
-load_plugin 'webgen/plugins/tags/tag_processor'
-
-module Tags
-
-  class WikiLinkTag < DefaultTag
-
-    infos( :name => 'Tag/WikiLink',
-           :author => Webgen::AUTHOR,
-           :summary => 'Adds a link to a wiki page'
-           )
-
-    param 'linkText', nil, 'The text of the link. If it is not specified, the title of the current page is used.'
-    param 'rootURL', '/wiki/wiki.pl?', 'The root URL for the wiki link, ie. the path to the wiki CGI.'
-    param 'relURL', nil, 'The relativ URL for the wiki link (the varying part that is appended to rootURL). ' +
-      'If it is not specified, the title of the current page is used.'
-    param 'invalidChars', ' &;', 'The characters which are invalid in wiki URLs.'
-    param 'replacementChar', '_', 'The character(s) which should be used instead of the invalid characters.'
-    set_mandatory 'rootURL'
-    set_mandatory 'invalidChars'
-    set_mandatory 'replacementChar'
-
-    register_tag 'wikilink'
-
-    def process_tag( tag, chain )
-      "<a href=\"#{link( chain.last )}\">#{param( 'linkText' ) || chain.last['title']}</a>"
-    end
-
-    #######
-    private
-    #######
-
-    def link( node )
-      rootURL = param( 'rootURL' )
-      relURL = param( 'relURL' ) || node['title']
-      rootURL + relURL.tr( param( 'invalidChars' ), param( 'replacementChar' ) )
-    end
-
-  end
-
-end

data/lib/webgen/rake/webgentask.rb

@@ -1,161 +0,0 @@
-# -*- ruby -*-
-
-#
-#--
-# webgentask.rb:
-#
-#   Define a task library for running webgen
-#
-# Copyright (C) 2007 Jeremy Hinegardner
-#
-# 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 'rake'
-require 'rake/tasklib'
-
-module Webgen
-
-  module Rake
-
-    ##
-    # A Rake task that generates a webgen website.
-    #
-    # It is assumed that you have already used the 'webgen' command
-    # to create the base directory for the site.  This task is here
-    # to make it easier to integrate the generation of the website
-    # within the broader scope of another project.
-    #
-    # === Basics
-    #
-    #   require 'webgen/rake/webgentask'
-    #
-    #   Webgen::Rake::WebgenTask.new do |t|
-    #       t.directory = File.join(Dir.pwd, "webgen")
-    #   end
-    #
-    # === Attributes
-    #
-    # The attributes available to the task in the new block are:A
-    #
-    # * name              - the name of the task.  This can also be set as
-    #                       a parameter to new (default :webgen)
-    # * directory         - the root directory of the webgen site
-    #                       (default File.join(Dir.pwd, "webgen")
-    # * clobber_outdir    - remove webgens output directory on clobber
-    #                       (default false)
-    #
-    # === Tasks Provided
-    #
-    # The tasks provided are :
-    #
-    # * webgen         - create the website
-    # * clobber_webgen - remove all the files created during creation
-    #
-    # If the +name+ attribute is changed then the tasks are changed
-    # to reflect that.  For Example:
-    #
-    #   Webgen::Rake::WebgenTask.new(:my_webgen) do |t|
-    #       t.clobber_outdir = true
-    #   end
-    #
-    # This will create tasks:
-    #
-    # * my_webgen
-    # * clobber_my_webgen
-    #
-    class WebgenTask < ::Rake::TaskLib
-
-      # Name of webgen task. (default is :webgen)
-      attr_accessor :name
-
-      # The directory of the webgen site.  This would be the
-      # directory of your config.yaml file.  Or the parent
-      # directory of the src/ directory for webgen
-      #
-      # The default for this is assumed to be
-      #   File.join(Dir.pwd,"webgen")
-      attr_accessor :directory
-
-      # During the clobber, should webgen's output directory be
-      # clobbered.  The default is false
-      attr_accessor :clobber_outdir
-
-      # Create a webgen task
-      def initialize(name = :webgen)
-        @name           = name
-        @directory      = File.join(Dir.pwd, "webgen")
-        @clobber_outdir = false
-
-        yield self if block_given?
-
-        @rendered_files = FileList.new
-
-        define
-      end
-
-      def define
-        desc "Run webgen"
-        task @name do |t|
-          Dir.chdir(@directory) do
-            begin
-              # some items from webgen may be sensitive to the
-              # current directory when it runs
-
-              require 'webgen/website'
-              @website = Webgen::WebSite.new @directory
-              @out_dir = File.expand_path(@website.param_for_plugin('Core/Configuration', 'outDir'))
-              @website.render
-              puts "Webgen rendered to : #{@out_dir}"
-
-              file_list = @website.manager['Misc/RenderedFiles'].files
-
-              # remove @out_dir from the list of rendered_files
-              file_list.delete @out_dir
-
-              @rendered_files << file_list
-            rescue => e
-              puts "Webgen task failed: #{e}"
-              raise e
-            end
-          end
-        end
-
-        clobber_task = paste("clobber_",@name)
-
-        # bit of conundrum here since we don't know what files
-        # to remove until they have been generated, so we have
-        # to generate all the files to remove them.
-        #
-        # I don't know of the right way to do this yet.
-        desc "Remove webgen products"
-        task clobber_task => [@name] do
-          rm_rf @rendered_files
-          if @clobber_outdir then
-            rm_r @out_dir rescue nil
-          end
-        end
-
-        task :clobber => [clobber_task]
-        self
-      end
-
-    end
-  end
-end
-