jro_apps/redmine Commit - r9969:2275f4613875

Makes Version#<=> consistent with SQL sort....

Jean-Philippe Lang -

r9969:2275f4613875

parent child

Context file:

r9969:2275f4613875

Collapse all files

app/models/version.rb +2 -2

             # Redmine - project management software
             # Copyright (C) 2006-2012  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
               include Redmine::SafeAttributes
               after_update :update_issues_from_sharing_change
               belongs_to :project
               has_many :fixed_issues, :class_name => 'Issue', :foreign_key => 'fixed_version_id', :dependent => :nullify
               acts_as_customizable
               acts_as_attachable :view_permission => :view_files,
                                  :delete_permission => :manage_files
               VERSION_STATUSES = %w(open locked closed)
               VERSION_SHARINGS = %w(none descendants hierarchy tree system)
               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 => :not_a_date, :allow_nil => true
               validates_inclusion_of :status, :in => VERSION_STATUSES
               validates_inclusion_of :sharing, :in => VERSION_SHARINGS
               scope :named, lambda {|arg| { :conditions => ["LOWER(#{table_name}.name) = LOWER(?)", arg.to_s.strip]}}
               scope :open, :conditions => {:status => 'open'}
               scope :visible, lambda {|*args| { :include => :project,
                                                       :conditions => Project.allowed_to_condition(args.first || User.current, :view_issues) } }
               safe_attributes 'name',
                 'description',
                 'effective_date',
                 'due_date',
                 'wiki_page_title',
                 'status',
                 'sharing',
                 'custom_field_values'
               # Returns true if +user+ or current user is allowed to view the version
               def visible?(user=User.current)
                 user.allowed_to?(:view_issues, self.project)
               end
               # Version files have same visibility as project files
               def attachments_visible?(*args)
                 project.present? && project.attachments_visible?(*args)
               end
               def start_date
                 @start_date ||= fixed_issues.minimum('start_date')
               end
               def due_date
                 effective_date
               end
               def due_date=(arg)
                 self.effective_date=(arg)
               end
               # Returns the total estimated time for this version
               # (sum of leaves estimated_hours)
               def estimated_hours
                 @estimated_hours ||= fixed_issues.leaves.sum(:estimated_hours).to_f
               end
               # Returns the total reported time for this version
               def spent_hours
                 @spent_hours ||= TimeEntry.sum(:hours, :joins => :issue, :conditions => ["#{Issue.table_name}.fixed_version_id = ?", id]).to_f
               end
               def closed?
                 status == 'closed'
               end
               def open?
                 status == 'open'
               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 behind_schedule?
                 if completed_pourcent == 100
                   return false
                 elsif due_date && start_date
                   done_date = start_date + ((due_date - start_date+1)* completed_pourcent/100).floor
                   return done_date <= Date.today
                 else
                   false # No issues so it's not late
                 end
               end
               # Returns the completion percentage of this version based on the amount of open/closed issues
               # and the time spent on the open issues.
               def completed_pourcent
                 if issues_count == 0
                 elsif open_issues_count == 0
                 else
                   issues_progress(false) + issues_progress(true)
                 end
               end
               # Returns the percentage of issues that have been marked as 'closed'.
               def closed_pourcent
                 if issues_count == 0
                 else
                   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
                 load_issue_counts
                 @issue_count
               end
               # Returns the total amount of open issues for this version.
               def open_issues_count
                 load_issue_counts
                 @open_issues_count
               end
               # Returns the total amount of closed issues for this version.
               def closed_issues_count
                 load_issue_counts
                 @closed_issues_count
               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
               def to_s_with_project
                 "#{project} - #{name}"
               end
               # Versions are sorted by effective_date and "Project Name - Version name"
               # Those with no effective_date are at the end, sorted by "Project Name - Version name"
               def <=>(version)
                 if self.effective_date
                   if version.effective_date
                     if self.effective_date == version.effective_date
-                      "#{self.project.name} - #{self.name}" <=> "#{version.project.name} - #{version.name}"
+                      name == version.name ? id <=> version.id : name <=> version.name
                     else
                       self.effective_date <=> version.effective_date
                     end
                   else
                     -1
                   end
                 else
                   if version.effective_date
                   else
