taskjuggler 3.3.0 → 3.4.0

data/lib/taskjuggler/TextParser.rb

@@ -341,8 +341,7 @@ class TaskJuggler
                   "Unexpected token '#{token[1]}' found. " +
                   "Expecting #{@stack.last.state.expectedTokens.length > 1 ?
                                'one of ' : ''}" +
-                  "#{@stack.last.state.expectedTokens.join(', ')}",
-                  @scanner.sourceFileInfo)
+                  "#{@stack.last.state.expectedTokens.join(', ')}", token[2])
           end
           if finishPattern(token)
             # Accept: We're done with parsing.
@@ -378,8 +377,7 @@ class TaskJuggler
         # rules.
         error('unexpctd_token', "Unexpected token '#{token[1]}' found. " +
               "Expecting one of " +
-              "#{stackEntry.state.expectedTokens.join(', ')}",
-              @scanner.sourceFileInfo)
+              "#{stackEntry.state.expectedTokens.join(', ')}", token[2])
       end
       # Memorize if the rule for this pattern was repeatable. Then we will
       # store the result of the pattern in an Array.

data/lib/taskjuggler/TextParser/MacroTable.rb

@@ -57,6 +57,13 @@ class TaskJuggler::TextParser
     # unchanged. No error is generated.
     def resolve(args, sourceFileInfo)
       name = args[0]
+      # If the first character of the macro name is a '?', the macro may be
+      # undefined and is silently ignored.
+      if name[0] == ??
+        # Remove the '?' from the name.
+        name = name[1..-1]
+        return [ nil, '' ] unless @macros[name]
+      end
       return nil unless @macros[name]
 
       resolved = @macros[name].value.dup

data/lib/taskjuggler/TextParser/Scanner.rb

@@ -174,7 +174,7 @@ class TaskJuggler::TextParser
         begin
           @stream = StringIO.new(data.forceUTF8Encoding)
         rescue
-          error('fileEncoding', $!)
+          error('fileEncoding', $!.message)
         end
         @log.msg { "Parsing file #{@fileName} ..." }
         @log.startProgressMeter("Reading file #{fileName}")
@@ -195,7 +195,7 @@ class TaskJuggler::TextParser
         begin
           @stream = StringIO.new(buffer.forceUTF8Encoding)
         rescue
-          error('bufferEncoding', $!)
+          error('bufferEncoding', $!.message)
         end
         #@log.msg { "Parsing buffer #{buffer[0, 20]} ..." }
       end
@@ -242,9 +242,9 @@ class TaskJuggler::TextParser
       tokenPatterns.each do |pat|
         type = pat[0]
         regExp = pat[1]
-        mode = pat[3] || :tjp
-        postProc = pat[4]
-        addPattern(type, Regexp.new(regExp), mode, postProc)
+        mode = pat[2] || :tjp
+        postProc = pat[3]
+        addPattern(type, regExp, mode, postProc)
       end
       self.mode = defaultMode
     end
@@ -449,13 +449,14 @@ class TaskJuggler::TextParser
     def expandMacro(prefix, args, callLength)
       # Get the expanded macro from the @macroTable.
       macro, text = @macroTable.resolve(args, sourceFileInfo)
-      unless macro && text
-        error('undefined_macro', "Undefined macro '#{args[0]}' called")
-      end
 
       # If the expanded macro is empty, we can ignore it.
       return if text == ''
 
+      unless macro && text
+        error('undefined_macro', "Undefined macro '#{args[0]}' called")
+      end
+
       unless @cf.injectMacro(macro, args, prefix + text, callLength)
         error('macro_stack_overflow', "Too many nested macro calls.")
       end
@@ -526,7 +527,7 @@ class TaskJuggler::TextParser
       rescue ArgumentError
         # This is triggered by StringScanner.scan, but we don't want to put
         # the block in the inner loops for performance reasons.
-        error('scan_encoding_error', $!.to_s)
+        error('scan_encoding_error', $!.message)
       end
     end
 

data/lib/taskjuggler/Tj3Config.rb

@@ -14,7 +14,7 @@
 require 'taskjuggler/UTF8String'
 require 'taskjuggler/AppConfig'
 
-AppConfig.version = '3.3.0'
+AppConfig.version = '3.4.0'
 AppConfig.packageName = 'taskjuggler'
 AppConfig.softwareName = 'TaskJuggler'
 AppConfig.packageInfo = 'A Project Management Software'

data/lib/taskjuggler/TjTime.rb

