webgen 0.4.1 → 0.4.2

data/lib/webgen/plugins/filehandlers/sipttra.rb

@@ -0,0 +1,73 @@
+#
+#--
+#
+# $Id: gallery.rb 569 2006-12-29 20:11:21Z 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'
+require 'erb'
+require 'webgen/sipttra_format'
+
+load_plugin 'webgen/plugins/filehandlers/filehandler'
+load_plugin 'webgen/plugins/filehandlers/page'
+
+
+module FileHandlers
+
+  # Handles sipttra (Simple Plain Text Tracker) files.
+  class SipttraHandler < DefaultHandler
+
+    infos( :name => 'File/SipttraHandler',
+           :author => Webgen::AUTHOR,
+           :summary => "Handles sipttra (Simple Plain Text Tracker) files"
+           )
+
+    register_extension 'todo'
+
+    default_meta_info( 'template' => '/sipttra.template' )
+
+    def create_node( file, parent, meta_info )
+      begin
+        data = File.read( file )
+        s = Sipttra::Tracker.new( data )
+      rescue
+        log(:error) { "Could not parse sipttra file <#{file}>, not creating an output page: #{$!.message}" }
+        return
+      end
+      meta_info.update( s.info['webgen-metainfo'] || {} )
+
+      filename = File.basename( file, '.todo' ) + '.page'
+      filehandler = @plugin_manager['Core/FileHandler']
+      pagehandler = @plugin_manager['File/PageHandler']
+      node = filehandler.create_node( filename, parent, pagehandler ) do |filename, parent, handler, mi|
+        pagehandler.create_node_from_data( filename, parent, "Forgotten to specify a sipttra template?! ;-)", mi.merge( meta_info ) )
+      end
+      node.node_info[:sipttra] = s if node
+      node.node_info[:src] = file if node
+
+      node
+    end
+
+    def write_node( node )
+      # do nothing
+    end
+
+  end
+
+end

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: template.rb 588 2007-01-12 09:55:32Z thomas $
+# $Id: template.rb 593 2007-02-13 19:33:44Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -36,6 +36,7 @@ module FileHandlers
 
     register_extension 'template'
 
+    default_meta_info( 'blocks' => [['content', 'html']] )
 
     def create_node( src_name, parent, meta_info )
       begin

data/lib/webgen/plugins/miscplugins/treewalker.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: treewalker.rb 531 2006-11-17 17:56:14Z thomas $
+# $Id: treewalker.rb 620 2007-02-28 09:19:15Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -28,13 +28,25 @@ module TreeWalkers
   # so that it is called when the main class' #execute method is called.
   class TreeWalker < Webgen::Plugin
 
-    infos( :author => Webgen::AUTHOR,
+    infos( :name => 'Misc/TreeWalker',
+           :author => Webgen::AUTHOR,
            :summary => "Super plugin for traversing the node tree"
            )
 
+    attr_reader :walkers
+
+    def initialize( plugin_manager )
+      super
+      @walkers = []
+    end
+
     # Walks the +tree+ for the +walker+ in the +direction+, either +:forward+ or +:backward+.
-    def execute( tree, walker, direction = :forward )
-      walk_tree( tree, walker, 0, direction )
+    # If +walker+ is +nil+, then all registered walkers are used!
+    def execute( tree, walker = nil, direction = :forward )
+      walkers = ( walker.nil? ? @walkers : [walker] )
+      walkers.each do |walker|
+        walk_tree( tree, walker, 0, direction )
+      end
     end
 
     #######
@@ -52,4 +64,28 @@ module TreeWalkers
 
   end
 
+
+  # Prints the whole tree of read files if the log level is at least DEBUG.
+  class DebugTreePrinter < Webgen::Plugin
+
+    infos( :name => 'Misc/DebugTreePrinter',
+           :author => Webgen::AUTHOR,
+           :summary => "Prints out the information in the tree for debug purposes."
+           )
+
+    depends_on 'Misc/TreeWalker'
+
+    def initialize( plugin_manager )
+      super
+      @plugin_manager['Misc/TreeWalker'].walkers << self
+    end
+
+    def call( node, level )
+      log(:debug) do
+        "   "*level  << "\\_ "*(level > 0 ? 1 : 0) << "#{node['title']}: #{node.node_info[:src]} -> #{node.path}"
+      end
+    end
+
+  end
+
 end

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: breadcrumbtrail.rb 561 2006-12-28 07:41:28Z thomas $
+# $Id: breadcrumbtrail.rb 595 2007-02-14 07:43:28Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -40,6 +40,8 @@ module Tags
            )
 
     param 'separator', ' / ', 'Separates the hierachy entries from each other.'
