taskjuggler 0.0.4 → 0.0.5

data/lib/ShiftAssignments.rb

@@ -79,12 +79,18 @@ class TaskJuggler
   # To optimize memory usage and computation time the Scoreboard objects for
   # similar ShiftAssignments are shared.
   #
-  # Scoreboard entries can have 5 possible values
+  # Scoreboard may be nil or a bit vector encoded as a Fixnum
   # nil: Value has not been determined yet.
-  # 0: No assignment
-  # 1: on shift
-  # 2: Off-hour slot
-  # 3: Vacation slot
+  # Bit 0:      0: No assignment
+  #             1: Has assignement
+  # Bit 1:      0: Work time
+  #             1: Off time
+  # Bit 2 - 5:  0: No vacation or leave time
+  #             1: Regular vacation
+  #             2 - 15: Reserved
+  # Bit 6:      Reserved
+  # Bit 7:      0: No global override
+  #             1: Override global setting
   class ShiftAssignments
 
     include ObjectSpace
@@ -137,59 +143,61 @@ class TaskJuggler
       # Check if we have a value already for this slot.
       return @scoreboard[idx] unless @scoreboard[idx].nil?
 
+
       # If not, compute it.
       @assignments.each do |sa|
         next unless sa.assigned?(date)
 
+        # Mark the slot as 'assigned'. Meaning, the rest of the bits are valid
+        # for this time slot.
+        @scoreboard[idx] = 1
+
+        # Set bit 1 if the shift is not active
+        @scoreboard[idx] |= 1 << 1 unless sa.onShift?(date)
+
+        # Set bits 2 - 5 to 1 if it's a vacation slot.
+        @scoreboard[idx] |= 1 << 3 if sa.onVacation?(date)
+
         # Set the 8th bit if the shift replaces global vacations.
-        replace = sa.replace?(date) ? (1 << 8) : 0
-
-        if sa.onVacation?(date)
-          # On vacation
-          return @scoreboard[idx] = 3 | replace
-        elsif sa.onShift?(date)
-          # On shift
-          return @scoreboard[idx] = 1 | replace
-        else
-          # Off hour
-          return @scoreboard[idx] = 2 | replace
-        end
+        @scoreboard[idx] |= 1 << 8 if sa.replace?(date)
+
+        return @scoreboard[idx]
       end
-      # No assignment for slot
+
+      # The slot is not covered by any assignment.
       @scoreboard[idx] = 0
     end
 
     # Returns true if any of the defined shift periods overlaps with the date or
     # interval specified by _date_.
     def assigned?(date)
-      getSbSlot(date) > 0
+      (getSbSlot(date) & 1) == 1
     end
 
     # Returns true if any of the defined shift periods contains the
     # _date_ and the shift has working hours defined for that _date_.
     def onShift?(date)
-      (getSbSlot(date) & 0xFF) == 1
+      (getSbSlot(date) & (1 << 1)) == 0
     end
 
     # Returns true if any of the defined shift periods contains the _date_ and
     # the shift has a vacation defined or all off hours defined for that _date_.
     def timeOff?(date)
-      (getSbSlot(date) & 0xFF) >= 2
+      (getSbSlot(date) & 0x3E) != 0
     end
 
     # Returns true if any of the defined shift periods contains the _date_ and
     # if the shift has a vacation defined for the _date_.
     def onVacation?(date)
-      (getSbSlot(date) & 0xFF) == 3
+      (getSbSlot(date) & 0x3C) != 0
     end
 
     # Return a list of intervals that lay within _iv_ and are at least
-    # minDuration long and contain no working time. In this class the scoreboard
-    # values 2 and 3 mark time off. Additionally the 8-th but may be set as
-    # well.
+    # minDuration long and contain no working time.
     def collectTimeOffIntervals(iv, minDuration)
-      @scoreboard.collectTimeOffIntervals(iv, minDuration,
-                                          [ 2, 3, (1 << 8) | 2, (1 << 8) | 3 ])
+      @scoreboard.collectIntervals(iv, minDuration) do |val|
+        (val & 0x3E) != 0
+      end
     end
 
     # Returns true if two ShiftAssignments object have the same assignment

