taskjuggler 0.0.7 → 0.0.8

data/lib/reports/Navigator.rb

@@ -198,7 +198,7 @@ class TaskJuggler
     # _url2_.
     def normalizeURL(url1, url2)
       cut = 0
-      0.upto(url1.length - 1) do |i|
+      url1.length.times do |i|
         return url1[cut, url1.length - cut] if url1[i] != url2[i]
         cut = i + 1 if url1[i] == ?/
       end

data/lib/reports/Report.rb

@@ -141,7 +141,7 @@ class TaskJuggler
         cssFileName = (auxSrcDir ? auxSrcDir + '/tjreport.css' : '')
         # Raise an error if we haven't found the data directory
         if auxSrcDir.nil? || !File.exists?(cssFileName)
-          dataDirError(cssFileName)
+          dataDirError(cssFileName, AppConfig.dataSearchDirs('data/css'))
         end
         cssFile = IO.read(cssFileName)
         if cssFile.empty?
@@ -214,35 +214,6 @@ EOT
       # CSV format can only handle the first element.
       return nil unless (csv = @content.to_csv)
 
-      # Expand nested tables into the outer table.
-      columnIdx = 0
-      while columnIdx < csv[0].length do
-        if csv[0][columnIdx].is_a?(Array)
-          # We've found a nested table.
-          nestedTable = csv[0][columnIdx]
-          # The nested table must have exactly as many lines as the outer table.
-          if csv.length != nestedTable.length
-            raise "Table size mismatch"
-          end
-          # Insert the nested table into the lines of the outer table.
-          csv.each do |line|
-            lineIdx = csv.index(line)
-            if lineIdx == 0
-              # The header cell can be reused.
-              line[columnIdx] = nestedTable[lineIdx]
-            else
-              # For normal lines we have no cells for the table. Just inject
-              # them.
-              line.insert(columnIdx, nestedTable[lineIdx])
-            end
-            # Make sure there are no more Arrays nested into the line.
-            line.flatten!
-          end
-        else
-          columnIdx += 1
-        end
-      end
-
       # Use the CSVFile class to write the Array of Arrays to a colon
       # separated file. Write to $stdout if the filename was set to '.'.
       begin
@@ -300,7 +271,9 @@ EOT
       # Find the data directory that came with the TaskJuggler installation.
       auxSrcDir = AppConfig.dataDirs("data/#{dirName}")[0].untaint
       # Raise an error if we haven't found the data directory
-      dataDirError(dirName) if auxSrcDir.nil? || !File.exists?(auxSrcDir)
+      if auxSrcDir.nil? || !File.exists?(auxSrcDir)
+        dataDirError(dirName, AppConfig.dataSearchDirs("data/#{dirName}"))
+      end
       # Don't copy directory if all files are up-to-date.
       return if directoryUpToDate?(auxSrcDir, auxDstDir + dirName)
 
@@ -322,13 +295,16 @@ EOT
       true
     end
 
-    def dataDirError(dirName)
+    def dataDirError(dirName, dirs)
       error('data_dir_error', <<"EOT"
 Cannot find the #{dirName} directory. This is usually the result of an
 improper TaskJuggler installation. If you know the directory, you can use the
 TASKJUGGLER_DATA_PATH environment variable to specify the location.  The
 variable should be set to the path without the /data at the end. Multiple
-directories must be separated by colons.
+directories must be separated by colons. The following directories have been
+tried:
+
+#{dirs.join("\n")}
 EOT
            )
     end

data/lib/reports/ReportBase.rb

@@ -96,7 +96,6 @@ class TaskJuggler
           delete = true
           a('scenarios').each do |scenarioIdx|
             if task.hasResourceAllocated?(scenarioIdx, iv, resource)
-            #if resource.allocated?(scenarioIdx, iv, task)
               delete = false
               break;
             end

data/lib/reports/ReportTable.rb

@@ -131,16 +131,27 @@ class TaskJuggler
 
     # Convert the intermediate representation into an Array of Arrays. _csv_ is
     # the destination Array of Arrays. It may contain columns already.
