taskjuggler 0.0.3 → 0.0.4

data/lib/ResourceScenario.rb

@@ -3,7 +3,7 @@
 #
 # = ResourceScenario.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009 by Chris Schlaeger <cs@kde.org>
+# 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
@@ -143,12 +143,12 @@ class TaskJuggler
     # directly assiciated with the Task is taken into account.
     def query_cost(query)
       if query.costAccount
-        query.sortableResult = query.numericalResult =
+        query.sortable = query.numerical = cost =
           turnover(query.startIdx, query.endIdx, query.costAccount,
                    query.scopeProperty)
-        query.result = query.currencyFormat.format(query.sortableResult)
+        query.string = query.currencyFormat.format(cost)
       else
-        query.result = 'No cost account'
+        query.string = 'No cost account'
       end
     end
 
@@ -156,22 +156,29 @@ class TaskJuggler
     # Task is given as scope property only the effort allocated to this Task is
     # taken into account.
     def query_effort(query)
-      query.sortableResult = query.numericalResult =
+      query.sortable = query.numerical = effort =
         getEffectiveWork(query.startIdx, query.endIdx, query.scopeProperty)
-      query.result = query.scaleLoad(query.sortableResult)
+      query.string = query.scaleLoad(effort)
     end
 
-    # The unallocated effort of the Resource in the specified interval.
+    # The unallocated work time of the Resource during the specified interval.
+    def query_freetime(query)
+      query.sortable = query.numerical = time =
+        getEffectiveFreeTime(query.startIdx, query.endIdx) / (60 * 60 * 24)
+      query.string = query.scaleDuration(time)
+    end
+
+    # The unallocated effort of the Resource during the specified interval.
     def query_freework(query)
-      query.sortableResult = query.numericalResult =
+      query.sortable = query.numerical = work =
         getEffectiveFreeWork(query.startIdx, query.endIdx)
-      query.result = query.scaleLoad(query.sortableResult)
+      query.string = query.scaleLoad(work)
     end
 
     # Get the rate of the resource.
     def query_rate(query)
-      query.sortableResult = query.numericalResult = rate
-      query.result = query.currencyFormat.format(query.sortableResult)
+      query.sortable = query.numerical = r = rate
+      query.string = query.currencyFormat.format(r)
     end
 
     # Compute the revenue generated by this Resource for a given Account during
@@ -179,12 +186,12 @@ class TaskJuggler
     # revenue directly associated to this Task is taken into account.
     def query_revenue(query)
       if query.revenueAccount
-        query.sortableResult = query.numericalResult =
+        query.sortable = query.numerical = revenue =
           turnover(query.startIdx, query.endIdx, query.revenueAccount,
                    query.scopeProperty)
-        query.result = query.currencyFormat.format(query.sortableResult)
+        query.string = query.currencyFormat.format(revenue)
       else
-        query.result = 'No revenue account'
+        query.string = 'No revenue account'
       end
     end
 
@@ -251,7 +258,29 @@ class TaskJuggler
       time
     end
 
-    # Return the unallocated work of the resource and its children wheighted by
+    # Return the unallocated work time (in seconds) of the resource and its
+    # children.
+    def getEffectiveFreeTime(startIdx, endIdx)
+      # Convert the interval dates to indexes if needed.
+      startIdx = @project.dateToIdx(startIdx, true) if startIdx.is_a?(TjTime)
+      endIdx = @project.dateToIdx(endIdx, true) if endIdx.is_a?(TjTime)
+
+      freeTime = 0
+      if @property.container?
+        @property.children.each do |resource|
+          freeTime += resource.getEffectiveFreeTime(@scenarioIdx, startIdx,
+                                                    endIdx)
+        end
+      else
+        initScoreboard if @scoreboard.nil?
+
+        freeTime = getFreeSlots(startIdx, endIdx) *
+          @project['scheduleGranularity']
+      end
+      freeTime
+    end
+
+    # Return the unallocated work of the resource and its children weighted by
     # their efficiency.
     def getEffectiveFreeWork(startIdx, endIdx)
       # Convert the interval dates to indexes if needed.
