jro_apps/redmine Commit - r2347:d3b2049851c8

Use estimated hours to weight issues in version completion calculation (#2182)....

Jean-Philippe Lang -

r2347:d3b2049851c8

parent child

Context file:

r2347:d3b2049851c8

Collapse all files

app/models/version.rb +40 -4

             # redMine - project management software
             # Copyright (C) 2006  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.
             class Version < ActiveRecord::Base
               before_destroy :check_integrity
               belongs_to :project
               has_many :fixed_issues, :class_name => 'Issue', :foreign_key => 'fixed_version_id'
               acts_as_attachable :view_permission => :view_files,
                                  :delete_permission => :manage_files
               validates_presence_of :name
               validates_uniqueness_of :name, :scope => [:project_id]
               validates_length_of :name, :maximum => 60
               validates_format_of :effective_date, :with => /^\d{4}-\d{2}-\d{2}$/, :message => 'activerecord_error_not_a_date', :allow_nil => true
               def start_date
                 effective_date
               end
               def due_date
                 effective_date
               end
               # Returns the total estimated time for this version
               def estimated_hours
                 @estimated_hours ||= fixed_issues.sum(:estimated_hours).to_f
               end
               # Returns the total reported time for this version
               def spent_hours
                 @spent_hours ||= TimeEntry.sum(:hours, :include => :issue, :conditions => ["#{Issue.table_name}.fixed_version_id = ?", id]).to_f
               end
               # Returns true if the version is completed: due date reached and no open issues
               def completed?
                 effective_date && (effective_date <= Date.today) && (open_issues_count == 0)
               end
               def completed_pourcent
-                if fixed_issues.count == 0
+                if issues_count == 0
                 elsif open_issues_count == 0
                 else
-                  (closed_issues_count * 100 + Issue.sum('done_ratio', :include => 'status', :conditions => ["fixed_version_id = ? AND is_closed = ?", id, false]).to_f) / fixed_issues.count
+                  issues_progress(false) + issues_progress(true)
                 end
               end
               def closed_pourcent
-                if fixed_issues.count == 0
+                if issues_count == 0
                 else
-                  closed_issues_count * 100.0 / fixed_issues.count
+                  issues_progress(false)
                 end
               end
               # Returns true if the version is overdue: due date reached and some open issues
               def overdue?
                 effective_date && (effective_date < Date.today) && (open_issues_count > 0)
               end
+              # Returns assigned issues count
+              def issues_count
+                @issue_count ||= fixed_issues.count
+              end
               def open_issues_count
                 @open_issues_count ||= Issue.count(:all, :conditions => ["fixed_version_id = ? AND is_closed = ?", self.id, false], :include => :status)
               end
               def closed_issues_count
                 @closed_issues_count ||= Issue.count(:all, :conditions => ["fixed_version_id = ? AND is_closed = ?", self.id, true], :include => :status)
               end
               def wiki_page
                 if project.wiki && !wiki_page_title.blank?
                   @wiki_page ||= project.wiki.find_page(wiki_page_title)
                 end
                 @wiki_page
               end
               def to_s; name end
               # Versions are sorted by effective_date and name
               # Those with no effective_date are at the end, sorted by name
               def <=>(version)
                 if self.effective_date
                   version.effective_date ? (self.effective_date == version.effective_date ? self.name <=> version.name : self.effective_date <=> version.effective_date) : -1
                 else
                   version.effective_date ? 1 : (self.name <=> version.name)
                 end
               end
             private
               def check_integrity
                 raise "Can't delete version" if self.fixed_issues.find(:first)
               end
+              # Returns the average estimated time of assigned issues
+              # or 1 if no issue has an estimated time
+              # Used to weigth unestimated issues in progress calculation
+              def estimated_average
+                if @estimated_average.nil?
+                  average = fixed_issues.average(:estimated_hours).to_f
+                  if average == 0
+                    average = 1
+                  end
+                  @estimated_average = average
+                end
+                @estimated_average
+              end
+              # Returns the total progress of open or closed issues
+              def issues_progress(open)
+                @issues_progress ||= {}
+                @issues_progress[open] ||= begin
+                  progress = 0
+                  if issues_count > 0
+                    ratio = open ? 'done_ratio' : 100
+                    done = fixed_issues.sum("COALESCE(estimated_hours, #{estimated_average}) * #{ratio}",
+                                              :include => :status,
+                                              :conditions => ["is_closed = ?", !open]).to_f
+                    progress = done / (estimated_average * issues_count)
+                  end
+                  progress
+                end
+              end
             end

test/unit/version_test.rb +85 -1

@@ -1,36 +1,120
1	# Redmine - project management software	1	# Redmine - project management software
2	# Copyright (C) 2006-2008 Jean-Philippe Lang	2	# Copyright (C) 2006-2008 Jean-Philippe Lang
3	#	3	#
4	# This program is free software; you can redistribute it and/or	4	# This program is free software; you can redistribute it and/or
5	# modify it under the terms of the GNU General Public License	5	# modify it under the terms of the GNU General Public License
6	# as published by the Free Software Foundation; either version 2	6	# as published by the Free Software Foundation; either version 2
7	# of the License, or (at your option) any later version.	7	# of the License, or (at your option) any later version.
8	#	8	#
9	# This program is distributed in the hope that it will be useful,	9	# This program is distributed in the hope that it will be useful,
10	# but WITHOUT ANY WARRANTY; without even the implied warranty of	10	# but WITHOUT ANY WARRANTY; without even the implied warranty of
11	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the	11	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12	# GNU General Public License for more details.	12	# GNU General Public License for more details.
13	#	13	#
14	# You should have received a copy of the GNU General Public License	14	# You should have received a copy of the GNU General Public License
15	# along with this program; if not, write to the Free Software	15	# along with this program; if not, write to the Free Software
16	# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.	16	# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17		17
18	require File.dirname(__FILE__) + '/../test_helper'	18	require File.dirname(__FILE__) + '/../test_helper'
19		19
20	class VersionTest < Test::Unit::TestCase	20	class VersionTest < Test::Unit::TestCase
21	fixtures :projects, :issues, :issue_statuses, :versions	21	fixtures :projects, :users, :issues, :issue_statuses, :trackers, :enumerations, :versions
22		22
23	def setup	23	def setup
24	end	24	end
25		25
26	def test_create	26	def test_create
27	v = Version.new(:project => Project.find(1), :name => '1.1', :effective_date => '2011-03-25')	27	v = Version.new(:project => Project.find(1), :name => '1.1', :effective_date => '2011-03-25')
28	assert v.save	28	assert v.save
29	end	29	end
30		30
31	def test_invalid_effective_date_validation	31	def test_invalid_effective_date_validation
32	v = Version.new(:project => Project.find(1), :name => '1.1', :effective_date => '99999-01-01')	32	v = Version.new(:project => Project.find(1), :name => '1.1', :effective_date => '99999-01-01')
33	assert !v.save	33	assert !v.save
34	assert_equal 'activerecord_error_not_a_date', v.errors.on(:effective_date)	34	assert_equal 'activerecord_error_not_a_date', v.errors.on(:effective_date)
35	end	35	end
		36
		37	def test_progress_should_be_0_with_no_assigned_issues
		38	project = Project.find(1)
		39	v = Version.create!(:project => project, :name => 'Progress')
		40	assert_equal 0, v.completed_pourcent
		41	assert_equal 0, v.closed_pourcent
		42	end
		43
		44	def test_progress_should_be_0_with_unbegun_assigned_issues
		45	project = Project.find(1)
		46	v = Version.create!(:project => project, :name => 'Progress')
		47	add_issue(v)
		48	add_issue(v, :done_ratio => 0)
		49	assert_progress_equal 0, v.completed_pourcent
		50	assert_progress_equal 0, v.closed_pourcent
		51	end
		52
		53	def test_progress_should_be_100_with_closed_assigned_issues
		54	project = Project.find(1)
		55	status = IssueStatus.find(:first, :conditions => {:is_closed => true})
		56	v = Version.create!(:project => project, :name => 'Progress')
		57	add_issue(v, :status => status)
		58	add_issue(v, :status => status, :done_ratio => 20)
		59	add_issue(v, :status => status, :done_ratio => 70, :estimated_hours => 25)
		60	add_issue(v, :status => status, :estimated_hours => 15)
		61	assert_progress_equal 100.0, v.completed_pourcent
		62	assert_progress_equal 100.0, v.closed_pourcent
		63	end
		64
		65	def test_progress_should_consider_done_ratio_of_open_assigned_issues
		66	project = Project.find(1)
		67	v = Version.create!(:project => project, :name => 'Progress')
		68	add_issue(v)
		69	add_issue(v, :done_ratio => 20)
		70	add_issue(v, :done_ratio => 70)
		71	assert_progress_equal (0.0 + 20.0 + 70.0)/3, v.completed_pourcent
		72	assert_progress_equal 0, v.closed_pourcent
		73	end
		74
		75	def test_progress_should_consider_closed_issues_as_completed
		76	project = Project.find(1)
		77	v = Version.create!(:project => project, :name => 'Progress')
		78	add_issue(v)
		79	add_issue(v, :done_ratio => 20)
		80	add_issue(v, :status => IssueStatus.find(:first, :conditions => {:is_closed => true}))
		81	assert_progress_equal (0.0 + 20.0 + 100.0)/3, v.completed_pourcent
		82	assert_progress_equal (100.0)/3, v.closed_pourcent
		83	end
		84
		85	def test_progress_should_consider_estimated_hours_to_weigth_issues
		86	project = Project.find(1)
		87	v = Version.create!(:project => project, :name => 'Progress')
		88	add_issue(v, :estimated_hours => 10)
		89	add_issue(v, :estimated_hours => 20, :done_ratio => 30)
		90	add_issue(v, :estimated_hours => 40, :done_ratio => 10)
		91	add_issue(v, :estimated_hours => 25, :status => IssueStatus.find(:first, :conditions => {:is_closed => true}))
		92	assert_progress_equal (10.00 + 20.00.3 + 400.1 + 25.01)/95.0*100, v.completed_pourcent
		93	assert_progress_equal 25.0/95.0*100, v.closed_pourcent
		94	end
		95
		96	def test_progress_should_consider_average_estimated_hours_to_weigth_unestimated_issues
		97	project = Project.find(1)
		98	v = Version.create!(:project => project, :name => 'Progress')
		99	add_issue(v, :done_ratio => 20)
		100	add_issue(v, :status => IssueStatus.find(:first, :conditions => {:is_closed => true}))
		101	add_issue(v, :estimated_hours => 10, :done_ratio => 30)
		102	add_issue(v, :estimated_hours => 40, :done_ratio => 10)
		103	assert_progress_equal (25.00.2 + 25.01 + 10.00.3 + 40.00.1)/100.0*100, v.completed_pourcent
		104	assert_progress_equal 25.0/100.0*100, v.closed_pourcent
		105	end
		106
		107	private
		108
		109	def add_issue(version, attributes={})
		110	Issue.create!({:project => version.project,
		111	:fixed_version => version,
		112	:subject => 'Test',
		113	:author => User.find(:first),
		114	:tracker => version.project.trackers.find(:first)}.merge(attributes))
		115	end
		116
		117	def assert_progress_equal(expected_float, actual_float, message="")
		118	assert_in_delta(expected_float, actual_float, 0.000001, message="")
		119	end
36	end	120	end

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages