taskjuggler 0.0.4 → 0.0.5

data/lib/LogicalOperation.rb

@@ -84,23 +84,30 @@ class TaskJuggler
       end
     end
 
-    # Convert the operation into a textual representation. This function is used
-    # for error reporting and debugging.
-    def to_s
+    # Convert the operation into a textual representation.
+    def to_s(query)
       if @operator.nil?
-        "#{@operand1.to_s}"
+        operand_to_s(@operand1, query)
       elsif @operand2.nil?
-        "#{@operator}(#{@operand1.is_a?(String) ?
-                       "'" + @operand1 + "'" : @operand1})"
+        @operator + operand_to_s(@operand1, query)
       else
-        "(#{@operand1.is_a?(String) ? "'" + @operand1 + "'" :
-                                            @operand1} #{@operator} #{
-            @operand2.is_a?(String) ? "'" + @operand2 + "'" : @operand2})"
+        "(#{operand_to_s(@operand1, query)} #{@operator} " +
+        "#{operand_to_s(@operand2, query)})"
       end
     end
 
   private
 
+    def operand_to_s(operand, query)
+      if operand.is_a?(LogicalOperation)
+        operand.to_s(query)
+      elsif operand.is_a?(String)
+        "'#{operand}'"
+      else
+        operand.to_s
+      end
+    end
+
     # 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
@@ -129,7 +136,7 @@ class TaskJuggler
       # 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)
+      return !val.empty? if val.is_a?(String)
       # In TJP logic 'non 0' means false.
       return val != 0 if val.is_a?(Fixnum) || val.is_a?(Bignum)
 
@@ -178,8 +185,6 @@ class TaskJuggler
     # the value.
     def eval(expr)
       query = expr.query
-      project = query.property.project
-      report = project.reportContext.report
       query.scenarioIdx = @scenarioIdx
       query.attributeId = @operand1
       query.process
@@ -191,9 +196,15 @@ class TaskJuggler
       query.result || ''
     end
 
-    # Used for debugging and error reporting.
-    def to_s # :nodoc
-      "#{@scenarioIdx}.#{@operand1.to_s}"
+    # Dumps the LogicalOperation as String. If _query_ is nil, the variable
+    # names are shown, otherwise their values.
+    def to_s(query)
+      if query
+        query.process
+        query.to_s
+      else
+        "#{@scenarioIdx}.#{@operand1}"
+      end
     end
 
   end
@@ -211,9 +222,12 @@ class TaskJuggler
       expr.query.property['flags', 0].include?(@operand1)
     end
 
-    # Used for debugging and error reporting.
-    def to_s # :nodoc:
-      @operand1
+    def to_s(query)
+      if query
+        query.property['flags', 0].include(@operand1) ? 'true' : 'false'
+      else
+        @operand1
+      end
     end
 
   end

data/lib/Project.rb

@@ -10,6 +10,8 @@
 # published by the Free Software Foundation.
 #
 
+require 'TjException'
+require 'Message'
 require 'TjTime'
 require 'Booking'
 require 'PropertySet'
@@ -25,6 +27,7 @@ require 'Resource'
 require 'reports/Report'
 require 'ShiftAssignments'
 require 'WorkingHours'
+require 'TimeSheets'
 require 'ProjectFileParser'
 require 'BatchProcessor'
 require 'Journal'
@@ -46,8 +49,8 @@ class TaskJuggler
   class Project
 
     attr_reader :accounts, :shifts, :tasks, :resources, :scenarios,
-                :reports, :messageHandler
-    attr_accessor :reportContext, :outputDir
+                :timeSheets, :reports, :messageHandler
+    attr_accessor :reportContext, :outputDir, :warnTsDeltas
 
     # Create a project with the specified +id+, +name+ and +version+.
     # +messageHandler+ is a MessageHandler reference that is used to handle
@@ -166,12 +169,16 @@ class TaskJuggler
               false, false,   true,  0.0 ],
         [ 'duties',    'Duties',       TaskListAttribute,
               false, false,   true,  [] ],
+        [ 'directreports', 'Direct Reports', ResourceListAttribute,
+              false, false,   true,  [] ],
         [ 'efficiency','Efficiency',   FloatAttribute,
               true,  false,   true,  1.0 ],
         [ 'effort', 'Total Effort',    FixnumAttribute,
               false, false,   true,  0 ],
         [ 'email',     'Email',        StringAttribute,
-              true,  false,   false, nil ],
+              false,  false,   false, nil ],
+        [ 'fail',      'Failure Condition', LogicalExpressionAttribute,
+              false, false,   true,  nil ],
         [ 'flags',     'Flags',        FlagListAttribute,
               true,  false,   true,  [] ],
         [ 'fte',       'FTE',          FloatAttribute,
@@ -182,8 +189,12 @@ class TaskJuggler
               false, false,   false, -1 ],
         [ 'limits',    'Limits',       LimitsAttribute,
               true,  true,    true,  nil ],