-    def to_csv(csv = nil)
-      csv = [ [ ] ] unless csv
-      @columns.each { |col| col.to_csv(csv) }
+    def to_csv(csv = [[ ]], startColumn = 0)
+      # Generate the header line.
+      columnIdx = startColumn
+      @columns.each do |col|
+        columnIdx += col.to_csv(csv, columnIdx)
+      end
 
-      @lines.each do |line|
-        # Insert a new Array for each line.
-        csv << []
-        line.to_csv(csv)
+      if @embedded
+        columnIdx - startColumn
+      else
+        # Content of embedded tables is inserted when generating the
+        # respective Line.
+        lineIdx = 1
+        @lines.each do |line|
+          # Insert a new Array for each line.
+          csv[lineIdx] = []
+          line.to_csv(csv, startColumn, lineIdx)
+          lineIdx += 1
+        end
+        csv
       end
-      csv
     end
 
   private

data/lib/reports/ReportTableCell.rb

@@ -35,6 +35,7 @@ class TaskJuggler
       @line = line
       @line.addCell(self) if line
 
+      # Specifies whether this is a header cell or not.
       @headerCell = headerCell
       # A copy of a Query object that is needed to access project data via the
       # query function.
@@ -49,6 +50,7 @@ class TaskJuggler
       @showTooltipHint = true
       # The original data of the cell content (optional, nil if not provided)
       @data = nil
+      # Determines the background color of the cell.
       @category = nil
       @hidden = false
       # How to horizontally align the cell
@@ -139,35 +141,43 @@ class TaskJuggler
     end
 
     # Add the text content of the cell to an Array of Arrays form of the table.
-    def to_csv(csv)
+    def to_csv(csv, columnIdx, lineIdx)
       # We only support left indentation in CSV files as the spaces for right
       # indentation will be disregarded by most applications.
       indent = @indent && @alignment == :left ? '  ' * @indent : ''
-      cell =
-        if @special
-          @special.to_csv
-          indent = nil
-        elsif @data && @data.is_a?(String)
-          @data
-        elsif @text
-          if @text.respond_to?('functionHandler')
-            @text.setQuery(@query)
-          end
-          str = @text.to_s
-          # Remove any trailing line breaks. These don't really make much
-          # sense in CSV files.
-          while str[-1] == ?\n
-            str.chomp!
+      columns = 1
+      if @special
+        # This is for nested tables. They will be inserted as whole columns
+        # in the existing table.
+        csv[lineIdx][columnIdx] = nil
+        columns = @special.to_csv(csv, columnIdx)
+      else
+        cell =
+          if @data && @data.is_a?(String)
+            @data
+          elsif @text
+            if @text.respond_to?('functionHandler')
+              @text.setQuery(@query)
+            end
+            str = @text.to_s
+            # Remove any trailing line breaks. These don't really make much
+            # sense in CSV files.
+            while str[-1] == ?\n
+              str.chomp!
+            end
+            str
           end
-          str
-        end
 
-      # Try to convert numbers and other types to their native Ruby type if
-      # they are supported by CSVFile.
-      native = CSVFile.strToNative(cell)
+        # Try to convert numbers and other types to their native Ruby type if
+        # they are supported by CSVFile.
+        native = CSVFile.strToNative(cell)
 
-      # Only for String objects, we add the indentation.
-      csv[-1] << (native.is_a?(String) ? indent + native : native)
+        # Only for String objects, we add the indentation.
+        csv[lineIdx][columnIdx] = (native.is_a?(String) ? indent + native :
+                                                          native)
+      end
+
+      return columns
     end
 
     private
@@ -260,10 +270,11 @@ class TaskJuggler
 
       shortText, singleLine = shortVersion(textAsString)
 
-      if (@line && @line.table.equiLines && (!singleLine || @width )) ||
-          !@category
+      if (@line && @line.table.equiLines && (!singleLine || @width )) &&
+          !@headerCell
         # The cell is size-limited. We only put a shortened plain-text version
         # in the cell and provide the full content via a tooltip.
