taskjuggler 0.0.11 → 0.1.0

data/lib/taskjuggler/Resource.rb

@@ -52,7 +52,8 @@ class TaskJuggler
       # the RichText components, we use the originally provided markup since
       # we compose the result as RichText markup first.
       rText = ''
-      list = @project['journal'].entriesByResource(self, query.start, query.end)
+      list = @project['journal'].entriesByResource(self, query.start, query.end,
+                                                   query.hideJournalEntry)
       # Sort all entries in buckets by their alert level.
       numberOfLevels = project['alertLevels'].length
       listByLevel = []
@@ -76,6 +77,9 @@ class TaskJuggler
           if entry.property.is_a?(Task)
             rText += "=== #{alertName} <nowiki>#{entry.property.name}" +
                      "</nowiki> (ID: #{entry.property.fullId}) ===\n\n"
+            unless entry.flags.empty?
+              rText += "'''Flags:''' #{entry.flags.join(', ')}\n\n"
+            end
             if tsRecord
               rText += "'''Work:''' #{tsRecord.actualWorkPercent.to_i}% "
               if tsRecord.actualWorkPercent != tsRecord.planWorkPercent
@@ -146,11 +150,16 @@ class TaskJuggler
     def dashboard(query)
       scenarioIdx = @project['trackingScenarioIdx']
       taskList = []
-      @project.tasks.each do |task|
-        if task['responsible', scenarioIdx].include?(self) &&
-           !@project['journal'].currentEntries(query.end, task,
-                                              0, query.start).empty?
-          taskList << task
+      unless scenarioIdx
+        rText = "No 'trackingscenario' defined."
+      else
+        @project.tasks.each do |task|
+          if task['responsible', scenarioIdx].include?(self) &&
+            !@project['journal'].currentEntries(query.end, task,
+                                                0, query.start,
+                                                query.hideJournalEntry).empty?
+            taskList << task
+          end
         end
       end
 

data/lib/taskjuggler/RichText/Document.rb

@@ -130,9 +130,9 @@ class TaskJuggler
 
       body << generateHTMLCover <<
         @toc.to_html <<
-        XMLElement.new('br') <<
-        XMLElement.new('hr') <<
-        XMLElement.new('br') <<
+        XMLElement.new('br', {}, true) <<
+        XMLElement.new('hr', {}, true) <<
+        XMLElement.new('br', {}, true) <<
         generateHTMLFooter
 
       html.write(directory + 'toc.html')

data/lib/taskjuggler/RichText/RTFQuery.rb

@@ -85,7 +85,7 @@ class TaskJuggler
       end
 
       if (expandedArgs['property'] || expandedArgs['scopeproperty']) &&
-          !(expandedArgs['family'] || query.propertyType)
+          !(expandedArgs['family'] || @query.propertyType)
         error('missing_family',
               "If you provide a property or scope property you need to " +
               "provide a family type as well.")
@@ -106,8 +106,8 @@ class TaskJuggler
         query.scopeProperty = nil
       end
       query.attributeId = expandedArgs['attribute'] if expandedArgs['attribute']
-      query.start = expandedArgs['start'] if expandedArgs['start']
-      query.end = expandedArgs['end'] if expandedArgs['end']
+      query.start = TjTime.new(expandedArgs['start']) if expandedArgs['start']
+      query.end = TjTime.new(expandedArgs['end']) if expandedArgs['end']
       if expandedArgs['numberformat']
         query.numberFormat = expandedArgs['numberformat']
       end
@@ -145,7 +145,7 @@ class TaskJuggler
         unless validTypes[args['family']]
           error('rtfq_bad_query_family',
                 "Unknown query family type '#{args['family']}'. " +
-                "Use one of #{validTypes}.join(', ')!")
+                "Use one of #{validTypes.keys.join(', ')}!")
         end
         query.propertyType = validTypes[args['family']]
         if query.propertyType == :Task

data/lib/taskjuggler/SheetHandlerBase.rb

@@ -123,11 +123,13 @@ class TaskJuggler
 
       cmd = @scmCommand.gsub(/%m/, message)
       cmd.gsub!(/%f/, fileName)
-      `#{cmd}` unless @dryRun
-      if $? == 0
-        info("Added #{fileName} to SCM")
-      else
-        error("SCM command #{cmd} failed: #{$?}")
+      unless @dryRun
+        `#{cmd}`
+        if $? == 0
+          info("Added #{fileName} to SCM")
+        else
+          error("SCM command #{cmd} failed: #{$?.class}")
+        end
       end
     end
 
