taskjuggler 0.0.11 → 0.1.0

data/lib/taskjuggler/PropertyTreeNode.rb

@@ -42,6 +42,38 @@ class TaskJuggler
     # specified by a hierachical _id_ (e. g. 'father.son').
     def initialize(propertySet, id, name, parent)
       @propertySet = propertySet
+      @project = propertySet.project
+      @parent = parent
+      # Attributes are created on-demand. We need to be careful that a pure
+      # check for existance does not create them unecessarily.
+      @attributes = Hash.new do |hash, attributeId|
+        unless (aType = attributeDefinition(attributeId))
+          raise ArgumentError,
+            "Unknown attribute '#{attributeId}' requested for " +
+            "#{self.class.to_s.sub(/TaskJuggler::/, '')} '#{fullId}'"
+        end
+        unless aType.scenarioSpecific
+          hash[attributeId] = aType.objClass.new(@propertySet, aType)
+        else
+          raise ArgumentError, "Attribute '#{attributeId}' is scenario specific"
+        end
+      end
+      @scenarioAttributes = Array.new(@project.scenarioCount) do
+        Hash.new do |hash, attributeId|
+          unless (aType = attributeDefinition(attributeId))
+            raise ArgumentError,
+              "Unknown attribute '#{attributeId}' requested for " +
+              "#{self.class.to_s.sub(/TaskJuggler::/, '')} '#{fullId}'"
+          end
+          if aType.scenarioSpecific
+            hash[attributeId] = aType.objClass.new(@propertySet, aType)
+          else
+            raise ArgumentError,
+              "Attribute '#{attributeId}' is not scenario specific"
+          end
+        end
+      end
+
       # If _id_ is still nil, we generate a unique id.
       unless id
         tag = self.class.to_s.gsub(/TaskJuggler::/, '')
@@ -51,27 +83,32 @@ class TaskJuggler
       if !@propertySet.flatNamespace && id.include?('.')
         parentId = id[0..(id.rindex('.') - 1)]
         # Set parent to the parent property if it's still nil.
-        parent = @propertySet[parentId] unless parent
+        @parent = @propertySet[parentId] unless @parent
         if $DEBUG
-          if !parent || !@propertySet[parent.fullId]
+          if !@parent || !@propertySet[@parent.fullId]
             raise "Fatal Error: parent must be member of same property set"
           end
-          if parentId != parent.fullId
-            raise "Fatal Error: parent (#{parent.fullId}) and parent ID " +
-                "(#{parentId}) don't match"
+          if parentId != @parent.fullId
+            raise "Fatal Error: parent (#{@parent.fullId}) and parent ID " +
+                "(#{@parentId}) don't match"
           end
         end
         @id = id[(id.rindex('.') + 1).. -1]
       else
         @id = id
       end
+      # The attribute 'id' is either the short ID or the full hierarchical ID.
+      set('id', fullId)
+
+      # The name of the property.
       @name = name
-      @project = propertySet.project
+      set('name', name)
+
       @level = -1
       @sourceFileInfo = nil
 
-      @parent = parent
       @sequenceNo = @propertySet.items + 1
+      set('seqno', @sequenceNo)
       # This is a list of the real sub nodes of this PropertyTreeNode.
       @children = []
       # This is a list of the adopted sub nodes of this PropertyTreeNode.
@@ -85,10 +122,6 @@ class TaskJuggler
       # node.
       @stepParents = []
 
-      @attributes = Hash.new
-      @scenarioAttributes = Array.new(@project.scenarioCount)
-      @scenarioAttributes.collect! { |sca| sca = Hash.new }
-
       # Scenario specific data
       @data = nil
     end
@@ -230,9 +263,9 @@ class TaskJuggler
     end
 
     # Return a list of all leaf nodes of this node.
-    def allLeaves
+    def allLeaves(withoutSelf = false)
       if leaf?
-        res = [ self ]
+        res = withoutSelf ? [] : [ self ]
       else
         res = []
         @children.each do |c|