+        # Header cells are never shortened.
         tooltip = @text if shortText != textAsString
         td << XMLText.new(shortText)
       else
@@ -322,5 +333,30 @@ class TaskJuggler
 
   end
 
+  # This class is used to model cells that are just placeholders for a line of
+  # an embedded ReportTable.
+  class PlaceHolderCell
+
+    # Create a new placeholder cell. _line_ is the line that this cell belongs
+    # to. _embeddedLine_ is the ReportTableLine that is embedded in this cell.
+    def initialize(line, embeddedLine)
+      @line = line
+      @line.addCell(self) if line
+      @embeddedLine = embeddedLine
+    end
+
+    # Add the current cell to the _csv_ CSV Arrays. _columnIdx_ is the start
+    # column in the _csv_. _lineIdx_ is the index of the current line. The
+    # return value is the number of added cells.
+    def to_csv(csv, columnIdx, lineIdx)
+      @embeddedLine.to_csv(csv, columnIdx, lineIdx)
+    end
+
+    def to_html
+      nil
+    end
+
+  end
+
 end
 

data/lib/reports/ReportTableColumn.rb

@@ -71,9 +71,9 @@ class TaskJuggler
     # Put the abstract representation into an Array. _csv_ is an Array of Arrays
     # of Strings. We have an Array with Strings for every cell. The outer Array
     # holds the Arrays representing the lines.
-    def to_csv(csv)
+    def to_csv(csv, startColumn)
       # For CSV reports we can only include the first header line.
-      @cell1.to_csv(csv)
+      @cell1.to_csv(csv, startColumn, 0)
     end
 
   end

data/lib/reports/ReportTableLine.rb

@@ -83,10 +83,12 @@ class TaskJuggler
 
     # Convert the intermediate format into an Array of values. One entry for
     # every column cell of this line.
-    def to_csv(csv)
+    def to_csv(csv, startColumn, lineIdx)
+      columnIdx = startColumn
       @cells.each do |cell|
-        cell.to_csv(csv)
+        columnIdx += cell.to_csv(csv, columnIdx, lineIdx)
       end
+      columnIdx - startColumn
     end
 
   end

data/lib/reports/TableReport.rb

@@ -581,6 +581,7 @@ class TaskJuggler
       tcLine = ReportTableLine.new(columnDef.column.cell1.special,
                                    line.property, line.scopeLine)
 
+      PlaceHolderCell.new(line, tcLine)
       # Depending on the property type we use different generator functions.
       if property.is_a?(Task)
         genCalChartTaskCell(query, tcLine, columnDef, start, sameTimeNextFunc)

data/lib/taskjuggler3.rb

@@ -151,7 +151,6 @@ def main
   exit 0 if @noReports
 
   exit 1 if !tj.generateReports(@outputDir) || tj.errors > 0
-
 end
 
 main()

data/manual/Installation

