taskjuggler 0.0.11 → 0.1.0

data/examples/tutorial.tjp

@@ -419,7 +419,8 @@ taskreport status "" {
     headline "Project Dashboard (<-query attribute='now'->)"
     columns name { title "Task" ${AlertColor} width 200},
             resources { width 200 ${AlertColor}
-                        listtype bullets listmode 2
+                        listtype bullets
+                        listitem "<-query attribute='name'->"
                         start ${projectstart} end ${projectend} },
             alerttrend { title "Trend" ${AlertColor} width 50 },
             journalmessages { width 350 ${AlertColor} }

data/lib/taskjuggler/Attributes.rb

@@ -448,17 +448,16 @@ class TaskJuggler
       out = []
       if query
         @value.each do |r|
-          case query.listMode
-          when 1
-            out << r.fullId
-          when 2, nil
-            out << r.name
-          when 3
-            out << "#{r.name} (#{r.fullId})"
-          when 4
-            out << "#{r.fullId}: #{r.name}"
+          if query.listItem
+            rti = RichText.new(query.listItem, RTFHandlers.create(r.project),
+                               r.project.messageHandler).
+                               generateIntermediateFormat
+            q = query.dup
+            q.property = r
+            rti.setQuery(q)
+            out << "<nowiki>#{rti.to_s}</nowiki>"
           else
-            out << "Bad listmode #{query.listmode}. Use 1 - 4."
+            out << "<nowiki>#{r.name}</nowiki>"
           end
         end
         query.assignList(out)
@@ -576,6 +575,28 @@ class TaskJuggler
     end
   end
 
+  class TaskDepListAttribute < ListAttributeBase
+    def initialize(property, type)
+      super
+    end
+
+    def TaskDepListAttribute::tjpId
+      'taskdeplist'
+    end
+
+    def to_s(query = nil)
+      out = []
+      @value.each { |t, onEnd| out << t.fullId }
+      out.join(", ")
+    end
+
+    def to_tjp
+      out = []
+      @value.each { |t, onEnd| out << t.fullId }
+      @type.id + " " + out.join(', ')
+    end
+  end
+
   class TaskListAttribute < ListAttributeBase
     def initialize(property, type)
       super
@@ -587,13 +608,13 @@ class TaskJuggler
 
     def to_s(query = nil)
       out = []
-      @value.each { |t, onEnd| out << t.fullId }
+      @value.each { |t| out << t.fullId }
       out.join(", ")
     end
 
     def to_tjp
       out = []
-      @value.each { |t, onEnd| out << t.fullId }
+      @value.each { |t| out << t.fullId }
       @type.id + " " + out.join(', ')
     end
   end

data/lib/taskjuggler/DataCache.rb

@@ -99,6 +99,21 @@ class TaskJuggler
       value
     end
 
+  if RUBY_VERSION < '1.9.0'
+
+    # Ruby 1.8 has a buggy hash key generation algorithm that leads to many
+    # hash collisions. We completely disable caching on 1.8.
+
+    def load(key)
+      nil
+    end
+
+    def cached(key)
+      yield
+    end
+
+  else
+
     # Retrieve the value indexed by _key_ from the cache. If it's not found,
     # nil is returned.
     def load(key)
@@ -124,6 +139,8 @@ class TaskJuggler
       end
     end
 
+  end
+
     def to_s
       <<"EOT"
 Entries: #{@entries.size}   Stores: #{@stores}

data/lib/taskjuggler/FileList.rb

@@ -44,6 +44,15 @@ class TaskJuggler
       @files[fileName] = FileRecord.new(fileName)
     end
 
+    # Return the name of the master file or nil of the master file was stdin.
+    def masterFile
+      @files.each_key do |file|
+        return file if file[-4, 4] == '.tjp'
+      end
+
+      nil
+    end
+
     # Return true if any of the files in the list have been modified after
     # they were added to the list.
     def modified?

data/lib/taskjuggler/HTMLDocument.rb

@@ -12,6 +12,7 @@
 #
 
 require 'taskjuggler/XMLDocument'
+require 'taskjuggler/HTMLElements'
 
 class TaskJuggler
 
@@ -20,11 +21,13 @@ class TaskJuggler
   # upon object creation.
   class HTMLDocument < XMLDocument
 
+    include HTMLElements
+
     # When creating a HTMLDocument the caller can specify the type of HTML that
     # will be used. The constructor then generates the proper XML declaration
     # for it. :strict, :transitional and :frameset are supported for _docType_.
-    def initialize(docType = :strict)
-      super()
+    def initialize(docType = :strict, &block)
+      super(&block)
 
       @elements << XMLBlob.new('<?xml version="1.0" encoding="UTF-8"?>')
       case docType
@@ -44,30 +47,25 @@ class TaskJuggler
                               "#{dtdRef}//EN\" \"#{url}\">")
       @elements << XMLComment.new('This file has been generated by ' +
                                   "#{AppConfig.appName} v#{AppConfig.version}")