@@ -242,20 +275,6 @@ class TaskJuggler
       res
     end
 
-    # Iterator over all non-scenario-specific attributes of this node.
-    def eachAttribute
-      @attributes.each do |attr|
-        yield attr
-      end
-    end
-
-    # Iterator over all scenario-specific attributes of this node.
-    def eachScenarioAttribute(scenario)
-      @scenarioAttributes[scenario].each_value do |attr|
-        yield attr
-      end
-    end
-
     # Return the full id of this node. For PropertySet objects with a flat
     # namespace, this is just the ID. Otherwise, the full ID is composed of all
     # IDs from the root node to this node, separating the IDs by a dot.
@@ -285,9 +304,9 @@ class TaskJuggler
     end
 
     # Return the hierarchical index of this node. In project management lingo
-    # this is called the Work Breakdown Structure (WBS). The result is an Array
+    # this is called the Breakdown Structure Index (BSI). The result is an Array
     # with an index for each level from the root to this node.
-    def getWBSIndicies
+    def getBSIndicies
       idcs = []
       p = self
       begin
@@ -358,95 +377,43 @@ class TaskJuggler
       n
     end
 
-    # Register a new attribute with the PropertyTreeNode and create the
-    # instances for each scenario.
-    def declareAttribute(attributeType)
-      if attributeType.scenarioSpecific
-        @project.scenarioCount.times do |i|
-          attribute = attributeType.objClass.new(self, attributeType)
-          @scenarioAttributes[i][attribute.id] = attribute
-        end
-      else
-        attribute = attributeType.objClass.new(self, attributeType)
-        @attributes[attribute.id] = attribute
-      end
-    end
-
     # Return the type of the attribute with ID _attributeId_.
     def attributeDefinition(attributeId)
       @propertySet.attributeDefinitions[attributeId]
     end
 
     # Return the value of the non-scenario-specific attribute with ID
-    # _attributeId_. In case the attribute does not exist, an exception is
-    # raised.
+    # _attributeId_. This method works for built-in attributes as well.
+    # In case the attribute does not exist, an exception is raised.
     def get(attributeId)
-      case attributeId
-      when 'id'
-        @id
-      when 'name'
-        @name
-      when 'seqno'
-        @sequenceNo
-      else
-        unless @attributes.has_key?(attributeId)
-          raise "Unknown attribute '#{attributeId}' requested for " +
-                "#{self.class.to_s.sub(/TaskJuggler::/, '')} '#{fullId}'"
-        end
-        @attributes[attributeId].get
-      end
+      @attributes[attributeId].get
     end
 
-    # Return the value of the attribute with ID _attributeId_. In case this is a
+    # Return the value of the attribute with ID _attributeId_. This method
+    # works for built-in attributes as well. In case this is a
     # scenario-specific attribute, the scenario index needs to be provided by
-    # _scenarioIdx_.
-    def getAttr(attributeId, scenarioIdx = nil)
-      if scenarioIdx.nil?
-        case attributeId
-        when 'id'
-          @id
-        when 'name'
-          @name
-        when 'seqno'
-          @sequenceNo
-        else
-          @attributes[attributeId]
-        end
-      else
-        @scenarioAttributes[scenarioIdx][attributeId]
-      end
-    end
-
-    # This function is similar to getAttr() but it always returns a
-    # AttributeBase object.
+    # _scenarioIdx_, otherwise it must be nil.  In case the attribute does not
+    # exist, an exception is raised.
     def getAttribute(attributeId, scenarioIdx = nil)
-      case attributeId
-      when 'id'
-        StringAttribute.new(self, fullId)
-      when 'name'
-        StringAttribute.new(self, @name)
-      when 'seqno'
-        FixnumAttribute.new(self, @sequenceNo)
+      if scenarioIdx
+        @scenarioAttributes[scenarioIdx][attributeId]
       else
-        @attributes[attributeId] ||
-        (scenarioIdx && @scenarioAttributes[scenarioIdx][attributeId])
+        @attributes[attributeId]
       end
     end
 
     # Set the non-scenario-specific attribute with ID _attributeId_ to _value_.
     # In case the attribute does not exist, an exception is raised.
     def set(attributeId, value)
