taskjuggler 0.0.4 → 0.0.5

data/lib/reports/StatusSheetReport.rb

@@ -0,0 +1,231 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = StatusSheetReport.rb -- The TaskJuggler III Project Management Software
+#
+# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+#
+# 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 'reports/ReportBase'
+
+class TaskJuggler
+
+  class ManagerStatusRecord
+
+    attr_reader :resource, :responsibilities
+
+    def initialize(resource)
+      # The Resource record of the manager
+      @resource = resource
+      # A list of Task objects with their JournalEntry records. Stored as
+      # Array of ManagerResponsibilities objects.
+      @responsibilities = []
+    end
+
+    def sort!(taskList)
+      @responsibilities.sort! do |r1, r2|
+        taskList.itemIndex(r1.task) <=> taskList.itemIndex(r2.task)
+      end
+      @responsibilities.each { |r| r.sort!(taskList) }
+    end
+
+  end
+
+  class ManagerResponsibilities
+
+    attr_reader :task, :journalEntries
+
+    def initialize(task, journalEntries)
+      @task = task
+      @journalEntries = journalEntries.dup
+    end
+
+    def sort!(taskList)
+      @journalEntries.sort! do |e1, e2|
+        taskList.itemIndex(e1.property) <=> taskList.itemIndex(e2.property)
+      end
+    end
+
+  end
+
+  # This specialization of ReportBase implements a template generator for
+  # status sheets. The status sheet is structured using the TJP file syntax.
+  class StatusSheetReport < ReportBase
+
+    # Create a new object and set some default values.
+    def initialize(report)
+      super(report)
+
+      # A list of ManagerStatusRecord objects, one for each manager.
+      @managers = []
+    end
+
+    # In the future we might want to generate other output than TJP synatx. So
+    # we generate an abstract version of the status sheet first.
+    def generateIntermediateFormat
+      super
+
+      # Prepare the resource list.
+      resourceList = PropertyList.new(@project.resources)
+      resourceList.setSorting(@report.get('sortResources'))
+      resourceList = filterResourceList(resourceList, nil,
+                                        @report.get('hideResource'),
+                                        @report.get('rollupResource'))
+      # Prepare a template for the Query we will use to get all the data.
+      scenarioIdx = a('scenarios')[0]
+      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') }
+      resourceList.query = Query.new(queryAttrs)
+      resourceList.sort!
+
+      # Prepare the task list.
+      taskList = PropertyList.new(@project.tasks)
+      taskList.setSorting(@report.get('sortTasks'))
+      taskList = filterTaskList(taskList, nil, @report.get('hideTask'),
+                                @report.get('rollupTask'))
+      taskList.sort!
+
+      resourceList.each do |resource|
+        # Status sheets only make sense for leaf resources.
+        next unless resource.leaf?
+
+        # Collect a list of tasks that the Resource is responsible for and
+        # don't have a parent task that the Resource is responsible for.
+        topLevelTasks = []
+        taskList.each do |task|
+          if task['responsible', scenarioIdx].include?(resource) &&
+             (task.parent.nil? ||
+              !task.parent['responsible', scenarioIdx].include?(resource))
+            topLevelTasks << task
+          end
+        end
+
+        next if topLevelTasks.empty?
+
+        # Store the list of top-level responsibilities.
+        @managers << (manager = ManagerStatusRecord.new(resource))
+
+        topLevelTasks.each do |task|
+          entries = @project['journal'].entries(a('start'), a('end'), task)
+          # Get a list of all current Entries of this task. This list may not
+          # contain all entries of the previous list, but it will for sure
+          # contain older entries with higher alert levels.
+          oldEntries = @project['journal'].currentEntries(a('end'), task,
+                                                          0, a('start'))
+          # Remove entries that are in both lists.
+          oldEntries.delete_if { |e| entries.include?(e) }
+          # Combine the list with oldEntries going first.
+          entries = oldEntries + entries
+          next if entries.empty?
+
+          manager.responsibilities << ManagerResponsibilities.new(task, entries)
+        end
+        # Sort the responsibilities list according to the original taskList.
+        manager.sort!(taskList)
+      end
+    end
+
+    # Generate a time sheet in TJP syntax format.
+    def to_tjp
+
+      # This String will hold the result.
+      @file = ''
+
+      # Iterate over all the ManagerStatusRecord objects.
+      @managers.each do |manager|
+        resource = manager.resource
+        @file << "# --------8<--------8<--------\n"
+        # Generate the time sheet header
+        @file << "statussheet #{resource.fullId} " +
+                 "#{a('start')} - #{a('end')} {\n\n"
+
+        if manager.responsibilities.empty?
+          # If there were no assignments, just write a comment.
+          @file << "  # This resource is not responsible for any task.\n\n"
+        else
+          manager.responsibilities.each do |responsibility|
+            task = responsibility.task
+            @file << "  # Task: #{task.name}\n"
+
+            responsibility.journalEntries.each do |entry|
+              task = entry.property
+              @file << "  task #{task.fullId} {\n"
+              alertLevel = @project['alertLevels'][entry.alertLevel][0]
+              @file << "    # status #{alertLevel} \"#{entry.headline}\" {\n"
+              @file << "    #   # Date: #{entry.date}\n"
+              if (tsRecord = entry.timeSheetRecord)
+                @file << "    #   # "
+                @file << "Work: #{tsRecord.actualWorkPercent.to_i}% "
+                if tsRecord.actualWorkPercent != tsRecord.planWorkPercent
+                  @file << "(#{tsRecord.planWorkPercent.to_i}%) "
+                end
+                if tsRecord.remaining
+                  @file << "   Remaining: #{tsRecord.actualRemaining}d "
+                  if tsRecord.actualRemaining !=  tsRecord.planRemaining
+                    @file << "(#{tsRecord.planRemaining}d) "
+                  end
+                else
+                  @file << "   End: " +
+                           "#{tsRecord.actualEnd.to_s(a('timeFormat'))} "
+                  if tsRecord.actualEnd != tsRecord.planEnd
+                    @file << "(#{tsRecord.planEnd.to_s(a('timeFormat'))}) "
+                  end
+                end
+                @file << "\n"
+              end
+              @file << "    #   author #{entry.author.fullId}\n"
+              if entry.summary
+                @file << "    #   summary -8<-\n" +
+                         indentBlock(4, entry.summary.richText.inputText) +
+                         "    #   ->8-\n"
+              end
+              if entry.details
+                @file << "    #   details -8<-\n" +
+                         indentBlock(4, entry.details.richText.inputText) +
+                         "    #   ->8-\n"
+              end
+              @file << "    # }\n  }\n\n"
+
+            end
+          end
+        end
+        @file << "}\n# -------->8-------->8--------\n\n"
+      end
+      @file
+    end
+
+  private
+
+    def indentBlock(indent, text)
+      indentation = ' ' * indent + '#   '
+      buffer = indentation
+      out = ''
+      text.each_utf8_char do |c|
+        unless buffer.empty?
+          out += buffer
+          buffer = ''
+        end
+        out << c
+        buffer = indentation if c == "\n"
+      end
+      # Make sure we always have a trailing line break
+      out += "\n" unless out[-1] == "\n"
+      out
+    end
+
+  end
+
+end
+

