taskjuggler 0.0.2 → 0.0.3

data/lib/TaskScenario.rb

@@ -64,6 +64,14 @@ class TaskJuggler
         @property['end', @scenarioIdx] = nil
       end
 
+      # Milestones may only have start or end date even when the 'scheduled'
+      # attribute is set. For further processing, we need to add the missing
+      # date.
+      if a('milestone') && a('scheduled')
+        @property['end', @scenarioIdx] = a('start') if a('start') && !a('end')
+        @property['start', @scenarioIdx] = a('end') if !a('start') && a('end')
+      end
+
       # Collect the limits of this task and all parent tasks into a single
       # Array.
       @limits = []
@@ -265,8 +273,9 @@ class TaskJuggler
         #   -  <-- |
         #   -  <-- -D
         #   -  <-- |D
-        if durationSpecs == 0 && ((a('forward') && a('end').nil?) ||
-                                  (!a('forward') && a('start').nil?))
+        if durationSpecs == 0 &&
+           ((a('forward') && a('end').nil? && !hasDependencies(true)) ||
+            (!a('forward') && a('start').nil? && !hasDependencies(false)))
           error('task_underspecified',
                 "Task #{@property.fullId} has too few specifations to be " +
                 "scheduled.")
@@ -375,7 +384,6 @@ class TaskJuggler
                "The start time (#{a('start')}) of task #{@property.fullId} " +
                "is too late. Must be before #{a('maxstart')}.")
       end
-
       # Check if the end time is ok
       error('task_end_undef',
             "Task #{@property.fullId} has undefined end time") if a('end').nil?
@@ -395,6 +403,13 @@ class TaskJuggler
                 "The end time (#{a('end')}) of task #{@property.fullId} " +
                 "is too late. Must be before #{a('maxend')}.")
       end
+      # Make sure the start is before the end
+      if a('start') > a('end')
+        error('start_after_end',
+              "The start time (#{a('start')}) of task #{@property.fullId} " +
+              "is after the end time (#{a('end')}).")
+      end
+
 
       # Check that tasks fits into parent task.
       unless (parent = @property.parent).nil? ||
@@ -919,22 +934,18 @@ class TaskJuggler
       a('length') > 0 || a('duration') > 0 || a('effort') > 0 || a('milestone')
     end
 
-    # This function checks if the task has a dependency on another task or
-    # fixed date for a certain end. If +atEnd+ is true, the task end will be
-    # checked.  Otherwise the start.
-    def hasDependencies(atEnd)
-      thisEnd = atEnd ? 'end' : 'start'
-      !a(thisEnd + 'succs').empty? || !a(thisEnd + 'preds').empty?
-    end
-
+    # Find the earliest possible start date for the task. This date must be
+    # after the end date of all the task that this task depends on.
+    # Dependencies may also require a minimum gap between the tasks.
     def earliestStart
-      # puts "Finding earliest start date for #{@property.fullId}"
+      # This is the date that we will return.
       startDate = nil
       a('depends').each do |dependency|
         potentialStartDate =
           dependency.task[dependency.onEnd ? 'end' : 'start', @scenarioIdx]
         return nil if potentialStartDate.nil?
 
+        # Determine the end date of a 'length' gap.
         dateAfterLengthGap = potentialStartDate
         gapLength = dependency.gapLength
         while gapLength > 0 && dateAfterLengthGap < @project['end'] do
@@ -944,6 +955,7 @@ class TaskJuggler
           dateAfterLengthGap += @project['scheduleGranularity']
         end
 
+        # Determine the end date of a 'duration' gap.
         if dateAfterLengthGap > potentialStartDate + dependency.gapDuration
           potentialStartDate = dateAfterLengthGap
         else
@@ -960,21 +972,37 @@ class TaskJuggler
       while (task = task.parent) do
         if task['start', @scenarioIdx] &&
            (startDate.nil? || task['start', @scenarioIdx] > startDate)
-          return task['start', @scenarioIdx]
+          startDate = task['start', @scenarioIdx]
+          break
         end
       end
 
+      # When the computed start date is after the already determined end date
+      # of the task, the start dependencies were too weak. This happens when
+      # task B depends on A and they are specified this way:
+      # task A: | --> D-
+      # task B: -D <-- |
+      if a('end') && startDate > a('end')
+        error('weak_start_dep',
+              "Task #{@property.fullId} has a too weak start dependencies " +
+              "to be scheduled properly.")
+      end
+
       startDate
     end
 