-      unless @attributes.has_key?(attributeId)
-        raise "Unknown attribute #{attributeId}"
-      end
       @attributes[attributeId].set(value)
     end
 
-    # Set the scenario specific attribute with ID _attributeId_ for the scenario
-    # with index _scenario_ to _value_. In case the attribute does not exist, an
-    # exception is raised.
+    # Set the scenario specific attribute with ID _attributeId_ for the
+    # scenario with index _scenario_ to _value_. If _scenario_ is nil, the
+    # attribute must not be scenario specific. In case the attribute does not
+    # exist, an exception is raised.
     def []=(attributeId, scenario, value)
-      if @scenarioAttributes[scenario].has_key?(attributeId)
+      if scenario
         if AttributeBase.mode == 0
           # If we get values in 'provided' mode, we copy them immedidately to
           # all derived scenarios.
@@ -474,10 +441,8 @@ class TaskJuggler
         else
           @scenarioAttributes[scenario][attributeId].set(value)
         end
-      elsif @attributes.has_key?(attributeId)
-        @attributes[attributeId].set(value)
       else
-        raise "Unknown attribute #{attributeId}"
+        @attributes[attributeId].set(value)
       end
     end
 
@@ -485,21 +450,19 @@ class TaskJuggler
     # scenario-specific attributes, _scenario_ must indicate the index of the
     # Scenario.
     def [](attributeId, scenario)
-      if @scenarioAttributes[scenario].has_key?(attributeId)
-        @scenarioAttributes[scenario][attributeId].get
-      else
-        get(attributeId);
-      end
+      @scenarioAttributes[scenario][attributeId].get
     end
 
     # Returns true if the value of the attribute _attributeId_ (in scenario
     # _scenarioIdx_) has been provided by the user.
     def provided(attributeId, scenarioIdx = nil)
       if scenarioIdx
-        return false if @scenarioAttributes[scenarioIdx][attributeId].nil?
+        unless @scenarioAttributes[scenarioIdx].has_key?(attributeId)
+          return false
+        end
         @scenarioAttributes[scenarioIdx][attributeId].provided
       else
-        return false if @attributes[attributeId].nil?
+        return false unless @attributes.has_key?(attributeId)
         @attributes[attributeId].provided
       end
     end
@@ -508,27 +471,32 @@ class TaskJuggler
     # _scenarioIdx_) has been inherited from a parent node or scenario.
     def inherited(attributeId, scenarioIdx = nil)
       if scenarioIdx
-        return false if @scenarioAttributes[scenarioIdx][attributeId].nil?
+        unless @scenarioAttributes[scenarioIdx].has_key?(attributeId)
+          return false
+        end
         @scenarioAttributes[scenarioIdx][attributeId].inherited
       else
-        return false if @attributes[attributeId].nil?
+        return false unless @attributes.has_key?(attributeId)
         @attributes[attributeId].inherited
       end
     end
 
     def modified?(attributeId, scenarioIdx = nil)
       if scenarioIdx
-        return false if @scenarioAttributes[scenarioIdx][attributeId].nil?
+        unless @scenarioAttributes[scenarioIdx].has_key?(attributeId)
+          return false
+        end
+
         @scenarioAttributes[scenarioIdx][attributeId].provided ||
         @scenarioAttributes[scenarioIdx][attributeId].inherited
       else
-        return false if @attributes[attributeId].nil?
+        return false unless @attributes.has_key?(attributeId)
         @attributes[attributeId].provided || @attributes[attributeId].inherited
       end
     end
 
     def checkFailsAndWarnings
-      if @attributes['fail'] || @attributes['warn']
+      if @attributes.has_key?('fail') || @attributes.has_key?('warn')
         propertyType = case self
                        when Task
                          'task'
@@ -544,7 +512,7 @@ class TaskJuggler
                        'end' => @project['end'],
                        'loadUnit' => :days,
                        'numberFormat' => @project['numberFormat'],
