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-2017 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.

Since:

  • 0.4.0

Constant Summary collapse

DONE_RATIO_OPTIONS = 
%w(issue_field issue_status)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Redmine::I18n

#current_language, #day_letter, #day_name, #find_language, #format_date, #format_hours, #format_time, #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, #safe_attribute?

Constructor Details

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

Returns a new instance of Issue

Since:

  • 1.4.0



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

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

Since:

  • 1.0.0



818
819
820
 
# File 'app/models/issue.rb', line 818

def current_journal
  @current_journal
end

#deleted_attachment_ids ⇒ Object

Returns the value of attribute deleted_attachment_ids

Since:

  • 3.4.0



57
58
59
 
# File 'app/models/issue.rb', line 57

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

Since:

  • 3.0.0



1524
1525
1526
1527
1528
1529
1530
1531
1532
 
# File 'app/models/issue.rb', line 1524

def self.allowed_target_projects(user=User.current, current_project=nil)
  condition = Project.allowed_to_condition(user, :add_issues)
  if current_project.is_a?(Project)
    condition = ["(#{condition}) OR #{Project.table_name}.id = ?", current_project.id]
  elsif current_project
    condition = ["(#{condition}) AND #{Project.table_name}.id IN (?)", current_project.map(&: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

Since:

  • 3.3.0



1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
 
# File 'app/models/issue.rb', line 1540

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, with_subprojects = false) ⇒ Object

Since:

  • 1.0.0



1468
1469
1470
 
# File 'app/models/issue.rb', line 1468

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

.by_author(project, with_subprojects = false) ⇒ Object

Since:

  • 1.0.0



1472
1473
1474
 
# File 'app/models/issue.rb', line 1472

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

.by_category(project, with_subprojects = false) ⇒ Object

Since:

  • 1.0.0



1464
1465
1466
 
# File 'app/models/issue.rb', line 1464

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

.by_priority(project, with_subprojects = false) ⇒ Object

Since:

  • 1.0.0



1460
1461
1462
 
# File 'app/models/issue.rb', line 1460

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

.by_subproject(project) ⇒ Object

Since:

  • 1.0.0



1476
1477
1478
1479
 
# File 'app/models/issue.rb', line 1476

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, with_subprojects = false) ⇒ Object

Since:

  • 1.0.0



1452
1453
1454
 
# File 'app/models/issue.rb', line 1452

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

.by_version(project, with_subprojects = false) ⇒ Object

Since:

  • 1.0.0



1456
1457
1458
 
# File 'app/models/issue.rb', line 1456

def self.by_version(project, with_subprojects=false)
  count_and_group_by(:project => project, :association => :fixed_version, :with_subprojects => with_subprojects)
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.

Since:

  • 1.0.0



1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
 
# File 'app/models/issue.rb', line 1488

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

Since:

  • 2.6.0



1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
 
# File 'app/models/issue.rb', line 1431

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

Since:

  • 1.3.0



1101
1102
1103
1104
1105
1106
1107
1108
 
# File 'app/models/issue.rb', line 1101

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_last_notes(issues, user = User.current) ⇒ Object

Preloads visible last notes for a collection of issues

Since:

  • 3.4.0



1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'app/models/issue.rb', line 1183

def self.load_visible_last_notes(issues, user=User.current)
  if issues.any?
    issue_ids = issues.map(&:id)
    journal_ids = Journal.joins(issue: :project).
      where(:journalized_type => 'Issue', :journalized_id => issue_ids).
      where(Journal.visible_notes_condition(user, :skip_pre_condition => true)).
      where.not(notes: '').
      group(:journalized_id).
      maximum(:id).
      values
    journals = Journal.where(:id => journal_ids).to_a

    issues.each do |issue|
      journal = journals.detect {|j| j.journalized_id == issue.id}
      issue.instance_variable_set("@last_notes", journal.try(:notes) || '')
    end
  end
end

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

Preloads users who updated last a collection of issues

Since:

  • 3.4.0



1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
 
# File 'app/models/issue.rb', line 1164

