taskjuggler 0.0.2 → 0.0.3

data/examples/tutorial.tjp

@@ -5,12 +5,12 @@
  * TaskJuggler. Please see the TaskJuggler manual for a more detailed
  * description of the various syntax elements.
  */
-project acso "Accounting Software" "1.0" 2002-01-16 - 2002-04-28 {
+project "Accounting Software"  2002-01-16 +4m {
   # Hide the clock time. Only show the date.
   timeformat "%Y-%m-%d"
   # Use US format for numbers
   numberformat "-" "" "," "." 1
-  # Use US financial format for currency values. Don't show pence.
+  # Use US financial format for currency values. Don't show cents.
   currencyformat "(" ")" "," "." 0
   # Pick a day during the project that will be reported as 'today' in
   # the project reports. If not specified, the current day will be
@@ -41,7 +41,6 @@ rate 390.0
 
 # Register Good Friday as a global holiday for all resources.
 vacation "Good Friday" 2002-03-29
-
 flags team
 
 # This is one way to form teams
@@ -223,11 +222,13 @@ task AcSo "Accounting Software" {
     task prev "Technology Preview" {
       depends !!software.backend
       startcredit 31000.0
+      note "All '''major''' features should be usable."
     }
 
     task beta "Beta version" {
       depends !!test.alpha
       charge 13000.0 onstart
+      note "Fully functional, may contain bugs."
     }
 
     task done "Ship Product to Customer" {
@@ -239,6 +240,7 @@ task AcSo "Accounting Software" {
       # maxend 2002-04-17
       depends !!test.beta, !!manual
       charge 33000.0 onstart
+      note "All priority 1 and 2 bugs must be fixed."
     }
   }
 }
@@ -248,23 +250,49 @@ task AcSo "Accounting Software" {
 # scheduled. But no reports would be generated to visualize the
 # results.
 
-# A traditional Gantt chart with a project overview.
-htmltaskreport "ProjectPlanOverview.html" {
-  prolog '
-== Accounting Software Project ==
-----
-=== Project Overview ===
+navigator navbar {
+  hidereport 0
+}
 
-The project is structured into 3 phases.
+textreport "Overview" {
+  formats html
+  header -8<-
+    == Accounting Software Project ==
+    ----
+    <[navigator id="navbar"]>
+    ----
+  ->8-
+  center '<[report id="overview"]>'
+
+  textreport "Development" {
+    center '<[report id="development"]>'
+  }
 
-# Specification
-# [[Development]]
-# Testing
+  textreport "Deliveries" {
+    center '<[report id="deliveries"]>'
+  }
 
-=== Project Plan ===
-'
+  textreport "ContactList" {
+    center '<[report id="contactList"]>'
+  }
+  textreport "Resource Graph" {
+    center '<[report id="resourceGraph"]>'
+  }
+}
 
-  headline "Project Plan Overview"
+# A traditional Gantt chart with a project overview.
+taskreport overview "" {
+  header -8<-
+    === Project Overview ===
+    
+    The project is structured into 3 phases.
+    
+    # Specification
+    # [[Development]]
+    # Testing
+    
+    === Project Plan ===
+  ->8-
   columns hierarchindex, name, start, end, effort, duration, cost,
           revenue, chart
   # For this report we like to have the abbreviated weekday in front
@@ -273,48 +301,43 @@ The project is structured into 3 phases.
   loadunit days
   hideresource 1
   balance cost rev
-  caption '
-All effort values are in man days.
-'
-
-  epilog '
-=== Staffing ===
-
-All project phases are properly staffed. See [[ResourceGraph]] for
-detailed resource allocations.
-
-=== Current Status ===
-
-The project started off with a delay of 4 days. This slightly affected
-the original schedule. See [[Deliveries]] for the impact on the
-delivery dates.
-'
+  caption 'All effort values are in man days.'
+
+  footer -8<-
+    === Staffing ===
+    
+    All project phases are properly staffed. See [[ResourceGraph]] for
+    detailed resource allocations.
+    
+    === Current Status ===
+    
+    The project started off with a delay of 4 days. This slightly affected
+    the original schedule. See [[Deliveries]] for the impact on the
+    delivery dates.
+  ->8-
 }
 
 # A list of tasks showing the resources assigned to each task.
-htmltaskreport "Development.html" {
+taskreport development "" {
   headline "Development - Resource Allocation Report"
   columns hierarchindex, name, start, end, effort { title "Work" },
           duration, chart { scale day }
   timeformat "%Y-%m-%d"
-  loadunit days
   hideresource ~isleaf()
   sortresources name.up
 }
 
 # A list of all tasks with the percentage completed for each task
-htmltaskreport "Deliveries.html" {
+taskreport deliveries "" {
   headline "Project Deliveries"
-  columns hierarchindex, name, start, end, complete, chart
-  timeformat "%a %Y-%m-%d"
+  columns hierarchindex, name, start, end, note, complete, chart
   taskroot AcSo.deliveries
   loadunit days
   hideresource 1
   scenarios plan, delayed
 }
-
 # A list of all employees with their contact details.
-htmlresourcereport "ContactList.html" {
+resourcereport contactList "" {
   headline "Contact list and duty plan"
   columns name, Email { cellurl "mailto:$${Email}" }, Phone,
           chart { scale day }
@@ -325,37 +348,10 @@ htmlresourcereport "ContactList.html" {
 
 # A graph showing resource allocation. It identifies whether each
 # resource is under- or over-allocated for.
-htmlresourcereport "ResourceGraph.html" {
+resourcereport resourceGraph "" {
   headline "Resource Allocation Graph"
   columns no, name, effort, rate, weekly #, utilization, freeload, chart
   loadunit shortauto
   hidetask ~isleaf()
   sorttasks plan.start.up
 }
-
-# A list of all project resources, both human and material resources,
-# together with the associated costs.
-htmlresourcereport "ResourceSheet.html" {
-  headline "Resource Sheet"
-  columns no, name, id, effort, weekly, rate, cost
-  loadunit days
-  hidetask ~isleaf()
-  sorttasks plan.start.up
-  balance cost rev
-}
-
-# A list of resources and each task associated with each resource.
-htmlresourcereport "ResourceUsage.html" {
-  headline "Resource Usage Report"
-  columns no, name, chart { scale day } #, utilization, freeload, cost, chart
-  loadunit days
-  sorttasks plan.start.up
-  hidetask ~isleaf()
-  end 2002-02-10
-}
-
-csvtaskreport "csvtest.csv" {
-  columns no, name, id, effort, revenue, cost
-  loadunit days
-}
-

data/lib/AttributeBase.rb

@@ -10,6 +10,8 @@
 # published by the Free Software Foundation.
 #
 
+require 'deep_copy'
+
 class TaskJuggler
 
   # This class is the base for all property attribute types. Each property can
@@ -21,8 +23,8 @@ class TaskJuggler
   # The class can track wheter the attribute value was provided by the project
   # file, inherited from another property or computed during scheduling.
   #
-  # Attributes that are of an inheritable type will be copied from a parent
-  # property.
+  # Attributes that are of an inherited type will be copied from a parent
+  # property or the global scope.
   class AttributeBase
     attr_reader :property, :type, :provided, :inherited, :value
 
@@ -38,39 +40,19 @@ class TaskJuggler
       # Flat that marks whether the value of this attribute was provided by the
       # user (in contrast to being calculated).
       @provided = false
-      # Some types can provide the default value as result of a initValue()
-      # method. If that does not exists, the default value from the
-      # AttributeDefinition.
-      if respond_to?('initValue')
-        @value = initValue(@type.default)
-      else
-        @value = @type.default
-      end
-      # The mode is flag that controls how value assignements affect the flags.
+      # Create the initial value according to the specified default for this
+      # type.
+      @value = @type.default.deep_clone
+      # The mode is flag that controls how value assignments affect the flags.
       @@mode = 0
     end
 
-    # Call this function to inherit _value_ from another property. It is very
-    # important that the values are deep copied as they may be modified later
-    # on.
+    # Call this function to inherit _value_ from the parent property. It is
+    # very important that the values are deep copied as they may be modified
+    # later on.
     def inherit(value)
       @inherited = true
-      if value.is_a?(Fixnum) || value.is_a?(Float) ||
-         value.is_a?(TrueClass) || value.is_a?(FalseClass)
-        @value = value
-      elsif value.is_a?(Limits)
-        @value = Limits.new(value)
-      elsif value.is_a?(ShiftAssignments)
-        @value = ShiftAssignments.new(value)
-      elsif value.is_a?(String) || value.is_a?(TjTime)
-        @value = value.clone
-      elsif value.is_a?(WorkingHours)
-        @value = WorkingHours.new(value)
-      elsif value.is_a?(Array)
-        @value = Array.new(value)
-      else
-        raise "Don't know how to copy values of class #{value.class}"
-      end
+      @value = value.deep_clone
     end
 
     # Change the @@mode. 0 means values are provided, 1 means values are
@@ -127,5 +109,19 @@ class TaskJuggler
 
   end
 
-end
+  # The ListAttributeBase is a specialized form of AttributeBase for a list of
+  # values instead of a single value. It will be used as a base class for all
+  # attributes that hold lists.
+  class ListAttributeBase < AttributeBase
 
+    def initialize(property, type)
+      super
+    end
+
+    def to_s
+      @value.join(', ')
+    end
+
+  end
+
+end

data/lib/AttributeDefinition.rb

@@ -17,28 +17,33 @@ class TaskJuggler
   # these bits of information, the PropertySet objects generate the attribute
   # lists for each PropertyTreeNode upon creation of the node.
   class AttributeDefinition
-    attr_reader :id, :name, :objClass, :inheritable, :scenarioSpecific,
-                :userDefined, :default
+    attr_reader :id, :name, :objClass, :inheritedFromParent,
+                :inheritedFromProject, :scenarioSpecific, :userDefined, :default
 
     # Create a new AttributeDefinition. _id_ is the ID of the attribute. It must
     # be unique within the PropertySet where it is used. _name_ is a more
     # descriptive text that will be used in report columns and the like.
     # _objClass_ is a reference to the class (not the object itself) of the
     # attribute. The possible classes all have names ending in Attribute.
-    # _inheritable_ is a boolean flag that needs to be true if the node can
-    # inherit the setting from the attribute of the parent node.
+    # _inheritedFromParent_ is a boolean flag that needs to be true if the
+    # node can inherit the setting from the attribute of the parent node.
+    # _inheritedFromProject_ is a boolen flag that needs to be true if the
+    # node can inherit the setting from an attribute in the global scope.
     # _scenarioSpecific_ is a boolean flag that is set to true if the attribute
     # can have different values for each scenario. _default_ is the default
     # value that is set upon creation of the attribute.
-    def initialize(id, name, objClass, inheritable, scenarioSpecific, default,
-                   userDefined = false)
+    def initialize(id, name, objClass, inheritedFromParent, inheritedFromProject,
+                   scenarioSpecific, default, userDefined = false)
       @id = id
       @name = name
       @objClass = objClass
-      @inheritable = inheritable
+      @inheritedFromParent = inheritedFromParent
+      @inheritedFromProject = inheritedFromProject
       @scenarioSpecific = scenarioSpecific
       @default = default
       @userDefined = userDefined
+      # Prevent objects from being deep copied.
+      freeze
     end
 
   end

data/lib/Attributes.rb

@@ -21,9 +21,28 @@ require 'WorkingHours'
 
 class TaskJuggler
 
+  class AccountAttribute < AttributeBase
+    def initialize(property, type)
+      super
+    end
+
+    def AccountAttribute::tjpId
+      'account'
+    end
+
+    def to_s
+      @value ? @value.id : ''
+    end
+
+    def to_tjp
+      @value ? @value.id : ''
+    end
+
+  end
+
   class AllocationAttribute < AttributeBase
     def initialize(property, type)
-      super(property, type)
+      super
 
       @value = Array.new
     end
@@ -93,7 +112,7 @@ class TaskJuggler
 
   class BooleanAttribute < AttributeBase
     def initialize(property, type)
-      super(property, type)
+      super
     end
 
     def BooleanAttribute::tjpId
@@ -112,7 +131,7 @@ class TaskJuggler
 
   class ChargeListAttribute < AttributeBase
     def initialize(property, type)
-      super(property, type)
+      super
     end
 
     def ChargeListAttribute::tjpId
@@ -130,7 +149,7 @@ class TaskJuggler
   class ChargeSetListAttribute < AttributeBase
 
     def initialize(property, type)
-      super(property, type)
+      super
 
       @value = Array.new
     end
@@ -153,9 +172,26 @@ class TaskJuggler
 
   end
 
+  class ColumnListAttribute < AttributeBase
+
+    def initialize(property, type)
+      super
+
+      @value = Array.new
+    end
+
+    def ColumnListAttribute::tjpId
+      'columns'
+    end
+
+    def to_s
+      "TODO"
+    end
+  end
+
   class DateAttribute < AttributeBase
     def initialize(property, type)
-      super(property, type)
+      super
     end
 
     def DateAttribute::tjpId
@@ -163,9 +199,15 @@ class TaskJuggler
     end
   end
 
+  class DefinitionListAttribute < ListAttributeBase
+    def initialize(property, type)
+      super
+    end
+  end
+
   class DependencyListAttribute < AttributeBase
     def initialize(property, type)
-      super(property, type)
+      super
 
       @value = Array.new
     end
@@ -190,7 +232,7 @@ class TaskJuggler
 
   class DurationAttribute < AttributeBase
     def initialize(property, type)
-      super(property, type)
+      super
     end
 
     def DurationAttribute::tjpId
@@ -205,7 +247,7 @@ class TaskJuggler
 
   class FixnumAttribute < AttributeBase
     def initialize(property, type)
-      super(property, type)
+      super
     end
 
     def FixnumAttribute::tjpId
@@ -215,7 +257,7 @@ class TaskJuggler
 
   class FlagListAttribute < AttributeBase
     def initialize(property, type)
-      super(property, type)
+      super
 
       @value = Array.new
     end
@@ -236,7 +278,7 @@ class TaskJuggler
 
   class FloatAttribute < AttributeBase
     def initialize(property, type)
-      super(property, type)
+      super
     end
 
     def FloatAttribute::tjpId
@@ -249,9 +291,21 @@ class TaskJuggler
 
   end
 
+  class FormatListAttribute < AttributeBase
+
+    def initialize(property, type)
+      super
+    end
+
+    def to_s
+      @value.join(', ')
+    end
+
+  end
+
   class IntervalListAttribute < AttributeBase
     def initialize(property, type)
-      super(property, type)
+      super
 
       @value = Array.new
     end
@@ -277,7 +331,7 @@ class TaskJuggler
   class LimitsAttribute < AttributeBase
 
     def initialize(property, type)
-      super(property, type)
+      super
     end
 
     def setProject(project)
@@ -294,20 +348,32 @@ class TaskJuggler
 
   end
 
+  class LogicalExpressionAttribute < AttributeBase
 
-  class LogicalAttribute
+    def initialize(property, type)
+      super
+    end
 
-    def initialize(attribute, scenario)
-      @scenarioIdx = scenario
-      super(attribute)
+    def LogicalExpressionAttribute::tjpId
+      'logicalexpression'
     end
 
-    def LogicalAttribute::tjpId
-      'logical'
+  end
+
+  class PropertyAttribute < AttributeBase
+    def initialize(property, type)
+      super
+    end
+
+    def PropertyAttribute::tjpId
+      'property'
     end
+  end
+
+  class RealFormatAttribute < AttributeBase
 
-    def eval(expr)
-      expr.property[@operand1, @scenarioIdx]
+    def initialize(property, type)
+      super
     end
 
   end
@@ -320,11 +386,19 @@ class TaskJuggler
     def ReferenceAttribute::tjpId
       'reference'
     end
+
+    def url
+      @value ? @value[0] : nil
+    end
+
+    def label
+      @value ? @value[1][0] : nil
+    end
   end
 
   class ResourceListAttribute < AttributeBase
     def initialize(property, type)
-      super(property, type)
+      super
 
       @value = Array.new
     end
@@ -349,7 +423,7 @@ class TaskJuggler
 
   class RichTextAttribute < AttributeBase
     def initialize(property, type)
-      super(property, type)
+      super
     end
 
     def RichTextAttribute::tjpId
@@ -362,10 +436,26 @@ class TaskJuggler
 
   end
 
+  class ScenarioListAttribute < AttributeBase
+    def initialize(property, type)
+      super
+    end
+
+    def ScenarioListAttribute::tjpId
+      'scenarios'
+    end
+
+    def to_s
+      @value.join(', ')
+    end
+
+  end
+
+
   class ShiftAssignmentsAttribute < AttributeBase
 
     def initialize(property, type)
-      super(property, type)
+      super
     end
 
     def setProject(project)
@@ -382,9 +472,23 @@ class TaskJuggler
 
   end
 
+  class SortListAttribute < AttributeBase
+
+    def initialize(property, type)
+      super
+
+      @value = Array.new
+    end
+
+    def SortListAttribute::tjpId
+      'sorting'
+    end
+
+  end
+
   class StringAttribute < AttributeBase
     def initialize(property, type)
-      super(property, type)
+      super
     end
 
     def StringAttribute::tjpId
@@ -399,7 +503,7 @@ class TaskJuggler
 
   class SymbolAttribute < AttributeBase
     def initialize(property, type)
-      super(property, type)
+      super
     end
 
     def SymbolAttribute::tjpId
@@ -409,7 +513,7 @@ class TaskJuggler
 
   class TaskListAttribute < AttributeBase
     def initialize(property, type)
-      super(property, type)
+      super
 
       @value = Array.new
     end
@@ -434,11 +538,7 @@ class TaskJuggler
 
   class WorkingHoursAttribute < AttributeBase
     def initialize(property, type)
-      super(property, type)
-    end
-
-    def initValue(arg)
-      WorkingHours.new
+      super
     end
 
     def WorkingHoursAttribute::tjpId
@@ -447,13 +547,13 @@ class TaskJuggler
 
     def to_tjp
       dayNames = %w( sun mon tue wed thu fri sat )
-      str = 'workinghours '
+      str = ''
       7.times do |day|
-        str += "#{dayNames[day]} "
+        str += "workinghours #{dayNames[day]} "
         whs = @value.getWorkingHours(day)
         if whs.empty?
           str += "off"
-          str += ",\n" if day < 6
+          str += "\n" if day < 6
           next
         end
         first = true

data/lib/Interval.rb

@@ -45,6 +45,8 @@ class TaskJuggler
         # Two arguments, a start and end date
         @start = args[0]
         @end = args[1]
+        raise "Interval start must be a date" unless @start.is_a?(TjTime)
+        raise "Interval end must be a date" unless @end.is_a?(TjTime)
         if @end < @start
           raise "Invalid interval"
         end