taskjuggler 0.0.8 → 0.0.9

data/lib/reports/TimeSheetReport.rb

@@ -3,7 +3,8 @@
 #
 # = TimeSheetReport.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of version 2 of the GNU General Public License as
@@ -198,7 +199,8 @@ EOT
       taskList = PropertyList.new(@project.tasks)
       taskList.setSorting(@report.get('sortTasks'))
       taskList = filterTaskList(taskList, nil, @report.get('hideTask'),
-                                @report.get('rollupTask'), @report.get('openNodes'))
+                                @report.get('rollupTask'),
+                                @report.get('openNodes'))
 
       records = []
       resourceList.each do |resource|

data/lib/reports/TjpExportRE.rb

@@ -3,7 +3,8 @@
 #
 # = TjpExportRE.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of version 2 of the GNU General Public License as
@@ -341,7 +342,8 @@ class TaskJuggler
           @bookings[scenarioIdx] = {}
           @resourceList.each do |resource|
             # Get the bookings for this resource hashed by task.
-            bookings = resource.getBookings(scenarioIdx)
+            bookings = resource.getBookings(scenarioIdx,
+                                            Interval.new(a('start'), a('end')))
             next if bookings.nil?
 
             # Now convert/add them to a tripple-stage hash by scenarioIdx, task

data/lib/{taskjuggler3.rb → tj3.rb}

@@ -1,9 +1,10 @@
 #!/usr/bin/env ruby -w
 # encoding: UTF-8
 #
-# = taskjuggler3.rb -- The TaskJuggler III Project Management Software
+# = tj3.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of version 2 of the GNU General Public License as
@@ -16,15 +17,15 @@ require 'Tj3Config'
 require 'TaskJuggler'
 
 # Name of the application suite
-AppConfig.appName = 'taskjuggler3'
+AppConfig.appName = 'tj3'
 
 def processArguments(argv)
   opts = OptionParser.new
 
   opts.banner = "#{AppConfig.softwareName} v#{AppConfig.version} - " +
                 "#{AppConfig.packageInfo}\n\n" +
-                "Copyright (c) #{AppConfig.copyright.join(', ')}" +
-                " by #{AppConfig.authors.join(', ')}\n\n" +
+                "Copyright (c) #{AppConfig.copyright.join(', ')}\n" +
+                "              by #{AppConfig.authors.join(', ')}\n\n" +
                 "#{AppConfig.license}\n" +
                 "For more info about #{AppConfig.softwareName} see " +
                 "#{AppConfig.contact}\n\n" +

data/lib/tj3client.rb

@@ -3,7 +3,8 @@
 #
 # = tj3client.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of version 2 of the GNU General Public License as
@@ -43,6 +44,8 @@ class TaskJuggler
       # Determines whether report IDs are fix IDs or regular expressions that
       # match a set of reports.
       @regExpMode = false
+      # List of requested output formats for reports.
+      @formats = nil
 
       @mandatoryArgs = '<command> [arg1 arg2 ...]'
 
@@ -131,10 +134,19 @@ EOT
           @uriFile = arg
         end
         @opts.on('-r', '--regexp',
-                format('The report IDs are not fixed but regular expressions ' +
-                       'that match a set of reports')) do |arg|
+                 format('The report IDs are not fixed but regular expressions ' +
+                        'that match a set of reports')) do |arg|
           @regExpMode = true
         end
+        @opts.on('--format [FORMAT]', [ :csv, :html, :niku, :tjp ],
+                 format('Request the report to be generated in the specified' +
+                        'format. Use multiple options to request multiple ' +
+                        'formats. Supported formats are csv, html, niku and ' +
+                        'tjp. By default, the formats specified in the report ' +
+                        'definition are used.')) do |arg|
+          @formats = [] unless @formats
+          @formats << arg
+        end
       end
     end
 
@@ -249,16 +261,9 @@ EOT
         callDaemon(:stop, [])
         info('Daemon terminated')
       when 'add'
