taskjuggler 3.1.0 → 3.2.0

data/lib/taskjuggler/reports/Navigator.rb

@@ -228,6 +228,7 @@ class TaskJuggler
           end
         end
       end
+      nil
     end
 
   end

data/lib/taskjuggler/reports/NikuReport.rb

@@ -306,8 +306,8 @@ EOT
                      'journalMode' => a('journalMode'),
                      'journalAttributes' => a('journalAttributes'),
                      'sortJournalEntries' => a('sortJournalEntries'),
-                     'costAccount' => a('costAccount'),
-                     'revenueAccount' => a('revenueAccount') }
+                     'costAccount' => a('costaccount'),
+                     'revenueAccount' => a('revenueaccount') }
       query = Query.new(queryAttrs)
 
       # Calculate the number of working days in the report interval.
@@ -440,8 +440,8 @@ EOT
                      'journalMode' => a('journalMode'),
                      'journalAttributes' => a('journalAttributes'),
                      'sortJournalEntries' => a('sortJournalEntries'),
-                     'costAccount' => a('costAccount'),
-                     'revenueAccount' => a('revenueAccount') }
+                     'costAccount' => a('costaccount'),
+                     'revenueAccount' => a('revenueaccount') }
       query = Query.new(queryAttrs)
 
       timeOffId = @report.get('timeOffId')

data/lib/taskjuggler/reports/Report.rb

@@ -18,6 +18,7 @@ require 'taskjuggler/reports/AccountListRE'
 require 'taskjuggler/reports/TextReport'
 require 'taskjuggler/reports/TaskListRE'
 require 'taskjuggler/reports/ResourceListRE'
+require 'taskjuggler/reports/TraceReport'
 require 'taskjuggler/reports/TagFile'
 require 'taskjuggler/reports/TjpExportRE'
 require 'taskjuggler/reports/StatusSheetReport'
@@ -45,6 +46,7 @@ class TaskJuggler
     # Create a new report object.
     def initialize(project, id, name, parent)
       super(project.reports, id, name, parent)
+      @messageHandler = MessageHandlerInstance.instance
       checkFileName(name)
       project.addReport(self)
 
@@ -129,6 +131,8 @@ class TaskJuggler
         @content = TextReport.new(self)
       when :taskreport
         @content = TaskListRE.new(self)
+      when :tracereport
+        @content = TraceReport.new(self)
       when :statusSheet
         @content = StatusSheetReport.new(self)
       when :timeSheet
@@ -154,22 +158,6 @@ class TaskJuggler
       @project.reportContexts.first.report.get('interactive')
     end
 
-    def error(id, message)
-      if message && !message.empty?
-        @project.messageHandler.error(id, message, @sourceFileInfo)
-      else
-        # We have no message, so the error has already been reported to the
-        # MessageHandler. Just trigger another exception to signal the error.
-        raise TjException
-      end
-    end
-
-    def warning(id, message)
-      if message && !message.empty?
-        @project.messageHandler.warning(id, message, @sourceFileInfo)
-      end
-    end
-
   private
     # Convenience function to access a report attribute
     def a(attribute)
@@ -187,7 +175,7 @@ class TaskJuggler
         return nil
       end
 
-      html = HTMLDocument.new(:strict)
+      html = HTMLDocument.new
       head = html.generateHead(@project['name'] + " - #{get('title') || @name}",
                                'description' => 'TaskJuggler Report',
                                'keywords' => 'taskjuggler, project, management')
@@ -347,7 +335,7 @@ EOT
       begin
         f = @name == '.' ? $stdout :
           File.new(((@name[0] == '/' ? '' : @project.outputDir) +
-                    @name + '.ical').untaint, 'w')
+                    @name + '.ics').untaint, 'w')
         f.puts "#{@content.to_iCal}"
       rescue IOError, SystemCallError
         error('write_ical', "Cannot write to file #{@name}.\n#{$!}")

data/lib/taskjuggler/reports/ReportBase.rb

