taskjuggler 0.0.2 → 0.0.3

data/lib/Journal.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = WorkingHours.rb -- The TaskJuggler III Project Management Software
+#
+# Copyright (c) 2006, 2007, 2008, 2009 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.
+#
+
+class TaskJuggler
+
+  class JournalEntry
+
+    attr_reader :date, :headline, :property
+    attr_accessor :intro, :more
+
+    def initialize(journal, date, headline, property)
+      @journal = journal
+      @journal.addEntry(self)
+      @date = date
+      @headline = headline
+      @property = property
+      @intro = nil
+      @more = nil
+    end
+
+  end
+
+  class Journal
+
+    def initialize
+      @entries = []
+    end
+
+    def addEntry(entry)
+      @entries << entry
+    end
+
+  end
+
+end

data/lib/{LogicalFlag.rb → KeywordArray.rb}

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby -w
 # encoding: UTF-8
 #
-# = LogicalFlag.rb -- The TaskJuggler III Project Management Software
+# = KeywordArray.rb -- The TaskJuggler III Project Management Software
 #
 # Copyright (c) 2006, 2007, 2008, 2009 by Chris Schlaeger <cs@kde.org>
 #
@@ -10,22 +10,14 @@
 # published by the Free Software Foundation.
 #
 
-require 'LogicalOperation'
-
 class TaskJuggler
 
-  class LogicalFlag < LogicalOperation
-
-    def initialize(opnd)
-      super
-    end
+  class KeywordArray < Array
 
-    def eval(expr)
-      expr.property['flags', 0].include?(@operand1)
-    end
+    alias a_include? include?
 
-    def to_s
-      @operand1
+    def include?(keyword)
+      self[0] == '*' || a_include?(keyword)
     end
 
   end

data/lib/KeywordDocumentation.rb

@@ -30,8 +30,8 @@ class TaskJuggler
   class KeywordDocumentation
 
     attr_reader :keyword, :pattern, :references
-    attr_accessor :contexts, :scenarioSpecific, :inheritable,
-                  :predecessor, :successor
+    attr_accessor :contexts, :scenarioSpecific, :inheritedFromProject,
+                  :inheritedFromParent, :predecessor, :successor
 
     # Construct a new KeywordDocumentation object. _rule_ is the
     # TextParser::Rule and _pattern_ is the corresponding TextParser::Pattern.
@@ -53,7 +53,8 @@ class TaskJuggler
       # keyword documentation of the optional attribute.
       @optionalAttributes = []
       @scenarioSpecific = false
-      @inheritable = false
+      @inheritedFromProject= false
+      @inheritedFromParent = false
       @contexts = []
       @seeAlso = []
       # The following are references to the neighboring keyword in an
@@ -104,7 +105,7 @@ class TaskJuggler
     def computeInheritance(keywords, rules)
       property = nil
       @contexts.each do |kwd|
-        if %w( task resource account shift scenario).include?(kwd.keyword)
+        if %w( task resource account report shift scenario).include?(kwd.keyword)
           property = kwd.keyword
           break
         end
@@ -118,12 +119,17 @@ class TaskJuggler
                         project.resources
                       when 'account'
                         project.accounts
+                      when 'report'
+                        project.reports
                       when 'shift'
                         project.shifts
                       when 'scenario'
                         project.scenarios
                       end
-        @inheritable = propertySet.inheritable?(keyword)
+        keyword = @keyword
+        keyword = keyword.split('.')[0] if keyword.include?('.')
+        @inheritedFromProject = propertySet.inheritedFromProject?(keyword)
+        @inheritedFromParent = propertySet.inheritedFromParent?(keyword)
       end
     end
 
@@ -148,7 +154,7 @@ class TaskJuggler
       # Top line with multiple elements
       str = "Keyword:     #{@keyword}     " +
             "Scenario Specific: #{@scenarioSpecific ? 'Yes' : 'No'}    " +
-            "Inheritable: #{@inheritable ? 'Yes' : 'No'}\n\n"
+            "Inherited: #{@inheritedFromParent ? 'Yes' : 'No'}\n\n"
 
       str += "Purpose:     #{format(tagW, newRichText(@pattern.doc).to_s,
                                     textW)}\n\n"
@@ -203,12 +209,37 @@ class TaskJuggler
         @optionalAttributes.sort! do |a, b|
           a.keyword <=> b.keyword
         end
+        showLegend = false
         @optionalAttributes.each do |attr|
           unless attrStr.empty?
             attrStr += ', '
           end
