ardekantur-gantty 0.1.5 → 0.1.6

data/lib/gantty.rb

@@ -55,9 +55,10 @@ module Gantty
   
   class GanttChart
     
-    attr_accessor :resources, :tasks
+    attr_accessor :resources, :tasks, :name
     
     def initialize file = nil
+      @name = nil
       @gantt = nil
       @resources, @tasks = [], []
       if file
@@ -158,7 +159,7 @@ module Gantty
       
       x = Builder::XmlMarkup.new :indent => 2
       x.instruct! :xml, :version => '1.0', :encoding => 'UTF-8'
-      xml = x.project( :name => "Test XML") do
+      xml = x.project( :name => @name) do
         
         x.description ''
         x.view( 'zooming-state' => 'default:7', 'id' => 'gantt-chart' )
@@ -256,14 +257,52 @@ module Gantty
     end
 
   end
-  
+
+  # A Task is a single Gantt chart item. It has several editable properties, as well as relationships with other tasks.
+  # == Properties
+  # name:: The description of the task.
+  # start:: The start date of the task. Accepts DateTime objects.
+  # end:: The end date of the task. Accepts DateTime objects.
+  # duration:: The duration, in days, of the task.
+  # percent_complete:: The percentage complete of the task. Accepts integers from 0 to 100.
+  # priority:: The importance of the task. Accepts one of <tt>[:low, :medium, :high]</tt>.
+  # color:: The color of the task in GanttProject. Accepts RGB hex triplets (such as "#391204")
+  # notes:: Notes for the task.
+  # link:: A hyperlink related to the task.
+  #
+  # == Coordinators
+  # Coordinators are people working on a task. They are defined as instances of the Resource class.
+  # Coordinators are added to Tasks by specifying the instance, for now. This is done with #add_resource:
+  #
+  #   @task.add_resource Gantty::Resource "Adam Alpha"
+  #
+  # == Dependencies  
+  # A dependency is a relationship between one task and another. They are defined as follows:
+  #
+  # * Start->Start: Both tasks start at the same time. Accessed as #starts_with.
+  # * Start->Finish: The current task finishes as the referenced task begins. Accessed as #finishes_before.
+  # * Finish->Start: The current task starts as the referenced task ends. Accessed as #starts_after.
+  # * Finish->Finish: Both tasks end at the same time. Accessed as #finishes_with.
+  #  
   class Task
-    attr_accessor :name, :start, :duration, :end, :percent_complete, :coordinators, :priority
-    attr_accessor :starts_with, :starts_after, :finishes_with, :finishes_before, :color
+    
+    attr_accessor :start, :duration, :end
+    attr_accessor :name, :percent_complete, :coordinators, :priority, :color
+    
+    # The dependency arrays of the task. Dependencies are defined at Task.
+    attr_accessor :starts_with, :starts_after, :finishes_with, :finishes_before
     attr_accessor :tasks, :notes, :link
     
+    # The GanttProject internal +id+ field for the task.
     attr_reader :id
     
+    # Create a new task. +t+ can be a hash of options, the +name+ of the task, or a Nokogiri node containing a task element of a GanttProject file.
+    # Most people will only use the first two options.
+    #
+    #   task = Gantty::Task.new "Create chunky bacon"
+    #   task = Gantty::Task.new :name => "Create chunky bacon"
+    #
+    # Right now, only specifying <tt>:name</tt> in the hash works.
     def initialize t
       @notes = nil
       @starts_with, @starts_after, @finishes_with, @finishes_before, @tasks = [], [], [], [], []
@@ -342,14 +381,14 @@ module Gantty
       return res
     end
     
-    #
+    #--
     # If Task B has predecessor Task A with relationship Finish->Start, task_b.before.include? task_a
     # <task id="#{task_a.id}"...><depend id="#{task_b.id}" type="2" difference="1" hardness="Rubber"/></task>
     # Start-Start:   1 => #starts_with
     # Finish-Start:  2 => #starts_after
     # Finish-Finish: 3 => #finishes_with
     # Start-Finish:  4 => #finishes_before
-    #
+    #++
     
     def add_starts_with t
       @starts_with << t
@@ -370,7 +409,16 @@ module Gantty
   end
   
   class Resource
-    attr_accessor :name, :email, :phone
+    # The name of the resource. Cannot be empty.
+    attr_accessor :name
+    
+    # The e-mail address of the resource.
+    attr_accessor :email
+    
+    # The phone number of the resource.
+    attr_accessor :phone
+    
+    # The GanttProject +id+ field of the resource.
     attr_reader :id
     
     def initialize r

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ardekantur-gantty
 version: !ruby/object:Gem::Version 
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors: 
 - ardekantur
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-22 00:00:00 -08:00
+date: 2008-11-23 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency