taskjuggler 3.6.0 → 3.7.1

data/lib/taskjuggler/UTF8String.rb

@@ -18,7 +18,7 @@ require 'base64'
 # This is an extension and modification of the standard String class. We do a
 # lot of UTF-8 character processing in the parser. Ruby 1.8 does not have good
 # enough UTF-8 support and Ruby 1.9 only handles UTF-8 characters as Strings.
-# This is very inefficient compared to representing them as Fixnum objects.
+# This is very inefficient compared to representing them as Integer objects.
 # Some of these hacks can be removed once we have switched to 1.9 support
 # only.
 class String
@@ -58,8 +58,8 @@ class String
     alias old_double_left_angle <<
 
     # Replacement for the existing << operator that also works for characters
-    # above Fixnum 255 (UTF-8 characters).
-    def << (obj)
+    # above Integer 255 (UTF-8 characters).
+    def <<(obj)
       if obj.is_a?(String) || (obj < 256)
         # In this case we can use the built-in concat.
         concat(obj)

data/lib/taskjuggler/WorkingHours.rb

@@ -17,7 +17,7 @@ require 'taskjuggler/Scoreboard'
 class TaskJuggler
 
   # Class to store the working hours for each day of the week. The working hours
-  # are stored as Arrays of Fixnum intervals for each day of the week. A day off
+  # are stored as Arrays of Integer intervals for each day of the week. A day off
   # is modelled as empty Array for that week day. The start end end times of
   # each working period are stored as seconds after midnight.
   class WorkingHours
@@ -100,7 +100,7 @@ class TaskJuggler
 
     # Set the working hours for a given week day. +dayOfWeek+ must be 0 for
     # Sunday, 1 for Monday and so on. +intervals+ must be an Array that
-    # contains an Array with 2 Fixnums for each working period. Each value
+    # contains an Array with 2 Integers for each working period. Each value
     # specifies the time of day as minutes after midnight. The first value is
     # the start time of the interval, the second the end time.
     def setWorkingHours(dayOfWeek, intervals)
@@ -133,7 +133,7 @@ class TaskJuggler
 
     # Return the working hour intervals for a given day of the week.
     # +dayOfWeek+ must 0 for Sunday, 1 for Monday and so on. The result is an
-    # Array that contains Arrays of 2 Fixnums.
+    # Array that contains Arrays of 2 Integers.
     def getWorkingHours(dayOfWeek)
       @days[dayOfWeek]
     end

data/lib/taskjuggler/XMLElement.rb

@@ -204,7 +204,18 @@ class TaskJuggler
     end
 
     def to_s(indent)
-      '<!-- ' + @text + " -->\n#{' ' * indent}"
+      '<!-- ' + canonicalize_comment(@text) + " -->\n#{' ' * indent}"
+    end
+
+    private
+
+    # It is crucial to canonicalize xml comment text because xml
+    # comment syntax forbids having a -- in the comment body.  I
+    # picked emacs's "M-x comment-region" approach of putting a
+    # backslash between the two.
+    def canonicalize_comment(text)
+      new_text = text.gsub("--", "-\\-")
+      new_text
     end
 
   end

data/lib/taskjuggler/apps/Tj3.rb

@@ -68,10 +68,12 @@ class TaskJuggler
 
     def processArguments(argv)
       super do
-        @opts.banner += <<'EOT'
+        @opts.banner.prepend(<<'EOT'
 This is the main application. It reads in your project files, schedules the
 project and generates the reports.
+
 EOT
+	)
         @opts.on('--debuglevel N', Integer,
                  format("Verbosity of debug output")) do |arg|
           TaskJuggler::Log.level = arg

data/lib/taskjuggler/apps/Tj3Client.rb

@@ -100,7 +100,7 @@ class TaskJuggler
 
     def processArguments(argv)
       super do
-        @opts.banner += <<'EOT'
+        prebanner = <<'EOT'
 The TaskJuggler client is used to send commands and data to the TaskJuggler
 daemon. The communication is done via TCP/IP.
 
