taskjuggler 0.0.3 → 0.0.4

data/lib/Scenario.rb

@@ -3,7 +3,7 @@
 #
 # = Scenario.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

data/lib/ScenarioData.rb

@@ -3,7 +3,7 @@
 #
 # = ScenarioData.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
@@ -56,7 +56,7 @@ class TaskJuggler
     end
 
     def query_id(query)
-      query.result = query.sortableResult = @property.fullId
+      query.sortable = query.string = @property.fullId
     end
 
   end

data/lib/Scoreboard.rb

@@ -3,7 +3,7 @@
 #
 # = Scoreboard.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

data/lib/Shift.rb

@@ -3,7 +3,7 @@
 #
 # = Shift.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

data/lib/ShiftAssignments.rb

@@ -3,7 +3,7 @@
 #
 # = ShiftAssignments.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

data/lib/ShiftScenario.rb

@@ -3,7 +3,7 @@
 #
 # = ShiftScenario.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

data/lib/SourceFileInfo.rb

@@ -3,7 +3,7 @@
 #
 # = SourceFileInfo.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

data/lib/SyntaxReference.rb

@@ -3,7 +3,7 @@
 #
 # = SyntaxReference.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
@@ -234,7 +234,7 @@ class TaskJuggler
           # If it's a terminal symbol, we found what we are looking for. We add
           # it to the attrs hash and mark it as non scenario specific.
           attrs[pattern] = scenarioSpecific
-        elsif pattern[0] == '!scenarioId'
+        elsif pattern[0] == '!scenarioIdCol'
           # A reference to the !scenarioId rule marks the next token of the
           # pattern as a reference to a rule with all scenario specific
           # attributes.

data/lib/TOCEntry.rb

@@ -3,7 +3,7 @@
 #
 # = TOCEntry.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

data/lib/TableColumnDefinition.rb

@@ -3,7 +3,7 @@
 #
 # = TableColumnDefinition.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
@@ -12,40 +12,83 @@
 
 class TaskJuggler
 
+  # A CellSettingPattern is used to store alternative settings for
+  # ReportTableCell settings. These could be the cell text, the tooltip or a
+  # color setting. The user can provide multiple options and the
+  # LogicalExpression is used to select the pattern for a given cell.
+  class CellSettingPattern
+
+    attr_reader :setting, :logExpr
+
+    def initialize(setting, logExpr)
+      @setting = setting
+      @logExpr = logExpr
+    end
+
+  end
+
+  # The CellSettingPatternList holds a list of possible test pattern for a cell
+  # or tooltip. The first entry who's LogicalExpression matches is used.
+  class CellSettingPatternList
+
+    def initialize
+      @patterns = []
+    end
+
+    # Add a new pattern to the list.
+    def addPattern(pattern)
+      @patterns << pattern
+    end
+
+    # Get the RichText that matches the _property_ and _scopeProperty_.
+    def getPattern(query)
+      @patterns.each do |pattern|
+        if pattern.logExpr.eval(query)
+          return pattern.setting
+        end
+      end
+      nil
+    end
+
+  end
+
   # This class holds the definition of a column of a report. This is the user
   # specified data that is later used to generate the actual ReportTableColumn.
   # The column is uniquely identified by an ID.
   class TableColumnDefinition
 
-    attr_reader :id
-    attr_accessor :cellText, :hideCellText, :cellURL, :hideCellURL,
-                  :title, :scale, :width,
-                  :content, :column
+    attr_reader :id, :cellText, :tooltip, :cellColor, :fontColor
+    attr_accessor :title, :start, :end, :scale, :width, :content, :column
 
     def initialize(id, title)
       # The column ID. It must be unique within the report.
       @id = id
       # An alternative title for the column header.
       @title = title
+      # An alternative start date for columns with time-variant values.
+      @start = nil
+      # An alternative end date for columns with time-variant values.
+      @end = nil
       # For regular columns (non-calendar and non-chart) the user can override
       # the actual cell content.
-      @cellText = nil
-      # A LogicalExpression that is evaluated for every cell. If it evaluates to
-      # true, the cell will remain empty.
-      @hideCellText = nil
-      # The cell text can be associated with a hyperlink.
-      @cellURL = nil
-      # A LogicalExpression that is evaluated for every cell. If the result is
-      # true, the cellURL will be ignored.
-      @hideCellURL = nil
+      @cellText = CellSettingPatternList.new
       # The content attribute is only used for calendar columns. It specifies
       # what content should be displayed in the colendar columns.
       @content = 'load'
