taskjuggler 0.0.11 → 0.1.0

data/lib/taskjuggler/UTF8String.rb

@@ -13,6 +13,8 @@
 
 KCODE='u'
 
+require 'base64'
+
 # This is an extension and modification of the standard String class. We do a
 # lot of UTF-8 character processing in the parser. Ruby 1.8 does not have good
 # enough UTF-8 support and Ruby 1.9 only handles UTF-8 characters as Strings.
@@ -102,4 +104,12 @@ class String
     [self].pack('M').gsub(/\n/, "\r\n")
   end
 
+  def to_base64
+    Base64.encode64(self)
+  end
+
+  def unix2dos
+    gsub(/\n/, "\r\n")
+  end
+
 end

data/lib/taskjuggler/UserManual.rb

@@ -17,6 +17,7 @@ require 'taskjuggler/RichText/Document'
 require 'taskjuggler/SyntaxReference'
 require 'taskjuggler/TjTime'
 require 'taskjuggler/RichText/FunctionExample'
+require 'taskjuggler/HTMLElements'
 
 class TaskJuggler
 
@@ -25,6 +26,8 @@ class TaskJuggler
   # but also contains the SyntaxReference for the TJP syntax.
   class UserManual < RichTextDocument
 
+    include HTMLElements
+
     # Create a UserManual object and gather the TJP syntax information.
     def initialize
       super
@@ -90,56 +93,58 @@ class TaskJuggler
     # Callback function used by the RichTextDocument class to generate the cover
     # page for the manual.
     def generateHTMLCover
-      html = []
-      html << (div = XMLElement.new('div', 'align' => 'center',
-        'style' => 'margin-top:40px; margin-botton:40px'))
-      div << XMLNamedText.new("The #{AppConfig.softwareName} User Manual",
-                              'h1')
-      div << XMLNamedText.new('Project Management beyond Gantt Chart drawing',
-                              'em')
-      div << XMLElement.new('br')
-      div << XMLNamedText.new(
-        "Copyright (c) #{AppConfig.copyright.join(', ')} " +
-        "by #{AppConfig.authors.join(', ')}", 'b')
-      div << XMLElement.new('br')
-      div << XMLText.new("Generated on #{TjTime.new.strftime('%Y-%m-%d')}")
-      div << XMLElement.new('br')
-      div << XMLNamedText.new("This manual covers #{AppConfig.softwareName} " +
-                              "version #{AppConfig.version}.", 'h3')
-      html << XMLElement.new('br')
-      html << XMLElement.new('hr')
-      html << XMLElement.new('br')
-
-      html
+      [
+        DIV.new('align' => 'center',
+                'style' => 'margin-top:40px; margin-botton:40px') do
+          [
+            H1.new { "The #{AppConfig.softwareName} User Manual" },
+            EM.new { 'Project Management beyond Gantt Chart drawing' },
+            BR.new,
+            B.new do
+              "Copyright (c) #{AppConfig.copyright.join(', ')} " +
+              "by #{AppConfig.authors.join(', ')}"
+            end,
+            BR.new,
+            "Generated on #{TjTime.new.strftime('%Y-%m-%d')}",
+            BR.new,
+            H3.new { "This manual covers #{AppConfig.softwareName} " +
+                     "version #{AppConfig.version}." }
+          ]
+        end,
+        BR.new,
+        HR.new,
+        BR.new
+      ]
     end
 
     # Callback function used by the RichTextDocument class to generate the
     # header for the manual pages.
     def generateHTMLHeader
-      html = []
-      html << (headline = XMLElement.new('div', 'align' => 'center'))
-      headline << XMLNamedText.new(
-        "The #{AppConfig.softwareName} User Manual", 'h3',
-        'align' => 'center')
-      headline << XMLNamedText.new(
-        'Project Management beyond Gantt Chart Drawing', 'em',
-        'align' => 'center')
-
-      html
+      DIV.new('align' => 'center') do
+        [
+          H3.new('align' => 'center') do
+            "The #{AppConfig.softwareName} User Manual"
+          end,
+          EM.new('align' => 'center') do
+            'Project Management beyond Gantt Chart Drawing'
+          end
+        ]
+      end
     end
 
     # Callback function used by the RichTextDocument class to generate the
     # footer for the manual pages.
     def generateHTMLFooter