-                    "#{self.project.name} - #{self.name}" <=> "#{version.project.name} - #{version.name}"
+                    name == version.name ? id <=> version.id : name <=> version.name
                   end
                 end
               end
               def self.fields_for_order_statement(table=nil)
                 table ||= table_name
                 ["(CASE WHEN #{table}.effective_date IS NULL THEN 1 ELSE 0 END)", "#{table}.effective_date", "#{table}.name", "#{table}.id"]
               end
               scope :sorted, order(fields_for_order_statement)
               # Returns the sharings that +user+ can set the version to
               def allowed_sharings(user = User.current)
                 VERSION_SHARINGS.select do |s|
                   if sharing == s
                     true
                   else
                     case s
                     when 'system'
                       # Only admin users can set a systemwide sharing
                       user.admin?
                     when 'hierarchy', 'tree'
                       # Only users allowed to manage versions of the root project can
                       # set sharing to hierarchy or tree
                       project.nil? || user.allowed_to?(:manage_versions, project.root)
                     else
                       true
                     end
                   end
                 end
               end
               private
               def load_issue_counts
                 unless @issue_count
                   @open_issues_count = 0
                   @closed_issues_count = 0
                   fixed_issues.count(:all, :group => :status).each do |status, count|
                     if status.is_closed?
                       @closed_issues_count += count
                     else
                       @open_issues_count += count
                     end
                   end
                   @issue_count = @open_issues_count + @closed_issues_count
                 end
               end
               # Update the issue's fixed versions. Used if a version's sharing changes.
               def update_issues_from_sharing_change
                 if sharing_changed?
                   if VERSION_SHARINGS.index(sharing_was).nil? ||
                       VERSION_SHARINGS.index(sharing).nil? ||
                       VERSION_SHARINGS.index(sharing_was) > VERSION_SHARINGS.index(sharing)
                     Issue.update_versions_from_sharing_change self
                   end
                 end
               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.  The returned percentage takes into account
               # the amount of estimated time set for this version.
               #
               # Examples:
               # issues_progress(true)   => returns the progress percentage for open issues.
               # issues_progress(false)  => returns the progress percentage for 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}",
                                               :joins => :status,
                                               :conditions => ["#{IssueStatus.table_name}.is_closed = ?", !open]).to_f
                     progress = done / (estimated_average * issues_count)
                   end
                   progress
                 end
               end
             end

