taskjuggler 0.1.1 → 0.2.0

data/lib/taskjuggler/PropertyTreeNode.rb

@@ -27,7 +27,7 @@ class TaskJuggler
   # attribute like an URL that contains more details about the task.
   class PropertyTreeNode
 
-    attr_reader :propertySet, :id, :parent, :project, :sequenceNo,
+    attr_reader :propertySet, :id, :subId, :parent, :project, :sequenceNo,
                 :children, :adoptees
     attr_accessor :name, :sourceFileInfo
     attr_reader :data
@@ -44,6 +44,10 @@ class TaskJuggler
       @propertySet = propertySet
       @project = propertySet.project
       @parent = parent
+
+      # Scenario specific data
+      @data = nil
+
       # 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|
@@ -53,12 +57,12 @@ class TaskJuggler
             "#{self.class.to_s.sub(/TaskJuggler::/, '')} '#{fullId}'"
         end
         unless aType.scenarioSpecific
-          hash[attributeId] = aType.objClass.new(@propertySet, aType)
+          hash[attributeId] = aType.objClass.new(@propertySet, aType, self)
         else
           raise ArgumentError, "Attribute '#{attributeId}' is scenario specific"
         end
       end
-      @scenarioAttributes = Array.new(@project.scenarioCount) do
+      @scenarioAttributes = Array.new(@project.scenarioCount) do |scenarioIdx|
         Hash.new do |hash, attributeId|
           unless (aType = attributeDefinition(attributeId))
             raise ArgumentError,
@@ -66,7 +70,8 @@ class TaskJuggler
               "#{self.class.to_s.sub(/TaskJuggler::/, '')} '#{fullId}'"
           end
           if aType.scenarioSpecific
-            hash[attributeId] = aType.objClass.new(@propertySet, aType)
+            hash[attributeId] = aType.objClass.new(@propertySet, aType,
+                                                   @data[scenarioIdx])
           else
             raise ArgumentError,
               "Attribute '#{attributeId}' is not scenario specific"
@@ -93,9 +98,9 @@ class TaskJuggler
                 "(#{@parentId}) don't match"
           end
         end
-        @id = id[(id.rindex('.') + 1).. -1]
+        @subId = id[(id.rindex('.') + 1).. -1]
       else
-        @id = id
+        @subId = id
       end
       # The attribute 'id' is either the short ID or the full hierarchical ID.
       set('id', fullId)
@@ -121,9 +126,6 @@ class TaskJuggler
       # This is a list of the PropertyTreeNode objects that have adopted this
       # node.
       @stepParents = []
-
-      # Scenario specific data
-      @data = nil
     end
 
     # We only use deep_clone for attributes, never for properties. Since
@@ -279,11 +281,11 @@ class TaskJuggler
     # 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.
     def fullId
-      res = @id
+      res = @subId
       unless @propertySet.flatNamespace
         t = self
         until (t = t.parent).nil?
-          res = t.id + "." + res
+          res = t.subId + "." + res
         end
       end
       res
@@ -386,7 +388,9 @@ class TaskJuggler
     # _attributeId_. This method works for built-in attributes as well.
     # In case the attribute does not exist, an exception is raised.
     def get(attributeId)
-      @attributes[attributeId].get
+      # Make sure the attribute gets created if it doesn't exist already.
+      @attributes[attributeId]
+      instance_variable_get(('@' + attributeId).intern)
     end
 
     # Return the value of the attribute with ID _attributeId_. This method
@@ -450,7 +454,8 @@ class TaskJuggler
     # scenario-specific attributes, _scenario_ must indicate the index of the
     # Scenario.
     def [](attributeId, scenario)
-      @scenarioAttributes[scenario][attributeId].get
+      @scenarioAttributes[scenario][attributeId]
+      @data[scenario].instance_variable_get(('@' + attributeId).intern)
     end
 
     # Returns true if the value of the attribute _attributeId_ (in scenario
@@ -641,15 +646,15 @@ class TaskJuggler
     end
 
     def error(id, text)