-      html = []
-      html << (div = XMLElement.new('div', 'align' => 'center',
-                                    'style' => 'font-size:10px;'))
-      div << XMLText.new("Copyright (c) #{AppConfig.copyright.join(', ')} by " +
-                         "#{AppConfig.authors.join(', ')}.")
-      div << XMLNamedText.new('TaskJuggler', 'a', 'href' => AppConfig.contact)
-      div << XMLText.new(' is a trademark of Chris Schlaeger.')
-
-      html
+      DIV.new('align' => 'center', 'style' => 'font-size:10px;') do
+        [
+          "Copyright (c) #{AppConfig.copyright.join(', ')} by " +
+          "#{AppConfig.authors.join(', ')}.",
+          A.new('href' => AppConfig.contact) do
+            'TaskJuggler'
+          end,
+          ' is a trademark of Chris Schlaeger.'
+        ]
+      end
     end
 
     # Callback function used by the RichTextDocument and KeywordDocumentation
@@ -149,37 +154,37 @@ class TaskJuggler
     # _succLabel_: Text for the reference to the next page. May be nil.
     # _succURL: URL to the next page.
     def generateHTMLNavigationBar(predLabel, predURL, succLabel, succURL)
-      html = []
-      html << XMLElement.new('br')
-      html << XMLElement.new('hr')
+      html = [ BR.new, HR.new ]
       if predLabel || succLabel
         # We use a tabel to get the desired layout.
-        html << (tab = XMLElement.new('table',
-          'style' => 'width:90%; margin-left:5%; margin-right:5%'))
-        tab << (tr = XMLElement.new('tr'))
-        tr << (td = XMLElement.new('td',
-          'style' => 'text-align:left; width:35%;'))
-        if predLabel
-          # Link to previous page.
-          td << XMLText.new('<< ')
-          td << XMLNamedText.new(predLabel, 'a', 'href' => predURL)
-          td << XMLText.new(' <<')
-        end
-        # Link to table of contents
-        tr << (td = XMLElement.new('td',
-          'style' => 'text-align:center; width:30%;'))
-        td << XMLNamedText.new('Table Of Contents', 'a', 'href' => 'toc.html')
-        tr << (td = XMLElement.new('td',
-          'style' => 'text-align:right; width:35%;'))
-        if succLabel
-          # Link to next page.
-          td << XMLText.new('>> ')
-          td << XMLNamedText.new(succLabel, 'a', 'href' => succURL)
-          td << XMLText.new(' >>')
-        end
-        html << XMLElement.new('hr')
+        html += [
+          TABLE.new('style' => 'width:90%; margin-left:5%; ' +
+                                       'margin-right:5%') do
+            TR.new do
+              [
+                TD.new('style' => 'text-align:left; width:35%;') do
+                  if predLabel
+                    # Link to previous page.
+                    [ '<< ', A.new('href' => predURL) { predLabel }, ' <<' ]
+                  end
+                end,
+                # Link to table of contents
+                TD.new('style' => 'text-align:center; width:30%;') do
+                  A.new('href' => 'toc.html') { 'Table Of Contents' }
+                end,
+                TD.new('style' => 'text-align:right; width:35%;') do
+                  if succLabel
+                    # Link to next page.
+                    [ '>> ', A.new('href' => succURL) { succLabel }, ' >>' ]
+                  end
+                end
+              ]
+            end
+          end,
+          HR.new
+        ]
       end
-      html << XMLElement.new('br')
+      html << BR.new
 
       html
     end
@@ -187,19 +192,22 @@ class TaskJuggler
     # Generate the top-level file for the HTML user manual.
     def generateHTMLindex(directory)
       html = HTMLDocument.new(:frameset)
