taskjuggler 0.0.3 → 0.0.4

data/lib/reports/ReportBase.rb

@@ -3,7 +3,7 @@
 #
 # = ReportBase.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009 by Chris Schlaeger <cs@kde.org>
+# 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
@@ -28,7 +28,13 @@ class TaskJuggler
     end
 
     def generateIntermediateFormat
-      raise 'This function must be overriden by derived classes.'
+      query = @report.project.reportContext.query
+      %w( header left center right footer
+          prolog headline caption epilog ).each do |name|
+        next unless text = a(name)
+
+        text.functionHandler('query').setQuery(query)
+      end
     end
 
     def to_html
@@ -52,11 +58,13 @@ class TaskJuggler
 
       if resource
         # If we have a resource we need to check that the resource is allocated
-        # to the tasks in any of the reported scenarios.
+        # to the tasks in any of the reported scenarios within the report time
+        # frame.
         list.delete_if do |task|
           delete = true
           a('scenarios').each do |scenarioIdx|
-            if task['assignedresources', scenarioIdx].include?(resource)
+            iv = Interval.new(a('start'), a('end'))
+            if task.hasResourceAllocated?(scenarioIdx, iv, resource)
               delete = false
               break;
             end
@@ -65,26 +73,6 @@ class TaskJuggler
         end
       end
 
-      # Remove all tasks that don't overlap with the reported interval.
-      list.delete_if do |task|
-        delete = true
-        a('scenarios').each do |scenarioIdx|
-          iv = Interval.new(task['start', scenarioIdx].nil? ?
-                            @project['start'] : task['start', scenarioIdx],
-                            task['end', scenarioIdx].nil? ?
-                            @project['end'] : task['end', scenarioIdx])
-          # Special case to include milestones at the report end.
-          if iv.start == iv.end && iv.end == @end
-            iv.start = iv.end = iv.start - 1
-          end
-          if iv.overlaps?(Interval.new(a('start'), a('end')))
-            delete = false
-            break;
-          end
-        end
-        delete
-      end
-
       standardFilterOps(list, hideExpr, rollupExpr, resource, taskRoot)
     end
 
@@ -106,7 +94,8 @@ class TaskJuggler
         list.delete_if do |resource|
           delete = true
           a('scenarios').each do |scenarioIdx|
-            if resource.allocated?(scenarioIdx, iv, task)
+            if task.hasResourceAllocated?(scenarioIdx, iv, resource)
+            #if resource.allocated?(scenarioIdx, iv, task)
               delete = false
               break;
             end
@@ -131,10 +120,15 @@ class TaskJuggler
     # This function implements the generic filtering functionality for all kinds
     # of lists.
     def standardFilterOps(list, hideExpr, rollupExpr, scopeProperty, root)
+      # Make a copy of the current Query.
+      query = @project.reportContext.query.dup
+      query.scopeProperty = scopeProperty
+
       # Remove all properties that the user wants to have hidden.
       if hideExpr
         list.delete_if do |property|
-          hideExpr.eval(property, scopeProperty)
+          query.property = property
+          hideExpr.eval(query)
         end
       end
 
@@ -144,7 +138,8 @@ class TaskJuggler
           parent = property.parent
           delete = false
           while (parent)
-            if rollupExpr.eval(parent, scopeProperty)
+            query.property = parent
+            if rollupExpr.eval(query)
               delete = true
               break
             end

data/lib/reports/ReportContext.rb

@@ -3,7 +3,7 @@
 #
 # = ReportContext.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009 by Chris Schlaeger <cs@kde.org>
+# 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
@@ -12,30 +12,44 @@
 
 class TaskJuggler
 
-  # Each Project has a single ReportContext object that is used during the
-  # report generation. It is a container for global state.
+  # The ReportContext objects provide some settings that are used during the
+  # generation of a report. Reports can be nested, so multiple objects can
+  # exist at a time. But there is only one current ReportContext that is
+  # always accessable via Project.reportContext.
   class ReportContext
 
-    attr_reader :project, :report
-    attr_accessor :start, :end, :tasks, :resources
+    attr_reader :project, :report, :query
+    attr_accessor :tasks, :resources
 
     def initialize(project, report)
       @project = project
       @report = report
