diff lib/redmine/helpers/gantt.rb @ 0:513646585e45

* Import Redmine trunk SVN rev 3859

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/lib/redmine/helpers/gantt.rb	Fri Jul 23 15:52:44 2010 +0100
@@ -0,0 +1,274 @@
+# Redmine - project management software
+# Copyright (C) 2006-2008  Jean-Philippe Lang
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+module Redmine
+  module Helpers
+    # Simple class to handle gantt chart data
+    class Gantt
+      attr_reader :year_from, :month_from, :date_from, :date_to, :zoom, :months, :events
+    
+      def initialize(options={})
+        options = options.dup
+        @events = []
+        
+        if options[:year] && options[:year].to_i >0
+          @year_from = options[:year].to_i
+          if options[:month] && options[:month].to_i >=1 && options[:month].to_i <= 12
+            @month_from = options[:month].to_i
+          else
+            @month_from = 1
+          end
+        else
+          @month_from ||= Date.today.month
+          @year_from ||= Date.today.year
+        end
+        
+        zoom = (options[:zoom] || User.current.pref[:gantt_zoom]).to_i
+        @zoom = (zoom > 0 && zoom < 5) ? zoom : 2    
+        months = (options[:months] || User.current.pref[:gantt_months]).to_i
+        @months = (months > 0 && months < 25) ? months : 6
+        
+        # Save gantt parameters as user preference (zoom and months count)
+        if (User.current.logged? && (@zoom != User.current.pref[:gantt_zoom] || @months != User.current.pref[:gantt_months]))
+          User.current.pref[:gantt_zoom], User.current.pref[:gantt_months] = @zoom, @months
+          User.current.preference.save
+        end
+        
+        @date_from = Date.civil(@year_from, @month_from, 1)
+        @date_to = (@date_from >> @months) - 1
+      end
+      
+      
+      def events=(e)
+        @events = e
+        # Adds all ancestors
+        root_ids = e.select {|i| i.is_a?(Issue) && i.parent_id? }.collect(&:root_id).uniq
+        if root_ids.any?
+          # Retrieves all nodes
+          parents = Issue.find_all_by_root_id(root_ids, :conditions => ["rgt - lft > 1"])
+          # Only add ancestors
+          @events += parents.select {|p| @events.detect {|i| i.is_a?(Issue) && p.is_ancestor_of?(i)}}
+        end
+        @events.uniq!
+        # Sort issues by hierarchy and start dates
+        @events.sort! {|x,y| 
+          if x.is_a?(Issue) && y.is_a?(Issue)
+            gantt_issue_compare(x, y, @events)
+          else
+            gantt_start_compare(x, y)
+          end
+        }
+        # Removes issues that have no start or end date
+        @events.reject! {|i| i.is_a?(Issue) && (i.start_date.nil? || i.due_before.nil?) }
+        @events
+      end
+      
+      def params
+        { :zoom => zoom, :year => year_from, :month => month_from, :months => months }
+      end
+      
+      def params_previous
+        { :year => (date_from << months).year, :month => (date_from << months).month, :zoom => zoom, :months => months }
+      end
+      
+      def params_next
+        { :year => (date_from >> months).year, :month => (date_from >> months).month, :zoom => zoom, :months => months }
+      end
+      
+      # Generates a gantt image
+      # Only defined if RMagick is avalaible
+      def to_image(format='PNG')
+        date_to = (@date_from >> @months)-1    
+        show_weeks = @zoom > 1
+        show_days = @zoom > 2
+        
+        subject_width = 320
+        header_heigth = 18
+        # width of one day in pixels
+        zoom = @zoom*2
+        g_width = (@date_to - @date_from + 1)*zoom
+        g_height = 20 * events.length + 20
+        headers_heigth = (show_weeks ? 2*header_heigth : header_heigth)
+        height = g_height + headers_heigth
+            
+        imgl = Magick::ImageList.new
+        imgl.new_image(subject_width+g_width+1, height)
+        gc = Magick::Draw.new
+        
+        # Subjects
+        top = headers_heigth + 20
+        gc.fill('black')
+        gc.stroke('transparent')
+        gc.stroke_width(1)
+        events.each do |i|
+          gc.text(4, top + 2, (i.is_a?(Issue) ? i.subject : i.name))
+          top = top + 20
+        end
+    
+        # Months headers
+        month_f = @date_from
+        left = subject_width
+        @months.times do 
+          width = ((month_f >> 1) - month_f) * zoom
+          gc.fill('white')
+          gc.stroke('grey')
+          gc.stroke_width(1)
+          gc.rectangle(left, 0, left + width, height)
+          gc.fill('black')
+          gc.stroke('transparent')
+          gc.stroke_width(1)
+          gc.text(left.round + 8, 14, "#{month_f.year}-#{month_f.month}")
+          left = left + width
+          month_f = month_f >> 1
+        end
+        
+        # Weeks headers
+        if show_weeks
+        	left = subject_width
+        	height = header_heigth
+        	if @date_from.cwday == 1
+        	    # date_from is monday
+                week_f = date_from
+        	else
+        	    # find next monday after date_from
+        		week_f = @date_from + (7 - @date_from.cwday + 1)
+        		width = (7 - @date_from.cwday + 1) * zoom
+                gc.fill('white')
+                gc.stroke('grey')
+                gc.stroke_width(1)
+                gc.rectangle(left, header_heigth, left + width, 2*header_heigth + g_height-1)
+        		left = left + width
+        	end
+        	while week_f <= date_to
+        		width = (week_f + 6 <= date_to) ? 7 * zoom : (date_to - week_f + 1) * zoom
+                gc.fill('white')
+                gc.stroke('grey')
+                gc.stroke_width(1)
+                gc.rectangle(left.round, header_heigth, left.round + width, 2*header_heigth + g_height-1)
+                gc.fill('black')
+                gc.stroke('transparent')
+                gc.stroke_width(1)
+                gc.text(left.round + 2, header_heigth + 14, week_f.cweek.to_s)
+        		left = left + width
+        		week_f = week_f+7
+        	end
+        end
+        
+        # Days details (week-end in grey)
+        if show_days
+        	left = subject_width
+        	height = g_height + header_heigth - 1
+        	wday = @date_from.cwday
+        	(date_to - @date_from + 1).to_i.times do 
+              width =  zoom
+              gc.fill(wday == 6 || wday == 7 ? '#eee' : 'white')
+              gc.stroke('grey')
+              gc.stroke_width(1)
+              gc.rectangle(left, 2*header_heigth, left + width, 2*header_heigth + g_height-1)
+              left = left + width
+              wday = wday + 1
+              wday = 1 if wday > 7
+        	end
+        end
+    
+        # border
+        gc.fill('transparent')
+        gc.stroke('grey')
+        gc.stroke_width(1)
+        gc.rectangle(0, 0, subject_width+g_width, headers_heigth)
+        gc.stroke('black')
+        gc.rectangle(0, 0, subject_width+g_width, g_height+ headers_heigth-1)
+            
+        # content
+        top = headers_heigth + 20
+        gc.stroke('transparent')
+        events.each do |i|      
+          if i.is_a?(Issue)       
+            i_start_date = (i.start_date >= @date_from ? i.start_date : @date_from )
+            i_end_date = (i.due_before <= date_to ? i.due_before : date_to )        
+            i_done_date = i.start_date + ((i.due_before - i.start_date+1)*i.done_ratio/100).floor
+            i_done_date = (i_done_date <= @date_from ? @date_from : i_done_date )
+            i_done_date = (i_done_date >= date_to ? date_to : i_done_date )        
+            i_late_date = [i_end_date, Date.today].min if i_start_date < Date.today
+            
+            i_left = subject_width + ((i_start_date - @date_from)*zoom).floor 	
+            i_width = ((i_end_date - i_start_date + 1)*zoom).floor                  # total width of the issue
+            d_width = ((i_done_date - i_start_date)*zoom).floor                     # done width
+            l_width = i_late_date ? ((i_late_date - i_start_date+1)*zoom).floor : 0 # delay width
+      
+            gc.fill('grey')
+            gc.rectangle(i_left, top, i_left + i_width, top - 6)
+            gc.fill('red')
+            gc.rectangle(i_left, top, i_left + l_width, top - 6) if l_width > 0
+            gc.fill('blue')
+            gc.rectangle(i_left, top, i_left + d_width, top - 6) if d_width > 0
+            gc.fill('black')
+            gc.text(i_left + i_width + 5,top + 1, "#{i.status.name} #{i.done_ratio}%")
+          else
+            i_left = subject_width + ((i.start_date - @date_from)*zoom).floor
+            gc.fill('green')
+            gc.rectangle(i_left, top, i_left + 6, top - 6)        
+            gc.fill('black')
+            gc.text(i_left + 11, top + 1, i.name)
+          end
+          top = top + 20
+        end
+        
+        # today red line
+        if Date.today >= @date_from and Date.today <= date_to
+          gc.stroke('red')
+          x = (Date.today-@date_from+1)*zoom + subject_width
+          gc.line(x, headers_heigth, x, headers_heigth + g_height-1)      
+        end    
+        
+        gc.draw(imgl)
+        imgl.format = format
+        imgl.to_blob
+      end if Object.const_defined?(:Magick)
+      
+      private
+      
+      def gantt_issue_compare(x, y, issues)
+        if x.parent_id == y.parent_id
+          gantt_start_compare(x, y)
+        elsif x.is_ancestor_of?(y)
+          -1
+        elsif y.is_ancestor_of?(x)
+          1
+        else
+          ax = issues.select {|i| i.is_a?(Issue) && i.is_ancestor_of?(x) && !i.is_ancestor_of?(y) }.sort_by(&:lft).first
+          ay = issues.select {|i| i.is_a?(Issue) && i.is_ancestor_of?(y) && !i.is_ancestor_of?(x) }.sort_by(&:lft).first
+          if ax.nil? && ay.nil?
+            gantt_start_compare(x, y)
+          else
+            gantt_issue_compare(ax || x, ay || y, issues)
+          end
+        end
+      end
+      
+      def gantt_start_compare(x, y)
+        if x.start_date.nil?
+          -1
+        elsif y.start_date.nil?
+          1
+        else
+          x.start_date <=> y.start_date
+        end
+      end
+    end
+  end
+end