+        [ 'managers', 'Managers',      ResourceListAttribute,
+              true,  false,   true,  [] ],
         [ 'rate',      'Rate',         FloatAttribute,
               true,  true,    true,  0.0 ],
+        [ 'reports', 'Reports', ResourceListAttribute,
+              false, false,   true,  [] ],
         [ 'shifts',    'Shifts',       ShiftAssignmentsAttribute,
               true, false,    true,  nil ],
         [ 'timezone',  'Time Zone',    StringAttribute,
@@ -192,6 +203,8 @@ class TaskJuggler
               false, false,   false, "" ],
         [ 'vacations',  'Vacations',   IntervalListAttribute,
               true,  true,    true,  [] ],
+        [ 'warn',      'Warning Condition', LogicalExpressionAttribute,
+              false, false,   true,  nil ],
         [ 'wbs',       'WBS',          StringAttribute,
               false, false,   false, "" ],
         [ 'workinghours', 'Working Hours', WorkingHoursAttribute,
@@ -229,6 +242,8 @@ class TaskJuggler
               false, false,   true,  [] ],
         [ 'endsuccs',  'End Succs.',   TaskListAttribute,
               false, false,   true,  [] ],
+        [ 'fail',      'Failure Condition', LogicalExpressionAttribute,
+              false, false,   true,  nil ],
         [ 'flags',     'Flags',        FlagListAttribute,
               true,  false,   true,  [] ],
         [ 'forward',   'Scheduling',   BooleanAttribute,
@@ -275,6 +290,8 @@ class TaskJuggler
               false, false,   true,  "" ],
         [ 'tree',      'Tree Index',   StringAttribute,
               false, false,   false, "" ],
+        [ 'warn',      'Warning Condition', LogicalExpressionAttribute,
+              false, false,   true,  nil ],
         [ 'wbs',       'WBS',          StringAttribute,
               false, false,   false, "" ]
       ]
@@ -373,9 +390,12 @@ class TaskJuggler
 
       Scenario.new(self, 'plan', 'Plan Scenario', nil)
 
+      @timeSheets = TimeSheets.new
+
       # This holds a reference to the ReportContext for each Thread.
       @reportContext = nil
       @outputDir = ''
+      @warnTsDeltas = false
     end
 
     # Overload the deep_clone function so that references to the project don't
@@ -465,6 +485,11 @@ class TaskJuggler
       @attributes['yearlyworkingdays'].to_f
     end
 
+    # Convert timeSlots to working days.
+    def slotsToDays(slots)
+      slots * @attributes['scheduleGranularity'] / (60 * 60 * dailyWorkingHours)
+    end
+
     # call-seq:
     #   scenario(index) -> Scenario
     #   scenario(id) -> Scenario
@@ -573,6 +598,7 @@ class TaskJuggler
         return false
       end
 
+      @timeSheets.warnOnDelta if @warnTsDeltas
       true
     end
 
@@ -619,17 +645,39 @@ class TaskJuggler
       true
     end
 
-    def generateReport(reportId)
-      unless (report = @reports[reportId])
-        error('unknown_report_id',
-              "Request to generate unknown report #{reportId}")
+    def generateReport(reportId, regExpMode)
+      reportList = regExpMode ? reportList = matchingReports(reportId) :
+                                [ reportId ]
+      reportList.each do |id|
+        unless (report = @reports[id])
+          error('unknown_report_id',
+                "Request to generate unknown report #{id}")
+        end
+        Log.startProgressMeter("Report #{report.name}")
+        @reportContext = ReportContext.new(self, report)
+        report.generate
+        Log.stopProgressMeter
       end
-      Log.startProgressMeter("Report #{report.name}")
-      @reportContext = ReportContext.new(self, report)
-      report.generate
-      Log.stopProgressMeter
     end
 