-      @project.messageHandler.error(id, text, sourceFileInfo, nil, self, nil)
+      @project.messageHandler.error(id, text, @sourceFileInfo, nil, self, nil)
     end
 
     def warning(id, text)
-      @project.messageHandler.warning(id, text, sourceFileInfo, nil, self, nil)
+      @project.messageHandler.warning(id, text, @sourceFileInfo, nil, self, nil)
     end
 
     def info(id, text)
-      @project.messageHandler.info(id, text, sourceFileInfo, nil, self, nil)
+      @project.messageHandler.info(id, text, @sourceFileInfo, nil, self, nil)
     end
 
 

data/lib/taskjuggler/Query.rb

@@ -273,7 +273,8 @@ class TaskJuggler
     # 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 ])
+      scaleValue(value, [ 24 * 60, 24, 1, 1.0 / 7, 1.0 / 30.42,
+                          1.0 / 91.25, 1.0 / 365 ])
     end
 
     # Convert a load or effort value to the format specified by @loadUnit.
@@ -285,6 +286,7 @@ class TaskJuggler
                           1.0,
                           1.0 / @project.weeklyWorkingDays,
                           1.0 / @project.monthlyWorkingDays,
+                          1.0 / (@project.yearlyWorkingDays / 4),
                           1.0 / @project.yearlyWorkingDays ])
     end
 
@@ -319,8 +321,9 @@ class TaskJuggler
         # the original value.
         delta = []
         # For each of the units we can define a maximum value that the value
-        # should not exceed. nil means no limit.
-        max = [ 60, 48, nil, 8, 24, nil ]
+        # should not exceed. nil means no limit. Never use quarters since it's
+        # pretty uncommon to use.
+        max = [ 60, 48, nil, 8, 24, 0, nil ]
 
         i = 0
         factors.each do |factor|
@@ -359,18 +362,18 @@ class TaskJuggler
           # other languages as well.
           units = []
           if str == "1"
-            units = %w( minute hour day week month year )
+            units = %w( minute hour day week month quarter year )
           else
-            units = %w( minutes hours days weeks months years )
+            units = %w( minutes hours days weeks months quarters years )
           end
           str += ' ' + units[shortest]
         else
-          str += %w( min h d w m y )[shortest]
+          str += %w( min h d w m q y )[shortest]
         end
       else
         # For fixed units we just need to do the conversion. No unit is
         # included.
-        units = [ :minutes, :hours, :days, :weeks, :months, :years ]
+        units = [ :minutes, :hours, :days, :weeks, :months, :quarters, :years ]
         str = @numberFormat.format(value * factors[units.index(@loadUnit)])
       end
       str

data/lib/taskjuggler/Resource.rb

@@ -24,10 +24,15 @@ class TaskJuggler
 
       @data = Array.new(@project.scenarioCount, nil)
       @project.scenarioCount.times do |i|
-        @data[i] = ResourceScenario.new(self, i, @scenarioAttributes[i])
+        ResourceScenario.new(self, i, @scenarioAttributes[i])
       end
     end
 
+    # Just a shortcut to avoid the slower calls via method_missing.
+    def book(scenarioIdx, sbIdx, task)
+      @data[scenarioIdx].book(sbIdx, task)
+    end
+
     # Many Resource functions are scenario specific. These functions are
     # provided by the class ResourceScenario. In case we can't find a
     # function called for the Resource class we try to find it in

data/lib/taskjuggler/ResourceScenario.rb

@@ -46,13 +46,22 @@ class TaskJuggler
       # Same but for each assigned resource.
       @lastBookedSlots = {}
 
+      # Attributed are only really created when they are accessed the first
+      # time. So make sure some needed attributes really exist so we don't
+      # have to check for existance each time we access them.
+      %w( alloctdeffort criticalness directreports duties efficiency
+          effort limits managers rate reports shifts
+          vacations workinghours ).each do |attr|
+        @property[attr, @scenarioIdx]
+      end
+
       @dCache = DataCache.instance
     end
 
     # This method must be called at the beginning of each scheduling run. It
     # initializes variables used during the scheduling process.
     def prepareScheduling