@@ -125,9 +125,10 @@ EOT
             end
           end
           args = args.join(' ')
-          @opts.banner += "     #{cmd[:label] + ' ' + args + tail}" +
+          prebanner += "     #{cmd[:label] + ' ' + args + tail}" +
                           "\n\n#{' ' * 10 + format(cmd[:descr], 10)}\n"
         end
+	@opts.banner.prepend(prebanner)
         @opts.on('-p', '--port <NUMBER>', Integer,
                  format('Use the specified TCP/IP port')) do |arg|
            @port = arg

data/lib/taskjuggler/apps/Tj3Daemon.rb

@@ -42,11 +42,13 @@ class TaskJuggler
 
     def processArguments(argv)
       super do
-        @opts.banner += <<'EOT'
+        @opts.banner.prepend(<<'EOT'
 The TaskJuggler daemon can be used to quickly generate reports for a number
 of scheduled projects that are resident in memory. Once the daemon has been
 started tj3client can be used to control it.
+
 EOT
+	)
         @opts.on('-d', '--dont-daemonize',
                  format("Don't put program into daemon mode. Keep it " +
                         'connected to the terminal and show debug output.')) do

data/lib/taskjuggler/apps/Tj3Man.rb

@@ -36,17 +36,19 @@ class TaskJuggler
 
     def processArguments(argv)
       super do
-        @opts.banner += <<'EOT'
+        @opts.banner.prepend(<<'EOT'
 This program can be used to generate the user manual in HTML format or to get
 a textual help for individual keywords.
+
 EOT
+	)
         @opts.on('-d', '--dir <directory>', String,
                 format('directory to put the manual')) do |dir|
           @directory = dir
         end
         @opts.on('--html',
                  format('Show the user manual in your local web browser. ' +
-                        'By default, Firefox is used or the brower specified ' +
+                        'By default, Firefox is used or the browser specified ' +
                         'with the $BROWSER environment variable.')) do
           @showHtml = true
         end

data/lib/taskjuggler/apps/Tj3SsReceiver.rb

@@ -27,13 +27,15 @@ class TaskJuggler
 
     def processArguments(argv)
       super do
-        @opts.banner += <<'EOT'
+        @opts.banner.prepend(<<'EOT'
 This program can be used to receive filled-out status sheets via email.
 It reads the emails from STDIN and extracts the status sheet from the
 attached files. The status sheet is checked for correctness. Good status
 sheets are filed away. The sender be informed by email that the status
 sheets was accepted or rejected.
+
 EOT
+	)
       end
     end
 

data/lib/taskjuggler/apps/Tj3SsSender.rb

@@ -38,11 +38,13 @@ class TaskJuggler
 
     def processArguments(argv)
       super do
-        @opts.banner += <<'EOT'
+        @opts.banner.prepend(<<'EOT'
 This program can be used to out status sheets templates via email. It will
 generate status sheet templates for managers of the project. The project data
 will be accesses via tj3client from a running TaskJuggler server process.
+
 EOT
+	)
         @opts.on('-r', '--resource <ID>', String,
                  format('Only generate template for given resource')) do |arg|
           @resourceList << arg

data/lib/taskjuggler/apps/Tj3TsReceiver.rb

@@ -30,13 +30,15 @@ class TaskJuggler
 
     def processArguments(argv)
       super do
-        @opts.banner += <<'EOT'
+        @opts.banner.prepend(<<'EOT'
 This program can be used to receive filled-out time sheets via email.  It
 reads the emails from STDIN and extracts the time sheet from the attached
 files. The time sheet is checked for correctness. Good time sheets are filed
 away. The sender will be informed by email that the time sheets was accepted
 or rejected.
+
 EOT
+	)
       end
     end
 

data/lib/taskjuggler/apps/Tj3TsSender.rb

@@ -37,11 +37,13 @@ class TaskJuggler
 
     def processArguments(argv)
       super do
-        @opts.banner += <<'EOT'
+        @opts.banner.prepend(<<'EOT'
 This program can be used to send out time sheets templates via email. It will
 generate time sheet templates for all resources of the project. The project
 data will be accesses via tj3client from a running TaskJuggler server process.
+
 EOT
+	)
         @opts.on('-r', '--resource <ID>', String,
                 format('Only generate template for given resource')) do |arg|
           @resourceList << arg

data/lib/taskjuggler/apps/Tj3TsSummary.rb

@@ -36,12 +36,14 @@ class TaskJuggler
 
     def processArguments(argv)
       super do
-        @opts.banner += <<'EOT'
+        @opts.banner.prepend(<<'EOT'
 This program can be used to send out individual copies and a summary of all
 accepted time sheets a list of email addresses. The directory structures for
 templates and submitted time sheets must be present. The project data will be
 accesses via tj3client from a running TaskJuggler server process.
+
 EOT
+	)
         @opts.on('-r', '--resource <ID>', String,
                  format('Only generate summary for given resource')) do |arg|
           @resourceList << arg

data/lib/taskjuggler/apps/Tj3WebD.rb

@@ -40,11 +40,13 @@ class TaskJuggler
 
     def processArguments(argv)
       super do
-        @opts.banner += <<'EOT'
+        @opts.banner.prepend(<<'EOT'
 The TaskJuggler web server can be used to serve the HTTP reports of
 TaskJuggler projects to be viewed by any HTML5 compliant web browser. It uses
 the TaskJuggler daemon (tj3d) for data hosting and report generation.
+
 EOT
+	)
         @opts.on('-d', '--dont-daemonize',
                  format("Don't put program into daemon mode. Keep it " +
                         'connected to the terminal and show debug output.')) do

data/lib/taskjuggler/deep_copy.rb

@@ -37,7 +37,7 @@ class Object
     # We can't clone frozen objects. So just return a reference to them.
     # Built-in classed can't be cloned either. The check below is probably
     # cheaper than the frequent (hiddent) exceptions from those objects.
-    return self if frozen? || nil? || is_a?(Fixnum) || is_a?(Float) ||
+    return self if frozen? || nil? || is_a?(Integer) || is_a?(Float) ||
                    is_a?(TrueClass) || is_a?(FalseClass) || is_a?(Symbol)
 
     # In case we have loops in our graph, we return references, not

data/lib/taskjuggler/reports/CSVFile.rb

@@ -157,7 +157,7 @@ class TaskJuggler
           end
         when :fieldEnd
           # We've completed processing a field. Add the field to the list of
-          # fields. Convert Fixnums and Floats in native types.
+          # fields. Convert Integers and Floats in native types.
           fields << unMarshal(field, quoted)
 
           if c == "\n"
@@ -198,7 +198,7 @@ class TaskJuggler
       if str.nil?
         nil
       elsif /^[-+]?\d+$/ =~ str
-        # field is a Fixnum
+        # field is an Integer
         str.to_i
       elsif /^[-+]?\d*\.?\d+([eE][-+]?\d+)?$/ =~ str
         # field is a Float
@@ -216,7 +216,7 @@ class TaskJuggler
     def marshal(field)
       if field.nil?
         ''
-      elsif field.is_a?(Fixnum) || field.is_a?(Float) || field.is_a?(Bignum)
+      elsif field.is_a?(Integer) || field.is_a?(Float)
         # Numbers don't have to be quoted.
         field.to_s
       else

data/lib/taskjuggler/reports/ChartPlotter.rb

@@ -163,7 +163,7 @@ class TaskJuggler
 
               @yMinDate = cell if @yMinDate.nil? || cell < @yMinDate
               @yMaxDate = cell if @yMaxDate.nil? || cell > @yMaxDate
-            elsif cell.is_a?(Fixnum) || cell.is_a?(Float)
+            elsif cell.is_a?(Integer) || cell.is_a?(Float)
               if @dataType && @dataType != :number
                 error("Column #{colIdx} contains non-number (#{cell}). " +
                       "The columns will be ignored.")

data/lib/taskjuggler/reports/GanttChart.rb

@@ -35,7 +35,7 @@ class TaskJuggler
     include HTMLGraphics
 
     attr_reader :start, :end, :now, :weekStartsMonday, :header, :width,
-                :scale, :scales, :table
+                :scale, :scales, :table, :markdate
     attr_writer :viewWidth
 
     # Create the GanttChart object, but don't do much right now. We still need
@@ -43,13 +43,14 @@ class TaskJuggler
     # is the date that should be used as current date. _weekStartsMonday_ is
     # true if the weeks should start on Mondays instead of Sundays. _table_ is a
     # reference to the TableReport that the chart is part of.
-    def initialize(now, weekStartsMonday, columnDef, table = nil)
+    def initialize(now, weekStartsMonday, columnDef, table = nil, markdate = nil)
       # The start and end dates of the reported interval.
       @start = nil
       @end = nil
       @now = now
       @columnDef = columnDef
       @table = table
+      @markdate = markdate
 
       # This defines the possible horizontal scales that the Gantt chart can
       # have. The scales differ in their resolution and the amount of detail
@@ -256,6 +257,11 @@ class TaskJuggler
       # Also protect the current date line from other vertical lines.
       @router.addZone(@header.nowLineX - 1, 0, 3, @height - 1, false, true)
 
+      # Protect the date set in custom reference line from other vertical lines.
+      if @header.markdateLineX
+        @router.addZone(@header.markdateLineX - 1, 0, 3, @height - 1, false, true)
+      end
+
       # Generate the dependency arrows for all visible tasks.
       @tasks.each do |task, lines|
         generateDepLines(task, lines)

data/lib/taskjuggler/reports/GanttHeader.rb

@@ -21,7 +21,7 @@ class TaskJuggler
   # holds the small scale (e. g. week or day).
   class GanttHeader
 
-    attr_reader :gridLines, :nowLineX, :cellStartDates
+    attr_reader :gridLines, :nowLineX, :cellStartDates, :markdateLineX
     attr_accessor :height
 
     # Create a GanttHeader object and generate the scales for the header.
@@ -39,6 +39,10 @@ class TaskJuggler
       # X coordinate of the "now" line. nil if "now" is off-chart.
       @nowLineX = nil
 
+      # X coordinate of the custom "markdate" line with date specified by user.
+      # nil if "markdate" is off-chart.
+      @markdateLineX = nil
+
       # The x coordinates and width of the cells created by the small scale. The
       # values are stored as [ x, w ].
       @cellStartDates = []
@@ -103,6 +107,12 @@ class TaskJuggler
 
       nlx = @chart.dateToX(@chart.now)
       @nowLineX = nlx if nlx
+
+      if @chart.markdate
+        flx = @chart.dateToX(@chart.markdate)
+        @markdateLineX = flx if flx
+      end
+
     end
 
     # Generate the actual scale cells.

data/lib/taskjuggler/reports/GanttLine.rb

@@ -49,6 +49,7 @@ class TaskJuggler
       @y = y + chart.header.height + 1
       # The height of the line in screen pixels.
       @height = height
+
       # The index of the line in the chart. It starts with 0 and is
       # incremented for each line by one.
       @lineIndex = lineIndex
@@ -95,6 +96,11 @@ class TaskJuggler
         div << rectToHTML(@chart.header.nowLineX, 0, 1, @height, 'nowline')
       end
 
+      # Render the 'markdate' line
+      if @chart.header.markdateLineX
+        div << rectToHTML(@chart.header.markdateLineX, 0, 1, @height, 'markdateline')
+      end
+
       div
     end
 

data/lib/taskjuggler/reports/ICalReport.rb

