taskjuggler 0.0.3 → 0.0.4

data/lib/PropertySet.rb

@@ -3,7 +3,7 @@
 #
 # = PropertySet.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
 #
 # 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
@@ -93,6 +93,24 @@ class TaskJuggler
       @attributeDefinitions.include?(attrId)
     end
 
+    # Check whether the PropertyTreeNode has a calculated attribute with the
+    # ID _attrId_. For scenarioSpecific attributes _scenarioIdx_ needs to be
+    # provided.
+    def hasQuery?(attrId, scenarioIdx = nil)
+      return false if @properties.empty?
+
+      property = @properties.first
+      methodName = 'query_' + attrId
+      # First we check for non-scenario-specific query functions.
+      if property.respond_to?(methodName)
+        return true
+      elsif scenarioIdx
+        # Then we check for scenario-specific ones via the @data member.
+        return property.data[scenarioIdx].respond_to?(methodName)
+      end
+      false
+    end
+
     # Return whether the attribute with _attrId_ is scenario specific or not.
     def scenarioSpecific?(attrId)
       # All hardwired attributes are not scenario specific.
@@ -224,19 +242,14 @@ class TaskJuggler
       @propertyMap[id]
     end
 
-    # Update the WBS and tree indicies. This method needs to be called whenever
-    # the set has been modified.
+    # Update the work-breakdown-structure (wbs) indicies. This method needs to
+    # be called whenever the set has been modified.
     def index
       each do |p|
         wbsIdcs = p.getWBSIndicies
-        tree = ""
         wbs = ""
         first = true
         wbsIdcs.each do |idx|
-          # Prefix the level index with zeros so that we always have a 5 digit
-          # long String. 5 digits should be large enough for all real-world
-          # projects.
-          tree += idx.to_s.rjust(5, '0')
           if first
             first = false
           else
@@ -245,7 +258,6 @@ class TaskJuggler
           wbs += idx.to_s
         end
         p.set('wbs', wbs)
-        p.set('tree', tree)
       end
     end
 
@@ -300,7 +312,7 @@ class TaskJuggler
 
     # Return the set of PropertyTreeNode objects as flat Array.
     def to_ary
-      @properties
+      @properties.dup
     end
 
     def to_s

data/lib/PropertyTreeNode.rb

@@ -3,7 +3,7 @@
 #
 # = PropertyTreeNode.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
 #
 # 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
@@ -29,6 +29,7 @@ class TaskJuggler
     attr_reader :propertySet, :id, :name, :parent, :project, :sequenceNo,
                 :children
     attr_accessor :sourceFileInfo
+    attr_reader :data
 
     # Create a new PropertyTreeNode object. _propertySet_ is the PropertySet
     # that this PropertyTreeNode object belongs to. The PropertySet determines
@@ -44,7 +45,7 @@ class TaskJuggler
       unless id
         tag = self.class.to_s.gsub(/TaskJuggler::/, '')
         id = '_' + tag + '_' + (propertySet.items + 1).to_s
-        id = parent.id + '.' + id if !@propertySet.flatNamespace && parent
+        id = parent.fullId + '.' + id if !@propertySet.flatNamespace && parent
       end
       if !@propertySet.flatNamespace && id.include?('.')
         parentId = id[0..(id.rindex('.') - 1)]
@@ -251,6 +252,19 @@ class TaskJuggler
       idcs
     end
 
+    # Return the 'index' attributes of this property, prefixed by the 'index'
+    # attributes of all its parents. The result is an Array of Fixnums.
+    def getIndicies
+      idcs = []
+      p = self
+      begin
+        parent = p.parent
+        idcs.insert(0, p.get('index'))
+        p = parent
+      end while p
+      idcs
+    end
+
     # Add _child_ node as child to this node.
     def addChild(child)
       if $DEBUG && child.propertySet != @propertySet
@@ -319,7 +333,9 @@ class TaskJuggler
         @sequenceNo
       else
         unless @attributes.has_key?(attributeId)
-          raise TjException.new, "Unknown attribute #{attributeId}"
+          raise TjException.new,
+                "Unknown attribute '#{attributeId}' requested for " +
+                "#{self.class.to_s.sub(/TaskJuggler::/, '')} '#{fullId}'"
         end
         @attributes[attributeId].get
       end