-        # Ask the daemon to create a new ProjectServer process and return a
-        # DRbObject to access it.
-        connectToProjectServer
-        # Ask the server to load the files in _args_ into the ProjectServer.
-        begin
-          res = @projectServer.loadProject(@ps_authKey, [ Dir.getwd, *args ])
-        rescue
-          error("Loading of project failed: #{$!}")
-        end
-        disconnectProjectServer
+        res = callDaemon(:addProject, [ Dir.getwd, args,
+                                        $stdout, $stderr, $stdin, @silent ])
+        info("Project(s) #{args.join(', ')} added")
         return res ? 0 : 1
       when 'remove'
         args.each do |arg|
@@ -289,7 +294,7 @@ EOT
         unless failed
           reportIds.each do |reportId|
             unless @reportServer.generateReport(@rs_authKey, reportId,
-                                                @regExpMode, nil)
+                                                @regExpMode, @formats, nil)
               failed = true
               break
             end
@@ -350,28 +355,6 @@ EOT
       0
     end
 
-    def connectToProjectServer
-      @ps_uri, @ps_authKey = callDaemon(:addProject, [])
-      begin
-        @projectServer = DRbObject.new(nil, @ps_uri)
-      rescue
-        error("Can't get ProjectServer object: #{$!}")
-      end
-      begin
-        @projectServer.connect(@ps_authKey, $stdout, $stderr, $stdin, @silent)
-      rescue
-        error("Can't connect IO: #{$!}")
-      end
-    end
-
-    def disconnectProjectServer
-      begin
-        @projectServer.disconnect(@ps_authKey)
-      rescue
-        error("Can't disconnect IO: #{$!}")
-      end
-    end
-
     def connectToReportServer(projectId)
       @ps_uri, @ps_authKey = callDaemon(:getProject, projectId)
       if @ps_uri.nil?

data/lib/tj3d.rb

@@ -1,9 +1,10 @@
 #!/usr/bin/env ruby -w
 # encoding: UTF-8
 #
-# = tj3ss_receiver.rb -- The TaskJuggler III Project Management Software
+# = tj3d.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of version 2 of the GNU General Public License as
@@ -87,6 +88,9 @@ EOT
       broker.webServerPort = @webServerPort if @webServerPort
       broker.projectFiles = sortInputFiles(files) unless files.empty?
       broker.daemonize = @daemonize
+      # Create log files for standard IO for each child process if the daemon
+      # is not disconnected from the terminal.
+      broker.logStdIO = !@daemonize
 
       broker.start
     end

data/lib/tj3man.rb

@@ -3,7 +3,8 @@
 #
 # = tj3man.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of version 2 of the GNU General Public License as
@@ -29,8 +30,8 @@ class Arguments
     opts = OptionParser.new
     opts.banner = "#{AppConfig.softwareName} v#{AppConfig.version} - " +
                   "#{AppConfig.packageInfo}\n\n" +
-                  "Copyright (c) #{AppConfig.copyright.join(', ')}" +
-                  " by #{AppConfig.authors.join(', ')}\n\n" +
+                  "Copyright (c) #{AppConfig.copyright.join(', ')}\n" +
+                  "              by #{AppConfig.authors.join(', ')}\n\n" +
                   "#{AppConfig.license}\n" +
                   "For more info about #{AppConfig.softwareName} see " +
                   "#{AppConfig.contact}\n"

data/lib/tj3ss_receiver.rb

@@ -3,7 +3,8 @@
 #
 # = tj3ss_receiver.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of version 2 of the GNU General Public License as

data/lib/tj3ss_sender.rb

@@ -3,7 +3,8 @@
 #
 # = tj3ss_sender.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of version 2 of the GNU General Public License as

data/lib/tj3ts_receiver.rb

@@ -3,7 +3,8 @@
 #
 # = tj3ts_receiver.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of version 2 of the GNU General Public License as

data/lib/tj3ts_sender.rb

@@ -3,7 +3,8 @@
 #
 # = tj3ts_sender.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of version 2 of the GNU General Public License as

