taskjuggler 0.0.7 → 0.0.8

data/lib/RichText.rb

@@ -73,6 +73,10 @@ class TaskJuggler
 
     attr_reader :inputText, :messageHandler
 
+    # The Parser uses complex to setup data structures that are identical for
+    # all RichText instances. So, we'll share them across the instances.
+    @@parser = nil
+
     # Create a rich text object by passing a String with markup elements to it.
     # _text_ must be plain text with MediaWiki compatible markup elements. In
     # case an error occurs, an exception of type TjException will be raised.
@@ -94,12 +98,20 @@ class TaskJuggler
       @functionHandlers.each do |h|
         rti.registerFunctionHandler(h)
       end
-      # Parse the input text into an abstract syntax tree.
-      parser = RichTextParser.new(@messageHandler, rti, sectionCounter,
-                                  tokenSet)
-      parser.open(@inputText)
+
+      # We'll setup the RichTextParser once and share it across all instances.
+      if @@parser
+        # We already have a RichTextParser that we can reuse.
+        @@parser.reuse(@messageHandler, rti, sectionCounter, tokenSet)
+      else
+        # There is no RichTextParser yet, create one.
+        @@parser = RichTextParser.new(@messageHandler, rti, sectionCounter,
+                                      tokenSet)
+      end
+
+      @@parser.open(@inputText)
       # Parse the input text and convert it to the intermediate representation.
-      return nil if (tree = parser.parse('richtext')) == false
+      return nil if (tree = @@parser.parse(:richtext)) == false
 
       # In case the result is empty, use an empty RichTextElement as result
       tree = RichTextElement.new(rti, :richtext, nil) unless tree

data/lib/RichTextParser.rb

@@ -32,24 +32,37 @@ class TaskJuggler
       super(messageHandler)
       @richTextI = rti
       # These are the tokens that can be returned by the RichTextScanner.
-      @variables = %w( LINEBREAK SPACE WORD BOLD ITALIC CODE BOLDITALIC PRE
-                       HREF HREFEND REF REFEND HLINE
-                       QUERY
-                       INLINEFUNCSTART INLINEFUNCEND
-                       BLOCKFUNCSTART BLOCKFUNCEND ID STRING
-                       TITLE1 TITLE2 TITLE3 TITLE4
-                       TITLE1END TITLE2END TITLE3END TITLE4END
-                       BULLET1 BULLET2 BULLET3 BULLET4
-                       NUMBER1 NUMBER2 NUMBER3 NUMBER4 )
+      @variables = [ :LINEBREAK, :SPACE, :WORD,
+                     :BOLD, :ITALIC, :CODE, :BOLDITALIC, :PRE,
+                     :HREF, :HREFEND, :REF, :REFEND, :HLINE,
+                     :QUERY,
+                     :INLINEFUNCSTART, :INLINEFUNCEND,
+                     :BLOCKFUNCSTART, :BLOCKFUNCEND, :ID, :STRING,
+                     :TITLE1, :TITLE2, :TITLE3, :TITLE4,
+                     :TITLE1END, :TITLE2END, :TITLE3END, :TITLE4END,
+                     :BULLET1, :BULLET2, :BULLET3, :BULLET4,
+                     :NUMBER1, :NUMBER2, :NUMBER3, :NUMBER4
+                   ]
       limitTokenSet(tokenSet)
       # Load the rule set into the parser.
       initRules
+      updateParserTables
       # The sections and numbered list can each nest 3 levels deep. We use these
       # counter Arrays to generate proper 1.2.3 type labels.
       @sectionCounter = sectionCounter
       @numberListCounter = [ 0, 0, 0, 0 ]
     end
 
+    def reuse(messageHandler, rti, sectionCounter = [ 0, 0, 0, 0],
+              tokenSet = nil)
+      @blockedVariables = {}
+      @stack = nil
+      @richTextI = rti
+      @messageHandler = messageHandler
+      @sectionCounter = sectionCounter
+      limitTokenSet(tokenSet)
+    end
+
     # Construct the parser and get ready to read.
     def open(text)
       # Make sure that the last line is properly terminated with a newline.

data/lib/RichTextScanner.rb

