taskjuggler 0.1.1 → 0.2.0

data/lib/taskjuggler/reports/ICalReport.rb

@@ -0,0 +1,136 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = ICalReport.rb -- The TaskJuggler III Project Management Software
+#
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               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/reports/ReportBase'
+require 'taskjuggler/ICalendar'
+
+class TaskJuggler
+
+  # This Report derivative generates iCalendar files.
+  class ICalReport < ReportBase
+
+    # Create a new ICalReport with _report_ as description.
+    def initialize(report)
+      super
+    end
+
+    # Generate an intermediate version of the report data.
+    def generateIntermediateFormat
+      super
+      # Prepare the task list.
+      @taskList = PropertyList.new(@project.tasks)
+      @taskList.setSorting(a('sortTasks'))
+      @taskList = filterTaskList(@taskList, nil, a('hideTask'), a('rollupTask'),
+                                 a('openNodes'))
+      @taskList.sort!
+
+      # Prepare the resource list. This is not yet used.
+      @resourceList = PropertyList.new(@project.resources)
+      @resourceList.setSorting(a('sortResources'))
+      @resourceList = filterResourceList(@resourceList, nil, a('hideResource'),
+                                         a('rollupResource'), a('openNodes'))
+      @resourceList.sort!
+
+      @query = @report.project.reportContexts.last.query.dup
+
+      @ical = ICalendar.new("#{AppConfig.packageName}-#{@project['projectid']}")
+      # Use the project start date of the current date (whichever is earlier)
+      # for the calendar creation date.
+      @ical.creationDate = [ @report.project['start'], TjTime.new ].min
+      # Use the project 'now' date a last modification date.
+      @ical.lastModified = @report.project['now']
+
+      # We only care about the first requested scenario.
+      scenarioIdx = a('scenarios').first
+      uidMap = {}
+      @taskList.each do |task|
+        todo = ICalendar::Todo.new(
+          @ical, "#{task['projectid', scenarioIdx]}-#{task.fullId}",
+          task.name, task['start', scenarioIdx], task['end', scenarioIdx])
+        # Save the ical UID of this TODO.
+        uidMap[task] = todo.uid
+        @query.property = task
+        @query.attributeId = 'complete'
+        @query.scenarioIdx = scenarioIdx
+        @query.process
+        todo.percentComplete = @query.to_num.to_i
+        # We must convert the TJ priority range (1 - 1000) to iCalendar range
+        # (0 - 9).
+        todo.priority = (task['priority', scenarioIdx] - 1) / 100
+        # If there is a parent task and it's known already, we set the
+        # relation in the TODO component.
+        if task.parent && uidMap[task.parent]
+          todo.relatedTo = uidMap[task.parent]
+        end
+        # If we have a task note, use this for the DESCRIPTION property.
+        if (note = task.get('note'))
+          note = note.to_s
+          todo.description = note
+        end
+        # Check if we have a responsible resource with an email address. Since
+        # ICalendar only knows one organizer we ignore all but the first.
+        organizer = nil
+        unless (responsible = task['responsible', scenarioIdx]).empty? &&
+               @resourceList.include?(organizer = responsible[0]) &&
+               organizer.get('email')
+          todo.setOrganizer(responsible[0].name, responsible[0].get('email'))
+        end
+        # Set the assigned resources as attendees.
+        attendees = []
+        task['assignedresources', scenarioIdx].each do |resource|
+          next unless @resourceList.include?(resource) &&
+                      resource.get('email')
+          attendees << resource
+          todo.addAttendee(resource.name, resource.get('email'))
+        end
+
+        # Generate an additional VEVENT entry for all leaf tasks that aren't
+        # milestones.
+        if task.leaf? && !task['milestone', scenarioIdx]
+          event = ICalendar::Event.new(
+            @ical, "#{task['projectid', scenarioIdx]}-#{task.fullId}",
+            task.name, task['start', scenarioIdx], task['end', scenarioIdx])
+          event.description = note if note
+          event.setOrganizer(organizer.name, organizer.email) if organizer
+          attendees.each do |attendee|
+            event.addAttendee(attendee.name, attendee.get('email'))
+          end
+        end
+
+        # Generate VJOURNAL entries for all the journal entries of this task.
+        @report.project['journal'].
+          entriesByTask(task, a('start'), a('end'),
+                        a('hideJournalEntry')).each do |entry|
+          journal = ICalendar::Journal.new(
+            @ical, "#{task['projectid', scenarioIdx]}-#{task.fullId}",
+            entry.headline, entry.date)
+          journal.relatedTo = uidMap[task]
+          journal.description = entry.summary.to_s + entry.details.to_s
+          # Set the author of the journal entry as organizer.
+          if (author = entry.author) && @resourceList.include?(author) &&
+             author.get('email')
+            journal.setOrganizer(author.name, author.get('email'))
+          end
+        end
+      end
+    end
+
+    # Convert the intermediate format into a DOS formated String.
+    def to_iCal
+      @ical.to_s
+    end
+
+  end
+
+end
+