+    # Find the latest possible end date for the task. This date must be
+    # before the start date of all the task that this task precedes.
+    # Dependencies may also require a minimum gap between the tasks.
     def latestEnd
-      # puts "Finding latest end date for #{@property.fullId}"
+      # This is the date that we will return.
       endDate = nil
       a('precedes').each do |dependency|
         potentialEndDate =
           dependency.task[dependency.onEnd ? 'end' : 'start', @scenarioIdx]
         return nil if potentialEndDate.nil?
 
+        # Determine the end date of a 'length' gap.
         dateBeforeLengthGap = potentialEndDate
         gapLength = dependency.gapLength
         while gapLength > 0 && dateBeforeLengthGap > @project['start'] do
@@ -984,6 +1012,8 @@ class TaskJuggler
           end
           dateBeforeLengthGap -= @project['scheduleGranularity']
         end
+
+        # Determine the end date of a 'duration' gap.
         if dateBeforeLengthGap < potentialEndDate - dependency.gapDuration
           potentialEndDate = dateBeforeLengthGap
         else
@@ -999,10 +1029,22 @@ class TaskJuggler
       while (task = task.parent) do
         if task['end', @scenarioIdx] &&
            (endDate.nil? || task['end', @scenarioIdx] < endDate)
-          return task['end', @scenarioIdx]
+          endDate = task['end', @scenarioIdx]
+          break
         end
       end
 
+      # When the computed end date is before the already determined start date
+      # of the task, the end dependencies were too weak. This happens when
+      # task A precedes B and they are specified this way:
+      # task A: | --> D-
+      # task B: -D <-- |
+      if a('start') && endDate > a('start')
+        error('weak_end_dep',
+              "Task #{@property.fullId} has a too weak end dependencies " +
+              "to be scheduled properly.")
+      end
+
       endDate
     end
 
@@ -1016,13 +1058,6 @@ class TaskJuggler
       end
     end
 
-    def markAsRunaway
-      warning('runaway', "Task #{@property.fullId} does not fit into " +
-                         "project time frame")
-
-      @isRunAway = true
-    end
-
     def query_complete(query)
       if @property.leaf?
         query.sortableResult = query.numericalResult = a('complete').to_i
@@ -1063,6 +1098,19 @@ class TaskJuggler
       query.result = query.scaleLoad(query.sortableResult)
     end
 
+    # A list of the resources that have been allocated to work on the task in
+    # the report time frame.
+    def query_resources(query)
+      list = ''
+      a('assignedresources').each do |resource|
+        if getAllocatedTime(query.startIdx, query.endIdx, resource) > 0.0
+          list += ', ' unless list.empty?
+          list += resource.id
+        end
+      end
+      query.sortableResult = query.result = list
+    end
+
     # Compute the revenue generated by this Task for a given Account during a
     # given interval.  If a Resource is provided as scopeProperty only the
     # revenue directly generated by the resource is taken into account.
@@ -1077,6 +1125,35 @@ class TaskJuggler
       end
     end
 
+    # Compute the total time _resource_ or all resources are allocated during
+    # interval specified by _startIdx_ and _endIdx_.
+    def getAllocatedTime(startIdx, endIdx, resource = nil)
+      return 0.0 if a('milestone')
+
+      allocatedTime = 0.0
+      if @property.container?
+        @property.children.each do |task|
+          allocatedTime += task.getAllocatedTime(@scenarioIdx, startIdx, endIdx,
+                                                 resource)
+        end
+      else
+        if resource
+          allocatedTime += resource.getAllocatedTime(@scenarioIdx,
+                                                     startIdx, endIdx,
+                                                     @property)
+        else
+          a('assignedresources').each do |r|
+            allocatedTime += r.getAllocatedTime(@scenarioIdx, startIdx, endIdx,
+                                                @property)
+          end
+        end
+      end
+      allocatedTime
+    end
+
+    # Compute the effective work a _resource_ or all resources do during the
+    # interval specified by _startIdx_ and _endIdx_. The effective work is the
+    # actual work multiplied by the efficiency of the resource.
     def getEffectiveWork(startIdx, endIdx, resource = nil)
       return 0.0 if a('milestone')
 
@@ -1335,6 +1412,7 @@ class TaskJuggler
     # booking describes the assignment of a Resource to a certain Task for a
     # specified Interval.
     def bookBookings