@@ -370,10 +370,13 @@ class TaskJuggler
     def to_s(format = nil)
       return 'unknown' if @time.nil?
       if format.nil?
-        format = '%Y-%m-%d-%H:%M' + (@time.sec == 0 ? '' : ':%S') + '-%z'
+        fmt = '%Y-%m-%d-%H:%M' + (@time.sec == 0 ? '' : ':%S') + '-%z'
+      else
+        # Handle TJ specific extensions to the strftime format.
+        fmt = format.sub(/%Q/, "#{((localtime.mon - 1) / 3) + 1}")
       end
       # Always report values in local timezone
-      localtime.strftime(format)
+      localtime.strftime(fmt)
     end
 
     # Return the seconds since Epoch.
@@ -416,32 +419,6 @@ class TaskJuggler
       localtime.year
     end
 
-    # Return the abbreviated month name.
-    def shortMonthName
-      localtime.strftime('%b')
-    end
-
-    # Return the number of the quarter prefixed by a 'Q'.
-    def quarterName
-      "Q#{(localtime.mon / 3) + 1}"
-    end
-
-    # Return the week number. _weekStartsMonday_ specifies wheter the counting
-    # should be for weeks starting Mondays or Sundays.
-    def week(weekStartsMonday)
-      localtime.strftime(weekStartsMonday ? '%W' : '%U')
-    end
-
-    # Return the abbreviated month name and the full year. E. g. 'Feb 1972'.
-    def monthAndYear
-      localtime.strftime('%b %Y')
-    end
-
-    # Return the abbreviated weekday and the full date. E. g. 'Sat 2007-11-03'.
-    def weekdayAndDate
-      localtime.strftime('%A %Y-%m-%d')
-    end
-
   private
 
     def parse(t)

data/lib/taskjuggler/TjpSyntaxRules.rb

@@ -839,6 +839,26 @@ invariant values.
 EOT
        )
 
+    pattern(%w( _timeformat1 $STRING ), lambda {
+      @column.timeformat1 = @val[1]
+    })
+    doc('timeformat1', <<'EOT'
+Specify an alternative format for the upper header line of calendar or Gantt
+chart columns.
+EOT
+       )
+    arg(1, 'format', 'See [[timeformat]] for details.')
+
+    pattern(%w( _timeformat2 $STRING ), lambda {
+      @column.timeformat2 = @val[1]
+    })
+    doc('timeformat2', <<'EOT'
+Specify an alternative format for the lower header line of calendar or Gantt
+chart columns.
+EOT
+       )
+    arg(1, 'format', 'See [[timeformat]] for details.')
+
     pattern(%w( _title $STRING ), lambda {
       @column.title = @val[1]
     })
@@ -3670,14 +3690,14 @@ EOT
     singlePattern('_annualleave')
     descr(<<'EOT'
 The number of annual leave units within the reported time period. The unit
-can be adjusted with [[loadunit.report]].
+can be adjusted with [[loadunit]].
 EOT
          )
 
     singlePattern('_annualleavebalance')
     descr(<<'EOT'
 The balance of the annual leave at the end of the reporting interval. The unit
-can be adjusted with [[loadunit.report]].
+can be adjusted with [[loadunit]].
 EOT
          )
 
@@ -3704,8 +3724,8 @@ EOT
     singlePattern('_alerttrend')
     descr(<<'EOT'
 Shows how the alert level at the end of the report period compares to the
-alert level at the begining of the report period. Possible values are up, down
-or flat.
+alert level at the begining of the report period. Possible values are
+''''Up'''', ''''Down'''' or ''''Flat''''.
 EOT
          )
 
@@ -3730,6 +3750,19 @@ EOT
 The number of sub-tasks (including the current task) that have been closed
 during the reported time period.  Closed means that they have and end date
 before the current time or [[now]] date.
+EOT
+         )
+
+    singlePattern('_competitorcount')
+    descr(<<'EOT'
+The number of tasks that have successfully competed for the same resources and
+have potentially delayed the completion of this task.
+EOT
+         )
+    singlePattern('_competitors')
+    descr(<<'EOT'
+A list of tasks that have successfully competed for the same resources and
+have potentially delayed the completion of this task.
 EOT
          )
 
@@ -4020,20 +4053,26 @@ EOT
     singlePattern('_scenario')
     descr('The name of the scenario')
 