-
-      if (parent = @project.reportContext)
+      queryAttrs = {
+        'project' => @project,
+        'loadUnit' => @report.get('loadUnit'),
+        'numberFormat' => @report.get('numberFormat'),
+        'timeFormat' => @report.get('timeFormat'),
+        'currencyFormat' => @report.get('currencyFormat'),
+        'start' => @report.get('start'),
+        'end' => @report.get('end'),
+        'costAccount' => @report.get('costAccount'),
+        'revenueAccount' => @report.get('revenueAccount')
+      }
+      @query = Query.new(queryAttrs)
+      if (@parent = @project.reportContext)
         # If the new ReportContext is created from within an existing context,
-        # this is used as parent context and all attribute values are copied
-        # as default initial values.
-        @start = parent.start
-        @end = parent.end
-        @tasks = parent.tasks
-        @resources = parent.resources
+        # this is used as parent context and the settings are copied as
+        # default initial values.
+        @tasks = @parent.tasks.dup
+        @resources = @parent.resources.dup
       else
-        @start = @end = nil
-        @tasks = @resources = nil
+        # There is no existing ReportContext yet, so we create one based on
+        # the settings of the report.
+        @tasks = @project.tasks.dup
+        @resources = @project.resources.dup
       end
     end
 
   end
+
 end

data/lib/reports/ReportTable.rb

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

data/lib/reports/ReportTableCell.rb

@@ -3,7 +3,7 @@
 #
 # = ReportTableCell.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009 by Chris Schlaeger <cs@kde.org>
+# 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
@@ -20,23 +20,29 @@ class TaskJuggler
   class ReportTableCell
 
     attr_reader :line
-    attr_accessor :data, :text, :url, :category, :hidden, :alignment,
-                  :padding, :indent, :fontSize, :fontColor, :bold, :width,
+    attr_accessor :data, :category, :hidden, :alignment, :padding,
+                  :text, :tooltip, :selfcontained,
+                  :cellColor, :indent, :icon, :fontSize, :fontColor,
+                  :bold, :width,
                   :rows, :columns, :special
 
     # Create the ReportTableCell object and initialize the attributes to some
     # default values. _line_ is the ReportTableLine this cell belongs to. _text_
     # is the text that should appear in the cell. _headerCell_ is a flag that
     # must be true only for table header cells.
-    def initialize(line, text = '', headerCell = false)
+    def initialize(line, query, text = nil, headerCell = false)
       @line = line
       @line.addCell(self) if line
 
       @headerCell = headerCell
-      # The printable form of the cell content
-      @text = text
-      # A URL that is associated with the content of the cell.
-      @url = nil
+      # A copy of a Query object that is needed to access project data via the
+      # query function.
+      @query = query ? query.dup : nil
+      # The cell textual content. This may be a String or a
+      # RichTextIntermediate object.
+      self.text = text || ''
+      # A custom text for the tooltip.
+      @tooltip = nil
       # The original data of the cell content (optional, nil if not provided)
       @data = nil
       @category = nil
@@ -48,12 +54,16 @@ class TaskJuggler
       # Whether or not to indent the cell. If not nil, it is a Fixnum
       # indicating the indentation level.
       @indent = nil
+      # The basename of the icon file
+      @icon = nil
       @fontSize = nil
-      @fontColor = 0x000000
+      @cellColor = nil
+      @fontColor = nil
       @bold = false
       @width = nil
       @rows = 1
       @columns = 1
+      @selfcontained = false
       # Ignore everything and use this reference to generate the output.
       @special = nil
     end
@@ -63,6 +73,7 @@ class TaskJuggler
     # with.
     def ==(c)
       @text == c.text &&
+      @tooltip == c.tooltip &&
       @alignment == c.alignment &&
       @padding == c.padding &&
       @indent == c.indent &&
@@ -79,44 +90,100 @@ class TaskJuggler
       attribs['rowspan'] = "#{@rows}" if @rows > 1
       attribs['colspan'] = "#{@columns}" if @columns > 1
       attribs['class'] = @category ? @category : 'tabcell'