@@ -345,6 +361,22 @@ class TaskJuggler
       end
     end
 
+    # This function is similar to getAttr() but it always returns a
+    # AttributeBase object.
+    def getAttribute(attributeId, scenarioIdx = nil)
+      case attributeId
+      when 'id'
+        StringAttribute.new(self, @id)
+      when 'name'
+        StringAttribute.new(self, @name)
+      when 'seqno'
+        FixnumAttribute.new(self, @sequenceNo)
+      else
+        @attributes[attributeId] ||
+        @scenarioAttributes[scenarioIdx][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)
@@ -379,18 +411,6 @@ class TaskJuggler
       end
     end
 
-    # This function returns true if the PropertyTreeNode has a query function
-    # for the given ID _queryId_. In case a _scenarioIdx_ is specified, the
-    # query function must be scenario specific.
-    def hasQuery?(queryId, scenarioIdx = nil)
-      methodName = 'query_' + queryId
-      if scenarioIdx
-        @data[scenarioIdx].respond_to?(methodName)
-      else
-        respond_to?(methodName)
-      end
-    end
-
     # Returns true if the value of the attribute _attributeId_ (in scenario
     # _scenarioIdx_) has been provided by the user.
     def provided(attributeId, scenarioIdx = nil)
@@ -415,6 +435,48 @@ class TaskJuggler
       end
     end
 
+    def modified?(attributeId, scenarioIdx = nil)
+      if scenarioIdx
+        return false if @scenarioAttributes[scenarioIdx][attributeId].nil?
+        @scenarioAttributes[scenarioIdx][attributeId].provided ||
+        @scenarioAttributes[scenarioIdx][attributeId].inherited
+      else
+        return false if @attributes[attributeId].nil?
+        @attributes[attributeId].provided || @attributes[attributeId].inherited
+      end
+    end
+
+    def query_alert(query)
+      journal = @project['journal']
+      query.sortable = query.numerical = alert =
+        journal.alertLevel(query.end, self)
+      query.string = @project.alertLevelName(alert)
+    end
+
+    def query_alertsummary(query)
+      alertMessages(query, false)
+    end
+
+    def query_alertmessage(query)
+      alertMessages(query, true)
+    end
+
+    def query_alerttrend(query)
+      journal = @project['journal']
+      startAlert = journal.alertLevel(query.start, self)
+      endAlert = journal.alertLevel(query.end, self)
+      if startAlert < endAlert
+        query.sortable = 0
+        query.string = 'Up'
+      elsif startAlert > endAlert
+        query.sortable = 2
+        query.string = 'Down'
+      else
+        query.sortable = 1
+        query.string = 'Flat'
+      end
+    end
+
     # Dump the class data in human readable form. Used for debugging only.
     def to_s # :nodoc:
       res = "#{self.class} #{fullId} \"#{@name}\"\n" +
@@ -460,6 +522,49 @@ class TaskJuggler
 
   private
 
+    # Create a blog-style list of all alert messages that match the Query.
+    def alertMessages(query, longVersion)
+      # The components of the message are either UTF-8 text or RichText. For
+      # the RichText components, we use the originally provided markup since
+      # we compose the result as RichText markup first.
+      rText = ''
+      @project['journal'].currentEntries(query.end, self, 0,
+                                         query.start).each do |entry|
+        rText += "== " + entry.headline + " ==\n"
+        rText += "''Reported on #{entry.date.to_s(query.timeFormat)}'' "
+        if entry.author
+          rText += "''by #{entry.author.name}''"
+        end
+        rText += "\n\n"
+        if entry.summary
+          rText += entry.summary.richText.inputText + "\n\n"
+        end
+        if longVersion && entry.details
+          rText += entry.details.richText.inputText + "\n\n"
+        end
+      end
+      # Now convert the RichText markup String into RichTextIntermediate
+      # format.
+      handlers = [
+        RTFNavigator.new(@project),
+        RTFQuery.new(@project),
+        RTFReport.new(@project)
+      ]
+      begin
+        rti = RichText.new(rText, handlers).generateIntermediateFormat
+      rescue RichTextException => msg
+        $stderr.puts "Error in RichText of rule #{@keyword}\n" +
+                     "Line #{msg.lineNo}: #{msg.text}\n" +
+                     "#{msg.line}"
+        return nil
+      end
+      # No section numbers, please!
+      rti.sectionNumbers = false
+      # We use a special class to allow CSS formating.
+      rti.cssClass = 'alertmessage'
+      query.rti = rti
+    end
+
     def newAttribute(attributeType)
       attribute = attributeType.objClass.new(self, attributeType)
       # If the attribute requires a pointer to the project, we'll hand it over.