@@ -329,13 +358,13 @@ class TaskJuggler
       endIdx = @lastBookedSlot + 1
 
       # In case the index markers are still uninitialized, we have no bookings.
-      return [] if startIdx.nil? || endIdx.nil?
+      return {} if startIdx.nil? || endIdx.nil?
 
-      startIdx.upto(endIdx - 1) do |idx|
+      startIdx.upto(endIdx) do |idx|
         task = @scoreboard[idx]
         # Now we watch for task changes.
         if task != lastTask || (lastTask == nil && task.is_a?(Task)) ||
-           (task.is_a?(Task) && idx == endIdx - 1)
+           (task.is_a?(Task) && idx == endIdx)
           unless lastTask.nil?
             # If we don't have a Booking for the task yet, we create one.
             if bookings[lastTask].nil?
@@ -343,7 +372,7 @@ class TaskJuggler
             end
 
             # Make sure the index is correct even for the last task block.
-            idx += 1 if idx == endIdx - 1
+            idx += 1 if idx == endIdx
             # Append the new interval to the Booking.
             bookings[lastTask].intervals <<
               Interval.new(@scoreboard.idxToDate(bookingStart),

data/lib/RichText.rb

@@ -3,7 +3,7 @@
 #
 # = RichText.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009 by Chris Schlaeger <cs@kde.org>
+# 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
@@ -63,82 +63,139 @@ class TaskJuggler
   #  [[item]] site internal internal reference (in HTML .html gets appended
   #                                             automatically)
   #  [[item An item]] another internal reference
-  #  [[protocol:path arg1 arg2 ...]]
+  #  [[function:path arg1 arg2 ...]]
   #
   #  <nowiki> ... </nowiki> Disable markup interpretation for the enclosed
   #  portion of text.
   #
   class RichText
 
-    attr_accessor :sectionNumbers, :lineWidth
+    attr_reader :inputText
 
     # Create a rich text object by passing a String with markup elements to it.
     # _text_ must be plain text with MediaWiki compatible markup elements. In
     # case an error occurs, an exception of type TjException will be raised.
-    def initialize(text, sectionCounter = [ 0, 0, 0] )
+    # _functionHandlers_ is a Hash that maps RichTextFunctionHandler objects
+    # by their function name.
+    def initialize(text, functionHandlers = [])
+      # Keep a copy of the original text.
+      @inputText = text
+      @functionHandlers = functionHandlers
+    end
+
+    # Convert the @inputText into an abstract syntax tree that can then be
+    # converted into the various output formats. _sectionCounter_ is an Array
+    # that holds the initial values for the section counters.
+    def generateIntermediateFormat(sectionCounter = [ 0, 0, 0], tokenSet = nil)
+      rti = RichTextIntermediate.new(self)
+      # Copy the function handlers.
+      @functionHandlers.each do |h|
+        rti.registerFunctionHandler(h)
+      end
+      # Parse the input text into an abstract syntax tree.
+      parser = RichTextParser.new(rti, sectionCounter, tokenSet)
+      parser.open(@inputText)
+      # Parse the input text and convert it to the intermediate representation.
+      tree = parser.parse('richtext')
+      # In case the result is empty, use an empty RichTextElement as result
+      tree = RichTextElement.new(rti, :richtext, nil) unless tree
+      tree.cleanUp
+      rti.tree = tree
+      rti
+    end
+
+    # Return the RichTextFunctionHandler for the function _name_. _block_
+    # specifies whether we are looking for a block or inline function.
+    def functionHandler(name, block)
+      @functionHandlers.each do |handler|
+        return handler if handler.function == name &&
+                          handler.blockFunction == block
+      end
+      nil
+    end
+
+    private
+
+  end
+
+  # The RichTextIntermediate is a container for the intermediate
+  # representation of a RichText object. By calling the to_* members it can be
+  # converted into the respective formats. A RichTextIntermediate object is
+  # generated by RichText::generateIntermediateFormat.
+  class RichTextIntermediate
+
+    attr_reader :richText
+    attr_accessor :blockMode, :sectionNumbers, :lineWidth, :linkTarget,
+                  :cssClass, :tree
+
+    def initialize(richText)
+      # A reference to the corresponding RichText object the RTI is derived
+      # from.
+      @richText = richText
+      # The root of the generated intermediate format. This is a
+      # RichTextElement.
+      @tree = nil
+      # The blockMode specifies whether the RichText should be interpreted as
+      # a line of text or a block (default).
+      @blockMode = true
       # Set this to false to disable automatically generated section numbers.
       @sectionNumbers = true
       # Set this to the width of your text area. Needed for horizonal lines.
       @lineWidth = 80
-      # These are the RichTextProtocolHandler objects to handle references with
-      # a protocol specification.
-      @protocolHandlers = {}
-      parser = RichTextParser.new(self, sectionCounter)
-      parser.open(text)
-      # Parse the input text and convert it to the intermediate representation.
-      @richText = parser.parse('richtext')
-      # In case the result is empty, use an empty RichTextElement as result
-      @richText = RichTextElement.new(@richText, :richtext, nil) unless @richText
-      @richText.cleanUp
+      # The target used for hypertext links.
+      @linkTarget = nil
+      # The CSS class used for some key HTML elements.
+      @cssClass = nil
+      # These are the RichTextFunctionHandler objects to handle references with
+      # a function specification.
+      @functionHandlers = {}
     end
 
-    # Use this function to register new RichTextProtocolHandler objects with
+    # Use this function to register new RichTextFunctionHandler objects with
     # this class.
-    def registerProtocol(protocolHandler)
-      @protocolHandlers[protocolHandler.protocol] = protocolHandler
+    def registerFunctionHandler(functionHandler)
+      raise "Bad function handler" unless functionHandler
+      @functionHandlers[functionHandler.function] = functionHandler.dup
     end
 
-    # Use this function to register a set of RichTextProtocolHandler objects
-    # with this class. This will replace any previously registered handlers.
-    def setProtocolHandlers(protocolHandlers)
-      @protocolHandlers = protocolHandlers
+    # Return the handler for the given _function_ or raise an exception if it
+    # does not exist.
+    def functionHandler(function)
+      @functionHandlers[function]
     end
 
-    # Return the handler for the given _protocol_ or raise an exception if it
-    # does not exist.
-    def protocolHandler(protocol)
-      unless @protocolHandlers.include?(protocol)
-        raise TjException.new, "Unsupported protocol #{protocol}"
-      end
-      @protocolHandlers[protocol]
+    # Return true if the RichText has no content.
+    def empty?
+      @tree.empty?
     end
 
-    # Return a TableOfContents for the section headings.
+    # Recursively extract the section headings from the RichTextElement and
+    # build the TableOfContents _toc_ with the gathered sections.  _fileName_
+    # is the base name (without .html or other suffix) of the file the
+    # TOCEntries should point to.
     def tableOfContents(toc, fileName)
-      @richText.tableOfContents(toc, fileName)
+      @tree.tableOfContents(toc, fileName)
     end
 
     # Return an Array with all other snippet names that are referenced by
-    # internal references in this RichText object.
+    # internal references in this RichTextElement.
     def internalReferences
-      @richText.internalReferences
+      @tree.internalReferences
     end
 
-    # Convert the rich text to plain ASCII text. All elements that can't be
-    # represented easily in ASCII Strings are ommitted.
+    # Convert the intermediate format into a plain text String object.
     def to_s
-      @richText.to_s
+      @tree.to_s
     end
 
-    # Convert the rich text to HTML elements.
+    # Convert the intermediate format into a XMLElement objects tree.
     def to_html
-      @richText.to_html
+      @tree.to_html
     end
 
-    # Convert the rich text to an ASCII version with HTML like markup tags. This
-    # is probably only usefull for the unit test.
-    def to_tagged #:nodoc:
-      @richText.to_tagged
+    # Convert the intermediate format into a tagged syntax String object.
+    def to_tagged
+      @tree.to_tagged
     end
 
   end

data/lib/RichTextDocument.rb

@@ -3,7 +3,7 @@
 #
 # = RichTextDocument.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009 by Chris Schlaeger <cs@kde.org>
+# 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
@@ -12,7 +12,7 @@
 
 require 'RichTextSnip'
 require 'TableOfContents'
-require 'RichTextProtocolHandler'
+require 'RichTextFunctionHandler'
 
 class TaskJuggler
 
@@ -24,26 +24,28 @@ class TaskJuggler
   # and generateHTMLFooter.
   class RichTextDocument
 
-    attr_reader :protocolHandlers
+    attr_reader :functionHandlers
 
     # Create a new empty RichTextDocument object.
     def initialize
-      @protocolHandlers = {}
+      @functionHandlers = []
       @snippets = []
       @dirty = false
       @sectionCounter = [ 0, 0, 0 ]
+      @linkTarget = nil
       @toc = nil
     end
 
-    # Register a new RichTextProtocolHandler for this document.
-    def registerProtocolHandler(handler)
-      @protocolHandlers[handler.protocol] = handler
+    # Register a new RichTextFunctionHandler for this document.
+    def registerFunctionHandler(handler)
+      @functionHandlers << handler
     end
 
     # Add a new structured text file to the document. _file_ must be the name of
     # a file with RichText compatible syntax elements.
     def addSnip(file)
-      @snippets << RichTextSnip.new(self, file, @sectionCounter)
+      @snippets << (snippet = RichTextSnip.new(self, file, @sectionCounter))
+      snippet.linkTarget = @linkTarget
       @dirty = true
     end
 

data/lib/RichTextElement.rb

@@ -3,7 +3,7 @@
 #
 # = RichTextElement.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009 by Chris Schlaeger <cs@kde.org>
+# 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
@@ -23,7 +23,7 @@ class TaskJuggler
   # category that identifies the content of the node.
   class RichTextElement
 
-    attr_reader :category, :children
+    attr_reader :richText, :category, :children
     attr_writer :data
     attr_accessor :appendSpace
 
@@ -65,10 +65,16 @@ class TaskJuggler
       self
     end
 
+    # Return true of the node contains an empty RichText tree.
+    def empty?
+      @category == :richtext && @children.empty?
+    end
+
+
     # Recursively extract the section headings from the RichTextElement and
-    # build fill the TableOfContents _toc_ with the gathered sections.
-    # _fileName_ is the base name (without .html or other suffix) of the file
-    # the TOCEntries should point to.
+    # build the TableOfContents _toc_ with the gathered sections.  _fileName_
+    # is the base name (without .html or other suffix) of the file the
+    # TOCEntries should point to.
     def tableOfContents(toc, fileName)
       number = nil
       case @category
@@ -150,7 +156,7 @@ class TaskJuggler
         post = "\n\n"
       when :numberlist1
       when :numberitem1
-        pre = "#{@data[0]} "
+        pre = "#{@data[0]}. "
         post = "\n\n"
       when :numberlist2
       when :numberitem2
@@ -163,6 +169,10 @@ class TaskJuggler
       when :ref
       when :href
       when :blockfunc
+      when :inlinefunc
+        noChilds = true
+        checkHandler
+        pre = @richText.functionHandler(@data[0]).to_s(@data[1])
       when :italic
       when :bold
       when :code
@@ -242,7 +252,9 @@ class TaskJuggler
         pre = "<ref data=\"#{@data}\">"
         post = '</ref>'
       when :href
-        pre = "<a href=\"#{@data}\" target=\"_blank\">"
+        pre = "<a href=\"#{@data}\" #{@richText.linkTarget ?
+                                      "target=\"#{@richText.linkTarget}\"" :
+                                      ""}>"
         post = '</a>'
       when :blockfunc
         pre = "<blockfunc:#{@data[0]}"