data/lib/tj3ts_summary.rb

@@ -3,7 +3,8 @@
 #
 # = tj3ts_summary.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               by Chris Schlaeger <chris@linux.com>
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of version 2 of the GNU General Public License as

data/manual/Day_To_Day_Juggling

@@ -1,5 +1,41 @@
 == Day To Day Juggling ==
 
+=== Working with multiple scenarios ===
+
+To analyze the impact that a small variation can have on a project,
+TaskJuggler supports an unlimited amount of scenarios. Each
+additional scenario is a slight derivation of the it's parent. The
+task tree structure needs to be the same for all scenarios, but most
+attributes can vary from one scenario to another. Several report
+types support comparative listing of multiple [[scenarios]].
+
+By default, TaskJuggler knows about one scenario, called
+''''plan''''. The name of this scenario can be changed just like you
+can add more scenarios in the [[project]] section of your project
+files.
+
+<[example file="Scenario" tag="header"]>
+
+This header section defines 3 different scenarios. ''''plan'''' is
+the top-level scenario. It has two derived scenarios, ''''actual''''
+and ''''test''''. These two scenarios are identical to the
+''''plan'''' scenario except for those attributes that are changed
+for these scenarios. Normally, all scenarios are scheduled on each
+''''tj3'''' run. To temporarily disable the scheduling of a scenario,
+you can use the [[disabled]] attribute.
+
+<[example file="Scenario" tag="task"]>
+
+If you prefix an attribute with the scenario ID followed immediately
+by a colon, you can specify a value for a particular attribute. Keep
+in mind that setting an attribute also sets the same value for ''all
+derived scenarios'' of this scenario as well! If you would specify
+''''actual:start'''' first and then ''''plan:start'''', the latter
+would overwrite the first value again since actual is a derived
+scenario of plan.
+
+The syntax reference lists for each attribute whether it is scenario
+specific or not.
 
 === Tracking the Project ===
 

data/manual/How_To_Contribute

@@ -66,6 +66,7 @@ the taskjuggler directory run the following commands.
 
  cd taskjuggler3
  rake test
+ rake spec
  rake manual
  rake gem
 
@@ -151,10 +152,14 @@ The following commands build the HTML files for the manual in the
 
 ==== Contributing to the Test Suite ====
 
