taskjuggler 0.0.3 → 0.0.4

data/lib/MacroParser.rb

@@ -3,7 +3,7 @@
 #
 # = MacroParser.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/MacroTable.rb

@@ -3,7 +3,7 @@
 #
 # = MacroTable.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
@@ -62,7 +62,7 @@ class TaskJuggler
     # unchanged. No error is generated.
     def resolve(args, sourceFileInfo)
       name = args[0]
-      resolved = @macros[name].value.clone
+      resolved = @macros[name].value.dup
       i = 0
       args.each do |arg|
         resolved.gsub!("${#{i}}", arg)

data/lib/Message.rb

@@ -3,7 +3,7 @@
 #
 # = Message.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/MessageHandler.rb

@@ -3,7 +3,7 @@
 #
 # = MessageHandler.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
@@ -14,17 +14,21 @@ class TaskJuggler
 
   class MessageHandler
 
-    attr_reader :messages
+    attr_reader :messages, :errors
 
     def initialize(console = false)
       @messages = []
       @console = console
+
+      @errors = 0
     end
 
     def send(message)
+      @errors += 1 if message.level == 'error' || message.level == 'fatal'
       @messages << message
       if @console
-        $stderr.puts message
+        # The to_s call is necessary to support remote prints via DRb.
+        $stderr.puts message.to_s
       end
     end
 

data/lib/Project.rb

