taskjuggler 0.0.11 → 0.1.0

data/lib/taskjuggler/LogicalExpression.rb

@@ -40,8 +40,8 @@ class TaskJuggler
     def eval(query)
       @query = query
       res = @operation.eval(self)
-      return res if res.class == TrueClass || res.class == FalseClass ||
-                    res.class == String
+      return res if res.is_a?(TrueClass) || res.is_a?(FalseClass) ||
+                    res.is_a?(String)
       # In TJP syntax 'non 0' means false.
       return res != 0
     end

data/lib/taskjuggler/LogicalFunction.rb

@@ -26,10 +26,12 @@ class TaskJuggler
     @@functions = {
         'hasalert' => 1,
         'isactive' => 1,
+        'ischildof' => 1,
         'isdependencyof' => 3,
         'isdutyof' => 2,
         'isfeatureof' => 2,
         'isleaf' => 0,
+        'ismilestone' => 1,
         'isongoing' => 1,
         'isresource' => 0,
         'istask' => 0,
@@ -96,7 +98,8 @@ class TaskJuggler
       query = expr.query
       project = property.project
       !project['journal'].currentEntries(query.end, property,
-                                         args[0], query.start).empty?
+                                         args[0], query.start,
+                                         query.hideJournalEntry).empty?
     end
 
     def isactive(expr, args)
@@ -115,6 +118,15 @@ class TaskJuggler
                                 scopeProperty) > 0.0
     end
 
+    def ischildof(expr, args)
+      # The the context property.
+      property = properties(expr)[0]
+      # Find the prospective parent ID in the current PropertySet.
+      return false unless (parent = property.propertySet[args[0]])
+
+      property.isChildOf?(parent)
+    end
+
     def isdependencyof(expr, args)
       property = properties(expr)[0]
       # The result can only be true when called for a Task property.
@@ -162,6 +174,15 @@ class TaskJuggler
       property.leaf?
     end
 
+    def ismilestone(expr, args)
+      property = properties(expr)[0]
+      return false unless property
+      # 1st arg must be a scenario index.
+      return false if (scenarioIdx = property.project.scenarioIdx(args[0])).nil?
+
+      property.is_a?(Task) && property['milestone', scenarioIdx]
+    end
+
     def isongoing(expr, args)
       property = properties(expr)[0]
       # The result can only be true when called for a Task property.

data/lib/taskjuggler/LogicalOperation.rb

@@ -182,7 +182,7 @@ class TaskJuggler
   class LogicalAttribute < LogicalOperation
 
     def initialize(attribute, scenario)
-      @scenarioIdx = scenario
+      @scenario = scenario
       super
     end
 
@@ -190,7 +190,7 @@ class TaskJuggler
     # the value.
     def eval(expr)
       query = expr.query
-      query.scenarioIdx = @scenarioIdx
+      query.scenarioIdx = @scenario.sequenceNo - 1
       query.attributeId = @operand1
       query.process
       # The logical expressions are mostly about comparing values. So we use
@@ -208,7 +208,7 @@ class TaskJuggler
         query.process
         query.to_s
       else
-        "#{@scenarioIdx}.#{@operand1}"
+        "#{@scenario.fullId}.#{@operand1}"
       end
     end
 
@@ -224,12 +224,22 @@ class TaskJuggler
 
     # Return true if the property has the flag assigned.
     def eval(expr)
-      expr.query.property['flags', 0].include?(@operand1)
+      if expr.query.is_a?(Query)
+        # This is used for Project or PTN related Queries
+        expr.query.property['flags', 0].include?(@operand1)
+      else
+        # This is used for Journal objects.
+        expr.query.flags.include?(@operand1)
+      end
     end
 
     def to_s(query)
       if query
-        query.property['flags', 0].include(@operand1) ? 'true' : 'false'
+        if query.is_a?(Query)
+          query.property['flags', 0].include(@operand1) ? 'true' : 'false'
+        else
+          query.flags.include(@operand1) ? 'true' : 'false'
+        end
       else
         @operand1
       end

data/lib/taskjuggler/Project.rb

@@ -95,7 +95,7 @@ class TaskJuggler
         'start' => nil,
         'timeFormat' => "%Y-%m-%d",
         'timezone' => TjTime.timeZone,
-        'trackingScenarioIdx' => 0,
+        'trackingScenarioIdx' => nil,
         'vacations' => [],
         'version' => version || "1.0",
         'weekStartsMonday' => true,