+      attribs['style'] = "background-color: #{@cellColor}; " if @cellColor
       cell = XMLElement.new('td', attribs)
 
       # Determine cell style
       alignSymbols = [ :left, :center, :right ]
       aligns = %w( left center right)
       style = "text-align:#{aligns[alignSymbols.index(@alignment)]}; "
+      paddingLeft = paddingRight = 0
       if @indent && @alignment != :center
         if @alignment == :left
-          style += "padding-left:#{@padding + @indent * 8}px; "
-          style += "padding-right:#{@padding}px; " unless @padding == 3
+          paddingLeft = @padding + @indent * 8
+          paddingRight = @padding
         elsif @alignment == :right
-          style += "padding-left:#{@padding}px; " unless @padding == 3
-          style += "padding-right:#{@padding +
-                                    (@line.table.maxIndent - @indent) * 8}px; "
+          paddingLeft = @padding
+          paddingRight = @padding + (@line.table.maxIndent - @indent) * 8
         end
+        style += "padding-left:#{paddingLeft}px; " unless paddingLeft == 3
+        style += "padding-right:#{paddingRight}px; " unless paddingRight == 3
       elsif @padding != 3
         style += "padding-left:#{@padding}px; padding-right:#{@padding}px; "
+        paddingLeft = paddingRight = @padding
       end
-      unless @text.is_a?(TaskJuggler::RichText)
-        style += 'font-weight:bold; ' if @bold
-        style += "font-size: #{@fontSize}px; " if fontSize
+      style += "width:#{@width - paddingLeft - paddingRight}px; " if @width
+      style += 'font-weight:bold; ' if @bold
+
+      # If we have a RichText content and a width limit, we enable line
+      # wrapping.
+      if @text.is_a?(RichTextIntermediate) && @width
+        style += "white-space:normal; "
       end
-      unless @fontColor == 0
-        style += "color:#{'#%06X' % @fontColor}; "
+
+      style += "font-size: #{@fontSize}px; " if fontSize
+      if @fontColor
+        style += "color:#{@fontColor}; "
       end
-      style += "width: #{@width}px; " if @width
-      if @text.is_a?(TaskJuggler::RichText) && @line && @line.table.equiLines
+      if @text.is_a?(RichTextIntermediate) && @line && @line.table.equiLines
         style += "height:#{@line.height - 3}px; "
       end
       cell << (div = XMLElement.new('div',
         'class' => @category ? 'celldiv' : 'headercelldiv', 'style' => style))
 
-      if url
-        div << (a = XMLElement.new('a', 'href' => @url))
-        a << XMLText.new(@text.is_a?(TaskJuggler::RichText) ?  @text.to_s : text)
+      if @icon && !@selfcontained
+        div << XMLElement.new('img', 'src' => "icons/#{@icon}.png",
+                                     'align' => 'top',
+                                     'style' => 'margin-right:3px;' +
+                                                'margin-bottom:2px')
+      end
+
+      return cell if @text.nil?
+
+      if @text.respond_to?('functionHandler') && @text.functionHandler('query')
+        @text.functionHandler('query').setQuery(@query)
+      end
+
+      shortText, singleLine = shortVersion(@text)
+      tooltip = nil
+      if (@line && @line.table.equiLines && (!singleLine || @width )) ||
+          !@category
+        # The cell is size-limited. We only put a shortened plain-text version
+        # in the cell and provide the full content via a tooltip.
+        div << XMLText.new(shortText)
+        tooltip = @text if @text != shortText
       else