@@ -144,7 +146,7 @@ class TaskJuggler
     def error(message)
       $stderr.puts message if @outputLevel >= 1
       log("ERROR", message) if @logLevel >= 1
-      exit 1
+      raise TjRuntimeError
     end
 
     def log(type, message)
@@ -187,14 +189,14 @@ class TaskJuggler
           subject subject
           text_part do
             content_type [ 'text', 'plain', { 'charset' => 'UTF-8' } ]
-            content_transfer_encoding 'quoted-printable'
-            body message.to_s.to_quoted_printable
+            content_transfer_encoding 'base64'
+            body message.to_s.to_base64
           end
           if message.is_a?(RichTextIntermediate)
             html_part do
               content_type 'text/html; charset=UTF-8'
-              content_transfer_encoding 'quoted-printable'
-              body self_.htmlMailBody(message).to_quoted_printable
+              content_transfer_encoding 'base64'
+              body self_.htmlMailBody(message).to_base64
             end
           end
         end
@@ -217,7 +219,7 @@ class TaskJuggler
 
       if @dryRun
         # For testing and debugging, we only print out the email.
-        puts mail.to_s
+        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.
@@ -228,7 +230,7 @@ class TaskJuggler
           # without further attempts.
           if @emailFailure
             log('ERROR', "Email double fault: #{$!}")
-            exit 1
+            raise TjRuntimeError
           else
             @emailFailure = true
             error("Email transmission failed: #{$!}")

data/lib/taskjuggler/SheetReceiver.rb

@@ -13,8 +13,9 @@
 
 require 'digest/md5'
 require 'mail'
-require 'open4'
 require 'yaml'
+require 'taskjuggler/apps/Tj3Client'
+require 'taskjuggler/StdIoWrapper'
 require 'taskjuggler/SheetHandlerBase'
 require 'taskjuggler/RichText'
 
@@ -22,6 +23,8 @@ class TaskJuggler
 
   class SheetReceiver < SheetHandlerBase
 
+    include StdIoWrapper
+
     def initialize(appName, type)
       super(appName)
 
@@ -172,27 +175,26 @@ EOT
     end
 
     def checkSheet(sheet)
-      err = ''
-      status = nil
+      res = nil
       begin
         # Save a copy of the sheet for debugging purposes.
         File.open("#{@failedSheetsDir}/#{@resourceId}-#{@date}.tji", 'w') do |f|
           f.write(sheet)
         end
-        command = "tj3client --silent #{@tj3clientOption} #{@projectId} ."
-        status = Open4.popen4(command) do |pid, stdin, stdout, stderr|
-          # Send the report to the tj3client process via stdin.
-          stdin.write(sheet)
-          stdin.close
-          # Without errors, the incoming report is pretty printed and returned
-          # in RichText format.
-          @report = stdout.read
-          @warnings = stderr.read
+        command = [ '--unsafe', '--silent', *@tj3clientOption.split(' '),
+                    @projectId, '.' ]
+        # Send the report to the tj3client process via stdin.
+        res = stdIoWrapper(sheet) do
+          Tj3Client.new.main(command)
         end
+        # Without errors, the incoming report is pretty printed and returned
+        # in RichText format.
+        @report = res.stdOut
+        @warnings = res.stdErr
       rescue
         fatal("Cannot check #{@sheetType} sheet: #{$!}")
       end
-      if status.exitstatus == 0
+      if res.returnValue == 0
         File.delete("#{@failedSheetsDir}/#{@resourceId}-#{@date}.tji")
         return true
       end
@@ -333,7 +335,7 @@ EOT
       sendEmail(@submitter, "Your #{@sheetType} sheet submission failed!",
                 message)
 
-      exit 1
+      raise TjRuntimeError
     end
 
     def fatal(message)
@@ -349,7 +351,7 @@ has been notified and will try to rectify the situation as
 soon as possible. Please re-submit your #{@sheetType} sheet later!
 EOT
                )
-      exit 1
+      raise TjRuntimeError
     end
 
 

data/lib/taskjuggler/SheetSender.rb

@@ -11,11 +11,12 @@
 # published by the Free Software Foundation.
 #
 
-require 'open4'
 require 'mail'
 require 'yaml'
+require 'taskjuggler/StdIoWrapper'
 require 'taskjuggler/SheetHandlerBase'
 require 'taskjuggler/reports/CSVFile'