+      scheduled = a('scheduled')
       a('booking').each do |booking|
         unless booking.resource.leaf?
           error('booking_resource_not_leaf',
@@ -1363,8 +1441,9 @@ class TaskJuggler
               @lastSlot = date if @lastSlot.nil? || date > @lastSlot
               @tentativeEnd = tEnd if @tentativeEnd.nil? ||
                 @tentativeEnd < tEnd
-              @property['start', @scenarioIdx] = date if a('start').nil? ||
-                                                         date < a('start')
+              if !a('scheduled') && (a('start').nil? || date < a('start'))
+                @property['start', @scenarioIdx] = date
+              end
 
               unless a('assignedresources').include?(booking.resource)
                 @property['assignedresources', @scenarioIdx] << booking.resource
@@ -1374,20 +1453,18 @@ class TaskJuggler
               # For tasks with a 'length' we track the covered work time and
               # set the task to 'scheduled' when we have enough length.
               @doneLength += 1
-              if @doneLength >= a('length')
+              if !scheduled && @doneLength >= a('length')
                 @property['end', @scenarioIdx] = tEnd
                 @property['scheduled', @scenarioIdx] = true
               end
             end
             date = tEnd
           end
-          if a('duration') > 0
-            # For tasks with a 'duration' we track the covered duration and
-            # set the task to 'scheduled' when we have enough duration.
+          if a('duration') > 0 && @tentativeEnd
             @doneDuration = ((@tentativeEnd - a('start')) /
                              @project['scheduleGranularity']).to_i
-            if @doneDuration >= a('duration')
-              @property['end', @scenarioIdx] = tEnd
+            if !scheduled && @doneDuration >= a('duration')
+              @property['end', @scenarioIdx] = @tentativeEnd
               @property['scheduled', @scenarioIdx] = true
             end
           end
@@ -1395,6 +1472,21 @@ class TaskJuggler
       end
     end
 
+    # This function checks if the task has a dependency on another task or
+    # fixed date for a certain end. If +atEnd+ is true, the task end will be
+    # checked.  Otherwise the start.
+    def hasDependencies(atEnd)
+      thisEnd = atEnd ? 'end' : 'start'
+      !a(thisEnd + 'succs').empty? || !a(thisEnd + 'preds').empty?
+    end
+
+    def markAsRunaway
+      warning('runaway', "Task #{@property.fullId} does not fit into " +
+                         "project time frame")
+
+      @isRunAway = true
+    end
+
     # This function determines if a task is really a milestones and marks them
     # accordingly.
     def markMilestone
@@ -1527,7 +1619,7 @@ class TaskJuggler
     # specified completion value.
     def calcCompletion
       # If the user provided a completion degree we are not touching it.
-      if property.provided('complete')
+      if @property.provided('complete', @scenarioIdx)
         return
       end
 

data/lib/TextParser.rb

@@ -97,7 +97,14 @@ class TaskJuggler
     def newRule(name)
       raise "Fatal Error: Rule #{name} already exists" if @rules.has_key?(name)
 
-      @rules[name] = @cr = TextParser::Rule.new(name)
+      if block_given?
+        saveCr = @cr
+        @rules[name] = @cr = TextParser::Rule.new(name)
+        yield
+        @cr = saveCr
+      else
+        @rules[name] = @cr = TextParser::Rule.new(name)
+      end
     end
 
     # Add a new pattern to the most recently added rule. _tokens_ is an array of
@@ -140,7 +147,7 @@ class TaskJuggler
     # To parse the input this function needs to be called with the name of the
     # rule to start with. It returns the result of the processing function of
     # the top-level parser rule that was specified by _ruleName_.
-    def parse(ruleName, enforceEndOfFile = true)
+    def parse(ruleName)
       @stack = []
       @@expectedTokens = []
       updateParserTables
@@ -175,6 +182,10 @@ class TaskJuggler
       @scanner.error(id, text, property)
     end
 
+    def warning(id, text, property = nil)
+      @scanner.warning(id, text, property)
+    end
+
   private
 
     # getTransitions recursively determines all possible target tokens
@@ -197,7 +208,7 @@ class TaskJuggler
           if token[0] == ?!
             unless @rules.has_key?(tokenId)
               raise "Fatal Error: Unknown reference to #{tokenId} in pattern " +
-                  "#{pat} + of rule #{rule.name}"
+                    "#{pat} + of rule #{rule.name}"
             end
             refRule = @rules[tokenId]
             # If the referenced rule describes optional content, we need to look