taskjuggler 0.0.5 → 0.0.6

data/lib/Limits.rb

@@ -25,14 +25,16 @@ class TaskJuggler
     class Limit
 
       attr_accessor :resource
+      attr_reader :name, :interval, :upper
 
       # To create a new Limit object, the Interval +interval+ and the
-      # period duration (+period+ in seconds) must be specified. This creates a
-      # counter for each period within the overall interval. +value+ is the value
-      # of the limit. +upper+ specifies whether the limit is an upper or lower
-      # limit. The limit can also be restricted to certain a Resource specified
-      # by +resource+.
-      def initialize(interval, period, value, upper, resource)
+      # period duration (+period+ in seconds) must be specified. This creates
+      # a counter for each period within the overall interval. +value+ is the
+      # value of the limit. +upper+ specifies whether the limit is an upper or
+      # lower limit. The limit can also be restricted to certain a Resource
+      # specified by +resource+.
+      def initialize(name, interval, period, value, upper, resource)
+        @name = name
         @interval = interval
         @period = period
         @value = value
@@ -47,7 +49,7 @@ class TaskJuggler
 
       # Returns a deep copy of the class instance.
       def copy
-        Limit.new(@interval, @period, @value, @upper, @resource)
+        Limit.new(@name, @interval, @period, @value, @upper, @resource)
       end
 
       # This function can be used to reset the counter for a specific period
@@ -56,7 +58,8 @@ class TaskJuggler
         return unless @dirty
 
         if date.nil?
-          @scoreboard = Scoreboard.new(@interval.start, @interval.end, @period, 0)
+          @scoreboard = Scoreboard.new(@interval.start, @interval.end,
+                                       @period, 0)
         else
           return unless @interval.contains?(date)
           @scoreboard.set(date, 0)
@@ -64,54 +67,67 @@ class TaskJuggler
         @dirty = false
       end
 
-      # Increase the counter for a specific period specified by +date+. If
-      # +resource+ is not nil, the counter is only increased if +resource+
-      # matches resource.
+      # Increase the counter if the _date_ matches the @interval. The
+      # relationship between @resource and _resource_ is described below.
+      # @r \ _r_  nil    y
+      # nil       inc   inc
+      #  x         -    if x==y inc else -
       def inc(date, resource)
-        return if !@interval.contains?(date) || (!resource.nil? && @resource != resource)
-
-        @dirty = true
-        @scoreboard.set(date, @scoreboard.get(date) + 1)
+        if @interval.contains?(date) &&
+           (@resource.nil? || @resource == resource)
+          # The condition is met, increment the counter for the interval.
+          @dirty = true
+          @scoreboard.set(date, @scoreboard.get(date) + 1)
+        end
       end
 
-      # Returns true if the counter for the time slot specified by +date+ or all
-      # counters are within the limit. If +upper+ is true, only upper limits are
-      # checked. If not, only lower limits are checked. If +resource+ is not
-      # nil, only limits for this resource are checked.
+      # Returns true if the counter for the time slot specified by +date+ or
+      # all counters are within the limit. If +upper+ is true, only upper
+      # limits are checked. If not, only lower limits are checked. The
+      # dependency between _resource_ and @resource is described in the matrix
+      # below:
+      # @r \ _r_  nil   y
+      # nil       test  true
+      #  x        true  if x==y test else true
       def ok?(date, upper, resource)
-        if date.nil?
-          # if @upper does not match, we can ignore this limit.
-          return true if @upper != upper || (!resource.nil? && @resource != resource)
+        # if @upper does not match or the provided resource does not match,
+        # we can ignore this limit.
+        return true if @upper != upper ||
+                       (!@resource.nil? ^ !resource.nil?) ||
+                       (@resource && resource && @resource != resource)
 
-          # Check all counters.
+        if date.nil?
+          # No date given. We need to check all counters.
           @scoreboard.each do |i|
             return false if @upper ? i >= @value : i < @value
           end
           return true
         else