-      @elements << (@html = XMLElement.new('html', 'xml:lang' => 'en',
-        'lang' => 'en', 'xmlns' => 'http://www.w3.org/1999/xhtml'))
-    end
-
-    # Overload the << operator to append to the @html element instead of the
-    # @elements Array.
-    def <<(element)
-      @html << element
+      @elements << HTML.new({ 'xml:lang' => 'en', 'lang' => 'en',
+                              'xmlns' => 'http://www.w3.org/1999/xhtml' })
     end
 
     # Generate the 'head' section of an HTML page.
     def generateHead(title, metaTags = {})
-      self << (head = XMLElement.new('head'))
-      head << XMLNamedText.new(title, 'title')
-      head << XMLElement.new('meta', { 'http-equiv' => 'Content-Type',
-                                       'content' => 'text/html; charset=utf-8' },
-                             true)
+      self << HEAD.new {
+        e = [
+          TITLE.new { title },
+          META.new({ 'http-equiv' => 'Content-Type',
+                     'content' => 'text/html; charset=utf-8' }),
+        ]
+        # Include optional meta tags.
+        metaTags.each do |name, content|
+          e << META.new({ 'name' => name, 'content' => content })
+        end
 
-      # Include optional meta tags.
-      metaTags.each do |name, content|
-        head << XMLElement.new('meta', { 'name' => name, 'content' => content },
-                               true)
-      end
-      head
+        e
+      }
     end
 
   end

data/lib/taskjuggler/HTMLElements.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = HTMLElements.rb -- The TaskJuggler III Project Management Software
+#
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               by Chris Schlaeger <chris@linux.com>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of version 2 of the GNU General Public License as
+# published by the Free Software Foundation.
+#
+
+require 'taskjuggler/XMLElement'
+
+class TaskJuggler
+
+  module HTMLElements
+
+    # A list of supported HTML tags.
+    htmlTags = %w( a b body br code col colgroup div em frame frameset footer
+                   h1 h2 h3 head html hr meta p pre table td title tr )
+    # A list of HTML tags that are self-closing.
+    closureTags = %w( area base basefont br hr input img link meta )
+
+    # For every HTML tag, we generate a class with the equivalent uppercase
+    # name. This class is derived off of XMLElement. This makes creating HTML
+    # code a lot simpler. Instead of
+    #   XMLElement.new('h1')
+    # we now can write
+    #   H1.new
+    htmlTags.each do |tag|
+      class_eval <<"EOT"
+        class #{tag.upcase} < XMLElement
+
+          def initialize(attrs = {}, &block)
+            super("#{tag}", attrs, #{closureTags.include?(tag)})
+          end
+
+        end
+EOT
+    end
+
+  end
+
+end

data/lib/taskjuggler/Journal.rb

@@ -22,7 +22,8 @@ class TaskJuggler
   class JournalEntry
 
     attr_reader :date, :headline, :property, :sourceFileInfo
-    attr_accessor :author, :summary, :details, :alertLevel, :timeSheetRecord
+    attr_accessor :author, :summary, :details, :alertLevel, :flags,
+                  :timeSheetRecord
 
     # Create a new JournalEntry object.
     def initialize(journal, date, headline, property, sourceFileInfo = nil)
@@ -45,6 +46,8 @@ class TaskJuggler
       @details = nil
       # The alert level.
       @alertLevel = 0
+      # A list of flags.
+      @flags = []
       # A reference to a time sheet record that was used to create this
       # JournalEntry object.
       @timeSheetRecord = nil
@@ -65,6 +68,8 @@ class TaskJuggler
   # date. This is a utility class only. Use Journal to store a journal.
   class JournalEntryList
 
+    attr_reader :entries
+
     def initialize
       @entries = []
       @sorted = false
@@ -81,13 +86,13 @@ class TaskJuggler
       @sorted = false
     end
 
-    # This function is probably obsolete!
     # Add a list of JournalEntry objects to the existing list. The list will
     # be marked unsorted.
-    #def +(list)
-    #  @entries += list
-    #  @sorted = false
-    #end
+    def +(list)
+      @entries += list.entries
+      @sorted = false
+      self
+    end
 
     # Return the _index_-th entry.
     def[](index)
@@ -113,6 +118,11 @@ class TaskJuggler
       @entries.empty?
     end
 
+    # Like Array:length
+    def length
+      @entries.length
+    end
+
     # Like Array::include?
     def include?(entry)
       @entries.include?(entry)
@@ -168,6 +178,11 @@ class TaskJuggler
       self
     end
 
+    # Eliminate duplicate entries.
+    def uniq!
+      @entries.uniq!
+    end
+
   end
 
   # A Journal is a list of JournalEntry objects. It provides methods to add
@@ -197,11 +212,12 @@ class TaskJuggler
     end
 
     # Return a list of all JournalEntry objects for the given _resource_ that
-    # are dated between _startDate_ and _endDate_, are for Task _task_ and
-    # have at least the alert level _alertLevel. If an optional parameter is
-    # nil, it always matches the entry.
+    # are dated between _startDate_ and _endDate_, are not hidden by their
+    # flags matching _logExp_, are for Task _task_ and have at least the alert
+    # level _alertLevel. If an optional parameter is nil, it always matches
+    # the entry.
     def entriesByResource(resource, startDate = nil, endDate = nil,
-                          task = nil, alertLevel = nil)
+                          logExp = nil, task = nil, alertLevel = nil)
       list = []
       @entries.each do |entry|
         if entry.author == resource &&