-                       'timeFormat' => @project['timeFormat'],
+                       'timeFormat' => nil,
                        'currencyFormat' => @project['currencyFormat'] }
         query = Query.new(queryAttrs)
         if @attributes['fail']
@@ -575,7 +543,7 @@ class TaskJuggler
     def query_alert(query)
       journal = @project['journal']
       query.sortable = query.numerical = alert =
-        journal.alertLevel(query.end, self)
+        journal.alertLevel(query.end, self, query.hideJournalEntry)
       query.string = colorName = @project.alertLevelName(alert)
       rText = "<fcol:#{colorName.downcase}>#{colorName}</fcol>"
       unless (rti = RichText.new(rText, RTFHandlers.create(@project),
@@ -591,32 +559,36 @@ class TaskJuggler
 
     def query_alertmessages(query)
       journalMessages(@project['journal'].alertEntries(query.end, self, 1,
-                                                       query.start),
+                                                       query.start,
+                                                       query.hideJournalEntry),
                       query, true)
     end
 
     def query_alertsummaries(query)
       journalMessages(@project['journal'].alertEntries(query.end, self, 1,
-                                                       query.start),
+                                                       query.start,
+                                                       query.hideJournalEntry),
                       query, false)
     end
 
     def query_journalmessages(query)
       journalMessages(@project['journal'].currentEntries(query.end, self, 0,
-                                                         query.start),
+                                                         query.start,
+                                                         query.hideJournalEntry),
                       query, true)
     end
 
     def query_journalsummaries(query)
       journalMessages(@project['journal'].currentEntries(query.end, self, 0,
-                                                         query.start),
+                                                         query.start,
+                                                         query.hideJournalEntry),
                       query, false)
     end
 
     def query_alerttrend(query)
       journal = @project['journal']
-      startAlert = journal.alertLevel(query.start, self)
-      endAlert = journal.alertLevel(query.end, self)
+      startAlert = journal.alertLevel(query.start, self, query.hideJournalEntry)
+      endAlert = journal.alertLevel(query.end, self, query.hideJournalEntry)
       if startAlert < endAlert
         query.sortable = 0
         query.string = 'Up'
@@ -642,22 +614,18 @@ class TaskJuggler
       end
       res += '  Children: ' + children + "\n"  unless children.empty?
       @attributes.sort.each do |key, attr|
-        #if attr.get != @propertySet.defaultValue(key)
-          res += indent("  #{key}: ", attr.to_s)
-        #end
+        res += indent("  #{key}: ", attr.to_s)
       end
       unless @scenarioAttributes.empty?
         project.scenarioCount.times do |sc|
           break if @scenarioAttributes[sc].nil?
           headerShown = false
           @scenarioAttributes[sc].sort.each do |key, attr|
-            if attr.get != @propertySet.defaultValue(key)
-              unless headerShown
-                res += "  Scenario #{project.scenario(sc).get('id')} (#{sc})\n"
-                headerShown = true
-              end
-              res += indent("    #{key}: ", attr.to_s)
+            unless headerShown
+              res += "  Scenario #{project.scenario(sc).get('id')} (#{sc})\n"
+              headerShown = true
             end
+            res += indent("    #{key}: ", attr.to_s)
           end
         end
       end
@@ -700,6 +668,9 @@ class TaskJuggler
           rText += "''by <nowiki>#{entry.author.name}</nowiki>''"
         end
         rText += "\n\n"
+        unless entry.flags.empty?
+          rText += "''Flags:'' #{entry.flags.join(', ')}\n\n"
+        end
         if entry.summary
           rText += entry.summary.richText.inputText + "\n\n"
         end

data/lib/taskjuggler/Query.rb

@@ -36,7 +36,8 @@ class TaskJuggler
     @@ps = %w( project propertyType propertyId property
                scopePropertyType scopePropertyId scopeProperty
                attributeId scenario scenarioIdx
-               loadUnit listType listMode numberFormat currencyFormat timeFormat
+               loadUnit numberFormat currencyFormat timeFormat
+               listItem listType hideJournalEntry
                costAccount revenueAccount selfContained)
     @@ps.each do |p|
       attr_accessor p.to_sym