@@ -96,7 +96,7 @@ class TaskJuggler
 
         # Generate an additional VEVENT entry for all leaf tasks that aren't
         # milestones.
-        if task.leaf? && !task['milestone', scenarioIdx]
+        if task.leaf? && !task['milestone', scenarioIdx] && @report.get('novevents') == [false]
           event = ICalendar::Event.new(
             @ical, "#{task['projectid', scenarioIdx]}-#{task.fullId}",
             task.name, task['start', scenarioIdx], task['end', scenarioIdx])

data/lib/taskjuggler/reports/Report.rb

@@ -297,7 +297,7 @@ EOT
         if @name == '.'
           $stdout.write(@content.to_tjp)
         else
-          fileName = absoluteFileName(@name)
+          fileName = @name
           fileName += a('definitions').include?('project') ? '.tjp' : '.tji'
           File.open(fileName, 'w') { |f| f.write(@content.to_tjp) }
         end

data/lib/taskjuggler/reports/ReportTableCell.rb

@@ -60,7 +60,7 @@ class TaskJuggler
       @alignment = :center
       # Horizontal padding between frame and cell content
       @padding = 3
-      # Whether or not to indent the cell. If not nil, it is a Fixnum
+      # Whether or not to indent the cell. If not nil, it is an Integer
       # indicating the indentation level.
       @indent = nil
       # The basename of the icon file

data/lib/taskjuggler/reports/TableReport.rb

@@ -32,6 +32,7 @@ class TaskJuggler
       'activetasks'       => [ 'Active Tasks',         true,   :right, true ],
       'annualleave'       => [ 'Annual Leave',         true,   :right, true ],
       'annualleavebalance'=> [ 'Annual Leave Balance', false,  :right, true ],
+      'annualleavelist'   => [ 'Annual Leave List',    false,  :left,  true ],
       'alert'             => [ 'Alert',                true,   :left,  false ],
       'alertmessages'     => [ 'Alert Messages',       false,  :left,  false ],
       'alertsummaries'    => [ 'Alert Summaries',      false,  :left,  false ],
@@ -79,7 +80,7 @@ class TaskJuggler
     @@propertiesByType = {
       # Type                     Indent  Align
       DateAttribute         => [ false,  :left ],
-      FixnumAttribute       => [ false,  :right ],
+      IntegerAttribute       => [ false,  :right ],
       FloatAttribute        => [ false,  :right ],
       ResourceListAttribute => [ false, :left ],
       RichTextAttribute     => [ false,  :left ],
@@ -338,9 +339,9 @@ class TaskJuggler
       when 'chart'
         # For the 'chart' column we generate a GanttChart object. The sizes are
         # set so that the lines of the Gantt chart line up with the lines of the
-        # table.
+        # table
         gantt = GanttChart.new(a('now'),
-                               a('weekStartsMonday'), columnDef, self)
+                               a('weekStartsMonday'), columnDef, self, a('markdate'))
 
         gantt.generateByScale(rStart, rEnd, columnDef.scale)
         # The header consists of 2 lines separated by a 1 pixel boundary.
@@ -867,12 +868,6 @@ class TaskJuggler
     # the next cell.
     def genCalChartTaskCell(query, 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)
-        resource = line.scopeLine.property
-      else
-        resource = nil
-      end
 
       # Get the interval of the task. In case a date is invalid due to a
       # scheduling problem, we use the full project interval.
@@ -1048,11 +1043,11 @@ class TaskJuggler
                             'busy'
                           elsif workLoad > 0.0 && freeLoad > 0.0
                             'loaded'
-                          elsif workLoad == 0.0 && freeLoad > 0.0
-                            'free'
-                          else
+                          elsif workLoad == 0.0 && freeLoad == 0.0
                             cell.tooltip = nil
                             'offduty'
+                          else
+                            'free'
                           end
                         end
         cell.category += line.subLineNo % 2 == 1 ? '1' : '2'