-      head = html.generateHead("The #{AppConfig.softwareName} User Manual",
-                               { 'description' =>
-                                 'A reference and user manual for the ' +
-                                 'TaskJuggler project management software.',
-                                 'keywords' => 'taskjuggler, manual, reference'})
-      html << (frameset = XMLElement.new('frameset', 'cols' => '15%, 85%'))
-      frameset << (navFrames = XMLElement.new('frameset', 'rows' => '15%, 85%'))
-      navFrames << XMLElement.new('frame', 'src' => 'alphabet.html',
-                                  'name' => 'alphabet')
-      navFrames << XMLElement.new('frame', 'src' => 'navbar.html',
-                                  'name' => 'navigator')
-      frameset << XMLElement.new('frame', 'src' => 'toc.html',
-                                 'name' => 'display')
+      html.generateHead("The #{AppConfig.softwareName} User Manual",
+                        { 'description' =>
+                          'A reference and user manual for the ' +
+                          'TaskJuggler project management software.',
+                          'keywords' => 'taskjuggler, manual, reference'})
+      html << FRAMESET.new('cols' => '15%, 85%') do
+        [
+          FRAMESET.new('rows' => '15%, 85%') do
+            [
+              FRAME.new('src' => 'alphabet.html', 'name' => 'alphabet'),
+              FRAME.new('src' => 'navbar.html', 'name' => 'navigator')
+            ]
+          end,
+          FRAME.new('src' => 'toc.html', 'name' => 'display')
+        ]
+      end
 
       html.write(directory + 'index.html')
     end

data/lib/taskjuggler/WorkingHours.rb

@@ -60,11 +60,10 @@ class TaskJuggler
 
         # Create a new object with default working hours.
         @timezone = timeZone
-        # Set the default working hours. Monday to Friday 9am - 12pm, 1pm - 6pm.
+        # Set the default working hours. Monday to Friday 9am - 5pm.
         # Saturday and Sunday are days off.
         1.upto(5) do |day|
-          @days[day] = [ [ 9 * 60 * 60, 12 * 60 * 60 ],
-                         [ 13 * 60 * 60, 18 * 60 * 60 ] ]
+          @days[day] = [ [ 9 * 60 * 60, 17 * 60 * 60 ] ]
         end
       end
     end

data/lib/taskjuggler/XMLDocument.rb

@@ -22,13 +22,22 @@ class TaskJuggler
   class XMLDocument
 
     # Create an empty XML document.
-    def initialize
-      @elements = []
+    def initialize(&block)
+      @elements = block ? yield(block) : []
     end
 
     # Add a top-level XMLElement.
-    def <<(element)
-      @elements << element
+    def <<(arg)
+      if arg.is_a?(Array)
+        @elements += arg.flatten
+      elsif arg.nil?
+        # do nothing
+      elsif arg.is_a?(XMLElement)
+        @elements << arg
+      else
+        raise ArgumentError, "Unsupported argument of type #{arg.class}: " +
+                             "#{arg.inspect}"
+      end
     end
 
     # Produce the XMLDocument as String.

data/lib/taskjuggler/XMLElement.rb

@@ -20,7 +20,7 @@ class TaskJuggler
   class XMLElement
 
     # Construct a new XML element and include it in an existing XMLElement tree.
-    def initialize(name, attributes = {}, selfClosing = false)
+    def initialize(name, attributes = {}, selfClosing = false, &block)
       if (name.nil? && attributes.length > 0) ||
          (!name.nil? && !name.is_a?(String))
         raise "Name must be nil or a String "
@@ -32,9 +32,34 @@ class TaskJuggler
         end
       end
       @attributes = attributes
-      @children = []
       # This can be set to true if <name /> is legal for this element.
       @selfClosing = selfClosing
+
+      @children = block ? yield(block) : []
+      # Allow blocks with single elements not to be Arrays. They will be
+      # automatically converted into Arrays here.
+      unless @children.is_a?(Array)
+        @children = [ @children ]
+      else
+        @children.flatten!
+      end
+
+      # Convert all children that are text String objects into XMLText
+      # objects.
+      @children.collect! do |c|
+        c.is_a?(String) ? XMLText.new(c) : c
+      end
+
+      # Make sure we have no nil objects in the list.
+      @children.delete_if { |c| c.nil? }
+
+      # Now all children must be XMLElement objects.
+      @children.each do |c|
+        unless c.is_a?(XMLElement)
+          raise ArgumentError,
+            "Element must be of type XMLElement, not #{c.class}: #{c.inspect}"
+        end
+      end
     end
 
     # Add a new child or a set of new childs to the element.
@@ -43,13 +68,16 @@ class TaskJuggler
       # individually.
       if arg.is_a?(XMLElement)
         @children << arg
+      elsif arg.is_a?(String)
+        @children << XMLText.new(arg)
       elsif arg.is_a?(Array)
         # Delete all nil entries
         arg.delete_if { |i| i.nil? }
         # Check that the rest are really all XMLElement objects.
         arg.each do |i|
           unless i.is_a?(XMLElement)