-          # If the date is outside the interval or @upper does not match, ignore
-          # this limit.
-          return true if !@interval.contains?(date) || @upper != upper
-          return @upper ? @scoreboard.get(date) < @value : @scoreboard.get(date) >= @value
+          # If the date is outside the interval we don't have to check
+          # anything. Everything is ok.
+          return true if !@interval.contains?(date)
+
+          return @upper ? @scoreboard.get(date) < @value :
+                          @scoreboard.get(date) >= @value
         end
       end
 
     end
 
-    attr_reader :limits, :project
+    attr_reader :project, :limits
 
     # Create a new Limits object. If an argument is passed, it acts as a copy
     # contructor.
     def initialize(limits = nil)
       if limits.nil?
         # Normal initialization
-        @limits = {}
+        @limits = []
         @project = nil
       else
         # Deep copy content from other instance.
-        @limits = {}
+        @limits = []
         limits.limits.each do |name, limit|
-          @limits[name] = limit.copy
+          @limits << limit.copy
         end
         @project = limits.project
       end
@@ -128,32 +144,40 @@ class TaskJuggler
 
     # Reset all counter for all limits.
     def reset
-      @limits.each_value { |limit| limit.reset }
+      @limits.each { |limit| limit.reset }
     end
 
-    # Call this function to create or change a limit. The limit must be uniquely
-    # identified by +name+. +value+ is the new limit value (in time slots).
-    # +period+ is the Interval where the limit is active. In case the interval
+    # Call this function to create or change a limit. The limit is uniquely
+    # identified by the combination of +name+, +interval+ and +resource+.
+    # +value+ is the new limit value (in time slots). In case the interval
     # is nil, the complete project time frame is used.
     def setLimit(name, value, interval = nil, resource = nil)
-      @limits.delete(name) if @limits[name]
-      newLimit(name, value, interval.nil? ?
-               Interval.new(@project['start'], @project['end']) : interval, resource)
+      iv = interval || Interval.new(@project['start'], @project['end'])
+      # If we have already a limit for the name + interval + resource
+      # combination, we delete it first.
+      @limits.delete_if do |l|
+        l.name == name && l.interval.start == iv.start &&
+        l.interval.end == iv.end && l.resource == resource
+      end
+
+      newLimit(name, value, iv, resource)
     end
 
     # This function increases the counters for all limits for a specific
     # interval identified by _date_.
     def inc(date, resource = nil)
-      @limits.each_value do |limit|
+      @limits.each do |limit|
         limit.inc(date, resource)
       end
     end
 
-    # Check all upper limits and return true if none is exceeded. If a _date_ is
-    # specified only the counter for that specific period is tested. Otherwise
-    # all periods are tested.
+    # Check all upper limits and return true if none is exceeded. If a _date_
+    # is specified only the counters for that specific period are tested.
+    # Otherwise all periods are tested. If _resource_ is nil, only
+    # non-resource-specific counters are checked, otherwise only the ones that
+    # match the _resource_.
     def ok?(date = nil, upper = true, resource = nil)
-      @limits.each_value do |limit|
+      @limits.each do |limit|
         return false unless limit.ok?(date, upper, resource)
       end
       true
@@ -176,12 +200,14 @@ class TaskJuggler
         period = 60 * 60 * 24
         upper = false
       when 'weeklymax'
-        interval.start = interval.start.beginOfWeek(@project['weekStartsMonday'])
+        interval.start = interval.start.beginOfWeek(
+          @project['weekStartsMonday'])
         interval.end = interval.end.beginOfWeek(@project['weekStartsMonday'])
         period = 60 * 60 * 24 * 7
         upper = true
       when 'weeklymin'
-        interval.start = interval.start.beginOfWeek(@project['weekStartsMonday'])
+        interval.start = interval.start.beginOfWeek(
+          @project['weekStartsMonday'])
         interval.end = interval.end.beginOfWeek(@project['weekStartsMonday'])
         period = 60 * 60 * 24 * 7
         upper = false
@@ -212,7 +238,7 @@ class TaskJuggler
       end
       endDate = @project['end']
 
-      @limits[name] = Limit.new(interval, period, value, upper, resource)
+      @limits << Limit.new(name, interval, period, value, upper, resource)
     end
 
   end

data/lib/LogFile.rb

@@ -28,17 +28,17 @@ class TaskJuggler
     end
 
     def debug(message)
-      $stdout.puts message if @outputLevel >= 4
+      $stderr.puts message if @outputLevel >= 4
       log('DEBUG', message) if @logLevel >= 4
     end
 
     def info(message)
-      $stdout.puts message if @outputLevel >= 3
+      $stderr.puts message if @outputLevel >= 3
       log('INFO', message) if @logLevel >= 3
     end
 
     def warning(message)
-      $stdout.puts message if @outputLevel >= 2
+      $stderr.puts message if @outputLevel >= 2
       log('WARN', message) if @logLevel >= 2
     end
 

data/lib/LogicalFunction.rb

@@ -27,6 +27,7 @@ class TaskJuggler
         'isactive' => 1,
         'isdependencyof' => 3,
         'isdutyof' => 2,
+        'isfeatureof' => 2,
         'isleaf' => 0,
         'isongoing' => 1,
         'isresource' => 0,
@@ -94,7 +95,7 @@ class TaskJuggler
       property, scopeProperty = properties(expr)
       query = expr.query
       project = property.project
-      date = project.reportContext.report.get('end')
+      date = project.reportContexts.last.report.get('end')
       !project['journal'].currentEntries(query.end, property,
                                          args[0], query.start).empty?
     end
@@ -110,9 +111,8 @@ class TaskJuggler
         expr.error("Unknown scenario '#{args[0]}' used for function isactive()")
       end
 
-      property.getAllocatedTime(scenarioIdx,
-                                project.reportContext.report.get('start'),
-                                project.reportContext.report.get('end'),
+      query = expr.query
+      property.getAllocatedTime(scenarioIdx, query.start, query.end,
                                 scopeProperty) > 0.0
     end
 
@@ -144,6 +144,19 @@ class TaskJuggler
       task['assignedresources', scenarioIdx].include?(resource)
     end
 
+    def isfeatureof(expr, args)
+      property, scopeProperty = properties(expr)
+      # The result can only be true when called for a Task property.
+      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.
+      return false if (scenarioIdx = project.scenarioIdx(args[1])).nil?
+
+      property.isFeatureOf(scenarioIdx, task)
+    end
+
     def isleaf(expr, args)
       property, scopeProperty = properties(expr)
       return false unless property
@@ -160,8 +173,8 @@ class TaskJuggler
         expr.error("Unknown scenario '#{args[0]}' used for function isongoing()")
       end
 
-      iv1 = Interval.new(project.reportContext.report.get('start'),
-                         project.reportContext.report.get('end'))
+      query = expr.query
+      iv1 = Interval.new(query.start, query.end)
       tStart = task['start', scenarioIdx]
       tEnd = task['end', scenarioIdx]
       # This helps to show tasks with scheduling errors.

data/lib/LogicalOperation.rb

@@ -65,13 +65,17 @@ class TaskJuggler
           return evalBinaryOperation(opnd1, operator, opnd2) do |o|
             coerceNumber(o, expr)
           end
+        elsif opnd1.is_a?(RichTextIntermediate)
+          return evalBinaryOperation(opnd1.to_s, operator, opnd2) do |o|
+            coerceString(o, expr)
+          end
         elsif opnd1.is_a?(String)
           return evalBinaryOperation(opnd1, operator, opnd2) do |o|
             coerceString(o, expr)
           end
         else
           expr.error("First operand of a binary operation must be a date, " +
-                     "a number or a string: #{opnd1}")
+                     "a number or a string: #{opnd1.class}")
         end
       when '&'
         return coerceBoolean(@operand1.eval(expr), expr) &&

data/lib/Project.rb

@@ -50,7 +50,7 @@ class TaskJuggler
 
     attr_reader :accounts, :shifts, :tasks, :resources, :scenarios,
                 :timeSheets, :reports, :messageHandler
-    attr_accessor :reportContext, :outputDir, :warnTsDeltas
+    attr_accessor :reportContexts, :outputDir, :warnTsDeltas
 
     # Create a project with the specified +id+, +name+ and +version+.
     # +messageHandler+ is a MessageHandler reference that is used to handle