+    def listReports(reportId, regExpMode)
+      reportList = regExpMode ? reportList = matchingReports(reportId) :
+                                @reports[reportId] ? [ reportId ] : []
+      puts "No match for #{reportId}" if reportList.empty?
+      reportList.each do |id|
+        report = @reports[id]
+        formats = report.get('formats')
+        next if formats.empty?
+
+        puts sprintf("%-20s %-15s %s", id, formats.join(', '), report.name)
+      end
+    end
+
+    def checkTimeSheets
+      @timeSheets.check
+    end
+
+
     ####################################################################
     # The following functions are not intended to be called from outside
     # the TaskJuggler library. There is no guarantee that these
@@ -784,6 +832,7 @@ class TaskJuggler
     def error(id, text)
       message = Message.new(id, 'error', text)
       @messageHandler.send(message)
+      raise TjException
     end
 
   protected
@@ -805,10 +854,14 @@ class TaskJuggler
       i = 0
       usedResources.each do |resource|
         resource.prepareScheduling(scIdx)
+        resource.preScheduleCheck(scIdx)
         i += 1
         Log.progress((i.to_f / total) * 0.8)
       end
 
+      resources.each { |resource| resource.setDirectReports(scIdx) }
+      resources.each { |resource| resource.setReports(scIdx) }
+
       tasks.each { |task| task.prepareScheduling(scIdx) }
       tasks.each { |task| task.Xref(scIdx) }
       tasks.each { |task| task.propagateInitialValues(scIdx) }
@@ -834,16 +887,18 @@ class TaskJuggler
       tasks.each { |task| task.calcCriticalness(scIdx) }
       Log.progress(0.95)
       tasks.each { |task| task.calcPathCriticalness(scIdx) }
+      Log.progress(0.99)
+      @timeSheets.check
       Log.progress(1.0)
 
       Log.stopProgressMeter
       # This is used for debugging only
       if false
         resources.each do |resource|
-          puts resource
+          puts "#{resource}"
         end
         tasks.each do |task|
-          puts task
+          puts "#{task}"
         end
       end
     end
@@ -864,6 +919,12 @@ class TaskJuggler
         i += 1
         Log.progress(0.5 + (i.to_f / total) * 0.5)
       end
+
+      # This should be really fast so we don't log progess.
+      @resources.each do |resource|
+        resource.postScheduleCheck(scIdx)
+      end
+
       Log.stopProgressMeter
     end
 
@@ -949,6 +1010,17 @@ class TaskJuggler
       true
     end
 
+    private
+
+    def matchingReports(reportId)
+      list = []
+      @reports.each do |report|
+        id = report.fullId
+        list << id if Regexp.new(reportId) =~ id
+      end
+      list
+    end
+
   end
 
 end

data/lib/ProjectFileParser.rb

@@ -165,6 +165,11 @@ class TaskJuggler
     # attribute. @propertySet determines what property should be extended.
     # _type_ is the attribute type, _default_ is the default value.
     def extendPropertySetDefinition(type, default)
+      if @propertySet.knownAttribute?(@val[1])
+        error('extend_redefinition',
+              "The extended attribute #{@val[1]} has already been defined.")
+      end
+
       # Determine the values for scenarioSpecific and inheritable.
       inherit = false
       scenarioSpecific = false
@@ -230,12 +235,15 @@ class TaskJuggler
     # inheritance. +name+ is the name of the report, +type+ is the report
     # type. +sourceFileInfo+ is a SourceFileInfo of the report definition. The
     # method returns the newly created Report.
-    def newReport(name, type, sourceFileInfo)
-      if @project.reportByName(name)
-        error('report_redefinition',
-              "A report with the name #{name} has already been defined.")
+    def newReport(id, name, type, sourceFileInfo)
+      @reportCounter += 1
+      if name != '.'
+        if @project.reportByName(name)
+          error('report_redefinition',
+                "A report with the name #{name} has already been defined.")
+        end
       end
-      @property = Report.new(@project, "report#{@reportCounter += 1}",
+      @property = Report.new(@project, id || "report#{@reportCounter}",
                              name, nil)
       @property.typeSpec = type
       @property.sourceFileInfo = sourceFileInfo
@@ -281,7 +289,7 @@ class TaskJuggler
         descr('No items')
         # Or the list consists of one or more comma separated keywords.
         pattern([ "!#{name}_AoN_ruleItems" ], lambda {
-          KeywordArray.new(@val)
+          KeywordArray.new(@val[0])
         })
       }
       # Create the rule for the comma separated list.