data/lib/reports/TableReport.rb

@@ -38,10 +38,13 @@ class TaskJuggler
       'effortdone'   => [ 'Effort Done',   true,   :right, true ],
       'effortleft'   => [ 'Effort Left',   true,   :right, true ],
       'freetime'     => [ 'Free Time',     true,   :right, true ],
+      'followers'    => [ 'Followers',     false,  :left,  true ],
       'id'           => [ 'Id',            false,  :left,  false ],
+      'journal'      => [ 'Journal',       false,  :left,  false ],
       'line'         => [ 'Line No.',      false,  :right, false ],
       'name'         => [ 'Name',          true,   :left,  false ],
       'no'           => [ 'No.',           false,  :right, false ],
+      'precursors'   => [ 'Precursors',    false,  :left,  true ],
       'rate'         => [ 'Rate',          true,   :right, true ],
       'resources'    => [ 'Resources',     false,  :left,  true ],
       'responsible'  => [ 'Responsible',   false,  :left,  true ],
@@ -52,12 +55,13 @@ class TaskJuggler
       'wbs'          => [ 'WBS',           false,  :left,  false ]
     }
     @@propertiesByType = {
-      # Type                  Indent  Align
-      DateAttribute      => [ false,  :left ],
-      FixnumAttribute    => [ false,  :right ],
-      FloatAttribute     => [ false,  :right ],
-      RichTextAttribute  => [ false,  :left ],
-      StringAttribute    => [ false,  :left ]
+      # Type                     Indent  Align
+      DateAttribute         => [ false,  :left ],
+      FixnumAttribute       => [ false,  :right ],
+      FloatAttribute        => [ false,  :right ],
+      ResourceListAttribute => [ false, :left ],
+      RichTextAttribute     => [ false,  :left ],
+      StringAttribute       => [ false,  :left ]
     }
     # Generate a new TableReport object.
     def initialize(report)
