taskjuggler 0.0.4 → 0.0.5

data/examples/tutorial.tjp

@@ -286,6 +286,25 @@ navigator navbar {
   hidereport 0
 }
 
+macro TaskTip [
+  tooltip istask() -8<-
+    '''Start: ''' <-query attribute='start'->
+    '''End: ''' <-query attribute='end'->
+    ----
+    '''Resources:'''
+    
+    <-query attribute='resources'->
+    ----
+    '''Precursors: '''
+    
+    <-query attribute='precursors'->
+    ----
+    '''Followers: '''
+    
+    <-query attribute='followers'->
+    ->8-
+]
+
 textreport "" {
   header -8<-
     == Accounting Software Project ==
@@ -348,9 +367,8 @@ taskreport overview "" {
     === Original Project Plan ===
   ->8-
   columns hierarchindex,
-          name { tooltip 1 "'''ID''': <-query attribute='id'->" },
-          start, end, effort, duration, cost,
-          revenue, chart
+          name, start, end, effort, duration, cost,
+          revenue, chart { ${TaskTip} }
   # For this report we like to have the abbreviated weekday in front
   # of the date. %a is the tag for this.
   timeformat "%a %Y-%m-%d"
@@ -415,7 +433,7 @@ taskreport development "" {
   scenarios delayed
   headline "Development - Resource Allocation Report"
   columns hierarchindex, name, start, end, effort { title "Work" },
-          duration, chart { scale day width 500 }
+          duration, chart { ${TaskTip} scale day width 500 }
   timeformat "%Y-%m-%d"
   hideresource ~(isleaf() & isleaf_())
   sortresources name.up
@@ -424,7 +442,8 @@ taskreport development "" {
 # A list of all tasks with the percentage completed for each task
 taskreport deliveries "" {
   headline "Project Deliverables"
-  columns hierarchindex, name, start, end, note { width 150 }, complete, chart
+  columns hierarchindex, name, start, end, note { width 150 }, complete,
+          chart { ${TaskTip} } 
   taskroot AcSo.deliveries
   hideresource 1
   scenarios plan, delayed
@@ -447,7 +466,7 @@ resourcereport contactList "" {
 resourcereport resourceGraph "" {
   scenarios delayed
   headline "Resource Allocation Graph"
-  columns no, name, effort, rate, weekly
+  columns no, name, effort, rate, weekly { ${TaskTip} }
   loadunit shortauto
   # We only like to show leaf tasks for leaf resources.
   hidetask ~(isleaf() & isleaf_())

data/lib/Attributes.rb

@@ -194,9 +194,9 @@ class TaskJuggler
       super
     end
 
-    def to_s(query)
+    def to_s(query = nil)
       if @value
-        @value.to_s(query.timeFormat)
+        @value.to_s(query ? query.timeFormat : '%Y-%m-%d')
       else
         'Error'
       end
@@ -251,6 +251,10 @@ class TaskJuggler
       @type.id + ' ' + @value.to_s + 'h'
     end
 
+    def to_s(query)
+      query ? query.scaleDuration(query.project.slotsToDays(@value)) : @value
+    end
+
   end
 
   class FixnumAttribute < AttributeBase

data/lib/HTMLDocument.rb

@@ -22,10 +22,10 @@ class TaskJuggler
     # When creating a HTMLDocument the caller can specify the type of HTML that
     # will be used. The constructor then generates the proper XML declaration
     # for it. :strict, :transitional and :frameset are supported for _docType_.
-    def initialize(docType = :transitional)
+    def initialize(docType = :strict)
       super()
 
-      @elements << XMLBlob.new('<?xml version="1.0" encoding="utf-8"?>')
+      @elements << XMLBlob.new('<?xml version="1.0" encoding="UTF-8"?>')
       case docType
       when :strict
         dtdRef = 'Strict'
@@ -53,6 +53,22 @@ class TaskJuggler
       @html << element
     end
 
+    # Generate the 'head' section of an HTML page.
+    def generateHead(title, metaTags = {})
+      self << (head = XMLElement.new('head'))
+      head << XMLNamedText.new(title, 'title')
+      head << XMLElement.new('meta', { 'http-equiv' => 'Content-Type',
+                                       'content' => 'text/html; charset=utf-8' },
+                             true)
+
+      # Include optional meta tags.
+      metaTags.each do |name, content|
+        head << XMLElement.new('meta', { 'name' => name, 'content' => content },
+                               true)
+      end
+      head
+    end
+
   end
 
 end

data/lib/Journal.rb

@@ -21,7 +21,7 @@ class TaskJuggler
   class JournalEntry
 
     attr_reader :date, :headline, :property, :sourceFileInfo
-    attr_accessor :author, :summary, :details, :alertLevel
+    attr_accessor :author, :summary, :details, :alertLevel, :timeSheetRecord
 
     # Create a new JournalEntry object.
     def initialize(journal, date, headline, property, sourceFileInfo = nil)
@@ -44,6 +44,9 @@ class TaskJuggler
       @details = nil
       # The alert level.
       @alertLevel = 0
+      # A reference to a time sheet record that was used to create this
+      # JournalEntry object.
+      @timeSheetRecord = nil
 
       # Add the new entry to the journal.
       @journal.addEntry(self)
@@ -169,6 +172,46 @@ class TaskJuggler
       @propertyToEntries[entry.property] << entry
     end
 
+    # Return a list of all JournalEntry objects for the given _resource_ that
+    # are dated between _startDate_ and _endDate_, are for Task _task_ and
+    # have at least the alert level _alertLevel. If an optional parameter is
+    # nil, it always matches the entry.
+    def entriesByResource(resource, startDate = nil, endDate = nil,
+                          task = nil, alertLevel = nil)
+      list = []
+      @entries.each do |entry|
+        if entry.author == resource &&
+           (startDate.nil? || entry.date > startDate) &&
+           (endDate.nil? || entry.date <= endDate) &&
+           (task.nil? || entry.property == task) &&
+           (alertLevel.nil? || entry.alertLevel >= alertLevel) &&
+           !entry.headline.empty?
+          list << entry
+        end
+      end
+      list
+    end
+
+    # Return a list of all JournalEntry objects for the given _task_ that
+    # are dated between _startDate_ and _endDate_, are from Author _resource_
+    # and have at least the alert level _alertLevel. If an optional parameter
+    # is nil, it always matches the entry.
+    def entriesByTask(task, startDate = nil, endDate = nil,
+                      resource = nil, alertLevel = nil)
+      list = []
+      @entries.each do |entry|
+        if entry.property == task &&
+           (startDate.nil? || entry.date > startDate) &&
+           (endDate.nil? || entry.date <= endDate) &&
+           (resource.nil? || entry.author == resource) &&
+           (alertLevel.nil? || entry.alertLevel >= alertLevel) &&
+           !entry.headline.empty?
+          list << entry
+        end
+      end
+      list
+    end
+
     def entries(startDate = nil, endDate = nil, property = nil,
                 alertLevel = nil)
       list = []
@@ -176,7 +219,7 @@ class TaskJuggler
         if (startDate.nil? || startDate <= entry.date) &&
            (endDate.nil? || endDate >= entry.date) &&
            (property.nil? || property == entry.property ||
-                             entry.property.isChildOf?(property)) ||
+                             entry.property.isChildOf?(property)) &&
            (alertLevel.nil? || alertLevel == entry.alertLevel)
           list << entry
         end
@@ -201,14 +244,14 @@ class TaskJuggler
     # This function returns a list of entries that have all the exact same
     # date and are the last entries before the deadline _date_. Only messages
     # with at least the required alert level _minLevel_ are returned. Messages
-    # with alert level _minLevel_ must not be older than _minDate_.
+    # with alert level _minLevel_ must not be newer than _minDate_.
     def currentEntries(date, property, minLevel, minDate)
       pEntries = @propertyToEntries[property] ?
                  @propertyToEntries[property].last(date) : []
       # Remove entries below the minium alert level or before the timeout
       # date.
       pEntries.delete_if { |e| e.alertLevel < minLevel  || e.headline.empty? ||
-                               (e.alertLevel == minLevel && e.date < minDate) }
+                               (e.alertLevel == minLevel && e.date <= minDate) }
 
       return [] if pEntries.empty?
 

data/lib/KeywordArray.rb

@@ -17,7 +17,7 @@ class TaskJuggler
     alias a_include? include?
 
     def include?(keyword)
-      self[0] == '*' || a_include?(keyword)
+      (self[0] == '*') || a_include?(keyword)
     end
 
   end

data/lib/KeywordDocumentation.rb

@@ -13,6 +13,7 @@
 require 'HTMLDocument'
 require 'RichText'
 require 'TjpExample'
+require 'TextFormatter'
 require 'Project'
 
 class TaskJuggler
@@ -149,7 +150,7 @@ class TaskJuggler
     # string.
     def to_s
       tagW = 13
-      textW = 79 - tagW
+      textW = 79
 
       # Top line with multiple elements
       str = "Keyword:     #{@keyword}     " +
@@ -172,17 +173,17 @@ class TaskJuggler
             if arg.typeSpec.nil? || ('<' + arg.name + '>') == arg.typeSpec
               indent = arg.name.length + 2
               argStr += "#{arg.name}: " +
-                      "#{format(indent, argText, textW - indent)}\n"
+                      "#{format(indent, argText, textW - tagW)}\n"
             else
               typeSpec = arg.typeSpec
               typeSpec[0] = '['
               typeSpec[-1] = ']'
               indent = arg.name.length + typeSpec.size + 3
               argStr += "#{arg.name} #{typeSpec}: " +
-                      "#{format(indent, argText, textW - indent)}\n"
+                      "#{format(indent, argText, textW - tagW)}\n"
             end
           end
-          str += format(tagW, argStr, textW)
+          str += indent(tagW, argStr)
         end
         str += "\n"
       end
@@ -266,10 +267,12 @@ class TaskJuggler
     # Return a String that represents the keyword documentation in an XML
     # formatted form.
     def generateHTML(directory)
-      html = HTMLDocument.new(:transitional)
-      html << (head = XMLElement.new('head'))
-      head << XMLNamedText.new("#{keyword}", 'title') <<
-        @manual.generateStyleSheet
+      html = HTMLDocument.new(:strict)
+      head = html.generateHead(keyword,
+                               { 'description' => 'The TaskJuggler Manual',
+                                 'keywords' =>
+                                 'taskjuggler, project, management' })
+      head << @manual.generateStyleSheet
 
       html << (body = XMLElement.new('body'))
       body << @manual.generateHTMLHeader <<
@@ -472,75 +475,8 @@ class TaskJuggler
       true
     end
 
-    # Utility function that is used to format the str String as a block of the
-    # specified _width_. The left side is indented with _indent_ white spaces.
-    def format(indent, str, width)
-      # The result goes here.
-      out = ''
-      # Position in the currently generated line.
-      linePos = 0
-      # The currently processed word.
-      word = ''
-      # True if this is the first word in a line.
-      firstWord = true
-      # Currently processed position in the input String _str_.
-      i = 0
-      indentBuf = ''
-      while i < str.length
-        # If the current line has reached or exceeded the _width_ we generate
-        # a new line prefixed with the proper indentation.
-        if linePos >= width
-          out += "\n" + ' ' * indent
-          linePos = 0
-          firstWord = true
-          unless word.empty?
-            # Resume the input processing at the beginning of the word that
-            # did not fit into the old line anymore.
-            i -= word.length - 1
-            word = ''
-            next
-          end
-        end
-
-        if str[i] == ?\n
-          # If the input contains line breaks we generate line breaks as well.
-          # Insert the just finished word and wrap the line. We only put the
-          # indentation in a buffer as we don't know if more words will be
-          # following. We don't want to generate an indentation after the last
-          # line break.
-          out += indentBuf + word + "\n"
-          indentBuf = ' ' * indent
-          word = ''
-          linePos = 0
-          firstWord = true
-        elsif str[i] == ?\s
-          # We have finished processing a word of the input string.
-          unless indentBuf.empty?
-            # In case we have a pending indentation we now know that we can
-            # safely insert it. There will be more words following.
-            out += indentBuf
-            indentBuf = ''
-          end
-          # Append the word and initialize the word buffer with an single space.
-          out += word
-          firstWord = false
-          word = ' '
-          linePos += 1
-        else
-          # Just append the character to the word buffer and advance the
-          # position counter. We ignore spaces in front of the first word of
-          # each generated line.
-          unless str[i] == ' ' && firstWord
-            word << str[i]
-          end
-          linePos += 1
-        end
-        i += 1
-      end
-      unless word.empty? || indentBuf.empty?
-        out += indentBuf
-      end
-      out += word
+    def indent(width, str)
+      TextFormatter.new(0, width).indent(str)[width..-1]
     end
 
     # Generate the navigation bar.
@@ -593,6 +529,10 @@ class TaskJuggler
       td
     end
 
+    def format(indent, str, width)
+      TextFormatter.new(width, indent).format(str)[indent..-1]
+    end
+
   end
 
 end

data/lib/Log.rb

@@ -11,6 +11,7 @@
 #
 
 require 'singleton'
+require 'monitor'
 
 class TaskJuggler
 
@@ -18,7 +19,7 @@ class TaskJuggler
   # trace messages are filtered based on their segment name and the nesting
   # level of the segments. The class is a Singleton, so there is only one
   # instance in the program.
-  class Log
+  class Log < Monitor
 
     include Singleton
 
@@ -27,6 +28,7 @@ class TaskJuggler
     @@segments = []
     @@silent = true
     @@progress = 0
+    @@progressMeter = ''
 
     # Set the maximum nesting level that should be shown. Segments with a
     # nesting level greater than _l_ will be silently dropped.

data/lib/LogFile.rb

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = LogFile.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 'singleton'
+
+class TaskJuggler
+
+  class LogFile
+
+    attr_accessor :logFile, :appName, :outputLevel, :logLevel
+
+    include Singleton
+
+    def initialize
+      @logFile = 'logfile'
+      @appName = 'undefined'
+      @logLevel = 3
+      @outputLevel = 3
+    end
+
+    def debug(message)
+      $stdout.puts message if @outputLevel >= 4
+      log('DEBUG', message) if @logLevel >= 4
+    end
+
+    def info(message)
+      $stdout.puts message if @outputLevel >= 3
+      log('INFO', message) if @logLevel >= 3
+    end
+
+    def warning(message)
+      $stdout.puts message if @outputLevel >= 2
+      log('WARN', message) if @logLevel >= 2
+    end
+
+    def error(message)
+      $stderr.puts message if @outputLevel >= 1
+      log("ERROR", message) if @logLevel >= 1
+    end
+
+    def fatal(message)
+      $stderr.puts message if @outputLevel >= 0
+      log("FATAL", message) if @logLevel >= 0
+      exit 1
+    end
+
+    def log(type, message)
+      timeStamp = Time.new.strftime("%Y-%m-%d %H:%M:%S")
+      begin
+        @logFile.untaint
+        File.open(@logFile, 'a') do |f|
+          f.write("#{timeStamp} #{type} #{@appName}[#{Process.pid}]: " +
+                  "#{message}\n")
+        end
+      rescue
+        $stderr.puts "Cannot write to log file #{@logFile}: #{$!}"
+      end
+    end
+
+  end
+
+end
+

data/lib/LogicalExpression.rb

@@ -33,12 +33,6 @@ class TaskJuggler
       @query = nil
     end
 
-    # Switch the scopeProperty to property. We need this for the scopeProperty
-    # operating functions. The @scopeProperty is set to nil.
-    def flipProperties
-      @query.property, @query.scopeProperty = @query.scopeProperty, nil
-    end
-
     # This function triggers the evaluation of the expression. _property_ is the
     # PropertyTreeNode that should be used for the evaluation. _scopeProperty_
     # is the PropertyTreeNode that describes the scope. It may be nil.
@@ -51,12 +45,13 @@ class TaskJuggler
       return res != 0
     end
 
-    # This function is only used for debugging.
-    def to_s # :nodoc:
+    # Dump the LogicalExpression as a String. If _query_ is provided, it will
+    # show the actual values, otherwise just the variable names.
+    def to_s(query = nil)
       if @sourceFileInfo.nil?
-        "#{@operation}"
+        "#{@operation.to_s(query)}"
       else
-        str = "#{@sourceFileInfo} #{@operation}"
+        str = "#{@sourceFileInfo} #{@operation.to_s(query)}"
       end
     end
 

data/lib/LogicalFunction.rb

@@ -37,6 +37,9 @@ class TaskJuggler
     # Create a new LogicalFunction. _opnd_ is the name of the function.
     def initialize(opnd)
       if opnd[-1] == ?_
+        # Function names with a trailing _ are like their counterparts without
+        # the _. But during evaluation the property and the scope properties
+        # will be switched.
         @name = opnd[0..-2]
         @invertProperties = true
       else
@@ -66,11 +69,6 @@ class TaskJuggler
     # Evaluate the function by calling it with the arguments.
     def eval(expr)
       args = []
-      if @invertProperties
-        return true unless expr.query.scopeProperty
-        expr = expr.dup
-        expr.flipProperties
-      end
       # Call the function and return the result.
       send(name, expr, @arguments)
     end
@@ -82,9 +80,19 @@ class TaskJuggler
 
   private
 
+    # Return the property and scope property as determined by the
+    # @invertProperties setting.
+    def properties(expr)
+      if @invertProperties
+        return expr.query.scopeProperty, nil
+      else
+        return expr.query.property, expr.query.scopeProperty
+      end
+    end
+
     def hasalert(expr, args)
+      property, scopeProperty = properties(expr)
       query = expr.query
-      property = query.property
       project = property.project
       date = project.reportContext.report.get('end')
       !project['journal'].currentEntries(query.end, property,
@@ -92,10 +100,10 @@ class TaskJuggler
     end
 
     def isactive(expr, args)
+      property, scopeProperty = properties(expr)
       # The result can only be true when called for a Task property.
-      return false unless (property = expr.query.property).is_a?(Task) ||
-                           property.is_a?(Resource)
-      scopeProperty = expr.query.scopeProperty
+      return false unless property.is_a?(Task) ||
+                          property.is_a?(Resource)
       project = property.project
       # 1st arg must be a scenario index.
       if (scenarioIdx = project.scenarioIdx(args[0])).nil?
@@ -109,9 +117,10 @@ class TaskJuggler
     end
 
     def isdependencyof(expr, args)
+      property, scopeProperty = properties(expr)
       # The result can only be true when called for a Task property.
-      return false unless expr.query.property.is_a?(Task)
-      project = expr.query.property.project
+      return false unless property.is_a?(Task)
+      project = property.project
       # 1st arg must be a task ID.
       return false if (task = project.task(args[0])).nil?
       # 2nd arg must be a scenario index.
@@ -119,12 +128,13 @@ class TaskJuggler
       # 3rd arg must be an integer number.
       return false unless args[2].is_a?(Fixnum)
 
-      expr.query.property.isDependencyOf(scenarioIdx, task, args[2])
+      property.isDependencyOf(scenarioIdx, task, args[2])
     end
 
     def isdutyof(expr, args)
+      property, scopeProperty = properties(expr)
       # The result can only be true when called for a Task property.
-      return false unless (task = expr.query.property).is_a?(Task)
+      return false unless (task = property).is_a?(Task)
       project = task.project
       # 1st arg must be a resource ID.
       return false if (resource = project.resource(args[0])).nil?
@@ -135,12 +145,15 @@ class TaskJuggler
     end
 
     def isleaf(expr, args)
-      expr.query.property.leaf?
+      property, scopeProperty = properties(expr)
+      return false unless property
+      property.leaf?
     end
 
     def isongoing(expr, args)
+      property, scopeProperty = properties(expr)
       # The result can only be true when called for a Task property.
-      return false unless (task = expr.query.property).is_a?(Task)
+      return false unless (task = property).is_a?(Task)
       project = task.project
       # 1st arg must be a scenario index.
       if (scenarioIdx = project.scenarioIdx(args[0])).nil?
@@ -159,15 +172,18 @@ class TaskJuggler
     end
 
     def isresource(expr, args)
-      expr.query.property.is_a?(Resource)
+      property, scopeProperty = properties(expr)
+      property.is_a?(Resource)
     end
 
     def istask(expr, args)
-      expr.query.property.is_a?(Task)
+      property, scopeProperty = properties(expr)
+      property.is_a?(Task)
     end
 
     def treelevel(expr, args)
-      expr.query.property.level + 1
+      property, scopeProperty = properties(expr)
+      property.level + 1
     end
 
   end