@@ -48,25 +48,25 @@ class TaskJuggler
 
     # Take the complete account list and remove all accounts that are matching
     # the hide expression, the rollup Expression or are not a descendent of
-    # accountRoot.
+    # accountroot.
     def filterAccountList(list_, hideExpr, rollupExpr, openNodes)
       list = PropertyList.new(list_)
-      if (accountRoot = a('accountRoot'))
-        # Remove all accounts that are not descendents of the accountRoot.
-        list.delete_if { |account| !account.isChildOf?(accountRoot) }
+      if (accountroot = a('accountroot'))
+        # Remove all accounts that are not descendents of the accountroot.
+        list.delete_if { |account| !account.isChildOf?(accountroot) }
       end
 
       standardFilterOps(list, hideExpr, rollupExpr, openNodes, nil,
-                        accountRoot)
+                        accountroot)
     end
 
     # Take the complete task list and remove all tasks that are matching the
     # hide expression, the rollup Expression or are not a descendent of
-    # taskRoot. In case resource is not nil, a task is only included if
+    # taskroot. In case resource is not nil, a task is only included if
     # the resource is allocated to it in any of the reported scenarios.
     def filterTaskList(list_, resource, hideExpr, rollupExpr, openNodes)
       list = PropertyList.new(list_)
-      if (taskRoot = a('taskRoot'))
+      if (taskRoot = a('taskroot'))
         # Remove all tasks that are not descendents of the taskRoot.
         list.delete_if { |task| !task.isChildOf?(taskRoot) }
       end
@@ -94,11 +94,11 @@ class TaskJuggler
 
     # Take the complete resource list and remove all resources that are matching
     # the hide expression, the rollup Expression or are not a descendent of
-    # resourceRoot. In case task is not nil, a resource is only included if
+    # resourceroot. In case task is not nil, a resource is only included if
     # it is assigned to the task in any of the reported scenarios.
     def filterResourceList(list_, task, hideExpr, rollupExpr, openNodes)
       list = PropertyList.new(list_)
-      if (resourceRoot = a('resourceRoot'))
+      if (resourceRoot = a('resourceroot'))
         # Remove all resources that are not descendents of the resourceRoot.
         list.delete_if { |resource| !resource.isChildOf?(resourceRoot) }
       end

data/lib/taskjuggler/reports/ReportContext.rb

@@ -38,8 +38,8 @@ class TaskJuggler
         'journalMode' => @report.get('journalMode'),
         'journalAttributes' => @report.get('journalAttributes'),
         'sortJournalEntries' => @report.get('sortJournalEntries'),
-        'costAccount' => @report.get('costAccount'),
-        'revenueAccount' => @report.get('revenueAccount')
+        'costAccount' => @report.get('costaccount'),
+        'revenueAccount' => @report.get('revenueaccount')
       }
       @query = Query.new(queryAttrs)
       if (@parent = @project.reportContexts.last)

data/lib/taskjuggler/reports/StatusSheetReport.rb

@@ -82,17 +82,17 @@ class TaskJuggler
       queryAttrs = { 'project' => @project,
                      'scopeProperty' => nil,
                      'scenarioIdx' => scenarioIdx,
-                     'loadUnit' => a('loadUnit'),
-                     'numberFormat' => a('numberFormat'),
-                     'timeFormat' => a('timeFormat'),
+                     'loadUnit' => :days,
+                     'numberFormat' => RealFormat.new([ '-', '', '', '.', 1]),
+                     'timeFormat' => "%Y-%m-%d",
                      'currencyFormat' => a('currencyFormat'),
                      'start' => a('start'), 'end' => a('end'),
                      'hideJournalEntry' => a('hideJournalEntry'),
                      'journalMode' => a('journalMode'),
                      'journalAttributes' => a('journalAttributes'),
                      'sortJournalEntries' => a('sortJournalEntries'),
-                     'costAccount' => a('costAccount'),
-                     'revenueAccount' => a('revenueAccount') }
+                     'costAccount' => a('costaccount'),
+                     'revenueAccount' => a('revenueaccount') }
       resourceList.query = Query.new(queryAttrs)
       resourceList.sort!
 
