taskjuggler 0.0.4 → 0.0.5

data/lib/RichTextElement.rb

@@ -13,9 +13,23 @@
 require 'UTF8String'
 require 'TjException'
 require 'XMLElement'
+require 'TextFormatter'
 
 class TaskJuggler
 
+  class RichTextImage
+
+    attr_reader :fileName
+    attr_accessor :altText, :verticalAlign
+
+    def initialize(fileName)
+      @fileName = fileName
+      @altText = nil
+      @verticalAlign = nil
+    end
+
+  end
+
   # The RichTextElement class models the nodes of the intermediate
   # representation that the RichTextParser generates. Each node can reference an
   # Array of other RichTextElement nodes, building a tree that represents the
@@ -39,8 +53,8 @@ class TaskJuggler
           @children = arg
         else
           unless arg.is_a?(RichTextElement) || arg.is_a?(String)
-            raise TjException.new,
-              "Element must be of type RichTextElement instead of #{arg.class}"
+            raise "Element must be of type RichTextElement instead of " +
+                  "#{arg.class}"
           end
           @children = [ arg ]
         end
@@ -128,44 +142,59 @@ class TaskJuggler
       case @category
       when :richtext
       when :title1
-        pre = "#{@data[0]} "
-        post = "\n\n"
+        return textBlockFormat(@richText.indent + @richText.titleIndent,
+                               sTitle(1), children_to_s,
+                               @richText.lineWidth) + "\n"
       when :title2
-        pre = "#{@data[0]}.#{@data[1]} "
-        post = "\n\n"
+        return textBlockFormat(@richText.indent + @richText.titleIndent,
+                               sTitle(2), children_to_s,
+                               @richText.lineWidth) + "\n"
       when :title3
-        pre = "#{@data[0]}.#{@data[1]}.#{@data[2]} "
-        post = "\n\n"
+        return textBlockFormat(@richText.indent + @richText.titleIndent,
+                               sTitle(3), children_to_s,
+                               @richText.lineWidth) + "\n"
       when :hline
-        return "#{'-' * (@richText.lineWidth - 4)}\n"
+        return "#{' ' * @richText.indent}" +
+               "#{'-' * (@richText.lineWidth - @richText.indent)}\n"
       when :paragraph
-        post = "\n\n"
+        return textBlockFormat(@richText.indent + @richText.parIndent,
+                               '', children_to_s, @richText.lineWidth) + "\n"
       when :pre
-        post = "\n"
+        return TextFormatter.new(@richText.lineWidth,
+                                 @richText.indent + @richText.preIndent).
+          indent(children_to_s) + "\n"
       when :bulletlist1
       when :bulletitem1
-        pre = '* '
-        post = "\n\n"
+        return textBlockFormat(@richText.indent + @richText.listIndent,
+                               '* ', children_to_s,
+                               @richText.lineWidth) + "\n"
       when :bulletlist2
       when :bulletitem2
-        pre = ' * '
-        post = "\n\n"
+        return textBlockFormat(@richText.indent + @richText.listIndent * 2,
+                               '* ', children_to_s,
+                               @richText.lineWidth) + "\n"
       when :bulletlist3
       when :bulletitem3
-        pre = '  * '
-        post = "\n\n"
+        return textBlockFormat(@richText.indent + @richText.listIndent * 3,
+                               '* ', children_to_s,
+                               @richText.lineWidth) + "\n"
       when :numberlist1
       when :numberitem1
-        pre = "#{@data[0]}. "
-        post = "\n\n"
+        return textBlockFormat(@richText.indent + @richText.listIndent,
+                               "#{@data[0]}. ", children_to_s,
+                               @richText.lineWidth) + "\n"
       when :numberlist2
       when :numberitem2
-        pre = "#{@data[0]}.#{@data[1]} "
-        post = "\n\n"
+        return textBlockFormat(@richText.indent + @richText.listIndent,
+                               "#{@data[0]}.#{@data[1]} ", children_to_s,
+                               @richText.lineWidth) + "\n"
       when :numberlist3
       when :numberitem3
-        pre = "#{@data[0]}.#{@data[1]}.#{@data[2]} "
-        post = "\n\n"
+        return textBlockFormat(@richText.indent + @richText.listIndent,
+                               "#{@data[0]}.#{@data[1]}.#{@data[2]} ",
+                               children_to_s, @richText.lineWidth) + "\n"
+      when :img
+        pre = @data.altText if @data.altText
       when :ref
       when :href
       when :blockfunc
