taskjuggler 0.0.5 → 0.0.6

data/lib/reports/GanttChart.rb

@@ -198,8 +198,9 @@ class TaskJuggler
     end
 
     # This is a noop function.
-    def to_csv(csv)
+    def to_csv
       # Can't put a Gantt chart into a CSV file.
+      ''
     end
 
     # Utility function that convers a date to the corresponding X-position in

data/lib/reports/Navigator.rb

@@ -127,23 +127,36 @@ class TaskJuggler
     # Generate an output format independant version of the navigator. This is
     # a tree of NavigatorElement objects.
     def generate(reports, reportRoot, parentElement)
-      raise "Report context missing" unless @project.reportContext.report
+      reportDef = @project.reportContexts.last.report
+      raise "Report context missing" unless reportDef
 
+      interactive = false
       reports.each do |report|
+        # The outermost (top-level) report determines whether the report
+        # should be rendered interactive or not.
+        interactive = report.interactive?  unless interactive
+
         hasURL = report.get('formats').include?(:html)
+        # Only generate menu entries for reports that are not the reportRoot,
+        # that are leaf reports and have an HTML output format.
         next if (report.parent != reportRoot) ||
                 (report.leaf? && !hasURL)
 
         label = report.get('title') || report.name
         # Determine the URL for this element.
         if hasURL
-          url = report.name + '.html'
-          url = normalizeURL(url, @project.reportContext.report.name)
+          if interactive
+            url = "/taskjuggler?project=#{report.project['projectid']};" +
+                  "report=#{report.fullId}"
+          else
+            url = report.name + '.html'
+            url = normalizeURL(url, reportDef.name)
+          end
         end
         parentElement.elements <<
           (element =  NavigatorElement.new(parentElement, label, url))
 
-        if report == @project.reportContext.report
+        if report == reportDef
           element.currentUrl = url
           # Mark this element and all its parents as current.
           nEl = element
@@ -172,7 +185,7 @@ class TaskJuggler
       list.setSorting([[ 'seqno', true, -1 ]])
       list.sort!
       # Remove all reports that the user doesn't want to have include.
-      query = @project.reportContext.query.dup
+      query = @project.reportContexts.last.query.dup
       query.scopeProperty = nil
       list.delete_if do |property|
         query.property = property

data/lib/reports/NikuReport.rb

@@ -193,6 +193,35 @@ EOT
       xml.to_s
     end
 
+    def to_csv
+      table = []
+      # Header line with project names
+      table << (row = [])
+      # First column is the resource name and ID.
+      row << ""
+      @projects.each_key do |projectId|
+        row << @projects[projectId].name
+      end
+
+      # Header line with project IDs
+      table << (row = [])
+      row << "Resource"
+      @projects.each_key do |projectId|
+        row << projectId
+      end
+
+      @resourcesTotalEffort.each_key do |resourceId|
+        # Add one line per resource.
+        table << (row = [])
+        row << "#{@resources[resourceId].name} (#{resourceId})"
+        @projects.each_key do |projectId|
+          row << sum(projectId, resourceId)
+        end
+      end
+
+      table
+    end
+
   private
 
     def sum(projectId, resourceId)
@@ -250,7 +279,8 @@ EOT
       resourceList.setSorting(@report.get('sortResources'))
       resourceList = filterResourceList(resourceList, nil,
                                         @report.get('hideResource'),
-                                        @report.get('rollupResource'))
+                                        @report.get('rollupResource'),
+                                        @report.get('openNodes'))
 
       resourceList.each do |resource|
         # We only care about leaf resources that have the custom attribute
@@ -307,7 +337,7 @@ EOT
       taskList = PropertyList.new(@project.tasks)
       taskList.setSorting(@report.get('sortTasks'))
       taskList = filterTaskList(taskList, nil, @report.get('hideTask'),
-                                @report.get('rollupTask'))
+                                @report.get('rollupTask'), @report.get('openNodes'))
 
 
       taskList.each do |task|

data/lib/reports/Report.rb

@@ -47,6 +47,34 @@ class TaskJuggler
     # report defined by all the class attributes and report elements is
     # generated according the the requested output format(s).
     def generate
+      begin
+        generateIntermediateFormat
+
+        # Then generate the actual output format.
+        get('formats').each do |format|
+          case format
+          when :html
+            generateHTML
+            copyAuxiliaryFiles
+          when :csv
+            generateCSV
+          when :niku
+            generateNiku
+          when :tjp
+            generateTJP
+          else
+            raise 'Unknown report output format #{format}.'
+          end
+        end
+      rescue TjException
+        error('reporting_failed', $!.message)
+      end
+      0
+    end
+
+    # Generate an output format agnostic version that can later be turned into
+    # the respective output formats.
+    def generateIntermediateFormat
       begin
         @content = nil
         case @typeSpec
@@ -71,27 +99,9 @@ class TaskJuggler
         # Most output format can be generated from a common intermediate
         # representation of the elements. We generate that IR first.
         @content.generateIntermediateFormat if @content
-
-        # Then generate the actual output format.
-        get('formats').each do |format|
-          case format
-          when :html
-            generateHTML
-            copyAuxiliaryFiles
-          when :csv
-            generateCSV
-          when :niku
-            generateNiku
-          when :tjp
-            generateTJP
-          else
-            raise 'Unknown report output format #{format}.'
-          end
-        end
       rescue TjException
-        error('reporting_failed', $!.message)
+        error('report_IR_generattion_failed', $!.message)
       end
-      0
     end
 
     # Render the content of the report as HTML (without the framing).
@@ -99,6 +109,12 @@ class TaskJuggler
       @content ? @content.to_html : nil
     end
 
+    # Return true if the report should be rendered in the interactive version,
+    # false if not. The top-level report defines the output format and the
+    # interactive setting.
+    def interactive?
+      @project.reportContexts.first.report.get('interactive')
+    end
 
   private
     # Convenience function to access a report attribute
@@ -114,14 +130,10 @@ class TaskJuggler
                                'keywords' => 'taskjuggler, project, management')
       if a('selfcontained')
         auxSrcDir = AppConfig.dataDirs('data/css')[0]
-        cssFileName = auxSrcDir + '/tjreport.css'
+        cssFileName = (auxSrcDir ? auxSrcDir + '/tjreport.css' : '')
+        # Raise an error if we haven't found the data directory
         if auxSrcDir.nil? || !File.exists?(cssFileName)
-          raise TjException.new, <<"EOT"
-Cannot find '#{cssFileName}'. This is usually the result of an improper
-TaskJuggler installation. If you know where to find the data directory, you
-can use the TASKJUGGLER_DATA_PATH environment variable to specify the
-location. The variable should be set to the path without the /data at the end.
-EOT
+          dataDirError(cssFileName)
         end
         cssFile = IO.read(cssFileName)
         if cssFile.empty?
@@ -139,6 +151,8 @@ EOT
                                'type' => 'text/css',
                                'href' => 'css/tjreport.css')
       end
+      html << XMLComment.new("Dynamic Report ID: " +
+                             "#{@project.reportContexts.last.dynamicReportId}")
       html << (body = XMLElement.new('body'))
 
       unless a('selfcontained')
@@ -172,8 +186,17 @@ EOT
                              'href' => "#{AppConfig.contact}")
       div << XMLText.new(" v#{AppConfig.version}")
 
-      html.write(((@name[0] == '/' ? '' : @project.outputDir) +
-                  @name + (@name == '.' ? '' : '.html')).untaint)
+      fileName =
+        if a('interactive') || @name == '.'
+          # Interactive HTML reports are always sent to stdout.
+          '.'
+        else
+          # Prepend the specified output directory unless the provided file
+          # name is an absolute file name.
+          ((@name[0] == '/' ? '' : @project.outputDir) +
+           @name + '.html').untaint
+        end
+      html.write(fileName)
     end
 
     # Generate a CSV version of the report.
@@ -253,7 +276,8 @@ EOT
     end
 
     def copyAuxiliaryFiles
-      return if @name == '.' # Don't copy files if output is stdout.
+      # Don't copy files if output is stdout.
+      return if @name == '.' || a('interactive')
 
       copyDirectory('css')
       copyDirectory('icons')
@@ -266,14 +290,8 @@ EOT
                                @name) + '/'
       # Find the data directory that came with the TaskJuggler installation.
       auxSrcDir = AppConfig.dataDirs("data/#{dirName}")[0]
-      if auxSrcDir.nil? || !File.exists?(auxSrcDir)
-        raise TjException.new, <<"EOT"
-Cannot find the #{dirName} directory. This is usually
-the result of an improper TaskJuggler installation. If you know the directory,
-you can use the TASKJUGGLER_DATA_PATH environment variable to specify the
-location.
-EOT
-      end
+      # Raise an error if we haven't found the data directory
+      dataDirError(dirName) if auxSrcDir.nil? || !File.exists?(auxSrcDir)
       # Don't copy directory if all files are up-to-date.
       return if directoryUpToDate?(auxSrcDir, auxDstDir + dirName)
 