+      # An alternative content for the tooltip message. It should be a
+      # RichText object.
+      @tooltip = CellSettingPatternList.new
+      # An alternative background color for the cell. The color setting is
+      # stored as "#RGB" or "#RRGGBB" String.
+      @cellColor = CellSettingPatternList.new
+      # An alternative font color for the cell. The format is equivalent to
+      # the @cellColor setting.
+      @fontColor = CellSettingPatternList.new
       # The scale attribute is only used for Gantt chart columns. It specifies
       # the minimum resolution of the chart.
       @scale = 'week'
-      # The default maximum width of columns.
-      @width = 450
+      # The width of columns.
+      @width = nil
 
       # Reference to the ReportTableColumn object that was created based on this
       # definition.

data/lib/TableOfContents.rb

@@ -3,7 +3,7 @@
 #
 # = TableOfContents.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

data/lib/Task.rb

@@ -3,7 +3,7 @@
 #
 # = Task.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

data/lib/TaskDependency.rb

@@ -3,7 +3,7 @@
 #
 # = TaskDependency.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

data/lib/TaskJuggler.rb

@@ -3,15 +3,17 @@
 #
 # = TaskJuggler.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
 # published by the Free Software Foundation.
 #
 
+require 'drb'
 require 'Project'
 require 'MessageHandler'
+require 'RemoteServiceManager'
 require 'Log'
 
 # The TaskJuggler class models the object that provides access to the
@@ -26,6 +28,7 @@ class TaskJuggler
   # whether or not messsages can be written to $stderr.
   def initialize(console)
     @project = nil
+    @parser = nil
     @messageHandler = MessageHandler.new(console)
     @maxCpuCores = 1
   end
@@ -33,29 +36,33 @@ class TaskJuggler
   # Read in the files passed as file names in _files_, parse them and
   # construct a Project object. In case of success true is returned.
   # Otherwise false.
-  def parse(files)
+  def parse(files, keepParser = false)
     Log.enter('parser', 'Parsing files ...')
     master = true
     @project = nil
 
-    parser = ProjectFileParser.new(@messageHandler)
+    @parser = ProjectFileParser.new(@messageHandler)
     files.each do |file|
       begin
-        parser.open(file, master)
+        @parser.open(file, master)
       rescue TjException
         Log.exit('parser')
         return false
       end
       if master
-        @project = parser.parse('project')
+        @project = @parser.parse('project')
         master = false
       else
-        parser.setGlobalMacros
-        parser.parse('properties')
+        @parser.setGlobalMacros
+        @parser.parse('properties')
       end
-      parser.close
+      @parser.close
     end
 
+    # For the report server mode we may need to keep the parser. Otherwise,
+    # destroy it.
+    @parser = nil unless keepParser
+
     Log.exit('parser')
     @messageHandler.messages.empty?
   end
@@ -81,5 +88,21 @@ class TaskJuggler
     res
   end
 
+  def serveReports
+    $SAFE = 1
+    Log.enter('reportserver', 'Starting Server Mode ...')
+    Log.status("Report Server is now active!")
+    serviceManager = RemoteServiceManager.new(@parser, @project)
+    DRb.start_service('druby://localhost:8474', serviceManager)
+    DRb.thread.join
+    # We'll probably never get here. The DRb threads may call exit().
+    Log.exit('reportserver')
+  end
+
+  # Return the number of errors that had been reported during processing.
+  def errors
+    @project.messageHandler.errors
+  end
+
 end
 

data/lib/TaskScenario.rb

@@ -3,7 +3,7 @@
 #
 # = TaskScenario.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
@@ -1060,10 +1060,10 @@ class TaskJuggler
 
     def query_complete(query)
       if @property.leaf?
-        query.sortableResult = query.numericalResult = a('complete').to_i
-        query.result = "#{query.sortableResult}%"
+        query.sortable = query.numerical = complete = a('complete').to_i
+        query.string = "#{complete}%"
       else
-        query.result = ''
+        query.string = ''
       end
     end
 
@@ -1072,30 +1072,57 @@ class TaskJuggler
     # directly generated by the resource is taken into account.
     def query_cost(query)
       if query.costAccount
-        query.sortableResult = query.numericalResult =
+        query.sortable = query.numerical = cost =
           turnover(query.startIdx, query.endIdx, query.costAccount,
                    query.scopeProperty)
-        query.result = query.currencyFormat.format(query.sortableResult)
+        query.string = query.currencyFormat.format(cost)
       else
-        query.result = 'No cost account'
+        query.string = 'No cost account'
       end
     end
 
     # The duration of the task. After scheduling, it can be determined for
     # all tasks. Also for those who did not have a 'duration' attribute.
     def query_duration(query)
-      query.sortableResult = query.numericalResult =
+      query.sortable = query.numerical = duration =
         (a('end') - a('start')) / (60 * 60 * 24)
-      query.result = query.scaleDuration(query.sortableResult)
+      query.string = query.scaleDuration(duration)
+    end
+
+    # The completed (as of 'now') effort allocated for the task in the
+    # specified interval.  In case a Resource is given as scope property only
+    # the effort allocated for this resource is taken into account.
+    def query_effortdone(query)
+      # For this query, we always override the query period.
+      query.sortable = query.numerical = effort =
+        getEffectiveWork(@project.dateToIdx(@project['start']),
+                         @project.dateToIdx(@project['now']),
+                         query.scopeProperty)
+      query.string = query.scaleLoad(effort)
+    end
+
+
+    # The remaining (as of 'now') effort allocated for the task in the
+    # specified interval.  In case a Resource is given as scope property only
+    # the effort allocated for this resource is taken into account.
+    def query_effortleft(query)
+      # For this query, we always override the query period.
+      query.start = @project['now']
+      query.end = @project['end']
+      query.sortable = query.numerical = effort =
+        getEffectiveWork(@project.dateToIdx(@project['now']),
+                         @project.dateToIdx(@project['end']),
+                         query.scopeProperty)
+      query.string = query.scaleLoad(effort)
     end
 
     # The effort allocated for the task in the specified interval. In case a
     # Resource is given as scope property only the effort allocated for this
     # resource is taken into account.
     def query_effort(query)
-      query.sortableResult = query.numericalResult =
+      query.sortable = query.numerical = work =
         getEffectiveWork(query.startIdx, query.endIdx, query.scopeProperty)
-      query.result = query.scaleLoad(query.sortableResult)
+      query.string = query.scaleLoad(work)
     end
 
     # A list of the resources that have been allocated to work on the task in
@@ -1105,10 +1132,12 @@ class TaskJuggler
       a('assignedresources').each do |resource|
         if getAllocatedTime(query.startIdx, query.endIdx, resource) > 0.0
           list += ', ' unless list.empty?
-          list += resource.id
+          list += "#{resource.name} (#{resource.fullId})"
         end
       end
-      query.sortableResult = query.result = list
+      query.sortable = query.string = list
+      rText = RichText.new(list)
+      query.rti = rText.generateIntermediateFormat
     end
 
     # Compute the revenue generated by this Task for a given Account during a
@@ -1116,15 +1145,33 @@ class TaskJuggler
     # revenue directly generated by the resource is taken into account.
     def query_revenue(query)
       if query.revenueAccount
-        query.sortableResult = query.numericalResult =
+        query.sortable = query.numerical = revenue =
           turnover(query.startIdx, query.endIdx, query.revenueAccount,
                    query.scopeProperty)
-        query.result = query.currencyFormat.format(query.sortableResult)
+        query.string = query.currencyFormat.format(revenue)
       else
-        query.result = 'No revenue account'
+        query.string = 'No revenue account'
       end
     end
 
+    def query_targets(query)
+      targetList = PropertyList.new(@project.tasks, false)
+      targets(targetList)
+      targetList.delete(@property)
+      targetList.setSorting([['start', true, @scenarioIdx],
+                             ['seqno', true, -1 ]])
+      targetList.sort!
+
+      res = ''
+      targetList.each do |task|
+        date = task['start', @scenarioIdx].to_s(@property.project['timeFormat'])
+        res += "# #{task.name} (#{task.fullId}) #{date}\n"
+      end
+      rText = RichText.new(res)
+      query.rti = rText.generateIntermediateFormat
+    end
+
+
     # Compute the total time _resource_ or all resources are allocated during
     # interval specified by _startIdx_ and _endIdx_.
     def getAllocatedTime(startIdx, endIdx, resource = nil)