data/lib/taskjuggler/reports/NikuReport.rb

@@ -305,7 +305,7 @@ EOT
       query = Query.new(queryAttrs)
 
       # Calculate the number of working days in the report interval.
-      workingDays = @project.workingDays(Interval.new(a('start'), a('end')))
+      workingDays = @project.workingDays(TimeInterval.new(a('start'), a('end')))
 
       resourceList.each do |resource|
         # We only care about leaf resources that have the custom attribute

data/lib/taskjuggler/reports/Report.rb

@@ -17,10 +17,12 @@ require 'taskjuggler/PropertyTreeNode'
 require 'taskjuggler/reports/TextReport'
 require 'taskjuggler/reports/TaskListRE'
 require 'taskjuggler/reports/ResourceListRE'
+require 'taskjuggler/reports/TagFile'
 require 'taskjuggler/reports/TjpExportRE'
 require 'taskjuggler/reports/StatusSheetReport'
 require 'taskjuggler/reports/TimeSheetReport'
 require 'taskjuggler/reports/NikuReport'
+require 'taskjuggler/reports/ICalReport'
 require 'taskjuggler/reports/CSVFile'
 require 'taskjuggler/reports/Navigator'
 require 'taskjuggler/reports/ReportContext'
@@ -28,6 +30,10 @@ require 'taskjuggler/HTMLDocument'
 
 class TaskJuggler
 
+  # Just a dummy class to make the 'flags' attribute work.
+  class ReportScenario < ScenarioData
+  end
+
   # The Report class holds the fundamental description and functionality to
   # turn the scheduled project into a user readable form. A report may contain
   # other reports.
@@ -43,6 +49,13 @@ class TaskJuggler
       # The type specifier must be set for every report. It tells whether this
       # is a task, resource, text or other report.
       @typeSpec = nil
+      # Reports don't really have any scenario specific attributes. But the
+      # flag handling code assumes they are. To use flags, we need them as
+      # well.
+      @data = Array.new(@project.scenarioCount, nil)
+      @project.scenarioCount.times do |i|
+        ReportScenario.new(self, i, @scenarioAttributes[i])
+      end
     end
 
     # The generate function is where the action happens in this class. The
@@ -65,11 +78,15 @@ class TaskJuggler
         end
 
         case format
+        when :iCal
+          generateICal
         when :html
           generateHTML
           copyAuxiliaryFiles
         when :csv
           generateCSV
+        when :ctags
+          generateCTags
         when :niku
           generateNiku
         when :tjp
@@ -90,10 +107,14 @@ class TaskJuggler
       case @typeSpec
       when :export
         @content = TjpExportRE.new(self)
+      when :iCal
+        @content = ICalReport.new(self)
       when :niku
         @content = NikuReport.new(self)
       when :resourcereport
         @content = ResourceListRE.new(self)
+      when :tagfile
+        @content = TagFile.new(self)
       when :textreport
         @content = TextReport.new(self)
       when :taskreport
@@ -293,6 +314,44 @@ EOT
       end
     end
 
