Class: Issue

Inherits:
ActiveRecord::Base
  • Object
show all
Includes:
Redmine::I18n, Redmine::NestedSet::IssueNestedSet, Redmine::SafeAttributes, Redmine::Utils::DateCalculation
Defined in:
app/models/issue.rb

Overview

Redmine - project management software Copyright (C) 2006-2016 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

DONE_RATIO_OPTIONS = 
%w(issue_field issue_status)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Redmine::NestedSet::IssueNestedSet

included

Methods included from Redmine::I18n

#current_language, #day_letter, #day_name, #find_language, #format_date, #format_hours, #format_time, included, #l, #l_hours, #l_hours_short, #l_or_humanize, #languages_options, #ll, #lu, #month_name, #set_language_if_valid, #valid_languages

Methods included from Redmine::Utils::DateCalculation

#add_working_days, #next_working_date, #non_working_week_days, #working_days

Methods included from Redmine::SafeAttributes

#delete_unsafe_attributes, included, #safe_attribute?

Constructor Details

#initialize(attributes = nil, *args) ⇒ Issue

Returns a new instance of Issue



201
202
203
204
205
206
207
208
 
# File 'app/models/issue.rb', line 201

def initialize(attributes=nil, *args)
  super
  if new_record?
    # set default values for new records only
    self.priority ||= IssuePriority.default
    self.watcher_user_ids = []
  end
end

Instance Attribute Details

#current_journal ⇒ Object (readonly)

Returns the current journal or nil if it's not initialized



785
786
787
 
# File 'app/models/issue.rb', line 785

def current_journal
  @current_journal
end

#deleted_attachment_ids ⇒ Object

Returns the value of attribute deleted_attachment_ids



62
63
64
 
# File 'app/models/issue.rb', line 62

def deleted_attachment_ids
  @deleted_attachment_ids
end

Class Method Details

.allowed_target_projects(user = User.current, current_project = nil) ⇒ Object

Returns a scope of projects that user can assign issues to If current_project is given, it will be included in the scope



1426
1427
1428
1429
1430
1431
1432
 
# File 'app/models/issue.rb', line 1426

def self.allowed_target_projects(user=User.current, current_project=nil)
  condition = Project.allowed_to_condition(user, :add_issues)
  if current_project
    condition = ["(#{condition}) OR #{Project.table_name}.id = ?", current_project.id]
  end
  Project.where(condition).having_trackers
end

.allowed_target_trackers(project, user = User.current, current_tracker = nil) ⇒ Object

Returns a scope of trackers that user can assign project issues to



1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
 
# File 'app/models/issue.rb', line 1440

def self.allowed_target_trackers(project, user=User.current, current_tracker=nil)
  if project
    scope = project.trackers.sorted
    unless user.admin?
      roles = user.roles_for_project(project).select {|r| r.has_permission?(:add_issues)}
      unless roles.any? {|r| r.permissions_all_trackers?(:add_issues)}
        tracker_ids = roles.map {|r| r.permissions_tracker_ids(:add_issues)}.flatten.uniq
        if current_tracker
          tracker_ids << current_tracker
        end
        scope = scope.where(:id => tracker_ids)
      end
    end
    scope
  else
    Tracker.none
  end
end

.by_assigned_to(project) ⇒ Object 



1377
1378
1379
 
# File 'app/models/issue.rb', line 1377

def self.by_assigned_to(project)
  count_and_group_by(:project => project, :association => :assigned_to)
end

.by_author(project) ⇒ Object 



1381
1382
1383
 
# File 'app/models/issue.rb', line 1381

def self.by_author(project)
  count_and_group_by(:project => project, :association => :author)
end

.by_category(project) ⇒ Object 



1373
1374
1375
 
# File 'app/models/issue.rb', line 1373

def self.by_category(project)
  count_and_group_by(:project => project, :association => :category)
end

.by_priority(project) ⇒ Object 



1369
1370
1371
 
# File 'app/models/issue.rb', line 1369

def self.by_priority(project)
  count_and_group_by(:project => project, :association => :priority)
end

.by_subproject(project) ⇒ Object 



1385
1386
1387
1388
 
# File 'app/models/issue.rb', line 1385

def self.by_subproject(project)
  r = count_and_group_by(:project => project, :with_subprojects => true, :association => :project)
  r.reject {|r| r["project_id"] == project.id.to_s}
end

.by_tracker(project) ⇒ Object 



1361
1362
1363
 
# File 'app/models/issue.rb', line 1361

def self.by_tracker(project)
  count_and_group_by(:project => project, :association => :tracker)
end

.by_version(project) ⇒ Object 



1365
1366
1367
 
# File 'app/models/issue.rb', line 1365

def self.by_version(project)
  count_and_group_by(:project => project, :association => :fixed_version)
end

.count_and_group_by(options) ⇒ Object

Query generator for selecting groups of issue counts for a project based on specific criteria

Options

  • project - Project to search in.

  • with_subprojects - Includes subprojects issues if set to true.

  • association - Symbol. Association for grouping.



1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
 
# File 'app/models/issue.rb', line 1397

def self.count_and_group_by(options)
  assoc = reflect_on_association(options[:association])
  select_field = assoc.foreign_key

  Issue.
    visible(User.current, :project => options[:project], :with_subprojects => options[:with_subprojects]).
    joins(:status, assoc.name).
    group(:status_id, :is_closed, select_field).
    count.
    map do |columns, total|
      status_id, is_closed, field_value = columns
      is_closed = ['t', 'true', '1'].include?(is_closed.to_s)
      {
        "status_id" => status_id.to_s,
        "closed" => is_closed,
        select_field => field_value.to_s,
        "total" => total.to_s
      }
    end
end

.cross_project_scope(project, scope = nil) ⇒ Object

Returns an issue scope based on project and scope



1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
 
# File 'app/models/issue.rb', line 1340

def self.cross_project_scope(project, scope=nil)
  if project.nil?
    return Issue
  end
  case scope
  when 'all', 'system'
    Issue
  when 'tree'
    Issue.joins(:project).where("(#{Project.table_name}.lft >= :lft AND #{Project.table_name}.rgt <= :rgt)",
                                :lft => project.root.lft, :rgt => project.root.rgt)
  when 'hierarchy'
    Issue.joins(:project).where("(#{Project.table_name}.lft >= :lft AND #{Project.table_name}.rgt <= :rgt) OR (#{Project.table_name}.lft < :lft AND #{Project.table_name}.rgt > :rgt)",
                                :lft => project.lft, :rgt => project.rgt)
  when 'descendants'
    Issue.joins(:project).where("(#{Project.table_name}.lft >= :lft AND #{Project.table_name}.rgt <= :rgt)",
                                :lft => project.lft, :rgt => project.rgt)
  else
    Issue.where(:project_id => project.id)
  end
end

.load_relations(issues) ⇒ Object

Preloads relations for a collection of issues



1052
1053
1054
1055
1056
1057
1058
1059
 
# File 'app/models/issue.rb', line 1052

def self.load_relations(issues)
  if issues.any?
    relations = IssueRelation.where("issue_from_id IN (:ids) OR issue_to_id IN (:ids)", :ids => issues.map(&:id)).all
    issues.each do |issue|
      issue.instance_variable_set "@relations", relations.select {|r| r.issue_from_id == issue.id || r.issue_to_id == issue.id}
    end
  end
end

.load_visible_relations(issues, user = User.current) ⇒ Object

Preloads visible relations for a collection of issues



1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
 
# File 'app/models/issue.rb', line 1085

def self.load_visible_relations(issues, user=User.current)
  if issues.any?
    issue_ids = issues.map(&:id)
    # Relations with issue_from in given issues and visible issue_to
    relations_from = IssueRelation.joins(:issue_to => :project).
                       where(visible_condition(user)).where(:issue_from_id => issue_ids).to_a
    # Relations with issue_to in given issues and visible issue_from
    relations_to = IssueRelation.joins(:issue_from => :project).
                       where(visible_condition(user)).
                       where(:issue_to_id => issue_ids).to_a
    issues.each do |issue|
      relations =
        relations_from.select {|relation| relation.issue_from_id == issue.id} +
        relations_to.select {|relation| relation.issue_to_id == issue.id}

      issue.instance_variable_set "@relations", IssueRelation::Relations.new(issue, relations.sort)
    end
  end
end

.load_visible_spent_hours(issues, user = User.current) ⇒ Object

Preloads visible spent time for a collection of issues



1062
1063
1064
1065
1066
1067
1068
1069
 
# File 'app/models/issue.rb', line 1062

def self.load_visible_spent_hours(issues, user=User.current)
  if issues.any?
    hours_by_issue_id = TimeEntry.visible(user).where(:issue_id => issues.map(&:id)).group(:issue_id).sum(:hours)
    issues.each do |issue|
      issue.instance_variable_set "@spent_hours", (hours_by_issue_id[issue.id] || 0)
    end
  end
end

.load_visible_total_spent_hours(issues, user = User.current) ⇒ Object

Preloads visible total spent time for a collection of issues



1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
 
# File 'app/models/issue.rb', line 1072

def self.load_visible_total_spent_hours(issues, user=User.current)
  if issues.any?
    hours_by_issue_id = TimeEntry.visible(user).joins(:issue).
      joins("JOIN #{Issue.table_name} parent ON parent.root_id = #{Issue.table_name}.root_id" +
        " AND parent.lft <= #{Issue.table_name}.lft AND parent.rgt >= #{Issue.table_name}.rgt").
      where("parent.id IN (?)", issues.map(&:id)).group("parent.id").sum(:hours)
    issues.each do |issue|
      issue.instance_variable_set "@total_spent_hours", (hours_by_issue_id[issue.id] || 0)
    end
  end
end

.self_and_descendants(issues) ⇒ Object

Returns a scope of the given issues and their descendants



1106
1107
1108
1109
1110
1111
1112
 
# File 'app/models/issue.rb', line 1106

def self.self_and_descendants(issues)
  Issue.joins("JOIN #{Issue.table_name} ancestors" +
      " ON ancestors.root_id = #{Issue.table_name}.root_id" +
      " AND ancestors.lft <= #{Issue.table_name}.lft AND ancestors.rgt >= #{Issue.table_name}.rgt"
    ).
    where(:ancestors => {:id => issues.map(&:id)})
end

.update_versions_from_hierarchy_change(project) ⇒ Object

Unassigns issues from versions that are no longer shared after project was moved



1284
1285
1286
1287
1288
1289
1290
1291
 
# File 'app/models/issue.rb', line 1284

def self.update_versions_from_hierarchy_change(project)
  moved_project_ids = project.self_and_descendants.reload.collect(&:id)
  # Update issues of the moved projects and issues assigned to a version of a moved project
  Issue.update_versions(
          ["#{Version.table_name}.project_id IN (?) OR #{Issue.table_name}.project_id IN (?)",
           moved_project_ids, moved_project_ids]
        )
end

.update_versions_from_sharing_change(version) ⇒ Object

Unassigns issues from version if it's no longer shared with issue's project



1277
1278
1279
1280
 
# File 'app/models/issue.rb', line 1277

def self.update_versions_from_sharing_change(version)
  # Update issues assigned to the version
  update_versions(["#{Issue.table_name}.fixed_version_id = ?", version.id])
end

.use_field_for_done_ratio? ⇒ Boolean

Returns:

  • (Boolean) 


681
682
683
 
# File 'app/models/issue.rb', line 681

def self.use_field_for_done_ratio?
  Setting.issue_done_ratio == 'issue_field'
end

.use_status_for_done_ratio? ⇒ Boolean

Returns:

  • (Boolean) 


677
678
679
 
# File 'app/models/issue.rb', line 677

def self.use_status_for_done_ratio?
  Setting.issue_done_ratio == 'issue_status'
end

.visible_condition(user, options = {}) ⇒ Object

Returns a SQL conditions string used to find all issues visible by the specified user



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'app/models/issue.rb', line 122

def self.visible_condition(user, options={})
  Project.allowed_to_condition(user, :view_issues, options) do |role, user|
    sql = if user.id && user.logged?
      case role.issues_visibility
      when 'all'
        '1=1'
      when 'default'
        user_ids = [user.id] + user.groups.map(&:id).compact
        "(#{table_name}.is_private = #{connection.quoted_false} OR #{table_name}.author_id = #{user.id} OR #{table_name}.assigned_to_id IN (#{user_ids.join(',')}))"
      when 'own'
        user_ids = [user.id] + user.groups.map(&:id).compact
        "(#{table_name}.author_id = #{user.id} OR #{table_name}.assigned_to_id IN (#{user_ids.join(',')}))"
      else
        '1=0'
      end
    else
      "(#{table_name}.is_private = #{connection.quoted_false})"
    end
    unless role.permissions_all_trackers?(:view_issues)
      tracker_ids = role.permissions_tracker_ids(:view_issues)
      if tracker_ids.any?
        sql = "(#{sql} AND #{table_name}.tracker_id IN (#{tracker_ids.join(',')}))"
      else
        sql = '1=0'
      end
    end
    sql
  end
end

Instance Method Details

#<=>(issue) ⇒ Object 



1246
1247
1248
1249
1250
1251
1252
1253
1254
 
# File 'app/models/issue.rb', line 1246

def <=>(issue)
  if issue.nil?
    -1
  elsif root_id != issue.root_id
    (root_id || 0) <=> (issue.root_id || 0)
  else
    (lft || 0) <=> (issue.lft || 0)
  end
end

#allowed_target_projects(user = User.current) ⇒ Object

Returns a scope of projects that user can assign the issue to



1419
1420
1421
1422
 
# File 'app/models/issue.rb', line 1419

def allowed_target_projects(user=User.current)
  current_project = new_record? ? nil : project
  self.class.allowed_target_projects(user, current_project)
end

#allowed_target_trackers(user = User.current) ⇒ Object

Returns a scope of trackers that user can assign the issue to



1435
1436
1437
 
# File 'app/models/issue.rb', line 1435

def allowed_target_trackers(user=User.current)
  self.class.allowed_target_trackers(project, user, tracker_id_was)
end

#assign_attributes(new_attributes, *args) ⇒ Object

Overrides assign_attributes so that project and tracker get assigned first



417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'app/models/issue.rb', line 417

def assign_attributes(new_attributes, *args)
  return if new_attributes.nil?
  attrs = new_attributes.dup
  attrs.stringify_keys!

  %w(project project_id tracker tracker_id).each do |attr|
    if attrs.has_key?(attr)
      send "#{attr}=", attrs.delete(attr)
    end
  end
  super attrs, *args
end

#assignable_users ⇒ Object

Users the issue can be assigned to



875
876
877
878
879
880
881
882
 
# File 'app/models/issue.rb', line 875

def assignable_users
  users = project.assignable_users(tracker).to_a
  users << author if author && author.active?
  if assigned_to_id_was.present? && assignee = Principal.find_by_id(assigned_to_id_was)
    users << assignee
  end
  users.uniq.sort
end

#assignable_versions ⇒ Object

Versions that the issue can be assigned to



885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
 
# File 'app/models/issue.rb', line 885

def assignable_versions
  return @assignable_versions if @assignable_versions

  versions = project.shared_versions.open.to_a
  if fixed_version
    if fixed_version_id_changed?
      # nothing to do
    elsif project_id_changed?
      if project.shared_versions.include?(fixed_version)
        versions << fixed_version
      end
    else
      versions << fixed_version
    end
  end
  @assignable_versions = versions.uniq.sort
end

#assigned_to_was ⇒ Object

Returns the previous assignee (user or group) if changed



963
964
965
966
967
968
969
 
# File 'app/models/issue.rb', line 963

def assigned_to_was
  # assigned_to_id_was is reset before after_save callbacks
  user_id = @previous_assigned_to_id || assigned_to_id_was
  if user_id && user_id != assigned_to_id
    @assigned_to_was ||= Principal.find_by_id(user_id)
  end
end

#attachments_editable?(user = User.current) ⇒ Boolean

Overrides Redmine::Acts::Attachable::InstanceMethods#attachments_editable?

Returns:

  • (Boolean) 


187
188
189
 
# File 'app/models/issue.rb', line 187

def attachments_editable?(user=User.current)
  attributes_editable?(user)
end

#attributes=(new_attributes) ⇒ Object 



430
431
432
 
# File 'app/models/issue.rb', line 430

def attributes=(new_attributes)
  assign_attributes new_attributes
end

#attributes_editable?(user = User.current) ⇒ Boolean

Returns true if user or current user is allowed to edit the issue

Returns:

  • (Boolean) 


182
183
184
 
# File 'app/models/issue.rb', line 182

def attributes_editable?(user=User.current)
  user_tracker_permission?(user, :edit_issues)
end

#available_custom_fields ⇒ Object

Overrides Redmine::Acts::Customizable::InstanceMethods#available_custom_fields



251
252
253
 
# File 'app/models/issue.rb', line 251

def available_custom_fields
  (project && tracker) ? (project.all_issue_custom_fields & tracker.custom_fields) : []
end

#base_reload ⇒ Object 



239
 
# File 'app/models/issue.rb', line 239

alias :base_reload :reload

#behind_schedule? ⇒ Boolean

Is the amount of work done less than it should for the due date

Returns:

  • (Boolean) 


863
864
865
866
867
 
# File 'app/models/issue.rb', line 863

def behind_schedule?
  return false if start_date.nil? || due_date.nil?
  done_date = start_date + ((due_date - start_date + 1) * done_ratio / 100).floor
  return done_date <= User.current.today
end

#blocked? ⇒ Boolean

Returns true if this issue is blocked by another issue that is still open

Returns:

  • (Boolean) 


904
905
906
 
# File 'app/models/issue.rb', line 904

def blocked?
  !relations_to.detect {|ir| ir.relation_type == 'blocks' && !ir.issue_from.closed?}.nil?
end

#blocks?(other) ⇒ Boolean

Returns true if this issue blocks the other issue, otherwise returns false

Returns:

  • (Boolean) 


1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
 
# File 'app/models/issue.rb', line 1120

def blocks?(other)
  all = [self]
  last = [self]
  while last.any?
    current = last.map {|i| i.relations_from.where(:relation_type => IssueRelation::TYPE_BLOCKS).map(&:issue_to)}.flatten.uniq
    current -= last
    current -= all
    return true if current.include?(other)
    last = current
    all += last
  end
  false
end

#category_id=(cid) ⇒ Object 



311
312
313
314
 
# File 'app/models/issue.rb', line 311

def category_id=(cid)
  self.category = nil
  write_attribute(:category_id, cid)
end

#children? ⇒ Boolean

Does this issue have children?

Returns:

  • (Boolean) 


870
871
872
 
# File 'app/models/issue.rb', line 870

def children?
  !leaf?
end

#closed? ⇒ Boolean

Return true if the issue is closed, otherwise false

Returns:

  • (Boolean) 


829
830
831
 
# File 'app/models/issue.rb', line 829

def closed?
  status.present? && status.is_closed?
end

#closing? ⇒ Boolean

Return true if the issue is being closed

Returns:

  • (Boolean) 


849
850
851
852
853
854
855
 
# File 'app/models/issue.rb', line 849

def closing?
  if new_record?
    closed?
  else
    status_id_changed? && closed? && !was_closed?
  end
end

#copy(attributes = nil, copy_options = {}) ⇒ Object

Returns an unsaved copy of the issue



280
281
282
283
284
 
# File 'app/models/issue.rb', line 280

def copy(attributes=nil, copy_options={})
  copy = self.class.new.copy_from(self, copy_options)
  copy.attributes = attributes if attributes
  copy
end

#copy? ⇒ Boolean

Returns true if the issue is a copy

Returns:

  • (Boolean) 


287
288
289
 
# File 'app/models/issue.rb', line 287

def copy?
  @copied_from.present?
end

#copy_from(arg, options = {}) ⇒ Object

Copies attributes from another issue, arg can be an id or an Issue



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'app/models/issue.rb', line 263

def copy_from(arg, options={})
  issue = arg.is_a?(Issue) ? arg : Issue.visible.find(arg)
  self.attributes = issue.attributes.dup.except("id", "root_id", "parent_id", "lft", "rgt", "created_on", "updated_on", "closed_on")
  self.custom_field_values = issue.custom_field_values.inject({}) {|h,v| h[v.custom_field_id] = v.value; h}
  self.status = issue.status
  self.author = User.current
  unless options[:attachments] == false
    self.attachments = issue.attachments.map do |attachement|
      attachement.copy(:container => self)
    end
  end
  @copied_from = issue
  @copy_options = options
  self
end

#css_classes(user = User.current) ⇒ Object

Returns a string of css classes that apply to the issue



1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
 
# File 'app/models/issue.rb', line 1261

def css_classes(user=User.current)
  s = "issue tracker-#{tracker_id} status-#{status_id} #{priority.try(:css_classes)}"
  s << ' closed' if closed?
  s << ' overdue' if overdue?
  s << ' child' if child?
  s << ' parent' unless leaf?
  s << ' private' if is_private?
  if user.logged?
    s << ' created-by-me' if author_id == user.id
    s << ' assigned-to-me' if assigned_to_id == user.id
    s << ' assigned-to-my-group' if user.groups.any? {|g| g.id == assigned_to_id}
  end
  s
end

#dates_derived? ⇒ Boolean

Returns:

  • (Boolean) 


1234
1235
1236
 
# File 'app/models/issue.rb', line 1234

def dates_derived?
  !leaf? && Setting.parent_issue_dates == 'derived'
end

#default_status ⇒ Object

Returns the default status of the issue based on its tracker Returns nil if tracker is nil



910
911
912
 
# File 'app/models/issue.rb', line 910

def default_status
  tracker.try(:default_status)
end

#deletable?(user = User.current) ⇒ Boolean

Returns true if user or current user is allowed to delete the issue

Returns:

  • (Boolean) 


197
198
199
 
# File 'app/models/issue.rb', line 197

def deletable?(user=User.current)
  user_tracker_permission?(user, :delete_issues)
end

#description=(arg) ⇒ Object 



405
406
407
408
409
410
 
# File 'app/models/issue.rb', line 405

def description=(arg)
  if arg.is_a?(String)
    arg = arg.gsub(/(\r\n|\n|\r)/, "\r\n")
  end
  write_attribute(:description, arg)
end

#destroy ⇒ Object

AR#Persistence#destroy would raise and RecordNotFound exception if the issue was already deleted or updated (non matching lock_version). This is a problem when bulk deleting issues or deleting a project (because an issue may already be deleted if its parent was deleted first). The issue is reloaded by the nested_set before being deleted so the lock_version condition should not be an issue but we handle it.



224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'app/models/issue.rb', line 224

def destroy
  super
rescue ActiveRecord::StaleObjectError, ActiveRecord::RecordNotFound
  # Stale or already deleted
  begin
    reload
  rescue ActiveRecord::RecordNotFound
    # The issue was actually already deleted
    @destroyed = true
    return freeze
  end
  # The issue was stale, retry to destroy
  super
end

#disabled_core_fields ⇒ Object 



574
575
576
 
# File 'app/models/issue.rb', line 574

def disabled_core_fields
  tracker ? tracker.disabled_core_fields : []
end

#done_ratio ⇒ Object 



669
670
671
672
673
674
675
 
# File 'app/models/issue.rb', line 669

def done_ratio
  if Issue.use_status_for_done_ratio? && status && status.default_done_ratio
    status.default_done_ratio
  else
    read_attribute(:done_ratio)
  end
end

#done_ratio_derived? ⇒ Boolean

Returns:

  • (Boolean) 


1242
1243
1244
 
# File 'app/models/issue.rb', line 1242

def done_ratio_derived?
  !leaf? && Setting.parent_issue_done_ratio == 'derived'
end

#due_before ⇒ Object

Returns the due date or the target due date if any Used on gantt chart



1160
1161
1162
 
# File 'app/models/issue.rb', line 1160

def due_before
  due_date || (fixed_version ? fixed_version.effective_date : nil)
end

#duplicates ⇒ Object

Returns an array of issues that duplicate this one



1154
1155
1156
 
# File 'app/models/issue.rb', line 1154

def duplicates
  relations_to.select {|r| r.relation_type == IssueRelation::TYPE_DUPLICATES}.collect {|r| r.issue_from}
end

#duration ⇒ Object

Returns the time scheduled for this issue.

Example:

Start Date: 2/26/09, End Date: 3/04/09
duration => 6


1169
1170
1171
 
# File 'app/models/issue.rb', line 1169

def duration
  (start_date && due_date) ? due_date - start_date : 0
end

#each_notification(users, &block) ⇒ Object 



1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
 
# File 'app/models/issue.rb', line 1002

def each_notification(users, &block)
  if users.any?
    if custom_field_values.detect {|value| !value.custom_field.visible?}
      users_by_custom_field_visibility = users.group_by do |user|
        visible_custom_field_values(user).map(&:custom_field_id).sort
      end
      users_by_custom_field_visibility.values.each do |users|
        yield(users)
      end
    else
      yield(users)
    end
  end
end

#editable?(user = User.current) ⇒ Boolean

Returns true if user or current user is allowed to edit or add notes to the issue

Returns:

  • (Boolean) 


177
178
179
 
# File 'app/models/issue.rb', line 177

def editable?(user=User.current)
  attributes_editable?(user) || notes_addable?(user)
end

#editable_custom_field_values(user = nil) ⇒ Object

Returns the custom_field_values that can be edited by the given user



579
580
581
582
583
584
 
# File 'app/models/issue.rb', line 579

def editable_custom_field_values(user=nil)
  read_only = read_only_attribute_names(user)
  visible_custom_field_values(user).reject do |value|
    read_only.include?(value.custom_field_id.to_s)
  end
end

#editable_custom_fields(user = nil) ⇒ Object

Returns the custom fields that can be edited by the given user



587
588
589
 
# File 'app/models/issue.rb', line 587

def editable_custom_fields(user=nil)
  editable_custom_field_values(user).map(&:custom_field).uniq
end

#estimated_hours=(h) ⇒ Object 



434
435
436
 
# File 'app/models/issue.rb', line 434

def estimated_hours=(h)
  write_attribute :estimated_hours, (h.is_a?(String) ? h.to_hours : h)
end

#find_relation(relation_id) ⇒ Object

Finds an issue relation given its id.



