taskjuggler 0.0.8 → 0.0.9

data/lib/reports/GanttRouter.rb

@@ -3,7 +3,8 @@
 #
 # = GanttRouter.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               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
@@ -47,6 +48,8 @@ class TaskJuggler
       # Hash objects.
       routes = []
       fromToPoints.each do |touple|
+        # Ignore lines where start is after end.
+        next if touple[0] > touple[2]
         routes << {
           :startX => touple[0],
           :startY => touple[1],

data/lib/reports/GanttTaskBar.rb

@@ -3,7 +3,8 @@
 #
 # = GanttTaskBar.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               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
@@ -25,9 +26,8 @@ class TaskJuggler
     # Create a GanttContainer object based on the following information: _line_
     # is a reference to the GanttLine. _xStart_ is the left edge of the task in
     # chart coordinates. _xEnd_ is the right edge.
-    def initialize(task, scenarioIdx, lineHeight, xStart, xEnd, y)
-      @task = task
-      @scenarioIdx = scenarioIdx
+    def initialize(query, lineHeight, xStart, xEnd, y)
+      @query = query
       @lineHeight = lineHeight
       @start = xStart
       @end = xEnd
@@ -87,9 +87,11 @@ class TaskJuggler
       # The we draw the filling.
       html << rectToHTML(xStart + 1, yCenter - @@size + 1, width - 2,
                          2 * @@size - 2, 'taskbar')
-      # And then the progress bar. If task is null we assume 50% completion.
-      if @task && @task['complete', @scenarioIdx]
-        completion = @task['complete', @scenarioIdx] / 100.0
+      # And then the progress bar. If query is null we assume 50% completion.
+      if @query
+        @query.attributeId = 'complete'
+        @query.process
+        completion = @query.result / 100.0
       else
         completion = 0.5
       end

data/lib/reports/HTMLGraphics.rb

@@ -3,7 +3,8 @@
 #
 # = HTMLGraphics.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               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

data/lib/reports/Navigator.rb

@@ -3,7 +3,8 @@
 #
 # = Navigator.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               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

data/lib/reports/NikuReport.rb

@@ -3,7 +3,8 @@
 #
 # = NikuReport.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               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
@@ -61,6 +62,10 @@ class TaskJuggler
       # A Hash to map ClarityRID to Resource
       @resources = {}
 
+      # Unallocated and vacation time during the report period for all
+      # resources hashed by ClarityId. Values are in days.
+      @resourcesFreeWork = {}
+
       # Resources total effort during the report period hashed by ClarityId
       @resourcesTotalEffort = {}
 
@@ -90,7 +95,7 @@ class TaskJuggler
       thead << (tr = XMLElement.new('tr', 'class' => 'tabline'))
       # First line
       tr << htmlTabCell('Project', true, 'right')
-      @projects.each_key do |projectId|
+      @projects.keys.sort.each do |projectId|
         # Don't include projects without allocations.
         next if projectTotal(projectId) <= 0.0
         name = @projects[projectId].name
@@ -104,7 +109,7 @@ class TaskJuggler
       # Second line
       thead << (tr = XMLElement.new('tr', 'class' => 'tabline'))
       tr << htmlTabCell('Resource', true, 'left')
-      @projects.each_key do |projectId|
+      @projects.keys.sort.each do |projectId|
         # Don't include projects without allocations.
         next if projectTotal(projectId) <= 0.0
         tr << htmlTabCell(projectId, true, 'center')
@@ -113,12 +118,12 @@ class TaskJuggler
 
       # The actual content. One line per resource.
       table << (tbody = XMLElement.new('tbody'))
-      @resourcesTotalEffort.each_key do |resourceId|
+      @resourcesTotalEffort.keys.sort.each do |resourceId|
         tbody << (tr = XMLElement.new('tr', 'class' => 'tabline'))
         tr << htmlTabCell("#{@resources[resourceId].name} (#{resourceId})",
                           true, 'left')
 
-        @projects.each_key do |projectId|
+        @projects.keys.sort.each do |projectId|
           next if projectTotal(projectId) <= 0.0
           value = sum(projectId, resourceId)
           tr << htmlTabCell(value >= 0.01 ? format("%.2f", value) : '')
@@ -130,7 +135,7 @@ class TaskJuggler
       # Project totals
       tbody << (tr = XMLElement.new('tr', 'class' => 'tabline'))
       tr << htmlTabCell('Total', 'true', 'left')
-      @projects.each_key do |projectId|
+      @projects.keys.sort.each do |projectId|
         next if projectTotal(projectId) <= 0.0
         tr << htmlTabCell(format("%.2f", projectTotal(projectId)), true,
                           'right')
@@ -161,16 +166,15 @@ EOT
       nikuDataBus << (projects = XMLElement.new('Projects'))
 
       timeFormat = '%Y-%m-%dT%H:%M:%S'
-      @projects.each_value do |prj|
-        # Don't include projects with 0 allocations
-        next if projectTotal(prj.id) <= 0.0
-
+      @projects.keys.sort.each do |projectId|
+        prj = @projects[projectId]
         projects << (project =
                      XMLElement.new('Project',
                                     'name' => prj.name,
                                     'projectID' => prj.id))
         project << (resources = XMLElement.new('Resources'))
-        prj.resources.each_value do |res|
+        prj.resources.keys.sort.each do |resourceId|
+          res = prj.resources[resourceId]
           resources << (resource =
                         XMLElement.new('Resource',
                                        'resourceID' => res.id,
@@ -199,22 +203,23 @@ EOT
       table << (row = [])
       # First column is the resource name and ID.
       row << ""
-      @projects.each_key do |projectId|
+      projectIds = @projects.keys.sort
+      projectIds.each do |projectId|
         row << @projects[projectId].name
       end
 
       # Header line with project IDs
       table << (row = [])
       row << "Resource"
-      @projects.each_key do |projectId|
+      projectIds.each do |projectId|
         row << projectId
       end
 
-      @resourcesTotalEffort.each_key do |resourceId|
+      @resourcesTotalEffort.keys.sort.each do |resourceId|
         # Add one line per resource.
         table << (row = [])
         row << "#{@resources[resourceId].name} (#{resourceId})"
-        @projects.each_key do |projectId|
+        projectIds.each do |projectId|
           row << sum(projectId, resourceId)
         end
       end
@@ -282,6 +287,22 @@ EOT
                                         @report.get('rollupResource'),
                                         @report.get('openNodes'))
 
+      # Prepare a template for the Query we will use to get all the data.
+      queryAttrs = { 'project' => @project,
+                     'scopeProperty' => nil,
+                     'scenarioIdx' => @scenarioIdx,
+                     'loadUnit' => a('loadUnit'),
+                     'numberFormat' => a('numberFormat'),
+                     'timeFormat' => a('timeFormat'),
+                     'currencyFormat' => a('currencyFormat'),
+                     'start' => a('start'), 'end' => a('end'),
+                     'costAccount' => a('costAccount'),
+                     'revenueAccount' => a('revenueAccount') }
+      query = Query.new(queryAttrs)
+
+      # Calculate the number of working days in the report interval.
+      workingDays = @project.workingDays(Interval.new(a('start'), a('end')))
+
       resourceList.each do |resource|
         # We only care about leaf resources that have the custom attribute
         # 'ClarityRID' set.
@@ -289,33 +310,28 @@ EOT
                 (resourceId = resource.get('ClarityRID')).nil? ||
                 resourceId.empty?
 
-        # Prepare a template for the Query we will use to get all the data.
-        queryAttrs = { 'project' => @project,
-                       'property' => resource,
-                       'scopeProperty' => nil,
-                       'scenarioIdx' => @scenarioIdx,
-                       'loadUnit' => a('loadUnit'),
-                       'numberFormat' => a('numberFormat'),
-                       'timeFormat' => a('timeFormat'),
-                       'currencyFormat' => a('currencyFormat'),
-                       'start' => a('start'), 'end' => a('end'),
-                       'costAccount' => a('costAccount'),
-                       'revenueAccount' => a('revenueAccount') }
-
-        query = Query.new(queryAttrs)
+
+        query.property = resource
 
         # First get the allocated effort.
         query.attributeId = 'effort'
         query.process
+        # Effort in resource days
         total = query.to_num
 
-        # Then add the still available effort.
-        query.attributeId = 'freework'
-        query.process
-        total += query.to_num
-
+        # Ignore resources that have no work allocations.
         next if total <= 0.0
 
+        # A fully allocated resource should always have a total of 1.0 per
+        # working day. If the total is larger, we assume unpaid overtime. If
+        # it's less, the resource was either not fully allocated or had less
+        # working hours or was on vacation.
+        if total >= workingDays
+          @resourcesFreeWork[resourceId] = 0.0
+        else
+          @resourcesFreeWork[resourceId] = workingDays - total
+          total = workingDays
+        end
         @resources[resourceId] = resource
 
         # This is the maximum possible work of this resource in the report
@@ -337,7 +353,8 @@ EOT
       taskList = PropertyList.new(@project.tasks)
       taskList.setSorting(@report.get('sortTasks'))
       taskList = filterTaskList(taskList, nil, @report.get('hideTask'),
-                                @report.get('rollupTask'), @report.get('openNodes'))
+                                @report.get('rollupTask'),
+                                @report.get('openNodes'))
 
 
       taskList.each do |task|
@@ -390,33 +407,46 @@ EOT
           'No tasks with the custom attributes ClarityPID and ClarityPName ' +
           'were found!'
       end
+
+      # If the user did specify a project ID and name to collect the vacation
+      # time, we'll add this as a project as well.
+      if (id = @report.get('timeOffId')) && (name = @report.get('timeOffName'))
+        @projects[id] = project = NikuProject.new(id, name)
+        @resources.each do |resourceId, resource|
+          project.resources[resourceId] = r = NikuResource.new(resourceId)
+          r.sum = @resourcesFreeWork[resourceId]
+        end
+      end
     end
 
     # Compute the total effort each Resource is allocated to the Task objects
     # that have the same ClarityPID.
     def computeProjectAllocations
+      # Prepare a template for the Query we will use to get all the data.
+      queryAttrs = { 'project' => @project,
+                     'scenarioIdx' => @scenarioIdx,
+                     'loadUnit' => a('loadUnit'),
+                     'numberFormat' => a('numberFormat'),
+                     'timeFormat' => a('timeFormat'),
+                     'currencyFormat' => a('currencyFormat'),
+                     'start' => a('start'), 'end' => a('end'),
+                     'costAccount' => a('costAccount'),
+                     'revenueAccount' => a('revenueAccount') }
+      query = Query.new(queryAttrs)
+
+      timeOffId = @report.get('timeOffId')
       @projects.each_value do |project|
+        next if project.id == timeOffId
         project.tasks.each do |task|
           task['assignedresources', @scenarioIdx].each do |resource|
             # Only consider resources that are in the filtered resource list.
             next unless @resources[resource.get('ClarityRID')]
 
-            # Prepare a template for the Query we will use to get all the data.
-            queryAttrs = { 'project' => @project,
-                           'property' => task,
-                           'scopeProperty' => resource,
-                           'scenarioIdx' => @scenarioIdx,
-                           'loadUnit' => a('loadUnit'),
-                           'numberFormat' => a('numberFormat'),
-                           'timeFormat' => a('timeFormat'),
-                           'currencyFormat' => a('currencyFormat'),
-                           'start' => a('start'), 'end' => a('end'),
-                           'costAccount' => a('costAccount'),
-                           'revenueAccount' => a('revenueAccount') }
-
-            query = Query.new(queryAttrs)
+            query.property = task
+            query.scopeProperty = resource
             query.attributeId = 'effort'
             query.process
+
             work = query.to_num
 
             # If the resource was not actually working on this task during the

data/lib/reports/Report.rb

@@ -3,7 +3,8 @@
 #
 # = Report.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               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
@@ -46,11 +47,20 @@ class TaskJuggler
     # The generate function is where the action happens in this class. The
     # report defined by all the class attributes and report elements is
     # generated according the the requested output format(s).
-    def generate
+    # _requestedFormats_ can be a list of formats that should be generated (e.
+    # g. :html, :csv, etc.).
+    def generate(requestedFormats = nil)
       generateIntermediateFormat
 
-      # Then generate the actual output format.
-      get('formats').each do |format|
+      # We either generate the requested formats or the list of formats that
+      # was specified in the report definition.
+      (requestedFormats || get('formats')).each do |format|
+        if @name.empty?
+          error('empty_report_file_name',
+                "Report #{@id} has output formats requested, but the " +
+                "file name is empty.")
+        end
+
         case format
         when :html
           generateHTML
@@ -132,6 +142,15 @@ class TaskJuggler
 
     # Generate an HTML version of the report.
     def generateHTML
+      return nil unless @content
+
+      unless @content.respond_to?('to_html')
+        warning('html_not_supported',
+                "HTML format is not supported for report #{@id} of " +
+                "type #{@typeSpec}.")
+        return nil
+      end
+
       html = HTMLDocument.new(:strict)
       head = html.generateHead("TaskJuggler Report - #{@name}",
                                'description' => 'TaskJuggler Report',
@@ -145,10 +164,9 @@ class TaskJuggler
         end
         cssFile = IO.read(cssFileName)
         if cssFile.empty?
-          raise TjException.new, <<"EOT"
-Cannot read '#{cssFileName}'. Make sure the file is not empty and you have
-read access permission.
-EOT
+          error('css_file_error',
+                "Cannot read '#{cssFileName}'. Make sure the file is not " +
+                "empty and you have read access permission.")
         end
         head << XMLElement.new('meta', 'http-equiv' => 'Content-Style-Type',
                                'content' => 'text/css; charset=utf-8')
@@ -181,7 +199,7 @@ EOT
       # Make sure we have some margins around the report.
       body << (frame = XMLElement.new('div', 'class' => 'tj_page'))
 
-      frame << @content.to_html if @content
+      frame << @content.to_html
 
       # The footer with some administrative information.
       frame << (div = XMLElement.new('div', 'class' => 'copyright'))
@@ -209,9 +227,16 @@ EOT
 
     # Generate a CSV version of the report.
     def generateCSV
+      # The CSV format can only handle the first element of a report.
       return nil unless @content
 
-      # CSV format can only handle the first element.
+      unless @content.respond_to?('to_csv')
+        warning('csv_not_supported',
+                "CSV format is not supported for report #{@id} of " +
+                "type #{@typeSpec}.")
+        return nil
+      end
+
       return nil unless (csv = @content.to_csv)
 
       # Use the CSVFile class to write the Array of Arrays to a colon
@@ -245,6 +270,13 @@ EOT
 
     # Generate Niku report
     def generateNiku
+      unless @content.respond_to?('to_niku')
+        warning('niku_not_supported',
+                "niku format is not supported for report #{@id} of " +
+                "type #{@typeSpec}.")
+        return nil
+      end
+
       begin
         f = @name == '.' ? $stdout :
           File.new(((@name[0] == '/' ? '' : @project.outputDir) +

data/lib/reports/ReportBase.rb

@@ -3,7 +3,8 @@
 #
 # = ReportBase.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               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

data/lib/reports/ReportContext.rb

@@ -3,7 +3,8 @@
 #
 # = ReportContext.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               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