taskjuggler 3.1.0 → 3.2.0

data/lib/taskjuggler/RichText/RTFNavigator.rb

@@ -24,7 +24,7 @@ class TaskJuggler
 
     def initialize(project, sourceFileInfo = nil)
       @project = project
-      super(project.messageHandler, 'navigator', sourceFileInfo)
+      super('navigator', sourceFileInfo)
       @blockFunction = true
     end
 

data/lib/taskjuggler/RichText/RTFQuery.rb

@@ -23,7 +23,7 @@ class TaskJuggler
 
     def initialize(project, sourceFileInfo = nil)
       @project = project
-      super(project.messageHandler, 'query', sourceFileInfo)
+      super('query', sourceFileInfo)
       @blockMode = false
     end
 
@@ -83,8 +83,7 @@ class TaskJuggler
           return nil
         end
         expandedArgs[arg] =
-          SimpleQueryExpander.new(value, @query, @messageHandler,
-                                  @sourceFileInfo).expand
+          SimpleQueryExpander.new(value, @query, @sourceFileInfo).expand
       end
 
       if (expandedArgs['property'] || expandedArgs['scopeproperty']) &&

data/lib/taskjuggler/RichText/RTFReport.rb

@@ -22,7 +22,7 @@ class TaskJuggler
 
     def initialize(project, sourceFileInfo = nil)
       @project = project
-      super(project.messageHandler, 'report', sourceFileInfo)
+      super('report', sourceFileInfo)
       @blockFunction = true
     end
 

data/lib/taskjuggler/RichText/RTFReportLink.rb

@@ -24,7 +24,7 @@ class TaskJuggler
 
     def initialize(project, sourceFileInfo = nil)
       @project = project
-      super(project.messageHandler, 'reportlink', sourceFileInfo)
+      super('reportlink', sourceFileInfo)
       @blockFunction = false
       @query = nil
     end
@@ -54,7 +54,6 @@ class TaskJuggler
 
         if args['attributes']
           qEx = SimpleQueryExpander.new(args['attributes'], @query,
-                                        @project.messageHandler,
                                         @sourceFileInfo)
           url += ";attributes=" + URLParameter.encode(qEx.expand)
         end

data/lib/taskjuggler/RichText/RTFWithQuerySupport.rb

@@ -17,7 +17,7 @@ class TaskJuggler
 
   class RTFWithQuerySupport < RichTextFunctionHandler
 
-    def initialize(messageHandler, type, sourceFileInfo = nil)
+    def initialize(type, sourceFileInfo = nil)
       super
       @query = nil
     end

data/lib/taskjuggler/RichText/Scanner.rb

@@ -30,7 +30,7 @@ class TaskJuggler
   # :func :    inside of a block <[ .. ]> or inline <- .. -> function
   class RichTextScanner < TextParser::Scanner
 