@@ -129,7 +129,7 @@ class TaskJuggler
           # all it's sub tasks.
           entries = @project['journal'].
             currentEntriesR(a('end'), task, 0, a('start') + 1,
-                            resourceList.query.hideJournalEntry)
+                            resourceList.query)
           next if entries.empty?
 
           manager.responsibilities << ManagerResponsibilities.new(task, entries)

data/lib/taskjuggler/reports/TableReport.rb

@@ -29,14 +29,16 @@ class TaskJuggler
 
     @@propertiesById = {
       # ID                   Header                   Indent  Align   Scen Spec.
+      'activetasks'       => [ 'Active Tasks',         true,   :right, true ],
       'annualleave'       => [ 'Annual Leave',         true,   :right, true ],
-      'annualleavebalance'=> [ 'Annual Leave Balance', false,   :right, true ],
+      'annualleavebalance'=> [ 'Annual Leave Balance', false,  :right, true ],
       'alert'             => [ 'Alert',                true,   :left,  false ],
       'alertmessages'     => [ 'Alert Messages',       false,  :left,  false ],
       'alertsummaries'    => [ 'Alert Summaries',      false,  :left,  false ],
       'alerttrend'        => [ 'Alert Trend',          false,  :left,  false ],
       'balance'           => [ 'Balance',              true,   :right, true ],
       'bsi'               => [ 'BSI',                  false,  :left,  false ],
+      'closedtasks'       => [ 'Closed Tasks',         true,   :right, true ],
       'complete'          => [ 'Completion',           false,  :right, true ],
       'cost'              => [ 'Cost',                 true,   :right, true ],
       'duration'          => [ 'Duration',             true,   :right, true ],
@@ -57,6 +59,7 @@ class TaskJuggler
       'line'              => [ 'Line No.',             false,  :right, false ],
       'name'              => [ 'Name',                 true,   :left,  false ],
       'no'                => [ 'No.',                  false,  :right, false ],
+      'opentasks'         => [ 'Open Tasks',           true,   :right, true ],
       'precursors'        => [ 'Precursors',           false,  :left,  true ],
       'rate'              => [ 'Rate',                 true,   :right, true ],
       'resources'         => [ 'Resources',            false,  :left,  true ],
@@ -208,33 +211,37 @@ class TaskJuggler
       # If we have user specified dates for the report period or the column
       # period, we don't adjust the period. This flag is used to mark if we
       # have user-provided values.
-      doNotAdjust = false
+      doNotAdjustStart = false
+      doNotAdjustEnd = false
 
       # Determine the start date for the column.
       if columnDef.start
         # We have a user-specified, column specific start date.
         rStart = columnDef.start
-        doNotAdjust = true
+        doNotAdjustStart = true
       else
         # Use the report start date.
         rStart = a('start')
-        doNotAdjust = true if rStart != @project['start']
+        doNotAdjustStart = true if rStart != @project['start']
       end
 
       if columnDef.end
         rEnd = columnDef.end
-        doNotAdjust = true
+        doNotAdjustEnd = true
       else
         rEnd = a('end')
-        doNotAdjust = true if rEnd != @project['end']
+        doNotAdjustEnd = true if rEnd != @project['end']
       end
+      origStart = rStart
+      origEnd = rEnd
 
       # Save the unadjusted dates to the columns Hash.
       @columns[columnDef] = TableReportColumn.new(rStart, rEnd)
 
       # If the task list is empty or the user has provided a custom start or
       # end date, we don't touch the report period.
-      return if tasks.empty? || scenarios.empty? || doNotAdjust
+      return if tasks.empty? || scenarios.empty? ||
+                (doNotAdjustStart && doNotAdjustEnd)
 
       # Find the start date of the earliest tasks included in the report and
       # the end date of the last included tasks.
@@ -289,19 +296,21 @@ class TaskJuggler
         margin = entry[0] * entry[2]
         minWidth = entry[0] * entry[1] if minWidth < entry[0] * entry[1]
       else
-        doNotAdjust = true
+        doNotAdjustStart = doNotAdjustEnd = true
       end
 
-      unless doNotAdjust
+      unless doNotAdjustStart && doNotAdjustEnd
         if minWidth > (rEnd - rStart + 1)
-          margin += (minWidth - (rEnd - rStart + 1)) / 2
+          margin = (minWidth - (rEnd - rStart + 1)) / 2
         end
 
         rStart -= margin
         rEnd += margin
 
         # Save the adjusted dates to the columns Hash.
-        @columns[columnDef] = TableReportColumn.new(rStart, rEnd)
+        @columns[columnDef] = TableReportColumn.new(
+          doNotAdjustStart ? origStart : rStart,
+          doNotAdjustEnd ? origEnd : rEnd)
       end
     end
 
@@ -390,7 +399,7 @@ class TaskJuggler
           line.no = no
           line.lineNo = lineNo
           line.subLineNo = @table.lines
-          setIndent(line, a('accountRoot'), accountList.treeMode?)
+          setIndent(line, a('accountroot'), accountList.treeMode?)
 
           # Generate a cell for each column in this line.
           a('columns').each do |columnDef|
@@ -437,7 +446,7 @@ class TaskJuggler
           line.no = no unless scopeLine
           line.lineNo = lineNo
           line.subLineNo = @table.lines
-          setIndent(line, a('taskRoot'), taskList.treeMode?)
+          setIndent(line, a('taskroot'), taskList.treeMode?)
 
           # Generate a cell for each column in this line.
           a('columns').each do |columnDef|
@@ -494,7 +503,7 @@ class TaskJuggler
           line.no = no unless scopeLine
           line.lineNo = lineNo
           line.subLineNo = @table.lines
-          setIndent(line, a('resourceRoot'), resourceList.treeMode?)
+          setIndent(line, a('resourceroot'), resourceList.treeMode?)
 
           # Generate a cell for each column in this line.
           a('columns').each do |column|
@@ -953,7 +962,7 @@ class TaskJuggler
         query.scopeProperty = nil
         query.attributeId = 'effort'
         query.startIdx = @project.dateToIdx(t)
-        query.endIdx = @project.dateToIdx(nextT) - 1
+        query.endIdx = @project.dateToIdx(nextT)
         query.process
         workLoad = query.to_num
         scaledWorkLoad = query.to_s

data/lib/taskjuggler/reports/TimeSheetReport.rb

@@ -187,17 +187,17 @@ EOT
       queryAttrs = { 'project' => @project,
                      'scopeProperty' => nil,
                      'scenarioIdx' => scenarioIdx,
-                     'loadUnit' => a('loadUnit'),
-                     'numberFormat' => a('numberFormat'),
-                     'timeFormat' => a('timeFormat'),
+                     'loadUnit' => :days,
+                     'numberFormat' => RealFormat.new([ '-', '', '', '.', 1]),
+                     'timeFormat' => "%Y-%m-%d",
                      'currencyFormat' => a('currencyFormat'),
                      'start' => from, 'end' => to,
                      'hideJournalEntry' => a('hideJournalEntry'),
                      'journalMode' => a('journalMode'),
                      'journalAttributes' => a('journalAttributes'),
                      'sortJournalEntries' => a('sortJournalEntries'),
-                     'costAccount' => a('costAccount'),
-                     'revenueAccount' => a('revenueAccount') }
+                     'costAccount' => a('costaccount'),
+                     'revenueAccount' => a('revenueaccount') }
       resourceList.query = Query.new(queryAttrs)
       resourceList.sort!
 

data/lib/taskjuggler/reports/TraceReport.rb

@@ -0,0 +1,251 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = TraceReport.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.
+#
+
+require 'taskjuggler/reports/ReportBase'
+require 'taskjuggler/reports/CSVFile'
+require 'taskjuggler/reports/ChartPlotter'
+require 'taskjuggler/TableColumnSorter'
+require 'taskjuggler/MessageHandler'
+
+class TaskJuggler
+
+  # The trace report is used to periodically snapshot a specific list of
+  # property attributes and add them to a CSV file.
+  class TraceReport < ReportBase
+
+    include MessageHandler
+
+    # Create a new object and set some default values.
+    def initialize(report)
+      super
+      @table = nil
+    end
+
+    # Generate the table in the intermediate format.
+    def generateIntermediateFormat
+      super
+
+      queryAttrs = { 'project' => @project,
+                     'scopeProperty' => nil,
+                     'loadUnit' => a('loadUnit'),
+                     'numberFormat' => a('numberFormat'),
+                     # We use a hardcoded %Y-%m-%d format for tracereports.
+                     'timeFormat' => "%Y-%m-%d",
+                     'currencyFormat' => a('currencyFormat'),
+                     'start' => a('start'), 'end' => a('end'),
+                     'hideJournalEntry' => a('hideJournalEntry'),
+                     'journalMode' => a('journalMode'),
+                     'journalAttributes' => a('journalAttributes'),
+                     'sortJournalEntries' => a('sortJournalEntries'),
+                     'costAccount' => a('costaccount'),
+                     'revenueAccount' => a('revenueaccount') }
+      query = Query.new(queryAttrs)
+
+      # Prepare the account list.
+      accountList = PropertyList.new(@project.accounts)
+      accountList.setSorting(a('sortAccounts'))
+      accountList.query = query
+      accountList = filterAccountList(accountList, a('hideAccount'),
+                                      a('rollupAccount'), a('openNodes'))
+      accountList.sort!
+
+      # Prepare the resource list.
+      resourceList = PropertyList.new(@project.resources)
+      resourceList.setSorting(a('sortResources'))
+      resourceList.query = query
+      resourceList = filterTaskList(resourceList, nil, a('hideResource'),
+                                     a('rollupResource'), a('openNodes'))
+      resourceList.sort!
+
+      # Prepare the task list.
+      taskList = PropertyList.new(@project.tasks)
+      taskList.includeAdopted
+      taskList.setSorting(a('sortTasks'))
+      taskList.query = query
+      taskList = filterTaskList(taskList, nil, a('hideTask'), a('rollupTask'),
+                                a('openNodes'))
+      taskList.sort!
+
+      @fileName = ((@report.name[0] == '/' ? '' : @project.outputDir) +
+                  @report.name + '.csv').untaint
+
+      # Generate the table header.
+      headers = [ 'Date' ] +
+                generatePropertyListHeader(accountList, query) +
+                generatePropertyListHeader(resourceList, query) +
+                generatePropertyListHeader(taskList, query)
+
+      discontinuedColumns = 0
+      if File.exists?(@fileName)
+        begin
+          @table = CSVFile.new.read(@fileName)
+        rescue
+          error('tr_cannot_read_csv',
+                "Cannot read CSV file #{@fileName}: #{$!}")
+        end
+
+        if @table[0] != headers
+          # Some columns have changed. We move all discontinued columns to the
+          # last columns and rearrange the others according to the new
+          # headers. New columns will be filled with nil in previous rows.
+          sorter = TableColumnSorter.new(@table)
+          @table = sorter.sort(headers)
+          discontinuedColumns = sorter.discontinuedColumns
+        end
+      else
+        @table = [ headers ]
+      end
+
+      # Convert empty strings into nil objects and dates in %Y-%m-%d format
+      # into TjTime objects.
+      @table.each do |line|
+        line.length.times do |i|
+          if line[i] == ''
+            line[i] = nil
+          elsif line[i].is_a?(String) && /\d{4}-\d{2}-\d{2}/ =~ line[i]
+            line[i] = TjTime.new(line[i])
+          end
+        end
+      end
+
+      query = @project.reportContexts.last.query.dup
+      dateTag = @project['now'].midnight
+
+      idx = @table.index { |line| line[0] == dateTag }
+      discColumnValues = discontinuedColumns > 0 ?
+                         Array.new(discontinuedColumns, nil) : []
+      if idx
+        # We already have an entry for the current date. All old values of
+        # this line will be overwritten with the current values. The old
+        # values in the discontinued columns will be kept.
+        if discontinuedColumns > 0
+          discColumnValues = @table[idx][headers.length..-1]
+        end
+        @table[idx] = []
+      else
+        # Append a new line of values to the table.
+        @table << []
+        idx = -1
+      end
+      # The first entry is always the current date.
+      @table[idx] << dateTag
+
+      # Now add the new values to the line
+      generatePropertyListValues(idx, accountList, query)
+      generatePropertyListValues(idx, resourceList, query)
+      generatePropertyListValues(idx, taskList, query)
+
+      # Fill the discontinued columns with old values or nil.
+      @table[idx] += discColumnValues
+
+      # Sort the table by ascending first column dates. We need to ensure that
+      # the header remains the first line in the table.
+      @table.sort! { |l1, l2| l1[0].is_a?(String) ? -1 :
+                              (l2[0].is_a?(String) ? 1 : l1[0] <=> l2[0]) }
+    end
+
+    def to_html
+      html = []
+      html << rt_to_html('header')
+
+      begin
+        plotter = ChartPlotter.new(a('width'), a('height'), @table)
+        plotter.generate
+        html << plotter.to_svg
+      rescue ChartPlotterError => exception
+        warning('chartPlotterError', exception.message, @report.sourceFileInfo)
+      end
+
+      html << rt_to_html('footer')
+
+      html
+    end
+
+    def to_csv
+      # Convert all TjTime values into String with format %Y-%m-%d and nil
+      # objects into empty Strings.
+      @table.each do |line|
+        line.length.times do |i|
+          if line[i].nil?
+            line[i] = ''
+          elsif line[i].is_a?(TjTime)
+            line[i] = line[i].to_s('%Y-%m-%d')
+          end
+        end
+      end
+
+      @table
+    end
+
+    private
+
+    def generatePropertyListHeader(propertyList, query)
+      headers = []
+      query = query.dup
+      a('columns').each do |columnDescr|
+        query.attributeId = columnDescr.id
+        a('scenarios').each do |scenarioIdx|
+          query.scenarioIdx = scenarioIdx
+          propertyList.each do |property|
+            query.property = property
+
+            #adjustColumnPeriod(columnDescr, propertyList, a.get('scenarios'))
+            header = SimpleQueryExpander.new(columnDescr.title, query,
+                                             @report.sourceFileInfo).expand
+
+            if headers.include?(header)
+              error('trace_columns_not_uniq',
+                    "The column title '#{header}' is already used " +
+                    "by a previous column. Column titles must be " +
+                    "unique!")
+            end
+
+            headers << header
+          end
+        end
+      end
+      headers
+    end
+
+    def generatePropertyListValues(idx, propertyList, query)
+      @report.get('columns').each do |columnDescr|
+        query.attributeId = columnDescr.id
+
+        a('scenarios').each do |scenarioIdx|
+          query.scenarioIdx = scenarioIdx
+
+          propertyList.each do |property|
+            query.property = property
+
+            query.process
+            @table[idx] << query.result
+          end
+        end
+      end
+    end
+
+    def columnTitle(property, scenarioIdx, columnDescr)
+      title = columnDescr.title.dup
+      # The title can be parameterized by including mini-queries for the ID
+      # or the name of the property, the scenario id or the attribute ID.
+      title.gsub!(/<-id->/, property.fullId)
+      title.gsub!(/<-scenario->/, @project.scenario(scenarioIdx).id)
+      title.gsub!(/<-name->/, property.name)
+      title.gsub!(/<-attribute->/, columnDescr.id)
+      title
+    end
+
+  end
+
+end
+