@@ -3,7 +3,7 @@
 #
 # = Project.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,12 +56,17 @@ class TaskJuggler
     def initialize(id, name, version, messageHandler)
       @messageHandler = messageHandler
       @attributes = {
-        'projectid' => id || "prj",
-        'projectids' => [ id ],
-        'name' => name,
-        'version' => version || "1.0",
-        'costAccount' => nil,
+        # This nested Array defines the supported alert levels. The lowest
+        # level comes first at index 0 and the level rises from there on.
+        # Currently, these levels are hardcoded. Each level entry has 3
+        # members: the tjp syntax token, the user visible name and the
+        # associated color as RGB byte array.
+        'alertLevels' => [
+          [ 'green',  'Green',  '#008000' ],
+          [ 'yellow', 'Yellow', '#BEA800' ],
+          [ 'red',    'Red',    '#C00000' ] ],
         'copyright' => nil,
+        'costAccount' => nil,
         'currency' => "EUR",
         'currencyFormat' => RealFormat.new([ '-', '', '', ',', 2 ]),
         'dailyworkinghours' => 8.0,
@@ -70,10 +75,13 @@ class TaskJuggler
         'journal' => Journal.new,
         'limits' => nil,
         'loadUnit' => :shortauto,
+        'name' => name,
         'navigators' => {},
         'now' => TjTime.now.align(3600),
         'numberFormat' => RealFormat.new([ '-', '', '', '.', 1]),
         'priority' => 500,
+        'projectid' => id || "prj",
+        'projectids' => [ id ],
         'rate' => 0.0,
         'revenueAccount' => nil,
         'scheduleGranularity' => Project.maxScheduleGranularity,
@@ -81,7 +89,9 @@ class TaskJuggler
         'start' => nil,
         'timeFormat' => "%Y-%m-%d",
         'timezone' => nil,
+        'trackingScenarioIdx' => 0,
         'vacations' => [],
+        'version' => version || "1.0",
         'weekStartsMonday' => true,
         'workinghours' => WorkingHours.new,
         'yearlyworkingdays' => 260.714
@@ -137,6 +147,8 @@ class TaskJuggler
         #     Inh.   Inh.Prj  Scen.  Default
         [ 'index',     'Index',        FixnumAttribute,
               false, false,   false, -1 ],
+        [ 'flags',     'Flags',        FlagListAttribute,
+              true,  false,   true,  [] ],
         [ 'tree',      'Tree Index',   StringAttribute,
               false, false,   false, "" ],
         [ 'wbs',       'WBS',          StringAttribute,
@@ -259,6 +271,8 @@ class TaskJuggler
               false, false,   true,  [] ],
         [ 'startsuccs', 'Start Succs.', TaskListAttribute,
               false, false,   true,  [] ],
+        [ 'status',    'Task Status',  StringAttribute,
+              false, false,   true,  "" ],
         [ 'tree',      'Tree Index',   StringAttribute,
               false, false,   false, "" ],
         [ 'wbs',       'WBS',          StringAttribute,
@@ -286,6 +300,8 @@ class TaskJuggler
               true,  true,    false, nil ],
         [ 'epilog',    'Epilog',       RichTextAttribute,
               false, false,   false, nil ],
+        [ 'flags',     'Flags',        FlagListAttribute,
+              true,  false,   true,  [] ],
         [ 'footer',    'Footer',       RichTextAttribute,
               true,  false,   false, nil ],
         [ 'formats',   'Formats',      FormatListAttribute,
@@ -294,8 +310,8 @@ class TaskJuggler
               true,  false,   false, true ],
         [ 'header',    'Header',       RichTextAttribute,
               true,  false,   false, nil ],
-        [ 'headline',  'Headline',     StringAttribute,
-              false, false,   false, '' ],
+        [ 'headline',  'Headline',     RichTextAttribute,
+              false, false,   false, nil ],
         [ 'hideResource', 'Hide Resource', LogicalExpressionAttribute,
               true,  false,   false, nil ],
         [ 'hideTask',  'Hide Task',    LogicalExpressionAttribute,
@@ -326,6 +342,8 @@ class TaskJuggler
               true, false,    false, nil ],
         [ 'scenarios',  'Scenarios',   ScenarioListAttribute,
               true, false,    false, [ 0 ] ],
+        [ 'selfcontained', 'Selfcontained', BooleanAttribute,
+              true, false,    false, false ],
         [ 'shortTimeFormat', 'Short Time Format', StringAttribute,
               true,  true,    false, nil ],
         [ 'sortResources', 'Sort Resources', SortListAttribute,
@@ -342,6 +360,8 @@ class TaskJuggler
               true,  true,    false, nil ],
         [ 'timezone', 'Time Zone',     StringAttribute,
               true,  true,    false, nil ],
+        [ 'title',    'Title',         StringAttribute,
+              false, false,   false, nil ],
         [ 'tree',      'Tree Index',   StringAttribute,
               false, false,   false, "" ],
         [ 'wbs',       'WBS',          StringAttribute,
@@ -353,6 +373,7 @@ class TaskJuggler
 
       Scenario.new(self, 'plan', 'Plan Scenario', nil)
 
+      # This holds a reference to the ReportContext for each Thread.
       @reportContext = nil
       @outputDir = ''
     end
@@ -390,6 +411,39 @@ class TaskJuggler
       @scenarios.items
     end
 
+    # Try to match _levelName_ to a defined alert level name and return the
+    # index of it. If no level is found, nil is returned.
+    def alertLevelIndex(levelName)
+      0.upto(@attributes['alertLevels'].length - 1) do |i|
+        if @attributes['alertLevels'][i][0] == levelName
+          return i
+        end
+      end
+      nil
+    end
+
+    # Return the ID or keyword of the alert level with the given _levelIndex_.
+    # Or nil if the level does not exist.
+    def alertLevelId(levelIndex)
+      return 'unknown' unless @attributes['alertLevels'][levelIndex]
+      @attributes['alertLevels'][levelIndex][0]
+    end
+
+    # Return the user readable name of the alert level with the given
+    # _levelIndex_. Or nil if the level does not exist.
+    def alertLevelName(levelIndex)
+      return 'unknown' unless @attributes['alertLevels'][levelIndex]
+      @attributes['alertLevels'][levelIndex][1]
+    end
+
+    # Return the color of the alert level with the given _levelIndex_. Or nil
+    # if the level does not exist. The color is an RGB encoded byte array,
+    # stored as hexadecimal String, prefixed with a pound sign.
+    def alertLevelColor(levelIndex)
+      return 'unknown' unless @attributes['alertLevels'][levelIndex]
+      @attributes['alertLevels'][levelIndex][2]
+    end
+
     # Return the average number of working hours per day. This defaults to 8 but
     # can be set to other values by the user.
     def dailyWorkingHours
@@ -537,14 +591,23 @@ class TaskJuggler
           end
         else
           bp = BatchProcessor.new(maxCpuCores)
-          @reports.each_value do |report|
+          @reports.each do |report|
             next if report.get('formats').empty?
-            bp.queue(report) { report.generate }
+            bp.queue(report) {
+              @reportContext = ReportContext.new(self, report)
+              report.generate
+            }
           end
           bp.wait do |report|
+            Log.startProgressMeter("Report #{report.tag.name}")
             $stdout.print(report.stdout)
             $stderr.print(report.stderr)
-            Log.startProgressMeter("Report #{report.tag.name}")
+            if report.retVal.signaled?
+              raise TjException.new, "Signal raised"
+            end
+            unless report.retVal.success?
+              raise TjException.new, "Process aborted"
+            end
             Log.stopProgressMeter
           end
         end
@@ -556,6 +619,17 @@ class TaskJuggler
       true
     end
 
+    def generateReport(reportId)
+      unless (report = @reports[reportId])
+        error('unknown_report_id',
+              "Request to generate unknown report #{reportId}")
+      end
+      Log.startProgressMeter("Report #{report.name}")
+      @reportContext = ReportContext.new(self, report)
+      report.generate
+      Log.stopProgressMeter
+    end
+
     ####################################################################
     # The following functions are not intended to be called from outside
     # the TaskJuggler library. There is no guarantee that these
@@ -695,10 +769,9 @@ class TaskJuggler
       name
     end
 
-
-
     # Print the attribute values. It's used for debugging only.
     def to_s
+      raise "STOP!"
       @attributes.each do |attribute, value|
         if value
           puts "#{attribute}: " +
@@ -707,6 +780,12 @@ class TaskJuggler
       end
     end
 
+    # This function sends an error message to the message handler.
+    def error(id, text)
+      message = Message.new(id, 'error', text)
+      @messageHandler.send(message)
+    end
+
   protected
 
     def prepareScenario(scIdx)
@@ -814,7 +893,7 @@ class TaskJuggler
       loop do
         # The main scheduler loop only needs to look at the first task that is
         # ready to be scheduled.
-        workItems = Array.new(tasks)
+        workItems = tasks.to_ary
 
         # Count the already completed tasks.
         completedTasks = 0

data/lib/ProjectFileParser.rb

@@ -3,7 +3,7 @@
 #
 # = ProjectFileParser.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
@@ -14,8 +14,9 @@ require 'TextParser'
 require 'TextScanner'
 require 'TjpSyntaxRules'
 require 'RichText'
-require 'RTPNavigator'
-require 'RTPReport'
+require 'RTFNavigator'
+require 'RTFQuery'
+require 'RTFReport'
 
 class TaskJuggler
 
@@ -49,20 +50,20 @@ class TaskJuggler
 
     # Call this function with the master file to start processing a TJP file or
     # a set of TJP files.
-    def open(file, master)
+    def open(file, master, fileNameIsBuffer = false)
       begin
         @scanner = TextScanner.new(file, @messageHandler)
         # We need the TextScanner object for error reporting.
-        if master && file != '.' && file[-4, 4] != '.tjp'
+        if master && !fileNameIsBuffer && file != '.' && file[-4, 4] != '.tjp'
           error('illegal_extension', "Project file name must end with " +
                 '\'.tjp\' extension')
         end
-        @scanner.open
+        @scanner.open(fileNameIsBuffer)
       rescue StandardError
         error('file_open', $!.message)
       end
 
-      @property = @report = nil
+      @property = nil
       @scenarioIdx = 0
       initFileStack
     end
@@ -99,6 +100,9 @@ class TaskJuggler
                                   @scanner.sourceFileInfo))
       @scanner.addMacro(Macro.new('now', @project['now'].to_s,
                                   @scanner.sourceFileInfo))
