taskjuggler 0.0.3 → 0.0.4

data/lib/KeywordArray.rb

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

@@ -3,7 +3,7 @@
 #
 # = KeywordDocumentation.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
@@ -325,7 +325,8 @@ class TaskJuggler
               tr1 << (td = XMLElement.new('td', 'width' => '30%'))
               td << XMLText.new("#{arg.name} [")
               td << XMLNamedText.new(
-                typeName, 'a', 'href' => "Getting_Started.html\##{typeName}")
+                typeName, 'a', 'href' =>
+                               "The_TaskJuggler_Syntax.html\##{typeName}")
               td << XMLText.new(']')
             end
             tr1 << (td = XMLElement.new('td',
@@ -563,13 +564,14 @@ class TaskJuggler
     def newRichText(text)
       begin
         rText = RichText.new(text)
-        @references += rText.internalReferences
+        rti = rText.generateIntermediateFormat
+        @references += rti.internalReferences
       rescue RichTextException => msg
         $stderr.puts "Error in RichText of rule #{@keyword}\n" +
                      "Line #{msg.lineNo}: #{msg.text}\n" +
                      "#{msg.line}"
       end
-      rText
+      rti
     end
 
     # Utility function to turn a list of keywords into a comma separated list

data/lib/Limits.rb

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

@@ -3,7 +3,7 @@
 #
 # = Log.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
@@ -101,6 +101,13 @@ class TaskJuggler
       end
     end
 
+    # Print out a status message unless we are in silent mode.
+    def Log.status(message)
+      return if @@silent
+
+      $stdout.puts message
+    end
+
     # The progress meter can be a textual progress bar or some animated
     # character sequence that informs the user about ongoing activities. Call
     # this function to start the progress meter display or to change the info

data/lib/LogicalExpression.rb

@@ -3,7 +3,7 @@
 #
 # = LogicalExpression.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
@@ -21,7 +21,7 @@ class TaskJuggler
   # objects and the context that it should be evaluated in.
   class LogicalExpression
 
-    attr_reader :property, :sourceFileInfo
+    attr_reader :query, :sourceFileInfo
 
     # Create a new LogicalExpression object. _op_ must be a LogicalOperation.
     # _sourceFileInfo_ is the file position where expression started. It may be
@@ -30,17 +30,23 @@ class TaskJuggler
       @operation = op
       @sourceFileInfo = sourceFileInfo
 
-      @property = @scopeProperty = nil
+      @query = nil
+    end
+
+    # Switch the scopeProperty to property. We need this for the scopeProperty
+    # operating functions. The @scopeProperty is set to nil.
+    def flipProperties
+      @query.property, @query.scopeProperty = @query.scopeProperty, nil
     end
 
     # This function triggers the evaluation of the expression. _property_ is the
     # PropertyTreeNode that should be used for the evaluation. _scopeProperty_
     # is the PropertyTreeNode that describes the scope. It may be nil.
-    def eval(property, scopeProperty)
-      @property = property
-      @scopeProperty = scopeProperty
+    def eval(query)
+      @query = query
       res = @operation.eval(self)
-      return res if res.class == TrueClass || res.class == FalseClass
+      return res if res.class == TrueClass || res.class == FalseClass ||
+                    res.class == String
       # In TJP syntax 'non 0' means false.
       return res != 0
     end
@@ -57,12 +63,7 @@ class TaskJuggler
     # This is an internal function. It's called by the LogicalOperation methods
     # in case something went wrong during an evaluation.
     def error(text) # :nodoc:
-      if @sourceFileInfo.nil?
-        str = "Logical expression error: " + text
-      else
-        str = "#{@sourceFileInfo} Logical expression error: #{text}\n"
-      end
-      raise TjException.new, str
+      raise TjException.new, "#{to_s}\nLogical expression error: #{text}"
     end
 
   end

data/lib/LogicalFunction.rb

@@ -3,7 +3,7 @@
 #
 # = LogicalFunction.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
@@ -23,16 +23,26 @@ class TaskJuggler
     # A map with the names of the supported functions and the number of
     # arguments they require.
     @@functions = {
+        'hasalert' => 1,
+        'isactive' => 1,
+        'isdependencyof' => 3,
         'isdutyof' => 2,
         'isleaf' => 0,
-        'isresource' => 1,
-        'isoncriticalpath' => 1,
+        'isongoing' => 1,
+        'isresource' => 0,
+        'istask' => 0,
         'treelevel' => 0
     }
 
     # Create a new LogicalFunction. _opnd_ is the name of the function.
     def initialize(opnd)
-      @name = opnd
+      if opnd[-1] == ?_
+        @name = opnd[0..-2]
+        @invertProperties = true
+      else
+        @name = opnd
+        @invertProperties = false
+      end
       @arguments = []
     end
 
@@ -56,8 +66,13 @@ class TaskJuggler
     # Evaluate the function by calling it with the arguments.
     def eval(expr)
       args = []
+      if @invertProperties
+        return true unless expr.query.scopeProperty
+        expr = expr.dup
+        expr.flipProperties
+      end
       # Call the function and return the result.
-      send(@name, expr, @arguments)
+      send(name, expr, @arguments)
     end
 
     # Return a textual expression of the function call.
@@ -67,33 +82,92 @@ class TaskJuggler
 
   private
 
+    def hasalert(expr, args)
+      query = expr.query
+      property = query.property
+      project = property.project
+      date = project.reportContext.report.get('end')
+      !project['journal'].currentEntries(query.end, property,
+                                         args[0], query.start).empty?
+    end
+
+    def isactive(expr, args)
+      # The result can only be true when called for a Task property.
+      return false unless (property = expr.query.property).is_a?(Task) ||
+                           property.is_a?(Resource)
+      scopeProperty = expr.query.scopeProperty
+      project = property.project
+      # 1st arg must be a scenario index.
+      if (scenarioIdx = project.scenarioIdx(args[0])).nil?
+        expr.error("Unknown scenario '#{args[0]}' used for function isactive()")
+      end
+
+      property.getAllocatedTime(scenarioIdx,
+                                project.reportContext.report.get('start'),
+                                project.reportContext.report.get('end'),
+                                scopeProperty) > 0.0
+    end
+
+    def isdependencyof(expr, args)
+      # The result can only be true when called for a Task property.
+      return false unless expr.query.property.is_a?(Task)
+      project = expr.query.property.project
+      # 1st arg must be a task ID.
+      return false if (task = project.task(args[0])).nil?
+      # 2nd arg must be a scenario index.
+      return false if (scenarioIdx = project.scenarioIdx(args[1])).nil?
+      # 3rd arg must be an integer number.
+      return false unless args[2].is_a?(Fixnum)
+
+      expr.query.property.isDependencyOf(scenarioIdx, task, args[2])
+    end
+
     def isdutyof(expr, args)
       # The result can only be true when called for a Task property.
-      return false unless expr.property.is_a?(Task)
-      project = expr.property.project
+      return false unless (task = expr.query.property).is_a?(Task)
+      project = task.project
       # 1st arg must be a resource ID.
       return false if (resource = project.resource(args[0])).nil?
       # 2nd arg must be a scenario index.
       return false if (scenarioIdx = project.scenarioIdx(args[1])).nil?
 
-      expr.property['assignedresources', scenarioIdx].include?(resource)
+      task['assignedresources', scenarioIdx].include?(resource)
     end
 
     def isleaf(expr, args)
-      expr.property.leaf?
+      expr.query.property.leaf?
+    end
+
+    def isongoing(expr, args)
+      # The result can only be true when called for a Task property.
+      return false unless (task = expr.query.property).is_a?(Task)
+      project = task.project
+      # 1st arg must be a scenario index.
+      if (scenarioIdx = project.scenarioIdx(args[0])).nil?
+        expr.error("Unknown scenario '#{args[0]}' used for function isongoing()")
+      end
+
+      iv1 = Interval.new(project.reportContext.report.get('start'),
+                         project.reportContext.report.get('end'))
+      tStart = task['start', scenarioIdx]
+      tEnd = task['end', scenarioIdx]
+      # This helps to show tasks with scheduling errors.
+      return true unless tStart && tEnd
+      iv2 = Interval.new(tStart, tEnd)
+
+      return iv1.overlaps?(iv2)
     end
 
     def isresource(expr, args)
-      expr.property.is_a?(Resource) && expr.property.fullId == args[0]
+      expr.query.property.is_a?(Resource)
     end
 
-    def isoncricitalpath(expr, args)
-      # TODO
-      false
+    def istask(expr, args)
+      expr.query.property.is_a?(Task)
     end
 
     def treelevel(expr, args)
-      expr.property.level + 1
+      expr.query.property.level + 1
     end
 
   end

data/lib/LogicalOperation.rb

@@ -3,7 +3,7 @@
 #
 # = LogicalOperation.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
@@ -39,81 +39,134 @@ class TaskJuggler
     # LogicalExpression. The result must be of a type that responds to all the
     # operators of this function.
     def eval(expr)
-      begin
-        case @operator
-        when nil
-          if @operand1.respond_to?(:eval)
-            # An operand can be a fixed value or another term. This could be a
-            # LogicalOperation, LogicalFunction or anything else that provides
-            # an appropriate eval() method.
-            return @operand1.eval(expr)
-          else
-            return @operand1
+      case @operator
+      when nil
+        if @operand1.respond_to?(:eval)
+          # An operand can be a fixed value or another term. This could be a
+          # LogicalOperation, LogicalFunction or anything else that provides
+          # an appropriate eval() method.
+          return @operand1.eval(expr)
+        else
+          return @operand1
+        end
+      when '~'
+        return !coerceBoolean(@operand1.eval(expr), expr)
+      when '>', '>=', '=', '<', '<=', '!='
+        # Evaluate the operation for all 2 operand operations that can be
+        # either interpreted as date, numbers or Strings.
+        opnd1 = @operand1.eval(expr)
+        opnd2 = @operand2.eval(expr)
+        if opnd1.is_a?(TjTime)
+          res= evalBinaryOperation(opnd1, operator, opnd2) do |o|
+            coerceTime(o, expr)
+          end
+          return res
+        elsif opnd1.is_a?(Fixnum) || opnd1.is_a?(Float) || opnd1.is_a?(Bignum)
+          return evalBinaryOperation(opnd1, operator, opnd2) do |o|
+            coerceNumber(o, expr)
+          end
+        elsif opnd1.is_a?(String)
+          return evalBinaryOperation(opnd1, operator, opnd2) do |o|
+            coerceString(o, expr)
           end
-        when '~'
-          return !coerceBoolean(@operand1.eval(expr))
-        when '>'
-          return coerceNumber(@operand1.eval(expr)) >
-                 coerceNumber(@operand2.eval(expr))
-        when '>='
-          return coerceNumber(@operand1.eval(expr)) >=
-                 coerceNumber(@operand2.eval(expr))
-        when '='
-          return coerceNumber(@operand1.eval(expr)) ==
-                 coerceNumber(@operand2.eval(expr))
-        when '<'
-          return coerceNumber(@operand1.eval(expr)) <
-                 coerceNumber(@operand2.eval(expr))
-        when '<='
-          return coerceNumber(@operand1.eval(expr)) <=
-                 coerceNumber(@operand2.eval(expr))
-        when '&'
-          return coerceBoolean(@operand1.eval(expr)) &&
-                 coerceBoolean(@operand2.eval(expr))
-        when '|'
-          return coerceBoolean(@operand1.eval(expr)) ||
-                 coerceBoolean(@operand2.eval(expr))
         else
-          raise TjException.new,
-                "Unknown operator #{@operator} in logical expression"
+          expr.error("First operand of a binary operation must be a date, " +
+                     "a number or a string: #{opnd1}")
         end
-      rescue TjException
-        expr.error "Can't evaluate #{to_s}"
+      when '&'
+        return coerceBoolean(@operand1.eval(expr), expr) &&
+               coerceBoolean(@operand2.eval(expr), expr)
+      when '|'
+        return coerceBoolean(@operand1.eval(expr), expr) ||
+               coerceBoolean(@operand2.eval(expr), expr)
+      else
+        expr.error("Unknown operator #{@operator} in logical expression")
       end
     end
 
     # Convert the operation into a textual representation. This function is used
     # for error reporting and debugging.
-    def to_s # :nodoc:
+    def to_s
       if @operator.nil?
-        @operand1.to_s
+        "#{@operand1.to_s}"
       elsif @operand2.nil?
-        "#{@operator}#{@operand1}"
+        "#{@operator}(#{@operand1.is_a?(String) ?
+                       "'" + @operand1 + "'" : @operand1})"
       else
-        "#{@operand1} #{@operator} #{@operand2}"
+        "(#{@operand1.is_a?(String) ? "'" + @operand1 + "'" :
+                                            @operand1} #{@operator} #{
+            @operand2.is_a?(String) ? "'" + @operand2 + "'" : @operand2})"
       end
     end
 
   private
 
+    # We need to do binary operator evaluation with various coerce functions.
+    # This function does the evaluation of _opnd1_ and _opnd2_ with the
+    # operation specified by _operator_. The operands are first coerced into
+    # the proper format by calling the block.
+    def evalBinaryOperation(opnd1, operator, opnd2)
+      case operator
+      when '>'
+        return yield(opnd1) > yield(opnd2)
+      when '>='
+        return yield(opnd1) >= yield(opnd2)
+      when '='
+        return yield(opnd1) == yield(opnd2)
+      when '<'
+        return yield(opnd1) < yield(opnd2)
+      when '<='
+        return yield(opnd1) <= yield(opnd2)
+      when '!='
+        return yield(opnd1) != yield(opnd2)
+      else
+        raise "Operator error"
+      end
+    end
+
     # Force the _val_ into a boolean value.
-    def coerceBoolean(val)
+    def coerceBoolean(val, expr)
+      # First the obvious ones.
       return val if val.class == TrueClass || val.class == FalseClass
