taskjuggler 3.1.0 → 3.2.0

data/examples/Tutorial/tutorial.tjp

@@ -42,7 +42,7 @@ copyright "© 2002 Crappy Software, Inc."
 rate 390.0
 
 # Register Good Friday as a global holiday for all resources.
-vacation "Good Friday" 2002-03-29
+leaves holiday "Good Friday" 2002-03-29
 flags team
 
 # This is one way to form teams
@@ -83,7 +83,7 @@ resource dev "Developers" {
   resource dev3 "Klaus Müller" {
     email "Klaus.Mueller@crappysoftware.com"
     Phone "x490"
-    vacation 2002-02-01 - 2002-02-05
+    leaves annual 2002-02-01 - 2002-02-05
   }
   flags team
 }
@@ -99,7 +99,7 @@ resource misc "The Others" {
     email "sung@crappysoftware.com"
     Phone "x482"
     rate 300.0
-    vacation 2002-03-11 - 2002-03-16
+    leaves annual 2002-03-11 - 2002-03-16
   }
 
   flags team
@@ -174,6 +174,12 @@ task AcSo "Accounting Software" {
       delayed:effort 40d
       depends !database, !backend
       allocate dev2, dev3
+      # Resource dev2 should only work 6 hours per day on this task.
+      limits {
+        dailymax 6h {
+          resources dev2
+        }
+      }
     }
 
     task backend "Back-End Functions" {
@@ -290,7 +296,7 @@ task AcSo "Accounting Software" {
 # results.
 
 navigator navbar {
-  hidereport 0
+  hidereport @none
 }
 
 macro TaskTip [
@@ -378,7 +384,7 @@ taskreport overview "" {
   # of the date. %a is the tag for this.
   timeformat "%a %Y-%m-%d"
   loadunit days
-  hideresource 1
+  hideresource @all
   balance cost rev
   caption 'All effort values are in man days.'
 
@@ -459,7 +465,7 @@ taskreport deliveries "" {
   columns bsi { title 'WBS' }, name, start, end, note { width 150 }, complete,
           chart { ${TaskTip} }
   taskroot AcSo.deliveries
-  hideresource 1
+  hideresource @all
   scenarios plan, delayed
 }
 # A list of all employees with their contact details.
@@ -473,7 +479,7 @@ resourcereport contactList "" {
           chart { scale day }
   hideresource ~isleaf()
   sortresources name.up
-  hidetask 1
+  hidetask @all
 }
 
 # A graph showing resource allocation. It identifies whether each

data/lib/taskjuggler/Attributes.rb

@@ -499,9 +499,8 @@ class TaskJuggler
       if query
         get.each do |r|
           if query.listItem
-            rti = RichText.new(query.listItem, RTFHandlers.create(r.project),
-                               r.project.messageHandler).
-                               generateIntermediateFormat
+            rti = RichText.new(query.listItem, RTFHandlers.create(r.project)).
+              generateIntermediateFormat
             q = query.dup
             q.property = r
             rti.setQuery(q)

data/lib/taskjuggler/HTMLDocument.rb

@@ -28,30 +28,35 @@ 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 = :strict, &block)
+    def initialize(docType = :html5, &block)
       super(&block)
 
-      @elements << XMLBlob.new('<?xml version="1.0" encoding="UTF-8"?>')
-      case docType
-      when :strict
-        dtdRef = 'Strict'
-        url = 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'
-      when :transitional
-        dtdRef = 'Transitional'
-        url = 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'
-      when :frameset
-        dtdRef = 'Frameset'
-        url = 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd'
+      unless docType == :html5
+        @elements << XMLBlob.new('<?xml version="1.0" encoding="UTF-8"?>')
+        case docType
+        when :strict
+          dtdRef = 'Strict'
+          url = 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'
+        when :transitional
+          dtdRef = 'Transitional'
+          url = 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'
+        when :frameset
+          dtdRef = 'Frameset'
+          url = 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd'
+        else
+          raise "Unsupported docType"
+        end
+        @elements << XMLBlob.new(
+          '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 ' +
+          "#{dtdRef}//EN\" \"#{url}\">")
       else
-        raise "Unsupported docType"
+        @elements << XMLBlob.new('<!DOCTYPE>')
       end
-      @elements << XMLBlob.new('<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 ' +
-                              "#{dtdRef}//EN\" \"#{url}\">")
       @elements << XMLComment.new('This file has been generated by ' +
                                   "#{AppConfig.appName} v#{AppConfig.version}")
-      @elements << (@html =
-                    HTML.new({ 'xml:lang' => 'en', 'lang' => 'en',
-                               'xmlns' => 'http://www.w3.org/1999/xhtml' }))
+      attrs = { 'xml:lang' => 'en', 'lang' => 'en' }
+      attrs['xmlns'] ='http://www.w3.org/1999/xhtml' unless docType == :html5
+      @elements << (@html = HTML.new(attrs))
     end
 
     # Generate the 'head' section of an HTML page.
@@ -61,6 +66,8 @@ class TaskJuggler
           TITLE.new { title },
           META.new({ 'http-equiv' => 'Content-Type',
                      'content' => 'text/html; charset=utf-8' }),
+          # Ugly hack to force IE into IE-9 mode.
+          META.new({ 'http-equiv' => 'X-UA-Compatible', 'content' => 'IE=9' })
         ]
         # Include optional meta tags.
         metaTags.each do |name, content|

data/lib/taskjuggler/Journal.rb

@@ -11,6 +11,8 @@
 # published by the Free Software Foundation.
 #
 
+require 'taskjuggler/MessageHandler'
+
 class TaskJuggler
 
   # A JournalEntry stores some RichText strings to describe a status or a
@@ -342,6 +344,8 @@ class TaskJuggler
   # information.
   class Journal
 
+    include MessageHandler
+
     # Create a new Journal object.
     def initialize
       # This list holds all entries.
@@ -435,15 +439,14 @@ class TaskJuggler
         if query.property
           if query.property.is_a?(Task)
             entries += currentEntriesR(query.end, query.property, 0,
-                                       query.start, query.hideJournalEntry)
+                                       query.start, query)
           end
         else
           query.project.tasks.each do |task|
             # We only care about top-level tasks.
             next if task.parent
 
-            entries += currentEntriesR(query.end, task, 0, query.start,
-                                       query.hideJournalEntry)
+            entries += currentEntriesR(query.end, task, 0, query.start, query)
             # Eliminate duplicates due to entries from adopted tasks
             entries.uniq!
           end
@@ -455,15 +458,14 @@ class TaskJuggler
         if query.property
           if query.property.is_a?(Task)
             entries += alertEntries(query.end, query.property, 1, query.start,
-                                    query.hideJournalEntry)
+                                    query)
           end
         else
           query.project.tasks.each do |task|
             # We only care about top-level tasks.
             next if task.parent
 
-            entries += alertEntries(query.end, task, 1, query.start,
-                                    query.hideJournalEntry)
+            entries += alertEntries(query.end, task, 1, query.start, query)
             # Eliminate duplicates due to entries from adopted tasks
             entries.uniq!
           end
@@ -485,11 +487,9 @@ class TaskJuggler
 
       # Now convert the RichText markup String into RichTextIntermediate
       # format.
-      unless (rti = RichText.new(rText, RTFHandlers.create(query.project),
-                                 query.project.messageHandler).
+      unless (rti = RichText.new(rText, RTFHandlers.create(query.project)).
                                  generateIntermediateFormat)
-        query.project.warning('ptn_journal',
-                              "Syntax error in journal: #{rText}")
+        warning('ptn_journal', "Syntax error in journal: #{rText}")
         return nil
       end
       # No section numbers, please!
@@ -579,12 +579,12 @@ class TaskJuggler
     # If the property does not have any JournalEntry objects or they are out
     # of date compared to the child properties, the level is computed based on
     # the highest level of the children. Only take the entries that are not
-    # filtered by _logExp_ into account.
-    def alertLevel(date, property, logExp)
+    # filtered by _query_.hideJournalEntry into account.
+    def alertLevel(date, property, query)
       maxLevel = 0
       # Gather all the current (as of the specified _date_) JournalEntry
       # objects for the property and than find the highest level.
-      currentEntriesR(date, property, 0, nil, logExp).each do |e|
+      currentEntriesR(date, property, 0, nil, query).each do |e|
         maxLevel = e.alertLevel if maxLevel < e.alertLevel
       end
       maxLevel
@@ -594,12 +594,12 @@ class TaskJuggler
     # _date_, are for _property_ or any of its childs, have at least _level_
     # alert and are after _minDate_. We only return those entries with the
     # highest overall alert level.
-    def alertEntries(date, property, minLevel, minDate, logExp)
+    def alertEntries(date, property, minLevel, minDate, query)
       maxLevel = 0
       entries = []
       # Gather all the current (as of the specified _date_) JournalEntry
       # objects for the property and than find the highest level.
-      currentEntriesR(date, property, minLevel, minDate, logExp).each do |e|
+      currentEntriesR(date, property, minLevel, minDate, query).each do |e|
         if maxLevel < e.alertLevel
           maxLevel = e.alertLevel
           entries = [ e ]
@@ -653,62 +653,82 @@ class TaskJuggler
     # property unless there is a property in the sub-tree specified by the
     # root _property_ with more up-to-date entries. The result is a
     # JournalEntryList.
-    def currentEntriesR(date, property, minLevel = 0, minDate = nil,
-                        logExp = nil)
-      # See if this property has any current JournalEntry objects.
-      pEntries = getEntries(property) ? getEntries(property).last(date) :
-                 JournalEntryList.new
-      # Remove entries below the minium alert level or before the timeout
-      # date.
-      pEntries.delete_if do |e|
-        e.headline.empty? || e.alertLevel < minLevel ||
-        (e.alertLevel == minLevel && minDate && e.date < minDate)
-      end
+    def currentEntriesR(date, property, minLevel, minDate, query)
+      DataCache.instance.cached(self, :currentEntriesR, date, property,
+                                minLevel, minDate, query) do
+        # See if this property has any current JournalEntry objects.
+        pEntries = getEntries(property) ? getEntries(property).last(date) :
+                   JournalEntryList.new
+        # Remove entries below the minium alert level or before the timeout
+        # date.
+        pEntries.delete_if do |e|
+          e.headline.empty? || e.alertLevel < minLevel ||
+          (e.alertLevel == minLevel && minDate && e.date < minDate)
+        end
 
-      # Determine the highest alert level of the pEntries.
-      maxPAlertLevel = 0
-      pEntries.each do |e|
-        maxPAlertLevel = e.alertLevel if e.alertLevel > maxPAlertLevel
-      end
+        # Determine the highest alert level of the pEntries.
+        maxPAlertLevel = 0
+        pEntries.each do |e|
+          maxPAlertLevel = e.alertLevel if e.alertLevel > maxPAlertLevel
+        end
 
-      cEntries = JournalEntryList.new
-      latestDate = nil
-      maxAlertLevel = 0
-      # If we have an entry from this property, we only care about child
-      # entries that are from a later date.
-      minDate = pEntries.first.date + 1 unless pEntries.empty?
-
-      # Now gather all current entries of the child properties and find the
-      # date that is closest to and right before the given _date_.
-      property.kids.each do |p|
-        currentEntriesR(date, p, minLevel, minDate).each do |e|
-          # Find the date of the most recent entry.
-          latestDate = e.date if latestDate.nil? || e.date > latestDate
-          # Find the highest alert level.
-          maxAlertLevel = e.alertLevel if e.alertLevel > maxAlertLevel
-          cEntries << e
+        cEntries = JournalEntryList.new
+        latestDate = nil
+        maxAlertLevel = 0
+        # If we have an entry from this property, we only care about child
+        # entries that are from a later date.
+        minDate = pEntries.first.date + 1 unless pEntries.empty?
+
+        # Now gather all current entries of the child properties and find the
+        # date that is closest to and right before the given _date_.
+        property.kids.each do |p|
+          currentEntriesR(date, p, minLevel, minDate, query).each do |e|
+            # Find the date of the most recent entry.
+            latestDate = e.date if latestDate.nil? || e.date > latestDate
+            # Find the highest alert level.
+            maxAlertLevel = e.alertLevel if e.alertLevel > maxAlertLevel
+            cEntries << e
+          end
         end
-      end
 
-      if !pEntries.empty? && (maxPAlertLevel > maxAlertLevel ||
-                              latestDate.nil? ||
-                              pEntries.first.date >= latestDate)
-        # If no child property has a more current JournalEntry or one with a
-        # higher alert level than this property and this property has
-        # JournalEntry objects, than those are taken.
-        entries = pEntries
-      else
-        # Otherwise we take the entries from the kids.
-        entries = cEntries
-      end
+        # Only Task properties have dependencies.
+        #if property.is_a?(Task)
+        #  # Now gather all current entries of the dependency properties and find
+        #  # the date that is closest to and right before the given _date_.
+        #  property['startpreds', query.scenarioIdx].each do |p, onEnd|
+        #    # We only follow end->start dependencies.
+        #    next unless onEnd
+
+        #    currentEntriesR(date, p, minLevel, minDate, query).each do |e|
+        #      # Find the date of the most recent entry.
+        #      latestDate = e.date if latestDate.nil? || e.date > latestDate
+        #      # Find the highest alert level.
+        #      maxAlertLevel = e.alertLevel if e.alertLevel > maxAlertLevel
+        #      cEntries << e
+        #    end
+        #  end
+        #end
+
+        if !pEntries.empty? && (maxPAlertLevel > maxAlertLevel ||
+                                latestDate.nil? ||
+                                pEntries.first.date >= latestDate)
+          # If no child property has a more current JournalEntry or one with a
+          # higher alert level than this property and this property has
+          # JournalEntry objects, than those are taken.
+          entries = pEntries
+        else
+          # Otherwise we take the entries from the kids.
+          entries = cEntries
+        end
 
-      # Remove all entries that are filtered by logExp.
-      if logExp
-        entries.delete_if { |e| hidden(e, logExp) }
-      end
+        # Remove all entries that are filtered by query.hideJournalEntry.
+        if query.hideJournalEntry
+          entries.delete_if { |e| hidden(e, query.hideJournalEntry) }
+        end
 
-      # Otherwise return the list provided by the childen.
-      entries
+        # Otherwise return the list provided by the childen.
+        entries
+      end
     end
 
     private

data/lib/taskjuggler/KeywordDocumentation.rb

@@ -12,6 +12,7 @@
 #
 
 require 'term/ansicolor'
+require 'taskjuggler/MessageHandler'
 require 'taskjuggler/HTMLDocument'
 require 'taskjuggler/RichText'
 require 'taskjuggler/TjpExample'
@@ -34,6 +35,7 @@ class TaskJuggler
 
     include HTMLElements
     include Term::ANSIColor
+    include MessageHandler
 
     attr_reader :keyword, :names, :pattern, :references, :optionalAttributes
     attr_accessor :contexts, :scenarioSpecific, :inheritedFromProject,
@@ -46,7 +48,6 @@ class TaskJuggler
     # _pattern_.  _optAttrPatterns_ is an Array with references to
     # TextParser::Patterns that are optional attributes to this keyword.
     def initialize(rule, pattern, syntax, args, optAttrPatterns, manual)
-      @messageHandler = MessageHandler.new(true)
       @rule = rule
       @pattern = pattern
       # The unique identifier. Usually the attribute or property name. To
@@ -160,7 +161,7 @@ class TaskJuggler
         end
       end
       if property
-        project = Project.new('id', 'dummy', '1.0', nil)
+        project = Project.new('id', 'dummy', '1.0')
         propertySet = case property
                       when 'task'
                         project.tasks
@@ -339,7 +340,7 @@ class TaskJuggler
     # Return a String that represents the keyword documentation in an XML
     # formatted form.
     def generateHTML(directory)
-      html = HTMLDocument.new(:strict)
+      html = HTMLDocument.new
       head = html.generateHead(keyword,
                                { 'description' => 'The TaskJuggler Manual',
                                  'keywords' =>
@@ -406,10 +407,9 @@ class TaskJuggler
     # catches all RichTextScanner processing problems and converts the exception
     # data into an error message.
     def newRichText(text)
-      rText = RichText.new(text, [], @messageHandler)
+      rText = RichText.new(text, [])
       unless (rti = rText.generateIntermediateFormat)
-        @messageHandler.error('rich_text',
-                              "Error in RichText of rule #{@keyword}")
+        error('rich_text', "Error in RichText of rule #{@keyword}")
       end
       @references += rti.internalReferences
       rti
@@ -545,17 +545,18 @@ class TaskJuggler
     end
 
     def generateHTMLContextLine
-      if @contexts.empty?
+      descr = []
+      @contexts.each do |c|
+        next if [ :deprecated, :removed ].include?(c.pattern.supportLevel)
+
+        descr << ', ' unless descr.empty?
+        descr << A.new('href' => "#{c.keyword}.html") { c.title }
+      end
+      if descr.empty?
         descr = A.new('href' =>
                       'Getting_Started.html#Structure_of_a_TJP_File') do
                         'Global scope'
                       end
-      else
-        descr = []
-        @contexts.each do |c|
-          descr << ', ' unless descr.empty?
-          descr << A.new('href' => "#{c.keyword}.html") { c.title }
-        end
       end
       generateHTMLTableLine('Context', descr)
     end
@@ -564,6 +565,8 @@ class TaskJuggler
       unless @seeAlso.empty?
         descr = []
         @seeAlso.each do |a|
+          next if [ :deprecated, :removed ].include?(a.pattern.supportLevel)
+
           descr << ', ' unless descr.empty?
           descr << A.new('href' => "#{a.keyword}.html") { a.title }
         end
@@ -629,6 +632,10 @@ class TaskJuggler
               end
 
               @optionalAttributes.each do |attr|
+                if [ :deprecated, :removed ].include?(attr.pattern.supportLevel)
+                  next
+                end
+
                 rows << TR.new('align' => 'left') do
                   [
                     TD.new('align' => 'left', 'class' => 'descr') do
@@ -657,6 +664,11 @@ class TaskJuggler
                   TD.new('class' => 'descr', 'style' => 'width:84%') do
                     list = []
                     @optionalAttributes.each do |attr|
+                      if [ :deprecated, :removed ].
+                         include?(attr.pattern.supportLevel)
+                        next
+                      end
+
                       list << ', ' unless list.empty?
                       list << A.new('href' => "#{attr.keyword}.html") do
                         attr.title