taskjuggler 3.0.0 → 3.1.0

data/lib/taskjuggler/ShiftScenario.rb

@@ -3,7 +3,7 @@
 #
 # = ShiftScenario.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
 #               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify
@@ -32,9 +32,9 @@ class TaskJuggler
     end
 
     # Returns true if the shift has a vacation defined for the _date_.
-    def onVacation?(date)
-      a('vacations').each do |vacationIv|
-        if vacationIv.contains?(date)
+    def onLeave?(date)
+      a('leaves').each do |leave|
+        if leave.interval.contains?(date)
           return true
         end
       end

data/lib/taskjuggler/SimpleQueryExpander.rb

@@ -3,7 +3,7 @@
 #
 # = SimpleQueryExpander.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
 #               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify

data/lib/taskjuggler/StatusSheetReceiver.rb

@@ -3,7 +3,7 @@
 #
 # = StatusSheetReceiver.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
 #               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify

data/lib/taskjuggler/StatusSheetSender.rb

@@ -3,7 +3,7 @@
 #
 # = StatusSheetSender.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
 #               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify

data/lib/taskjuggler/StdIoWrapper.rb

@@ -3,7 +3,7 @@
 #
 # = StdIoWrapper.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
 #               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify

data/lib/taskjuggler/SyntaxReference.rb

@@ -3,7 +3,7 @@
 #
 # = SyntaxReference.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
 #               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify
@@ -33,7 +33,7 @@ class TaskJuggler
     # are then cross referenced to capture their relationships. _manual_ is an
     # optional reference to the  UserManual object that uses this
     # SyntaxReference.
-    def initialize(manual = nil)
+    def initialize(manual = nil, ignoreOld = false)
       @manual = manual
       @messageHandler = MessageHandler.new(true)
       @parser = ProjectFileParser.new(@messageHandler)
@@ -46,6 +46,9 @@ class TaskJuggler
         rule.patterns.each do |pattern|
           #  Only patterns that are documented are of interest.
           next if pattern.doc.nil?
+          # Ignore deprecated and removed keywords if requested
+          next if ignoreOld &&
+                  [ :deprecated, :removed ].include?(pattern.supportLevel)
 
           # Make sure each keyword is unique.
           if @keywords.include?(pattern.keyword)

data/lib/taskjuggler/TableColumnDefinition.rb

@@ -3,7 +3,7 @@
 #
 # = TableColumnDefinition.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
 #               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify

data/lib/taskjuggler/Task.rb

@@ -3,7 +3,7 @@
 #
 # = Task.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
 #               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify
@@ -32,10 +32,6 @@ class TaskJuggler
       @data[scenarioIdx].readyForScheduling?
     end
 
-    def query_journal_sub(query)
-      journalText(query, true, true)
-    end
-
     private
 
     # Create a blog-style list of all alert messages that match the Query.
@@ -59,10 +55,10 @@ class TaskJuggler
         if entry.property.is_a?(Task)
           levelRecord = @project['alertLevels'][entry.alertLevel]
           if query.selfContained
-            alertName = "<nowiki>[#{levelRecord[1]}]</nowiki>"
+            alertName = "<nowiki>[#{levelRecord.name}]</nowiki>"
           else
-            alertName = "[[File:icons/flag-#{levelRecord[0]}.png|" +
-                        "alt=[#{levelRecord[1]}]|text-bottom]]"
+            alertName = "[[File:icons/flag-#{levelRecord.id}.png|" +
+                        "alt=[#{levelRecord.name}]|text-bottom]]"
           end
           rText += "== #{alertName} <nowiki>#{entry.headline}</nowiki> ==\n" +
                    "''Reported on #{entry.date.to_s(query.timeFormat)}'' "

data/lib/taskjuggler/TaskDependency.rb

@@ -3,7 +3,7 @@
 #
 # = TaskDependency.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
 #               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify

data/lib/taskjuggler/TaskJuggler.rb

@@ -3,7 +3,7 @@
 #
 # = TaskJuggler.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
 #               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify

data/lib/taskjuggler/TaskScenario.rb

@@ -3,7 +3,7 @@
 #
 # = TaskScenario.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
 #               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify
@@ -27,7 +27,7 @@ class TaskJuggler
       # time. So make sure some needed attributes really exist so we don't
       # have to check for existance each time we access them.
       %w( allocate assignedresources booking charge chargeset complete
-          criticalness depends duration effort end forward length
+          criticalness depends duration effort end forward gauge length
           maxend maxstart minend minstart milestone pathcriticalness
           precedes priority scheduled shifts start status ).each do |attr|
         @property[attr, @scenarioIdx]
@@ -1243,14 +1243,13 @@ class TaskJuggler
 
     def query_complete(query)
       # If we haven't calculated the value yet, calculate it first.
-      unless (complete = @complete)
+      unless @complete
         calcCompletion
-        complete = @complete
       end
 
-      query.sortable = query.numerical = complete
+      query.sortable = query.numerical = @complete
       # For the string output, we only use integer numbers.
-      query.string = "#{complete.to_i}%"
+      query.string = "#{@complete.to_i}%"
     end
 
     # Compute the cost generated by this Task for a given Account during a given
@@ -1338,6 +1337,19 @@ class TaskJuggler
       query.assignList(list)
     end
 
+    # The number of different resources assigned to the task during the query
+    # interval. Each resource is counted based on their mathematically rounded
+    # efficiency.
+    def query_headcount(query)
+      headcount = 0
+      assignedResources(Interval.new(query.start, query.end)).each do |res|
+        headcount += res['efficiency', @scenarioIdx].round
+      end
+
+      query.sortable = query.numerical = headcount
+      query.string = query.numberFormat.format(headcount)
+    end
+
     def query_maxend(query)
       queryDateLimit(query, @maxend)
     end
@@ -1386,17 +1398,19 @@ class TaskJuggler
     # A list of the resources that have been allocated to work on the task in
     # the report time frame.
     def query_resources(query)
-      return '' unless @property.leaf?
-
       list = []
-      @assignedresources.each do |resource|
-        if resource.allocated?(@scenarioIdx,
-                               TimeInterval.new(query.start, query.end),
-                               @property)
+      iv = TimeInterval.new(query.start, query.end)
+      assignedResources(iv).each do |resource|
+        if resource.allocated?(@scenarioIdx, iv, @property)
           if query.listItem
             rti = RichText.new(query.listItem, RTFHandlers.create(@project),
                                @project.messageHandler).
                                generateIntermediateFormat
+            unless rti
+              error('bad_resource_ts_query',
+                    "Syntax error in query statement for task attribute " +
+                    "'resources'.")
+            end
             q = query.dup
             q.property = resource
             rti.setQuery(q)
@@ -1425,12 +1439,16 @@ class TaskJuggler
 
     def query_status(query)
       # If we haven't calculated the completion yet, calculate it first.
-      if (status = @status).empty?
-        calcCompletion
-        status = @status
-      end
+      calcStatus if @status.empty?
+
+      query.string = @status
+    end
 
-      query.string = status
+    def query_gauge(query)
+      # If we haven't calculated the schedule status yet, calculate it first.
+      calcGauge unless @gauge
+
+      query.string = @gauge
     end
 
     def query_inputs(query)
@@ -1611,6 +1629,27 @@ class TaskJuggler
       false
     end
 
+    # Gather a list of Resource objects that have been assigned to the task
+    # (including sub tasks) for the given Interval _interval_.
+    def assignedResources(interval)
+      list = []
+
+      if @property.container?
+        @property.kids.each do |task|
+          list += task.assignedResources(@scenarioIdx, interval)
+        end
+        list.uniq!
+      else
+        @assignedresources.each do |resource|
+          if resource.allocated?(@scenarioIdx, interval, @property)
+            list << resource
+          end
+        end
+      end
+
+      list
+    end
+
   private
 
     def scheduleSlot
@@ -2143,42 +2182,39 @@ class TaskJuggler
     # Calculate the current completion degree for tasks that have no user
     # specified completion value.
     def calcCompletion
-      # If the user provided a completion degree we are not touching it.
-      if @property.provided('complete', @scenarioIdx)
-        calcStatus
-        return @complete
-      end
+      # If we already have a value for @complete, we don't need to calculate
+      # anything.
+      return @complete if @complete
 
       # We cannot compute a completion degree without a start or end date.
       if @start.nil? || @end.nil?
         @complete = 0.0
-        @status = 'unknown'
         return nil
       end
 
+      @complete = calcTaskCompletion
+    end
+
+    def calcTaskCompletion
       completion = 0.0
-      if @milestone
-        # Milestones are either 0% or 100% complete.
-        @complete = completion = @end <= @project['now'] ? 100.0 : 0.0
-        @status = @end <= @project['now'] ? 'done' : 'not reached'
+
+      if @property.container?
+        # For container task the completion degree is the average of the
+        # sub tasks.
+        @property.kids.each do |child|
+          return nil unless (comp = child.calcCompletion(@scenarioIdx))
+          completion += comp
+        end
+        completion /= @property.children.length
       else
-        # The task is in progress. Calculate the current completion
-        # degree.
+        # For leaf tasks we first compare the start and end dates against the
+        # current date.
         if @end <= @project['now']
           # The task has ended already. It's 100% complete.
           completion = 100.0
         elsif @project['now'] <= @start
           # The task has not started yet. Its' 0% complete.
           completion = 0.0