+    param 'omitLast', false, 'Omits the last path component.'
+    param 'omitIndexFile', false, 'Omits the last path component if it is an index file.'
 
     register_tag 'breadcrumbTrail'
 
@@ -47,11 +49,22 @@ module Tags
       out = []
       node = chain.last
 
+      omitIndexFile = if node.meta_info.has_key?( 'omitIndexFileInBreadcrumbTrail' )
+                        node['omitIndexFileInBreadcrumbTrail']
+                      else
+                        param( 'omitIndexFile' )
+                      end
+      omitIndexFile = omitIndexFile && node.parent['indexFile'] &&
+        node.parent['indexFile'].node_for_lang( node['lang'] ) == node
+
+      node = node.parent if omitIndexFile
+
       until node.nil?
         out.push( node.link_from( chain.last ) )
         node = node.parent
       end
 
+      out[0] = '' if param( 'omitLast' ) && !omitIndexFile
       out = out.reverse.join( param( 'separator' ) )
       log(:debug) { "Breadcrumb trail for <#{chain.last.node_info[:src]}>: #{out}" }
       out

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

@@ -0,0 +1,54 @@
+#
+#--
+#
+# $Id: meta.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 CustomVarTag < DefaultTag
+
+    infos( :name => 'Tag/CustomVar',
+           :author => Webgen::AUTHOR,
+           :summary => "Used to output custom variables defined in Core/Configuration:customVars."
+           )
+
+    param 'var', nil, 'The variable of which the value should be retrieved.'
+    set_mandatory 'var', true
+
+    register_tag 'customVar'
+
+    def process_tag( tag, chain )
+      output = ''
+      customVars = param( 'customVars', 'Core/Configuration' )
+      var = param( 'var' )
+
+      if customVars.kind_of?( Hash ) && customVars.has_key?( var )
+        output = customVars[var]
+      else
+        log(:warn) { "No custom variable called '#{var}' found in Core/Configuration:customVars (file <#{chain.first.node_info[:src]}>)" }
+      end
+      output
+    end
+
+  end
+
+end

data/lib/webgen/sipttra_format.rb