+      @scanner.addMacro(Macro.new('today', @project['now'].
+                                   to_s(@project['timeFormat']),
+                                  @scanner.sourceFileInfo))
     end
 
   private
@@ -130,11 +134,13 @@ class TaskJuggler
       # Make sure the interval is within the project time frame.
       if iv.start < @project['start'] || iv.start >= @project['end']
         error('interval_start_in_range',
-                "Start date #{iv.start} must be within the project time frame")
+              "Start date #{iv.start} must be within the project time frame " +
+              "(#{@project['start']} - #{@project['end']})")
       end
       if iv.end <= @project['start'] || iv.end > @project['end']
         error('interval_end_in_range',
-                "End date #{iv.end} must be within the project time frame")
+              "End date #{iv.end} must be within the project time frame " +
+              "(#{@project['start']} - #{@project['end']})")
       end
     end
 
@@ -194,20 +200,29 @@ class TaskJuggler
     # This is necessary, because the RichText parser knows nothing about the
     # actual input file. So we have to map the error location in the RichText
     # input stream back to the position in the project file.
-    def newRichText(text)
+    # To limit the supported set of variable tokens, a subset can be provided
+    # by _tokenSet_.
+    def newRichText(text, tokenSet = nil)
       sfi = sourceFileInfo
       begin