@@ -76,57 +80,37 @@ class TaskJuggler
       super
     end
 
-
-
     # Turn the TableReport into an equivalent HTML element tree.
     def to_html
       html = []
 
       html << rt_to_html('header')
-      html << (table = XMLElement.new('table', 'summary' => 'Report Table',
-                                     'cellspacing' => '2', 'border' => '0',
-                                     'cellpadding' => '0', 'align' => 'center',
-                                     'class' => 'tjtable'))
-
-      # The headline is put in a sub-table to appear bigger.
-      if a('headline')
-        table << (thead = XMLElement.new('thead'))
-        thead << (tr = XMLElement.new('tr'))
-        tr << (td = XMLElement.new('td'))
-        td << (table1 = XMLElement.new('table', 'summary' => 'headline',
-                                       'cellspacing' => '1', 'border' => '0',
-                                       'cellpadding' => '5',
-                                       'align' => 'center', 'width' => '100%'))
-        table1 << (tr1 = XMLElement.new('tr'))
-        tr1 << (td1 = XMLElement.new('td', 'align' => 'center',
-                                     'style' => 'font-size:16px; ' +
-                                                'font-weight:bold; ' +
-                                                'padding:5px',
-                                     'class' => 'tabfront'))
-        td1 << a('headline').to_html
-      end
+      html << (tableFrame = generateHtmlTableFrame)
 
       # Now generate the actual table with the data.
-      table << (tbody = XMLElement.new('tbody'))
-      tbody << (tr = XMLElement.new('tr'))
-      tr << (td = XMLElement.new('td'))
-      td << @table.to_html
+      tableFrame << generateHtmlTableRow do
+        td = XMLElement.new('td')
+        td << @table.to_html
+        td
+      end
 
       # Embedd the caption as RichText into the table footer.
       if a('caption')
-        tbody << (tr = XMLElement.new('tr'))
-        tr << (td = XMLElement.new('td', 'class' => 'tabback'))
-        td << (div = XMLElement.new('div', 'class' => 'caption',
-                                    'style' => 'margin:1px'))
-        a('caption').sectionNumbers = false
-        div << a('caption').to_html
+        tableFrame << generateHtmlTableRow do
+          td = XMLElement.new('td')
+          td << (div = XMLElement.new('div', 'class' => 'tj_table_caption'))
+          a('caption').sectionNumbers = false
+          div << a('caption').to_html
+          td
+        end
       end
 
-      # A sub-table with the legend.
-      tbody << (tr = XMLElement.new('tr', 'style' => 'font-size:10px;'))
-      tr << (td = XMLElement.new('td', 'style' =>
-                                 'padding-left:1px; padding-right:1px;'))
-      td << @legend.to_html
+      # The legend.
+      tableFrame << generateHtmlTableRow do
+        td = XMLElement.new('td')
+        td << @legend.to_html
+        td
+      end
 
       html << rt_to_html('footer')
       html
@@ -553,10 +537,8 @@ class TaskJuggler
         # The GanttChart can be reached via the special variable of the column
         # header.
         chart = columnDef.column.cell1.special
-        GanttLine.new(chart, property, line.scopeProperty,
-                      query.scenarioIdx,
-                      (line.subLineNo - 1) * (line.height + 1),
-                      line.height)
+        GanttLine.new(chart, query, (line.subLineNo - 1) * (line.height + 1),
+                      line.height, a('selfcontained') ? nil : columnDef.tooltip)
         return true
       # The calendar cells can be all generated by the same function. But we
       # need to use different parameters.
@@ -704,6 +686,8 @@ class TaskJuggler
           else
             nil
           end
+          cell.iconTooltip = RichText.new("'''ID:''' #{property.fullId}").
+          generateIntermediateFormat
       when 'no'
         cell.text = line.no.to_s
       when 'wbs'