@@ -21,8 +21,12 @@ have the minimum required version installed.
 runtime environment to run it. This can be downloaded from
 [http://www.ruby-lang.org/en/downloads/ here].  Most Linux
 distributions usually have Ruby already included. So does MacOS X
-Leopard. For Windows, there is a one-click installer available.
-TaskJuggler currently needs at least Ruby version 1.8.6.
+Leopard. For Windows, there is a one-click installer available. The
+recommended Ruby version to make full use of TaskJuggler is 1.9.2.
+Ruby 1.9.1 contains some bugs that prevent the multi-core support to
+work. For users that are not interested in multi-core support, the web
+server,  the time sheet infrastructure and daemon Ruby 1.8.7 is still
+ok to use.
 
 * '''RubyGems:''' If it did not come with your OS or the Ruby
 installation, see [http://docs.rubygems.org here] how to get and
@@ -45,7 +49,7 @@ or command window:
   gem install taskjuggler
 
 This will download and install the latest version from the
-[http://gemcutter.org/ Gemcutter] site.
+[http://rubygems.org/gems/taskjuggler RubyGems.org] site.
 
 ==== The manual way ====
 

data/manual/Intro

@@ -34,11 +34,11 @@ will become a companion you don't want to miss anymore.
 === About TaskJuggler III ===
 
 TaskJuggler III is the completely re-implemented version of the TaskJuggler
-2.x series. It is currently still in the development stage. It
-already is mostly stable and feature complete, but not yet recommended
-for any serious work. The code base is still in active development
-and the quality and reliability may change daily. You are welcome to try
-it and play with it, but expect it to fail.
+2.x series. We have not yet released a stable version. It already is
+mostly stable and each official release is installed by more than a
+1000 users.  The code base is still in active development and the
+quality and reliability may change daily. You are welcome to try it
+and play with it, but be sure to independently check all results.
 
 TaskJuggler is a commandline tool that you use from a
 [http://en.wikipedia.org/wiki/Shell_(computing) shell]. This does not
@@ -84,22 +84,24 @@ License].
 
 === Features and Highlights ===
 
-* Manages tasks, resources and costs in one package
+* Manages tasks, resources, costs and revenue in one package
 * Automatic resource leveling and tasks conflict resolution
 * Flexible working hours and vacation handling
 * Multiple timezone support
 * Support for shift working
 * Project tracking and status reporting
+* Server based time sheet system for status and actual collection
 * Unlimited number of scenarios (baselines) of same project for what-if
 analysis
 * CSV data export for exchange with popular office software
+* Support for profit/loss analysis
+* Built-in web server for dynamically generated reports
 * Project breakdown and management team support
 * Powerful and flexible filtering functions to provide the right
 amount of detail to the right audience
-* Tasks may have initial costs, finishing costs and run rates
-* Resources may have running costs
-* Support for profit/loss analysis
-* Powerful project description syntax with macro support
+* Project description syntax with macro support
+* Detailed reference manual
+* Support for project management teams and revision control
 
 === TaskJuggler on the Web ===
 

data/manual/The_TaskJuggler_Syntax

@@ -110,8 +110,8 @@ provided in the project header.
 * ''''now'''' The current date. If the user does not provide a date
 with the [[now]] keyword, the moment of the processing of the file
 will be inserted. Keep in mind that this will change every time you
-process your project. 
-* ''''today'''' Similar to ''''now'''' but formatted according to
-the [[timeformat]] when the [[now]] attribute was used. The current
-setting of [[timeformat]] has no impact on the expansion of the macro.
+process your project.  The current setting of [[timeformat]] has no
+impact on the expansion of the macro.
+* ''''today'''' Identical to ''''now'''' but formatted according to
+the [[timeformat]] setting of the current context.
 

data/test/TestSuite/CSV-Reports/celltext-Reference.csv

@@ -1,14 +1,14 @@
-WBS;Name
-1;Plan Work (plan)
-1.1;  Plan A (plan.plan_a)
-1.2;  Plan B (plan.plan_b)
-1.3;  Plan C (plan.plan_c)
-2;Execute Work (execute)
-2.1;  Step 1 (execute.ex1)
-2.2;  Step 2 (execute.ex2)
-2.2.1;    Step 2.1 (execute.ex2.ex2_1)
-2.2.2;    Step 2.2 (execute.ex2.ex2_2)
-2.3;  Milestone 1 (execute.ms1)
-2.4;  Step 3 (execute.ex3)
-2.5;  Step 4 (execute.ex4)
-3;Check Work (check)
+"WBS";"Name"
+1;"Plan Work (plan)"
+1.1;"  Plan A (plan.plan_a)"
+1.2;"  Plan B (plan.plan_b)"
+1.3;"  Plan C (plan.plan_c)"
+2;"Execute Work (execute)"
+2.1;"  Step 1 (execute.ex1)"
+2.2;"  Step 2 (execute.ex2)"
+"2.2.1";"    Step 2.1 (execute.ex2.ex2_1)"
+"2.2.2";"    Step 2.2 (execute.ex2.ex2_2)"
+2.4;"  Step 3 (execute.ex3)"
+2.5;"  Step 4 (execute.ex4)"
+2.3;"  Milestone 1 (execute.ms1)"
+3;"Check Work (check)"

data/test/TestSuite/CSV-Reports/genrefs

@@ -2,5 +2,5 @@
 
 for f in *.tjp ; do
   basename=`echo $f | sed 's/.tjp//g'`
-  tj3 $f > $basename-Reference.csv
+  tj3 --silent $f > $basename-Reference.csv
 done

data/test/TestSuite/CSV-Reports/resourcereport-Reference.csv

@@ -1,4 +1,4 @@
-WBS;Name;Effort;2007-12-10-00:00:00;2007-12-17-00:00:00;2007-12-24-00:00:00;2007-12-31-00:00:00;2008-01-07-00:00:00;2008-01-14-00:00:00;2008-01-21-00:00:00;2008-01-28-00:00:00;2008-02-04-00:00:00;2008-02-11-00:00:00;2008-02-18-00:00:00;2008-02-25-00:00:00;2008-03-03-00:00:00;2008-03-10-00:00:00
-1;Jill;42.5;"";5.0;2.5;5.0;5.0;5.0;5.0;5.0;5.0;5.0;"";"";"";""
-2;Joe;14.0;"";5.0;5.0;"";2.0;"";"";"";2.0;"";"";"";"";""
-3;Jack;17.0;"";"";"";"";3.0;5.0;4.0;"";5.0;"";"";"";"";""
+"WBS";"Name";"Effort";"2007-12-03-00:00:00";"2007-12-10-00:00:00";"2007-12-17-00:00:00";"2007-12-24-00:00:00";"2007-12-31-00:00:00";"2008-01-07-00:00:00";"2008-01-14-00:00:00";"2008-01-21-00:00:00";"2008-01-28-00:00:00";"2008-02-04-00:00:00";"2008-02-11-00:00:00";"2008-02-18-00:00:00"
+3;"Jack";17.0;"";"";"";"";"";3.0;5.0;4.0;"";5.0;"";""
+1;"Jill";42.5;"";"";5.0;2.5;5.0;5.0;5.0;5.0;5.0;5.0;5.0;""
+2;"Joe";14.0;"";"";5.0;5.0;"";2.0;"";"";"";2.0;"";""

data/test/TestSuite/CSV-Reports/resourcereport_with_tasks-Reference.csv

@@ -1,22 +1,22 @@
-WBS;Name;Effort;2007-12-10-00:00:00;2007-12-17-00:00:00;2007-12-24-00:00:00;2007-12-31-00:00:00;2008-01-07-00:00:00;2008-01-14-00:00:00;2008-01-21-00:00:00;2008-01-28-00:00:00;2008-02-04-00:00:00;2008-02-11-00:00:00;2008-02-18-00:00:00;2008-02-25-00:00:00;2008-03-03-00:00:00;2008-03-10-00:00:00
-1;Jill;42.5;"";5.0;2.5;5.0;5.0;5.0;5.0;5.0;5.0;5.0;"";"";"";""
-    1;  Plan Work;12.5;"";5.0;2.5;5.0;"";"";"";"";"";"";"";"";"";""
-    1.2;    Plan B;7.5;"";5.0;2.5;"";"";"";"";"";"";"";"";"";"";""
-    1.3;    Plan C;5.0;"";"";"";5.0;"";"";"";"";"";"";"";"";"";""
-    2;  Execute Work;25.0;"";"";"";"";5.0;5.0;5.0;5.0;5.0;"";"";"";"";""
-    2.1;    Step 1;20.0;"";"";"";"";5.0;5.0;5.0;5.0;"";"";"";"";"";""
-    2.2;    Step 2;5.0;"";"";"";"";"";"";"";"";5.0;"";"";"";"";""
-    2.2.2;      Step 2.2;5.0;"";"";"";"";"";"";"";"";5.0;"";"";"";"";""
-    3;  Check Work;5.0;"";"";"";"";"";"";"";"";"";5.0;"";"";"";""
-2;Joe;14.0;"";5.0;5.0;"";2.0;"";"";"";2.0;"";"";"";"";""
-    1;  Plan Work;10.0;"";5.0;5.0;"";"";"";"";"";"";"";"";"";"";""
-    1.1;    Plan A;10.0;"";5.0;5.0;"";"";"";"";"";"";"";"";"";"";""
-    2;  Execute Work;4.0;"";"";"";"";2.0;"";"";"";2.0;"";"";"";"";""
-    2.2;    Step 2;2.0;"";"";"";"";2.0;"";"";"";"";"";"";"";"";""
-    2.2.1;      Step 2.1;2.0;"";"";"";"";2.0;"";"";"";"";"";"";"";"";""
-    2.5;    Step 4;2.0;"";"";"";"";"";"";"";"";2.0;"";"";"";"";""
-3;Jack;17.0;"";"";"";"";3.0;5.0;4.0;"";5.0;"";"";"";"";""
-    2;  Execute Work;17.0;"";"";"";"";3.0;5.0;4.0;"";5.0;"";"";"";"";""
-    2.2;    Step 2;5.0;"";"";"";"";"";"";"";"";5.0;"";"";"";"";""
-    2.2.2;      Step 2.2;5.0;"";"";"";"";"";"";"";"";5.0;"";"";"";"";""
-    2.4;    Step 3;12.0;"";"";"";"";3.0;5.0;4.0;"";"";"";"";"";"";""
+"WBS";"Name";"Effort";"2007-12-03-00:00:00";"2007-12-10-00:00:00";"2007-12-17-00:00:00";"2007-12-24-00:00:00";"2007-12-31-00:00:00";"2008-01-07-00:00:00";"2008-01-14-00:00:00";"2008-01-21-00:00:00";"2008-01-28-00:00:00";"2008-02-04-00:00:00";"2008-02-11-00:00:00";"2008-02-18-00:00:00"
+3;"Jack";17.0;"";"";"";"";"";3.0;5.0;4.0;"";5.0;"";""
+2;"  Execute Work";17.0;"";"";"";"";"";3.0;5.0;4.0;"";5.0;"";""
+2.2;"    Step 2";5.0;"";"";"";"";"";"";"";"";"";5.0;"";""
+"    2.2.2";"      Step 2.2";5.0;"";"";"";"";"";"";"";"";"";5.0;"";""
+2.4;"    Step 3";12.0;"";"";"";"";"";3.0;5.0;4.0;"";"";"";""
+1;"Jill";42.5;"";"";5.0;2.5;5.0;5.0;5.0;5.0;5.0;5.0;5.0;""
+1;"  Plan Work";12.5;"";"";5.0;2.5;5.0;"";"";"";"";"";"";""
+1.2;"    Plan B";7.5;"";"";5.0;2.5;"";"";"";"";"";"";"";""
+1.3;"    Plan C";5.0;"";"";"";"";5.0;"";"";"";"";"";"";""
+2;"  Execute Work";25.0;"";"";"";"";"";5.0;5.0;5.0;5.0;5.0;"";""
+2.1;"    Step 1";20.0;"";"";"";"";"";5.0;5.0;5.0;5.0;"";"";""
+2.2;"    Step 2";5.0;"";"";"";"";"";"";"";"";"";5.0;"";""
+"    2.2.2";"      Step 2.2";5.0;"";"";"";"";"";"";"";"";"";5.0;"";""
+3;"  Check Work";5.0;"";"";"";"";"";"";"";"";"";"";5.0;""
+2;"Joe";14.0;"";"";5.0;5.0;"";2.0;"";"";"";2.0;"";""
+1;"  Plan Work";10.0;"";"";5.0;5.0;"";"";"";"";"";"";"";""
+1.1;"    Plan A";10.0;"";"";5.0;5.0;"";"";"";"";"";"";"";""
+2;"  Execute Work";4.0;"";"";"";"";"";2.0;"";"";"";2.0;"";""
+2.2;"    Step 2";2.0;"";"";"";"";"";2.0;"";"";"";"";"";""
+"    2.2.1";"      Step 2.1";2.0;"";"";"";"";"";2.0;"";"";"";"";"";""
+2.5;"    Step 4";2.0;"";"";"";"";"";"";"";"";"";2.0;"";""