data/lib/Query.rb

@@ -3,7 +3,7 @@
 #
 # = Query.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
 #
 # 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
@@ -19,7 +19,8 @@ class TaskJuggler
   # run has been completed, but it only produces good results for static
   # attributes. And for such queries, the PropertyTreeNode.get and [] functions
   # are a lot more efficient.
-  # # When constructing a Query, a set of variables need to be set that is
+  #
+  # When constructing a Query, a set of variables need to be set that is
   # sufficient enough to identify a unique attribute. Some attribute are
   # computed dynamically and further variables such as a start and end time will
   # be incorporated into the result computation.
@@ -33,17 +34,22 @@ class TaskJuggler
 
     attr_accessor :project, :propertyType, :propertyId, :property,
                   :scopePropertyType, :scopePropertyId, :scopeProperty,
-                  :attributeId, :scenarioIdx, :start, :end, :startIdx, :endIdx,
-                  :numberFormat, :currencyFormat, :costAccount, :revenueAccount,
+                  :attributeId, :scenarioIdx, :startIdx, :endIdx,
+                  :timeFormat, :numberFormat, :currencyFormat, :costAccount,
+                  :revenueAccount,
                   :loadUnit,
-                  :result, :numericalResult, :sortableResult, :ok, :errorMessage
+                  :ok, :errorMessage
+    attr_reader :end, :start
+    attr_writer :sortable, :numerical, :string, :rti
 
     # Create a new Query object. The _parameters_ need to be sufficent to
     # uniquely identify an attribute.
     def initialize(parameters = { })
       ps = %w( project propertyType propertyId property scopePropertyId
-               scopeProperty attributeId scenarioIdx start end startIdx endIdx
-               loadUnit numberFormat currencyFormat costAccount revenueAccount)
+               scopeProperty attributeId scenario scenarioIdx
+               start end startIdx endIdx
+               loadUnit numberFormat currencyFormat timeFormat
+               costAccount revenueAccount)
       ps.each do |p|
         instance_variable_set('@' + p, parameters[p] ? parameters[p] : nil)
       end
@@ -51,26 +57,49 @@ class TaskJuggler
       reset
     end
 
-    # Queries object can be reused. Calling this function will clear the query
-    # result data.
-    def reset
-      @result = nil
-      @numericalResult = nil
-      @sortableResult = nil
-      @loadUnit = :days
-      @ok = nil
-      @errorMessage = nil
+    # Reset the @startIdx when a start date is set.
+    def start=(date)
+      @start = date
+      @startIdx = nil
+    end
+
+    # Reset the @endIdx when an end date is set.
+    def end=(date)
+      @end = date
+      @endIdx = nil
     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 put into the Query object.
+    # otherwise. The actual result data is stored in the Query object. It can
+    # then be retrieved by the caller with the methods to_s(), to_num(),
+    # to_sort() and result().
     def process
+      reset
       begin
         # Resolve property reference from property ID.
-        if !@property.nil? && !@propertyId.nil?
+        if @property.nil? && !@propertyId.nil?
           @property = resolvePropertyId(@propertyType, @propertyId)
         end