@@ -742,7 +726,7 @@ class TaskJuggler
     # in this line. _line_ is the @table line. _t_ is the start date for the
     # calendar. _sameTimeNextFunc_ is the function that will move the date to
     # the next cell.
-    def genCalChartTaskCell(query, line, columnDef, t, sameTimeNextFunc)
+    def genCalChartTaskCell(origQuery, line, columnDef, t, sameTimeNextFunc)
       task = line.property
       # Find out if we have an enclosing resource scope.
       if line.scopeLine && line.scopeLine.property.is_a?(Resource)
@@ -753,27 +737,34 @@ class TaskJuggler
 
       # Get the interval of the task. In case a date is invalid due to a
       # scheduling problem, we use the full project interval.
-      taskIv = Interval.new(task['start', query.scenarioIdx].nil? ?
-                            @project['start'] : task['start', query.scenarioIdx],
-                            task['end', query.scenarioIdx].nil? ?
-                            @project['end'] : task['end', query.scenarioIdx])
+      taskStart = task['start', origQuery.scenarioIdx]
+      taskEnd = task['end', origQuery.scenarioIdx]
+      taskIv = Interval.new(taskStart.nil? ?  @project['start'] : taskStart,
+                            taskEnd.nil? ?  @project['end'] : taskEnd)
 
       firstCell = nil
       while t < @end
-        # Create a new cell
-        cell = newCell(query, line)
-
+        # We modify the start and end dates to match the cell boundaries. So
+        # we need to make sure we don't modify the original Query but our own
+        # copies.
+        query = origQuery.dup
         # call TjTime::sameTimeNext... function
         nextT = t.send(sameTimeNextFunc)
         cellIv = Interval.new(t, nextT)
         case columnDef.content
         when 'empty'
+          # Create a new cell
+          cell = newCell(query, line)
           # We only generate cells will different background colors.
         when 'load'
           query.attributeId = 'effort'
-          query.startIdx = t
-          query.endIdx = nextT
+          query.start = t
+          query.end = nextT
           query.process
+
+          # Create a new cell
+          cell = newCell(query, line)
+
           # To increase readability, we don't show 0.0 values.
           cell.text = query.to_s if query.to_num != 0.0
         else
@@ -782,10 +773,16 @@ class TaskJuggler
 
         # Determine cell category (mostly the background color)
         if cellIv.overlaps?(taskIv)
+          # The cell is either a container or leaf task
           cell.category = task.container? ? 'calconttask' : 'caltask'
+          # If the user has requested a custom tooltip, add it to each task cell.
+          cell.tooltip = columnDef.tooltip.getPattern(query) || nil
+          cell.showTooltipHint = false
         elsif !@project.isWorkingTime(cellIv)
+          # The cell is a vacation cell.
           cell.category = 'offduty'
         else
+          # The cell is just filled with the background color.
           cell.category = 'taskcell'
         end
         cell.category += line.property.get('index') % 2  == 1 ? '1' : '2'
@@ -808,7 +805,7 @@ class TaskJuggler
     # reported in this line. _line_ is the @table line. _t_ is the start date
     # for the calendar. _sameTimeNextFunc_ is the function that will move the
     # date to the next cell.