-The test suite can be found in the ''''test'''' directory. It
-contains unit and system tests but is very rudimentary at the moment.
-Adding more system tests to the CSV-Report directory is probably the
-best place to start.
+The test suite can be found in the ''''test'''' and ''''spec''''
+directories. It contains unit and system tests but is very rudimentary
+at the moment.  Adding more system tests to the test/CSV-Report directory
+is probably the best place to start. Originally, TaskJuggler used
+classic Ruby unit tests, but a migration to
+[http://rspec.info/|RSpec-2] is in the works now. New tests should be
+written as RSpec tests unless they require infrastructure only
+available in the ''''test'''' directory.
 
 ==== Contributing to the Ruby code ====
 

data/manual/Installation

@@ -54,8 +54,8 @@ This will download and install the latest version from the
 ==== The manual way ====
 
 If the easy way doesn't work for you, you need to download and install
-the packages manually.  Get TaskJuggler III from the
-[http://www.taskjuggler.org/download.php Download Page].
+the packages manually.  Download TaskJuggler III gem file from the
+[http://rubygems.org/gems/taskjuggler RubyGems.org] site.
 
 A gem package is an operating system and architecture independent
 archive file for Ruby programs. You can install it on any system that
@@ -137,10 +137,17 @@ from source put the following code in ''''${HOME}/bin/tj3''''.
  
  $:.unshift "#{ENV['TASKJUGGLER_DATA_PATH']}/lib/"
  
- require "taskjuggler3"
+ require File.basename(__FILE__)
 
 Don't forget to mark it as executable.
 
  chmod 750 ${HOME}/bin/tj3
 
+Other programs like ''''tj3client'''', ''''tj3man'''' or ''''tj3d'''' can simply be
+added as symbolic links to tj3.
+
+  cd ${HOME}/bin
+  ln -s tj3 tj3man
+  ln -s tj3 tj3client
+  ln -s tj3 tj3d
 

data/manual/TaskJuggler_Internals

@@ -24,11 +24,9 @@ During the scheduling process, tasks can have 3 different states.
 # ''''Not ready for scheduling'''': The task is missing a start or
 end date that depends on another task's date that hasn't been
 determined yet.
-
 # ''''Ready for scheduling'''': The task has at least a start or end
 date but one of them is still missing or resources have not yet been
 assigned for all time slots.
-
 # ''''Scheduling completed'''': The task has a start and end date and
 resources have been assigned for all time slots.
 

data/manual/Tutorial

@@ -498,9 +498,9 @@ the top-level format will be used for all included reports as well.
 
 <[example file="tutorial" tag="overview_report1"]>
 
-Web browsers usually look for a file called ''''Overview.html'''' when
-they are pointed to a directory. For the main report, we choose the
-file name ''''Overview'''' and the format ''''html''''.
+For the main report, we choose the file name ''''Overview'''' and the
+format ''''html''''. So, the generated file will be called
+''''Overview.html''''.
 
 As we've mentioned before, the sections of a ''''textreport'''' are
 defined in Rich Text format. Here we use a so called block generator
@@ -537,6 +537,28 @@ the P&L in this report.
 
 <[example file="tutorial" tag="overview2"]>
 
+The columns of the report can be customized. You can overwrite the
+default title or the cell content. See [[columns]] for a full list of
+available attributes. For the chart column, we'd like to have a
+tool tip that displays additional details when the mouse pointer is
+placed over a task bar. Since we use this tool tip in several
+reports, we have defined the ''''TaskTip'''' macro for it.
+
+<[example file="tutorial" tag="tasktip"]>
+
+The [[tooltip.column|tooltip]] attribute describes the content of the
+tool tip. The first parameter is a logical expression that determines
+when the tool tip is active. You can specify multiple tool tips. The
+first matching one is being displayed. The condition is evaluated for
+each report line. The ''''istask()'''' function only evaluates to true
+for task lines. See [[functions]] for a complete list of functions
+that can be used in [[logicalexpression|logical expressions]].
+
+The content of the tool tip is a template that uses
+[[Rich_Text_Attributes#Block_and_Inline_Generators|query
+generators]] to include task attributes such as the start and end
+date.
+
 We have chosen to include the start and end date of each task in the
 report. By default, TaskJuggler lists dates as day, month and year.
 We like the format to be similar to the format that the project

data/prj_cfg.rb

@@ -8,7 +8,7 @@ UNIX_NAME       = 'taskjuggler'
 
 # PERSONAL
 USER_NAME       = 'Chris Schlaeger'
-USER_EMAIL      = 'cs@kde.org'
+USER_EMAIL      = 'chris@linux.com'
 RUBYFORGE_USER  = ENV['RUBYFORGE_USER']
 #CERT_PRIVATE    = ENV['HOME']/.gem/certs/gem-private-key.pem
 
@@ -45,6 +45,8 @@ RAKEFILE        = 'Rakefile'
 SETUP_FILE      = 'setup.rb'
 PRJ_FILE        = 'prj_cfg.rb'
 GEM_SPEC_FILE   = 'gem_spec.rb'
-DATA_FILES      = FileList["benchmarks/**/*", "examples/**/*", "manual/*", "test/all.rb", "test/MessageChecker.rb", "test/TestSuite/**/*", "data/**/*"]
+DATA_FILES      = FileList["benchmarks/**/*", "examples/**/*", "manual/*", "test/all.rb", "test/MessageChecker.rb", "test/TestSuite/**/*", "spec/**/*", "data/**/*"]
 DEPENDENCIES    = { 'mail' => '= 2.1.3',
                     'open4' => '1.0.1' }
+DEVEL_DEPENDENCIES = { 'rcov' => '0.9.9',
+                       'rspec' => '2.3.0' }