@@ -252,6 +264,14 @@ class TaskJuggler
           end
         end
         post = "/>"
+      when :inlinefunc
+        pre = "<inlinefunc:#{@data[0]}"
+        if @data[1]
+          @data[1].keys.sort.each do |key|
+            pre += " #{key}=\"#{@data[1][key]}\""
+          end
+        end
+        post = "/>"
       when :italic
         pre = '<i>'
         post = '</i>'
@@ -283,33 +303,23 @@ class TaskJuggler
     # Convert the intermediate representation into HTML elements.
     def to_html
       noChilds = false
+      attrs = {}
+      attrs['class'] = @richText.cssClass if @richText.cssClass
       html =
       case @category
       when :richtext
-        XMLElement.new('div')
+        XMLElement.new(@richText.blockMode ? 'div' : 'span', attrs)
       when :title1
-        el = XMLElement.new('h1', 'id' => convertToID(children_to_s))
-        if @richText.sectionNumbers
-          el << XMLText.new("#{@data[0]} ")
-        end
-        el
+        htmlTitle(1)
       when :title2
-        el = XMLElement.new('h2', 'id' => convertToID(children_to_s))
-        if @richText.sectionNumbers
-          el << XMLText.new("#{@data[0]}.#{@data[1]} ")
-        end
-        el
+        htmlTitle(2)
       when :title3
