Class: Issue

Inherits:
ApplicationRecord 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 © 2006- Jean-Philippe Lang

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Constant Summary collapse

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

#abbr_day_name, #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, #normalize_float, #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?

Methods inherited from ApplicationRecord

human_attribute_name

Constructor Details

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

Returns a new instance of Issue.



227
228
229
230
231
232
233
234
 
# File 'app/models/issue.rb', line 227

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

#deleted_attachment_ids ⇒ Object 



462
463
464
 
# File 'app/models/issue.rb', line 462

def deleted_attachment_ids
  Array(@deleted_attachment_ids).map(&:to_i)
end

#transition_warning ⇒ Object (readonly)

Returns the value of attribute transition_warning.



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

def transition_warning
  @transition_warning
end

Class Method Details

.allowed_target_projects(user = User.current, current_project = nil, scope = 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



1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
 
# File 'app/models/issue.rb', line 1661

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

  if scope.nil?
    scope = Project
  end

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



1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
 
# File 'app/models/issue.rb', line 1680

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 



1599
1600
1601
 
# File 'app/models/issue.rb', line 1599

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 



1603
1604
1605
 
# File 'app/models/issue.rb', line 1603

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 



1595
1596
1597
 
# File 'app/models/issue.rb', line 1595

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 



1591
1592
1593
 
# File 'app/models/issue.rb', line 1591

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 



1607
1608
1609
1610
 
# File 'app/models/issue.rb', line 1607

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 



1583
1584
1585
 
# File 'app/models/issue.rb', line 1583

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 



1587
1588
1589
 
# File 'app/models/issue.rb', line 1587

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.



1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
 
# File 'app/models/issue.rb', line 1619

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



1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
 
# File 'app/models/issue.rb', line 1556

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



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

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



1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
 
# File 'app/models/issue.rb', line 1298

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



1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
 
# File 'app/models/issue.rb', line 1279

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



1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
 
# File 'app/models/issue.rb', line 1248

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



1225
1226
1227
1228
1229
1230
1231
1232
 
# File 'app/models/issue.rb', line 1225

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



1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
 
# File 'app/models/issue.rb', line 1235

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



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

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(conditions = nil) ⇒ Object

Update issues so their versions are not pointing to a fixed_version that is not shared with the issue’s project



1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
 
# File 'app/models/issue.rb', line 1904

def update_versions(conditions=nil)
  # Only need to update issues with a fixed_version from
  # a different project and that is not systemwide shared
  Issue.joins(:project, :fixed_version).
    where("#{Issue.table_name}.fixed_version_id IS NOT NULL" +
      " AND #{Issue.table_name}.project_id <> #{::Version.table_name}.project_id" +
      " AND #{::Version.table_name}.sharing <> 'system'").
    where(conditions).each do |issue|
    next if issue.project.nil? || issue.fixed_version.nil?

    unless issue.project.shared_versions.include?(issue.fixed_version)
      retried = false
      begin
        issue.init_journal(User.current)
        issue.fixed_version = nil
        issue.save
      rescue ActiveRecord::StaleObjectError
        raise if retried

        retried = true
        issue.reload
        retry
      end
    end
  end
end

.update_versions_from_hierarchy_change(project) ⇒ Object

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



1497
1498
1499
1500
1501
1502
1503
1504
1505
 
# File 'app/models/issue.rb', line 1497

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



1490
1491
1492
1493
 
# File 'app/models/issue.rb', line 1490

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) 


748
749
750
 
# File 'app/models/issue.rb', line 748

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

.use_status_for_done_ratio? ⇒ Boolean

Returns:

  • (Boolean) 


744
745
746
 
# File 'app/models/issue.rb', line 744

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



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'app/models/issue.rb', line 132

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 



1458
1459
1460
1461
1462
1463
1464
1465
1466
 
# File 'app/models/issue.rb', line 1458

def <=>(issue)
  return nil unless issue.is_a?(Issue)

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

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



1650
1651
1652
1653
1654
1655
1656
1657
 
# File 'app/models/issue.rb', line 1650

def allowed_target_projects(user=User.current, scope=nil)
  current_project = new_record? ? nil : project
  if scope
    scope = filter_projects_scope(scope)
  end

  self.class.allowed_target_projects(user, current_project, scope)
end