1115
1116
1117
 
# File 'app/models/issue.rb', line 1115

def find_relation(relation_id)
  IssueRelation.where("issue_to_id = ? OR issue_from_id = ?", id, id).find(relation_id)
end

#fixed_version_id=(vid) ⇒ Object 



316
317
318
319
 
# File 'app/models/issue.rb', line 316

def fixed_version_id=(vid)
  self.fixed_version = nil
  write_attribute(:fixed_version_id, vid)
end

#init_journal(user, notes = "") ⇒ Object 



780
781
782
 
# File 'app/models/issue.rb', line 780

def init_journal(user, notes = "")
  @current_journal ||= Journal.new(:journalized => self, :user => user, :notes => notes)
end

#journalized_attribute_names ⇒ Object

Returns the names of attributes that are journalized when updating the issue



790
791
792
793
794
795
796
 
# File 'app/models/issue.rb', line 790

def journalized_attribute_names
  names = Issue.column_names - %w(id root_id lft rgt lock_version created_on updated_on closed_on)
  if tracker
    names -= tracker.disabled_core_fields
  end
  names
end

#journals_after(journal_id) ⇒ Object

Returns a scope for journals that have an id greater than journal_id



808
809
810
811
812
813
814
 
# File 'app/models/issue.rb', line 808

def journals_after(journal_id)
  scope = journals.reorder("#{Journal.table_name}.id ASC")
  if journal_id.present?
    scope = scope.where("#{Journal.table_name}.id > ?", journal_id.to_i)
  end
  scope
end

#last_journal_id ⇒ Object

Returns the id of the last journal or nil



799
800
801
802
803
804
805
 
# File 'app/models/issue.rb', line 799

def last_journal_id
  if new_record?
    nil
  else
    journals.maximum(:id)
  end
end

#new_statuses_allowed_to(user = User.current, include_default = false) ⇒ Object

Returns an array of statuses that user is able to apply



915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
 
# File 'app/models/issue.rb', line 915

def new_statuses_allowed_to(user=User.current, include_default=false)
  initial_status = nil
  if new_record?
    # nop
  elsif tracker_id_changed?
    if Tracker.where(:id => tracker_id_was, :default_status_id => status_id_was).any?
      initial_status = default_status
    elsif tracker.issue_status_ids.include?(status_id_was)
      initial_status = IssueStatus.find_by_id(status_id_was)
    else
      initial_status = default_status
    end
  else
    initial_status = status_was
  end

  initial_assigned_to_id = assigned_to_id_changed? ? assigned_to_id_was : assigned_to_id
  assignee_transitions_allowed = initial_assigned_to_id.present? &&
    (user.id == initial_assigned_to_id || user.group_ids.include?(initial_assigned_to_id))

  statuses = []
  statuses += IssueStatus.new_statuses_allowed(
    initial_status,
    user.admin ? Role.all.to_a : user.roles_for_project(project),
    tracker,
    author == user,
    assignee_transitions_allowed
  )
  statuses << initial_status unless statuses.empty?
  statuses << default_status if include_default || (new_record? && statuses.empty?)

  if new_record? && @copied_from
    statuses << @copied_from.status
  end

  statuses = statuses.compact.uniq.sort
  if blocked? || descendants.open.any?
    # cannot close a blocked issue or a parent with open subtasks
    statuses.reject!(&:is_closed?)
  end
  if ancestors.open(false).any?
    # cannot reopen a subtask of a closed parent
    statuses.select!(&:is_closed?)
  end
  statuses
end

#notes_addable?(user = User.current) ⇒ Boolean

Returns true if user or current user is allowed to add notes to the issue

Returns:

  • (Boolean) 


192
193
194
 
# File 'app/models/issue.rb', line 192

def notes_addable?(user=User.current)
  user_tracker_permission?(user, :add_issue_notes)
end

#notified_users ⇒ Object

Returns the users that should be notified



977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'app/models/issue.rb', line 977

def notified_users
  notified = []
  # Author and assignee are always notified unless they have been
  # locked or don't want to be notified
  notified << author if author
  if assigned_to
    notified += (assigned_to.is_a?(Group) ? assigned_to.users : [assigned_to])
  end
  if assigned_to_was
    notified += (assigned_to_was.is_a?(Group) ? assigned_to_was.users : [assigned_to_was])
  end
  notified = notified.select {|u| u.active? && u.notify_about?(self)}

  notified += project.notified_users
  notified.uniq!
  # Remove users that can not view the issue
  notified.reject! {|user| !visible?(user)}
  notified
end

#notify=(arg) ⇒ Object 



1021
1022
1023
 
# File 'app/models/issue.rb', line 1021

def notify=(arg)
  @notify = arg
end

#notify? ⇒ Boolean

Returns:

  • (Boolean) 


1017
1018
1019
 
# File 'app/models/issue.rb', line 1017

def notify?
  @notify != false
end

#overdue? ⇒ Boolean

Returns true if the issue is overdue

Returns:

  • (Boolean) 


858
859
860
 
# File 'app/models/issue.rb', line 858

def overdue?
  due_date.present? && (due_date < User.current.today) && !closed?
end

#parent_issue_id ⇒ Object 



1306
1307
1308
1309
1310
1311
1312
1313
1314
 
# File 'app/models/issue.rb', line 1306

def parent_issue_id
  if @invalid_parent_issue_id
    @invalid_parent_issue_id
  elsif instance_variable_defined? :@parent_issue
    @parent_issue.nil? ? nil : @parent_issue.id
  else
    parent_id
  end
end

#parent_issue_id=(arg) ⇒ Object 



1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
 
# File 'app/models/issue.rb', line 1293

