taskjuggler 0.2.1 → 0.2.2

data/lib/taskjuggler/TextParser/Scanner.rb

@@ -103,14 +103,6 @@ class TaskJuggler::TextParser
           if (@line = @stream.gets)
             # Update activity meter about every 1024 lines.
             @log.activity if (@stream.lineno & 0x3FF) == 0
-            # Check for DOS or Mac end of line signatures.
-            if @line[-1] == ?\r
-              # Mac: Convert CR into LF
-              @line[-1] = ?\n
-            elsif @line[-2] == ?\r
-              # DOS: Convert CR+LF into LF
-              @line = @line.chomp + "\n"
-            end
           else
             # We've reached the end of the current file.
             @scanner = nil
@@ -173,8 +165,13 @@ class TaskJuggler::TextParser
       def initialize(fileName, log)
         super(log)
         @fileName = fileName.dup.untaint
-        @stream = fileName == '.' ? $stdin : File.new(@fileName, 'r')
-        @log << "Parsing file #{@fileName} ..."
+        data = (fileName == '.' ? $stdin : File.new(@fileName, 'r')).read
+        begin
+          @stream = StringIO.new(data.forceUTF8Encoding)
+        rescue
+          error('fileEncoding', $!)
+        end
+        @log.msg { "Parsing file #{@fileName} ..." }
         @log.startProgressMeter("Reading file #{fileName}")
       end
 
@@ -190,8 +187,12 @@ class TaskJuggler::TextParser
 
       def initialize(buffer, log)
         super(log)
-        @stream = StringIO.new(buffer)
-        @log << "Parsing buffer #{buffer[0, 20]} ..."
+        begin
+          @stream = StringIO.new(buffer.forceUTF8Encoding)
+        rescue
+          error('bufferEncoding', $!)
+        end
+        #@log.msg { "Parsing buffer #{buffer[0, 20]} ..." }
       end
 
     end
@@ -286,8 +287,8 @@ class TaskJuggler::TextParser
         begin
           @fileStack = [ [ @cf = FileStreamHandle.new(@masterFile, @log),
                            nil, nil ] ]
-        rescue StandardError
-          error('open_file', "Cannot open file #{@masterFile}")
+        rescue IOError, SystemCallError
+          error('open_file', "Cannot open file #{@masterFile}: #{$!}")
         end
       end
       @masterPath = @cf.dirname + '/'
@@ -335,7 +336,7 @@ class TaskJuggler::TextParser
       begin
         @fileStack << [ (@cf = FileStreamHandle.new(includeFileName, @log)),
                         nil, block ]
-        @log << "Parsing file #{includeFileName}"
+        @log.msg { "Parsing file #{includeFileName}" }
       rescue StandardError
         error('bad_include', "Cannot open include file #{includeFileName}", sfi)
       end
@@ -384,7 +385,7 @@ class TaskJuggler::TextParser
         # completion. Close it and remove the corresponding entry from the
         # @fileStack.
         @finishLastFile = false
-        #@log << "Completed file #{@cf.fileName}"
+        #@log.msg { "Completed file #{@cf.fileName}" }
 
         # If we have a block to be executed on EOF, we call it now.
         onEof = @fileStack.last[2]
@@ -401,7 +402,7 @@ class TaskJuggler::TextParser
         else
           # Continue parsing the file that included the current file.
           @cf, tokenBuffer = @fileStack.last
-          @log << "Parsing file #{@cf.fileName} ..."
+          @log.msg { "Parsing file #{@cf.fileName} ..." }
           # If we have a left over token from previously processing this file,
           # return it now.
           if tokenBuffer
@@ -462,7 +463,7 @@ class TaskJuggler::TextParser
     # Return a token to retrieve it with the next nextToken() call again. Only 1
     # token can be returned before the next nextToken() call.
     def returnToken(token)
-      #@log << "-> Returning Token: [#{token[0]}][#{token[1]}]"
+      #@log.msg { "-> Returning Token: [#{token[0]}][#{token[1]}]" }
       unless @tokenBuffer.nil?
         $stderr.puts @tokenBuffer
         raise "Fatal Error: Cannot return more than 1 token in a row"

data/lib/taskjuggler/Tj3Config.rb

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

data/lib/taskjuggler/TjpSyntaxRules.rb

@@ -1526,8 +1526,12 @@ EOT
 
     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])