@@ -0,0 +1,343 @@
+#
+#--
+#
+# $Id: gallery.rb 569 2006-12-29 20:11:21Z 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'
+require 'cgi'
+
+
+module Sipttra
+
+  # A simple node belonging to a Tracker. One node represents exactly one line of a sipttra file.
+  class Node
+
+    attr_accessor :tracker
+
+    # Returns the line representation of this node.
+    def to_line
+      ''
+    end
+
+  end
+
+
+  # Base class for all nodes which deal with simple text lines.
+  class TextNode < Node
+
+    # The text of the node/line.
+    attr_accessor :text
+
+    def initialize( text )
+      @text = text
+    end
+
+    def to_line
+      @text
+    end
+
+    def to_s
+      @text
+    end
+
+  end
+
+
+  # A comment is just a special text node.
+  class Comment < TextNode; end
+
+
+  # Represents a category line.
+  class Category < Node
+
+    # The name of the category.
+    attr_accessor :name
+
+    # The type of the category.
+    attr_accessor :type
+
+    def initialize( name, type = nil )
+      @name = name
+      @type = type
+      raise "Category must have a name" if name.nil?
+    end
+
+    # Returns all tickets belonging to this category.
+    def tickets
+      tickets = []
+      i = @tracker.nodes.index( self ) + 1
+      while i < @tracker.nodes.length
+        line = @tracker.nodes[i]
+        break if line.kind_of?( Category )
+        tickets << line if line.kind_of?( Ticket )
+        i += 1
+      end
+      tickets
+    end
+
+    def to_line
+      '### ' + to_s + ' ###'
+    end
+
+    def to_s
+      name + (type.nil? ? '' : ' (' + type + ')')
+    end
+
+  end
+
+
+  # Represents a ticket line.
+  class Ticket < Node
+
+    attr_accessor :name, :due_date, :belongs_to, :summary
+
+    def initialize( name, due_date, belongs_to, text = '' )
+      @name =  name
+      @due_date = due_date
+      @belongs_to = belongs_to
+      @summary = text.strip
+    end
+
+    # Returns the category to which this ticket belongs.
+    def category
+      i = @tracker.nodes.index( self ) - 1
+      i -= 1 while i >= 0 && !@tracker.nodes[i].kind_of?( Category )
+      (i < 0 ? nil : @tracker.nodes[i])
+    end
+
+    # Returns +true+ if this ticket is closed, ie. if it belongs to a category with type closed.
+    def closed?
+      category.type == 'closed'
+    end
+
+    # Returns the tickets assigned to this ticket, ie. all sub-tickets. The +type+ parameter can be
+    # one of:
+    # :open   :: all tickets with a type different from +closed+
+    # :closed :: all tickets with type +closed+
+    # :all    :: all tickets independent from type
+    def assigned_tickets( type = :all )
+      if @name.nil?
+        []
+      else
+        @tracker.tickets.select do |t|
+          t.belongs_to == @name &&
+            (type == :all || (type == :closed ? t.category.type == 'closed' : t.category.type != 'closed' ))
+        end
+      end
+    end
+
+    # Returns the detailed description for this ticket.
+    def description
+      text = []
+      line = nil
+      i = @tracker.nodes.index( self ) + 1
+      while i < @tracker.nodes.length && (line = @tracker.nodes[i]).kind_of?( AdditionalText )
+        text << line
+        i += 1
+      end
+      text.join( "\n" ).strip
+    end
+
+    # Returns the whole text for the ticket, ie. the summary and ticket joined by a line separator.
+    def all_text
+      [@summary, description].join( "\n" )
+    end
+    alias_method :to_s, :all_text
+
+    def to_line
+      s = '*'
+      s << ' ' + name unless name.nil?
+      s << ' (' + due_date + ')' unless due_date.nil?
+      s << ' [' + belongs_to + ']' unless belongs_to.nil?
+      s << (!name.nil? && due_date.nil? && belongs_to.nil? ? ':' : '' ) + (summary.empty? ? '' : ' ' + summary.to_s)
+      s
+    end
+
+  end
+
+
+  # Represents a milestone which is a special ticket.
+  class Milestone < Ticket
+
+    def initialize( *args )
+      super( *args )
+      raise "Milestone must have a name" if @name.nil?
+    end
+
+    # Like assigned_tickets but includes tickets in sub milestones.
+    def all_assigned_tickets( type = :all )
+      (assigned_tickets( type ) + sub_milestones.collect {|sm| sm.all_assigned_tickets( type )}).flatten
+    end
+
+    # A milestone is closed if all assigned tickets are closed, including the ones from the sub
+    # milestones.
+    def closed?
+      assigned_tickets( :open ).empty? && sub_milestones.all? {|sm| sm.closed?}
+    end
+
+    # Returns all direct sub milestones.
+    def sub_milestones
+      (@name.nil? ? [] : @tracker.milestones.select {|m| m.belongs_to == @name})
+    end
+
+  end
+
+
+  # Represents additional text lines for tickets. All additional text lines for one ticket are the
+  # ticket's description.
+  class AdditionalText < TextNode
+
+    def initialize( text )
+      super( text.sub( /^  /, '' ) )
+    end
+
+    def to_line
+      (@text.strip.empty? ? '' : '  ' + @text)
+    end
+
+  end
+
+
+  # The tracker is used to parse sipttra files and to change the sipttra data in memory.
+  class Tracker
+
+    IDENT_REGEXP=/\w[-.\w\d]*/
+
+    DATE_REGEXP=/\((\d\d\d\d-\d\d-\d\d)\)/
+    BELONGS_REGEXP=/\[(#{IDENT_REGEXP})\]/
+
+    TICKET_REGEXP=/^\*(?:\s(#{IDENT_REGEXP})(?=:|\s\[|\s\():?)?(?:\s#{DATE_REGEXP})?(?:\s#{BELONGS_REGEXP})?(?:$|\s(.*)$)/
+    CONTENT_REGEXP=/^\s\s(.*)$/
+    CATEGORY_REGEXP=/^(#+)\s{1,}([^(]*?)(?:\s*\((\w+)\))?\s{1,}\1$/
+
+    attr_reader :nodes, :info
+
+    def initialize( data = nil )
+      @nodes = []
+      @info = {}
+      parse( data ) if data
+    end
+
+    # Parses the given +data+ and fills the tracker with information.
+    def parse( data )
+      @nodes = []
+      @info = {}
+      level = 0
+
+      if data =~ /\A---\n/m
+        begin
+          index = data.index( "---\n", 4 ) || 0
+          @info = YAML.load( data[0...index] )
+          data = data[index..-1]
+        rescue
+        ensure
+          @info = {} unless @info.kind_of?( Hash )
+        end
+      end
+
+      data.split(/\n/).each do |line|
+        case
+        when (m = CATEGORY_REGEXP.match( line )) && category( m[2], m[3] ).nil?
+          @nodes << Category.new( m[2], m[3] )
+          level = 1
+
+        when level == 0
+          @nodes  << Comment.new( line )
+
+        when (m = TICKET_REGEXP.match( line )) && (milestone( m[1] ).nil? && ticket( m[1] ).nil?)
+          if @nodes.find_all {|child| child.kind_of?( Category )}.last.type.nil?
+            @nodes << Milestone.new( m[1], m[2], m[3], m[4] || '' )
+          else
+            @nodes << Ticket.new( m[1], m[2], m[3], m[4] || '' )
+          end
+
+        when (@nodes.last.kind_of?( Ticket ) || @nodes.last.kind_of?( AdditionalText )) &&
+            (line.empty? || (m = CONTENT_REGEXP.match( line )))
+          @nodes << AdditionalText.new( line )
+
+        else
+          @nodes << Comment.new( line )
+        end
+        @nodes.last.tracker = self
+      end
+
+    end
+
+    def check_consistency
+      # TODO what to check?
+    end
+
+    # If Bluecloth is available +text+ is considered to be in Markdown format and converted
+    # to HTML. Otherwise the unchanged text is returned.
+    def htmlize( text )
+      require 'bluecloth'
+      BlueCloth.new( text ).to_html
+    rescue
+      text
+    end
+
+    # Returns all categories.
+    def categories
+      @nodes.find_all {|child| child.kind_of?( Category ) && !child.type.nil? }
+    end
+
+    # Returns the category with the given +name+ and +type+.
+    def category( name, type )
+      categories.find {|cat| cat.name == name && cat.type == type}
+    end
+
+    # Returns all category names.
+    def category_names
+      categories.collect {|cat| cat.name}.uniq
+    end
+
+    # Returns all milestones.
+    def milestones
+      @nodes.find_all {|child| child.instance_of?( Milestone ) }
+    end
+
+    # Returns the milestone with the given +name+.
+    def milestone( name )
+      (name.nil? ? nil : milestones.find {|ms| ms.name == name})
+    end
+
+    # Returns all tickets independent from their categories.
+    def tickets
+      @nodes.find_all {|child| child.instance_of?( Ticket ) }
+    end
+
+    # Returns the ticket with the given +name+.
+    def ticket( name )
+      (name.nil? ? nil : tickets.find {|ticket| ticket.name == name})
+    end
+
+    # Returns all tickets for the category +name+ independent from the category type.
+    def tickets_for_category( name )
+      tickets.select {|t| t.category.name == name}
+    end
+
+    # Returns a string representation of the tracker which can later be used by #parse .
+    def to_s
+      @info.to_yaml.sub( /^---\s*\n/m, '' ) + "\n\n" + @nodes.collect {|line| line.to_line}.join( "\n" )
+    end
+
+  end
+
+end