@@ -295,6 +313,16 @@ EOT
       true
     end
 
+    def dataDirError(dirName)
+      raise TjException.new, <<"EOT"
+Cannot find the #{dirName} directory. This is usually the result of an
+improper TaskJuggler installation. If you know the directory, you can use the
+TASKJUGGLER_DATA_PATH environment variable to specify the location.  The
+variable should be set to the path without the /data at the end. Multiple
+directories must be separated by colons.
+EOT
+    end
+
     def error(id, message)
         @project.messageHandler.send(Message.new(id, 'error', message, nil, nil,
                                                  @sourceFileInfo))

data/lib/reports/ReportBase.rb

@@ -28,7 +28,7 @@ class TaskJuggler
     end
 
     def generateIntermediateFormat
-      query = @report.project.reportContext.query
+      query = @report.project.reportContexts.last.query
       %w( header left center right footer
           prolog headline caption epilog ).each do |name|
         next unless text = a(name)
@@ -49,7 +49,7 @@ class TaskJuggler
     # hide expression, the rollup Expression or are not a descendent of
     # 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)
+    def filterTaskList(list_, resource, hideExpr, rollupExpr, openNodes)
       list = PropertyList.new(list_)
       if (taskRoot = a('taskRoot'))
         # Remove all tasks that are not descendents of the taskRoot.
@@ -73,14 +73,14 @@ class TaskJuggler
         end
       end
 
-      standardFilterOps(list, hideExpr, rollupExpr, resource, taskRoot)
+      standardFilterOps(list, hideExpr, rollupExpr, openNodes, resource, taskRoot)
     end
 
     # 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
     # it is assigned to the task in any of the reported scenarios.
-    def filterResourceList(list_, task, hideExpr, rollupExpr)
+    def filterResourceList(list_, task, hideExpr, rollupExpr, openNodes)
       list = PropertyList.new(list_)
       if (resourceRoot = a('resourceRoot'))
         # Remove all resources that are not descendents of the resourceRoot.
@@ -104,7 +104,7 @@ class TaskJuggler
         end
       end
 
-      standardFilterOps(list, hideExpr, rollupExpr, task, resourceRoot)
+      standardFilterOps(list, hideExpr, rollupExpr, openNodes, task, resourceRoot)
     end
 
     private
@@ -140,9 +140,10 @@ class TaskJuggler
 
     # This function implements the generic filtering functionality for all kinds
     # of lists.
-    def standardFilterOps(list, hideExpr, rollupExpr, scopeProperty, root)
+    def standardFilterOps(list, hideExpr, rollupExpr, openNodes, scopeProperty,
+                          root)
       # Make a copy of the current Query.
-      query = @project.reportContext.query.dup
+      query = @project.reportContexts.last.query.dup
       query.scopeProperty = scopeProperty
 
       # Remove all properties that the user wants to have hidden.
@@ -154,13 +155,17 @@ class TaskJuggler
       end
 
       # Remove all children of properties that the user has rolled-up.
-      if rollupExpr
+      if rollupExpr || openNodes
         list.delete_if do |property|
           parent = property.parent
           delete = false
           while (parent)
             query.property = parent
-            if rollupExpr.eval(query)
+            # If openNodes is not nil, only the listed nodes will be unrolled.
+            # If openNodes is nil, only the nodes that match rollupExpr will
+            # not be unrolled.
+            if (openNodes && !openNodes.include?([ parent, scopeProperty ])) ||
+               (!openNodes && rollupExpr.eval(query))
               delete = true
               break
             end

data/lib/reports/ReportContext.rb

@@ -15,15 +15,17 @@ class TaskJuggler
   # 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.
+  # always accessable via Project.reportContexts.last().
   class ReportContext
 
-    attr_reader :project, :report, :query
-    attr_accessor :tasks, :resources
+    attr_reader :dynamicReportId, :project, :report, :query
+    attr_accessor :childReportCounter, :tasks, :resources, :attributeBackup
 
     def initialize(project, report)
       @project = project
       @report = report
+      @childReportCounter = 0
+      @attributeBackup = nil
       queryAttrs = {
         'project' => @project,
         'loadUnit' => @report.get('loadUnit'),
@@ -36,13 +38,26 @@ class TaskJuggler
         'revenueAccount' => @report.get('revenueAccount')
       }
       @query = Query.new(queryAttrs)