def parent_issue_id=(arg)
  s = arg.to_s.strip.presence
  if s && (m = s.match(%r{\A#?(\d+)\z})) && (@parent_issue = Issue.find_by_id(m[1]))
    @invalid_parent_issue_id = nil
  elsif s.blank?
    @parent_issue = nil
    @invalid_parent_issue_id = nil
  else
    @parent_issue = nil
    @invalid_parent_issue_id = arg
  end
end

#priority_derived? ⇒ Boolean

Returns:

  • (Boolean) 


1238
1239
1240
 
# File 'app/models/issue.rb', line 1238

def priority_derived?
  !leaf? && Setting.parent_issue_priority == 'derived'
end

#priority_id=(pid) ⇒ Object 



306
307
308
309
 
# File 'app/models/issue.rb', line 306

def priority_id=(pid)
  self.priority = nil
  write_attribute(:priority_id, pid)
end

#project=(project, keep_tracker = false) ⇒ Object

Sets the project. Unless keep_tracker argument is set to true, this will change the tracker to the first tracker of the new project if the previous tracker is not part of the new project trackers. This will:

  • clear the fixed_version is it's no longer valid for the new project.

  • clear the parent issue if it's no longer valid for the new project.

  • set the category to the category with the same name in the new project if it exists, or clear it if it doesn't.

  • for new issue, set the fixed_version to the project default version if it's a valid fixed_version.



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'app/models/issue.rb', line 367

def project=(project, keep_tracker=false)
  project_was = self.project
  association(:project).writer(project)
  if project_was && project && project_was != project
    @assignable_versions = nil

    unless keep_tracker || project.trackers.include?(tracker)
      self.tracker = project.trackers.first
    end
    # Reassign to the category with same name if any
    if category
      self.category = project.issue_categories.find_by_name(category.name)
    end
    # Clear the assignee if not available in the new project for new issues (eg. copy)
    # For existing issue, the previous assignee is still valid, so we keep it
    if new_record? && assigned_to && !assignable_users.include?(assigned_to)
      self.assigned_to_id = nil
    end
    # Keep the fixed_version if it's still valid in the new_project
    if fixed_version && fixed_version.project != project && !project.shared_versions.include?(fixed_version)
      self.fixed_version = nil
    end
    # Clear the parent task if it's no longer valid
    unless valid_parent_project?
      self.parent_issue_id = nil
    end
    reassign_custom_field_values
    @workflow_rule_by_attribute = nil
  end
  # Set fixed_version to the project default version if it's valid
  if new_record? && fixed_version.nil? && project && project.default_version_id?
    if project.shared_versions.open.exists?(project.default_version_id)
      self.fixed_version_id = project.default_version_id
    end
  end
  self.project
end

#project_id=(project_id) ⇒ Object 



349
350
351
352
353
354
 
# File 'app/models/issue.rb', line 349

def project_id=(project_id)
  if project_id.to_s != self.project_id.to_s
    self.project = (project_id.present? ? Project.find_by_id(project_id) : nil)
  end
  self.project_id
end

#read_only_attribute_names(user = nil) ⇒ Object

Returns the names of attributes that are read-only for user or the current user For users with multiple roles, the read-only fields are the intersection of read-only fields of each role The result is an array of strings where sustom fields are represented with their ids

Examples:

issue.read_only_attribute_names # => ['due_date', '2']
issue.read_only_attribute_names(user) # => []



599
600
601
 
# File 'app/models/issue.rb', line 599

def read_only_attribute_names(user=nil)
  workflow_rule_by_attribute(user).reject {|attr, rule| rule != 'readonly'}.keys
end

#recipients ⇒ Object

Returns the email addresses that should be notified



998
999
1000
 
# File 'app/models/issue.rb', line 998

def recipients
  notified_users.collect(&:mail)
end

#relations ⇒ Object 



1047
1048
1049
 
# File 'app/models/issue.rb', line 1047

def relations
  @relations ||= IssueRelation::Relations.new(self, (relations_from + relations_to).sort)
end

#reload(*args) ⇒ Object 



240
241
242
243
244
245
246
247
248
 
# File 'app/models/issue.rb', line 240

def reload(*args)
  @workflow_rule_by_attribute = nil
  @assignable_versions = nil
  @relations = nil
  @spent_hours = nil
  @total_spent_hours = nil
  @total_estimated_hours = nil
  base_reload(*args)
end

#reopening? ⇒ Boolean Also known as: reopened?

Return true if the issue is being reopened

Returns:

  • (Boolean) 


839
840
841
842
843
844
845
 
# File 'app/models/issue.rb', line 839

def reopening?
  if new_record?
    false
  else
    status_id_changed? && !closed? && was_closed?
  end
end

#required_attribute?(name, user = nil) ⇒ Boolean

Returns true if the attribute is required for user

Returns:

  • (Boolean) 


616
617
618
 
# File 'app/models/issue.rb', line 616

def required_attribute?(name, user=nil)
  required_attribute_names(user).include?(name.to_s)
end

#required_attribute_names(user = nil) ⇒ Object

Returns the names of required attributes for user or the current user For users with multiple roles, the required fields are the intersection of required fields of each role The result is an array of strings where sustom fields are represented with their ids

Examples:

issue.required_attribute_names # => ['due_date', '2']
issue.required_attribute_names(user) # => []



611
612
613
 
# File 'app/models/issue.rb', line 611

def required_attribute_names(user=nil)
  workflow_rule_by_attribute(user).reject {|attr, rule| rule != 'required'}.keys
end

#reschedule_on(date) ⇒ Object

Sets start_date on the given date or the next working day and changes due_date to keep the same working duration.



1193
1194
1195
1196
1197
1198
 
# File 'app/models/issue.rb', line 1193

def reschedule_on(date)
  wd = working_duration
  date = next_working_date(date)
  self.start_date = date
  self.due_date = add_working_days(date, wd)
end

#reschedule_on!(date) ⇒ Object

Reschedules the issue on the given date or the next working day and saves the record. If the issue is a parent task, this is done by rescheduling its subtasks.



1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
 
# File 'app/models/issue.rb', line 1202

def reschedule_on!(date)
  return if date.nil?
  if leaf? || !dates_derived?
    if start_date.nil? || start_date != date
      if start_date && start_date > date
        # Issue can not be moved earlier than its soonest start date
        date = [soonest_start(true), date].compact.max
      end
      reschedule_on(date)
      begin
        save
      rescue ActiveRecord::StaleObjectError
        reload
        reschedule_on(date)
        save
      end
    end
  else
    leaves.each do |leaf|
      if leaf.start_date
        # Only move subtask if it starts at the same date as the parent
        # or if it starts before the given date
        if start_date == leaf.start_date || date > leaf.start_date
          leaf.reschedule_on!(date)
        end
      else
        leaf.reschedule_on!(date)
      end
    end
  end
end

#safe_attribute_names(user = nil) ⇒ Object 



479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'app/models/issue.rb', line 479

def safe_attribute_names(user=nil)
  names = super
  names -= disabled_core_fields
  names -= read_only_attribute_names(user)
  if new_record?
    # Make sure that project_id can always be set for new issues
    names |= %w(project_id)
  end
  if dates_derived?
    names -= %w(start_date due_date)
  end
  if priority_derived?
    names -= %w(priority_id)
  end
  if done_ratio_derived?
    names -= %w(done_ratio)
  end
  names
end

#safe_attributes=(attrs, user = User.current) ⇒ Object

Safely sets attributes Should be called from controllers instead of #attributes= attr_accessible is too rough because we still want things like Issue.new(:project => foo) to work



503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
 
# File 'app/models/issue.rb', line 503

def safe_attributes=(attrs, user=User.current)
  return unless attrs.is_a?(Hash)

  attrs = attrs.deep_dup

  # Project and Tracker must be set before since new_statuses_allowed_to depends on it.
  if (p = attrs.delete('project_id')) && safe_attribute?('project_id')
    if p.is_a?(String) && !p.match(/^\d*$/)
      p_id = Project.find_by_identifier(p).try(:id)
    else
      p_id = p.to_i
    end
    if allowed_target_projects(user).where(:id => p_id).exists?
      self.project_id = p_id
    end

    if project_id_changed? && attrs['category_id'].to_s == category_id_was.to_s
      # Discard submitted category on previous project
      attrs.delete('category_id')
    end
  end

  if (t = attrs.delete('tracker_id')) && safe_attribute?('tracker_id')
    if allowed_target_trackers(user).where(:id => t.to_i).exists?
      self.tracker_id = t
    end
  end
  if project
    # Set a default tracker to accept custom field values
    # even if tracker is not specified
    self.tracker ||= allowed_target_trackers(user).first
  end

  statuses_allowed = new_statuses_allowed_to(user)
  if (s = attrs.delete('status_id')) && safe_attribute?('status_id')
    if statuses_allowed.collect(&:id).include?(s.to_i)
      self.status_id = s
    end
  end
  if new_record? && !statuses_allowed.include?(status)
    self.status = statuses_allowed.first || default_status
  end
  if (u = attrs.delete('assigned_to_id')) && safe_attribute?('assigned_to_id')
    self.assigned_to_id = u
  end


  attrs = delete_unsafe_attributes(attrs, user)
  return if attrs.empty?

  if attrs['parent_issue_id'].present?
    s = attrs['parent_issue_id'].to_s
    unless (m = s.match(%r{\A#?(\d+)\z})) && (m[1] == parent_id.to_s || Issue.visible(user).exists?(m[1]))
      @invalid_parent_issue_id = attrs.delete('parent_issue_id')
    end
  end

  if attrs['custom_field_values'].present?
    editable_custom_field_ids = editable_custom_field_values(user).map {|v| v.custom_field_id.to_s}
    attrs['custom_field_values'].select! {|k, v| editable_custom_field_ids.include?(k.to_s)}
  end

  if attrs['custom_fields'].present?
    editable_custom_field_ids = editable_custom_field_values(user).map {|v| v.custom_field_id.to_s}
    attrs['custom_fields'].select! {|c| editable_custom_field_ids.include?(c['id'].to_s)}
  end

  # mass-assignment security bypass
  assign_attributes attrs, :without_protection => true
end

#set_parent_id ⇒ Object 



1316
1317
1318
 
# File 'app/models/issue.rb', line 1316

def set_parent_id
  self.parent_id = parent_issue_id
end

#soonest_start(reload = false) ⇒ Object 



1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
 
# File 'app/models/issue.rb', line 1178

def soonest_start(reload=false)
  if @soonest_start.nil? || reload
    relations_to.reload if reload
    dates = relations_to.collect{|relation| relation.successor_soonest_start}
    p = @parent_issue || parent
    if p && Setting.parent_issue_dates == 'derived'
      dates << p.soonest_start
    end
    @soonest_start = dates.compact.max
  end
  @soonest_start
end

#spent_hours ⇒ Object

Returns the number of hours spent on this issue



1026
1027
1028
 
# File 'app/models/issue.rb', line 1026

def spent_hours
  @spent_hours ||= time_entries.sum(:hours) || 0
end

#status=(status) ⇒ Object

Sets the status.



299
300
301
302
303
304
 
# File 'app/models/issue.rb', line 299

def status=(status)
  if status != self.status
    @workflow_rule_by_attribute = nil
  end
  association(:status).writer(status)
end

#status_id=(status_id) ⇒ Object 



291
292
293
294
295
296
 
# File 'app/models/issue.rb', line 291

def status_id=(status_id)
  if status_id.to_s != self.status_id.to_s
    self.status = (status_id.present? ? IssueStatus.find_by_id(status_id) : nil)
  end
  self.status_id
end

#status_was ⇒ Object

Returns the initial status of the issue Returns nil for a new issue



818
819
820
821
822
823
824
825
826
 
# File 'app/models/issue.rb', line 818

def status_was
  if status_id_changed?
    if status_id_was.to_i > 0
      @status_was ||= IssueStatus.find_by_id(status_id_was)
    end
  else
    @status_was ||= status
  end
end

#to_s ⇒ Object 



1256
1257
1258
 
# File 'app/models/issue.rb', line 1256

def to_s
  "#{tracker} ##{id}: #{subject}"
end

#total_estimated_hours ⇒ Object 



1039
1040
1041
1042
1043
1044
1045
 
# File 'app/models/issue.rb', line 1039

def total_estimated_hours
  if leaf?
    estimated_hours
  else
    @total_estimated_hours ||= self_and_descendants.sum(:estimated_hours)
  end
end

#total_spent_hours ⇒ Object

Returns the total number of hours spent on this issue and its descendants



1031
1032
1033
1034
1035
1036
1037
 
# File 'app/models/issue.rb', line 1031

def total_spent_hours
  @total_spent_hours ||= if leaf?
    spent_hours
  else
    self_and_descendants.joins(:time_entries).sum("#{TimeEntry.table_name}.hours").to_f || 0.0
  end
end

#tracker=(tracker) ⇒ Object

Sets the tracker. This will set the status to the default status of the new tracker if:

  • the status was the default for the previous tracker

  • or if the status was not part of the new tracker statuses

  • or the status was nil



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'app/models/issue.rb', line 333

def tracker=(tracker)
  tracker_was = self.tracker
  association(:tracker).writer(tracker)
  if tracker != tracker_was
    if status == tracker_was.try(:default_status)
      self.status = nil
    elsif status && tracker && !tracker.issue_status_ids.include?(status.id)
      self.status = nil
    end
    reassign_custom_field_values
    @workflow_rule_by_attribute = nil
  end
  self.status ||= default_status
  self.tracker
end

#tracker_id=(tracker_id) ⇒ Object 



321
322
323
324
325
326
 
# File 'app/models/issue.rb', line 321

def tracker_id=(tracker_id)
  if tracker_id.to_s != self.tracker_id.to_s
    self.tracker = (tracker_id.present? ? Tracker.find_by_id(tracker_id) : nil)
  end
  self.tracker_id
end

#tracker_was ⇒ Object

Returns the original tracker



972
973
974
 
# File 'app/models/issue.rb', line 972

def tracker_was
  Tracker.find_by_id(tracker_id_was)
end

#update_done_ratio_from_issue_status ⇒ Object

Set the done_ratio using the status if that setting is set. This will keep the done_ratios even if the user turns off the setting later



774
775
776
777
778
 
# File 'app/models/issue.rb', line 774

def update_done_ratio_from_issue_status
  if Issue.use_status_for_done_ratio? && status && status.default_done_ratio
    self.done_ratio = status.default_done_ratio
  end
end

#valid_parent_project?(issue = parent) ⇒ Boolean

Returns true if issue's project is a valid parent issue project

Returns:

  • (Boolean) 


1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
 
# File 'app/models/issue.rb', line 1322

def valid_parent_project?(issue=parent)
  return true if issue.nil? || issue.project_id == project_id

  case Setting.cross_project_subtasks
  when 'system'
    true
  when 'tree'
    issue.project.root == project.root
  when 'hierarchy'
    issue.project.is_or_is_ancestor_of?(project) || issue.project.is_descendant_of?(project)
  when 'descendants'
    issue.project.is_or_is_ancestor_of?(project)
  else
    false
  end
end

#validate_custom_field_values ⇒ Object

Overrides Redmine::Acts::Customizable::InstanceMethods#validate_custom_field_values so that custom values that are not editable are not validated (eg. a custom field that is marked as required should not trigger a validation error if the user is not allowed to edit this field).



765
766
767
768
769
770
 
# File 'app/models/issue.rb', line 765

def validate_custom_field_values
  user = new_record? ? author : current_journal.try(:user)
  if new_record? || custom_field_values_changed?
    editable_custom_field_values(user).each(&:validate_value)
  end
end

#validate_issue ⇒ Object 



685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
 
# File 'app/models/issue.rb', line 685

def validate_issue
  if due_date && start_date && (start_date_changed? || due_date_changed?) && due_date < start_date
    errors.add :due_date, :greater_than_start_date
  end

  if start_date && start_date_changed? && soonest_start && start_date < soonest_start
    errors.add :start_date, :earlier_than_minimum_start_date, :date => format_date(soonest_start)
  end

  if fixed_version
    if !assignable_versions.include?(fixed_version)
      errors.add :fixed_version_id, :inclusion
    elsif reopening? && fixed_version.closed?
      errors.add :base, I18n.t(:error_can_not_reopen_issue_on_closed_version)
    end
  end

  # Checks that the issue can not be added/moved to a disabled tracker
  if project && (tracker_id_changed? || project_id_changed?)
    if tracker && !project.trackers.include?(tracker)
      errors.add :tracker_id, :inclusion
    end
  end

  if assigned_to_id_changed? && assigned_to_id.present?
    unless assignable_users.include?(assigned_to)
      errors.add :assigned_to_id, :invalid
    end
  end

  # Checks parent issue assignment
  if @invalid_parent_issue_id.present?
    errors.add :parent_issue_id, :invalid
  elsif @parent_issue
    if !valid_parent_project?(@parent_issue)
      errors.add :parent_issue_id, :invalid
    elsif (@parent_issue != parent) && (
        self.would_reschedule?(@parent_issue) ||
        @parent_issue.self_and_ancestors.any? {|a| a.relations_from.any? {|r| r.relation_type == IssueRelation::TYPE_PRECEDES && r.issue_to.would_reschedule?(self)}}
      )
      errors.add :parent_issue_id, :invalid
    elsif !closed? && @parent_issue.closed?
      # cannot attach an open issue to a closed parent
      errors.add :base, :open_issue_with_closed_parent
    elsif !new_record?
      # moving an existing issue
      if move_possible?(@parent_issue)
        # move accepted
      else
        errors.add :parent_issue_id, :invalid
      end
    end
  end
end

#validate_required_fields ⇒ Object

Validates the issue against additional workflow requirements



741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
 
# File 'app/models/issue.rb', line 741

def validate_required_fields
  user = new_record? ? author : current_journal.try(:user)

  required_attribute_names(user).each do |attribute|
    if attribute =~ /^\d+$/
      attribute = attribute.to_i
      v = custom_field_values.detect {|v| v.custom_field_id == attribute }
      if v && Array(v.value).detect(&:present?).nil?
        errors.add :base, v.custom_field.name + ' ' + l('activerecord.errors.messages.blank')
      end
    else
      if respond_to?(attribute) && send(attribute).blank? && !disabled_core_fields.include?(attribute)
        next if attribute == 'category_id' && project.try(:issue_categories).blank?
        next if attribute == 'fixed_version_id' && assignable_versions.blank?
        errors.add attribute, :blank
      end
    end
  end
end

#visible?(usr = nil) ⇒ Boolean

Returns true if usr or current user is allowed to view the issue

Returns:

  • (Boolean) 


153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'app/models/issue.rb', line 153

def visible?(usr=nil)
  (usr || User.current).allowed_to?(:view_issues, self.project) do |role, user|
    visible = if user.logged?
      case role.issues_visibility
      when 'all'
        true
      when 'default'
        !self.is_private? || (self.author == user || user.is_or_belongs_to?(assigned_to))
      when 'own'
        self.author == user || user.is_or_belongs_to?(assigned_to)
      else
        false
      end
    else
      !self.is_private?
    end
    unless role.permissions_all_trackers?(:view_issues)
      visible &&= role.permissions_tracker_ids?(:view_issues, tracker_id)
    end
    visible
  end
end

#visible_custom_field_values(user = nil) ⇒ Object 



255
256
257
258
259
260
 
# File 'app/models/issue.rb', line 255

def visible_custom_field_values(user=nil)
  user_real = user || User.current
  custom_field_values.select do |value|
    value.custom_field.visible_by?(project, user_real)
  end
end

#was_closed? ⇒ Boolean

Returns true if the issue was closed when loaded

Returns:

  • (Boolean) 


834
835
836
 
# File 'app/models/issue.rb', line 834

def was_closed?
  status_was.present? && status_was.is_closed?
end

#working_duration ⇒ Object

Returns the duration in working days



1174
1175
1176
 
# File 'app/models/issue.rb', line 1174

def working_duration
  (start_date && due_date) ? working_days(start_date, due_date) : 0
end

#would_reschedule?(other) ⇒ Boolean

Returns true if the other issue might be rescheduled if the start/due dates of this issue change

Returns:

  • (Boolean) 


1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
 
# File 'app/models/issue.rb', line 1135

def would_reschedule?(other)
  all = [self]
  last = [self]
  while last.any?
    current = last.map {|i|
      i.relations_from.where(:relation_type => IssueRelation::TYPE_PRECEDES).map(&:issue_to) +
      i.leaves.to_a +
      i.ancestors.map {|a| a.relations_from.where(:relation_type => IssueRelation::TYPE_PRECEDES).map(&:issue_to)}
    }.flatten.uniq
    current -= last
    current -= all
    return true if current.include?(other)
    last = current
    all += last
  end
  false
end