@@ -1187,6 +1234,53 @@ class TaskJuggler
       end
     end
 
+    # Check if the Task _task_ depends on this task. _depth_ specifies how
+    # many dependent task are traversed at max. A value of 0 means no limit.
+    def isDependencyOf(task, depth)
+      return true if task == @property
+
+      # Check if any of the parent tasks is a dependency of _task_.
+      t = @property.parent
+      while t
+        # If the parent is a dependency, than all childs are as well.
+        return true if t.isDependencyOf(@scenarioIdx, task, depth)
+        t = t.parent
+      end
+
+
+      a('startsuccs').each do |dep|
+        unless dep[1]
+          # must be a start->start dependency
+          return true if dep[0].isDependencyOf(@scenarioIdx, task, depth)
+        end
+      end
+
+      return false if depth == 1
+
+      a('endsuccs').each do |dep|
+        unless dep[1]
+          # must be an end->start dependency
+          return true if dep[0].isDependencyOf(@scenarioIdx, task, depth - 1)
+        end
+      end
+
+      false
+    end
+
+    # Returns true of the _resource_ is assigned to this task or any of its
+    # children.
+    def hasResourceAllocated?(interval, resource)
+      if @property.leaf?
+        return resource.allocated?(@scenarioIdx, interval, @property)
+      else
+        @property.children.each do |t|
+          return true if t.hasResourceAllocated?(@scenarioIdx, interval,
+                                                 resource)
+        end
+      end
+      false
+    end
+
   private
     def scheduleSlot(slot, slotDuration)
       # Tasks must always be scheduled in a single contigous fashion. @lastSlot
@@ -1480,6 +1574,18 @@ class TaskJuggler
       !a(thisEnd + 'succs').empty? || !a(thisEnd + 'preds').empty?
     end
 
+    # Return true if this task or any of its parent tasks has at least one
+    # sucessor task.
+    def hasSuccessors
+      t = @property
+      while t
+        return true unless t['endsuccs', @scenarioIdx].empty?
+        t = t.parent
+      end
+
+      false
+    end
+
     def markAsRunaway
       warning('runaway', "Task #{@property.fullId} does not fit into " +
                          "project time frame")
@@ -1620,19 +1726,31 @@ class TaskJuggler
     def calcCompletion
       # If the user provided a completion degree we are not touching it.
       if @property.provided('complete', @scenarioIdx)
+        calcStatus
         return
       end
 
       if a('start').nil? || a('end').nil?
         @property['complete', @scenarioIdx] = 0.0
+        @property['status', @scenarioIdx] = 'unknown'
         return
       end
 
       if a('milestone')
         @property['complete', @scenarioIdx] =
           @property['end', @scenarioIdx] <= @project['now'] ? 100.0 : 0.0
+        @property['status', @scenarioIdx] =
+          a('end') <= @project['now'] ? 'done' : 'not reached'
       elsif @property.container?
         #TODO
+        @property['status', @scenarioIdx] =
+          if a('end') < @project['now']
+            'done'
+          elsif a('start') > @project['now']
+            'not started'
+          else
+            'in progress'
+          end
       else
         # Normal leaf task
         if a('end') <= @project['now']
@@ -1647,7 +1765,38 @@ class TaskJuggler
                         (a('end') - a('start'))) * 100.0
         end
         @property['complete', @scenarioIdx] = completion
+        calcStatus
+      end
+    end
+
+    # Calculate the status of the task based on the 'complete' attribute.
+    def calcStatus
+      @property['status', @scenarioIdx] =
+        if a('complete') == 0.0
+          'not started'
+        elsif a('complete') >= 100.0
+          'done'
+        else
+          'in progress'
+        end
+    end
+
+    # Recursively compile a list of Task properties which depend on the
+    # current task.
+    def targets(list)
+      # A target must be a leaf function that has no direct or indirect
+      # (through parent) following tasks.
+      if @property.leaf? && !hasSuccessors && !list.include?(@property)
+        list << @property
+        return
       end
+
+      a('endsuccs').each do |t, onEnd|
+        t.targets(@scenarioIdx, list)
+      end
+
+      # Check of indirect followers.
+      @property.parent.targets(@scenarioIdx, list) if @property.parent
     end
 
     # Compute the turnover generated by this Task for a given Account _account_