taskjuggler 3.0.0 → 3.1.0

data/lib/taskjuggler/TextFormatter.rb

@@ -3,7 +3,7 @@
 #
 # = TextFormatter.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
 #               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify
@@ -50,7 +50,7 @@ class TaskJuggler
           # The indent buffer for the next line.
           indentBuf = "\n" + ' ' * @indentation
         else
-          # If we still have a indent buffer, we need to insert it first.
+          # If we still have an indent buffer, we need to insert it first.
           if indentBuf
             out += indentBuf
             linePos = indentBuf.delete("\n").length
@@ -103,6 +103,13 @@ class TaskJuggler
             # The word has ended.
             appendWord
             state = c == ' ' ? :betweenWords : :betweenWordsOrLines
+          elsif c == "\r"
+            # CR is used to start a new line but without starting a new
+            # paragraph.
+            appendWord
+            @indentBuf = "\n" + ' ' * @firstLineIndent
+            @beginOfLine = true
+            state = :betweenWords
           else
             # Add the character to the word buffer.
             @wordBuf << c

data/lib/taskjuggler/TextParser.rb

@@ -3,7 +3,7 @@
 #
 # = TextParser.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
 #               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify
@@ -178,7 +178,7 @@ class TaskJuggler
       @states = {}
       # Generate the parser states for all patterns of all rules.
       @rules.each_value do |rule|
-        rule.generateStates.each do |s|
+        rule.generateStates(@rules).each do |s|
           @states[[ s.rule, s.pattern, s.index ]] = s
         end
         checkRule(rule)
@@ -318,6 +318,16 @@ class TaskJuggler
             # stores the result of the pattern and keeps the State that we
             # need to return to in case we jump to other patterns from this
             # pattern.
+            if state.pattern.supportLevel == :deprecated
+              warning('deprecated_keyword',
+                      "The keyword '#{token[1]}' has been deprecated! " +
+                      "See the reference manual for details.")
+            end
+            if state.pattern.supportLevel == :removed
+              error('removed_keyword',
+                    "The keyword '#{token[1]}' is no longer supported! " +
+                    "See the reference manual for details.")
+            end
             @stack.push(TextParser::StackElement.new(state.pattern.function,
                                                      state))
           end
@@ -456,7 +466,7 @@ class TaskJuggler
 
     def getNextToken
       token = nextToken