-          attrStr += '[sc:]' if attr.scenarioSpecific
           attrStr += attr.keyword
+          if attr.scenarioSpecific || attr.inheritedFromProject ||
+             attr.inheritedFromParent
+            first = true
+            showLegend = true
+            attrStr += '['
+            if attr.scenarioSpecific
+              attrStr += 'sc'
+              first = false
+            end
+            if attr.inheritedFromProject
+              attrStr += ':' unless first
+              attrStr += 'ig'
+              first = false
+            end
+            if attr.inheritedFromParent
+              attrStr += ':' unless first
+              attrStr += 'ip'
+            end
+            attrStr += ']'
+          end
+        end
+        if showLegend
+          attrStr += "\n\n[sc] : Attribute is scenario specific" +
+                     "\n[ig] : Attribute is inherited from global attribute" +
+                     "\n[ip] : Attribute is inherited from parent property"
         end
         str += format(tagW, attrStr, textW)
         str += "\n"
@@ -288,10 +319,14 @@ class TaskJuggler
               tr1 << XMLNamedText.new("#{arg.name}", 'td', 'width' => '30%')
             else
               typeSpec = arg.typeSpec
+              typeName = typeSpec[1..-2]
               typeSpec[0] = '['
               typeSpec[-1] = ']'
-              tr1 << XMLNamedText.new("#{arg.name} #{typeSpec}", 'td',
-                                    'width' => '30%')
+              tr1 << (td = XMLElement.new('td', 'width' => '30%'))
+              td << XMLText.new("#{arg.name} [")
+              td << XMLNamedText.new(
+                typeName, 'a', 'href' => "Getting_Started.html\##{typeName}")
+              td << XMLText.new(']')
             end
             tr1 << (td = XMLElement.new('td',
               'style' => 'margin-top:2px; margin-bottom:2px;'))
@@ -340,52 +375,55 @@ class TaskJuggler
         @optionalAttributes.sort! do |a, b|
           a.keyword <=> b.keyword
         end
-        hasScenSpec = hasInheritable = false
-        none = []
-        scenSpec = []
-        inheritable = []
-        scenSpecInheritable = []
+
+        showDetails = false
         @optionalAttributes.each do |attr|
-          if attr.inheritable
-            hasInheritable = true
-            if attr.scenarioSpecific
-              hasScenSpec = true
-              scenSpecInheritable << attr
-            else
-              inheritable << attr
-            end
-          else
-            if attr.scenarioSpecific
-              hasScenSpec = true
-              scenSpec << attr
-            else
-              none << attr
-            end
+          if attr.scenarioSpecific || attr.inheritedFromProject ||
+             attr.inheritedFromParent
+            showDetails = true
+            break
           end
         end
+
         bbox << (p = XMLElement.new('p'))
         p << (tab = XMLElement.new('table', 'align' => 'center',
-                                 'class' => 'table'))
+                                   'class' => 'table'))
         tab << (tr = XMLElement.new('tr', 'align' => 'left'))