@@ -248,6 +277,8 @@ class TaskJuggler
       when :numberitem3
         pre = "<li>#{@data[0]}.#{@data[1]}.#{@data[2]} "
         post = "</li>\n"
+      when :img
+        pre = "<img file=\"#{@data.fileName}\"/>"
       when :ref
         pre = "<ref data=\"#{@data}\">"
         post = '</ref>'
@@ -317,13 +348,16 @@ class TaskJuggler
         htmlTitle(3)
       when :hline
         noChilds = true
-        XMLElement.new('hr', attrs)
+        XMLElement.new('hr', attrs, true)
       when :paragraph
         XMLElement.new('p', attrs)
       when :pre
         noChilds = true
-        pre = XMLElement.new('pre')
+        attrs['codesection'] = '1'
+        div = XMLElement.new('div', attrs)
+        div << (pre = XMLElement.new('pre', attrs))
         pre << XMLText.new(@children[0])
+        div
       when :bulletlist1
         XMLElement.new('ul')
       when :bulletitem1
@@ -348,6 +382,13 @@ class TaskJuggler
         XMLElement.new('ol')
       when :numberitem3
         XMLElement.new('li')
+      when :img
+        el = XMLElement.new('img', 'src' => @data.fileName)
+        el['alt'] = @data.altText if @data.altText
+        if @data.verticalAlign
+          el['style'] = "vertical-align:#{@data.verticalAlign}; "
+        end
+        el
       when :ref
         XMLElement.new('a', 'href' => "#{@data}.html")
       when :href
@@ -419,6 +460,18 @@ class TaskJuggler
 
     private
 
+    def sTitle(level)
+      s = ''
+      if @richText.sectionNumbers
+        1.upto(level) do |i|
+          s += '.' unless s.empty?
+          s += "#{@data[i - 1]}"
+        end
+        s += ') '
+      end
+      s
+    end
+
     def htmlTitle(level)
       attrs = { 'id' => convertToID(children_to_s) }
       attrs['class'] = @richText.cssClass if @richText.cssClass
@@ -435,6 +488,15 @@ class TaskJuggler
       el
     end
 
+    def textBlockFormat(indent, label, str, width)
+      labLen = label.length
+      TextFormatter.new(width, indent + labLen, indent).format(label + str)
+    end
+
+    def textBlockIndent(indent, str, width)
+      TextFormatter.new(width, indent).indent(str)
+    end
+
   end
 
 end

data/lib/RichTextScanner.rb

@@ -71,6 +71,8 @@ class TaskJuggler
         return nextTokenFuncArg
       elsif @mode == :href
         return nextTokenHRef
+      elsif @mode == :ref
+        return nextTokenRef
       end
       if @beginOfLine && @mode == :wiki
         if (res = nextTokenWikiBOL)
@@ -159,12 +161,36 @@ class TaskJuggler
       token
     end
 
+    def nextTokenRef
+      c = nextChar
+      return [ '.', '<END' ] if c.nil?
+
+      return [ 'LITERAL', '|' ] if c == '|'
+
+      if c == ']' && peek == ']'
+        nextChar
+        @mode = :wiki
+        return [ 'REFEND', ']]' ]
+      end
+
+      token = c
+      while (c = nextChar)
+        break if c.nil?
+        if c == '|' || (c == ']' && peek == ']')
+          returnChar
+          break
+        end
+        token << c
+      end
+      [ 'WORD', token ]
+    end
+
     def nextTokenHRef
       token = [ '.', '<END>' ]
       while (c = nextChar)
         if c.nil?
           # We've reached the end of the text.
-          return [ '.', '<END>' ]
+          return token
         elsif c == ' ' || c == "\t" || c == "\n"
           # Sequences of tabs, spaces and newlines are treated as token
           # boundaries, but otherwise they are ignored.
@@ -313,6 +339,7 @@ class TaskJuggler
           @mode = :href
           [ 'HREF' , '[' ]
         else
+          @mode = :ref
           [ 'REF', '[[' ]
         end
       elsif c == ']' && peek == ']'
@@ -364,7 +391,7 @@ class TaskJuggler
         # The next character may be a control character.
         @beginOfLine = true
         [ 'LINEBREAK', "\n" ]
-      elsif "\n*# =-".include?(c)
+      elsif "\n*#=-".include?(c)
         # These characters correspond to the first characters of a block
         # element. When they are found at the begin of the line, the newline
         # was really a line break.
