taskjuggler 3.1.0 → 3.2.0

data/lib/taskjuggler/Painter/Group.rb

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = Group.rb -- The TaskJuggler III Project Management Software
+#
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
+#               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
+# published by the Free Software Foundation.
+#
+
+require 'taskjuggler/Painter/Primitives'
+require 'taskjuggler/Painter/SVGSupport'
+
+class TaskJuggler
+
+  class Painter
+
+    # The Group can be used to group Elements together and define common
+    # attributes in a single place.
+    class Group
+
+      include Primitives
+      include SVGSupport
+
+      def initialize(values, &block)
+        @attributes = [
+          :fill, :font_family, :font_size, :stroke, :stroke_width
+        ]
+        values.each do |k, v|
+          unless @attributes.include?(k)
+            raise ArgumentError, "Unsupported attribute #{k}. " +
+                                 "Use one of #{@attributes.join(', ')}."
+          end
+        end
+
+        @values = values
+        @elements = []
+
+        if block
+          if block.arity == 1
+            # This is the traditional case where self is passed to the block.
+            # All Primitives methods now must be prefixed with the block
+            # variable to call them.
+            yield self
+          else
+            # In order to have the primitives easily available in the block,
+            # we use instance_eval to switch self to this object. But this
+            # makes the methods of the original self no longer accessible. We
+            # work around this by saving the original self and using
+            # method_missing to delegate the method call to the original self.
+            @originalSelf = eval('self', block.binding)
+            instance_eval(&block)
+          end
+        end
+      end
+
+      # Delegator to @originalSelf.
+      def method_missing(method, *args, &block)
+        @originalSelf.send(method, *args, &block)
+      end
+
+      # Convert the Group into an XMLElement tree using SVG syntax.
+      def to_svg
+        XMLElement.new('g', valuesToSVG) do
+          @elements.map { |el| el.to_svg }
+        end
+      end
+
+    end
+
+  end
+
+end
+

data/lib/taskjuggler/Painter/Points.rb

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = Points.rb -- The TaskJuggler III Project Management Software
+#
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
+#               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
+# published by the Free Software Foundation.
+#
+
+class TaskJuggler
+
+  class Painter
+
+    # Utility class to describe a list of x, y coordinates. Each coordinate is
+    # an Array with 2 elements. The whole list is another Array.
+    class Points
+
+      # Store the list after doing some error checking.
+      def initialize(arr)
+        arr.each do |point|
+          unless point.is_a?(Array) && point.length == 2
+            raise ArgumentError, 'Points must be an Array with 2 coordinates'
+          end
+        end
+        @points = arr
+      end
+
+      # Conver the list of coordinates into a String that is compatible with
+      # SVG syntax.
+      def to_s
+        str = ''
+        @points.each do |point|
+          str += "#{point[0]},#{point[1]} "
+        end
+        str
+      end
+
+    end
+
+  end
+
+end
+

data/lib/taskjuggler/Painter/Primitives.rb

@@ -0,0 +1,100 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = Primitives.rb -- The TaskJuggler III Project Management Software
+#
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
+#               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
+# published by the Free Software Foundation.
+#
+
+require 'taskjuggler/Painter/Color'
+require 'taskjuggler/Painter/Points'
+
+class TaskJuggler
+
+  class Painter
+
+    # This module contains utility methods to create the canvas Elements with
+    # minimal overhead. The element is added to it's current parent and
+    # mandatory arguments are enforced. It also eliminates the need to call
+    # 'new' methods of each Element.
+    module Primitives
+
+      unless defined?(StrokeAttrs)
+        StrokeAttrs = [ :stroke, :stroke_opacity, :stroke_width ]
+        FillAttrs = [ :fill, :fill_opacity ]
+        FillAndStrokeAttrs = StrokeAttrs + FillAttrs
+        TextAttrs = FillAndStrokeAttrs + [ :font_family, :font_size ]
+      end
+
+      def color(*args)
+        Color.new(*args)
+      end
+
+      def points(arr)
+        Points.new(arr)
+      end
+
+      def group(attrs = {}, &block)
+        @elements << (g = Group.new(attrs, &block))
+        g
+      end
+
+      def circle(cx, cy, r, attrs = {})
+        attrs[:cx] = cx
+        attrs[:cy] = cy
+        attrs[:r] = r
+        @elements << (c = Circle.new(attrs))
+        c
+      end
+
+      def ellipse(cx, cy, rx, ry, attrs = {})
+        attrs[:cx] = cx
+        attrs[:cy] = cy
+        attrs[:rx] = rx
+        attrs[:ry] = ry
+        @elements << (e = Ellipse.new(attrs))
+        e
+      end
+
+      def line(x1, y1, x2, y2, attrs = {})
+        attrs[:x1] = x1
+        attrs[:y1] = y1
+        attrs[:x2] = x2
+        attrs[:y2] = y2
+        @elements << (l = Line.new(attrs))
+        l
+      end
+
+      def polyline(points, attrs = {})
+        attrs[:points] = points.is_a?(Array) ? Points.new(points) : points
+        @elements << (l = PolyLine.new(attrs))
+        l
+      end
+
+      def rect(x, y, width, height, attrs = {})
+        attrs[:x] = x
+        attrs[:y] = y
+        attrs[:width] = width
+        attrs[:height] = height
+        @elements << (r = Rect.new(attrs))
+        r
+      end
+
+      def text(x, y, str, attrs = {})
+        attrs[:x] = x
+        attrs[:y] = y
+        @elements << (t = Text.new(str, attrs))
+        t
+      end
+
+    end
+
+  end
+
+end
+

