taskjuggler 0.0.10 → 0.0.11

data/lib/{ProjectFileParser.rb → taskjuggler/ProjectFileParser.rb}

@@ -11,11 +11,11 @@
 # published by the Free Software Foundation.
 #
 
-require 'TextParser'
-require 'ProjectFileScanner'
-require 'TjpSyntaxRules'
-require 'RichText'
-require 'RTFHandlers'
+require 'taskjuggler/TextParser'
+require 'taskjuggler/ProjectFileScanner'
+require 'taskjuggler/TjpSyntaxRules'
+require 'taskjuggler/RichText'
+require 'taskjuggler/RichText/RTFHandlers'
 
 class TaskJuggler
 
@@ -220,9 +220,8 @@ class TaskJuggler
         rText.messageHandler.messages.each do |msg|
           # Map the SourceFileInfo of the RichText back to the original
           # location in the input file.
-          sfi = SourceFileInfo.new(sfi.fileName,
-                                   sfi.lineNo + msg.sourceFileInfo.lineNo - 1,
-                                   0)
+          sfi = TextParser::SourceFileInfo.new(
+            sfi.fileName, sfi.lineNo + msg.sourceFileInfo.lineNo - 1, 0)
           # Then replay the error message.
           @messageHandler.addMessage(msg.type, msg.id, msg.message, sfi,
                                      msg.line)
@@ -254,7 +253,6 @@ class TaskJuggler
       @property
     end
 
-
     # If the @limitResources list is not empty, we have to create a Limits
     # object for each Resource. Otherwise, one Limits object is enough.
     def setLimit(name, value, interval)
@@ -267,6 +265,24 @@ class TaskJuggler
       end
     end
 
+    # Set the _attribute_ to _value_ and reset all other duration attributes.
+    def setDurationAttribute(attribute, value = true)
+      checkContainer(attribute)
+      { 'milestone' => false, 'duration' => 0,
+        'length' => 0, 'effort' => 0 }.each do |attr, val|
+        if attribute == attr
+          @property[attr, @scenarioIdx] = value
+        else
+          if @property.getAttr(attr, @scenarioIdx).provided
+            error('multiple_durations',
+                  "This duration criteria is overwriting a previously " +
+                  "provided criteria (duration, effort, length or milestone).")
+          end
+          @property[attr, @scenarioIdx] = val
+        end
+      end
+    end
+
     # The following functions are mostly conveniance functions to simplify the
     # syntax tree definition. The *Rule functions may only be used in _rule
     # functions. And only one function call per _rule function is allowed.

data/lib/{ProjectFileScanner.rb → taskjuggler/ProjectFileScanner.rb}

@@ -11,13 +11,13 @@
 # published by the Free Software Foundation.
 #
 
-require 'TextScanner'
+require 'taskjuggler/TextParser/Scanner'
 
 class TaskJuggler
 
-  # This class specializes the TextScanner class to detect the tokens of the
-  # TJP syntax.
-  class ProjectFileScanner < TextScanner
+  # This class specializes the TextParser::Scanner class to detect the tokens
+  # of the TJP syntax.
+  class ProjectFileScanner < TextParser::Scanner
 
     def initialize(masterFile, messageHandler)
       tokenPatterns = [
@@ -146,7 +146,7 @@ class TaskJuggler
         [ :LITERAL, /./ ]
       ]
 
-      super(masterFile, messageHandler, tokenPatterns, :tjp)
+      super(masterFile, messageHandler, Log, tokenPatterns, :tjp)
     end
 
     private

data/lib/{PropertySet.rb → taskjuggler/PropertySet.rb}

@@ -11,9 +11,8 @@
 # published by the Free Software Foundation.
 #
 
-
-require 'AttributeDefinition'
-require 'PropertyTreeNode'
+require 'taskjuggler/AttributeDefinition'
+require 'taskjuggler/PropertyTreeNode'
 
 class TaskJuggler
 
@@ -78,7 +77,7 @@ class TaskJuggler
 
     # Iterate over all attribute definitions.
     def eachAttributeDefinition