@@ -209,18 +225,19 @@ class TaskJuggler
            (endDate.nil? || entry.date <= endDate) &&
            (task.nil? || entry.property == task) &&
            (alertLevel.nil? || entry.alertLevel >= alertLevel) &&
-           !entry.headline.empty?
+           !entry.headline.empty? && !hidden(entry, logExp)
           list << entry
         end
       end
       list
     end
 
-    # Return a list of all JournalEntry objects for the given _task_ that
-    # are dated between _startDate_ and _endDate_ (end date not included), are
-    # from Author _resource_ and have at least the alert level _alertLevel. If
-    # an optional parameter is nil, it always matches the entry.
-    def entriesByTask(task, startDate = nil, endDate = nil,
+    # Return a list of all JournalEntry objects for the given _task_ that are
+    # dated between _startDate_ and _endDate_ (end date not included), are not
+    # hidden by their flags matching _logExp_ are from Author _resource_ and
+    # have at least the alert level _alertLevel. If an optional parameter is
+    # nil, it always matches the entry.
+    def entriesByTask(task, startDate = nil, endDate = nil, logExp = nil,
                       resource = nil, alertLevel = nil)
       list = []
       @entries.each do |entry|
@@ -229,7 +246,7 @@ class TaskJuggler
            (endDate.nil? || entry.date < endDate) &&
            (resource.nil? || entry.author == resource) &&
            (alertLevel.nil? || entry.alertLevel >= alertLevel) &&
-           !entry.headline.empty?
+           !entry.headline.empty? && !hidden(entry, logExp)
           list << entry
         end
       end
@@ -237,21 +254,24 @@ class TaskJuggler
     end
 
     # Return a list of all JournalEntry objects for the given _task_ or any of
-    # its sub tasks that are dated between _startDate_ and _endDate_, are from
-    # Author _resource_ and have at least the alert level _alertLevel. If an
-    # optional parameter is nil, it always matches the entry.
-    def entriesByTaskR(task, startDate = nil, endDate = nil,
-                      resource = nil, alertLevel = nil)
-      list = entriesByTask(task, startDate, endDate, resource, alertLevel)
+    # its sub tasks that are dated between _startDate_ and _endDate_, are not
+    # hidden by their flags matching _logExp_, are from Author _resource_ and
+    # have at least the alert level _alertLevel. If an optional parameter is
+    # nil, it always matches the entry.
+    def entriesByTaskR(task, startDate = nil, endDate = nil, logExp = nil,
+                       resource = nil, alertLevel = nil)
+      list = entriesByTask(task, startDate, endDate, logExp, resource,
+                           alertLevel)
 
       task.kids.each do |t|
-        list += entriesByTaskR(t, startDate, endDate, resource, alertLevel)
+        list += entriesByTaskR(t, startDate, endDate, logExp, resource,
+                               alertLevel)
       end
 
       list
     end
 
-    def entries(startDate = nil, endDate = nil, property = nil,
+    def entries(startDate = nil, endDate = nil, logExp = nil, property = nil,
                 alertLevel = nil)
       list = []
       @entries.each do |entry|
@@ -259,7 +279,8 @@ class TaskJuggler
            (endDate.nil? || endDate >= entry.date) &&
            (property.nil? || property == entry.property ||
                              entry.property.isChildOf?(property)) &&
-           (alertLevel.nil? || alertLevel == entry.alertLevel)
+           (alertLevel.nil? || alertLevel == entry.alertLevel) &&
+           !hidden(entry, logExp)
           list << entry
         end
       end
@@ -269,12 +290,13 @@ class TaskJuggler
     # Determine the alert level for the given _property_ at the given _date_.
     # If the property does not have any JournalEntry objects or they are out
     # of date compared to the child properties, the level is computed based on
-    # the highest level of the children.
-    def alertLevel(date, property)
+    # the highest level of the children. Only take the entries that are not
+    # filtered by _logExp_ into account.
+    def alertLevel(date, property, logExp)
       maxLevel = 0
       # Gather all the current (as of the specified _date_) JournalEntry
       # objects for the property and than find the highest level.
-      currentEntriesR(date, property).each do |e|
+      currentEntriesR(date, property, 0, nil, logExp).each do |e|
         maxLevel = e.alertLevel if maxLevel < e.alertLevel
       end
       maxLevel
@@ -283,12 +305,12 @@ class TaskJuggler
     # Return the list of JournalEntry objects that are dated at or before
     # _date_, are for _property_ or any of its childs, have at least _level_
     # alert and are after _minDate_.
-    def alertEntries(date, property, minLevel, minDate)
+    def alertEntries(date, property, minLevel, minDate, logExp)
       maxLevel = 0
       entries = []
       # Gather all the current (as of the specified _date_) JournalEntry
       # objects for the property and than find the highest level.
-      currentEntriesR(date, property, minLevel, minDate).each do |e|
+      currentEntriesR(date, property, minLevel, minDate, logExp).each do |e|
         if maxLevel < e.alertLevel
           maxLevel = e.alertLevel
           entries = [ e ]
@@ -303,7 +325,7 @@ class TaskJuggler
     # date and are the last entries before the deadline _date_. Only messages
     # with at least the required alert level _minLevel_ are returned. Messages
     # with alert level _minLevel_ must be newer than _minDate_.
-    def currentEntries(date, property, minLevel, minDate)
+    def currentEntries(date, property, minLevel, minDate, logExp)
       pEntries = @propertyToEntries[property] ?
                  @propertyToEntries[property].last(date) : JournalEntryList.new
       # Remove entries below the minium alert level or before the timeout
@@ -313,20 +335,25 @@ class TaskJuggler
         (e.alertLevel == minLevel && minDate && e.date < minDate)
       end
 
-      return pEntries if pEntries.empty?
-
-      # Check parents for a more important or more up-to-date message.
-      p = property.parent
-      while p do
-        ppEntries = @propertyToEntries[p] ?
-                    @propertyToEntries[p].last(date) : JournalEntryList.new
-
-        # A parent has a more up-to-date message.
-        if !ppEntries.empty? && ppEntries.first.date >= pEntries.first.date
-          return JournalEntryList.new
+      unless pEntries.empty?
+        # Check parents for a more important or more up-to-date message.
+        p = property.parent
+        while p do
+          ppEntries = @propertyToEntries[p] ?
+            @propertyToEntries[p].last(date) : JournalEntryList.new
+
+          # A parent has a more up-to-date message.
+          if !ppEntries.empty? && ppEntries.first.date >= pEntries.first.date
+            return JournalEntryList.new
+          end
+
+          p = p.parent
         end
+      end
 
-        p = p.parent
+      # Remove all entries that are filtered by logExp.
+      if logExp
+        pEntries.delete_if { |e| hidden(e, logExp) }
       end
 
       pEntries
@@ -337,7 +364,8 @@ class TaskJuggler
     # property unless there is a property in the sub-tree specified by the
     # root _property_ with more up-to-date entries. The result is a
     # JournalEntryList.
-    def currentEntriesR(date, property, minLevel = 0, minDate = nil)
+    def currentEntriesR(date, property, minLevel = 0, minDate = nil,
+                        logExp = nil)
       # See if this property has any current JournalEntry objects.
       pEntries = @propertyToEntries[property] ?
                  @propertyToEntries[property].last(date) : JournalEntryList.new
@@ -374,17 +402,38 @@ class TaskJuggler
       if !pEntries.empty? && (maxPAlertLevel > maxAlertLevel ||
                               latestDate.nil? ||
                               pEntries.first.date >= latestDate)
+
+        # Remove all entries that are filtered by logExp.
+        if logExp
+          pEntries.delete_if { |e| hidden(e, logExp) }
+        end
+
         return pEntries
       end
+
       # Remove all child entries that are older than the current parent
       # entries (if we have parent entries).
       unless pEntries.empty?
-        entries.delete_if { |e| e.date <= pEntries.first.date }
+        entries.delete_if do |e|
+          e.date <= pEntries.first.date
+        end
+      end
+
+      # Remove all entries that are filtered by logExp.
+      if logExp
+        entries.delete_if { |e| hidden(e, logExp) }
       end
+
       # Otherwise return the list provided by the childen.
       entries
     end
 
+    private
+
+    def hidden(entry, logExp)
+      logExp.nil? ? false : logExp.eval(entry)
+    end
+
   end
 
 end