#allowed_target_projects_for_subtask(user = User.current) ⇒ Object

Returns a scope of projects that user can assign the subtask



1641
1642
1643
1644
1645
1646
1647
 
# File 'app/models/issue.rb', line 1641

def allowed_target_projects_for_subtask(user=User.current)
  if parent_issue_id.present?
    scope = filter_projects_scope(Setting.cross_project_subtasks)
  end

  self.class.allowed_target_projects(user, project, scope)
end

#allowed_target_trackers(user = User.current) ⇒ Object

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



1675
1676
1677
 
# File 'app/models/issue.rb', line 1675

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



467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'app/models/issue.rb', line 467

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



1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
 
# File 'app/models/issue.rb', line 1000

def assignable_users
  return [] if project.nil?

  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



1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
 
# File 'app/models/issue.rb', line 1012

def assignable_versions
  return @assignable_versions if @assignable_versions
  return [] if project.nil?

  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_addable?(user = User.current) ⇒ Boolean

Returns:

  • (Boolean) 


203
204
205
 
# File 'app/models/issue.rb', line 203

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

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

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

Returns:

  • (Boolean) 


223
224
225
 
# File 'app/models/issue.rb', line 223

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

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

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

Returns:

  • (Boolean) 


208
209
210
 
# File 'app/models/issue.rb', line 208

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

#attributes=(new_attributes) ⇒ Object 



481
482
483
 
# File 'app/models/issue.rb', line 481

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) 


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

def attributes_editable?(user=User.current)
  user_tracker_permission?(user, :edit_issues) || (
    user_tracker_permission?(user, :edit_own_issues) && author == user
  )
end

#available_custom_fields ⇒ Object

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



279
280
281
 
# File 'app/models/issue.rb', line 279

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

#base_reload ⇒ Object 



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

alias :base_reload :reload

#behind_schedule? ⇒ Boolean

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

Returns:

  • (Boolean) 


987
988
989
990
991
992
 
# File 'app/models/issue.rb', line 987

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) 


1032
1033
1034
 
# File 'app/models/issue.rb', line 1032

def blocked?
  relations_to.any? {|ir| ir.relation_type == 'blocks' && ir.issue_from&.closed? == false}
end

#blocks?(other) ⇒ Boolean

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

Returns:

  • (Boolean) 


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

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

    last = current
    all += last
  end
  false
end

#category_id=(cid) ⇒ Object 



358
359
360
361
 
# File 'app/models/issue.rb', line 358

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

#children? ⇒ Boolean

Does this issue have children?

Returns:

  • (Boolean) 


995
996
997
 
# File 'app/models/issue.rb', line 995

def children?
  !leaf?
end

#clear_journal ⇒ Object

Clears the current journal



877
878
879
 
# File 'app/models/issue.rb', line 877

def clear_journal
  @current_journal = nil
end

#closable? ⇒ Boolean

Returns true if this issue can be closed and if not, returns false and populates the reason

Returns:

  • (Boolean) 


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

def closable?
  if descendants.open.any?
    @transition_warning = l(:notice_issue_not_closable_by_open_tasks)
    return false
  end
  if blocked?
    @transition_warning = l(:notice_issue_not_closable_by_blocking_issue)
    return false
  end
  return true
end

#closed? ⇒ Boolean

Return true if the issue is closed, otherwise false

Returns:

  • (Boolean) 


953
954
955
 
# File 'app/models/issue.rb', line 953

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

#closing? ⇒ Boolean

Return true if the issue is being closed

Returns:

  • (Boolean) 


973
974
975
976
977
978
979
 
# File 'app/models/issue.rb', line 973

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



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

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) 


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

def copy?
  @copied_from.present?
end

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

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



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'app/models/issue.rb', line 296

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({}) do |h, v|
      h[v.custom_field_id] = v.value
      h
    end
  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.visible_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



1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
 
# File 'app/models/issue.rb', line 1473

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?
  s << ' behind-schedule' if behind_schedule?
  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

#current_journal ⇒ Object

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



872
873
874
 
# File 'app/models/issue.rb', line 872

def current_journal
  @current_journal
end

#dates_derived? ⇒ Boolean

Returns:

  • (Boolean) 


1446
1447
1448
 
# File 'app/models/issue.rb', line 1446

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



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

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) 