-    def initialize(masterFile, messageHandler, log)
+    def initialize(masterFile, log)
       tokenPatterns = [
         # :bol mode rules
         [ :LINEBREAK, /\s*\n/, :bol, method('linebreak') ],
@@ -49,8 +49,8 @@ class TaskJuggler
         [ :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') ],
+        [ 'BULLET*', /\*{1,4}[ \t]+/, [ :bop, :bol ], method('bullet') ],
+        [ 'NUMBER*', /\#{1,4}[ \t]+/, [ :bop, :bol ], method('number') ],
         [ :HLINE, /----/, [ :bop, :bol ], method('inlineMode') ],
 
         # :bop, :bol and :inline mode rules
@@ -94,7 +94,7 @@ class TaskJuggler
         [ nil, /[ \t\n]+/, :func ],
         [ :LITERAL, /./, :func ]
       ]
-      super(masterFile, messageHandler, log, tokenPatterns, :bop)
+      super(masterFile, log, tokenPatterns, :bop)
     end
 
     private
@@ -130,12 +130,12 @@ class TaskJuggler
 
     def bullet(type, match)
       self.mode = :inline
-      [ "BULLET#{match.length - 1}".intern, match ]
+      [ "BULLET#{match.count('*')}".intern, match ]
     end
 
     def number(type, match)
       self.mode = :inline
-      [ "NUMBER#{match.length - 1}".intern, match ]
+      [ "NUMBER#{match.count('#')}".intern, match ]
     end
 
     def fontColorStart(type, match)

data/lib/taskjuggler/RichText/Snip.rb

@@ -40,8 +40,7 @@ class TaskJuggler
       File.open(fileName) do |file|
         file.each_line { |line| text += line }
       end
-      rText = RichText.new(text, @document.functionHandlers,
-                           MessageHandler.new(true))
+      rText = RichText.new(text, @document.functionHandlers)
       unless (@richText = rText.generateIntermediateFormat(sectionCounter))
         exit
       end

data/lib/taskjuggler/RuntimeConfig.rb

@@ -29,8 +29,7 @@ class RuntimeConfig
     if configFile
       # Read user specified config file.
       unless loadConfigFile(configFile)
-        $stderr.puts "Config file #{configFile} not found!"
-        exit 1
+        error("Config file #{configFile} not found!")
       end
     else
       # Search config files in certain directories.
@@ -71,14 +70,13 @@ class RuntimeConfig
 
   def loadConfigFile(fileName)
     if File.exist?(fileName)
+      debug("Loading #{fileName}")
       begin
-        debug("Loading #{fileName}")
         @config = YAML::load(File.read(fileName))
-        debug(@config.to_s)
       rescue
-        $stderr.puts "Error in config file #{fileName}: #{$!}"
-        exit 1
+        error("Error in config file #{fileName}: #{$!}")
       end
+      debug(@config.to_s)
       return true
     end
     false
@@ -90,5 +88,10 @@ class RuntimeConfig
     puts message
   end
 
+  def error(message)
+    $stderr.puts message
+    exit 1
+  end
+
 end
 

data/lib/taskjuggler/ScenarioData.rb

@@ -25,6 +25,7 @@ class TaskJuggler
       @project = property.project
       @scenarioIdx = idx
       @attributes = attributes
+      @messageHandler = MessageHandlerInstance.instance
 
       # Register the scenario with the Task.
       @property.data[idx] = self
@@ -42,21 +43,21 @@ class TaskJuggler
     end
 
     def error(id, text, sourceFileInfo = nil, property = nil)
-      @project.messageHandler.error(
+      @messageHandler.error(
         id, text, sourceFileInfo || @property.sourceFileInfo, nil,
         property || @property,
         @project.scenario(@scenarioIdx))
     end
 
     def warning(id, text, sourceFileInfo = nil, property = nil)
-      @project.messageHandler.warning(
+      @messageHandler.warning(
         id, text, sourceFileInfo || @property.sourceFileInfo, nil,
         property || @property,
         @project.scenario(@scenarioIdx))
     end
 
     def info(id, text, sourceFileInfo = nil, property = nil)
-      @project.messageHandler.info(
+      @messageHandler.info(
         id, text, sourceFileInfo || @property.sourceFileInfo, nil,
         property || @property,
         @project.scenario(@scenarioIdx))

data/lib/taskjuggler/Scoreboard.rb

@@ -170,6 +170,12 @@ class TaskJuggler
       intervals
     end
 
+    def inspect
+      0.upto(@sb.length - 1) do |i|
+        puts "#{idxToDate(i)}: #{@sb[i]}"
+      end
+    end
+
   end
 
 end

data/lib/taskjuggler/SheetHandlerBase.rb

@@ -25,7 +25,8 @@ class TaskJuggler
     def initialize(appName)
       @appName = appName
       # User specific settings
-      @smtpServer= nil
+      @emailDeliveryMethod = 'smtp'
+      @smtpServer = nil
       @senderEmail = nil
       @workingDir = nil
       @scmCommand = nil
@@ -87,7 +88,14 @@ class TaskJuggler
 
     def setWorkingDir
       # Make sure the user has provided a properly setup config file.
-      error('\'smtpServer\' not configured') unless @smtpServer
+      case @emailDeliveryMethod
+      when 'smtp'
+        error('\'smtpServer\' not configured') unless @smtpServer
+      when 'sendmail'
+        # nothing to check
+      else
+        error("Unknown emailDeliveryMethod #{@emailDeliveryMethod}")
+      end
       error('\'senderEmail\' not configured') unless @senderEmail
 
       # Change into the specified working directory
@@ -156,11 +164,20 @@ class TaskJuggler
 
     def sendEmail(to, subject, message, attachment = nil, from = nil,
                   inReplyTo = nil)
-      Mail.defaults do
-        delivery_method :smtp, {
-          :address => @smtpServer,
-          :port => 25
-        }
+      case @emailDeliveryMethod
+      when 'smtp'
+        Mail.defaults do
+          delivery_method :smtp, {
+            :address => @smtpServer,
+            :port => 25
+          }
+        end
+      when 'sendmail'
+        Mail.defaults do
+          delivery_method :sendmail
+        end
+      else
+        raise "Unknown email delivery method: #{@emailDeliveryMethod}"
       end
 
       begin
@@ -202,7 +219,7 @@ class TaskJuggler
         puts "-- Email Start #{'-' * 60}\n#{mail.to_s}-- Email End #{'-' * 62}"
         log('INFO', "Show email '#{subject}' to #{to}")
       else
-        # Actually send out the email via SMTP.
+        # Actually send out the email.
         begin
           mail.deliver
         rescue

data/lib/taskjuggler/SimpleQueryExpander.rb

@@ -12,6 +12,7 @@
 #
 
 require 'strscan'
+require 'taskjuggler/MessageHandler'
 
 class TaskJuggler
 
@@ -22,20 +23,29 @@ class TaskJuggler
   # context of the query.
   class SimpleQueryExpander
 
+    include MessageHandler
+
     # _inputStr_ is the String with the embedded queries. _query_ is the Query
     # with that provides the evaluation context. _messageHandle_ is a
     # MessageHandler that will be used for error reporting. _sourceFileInfo_
     # is a SourceFileInfo reference used for error reporting.
-    def initialize(inputStr, query, messageHandler, sourceFileInfo)
+    def initialize(inputStr, query, sourceFileInfo)
       @inputStr = inputStr
       @query = query.dup
-      @messageHandler = messageHandler
       @sourceFileInfo = sourceFileInfo
     end
 
     def expand
       # Create a copy of the input string since we will modify it.
       str = @inputStr.dup
+
+      # The scenario name is not an attribute that can be queried. We need to
+      # handle this separately
+      if @query.scenarioIdx
+        str.gsub!(/<-scenario->/,
+                  @query.project.scenario(@query.scenarioIdx).id)
+      end
+
       # Replace all occurences of <-name->.
       str.gsub!(/<-[a-zA-Z][_a-zA-Z]*->/) do |match|
         attribute = match[2..-3]
@@ -45,9 +55,8 @@ class TaskJuggler
           @query.to_s
         else
           # The query failed. We report an error.
-          @messageHandler.error('sqe_expand_failed',
-                                "Unknown attribute #{attribute}",
-                                @sourceFileInfo)
+          error('sqe_expand_failed', "Unknown attribute #{attribute}",
+                @sourceFileInfo)
         end
       end
       str

data/lib/taskjuggler/SyntaxReference.rb

@@ -35,8 +35,7 @@ class TaskJuggler
     # SyntaxReference.
     def initialize(manual = nil, ignoreOld = false)
       @manual = manual
-      @messageHandler = MessageHandler.new(true)
-      @parser = ProjectFileParser.new(@messageHandler)
+      @parser = ProjectFileParser.new
       @parser.updateParserTables
 
       # This hash stores all documented keywords using the keyword as

data/lib/taskjuggler/TableColumnSorter.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = TableColumnSorter.rb -- The TaskJuggler III Project Management Software
+#
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
+#               by Chris Schlaeger <chris@linux.com>
+#
+# 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.
+#
+
+class TaskJuggler
+
+  # This class can rearrange the columns of a table according to a new order
+  # determined by an Array of table headers. The table is an Array of table
+  # lines. Each line is another Array. The first line of the table is an Array
+  # of the headers of the columns.
+  class TableColumnSorter
+
+    attr_reader :discontinuedColumns
+
+    # Register a new table for rearranging.
+    def initialize(table)
+      @oldTable = table
+      @discontinuedColumns = nil
+    end
+
+    # Rearrange the registered table. The old table won't be modified. The
+    # method returns a new table (Array of Arrays). _newHeaders_ is an Array
+    # that represents the new column headers. The columns that are not in the
+    # new header will be the last columns of the new table.
+    def sort(newHeaders)
+      # Maps old index to new index.
+      columnIdxMap = {}
+      newHeaderIndex = newHeaders.length
+      oldHeaders = @oldTable[0]
+      discontinuedHeaders = []
+      oldHeaders.length.times do |i|
+        if (ni = newHeaders.index(oldHeaders[i]))
+          # This old column is still in the new header
+          columnIdxMap[i] = ni
+        else
+          # This old column is no longer contained in the new header. We
+          # append it at the end.
+          columnIdxMap[i] = newHeaderIndex
+          discontinuedHeaders << oldHeaders[i]
+          newHeaderIndex += 1
+        end
+      end
+
+      # We construct a new table from scratch. All values from the old table
+      # are copied over. columns in the new table that were not contained in
+      # the old table will be filled with nil.
+      newTable = []
+      @oldTable.length.times do |lineIdx|
+        oldLine = @oldTable[lineIdx]
+        if lineIdx == 0
+          # Insert the new headers. The discontinued ones will be added below.
+          newTable[0] = newHeaders
+        else
+          # Add a line of nils to the new table.
+          newTable[lineIdx] = Array.new(newHeaderIndex, nil)
+        end
+
+        # Copy the old column to the new position.
+        columnIdxMap.each do |oldColIdx, newColIdx|
+          newTable[lineIdx][newColIdx] = oldLine[oldColIdx]
+        end
+      end
+
+      # Now we need to add the new column headers that were not in the old
+      # headers.
+      #newTable[0] += discontinuedHeaders
+
+      @discontinuedColumns = discontinuedHeaders.length
+      newTable
+    end
+
+  end
+
+end
+

data/lib/taskjuggler/Task.rb

@@ -96,11 +96,9 @@ class TaskJuggler
 
       # Now convert the RichText markup String into RichTextIntermediate
       # format.
-      unless (rti = RichText.new(rText, RTFHandlers.create(@project),
-                                 @project.messageHandler).
-                                 generateIntermediateFormat)
-        @project.messageHandler.warning(
-          'task_journal_text', 'Syntax error in journal text')
+      unless (rti = RichText.new(rText, RTFHandlers.create(@project)).
+              generateIntermediateFormat)
+        warning('task_journal_text', 'Syntax error in journal text')
         return nil
       end
 

data/lib/taskjuggler/TaskJuggler.rb

@@ -23,17 +23,19 @@ require 'taskjuggler/Log'
 # files, schedule them and generate the reports.
 class TaskJuggler
 
-  attr_reader :project, :messageHandler
-  attr_accessor :maxCpuCores, :warnTsDeltas
+  include MessageHandler
+
+  attr_reader :project
+  attr_accessor :maxCpuCores, :warnTsDeltas, :generateTraces
 
   # Create a new TaskJuggler object. _console_ is a boolean that determines
   # whether or not messsages can be written to $stderr.
-  def initialize(console)
+  def initialize
     @project = nil
     @parser = nil
-    @messageHandler = MessageHandler.new(console)
     @maxCpuCores = 1
     @warnTsDeltas = false
+    @generateTraces = false
     TjTime.setTimeZone('UTC')
   end
 
@@ -41,18 +43,21 @@ class TaskJuggler
   # construct a Project object. In case of success true is returned.
   # Otherwise false.
   def parse(files, keepParser = false)
+    # Reset the MessageHandler to clear all errors.
+    MessageHandlerInstance.instance.clear
+
     Log.enter('parser', 'Parsing files ...')
     master = true
     @project = nil
 
     #RubyProf.start
-    @parser = ProjectFileParser.new(@messageHandler)
+    @parser = ProjectFileParser.new
     files.each do |file|
       begin
         @parser.open(file, master)
       rescue TjException => msg
         if msg.message && !msg.message.empty?
-          @messageHandler.critical('parse', msg.message)
+          critical('parse', msg.message)
         end
         Log.exit('parser')
         return false
@@ -91,7 +96,7 @@ class TaskJuggler
     @parser = nil unless keepParser
 
     Log.exit('parser')
-    @messageHandler.errors == 0
+    MessageHandlerInstance.instance.errors == 0
   end
 
   # Parse a file and add the content to the existing project. _fileName_ is
@@ -102,7 +107,7 @@ class TaskJuggler
       @project.inputFiles << fileName
     rescue TjException => msg
       if msg.message && !msg.message.empty?
-        @messageHandler.critical('parse_file', msg.message)
+        critical('parse_file', msg.message)
       end
       return nil
     end
@@ -125,11 +130,13 @@ class TaskJuggler
       res = @project.schedule
     rescue TjException => msg
       if msg.message && !msg.message.empty?
-        @messageHandler.critical('scheduling_error', msg.message)
+        critical('scheduling_error', msg.message)
       end
       return false
     end
 
+    @project.enableTraceReports(@generateTraces)
+
     Log.exit('scheduler')
     res
   end
@@ -157,7 +164,7 @@ class TaskJuggler
       #end
     rescue TjException => msg
       if msg.message && !msg.message.empty?
-        @messageHandler.critical('generate_reports', msg.message)
+        critical('generate_reports', msg.message)
       end
       return false
     end
@@ -179,7 +186,7 @@ class TaskJuggler
       @project.generateReport(reportId, regExpMode, formats, dynamicAttributes)
     rescue TjException => msg
       if msg.message && !msg.message.empty?
-        @messageHandler.critical('generate_report', msg.message)
+        critical('generate_report', msg.message)
       end
       Log.exit('generateReport')
       return false
@@ -196,7 +203,7 @@ class TaskJuggler
       @project.listReports(reportId, regExpMode)
     rescue TjException => msg
       if msg.message && !msg.message.empty?
-        @messageHandler.critical('list_reports', msg.message)
+        critical('list_reports', msg.message)
       end
       Log.exit('listReports')
       return false
@@ -210,9 +217,9 @@ class TaskJuggler
     begin
       # Check the master file is really a file and not stdin.
       unless (masterFile = @project.inputFiles.masterFile)
-        @messageHandler.error('cannot_freeze_stdin',
-                              "The project freeze feature only when the " +
-                              "master file is a real file, not standard input.")
+        error('cannot_freeze_stdin',
+              "The project freeze feature only when the " +
+              "master file is a real file, not standard input.")
       end
 
       # Derive the file names for the header and bookings file from the base
@@ -223,10 +230,10 @@ class TaskJuggler
       bookingsFile = bookingsFileBase + '.tji'
 
       if !File.exists?(bookingsFile) || !File.exists?(headerFile)
-        @messageHandler.info('incl_freeze_files',
-                             "Please make sure you include #{headerFile} at " +
-                             "the end of the project header and " +
-                             "#{bookingsFile} at the end of #{masterFile}.")
+        info('incl_freeze_files',
+             "Please make sure you include #{headerFile} at " +
+             "the end of the project header and " +
+             "#{bookingsFile} at the end of #{masterFile}.")
       end
 
       # Generate the project header include file with the new 'now' date.
@@ -235,9 +242,9 @@ class TaskJuggler
           f.puts("now #{freezeDate}")
         end
       rescue
-        @messageHandler.error('write_header_incl',
-                              "Cannote write header include file " +
-                              "#{headerFile}")
+        error('write_header_incl',
+              "Cannote write header include file " +
+              "#{headerFile}")
       end
 
       # Generate an export report for the bookings.
@@ -248,8 +255,7 @@ class TaskJuggler
 
       # We export only the tracking scenario.
       unless (trackingScenarioIdx = @project['trackingScenarioIdx'])
-        @messageHandler.error('no_tracking_scen',
-                              'No trackingscenario defined')
+        error('no_tracking_scen', 'No trackingscenario defined')
       end
       report.set('scenarios', [ trackingScenarioIdx ])
 
@@ -304,8 +310,9 @@ class TaskJuggler
                      'start' => ts.interval.start,
                      'end' => ts.interval.end,
                      'journalMode' => :journal,
-                     'journalAttributes' => %w( alert property headline flags
-                                                timesheet summary details ),
+                     'journalAttributes' => %w( alert property propertyid
+                                                headline flags timesheet
+                                                summary details ),
                      'sortJournalEntries' => [ [ :seqno, 1 ] ],
                      'timeFormat' => '%Y-%m-%d',
                      'selfContained' => true }
@@ -313,7 +320,7 @@ class TaskJuggler
       puts ts.resource.query_journal(query).richText.inputText
     rescue TjException => msg
       if msg.message && !msg.message.empty?
-        @messageHandler.critical('check_time_sheet', msg.message)
+        critical('check_time_sheet', msg.message)
       end
       Log.exit('checkTimeSheet')
       return false
@@ -349,7 +356,7 @@ class TaskJuggler
       puts ss[0].query_dashboard(query).richText.inputText
     rescue TjException => msg
       if msg.message && !msg.message.empty?
-        @messageHandler.critical('check_status_sheet', msg.message)
+        critical('check_status_sheet', msg.message)
       end
       Log.exit('checkStatusSheet')
       return false
@@ -372,7 +379,7 @@ class TaskJuggler
 
   # Return the number of errors that had been reported during processing.
   def errors
-    @project.messageHandler.errors
+    MessageHandlerInstance.instance.errors
   end
 
 end