+      # An empty String means false, else true.
+      return !val.empty if val.is_a?(String)
       # In TJP logic 'non 0' means false.
-      val != 0
+      return val != 0 if val.is_a?(Fixnum) || val.is_a?(Bignum)
+
+      expr.error("Operand #{val} can't be evaluated to true or false.")
     end
 
     # Force the _val_ into a number. In case this fails, an exception is raised.
-    def coerceNumber(val)
+    def coerceNumber(val, expr)
       unless val.is_a?(Fixnum) || val.is_a?(Float) || val.is_a?(Bignum)
-        raise TjException.new,
-          "Operand #{val} of type #{val.class} must be a number"
+        expr.error("Operand #{val} of type #{val.class} must be a number.")
+      end
+      val
+    end
+
+    # Force the _val_ into a String. In case this fails, an exception is raised.
+    def coerceString(val, expr)
+      unless val.respond_to?('to_s')
+        expr.error("Operand #{val} of type #{val.class} can't be converted " +
+                   "into a string")
+      end
+      val
+    end
+
+    # Force the _val_ into a String. In case this fails, an exception is raised.
+    def coerceTime(val, expr)
+      unless val.is_a?(TjTime)
+        expr.error("Operand #{val} of type #{val.class} can't be converted " +
+                   "into a date")
       end
       val
     end
 
   end
 