-            raise "Element must be of type XMLElement not #{i.class}"
+            raise ArgumentError,
+              "Element must be of type XMLElement, not #{i.class}: #{i.inspect}"
           end
         end
         @children += arg

data/lib/taskjuggler/apps/Tj3.rb

@@ -24,6 +24,8 @@ class TaskJuggler
     def initialize
       super
 
+      # tj3 just requires Ruby 1.8.7. All other apps need 1.9.2.
+      @mininumRubyVersion = '1.8.7'
       # By default, we're only using 1 CPU core.
       @maxCpuCores = 1
       # Don't generate warnings for differences between time sheet data and
@@ -33,6 +35,10 @@ class TaskJuggler
       @checkSyntax = false
       # Don't generate reports when previous errors have been found.
       @forceReports = false
+      # Should a booking file be generated?
+      @freeze = false
+      # The cut-off date for the freeze
+      @freezeDate = TjTime.new.align(3600)
       # Don't generate any reports.
       @noReports = false
       # The directory where generated reports should be put in.
@@ -64,6 +70,22 @@ EOT
                 format('Generate reports despite scheduling errors')) do
           @forceReports = true
         end
+        @opts.on('--freeze',
+                 format('Generate or update the booking file for ' +
+                        'the project. The file will have the same ' +
+                        'base name as the project file but has a ' +
+                        '-bookings.tji extension.')) do
+          @freeze = true
+        end
+        @opts.on('--freezedate <date>', String,
+                 format('Use a different date than the current moment' +
+                        'as cut-off date for the booking file')) do |arg|
+          begin
+            @freezeDate = TjTime.new(arg).align(3600)
+          rescue TjException => msg
+            error("Invalid freeze date: #{msg}")
+          end
+        end
         @opts.on('--check-time-sheet <tji-file>', String,
                 format("Check the given time sheet")) do |arg|
           @timeSheets << arg
@@ -97,33 +119,43 @@ EOT
       end
     end
 
-    def main(argv = ARGV)
-      files = super
+    def appMain(files)
+      begin
+        if files.empty?
+          error('You must provide at least one .tjp file', 1)
+        end
 
-      tj = TaskJuggler.new(true)
-      tj.maxCpuCores = @maxCpuCores
-      tj.warnTsDeltas = @warnTsDeltas
-      keepParser = !@timeSheets.empty? || !@statusSheets.empty?
-      return 1 unless tj.parse(files, keepParser)
+        tj = TaskJuggler.new(true)
+        tj.maxCpuCores = @maxCpuCores
+        tj.warnTsDeltas = @warnTsDeltas
+        keepParser = !@timeSheets.empty? || !@statusSheets.empty?
+        return 1 unless tj.parse(files, keepParser)
 
-      return 0 if @checkSyntax
+        return 0 if @checkSyntax
 
-      if !tj.schedule
-        return 1 unless @forceReports
-      end
+        if !tj.schedule
+          return 1 unless @forceReports
+        end
 
-      # The checks of time and status sheets is probably only used for debugging.
-      # Normally, this function is provided by tj3client.
-      @timeSheets.each do |ts|
-        return 1 if !tj.checkTimeSheet(ts, File.read(ts)) || tj.errors > 0
-      end
-      @statusSheets.each do |ss|
-        return 1 if !tj.checkStatusSheet(ss, File.read(ss)) || tj.errors > 0
-      end
+        # The checks of time and status sheets is probably only used for
+        # debugging.  Normally, this function is provided by tj3client.
+        @timeSheets.each do |ts|
+          return 1 if !tj.checkTimeSheet(ts) || tj.errors > 0
+        end
+        @statusSheets.each do |ss|
+          return 1 if !tj.checkStatusSheet(ss) || tj.errors > 0
+        end
 
-      return 0 if @noReports
+        # Check for freeze mode and generate the booking file if requested.
+        tj.freeze(@freezeDate) if @freeze
 
-      return 1 if !tj.generateReports(@outputDir) || tj.errors > 0
+        return 0 if @noReports
+
+        return 1 if !tj.generateReports(@outputDir) || tj.errors > 0
+
+      rescue TjRuntimeError
+        return 1
+      end
 
       0
     end