test/unit/version_test.rb +1 0

             # Redmine - project management software
             # Copyright (C) 2006-2012  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.
             require File.expand_path('../../test_helper', __FILE__)
             class VersionTest < ActiveSupport::TestCase
               fixtures :projects, :users, :issues, :issue_statuses, :trackers, :enumerations, :versions
               def setup
               end
               def test_create
                 v = Version.new(:project => Project.find(1), :name => '1.1', :effective_date => '2011-03-25')
                 assert v.save
                 assert_equal 'open', v.status
                 assert_equal 'none', v.sharing
               end
               def test_invalid_effective_date_validation
                 v = Version.new(:project => Project.find(1), :name => '1.1', :effective_date => '99999-01-01')
                 assert !v.save
                 assert_include I18n.translate('activerecord.errors.messages.not_a_date'),
                                v.errors[:effective_date]
               end
               def test_progress_should_be_0_with_no_assigned_issues
                 project = Project.find(1)
                 v = Version.create!(:project => project, :name => 'Progress')
                 assert_equal 0, v.completed_pourcent
                 assert_equal 0, v.closed_pourcent
               end
               def test_progress_should_be_0_with_unbegun_assigned_issues
                 project = Project.find(1)
                 v = Version.create!(:project => project, :name => 'Progress')
                 add_issue(v)
                 add_issue(v, :done_ratio => 0)
                 assert_progress_equal 0, v.completed_pourcent
                 assert_progress_equal 0, v.closed_pourcent
               end
               def test_progress_should_be_100_with_closed_assigned_issues
                 project = Project.find(1)
                 status = IssueStatus.find(:first, :conditions => {:is_closed => true})
                 v = Version.create!(:project => project, :name => 'Progress')
                 add_issue(v, :status => status)
                 add_issue(v, :status => status, :done_ratio => 20)
                 add_issue(v, :status => status, :done_ratio => 70, :estimated_hours => 25)
                 add_issue(v, :status => status, :estimated_hours => 15)
                 assert_progress_equal 100.0, v.completed_pourcent
                 assert_progress_equal 100.0, v.closed_pourcent
               end
               def test_progress_should_consider_done_ratio_of_open_assigned_issues
                 project = Project.find(1)
                 v = Version.create!(:project => project, :name => 'Progress')
                 add_issue(v)
                 add_issue(v, :done_ratio => 20)
                 add_issue(v, :done_ratio => 70)
                 assert_progress_equal (0.0 + 20.0 + 70.0)/3, v.completed_pourcent
                 assert_progress_equal 0, v.closed_pourcent
               end
               def test_progress_should_consider_closed_issues_as_completed
                 project = Project.find(1)
                 v = Version.create!(:project => project, :name => 'Progress')
                 add_issue(v)
                 add_issue(v, :done_ratio => 20)
                 add_issue(v, :status => IssueStatus.find(:first, :conditions => {:is_closed => true}))
                 assert_progress_equal (0.0 + 20.0 + 100.0)/3, v.completed_pourcent
                 assert_progress_equal (100.0)/3, v.closed_pourcent
               end
               def test_progress_should_consider_estimated_hours_to_weigth_issues
                 project = Project.find(1)
                 v = Version.create!(:project => project, :name => 'Progress')
                 add_issue(v, :estimated_hours => 10)
                 add_issue(v, :estimated_hours => 20, :done_ratio => 30)
                 add_issue(v, :estimated_hours => 40, :done_ratio => 10)
                 add_issue(v, :estimated_hours => 25, :status => IssueStatus.find(:first, :conditions => {:is_closed => true}))
                 assert_progress_equal (10.0*0 + 20.0*0.3 + 40*0.1 + 25.0*1)/95.0*100, v.completed_pourcent
                 assert_progress_equal 25.0/95.0*100, v.closed_pourcent
               end
               def test_progress_should_consider_average_estimated_hours_to_weigth_unestimated_issues
                 project = Project.find(1)
                 v = Version.create!(:project => project, :name => 'Progress')
                 add_issue(v, :done_ratio => 20)
                 add_issue(v, :status => IssueStatus.find(:first, :conditions => {:is_closed => true}))
                 add_issue(v, :estimated_hours => 10, :done_ratio => 30)
                 add_issue(v, :estimated_hours => 40, :done_ratio => 10)
                 assert_progress_equal (25.0*0.2 + 25.0*1 + 10.0*0.3 + 40.0*0.1)/100.0*100, v.completed_pourcent
                 assert_progress_equal 25.0/100.0*100, v.closed_pourcent
               end
               def test_should_sort_scheduled_then_unscheduled_versions
                 Version.delete_all
                 v4 = Version.create!(:project_id => 1, :name => 'v4')
                 v3 = Version.create!(:project_id => 1, :name => 'v2', :effective_date => '2012-07-14')
                 v2 = Version.create!(:project_id => 1, :name => 'v1')
                 v1 = Version.create!(:project_id => 1, :name => 'v3', :effective_date => '2012-08-02')
                 v5 = Version.create!(:project_id => 1, :name => 'v5', :effective_date => '2012-07-02')
