File: app/models/issue_status.rb

Overview
Module Structure
Class Hierarchy
Code

Overview

Module Structure

  module: <Toplevel Module>
  class: IssueStatus#18
inherits from
  Base ( ActiveRecord )
has properties
method: update_default #33
class method: default #38
class method: update_issue_done_ratios #43
method: new_statuses_allowed_to / 4 #56
method: find_new_statuses_allowed_to / 4 #72
method: <=> / 1 #89
method: to_s #93
method: check_integrity #96
method: delete_workflows #101

Class Hierarchy

Object ( Builtin-Module )
Base ( ActiveRecord )
  IssueStatus    #18

Code

   1  # Redmine - project management software
   2  # Copyright (C) 2006-2011  Jean-Philippe Lang
   3  #
   4  # This program is free software; you can redistribute it and/or
   5  # modify it under the terms of the GNU General Public License
   6  # as published by the Free Software Foundation; either version 2
   7  # of the License, or (at your option) any later version.
   8  #
   9  # This program is distributed in the hope that it will be useful,
  10  # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  # GNU General Public License for more details.
  13  #
  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
  16  # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  17 
  18  class IssueStatus < ActiveRecord::Base
  19    before_destroy :check_integrity
  20    has_many :workflows, :foreign_key => "old_status_id"
  21    acts_as_list
  22 
  23    before_destroy :delete_workflows
  24    after_save     :update_default
  25 
  26    validates_presence_of :name
  27    validates_uniqueness_of :name
  28    validates_length_of :name, :maximum => 30
  29    validates_inclusion_of :default_done_ratio, :in => 0..100, :allow_nil => true
  30 
  31    named_scope :named, lambda {|arg| { :conditions => ["LOWER(#{table_name}.name) = LOWER(?)", arg.to_s.strip]}}
  32 
  33    def update_default
  34      IssueStatus.update_all("is_default=#{connection.quoted_false}", ['id <> ?', id]) if self.is_default?
  35    end
  36 
  37    # Returns the default status for new issues
  38    def self.default
  39      find(:first, :conditions =>["is_default=?", true])
  40    end
  41 
  42    # Update all the +Issues+ setting their done_ratio to the value of their +IssueStatus+
  43    def self.update_issue_done_ratios
  44      if Issue.use_status_for_done_ratio?
  45        IssueStatus.find(:all, :conditions => ["default_done_ratio >= 0"]).each do |status|
  46          Issue.update_all(["done_ratio = ?", status.default_done_ratio],
  47                           ["status_id = ?", status.id])
  48        end
  49      end
  50 
  51      return Issue.use_status_for_done_ratio?
  52    end
  53 
  54    # Returns an array of all statuses the given role can switch to
  55    # Uses association cache when called more than one time
  56    def new_statuses_allowed_to(roles, tracker, author=false, assignee=false)
  57      if roles && tracker
  58        role_ids = roles.collect(&:id)
  59        transitions = workflows.select do |w|
  60          role_ids.include?(w.role_id) &&
  61          w.tracker_id == tracker.id &&
  62          ((!w.author && !w.assignee) || (author && w.author) || (assignee && w.assignee))
  63        end
  64        transitions.collect{|w| w.new_status}.compact.sort
  65      else
  66        []
  67      end
  68    end
  69 
  70    # Same thing as above but uses a database query
  71    # More efficient than the previous method if called just once
  72    def find_new_statuses_allowed_to(roles, tracker, author=false, assignee=false)
  73      if roles.present? && tracker
  74        conditions = "(author = :false AND assignee = :false)"
  75        conditions << " OR author = :true" if author
  76        conditions << " OR assignee = :true" if assignee
  77 
  78        workflows.find(:all,
  79          :include => :new_status,
  80          :conditions => ["role_id IN (:role_ids) AND tracker_id = :tracker_id AND (#{conditions})",
  81            {:role_ids => roles.collect(&:id), :tracker_id => tracker.id, :true => true, :false => false}
  82            ]
  83          ).collect{|w| w.new_status}.compact.sort
  84      else
  85        []
  86      end
  87    end
  88 
  89    def <=>(status)
  90      position <=> status.position
  91    end
  92 
  93    def to_s; name end
  94 
  95  private
  96    def check_integrity
  97      raise "Can't delete status" if Issue.find(:first, :conditions => ["status_id=?", self.id])
  98    end
  99 
 100    # Deletes associated workflows
 101    def delete_workflows
 102      Workflow.delete_all(["old_status_id = :id OR new_status_id = :id", {:id => id}])
 103    end
 104  end