@@ -32,61 +32,61 @@ class TaskJuggler
     def initialize(masterFile, messageHandler)
       tokenPatterns = [
         # :bol mode rules
-        [ 'LINEBREAK', /\s*\n/, :bol, method('linebreak') ],
+        [ :LINEBREAK, /\s*\n/, :bol, method('linebreak') ],
         [ nil, /\s+/, :bol, method('inlineMode') ],
 
         # :bop mode rules
-        [ 'PRE', / [^\n]+\n?/, :bop, method('pre') ],
+        [ :PRE, / [^\n]+\n?/, :bop, method('pre') ],
         [ nil, /\s*\n/, :bop, method('linebreak') ],
 
         # :inline mode rules
-        [ 'SPACE', /[ \t\n]+/, :inline, method('space') ],
+        [ :SPACE, /[ \t\n]+/, :inline, method('space') ],
 
         # :bop and :bol mode rules
-        [ 'INLINEFUNCSTART', /<-/, [ :bop, :bol, :inline ],
+        [ :INLINEFUNCSTART, /<-/, [ :bop, :bol, :inline ],
           method('functionStart') ],
-        [ 'BLOCKFUNCSTART', /<\[/, [ :bop, :bol ], method('functionStart') ],
-        [ 'TITLE*', /={2,5}/, [ :bop, :bol ], method('titleStart') ],
+        [ :BLOCKFUNCSTART, /<\[/, [ :bop, :bol ], method('functionStart') ],
+        [ ':TITLE*', /={2,5}/, [ :bop, :bol ], method('titleStart') ],
         [ 'TITLE*END', /={2,5}/, :inline, method('titleEnd') ],
         [ 'BULLET*', /\*{1,4} /, [ :bop, :bol ], method('bullet') ],
         [ 'NUMBER*', /\#{1,4} /, [ :bop, :bol ], method('number') ],
-        [ 'HLINE', /----/, [ :bop, :bol ], method('inlineMode') ],
+        [ :HLINE, /----/, [ :bop, :bol ], method('inlineMode') ],
 
         # :bop, :bol and :inline mode rules
         # The <nowiki> token puts the scanner into :nowiki mode.
         [ nil, /<nowiki>/, [ :bop, :bol, :inline ], method('nowikiStart') ],
-        [ 'QUOTES', /'{2,5}/, [ :bop, :bol, :inline ], method('quotes') ],
-        [ 'REF', /\[\[/, [ :bop, :bol, :inline ], method('refStart') ],
-        [ 'HREF', /\[/, [ :bop, :bol, :inline], method('hrefStart') ],
-        [ 'WORD', /.[^ \n\t\[<']*/, [ :bop, :bol, :inline ],
+        [ :QUOTES, /'{2,5}/, [ :bop, :bol, :inline ], method('quotes') ],
+        [ :REF, /\[\[/, [ :bop, :bol, :inline ], method('refStart') ],
+        [ :HREF, /\[/, [ :bop, :bol, :inline], method('hrefStart') ],
+        [ :WORD, /.[^ \n\t\[<']*/, [ :bop, :bol, :inline ],
           method('inlineMode') ],
 
         # :nowiki mode rules
         [ nil, /<\/nowiki>/, :nowiki, method('nowikiEnd') ],
-        [ 'WORD', /(<(?!\/nowiki>)|[^ \t\n<])+/, :nowiki ],
-        [ 'SPACE', /[ \t]+/, :nowiki ],
-        [ 'LINEBREAK', /\s*\n/, :nowiki ],
+        [ :WORD, /(<(?!\/nowiki>)|[^ \t\n<])+/, :nowiki ],
+        [ :SPACE, /[ \t]+/, :nowiki ],
+        [ :LINEBREAK, /\s*\n/, :nowiki ],
 
         # :ref mode rules
-        [ 'REFEND', /\]\]/, :ref, method('refEnd') ],
-        [ 'WORD', /(<(?!-)|(\](?!\])|[^|<\]]))+/, :ref ],
-        [ 'QUERY', /<-\w+->/, :ref, method('query') ],
-        [ 'LITERAL', /./, :ref ],
+        [ :REFEND, /\]\]/, :ref, method('refEnd') ],
+        [ :WORD, /(<(?!-)|(\](?!\])|[^|<\]]))+/, :ref ],
+        [ :QUERY, /<-\w+->/, :ref, method('query') ],
+        [ :LITERAL, /./, :ref ],
 
         # :href mode rules
-        [ 'HREFEND', /\]/, :href, method('hrefEnd') ],
-        [ 'WORD', /(<(?!-)|[^ \t\n\]<])+/, :href ],
-        [ 'QUERY', /<-\w+->/, :href, method('query') ],
-        [ 'SPACE', /[ \t\n]+/, :href ],
+        [ :HREFEND, /\]/, :href, method('hrefEnd') ],
+        [ :WORD, /(<(?!-)|[^ \t\n\]<])+/, :href ],
+        [ :QUERY, /<-\w+->/, :href, method('query') ],
+        [ :SPACE, /[ \t\n]+/, :href ],
 
         # :func mode rules
-        [ 'INLINEFUNCEND', /->/ , :func, method('functionEnd') ],
-        [ 'BLOCKFUNCEND', /\]>/, :func, method('functionEnd') ],
-        [ 'ID', /[a-zA-Z_]\w*/, :func ],
-        [ 'STRING', /"(\\"|[^"])*"/, :func, method('dqString') ],
-        [ 'STRING', /'(\\'|[^'])*'/, :func, method('sqString') ],
+        [ :INLINEFUNCEND, /->/ , :func, method('functionEnd') ],
+        [ :BLOCKFUNCEND, /\]>/, :func, method('functionEnd') ],
+        [ :ID, /[a-zA-Z_]\w*/, :func ],
+        [ :STRING, /"(\\"|[^"])*"/, :func, method('dqString') ],
+        [ :STRING, /'(\\'|[^'])*'/, :func, method('sqString') ],
         [ nil, /[ \t\n]+/, :func ],
-        [ 'LITERAL', /./, :func ]
+        [ :LITERAL, /./, :func ]
       ]
       super(masterFile, messageHandler, tokenPatterns, :bop)
     end
@@ -100,7 +100,7 @@ class TaskJuggler
         # And return an empty string.
         match = ''
       end
-      [type, match ]
+      [ type, match ]
     end
 
     def linebreak(type, match)
@@ -115,26 +115,26 @@ class TaskJuggler
 
     def titleStart(type, match)
       self.mode = :inline
-      [ "TITLE#{match.length - 1}", match ]
+      [ "TITLE#{match.length - 1}".intern, match ]
     end
 
     def titleEnd(type, match)
-      [ "TITLE#{match.length - 1}END", match ]
+      [ "TITLE#{match.length - 1}END".intern, match ]
     end
 
     def bullet(type, match)
       self.mode = :inline
-      [ "BULLET#{match.length - 1}", match ]
+      [ "BULLET#{match.length - 1}".intern, match ]
     end
 
     def number(type, match)
       self.mode = :inline
-      [ "NUMBER#{match.length - 1}", match ]
+      [ "NUMBER#{match.length - 1}".intern, match ]
     end
 
     def quotes(type, match)
       self.mode = :inline
-      types = [ nil, nil, 'ITALIC', 'BOLD' , 'CODE', 'BOLDITALIC' ]
+      types = [ nil, nil, :ITALIC, :BOLD , :CODE, :BOLDITALIC ]
       [ types[match.length], match ]
     end
 

data/lib/RichTextSyntaxRules.rb

@@ -35,32 +35,38 @@ class TaskJuggler
       })
     end
 
-    # The following syntax elements are all block elements that can span
-    # multiple lines.
     def rule_sections
       optional
       repeatable
-      pattern(%w( !headlines !blankLines ), lambda {
+      pattern(%w( !section !blankLines ), lambda {
         @val[0]
       })
-      pattern(%w( $HLINE !blankLines ), lambda {
+    end
+
+    # The following syntax elements are all block elements that can span
+    # multiple lines.
+    def rule_section
+      pattern(%w( !headlines ), lambda {
+        @val[0]
+      })
+      pattern(%w( $HLINE ), lambda {
         RichTextElement.new(@richTextI, :hline, @val[0])
       })
-      pattern(%w( !paragraph !blankLines ), lambda {
+      pattern(%w( !paragraph ), lambda {
         @val[0]
       })
-      pattern(%w( !pre !blankLines ), lambda {
+      pattern(%w( !pre ), lambda {
         RichTextElement.new(@richTextI, :pre, @val[0].join)
       })
-      pattern(%w( !bulletList1 !blankLines ), lambda {
+      pattern(%w( !bulletList1 ), lambda {
 
         RichTextElement.new(@richTextI, :bulletlist1, @val[0])
       })
-      pattern(%w( !numberList1 !blankLines ), lambda {
+      pattern(%w( !numberList1 ), lambda {
         @numberListCounter = [ 0, 0, 0, 0 ]
         RichTextElement.new(@richTextI, :numberlist1, @val[0])
       })
-      pattern(%w( !blockFunction !blankLines ), lambda {
+      pattern(%w( !blockFunction ), lambda {
         @val[0]
       })
     end
@@ -242,19 +248,19 @@ class TaskJuggler
         # Since the italic end marker will disappear we need to make sure
         # there was no space before it.
         @val[2].last.appendSpace = false if @val[2].last
-        el.appendSpace = !@val[4].empty?
+        el.appendSpace = !@val[4].nil?
         el
       })
       pattern(%w( $BOLD !space !plainTextWithLinks $BOLD !space ), lambda {
         el = RichTextElement.new(@richTextI, :bold, @val[2])
         @val[2].last.appendSpace = false if @val[2].last
-        el.appendSpace = !@val[4].empty?
+        el.appendSpace = !@val[4].nil?
         el
       })
       pattern(%w( $CODE !space !plainTextWithLinks $CODE !space ), lambda {
         el = RichTextElement.new(@richTextI, :code, @val[2])
         @val[2].last.appendSpace = false if @val[2].last
-        el.appendSpace = !@val[4].empty?
+        el.appendSpace = !@val[4].nil?
         el
       })
       pattern(%w( $BOLDITALIC !space !plainTextWithLinks $BOLDITALIC !space ),
@@ -263,13 +269,12 @@ class TaskJuggler
                             :bold, RichTextElement.new(@richTextI,
                                                        :italic, @val[2]))
         @val[2].last.appendSpace = false if @val[2].last
-        el.appendSpace = !@val[4].empty?
+        el.appendSpace = !@val[4].nil?
         el
       })
     end
 
     def rule_plainTextWithLinks
-      repeatable
       pattern(%w( !plainText ), lambda {
         @val[0]
       })
@@ -291,34 +296,34 @@ class TaskJuggler
             error('rt_file_bad_ext', "Unsupported file type: #{extension}")
           end
           el.data = img = RichTextImage.new(locator)
-          @val[2].each do |token|
-            if token[0, 4] == 'alt='
-              img.altText = token[4..-1]
-            elsif %w( top middle bottom baseline sub super text-top
-                      text-bottom ).include?(token)
-              img.verticalAlign = token
-            else
-              error('rt_bad_file_option',
-                    "Unknown option '#{token}' for file reference " +
-                    "#{v1}.")
+          if @val[2]
+            @val[2].each do |token|
+              if token[0, 4] == 'alt='
+                img.altText = token[4..-1]
+              elsif %w( top middle bottom baseline sub super text-top
+                        text-bottom ).include?(token)
+                img.verticalAlign = token
+              else
+                error('rt_bad_file_option',
+                      "Unknown option '#{token}' for file reference " +
+                      "#{v1}.")
+              end
             end
           end
         else
+          val = @val[2] || v1
           el = RichTextElement.new(@richTextI, :ref,
-                                   RichTextElement.new(@richTextI,
-                                                       :text, @val[2].empty? ?
-                                                       v1 : @val[2]))
+                                   RichTextElement.new(@richTextI, :text, val))
           el.data = v1
-          el.appendSpace = !@val[4].empty?
+          el.appendSpace = !@val[4].nil?
         end
         el
       })
       pattern(%w( $HREF !wordWithQueries !space !plainTextWithQueries
                   $HREFEND !space ), lambda {
-        el = RichTextElement.new(@richTextI, :href, @val[3].empty? ?
-                                 @val[1] : @val[3])
+        el = RichTextElement.new(@richTextI, :href, @val[3] || @val[1])
         el.data = RichTextElement.new(@richTextI, :richtext, @val[1])
-        el.appendSpace = !@val[5].empty?
+        el.appendSpace = !@val[5].nil?
         el
       })
     end
@@ -361,7 +366,7 @@ class TaskJuggler
       optional
       pattern(%w( $WORD !space ), lambda {
         el = RichTextElement.new(@richTextI, :text, @val[0])
-        el.appendSpace = !@val[1].empty?
+        el.appendSpace = !@val[1].nil?
         el
       })
     end
@@ -370,7 +375,7 @@ class TaskJuggler
       repeatable
       optional
       pattern(%w( !wordWithQueries !space ), lambda {
-        @val[0][-1].appendSpace = true if !@val[1].empty?
+        @val[0][-1].appendSpace = true if @val[1]
         @val[0]
       })
     end
@@ -394,7 +399,7 @@ class TaskJuggler
       pattern(%w( $BLOCKFUNCSTART $ID !functionArguments $BLOCKFUNCEND ),
               lambda {
         args = {}
-        @val[2].each { |arg| args[arg[0]] = arg[1] }
+        @val[2].each { |arg| args[arg[0]] = arg[1] } if @val[2]
         el = RichTextElement.new(@richTextI, :blockfunc)
         # Data is a 2 element Array with the function name and a Hash for the
         # arguments.
@@ -412,7 +417,7 @@ class TaskJuggler
                   !space ),
               lambda {
         args = {}
-        @val[2].each { |arg| args[arg[0]] = arg[1] }
+        @val[2].each { |arg| args[arg[0]] = arg[1] } if @val[2]
         el = RichTextElement.new(@richTextI, :inlinefunc)
         # Data is a 2 element Array with the function name and a Hash for the
         # arguments.
@@ -421,7 +426,7 @@ class TaskJuggler
                 "Unsupported inline function #{@val[1]}")
         end
         el.data = [@val[1], args ]
-        el.appendSpace = !@val[4].empty?
+        el.appendSpace = !@val[4].nil?
         el
       })
     end

data/lib/Scoreboard.rb

@@ -52,20 +52,29 @@ class TaskJuggler
     # Converts a date to the corresponding scoreboard index. You can optionally
     # sanitize the _date_ by forcing it into the project time span.
     def dateToIdx(date, forceIntoProject = false)
+      idx = ((date - @startDate) / @resolution).to_i
+
       if forceIntoProject
-        return 0 if date < @startDate
-        return @size - 1 if date >= @endDate
-      elsif date < @startDate || date > @endDate
+        return 0 if idx < 0
+        return @size - 1 if idx >= @size
+      elsif (idx < 0 || idx >= @size)
         raise "Date #{date} is out of project time range " +
               "(#{@startDate} - #{@endDate})"
       end
-      ((date - @startDate) / @resolution).to_i
+
+      idx
     end
 
     # Iterate over all scoreboard entries.
-    def each
-      @sb.each do |entry|
-        yield entry
+    def each(startIdx = 0, endIdx = @size)
+      if startIdx != 0 || endIdx != @size
+        startIdx.upto(endIdx - 1) do |i|
+          yield @sb[i]
+        end
+      else
+        @sb.each do |entry|
+          yield entry
+        end
       end
     end
 

data/lib/StatusSheetSender.rb

@@ -30,6 +30,8 @@ class TaskJuggler
       @hideResource = '0'
       # The base directory of the status sheet templates.
       @templateDir = 'StatusSheetTemplates'
+      # The base directory of the received time sheets.
+      @timeSheetDir = 'TimeSheets'
       # This file contains the time intervals that the StatusSheetReceiver will
       # accept as a valid interval.
       @signatureFile = "#{@templateDir}/acceptable_intervals"
@@ -46,9 +48,70 @@ 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
+      # tj3ts_summary generates a list of resources that have not submitted
+      # their reports yet. If you want to generate the warning below, make
+      # sure you run tj3ts_summary immediately before you sent the status sheet
+      # templates.
+      defaulters = defaulterList
+      unless defaulters.empty?
+        @introText += <<"EOT"
+=============================== W A R N I N G ==============================
+
+The following people have not submitted their report yet. The status reports
+for the work they have done is not included in this template! You can either
+manually add their status to the tasks or asked them to send their time sheet
+immediately and re-request this template.
+
+#{defaulters.join}
+
+EOT
+      end
+
       @mailSubject = "Your weekly status report template for %s"
     end
 
+    def defaulterList
+      dirs = Dir.glob("#{@timeSheetDir}/????-??-??").sort
+      tsDir = nil
+      # The status sheet intervals and the time sheet intervals are not
+      # identical. The status sheet interval can be smaller and is somewhat
+      # later. But it always includes the end date of the corresponding time
+      # sheet period. To get the file with the IDs of the resources that have
+      # not submitted their report, we need to find the time sheet directory
+      # that is within the status sheet period.
+      repDate = Time.local(*@date.split('-'))
+      dirs.each do |dir|
+        dirDate = Time.local(*dir[-10..-1].split('-'))
+        if dirDate < repDate
+          tsDir = dir
+        else
+          break
+        end
+      end
+      # Check if there is a time sheet directory.
+      return [] unless tsDir
+
+      missingFile = "#{tsDir}/missing-reports"
+      # Check if it's got a missing-reports file.
+      return [] if !File.exists?(missingFile)
+
+      # The sheet could have been submitted after tj3ts_summary was run. We
+      # ignore the entry if a time sheet file now exists. There is a race
+      # condition here. The file may exist, but it may not yet be loaded for
+      # the current project that is used to generate the status report. There
+      # is a race condition here. The file may exist, but it may not yet be
+      # loaded for the current project that is used to generate the status
+      # report.
+      list = File.readlines(missingFile)
+      list.delete_if do |resource|
+        tsDate = tsDir[-10..-1]
+        File.exists?("#{tsDir}/#{resource.chomp}_#{tsDate}.tji")
+      end
+
+      # Return the content of the file.
+      list
+    end
+
   end
 
 end