-      @property['effort', @scenarioIdx] = 0
+      @effort = 0
       initScoreboard if @property.leaf?
 
       setDirectReports
@@ -66,14 +75,14 @@ class TaskJuggler
     def calcCriticalness
       if @scoreboard.nil?
         # Resources that are not allocated are not critical at all.
-        @property['criticalness', @scenarioIdx] = 0.0
+        @criticalness = 0.0
       else
         freeSlots = 0
         @scoreboard.each do |slot|
           freeSlots += 1 if slot.nil?
         end
-        @property['criticalness', @scenarioIdx] = freeSlots == 0 ? 1.0 :
-          a('alloctdeffort') / freeSlots
+        @criticalness = freeSlots == 0 ? 1.0 :
+          @alloctdeffort / freeSlots
       end
     end
 
@@ -84,7 +93,7 @@ class TaskJuggler
       # The 'directreports' attribute is the reverse link for the 'managers'
       # attribute. In contrast to the 'managers' attribute, the
       # 'directreports' list has no duplicate entries.
-      a('managers').each do |manager|
+      @managers.each do |manager|
         unless manager['directreports', @scenarioIdx].include?(@property)
           manager['directreports', @scenarioIdx] << @property
         end
@@ -92,15 +101,15 @@ class TaskJuggler
     end
 
     def setReports
-      return unless a('directreports').empty?
+      return unless @directreports.empty?
 
-      a('managers').each do |r|
+      @managers.each do |r|
         r.setReports_i(@scenarioIdx, [ @property ])
       end
     end
 
     def preScheduleCheck
-      a('managers').each do |manager|
+      @managers.each do |manager|
         unless manager.leaf?
           error('manager_is_group',
                 "Resource #{@property.fullId} has group #{manager.fullId} " +
@@ -124,7 +133,7 @@ class TaskJuggler
 
       if (parent = @property.parent)
         # Add the assigned task to the parent duties list.
-        a('duties').each do |task|
+        @duties.each do |task|
           unless parent['duties', @scenarioIdx].include?(task)
             parent['duties', @scenarioIdx] << task
           end
@@ -137,8 +146,8 @@ class TaskJuggler
     def available?(sbIdx)
       return false unless @scoreboard[sbIdx].nil?
 
-      limits = a('limits')
-      return false if limits && !limits.ok?(@scoreboard.idxToDate(sbIdx))
+      limits = @limits
+      return false if limits && !limits.ok?(sbIdx)
 
       true
     end
@@ -156,8 +165,8 @@ class TaskJuggler
       return false if !force && !available?(sbIdx)
 
       # Make sure the task is in the list of duties.
-      unless a('duties').include?(task)
-        @property['duties', @scenarioIdx] << task
+      unless @duties.include?(task)
+        @duties << task
       end
 
       #puts "Booking resource #{@property.fullId} at " +
@@ -170,7 +179,7 @@ class TaskJuggler
         t['effort', @scenarioIdx] += 1
         t = t.parent
       end
-      a('limits').inc(@scoreboard.idxToDate(sbIdx)) if a('limits')
+      @limits.inc(sbIdx) if @limits
 
       # Scoreboard iterations are fairly expensive but they are very frequent
       # operations in later processing. To limit the interations to the
@@ -242,7 +251,7 @@ class TaskJuggler
                    query.scopeProperty)
         query.string = query.currencyFormat.format(cost)
       else
-        query.string = 'No cost account'
+        query.string = 'No \'balance\' defined!'
       end
     end
 
@@ -285,12 +294,12 @@ class TaskJuggler
                    query.scopeProperty)
         query.string = query.currencyFormat.format(revenue)
       else
-        query.string = 'No revenue account'
+        query.string = 'No \'balance\' defined!'
       end
     end
 
     # The work time of the Resource that was blocked by a vacation during the
