taskjuggler 0.1.1 → 0.2.0

data/manual/Installation

@@ -49,6 +49,9 @@ 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. On Windows you need at least Ruby 1.9.2.
 
+See below for instructions on how to use the latest and greates Ruby
+version in parallel with your distribution Ruby.
+
 * '''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.
@@ -210,3 +213,126 @@ manual and some other parts do require a build step.
 
 will do it all and even create installable gem files again.
 
+=== Installing a newer Ruby version ===
+
+New Ruby versions are released usually about once or twice a year.
+Unfortunately, it takes some time before Linux distributions pick up
+the new release. Depending on your distribution, this can take
+anything from a few weeks to several years. Many distributions still
+have not yet made the switch to Ruby 1.9. The core part of
+TaskJuggler can be used with Ruby 1.8.9, but it is at least 3 times
+slower. Therefor it is recommended, that you install the latest
+stable release of Ruby to use TaskJuggler. This can easily and safely
+being done in parallel to your distribution Ruby. Both versions can
+be used in parallel without interfering each other.
+
+This section only covers Linux. For other operating system, please
+search the web for instructions. If you want to contribute the
+description for another OS, please see [[How_To_Contribute]].
+
+First, you need to download the source code of the latest stable
+release from
+[http://www.ruby-lang.org/en/downloads/ www.ruby-lang.org].
+
+The source code is distributed as zipped tarfile. You can extract it
+like this. Change the file name to the actual version you have
+downloaded.
+
+  tar -Zxvf ruby-X.X.X-*.tar.gz
+
+This will create a directory with the same name as the archive, but
+without the ''''.tar.gz'''' extension. Now change into this directory
+and configure the source code for your specific OS and compile it.
+For this to work, you need to have the GNU C compiler and related
+utilities installed. We configure Ruby to append ''''19'''' to all
+executable names. This way, you can easily choose if you want to run
+the old or the new Ruby. ''''ruby'''' runs your distribution Ruby,
+''''ruby19'''' runs your new ruby.
+
+  cd ruby-X.X.X-*
+  ./configure --program-suffix=19
+  make
+
+If all goes well, you can install it now. This requires root
+permission, so you need to enter the root password. All executables
+will be installed into ''''/usr/local/bin''''.
+
+  sudo make install
+
+As a final step, you need to install the ''''mail'''' gem.
+
+  sudo gem19 install mail
+
+If you don't want to use TaskJuggler from the git repository, you can
+install the TaskJuggler gem as well.
+
+  sudo gem19 install taskjuggler
+
+That's it. You now have the latest Ruby installed and are ready to
+use TaskJuggler.
+
+=== Installing the Vim Support ===
+
+TaskJuggler can be used with any text editor that supports UTF-8 text
+file editing. If you don't have a preference yet, we recommend to try
+the [http://www.vim.org Vim] text editor. It's a very powerful editor
+and it has been customized for better integration with TaskJuggler.
+This section describes, how to activate and use the Vim integration.
+Vim is provided by pretty much any Linux distribution and also works
+well on MacOX and Windows. See the web page for how to install it if
+you don't have it yet.
+
+This section describes the integration on Linux. Please see the
+[[How_To_Contribute]] section if you want to contribute the
+description for another OS.
+
+If you have never customized Vim, you need to create a few
+directories first.
+
+  cd ${HOME}
+  mkdir .vim
+  mkdir .vim/syntax
+
+Then copy the syntax file ''''tjp.vim'''' into the vim syntax
+directory. The following command works if you have installed
+TaskJuggler as a gem with the system provided Ruby. For other cases,
+you may have to modify it accordingly.
+
+  cp `gem contents taskjuggler | fgrep tjp.vim` .vim/syntax
+
+Now we have to make sure, Vim detects the file. Edit the
+''''.vim/filetype.vim'''' file to contain the following section.
+
+ augroup filetypedetect
+ au BufNewFile,BufRead *.tjp,*.tji               setf tjp
+ augroup END
+
+And edit the ''''.vim/syntax.vim'''' file to contain the following line.
+
+ au! Syntax tjp          so ~/.vim/syntax/tjp.vim
+
+When you now open a ''''.tjp'''' or ''''.tji'''' file in Vim, you
+should have the following features available:
+
+* Syntax highlighting. TJP keywords should be colored in different colors.
+* Syntax folding. The optional parts of properties within the curly
+  braces can be collapsed. For this to work, the opening brace needs
+  to be on the same line as the property keyword. The closing brace
+  must be the first non-blank character of the last line of the
+  block. See the '''':help fold'''' Vim help command for details how
+  to open and close folds.
+* Tag navigation. If you include a [tagfile] report in your project,
+  Vim will know all property IDs and can jump to them. If you have a
+  task with the ID ''''foo.bar'''', the command '''':ta foo.bar''''
+  will put the cursor right where task ''''foo.bar'''' was declared.
+* ID completion. If you include a [tagfile] report in your project,
+  Vim can tell you the full hierarchical ID of a property. Just move
+  the cursor to the first line of the property definition and press
+  ''''Ctrl-]''''.
+* Run tj3 from within vim. Just type '''':make your_project.tjp'''' to
+  start the scheduling process. In case of errors or warnings, you
+  will be able to navigate the errors with '''':cn'''' and
+  '''':cp''''.
+* Move the cursor over any TaskJuggler syntax keyword and press
+  ''''shift-k'''' to get the manual page for this keyword.
+

data/spec/ICalendar_spec.rb

@@ -0,0 +1,45 @@
+#!/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/ICalendar'
+
+class TaskJuggler
+
+  describe ICalendar do
+
+    describe ICalendar::Component do
+
+      it 'should quote properly' do
+        c = ICalendar::Component.new(nil, '', nil, nil)
+        [
+          [ '', '' ],
+          [ 'foo', 'foo' ],
+          [ '"', '\"' ],
+          [ ';', '\;' ],
+          [ ',', '\,' ],
+          [ "\n", '\n' ],
+          [ "foo\nbar", 'foo\nbar' ],
+          [ 'a"b"c', 'a\"b\"c' ]
+        ].each do |i, o|
+          c.send('quoted', i).should == o
+        end
+      end
+
+    end
+
+  end
+
+end
+

data/spec/IntervalList_spec.rb

@@ -27,17 +27,17 @@ class TaskJuggler
       @t4 = TjTime.new('2011-01-05').freeze
       @t5 = TjTime.new('2011-01-06').freeze
       @t6 = TjTime.new('2011-01-07').freeze
-      @i0_1 = Interval.new(@t0, @t1).freeze
-      @i0_2 = Interval.new(@t0, @t2).freeze
-      @i0_3 = Interval.new(@t0, @t3).freeze
-      @i1_2 = Interval.new(@t1, @t2).freeze
-      @i1_3 = Interval.new(@t1, @t3).freeze
-      @i2_3 = Interval.new(@t2, @t3).freeze
-      @i3_4 = Interval.new(@t3, @t4).freeze
-      @i3_6 = Interval.new(@t3, @t6).freeze
-      @i4_5 = Interval.new(@t4, @t5).freeze
-      @i4_6 = Interval.new(@t4, @t6).freeze
-      @i5_6 = Interval.new(@t5, @t6).freeze
+      @i0_1 = TimeInterval.new(@t0, @t1).freeze
+      @i0_2 = TimeInterval.new(@t0, @t2).freeze
+      @i0_3 = TimeInterval.new(@t0, @t3).freeze
+      @i1_2 = TimeInterval.new(@t1, @t2).freeze
+      @i1_3 = TimeInterval.new(@t1, @t3).freeze
+      @i2_3 = TimeInterval.new(@t2, @t3).freeze
+      @i3_4 = TimeInterval.new(@t3, @t4).freeze
+      @i3_6 = TimeInterval.new(@t3, @t6).freeze
+      @i4_5 = TimeInterval.new(@t4, @t5).freeze
+      @i4_6 = TimeInterval.new(@t4, @t6).freeze
+      @i5_6 = TimeInterval.new(@t5, @t6).freeze
     end
 
     describe "#<<" do

data/tasks/changelog.rake

@@ -3,76 +3,166 @@ require 'time'
 desc 'update changelog'
 task :CHANGELOG do
 
-  # 'git tag' is not sorted numerically. This function implements a numerical
-  # comparison for tag versions of the format 'release-X.X.X'. X can be a
-  # multi-digit number.
-  def compareTags(a, b)
-
-    def versionToComparable(v)
-      /\d+\.\d+\.\d+/.match(v)[0].split('.').map{ |l| sprintf("%03d", l.to_i)}.
-                                                           join('.')
+  class Entry
+
+    attr_reader :type
+
+    def initialize(ref, author, time, message)
+      @ref = ref
+      @author = author
+      @time = time
+      @message = message
+      if (m = /New: (.*)/.match(@message))
+        @type = :feature
+        @message = m[1]
+      elsif (m = /Fix: (.*)/.match(@message))
+        @type = :bugfix
+        @message = m[1]
+      else
+        @type = :other
+      end
+    end
+
+    def to_s
+      "  * #{@message}\n"
+    end
+
+  end
+
+  class Release
+
+    attr_reader :date, :version, :tag
+
+    def initialize(tag, predecessor)
+      @tag = tag
+      # We only support release tags in the form X.X.X
+      @version = /\d+\.\d+\.\d+/.match(tag)
+
+      # Construct a Git range.
+      interval = predecessor ? "#{predecessor.tag}..#{@tag}" : @tag
+
+      # Get the date of the release
+      date = Time.parse(/Date: (.*)/.match(`git show #{tag}`)[1]).utc
+      @date = date.strftime("%Y-%m-%d")
+
+      @entries = []
+      # Use -z option for git-log to get 0 bytes as separators.
+      `git log -z #{interval}`.split("\0").each do |commit|
+        # We ignore merges.
+        next if commit =~ /^Merge: \d*/
+
+        ref, author, time, _, message = commit.split("\n", 5)
+        ref = ref[/commit ([0-9a-f]+)/, 1]
+        author = author[/Author: (.*)/, 1].strip
+        time = Time.parse(time[/Date: (.*)/, 1]).utc
+        # Eleminate git-svn-id: lines
+        message.gsub!(/git-svn-id: .*\n/, '')
+        # Eliminate Signed-off-by: lines
+        message.gsub!(/Signed-off-by: .*\n/, '')
+        message.strip!
+        @entries << Entry.new(ref, author, time, message)
+      end
+    end
+
+    def empty?
+      @entries.empty?
+    end
+
+    def to_s
+      s = ''
+      if hasFeatures? || hasFixes?
+        if hasFeatures?
+          s << "== New Features\n\n"
+          @entries.each do |entry|
+            s << entry.to_s if entry.type == :feature
+          end
+          s << "\n"
+        end
+        if hasFixes?
+          s << "== Bug Fixes\n\n"
+          @entries.each do |entry|
+            s << entry.to_s if entry.type == :bugfix
+          end
+          s << "\n"
+        end
+      else
+        @entries.each do |entry|
+          s << entry.to_s
+        end
+      end
+      s
+    end
+
+    private
+
+    def hasFeatures?
+      @entries.each do |entry|
+        return true if entry.type == :feature
+      end
+      false
+    end
+
+    def hasFixes?
+      @entries.each do |entry|
+        return true if entry.type == :bugfix
+      end
+      false
     end
 
-    versionToComparable(a) <=> versionToComparable(b)
   end
 
-  # Get list of release tags from Git repository
-  releases = `git tag`.split("\n").map { |r| r.chomp }.
-    sort{ |a, b| compareTags(a, b) }
-  releases << 'HEAD'
-
-  # Now we get the commit entries for each release
-  sections = []
-  prevRelease = nil
-  releases.each do |release|
-    # This buffer holds the final text for the release section. It will
-    # contain the commit messages in RDoc format.
-    text = ''
-    # We only support release tags in the form X.X.X
-    version = /\d+\.\d+\.\d+/.match(release)
-    # Construct a Git range.
-    interval = prevRelease ? "#{prevRelease}..#{release}" : release
-    prevRelease = release
-
-    # Get the date of the release
-    date = Time.parse(/Date: (.*)/.match(`git show #{release}`)[1]).utc
-    date = date.strftime("%Y-%m-%d")
-
-    logText = ''
-    # Use -z option for git-log to get 0 bytes as separators.
-    `git log -z #{interval}`.split("\0").each do |commit|
-      # We ignore merges.
-      next if commit =~ /^Merge: \d*/
-
-      ref, author, time, _, message = commit.split("\n", 5)
-      ref = ref[/commit ([0-9a-f]+)/, 1]
-      author = author[/Author: (.*)/, 1].strip
-      time = Time.parse(time[/Date: (.*)/, 1]).utc
-      # Eleminate git-svn-id: lines
-      message.gsub!(/git-svn-id: .*\n/, '')
-      # Eliminate Signed-off-by: lines
-      message.gsub!(/Signed-off-by: .*\n/, '')
-      message.strip!
-
-      logText += "  * #{message}\n"
+  class ChangeLog
+
+    def initialize
+      @releases = []
+      predecessor = nil
+      getReleaseVersions.each do |version|
+        @releases << (predecessor = Release.new(version, predecessor))
+      end
     end
 
-    # Skip the release if there are no changes. E. g. HEAD at release.
-    next if logText.empty?
+    def to_s
+      s = ''
+      @releases.reverse.each do |release|
+        next if release.empty?
 
-    # We use RDOC markup syntax to generate a title
-    if version
-      text += "= Release #{version} (#{date})\n\n" + logText
-    else
-      text += "= Next Release (Some Day)\n\n" + logText
+        # We use RDOC markup syntax to generate a title
+        if release.version
+          s << "= Release #{release.version} (#{release.date})\n\n"
+        else
+          s << "= Next Release (Some Day)\n\n"
+        end
+        s << release.to_s + "\n"
+      end
+      s
     end
-    sections << text
+
+    private
+
+    # 'git tag' is not sorted numerically. This function implements a
+    # numerical comparison for tag versions of the format 'release-X.X.X'. X
+    # can be a multi-digit number.
+    def compareTags(a, b)
+
+      def versionToComparable(v)
+        /\d+\.\d+\.\d+/.match(v)[0].split('.').map{ |l| sprintf("%03d", l.to_i)}.
+                                                             join('.')
+      end
+
+      versionToComparable(a) <=> versionToComparable(b)
+    end
+
+    def getReleaseVersions
+      # Get list of release tags from Git repository
+      releaseVersions = `git tag`.split("\n").map { |r| r.chomp }.
+        sort{ |a, b| compareTags(a, b) }
+      releaseVersions << 'HEAD'
+    end
+
   end
 
   File.open('CHANGELOG', 'w+') do |changelog|
-    # List releases from last to first.
-    sections.reverse.each do |section|
-      changelog.puts section + "\n"
-    end
+    changelog.puts ChangeLog.new.to_s
   end
+
 end

data/tasks/gem.rake

@@ -12,6 +12,7 @@ execs = Dir.glob('./bin/*') + Dir.glob('./**/run') +
 
 task :release => [:clobber] do
     puts "Preparing release of #{PROJECT_NAME} version #{PROJECT_VERSION}"
+    Rake::Task[:vim].invoke
     Rake::Task[:spec].invoke
     Rake::Task[:test].invoke
     Rake::Task[:rdoc].invoke

data/tasks/vim.rake

@@ -1,9 +1,9 @@
-# TASK VIM SYNTAX 
+# TASK VIM SYNTAX
 
 require 'taskjuggler/VimSyntax'
 
 desc 'Generate vim.tjp Vim syntax file'
 task :vim do
-  TaskJuggler::VimSyntax.new.generate('tjp.vim')
+  TaskJuggler::VimSyntax.new.generate('data/tjp.vim')
 end
 

data/test/TestSuite/Export-Reports/refs/Booking.tjp

@@ -10,7 +10,7 @@ projectids project
 resource tux "Tux"
 
 task test "Testing" {
-  start 2007-01-05-07:00-+0000
+  start 2007-01-08-20:00-+0000
   end 2007-01-24-22:00-+0000
   scheduling asap
   scheduled

data/test/TestSuite/Export-Reports/refs/CompletedWork.tji.tjp

@@ -0,0 +1,40 @@
+project prj "Project" "1.0" 2000-01-01-00:00-+0000 - 2000-03-01-00:00-+0000 {
+  timezone "Europe/Berlin"
+  scenario plan "Plan Scenario" {
+    active yes
+  }
+}
+
+projectids prj
+
+resource r "Resource"
+
+task t "Task" {
+  start 2000-01-01-00:00-+0000
+  end 2000-01-14-17:00-+0000
+  scheduling asap
+  scheduled
+}
+supplement task t {
+  booking r 2000-01-03-08:00-+0000 + 3.0h,
+          2000-01-03-12:00-+0000 + 5.0h,
+          2000-01-04-08:00-+0000 + 3.0h,
+          2000-01-04-12:00-+0000 + 5.0h,
+          2000-01-05-08:00-+0000 + 3.0h,
+          2000-01-05-12:00-+0000 + 5.0h,
+          2000-01-06-08:00-+0000 + 3.0h,
+          2000-01-06-12:00-+0000 + 5.0h,
+          2000-01-07-08:00-+0000 + 3.0h,
+          2000-01-07-12:00-+0000 + 5.0h { overtime 2 }
+  priority 500
+  projectid prj
+}
+supplement resource r {
+  workinghours sun off
+               workinghours mon 9:00 - 12:00, 13:00 - 18:00
+               workinghours tue 9:00 - 12:00, 13:00 - 18:00
+               workinghours wed 9:00 - 12:00, 13:00 - 18:00
+               workinghours thu 9:00 - 12:00, 13:00 - 18:00
+               workinghours fri 9:00 - 12:00, 13:00 - 18:00
+               workinghours sat off
+}

data/test/TestSuite/Export-Reports/refs/Macro-2.tjp

@@ -8,7 +8,12 @@ project prj "Test" "1.0" 2010-04-28-00:00-+0000 - 2010-05-05-00:00-+0000 {
 projectids prj
 
 
-task _Task_1 "task" {
+task _Task_1 " Crème brûlée   Prepare " {
+  start 2010-04-28-00:00-+0000
+  milestone
+  scheduled
+}
+task _Task_2 "task" {
   start 2010-04-28-00:00-+0000
   milestone
   scheduled
@@ -17,3 +22,7 @@ supplement task _Task_1 {
   priority 500
   projectid prj
 }
+supplement task _Task_2 {
+  priority 500
+  projectid prj
+}

data/test/TestSuite/Export-Reports/refs/TaskPrefix.tjp

@@ -18,7 +18,7 @@ task parent_task "Parent task" {
   }
 }
 task other_task "Other task" {
-  start 2010-12-01-00:00-+0000
+  start 2010-12-02-08:00-+0000
   end 2010-12-02-16:00-+0000
   scheduling asap
   scheduled