+                assert_equal [v5, v3, v1, v2, v4], [v1, v2, v3, v4, v5].sort
                 assert_equal [v5, v3, v1, v2, v4], Version.sorted.all
               end
               context "#behind_schedule?" do
                 setup do
                   ProjectCustomField.destroy_all # Custom values are a mess to isolate in tests
                   @project = Project.create!(:name => 'test0', :identifier => 'test0')
                   @project.trackers << Tracker.create!(:name => 'track')
                   @version = Version.create!(:project => @project, :effective_date => nil, :name => 'version')
                 end
                 should "be false if there are no issues assigned" do
                   @version.update_attribute(:effective_date, Date.yesterday)
                   assert_equal false, @version.behind_schedule?
                 end
                 should "be false if there is no effective_date" do
                   assert_equal false, @version.behind_schedule?
                 end
                 should "be false if all of the issues are ahead of schedule" do
                   @version.update_attribute(:effective_date, 7.days.from_now.to_date)
                   add_issue(@version, :start_date => 7.days.ago, :done_ratio => 60) # 14 day span, 60% done, 50% time left
                   add_issue(@version, :start_date => 7.days.ago, :done_ratio => 60) # 14 day span, 60% done, 50% time left
                   assert_equal 60, @version.completed_pourcent
                   assert_equal false, @version.behind_schedule?
                 end
                 should "be true if any of the issues are behind schedule" do
                   @version.update_attribute(:effective_date, 7.days.from_now.to_date)
                   add_issue(@version, :start_date => 7.days.ago, :done_ratio => 60) # 14 day span, 60% done, 50% time left
                   add_issue(@version, :start_date => 7.days.ago, :done_ratio => 20) # 14 day span, 20% done, 50% time left
                   assert_equal 40, @version.completed_pourcent
                   assert_equal true, @version.behind_schedule?
                 end
                 should "be false if all of the issues are complete" do
                   @version.update_attribute(:effective_date, 7.days.from_now.to_date)
                   add_issue(@version, :start_date => 14.days.ago, :done_ratio => 100, :status => IssueStatus.find(5)) # 7 day span
                   add_issue(@version, :start_date => 14.days.ago, :done_ratio => 100, :status => IssueStatus.find(5)) # 7 day span
                   assert_equal 100, @version.completed_pourcent
                   assert_equal false, @version.behind_schedule?
                 end
               end
               context "#estimated_hours" do
                 setup do
                   @version = Version.create!(:project_id => 1, :name => '#estimated_hours')
                 end
                 should "return 0 with no assigned issues" do
                   assert_equal 0, @version.estimated_hours
                 end
                 should "return 0 with no estimated hours" do
                   add_issue(@version)
                   assert_equal 0, @version.estimated_hours
                 end
                 should "return the sum of estimated hours" do
                   add_issue(@version, :estimated_hours => 2.5)
                   add_issue(@version, :estimated_hours => 5)
                   assert_equal 7.5, @version.estimated_hours
                 end
                 should "return the sum of leaves estimated hours" do
                   parent = add_issue(@version)
                   add_issue(@version, :estimated_hours => 2.5, :parent_issue_id => parent.id)
                   add_issue(@version, :estimated_hours => 5, :parent_issue_id => parent.id)
                   assert_equal 7.5, @version.estimated_hours
                 end
               end
               test "should update all issue's fixed_version associations in case the hierarchy changed XXX" do
                 User.current = User.find(1) # Need the admin's permissions
                 @version = Version.find(7)
                 # Separate hierarchy
                 project_1_issue = Issue.find(1)
                 project_1_issue.fixed_version = @version
                 assert project_1_issue.save, project_1_issue.errors.full_messages.to_s
                 project_5_issue = Issue.find(6)
                 project_5_issue.fixed_version = @version
                 assert project_5_issue.save
                 # Project
                 project_2_issue = Issue.find(4)
                 project_2_issue.fixed_version = @version
                 assert project_2_issue.save
                 # Update the sharing
                 @version.sharing = 'none'
                 assert @version.save
                 # Project 1 now out of the shared scope
                 project_1_issue.reload
                 assert_equal nil, project_1_issue.fixed_version, "Fixed version is still set after changing the Version's sharing"
                 # Project 5 now out of the shared scope
                 project_5_issue.reload
                 assert_equal nil, project_5_issue.fixed_version, "Fixed version is still set after changing the Version's sharing"
                 # Project 2 issue remains
                 project_2_issue.reload
                 assert_equal @version, project_2_issue.fixed_version
               end
               private
               def add_issue(version, attributes={})
                 Issue.create!({:project => version.project,
                                :fixed_version => version,
                                :subject => 'Test',
                                :author => User.find(:first),
                                :tracker => version.project.trackers.find(:first)}.merge(attributes))
               end
               def assert_progress_equal(expected_float, actual_float, message="")
                 assert_in_delta(expected_float, actual_float, 0.000001, message="")
               end
             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