def self.load_visible_last_updated_by(issues, user=User.current)
  if issues.any?
    issue_ids = issues.map(&:id)
    journal_ids = Journal.joins(issue: :project).
      where(:journalized_type => 'Issue', :journalized_id => issue_ids).
      where(Journal.visible_notes_condition(user, :skip_pre_condition => true)).
      group(:journalized_id).
      maximum(:id).
      values
    journals = Journal.where(:id => journal_ids).preload(:user).to_a

    issues.each do |issue|
      journal = journals.detect {|j| j.journalized_id == issue.id}
      issue.instance_variable_set("@last_updated_by", journal.try(:user) || '')
    end
  end
end

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

Preloads visible relations for a collection of issues

Since:

  • 2.2.0



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

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

Since:

  • 1.4.0



1111
1112
1113
1114
1115
1116
1117
1118
 
# File 'app/models/issue.rb', line 1111

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.0)
    end
  end
end

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

Preloads visible total spent time for a collection of issues

Since:

  • 3.1.1



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

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.0)
    end
  end
end

.self_and_descendants(issues) ⇒ Object

Returns a scope of the given issues and their descendants

Since:

  • 3.2.5



1155
1156
1157
1158
1159
1160
1161
 
# File 'app/models/issue.rb', line 1155

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

Since:

  • 0.9.0



1375
1376
1377
1378
1379
1380
1381
1382
 
# File 'app/models/issue.rb', line 1375

def self.update_versions_from_hierarchy_change(project)
  moved_project_ids = project.self_and_descendants.reload.pluck(: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

Since:

  • 0.9.0



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

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)

Since:

  • 0.9.0



706
707
708
 
# File 'app/models/issue.rb', line 706

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

.use_status_for_done_ratio? ⇒ Boolean

Returns:

  • (Boolean)

Since:

  • 0.9.0



702
703
704
 
# File 'app/models/issue.rb', line 702

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

Since:

  • 1.2.0



120
121
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
 
# File 'app/models/issue.rb', line 120

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.pluck(: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.pluck(: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

Since:

  • 1.0.0



1337
1338
1339
1340
1341
1342
1343
1344
1345
 
# File 'app/models/issue.rb', line 1337

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, context = nil) ⇒ Object

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

Since:

  • 1.4.0



1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
 
# File 'app/models/issue.rb', line 1510

def allowed_target_projects(user=User.current, context=nil)
  if new_record? && context.is_a?(Project) && !copy?
    current_project = context.self_and_descendants
  elsif new_record?
    current_project = nil
  else
    current_project = project
  end

  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

Since:

  • 3.3.0



1535
1536
1537
 
# File 'app/models/issue.rb', line 1535

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

Since:

  • 3.4.0



431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'app/models/issue.rb', line 431

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

Since:

  • 0.6.0



933
934
935
936
937
938
939
940
 
# File 'app/models/issue.rb', line 933

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

Since:

  • 0.9.0



943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
 
# File 'app/models/issue.rb', line 943

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

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

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

Returns:

  • (Boolean)

Since:

  • 3.3.0



185
186
187
 
# File 'app/models/issue.rb', line 185

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

#attributes=(new_attributes) ⇒ Object

Since:

  • 3.0.0



444
445
446
 
# File 'app/models/issue.rb', line 444

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)

Since:

  • 3.0.0



180
181
182
 
# File 'app/models/issue.rb', line 180

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

Since:

  • 0.8.0



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

Since:

  • 2.3.0



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

alias :base_reload :reload

#behind_schedule? ⇒ Boolean

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

Returns:

  • (Boolean)

Since:

  • 1.1.0



921
922
923
924
925
 
# File 'app/models/issue.rb', line 921

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)

Since:

  • 0.9.0



962
963
964
 
# File 'app/models/issue.rb', line 962

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)

Since:

  • 3.3.0



1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
 
# File 'app/models/issue.rb', line 1208

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

Since:

  • 1.4.0



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

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

#children? ⇒ Boolean

Does this issue have children?

Returns:

  • (Boolean)

Since:

  • 1.0.2



928
929
930
 
# File 'app/models/issue.rb', line 928

def children?
  !leaf?
end

#clear_journal ⇒ Object

Clears the current journal

Since:

  • 3.4.0



823
824
825
 
# File 'app/models/issue.rb', line 823

def clear_journal
  @current_journal = nil
end

#closed? ⇒ Boolean

Return true if the issue is closed, otherwise false

Returns:

  • (Boolean)

Since:

  • 0.6.0



887
888
889
 
# File 'app/models/issue.rb', line 887

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