-      @attributeDefinitions.each do |key, value|
+      @attributeDefinitions.sort.each do |key, value|
         yield(value)
       end
     end

data/lib/{PropertyTreeNode.rb → taskjuggler/PropertyTreeNode.rb}

@@ -28,7 +28,7 @@ class TaskJuggler
   class PropertyTreeNode
 
     attr_reader :propertySet, :id, :parent, :project, :sequenceNo,
-                :children
+                :children, :adoptees
     attr_accessor :name, :sourceFileInfo
     attr_reader :data
 
@@ -72,12 +72,18 @@ class TaskJuggler
 
       @parent = parent
       @sequenceNo = @propertySet.items + 1
-      @children = Array.new
+      # This is a list of the real sub nodes of this PropertyTreeNode.
+      @children = []
+      # This is a list of the adopted sub nodes of this PropertyTreeNode.
+      @adoptees = []
       # In case we have a parent object, we register this object as child of
       # the parent.
       if (@parent)
         @parent.addChild(self)
       end
+      # This is a list of the PropertyTreeNode objects that have adopted this
+      # node.
+      @stepParents = []
 
       @attributes = Hash.new
       @scenarioAttributes = Array.new(@project.scenarioCount)
@@ -94,6 +100,61 @@ class TaskJuggler
       self
     end
 
+    # Adopt _property_ as a step child. Also register the new relationship
+    # with the child.
+    def adopt(property)
+      return if @adoptees.include?(property)
+
+      # The adopted node and the adopting node must not have any common
+      # ancestors.
+      if root == property.root
+        error('adopt_common_root',
+              "The adoptee #{property.fullId} and the parent #{fullId} " +
+              "may not share common ancestors.")
+      end
+
+      # The adopted trees for this node must not overlap.
+      @adoptees.each do |adoptee|
+        # Check if the to be adopted node is an ancestor of an already adopted
+        # node.
+        if adoptee.ancestors.include?(property)
+          error('adopt_duplicate_child',
+                "The child #{adoptee.fullId} of #{property.fullId} " +
+                "has already been adopted by #{fullId}.")
+        end
+        # Check if the already adopted nodes are an ancestor of the to be
+        # adopted node.
+        if property.ancestors.include?(adoptee)
+          error('adopt_duplicate_parent',
+                "The parent #{adoptee.fullId} of #{property.fullId} " +
+                "has already been adopted by #{fullId}.")
+        end
+      end
+
+      @adoptees << property
+      property.getAdopted(self)
+    end
+
+    # Get adopted by _property_. Also register the new relationship with the
+    # step parent. This method is for internal use only. Other classes should
+    # alway use PropertyTreeNode::adopt().
+    def getAdopted(property) # :nodoc:
+      return if @stepParents.include?(property)
+
+      @stepParents << property
+      property.adopt(self)
+    end
+
+    # Return a list of all children including adopted kids.
+    def kids
+      @children + @adoptees
+    end
+
+    # Return a list of all parents including step parents.
+    def parents
+      (@parent ? [ @parent ] : []) + @stepParents
+    end
+
     # This method creates a shallow copy of all attributes and returns them as
     # an Array that can be used with restoreAttributes().
     def backupAttributes
@@ -270,12 +331,22 @@ class TaskJuggler
 
     # Return true if the node is a leaf node (has no children).
     def leaf?
-      @children.empty?
+      @children.empty? && @adoptees.empty?
     end
 
     # Return true if the node has children.
     def container?
-      !@children.empty?
+      !@children.empty? || !@adoptees.empty?
+    end
+
+    # Return a list with all parent nodes of this node.
+    def ancestors
+      nodes = []
+      n = self
+      while n.parent
+        nodes << (n = n.parent)
+      end
+      nodes
     end
 
     # Return the top-level node for this node.
@@ -379,19 +450,26 @@ class TaskJuggler
         if AttributeBase.mode == 0
           # If we get values in 'provided' mode, we copy them immedidately to
           # all derived scenarios.
+          overwrite = false
           @project.scenario(scenario).all.each do |sc|
             scenarioIdx = @project.scenarioIdx(sc)