@@ -115,14 +115,12 @@ class TaskJuggler
       attrs = [
         # ID           Name          Type
         #     Inh.   Inh.Prj  Scen.  Default
-        [ 'enabled',   'Enabled',    BooleanAttribute,
+        [ 'active',   'Enabled',    BooleanAttribute,
               true,  false,   false, true ],
-        [ 'minslackrate', 'Min. Slack Rate', FloatAttribute,
-              true,  false,   false, 1.0 ],
+        [ 'ownbookings', 'Own Bookings', BooleanAttribute,
+              false, false,   false, true ],
         [ 'projection', 'Projection Mode', BooleanAttribute,
               true,  false,   false, false ],
-        [ 'strict', 'Strict Bookings', BooleanAttribute,
-              true, false,    false, false ]
       ]
       attrs.each { |a| @scenarios.addAttributeType(AttributeDefinition.new(*a)) }
 
@@ -140,7 +138,7 @@ class TaskJuggler
               false, false,   false, "" ],
         [ 'vacations', 'Vacations',    IntervalListAttribute,
               true,  true,    true,  [] ],
-        [ 'wbs',       'WBS',          StringAttribute,
+        [ 'bsi',       'BSI',          StringAttribute,
               false, false,   false, "" ],
         [ 'workinghours', 'Working Hours', WorkingHoursAttribute,
               true,  true,    true,  nil ]
@@ -157,7 +155,7 @@ class TaskJuggler
               true,  false,   true,  [] ],
         [ 'tree',      'Tree Index',   StringAttribute,
               false, false,   false, "" ],
-        [ 'wbs',       'WBS',          StringAttribute,
+        [ 'bsi',       'BSI',          StringAttribute,
               false, false,   false, "" ]
       ]
       attrs.each { |a| @accounts.addAttributeType(AttributeDefinition.new(*a)) }
@@ -206,7 +204,7 @@ class TaskJuggler
               true,  true,    true,  [] ],
         [ 'warn',      'Warning Condition', LogicalExpressionListAttribute,
               false, false,   false, [] ],
-        [ 'wbs',       'WBS',          StringAttribute,
+        [ 'bsi',       'BSI',          StringAttribute,
               false, false,   false, "" ],
         [ 'workinghours', 'Working Hours', WorkingHoursAttribute,
               true,  true,    true,  nil ]
@@ -239,9 +237,9 @@ class TaskJuggler
               false, false,   true,  0 ],
         [ 'end',       'End',          DateAttribute,
               false, false,   true,  nil ],