+      sc = @val[1]
+      unless @project.scenario(sc).get('active')
+        warning('ical_sc_disabled',
+                "Scenario #{sc} has been disabled")
+      end
+      @property.set('scenarios', [ @val[1] ])
     })
     doc('scenario.ical', <<'EOT'
 Id of the scenario that should be included in the report. By default, the
@@ -1768,6 +1772,73 @@ EOT
     singlePattern('!intervals')
   end
 
+  def rule_journalReportAttributes
+    pattern(%w( _journalattributes !journalReportAttributesList ), lambda {
+      @property.set('journalAttributes', @val[1])
+    })
+    doc('journalattributes', <<'EOT'
+A list that determines which of the journal attributes should be included in
+the journal report.
+EOT
+       )
+    allOrNothingListRule('journalReportAttributesList',
+                         { 'author' => 'Include the author if known',
+                           'date' => 'Include the date',
+                           'details' => 'Include the details',
+                           'flags' => 'Include the flags',
+                           'headline' => 'Include the headline',
+                           'property' => 'Include the task or resource name',
+                           'propertyid' => 'Include the property ID. ' +
+                                           'Requires \'property\'.',
+                           'summary' => 'Include the summary',
+                           'timesheet' => 'Include the timesheet information.' +
+                                          ' Requires \'property\'.'})
+  end
+
+  def rule_journalReportMode
+    pattern(%w( _journal ), lambda { :journal })
+    descr(<<'EOT'
+This is the regular journal. It contains all journal entries that are dated in
+the query interval. If a property is given, only entries of this property are
+included. Without a property context, all the project entries are included
+unless hidden by other attributes like [[hidejournalentry]].
+EOT
+       )
+    pattern(%w( _journal_sub ), lambda { :journal_sub })
+    descr(<<'EOT'
+This mode only yields entries if used in the context of a task. It contains
+all journal entries that are dated in the query interval for the task and all
+its sub tasks.
+EOT
+       )
+    pattern(%w( _status_down ), lambda { :status_down })
+    descr(<<'EOT'
+In this mode only the last entries before the report end date for each
+property and all its sub-properties are included. If there are multiple entries
+at the exact same date, then all these entries are included.
+EOT
+       )
+    pattern(%w( _status_up ), lambda { :status_up })
+    descr(<<'EOT'
+In this mode only the last entries before the report end date for each
+property are included. If there are multiple entries at the exact same date,
+then all these entries are included. If any of the parent properties has a
+more recent entry that is still before the report end date, no entries will be
+included.
+EOT
+       )
+    pattern(%w( _alerts_down ), lambda { :alerts_down })
+    descr(<<'EOT'
+In this mode only the last entries before the report end date for the context
+property and all its sub-properties is included. If there are multiple entries
+at the exact same date, then all these entries are included. In contrast to
+the ''''status_down'''' mode, only entries with an alert level above the
+default level, and only those with the highest overall alert level are
+included.
+EOT
+       )
+  end
+
   def rule_journalEntry
     pattern(%w( !journalEntryHeader !journalEntryBody ), lambda {
       @val[0]
@@ -1848,6 +1919,30 @@ The headline of the journal entry. It will be interpreted as
 EOT
        )
   end
+
+  def rule_journalSortCriteria
+    pattern(%w( !journalSortCriterium !moreJournalSortCriteria ), lambda {
+      [ @val[0] ] + (@val[1].nil? ? [] : @val[1])
+    })
+  end
+
+  def rule_journalSortCriterium
+    pattern(%w( $ABSOLUTE_ID ), lambda {
+      supported = []
+      JournalEntryList::SortingAttributes.each do |attr|
+        supported << "#{attr}.up"
+        supported << "#{attr}.down"
+      end
+      unless supported.include?(@val[0])
+        error('bad_journal_sort_criterium',
+              "Unsupported sorting criterium #{@val[0]}. Must be one of " +
+              "#{supported.join(', ')}.")
+      end
+      attr, direction = @val[0].split('.')
+      [ attr.intern, direction == 'up' ? 1 : -1 ]
+    })
+  end
+
   def rule_leafResourceId
     pattern(%w( !resourceId ), lambda {
       resource = @val[0]
@@ -2192,6 +2287,10 @@ EOT
     commaListRule('!taskDep')
   end
 
+  def rule_moreJournalSortCriteria
+    commaListRule('!journalSortCriterium')
+  end
+
   def rule_moreLeafResources
     commaListRule('!resourceLeafList')
   end
@@ -3058,7 +3157,11 @@ EOT
               "#{@val[1]} is not a list attribute. Only those can be purged.",
               @sourceFileInfo[1])
       end
-      @property.getAttribute(@val[1], @scenarioIdx).reset
+      if @property.attributeDefinition(@val[1]).scenarioSpecific
+        @property.getAttribute(@val[1], @scenarioIdx).reset
+      else
+        @property.getAttribute(@val[1]).reset
+      end
     })
     doc('purge', <<'EOT'
 List attributes, like regular attributes, can inherit their values from the
@@ -3134,20 +3237,10 @@ EOT
          )
 
     singlePattern('_alertmessages')
-    descr(<<'EOT'
-The headlines, the summary and the details of the message from the journal
-entries that caused the current alert level to be larger than the defaul level
-for this task or any of its sub tasks.
-EOT
-         )
+    descr('Deprecated. Please use ''''journal'''' instead')
 
     singlePattern('_alertsummaries')
-    descr(<<'EOT'
-The headlines and the summary message from the journal entries that caused the
-current alert level to be larger than the default for this task or any of its
-sub tasks.
-EOT
-         )
+    descr('Deprecated. Please use ''''journal'''' instead')
 
     singlePattern('_alerttrend')
     descr(<<'EOT'
@@ -3168,7 +3261,18 @@ EOT
          )
 
     singlePattern('_complete')
-    descr('The completion degree of a task')
+    descr(<<'EOT'
+The completion degree of a task. Unless a completion degree is manually
+provided, this is a computed value relative the [[now]] date of the project. A
+task that has ended before the now date is always 100% complete. A task that
+starts at or after the now date is always 0%. For [[effort]] based task the
+computation degree is the percentage of done effort of the overall effort. For
+other leaf task, the completion degree is the percentage of the already passed
+duration of the overall task duration. For container task, it's always the
+average of the direct sub tasks. If the sub tasks consist of a mixture of
+effort and non-effort tasks, the completion value is only of limited value.
+EOT
+         )
 
     pattern([ '_completed' ], lambda {
       'complete'
@@ -3287,30 +3391,22 @@ EOT
 
     singlePattern('_journal')
     descr(<<'EOT'
-The journal entries for the task or resource for the reported interval.
+The journal entries for the task or resource for the reported interval. The
+generated text can be customized with the [[journalmode]],
+[[journalattributes]], [[hidejournalentry]] and [[sortjournalentries]]. If
+used in queries without a property context, the journal for the complete
+project is generated.
 EOT
          )
 
     singlePattern('_journal_sub')
-    descr(<<'EOT'
-The journal entries for the task or resource and all its subtasks or resources
-for the reported interval.
-EOT
-         )
+    descr('Deprecated. Please use ''''journal'''' instead')
 
     singlePattern('_journalmessages')
-    descr(<<'EOT'
-The headlines, the summary and the details of the message from the journal
-entries that caused the current alert level for this task.
-EOT
-         )
+    descr('Deprecated. Please use ''''journal'''' instead')
 
     singlePattern('_journalsummaries')
-    descr(<<'EOT'
-The headlines and the summary message from the journal entries that caused the
-current alert level for this task.
-EOT
-         )
+    descr('Deprecated. Please use ''''journal'''' instead')
 
     singlePattern('_line')
     descr('The line number in the report')
@@ -3541,8 +3637,15 @@ EOT
     pattern(%w( !headline ))
     pattern(%w( !hidejournalentry ))
     pattern(%w( !hideresource ))
-
     pattern(%w( !hidetask ))
+    pattern(%w( !journalReportAttributes ))
+    pattern(%w( _journalmode !journalReportMode ), lambda {
+      @property.set('journalMode', @val[1])
+    })
+    doc('journalmode', <<'EOT'
+This attribute controls what journal entries are aggregated into the report.
+EOT
+       )
 
     pattern(%w( _left $STRING ), lambda {
       @property.set('left', newRichText(@val[1], @sourceFileInfo[1]))
@@ -3566,6 +3669,11 @@ EOT
       @property.set('numberFormat', @val[0])
     })
 
+    pattern(%w( _opennodes !nodeIdList ), lambda {
+      @property.set('openNodes', @val[1])
+    })
+    doc('opennodes', 'For internal use only!')
+
     pattern(%w( !reportPeriod ))
 
     pattern(%w( _prolog $STRING ), lambda {
@@ -3578,11 +3686,7 @@ EOT
        )
     also(%w( epilog footer header ))
 
-    pattern(%w( _opennodes !nodeIdList ), lambda {
-      @property.set('openNodes', @val[1])
-    })
-    doc('opennodes', 'For internal use only!')
-
+    pattern(%w( !purge ))
     pattern(%w( !report ))
 
     pattern(%w( _right $STRING ), lambda {
@@ -3622,6 +3726,7 @@ used.
 EOT
        )
 
+    pattern(%w( !sortJournalEntries ))
     pattern(%w( !sortResources ))
     pattern(%w( !sortTasks ))
 
@@ -4501,6 +4606,31 @@ EOT
          )
   end
 
+  def rule_sortJournalEntries
+    pattern(%w( _sortjournalentries !journalSortCriteria ), lambda {
+      @property.set('sortJournalEntries', @val[1])
+    })
+    doc('sortjournalentries', <<'EOT'
+Determines how the entries in a journal are sorted. Multiple criteria can be
+specified as a comma separated list. If one criteria is not sufficient to sort
+a group of journal entries, the next criteria will be used to sort the entries
+in this group.
+
+The following values are supported:
+* ''''date.down'''': Sort descending order by the date of the journal entry
+* ''''date.up'''': Sort ascending order by the date of the journal entry
+* ''''alert.down'''': Sort in descending order by the alert level of the
+journal entry
+* ''''alert.up'''': Sort in ascending order by the alert level of the
+journal entry
+ ''''property.down'''': Sort in descending order by the task or resource
+the journal entry is associated with
+* ''''property.up'''': Sort in ascending order by the task or resource the
+journal entry is associated with
+EOT
+        )
+  end
+
   def rule_sortResources
     pattern(%w( _sortresources !sortCriteria ), lambda {
       @property.set('sortResources', @val[1])
@@ -5287,17 +5417,21 @@ EOT
     also(%w( effort length ))
 
     pattern(%w( _effort !workingDuration ), lambda {
-      if @val[1] <= 0.0
-        error('effort_zero', "Effort value must be larger than 0",
+      if @val[1] <= 0
+        error('effort_zero', "Effort value must at least as large as the " +
+                             "timing resolution " +
+                             "(#{@project['scheduleGranularity'] / 60}min).",
               @sourceFileInfo[1], @property)
       end
       setDurationAttribute('effort', @val[1])
     })
     doc('effort', <<'EOT'
-Specifies the effort needed to complete the task. An effort of 4d can be done
-with 2 full-time resources in 2 days. The task will not finish before the
-resources have contributed the specified effort. So the duration of the task
-will depend on the availability of the resources.
+Specifies the effort needed to complete the task. An effort of ''''6d'''' (6
+resource-days) can be done with 2 full-time resources in 3 working days. The
+task will not finish before the allocated resources have contributed the
+specified effort. Hence the duration of the task will depend on the
+availability of the allocated resources. The specified effort value must be at
+least as large as the [[timingresolution]].
 
 WARNING: In almost all real world projects effort is not the product of time
 and resources. This is only true if the task can be partitioned without adding
@@ -5305,7 +5439,8 @@ any overhead. For more information about this read ''The Mythical Man-Month'' by
 Frederick P. Brooks, Jr.
 
 Tasks may not have subtasks if this attribute is used. Setting this attribute
-will reset the [[duration]] and [[length]] attributes.
+will reset the [[duration]] and [[length]] attributes. A task with an effort
+value cannot be a [[milestone]].
 EOT
        )
     example('Durations')

data/lib/taskjuggler/UTF8String.rb

@@ -112,4 +112,34 @@ class String
     gsub(/\n/, "\r\n")
   end
 
+  # Ensure the String is really UTF-8 encoded and newlines are only \n. If
+  # that's not possible, an Encoding::UndefinedConversionError is raised.
+  def forceUTF8Encoding
+    if RUBY_VERSION < '1.9.0'
+      # Ruby 1.8 really only support 7 bit ASCII well. Only do the line-end
+      # clean-up.
+      gsub(/\r\n/, "\n")
+    else
+      begin
+        # Ensure that the text has LF line ends and is UTF-8 encoded.
+        encode('UTF-8', :universal_newline => true)
+      rescue
+        # The encoding of the String is broken. Find the first broken line and
+        # report it.
+        lineCtr = 1
+        each_line do |line|
+          begin
+            line.encode('UTF-8')
+          rescue
+           line = line.encode('UTF-8', :invalid => :replace,
+                                       :undef => :replace, :replace => '<?>')
+            raise Encoding::UndefinedConversionError,
+                  "UTF-8 encoding error in line #{lineCtr}: #{line}"
+          end
+          lineCtr += 1
+        end
+      end
+    end
+  end
+
 end