-        el = XMLElement.new('h3', 'id' => convertToID(children_to_s))
-        if @richText.sectionNumbers
-          el << XMLText.new("#{@data[0]}.#{@data[1]}.#{@data[2]} ")
-        end
-        el
+        htmlTitle(3)
       when :hline
         noChilds = true
-        XMLElement.new('hr')
+        XMLElement.new('hr', attrs)
       when :paragraph
-        XMLElement.new('p')
+        XMLElement.new('p', attrs)
       when :pre
         noChilds = true
         pre = XMLElement.new('pre')
@@ -341,16 +351,23 @@ class TaskJuggler
       when :ref
         XMLElement.new('a', 'href' => "#{@data}.html")
       when :href
-        XMLElement.new('a', 'href' => @data, 'target' => '_blank')
+        a = XMLElement.new('a', 'href' => @data.to_s)
+        a['target'] = @richText.linkTarget if @richText.linkTarget
+        a
       when :blockfunc
         noChilds = true
-        @richText.protocolHandler(@data[0]).to_html(@data[1])
+        checkHandler
+        @richText.functionHandler(@data[0]).to_html(@data[1])
+      when :inlinefunc
+        noChilds = true
+        checkHandler
+        @richText.functionHandler(@data[0]).to_html(@data[1])
       when :italic
         XMLElement.new('i')
       when :bold
         XMLElement.new('b')
       when :code
-        XMLElement.new('code')
+        XMLElement.new('code', attrs)
       when :text
         noChilds = true
         XMLText.new(@children[0])
@@ -378,6 +395,15 @@ class TaskJuggler
       text
     end
 
+    def checkHandler
+      unless @data[0] && @data[0].is_a?(String)
+        raise "Bad RichText function '#{@data[0]}' requested"
+      end
+      if @richText.functionHandler(@data[0]).nil?
+        raise "No handler for #{@data[0]} registered"
+      end
+    end
+
     # This function converts a String into a new String that only contains
     # characters that are acceptable for HTML tag IDs.
     def convertToID(text)
@@ -391,6 +417,24 @@ class TaskJuggler
       out.chomp('_')
     end
 
+    private
+
+    def htmlTitle(level)
+      attrs = { 'id' => convertToID(children_to_s) }
+      attrs['class'] = @richText.cssClass if @richText.cssClass
+      el = XMLElement.new("h#{level}", attrs)
+      if @richText.sectionNumbers
+        s = ''
+        1.upto(level) do |i|
+          s += '.' unless s.empty?
+          s += "#{@data[i - 1]}"
+        end
+        s += ' '
+        el << XMLText.new(s)
+      end
+      el
+    end
+
   end
 
 end