+    singlePattern('_scheduling')
+    descr(<<'EOT'
+The scheduling mode of the leaf tasks. ASAP tasks are scheduled start to end while ALAP tasks are scheduled end to start.
+EOT
+         )
+
     singlePattern('_seqno')
     descr('The index of the item based on the declaration order')
 
     singlePattern('_sickleave')
     descr(<<'EOT'
 The number of sick leave units within the reported time period. The unit can
-be adjusted with [[loadunit.report]].
+be adjusted with [[loadunit]].
 EOT
          )
 
     singlePattern('_specialleave')
     descr(<<'EOT'
 The number of special leave units within the reported time period. The unit
-can be adjusted with [[loadunit.report]].
+can be adjusted with [[loadunit]].
 EOT
          )
 
@@ -4067,7 +4106,7 @@ EOT
     singlePattern('_unpaidleave')
     descr(<<'EOT'
 The number of unpaid leave units within the reported time period. The unit
-can be adjusted with [[loadunit.report]].
+can be adjusted with [[loadunit]].
 EOT
          )
 
@@ -4100,6 +4139,22 @@ EOT
        )
     example('AccountReport')
 
+    pattern(%w( _auxdir $STRING ), lambda {
+      auxdir = @val[1]
+      # Ensure that the directory always ends with a '/'.
+      auxdir += '/' unless auxdir[-1] == ?/
+      @property.set('auxdir', auxdir)
+    })
+    level(:beta)
+    doc('auxdir', <<'EOT'
+Specifies an alternative directory for the auxiliary report files such as CSS,
+JavaScript and icon files. If this attribute is not set, the directoy will be
+generated automatically. If an alternative is provided, the user has to ensure
+that the directory exists and is filled with the proper data. The specified
+path and be absolute or relative to the generated report file.
+EOT
+       )
+
     pattern(%w( !balance ), lambda {
       @property.set('costaccount', @val[0][0])
       @property.set('revenueaccount', @val[0][1])
@@ -4254,6 +4309,16 @@ EOT
     also(%w( epilog footer header ))
 
     pattern(%w( !purge ))
+
+    pattern(%w( _rawhtmlhead $STRING ), lambda {
+      @property.set('rawHtmlHead', @val[1])
+    })
+    doc('rawhtmlhead', <<'EOT'
+Define a HTML fragment that will be inserted at the end of the HTML head
+section.
+EOT
+       )
+
     pattern(%w( !reports ))
 
     pattern(%w( _right $STRING ), lambda {
@@ -5315,8 +5380,9 @@ EOT
       newReport(@val[1], @val[2], :statusSheet, @sourceFileInfo[0])
       @property.set('formats', [ :tjp ])
 
-      unless @project.scenario(0).get('active')
-        @property.set('scenarios', [ 0 ])
+      unless (@project['trackingScenarioIdx'])
+        error('ss_no_tracking_scenario',
+              'You must have a tracking scenario defined to use status sheets.')
       end
       # Show all tasks, sorted by id-up.
       @property.set('hideTask', LogicalExpression.new(LogicalOperation.new(0)))
@@ -5627,8 +5693,8 @@ EOT
       @property.set('sortResources', [ [ 'seqno', true, -1 ] ])
     })
     arg(2, 'file name', <<'EOT'
-The name of the tagfile to generate. You can leave it empty and it will
-default to the commonly used name ''''tags''''.
+The name of the tagfile to generate. Use ''''tags'''' if you want vim and
+other tools to find it automatically.
 EOT
        )
   end
@@ -6437,6 +6503,10 @@ higher priority. This can result in situations where high priority tasks do
 not get their resources even though the parallel competing tasks have a much
 lower priority.
 
+ALAP tasks may not have [[booking.task|bookings]] since the first booked slot
+determines the start date of the task and prevents it from being scheduled
+from end to start.
+
 As a general rule, try to avoid ALAP tasks whenever possible. Have a close
 eye on tasks that have been switched implicitly to ALAP mode because the
 end attribute comes after the start attribute.
@@ -6971,9 +7041,11 @@ EOT
       newReport(@val[1], @val[2], :timeSheet, @sourceFileInfo[0])
       @property.set('formats', [ :tjp ])
 
-      unless @project.scenario(0).get('active')
-        @property.set('scenarios', [ 0 ])
+      unless (scenarioIdx = @project['trackingScenarioIdx'])
+        error('ts_no_tracking_scenario',
+              'You must have a tracking scenario defined to use time sheets.')
       end
+      @property.set('scenarios', [ scenarioIdx ])
       # Show all tasks, sorted by seqno-up.
       @property.set('hideTask', LogicalExpression.new(LogicalOperation.new(0)))
       @property.set('sortTasks', [ [ 'seqno', true, -1 ] ])

data/lib/taskjuggler/UTF8String.rb

@@ -86,6 +86,11 @@ class String
       len
     end
 
+    def ljust(len, pad = ' ')
+      return self + pad * (len - length_utf8) if length_utf8 < len
+      self
+    end
+
     alias old_reverse reverse
 
     # UTF-8 aware version of reverse that replaces the built-in one.

data/lib/taskjuggler/XMLElement.rb

@@ -87,7 +87,7 @@ class TaskJuggler
         end
         @children += arg
       elsif arg.nil?
-        # do nothing
+        # Do nothing. Insertions of nil are simply ignored.
       else
         raise "Elements must be of type XMLElement not #{arg.class}"
       end
@@ -215,6 +215,7 @@ class TaskJuggler
 
     def initialize(blob = '')
       super(nil, {})
+      raise ArgumentError, "blob may not be nil" if blob.nil?
       @blob = blob
     end
 

data/lib/taskjuggler/apps/Tj3.rb

@@ -35,6 +35,10 @@ class TaskJuggler
       @checkSyntax = false
       # Don't generate reports when previous errors have been found.
       @forceReports = false
+      # List of requested report IDs.
+      @reportIDs = []
+      # List of requested report IDs (as regular expressions).
+      @reportRegExpIDs = []
       # Don't generate trace reports by default
       @generateTraces = false
       # Should a booking file be generated?
@@ -72,10 +76,6 @@ EOT
                 format('Restrict debug output to a list of modules')) do |arg|
           TaskJuggler::Log.segments = arg
         end
-        @opts.on('-f', '--force-reports',
-                format('Generate reports despite scheduling errors')) do
-          @forceReports = true
-        end
         @opts.on('--freeze',
                  format('Generate or update the booking file for ' +
                         'the project. The file will have the same ' +
@@ -120,6 +120,21 @@ EOT
                        'reports.')) do
          @noReports = true
         end
+        @opts.on('--report <report ID>', String,
+                 format('Only generate the report with the specified ID. ' +
+                        'This option can be used multiple times.')) do |arg|
+          @reportIDs << arg
+        end
+        @opts.on('--reports <report ID RegExp>', String,
+                 format('Only generate the reports that have IDs that match ' +
+                        'the specified regular expression. This option can ' +
+                        'be used multiple times.')) do |arg|
+          @reportRegExpIDs << arg
+        end
+        @opts.on('-f', '--force-reports',
+                format('Generate reports despite scheduling errors')) do
+          @forceReports = true
+        end
         @opts.on('--add-trace',
                  format('Append a current data set to all trace reports.')) do
           @generateTraces = true
@@ -181,7 +196,16 @@ EOT
 
       return 0 if @noReports
 
-      return 1 if !tj.generateReports(@outputDir) || tj.errors > 0
+      if @reportIDs.empty? && @reportRegExpIDs.empty?
+        return 1 if !tj.generateReports(@outputDir) || tj.errors > 0
+      else
+        @reportIDs.each do |id|
+          return 1 if !tj.generateReport(id, false)
+        end
+        @reportRegExpIDs.each do |id|
+          return 1 if !tj.generateReport(id, true)
+        end
+      end
 
       0
     end

data/lib/taskjuggler/daemon/ProcessIntercom.rb

@@ -29,7 +29,7 @@ class TaskJuggler
         MessageHandlerInstance.instance.trapSetup = false
         res
       rescue => e
-        # Any exception here is a fata error. We try hard to terminate the DRb
+        # Any exception here is a fatal error. We try hard to terminate the DRb
         # thread and then exit the program.
         begin
           fatal('pi_crash_trap', "#{e}\n#{e.backtrace.join("\n")}\n\n" +

data/lib/taskjuggler/daemon/ProjectServer.rb

@@ -340,8 +340,11 @@ class TaskJuggler
             # If we have not received a ping from the ProjectBroker for 2
             # minutes, we assume it has died and terminate as well.
             if TjTime.new - @lastPing > 180
-              error('daemon_heartbeat_lost',
-                    'Heartbeat from daemon lost. Terminating.')
+              # Since the abort via error() is not thread safe, we issue a
+              # warning and abort manually.
+              warning('daemon_heartbeat_lost',
+                      'Heartbeat from daemon lost. Terminating.')
+              exit 1
             end
             sleep 1
           end