-        tr << XMLNamedText.new('Attributes', 'td', 'class' => 'tag',
-                               'style' => 'width:15%')
-        if hasScenSpec || hasInheritable
-          tr << XMLNamedText.new('Scenario specific', 'td', 'class' => 'tag',
-                                 'style' => 'width:42%')
-          tr << XMLNamedText.new('Not scenario specific', 'td', 'class' => 'tag',
-                                 'style' => 'width:43%')
-          tab << (tr = XMLElement.new('tr', 'align' => 'left'))
-          tr << XMLNamedText.new('Inheritable', 'td', 'class' => 'tag',
+        if showDetails
+          # Table of all attributes with checkmarks for being scenario
+          # specific, inherited from parent and inherited from global scope.
+          tr << XMLNamedText.new('Attributes', 'td', 'class' => 'tag',
+                                 'rowspan' =>
+                                 "#{@optionalAttributes.length + 1}",
+                                 'style' => 'width:15%')
+          tr << XMLNamedText.new('Name', 'td', 'class' => 'tag',
+                                 'style' => 'width:40%')
+          tr << XMLNamedText.new('Scen. spec.', 'td', 'class' => 'tag',
                                  'style' => 'width:15%')
-          tr << listHTMLAttributes(scenSpecInheritable, 42)
-          tr << listHTMLAttributes(inheritable, 43)
-          tab << (tr = XMLElement.new('tr', 'align' => 'left'))
-          tr << XMLNamedText.new('Not inheritable', 'td', 'class' => 'tag',
+          tr << XMLNamedText.new('Inh. fm. Global', 'td', 'class' => 'tag',
                                  'style' => 'width:15%')
-          tr << listHTMLAttributes(scenSpec, 42)
-          tr << listHTMLAttributes(none, 43)
+          tr << XMLNamedText.new('Inh. fm. Parent', 'td', 'class' => 'tag',
+                                 'style' => 'width:15%')
+          @optionalAttributes.each do |attr|
+            tab << (tr = XMLElement.new('tr', 'align' => 'left'))
+            tr << (td = XMLElement.new('td', 'class' => 'descr'))
+            keywordHTMLRef(td, attr)
+            tr << (td = XMLElement.new('td', 'align' => 'center',
+                                       'class' => 'descr'))
+            td << XMLText.new('x') if attr.scenarioSpecific
+            tr << (td = XMLElement.new('td', 'align' => 'center',
+                                       'class' => 'descr'))
+            td << XMLText.new('x') if attr.inheritedFromProject
+            tr << (td = XMLElement.new('td', 'align' => 'center',
+                                       'class' => 'descr'))
+            td << XMLText.new('x') if attr.inheritedFromParent
+          end
         else
-          tr << (td = XMLElement.new('td', 'class' => 'descr'))
+          # Comma separated list of all attributes.
+          tr << XMLNamedText.new('Attributes', 'td', 'class' => 'tag',
+                                 'style' => 'width:15%')
+          tr << (td = XMLElement.new('td', 'class' => 'descr',
+                                     'style' => 'width:85%'))
           first = true
           @optionalAttributes.each do |attr|
             if first
@@ -393,7 +431,6 @@ class TaskJuggler
             else
               td << XMLText.new(', ')
             end
-            td << XMLText.new('[sc:]') if attr.scenarioSpecific
             keywordHTMLRef(td, attr)
           end
         end

data/lib/Limits.rb

@@ -120,7 +120,9 @@ class TaskJuggler
     # The objects need access to some project specific data like the project
     # period.
     def setProject(project)
-      raise "Cannot change project after limits have been set!" unless @limits.empty?
+      unless @limits.empty?
+        raise "Cannot change project after limits have been set!"
+      end
       @project = project
     end
 
@@ -174,13 +176,13 @@ class TaskJuggler
         period = 60 * 60 * 24
         upper = false
       when 'weeklymax'
-        interval.start = interval.start.beginOfWeek(@project['weekstartsmonday'])
-        interval.end = interval.end.beginOfWeek(@project['weekstartsmonday'])
+        interval.start = interval.start.beginOfWeek(@project['weekStartsMonday'])
+        interval.end = interval.end.beginOfWeek(@project['weekStartsMonday'])
         period = 60 * 60 * 24 * 7
         upper = true
       when 'weeklymin'
-        interval.start = interval.start.beginOfWeek(@project['weekstartsmonday'])
-        interval.end = interval.end.beginOfWeek(@project['weekstartsmonday'])
+        interval.start = interval.start.beginOfWeek(@project['weekStartsMonday'])
+        interval.end = interval.end.beginOfWeek(@project['weekStartsMonday'])
         period = 60 * 60 * 24 * 7
         upper = false
       when 'monthlymax'

data/lib/LogicalExpression.rb

@@ -12,11 +12,11 @@
 
 require 'LogicalOperation'
 require 'Attributes'
-require 'LogicalFlag'
 require 'LogicalFunction'
 
 class TaskJuggler
 
+
   # A LogicalExpression is an object that describes tree of LogicalOperation
   # objects and the context that it should be evaluated in.
   class LogicalExpression

data/lib/LogicalOperation.rb

@@ -114,5 +114,38 @@ class TaskJuggler
 
   end
 
+  class LogicalAttribute < LogicalOperation
+
+    def initialize(attribute, scenario)
+      @scenarioIdx = scenario
+      super
+    end
+
+    def LogicalAttribute::tjpId
+      'logical'
+    end
+
+    def eval(expr)
+      expr.property[@operand1, @scenarioIdx]
+    end
+
+  end
+
+  class LogicalFlag < LogicalOperation
+
+    def initialize(opnd)
+      super
+    end
+
+    def eval(expr)
+      expr.property['flags', 0].include?(@operand1)
+    end
+
+    def to_s
+      @operand1
+    end
+
+  end
+
 end