taskjuggler 0.0.5 → 0.0.6

data/lib/RichTextSyntaxRules.rb

@@ -56,7 +56,7 @@ class TaskJuggler
         RichTextElement.new(@richTextI, :bulletlist1, @val[0])
       })
       pattern(%w( !numberList1 ), lambda {
-        @numberListCounter = [ 0, 0, 0 ]
+        @numberListCounter = [ 0, 0, 0, 0 ]
         RichTextElement.new(@richTextI, :numberlist1, @val[0])
       })
       pattern(%w( !blockFunction !blankLines ), lambda {
@@ -74,12 +74,15 @@ class TaskJuggler
       pattern(%w( !title3 ), lambda {
         @val[0]
       })
+      pattern(%w( !title4 ), lambda {
+        @val[0]
+      })
     end
 
     def rule_title1
-      pattern(%w( $TITLE1 !text $TITLE1END ), lambda {
-        @val[1][-1].appendSpace = false
-        el = RichTextElement.new(@richTextI, :title1, @val[1])
+      pattern(%w( $TITLE1 !space !text $TITLE1END ), lambda {
+        @val[2][-1].appendSpace = false
+        el = RichTextElement.new(@richTextI, :title1, @val[2])
         @sectionCounter[0] += 1
         @sectionCounter[1] = @sectionCounter[2] = 0
         el.data = @sectionCounter.dup
@@ -88,9 +91,9 @@ class TaskJuggler
     end
 
     def rule_title2
-      pattern(%w( $TITLE2 !text $TITLE2END ), lambda {
-        @val[1][-1].appendSpace = false
-        el = RichTextElement.new(@richTextI, :title2, @val[1])
+      pattern(%w( $TITLE2 !space !text $TITLE2END ), lambda {
+        @val[2][-1].appendSpace = false
+        el = RichTextElement.new(@richTextI, :title2, @val[2])
         @sectionCounter[1] += 1
         @sectionCounter[2] = 0
         el.data = @sectionCounter.dup
@@ -99,10 +102,21 @@ class TaskJuggler
     end
 
     def rule_title3
-      pattern(%w( $TITLE3 !text $TITLE3END ), lambda {
-        @val[1][-1].appendSpace = false
-        el = RichTextElement.new(@richTextI, :title3, @val[1])
+      pattern(%w( $TITLE3 !space !text $TITLE3END ), lambda {
+        @val[2][-1].appendSpace = false
+        el = RichTextElement.new(@richTextI, :title3, @val[2])
         @sectionCounter[2] += 1
+        @sectionCounter[3] = 0
+        el.data = @sectionCounter.dup
+        el
+      })
+    end
+
+    def rule_title4
+      pattern(%w( $TITLE4 !space !text $TITLE4END ), lambda {
+        @val[2][-1].appendSpace = false
+        el = RichTextElement.new(@richTextI, :title4, @val[2])
+        @sectionCounter[3] += 1
         el.data = @sectionCounter.dup
         el
       })
@@ -134,6 +148,16 @@ class TaskJuggler
       pattern(%w( $BULLET3 !text $LINEBREAK), lambda {
         RichTextElement.new(@richTextI, :bulletitem3, @val[1])
       })
+      pattern(%w( !bulletList4 ), lambda {
+        RichTextElement.new(@richTextI, :bulletlist4, @val[0])
+      })
+    end
+
+    def rule_bulletList4
+      repeatable
+      pattern(%w( $BULLET4 !text $LINEBREAK), lambda {
+        RichTextElement.new(@richTextI, :bulletitem4, @val[1])
+      })
     end
 
     def rule_numberList1
@@ -173,6 +197,20 @@ class TaskJuggler
         el.data = @numberListCounter.dup
         el
       })
+      pattern(%w( !numberList4 ), lambda {
+        @numberListCounter[3] = 0
+        RichTextElement.new(@richTextI, :numberlist4, @val[0])
+      })
+    end
+
+    def rule_numberList4
+      repeatable
+      pattern(%w( $NUMBER4 !text $LINEBREAK), lambda {
+        el = RichTextElement.new(@richTextI, :numberitem4, @val[1])
+        @numberListCounter[3] += 1
+        el.data = @numberListCounter.dup
+        el
+      })
     end
 
     def rule_paragraph

data/lib/ScenarioData.rb

@@ -55,9 +55,11 @@ class TaskJuggler
       @project.sendMessage(message)
     end
 
-    def query_id(query)
-      query.sortable = query.string = @property.fullId
-    end
+    # Not sure why this method was put there. If needed, it should in
+    # PropertyTreeNode!
+    #def query_id(query)
+    #  query.sortable = query.string = @property.fullId
+    #end
 
   end
 

data/lib/SheetReceiver.rb

@@ -39,11 +39,13 @@ class TaskJuggler
       @signatureFile = nil
       # The log file
       @logFile = nil
+      # The subject of the confirmation email
+      @emailSubject = nil
 
       # Regular expressions to identify a status sheet.
-      @sheetHeader = /^[ ]*statussheet\s([a-z][a-z0-9_]*)\s([0-9]*-[0-9]*-[0-9]*)/
+      @sheetHeader = nil
       # Regular expression to extract the sheet signature (date).
-      @signatureFilter = /^[ ]*statussheet\s[a-z][a-z0-9_]*\s([0-9:\-+]*)/
+      @signatureFilter = nil
       # The email address of the submitter of the sheet.
       @submitter = nil
       # The resource ID of the submitter.
@@ -73,7 +75,16 @@ class TaskJuggler
 
       createDirectories
 
-      mail = Mail.new($stdin.read)
+      begin
+        rawMail = $stdin.read
+        mail = Mail.new(rawMail)
+      rescue
+        # Try to extract the mail sender the dirty way so we can at least send
+        # a response to the submitter.
+        fromLine = rawMail.match('^From: .*')[0]
+        @submitter = fromLine[6..-1] if fromLine.is_a?(String)
+        error("Incoming mail could not be processed: #{$!}")
+      end
 
       # Who sent this email?
       @submitter = mail.from.respond_to?('[]') ? mail.from[0] : mail.from
@@ -114,9 +125,16 @@ EOT
 
     # Isolate the actual syntax from _sheet_ and process it.
     def processSheet(sheet)
+      # Make sure the sheet is really valid UTF-8
+      begin
+        sheet.encode!('UTF-8')
+      rescue
+        error("The sheet contains badly encoded characters. #{$!}")
+      end
       # Store the detected sheet so we can include it with error reports if
       # needed.
-      @sheet = cutOut(fixLineBreaks(sheet))
+      @sheet = fixLineBreaks(sheet)
+      @sheet = cutOut(@sheet) unless @sheetWasAttached
       # A valid sheet must have the poper header line.
       if @sheetHeader.match(@sheet)
         checkSignature(@sheet)
@@ -218,7 +236,7 @@ EOT
       text += @report
 
       # Send out the email.
-      sendEmail(@submitter, "Report from #{getResourceName} for #{@date}", text,
+      sendEmail(@submitter, sprintf(@emailSubject, getResourceName, @date), text,
                 nil, nil, @messageId)
       true
     end
@@ -294,7 +312,7 @@ EOT
       rescue
       end
 
-      sendEmail(@submitter, 'Your time sheet submission failed!', message)
+      sendEmail(@submitter, "Your #{@sheetType} sheet submission failed!", message)
 
       exit 1
     end

data/lib/SheetSender.rb

@@ -14,6 +14,7 @@ require 'open4'
 require 'mail'
 require 'yaml'
 require 'SheetHandlerBase'
+require 'reports/CSVFile'
 
 class TaskJuggler
 
@@ -40,6 +41,9 @@ class TaskJuggler
       @force = false
 
       @signatureFilter = nil
+      # The subject of the template email.
+      @mailSubject = nil
+      # The into text of the template email.
       @introText = nil
 
       # The end date of the reported interval.
@@ -78,6 +82,9 @@ class TaskJuggler
     def genResourceList(resourceList)
       list = []
       info('Retrieving resource list...')
+      # Create a TJP report definition for a CSV report that contains the id,
+      # name, email, effort and free work for each resource that is not hidden
+      # by @hideResource.
       reportDef = <<"EOF"
 resourcereport rl_21497214 '.' {
   formats csv
@@ -89,19 +96,17 @@ resourcereport rl_21497214 '.' {
 }
 EOF
       report = generateReport('rl_21497214', reportDef)
-      first = true
-      report.each_line do |line|
-        if first
-          first = false
-          next
-        end
-        id, name, email, effort, free = line.split(';')
-        if email.empty?
+      # Parse the CSV report into an Array of Arrays
+      csv = CSVFile.new.parse(report)
+
+      # Get rid of the column title line
+      csv.delete_at(0)
+
+      # Process the CSV report line by line
+      csv.each do |id, name, email, effort, free|
+        if email.nil? || email.empty?
           error("Resource '#{id}' must have a valid email address")
         end
-        # Convert effort and free values into Float objects.
-        effort = effort.to_f
-        free = free.to_f
 
         # Ignore resources that are on vacation for the whole period.
         if effort == 0.0 && free == 0.0
@@ -181,8 +186,7 @@ EOT
 
         message = " Hello #{name}!\n\n#{@introText}" + File.read(attachment)
 
-        sendEmail(email, "Your weekly report template for #{@date}",
-                  message, attachment)
+        sendEmail(email, sprintf(@mailSubject, @date), message, attachment)
       end
     end
 

data/lib/ShiftAssignments.rb

@@ -10,6 +10,7 @@
 # published by the Free Software Foundation.
 #
 
+require 'monitor'
 require 'Scoreboard'
 
 class TaskJuggler
@@ -26,10 +27,8 @@ class TaskJuggler
       @interval = interval
     end
 
-    # Returns true if the ShiftAssignment objects are similar enough.
-    def ==(sa)
-      return @shiftScenario.object_id == sa.shiftScenario.object_id &&
-             @interval == sa.interval
+    def hashKey
+      return "#{@shiftScenario.object_id}|#{@interval.start}|#{@interval.end}"
     end
 
     # Return a deep copy of self.
@@ -91,28 +90,39 @@ class TaskJuggler
   # Bit 6:      Reserved
   # Bit 7:      0: No global override
   #             1: Override global setting
-  class ShiftAssignments
+  class ShiftAssignments < Monitor
 
     include ObjectSpace
 
-    attr_reader :project, :assignments
+    attr_accessor :project
+    attr_reader :assignments
 
     # This class is sharing the Scoreboard instances for ShiftAssignments that
-    # have identical assignement data. This class variable holds an array with
+    # have identical assignment data. This class variable holds a Hash with
     # records for each unique Scoreboard. A record is an array of references
     # to the owning ShiftAssignments objects and a reference to the Scoreboard
     # object.
-    @@scoreboards = []
+    @@scoreboards = {}
 
     def initialize(sa = nil)
       define_finalizer(self, self.class.method(:deleteScoreboard).to_proc)
 
+      # An Array of ShiftAssignment objects.
       @assignments = []
+
+      # A String that uniquely identifies the content of this ShiftAssignment
+      # object.
+      @hashKey = nil
+
       if sa
+        # A ShiftAssignments object was passed to the contructor. We create a
+        # deep copy of it.
         @project = sa.project
         sa.assignments.each do |assignment|
           @assignments << assignment.copy
         end
+        # Create a new ScoreBoard or share one with a ShiftAssignments object
+        # that has the same set of shift assignments.
         @scoreboard = newScoreboard
       else
         @project = nil
@@ -120,11 +130,6 @@ class TaskJuggler
       end
     end
 
-    # Some operations require access to the whole project.
-    def setProject(project)
-      @project = project
-    end
-
     # Add a new assignment to the list. In case there was no overlap the
     # function returns true. Otherwise false.
     def addAssignment(shiftAssignment)
@@ -200,24 +205,12 @@ class TaskJuggler
       end
     end
 
-    # Returns true if two ShiftAssignments object have the same assignment
-    # pattern.
-    def ==(shiftAssignments)
-      return false if @assignments.size != shiftAssignments.assignments.size ||
-                      @project != shiftAssignments.project
-
-      @assignments.size.times do |i|
-        return false if @assignments[i] != shiftAssignments.assignments[i]
-      end
-      true
-    end
-
     def ShiftAssignments.scoreboards
       @@scoreboards
     end
 
     def ShiftAssignments.sbClear
-      @@scoreboards = []
+      @@scoreboards = {}
     end
 
     # This function is primarily used for debugging purposes.
@@ -237,52 +230,63 @@ class TaskJuggler
       out
     end
 
+    def hashKey
+      @hashKey if @hashKey
+
+      @hashKey = "#{@project.object_id}|"
+      @assignments.sort! { |a, b| a.interval.start <=> b.interval.start }
+      @assignments.each { |a| @hashKey += a.hashKey + '||' }
+      @hashKey
+    end
+
   private
 
     # This function either returns a new Scoreboard or a reference to an
     # existing one in case we already have one for the same assigment patterns.
     def newScoreboard
-      @@scoreboards.each do |sbRecord|
-        # We only have to look at the first ShiftAssignment for a comparison.
-        # The others should match as well.
-        if self == ObjectSpace._id2ref(sbRecord[0][0])
-          # Register the ShiftAssignments object as a user of an existing
-          # scoreboard.  We have to store the object_id, not the reference. If
-          # we'd store a reference, the GC will never destroy it.
-          sbRecord[0] << object_id
-          # Return a reference to the existing scoreboard.
-          return sbRecord[1]
-        end
+      if (record = @@scoreboards[hashKey])
+        # If we already have a Scoreboard object for the hashKey of this
+        # ShiftAssignments object, we can re-use this. We just need to
+        # register the object as a user of it.
+        record[0] << object_id
+
+        # Return the re-used Scoreboard object.
+        return record[1]
       end
+
       # We have not found a matching scoreboard, so we have to create a new one.
       newSb = Scoreboard.new(@project['start'], @project['end'],
                              @project['scheduleGranularity'])
       # Create a new record for it and register the ShiftAssignments object as
-      # first user.
-      newRecord = [ [ object_id ], newSb ]
+      # first user. Add the record to the @@scoreboards list.
+      @@scoreboards[hashKey] = [ [ object_id ], newSb ]
+
       # Append the new record to the list.
-      @@scoreboards << newRecord
       return newSb
     end
 
     # This function is called whenever a ShiftAssignments object gets destroyed
     # by the GC.
     def ShiftAssignments.deleteScoreboard(objId)
-      # Attention: Due to the way this class is called, there will be no visible
-      # exceptions here. All runtime errors will go unnoticed!
+      # Attention: Due to the way this class is called, there will be no
+      # visible exceptions here. All runtime errors will go unnoticed!
       #
-      # Well search the @@scoreboards for an entry that holds a reference to the
-      # deleted ShiftAssignments object. If it's the last in the record, we
-      # delete the whole record. If not, we'll just remove it form the record.
-      @@scoreboards.each do |sbRecord|
-        assignmentObjectIDs = sbRecord[0]
-        assignmentObjectIDs.delete_if { |id| id == objId }
-        # No more ShiftAssignments in this record. Delete it from the list.
-        break if assignmentObjectIDs.empty?
+      # We'll search the @@scoreboards for an entry that holds a reference to
+      # the deleted ShiftAssignments object. If it's the last in the record,
+      # we delete the whole record. If not, we'll just remove the reference
+      # form the record.
+      @@scoreboards.each_value do |record|
+        if record[0].include?(objId)
+          # Remove the ShiftAssignments object as user of this Scoreboard
+          # object.
+          record[0].delete(objId)
+          # We've found what we were looking for.
+          break
+        end
       end
+
       # Delete all entries which have empty reference lists.
-      @@scoreboards.delete_if { |sbRecord| sbRecord[0].empty? }
-      ObjectSpace.undefine_finalizer(self)
+      @@scoreboards.delete_if { |key, record| record[0].empty? }
     end
 
     # Returns true if the interval overlaps with any of the assignment periods.

data/lib/StatusSheetReceiver.rb

@@ -37,6 +37,7 @@ class TaskJuggler
       @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:\-+]*)/
+      @emailSubject = "Status report from %s for %s"
     end
 
   end