-    # specified Interval. The result is in working days (effort).
+    # specified TimeInterval. The result is in working days (effort).
     def query_vacationdays(query)
       query.sortable = query.numerical = time =
         getVacationDays(query.startIdx, query.endIdx)
@@ -302,7 +311,7 @@ class TaskJuggler
     def getEffectiveWork(startIdx, endIdx, task = nil)
       # There can't be any effective work if the start is after the end or the
       # todo list doesn't contain the specified task.
-      return 0.0 if startIdx >= endIdx || (task && !a('duties').include?(task))
+      return 0.0 if startIdx >= endIdx || (task && !@duties.include?(task))
 
       # The unique key we use to address the result in the cache.
       key = [ self, :ResourceScenarioEffectiveWork, startIdx, endIdx,
@@ -324,7 +333,7 @@ class TaskJuggler
 
         work = @project.convertToDailyLoad(
                  getAllocatedSlots(startIdx, endIdx, task) *
-                 @project['scheduleGranularity']) * a('efficiency')
+                 @project['scheduleGranularity']) * @efficiency
       end
       @dCache.store(work, key)
     end
@@ -384,7 +393,7 @@ class TaskJuggler
       else
         work = @project.convertToDailyLoad(
                  getFreeSlots(startIdx, endIdx) *
-                 @project['scheduleGranularity']) * a('efficiency')
+                 @project['scheduleGranularity']) * @efficiency
       end
       work
     end
@@ -406,7 +415,7 @@ class TaskJuggler
 
         vacationDays = @project.convertToDailyLoad(
           getVacationSlots(startIdx, endIdx) *
-          @project['scheduleGranularity']) * a('efficiency')
+          @project['scheduleGranularity']) * @efficiency
       end
       vacationDays
     end
@@ -418,7 +427,7 @@ class TaskJuggler
           amount += child.turnover(@scenarioIdx, startIdx, endIdx, account, task)
         end
       else
-        a('duties').each do |duty|
+        @duties.each do |duty|
           amount += duty.turnover(@scenarioIdx, startIdx, endIdx, account,
                                   @property)
         end
@@ -427,18 +436,18 @@ class TaskJuggler
       amount
     end
 
-    # Returns the cost for using this resource during the specified Interval
-    # _period_. If a Task _task_ is provided, only the work on this particular
-    # task is considered.
+    # Returns the cost for using this resource during the specified
+    # TimeInterval _period_. If a Task _task_ is provided, only the work on
+    # this particular task is considered.
     def cost(startIdx, endIdx, task = nil)
-      getAllocatedTime(startIdx, endIdx, task) * a('rate')
+      getAllocatedTime(startIdx, endIdx, task) * @rate
     end
 
     # Returns true if the resource or any of its children is allocated during
-    # the period specified with the Interval _iv_. If task is not nil
+    # the period specified with the TimeInterval _iv_. If task is not nil
     # only allocations to this tasks are respected.
     def allocated?(iv, task = nil)
-      return false if task && !a('duties').include?(task)
+      return false if task && !@duties.include?(task)
 
       startIdx = @project.dateToIdx(iv.start)
       endIdx = @project.dateToIdx(iv.end)
@@ -450,26 +459,22 @@ class TaskJuggler
     end
 
     # Iterate over the scoreboard and turn its content into a set of Bookings.
-    #  _iv_ can be an Interval to limit the bookings within the provided
-    #  period.
-    def getBookings(iv = nil)
-      return {} if @property.container? || @scoreboard.nil? ||
-                   @firstBookedSlot.nil? || @lastBookedSlot.nil?
-
-      bookings = {}
-      lastTask = nil
-      bookingStart = nil
+    #  _iv_ can be a TimeInterval to limit the bookings within the provided
+    #  period. if _hashByTask_ is true, the result is a Hash of Arrays with
+    #  bookings hashed by Task. Otherwise it's just a plain Array with
+    #  Bookings.
+    def getBookings(iv = nil, hashByTask = true)
+      bookings = hashByTask ? {} : []
+      return bookings if @property.container? || @scoreboard.nil? ||
+                         @firstBookedSlot.nil? || @lastBookedSlot.nil?
 
       # To speedup the collection we start with the first booked slot and end
       # with the last booked slot.
       startIdx = @firstBookedSlot
       endIdx = @lastBookedSlot + 1
 