+    # Generate Niku report
+    def generateICal
+      unless @content.respond_to?('to_iCal')
+        warning('ical_not_supported',
+                "iCalendar format is not supported for report #{@id} of " +
+                "type #{@typeSpec}.")
+        return nil
+      end
+
+      begin
+        f = @name == '.' ? $stdout :
+          File.new(((@name[0] == '/' ? '' : @project.outputDir) +
+                    @name + '.ical').untaint, 'w')
+        f.puts "#{@content.to_iCal}"
+      rescue IOError
+        error('write_ical', "Cannot write to file #{@name}.\n#{$!}")
+      end
+    end
+
+    # Generate ctags file
+    def generateCTags
+      unless @content.respond_to?('to_ctags')
+        warning('ctags_not_supported',
+                "ctags format is not supported for report #{@id} of " +
+                "type #{@typeSpec}.")
+        return nil
+      end
+
+      begin
+        f = @name == '.' ? $stdout :
+          File.new(((@name[0] == '/' ? '' : @project.outputDir) +
+                    @name).untaint, 'w')
+        f.puts "#{@content.to_ctags}"
+      rescue IOError
+        error('write_ctags', "Cannot write to file #{@name}.\n#{$!}")
+      end
+    end
+
     def copyAuxiliaryFiles
       # Don't copy files if output is stdout.
       return if @name == '.' || a('interactive')

data/lib/taskjuggler/reports/ReportBase.rb

@@ -64,7 +64,7 @@ class TaskJuggler
         list.delete_if do |task|
           delete = true
           a('scenarios').each do |scenarioIdx|
-            iv = Interval.new(a('start'), a('end'))
+            iv = TimeInterval.new(a('start'), a('end'))
             if task.hasResourceAllocated?(scenarioIdx, iv, resource)
               delete = false
               break;
@@ -92,7 +92,7 @@ class TaskJuggler
       if task
         # If we have a task we need to check that the resources are assigned
         # to the task in any of the reported scenarios.
-        iv = Interval.new(a('start'), a('end'))
+        iv = TimeInterval.new(a('start'), a('end'))
         list.delete_if do |resource|
           delete = true
           a('scenarios').each do |scenarioIdx|
@@ -194,71 +194,6 @@ class TaskJuggler
       list
     end
 
-    # This function converts number to strings that may include a unit. The
-    # unit is determined by @loadUnit. In the automatic modes, the shortest
-    # possible result is shown and the unit is always appended. _value_ is the
-    # value to convert. _factors_ determines the conversion factors for the
-    # different units.
-    # TODO: Delete when all users have been migrated to use Query!
-    def scaleValue(value, factors)
-      loadUnit = a('loadUnit')
-      numberFormat = a('numberFormat')
-
-      if loadUnit == :shortauto || loadUnit == :longauto
-        # We try all possible units and store the resulting strings here.
-        options = []
-        # For each of the units we can define a maximum value that the value
-        # should not exceed. A maximum of 0 means no limit.
-        max = [ 60, 48, 0, 8, 24, 0 ]
-
-        i = 0
-        shortest = nil
-        factors.each do |factor|
-          scaledValue = value * factor
-          str = numberFormat.format(scaledValue)
-          # We ignore results that are 0 or exceed the maximum. To ensure that
-          # we have at least one result the unscaled value is always taken.
-          if (factor != 1.0 && scaledValue == 0) ||
-             (max[i] != 0 && scaledValue > max[i])
-            options << nil
-          else
-            options << str
-          end
-          i += 1
-        end
-
-        # Default to days in case they are all the same.
-        shortest = 2
-        # Find the shortest option.
-        6.times do |j|
-          shortest = j if options[j] &&
-                          options[j].length < options[shortest].length
-        end
-
-        str = options[shortest]
-        if loadUnit == :longauto
-          # For the long units we handle singular and plural properly. For
-          # English we just need to append an 's', but this code will work for
-          # other languages as well.
-          units = []
-          if str == "1"
-            units = %w( minute hour day week month year )
-          else
-            units = %w( minutes hours days weeks months years )
-          end
-          str += ' ' + units[shortest]
-        else
-          str += %w( min h d w m y )[shortest]
-        end
-      else
-        # For fixed units we just need to do the conversion. No unit is
-        # included.
-        units = [ :minutes, :hours, :days, :weeks, :months, :years ]
-        str = numberFormat.format(value * factors[units.index(loadUnit)])
-      end
-      str
-    end
-
   end
 
 end

data/lib/taskjuggler/reports/TableReport.rb

@@ -488,7 +488,7 @@ class TaskJuggler
                            t.send(name1Func) == currentInterval)
           # call TjTime::sameTimeNext... function to get the end of the column.
           nextT = t.send(sameTimeNextFunc)
-          iv = Interval.new(t, nextT)
+          iv = TimeInterval.new(t, nextT)
           # Create the new column object.
           column = ReportTableColumn.new(table, nil, '')
           # Store the date of the column in the original form.
@@ -505,7 +505,7 @@ class TaskJuggler
           # TODO: The width should be taken from some data structure.
           column.cell2.width = 20
           # Off-duty cells will have a different color than working time cells.
-          unless @project.isWorkingTime(iv)
+          unless @project.hasWorkingTime(iv)
             column.cell2.category = 'tabhead_offduty'
           end
           cellsInInterval += 1
@@ -736,8 +736,8 @@ class TaskJuggler
       # scheduling problem, we use the full project interval.
       taskStart = task['start', origQuery.scenarioIdx]
       taskEnd = task['end', origQuery.scenarioIdx]
-      taskIv = Interval.new(taskStart.nil? ?  @project['start'] : taskStart,
-                            taskEnd.nil? ?  @project['end'] : taskEnd)
+      taskIv = TimeInterval.new(taskStart.nil? ?  @project['start'] : taskStart,
+                                taskEnd.nil? ?  @project['end'] : taskEnd)
 
       firstCell = nil
       while t < @end
@@ -747,7 +747,7 @@ class TaskJuggler
         query = origQuery.dup
         # call TjTime::sameTimeNext... function
         nextT = t.send(sameTimeNextFunc)
-        cellIv = Interval.new(t, nextT)
+        cellIv = TimeInterval.new(t, nextT)
         case columnDef.content
         when 'empty'
           # Create a new cell
@@ -814,8 +814,9 @@ class TaskJuggler
         # scheduling problem, we use the full project interval.
         taskStart = task['start', origQuery.scenarioIdx]
         taskEnd = task['end', origQuery.scenarioIdx]
-        taskIv = Interval.new(taskStart.nil? ?  @project['start'] : taskStart,
-                              taskEnd.nil? ?  @project['end'] : taskEnd)
+        taskIv = TimeInterval.new(taskStart.nil? ? @project['start'] :
+                                                   taskStart,
+                                  taskEnd.nil? ?  @project['end'] : taskEnd)
       else
         task = nil
       end
@@ -832,7 +833,7 @@ class TaskJuggler
 
         # call TjTime::sameTimeNext... function
         nextT = t.send(sameTimeNextFunc)
-        cellIv = Interval.new(t, nextT)
+        cellIv = TimeInterval.new(t, nextT)
         # Get work load for all tasks.
         query.scopeProperty = nil
         query.attributeId = 'effort'

data/lib/taskjuggler/reports/TagFile.rb