data/lib/taskjuggler/Painter/SVGSupport.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = SVGSupport.rb -- The TaskJuggler III Project Management Software
+#
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
+#               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
+# published by the Free Software Foundation.
+#
+
+class TaskJuggler
+
+  class Painter
+
+    # Utility module to convert the attributes into SVG compatible syntax.
+    module SVGSupport
+
+      def valuesToSVG
+        values = {}
+        @values.each do |k, v|
+          unit = k == :font_size ? 'pt' : ''
+          # Convert the underscores to dashes and the symbols to Strings.
+          values[k.to_s.gsub(/[_]/, '-')] = v.to_s + unit
+        end
+        values
+      end
+
+    end
+
+  end
+
+end
+

data/lib/taskjuggler/Painter/Text.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = Text.rb -- The TaskJuggler III Project Management Software
+#
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
+#               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
+# published by the Free Software Foundation.
+#
+
+require 'taskjuggler/XMLElement'
+require 'taskjuggler/Painter/Element'
+
+class TaskJuggler
+
+  class Painter
+
+    # A text element.
+    class Text < Element
+
+      # Create a text of _str_ at x, y coordinates.
+      def initialize(str, attrs)
+        super('text', [ :x, :y ] + TextAttrs, attrs)
+        @text = str
+      end
+
+    end
+
+  end
+
+end
+
+

data/lib/taskjuggler/Project.rb

@@ -54,16 +54,15 @@ class TaskJuggler
   # the list of known Attributes.
   class Project
 
+    include MessageHandler
+
     attr_reader :accounts, :shifts, :tasks, :resources, :scenarios,
-                :timeSheets, :reports, :messageHandler, :inputFiles
+                :timeSheets, :reports, :inputFiles
     attr_accessor :reportContexts, :outputDir, :warnTsDeltas
 
     # Create a project with the specified +id+, +name+ and +version+.
