taskjuggler 0.0.10 → 0.0.11

data/manual/Installation

@@ -17,6 +17,27 @@ compile anything. But TaskJuggler has a very small set of
 dependencies that you have to take care of first. Please make sure you
 have the minimum required version installed.
 
+==== Supported Operating Systems ====
+
+* '''Linux''': Linux is the primary development platform for
+TaskJuggler. Releases are tested on recent openSUSE versions.
+
+* '''Other Unix OSes''': Should work as well, but releases are not
+tested on these OSes.
+
+* '''Windows''': Windows7 and some older version of Windows should
+work. There is no maintainer for this platform, so all releases are
+not tested on this platform.
+
+* '''MacOSX''': Will probably work as well. Releases are not tested
+on this OS. Older MacOS versions will likely not work.
+
+If you are interested in becoming the maintainer for any of the
+currently unmaintained (and untested) OSes, please contact us via the
+developer mailing list.
+
+==== Other required Software ====
+
 * '''Ruby:''' TaskJuggler III is written in Ruby.  You need a Ruby
 runtime environment to run it. This can be downloaded from
 [http://www.ruby-lang.org/en/downloads/ here].  Most Linux
@@ -26,12 +47,15 @@ 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.
+ok to use. On Windows you need at least Ruby 1.9.2.
 
 * '''RubyGems:''' If it did not come with your OS or the Ruby
 installation, see [http://docs.rubygems.org here] how to get and
 install it.
 
+Other versions of Ruby (Rubinius, JRuby, etc.) may work but have not
+been tested.
+
 === Installation Steps for Users ===
 
 ==== The easy way ====
@@ -106,11 +130,10 @@ Then checkout the source code with the following command
 
  git clone http://www.taskjuggler.org/git-repos/taskjuggler3.git
 
-Make sure, you
-have removed all previously installed instances of TaskJuggler from
-your system before doing so. It is a common mistake to have an old
-version of the TaskJuggler installed and then use parts of the old and
-new version together.
+Make sure, you have removed all previously installed instances of
+TaskJuggler from your system before doing so. It is a common mistake
+to have an old version of the TaskJuggler installed and then use parts
+of the old and new version together.
 
 If your Ruby installation does not come with the
 [http://rake.rubyforge.org Rake] build tool, you need to install it
@@ -151,3 +174,39 @@ added as symbolic links to tj3.
   ln -s tj3 tj3client
   ln -s tj3 tj3d
 
+=== Quickly switching between various TaskJuggler III versions ===
+
+One of the benefits of using TaskJuggler from the Git repository is
+the ability to get the latest bug fixes. If a bug was reported, it is
+usually fixed fairly quickly, but it can take several weeks before
+the next official release happens. The following commands must all be
+executed from within the checked-out Git directory.
+
+ git pull
+
+gets you the latest changes. We usually try to keep the head branch
+stable. Using it should not be much more risky than using a regular
+release. Nevertheless, problems can occur and a fixed version might
+take a few days.
+
+ git checkout -f XXXXXXXX
+
+will switch your current working copy to the version with commit ID
+XXXXXXXX. Alternatively, you can also use tag names.
+
+ git checkout -f release-0.0.10
+
+This will switch to the released version 0.0.10.
+
+ git tag
+
+provides you with a list of all tags.
+
+TaskJuggler III is written in Ruby. There is no make or build process
+needed. Every code change is effective immediately. The tutorial, the
+manual and some other parts do require a build step.
+
+ rake release
+
+will do it all and even create installable gem files again.
+

data/manual/Reporting_Bugs

@@ -10,12 +10,10 @@ find a bug, please follow this procedure:
 feature.
 
 * Check the [http://www.taskjuggler.org TaskJuggler web page] and the
-[http://www.taskjuggler.org/forum.php discussion groups]. In
-particular, you should check the
-[http://groups.google.com/group/taskjuggler-bugs/topics existing bug
-reports].
-
-* Possibly the bug was already found and a patch or workaround exists.
+[http://www.taskjuggler.org/forum.php discussion groups]. You should
+also search the [https://github.com/taskjuggler/TaskJuggler/issues
+issue tracker] if the problem has been reported before. If so, it's
+quite likely that there is already a workaround or fix available. 
 
 * Try to create a test project that is as small as possible but still
 reproduces the bug.
@@ -27,20 +25,8 @@ following command to store the messages into a file.
 
  tj3 yourproject.tjp 2> error_message
 
-* Send the test project and a detailed description of the problem to
-the TaskJuggler developers. If you are pretty confident, that you've
-found a new bug, please post it to the
-[http://groups.google.com/group/taskjuggler-bugs TaskJuggler Bug
-Group]. If you aren't sure or want to provide patches or feedback,
-please use the [http://groups.google.com/group/taskjuggler-dev
-TaskJuggler Developer Group].
-
-* When posting complete files, make sure you attach them. Don't paste
-them into the body of the email. Some email servers and clients have
-a habit of converting the body into HTML which will corrupt the file
-contents. Unfortunately, the Google Groups web interface does not
-support attachments. Please use a regular email program instead. The
-posting addresses can be found on the above mentioned pages.
+* Enter a detailed description of the problem into the issue tracker
+and don't forget to attach your test project.
 
 * Not attaching a test case will severely limit our abilities to help
 you. Please make sure you provide meaningful descriptions and a small

data/manual/TaskJuggler_Internals

@@ -81,5 +81,12 @@ with fairly short computation overhead. The scheduling process is not
 an optimization process. It does not evaluate alternatives and it
 does not search for local extremes in a solution space.
 
-
+A task can only be scheduled when it is ready for scheduling. This
+means that at least the start date for the scheduling process must be
+known. For ASAP (As Soon As Possible) tasks, the scheduler start date
+is the start date of the task. For ALAP (As Late As Possible) tasks
+the scheduler start date is the end date of the task. ASAP task will
+be scheduled from start to end, ALAP tasks from end to start. This is
+important to understand as resource assignments for each time slot
+will be determined in this order.
 

data/manual/Tutorial

@@ -46,6 +46,22 @@ must be enclosed in single or double quotes. The argument types and
 meaning is explained for each keyword in the syntax reference section
 of this manual.
 
+TaskJuggler manages all events with an accuracy of up to 15 minutes.
+In many cases, you don't care about this level of accuracy.
+Nevertheless, it's good to have it when you need it. All dates can
+optionally be extended by a time. By default, TaskJuggler assumes
+that all times are UTC (world time) times. If you prefer a different
+time zone, you need to use the [[timezone]] attribute.
+
+<[example file="tutorial" tag="timezone"]>
+
+Be aware that the project start and end dates in the project header
+are specified before you specify the time zone. The project header
+dates are always assumed to be UTC unless you specify differently.
+See [[interval2]] for details.
+
+ project acso "Accounting Software"  2002-01-16-0:00-+0100
+
 The [[currency]] attribute specifies the unit of currency values.
 
 <[example file="tutorial" tag="currency"]>

data/prj_cfg.rb

@@ -15,7 +15,7 @@ RUBYFORGE_USER  = ENV['RUBYFORGE_USER']
 # VERSION
 begin
     $: << 'lib'
-    require 'lib/Tj3Config'
+    require 'lib/taskjuggler/Tj3Config'
     PROJECT_VERSION = AppConfig.version
 rescue LoadError
     puts '> unable to set project version, what a shame ... does version mean something to you ??'
@@ -34,7 +34,7 @@ RAKE_DIR        = 'tasks'
 MANUAL_DIR      = 'manual'
 
 # FILES
-README          = FileList['README']
+README          = FileList['README.rdoc']
 CHANGELOG       = 'CHANGELOG'
 LICENSE         = 'COPYING'
 DESCRIPTION     = <<'EOT'
@@ -42,7 +42,6 @@ TaskJuggler is a project management software that goes far beyond the commonly
 known Gantt chart editors.
 EOT
 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/**/*", "spec/**/*", "data/**/*"]

data/spec/IntervalList_spec.rb

@@ -12,7 +12,8 @@
 #
 
 require 'rubygems'
-require 'IntervalList'
+
+require 'taskjuggler/IntervalList'
 
 class TaskJuggler
 

data/spec/ProjectBroker_spec.rb

@@ -11,7 +11,7 @@
 # published by the Free Software Foundation.
 #
 
-require 'daemon/ProjectBroker'
+require 'taskjuggler/daemon/ProjectBroker'
 
 RSpec.configure do |c|
   c.filter_run_excluding :ruby => lambda {|version|

data/spec/TernarySearchTree_spec.rb

@@ -0,0 +1,131 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = IntervalList_spec.rb -- The TaskJuggler III Project Management Software
+#
+# 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
+# published by the Free Software Foundation.
+#
+
+require 'rubygems'
+
+require 'taskjuggler/TernarySearchTree'
+
+class TaskJuggler
+
+  describe TernarySearchTree do
+
+    before do
+      @tst = TernarySearchTree.new
+    end
+
+    it 'should not contain anything yet' do
+      @tst.length.should be_equal 0
+      @tst[''].should be_nil
+    end
+
+    it 'should accept single element on creation' do
+      @tst = TernarySearchTree.new('foo')
+      @tst.length.should == 1
+    end
+
+    it 'should accept an Array on creation' do
+      @tst = TernarySearchTree.new(%w( foo bar ))
+      @tst.length.should == 2
+    end
+
+    it 'should not accept an empty String' do
+      lambda { @tst.insert('') }.should raise_error
+    end
+
+    it 'should not accept nil' do
+      lambda { @tst.insert(nil) }.should raise_error
+    end
+
+    it 'should store inserted values' do
+      v = %w( foo bar foobar barfoo fo ba foo1 bar1 zzz )
+      @tst.insertList(v)
+
+      @tst.length.should be_equal v.length
+      rv = @tst.to_a.sort
+      rv.should == v.sort
+    end
+
+    it 'should find exact matches' do
+      v = %w( foo bar foobar barfoo fo ba foo1 bar1 zzz )
+      v.each { |val| @tst << val }
+
+      v.each do |val|
+        @tst[val].should == val
+      end
+    end
+
+    it 'should not find non-existing elements' do
+      %w( foo bar foobar barfoo fo ba foo1 bar1 zzz ).each { |v| @tst << v }
+
+      @tst['foos'].should be_nil
+      @tst['bax'].should be_nil
+      @tst[''].should be_nil
+    end
+
+    it 'should find partial matches' do
+      %w( foo bar foobar barfoo ba foo1 bar1 zzz ).each { |v| @tst << v }
+
+      @tst['foo', true].sort.should == %w( foo foobar foo1 ).sort
+      @tst['fo', true].sort.should == %w( foo foobar foo1 ).sort
+      @tst['b', true].sort.should == %w( bar barfoo ba bar1 ).sort
+      @tst['zzz', true].should == [ 'zzz' ]
+    end
+
+    it 'should not find non-existing elements' do
+      %w( foo bar foobar barfoo fo ba foo1 bar1 zzz ).each { |v| @tst << v }
+
+      @tst['foos', true].should be_nil
+      @tst['', true].should be_nil
+    end
+
+    it 'should store duplicate entries only once' do
+      v = %w( foo bar foobar bar foo fo ba foo1 ba foobar bar1 zzz )
+      @tst.insertList(v)
+      @tst.length.should == v.uniq.length
+    end
+
+    it 'maxDepth should work' do
+      v = %w( a b c d e f)
+      v.each { |val| @tst << val }
+      @tst.maxDepth.should == v.length
+    end
+
+    it 'should be able to balance a tree' do
+      %w( aa ab ac ba bb bc ca cb cc ).each { |v| @tst << v }
+      tst = @tst.balanced
+      @tst.balance!
+      @tst.to_a.should == tst.to_a
+      # The tree is not perfectly balanced.
+      @tst.maxDepth.should == 5
+    end
+
+    #it 'should store integer lists' do
+    #  @tst.insert([ 0, 1, 2 ])
+
+    #  @tst.length.should == 1
+    #  @tst.to_a.should be == [ 0, 1, 2 ]
+    #end
+
+    #it 'should work with integer lists as well' do
+    #  v = [ [ 0, 1, 2], [ 0, 3, 2], [ 1, 3 ], [ 0, 2, 1], [ 1, 0, 3] ]
+    #  @tst.insertList(v)
+
+    #  @tst.length.should be_equal v.length
+    #  rv = @tst.to_a.sort
+    #  rv.should == v.sort
+    #end
+
+  end
+
+end
+

data/spec/TimeSheets_spec.rb

@@ -0,0 +1,129 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = TimeSheets_spec.rb -- The TaskJuggler III Project Management Software
+#
+# 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
+# published by the Free Software Foundation.
+#
+
+require 'rubygems'
+require 'fileutils'
+require 'support/DaemonControl'
+require 'taskjuggler/apps/Tj3TsSender'
+
+class TaskJuggler
+
+  describe TimeSheetSender do
+
+    include DaemonControl
+    include FileUtils
+
+    before(:all) do
+      # Make sure we run in the same directory as the spec file.
+      @pwd = pwd
+      cd(File.dirname(__FILE__))
+
+      cleanup
+      startDaemon(<<'EOT'
+  smtpServer: foobar.com
+_timesheets:
+  projectId: tstest
+  senderEmail: foo@example.com
+  _sender:
+    hideResource: '~isleaf()'
+  _summary:
+    sheetRecipients:
+      - archive@example.com
+    digestRecipients:
+      - archive@example.com
+      - crew@example.com
+EOT
+                 )
+      prj = <<'EOT'
+project tstest "Time Sheet Test" 2011-03-14 +2m
+resource "Team" {
+  resource r1 "R1" {
+    email "r1@example.com"
+  }
+  resource r2 "R2" {
+    email "r2@example.com"
+  }
+}
+task t1 "T1" {
+  effort 2.5d
+  allocate r1
+}
+task t2 "T2" {
+  depends !t1
+  effort 2.5d
+  allocate r1
+}
+task t3 "T3" {
+  effort 10d
+  allocate r2
+}
+EOT
+      res = stdIoWrapper(prj) do
+        Tj3Client.new.main(%w( --unsafe --silent add . ))
+      end
+      unless res.stdErr =~ /Project tstest loaded/
+        raise "Project not loaded: #{res.stdErr}"
+      end
+      raise "Can't load project" unless res.returnValue == 0
+
+      @res = stdIoWrapper do
+        Tj3TsSender.new.main(%w( --dryrun --silent -e 2011-03-21 ))
+      end
+      raise "Timesheet generation failed" unless @res.returnValue == 0
+    end
+
+    after(:all) do
+      stopDaemon
+      cleanup
+      cd(@pwd)
+    end
+
+    it 'should generate properly dated headers' do
+      countLines(@res.stdOut,
+                 'timesheet r1 2011-03-14-00:00-+0000 - ' +
+                 '2011-03-21-00:00-+0000').should == 1
+      countLines(@res.stdOut,
+                 'timesheet r2 2011-03-14-00:00-+0000 - ' +
+                 '2011-03-21-00:00-+0000').should == 1
+    end
+
+    it 'should generate 2 emails' do
+      countLines(@res.stdOut, 'From: foo@example.com').should == 2
+      countLines(@res.stdOut, 'To: r1@example.com').should == 1
+      countLines(@res.stdOut, 'To: r2@example.com').should == 1
+    end
+
+    private
+
+    def countLines(text, pattern)
+      c = 0
+      if pattern.is_a?(Regexp)
+        text.each_line do |line|
+          c += 1 if line =~ pattern
+        end
+      else
+        text.each_line do |line|
+          c += 1 if line.include?(pattern)
+        end
+      end
+      c
+    end
+
+    def cleanup
+      rm_rf %w( TimeSheetTemplates timesheets.log tj3.log tj3ts_sender.log )
+    end
+
+  end
+
+end
+