-        rText = RichText.new(text)
-        rText.registerProtocol(RTPNavigator.new(@project, sfi))
-        rText.registerProtocol(RTPReport.new(@project, sfi))
+        handlers = [
+          RTFNavigator.new(@project, sfi),
+          RTFQuery.new(@project, sfi),
+          RTFReport.new(@project, sfi)
+        ]
+        rText = RichText.new(text, handlers)
+        rti = rText.generateIntermediateFormat( [ 0, 0, 0], tokenSet)
+        rti.sectionNumbers = false
       rescue RichTextException => msg
         sfi = SourceFileInfo.new(sfi.fileName, sfi.lineNo + msg.lineNo - 1, 0)
         message = Message.new(msg.id, 'error', msg.text + "\n" + msg.line,
                               @property, nil, sfi)
         @messageHandler.send(message)
 
+        # An empty strings signals an already reported error
+        raise TjException.new, ''
       end
-      rText
+      rti
     end
 
     # This method is a convenience wrapper around Project.new. It checks if
@@ -224,7 +239,7 @@ class TaskJuggler
                              name, nil)
       @property.typeSpec = type
       @property.sourceFileInfo = sourceFileInfo
-      @property.set('formats', [ type ])
+      @property.set('formats', [ :tjp ])
       @property.inheritAttributes
       @property
     end

data/lib/PropertyList.rb

@@ -3,7 +3,7 @@
 #
 # = PropertyList.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,7 @@ class TaskJuggler
   # be used for sorting, a scenario index if necessary and the sorting
   # direction (up/down). All nodes in the PropertyList must belong to the same
   # PropertySet.
-  class PropertyList < Array
+  class PropertyList
 
     attr_writer :query
     attr_reader :propertySet, :query, :sortingLevels, :sortingCriteria,
@@ -27,8 +27,8 @@ class TaskJuggler
 
     # A PropertyList is always bound to a certain PropertySet. All properties
     # in the list must be of that set.
-    def initialize(arg)
-      super(arg.to_ary)
+    def initialize(arg, copyItems = true)
+      @items = copyItems ? arg.to_ary : []
       if arg.is_a?(PropertySet)
         # Create a PropertyList from the given PropertySet.
         @propertySet = arg
@@ -40,7 +40,7 @@ class TaskJuggler
         @query = nil
         resetSorting
         addSortingCriteria('seqno', true, -1)
-        self.sort!
+        sort!
       else
         # Create a PropertyList from a given other PropertyList.
         @propertySet = arg.propertySet
@@ -52,6 +52,17 @@ class TaskJuggler
       end
     end
 
+    # This class should be a derived class of Array. But since it re-defines
+    # sort!() and still needs to call Array::sort!() I took a different route.
+    # All missing methods will be propagated to the @items Array.
+    def method_missing(func, *args, &block)
+      @items.method(func).call(*args, &block)
+    end
+
+    def to_ary
+      @items.dup
+    end
+
     # Set all sorting levels as Array of triplets.
     def setSorting(modes)
       resetSorting
@@ -68,8 +79,8 @@ class TaskJuggler
       @scenarioIdx = []
     end
 
-    # Append another Array of Tasks or a PropertyList to this. The list will be
-    # sorted again.
+    # Append another Array of PropertyTreeNodes or a PropertyList to this. The
+    # list will be sorted again.
     def append(list)
       if $DEBUG
         list.each do |node|
@@ -79,13 +90,14 @@ class TaskJuggler
         end
       end
 
-      concat(list)
-      self.sort!
+      @items.concat(list)
+      sort!
     end
 
     # Append a new sorting level to the existing levels.
     def addSortingCriteria(criteria, up, scIdx)
-      unless @propertySet.knownAttribute?(criteria)
+      unless @propertySet.knownAttribute?(criteria) ||
+             @propertySet.hasQuery?(criteria, scIdx)
         raise TjException.new, "Unknown attribute #{criteria} used for " +
                                'sorting criterium'
       end