@@ -414,13 +441,13 @@ class TaskJuggler
       while (c = nextChar) && !" \n\t".include?(c)
         case @mode
         when :wiki
-          # Or at least to ' characters in a row.
+          # Or at least two ' characters in a row.
           break if c == "'" && peek == "'"
-          # Or a -, ] or <
+          # Or a ] or <
           break if ']<'.include?(c)
         when :href
           # Look for - of the end mark -> end ']'
-          break if c == '-' || c == ']' || c == '<'
+          break if '-]<'.include?(c)
         else
           # Make sure we find the </nowiki> tag even within a word.
           break if c == '<'

data/lib/RichTextSnip.rb

@@ -57,6 +57,11 @@ class TaskJuggler
       @richText.linkTarget = target
     end
 
+    # Set the CSS class.
+    def cssClass=(css)
+      @richText.cssClass = css
+    end
+
     # Generate a TableOfContents object from the section headers of the
     # RichTextSnip.
     def tableOfContents(toc, fileName)
@@ -74,10 +79,7 @@ class TaskJuggler
     # directory.
     def generateHTML(directory = '')
       html = HTMLDocument.new
-      html << (head = XMLElement.new('head'))
-      head << XMLNamedText.new(@name, 'title')
-      head << XMLElement.new('meta', 'http-equiv' => 'Content-Type',
-                             'content' => 'text/html; charset=utf-8')
+      head = html.generateHead(@name)
       head << @document.generateStyleSheet
 
       html << (body = XMLElement.new('body'))

data/lib/RichTextSyntaxRules.rb

@@ -225,14 +225,36 @@ class TaskJuggler
       pattern(%w( !plainText ), lambda {
         @val[0]
       })