-      # In case the index markers are still uninitialized, we have no bookings.
-      return {} if startIdx.nil? || endIdx.nil?
-
-      # If the user provided an Interval, we only return bookings within this
-      # Interval.
+      # If the user provided a TimeInterval, we only return bookings within
+      # this TimeInterval.
       if iv
         ivStartIdx = @project.dateToIdx(iv.start)
         ivEndIdx = @project.dateToIdx(iv.end)
@@ -477,21 +482,35 @@ class TaskJuggler
         endIdx = ivEndIdx if ivEndIdx < endIdx
       end
 
+      lastTask = nil
+      bookingStart = nil
+
       startIdx.upto(endIdx) do |idx|
         task = @scoreboard[idx]
         # Now we watch for task changes.
-        if task != lastTask || (lastTask == nil && task.is_a?(Task)) ||
-           (task.is_a?(Task) && idx == endIdx)
-          unless lastTask.nil?
+        if task != lastTask ||
+           (task.is_a?(Task) && (lastTask.nil? || idx == endIdx))
+          if lastTask
+            # We've found the end of a task booking series.
             # If we don't have a Booking for the task yet, we create one.
-            if bookings[lastTask].nil?
-              bookings[lastTask] = Booking.new(@property, lastTask, [])
+            if hashByTask
+              if bookings[lastTask].nil?
+                bookings[lastTask] = Booking.new(@property, lastTask, [])
+              end
+              # Append the new interval to the Booking.
+              bookings[lastTask].intervals <<
+              TimeInterval.new(@scoreboard.idxToDate(bookingStart),
+                               @scoreboard.idxToDate(idx))
+            else
+              if bookings.empty? || bookings.last.task != lastTask
+                bookings << Booking.new(@property, lastTask, [])
+              end
+              # Append the new interval to the Booking.
+              bookings.last.intervals <<
+              TimeInterval.new(@scoreboard.idxToDate(bookingStart),
+                               @scoreboard.idxToDate(idx))
             end
 
-            # Append the new interval to the Booking.
-            bookings[lastTask].intervals <<
-              Interval.new(@scoreboard.idxToDate(bookingStart),
-                           @scoreboard.idxToDate(idx))
           end
           # Get ready for the next task booking interval
           if task.is_a?(Task)
@@ -578,19 +597,16 @@ class TaskJuggler
                                    @project['scheduleGranularity'], 2)
 
       # We'll need this frequently and can savely cache it here.
-      @shifts = a('shifts')
-      @workinghours = a('workinghours')
+      @shifts = @shifts
+      @workinghours = @workinghours
 
       # Change all work time slots to nil (available) again.
-      date = @scoreboard.idxToDate(0)
-      delta = @project['scheduleGranularity']
       @project.scoreboardSize.times do |i|
-        @scoreboard[i] = nil if onShift?(date)
-        date += delta
+        @scoreboard[i] = nil if onShift?(i)
       end
 
       # Mark all resource specific vacation slots as such
-      a('vacations').each do |vacation|
+      @vacations.each do |vacation|
         startIdx = @scoreboard.dateToIdx(vacation.start)
         endIdx = @scoreboard.dateToIdx(vacation.end)
         startIdx.upto(endIdx - 1) do |i|
@@ -613,7 +629,7 @@ class TaskJuggler
       unless @shifts.nil?
         # Mark the vacations from all the shifts the resource is assigned to.
         @project.scoreboardSize.times do |i|
-          v = @shifts.getSbSlot(@scoreboard.idxToDate(i))
+          v = @shifts.getSbSlot(i)
           # Check if the vacation replacement bit is set. In that case we copy
           # the whole interval over to the resource scoreboard overriding any
           # global vacations.