-      #Log << "Token: [#{token[0]}][#{token[1]}]"
+      # puts "Token: [#{token[0]}][#{token[1]}]"
       if @blockedVariables[token[0]]
         error('unsupported_token',
               "The token #{token[1]} is not supported in this context.",

data/lib/taskjuggler/TextParser/MacroTable.rb

@@ -3,7 +3,7 @@
 #
 # = MacroTable.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
 #               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify

data/lib/taskjuggler/TextParser/Pattern.rb

@@ -3,7 +3,7 @@
 #
 # = Pattern.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
 #               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify
@@ -40,8 +40,8 @@ class TaskJuggler::TextParser
   # documentary information about the pattern.
   class Pattern
 
-    attr_reader :keyword, :doc, :seeAlso, :exampleFile, :exampleTag,
-                :tokens, :function
+    attr_reader :keyword, :doc, :supportLevel, :seeAlso, :exampleFile,
+                :exampleTag, :tokens, :function
 
     # Create a new Pattern object. _tokens_ must be an Array of String objects
     # that describe the Pattern. _function_ can be a reference to a method
@@ -54,6 +54,10 @@ class TaskJuggler::TextParser
       # A list of TokenDoc elements that describe the meaning of variable
       # tokens. The order of the tokens and entries in the Array must correlate.
       @args = []
+      # The syntax can evolve over time. The support level specifies which
+      # level of support this pattern hast. Possible values are :experimental,
+      # :beta, :supported, :deprecated, :removed
+      @supportLevel = :supported
       # A list of references to other patterns that are related to this pattern.
       @seeAlso = []
       # A reference to a file under test/TestSuite/Syntax/Correct and a tag
@@ -98,9 +102,31 @@ class TaskJuggler::TextParser
     # Generate the state machine states for the pattern. _rule_ is the Rule
     # that the pattern belongs to. A list of generated State objects will be
     # returned.
-    def generateStates(rule)
+    def generateStates(rule, rules)
+      # The last token of a pattern must always trigger a reduce operation.
+      # But the the last tokens of a pattern describe fully optional syntax,
+      # the last non-optional token and all following optional tokens must
+      # trigger a reduce operation. Here we find the index of the first token
+      # that must trigger a reduce operation.
+      firstReduceableToken = @tokens.length - 1
+      (@tokens.length - 2).downto(0).each do |i|
+        if optionalToken(i + 1, rules)
+          # If token i + 1 is optional, assume token i is the first one to
+          # trigger a reduce.
+          firstReduceableToken = i
+        else
+          # token i + 1 is not optional, we found the first token to trigger
+          # the reduce.
+          break
+        end
+      end
+
       states = []
-      @tokens.length.times { |i| states << State.new(rule, self, i) }
+      @tokens.length.times do |i|
+        states << (state = State.new(rule, self, i))
+        # Mark all states that are allowed to trigger a reduce operation.
+        state.noReduce = false if i >= firstReduceableToken
+      end
       states
     end
 
@@ -118,9 +144,6 @@ class TaskJuggler::TextParser
       # the next token of the pattern as well.
       loop do
         if destIndex >= @tokens.length
-          # Have we reached the end of the pattern? Such state always trigger
-          # a reduce operation.
-          sourceState.noReduce = false
           if sourceState.rule == destRule
             if destRule.repeatable
               # The transition leads us back to the start of the Rule. This
@@ -199,6 +222,15 @@ class TaskJuggler::TextParser
       @lastSyntaxToken = idx
     end
 
+    # Specify the support level of this pattern.
+    def setSupportLevel(level)
+      unless [ :experimental, :beta, :supported, :deprecated,
+               :removed ].include?(level)
+        raise "Fatal Error: Unknown support level #{level}"
+      end
+      @supportLevel = level
+    end
+
     # Set the references to related patterns.
     def setSeeAlso(also)
       @seeAlso = also
@@ -385,6 +417,18 @@ class TaskJuggler::TextParser
       argDocs << argDoc
     end
 
+    # Check if token with _index_ describes fully optional syntax elements.
+    def optionalToken(index, rules)
+      # If the token is a reference to another rule, we need to check if it's
+      # optional.
+      if @tokens[index][0] == :reference
+        return rules[@tokens[index][1]].optional?(rules)
+      end
+
+      # All other token types are never optional.
+      false
+    end
+
   end
 
 end

data/lib/taskjuggler/TextParser/Rule.rb

@@ -3,7 +3,7 @@
 #
 # = Rule.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
 #               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify
@@ -78,14 +78,14 @@ class TaskJuggler::TextParser
       end
     end
 
-    def generateStates
+    def generateStates(rules)
       # First, add an entry State for this rule. Entry states are never
       # reached by normal state transitions. They are only used as (re-)start
       # states.
       states = [ State.new(self) ]
 
       @patterns.each do |pattern|
-        states += pattern.generateStates(self)
+        states += pattern.generateStates(self, rules)
       end
       states
     end
@@ -95,8 +95,8 @@ class TaskJuggler::TextParser
     def addTransitionsToState(states, rules, stateStack, sourceState,
                               loopBack)
       @patterns.each do |pattern|
-        pattern.addTransitionsToState(states, rules, stateStack.dup, sourceState,
-                                      self, 0, loopBack)
+        pattern.addTransitionsToState(states, rules, stateStack.dup,
+                                      sourceState, self, 0, loopBack)
       end
     end
 
@@ -129,6 +129,12 @@ class TaskJuggler::TextParser
       @patterns[-1].setLastSyntaxToken(idx)
     end
 
+    # Specify the support level of the current pattern.
+    def setSupportLevel(level)
+      raise 'No pattern defined yet' if @patterns.empty?
+      @patterns[-1].setSupportLevel(level)
+    end
+
     # Add a reference to another rule for documentation purposes.
     def setSeeAlso(also)
       raise 'No pattern defined yet' if @patterns.empty?

data/lib/taskjuggler/TextParser/Scanner.rb

@@ -3,7 +3,7 @@
 #
 # = Scanner.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
 #               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify

data/lib/taskjuggler/TextParser/SourceFileInfo.rb

@@ -3,7 +3,7 @@
 #
 # = SourceFileInfo.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
 #               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify

data/lib/taskjuggler/TextParser/StackElement.rb

@@ -3,7 +3,7 @@
 #
 # = StackElement.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
 #               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify

data/lib/taskjuggler/TextParser/State.rb

@@ -3,7 +3,7 @@
 #
 # = State.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
 #               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify
@@ -93,7 +93,7 @@ class TaskJuggler::TextParser
       @transitions = {}
     end
 
-    # Completed the StateTransition list. We can only call this function after
+    # Complete the StateTransition list. We can only call this function after
     # all State objects for the syntax have been created. So we can't make
     # this part of the constructor.
     def addTransitions(states, rules)

data/lib/taskjuggler/TextParser/TokenDoc.rb

@@ -3,7 +3,7 @@
 #
 # = TokenDoc.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
 #               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify

data/lib/taskjuggler/TimeSheetReceiver.rb

@@ -3,7 +3,7 @@
 #
 # = TimeSheetReceiver.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
 #               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify

data/lib/taskjuggler/TimeSheetSender.rb

@@ -3,7 +3,7 @@
 #
 # = TimeSheetSender.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
 #               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify

data/lib/taskjuggler/TimeSheetSummary.rb

@@ -3,7 +3,7 @@
 #
 # = TimeSheetSummary.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
 #               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify

data/lib/taskjuggler/TimeSheets.rb

@@ -3,7 +3,7 @@
 #
 # = TimeSheets.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
 #               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify
@@ -292,8 +292,8 @@ class TaskJuggler
 
       if @resource['efficiency', scenarioIdx] > 0.0
         targetSlots = totalNetWorkingSlots
-        # This is acceptable rounding error when checking the total reported
-        # work.
+        # This is the acceptable rounding error when checking the total
+        # reported work.
         delta = 1
         if totalSlots < (targetSlots - delta)
           error('ts_work_too_low',
@@ -329,12 +329,10 @@ class TaskJuggler
     # report period. This value is not resource specific.
     def totalGrossWorkingSlots
       project = @resource.project
-      # Calculate the average working days per week (usually 5)
-      weeklyWorkingDays = project['yearlyworkingdays'] / 52.1428
       # Calculate the number of weeks in the report
       weeksToReport = (@interval.end - @interval.start) / (60 * 60 * 24 * 7)
 
-      daysToSlots(weeklyWorkingDays * weeksToReport)
+      daysToSlots(project.weeklyWorkingDays * weeksToReport)
     end
 
     # Compute the total number of actual working time slots of the

data/lib/taskjuggler/Tj3AppBase.rb

@@ -3,7 +3,7 @@
 #
 # = Tj3AppBase.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
 #               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify
@@ -13,10 +13,12 @@
 
 require 'rubygems'
 require 'optparse'
+require 'term/ansicolor'
 require 'taskjuggler/Tj3Config'
 require 'taskjuggler/RuntimeConfig'
 require 'taskjuggler/TjTime'
 require 'taskjuggler/TextFormatter'
+require 'taskjuggler/Log'
 
 class TaskJuggler
 
@@ -35,6 +37,11 @@ class TaskJuggler
       @configFile = nil
       @mandatoryArgs = ''
       @mininumRubyVersion = '1.9.2'
+
+      # If stdout is not a tty, we don't use ANSI escape sequences to color
+      # the terminal output. Additionally, we have the --no-color option to
+      # force colors off in case this does not work properly.
+      Term::ANSIColor.coloring = STDOUT.tty?
     end
 
     def processArguments(argv)
@@ -59,6 +66,16 @@ class TaskJuggler
       @opts.on('--silent',
                format("Don't show program and progress information")) do
         @silent = true
+        TaskJuggler::Log.silent = true
+      end
+      @opts.on('--no-color',
+               format(<<'EOT'
+Don't use ANSI contol sequences to color the terminal output. Colors should
+only be used when spooling to an ANSI terminal. In case the detection fails,
+you can this option to force colors to be off.
+EOT
+                     )) do
+        Term::ANSIColor::coloring = false
       end
       @opts.on('--debug', format('Enable Ruby debug mode')) do
         $DEBUG = true

data/lib/taskjuggler/Tj3Config.rb

@@ -3,7 +3,7 @@
 #
 # = Tj3Config.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
 #               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify
@@ -14,11 +14,11 @@
 require 'taskjuggler/UTF8String'
 require 'taskjuggler/AppConfig'
 
-AppConfig.version = '3.0.0'
+AppConfig.version = '3.1.0'
 AppConfig.packageName = 'taskjuggler'
-AppConfig.softwareName = 'TaskJuggler III'
+AppConfig.softwareName = 'TaskJuggler'
 AppConfig.packageInfo = 'A Project Management Software'
-AppConfig.copyright = [ (2006..2011).to_a ]
+AppConfig.copyright = [ (2006..2012).to_a ]
 AppConfig.authors = [ 'Chris Schlaeger <chris@linux.com>' ]
 AppConfig.contact = 'http://www.taskjuggler.org'
 AppConfig.license = <<'EOT'

data/lib/taskjuggler/Tj3SheetAppBase.rb

@@ -3,7 +3,7 @@
 #
 # = Tj3SheetAppBase.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
 #               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify