Class: Version
- Inherits:
-
ActiveRecord::Base
- Object
- ActiveRecord::Base
- Version
- Includes:
- Redmine::SafeAttributes
- Defined in:
- app/models/version.rb
Overview
Redmine - project management software Copyright (C) 2006-2014 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.
Constant Summary collapse
- VERSION_STATUSES =
%w(open locked closed)
- VERSION_SHARINGS =
%w(none descendants hierarchy tree system)
Class Method Summary collapse
Instance Method Summary collapse
-
#<=>(version) ⇒ Object
Versions are sorted by effective_date and name Those with no effective_date are at the end, sorted by name.
-
#allowed_sharings(user = User.current) ⇒ Object
Returns the sharings that
user
can set the version to. - #attachments_deletable?(usr = User.current) ⇒ Boolean
-
#attachments_visible?(*args) ⇒ Boolean
Version files have same visibility as project files.
- #behind_schedule? ⇒ Boolean
- #closed? ⇒ Boolean
-
#closed_issues_count ⇒ Object
Returns the total amount of closed issues for this version.
-
#closed_percent ⇒ Object
Returns the percentage of issues that have been marked as 'closed'.
-
#completed? ⇒ Boolean
Returns true if the version is completed: due date reached and no open issues.
-
#completed_percent ⇒ Object
Returns the completion percentage of this version based on the amount of open/closed issues and the time spent on the open issues.
- #due_date ⇒ Object
- #due_date=(arg) ⇒ Object
-
#estimated_hours ⇒ Object
Returns the total estimated time for this version (sum of leaves estimated_hours).
-
#issues_count ⇒ Object
Returns assigned issues count.
- #open? ⇒ Boolean
-
#open_issues_count ⇒ Object
Returns the total amount of open issues for this version.
-
#overdue? ⇒ Boolean
Returns true if the version is overdue: due date reached and some open issues.
-
#shared? ⇒ Boolean
Returns true if the version is shared, otherwise false.
-
#spent_hours ⇒ Object
Returns the total reported time for this version.
- #start_date ⇒ Object
- #to_s ⇒ Object
- #to_s_with_project ⇒ Object
-
#visible?(user = User.current) ⇒ Boolean
Returns true if
user
or current user is allowed to view the version. - #wiki_page ⇒ Object
Methods included from Redmine::SafeAttributes
#delete_unsafe_attributes, included, #safe_attribute?, #safe_attribute_names, #safe_attributes=
Class Method Details
.fields_for_order_statement(table = nil) ⇒ Object
196 197 198 199 |
# File 'app/models/version.rb', line 196 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 |
Instance Method Details
#<=>(version) ⇒ Object
Versions are sorted by effective_date and name Those with no effective_date are at the end, sorted by name
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'app/models/version.rb', line 176 def <=>(version) if self.effective_date if version.effective_date if self.effective_date == version.effective_date 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 1 else name == version.name ? id <=> version.id : name <=> version.name end end end |
#allowed_sharings(user = User.current) ⇒ Object
Returns the sharings that user
can set the version to
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 |
# File 'app/models/version.rb', line 204 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 |
#attachments_deletable?(usr = User.current) ⇒ Boolean
66 67 68 |
# File 'app/models/version.rb', line 66 def (usr=User.current) project.present? && project.(usr) end |
#attachments_visible?(*args) ⇒ Boolean
Version files have same visibility as project files
62 63 64 |
# File 'app/models/version.rb', line 62 def (*args) project.present? && project.(*args) end |
#behind_schedule? ⇒ Boolean
106 107 108 109 110 111 112 113 114 115 |
# File 'app/models/version.rb', line 106 def behind_schedule? if completed_percent == 100 return false elsif due_date && start_date done_date = start_date + ((due_date - start_date+1)* completed_percent/100).floor return done_date <= Date.today else false # No issues so it's not late end end |
#closed? ⇒ Boolean
93 94 95 |
# File 'app/models/version.rb', line 93 def closed? status == 'closed' end |
#closed_issues_count ⇒ Object
Returns the total amount of closed issues for this version.
156 157 158 159 |
# File 'app/models/version.rb', line 156 def closed_issues_count load_issue_counts @closed_issues_count end |
#closed_percent ⇒ Object
Returns the percentage of issues that have been marked as 'closed'.
130 131 132 133 134 135 136 |
# File 'app/models/version.rb', line 130 def closed_percent if issues_count == 0 0 else issues_progress(false) end end |
#completed? ⇒ Boolean
Returns true if the version is completed: due date reached and no open issues
102 103 104 |
# File 'app/models/version.rb', line 102 def completed? effective_date && (effective_date < Date.today) && (open_issues_count == 0) end |
#completed_percent ⇒ Object
Returns the completion percentage of this version based on the amount of open/closed issues and the time spent on the open issues.
119 120 121 122 123 124 125 126 127 |
# File 'app/models/version.rb', line 119 def completed_percent if issues_count == 0 0 elsif open_issues_count == 0 100 else issues_progress(false) + issues_progress(true) end end |
#due_date ⇒ Object
74 75 76 |
# File 'app/models/version.rb', line 74 def due_date effective_date end |
#due_date=(arg) ⇒ Object
78 79 80 |
# File 'app/models/version.rb', line 78 def due_date=(arg) self.effective_date=(arg) end |
#estimated_hours ⇒ Object
Returns the total estimated time for this version (sum of leaves estimated_hours)
84 85 86 |
# File 'app/models/version.rb', line 84 def estimated_hours @estimated_hours ||= fixed_issues.leaves.sum(:estimated_hours).to_f end |
#issues_count ⇒ Object
Returns assigned issues count
144 145 146 147 |
# File 'app/models/version.rb', line 144 def issues_count load_issue_counts @issue_count end |
#open? ⇒ Boolean
97 98 99 |
# File 'app/models/version.rb', line 97 def open? status == 'open' end |
#open_issues_count ⇒ Object
Returns the total amount of open issues for this version.
150 151 152 153 |
# File 'app/models/version.rb', line 150 def open_issues_count load_issue_counts @open_issues_count end |
#overdue? ⇒ Boolean
Returns true if the version is overdue: due date reached and some open issues
139 140 141 |
# File 'app/models/version.rb', line 139 def overdue? effective_date && (effective_date < Date.today) && (open_issues_count > 0) end |
#shared? ⇒ Boolean
Returns true if the version is shared, otherwise false
225 226 227 |
# File 'app/models/version.rb', line 225 def shared? sharing != 'none' end |
#spent_hours ⇒ Object
Returns the total reported time for this version
89 90 91 |
# File 'app/models/version.rb', line 89 def spent_hours @spent_hours ||= TimeEntry.joins(:issue).where("#{Issue.table_name}.fixed_version_id = ?", id).sum(:hours).to_f end |
#start_date ⇒ Object
70 71 72 |
# File 'app/models/version.rb', line 70 def start_date @start_date ||= fixed_issues.minimum('start_date') end |
#to_s ⇒ Object
168 |
# File 'app/models/version.rb', line 168 def to_s; name end |
#to_s_with_project ⇒ Object
170 171 172 |
# File 'app/models/version.rb', line 170 def to_s_with_project "#{project} - #{name}" end |
#visible?(user = User.current) ⇒ Boolean
Returns true if user
or current user is allowed to view the
version
57 58 59 |
# File 'app/models/version.rb', line 57 def visible?(user=User.current) user.allowed_to?(:view_issues, self.project) end |
#wiki_page ⇒ Object
161 162 163 164 165 166 |
# File 'app/models/version.rb', line 161 def wiki_page if project.wiki && !wiki_page_title.blank? @wiki_page ||= project.wiki.find_page(wiki_page_title) end @wiki_page end |