@@ -95,6 +107,9 @@ class TaskJuggler
                 "You must specify a scenario id."
         end
       else
+        if @propertySet.project.scenario(scIdx).nil?
+          raise TjException.new, "Unknown scenario index #{scIdx} used."
+        end
         if !@propertySet.scenarioSpecific?(criteria)
           raise TjException.new, "Attribute #{criteria} is not scenario specific"
         end
@@ -114,7 +129,82 @@ class TaskJuggler
 
     # Sort the properties according to the currently defined sorting criteria.
     def sort!
-      super do |a, b|
+      if treeMode?
+        # Tree sorting is somewhat complex. It will be based on the 'tree'
+        # attribute of the PropertyTreeNodes but we have to update them first
+        # based on the other sorting criteria.
+
+        # Remove the tree sorting mode first.
+        sc = @sortingCriteria.delete_at(0)
+        su = @sortingUp.delete_at(0)
+        si = @scenarioIdx.delete_at(0)
+        @sortingLevels -= 1
+
+        # Sort the list based on the rest of the modes.
+        sortInternal
+        # The update the 'index' attributes of the PropertyTreeNodes.
+        index
+        # An then the 'tree' attributes.
+        indexTree
+
+        # Restore the 'tree' sorting mode again.
+        @sortingCriteria.insert(0, sc)
+        @sortingUp.insert(0, su)
+        @scenarioIdx.insert(0, si)
+        @sortingLevels += 1
+
+        # Sort again, now based on the updated 'tree' attributes.
+        sortInternal
+      else
+        sortInternal
+      end
+      # Update indexes.
+      index
+    end
+
+    # This function sets the index attribute of all the properties in the list.
+    # The index starts with 0 and increases for each property.
+    def index
+      i = 0
+      @items.each do |p|
+        p.set('index', i += 1)
+      end
+    end
+
+    # Turn the list into a String. This is only used for debugging.
+    def to_s # :nodoc:
+      res = "Sorting: "
+      @sortingLevels.times do |i|
+        res += "#{@sortingCriteria[i]}/#{@sortingUp[i] ? 'up' : 'down'}/" +
+               "#{@scenarioIdx[i]}, "
+      end
+      res += "\n#{@items.length} properties:"
+      @items.each { |i| res += "#{i.get('id')}: #{i.get('name')}\n" }
+      res
+    end
+
+    private
+
+    # Update the 'tree' indicies that are needed for the 'tree' sorting mode.
+    def indexTree
+      @items.each do |property|
+        # The indicies are an Array if the 'index' attributes for this
+        # property and all its parents.
+        treeIdcs = property.getIndicies
+        # Now convert them to a String.
+        tree = ''
+        treeIdcs.each do |idx|
+          # Prefix the level index with zeros so that we always have a 6
+          # digit long String. 6 digits should be large enough for all
+          # real-world projects.
+          tree += idx.to_s.rjust(6, '0')
+        end
+        property.set('tree', tree)
+      end
+    end
+
+    def sortInternal
+      @items.sort! do |a, b|
         res = 0
         @sortingLevels.times do |i|
           if @query
@@ -125,11 +215,11 @@ class TaskJuggler
 
             @query.property = a
             @query.process
-            aVal = @query.sortableResult
+            aVal = @query.to_sort
 
             @query.property = b
             @query.process
-            bVal = @query.sortableResult
+            bVal = @query.to_sort
           else
             # In case we don't have a query, we use the static mechanism.
             # If the scenario index is negative we have a non-scenario-specific
@@ -151,29 +241,6 @@ class TaskJuggler
         end
         res
       end
-      # Update indexes.
-      index
-    end
-
-    # This function sets the index attribute of all the properties in the list.
-    # The index starts with 0 and increases for each property.
-    def index
-      i = 0
-      each do |p|
-        p.set('index', i += 1)
-      end
-    end
-
-    # Turn the list into a String. This is only used for debugging.
-    def to_s # :nodoc:
-      res = "Sorting: "
-      @sortingLevels.times do |i|
-        res += "#{@sortingCriteria[i]}/#{@sortingUp[i] ? 'up' : 'down'}/" +
-               "#{@scenarioIdx[i]}, "
-      end
-      res += "\n"
-      each { |i| res += "#{i.get('id')}: #{i.get('name')}\n" }
-      res
     end
 
   end