-        elsif !property.leaf?
-          # For container task the completion degree is the average of the
-          # sub tasks.
-          completion = 0.0
-          @property.kids.each do |child|
-            return nil unless (comp = child.calcCompletion(@scenarioIdx))
-            completion += comp
-          end
-          completion /= @property.children.length
         elsif @effort > 0
           # Effort based leaf tasks. The completion degree is the percentage
           # of effort that has been done already.
@@ -2189,11 +2225,8 @@ class TaskJuggler
           completion = done / total * 100.0
         else
           # Length/duration leaf tasks.
-          completion = ((@project['now'] - @start) /
-                        (@end - @start)) * 100.0
+          completion = ((@project['now'] - @start) / (@end - @start)) * 100.0
         end
-        @complete = completion
-        calcStatus
       end
 
       completion
@@ -2201,13 +2234,60 @@ class TaskJuggler
 
     # Calculate the status of the task based on the 'complete' attribute.
     def calcStatus
-      @status = if @complete == 0.0
-                  'not started'
-                elsif @complete >= 100.0
-                  'done'
-                else
-                  'in progress'
-                end
+      # If the completion degree is not yet available, we need to calculate it
+      # first.
+      calcCompletion unless @complete
+
+      if @complete
+        @status = if @complete == 0.0
+                    # Milestones are reached, normal tasks started.
+                    @milestone ? 'not reached' : 'not started'
+                  elsif @complete >= 100.0
+                    'done'
+                  else
+                    'in progress'
+                  end
+      else
+        # The completion degree could not be calculated due to errors. We set
+        # the state to unknown.
+        @status = 'unknown'
+      end
+    end
+
+    # The gauge shows if a task is ahead, behind or on schedule. The measure
+    # is based on the provided 'complete' value and the current date.
+    def calcGauge
+      # If the completion degree is not yet available, we need to calculate it
+      # first.
+      calcCompletion unless @complete
+
+      return @gauge if @gauge
+
+      if @property.container?
+        states = [ 'on schedule', 'ahead of schedule', 'behind schedule',
+                   'unknown' ]
+
+        gauge = 0
+        @property.kids.each do |child|
+          if (idx = states.index(child.calcGauge(@scenarioIdx))) > gauge
+            gauge = idx
+          end
+        end
+        @gauge = states[gauge]
+      else
+        @gauge =
+          if (calculatedComplete = calcTaskCompletion).nil?
+            # The completion degree could not be calculated due to errors. We
+            # set the state to unknown.
+            'unknown'
+          elsif @complete == calculatedComplete
+            'on schedule'
+          elsif @complete < calculatedComplete
+            'behind schedule'
+          else
+            'ahead of schedule'
+          end
+      end
     end
 
     # Recursively compile a list of Task properties which depend on the
@@ -2281,9 +2361,9 @@ class TaskJuggler
     # be TjTime values or Scoreboard indexes. If a Resource _resource_ is given,
     # only the turnover directly generated by the resource is taken into
     # account.
-    def turnover(startIdx, endIdx, account, resource = nil)
+    def turnover(startIdx, endIdx, account, resource = nil, includeKids = true)
       amount = 0.0
-      if @property.container?
+      if @property.container? && includeKids
         @property.kids.each do |child|
           amount += child.turnover(@scenarioIdx, startIdx, endIdx, account,
                                    resource)

data/lib/taskjuggler/TernarySearchTree.rb

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby -w
 # encoding: UTF-8
 #
-# = Account.rb -- The TaskJuggler III Project Management Software
+# = TernarySearchTree.rb -- The TaskJuggler III Project Management Software
 #
-# Copylarger (c) 2006, 2007, 2008, 2009, 2010, 2011
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
 #               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify
@@ -85,7 +85,8 @@ class TaskJuggler
         if index == maxIdx
           # We've reached the end of the search pattern.
           if partialMatch
-            return collect { |v| str[0..-2] + v }
+            # The strange looking ('' << val) is for Ruby 1.8 compatibility.
+            return collect { |v| str[0..-2] + ('' << v) }
           else
             return str if @last
           end
@@ -127,7 +128,8 @@ class TaskJuggler
       result = []
 
       result += @smaller.collect(str, &block) if @smaller
-      newStr = str.nil? ? @value : str + @value
+      # The strange looking ('' << val) is for Ruby 1.8 compatibility.
+      newStr = str.nil? ? ('' << @value) : str + ('' << @value)
       result << yield(newStr) if @last
       result += @equal.collect(newStr, &block) if @equal
       result += @larger.collect(str, &block) if @larger