@@ -303,6 +311,10 @@ class TaskJuggler
 
     def listRule(name, listItem)
       pattern([ "#{listItem}", "!#{name}" ], lambda {
+        if @val[1] && @val[1].include?(@val[0])
+          error('duplicate_in_list',
+                "Duplicate items in list.")
+        end
         [ @val[0] ] + (@val[1].nil? ? [] : @val[1])
       })
       newRule(name) {
@@ -366,6 +378,7 @@ class TaskJuggler
     # Add a reference to another pattern. This information is only used to
     # generate the documentation for the patterns of this rule.
     def also(seeAlso)
+      seeAlso = [ seeAlso ] unless seeAlso.is_a?(Array)
       @cr.setSeeAlso(seeAlso)
     end
 

data/lib/PropertyList.rb

@@ -162,6 +162,11 @@ class TaskJuggler
       index
     end
 
+    # Return the Array index of _item_ or nil.
+    def itemIndex(item)
+      @items.index(item)
+    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
@@ -225,8 +230,13 @@ class TaskJuggler
             # If the scenario index is negative we have a non-scenario-specific
             # attribute.
             if @scenarioIdx[i] < 0
-              aVal = a.get(@sortingCriteria[i])
-              bVal = b.get(@sortingCriteria[i])
+              if @sortingCriteria[i] == 'id'
+                aVal = a.fullId
+                bVal = b.fullId
+              else
+                aVal = a.get(@sortingCriteria[i])
+                bVal = b.get(@sortingCriteria[i])
+              end
             else
               aVal = a[@sortingCriteria[i], @scenarioIdx[i]]
               bVal = b[@sortingCriteria[i], @scenarioIdx[i]]

data/lib/PropertyTreeNode.rb

@@ -161,11 +161,25 @@ class TaskJuggler
           next if scenario.parent.nil?
           parentScenarioIdx = scenario.parent.sequenceNo - 1
           # We copy only provided or inherited values from parent scenario when
-          # we don't have a provided or inherited value in this scenario.
-          if (provided(attrDef.id, parentScenarioIdx) ||
-              inherited(attrDef.id, parentScenarioIdx)) &&
-             !(provided(attrDef.id, scenarioIdx) ||
-               inherited(attrDef.id, scenarioIdx))
+          # we don't have a provided value in this scenario. Inherited values
+          # will be overwritten
+          parPro = provided(attrDef.id, parentScenarioIdx)
+          parInh = inherited(attrDef.id, parentScenarioIdx)
+          chiPro = provided(attrDef.id, scenarioIdx)
+          chiInh = inherited(attrDef.id, scenarioIdx)
+          # Parent/Child inheritance matrix
+          # P: Provided   p: not provided
+          # I: Inherited  i: not inherited
+          # -: Illegal  N: Don't copy  Y: Copy
+          #
+          #          parent
+          #          PI  Pi  pI  pi
+          # child PI  -   -   -   -
+          #       Pi  -   N   N   N
+          #       pI  -   Y   N   N
+          #       pi  -   Y   Y   N
+          if ((parPro || parInh) && !(chiPro || chiInh)) ||
+              (parPro && !chiPro && chiInh)
             @scenarioAttributes[scenarioIdx][attrDef.id] =
               @scenarioAttributes[parentScenarioIdx][attrDef.id].deep_clone
           end
@@ -530,10 +544,10 @@ class TaskJuggler
       rText = ''
       @project['journal'].currentEntries(query.end, self, 0,
                                          query.start).each do |entry|
-        rText += "== " + entry.headline + " ==\n"
+        rText += "=== <nowiki>" + entry.headline + "</nowiki> ===\n"
         rText += "''Reported on #{entry.date.to_s(query.timeFormat)}'' "
         if entry.author
-          rText += "''by #{entry.author.name}''"
+          rText += "''by <nowiki>#{entry.author.name}</nowiki>''"
         end
         rText += "\n\n"
         if entry.summary
@@ -553,7 +567,7 @@ class TaskJuggler
       begin
         rti = RichText.new(rText, handlers).generateIntermediateFormat
       rescue RichTextException => msg
-        $stderr.puts "Error in RichText of rule #{@keyword}\n" +
+        $stderr.puts "Error while processing Rich Text\n" +
                      "Line #{msg.lineNo}: #{msg.text}\n" +
                      "#{msg.line}"
         return nil
@@ -561,7 +575,7 @@ class TaskJuggler
       # No section numbers, please!
       rti.sectionNumbers = false
       # We use a special class to allow CSS formating.
-      rti.cssClass = 'alertmessage'
+      rti.cssClass = 'tj_journal'
       query.rti = rti
     end
 

data/lib/Query.rb

@@ -34,12 +34,12 @@ class TaskJuggler
 
     attr_accessor :project, :propertyType, :propertyId, :property,
                   :scopePropertyType, :scopePropertyId, :scopeProperty,
-                  :attributeId, :scenarioIdx, :startIdx, :endIdx,
+                  :attributeId, :scenarioIdx,
                   :timeFormat, :numberFormat, :currencyFormat, :costAccount,
                   :revenueAccount,
                   :loadUnit,
                   :ok, :errorMessage
-    attr_reader :end, :start
+    attr_reader :end, :endIdx, :start, :startIdx
     attr_writer :sortable, :numerical, :string, :rti
 
     # Create a new Query object. The _parameters_ need to be sufficent to
@@ -47,26 +47,66 @@ class TaskJuggler
     def initialize(parameters = { })
       ps = %w( project propertyType propertyId property scopePropertyId
                scopeProperty attributeId scenario scenarioIdx
-               start end startIdx endIdx
                loadUnit numberFormat currencyFormat timeFormat
                costAccount revenueAccount)
       ps.each do |p|
         instance_variable_set('@' + p, parameters[p] ? parameters[p] : nil)
       end
 
+      # instance_variable_set does not call writer functions. So we need to
+      # handle @start, @end, @startIdx and @endIdx separately.
+      %w( end endIdx start startIdx ).each do |p|
+        send(p + '=', parameters[p]) if parameters[p]
+      end
+
       reset
     end
 
-    # Reset the @startIdx when a start date is set.
+    # We probably need the start and end dates as TjTime and Scoreboard index.
+    # We store both, but we need to assure they are always in sync.
+
     def start=(date)
-      @start = date
-      @startIdx = nil
+      if date.is_a?(TjTime)
+        @start = date
+        @startIdx = @project.dateToIdx(date, true)
+      #elsif date.is_a?(Fixnum)
+      #  self.startIdx=(date)
+      else
+        raise "Unsupported type #{date.class}"
+      end
+    end
+
+    def startIdx=(idx)
+      if idx.is_a?(Fixnum)
+        @startIdx = idx
+        @start = @project.idxToDate(idx)
+      #elsif idx.is_a?(TjTime)
+      #  self.start=(idx)
+      else
+        raise "Unsupported type #{idx.class}"
+      end
     end
 
-    # Reset the @endIdx when an end date is set.
     def end=(date)
-      @end = date
-      @endIdx = nil
+      if date.is_a?(TjTime)
+        @end = date
+        @endIdx = @project.dateToIdx(date, true)
+      #elsif date.is_a?(Fixnum)
+      #  self.endIdx=(date)
+      else
+        raise "Unsupported type #{date.class}"
+      end
+    end
+
+    def endIdx=(idx)
+      if idx.is_a?(Fixnum)
+        @endIdx = idx
+        @end = @project.idxToDate(idx)
+      #elsif idx.is_a?(TjTime)
+      #  self.end=(idx)
+      else
+        raise "Unsupported type #{idx.class}"
+      end
     end
 
     # This method tries to resolve the query and return a result. In case it
@@ -114,8 +154,6 @@ class TaskJuggler
             raise "Query cannot resolve scenario '#{@scenario}'"
           end
         end
-        @startIdx = @project.dateToIdx(@start, true) if @startIdx.nil? && @start
-        @endIdx = @project.dateToIdx(@end, true) - 1 if @endIdx.nil? && @end
 
         queryMethodName = 'query_' + @attributeId
         # First we check for non-scenario-specific query functions.
@@ -128,7 +166,7 @@ class TaskJuggler
         else
           # The result is a BaseAttribute
           unless (@attr = @property.getAttribute(@attributeId, @scenarioIdx))
-            errorMessage = "Unknown attribute #{@attributeId} queried"
+            @errorMessage = "Unknown attribute #{@attributeId} queried"
             return @ok = false
           end
         end
@@ -289,7 +327,7 @@ class TaskJuggler
     # result data.
     def reset
       @attr = @numerical = @sortable = @string = @rti = nil
-      @ok = nil
+      @ok = true
       @errorMessage = nil
     end
 

data/lib/RTFReport.rb

@@ -34,11 +34,11 @@ class TaskJuggler
       if args.nil? || (id = args['id']).nil?
         error('rtp_report_id',
               "Argument 'id' missing to specify the report to be used.")
-        nil
+        return nil
       end
       unless (report = @project.report(id))
         error('rtp_report_unknown_id', "Unknown report #{id}")
-        nil
+        return nil
       end
 
       # Save the old report context record