-            overwrite = @scenarioAttributes[scenarioIdx][attributeId].provided
+
+            if @scenarioAttributes[scenarioIdx][attributeId].provided
+              overwrite = true
+            end
+
             if scenarioIdx == scenario
               @scenarioAttributes[scenarioIdx][attributeId].set(value)
             else
               @scenarioAttributes[scenarioIdx][attributeId].inherit(value)
             end
-            if overwrite
-              raise AttributeOverwrite,
-                "Overwriting a previously provided value for attribute " +
-                "#{attributeId}"
-            end
+          end
+          # We only raise the overwrite error after all scenarios have been
+          # set. For some attributes the overwrite is actually allowed.
+          if overwrite
+            raise AttributeOverwrite,
+              "Overwriting a previously provided value for attribute " +
+              "#{attributeId}"
           end
         else
           @scenarioAttributes[scenario][attributeId].set(value)
@@ -449,11 +527,66 @@ class TaskJuggler
       end
     end
 
+    def checkFailsAndWarnings
+      if @attributes['fail'] || @attributes['warn']
+        propertyType = case self
+                       when Task
+                         'task'
+                       when Resource
+                         'resource'
+                       else
+                         'unknown'
+                       end
+        queryAttrs = { 'project' => @project,
+                       'property' => self,
+                       'scopeProperty' => nil,
+                       'start' => @project['start'],
+                       'end' => @project['end'],
+                       'loadUnit' => :days,
+                       'numberFormat' => @project['numberFormat'],
+                       'timeFormat' => @project['timeFormat'],
+                       'currencyFormat' => @project['currencyFormat'] }
+        query = Query.new(queryAttrs)
+        if @attributes['fail']
+          @attributes['fail'].get.each do |expr|
+            if expr.eval(query)
+              error("#{propertyType}_fail_check",
+                    "User defined check failed for #{propertyType} " +
+                    "#{fullId} \n" +
+                    "Condition: #{expr.to_s}\n" +
+              "Result:    #{expr.to_s(query)}")
+            end
+          end
+        end
+        if @attributes['warn']
+          @attributes['warn'].get.each do |expr|
+            if expr.eval(query)
+              warning("#{propertyType}_warn_check",
+                      "User defined warning triggered for #{propertyType} " +
+                      "#{fullId} \n" +
+                      "Condition: #{expr.to_s}\n" +
+              "Result:    #{expr.to_s(query)}")
+            end
+          end
+        end
+      end
+    end
+
     def query_alert(query)
       journal = @project['journal']
       query.sortable = query.numerical = alert =
         journal.alertLevel(query.end, self)
-      query.string = @project.alertLevelName(alert)
+      query.string = colorName = @project.alertLevelName(alert)
+      rText = "<fcol:#{colorName.downcase}>#{colorName}</fcol>"
+      unless (rti = RichText.new(rText, RTFHandlers.create(@project),
+                                 @project.messageHandler).
+                                 generateIntermediateFormat)
+        @project.messageHandler.warning('ptn_journal',
+                                        "Syntax error in journal message")
+        return nil
+      end
+      rti.blockMode = false
+      query.rti = rti
     end
 
     def query_alertmessages(query)
@@ -539,6 +672,19 @@ class TaskJuggler
       @data[scenarioIdx].method(func).call(*args)
     end
 
+    def error(id, text)
+      @project.messageHandler.error(id, text, sourceFileInfo, nil, self, nil)
+    end
+
+    def warning(id, text)
+      @project.messageHandler.warning(id, text, sourceFileInfo, nil, self, nil)
+    end
+
+    def info(id, text)
+      @project.messageHandler.info(id, text, sourceFileInfo, nil, self, nil)
+    end
+
+
   private
 
     # Create a blog-style list of all alert messages that match the Query.

data/lib/{Query.rb → taskjuggler/Query.rb}

@@ -11,7 +11,7 @@
 # published by the Free Software Foundation.
 #
 
-require 'TjException'
+require 'taskjuggler/TjException'
 
 class TaskJuggler
 
@@ -68,7 +68,7 @@ class TaskJuggler
     def start=(date)
       if date.is_a?(TjTime)
         @start = date
-        @startIdx = @project.dateToIdx(date, true)
+        @startIdx = @project.dateToIdx(date)
       else
         raise "Unsupported type #{date.class}"
       end
@@ -86,7 +86,7 @@ class TaskJuggler
     def end=(date)
       if date.is_a?(TjTime)
         @end = date
-        @endIdx = @project.dateToIdx(date, true)
+        @endIdx = @project.dateToIdx(date)
       else
         raise "Unsupported type #{date.class}"
       end
@@ -112,6 +112,10 @@ class TaskJuggler
         # Resolve property reference from property ID.
         if @property.nil? && !@propertyId.nil?
           @property = resolvePropertyId(@propertyType, @propertyId)
+          unless @property
+            @errorMessage = "Unknown property #{@propertyId} queried"
+            return @ok = false
+          end
         end
 
         unless @property
@@ -119,8 +123,8 @@ class TaskJuggler
           supportedAttrs = %w( copyright currency end name now projectid
                                start version )
           unless supportedAttrs.include?(@attributeId)
-            raise TjException.new,
-                  "Unsupported project attribute '#{@attributeId}'"
+            @errorMessage = "Unsupported project attribute '#{@attributeId}'"
+            return @ok = false
           end
           attr = @project[@attributeId]
           if attr.is_a?(TjTime)
@@ -136,6 +140,10 @@ class TaskJuggler
         if !@scopeProperty.nil? && !@scopePropertyId.nil?
           @scopeProperty = resolvePropertyId(@scopePropertyType,
                                              @scopePropertyId)
+          unless @scopeProperty
+            @errorMessage = "Unknown scope property #{@scopePropertyId} queried"
+            return @ok = false
+          end
         end
         # Make sure the have a reference to the project.
         @project = @property.project unless @project
@@ -208,6 +216,8 @@ class TaskJuggler
 
     # Return the result as RichTextIntermediate object. The result may be nil.
     def to_rti
+      return @attr.value if @attr.is_a?(RichTextAttribute)
+
       @attr ? @attr.to_rti(self) : @rti
     end
 
@@ -219,10 +229,10 @@ class TaskJuggler
         else
           @attr.value
         end
-      elsif @rti
-        @rti
       elsif @numerical
         @numerical
+      elsif @rti
+        @rti
       else
         @string
       end

data/lib/{Resource.rb → taskjuggler/Resource.rb}

@@ -11,9 +11,8 @@
 # published by the Free Software Foundation.
 #
 
-
-require 'PropertyTreeNode'
-require 'ResourceScenario'
+require 'taskjuggler/PropertyTreeNode'
+require 'taskjuggler/ResourceScenario'
 
 class TaskJuggler
 
@@ -65,7 +64,8 @@ class TaskJuggler
         levelList = listByLevel[level]
         levelRecord = @project['alertLevels'][level]
         if query.selfContained
-          alertName = "<nowiki>[#{levelRecord[1]}]</nowiki>"
+          alertName = "<nowiki>[</nowiki><fcol:#{levelRecord[0]}>" +
+                      "#{levelRecord[1]}</fcol><nowiki>]</nowiki>"
         else
           alertName = "[[File:icons/flag-#{levelRecord[0]}.png|" +
           "alt=[#{levelRecord[1]}]|text-bottom]]"
@@ -164,8 +164,10 @@ class TaskJuggler
         rText = ''
 
         taskList.each do |task|
-          rText += "=== <nowiki>[#{task.query_alert(query)}] Task: " +
-            "#{task.name}</nowiki> (#{task.fullId}) ===\n\n"
+          rText += "=== <nowiki>[</nowiki>" +
+                   "#{task.query_alert(query).richText.inputText}" +
+                   "<nowiki>] Task: #{task.name}</nowiki> " +
+                   "(#{task.fullId}) ===\n\n"
           rText += task.query_journalmessages(query).richText.inputText + "\n\n"
         end
       end