+require 'taskjuggler/apps/Tj3Client'
 
 class TaskJuggler
 
@@ -24,6 +25,8 @@ class TaskJuggler
 
     attr_accessor :force, :intervalDuration
 
+    include StdIoWrapper
+
     def initialize(appName, type)
       super(appName)
 
@@ -168,6 +171,9 @@ EOF
 EOT
         generateReport(reportId, reportDef)
       end
+      unless firstTemplateFile
+        error("No #{@sheetType} sheet templates found in #{@templateDir}")
+      end
       enableSignatureForReporting(firstTemplateFile)
     end
 
@@ -244,17 +250,17 @@ EOT
     def generateReport(id, reportDef)
       out = ''
       err = ''
+      res = nil
       begin
-        command = "tj3client --silent report #{@projectId} #{id} = ."
-        status = Open4.popen4(command) do |pid, stdin, stdout, stderr|
-          # Send the report definition to the tj3client process via stdin.
-          stdin.write(reportDef)
-          stdin.close
-          # Retrieve the output
-          out = stdout.read
-          err = stderr.read
+        command = [ '--unsafe', '--silent', 'report', @projectId, id, '=', '.' ]
+
+        # Send the report definition to the tj3client process via stdin.
+        res = stdIoWrapper(reportDef) do
+          Tj3Client.new.main(command)
         end
-        if status.exitstatus != 0
+        out = res.stdOut
+        err = res.stdErr
+        if res.returnValue != 0
           error("generateReport: #{err}")
         end
       rescue

data/{spec/support → lib/taskjuggler}/StdIoWrapper.rb

@@ -13,27 +13,44 @@
 
 class TaskJuggler
 
+  # This module provides just one method to run the passed block. It will
+  # capture all content that will be send to $stdout and $stderr by the block.
+  # I can also feed the String provided by _stdIn_ to $stdin of the block.
   module StdIoWrapper
 
     Results = Struct.new(:returnValue, :stdOut, :stdErr)
 
     def stdIoWrapper(stdIn = nil)
+      # Save the old $stdout and $stderr and replace them with StringIO
+      # objects to capture the output.
       oldStdOut = $stdout
       oldStdErr = $stderr
       $stdout = (out = StringIO.new)
       $stderr = (err = StringIO.new)
 
+      # If the caller provided a String to feed into $stdin, we replace that
+      # as well.
       if stdIn
         oldStdIn = $stdin
         $stdin = StringIO.new(stdIn)
       end
+
       begin
+        # Call the block with the hooked up IOs.
         res = yield
+      rescue RuntimeError
+        # Blocks that are called this way usually return 0 on success and 1 on
+        # errors.
+        res = 1
       ensure
+        # Restore the stdio channels no matter what.
         $stdout = oldStdOut
         $stderr = oldStdErr
         $stdin = oldStdIn if stdIn
       end
+
+      # Return the return value of the block and the $stdout and $stderr
+      # captures.
       Results.new(res, out.string, err.string)
     end
 

data/lib/taskjuggler/SyntaxReference.rb

@@ -146,7 +146,7 @@ class TaskJuggler
       html << (body = XMLElement.new('body'))
 
       body << XMLNamedText.new('Table Of Contents', 'a', 'href' => 'toc.html')
-      body << XMLElement.new('br')
+      body << XMLElement.new('br', {}, true)
 
       normalizedKeywords = {}
       keywords.each do |keyword|
@@ -164,7 +164,7 @@ class TaskJuggler
         keyword = normalizedKeywords[normalized]
         body << XMLNamedText.new("#{normalized}", 'a',
                                  'href' => "#{keyword}.html")
-        body << XMLElement.new('br')
+        body << XMLElement.new('br', {}, true)
       end
 
       html.write(directory + 'navbar.html')

data/lib/taskjuggler/TableColumnDefinition.rb

@@ -59,7 +59,7 @@ class TaskJuggler
   class TableColumnDefinition
 
     attr_reader :id, :cellText, :tooltip, :hAlign, :cellColor, :fontColor
-    attr_accessor :title, :start, :end, :scale, :listType, :listMode,
+    attr_accessor :title, :start, :end, :scale, :listItem, :listType,
                   :width, :content, :column
 
     def initialize(id, title)
@@ -88,11 +88,12 @@ class TaskJuggler
       # An alternative font color for the cell. The format is equivalent to
       # the @cellColor setting.
       @fontColor = CellSettingPatternList.new