+  # This class handles operands that are property attributes. They are
+  # addressed by attribute ID and scenario index. The expression provides the
+  # property reference.
   class LogicalAttribute < LogicalOperation
 
     def initialize(attribute, scenario)
@@ -121,27 +174,45 @@ class TaskJuggler
       super
     end
 
-    def LogicalAttribute::tjpId
-      'logical'
+    # To evaluate a property attribute we use the Query mechanism to retrieve
+    # the value.
+    def eval(expr)
+      query = expr.query
+      project = query.property.project
+      report = project.reportContext.report
+      query.scenarioIdx = @scenarioIdx
+      query.attributeId = @operand1
+      query.process
+      # The logical expressions are mostly about comparing values. So we use
+      # the sortableResult of the Query. This creates some challenges for load
+      # values, as the user is not accustomed to the internal representation
+      # of those.
+      # Convert nil results into empty Strings if necessary
+      query.result || ''
     end
 
-    def eval(expr)
-      expr.property[@operand1, @scenarioIdx]
+    # Used for debugging and error reporting.
+    def to_s # :nodoc
+      "#{@scenarioIdx}.#{@operand1.to_s}"
     end
 
   end
 
+  # This class handles operands that represent flags. The operation evaluates
+  # to true if the property provided by the expression has the flag assigned.
   class LogicalFlag < LogicalOperation
 
     def initialize(opnd)
       super
     end
 
+    # Return true if the property has the flag assigned.
     def eval(expr)
-      expr.property['flags', 0].include?(@operand1)
+      expr.query.property['flags', 0].include?(@operand1)
     end
 
-    def to_s
+    # Used for debugging and error reporting.
+    def to_s # :nodoc:
       @operand1
     end