+
+        unless @property
+          # No property was provided. We are looking for a project attribute.
+          supportedAttrs = %w( copyright currency end name now projectid
+                               start version )
+          unless supportedAttrs.include?(@attributeId)
+            raise TjException.new,
+                  "Unsupported project attribute '#{@attributeId}'"
+          end
+          attr = @project[@attributeId]
+          if attr.is_a?(TjTime)
+            @sortable = @numerical = attr
+            @string = attr.to_s(@timeFormat)
+          else
+            @sortable = @string = attr
+          end
+          return @ok = true
+        end
+
         # Same for the scope property.
         if !@scopeProperty.nil? && !@scopePropertyId.nil?
           @scopeProperty = resolvePropertyId(@scopePropertyType,
@@ -79,45 +108,77 @@ class TaskJuggler
         # Make sure the have a reference to the project.
         @project = @property.project unless @project
 
+        if @scenario && !@scenarioIdx
+          @scenarioIdx = @project.scenarioIdx(@scenario)
+          unless @scenarioIdx
+            raise "Query cannot resolve scenario '#{@scenario}'"
+          end
+        end
         @startIdx = @project.dateToIdx(@start, true) if @startIdx.nil? && @start
         @endIdx = @project.dateToIdx(@end, true) - 1 if @endIdx.nil? && @end
 
-        if @property.hasQuery?(@attributeId, @scenarioIdx)
-          # Call the property query function to get the result.
-          if @scenarioIdx
-            @property.send('query_' + @attributeId, scenarioIdx, self)
-          else
-            @property.send('query_' + @attributeId, self)
-          end
+        queryMethodName = 'query_' + @attributeId
+        # First we check for non-scenario-specific query functions.
+        if @property.respond_to?(queryMethodName)
+          @property.send(queryMethodName, self)
+        elsif @scenarioIdx &&
+              @property.data[@scenarioIdx].respond_to?(queryMethodName)
+          # Then we check for scenario-specific ones via the @data member.
+          @property.send(queryMethodName, @scenarioIdx, self)
         else
-          # There is no query function. We simply use the property attribute
-          # value.
-          @sortableResult =
-            if @scenarioIdx
-              @property[@attributeId, @scenarioIdx]
-            else
-              @property.get(@attributeId)
-            end
-          if @sortableResult.is_a?(Array)
-            # This ugly special case is needed for custom attributes of type
-            # reference.
-            @sortableResult = @sortableResult[0]
+          # The result is a BaseAttribute
+          unless (@attr = @property.getAttribute(@attributeId, @scenarioIdx))
+            errorMessage = "Unknown attribute #{@attributeId} queried"
+            return @ok = false
           end
-          @result = @sortableResult.to_s
-          @numericalResult = @result if @result.is_a?(Fixnum) or
-                                        @result.is_a?(Float)
         end
       rescue TjException
-        @errorMessage = $!
-        @result = ''
+        @errorMessage = $!.message
         return @ok = false
       end
       @ok = true
     end
 
-    # Convert a duration to the format specified by @loadUnit.  _work_ is the
-    # effort in man days. The return value is the converted value with optional
-    # unit as a String.
+    # Return the result of the Query as String. The result may be nil.
+    def to_s
+      @attr ? @attr.to_s(self) : (@string || '')
+    end
+
+    # Return the result of the Query as Fixnum or Float. The result may be
+    # nil.
+    def to_num
+      @attr ? @attr.to_num : @numerical
+    end
+
+    # Return the result in the best suited type and format for sorting. The
+    # result may be nil.
+    def to_sort
+      @attr ? @attr.to_sort : @sortable
+    end
+
+    # Return the result as RichTextIntermediate object. The result may be nil.
+    def to_rti
+      @attr ? @attr.to_rti(self) : @rti
+    end
+
+    # Return the result in the orginal form. It may be nil.
+    def result
+      if @attr
+        if @attr.value && @attr.is_a?(ReferenceAttribute)
+          @attr.value[0]
+        else
+          @attr.value
+        end
+      elsif @numerical
+        @numerical
+      else
+        @string
+      end
+    end
+
+    # Convert a duration to the format specified by @loadUnit.  _value_ is the
+    # duration effort in days. The return value is the converted value with
+    # optional unit as a String.
     def scaleDuration(value)
       scaleValue(value, [ 24 * 60, 24, 1, 1.0 / 7, 1.0 / 30.42, 1.0 / 365 ])
     end
@@ -142,11 +203,11 @@ class TaskJuggler
       end
       case pType
       when :Account
-        @project.account[pId]
+        @project.account(pId)
       when :Task
-        @project.task[pId]
+        @project.task(pId)
       when:Resource
-        @project.resource[pId]
+        @project.resource(pId)
       else
         raise TjException.new, "Unknown property type #{pType}"
       end
@@ -222,6 +283,16 @@ class TaskJuggler
       str
     end
 
+    private
+
+    # Queries object can be reused. Calling this function will clear the query
+    # result data.
+    def reset
+      @attr = @numerical = @sortable = @string = @rti = nil
+      @ok = nil
+      @errorMessage = nil
+    end
+
   end
 
 end