@@ -335,6 +335,8 @@ class TaskJuggler
               true,  false,   false, nil ],
         [ 'index',     'Index',        FixnumAttribute,
               false, false,   false, -1 ],
+        [ 'interactive', 'Interactive', BooleanAttribute,
+              false, false,   false, false ],
         [ 'left',      'Left',         RichTextAttribute,
               true,  false,   false, nil ],
         [ 'loadUnit',  'Load Unit',    StringAttribute,
@@ -343,6 +345,8 @@ class TaskJuggler
               true,  true,    false, nil ],
         [ 'numberFormat', 'Number Format', RealFormatAttribute,
               true,  true,    false, nil ],
+        [ 'openNodes', 'Open Nodes',   NodeListAttribute,
+              false, false,   false, nil ],
         [ 'prolog',    'Prolog',       RichTextAttribute,
               false, false,   false, nil],
         [ 'resourceAttributes', 'Resource Attributes', FormatListAttribute,
@@ -392,8 +396,12 @@ class TaskJuggler
 
       @timeSheets = TimeSheets.new
 
-      # This holds a reference to the ReportContext for each Thread.
-      @reportContext = nil
+      # The ReportContext provides additional settings to the report that can
+      # complement or replace the report attributes. Reports can include other
+      # reports. During report generation, only one context is active, but the
+      # context of enclosing reports needs to be preserved. Therefor we use a
+      # stack to implement this.
+      @reportContexts = []
       @outputDir = ''
       @warnTsDeltas = false
     end
@@ -611,8 +619,9 @@ class TaskJuggler
           @reports.each do |report|
             next if report.get('formats').empty?
             Log.startProgressMeter("Report #{report.name}")
-            @reportContext = ReportContext.new(self, report)
+            @reportContexts.push(ReportContext.new(self, report))
             report.generate
+            @reportContexts.pop
             Log.stopProgressMeter
           end
         else
@@ -620,8 +629,10 @@ class TaskJuggler
           @reports.each do |report|
             next if report.get('formats').empty?
             bp.queue(report) {
-              @reportContext = ReportContext.new(self, report)
-              report.generate
+              @reportContexts.push(ReportContext.new(self, report))
+              res = report.generate
+              @reportContexts.pop
+              res
             }
           end
           bp.wait do |report|
@@ -645,7 +656,7 @@ class TaskJuggler
       true
     end
 
-    def generateReport(reportId, regExpMode)
+    def generateReport(reportId, regExpMode, dynamicAttributes = nil)
       reportList = regExpMode ? reportList = matchingReports(reportId) :
                                 [ reportId ]
       reportList.each do |id|
@@ -654,8 +665,25 @@ class TaskJuggler
                 "Request to generate unknown report #{id}")
         end
         Log.startProgressMeter("Report #{report.name}")
-        @reportContext = ReportContext.new(self, report)
+        @reportContexts.push(context = ReportContext.new(self, report))
+
+        name = nil
+        # If we have dynamic attributes we need to backup the old attributes
+        # first, then parse the dynamicAttributes String replacing the
+        # original values.
+        if dynamicAttributes
+          context.attributeBackup = report.backupAttributes
+          parser = ProjectFileParser.new(@messageHandler)
+          parser.parseReportAttributes(report, dynamicAttributes)
+          report.set('interactive', true)
+        end
+
         report.generate
+
+        if dynamicAttributes
+          report.restoreAttributes(context.attributeBackup)
+        end
+        @reportContexts.pop
         Log.stopProgressMeter
       end
     end
@@ -669,7 +697,7 @@ class TaskJuggler
         formats = report.get('formats')
         next if formats.empty?
 
-        puts sprintf("%-20s %-15s %s", id, formats.join(', '), report.name)
+        puts sprintf("%s\t%s\t%s", id, formats.join(', '), report.name)
       end
     end
 

data/lib/ProjectFileParser.rb

@@ -11,12 +11,10 @@
 #
 
 require 'TextParser'
-require 'TextScanner'
+require 'ProjectFileScanner'
 require 'TjpSyntaxRules'
 require 'RichText'
-require 'RTFNavigator'
-require 'RTFQuery'
-require 'RTFReport'
+require 'RTFHandlers'
 
 class TaskJuggler
 