218
219
220
 
# File 'app/models/issue.rb', line 218

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

#description=(arg) ⇒ Object 



455
456
457
458
459
460
 
# File 'app/models/issue.rb', line 455

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.



250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'app/models/issue.rb', line 250

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 



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

def disabled_core_fields
  tracker ? tracker.disabled_core_fields : []
end

#done_ratio ⇒ Object 



736
737
738
739
740
741
742
 
# File 'app/models/issue.rb', line 736

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) 


1454
1455
1456
 
# File 'app/models/issue.rb', line 1454

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



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

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

#duplicates ⇒ Object

Returns an array of issues that duplicate this one



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

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



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

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) 


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

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



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

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



649
650
651
 
# File 'app/models/issue.rb', line 649

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

#estimated_hours=(h) ⇒ Object 



485
486
487
 
# File 'app/models/issue.rb', line 485

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

#estimated_remaining_hours ⇒ Object

Returns the number of estimated remaining hours on this issue



1181
1182
1183
 
# File 'app/models/issue.rb', line 1181

def estimated_remaining_hours
  (estimated_hours || 0) * (100 - (done_ratio || 0)) / 100
end

#find_relation(relation_id) ⇒ Object

Finds an issue relation given its id.



1318
1319
1320
 
# File 'app/models/issue.rb', line 1318

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 



363
364
365
366
 
# File 'app/models/issue.rb', line 363

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

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



867
868
869
 
# File 'app/models/issue.rb', line 867

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



882
883
884
885
886
887
888
 
# File 'app/models/issue.rb', line 882

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



900
901
902
903
904
905
906
 
# File 'app/models/issue.rb', line 900

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



891
892
893
894
895
896
897
 
# File 'app/models/issue.rb', line 891

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

#last_notes ⇒ Object 



1200
1201
1202
1203
1204
1205
1206
 
# File 'app/models/issue.rb', line 1200

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

#last_updated_by ⇒ Object 



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

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



1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'app/models/issue.rb', line 1065

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,
    roles_for_workflow(user),
    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
  unless closable?
    # cannot close a blocked issue or a parent with open subtasks
    statuses.reject!(&:is_closed?)
  end
  unless reopenable?
    # 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) 


213
214
215
 
# File 'app/models/issue.rb', line 213

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

#notified_users ⇒ Object

Returns the users that should be notified



1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
 
# File 'app/models/issue.rb', line 1128

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 += project.users.preload(:preference).select(&:notify_about_high_priority_issues?) if priority.high?
  notified.uniq!
  # Remove users that can not view the issue
  notified.reject! {|user| !visible?(user)}
  notified
end

#notify=(arg) ⇒ Object 



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

def notify=(arg)
  @notify = arg
end

#notify? ⇒ Boolean

Returns:

  • (Boolean) 


1149
1150
1151
 
# File 'app/models/issue.rb', line 1149

def notify?
  @notify != false
end

#overdue? ⇒ Boolean

Returns true if the issue is overdue

Returns:

  • (Boolean) 


982
983
984
 
# File 'app/models/issue.rb', line 982

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

#parent_issue_id ⇒ Object 



1520
1521
1522
1523
1524
1525
1526
1527
1528
 
# File 'app/models/issue.rb', line 1520

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 



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

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



1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
 
# File 'app/models/issue.rb', line 1115

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

#prior_assigned_to ⇒ Object

Returns the assignee immediately prior to the current one from the issue history



929
930
931
932
933
934
935
936
937
938
 
# File 'app/models/issue.rb', line 929

def prior_assigned_to
  prior_assigned_to_id =
    journals.joins(:details)
            .where(details: {prop_key: 'assigned_to_id'})
            .where.not(details: {old_value: nil})
            .order(id: :desc)
            .pick(:old_value)

  prior_assigned_to_id && Principal.find_by(id: prior_assigned_to_id)
end

#priority_derived? ⇒ Boolean

Returns:

  • (Boolean) 


1450
1451
1452
 
# File 'app/models/issue.rb', line 1450

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

#priority_id=(pid) ⇒ Object 



353
354
355
356
 
# File 'app/models/issue.rb', line 353

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.



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'app/models/issue.rb', line 414

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 



396
397
398
399
400
401
 
# File 'app/models/issue.rb', line 396

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