data/lib/StatusSheetReceiver.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = StatusSheetReceiver.rb -- The TaskJuggler III Project Management Software
+#
+# 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
+# published by the Free Software Foundation.
+#
+
+require 'SheetReceiver'
+
+class TaskJuggler
+
+  # This class specializes SheetReceiver to process status sheets.
+  class StatusSheetReceiver < SheetReceiver
+
+    def initialize(appName)
+      super(appName, 'status')
+
+      @tj3clientOption = 'check-ss'
+
+      # File name and directory settings.
+      @sheetDir = 'StatusSheets'
+      @templateDir = 'StatusSheetTemplates'
+      @failedMailsDir = "#{@sheetDir}/FailedMails"
+      @failedSheetsDir = "#{@sheetDir}/FailedSheets"
+      # This file contains the time intervals that the StatusSheetReceiver will
+      # accept as a valid interval.
+      @signatureFile = "#{@templateDir}/acceptable_intervals"
+      # The log file
+      @logFile = 'statussheets.log'
+
+      # Regular expression to identify status sheets.
+      @sheetHeader = /^[ ]*statussheet\s([a-z][a-z0-9_]*)\s[0-9\-:+]*\s-\s([0-9]*-[0-9]*-[0-9]*)/
+      # Regular expression to extract the sheet signature (time period).
+      @signatureFilter = /^[ ]*statussheet\s[a-z][a-z0-9_]*\s([0-9:\-+]*\s-\s[0-9:\-+]*)/
+    end
+
+  end
+
+end
+

data/lib/StatusSheetSender.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = StatusSheetSender.rb -- The TaskJuggler III Project Management Software
+#
+# 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
+# published by the Free Software Foundation.
+#
+
+require 'SheetSender'
+
+class TaskJuggler
+
+  # The StatusSheetSender class generates status sheet templates for the current
+  # week and sends them out to the managers. For this to work, the resources
+  # must provide the 'Email' custom attribute with their email address. The
+  # actual project data is accessed via tj3client on a tj3 server process.
+  class StatusSheetSender < SheetSender
+
+    attr_accessor :date, :hideResource
+
+    def initialize(appName)
+      super(appName, 'status')
+
+      # This is a LogicalExpression string that controls what resources should
+      # not be getting a status sheet.
+      @hideResource = '0'
+      # The base directory of the status sheet templates.
+      @templateDir = 'StatusSheetTemplates'
+      # This file contains the time intervals that the StatusSheetReceiver will
+      # accept as a valid interval.
+      @signatureFile = "#{@templateDir}/acceptable_intervals"
+      # The log file
+      @logFile = 'statussheets.log'
+
+      @signatureFilter = /^[ ]*statussheet\s[a-z][a-z0-9_]*\s([0-9:\-+]*\s-\s[0-9:\-+]*)/
+      @introText = <<'EOT'
+Please find enclosed your weekly status report template. Please fill out the
+form and send it back to the sender of this email. You can either use the
+attached file or the body of the email. In case you send it in the body of the
+email, make sure it only contains the 'statussheet' syntax. It must be plain
+text, UTF-8 encoded and the status sheet header from 'statussheet' to the period
+end date must be in a single line that starts at the beginning of the line.
+
+EOT
+    end
+
+  end
+
+end
+

data/lib/SyntaxReference.rb

@@ -136,10 +136,7 @@ class TaskJuggler
     # support navigating through the syntax reference.
     def generateHTMLnavbar(directory, keywords)
       html = HTMLDocument.new
-      html << (head = XMLElement.new('head'))
-      head << XMLNamedText.new('TaskJuggler Syntax Reference Navigator', 'title')
-      head << XMLElement.new('meta', 'http-equiv' => 'Content-Type',
-                             'content' => 'text/html; charset=utf-8')
+      head = html.generateHead('TaskJuggler Syntax Reference Navigator')
       head << XMLElement.new('base', 'target' => 'display')
       html << (body = XMLElement.new('body'))
 
@@ -168,9 +165,7 @@ class TaskJuggler
       html.write(directory + 'navbar.html')
 
       html = HTMLDocument.new
-      html << (head = XMLElement.new('head'))
-      head << XMLElement.new('meta', 'http-equiv' => 'Content-Type',
-                             'content' => 'text/html; charset=utf-8')
+      head = html.generateHead('TaskJuggler Syntax Reference Navigator')
       head << XMLElement.new('base', 'target' => 'navigator')
       html << (body = XMLElement.new('body'))
 

data/lib/Task.rb

@@ -31,6 +31,76 @@ class TaskJuggler
       @data[scenarioIdx].readyForScheduling?
     end
 
+    def query_journal(query)
+      journalMessages(query, true)
+    end
+
+    private
+
+    # Create a blog-style list of all alert messages that match the Query.
+    def journalMessages(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 = ''
+      list = @project['journal'].entriesByTask(self, query.start, query.end)
+      list.reverse.each do |entry|
+        # The TimeSheetRecords associated with this entry.
+        tsRecord = entry.timeSheetRecord
+        if entry.property.is_a?(Task)
+          levelRecord = @project['alertLevels'][entry.alertLevel]
+          alertName = "[[File:icons/flag-#{levelRecord[0]}.png|" +
+                      "alt=[#{levelRecord[1]}]|text-bottom]]"
+          rText += "== #{alertName} <nowiki>#{entry.headline}</nowiki> ==\n" +
+                   "''Reported on #{entry.date.to_s(query.timeFormat)}'' "
+          if entry.author
+            rText += "''by <nowiki>#{entry.author.name}</nowiki>''"
+          end
+          rText += "\n\n"
+          if tsRecord
+            rText += "'''Work:''' #{tsRecord.actualWorkPercent.to_i}% "
+            if tsRecord.remaining
+              rText += "'''Remaining:''' #{tsRecord.actualRemaining}d "
+            else
+              rText += "'''End:''' " +
+                       "#{tsRecord.actualEnd.to_s(query.timeFormat)} "
+            end
+            rText += "\n\n"
+          end
+        end
+        unless entry.headline.empty?
+          rText += "'''<nowiki>#{entry.headline}</nowiki>'''\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.
+      handlers = [
+        RTFNavigator.new(@project),
+        RTFQuery.new(@project),
+        RTFReport.new(@project)
+      ]
+      begin
+        rti = RichText.new(rText, handlers).generateIntermediateFormat
+      rescue RichTextException => msg
+        $stderr.puts "Error while processing Rich Text\n" +
+                     "Line #{msg.lineNo}: #{msg.text}\n" +
+                     "#{msg.line}"
+        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
+
   end
 
 end

data/lib/TaskJuggler.rb

@@ -13,7 +13,6 @@
 require 'drb'
 require 'Project'
 require 'MessageHandler'
-require 'RemoteServiceManager'
 require 'Log'
 
 # The TaskJuggler class models the object that provides access to the
@@ -22,7 +21,7 @@ require 'Log'
 class TaskJuggler
 
   attr_reader :messageHandler
-  attr_accessor :maxCpuCores
+  attr_accessor :maxCpuCores, :warnTsDeltas
 
   # Create a new TaskJuggler object. _console_ is a boolean that determines
   # whether or not messsages can be written to $stderr.
@@ -31,6 +30,7 @@ class TaskJuggler
     @parser = nil
     @messageHandler = MessageHandler.new(console)
     @maxCpuCores = 1
+    @warnTsDeltas = false
   end
 
   # Read in the files passed as file names in _files_, parse them and
@@ -64,7 +64,20 @@ class TaskJuggler
     @parser = nil unless keepParser
 
     Log.exit('parser')
-    @messageHandler.messages.empty?
+    @messageHandler.errors == 0
+  end
+
+  # Parse a file and add the content to the existing project. _fileName_ is
+  # the name of the file. _rule_ is the TextParser::Rule to start with.
+  def parseFile(fileName, rule)
+    @parser.open(fileName, false)
+    @parser.setGlobalMacros
+    return nil if (res = @parser.parse(rule)).nil?
+    # Make sure that _rule_ described the full content of the file. There
+    # should be no more content left.
+    @parser.checkForEnd
+    @parser.close
+    res
   end
 
   # Schedule all scenarios in the project. Return true if no error was
@@ -72,6 +85,7 @@ class TaskJuggler
   def schedule
     Log.enter('scheduler', 'Scheduling project ...')
     #puts @project.to_s
+    @project.warnTsDeltas = @warnTsDeltas
     res = @project.schedule
     Log.exit('scheduler')
     res
@@ -88,15 +102,103 @@ class TaskJuggler
     res
   end
 
-  def serveReports
-    $SAFE = 1
-    Log.enter('reportserver', 'Starting Server Mode ...')
-    Log.status("Report Server is now active!")
-    serviceManager = RemoteServiceManager.new(@parser, @project)
-    DRb.start_service('druby://localhost:8474', serviceManager)
-    DRb.thread.join
-    # We'll probably never get here. The DRb threads may call exit().
-    Log.exit('reportserver')
+  # Generate the report with the ID _reportId_.
+  def generateReport(reportId, regExpMode)
+    begin
+      Log.enter('generateReport', 'Generating report #{reportId} ...')
+      @project.generateReport(reportId, regExpMode)
+    rescue TjException
+      Log.exit('generateReport')
+      return false
+    end
+    Log.exit('generateReport')
+    true
+  end
+
+  # Generate the report with the ID _reportId_.
+  def listReports(reportId, regExpMode)
+    begin
+      Log.enter('listReports', 'Generating report list for #{reportId} ...')
+      @project.listReports(reportId, regExpMode)
+    rescue TjException
+      Log.exit('listReports')
+      return false
+    end
+    Log.exit('listReports')
+    true
+  end
+
+  # Check the content of the file _fileName_ and interpret it as a time sheet.
+  # If the sheet is syntaxtically correct and matches the loaded project, true
+  # is returned. Otherwise false.
+  def checkTimeSheet(fileName)
+    begin
+      Log.enter('checkTimeSheet', 'Parsing #{fileName} ...')
+      # Make sure we don't use data from old time sheets or Journal entries.
+      @project.timeSheets.clear
+      @project['journal'] = Journal.new
+      return false unless (ts = parseFile(fileName, 'timeSheet'))
+      return false unless @project.checkTimeSheets
+      queryAttrs = { 'project' => @project,
+                     'property' => ts.resource,
+                     'scopeProperty' => nil,
+                     'scenarioIdx' => @project['trackingScenarioIdx'],
+                     'start' => ts.interval.start,
+                     'end' => ts.interval.end,
+                     'timeFormat' => '%Y-%m-%d' }
+      query = Query.new(queryAttrs)
+      rti = ts.resource.query_journal(query)
+      rti.lineWidth = 72
+      rti.indent = 2
+      rti.titleIndent = 0
+      rti.listIndent = 2
+      rti.parIndent = 2
+      rti.preIndent = 4
+      puts rti.to_s
+    rescue TjException
+      Log.exit('checkTimeSheet')
+      return false
+    end
+    Log.exit('checkTimeSheet')
+    true
+  end
+
+  # Check the content of the file _fileName_ and interpret it as a status
+  # sheet.  If the sheet is syntaxtically correct and matches the loaded
+  # project, true is returned. Otherwise false.
+  def checkStatusSheet(fileName)
+    begin
+      Log.enter('checkStatusSheet', 'Parsing #{fileName} ...')
+      return false unless (ss = parseFile(fileName, 'statusSheet'))
+      queryAttrs = { 'project' => @project,
+                     'property' => ss[0],
+                     'scopeProperty' => nil,
+                     'scenarioIdx' => @project['trackingScenarioIdx'],
+                     'timeFormat' => '%Y-%m-%d',
+                     'start' => ss[1],
+                     'end' => ss[2],
+                     'timeFormat' => '%Y-%m-%d' }
+      query = Query.new(queryAttrs)
+      rti = ss[0].query_dashboard(query)
+      rti.lineWidth = 72
+      rti.indent = 2
+      rti.titleIndent = 0
+      rti.listIndent = 2
+      rti.parIndent = 2
+      rti.preIndent = 4
+      puts rti.to_s
+    rescue TjException
+      Log.exit('checkStatusSheet')
+      return false
+    end
+    Log.exit('checkStatusSheet')
+    true
+  end
+
+  # Return the ID of the project or nil if no project has been loaded yet.
+  def projectId
+    return nil if @project.nil?
+    @project['projectid']
   end
 
   # Return the number of errors that had been reported during processing.