-      if (@parent = @project.reportContext)
+      if (@parent = @project.reportContexts.last)
+        # For interactive reports we need some ID that uniquely identifies the
+        # report within the composed report. Since a project report can be
+        # included multiple times in the same report, we need to generate
+        # another ID for each instantiated report. We create this report by
+        # using a counter for the number of child reports that each report
+        # has. The unique ID is then the concatenated list of counters from
+        # parent to leaf, separating each value by a '.'.
+        @dynamicReportId = @parent.dynamicReportId +
+                           ".#{@parent.childReportCounter}"
+        @parent.childReportCounter += 1
         # If the new ReportContext is created from within an existing context,
         # this is used as parent context and the settings are copied as
         # default initial values.
         @tasks = @parent.tasks.dup
         @resources = @parent.resources.dup
       else
+        # The ID of the root report is always "0". The first child will then
+        # be "0.0", the seconds "0.1" and so on.
+        @dynamicReportId = "0"
         # There is no existing ReportContext yet, so we create one based on
         # the settings of the report.
         @tasks = @project.tasks.dup

data/lib/reports/ReportTable.rb

@@ -131,8 +131,8 @@ class TaskJuggler
 
     # Convert the intermediate representation into an Array of Arrays. _csv_ is
     # the destination Array of Arrays. It may contain columns already.
-    def to_csv()
-      csv = [ [ ] ]
+    def to_csv(csv = nil)
+      csv = [ [ ] ] unless csv
       @columns.each { |col| col.to_csv(csv) }
 
       @lines.each do |line|

data/lib/reports/ReportTableCell.rb

@@ -141,16 +141,32 @@ class TaskJuggler
       # We only support left indentation in CSV files as the spaces for right
       # indentation will be disregarded by most applications.
       indent = @indent && @alignment == :left ? '  ' * @indent : ''
-      if @special
-        csv[-1] << @special.to_csv
-      elsif @data && @data.is_a?(String)
-        csv[-1] << indent + @data
-      elsif @text
-        if @text.respond_to?('functionHandler')
-          @text.functionHandler('query').setQuery(@query)
+      cell =
+        if @special
+          @special.to_csv
+          indent = nil
+        elsif @data && @data.is_a?(String)
+          @data
+        elsif @text
+          if @text.respond_to?('functionHandler') &&
+             @text.functionHandler('query')
+            @text.functionHandler('query').setQuery(@query)
+          end
+          str = @text.to_s
+          # Remove any trailing line breaks. These don't really make much
+          # sense in CSV files.
+          while str[-1] == ?\n
+            str.chomp!
+          end
+          str
         end
-        csv[-1] << indent + shortVersion(@text)[0]
-      end
+
+      # Try to convert numbers and other types to their native Ruby type if
+      # they are supported by CSVFile.
+      native = CSVFile.strToNative(cell)
+
+      # Only for String objects, we add the indentation.
+      csv[-1] << (native.is_a?(String) ? indent + native : native)
     end
 
     private
@@ -218,33 +234,41 @@ class TaskJuggler
       if @fontColor
         style += "color:#{@fontColor}; "
       end
+
+      return nil, nil if @text.nil? || @text.empty?
+
       td = XMLElement.new('td', 'class' => 'tj_table_cell_label',
                                 'style' => style)
-
       tooltip = nil
-      unless @text.nil? || @text.empty?
-        if @text.respond_to?('functionHandler') &&
-           @text.functionHandler('query')
-          @text.functionHandler('query').setQuery(@query)
-        end
 
-        shortText, singleLine = shortVersion(@text)
-        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.
-          td << XMLText.new(shortText)
-          tooltip = @text if @text != shortText
-        else
-          # 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
-            td << @text.to_html
-          else
-            td << XMLText.new(@text)
+      # @text can be a String or a RichText (with or without embedded
+      # queries). To find out if @text has multiple lines, we need to expand
+      # it and convert it to a plain text again.
+      textAsString =
+        if @text.is_a?(RichTextIntermediate)
+          # @text is a RichText.
+          if @text.respond_to?('functionHandler') &&
+             @text.functionHandler('query')
+            @text.functionHandler('query').setQuery(@query)
           end
+          @text.to_s
+        else
+          @text
         end
+
+      return nil, nil if textAsString.empty?
+
+      shortText, singleLine = shortVersion(textAsString)
+
+      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.
+        tooltip = @text if shortText != textAsString
+        td << XMLText.new(shortText)
+      else
+        td << (@text.is_a?(RichTextIntermediate) ? @text.to_html :
+                                                   XMLText.new(@text))
       end
 
       return td, tooltip