-        div << (@text.is_a?(TaskJuggler::RichText) ?
-                @text.to_html : XMLText.new(@text))
+        # The cell will adjust to the size of the content.
+        if @text.is_a?(RichTextIntermediate)
+          # Don't put the @text into a <div> but a <span>.
+          @text.blockMode = false #if singleLine
+          div << @text.to_html
+        else
+          div << XMLText.new(shortText)
+        end
+      end
+
+      # Overwrite the tooltip if the user has specified a custom tooltip.
+      tooltip = @tooltip if @tooltip
+      if tooltip && !tooltip.empty? && !@selfcontained
+        if tooltip.respond_to?('functionHandler') &&
+           tooltip.functionHandler('query')
+          tooltip.functionHandler('query').setQuery(@query)
+        end
+        div['onmouseover'] = "TagToTip('#{cell.object_id}')"
+        div['onmouseout'] = 'UnTip()'
+        div << (ltDiv = XMLElement.new('div',
+                                       'style' => 'position:fixed; ' +
+                                       'visibility:hidden',
+                                       'id' => "#{cell.object_id}"))
+        ltDiv << (tooltip.respond_to?('to_html') ? tooltip.to_html :
+                                                   XMLText.new(tooltip))
+
+        div << XMLElement.new('img', 'src' => 'icons/details.png',
+                              'width' => '6px',
+                              'style' => 'vertical-align:top; ' +
+                                         'margin:2px; ' +
+                                         'top:5px')
       end
 
       cell
@@ -132,8 +199,34 @@ class TaskJuggler
       elsif @data && @data.is_a?(String)
         csv[-1] << indent + @data
       elsif @text
-        csv[-1] << indent + @text
+        if @text.respond_to?('functionHandler')
+          @text.functionHandler('query').setQuery(@query)
+        end
+        csv[-1] << indent + shortVersion(@text)[0]
+      end
+    end
+
+    private
+
+    # Convert a RichText String into a small one-line plain text
+    # version that fits the column.
+    def shortVersion(itext)
+      text = itext.to_s
+      singleLine = true
+      modified = false
+      if text.include?("\n")
+        text = text[0, text.index("\n")]
+        singleLine = false
+        modified = true
+      end
+      # Assuming an average character width of 9 pixels
+      if @width && (text.length > (@width / 9))
+        text = text[0, @width / 9]
+        modified = shortened = true
       end
+      # Add three dots to show that there is more info available.
+      text += "..." if modified
+      [ text, singleLine ]
     end
 
   end

data/lib/reports/ReportTableColumn.rb

@@ -3,7 +3,7 @@
 #
 # = ReportTableColumn.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009 by Chris Schlaeger <cs@kde.org>
+# 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
@@ -42,9 +42,9 @@ class TaskJuggler
       definition.column = self if definition
 
       # Create the 2 cells of the header.
-      @cell1 = ReportTableCell.new(nil, title, true)
+      @cell1 = ReportTableCell.new(nil, nil, title, true)
       @cell1.padding = 5
-      @cell2 = ReportTableCell.new(nil, '', true)
+      @cell2 = ReportTableCell.new(nil, nil, '', true)
       # Header text is always bold.
       @cell1.bold = @cell2.bold = true
       # This variable is set to true if the column requires a scrollbar later

data/lib/reports/ReportTableLegend.rb

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

data/lib/reports/ReportTableLine.rb

@@ -3,7 +3,7 @@
 #
 # = ReportTableLine.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009 by Chris Schlaeger <cs@kde.org>
+# 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
@@ -17,7 +17,8 @@ class TaskJuggler
   class ReportTableLine
 
     attr_reader :table, :property, :scopeLine
-    attr_accessor :height, :indentation, :fontSize, :no, :lineNo, :subLineNo
+    attr_accessor :height, :indentation, :fontSize, :bold,
+                  :no, :lineNo, :subLineNo
 
     # Create a ReportTableCell object and initialize the variables with default
     # values. _table_ is a reference to the ReportTable object this line belongs
@@ -39,6 +40,8 @@ class TaskJuggler
       @indentation = 0
       # The factor used to enlarge or shrink the font size for this line.
       @fontSize = 12
+      # Specifies whether the whole line should be in bold type or not.
+      @bold = false
       # Counter that counts primary and nested lines separately. It restarts
       # with 0 for each new nested line set. Scenario lines don't count.
       @no = nil
@@ -63,6 +66,11 @@ class TaskJuggler
       @cells << cell
     end
 
+    # Return the scope property or nil
+    def scopeProperty
+      @scopeLine ? @scopeLine.property : nil
+    end
+
     # Return this line as a set of XMLElement that represent the line in HTML.
     def to_html
       style = ""