taskjuggler 0.0.3 → 0.0.4

data/lib/reports/TaskListRE.rb

@@ -3,7 +3,7 @@
 #
 # = TaskListRE.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
@@ -30,6 +30,8 @@ class TaskJuggler
 
     # Generate the table in the intermediate format.
     def generateIntermediateFormat
+      super
+
       setReportPeriod
 
       # Prepare the task list.
@@ -37,6 +39,7 @@ class TaskJuggler
       taskList.setSorting(@report.get('sortTasks'))
       taskList = filterTaskList(taskList, nil, @report.get('hideTask'),
                                 @report.get('rollupTask'))
+      taskList.query = @report.project.reportContext.query
       taskList.sort!
 
       # Prepare the resource list.
@@ -45,6 +48,7 @@ class TaskJuggler
       resourceList = filterResourceList(resourceList, nil,
                                         @report.get('hideResource'),
                                         @report.get('rollupResource'))
+      resourceList.query = @report.project.reportContext.query
       resourceList.sort!
 
       adjustReportPeriod(taskList, @report.get('scenarios'),

data/lib/reports/TextReport.rb

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby -w
 # encoding: UTF-8
 #
-# = ReportBase.rb -- The TaskJuggler III Project Management Software
+# = TextReport.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,6 +28,8 @@ class TaskJuggler
     end
 
     def generateIntermediateFormat
+      super
+
       if a('center')
         if a('left') && a('right')
           @lWidth = @rWidth = 20
@@ -66,8 +68,9 @@ class TaskJuggler
         %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}%"))
-            td << rt_to_html(i)
+            tr << (td = XMLElement.new('td', 'width' => "#{width}%",
+                                       'style' => 'vertical-align:top'))
+            td << (el = rt_to_html(i))
           end
         end
 

data/lib/reports/TimeSheetReport.rb

@@ -0,0 +1,233 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = TimeSheetReport.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
+
+  # Utility class for the intermediate TimeSheetReport format.
+  class TSResourceRecord
+
+    attr_reader :resource, :tasks
+
+    def initialize(resource)
+      @resource = resource
+      @tasks = []
+    end
+
+  end
+
+  # Utility class for the intermediate TimeSheetReport format.
+  class TSTaskRecord
+
+    attr_reader :task, :work, :remaining, :endDate
+
+    def initialize(task, work, remaining = nil, endDate = nil)
+      @task = task
+      @work = work
+      @remaining = remaining
+      @endDate = endDate
+    end
+
+  end
+
+  # This specialization of ReportBase implements a template generator for time
+  # sheets. The time sheet is structured using the TJP file syntax.
+  class TimeSheetReport < ReportBase
+
+    attr_reader :mainFile
+
+    # Create a new object and set some default values.
+    def initialize(report)
+      super(report)
+
+      @report.set('scenarios', [ 0 ])
+      # Show all tasks, sorted by seqno-up.
+      @report.set('hideTask', LogicalExpression.new(LogicalOperation.new(0)))
+      @report.set('sortTasks', [ [ 'seqno', true, -1 ] ])
+      # Show all resources, sorted by seqno-up.
+      @report.set('hideResource', LogicalExpression.new(LogicalOperation.new(0)))
+      @report.set('sortResources', [ [ 'seqno', true, -1 ] ])
+
+      @records = []
+    end
+
+    # In the future we might want to generate other output than TJP synatx. So
+    # we generate an abstract version of the time sheet first. This abstract
+    # version has a TSResourceRecord for each resource and each of these
+    # records holds a TSTaskRecord for each assigned task.
+    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'))
+
+      resourceList.each do |resource|
+        # Time sheets only make sense for leaf resources that actuall do work.
+        next unless resource.leaf?
+
+        # Create a new TSResourceRecord for the resource.
+        @records << (resourceRecord = TSResourceRecord.new(resource))
+
+        # Now we have to find all the task that the resource is allocated to
+        # during the report period.
+        assignedTaskList = filterTaskList(taskList, resource,
+                                          a('hideTask'),
+                                          a('rollupTask'))
+        queryAttrs['scopeProperty'] = resource
+        assignedTaskList.query = Query.new(queryAttrs)
+        assignedTaskList.sort!
+
+        assignedTaskList.each do |task|
+          # Time sheet task records only make sense for leaf tasks.
+          next unless task.leaf?
+
+          queryAttrs['property'] = task
+          query = Query.new(queryAttrs)
+
+          # Get the allocated effort for the task for this period.
+          query.attributeId = 'effort'
+          query.start = a('start')
+          query.end = a('end')
+          query.process
+          work = query.to_s
+
+          if task['effort', scenarioIdx]
+            # The task is an effort based task.
+            # Get the remaining effort for this task.
+            query.start = a('end')
+            query.end = task['end', scenarioIdx]
+            query.process
+            remaining = query.to_s
+            endDate = nil
+          else
+            # The task is a duration task.
+            # Get the planned task end date.
+            remaining = nil
+            endDate = task['end', scenarioIdx]
+          end
+
+          # Put all data into a TSTaskRecord and push it into the resource
+          # record.
+          resourceRecord.tasks <<
+            TSTaskRecord.new(task, work, remaining, endDate)
+        end
+      end
+    end
+
+    # Generate a time sheet in TJP syntax format.
+    def to_tjp
+
+      # Prepare the task list.
+      @taskList = PropertyList.new(@project.tasks)
+      @taskList.setSorting(a('sortTasks'))
+      @taskList = filterTaskList(@taskList, nil, a('hideTask'), a('rollupTask'))
+      @taskList.sort!
+
+      # This String will hold the result.
+      @file = ''
+
+      # Iterate over all the resources that we have TSResourceRecords for.
+      @records.each do |rr|
+        resource = rr.resource
+        # Generate the time sheet header
+        @file << "timesheet #{resource.fullId} " +
+                 "#{a('start')} - #{a('end')} {\n\n"
+
+        if rr.tasks.empty?
+          # If there were no assignments, just write a comment.
+          @file << "  # There were no planned tasks assignements for " +
+                   "this period!\n\n"
+        else
+          rr.tasks.each do |tr|
+            task = tr.task
+
+            @file << "  # Task: #{task.name}\n"
+            @file << "  task #{task.fullId} {\n"
+            @file << "    work #{tr.work}\n"
+            if tr.remaining
+              @file << "    remaining #{tr.remaining}\n"
+            else
+              @file << "    end #{tr.endDate.to_tjp}\n"
+            end
+            @file << "    status green \"Your status here!\" {\n" +
+                     "      summary\n" +
+                     "      -8<-\n" +
+                     "      Your summary here!\n" +
+                     "      ->8-\n" +
+                     "    }\n"
+            @file << "  }\n\n"
+          end
+        end
+        @file << <<'EOT'
+  # If you had unplanned tasks, uncomment and fill out the following lines:
+  # newtask new.task.id "A task title" {
+  #   work X.Xd
+  #   remaining Y.Yd
+  # }
+EOT
+        @file << "}\n\n"
+      end
+      @file
+    end
+
+  private
+
+    # This utility function is used to indent multi-line attributes. All
+    # attributes should be filtered through this function. Attributes that
+    # contain line breaks will be indented properly. In addition to the
+    # indentation specified by _indent_ all but the first line will be indented
+    # after the first word of the first line. The text may not end with a line
+    # break.
+    def indentBlock(text, indent)
+      out = ''
+      firstSpace = 0
+      text.length.times do |i|
+        if firstSpace == 0 && text[i] == ?\ # There must be a space after ?
+          firstSpace = i
+        end
+        out << text[i]
+        if text[i] == ?\n
+          out += ' ' * (indent + firstSpace)
+        end
+      end
+      out
+    end
+
+  end
+
+end
+

data/lib/reports/TjpExportRE.rb

@@ -3,7 +3,7 @@
 #
 # = TjpExportRE.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
@@ -41,8 +41,8 @@ class TaskJuggler
       @report.set('sortResources', [ [ 'seqno', true, -1 ] ])
     end
 
-    # There is nothing to do here.
     def generateIntermediateFormat
+      super
     end
 
     # Return the project data in TJP syntax format.

data/lib/taskjuggler3.rb

@@ -3,7 +3,7 @@
 #
 # = taskjuggler3.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,12 +20,12 @@ AppConfig.appName = 'taskjuggler3'
 def processArguments(argv)
   opts = OptionParser.new
 
-  opts.banner = "#{AppConfig.packageName} v#{AppConfig.version} - " +
+  opts.banner = "#{AppConfig.softwareName} v#{AppConfig.version} - " +
                 "#{AppConfig.packageInfo}\n\n" +
                 "Copyright (c) #{AppConfig.copyright.join(', ')}" +
                 " by #{AppConfig.authors.join(', ')}\n\n" +
                 "#{AppConfig.license}\n" +
-                "For more info about #{AppConfig.packageName} see " +
+                "For more info about #{AppConfig.softwareName} see " +
                 "#{AppConfig.contact}\n\n" +
                 "Usage: #{AppConfig.appName} [options] file.tjp " +
                 "[ file1.tji ... ]"
@@ -44,6 +44,11 @@ def processArguments(argv)
           'Generate reports despite scheduling errors') do
     @forceReports = true
   end
+  opts.on('-s', '--report-server',
+          'Parse and schedule the project and wait for remote report ' +
+          'requests') do
+    @reportServer = true
+  end
   opts.on('-o', '--output-dir <directory>', String,
           'Directory the reports should go into') do |arg|
     @outputDir = arg + '/'
@@ -57,7 +62,7 @@ def processArguments(argv)
   end
 
   opts.on_tail('--version', 'Show version info') do
-    puts "#{AppConfig.packageName} v#{AppConfig.version} - " +
+    puts "#{AppConfig.softwareName} v#{AppConfig.version} - " +
       "#{AppConfig.packageInfo}"
     exit 0
   end
@@ -74,12 +79,12 @@ def processArguments(argv)
 
   if files.empty?
     puts opts.to_s
-    $stderr.puts "\nNo file name specified!"
+    $stderr.puts "\nNo project file name specified!"
     exit 1
   end
 
   unless TaskJuggler::Log.silent
-    puts "#{AppConfig.packageName} v#{AppConfig.version} - " +
+    puts "#{AppConfig.softwareName} v#{AppConfig.version} - " +
       "#{AppConfig.packageInfo}\n\n" +
       "Copyright (c) #{AppConfig.copyright.join(', ')}" +
       " by #{AppConfig.authors.join(', ')}\n\n" +
@@ -92,17 +97,28 @@ end
 def main
   @maxCpuCores = 1
   @forceReports = false
+  @reportServer = false
   @outputDir = ''
 
-  errors = false
-  tj = TaskJuggler.new(files = processArguments(ARGV))
+  # Install signal handler to exit gracefully on CTRL-C.
+  Kernel.trap('INT') do
+    puts "\nAborting on user request!"
+    exit 1
+  end
+
+  files = processArguments(ARGV)
+  tj = TaskJuggler.new(true)
   tj.maxCpuCores = @maxCpuCores
-  exit 1 unless tj.parse(files)
+  exit 1 unless tj.parse(files, @reportServer)
   if !tj.schedule
-    errors = true
     exit 1 unless @forceReports
   end
-  exit 1 if !tj.generateReports(@outputDir) || errors
+
+  if @reportServer
+    tj.serveReports
+  else
+    exit 1 if !tj.generateReports(@outputDir) || tj.errors > 0
+  end
 
 end
 

data/lib/tj3client.rb

@@ -0,0 +1,110 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = tj3client.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 'optparse'
+require 'drb'
+require 'Tj3Config'
+
+# Name of the application suite
+AppConfig.appName = 'tj3client'
+
+def processArguments(argv)
+  opts = OptionParser.new
+
+  opts.banner = "#{AppConfig.softwareName} v#{AppConfig.version} - " +
+                "#{AppConfig.packageInfo}\n\n" +
+                "Copyright (c) #{AppConfig.copyright.join(', ')}" +
+                " by #{AppConfig.authors.join(', ')}\n\n" +
+                "#{AppConfig.license}\n" +
+                "For more info about #{AppConfig.softwareName} see " +
+                "#{AppConfig.contact}\n\n" +
+                "Usage: #{AppConfig.appName} [options] file.tjp " +
+                "[ file1.tji ... ]"
+  opts.separator ""
+  opts.on('--silent', "Don't show program and progress information") do
+    @silent = true
+  end
+  opts.on('-g', '--generate-report <ID>', String,
+          'Generate reports despite scheduling errors') do |arg|
+    @reports << arg
+  end
+  opts.on_tail('-h', '--help', 'Show this message') do
+    puts opts.to_s
+    exit 0
+  end
+
+  opts.on_tail('--version', 'Show version info') do
+    puts "#{AppConfig.softwareName} v#{AppConfig.version} - " +
+      "#{AppConfig.packageInfo}"
+    exit 0
+  end
+
+  # Show some progress information by default
+  @silent = false
+  begin
+    files = opts.parse(argv)
+  rescue OptionParser::ParseError => msg
+    puts opts.to_s + "\n"
+    $stderr.puts msg
+    exit 0
+  end
+
+  unless @silent
+    puts "#{AppConfig.softwareName} v#{AppConfig.version} - " +
+      "#{AppConfig.packageInfo}\n\n" +
+      "Copyright (c) #{AppConfig.copyright.join(', ')}" +
+      " by #{AppConfig.authors.join(', ')}\n\n" +
+      "#{AppConfig.license}\n"
+  end
+
+  files
+end
+
+def main
+  @reports = []
+
+  # Install signal handler to exit gracefully on CTRL-C.
+  Kernel.trap('INT') do
+    puts "\nAborting on user request!"
+    exit 1
+  end
+
+  files = processArguments(ARGV)
+
+  # Connect to the RemoteServiceManager object and request a new service
+  # process.
+  DRb.start_service
+  serviceManager = DRbObject.new(nil, 'druby://localhost:8474')
+
+  uri = serviceManager.requestService
+  DRb.stop_service
+
+  DRb.start_service
+  server = DRbObject.new(nil, uri)
+  server.connect($stdout, $stderr)
+
+  files.each do |file|
+    fileContent = IO.read(file)
+    server.parse(fileContent)
+  end
+
+  @reports.each do |id|
+    server.generateReport(id)
+  end
+
+  server.disconnect
+end
+
+main()
+exit 0
+
+