taskjuggler 0.1.1 → 0.2.0

data/lib/taskjuggler/TextParser/Scanner.rb

@@ -69,16 +69,25 @@ class TaskJuggler::TextParser
 
       # Inject the String _text_ into the input stream at the current cursor
       # position.
-      def injectText(text)
+      def injectText(text, callLength)
+        # Current scanner position in _bytes_ form start
         pos = @scanner.pos
-        @nextMacroEnd = pos + text.length
-        @line = @line[0, pos] + text + @line[pos..-1]
+        # Remove the macro call from the end of the already parsed input.
+        preCall = @scanner.pre_match[0..-(callLength + 1)]
+        # Store the end position of the inserted macro in bytes.
+        @nextMacroEnd = preCall.bytesize + text.bytesize
+        # Compose the new @line from the cleaned input, the injected text and
+        # the remainer of the old @line.
+        @line = preCall + text + @scanner.post_match
+        # Start the StringScanner again at the first character of the injected
+        # text.
         @scanner = StringScanner.new(@line)
-        @scanner.pos = pos
+        @scanner.pos = preCall.bytesize
       end
 
-      def injectMacro(macro, args, text)
-        injectText(text)
+      def injectMacro(macro, args, text, callLength)
+        # We add 3 chars more for the ${}.
+        injectText(text, callLength)
 
         # Simple detection for recursive macro calls.
         return false if @macroStack.length > 20
@@ -151,7 +160,7 @@ class TaskJuggler::TextParser
       def line
         return '' unless @line
 
-        @line[0..(@scanner.pos - 1)]
+        (@scanner.pre_match || '') + (@scanner.matched || '')
       end
 
     end
@@ -474,8 +483,9 @@ class TaskJuggler::TextParser
     # Expand a macro and inject it into the input stream. _prefix_ is any
     # string that was found right before the macro call. We have to inject it
     # before the expanded macro. _args_ is an Array of Strings. The first is
-    # the macro name, the rest are the parameters.
-    def expandMacro(prefix, args)
+    # the macro name, the rest are the parameters. _callLength_ is the number
+    # of characters for the complete macro call "${...}".
+    def expandMacro(prefix, args, callLength)
       # Get the expanded macro from the @macroTable.
       macro, text = @macroTable.resolve(args, sourceFileInfo)
       unless macro && text
@@ -485,7 +495,7 @@ class TaskJuggler::TextParser
       # If the expanded macro is empty, we can ignore it.
       return if text == ''
 
-      unless @cf.injectMacro(macro, args, prefix + text)
+      unless @cf.injectMacro(macro, args, prefix + text, callLength)
         error('macro_stack_overflow', "Too many nested macro calls.")
       end
     end
@@ -514,7 +524,8 @@ class TaskJuggler::TextParser
             args = entry.args[1..-1]
             args.collect! { |a| '"' + a + '"' }
             @messageHandler.info('macro_stack',
-                                 "  ${#{macro.name} #{args.join(' ')}}",
+                                 "  ${#{macro.name}#{args.empty? ? '' : ' '}" +
+                                 "#{args.join(' ')}}",
                                  macro.sourceFileInfo)
           end
         end

data/lib/taskjuggler/TimeSheets.rb

@@ -102,7 +102,7 @@ class TaskJuggler
         if @status.headline.empty?
           error('ts_no_headline',
                 "You must provide a headline for the status of " +
-                "task #{@task.fullId}")
+                "task #{taskId}")
         end
         if @status.summary &&
           @status.summary.richText.inputText == "A summary text\n"

data/lib/taskjuggler/Tj3Config.rb

@@ -14,7 +14,7 @@
 require 'taskjuggler/UTF8String'
 require 'taskjuggler/AppConfig'
 
-AppConfig.version = '0.1.1'
+AppConfig.version = '0.2.0'
 AppConfig.packageName = 'taskjuggler'
 AppConfig.softwareName = 'TaskJuggler III'
 AppConfig.packageInfo = 'A Project Management Software'

data/lib/taskjuggler/TjTime.rb

@@ -26,9 +26,8 @@ class TaskJuggler
     # The number of days per month. Leap years are taken care of separately.
     MON_MAX = [ 0, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 ]
 
-    # The current time zone name.
-    @@tz = 'UTC'
-    ENV['TZ'] = @@tz
+    # Initialize @@tz with the current time zone if it is set.
+    @@tz = ENV['TZ']
 
     # call-seq:
     #   TjTime() -> TjTime (now)
@@ -114,6 +113,11 @@ class TaskJuggler
       TjTime.new((localtime.to_i / clock) * clock)
     end
 
+    # Return the time object in UTC.
+    def utc
+      TjTime.new(@time.dup.gmtime)
+    end
+
     # Returns the total number of seconds of the day. The time is assumed to be
     # in the time zone specified by _tz_.
     def secondsOfDay(tz = nil)

data/lib/taskjuggler/TjpSyntaxRules.rb

@@ -289,7 +289,7 @@ EOT
       end
 
       if @val[1].nil?
-        intervals = [ Interval.new(@project['start'], @project['end']) ]
+        intervals = [ TimeInterval.new(@project['start'], @project['end']) ]
       else
         intervals = @val[1]
       end
@@ -883,7 +883,7 @@ EOT
 
   def rule_exportHeader
     pattern(%w( _export !optionalID $STRING ), lambda {
-      report = newReport(@val[1], @val[2], :export, sourceFileInfo)
+      report = newReport(@val[1], @val[2], :export, @sourceFileInfo[0])
 
       # By default, we export all scenarios.
       scenarios = Array.new(@project.scenarios.items) { |i| i }
@@ -939,7 +939,8 @@ Define a list of resource attributes that should be included in the report.
 EOT
        )
     allOrNothingListRule('exportableResourceAttributes',
-                         { 'vacation' => 'Include vacations',
+                         { 'booking' => 'Include bookings',
+                           'vacation' => 'Include vacations',
                            'workinghours' => 'Include working hours' })
 
     pattern(%w( !rollupresource ))
@@ -1269,7 +1270,7 @@ EOT
 
         # We allow multiple instances of flag definitions.
         begin
-          @property['flags', @scenarioIdx] << flag
+          @property['flags', @scenarioIdx] += [ flag ]
         rescue AttributeOverwrite
         end
       end
@@ -1495,6 +1496,71 @@ EOT
        )
     also(%w( sorttasks ))
   end
+  def rule_iCalReport
+    pattern(%w( !iCalReportHeader !iCalReportBody ), lambda {
+      @property = nil
+    })
+    doc('icalreport', <<'EOT'
+Generates an RFC5545 compliant iCalendar file. This file can be used to export
+task information to calendar applications or other tools that read iCalendar
+files.
+EOT
+       )
+  end
+  def rule_iCalReportBody
+    optionsRule('iCalReportAttributes')
+  end
+
+  def rule_iCalReportAttributes
+    optional
+    repeatable
+
+    pattern(%w( !hideresource ))
+    pattern(%w( !hidejournalentry ))
+    pattern(%w( !hidetask ))
+    pattern(%w( !reportEnd ))
+    pattern(%w( !reportPeriod ))
+    pattern(%w( !reportStart ))
+    pattern(%w( !rollupresource ))
+    pattern(%w( !rolluptask ))
+
+    pattern(%w( _scenario !scenarioId ), lambda {
+      # Don't include disabled scenarios in the report
+      @val[1].delete_if { |sc| !@project.scenario(sc).get('active') }
+      @property.set('scenarios', @val[1])
+    })
+    doc('scenario.ical', <<'EOT'
+Id of the scenario that should be included in the report. By default, the
+top-level scenario will be included. This attribute can be used select another
+scenario.
+EOT
+       )
+  end
+
+  def rule_iCalReportHeader
+    pattern(%w( _icalreport !optionalID $STRING ), lambda {
+      report = newReport(@val[1], @val[2], :iCal, @sourceFileInfo[0])
+
+      @property.set('formats', [ :iCal ])
+      # By default, we export only the first scenario.
+      report.set('scenarios', [ 0 ])
+      # Show all tasks, sorted by seqno-up.
+      report.set('hideTask', LogicalExpression.new(LogicalOperation.new(0)))
+      report.set('sortTasks', [ [ 'seqno', true, -1 ] ])
+      # Show all resources, sorted by seqno-up.
+      report.set('hideResource',
+                  LogicalExpression.new(LogicalOperation.new(0)))
+      report.set('sortResources', [ [ 'seqno', true, -1 ] ])
+      # Show all journal entries.
+      report.set('hideJournalEntry',
+                 LogicalExpression.new(LogicalOperation.new(0)))
+    })
+    arg(1, 'file name', <<'EOT'
+The name of the report file to generate without an extension.  Use . to use
+the standard output channel.
+EOT
+       )
+  end
 
   def rule_idOrAbsoluteId
     singlePattern('$ID')
@@ -1602,12 +1668,12 @@ EOT
             error('start_before_end', "The end date (#{endSpec}) must be " +
                   "after the start date (#{@val[0]}).", @sourceFileInfo[0])
           end
-          Interval.new(@val[0], endSpec)
+          TimeInterval.new(@val[0], endSpec)
         else
-          Interval.new(@val[0], @val[0] + endSpec)
+          TimeInterval.new(@val[0], @val[0] + endSpec)
         end
       else
-        Interval.new(@val[0], @val[0].sameTimeNextDay)
+        TimeInterval.new(@val[0], @val[0].sameTimeNextDay)
       end
     })
     doc('interval3', <<'EOT'
@@ -1633,9 +1699,9 @@ EOT
           error('start_before_end', "The end date (#{endSpec}) must be after " +
                 "the start date (#{@val[0]}).", @sourceFileInfo[0])
         end
-        Interval.new(@val[0], endSpec)
+        TimeInterval.new(@val[0], endSpec)
       else
-        Interval.new(@val[0], @val[0] + endSpec)
+        TimeInterval.new(@val[0], @val[0] + endSpec)
       end
     })
     doc('interval2', <<'EOT'
@@ -1811,7 +1877,9 @@ EOT
     )
 
     pattern(%w( _period !valInterval ), lambda {
-      @limitInterval = @val[1]
+      @limitInterval = ScoreboardInterval.new(@project['start'],
+                                              @project['scheduleGranularity'],
+                                              @val[1].start, @val[1].end)
     })
     doc('period.limit', <<'EOT'
 This property is a shortcut for setting the start and end dates of the limit
@@ -1843,7 +1911,9 @@ EOT
 
   def rule_limitValue
     pattern([ '!workingDuration' ], lambda {
-      @limitInterval = Interval.new(@project['start'], @project['end'])
+      @limitInterval = ScoreboardInterval.new(@project['start'],
+                                              @project['scheduleGranularity'],
+                                              @project['start'], @project['end'])
       @limitResources = []
       @val[0]
     })
@@ -1987,7 +2057,8 @@ EOT
     pattern([ '_longauto'] , lambda { :longauto })
     descr(<<'EOT'
 Automatically select the unit that produces the shortest and most readable
-value. The unit name will not be abbreviated.
+value. The unit name will not be abbreviated. It will not use quarters since
+it is not common.
 EOT
          )
 
@@ -1995,12 +2066,16 @@ EOT
     descr('Display all load and duration values as minutes.')
 
     pattern([ '_months' ], lambda { :months })
-    descr('Display all load and duration values as monts.')
+    descr('Display all load and duration values as months.')
+
+    pattern([ '_quarters' ], lambda { :quarters })
+    descr('Display all load and duration values as quarters.')
 
     pattern([ '_shortauto' ], lambda { :shortauto })
     descr(<<'EOT'
 Automatically select the unit that produces the shortest and most readable
-value. The unit name will be abbreviated.
+value. The unit name will be abbreviated. It will not use quarters since it is
+not common.
 EOT
          )
 
@@ -2223,7 +2298,7 @@ EOF
 
   def rule_nikuReportHeader
     pattern(%w( _nikureport !optionalID $STRING ), lambda {
-      newReport(@val[1], @val[2], :niku, sourceFileInfo)
+      newReport(@val[1], @val[2], :niku, @sourceFileInfo[0])
       @property.set('numberFormat', RealFormat.new(['-', '', '', '.', 2]))
     })
     arg(1, 'file name', <<'EOT'
@@ -2646,6 +2721,8 @@ the project. All sub-scenarios of this scenario inherit the bookings of the
 tracking scenario and may not have any bookings of their own. The tracking
 scenario must also be specified to use time and status sheet reports.
 
+The tracking scenario must be defined after all scenario have been defined.
+
 The tracking scenario and all scenarios derived from it will be scheduled in
 projection mode. This means that the scheduler will only add bookings after
 the current date or the date specified by [[now]]. It is assumed that all
@@ -2852,6 +2929,7 @@ Declare one or more flag for later use. Flags can be used to mark tasks, resourc
 EOT
        )
 
+    pattern(%w( !iCalReport ))
     pattern(%w( !propertiesInclude ))
 
     pattern(%w( !limits ), lambda {
@@ -2902,6 +2980,7 @@ EOT
 
     pattern(%w( !report ))
     pattern(%w( !resource ))
+    pattern(%w( !tagfile ))
     pattern(%w( !shift ))
     pattern(%w( !statusSheet ))
     pattern(%w( !statusSheetReport ))
@@ -4172,6 +4251,12 @@ EOT
     pattern(%w( _scenario $ID $STRING ), lambda {
       # If this is the top-level scenario, we must delete the default scenario
       # first.
+      @project.scenarios.each do |scenario|
+        if scenario.get('projection')
+          error('scenario_after_tracking',
+                'Scenarios must be defined before a tracking scenario is set.')
+        end
+      end
       @project.scenarios.clearProperties if @property.nil?
       if @project.scenario(@val[1])
         error('scenario_exists',
@@ -4247,7 +4332,7 @@ EOT
       sa.project = @project
 
       if @val[1].nil?
-        intervals = [ Interval.new(@project['start'], @project['end']) ]
+        intervals = [ TimeInterval.new(@project['start'], @project['end']) ]
       else
         intervals = @val[1]
       end
@@ -4465,7 +4550,7 @@ EOT
       else
         fileName = "statusSheet#{@project.reports.length + 1}"
       end
-      report = newReport(@val[1], fileName, :statusSheet, sourceFileInfo)
+      report = newReport(@val[1], fileName, :statusSheet, @sourceFileInfo[0])
       report.set('scenarios', [ 0 ])
       # Show all tasks, sorted by id-up.
       report.set('hideTask', LogicalExpression.new(LogicalOperation.new(0)))
@@ -4734,6 +4819,54 @@ EOT
     arg(1, 'task ID', 'The ID of an already defined task.')
   end
 
+  def rule_tagfile
+    pattern(%w( !tagfileHeader !tagfileBody ), lambda {
+      @property = nil
+    })
+    doc('tagfile', <<'EOT'
+The tagfile report generates a file that maps properties to source file
+locations. This can be used by editors to quickly jump to a certain task or
+resource definition. Currently only the ctags format is supported that is used
+by editors like [http://www.vim.org|vim].
+EOT
+       )
+  end
+
+  def rule_tagfileHeader
+    pattern(%w( _tagfile !optionalID $STRING ), lambda {
+      report = newReport(@val[1], @val[2], :tagfile, @sourceFileInfo[0])
+
+      @property.set('formats', [ :ctags ])
+      # Include all tasks.
+      report.set('hideTask', LogicalExpression.new(LogicalOperation.new(0)))
+      report.set('sortTasks', [ [ 'seqno', true, -1 ] ])
+      # Include all resources.
+      report.set('hideResource',
+                  LogicalExpression.new(LogicalOperation.new(0)))
+      report.set('sortResources', [ [ 'seqno', true, -1 ] ])
+    })
+    arg(1, 'file name', <<'EOT'
+The name of the tagfile to generate. You can leave it empty and it will
+default to the commonly used name ''''tags''''.
+EOT
+       )
+  end
+
+  def rule_tagfileAttributes
+    optional
+    repeatable
+
+    pattern(%w( !hideresource ))
+    pattern(%w( !hidetask ))
+    pattern(%w( !rollupresource ))
+    pattern(%w( !rolluptask ))
+  end
+
+  def rule_tagfileBody
+    optionsRule('tagfileAttributes')
+  end
+
+
   def rule_task
     pattern(%w( !taskHeader !taskBody ), lambda {
       @property = @property.parent
@@ -5841,7 +5974,8 @@ EOT
   end
   def rule_tsReportHeader
     pattern(%w( _timesheetreport !optionalID $STRING ), lambda {
-      report = newReport(@val[1], @val[2], :timeSheet, sourceFileInfo)
+      report = newReport(@val[1], @val[2], :timeSheet, @sourceFileInfo[0])
+
       report.set('scenarios', [ 0 ])
       # Show all tasks, sorted by seqno-up.
       report.set('hideTask', LogicalExpression.new(LogicalOperation.new(0)))
@@ -6075,12 +6209,12 @@ EOT
                   "after the start date (#{@val[0]}).",
                   @sourceFileInfo[1])
           end
-          iv = Interval.new(@val[0], endSpec)
+          iv = TimeInterval.new(@val[0], endSpec)
         else
-          iv = Interval.new(@val[0], @val[0] + endSpec)
+          iv = TimeInterval.new(@val[0], @val[0] + endSpec)
         end
       else
-        iv = Interval.new(@val[0], @val[0].sameTimeNextDay)
+        iv = TimeInterval.new(@val[0], @val[0].sameTimeNextDay)
       end
       checkInterval(iv)
       iv
@@ -6111,9 +6245,9 @@ EOT
           error('start_before_end', "The end date (#{endSpec}) must be after " +
                 "the start date (#{@val[0]}).", @sourceFileInfo[1])
         end
-        iv = Interval.new(@val[0], endSpec)
+        iv = TimeInterval.new(@val[0], endSpec)
       else
-        iv = Interval.new(@val[0], @val[0] + endSpec)
+        iv = TimeInterval.new(@val[0], @val[0] + endSpec)
       end
       checkInterval(iv)
       iv

data/lib/taskjuggler/VimSyntax.rb

@@ -210,6 +210,24 @@ hi def link tjpnumber Number
 
 let b:current_syntax = "tjp"
 
+" Support running tj3 from within vim. Just type ':make your_project.tjp' to
+" activate it.
+set makeprg=tj3
+
+" Support browsing the man page by typing Shift-k while having the cursor over
+" any syntax keyword
+set keywordprg=tj3man
+
+" Remap Ctrl-] to show full ID of property defined in the current
+" line. This requires a current ctags file (generated by 'tagfile'
+" report') to be present in the directory where vim was started.
+map <C-]> :call ShowFullID()<CR>
+function! ShowFullID()
+  let linenumber = line(".")
+  let filename = bufname("%")
+  execute "!grep '".filename."\t".linenumber.";' tags|cut -f 1"
+endfunction
+
 augroup TaskJugglerSource
   " Remove all trailing white spaces from line ends when saving files
   " Note: This overwrites the s mark.

data/lib/taskjuggler/WorkingHours.rb

@@ -48,6 +48,9 @@ class TaskJuggler
         @startDate = wh.startDate
         @endDate = wh.endDate
         @slotDuration = wh.slotDuration
+        # Make sure the copied scoreboard has been created, so we can share it
+        # copy-on-write.
+        wh.onShift?(0)
         @scoreboard = wh.scoreboard
       else
         slotDuration = arg1
@@ -68,6 +71,14 @@ class TaskJuggler
       end
     end
 
+    # Since we want to share the scoreboard among instances with identical
+    # working hours, we need to prevent the scoreboard from being deep cloned.
+    # Calling the constructor with self in a re-defined deep_clone method will
+    # do just that.
+    def deep_clone
+      WorkingHours.new(self)
+    end
+
     # Return true of the given WorkingHours object +wh+ is identical to this
     # object.
     def ==(wh)
@@ -126,11 +137,16 @@ class TaskJuggler
       @days[dayOfWeek]
     end
 
-    # Return true if _date_ is within the defined working hours.
-    def onShift?(date)
+    # Return true if _arg_ is within the defined working hours. _arg_ can be a
+    # TjTime object or a global scoreboard index.
+    def onShift?(arg)
       initScoreboard unless @scoreboard
 
-      @scoreboard.get(date)
+      if arg.is_a?(TjTime)
+        @scoreboard.get(arg)
+      else
+        @scoreboard[arg]
+      end
     end
 
     # Return true only if all slots in the _interval_ are offhour slots.
@@ -209,7 +225,7 @@ class TaskJuggler
       end
 
       # Restore old time zone setting.
-      if @timezone
+      if @timezone && oldTimezone
         TjTime.setTimeZone(oldTimezone)
       end
     end

data/lib/taskjuggler/apps/Tj3.rb

@@ -39,8 +39,12 @@ class TaskJuggler
       @freeze = false
       # The cut-off date for the freeze
       @freezeDate = TjTime.new.align(3600)
+      # Should bookings be grouped by Task or by Resource (default).
+      @freezeByTask = false
       # Don't generate any reports.
       @noReports = false
+      # Treat warnings like errors or not.
+      @abortOnWarning = false
       # The directory where generated reports should be put in.
       @outputDir = ''
       # The file names of the time sheet files to check.
@@ -86,6 +90,11 @@ EOT
             error("Invalid freeze date: #{msg}")
           end
         end
+        @opts.on('--freezebytask',
+                 format('Group the bookings in the booking file generated ' +
+                        'during a freeze by task instead of by resource.')) do
+          @freezeByTask = true
+        end
         @opts.on('--check-time-sheet <tji-file>', String,
                 format("Check the given time sheet")) do |arg|
           @timeSheets << arg
@@ -108,6 +117,10 @@ EOT
                        'reports.')) do
          @noReports = true
         end
+        @opts.on('--abort-on-warnings',
+                 format('Abort program on warnings like we do on errors.')) do
+          @abortOnWarning = true
+        end
         @opts.on('-o', '--output-dir <directory>', String,
                 format('Directory the reports should go into')) do |arg|
           @outputDir = arg + '/'
@@ -128,6 +141,7 @@ EOT
         tj = TaskJuggler.new(true)
         tj.maxCpuCores = @maxCpuCores
         tj.warnTsDeltas = @warnTsDeltas
+        tj.messageHandler.abortOnWarning = @abortOnWarning
         keepParser = !@timeSheets.empty? || !@statusSheets.empty?
         return 1 unless tj.parse(files, keepParser)
 
@@ -147,7 +161,8 @@ EOT
         end
 
         # Check for freeze mode and generate the booking file if requested.
-        tj.freeze(@freezeDate) if @freeze
+        return 1 if @freeze && tj.freeze(@freezeDate, @freezeByTask) &&
+                    tj.errors > 0
 
         return 0 if @noReports
 

data/lib/taskjuggler/reports/GanttLine.rb

@@ -317,7 +317,7 @@ class TaskJuggler
     # resource int the chart. Depending on the resolution, the only periods with
     # a duration above the threshold are shown.
     def generateTimeOffZones
-      iv = Interval.new(@chart.start, @chart.end)
+      iv = TimeInterval.new(@chart.start, @chart.end)
       # Don't show any zones if the threshold for this scale is 0 or smaller.
       return if (minTimeOff = @chart.scale['minTimeOff']) <= 0