661
662
663
 
# File 'app/models/issue.rb', line 661

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



1145
1146
1147
 
# File 'app/models/issue.rb', line 1145

def recipients
  notified_users.collect(&:mail)
end

#relations ⇒ Object 



1185
1186
1187
1188
1189
1190
 
# File 'app/models/issue.rb', line 1185

def relations
  @relations ||= IssueRelation::Relations.new(
    self,
    IssueRelation.where('issue_from_id = ? OR issue_to_id = ?', id, id).sort
  )
end

#reload(*args) ⇒ Object 



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

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

#reopenable? ⇒ Boolean

Returns true if this issue can be reopen and if not, returns false and populates the reason

Returns:

  • (Boolean) 


1050
1051
1052
1053
1054
1055
1056
 
# File 'app/models/issue.rb', line 1050

def reopenable?
  if ancestors.open(false).any?
    @transition_warning = l(:notice_issue_not_reopenable_by_closed_parent_issue)
    return false
  end
  return true
end

#reopening? ⇒ Boolean Also known as: reopened?

Return true if the issue is being reopened

Returns:

  • (Boolean) 


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

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) 


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

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



673
674
675
 
# File 'app/models/issue.rb', line 673

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.



1401
1402
1403
1404
1405
1406
 
# File 'app/models/issue.rb', line 1401

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.



1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
 
# File 'app/models/issue.rb', line 1410

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 



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
 
# File 'app/models/issue.rb', line 532

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



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
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
 
# File 'app/models/issue.rb', line 556

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) && !/^\d*$/.match?(p)
      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) 


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

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

#set_parent_id ⇒ Object 



1532
1533
1534
 
# File 'app/models/issue.rb', line 1532

def set_parent_id
  self.parent_id = parent_issue_id
end

#soonest_start(reload = false) ⇒ Object 



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

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



1158
1159
1160
 
# File 'app/models/issue.rb', line 1158

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

#status=(status) ⇒ Object

Sets the status.



346
347
348
349
350
351
 
# File 'app/models/issue.rb', line 346

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

#status_id=(status_id) ⇒ Object 



338
339
340
341
342
343
 
# File 'app/models/issue.rb', line 338

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



942
943
944
945
946
947
948
949
950
 
# File 'app/models/issue.rb', line 942

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 



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

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

#total_estimated_hours ⇒ Object 



1172
1173
1174
1175
1176
1177
1178
 
# File 'app/models/issue.rb', line 1172

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

#total_spent_hours ⇒ Object

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



1163
1164
1165
1166
1167
1168
1169
1170
 
# File 'app/models/issue.rb', line 1163

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



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'app/models/issue.rb', line 380

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 



368
369
370
371
372
373
 
# File 'app/models/issue.rb', line 368

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



1109
1110
1111
 
# File 'app/models/issue.rb', line 1109

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



861
862
863
864
865
 
# File 'app/models/issue.rb', line 861

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) 


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

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



852
853
854
855
856
857
 
# File 'app/models/issue.rb', line 852

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 



752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'app/models/issue.rb', line 752

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 project && fixed_version_id
    if fixed_version.nil? || assignable_versions.exclude?(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

  if project && category_id
    unless project.issue_category_ids.include?(category_id)
      errors.add :category_id, :inclusion
    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 project && 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? do |a|
          a.relations_from.any? do |r|
            r.relation_type == IssueRelation::TYPE_PRECEDES &&
               r.issue_to.would_reschedule?(self)
          end
        end
      )
      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 



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

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



819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
 
# File 'app/models/issue.rb', line 819

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

  required_attribute_names(user).each do |attribute|
    if /^\d+$/.match?(attribute)
      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(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) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'app/models/issue.rb', line 167

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 



283
284
285
286
287
288
 
# File 'app/models/issue.rb', line 283

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



910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
 
# File 'app/models/issue.rb', line 910

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) 


958
959
960
 
# File 'app/models/issue.rb', line 958

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

#working_duration ⇒ Object

Returns the duration in working days



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

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) 


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

def would_reschedule?(other)
  all = [self]
  last = [self]
  while last.any?
    current = last.map do |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)}
    end.flatten.uniq
    current -= last
    current -= all
    return true if current.include?(other)

    last = current
    all += last
  end
  false
end