-    def genCalChartResourceCell(query, line, columnDef, t,
+    def genCalChartResourceCell(origQuery, line, columnDef, t,
                                 sameTimeNextFunc)
       resource = line.property
       # Find out if we have an enclosing task scope.
@@ -816,17 +813,21 @@ class TaskJuggler
         task = line.scopeLine.property
         # Get the interval of the task. In case a date is invalid due to a
         # scheduling problem, we use the full project interval.
-        taskIv = Interval.new(task['start', query.scenarioIdx].nil? ?
-                              @project['start'] :
-                              task['start', query.scenarioIdx],
-                              task['end', query.scenarioIdx].nil? ?
-                              @project['end'] : task['end', query.scenarioIdx])
+        taskStart = task['start', origQuery.scenarioIdx]
+        taskEnd = task['end', origQuery.scenarioIdx]
+        taskIv = Interval.new(taskStart.nil? ?  @project['start'] : taskStart,
+                              taskEnd.nil? ?  @project['end'] : taskEnd)
       else
         task = nil
       end
 
       firstCell = nil
       while t < @end
+        # We modify the start and end dates to match the cell boundaries. So
+        # we need to make sure we don't modify the original Query but our own
+        # copies.
+        query = origQuery.dup
+
         # Create a new cell
         cell = newCell(query, line)
 
@@ -868,12 +869,17 @@ class TaskJuggler
           raise "Unknown column content #{column.content}"
         end
 
+        # Set the tooltip for the cell. We might delete it again.
+        cell.tooltip = columnDef.tooltip.getPattern(query) || nil
+        cell.showTooltipHint = false
+
         # Determine cell category (mostly the background color)
         cell.category = if task
                           if cellIv.overlaps?(taskIv)
                             if workLoadTask > 0.0 && freeLoad == 0.0
                               'busy'
                             elsif workLoad == 0.0 && freeLoad == 0.0
+                              cell.tooltip = nil
                               'offduty'
                             else
                               'loaded'
@@ -882,8 +888,10 @@ class TaskJuggler
                             if freeLoad > 0.0
                               'free'
                             elsif workLoad == 0.0 && freeLoad == 0.0
+                              cell.tooltip = nil
                               'offduty'
                             else
+                              cell.tooltip = nil
                               'resourcecell'
                             end
                           end
@@ -895,6 +903,7 @@ class TaskJuggler
                           elsif workLoad == 0.0 && freeLoad > 0.0
                             'free'
                           else
+                            cell.tooltip = nil
                             'offduty'
                           end
                         end

data/lib/reports/TaskListRE.rb

@@ -42,12 +42,10 @@ class TaskJuggler
       taskList.query = @report.project.reportContext.query
       taskList.sort!
 
-      # Prepare the resource list.
+      # Prepare the resource list. Don't filter it yet! It would break the
+      # *_() LogicalFunctions.
       resourceList = PropertyList.new(@project.resources)
       resourceList.setSorting(@report.get('sortResources'))
-      resourceList = filterResourceList(resourceList, nil,
-                                        @report.get('hideResource'),
-                                        @report.get('rollupResource'))
       resourceList.query = @report.project.reportContext.query
       resourceList.sort!
 

data/lib/reports/TextReport.rb

@@ -25,27 +25,33 @@ class TaskJuggler
       super
 
       @lWidth = @cWidth = @rWidth = 0
+      @lPadding = @cPadding = @rPadding = 0
     end
 
     def generateIntermediateFormat
       super
 
+      # A width of 0 means, the columns flexible.
       if a('center')
         if a('left') && a('right')
           @lWidth = @rWidth = 20
           @cWidth = 60
+          @lPadding = @cPadding = 2
         elsif a('left') && !a('right')
           @lWidth = 25
           @cWidth = 75
+          @lPadding = 2
         elsif !a('left') && a('right')
           @cWidth = 75
           @rWidth = 25
+          @cPadding = 2
         else
           @cWidth = 100
         end
       else
         if a('left') && a('right')
           @lWidth = @rWidth = 50
+          @lPadding = 2
         elsif a('left') && !a('right')
           @lWidth = 100
         elsif !a('left') && a('right')
@@ -56,21 +62,21 @@ class TaskJuggler
 
     def to_html
       html = []
-
       html << rt_to_html('header')
-      if @lWidth > 0 || @cWidth > 0 || @rWidth > 0
-        html << (table = XMLElement.new('table', 'align' => 'center',
-                                        'cellspacing' => '1',
-                                        'cellpadding' => '2', 'width' => '100%',
-                                        'class' => 'textPageSkel'))
-        table << (tr = XMLElement.new('tr'))
-
+      if a('left') || a('center') || a('right')
+        html << (table = XMLElement.new('table', 'class' => 'tj_text_page',
+                                                 'cellspacing' => '0'))
+        table << (row = XMLElement.new('tr', 'class' => 'tj_text_row'))
         %w( left center right).each do |i|
           width = instance_variable_get('@' + i[0].chr + 'Width')
-          if width > 0
-            tr << (td = XMLElement.new('td', 'width' => "#{width}%",
-                                       'style' => 'vertical-align:top'))
-            td << (el = rt_to_html(i))
+          padding = instance_variable_get('@' + i[0].chr + 'Padding')
+          if a(i)
+            row << (col = XMLElement.new('td', 'class' => "tj_column_#{i}"))
+            style = ''
+            style += "width:#{width}%; " if width > 0
+            style += "padding-right:#{padding}%; " if padding > 0
+            col['style'] = style
+            col << rt_to_html(i)
           end
         end