@@ -654,21 +670,21 @@ class TaskJuggler
               "Management loop detected. #{@property.fullId} has self " +
               "in list of reports")
       end
-      @property['reports', @scenarioIdx] += reports
+      @reports += reports
       # Resources can end up multiple times in the list if they have multiple
       # reporting chains. We only need them once in the list.
-      a('reports').uniq!
+      @reports.uniq!
 
-      a('managers').each do |r|
-        r.setReports_i(@scenarioIdx, a('reports'))
+      @managers.each do |r|
+        r.setReports_i(@scenarioIdx, @reports)
       end
     end
 
-    def onShift?(date)
-      if @shifts && @shifts.assigned?(date)
-        return @shifts.onShift?(date)
+    def onShift?(sbIdx)
+      if @shifts && @shifts.assigned?(sbIdx)
+        return @shifts.onShift?(sbIdx)
       else
-        @workinghours.onShift?(date)
+        @workinghours.onShift?(sbIdx)
       end
     end
 
@@ -682,7 +698,7 @@ class TaskJuggler
                                                task)
         end
       else
-        return false unless @scoreboard && a('duties').include?(task)
+        return false unless @scoreboard && @duties.include?(task)
 
         startIdx, endIdx = fitIndicies(startIdx, endIdx, task)
         return false if startIdx >= endIdx
@@ -703,7 +719,7 @@ class TaskJuggler
         end
         dailyRate
       else
-        a('rate')
+        @rate
       end
     end
 

data/lib/taskjuggler/RichText/RTFQuery.rb

@@ -159,8 +159,8 @@ class TaskJuggler
     def setLoadUnit(query, args)
       units = {
         'days' => :days, 'hours' => :hours, 'longauto' => :longauto,
-        'minutes' => :minutes, 'months' => :months, 'shortauto' => :shortauto,
-        'weeks' => :weeks, 'years' => :years
+        'minutes' => :minutes, 'months' => :months, 'quarters' => :quarters,
+        'shortauto' => :shortauto, 'weeks' => :weeks, 'years' => :years
       }
       query.loadUnit = units[args['loadunit']] if args['loadunit']
     end

data/lib/taskjuggler/ScenarioData.rb

@@ -25,10 +25,20 @@ class TaskJuggler
       @project = property.project
       @scenarioIdx = idx
       @attributes = attributes
+
+      # Register the scenario with the Task.
+      @property.data[idx] = self
+    end
+
+    # We only use deep_clone for attributes, never for properties. Since
+    # attributes may reference properties these references should remain
+    # references.
+    def deep_clone
+      self
     end
 
     def a(attributeName)
-      @attributes[attributeName].value
+      @attributes[attributeName].get
     end
 
     def error(id, text, sourceFileInfo = nil, property = nil)

data/lib/taskjuggler/Scoreboard.rb

@@ -81,6 +81,13 @@ class TaskJuggler
       end
     end
 
+    # Iterate over all scoreboard entries by index.
+    def each_index
+      @sb.each_index do |index|
+        yield index
+      end
+    end
+
     # Assign result of block to each element.
     def collect!
       @sb.collect! { |x| yield x }
@@ -154,7 +161,7 @@ class TaskJuggler
               start = sIdx if start < sIdx
               idx = eIdx if idx > eIdx
 
-              intervals << Interval.new(idxToDate(start), idxToDate(idx))
+              intervals << TimeInterval.new(idxToDate(start), idxToDate(idx))
             end
             duration = start = 0
           end

data/lib/taskjuggler/Shift.rb

@@ -26,7 +26,7 @@ class TaskJuggler
 
       @data = Array.new(@project.scenarioCount, nil)
       @project.scenarioCount.times do |i|
-        @data[i] = ShiftScenario.new(self, i, @scenarioAttributes[i])
+        ShiftScenario.new(self, i, @scenarioAttributes[i])
       end
     end