-        [ 'endpreds',  'End Preds.',   TaskListAttribute,
+        [ 'endpreds',  'End Preds.',   TaskDepListAttribute,
               false, false,   true,  [] ],
-        [ 'endsuccs',  'End Succs.',   TaskListAttribute,
+        [ 'endsuccs',  'End Succs.',   TaskDepListAttribute,
               false, false,   true,  [] ],
         [ 'fail',      'Failure Conditions', LogicalExpressionListAttribute,
               false, false,   false, [] ],
@@ -283,9 +281,9 @@ class TaskJuggler
               true,  false,   true, nil ],
         [ 'start',     'Start',        DateAttribute,
               false, false,   true,  nil ],
-        [ 'startpreds', 'Start Preds.', TaskListAttribute,
+        [ 'startpreds', 'Start Preds.', TaskDepListAttribute,
               false, false,   true,  [] ],
-        [ 'startsuccs', 'Start Succs.', TaskListAttribute,
+        [ 'startsuccs', 'Start Succs.', TaskDepListAttribute,
               false, false,   true,  [] ],
         [ 'status',    'Task Status',  StringAttribute,
               false, false,   true,  "" ],
@@ -293,7 +291,7 @@ class TaskJuggler
               false, false,   false, "" ],
         [ 'warn',      'Warning Condition', LogicalExpressionListAttribute,
               false, false,   false, [] ],
-        [ 'wbs',       'WBS',          StringAttribute,
+        [ 'bsi',       'BSI',          StringAttribute,
               false, false,   false, "" ]
       ]
       attrs.each { |a| @tasks.addAttributeType(AttributeDefinition.new(*a)) }
@@ -330,6 +328,8 @@ class TaskJuggler
               true,  false,   false, nil ],
         [ 'headline',  'Headline',     RichTextAttribute,
               true, false,   false, nil ],
+        [ 'hideJournalEntry', 'Hide JournalEntry', LogicalExpressionAttribute,
+              true,  false,   false, nil ],
         [ 'hideResource', 'Hide Resource', LogicalExpressionAttribute,
               true,  false,   false, nil ],
         [ 'hideTask',  'Hide Task',    LogicalExpressionAttribute,
@@ -390,7 +390,7 @@ class TaskJuggler
               true, false,   false, nil ],
         [ 'tree',      'Tree Index',   StringAttribute,
               false, false,   false, "" ],
-        [ 'wbs',       'WBS',          StringAttribute,
+        [ 'bsi',       'BSI',          StringAttribute,
               false, false,   false, "" ],
         [ 'weekStartsMonday', 'Week Starts Monday', BooleanAttribute,
               true,  true,    false, false ]
@@ -606,7 +606,7 @@ class TaskJuggler
 
       @scenarios.each do |sc|
         # Skip disabled scenarios
-        next unless sc.get('enabled')
+        next unless sc.get('active')
 
         scIdx = scenarioIdx(sc)
 
@@ -914,6 +914,63 @@ class TaskJuggler
       name
     end
 
+    def journal(query)
+      entries = JournalEntryList.new
+      @tasks.each do |task|
+        # We only care about top-level tasks.
+        next if task.parent
+
+        entries += (e = @attributes['journal'].
+          currentEntriesR(query.end, task, 0, query.start,
+                          query.hideJournalEntry))
+      end
+
+      # Eliminate duplicates due to entries from adopted tasks
+      entries.uniq!
+
+      journalMessages(entries, query, true)
+    end
+
+    # Create a blog-style list of all alert messages that match the Query.
+    def journalMessages(entries, query, longVersion)
+      # The components of the message are either UTF-8 text or RichText. For
+      # the RichText components, we use the originally provided markup since
+      # we compose the result as RichText markup first.
+      rText = ''
+      entries.each do |entry|
+        rText += "==== <nowiki>" + entry.headline + "</nowiki> ====\n"
+        #rText += "''Reported on #{entry.date.to_s(query.timeFormat)}'' "
+        #if entry.author
+        #  rText += "''by <nowiki>#{entry.author.name}</nowiki>''"
+        #end
+        #rText += "\n\n"
+        #unless entry.flags.empty?
+        #  rText += "''Flags:'' #{entry.flags.join(', ')}\n\n"
+        #end
+        if entry.summary
+          rText += entry.summary.richText.inputText + "\n\n"
+        end
+        if longVersion && entry.details
+          rText += entry.details.richText.inputText + "\n\n"
+        end
+      end
+      # Now convert the RichText markup String into RichTextIntermediate
+      # format.
+      unless (rti = RichText.new(rText, RTFHandlers.create(self),
+                                 @messageHandler).
+                                 generateIntermediateFormat)
+        @messageHandler.warning('ptn_journal',
+                                "Syntax error in journal message")
+        return nil
+      end
+      # No section numbers, please!
+      rti.sectionNumbers = false
+      # We use a special class to allow CSS formating.
+      rti.cssClass = 'tj_journal'
+      query.rti = rti
+    end
+
+
     # Print the attribute values. It's used for debugging only.
     def to_s
       #raise "STOP!"

data/lib/taskjuggler/ProjectFileParser.rb

@@ -273,7 +273,7 @@ class TaskJuggler
         if attribute == attr
           @property[attr, @scenarioIdx] = value
         else
-          if @property.getAttr(attr, @scenarioIdx).provided
+          if @property.getAttribute(attr, @scenarioIdx).provided
             error('multiple_durations',
                   "This duration criteria is overwriting a previously " +
                   "provided criteria (duration, effort, length or milestone).")

data/lib/taskjuggler/ProjectFileScanner.rb

@@ -71,6 +71,10 @@ class TaskJuggler
         # neither the start nor the end of the macro.
         [ nil, /.*\n/, :macroCall, method('midMacroCall') ],
 
+        # Environment variable reference. This is similar to the macro call,
+        # but the it can only extend within the starting line.
+        [ nil, /([-a-zA-Z_0-9>:.+]*|"(\\"|[^"])*?|'(\\'|[^'])*?)?\$\([A-Z_][A-Z_0-9]*\)/,
+          :tjp, method('environmentVariable') ],
         # An ID with a colon suffix: foo:
         [ :ID_WITH_COLON, /[a-zA-Z_]\w*:/, :tjp, method('chop') ],
 
@@ -291,6 +295,29 @@ class TaskJuggler
       [ :STRING, @string ]
     end
 
+    def environmentVariable(type, match)
+      # Store any characters that precede the $( in prefix and remove it from
+      # @macroCall.
+      if (start = match.index('$(')) > 0
+        prefix = match[0..(start - 1)]
+        envRef = match[start..-1]
+      else
+        prefix = ''
+        envRef = match
+      end
+
+      # Remove '$(' and ')'
+      varName = envRef[2..-2]
+
+      if (value = ENV[varName])
+        @cf.injectText(prefix + value)
+      else
+        error('unknown_env_var', "Unknown environment variable '#{varName}'")
+      end
+
+      [ nil, '' ]
+    end
+
     def startMacroDef(type, match)
       self.mode = :macroDef
       # Remove the opening '['

data/lib/taskjuggler/PropertySet.rb

@@ -38,29 +38,21 @@ class TaskJuggler
       @flatNamespace = flatNamespace
       # The main Project data structure reference.
       @project = project
-      # This is the blueprint for PropertyTreeNode attribute sets. Whever a new
-      # PropertTreeNode is created, an attribute is created for each definition
-      # in this list.
-      @attributeDefinitions = Hash.new
       # A list of all PropertyTreeNodes in this set.
       @properties = Array.new
       # A hash of all PropertyTreeNodes in this set, hashed by their ID. This is
       # the same data as in @properties, but hashed by ID for faster access.
       @propertyMap = Hash.new
 
-      # IDs and names of the built-in attributes. TODO: Check performance impact
-      # when making them normal attributes.
-      @@fixedAttributeNames = {
-        'id' => 'ID',
-        'name' => 'Name',
-        'seqno' => 'Seq. No.'
-      }
-      # And their types.
-      @@fixedAttributesTypes = {
-        'id' => :String,
-        'name' => :String,
-        'seqno' => :Fixnum
-      }
+      # This is the blueprint for PropertyTreeNode attribute sets. Whever a new
+      # PropertTreeNode is created, an attribute is created for each definition
+      # in this list.
+      @attributeDefinitions = Hash.new
+      [
+        [ 'id',   'ID',       StringAttribute, false,  false,  false,  '' ],
+        [ 'name', 'Name',     StringAttribute, false,  false,  false,  '' ],
+        [ 'seqno', 'Seq. No', FixnumAttribute, false,  false,  false,  0 ]
+      ].each { |a| addAttributeType(AttributeDefinition.new(*a)) }
     end
 
     # Use the function to declare the various attributes that properties of this
@@ -84,7 +76,6 @@ class TaskJuggler
 
     # Return true if there is an AttributeDefinition for _attrId_.
     def knownAttribute?(attrId)
-      @@fixedAttributeNames.include?(attrId) ||
       @attributeDefinitions.include?(attrId)
     end
 
@@ -160,12 +151,8 @@ class TaskJuggler
     def attributeName(attrId)
       # Some attributes are hardwired into the properties. These need to be
       # treated separately.
-      if @@fixedAttributeNames[attrId].nil?
-        if @attributeDefinitions.include?(attrId)
-          return @attributeDefinitions[attrId].name
-        end
-      else
-        return @@fixedAttributeNames[attrId]
+      if @attributeDefinitions.include?(attrId)
+        return @attributeDefinitions[attrId].name
       end
 
       nil
@@ -174,14 +161,10 @@ class TaskJuggler
     # Return the type of the attribute with the Id specified by _attrId_.
     def attributeType(attrId)
       # Hardwired attributes need special treatment.
-      if @@fixedAttributesTypes[attrId].nil?
-        if @attributeDefinitions.has_key?(attrId)
-          @attributeDefinitions[attrId].objClass
-        else
-          nil
-        end
+      if @attributeDefinitions.has_key?(attrId)
+        @attributeDefinitions[attrId].objClass
       else
-        @@fixedAttributesTypes[attrId]
+        nil
       end
     end
 
@@ -189,16 +172,10 @@ class TaskJuggler
     # indexed by ID. In case an object with the same ID already exists in the
     # set it will be overwritten.
     #
-    # Whenever the set has been extended, the 'wbs' and 'tree' attributes of the
+    # Whenever the set has been extended, the 'bsi' and 'tree' attributes of the
     # properties are no longer up-to-date. You must call index() before using
     # these attributes.
     def addProperty(property)
-      # The PropertySet defines the set of attribute that each PropertyTreeNode
-      # in this set has. Create these attributes with their default values.
-      @attributeDefinitions.each_value do |attributeType|
-        property.declareAttribute(attributeType)
-      end
-
       # The PropertyTreeNode objects are indexed by ID or hierachical ID
       # depending on the name space setting of this set.
       if @flatNamespace
@@ -247,22 +224,22 @@ class TaskJuggler
       @propertyMap[id]
     end
 
-    # Update the work-breakdown-structure (wbs) indicies. This method needs to
+    # Update the breakdown structure indicies (bsi). This method needs to
     # be called whenever the set has been modified.
     def index
       each do |p|
-        wbsIdcs = p.getWBSIndicies
-        wbs = ""
+        bsIdcs = p.getBSIndicies
+        bsi = ""
         first = true
-        wbsIdcs.each do |idx|
+        bsIdcs.each do |idx|
           if first
             first = false
           else
-            wbs += '.'
+            bsi += '.'
           end
-          wbs += idx.to_s
+          bsi += idx.to_s
         end
-        p.set('wbs', wbs)
+        p.set('bsi', bsi)
       end
     end