-      pattern(%w( $REF $WORD !space !plainText $REFEND !space ), lambda {
-        el = RichTextElement.new(@richTextI, :ref,
-                                 RichTextElement.new(@richTextI,
-                                                     :text, @val[3].empty? ?
-                                                     @val[1] :
-                                                     @val[3].join(' ')))
-        el.data = @val[1]
-        el.appendSpace = !@val[5].empty?
+      pattern(%w( $REF !refToken !moreRefToken $REFEND !space ), lambda {
+        if @val[1].index(':')
+          protocol, locator = @val[1].split(':')
+        else
+          protocol = nil
+        end
+        el = nil
+        if protocol == 'File'
+          el = RichTextElement.new(@richTextI, :img)
+          el.data = img = RichTextImage.new(locator)
+          @val[2].each do |token|
+            if token[0, 4] == 'alt='
+              img.altText = token[4..-1]
+            elsif %w( top middle bottom baseline sub super text-top text-bottom).
+                  include?(token)
+              img.verticalAlign = token
+            else
+              error('rt_bad_file_option',
+                    "Unknown option '#{token}' for file reference " +
+                    "#{@val[1]}.")
+            end
+          end
+        else
+          el = RichTextElement.new(@richTextI, :ref,
+                                   RichTextElement.new(@richTextI,
+                                                       :text, @val[2].empty? ?
+                                                       @val[1] : @val[2]))
+          el.data = @val[1]
+          el.appendSpace = !@val[4].empty?
+        end
         el
       })
       pattern(%w( $HREF !wordWithQueries !space !plainTextWithQueries
@@ -245,6 +267,20 @@ class TaskJuggler
       })
     end
 
+    def rule_moreRefToken
+      repeatable
+      optional
+      pattern(%w( _| !refToken ), lambda {
+        @val[1]
+      })
+    end
+
+    def rule_refToken
+      pattern(%w( $WORD ), lambda {
+        @val[0]
+      })
+    end
+
     def rule_wordWithQueries
       repeatable
       pattern(%w( $WORD ), lambda {

data/lib/RuntimeConfig.rb

@@ -0,0 +1,93 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = RuntimeConfig.rb -- The TaskJuggler III Project Management Software
+#
+# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+#
+# 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 'yaml'
+
+# The RuntimeConfig searches for a YAML config file in a list of directories.
+# When a file is found it is read-in. The read-in config values are grouped in
+# a tree of sections. The values of a section can then be used to overwrite
+# the instance variable of a passed object.
+class RuntimeConfig
+
+  attr_accessor :debugMode
+
+  def initialize(appName, configFile = nil)
+    @appName = appName
+    @config = nil
+    @debugMode = false
+
+    if configFile
+      # Read user specified config file.
+      if File.exist?(configFile)
+        begin
+          @config = YAML::load(File.read(configFile))
+        rescue
+          $stderr.puts "Error in config file #{configFile}: #{$!}"
+          exit 1
+        end
+      else
+        $stderr.puts "Config file #{configFile} not found!"
+        exit 1
+      end
+    else
+      # Search config files in certain directories.
+      @path = [ '.', ENV['HOME'], '/etc' ]
+
+      @path.each do |path|
+        # Try UNIX style hidden file first, then .rc.
+        [ "#{path}/.#{appName}rc", "#{path}/#{appName}.rc" ].each do |file|
+          if File.exist?(file)
+            debug("Loading #{file}")
+            @config = YAML::load(File.read(file))
+            debug(@config.to_s)
+            break
+          end
+        end
+        break if @config
+      end
+    end
+  end
+
+  def configure(object, section)
+    debug("Configuring object of type #{object.class}")
+    sections = section.split('.')
+    p = @config
+    sections.each do |sec|
+      if p.nil? || !p.include?('_' + sec)
+        debug("Section #{section} not found in config file")
+        return false
+      end
+      p = p['_' + sec]
+    end
+
+    object.instance_variables.each do |iv|
+      ivName = iv[1..-1]
+      debug("Processing class variable #{ivName}")
+      if p.include?(ivName)
+        debug("Setting @#{ivName} to #{p[ivName]}")
+        object.instance_variable_set(iv, p[ivName])
+      end
+    end
+
+    true
+  end
+
+  private
+
+  def debug(message)
+    return unless @debugMode
+
+    puts message
+  end
+
+end
+

data/lib/Scoreboard.rb

@@ -95,11 +95,11 @@ class TaskJuggler
     end
 
     # Return a list of intervals that describe a contiguous part of the
-    # scoreboard that contains only the values listed in _targets_. The
-    # intervals must be within the interval described by _iv_ and must be at
-    # least _minDuration_ long. The return value is an Array of [ start, end ]
-    # TjTime values.
-    def collectTimeOffIntervals(iv, minDuration, targets)
+    # scoreboard that contains only the values that yield true for the passed
+    # block.  The intervals must be within the interval described by _iv_ and
+    # must be at least _minDuration_ long. The return value is an Array of [
+    # start, end ] TjTime values.
+    def collectIntervals(iv, minDuration)
       # Determine the start and stop index for the scoreboard search.
       startIdx = dateToIdx(iv.start, true)
       endIdx = dateToIdx(iv.end, true)
@@ -116,7 +116,7 @@ class TaskJuggler
 
       startIdx.upto(endIdx) do |idx|
         # Check whether the scoreboard slot matches any of the target values.
-        if targets.include?(@sb[idx])
+        if yield(@sb[idx])
           # If so, save the start position if this is the first slot and start
           # counting the matching slots.
           start = idx if start == 0

data/lib/SheetHandlerBase.rb

@@ -0,0 +1,215 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = SheetHandlerBase.rb -- The TaskJuggler III Project Management Software
+#
+# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+#
+# 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 'mail'
+
+require 'UTF8String'
+
+class TaskJuggler
+
+  class SheetHandlerBase
+
+    attr_accessor :workingDir, :dryRun
+
+    def initialize(appName)
+      @appName = appName
+      # User specific settings
+      @smtpServer= nil
+      @senderEmail = nil
+      @workingDir = nil
+      @scmCommand = nil
+      # The default project ID
+      @projectId = 'prj'
+
+      # Controls the amount of output that is sent to the terminal.
+      # 0: No output
+      # 1: only errors
+      # 2: errors and warnings
+      # 3: All messages
+      @outputLevel = 2
+      # Controls the amount of information that is added to the log file. The
+      # levels are identical to @outputLevel.
+      @logLevel = 3
+      # Set to true to not send any emails. Instead the email (header + body) is
+      # printed to the terminal.
+      @dryRun = false
+
+      @logFile = 'timesheets.log'
+      @emailFailure = false
+    end
+
+    # Extract the text between the cut-marker lines and remove any email
+    # quotes from the beginnin of the line.
+    def cutOut(text)
+      # Pattern for the section start marker
+      mark1 = /(.*)# --------8<--------8<--------/
+      # Pattern for the section end marker
+      mark2 = /# -------->8-------->8--------/
+      # The cutOut section
+      cutOutText = nil
+      quoteLen = 0
+      quoteMarks = emptyLine = ''
+      text.each_line do |line|
+        if cutOutText.nil?
+          # We are looking for the line with the start marker (mark1)
+          if (matches = mark1.match(line))
+            quoteMarks = matches[1]
+            quoteLen = quoteMarks.length
+            # Special case for quoted empty lines without trailing spaces.
+            emptyLine = quoteMarks.chomp.chomp(' ') + "\n"
+            cutOutText = line[quoteLen..-1]
+          end
+        else
+          # Remove quote marks from the beginning of the line.
+          line = line[quoteLen..-1] if line[0, quoteLen] == quoteMarks
+          line = "\n" if line == emptyLine
+
+          cutOutText << line
+          # We are gathering text until we hit the end marker (mark2)
+          return cutOutText if mark2.match(line)
+        end
+      end
+
+      # There are no cut markers. We just return the original text.
+      text
+    end
+
+    # Convert all CR+LF and CR line breaks into LF line breaks.
+    def fixLineBreaks(text)
+      out = ''
+      cr = false
+      text.each_utf8_char do |c|
+        if c == "\r"
+          # We don't know yet if it's a CR or CR+LF.
+          cr = true
+        else
+          if cr
+            # If we only found a CR. Replace it with a LF.
+            out << "\n" if c != "\n"
+            cr = false
+          end
+          out << c
+        end
+      end
+      out
+    end
+
+    def setWorkingDir
+      # Make sure the user has provided a properly setup config file.
+      error('\'smtpServer\' not configured') unless @smtpServer
+      error('\'senderEmail\' not configured') unless @senderEmail
+
+      # Change into the specified working directory
+      begin
+        Dir.chdir(@workingDir) if @workingDir
+      rescue
+        error("Working directory #{@workingDir} not found")
+      end
+    end
+
+    def addToScm(message, fileName)
+      return unless @scmCommand
+
+      cmd = @scmCommand.gsub(/%m/, message)
+      cmd.gsub!(/%f/, fileName)
+      `#{cmd}` unless @dryRun
+      if $? == 0
+        info("Added #{fileName} to SCM")
+      else
+        error("SCM command #{cmd} failed: #{$?}")
+      end
+    end
+
+    def info(message)
+      puts message if @outputLevel >= 3
+      log('INFO', message) if @logLevel >= 3
+    end
+
+    def warning(message)
+      puts message if @outputLevel >= 2
+      log('WARN', message) if @logLevel >= 2
+    end
+
+    def error(message)
+      $stderr.puts message if @outputLevel >= 1
+      log("ERROR", message) if @logLevel >= 1
+      exit 1
+    end
+
+    def log(type, message)
+      timeStamp = Time.new.strftime("%Y-%m-%d %H:%M:%S")
+      File.open(@logFile, 'a') do |f|
+        f.write("#{timeStamp} #{type} #{@appName}: #{message}\n")
+      end
+    end
+
+    def sendEmail(to, subject, message, attachment = nil, from = nil,
+                  inReplyTo = nil)
+      Mail.defaults do
+        delivery_method :smtp, {
+          :address => @smtpServer,
+          :port => 25
+        }
+      end
+
+      begin
+        mail = Mail.new do
+          subject subject
+          text_part do
+            content_type [ 'text', 'plain', { 'charset' => 'UTF-8' } ]
+            content_transfer_encoding 'quoted-printable'
+            body message.to_quoted_printable
+          end
+        end
+        mail.to = to
+        mail.from = from || @senderEmail
+        mail.in_reply_to = inReplyTo if inReplyTo
+        mail['User-Agent'] = "#{AppConfig.softwareName}/#{AppConfig.version}"
+        mail['X-TaskJuggler'] = @appName
+        if attachment
+          mail.add_file ({
+            :filename => File.basename(attachment),
+            :content => File.read(attachment)
+          })
+        end
+        #raise "Mail header problem" unless mail.errors.empty?
+      rescue
+        @emailFailure = true
+        error("Email processing failed: #{$!}")
+      end
+
+      if @dryRun
+        # For testing and debugging, we only print out the email.
+        puts mail.to_s
+        log('INFO', "Show email '#{subject}' to #{to}")
+      else
+        # Actually send out the email via SMTP.
+        begin
+          mail.deliver
+        rescue
+          # We try to send out another email. If that fails again, we abort
+          # without further attempts.
+          if @emailFailure
+            log('ERROR', "Email double fault: #{$!}")
+            exit 1
+          else
+            @emailFailure = true
+            error("Email transmission failed: #{$!}")
+          end
+        end
+        log('INFO', "Sent email '#{subject}' to #{to}")
+      end
+    end
+
+  end
+
+end