@@ -58,6 +59,10 @@ class TaskJuggler
       %w( end endIdx start startIdx ).each do |p|
         send(p + '=', parameters[p]) if parameters[p]
       end
+      # The custom data hash can be filled with results to be returned for
+      # special attributes that are not directly property attributes or
+      # computed attributes.
+      @customData = {}
 
       reset
     end
@@ -68,10 +73,10 @@ class TaskJuggler
     def start=(date)
       if date.is_a?(TjTime)
         @start = date
-        @startIdx = @project.dateToIdx(date)
       else
         raise "Unsupported type #{date.class}"
       end
+      @startIdx = @project.dateToIdx(@start)
     end
 
     def startIdx=(idx)
@@ -86,10 +91,10 @@ class TaskJuggler
     def end=(date)
       if date.is_a?(TjTime)
         @end = date
-        @endIdx = @project.dateToIdx(date)
       else
         raise "Unsupported type #{date.class}"
       end
+      @endIdx = @project.dateToIdx(@end)
     end
 
     def endIdx=(idx)
@@ -101,6 +106,13 @@ class TaskJuggler
       end
     end
 
+    # Set a custom data entry. _name_ is the name of the pseudo attribute.
+    # _data_ must be a Hash that contains the value for :numberical, :string,
+    # :sortable or :rti results.
+    def setCustomData(name, data)
+      @customData[name] = data
+    end
+
     # This method tries to resolve the query and return a result. In case it
     # finds an attribute that matches the query, it returns true; false
     # otherwise. The actual result data is stored in the Query object. It can
@@ -120,13 +132,17 @@ class TaskJuggler
 
         unless @property
           # No property was provided. We are looking for a project attribute.
-          supportedAttrs = %w( copyright currency end name now projectid
+          supportedAttrs = %w( copyright currency end journal name now projectid
                                start version )
           unless supportedAttrs.include?(@attributeId)
             @errorMessage = "Unsupported project attribute '#{@attributeId}'"
             return @ok = false
           end
-          attr = @project[@attributeId]
+          if @project.respond_to?(attributeId)
+            @project.send(attributeId, self)
+          else
+            attr = @project[@attributeId]
+          end
           if attr.is_a?(TjTime)
             @sortable = @numerical = attr
             @string = attr.to_s(@timeFormat)
@@ -157,15 +173,30 @@ class TaskJuggler
 
         queryMethodName = 'query_' + @attributeId
         # First we check for non-scenario-specific query functions.
-        if @property.respond_to?(queryMethodName)
+        if (data = @customData[@attributeId])
+          @sortable = data[:sortable]
+          @numerical = data[:numerical]
+          @string = data[:string]
+          @rti = data[:rti]
+        elsif @property.respond_to?(queryMethodName)
           @property.send(queryMethodName, self)
-        elsif @scenarioIdx &&
+        elsif @scenarioIdx && @property.data &&
               @property.data[@scenarioIdx].respond_to?(queryMethodName)
           # Then we check for scenario-specific ones via the @data member.
           @property.send(queryMethodName, @scenarioIdx, self)
         else
           # The result is a BaseAttribute
-          unless (@attr = @property.getAttribute(@attributeId, @scenarioIdx))
+          begin
+            # The user may also provide a scenario index for
+            # non-scenario-specific values. We need to check if the attribute
+            # is really scenario specific or not because
+            # PropertyTreeNode::getAttribute can only handle an index for
+            # scenario-specific attributs.
+            aType = @property.attributeDefinition(@attributeId)
+            raise ArgumentError unless aType
+            scIdx = aType.scenarioSpecific ? @scenarioIdx : nil
+            @attr = @property.getAttribute(@attributeId, scIdx)
+          rescue ArgumentError
             @errorMessage = "Unknown attribute #{@attributeId} queried"
             return @ok = false
           end