#closing? ⇒ Boolean

Return true if the issue is being closed

Returns:

  • (Boolean)

Since:

  • 1.0.0



907
908
909
910
911
912
913
 
# File 'app/models/issue.rb', line 907

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

Since:

  • 1.4.0



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

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)

Since:

  • 1.4.0



298
299
300
 
# File 'app/models/issue.rb', line 298

def copy?
  @copied_from.present?
end

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

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

Since:

  • 0.6.0



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'app/models/issue.rb', line 268

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", "status_id", "closed_on")
  self.custom_field_values = issue.custom_field_values.inject({}) {|h,v| h[v.custom_field_id] = v.value; h}
  if options[:keep_status]
    self.status = issue.status
  end
  self.author = User.current
  unless options[:attachments] == false
    self.attachments = issue.attachments.map do |attachement|
      attachement.copy(:container => self)
    end
  end
  unless options[:watchers] == false
    self.watcher_user_ids =
      issue.watcher_users.select{|u| u.status == User::STATUS_ACTIVE}.map(&:id)
  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

Since:

  • 0.9.0



1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
 
# File 'app/models/issue.rb', line 1352

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)

Since:

  • 3.1.0



1325
1326
1327
 
# File 'app/models/issue.rb', line 1325

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

Since:

  • 3.0.0



968
969
970
 
# File 'app/models/issue.rb', line 968

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)

Since:

  • 3.3.0



195
196
197
 
# File 'app/models/issue.rb', line 195

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

#description=(arg) ⇒ Object

Since:

  • 1.2.1



419
420
421
422
423
424
 
# File 'app/models/issue.rb', line 419

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.

Since:

  • 1.4.4



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

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

Since:

  • 2.1.0



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

def disabled_core_fields
  tracker ? tracker.disabled_core_fields : []
end

#done_ratio ⇒ Object

Since:

  • 0.9.0



694
695
696
697
698
699
700
 
# File 'app/models/issue.rb', line 694

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)

Since:

  • 3.1.0



1333
1334
1335
 
# File 'app/models/issue.rb', line 1333

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

Since:

  • 0.8.0



1248
1249
1250
 
# File 'app/models/issue.rb', line 1248

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

#duplicates ⇒ Object

Returns an array of issues that duplicate this one

Since:

  • 0.6.0



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

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

Since:

  • 0.5.1



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

def duration
  (start_date && due_date) ? due_date - start_date : 0
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)

Since:

  • 2.3.0



175
176
177
 
# File 'app/models/issue.rb', line 175

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

Since:

  • 2.1.0



604
605
606
607
608
609
 
# File 'app/models/issue.rb', line 604

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

Since:

  • 2.5.2



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

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

#estimated_hours=(h) ⇒ Object

Since:

  • 0.7.0



448
449
450
 
# File 'app/models/issue.rb', line 448

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

#find_relation(relation_id) ⇒ Object

Finds an issue relation given its id.

Since:

  • 1.3.0



1203
1204
1205
 
# File 'app/models/issue.rb', line 1203

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

Since:

  • 1.4.0



327
328
329
330
 
# File 'app/models/issue.rb', line 327

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

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



813
814
815
 
# File 'app/models/issue.rb', line 813

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

Since:

  • 3.0.0



828
829
830
831
832
833
834
 
# File 'app/models/issue.rb', line 828

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

Since:

  • 2.1.0



846
847
848
849
850
851
852
 
# File 'app/models/issue.rb', line 846

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

Since:

  • 1.4.0



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

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

#last_notes ⇒ Object

Since:

  • 3.4.0



1092
1093
1094
1095
1096
1097
1098
 
# File 'app/models/issue.rb', line 1092

def last_notes
  if @last_notes
    @last_notes
  else
    journals.where.not(notes: '').reorder(:id => :desc).first.try(:notes)
  end
end

#last_updated_by ⇒ Object

Since:

  • 3.4.0



1084
1085
1086
1087
1088
1089
1090
 
# File 'app/models/issue.rb', line 1084

def last_updated_by
  if @last_updated_by
    @last_updated_by.presence
  else
    journals.reorder(:id => :desc).first.try(:user)
  end
end

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

Returns an array of statuses that user is able to apply

Since:

  • 0.7.0



973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
 
# File 'app/models/issue.rb', line 973

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?)

  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)

Since:

  • 3.3.0



190
191
192
 
# File 'app/models/issue.rb', line 190

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

#notified_users ⇒ Object

Returns the users that should be notified

Since:

  • 2.2.0



1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
 
# File 'app/models/issue.rb', line 1030

def notified_users
  # Author and assignee are always notified unless they have been
  # locked or don't want to be notified
  notified = [author, assigned_to, previous_assignee].compact.uniq
  notified = notified.map {|n| n.is_a?(Group) ? n.users : n}.flatten
  notified.uniq!
  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

Since:

  • 3.2.0



1054
1055
1056
 
# File 'app/models/issue.rb', line 1054

def notify=(arg)
  @notify = arg
end

#notify? ⇒ Boolean

Returns:

  • (Boolean)

Since:

  • 3.2.0



1050
1051
1052
 
# File 'app/models/issue.rb', line 1050

def notify?
  @notify != false
end

#overdue? ⇒ Boolean

Returns true if the issue is overdue

Returns:

  • (Boolean)

Since:

  • 0.8.0



916
917
918
 
# File 'app/models/issue.rb', line 916

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

#parent_issue_id ⇒ Object

Since:

  • 1.0.0



1397
1398
1399
1400
1401
1402
1403
1404
1405
 
# File 'app/models/issue.rb', line 1397

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

Since:

  • 1.0.0



1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
 
# File 'app/models/issue.rb', line 1384

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

#previous_assignee ⇒ Object

Returns the previous assignee whenever we're before the save or in after_* callbacks

Since:

  • 4.0.0



1023
1024
1025
1026
1027
 
# File 'app/models/issue.rb', line 1023

def previous_assignee
  if previous_assigned_to_id = assigned_to_id_change_to_be_saved.nil? ? assigned_to_id_before_last_save : assigned_to_id_in_database
    Principal.find_by_id(previous_assigned_to_id)
  end
end

#priority_derived? ⇒ Boolean

Returns:

  • (Boolean)

Since:

  • 3.1.0



1329
1330
1331
 
# File 'app/models/issue.rb', line 1329

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

#priority_id=(pid) ⇒ Object

Since:

  • 0.6.0



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

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.

Since:

  • 1.4.0



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
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'app/models/issue.rb', line 378

def project=(project, keep_tracker=false)
  project_was = self.project
  association(:project).writer(project)
  if project != project_was
    @safe_attribute_names = nil
  end
  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

Since:

  • 1.4.0



360
361
362
363
364
365
 
# File 'app/models/issue.rb', line 360

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) # => []

Since:

  • 2.1.0



624
625
626
 
# File 'app/models/issue.rb', line 624

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

Since:

  • 0.6.0



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

def recipients
  notified_users.collect(&:mail)
end

#relations ⇒ Object

Since:

  • 0.5.1



1080
1081
1082
 
# File 'app/models/issue.rb', line 1080

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

#reload(*args) ⇒ Object

Since:

  • 2.1.0



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

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

#reopening? ⇒ Boolean Also known as: reopened?

Return true if the issue is being reopened

Returns:

  • (Boolean)

Since:

  • 3.0.0



897
898
899
900
901
902
903
 
# File 'app/models/issue.rb', line 897

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)

Since:

  • 2.1.0



641
642
643
 
# File 'app/models/issue.rb', line 641

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) # => []

Since:

  • 2.1.0



636
637
638
 
# File 'app/models/issue.rb', line 636

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.

Since:

  • 2.2.0



1281
1282
1283
1284
1285
1286
 
# File 'app/models/issue.rb', line 1281

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, journal = nil) ⇒ 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.

Since:

  • 2.2.0



1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
 
# File 'app/models/issue.rb', line 1290

def reschedule_on!(date, journal=nil)
  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
      if journal
        init_journal(journal.user)
      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

Since:

  • 2.1.0



493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'app/models/issue.rb', line 493

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

Since:

  • 1.0.0



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
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
 
# File 'app/models/issue.rb', line 517