+      # Specifies a RichText pattern to be used to generate the text of the
+      # individual list items.
+      @listItem = nil
       # Specifies whether list items are comma separated, bullet or numbered
       # list.
       @listType = nil
-      # Specifies how the list entries look like.
-      @listMode = nil
       # The scale attribute is only used for Gantt chart columns. It specifies
       # the minimum resolution of the chart.
       @scale = 'week'

data/lib/taskjuggler/Task.rb

@@ -49,9 +49,11 @@ class TaskJuggler
       # we compose the result as RichText markup first.
       rText = ''
       if recursive
-        list = @project['journal'].entriesByTaskR(self, query.start, query.end)
+        list = @project['journal'].entriesByTaskR(self, query.start, query.end,
+                                                  query.hideJournalEntry)
       else
-        list = @project['journal'].entriesByTask(self, query.start, query.end)
+        list = @project['journal'].entriesByTask(self, query.start, query.end,
+                                                 query.hideJournalEntry)
       end
       list.reverse.each do |entry|
         tsRecord = entry.timeSheetRecord
@@ -70,6 +72,9 @@ class TaskJuggler
             rText += "''by <nowiki>#{entry.author.name}</nowiki>''"
           end
           rText += "\n\n"
+          unless entry.flags.empty?
+            rText += "'''Flags:''' #{entry.flags.join(', ')}\n\n"
+          end
           if tsRecord
             rText += "'''Work:''' #{tsRecord.actualWorkPercent.to_i}% "
             if tsRecord.remaining

data/lib/taskjuggler/TaskJuggler.rb

@@ -205,12 +205,79 @@ class TaskJuggler
     true
   end
 
+  # Generate an export report definition for bookings up to the _freezeDate_.
+  def freeze(freezeDate)
+    # Check the master file is really a file and not stdin.
+    unless (masterFile = @project.inputFiles.masterFile)
+      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
+    # name of the master file.
+    masterFileBase = File.basename(masterFile, '.tjp')
+    headerFile = masterFileBase + '-header.tji'
+    bookingsFileBase = masterFileBase + '-bookings'
+    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}.")
+    end
+
+    # Generate the project header include file with the new 'now' date.
+    begin
+      File.open(headerFile, 'w') do |f|
+        f.puts("now #{freezeDate}")
+      end
+    rescue
+      @messageHandler.critical('write_header_incl',
+                               "Cannote write header include file " +
+                               "#{headerFile}")
+    end
+
+    # Generate an export report for the bookings.
+    report = Report.new(@project, '_bookings_', bookingsFileBase, nil)
+    report.typeSpec = :export
+    report.set('formats', [ :tjp ])
+    report.inheritAttributes
+
+    # We export only the tracking scenario.
+    unless (trackingScenarioIdx = @project['trackingScenarioIdx'])
+      @messageHandler.critical('no_tracking_scen',
+                               'No trackingscenario defined')
+    end
+    report.set('scenarios', [ trackingScenarioIdx ])
+
+    # Show all tasks, sorted by seqno-up.
+    report.set('hideTask', LogicalExpression.new(LogicalOperation.new(0)))
+    report.set('sortTasks', [ [ 'seqno', true, -1 ] ])
+    # Show all resources, sorted by seqno-up.
+    report.set('hideResource',
+                LogicalExpression.new(LogicalOperation.new(0)))
+    report.set('sortResources', [ [ 'seqno', true, -1 ] ])
+    # Only generate bookings, no other attributes or definitions.
+    report.set('definitions', [])
+    report.set('taskAttributes', [ 'booking' ])
+    report.set('resourceAttributes', [])
+  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} ...')
+
+      # To use this feature, the user must have specified which scenario is
+      # the tracking scenario.
+      unless @project['trackingScenarioIdx']
+        raise TjException.new, 'No trackingscenario defined'
+      end
+
       # Make sure we don't use data from old time sheets or Journal entries.
       @project.timeSheets.clear
       @project['journal'] = Journal.new
@@ -243,6 +310,13 @@ class TaskJuggler
   def checkStatusSheet(fileName)
     begin
       Log.enter('checkStatusSheet', 'Parsing #{fileName} ...')
+
+      # To use this feature, the user must have specified which scenario is
+      # the tracking scenario.
+      unless @project['trackingScenarioIdx']
+        raise TjException.new, 'No trackingscenario defined'
+      end
+
       return false unless (ss = parseFile(fileName, :statusSheetFile))
       queryAttrs = { 'project' => @project,
                      'property' => ss[0],