-    # +messageHandler+ is a MessageHandler reference that is used to handle
-    # all error and warning messages that might occur during processing. The
-    # constructor will set default values for all project attributes.
-    def initialize(id, name, version, messageHandler)
-      @messageHandler = messageHandler
+    # The constructor will set default values for all project attributes.
+    def initialize(id, name, version)
       AttributeBase.setMode(0)
       @attributes = {
         # This nested Array defines the supported alert levels. The lowest
@@ -73,7 +72,7 @@ class TaskJuggler
         # associated color as RGB byte array.
         'alertLevels' => AlertLevelDefinitions.new,
         'copyright' => nil,
-        'costAccount' => nil,
+        'costaccount' => nil,
         'currency' => "EUR",
         'currencyFormat' => RealFormat.new([ '-', '', '', ',', 2 ]),
         'dailyworkinghours' => 8.0,
@@ -91,7 +90,7 @@ class TaskJuggler
         'projectid' => id || "prj",
         'projectids' => [ id ],
         'rate' => 0.0,
-        'revenueAccount' => nil,
+        'revenueaccount' => nil,
         'scheduleGranularity' => Project.maxScheduleGranularity,
         'shortTimeFormat' => "%H:%M",
         'start' => nil,
@@ -333,7 +332,7 @@ class TaskJuggler
       attrs = [
         # ID           Name            Type
         #     Inh.   Inh.Prj  Scen.  Default
-        [ 'accountRoot',  'Account Root',    PropertyAttribute,
+        [ 'accountroot',  'Account Root',    PropertyAttribute,
               true,  false,   false, nil ],
         [ 'bsi',       'BSI',          StringAttribute,
               false, false,   false, "" ],
@@ -343,7 +342,7 @@ class TaskJuggler
               true,  false,   false, nil ],
         [ 'columns',   'Columns',      ColumnListAttribute,
               true,  false,   false, [] ],
-        [ 'costAccount', 'Cost Account', AccountAttribute,
+        [ 'costaccount', 'Cost Account', AccountAttribute,
               true,  true,    false, nil ],
         [ 'currencyFormat', 'Currency Format', RealFormatAttribute,
               true,  true,    false, nil ],
@@ -373,6 +372,8 @@ class TaskJuggler
               true,  false,   false, nil ],
         [ 'hideTask',  'Hide Task',    LogicalExpressionAttribute,
               true,  false,   false, nil ],
+        [ 'height',    'Height',       FixnumAttribute,
+              false,  false,   false, 480 ],
         [ 'id',       'ID',         StringAttribute,
               false, false,   false, nil ],
         [ 'index',     'Index',        FixnumAttribute,
@@ -399,9 +400,9 @@ class TaskJuggler
               true, false,   false, nil],
         [ 'resourceAttributes', 'Resource Attributes', FormatListAttribute,
               true,  false,   false, KeywordArray.new([ '*' ]) ],
-        [ 'resourceRoot',  'resource Root', PropertyAttribute,
+        [ 'resourceroot',  'resource Root', PropertyAttribute,
               true,  false,   false, nil ],
-        [ 'revenueAccount', 'Revenue Account', AccountAttribute,
+        [ 'revenueaccount', 'Revenue Account', AccountAttribute,
               true,  true,    false, nil ],
         [ 'right',     'Right',        RichTextAttribute,
               true,  false,   false, nil ],
@@ -431,7 +432,7 @@ class TaskJuggler
               true,  true,    false, nil ],
         [ 'taskAttributes', 'Task Attributes', FormatListAttribute,
               true,  false,   false, KeywordArray.new([ '*' ]) ],
-        [ 'taskRoot',  'Task Root',    PropertyAttribute,
+        [ 'taskroot',  'Task Root',    PropertyAttribute,
               true,  false,   false, nil ],
         [ 'timeFormat', 'Time Format', StringAttribute,
               true,  true,    false, nil ],
@@ -446,7 +447,9 @@ class TaskJuggler
         [ 'tree',      'Tree Index',   StringAttribute,
               false, false,   false, "" ],
         [ 'weekStartsMonday', 'Week Starts Monday', BooleanAttribute,
-              true,  true,    false, false ]
+              true,  true,    false, false ],
+        [ 'width',     'Width',        FixnumAttribute,
+              true,  false,   false, 640 ]
       ]
       attrs.each { |a| @reports.addAttributeType(AttributeDefinition.new(*a)) }
 
@@ -653,6 +656,24 @@ class TaskJuggler
       true
     end
 
+    # Add the CSV output format to all reports of type 'tracereport' if
+    # _enable_ is true. Otherwise remove all CSV output formats.
+    def enableTraceReports(enable)
+      @reports.each do |report|
+         next unless report.typeSpec == :tracereport
+
+         if enable
+           # Enable the CSV format for the tracereport
+           unless report.get('formats').include?(:csv)
+             report.get('formats') << :csv
+           end
+         else
+           # Disabe CSV format for the tracereport
+           report.get('formats').delete(:csv)
+         end
+      end
+    end
+
     # Make sure that we have a least one report defined that has an output
     # format.
     def checkReports
@@ -665,8 +686,8 @@ class TaskJuggler
       unless @accounts.empty?
         @reports.each do |report|
           if (report.typeSpec != :accountreport) &&
-             (report.get('costAccount').nil? ||
-              report.get('revenueAccount').nil?)
+             (report.get('costaccount').nil? ||
+              report.get('revenueaccount').nil?)
             warning('report_without_balance',
                     "The report #{report.fullId} has no 'balance' defined. " +
                     "No cost or revenue computation will be possible.",
@@ -690,7 +711,10 @@ class TaskJuggler
       @reports.index
       if maxCpuCores == 1
         @reports.each do |report|
+          # Skip reports that don't have any format specified or trace reports
+          # when generateTraces is false.
           next if report.get('formats').empty?
+
           Log.startProgressMeter("Report #{report.name}")
           @reportContexts.push(ReportContext.new(self, report))
           report.generate
@@ -702,7 +726,11 @@ class TaskJuggler
         # BatchProcessor queue.
         bp = BatchProcessor.new(maxCpuCores)
         @reports.each do |report|
-          next if report.get('formats').empty?
+          # Skip reports that don't have any format specified or trace reports
+          # when generateTraces is false.
+          next if report.get('formats').empty? ||
+                  (report.typeSpec == :trace && !generateTraces)
+
           bp.queue(report) {
             @reportContexts.push(ReportContext.new(self, report))
             res = report.generate
@@ -751,7 +779,7 @@ class TaskJuggler
         if dynamicAttributes
           unless dynamicAttributes.empty?
             context.attributeBackup = report.backupAttributes
-            parser = ProjectFileParser.new(@messageHandler)
+            parser = ProjectFileParser.new
             parser.parseReportAttributes(report, dynamicAttributes)
           end
           report.set('interactive', true)
@@ -1013,17 +1041,6 @@ class TaskJuggler
       str
     end
 
-    # Generate an error message via the message handler.
-    def error(id, text, sourceFileInfo = nil)
-      @messageHandler.error(id, text, sourceFileInfo)
-    end
-
-    # Generate a warning message via the message handle.
-    def warning(id, text, sourceFileInfo = nil)
-      @messageHandler.warning(id, text, sourceFileInfo)
-    end
-
-
   protected
 
     def prepareScenario(scIdx)