@@ -38,10 +36,10 @@ class TaskJuggler
       super()
 
       @messageHandler = messageHandler
-      # Define the token types that the TextScanner may return for variable
-      # elements.
+      # Define the token types that the ProjectFileScanner may return for
+      # variable elements.
       @variables = %w( INTEGER FLOAT DATE TIME STRING LITERAL ID ID_WITH_COLON
-                       RELATIVE_ID ABSOLUTE_ID MACRO )
+                       ABSOLUTE_ID MACRO )
 
       initRules
 
@@ -52,8 +50,8 @@ class TaskJuggler
     # a set of TJP files.
     def open(file, master, fileNameIsBuffer = false)
       begin
-        @scanner = TextScanner.new(file, @messageHandler)
-        # We need the TextScanner object for error reporting.
+        @scanner = ProjectFileScanner.new(file, @messageHandler)
+        # We need the ProjectFileScanner object for error reporting.
         if master && !fileNameIsBuffer && file != '.' && file[-4, 4] != '.tjp'
           error('illegal_extension', "Project file name must end with " +
                 '\'.tjp\' extension')
@@ -92,7 +90,7 @@ class TaskJuggler
 
     # A set of standard marcros is defined in all files as soon as the project
     # header has been read. Calling this functions gets the values from @project
-    # and inserts the Macro objects into the TextScanner.
+    # and inserts the Macro objects into the ProjectFileScanner.
     def setGlobalMacros
       @scanner.addMacro(Macro.new('projectstart', @project['start'].to_s,
                                   @scanner.sourceFileInfo))
@@ -105,6 +103,13 @@ class TaskJuggler
                                   @scanner.sourceFileInfo))
     end
 
+    def parseReportAttributes(report, attributes)
+      @property = report
+      @project = report.project
+      open(attributes, false, true)
+      parse('reportAttributes')
+    end
+
   private
 
     # Utility function that convers English weekday names into their index
@@ -124,7 +129,8 @@ class TaskJuggler
       if @property.container?
         error('container_attribute',
               "The attribute #{attribute} may not be used for this property " +
-              'after sub properties have been added.')
+              'after sub properties have been added.', @property,
+              @sourceFileInfo[0])
       end
     end
 
@@ -147,13 +153,16 @@ class TaskJuggler
     # Convenience function to check the integrity of a booking statement.
     def checkBooking(task, resource)
       unless task.leaf?
-        error('booking_no_leaf', "#{task.fullId} is not a leaf task")
+        error('booking_no_leaf', "#{task.fullId} is not a leaf task",
+              task, @sourceFileInfo[0])
       end
       if task['milestone', @scenarioIdx]
-        error('booking_milestone', "You cannot add bookings to a milestone")
+        error('booking_milestone', "You cannot add bookings to a milestone",
+              task, @sourceFileInfo[0])
       end
       unless resource.leaf?
-        error('booking_group', "You cannot book a group resource")
+        error('booking_group', "You cannot book a group resource",
+              task, @sourceFileInfo[0])
       end
     end
 
@@ -210,12 +219,7 @@ class TaskJuggler
     def newRichText(text, tokenSet = nil)
       sfi = sourceFileInfo
       begin
-        handlers = [
-          RTFNavigator.new(@project, sfi),
-          RTFQuery.new(@project, sfi),
-          RTFReport.new(@project, sfi)
-        ]
-        rText = RichText.new(text, handlers)
+        rText = RichText.new(text, RTFHandlers.create(@project, sfi))
         rti = rText.generateIntermediateFormat( [ 0, 0, 0], tokenSet)
         rti.sectionNumbers = false
       rescue RichTextException => msg
@@ -283,7 +287,7 @@ class TaskJuggler
         })
         descr('A shortcut for all items')
         # A '-' means the list should be empty.
-        pattern([ '_ - ' ], lambda {
+        pattern([ '_-' ], lambda {
           KeywordArray.new
         })
         descr('No items')
@@ -429,7 +433,6 @@ class TaskJuggler
         stackEntry = @fileStack.last
         instance_variable_set('@' + var, stackEntry[var])
       end
-      @property = nil
     end
 
   end