@@ -0,0 +1,120 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = ProjectFileParser.rb -- The TaskJuggler III Project Management Software
+#
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               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/reports/ReportBase.rb'
+require 'taskjuggler/Tj3Config'
+
+class TaskJuggler
+
+  # This class specializes ReportBase to generate tag files used by editors
+  # such as vim.
+  class TagFile < ReportBase
+
+    # The TagFileEntry class is used to store the intermediate representation
+    # of the TagFile.
+    class TagFileEntry
+
+      attr_reader :tag, :file, :line, :kind
+
+      # Create a new TagFileEntry object. _tag_ is the property ID. _file_ is
+      # the source file name, _line_ the line number in this file. _kind_
+      # specifies the property type. The following types should be used:
+      # r : Resource
+      # t : Task
+      # p : Report
+      def initialize(tag, file, line, kind)
+        @tag = tag
+        @file = file
+        @line = line
+        @kind = kind
+      end
+
+      # Used to sort the tag file entries by tag.
+      def <=>(e)
+        @tag <=> e.tag
+      end
+
+      # Convert the entry into a ctags compatible line.
+      def to_ctags
+        "#{@tag}\t#{@file}\t#{@line};\"\t#{@kind}\n"
+      end
+
+    end
+
+    def initialize(report)
+      super
+    end
+
+    def generateIntermediateFormat
+      super
+
+      @tags = []
+
+      # Add the resources.
+      @resourceList = PropertyList.new(@project.resources)
+      @resourceList.setSorting(a('sortResources'))
+      @resourceList = filterResourceList(@resourceList, nil, a('hideResource'),
+                                         a('rollupResource'), a('openNodes'))
+      @resourceList.each do |resource|
+        next unless resource.sourceFileInfo
+        @tags << TagFileEntry.new(resource.fullId,
+                                  resource.sourceFileInfo.fileName,
+                                  resource.sourceFileInfo.lineNo, 'r')
+      end
+
+      # Add the tasks.
+      @taskList = PropertyList.new(@project.tasks)
+      @taskList.setSorting(a('sortTasks'))
+      @taskList = filterTaskList(@taskList, nil, a('hideTask'), a('rollupTask'),
+                                 a('openNodes'))
+      @taskList.each do |task|
+        next unless task.sourceFileInfo
+        @tags << TagFileEntry.new(task.fullId,
+                                  task.sourceFileInfo.fileName,
+                                  task.sourceFileInfo.lineNo, 't')
+      end
+
+      # Add the reports.
+      @project.reports.each do |report|
+        next unless report.sourceFileInfo
+        @tags << TagFileEntry.new(report.fullId,
+                                  report.sourceFileInfo.fileName,
+                                  report.sourceFileInfo.lineNo, 'p')
+      end
+    end
+
+    # Returns a String that contains the content of the ctags file.
+    # See http://vimdoc.sourceforge.net/htmldoc/tagsrch.html for the spec.
+    def to_ctags
+      # The ctags header. Not used if this is really needed.
+      s = <<"EOT"
+!_TAG_FILE_FORMAT	2	/extended format; --format=1 will not append ;" to lines/
+!_TAG_FILE_SORTED	1	/0=unsorted, 1=sorted, 2=foldcase/
+!_TAG_PROGRAM_AUTHOR	#{AppConfig.authors.join(';')}	//
+!_TAG_PROGRAM_NAME	#{AppConfig.softwareName}	//
+!_TAG_PROGRAM_URL	#{AppConfig.contact}	/official site/
+!_TAG_PROGRAM_VERSION	#{AppConfig.version}	//
+EOT
+
+      # Turn the list of Tags into ctags lines.
+      @tags.sort.each do |tag|
+        s << tag.to_ctags
+      end
+
+      s
+    end
+
+  end
+
+end
+

data/lib/taskjuggler/reports/TimeSheetReport.rb

@@ -241,9 +241,9 @@ EOT
 
         assignedTaskList.each do |task|
           # Time sheet task records only make sense for leaf tasks.
-          reportIv = Interval.new(from, to)
-          taskIv = Interval.new(task['start', scenarioIdx],
-                                task['end', scenarioIdx])
+          reportIv = TimeInterval.new(from, to)
+          taskIv = TimeInterval.new(task['start', scenarioIdx],
+                                    task['end', scenarioIdx])
           next if !task.leaf? || !reportIv.overlaps?(taskIv)
 
           queryAttrs['property'] = task

data/lib/taskjuggler/reports/TjpExportRE.rb

@@ -26,7 +26,7 @@ class TaskJuggler
       @supportedTaskAttrs = %w( booking complete depends flags maxend
                                 maxstart minend minstart note priority
                                 projectid responsible )