def safe_attributes=(attrs, user=User.current)
  if attrs.respond_to?(:to_unsafe_hash)
    attrs = attrs.to_unsafe_hash
  end

  @attributes_set_by = user
  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'].present? && 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 && tracker.nil?
    # Set a default tracker to accept custom field values
    # even if tracker is not specified
    allowed_trackers = allowed_target_trackers(user)

    if attrs['parent_issue_id'].present?
      # If parent_issue_id is present, the first tracker for which this field
      # is not disabled is chosen as default
      self.tracker = allowed_trackers.detect {|t| t.core_fields.include?('parent_issue_id')}
    end
    self.tracker ||= allowed_trackers.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

  assign_attributes attrs
end

#set_custom_field_default?(custom_value) ⇒ Boolean

Overrides Redmine::Acts::Customizable::InstanceMethods#set_custom_field_default?

Returns:

  • (Boolean)

Since:

  • 4.0.0



263
264
265
 
# File 'app/models/issue.rb', line 263

def set_custom_field_default?(custom_value)
  new_record? || project_id_changed?|| tracker_id_changed?
end

#set_parent_id ⇒ Object

Since:

  • 3.0.0



1407
1408
1409
 
# File 'app/models/issue.rb', line 1407

def set_parent_id
  self.parent_id = parent_issue_id
end

#soonest_start(reload = false) ⇒ Object

Since:

  • 0.5.1



1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
 
# File 'app/models/issue.rb', line 1266

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

Since:

  • 0.5.0



1059
1060
1061
 
# File 'app/models/issue.rb', line 1059

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

#status=(status) ⇒ Object

Sets the status.

Since:

  • 3.0.0



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

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

#status_id=(status_id) ⇒ Object

Since:

  • 1.0.0



302
303
304
305
306
307
 
# File 'app/models/issue.rb', line 302

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

Since:

  • 2.3.0



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

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

Since:

  • 0.7.0



1347
1348
1349
 
# File 'app/models/issue.rb', line 1347

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

#total_estimated_hours ⇒ Object

Since:

  • 3.1.0



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

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

Since:

  • 1.4.0



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

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

Since:

  • 3.0.0



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'app/models/issue.rb', line 344

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

Since:

  • 0.9.0



332
333
334
335
336
337
 
# File 'app/models/issue.rb', line 332

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

Since:

  • 3.2.0



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

def tracker_was
  Tracker.find_by_id(tracker_id_in_database)
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

Since:

  • 0.9.0



807
808
809
810
811
 
# File 'app/models/issue.rb', line 807

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)

Since:

  • 2.2.0



1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
 
# File 'app/models/issue.rb', line 1413

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).

Since:

  • 3.1.0



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

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

Since:

  • 1.3.0



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
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
 
# File 'app/models/issue.rb', line 710

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_permissions ⇒ Object

Since:

  • 3.3.4



786
787
788
789
790
791
792
 
# File 'app/models/issue.rb', line 786

def validate_permissions
  if @attributes_set_by && new_record? && copy?
    unless allowed_target_trackers(@attributes_set_by).include?(tracker)
      errors.add :tracker, :invalid
    end
  end
end

#validate_required_fields ⇒ Object

Validates the issue against additional workflow requirements

Since:

  • 2.1.0



766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
 
# File 'app/models/issue.rb', line 766

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)

Since:

  • 0.9.0



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

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

Since:

  • 2.4.0



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

#visible_journals_with_index(user = User.current) ⇒ Object

Returns the journals that are visible to user with their index Used to display the issue history

Since:

  • 3.4.0



856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
 
# File 'app/models/issue.rb', line 856

def visible_journals_with_index(user=User.current)
  result = journals.
    preload(:details).
    preload(:user => :email_address).
    reorder(:created_on, :id).to_a

  result.each_with_index {|j,i| j.indice = i+1}

  unless user.allowed_to?(:view_private_notes, project)
    result.select! do |journal|
      !journal.private_notes? || journal.user == user
    end
  end
  Journal.preload_journals_details_custom_fields(result)
  result.select! {|journal| journal.notes? || journal.visible_details.any?}
  result
end

#was_closed? ⇒ Boolean

Returns true if the issue was closed when loaded

Returns:

  • (Boolean)

Since:

  • 3.0.0



892
893
894
 
# File 'app/models/issue.rb', line 892

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

#working_duration ⇒ Object

Returns the duration in working days

Since:

  • 2.2.0



1262
1263
1264
 
# File 'app/models/issue.rb', line 1262

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)

Since:

  • 3.3.0



1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
 
# File 'app/models/issue.rb', line 1223

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