-      @supportedResourceAttrs = %w( flags vacation workinghours )
+      @supportedResourceAttrs = %w( booking flags vacation workinghours )
     end
 
     def generateIntermediateFormat
@@ -193,7 +193,7 @@ class TaskJuggler
     def generateTask(task, indent)
       Log.activity if task.sequenceNo % 100 == 0
 
-      @file << ' ' * indent + "task #{task.id} " +
+      @file << ' ' * indent + "task #{task.subId} " +
                "#{quotedString(task.name)} {\n"
 
       if a('taskAttributes').include?('depends')
@@ -274,7 +274,6 @@ class TaskJuggler
     def generateResourceAttributes
       @resourceList.each do |resource|
         Log.activity if resource.sequenceNo % 100 == 0
-
         @file << "supplement resource #{resource.fullId} {\n"
         @project.resources.eachAttributeDefinition do |attrDef|
           id = attrDef.id
@@ -285,6 +284,7 @@ class TaskJuggler
           if attrDef.scenarioSpecific
             a('scenarios').each do |scenarioIdx|
               next if inheritable?(resource, id, scenarioIdx)
+
               generateAttribute(resource, id, 2, scenarioIdx)
             end
           else
@@ -292,6 +292,15 @@ class TaskJuggler
           end
         end
 
+        # Since 'booking' is a task attribute, we need a special handling if
+        # we want to list them in the resource context.
+        if a('resourceAttributes').include?('booking') &&
+           a('resourceAttributes')[0] != '*'
+          a('scenarios').each do |scenarioIdx|
+            generateBookingsByResource(resource, 2, scenarioIdx)
+          end
+        end
+
         @file << "}\n"
       end
     end
@@ -326,7 +335,7 @@ class TaskJuggler
               when 'depends'
                 next     # already taken care of
               when 'booking'
-                generateBooking(task, 2, scenarioIdx)
+                generateBookingsByTask(task, 2, scenarioIdx)
               else
                 generateAttribute(task, id, 2, scenarioIdx)
               end
@@ -363,13 +372,14 @@ class TaskJuggler
     # report.
     def getBookings
       @bookings = {}
-      if a('taskAttributes').include?('booking')
+      if a('taskAttributes').include?('booking') ||
+         a('resourceAttributes').include?('booking')
         a('scenarios').each do |scenarioIdx|
           @bookings[scenarioIdx] = {}
           @resourceList.each do |resource|
             # Get the bookings for this resource hashed by task.
-            bookings = resource.getBookings(scenarioIdx,
-                                            Interval.new(a('start'), a('end')))
+            bookings = resource.getBookings(
+              scenarioIdx, TimeInterval.new(a('start'), a('end')))
             next if bookings.nil?
 
             # Now convert/add them to a tripple-stage hash by scenarioIdx, task
@@ -387,7 +397,7 @@ class TaskJuggler
       end
     end
 
-    def generateBooking(task, indent, scenarioIdx)
+    def generateBookingsByTask(task, indent, scenarioIdx)
       return unless @bookings[scenarioIdx].include?(task)
 
       # Convert Hash into an [ Resource, Booking ] Array sorted by Resource
@@ -397,10 +407,24 @@ class TaskJuggler
       end
 
       resourceBookings.each do |resourceId, booking|
-        generateAttributeText('booking ' + booking.to_tjp, indent, scenarioIdx)
+        generateAttributeText('booking ' + booking.to_tjp(false), indent,
+                              scenarioIdx)
       end
     end
 
+    def generateBookingsByResource(resource, indent, scenarioIdx)
+      # Get the bookings for this resource hashed by task.
+      bookings = resource.getBookings(scenarioIdx,
+                                      TimeInterval.new(a('start'), a('end')),
+                                      false)
+      bookings.each do |booking|
+        next unless @taskList.include?(booking.task)
+        generateAttributeText('booking ' + booking.to_tjp(true), indent,
+                              scenarioIdx)
+      end
+    end
+
+
     # 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