jro_apps/redmine Commit - r3176:46bf2b9276dd

1

# redMine - project management software

1

# redMine - project management software

2

3

#

3

#

4

# This program is free software; you can redistribute it and/or

4

# This program is free software; you can redistribute it and/or

5

# modify it under the terms of the GNU General Public License

5

# modify it under the terms of the GNU General Public License

6

# as published by the Free Software Foundation; either version 2

6

# as published by the Free Software Foundation; either version 2

7

# of the License, or (at your option) any later version.

7

# of the License, or (at your option) any later version.

8

#

8

#

9

# This program is distributed in the hope that it will be useful,

9

# This program is distributed in the hope that it will be useful,

10

# but WITHOUT ANY WARRANTY; without even the implied warranty of

10

# but WITHOUT ANY WARRANTY; without even the implied warranty of

11

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

11

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

12

# GNU General Public License for more details.

12

# GNU General Public License for more details.

13

#

13

#

14

# You should have received a copy of the GNU General Public License

14

# You should have received a copy of the GNU General Public License

15

# along with this program; if not, write to the Free Software

15

# along with this program; if not, write to the Free Software

16

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

16

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

17

18

class Issue < ActiveRecord::Base

18

class Issue < ActiveRecord::Base

19

belongs_to :project

19

belongs_to :project

20

belongs_to :tracker

20

belongs_to :tracker

21

belongs_to :status, :class_name => 'IssueStatus', :foreign_key => 'status_id'

21

belongs_to :status, :class_name => 'IssueStatus', :foreign_key => 'status_id'

22

belongs_to :author, :class_name => 'User', :foreign_key => 'author_id'

22

belongs_to :author, :class_name => 'User', :foreign_key => 'author_id'

23

belongs_to :assigned_to, :class_name => 'User', :foreign_key => 'assigned_to_id'

23

belongs_to :assigned_to, :class_name => 'User', :foreign_key => 'assigned_to_id'

24

belongs_to :fixed_version, :class_name => 'Version', :foreign_key => 'fixed_version_id'

24

belongs_to :fixed_version, :class_name => 'Version', :foreign_key => 'fixed_version_id'

25

belongs_to :priority, :class_name => 'IssuePriority', :foreign_key => 'priority_id'

25

belongs_to :priority, :class_name => 'IssuePriority', :foreign_key => 'priority_id'

26

belongs_to :category, :class_name => 'IssueCategory', :foreign_key => 'category_id'

26

belongs_to :category, :class_name => 'IssueCategory', :foreign_key => 'category_id'

27

28

has_many :journals, :as => :journalized, :dependent => :destroy

28

has_many :journals, :as => :journalized, :dependent => :destroy

29

has_many :time_entries, :dependent => :delete_all

29

has_many :time_entries, :dependent => :delete_all

30

has_and_belongs_to_many :changesets, :order => "#{Changeset.table_name}.committed_on ASC, #{Changeset.table_name}.id ASC"

30

has_and_belongs_to_many :changesets, :order => "#{Changeset.table_name}.committed_on ASC, #{Changeset.table_name}.id ASC"

31

32

has_many :relations_from, :class_name => 'IssueRelation', :foreign_key => 'issue_from_id', :dependent => :delete_all

32

has_many :relations_from, :class_name => 'IssueRelation', :foreign_key => 'issue_from_id', :dependent => :delete_all

33

has_many :relations_to, :class_name => 'IssueRelation', :foreign_key => 'issue_to_id', :dependent => :delete_all

33

has_many :relations_to, :class_name => 'IssueRelation', :foreign_key => 'issue_to_id', :dependent => :delete_all

34

35

acts_as_attachable :after_remove => :attachment_removed

35

acts_as_attachable :after_remove => :attachment_removed

36

acts_as_customizable

36

acts_as_customizable

37

acts_as_watchable

37

acts_as_watchable

38

acts_as_searchable :columns => ['subject', "#{table_name}.description", "#{Journal.table_name}.notes"],

38

acts_as_searchable :columns => ['subject', "#{table_name}.description", "#{Journal.table_name}.notes"],

39

:include => [:project, :journals],

39

:include => [:project, :journals],

40

# sort by id so that limited eager loading doesn't break with postgresql

40

# sort by id so that limited eager loading doesn't break with postgresql

41

:order_column => "#{table_name}.id"

41

:order_column => "#{table_name}.id"

42

acts_as_event :title => Proc.new {|o| "#{o.tracker.name} ##{o.id} (#{o.status}): #{o.subject}"},

42

acts_as_event :title => Proc.new {|o| "#{o.tracker.name} ##{o.id} (#{o.status}): #{o.subject}"},

43

:url => Proc.new {|o| {:controller => 'issues', :action => 'show', :id => o.id}},

43

:url => Proc.new {|o| {:controller => 'issues', :action => 'show', :id => o.id}},

44

:type => Proc.new {|o| 'issue' + (o.closed? ? ' closed' : '') }

44

:type => Proc.new {|o| 'issue' + (o.closed? ? ' closed' : '') }

45

46

acts_as_activity_provider :find_options => {:include => [:project, :author, :tracker]},

46

acts_as_activity_provider :find_options => {:include => [:project, :author, :tracker]},

47

:author_key => :author_id

47

:author_key => :author_id

48

49

DONE_RATIO_OPTIONS = %w(issue_field issue_status)

49

DONE_RATIO_OPTIONS = %w(issue_field issue_status)

50

51

validates_presence_of :subject, :priority, :project, :tracker, :author, :status

51

validates_presence_of :subject, :priority, :project, :tracker, :author, :status

52

validates_length_of :subject, :maximum => 255

52

validates_length_of :subject, :maximum => 255

53

validates_inclusion_of :done_ratio, :in => 0..100

53

validates_inclusion_of :done_ratio, :in => 0..100

54

validates_numericality_of :estimated_hours, :allow_nil => true

54

validates_numericality_of :estimated_hours, :allow_nil => true

55

56

named_scope :visible, lambda {|*args| { :include => :project,

56

named_scope :visible, lambda {|*args| { :include => :project,

57

:conditions => Project.allowed_to_condition(args.first || User.current, :view_issues) } }

57

:conditions => Project.allowed_to_condition(args.first || User.current, :view_issues) } }

58

59

named_scope :open, :conditions => ["#{IssueStatus.table_name}.is_closed = ?", false], :include => :status

59

named_scope :open, :conditions => ["#{IssueStatus.table_name}.is_closed = ?", false], :include => :status

60

61

before_save :update_done_ratio_from_issue_status

61

before_save :update_done_ratio_from_issue_status

62

after_save :create_journal

62

after_save :create_journal

63

64

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

64

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

65

def visible?(usr=nil)

65

def visible?(usr=nil)

66

(usr || User.current).allowed_to?(:view_issues, self.project)

66

(usr || User.current).allowed_to?(:view_issues, self.project)

67

end

67

end

68

69

def after_initialize

69

def after_initialize

70

if new_record?

70

if new_record?

71

# set default values for new records only

71

# set default values for new records only

72

self.status ||= IssueStatus.default

72

self.status ||= IssueStatus.default

73

self.priority ||= IssuePriority.default

73

self.priority ||= IssuePriority.default

74

end

74

end

75

end

75

end

76

77

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

77

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

78

def available_custom_fields

78

def available_custom_fields

79

(project && tracker) ? project.all_issue_custom_fields.select {|c| tracker.custom_fields.include? c } : []

79

(project && tracker) ? project.all_issue_custom_fields.select {|c| tracker.custom_fields.include? c } : []

80

end

80

end

81

82

def copy_from(arg)

82

def copy_from(arg)

83

issue = arg.is_a?(Issue) ? arg : Issue.find(arg)

83

issue = arg.is_a?(Issue) ? arg : Issue.find(arg)

84

self.attributes = issue.attributes.dup.except("id", "created_on", "updated_on")

84

self.attributes = issue.attributes.dup.except("id", "created_on", "updated_on")

85

self.custom_values = issue.custom_values.collect {|v| v.clone}

85

self.custom_values = issue.custom_values.collect {|v| v.clone}

86

self.status = issue.status

86

self.status = issue.status

87

self

87

self

88

end

88

end

89

90

# Moves/copies an issue to a new project and tracker

90

# Moves/copies an issue to a new project and tracker

91

# Returns the moved/copied issue on success, false on failure

91

# Returns the moved/copied issue on success, false on failure

92

def move_to(new_project, new_tracker = nil, options = {})

92

def move_to(new_project, new_tracker = nil, options = {})

93

options ||= {}

93

options ||= {}

94

issue = options[:copy] ? self.clone : self

94

issue = options[:copy] ? self.clone : self

95

transaction do

95

transaction do

96

if new_project && issue.project_id != new_project.id

96

if new_project && issue.project_id != new_project.id

97

# delete issue relations

97

# delete issue relations

98

unless Setting.cross_project_issue_relations?

98

unless Setting.cross_project_issue_relations?

99

issue.relations_from.clear

99

issue.relations_from.clear

100

issue.relations_to.clear

100

issue.relations_to.clear

101

end

101

end

102

# issue is moved to another project

102

# issue is moved to another project

103

# reassign to the category with same name if any

103

# reassign to the category with same name if any

104

new_category = issue.category.nil? ? nil : new_project.issue_categories.find_by_name(issue.category.name)

104

new_category = issue.category.nil? ? nil : new_project.issue_categories.find_by_name(issue.category.name)

105

issue.category = new_category

105

issue.category = new_category

106

# Keep the fixed_version if it's still valid in the new_project

106

# Keep the fixed_version if it's still valid in the new_project

107

unless new_project.shared_versions.include?(issue.fixed_version)

107

unless new_project.shared_versions.include?(issue.fixed_version)

108

issue.fixed_version = nil

108

issue.fixed_version = nil

109

end

109

end

110

issue.project = new_project

110

issue.project = new_project

111

end

111

end

112

if new_tracker

112

if new_tracker

113

issue.tracker = new_tracker

113

issue.tracker = new_tracker

114

end

114

end

115

if options[:copy]

115

if options[:copy]

116

issue.custom_field_values = self.custom_field_values.inject({}) {|h,v| h[v.custom_field_id] = v.value; h}

116

issue.custom_field_values = self.custom_field_values.inject({}) {|h,v| h[v.custom_field_id] = v.value; h}

117

issue.status = if options[:attributes] && options[:attributes][:status_id]

117

issue.status = if options[:attributes] && options[:attributes][:status_id]

118

IssueStatus.find_by_id(options[:attributes][:status_id])

118

IssueStatus.find_by_id(options[:attributes][:status_id])

119

else

119

else

120

self.status

120

self.status

121

end

121

end

122

end

122

end

123

# Allow bulk setting of attributes on the issue

123

# Allow bulk setting of attributes on the issue

124

if options[:attributes]

124

if options[:attributes]

125

issue.attributes = options[:attributes]

125

issue.attributes = options[:attributes]

126

end

126

end

127

if issue.save

127

if issue.save

128

unless options[:copy]

128

unless options[:copy]

129

# Manually update project_id on related time entries

129

# Manually update project_id on related time entries

130

TimeEntry.update_all("project_id = #{new_project.id}", {:issue_id => id})

130

TimeEntry.update_all("project_id = #{new_project.id}", {:issue_id => id})

131

end

131

end

132

else

132

else

133

Issue.connection.rollback_db_transaction

133

Issue.connection.rollback_db_transaction

134

return false

134

return false

135

end

135

end

136

end

136

end

137

return issue

137

return issue

138

end

138

end

139

140

def priority_id=(pid)

140

def priority_id=(pid)

141

self.priority = nil

141

self.priority = nil

142

write_attribute(:priority_id, pid)

142

write_attribute(:priority_id, pid)

143

end

143

end

144

145

def tracker_id=(tid)

145

def tracker_id=(tid)

146

self.tracker = nil

146

self.tracker = nil

147

write_attribute(:tracker_id, tid)

147

write_attribute(:tracker_id, tid)

148

result = write_attribute(:tracker_id, tid)

148

result = write_attribute(:tracker_id, tid)

149

@custom_field_values = nil

149

@custom_field_values = nil

150

result

150

result

151

end

151

end

152

153

# Overrides attributes= so that tracker_id gets assigned first

153

# Overrides attributes= so that tracker_id gets assigned first

154

def attributes_with_tracker_first=(new_attributes, *args)

154

def attributes_with_tracker_first=(new_attributes, *args)

155

return if new_attributes.nil?

155

return if new_attributes.nil?

156

new_tracker_id = new_attributes['tracker_id'] || new_attributes[:tracker_id]

156

new_tracker_id = new_attributes['tracker_id'] || new_attributes[:tracker_id]

157

if new_tracker_id

157

if new_tracker_id

158

self.tracker_id = new_tracker_id

158

self.tracker_id = new_tracker_id

159

end

159

end

160

self.~~attributes_without_tracker_first~~ = new_attributes, *args

160

send :attributes_without_tracker_first=, new_attributes, *args

161

end

161

end

162

alias_method_chain :attributes=, :tracker_first

162

alias_method_chain :attributes=, :tracker_first

163

164

def estimated_hours=(h)

164

def estimated_hours=(h)

165

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

165

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

166

end

166

end

167

168

def done_ratio

168

def done_ratio

169

if Issue.use_status_for_done_ratio? && status && status.default_done_ratio?

169

if Issue.use_status_for_done_ratio? && status && status.default_done_ratio?

170

status.default_done_ratio

170

status.default_done_ratio

171

else

171

else

172

read_attribute(:done_ratio)

172

read_attribute(:done_ratio)

173

end

173

end

174

end

174

end

175

176

def self.use_status_for_done_ratio?

176

def self.use_status_for_done_ratio?

177

Setting.issue_done_ratio == 'issue_status'

177

Setting.issue_done_ratio == 'issue_status'

178

end

178

end

179

180

def self.use_field_for_done_ratio?

180

def self.use_field_for_done_ratio?

181

Setting.issue_done_ratio == 'issue_field'

181

Setting.issue_done_ratio == 'issue_field'

182

end

182

end

183

184

def validate

184

def validate

185

if self.due_date.nil? && @attributes['due_date'] && !@attributes['due_date'].empty?

185

if self.due_date.nil? && @attributes['due_date'] && !@attributes['due_date'].empty?

186

errors.add :due_date, :not_a_date

186

errors.add :due_date, :not_a_date

187

end

187

end

188

189

if self.due_date and self.start_date and self.due_date < self.start_date

189

if self.due_date and self.start_date and self.due_date < self.start_date

190

errors.add :due_date, :greater_than_start_date

190

errors.add :due_date, :greater_than_start_date

191

end

191

end

192

193

if start_date && soonest_start && start_date < soonest_start

193

if start_date && soonest_start && start_date < soonest_start

194

errors.add :start_date, :invalid

194

errors.add :start_date, :invalid

195

end

195

end

196

197

if fixed_version

197

if fixed_version

198

if !assignable_versions.include?(fixed_version)

198

if !assignable_versions.include?(fixed_version)

199

errors.add :fixed_version_id, :inclusion

199

errors.add :fixed_version_id, :inclusion

200

elsif reopened? && fixed_version.closed?

200

elsif reopened? && fixed_version.closed?

201

errors.add_to_base I18n.t(:error_can_not_reopen_issue_on_closed_version)

201

errors.add_to_base I18n.t(:error_can_not_reopen_issue_on_closed_version)

202

end

202

end

203

end

203

end

204

205

# Checks that the issue can not be added/moved to a disabled tracker

205

# Checks that the issue can not be added/moved to a disabled tracker

206

if project && (tracker_id_changed? || project_id_changed?)

206

if project && (tracker_id_changed? || project_id_changed?)

207

unless project.trackers.include?(tracker)

207

unless project.trackers.include?(tracker)

208

errors.add :tracker_id, :inclusion

208

errors.add :tracker_id, :inclusion

209

end

209

end

210

end

210

end

211

end

211

end

212

213

def before_create

213

def before_create

214

# default assignment based on category

214

# default assignment based on category

215

if assigned_to.nil? && category && category.assigned_to

215

if assigned_to.nil? && category && category.assigned_to

216

self.assigned_to = category.assigned_to

216

self.assigned_to = category.assigned_to

217

end

217

end

218

end

218

end

219

220

# Set the done_ratio using the status if that setting is set. This will keep the done_ratios

220

# Set the done_ratio using the status if that setting is set. This will keep the done_ratios

221

# even if the user turns off the setting later

221

# even if the user turns off the setting later

222

def update_done_ratio_from_issue_status

222

def update_done_ratio_from_issue_status

223

if Issue.use_status_for_done_ratio? && status && status.default_done_ratio?

223

if Issue.use_status_for_done_ratio? && status && status.default_done_ratio?

224

self.done_ratio = status.default_done_ratio

224

self.done_ratio = status.default_done_ratio

225

end

225

end

226

end

226

end

227

228

def after_save

228

def after_save

229

# Reload is needed in order to get the right status

229

# Reload is needed in order to get the right status

230

reload

230

reload

231

232

# Update start/due dates of following issues

232

# Update start/due dates of following issues

233

relations_from.each(&:set_issue_to_dates)

233

relations_from.each(&:set_issue_to_dates)

234

235

# Close duplicates if the issue was closed

235

# Close duplicates if the issue was closed

236

if @issue_before_change && !@issue_before_change.closed? && self.closed?

236

if @issue_before_change && !@issue_before_change.closed? && self.closed?

237

duplicates.each do |duplicate|

237

duplicates.each do |duplicate|

238

# Reload is need in case the duplicate was updated by a previous duplicate

238

# Reload is need in case the duplicate was updated by a previous duplicate

239

duplicate.reload

239

duplicate.reload

240

# Don't re-close it if it's already closed

240

# Don't re-close it if it's already closed

241

next if duplicate.closed?

241

next if duplicate.closed?

242

# Same user and notes

242

# Same user and notes

243

duplicate.init_journal(@current_journal.user, @current_journal.notes)

243

duplicate.init_journal(@current_journal.user, @current_journal.notes)

244

duplicate.update_attribute :status, self.status

244

duplicate.update_attribute :status, self.status

245

end

245

end

246

end

246

end

247

end

247

end

248

249

def init_journal(user, notes = "")

249

def init_journal(user, notes = "")

250

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

250

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

251

@issue_before_change = self.clone

251

@issue_before_change = self.clone

252

@issue_before_change.status = self.status

252

@issue_before_change.status = self.status

253

@custom_values_before_change = {}

253

@custom_values_before_change = {}

254

self.custom_values.each {|c| @custom_values_before_change.store c.custom_field_id, c.value }

254

self.custom_values.each {|c| @custom_values_before_change.store c.custom_field_id, c.value }

255

# Make sure updated_on is updated when adding a note.

255

# Make sure updated_on is updated when adding a note.

256

updated_on_will_change!

256

updated_on_will_change!

257

@current_journal

257

@current_journal

258

end

258

end

259

260

# Return true if the issue is closed, otherwise false

260

# Return true if the issue is closed, otherwise false

261

def closed?

261

def closed?

262

self.status.is_closed?

262

self.status.is_closed?

263

end

263

end

264

265

# Return true if the issue is being reopened

265

# Return true if the issue is being reopened

266

def reopened?

266

def reopened?

267

if !new_record? && status_id_changed?

267

if !new_record? && status_id_changed?

268

status_was = IssueStatus.find_by_id(status_id_was)

268

status_was = IssueStatus.find_by_id(status_id_was)

269

status_new = IssueStatus.find_by_id(status_id)

269

status_new = IssueStatus.find_by_id(status_id)

270

if status_was && status_new && status_was.is_closed? && !status_new.is_closed?

270

if status_was && status_new && status_was.is_closed? && !status_new.is_closed?

271

return true

271

return true

272

end

272

end

273

end

273

end

274

false

274

false

275

end

275

end

276

277

# Returns true if the issue is overdue

277

# Returns true if the issue is overdue

278

def overdue?

278

def overdue?

279

!due_date.nil? && (due_date < Date.today) && !status.is_closed?

279

!due_date.nil? && (due_date < Date.today) && !status.is_closed?

280

end

280

end

281

282

# Users the issue can be assigned to

282

# Users the issue can be assigned to

283

def assignable_users

283

def assignable_users

284

project.assignable_users

284

project.assignable_users

285

end

285

end

286

287

# Versions that the issue can be assigned to

287

# Versions that the issue can be assigned to

288

def assignable_versions

288

def assignable_versions

289

@assignable_versions ||= (project.shared_versions.open + [Version.find_by_id(fixed_version_id_was)]).compact.uniq.sort

289

@assignable_versions ||= (project.shared_versions.open + [Version.find_by_id(fixed_version_id_was)]).compact.uniq.sort

290

end

290

end

291

292

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

292

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

293

def blocked?

293

def blocked?

294

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

294

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

295

end

295

end

296

297

# Returns an array of status that user is able to apply

297

# Returns an array of status that user is able to apply

298

def new_statuses_allowed_to(user)

298

def new_statuses_allowed_to(user)

299

statuses = status.find_new_statuses_allowed_to(user.roles_for_project(project), tracker)

299

statuses = status.find_new_statuses_allowed_to(user.roles_for_project(project), tracker)

300

statuses << status unless statuses.empty?

300

statuses << status unless statuses.empty?

301

statuses = statuses.uniq.sort

301

statuses = statuses.uniq.sort

302

blocked? ? statuses.reject {|s| s.is_closed?} : statuses

302

blocked? ? statuses.reject {|s| s.is_closed?} : statuses

303

end

303

end

304

305

# Returns the mail adresses of users that should be notified

305

# Returns the mail adresses of users that should be notified

306

def recipients

306

def recipients

307

notified = project.notified_users

307

notified = project.notified_users

308

# Author and assignee are always notified unless they have been locked

308

# Author and assignee are always notified unless they have been locked

309

notified << author if author && author.active?

309

notified << author if author && author.active?

310

notified << assigned_to if assigned_to && assigned_to.active?

310

notified << assigned_to if assigned_to && assigned_to.active?

311

notified.uniq!

311

notified.uniq!

312

# Remove users that can not view the issue

312

# Remove users that can not view the issue

313

notified.reject! {|user| !visible?(user)}

313

notified.reject! {|user| !visible?(user)}

314

notified.collect(&:mail)

314

notified.collect(&:mail)

315

end

315

end

316

317

# Returns the total number of hours spent on this issue.

317

# Returns the total number of hours spent on this issue.

318

#

318

#

319

# Example:

319

# Example:

320

# spent_hours => 0

320

# spent_hours => 0

321

# spent_hours => 50

321

# spent_hours => 50

322

def spent_hours

322

def spent_hours

323

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

323

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

324

end

324

end

325

326

def relations

326

def relations

327

(relations_from + relations_to).sort

327

(relations_from + relations_to).sort

328

end

328

end

329

330

def all_dependent_issues

330

def all_dependent_issues

331

dependencies = []

331

dependencies = []

332

relations_from.each do |relation|

332

relations_from.each do |relation|

333

dependencies << relation.issue_to

333

dependencies << relation.issue_to

334

dependencies += relation.issue_to.all_dependent_issues

334

dependencies += relation.issue_to.all_dependent_issues

335

end

335

end

336

dependencies

336

dependencies

337

end

337

end

338

339

# Returns an array of issues that duplicate this one

339

# Returns an array of issues that duplicate this one

340

def duplicates

340

def duplicates

341

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

341

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

342

end

342

end

343

344

# Returns the due date or the target due date if any

344

# Returns the due date or the target due date if any

345

# Used on gantt chart

345

# Used on gantt chart

346

def due_before

346

def due_before

347

due_date || (fixed_version ? fixed_version.effective_date : nil)

347

due_date || (fixed_version ? fixed_version.effective_date : nil)

348

end

348

end

349

350

# Returns the time scheduled for this issue.

350

# Returns the time scheduled for this issue.

351

#

351

#

352

# Example:

352

# Example:

353

# Start Date: 2/26/09, End Date: 3/04/09

353

# Start Date: 2/26/09, End Date: 3/04/09

354

# duration => 6

354

# duration => 6

355

def duration

355

def duration

356

(start_date && due_date) ? due_date - start_date : 0

356

(start_date && due_date) ? due_date - start_date : 0

357

end

357

end

358

359

def soonest_start

359

def soonest_start

360

@soonest_start ||= relations_to.collect{|relation| relation.successor_soonest_start}.compact.min

360

@soonest_start ||= relations_to.collect{|relation| relation.successor_soonest_start}.compact.min

361

end

361

end

362

363

def to_s

363

def to_s

364

"#{tracker} ##{id}: #{subject}"

364

"#{tracker} ##{id}: #{subject}"

365

end

365

end

366

367

# Returns a string of css classes that apply to the issue

367

# Returns a string of css classes that apply to the issue

368

def css_classes

368

def css_classes

369

s = "issue status-#{status.position} priority-#{priority.position}"

369

s = "issue status-#{status.position} priority-#{priority.position}"

370

s << ' closed' if closed?

370

s << ' closed' if closed?

371

s << ' overdue' if overdue?

371

s << ' overdue' if overdue?

372

s << ' created-by-me' if User.current.logged? && author_id == User.current.id

372

s << ' created-by-me' if User.current.logged? && author_id == User.current.id

373

s << ' assigned-to-me' if User.current.logged? && assigned_to_id == User.current.id

373

s << ' assigned-to-me' if User.current.logged? && assigned_to_id == User.current.id

374

s

374

s

375

end

375

end

376

377

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

377

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

378

def self.update_versions_from_sharing_change(version)

378

def self.update_versions_from_sharing_change(version)

379

# Update issues assigned to the version

379

# Update issues assigned to the version

380

update_versions(["#{Issue.table_name}.fixed_version_id = ?", version.id])

380

update_versions(["#{Issue.table_name}.fixed_version_id = ?", version.id])

381

end

381

end

382

383

# Unassigns issues from versions that are no longer shared

383

# Unassigns issues from versions that are no longer shared

384

# after +project+ was moved

384

# after +project+ was moved

385

def self.update_versions_from_hierarchy_change(project)

385

def self.update_versions_from_hierarchy_change(project)

386

moved_project_ids = project.self_and_descendants.reload.collect(&:id)

386

moved_project_ids = project.self_and_descendants.reload.collect(&:id)

387

# Update issues of the moved projects and issues assigned to a version of a moved project

387

# Update issues of the moved projects and issues assigned to a version of a moved project

388

Issue.update_versions(["#{Version.table_name}.project_id IN (?) OR #{Issue.table_name}.project_id IN (?)", moved_project_ids, moved_project_ids])

388

Issue.update_versions(["#{Version.table_name}.project_id IN (?) OR #{Issue.table_name}.project_id IN (?)", moved_project_ids, moved_project_ids])

389

end

389

end

390

391

private

391

private

392

393

# Update issues so their versions are not pointing to a

393

# Update issues so their versions are not pointing to a

394

# fixed_version that is not shared with the issue's project

394

# fixed_version that is not shared with the issue's project

395

def self.update_versions(conditions=nil)

395

def self.update_versions(conditions=nil)

396

# Only need to update issues with a fixed_version from

396

# Only need to update issues with a fixed_version from

397

# a different project and that is not systemwide shared

397

# a different project and that is not systemwide shared

398

Issue.all(:conditions => merge_conditions("#{Issue.table_name}.fixed_version_id IS NOT NULL" +

398

Issue.all(:conditions => merge_conditions("#{Issue.table_name}.fixed_version_id IS NOT NULL" +

399

" AND #{Issue.table_name}.project_id <> #{Version.table_name}.project_id" +

399

" AND #{Issue.table_name}.project_id <> #{Version.table_name}.project_id" +

400

" AND #{Version.table_name}.sharing <> 'system'",

400

" AND #{Version.table_name}.sharing <> 'system'",

401

conditions),

401

conditions),

402

:include => [:project, :fixed_version]

402

:include => [:project, :fixed_version]

403

).each do |issue|

403

).each do |issue|

404

next if issue.project.nil? || issue.fixed_version.nil?

404

next if issue.project.nil? || issue.fixed_version.nil?

405

unless issue.project.shared_versions.include?(issue.fixed_version)

405

unless issue.project.shared_versions.include?(issue.fixed_version)

406

issue.init_journal(User.current)

406

issue.init_journal(User.current)

407

issue.fixed_version = nil

407

issue.fixed_version = nil

408

issue.save

408

issue.save

409

end

409

end

410

end

410

end

411

end

411

end

412

413

# Callback on attachment deletion

413

# Callback on attachment deletion

414

def attachment_removed(obj)

414

def attachment_removed(obj)

415

journal = init_journal(User.current)

415

journal = init_journal(User.current)

416

journal.details << JournalDetail.new(:property => 'attachment',

416

journal.details << JournalDetail.new(:property => 'attachment',

417

:prop_key => obj.id,

417

:prop_key => obj.id,

418

:old_value => obj.filename)

418

:old_value => obj.filename)

419

journal.save

419

journal.save

420

end

420

end

421

422

# Saves the changes in a Journal

422

# Saves the changes in a Journal

423

# Called after_save

423

# Called after_save

424

def create_journal

424

def create_journal

425

if @current_journal

425

if @current_journal

426

# attributes changes

426

# attributes changes

427

(Issue.column_names - %w(id description lock_version created_on updated_on)).each {|c|

427

(Issue.column_names - %w(id description lock_version created_on updated_on)).each {|c|

428

@current_journal.details << JournalDetail.new(:property => 'attr',

428

@current_journal.details << JournalDetail.new(:property => 'attr',

429

:prop_key => c,

429

:prop_key => c,

430

:old_value => @issue_before_change.send(c),

430

:old_value => @issue_before_change.send(c),

431

:value => send(c)) unless send(c)==@issue_before_change.send(c)

431

:value => send(c)) unless send(c)==@issue_before_change.send(c)

432

}

432

}

433

# custom fields changes

433

# custom fields changes

434

custom_values.each {|c|

434

custom_values.each {|c|

435

next if (@custom_values_before_change[c.custom_field_id]==c.value ||

435

next if (@custom_values_before_change[c.custom_field_id]==c.value ||

436

(@custom_values_before_change[c.custom_field_id].blank? && c.value.blank?))

436

(@custom_values_before_change[c.custom_field_id].blank? && c.value.blank?))

437

@current_journal.details << JournalDetail.new(:property => 'cf',

437

@current_journal.details << JournalDetail.new(:property => 'cf',

438

:prop_key => c.custom_field_id,

438

:prop_key => c.custom_field_id,

439

:old_value => @custom_values_before_change[c.custom_field_id],

439

:old_value => @custom_values_before_change[c.custom_field_id],

440

:value => c.value)

440

:value => c.value)

441

}

441

}

442

@current_journal.save

442

@current_journal.save

443

end

443

end

444

end

444

end

445

end

445

end

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

             # redMine - project management software
             # Copyright (C) 2006-2007  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.
             class Issue < ActiveRecord::Base
               belongs_to :project
               belongs_to :tracker
               belongs_to :status, :class_name => 'IssueStatus', :foreign_key => 'status_id'
               belongs_to :author, :class_name => 'User', :foreign_key => 'author_id'
               belongs_to :assigned_to, :class_name => 'User', :foreign_key => 'assigned_to_id'
               belongs_to :fixed_version, :class_name => 'Version', :foreign_key => 'fixed_version_id'
               belongs_to :priority, :class_name => 'IssuePriority', :foreign_key => 'priority_id'
               belongs_to :category, :class_name => 'IssueCategory', :foreign_key => 'category_id'
               has_many :journals, :as => :journalized, :dependent => :destroy
               has_many :time_entries, :dependent => :delete_all
               has_and_belongs_to_many :changesets, :order => "#{Changeset.table_name}.committed_on ASC, #{Changeset.table_name}.id ASC"
               has_many :relations_from, :class_name => 'IssueRelation', :foreign_key => 'issue_from_id', :dependent => :delete_all
               has_many :relations_to, :class_name => 'IssueRelation', :foreign_key => 'issue_to_id', :dependent => :delete_all
               acts_as_attachable :after_remove => :attachment_removed
               acts_as_customizable
               acts_as_watchable
               acts_as_searchable :columns => ['subject', "#{table_name}.description", "#{Journal.table_name}.notes"],
                                  :include => [:project, :journals],
                                  # sort by id so that limited eager loading doesn't break with postgresql
                                  :order_column => "#{table_name}.id"
               acts_as_event :title => Proc.new {|o| "#{o.tracker.name} ##{o.id} (#{o.status}): #{o.subject}"},
                             :url => Proc.new {|o| {:controller => 'issues', :action => 'show', :id => o.id}},
                             :type => Proc.new {|o| 'issue' + (o.closed? ? ' closed' : '') }
               acts_as_activity_provider :find_options => {:include => [:project, :author, :tracker]},
                                         :author_key => :author_id
               DONE_RATIO_OPTIONS = %w(issue_field issue_status)
               validates_presence_of :subject, :priority, :project, :tracker, :author, :status
               validates_length_of :subject, :maximum => 255
               validates_inclusion_of :done_ratio, :in => 0..100
               validates_numericality_of :estimated_hours, :allow_nil => true
               named_scope :visible, lambda {|*args| { :include => :project,
                                                       :conditions => Project.allowed_to_condition(args.first || User.current, :view_issues) } }
               named_scope :open, :conditions => ["#{IssueStatus.table_name}.is_closed = ?", false], :include => :status
               before_save :update_done_ratio_from_issue_status
               after_save :create_journal
               # Returns true if usr or current user is allowed to view the issue
               def visible?(usr=nil)
                 (usr || User.current).allowed_to?(:view_issues, self.project)
               end
               def after_initialize
                 if new_record?
                   # set default values for new records only
                   self.status ||= IssueStatus.default
                   self.priority ||= IssuePriority.default
                 end
               end
               # Overrides Redmine::Acts::Customizable::InstanceMethods#available_custom_fields
               def available_custom_fields
                 (project && tracker) ? project.all_issue_custom_fields.select {|c| tracker.custom_fields.include? c } : []
               end
               def copy_from(arg)
                 issue = arg.is_a?(Issue) ? arg : Issue.find(arg)
                 self.attributes = issue.attributes.dup.except("id", "created_on", "updated_on")
                 self.custom_values = issue.custom_values.collect {|v| v.clone}
                 self.status = issue.status
                 self
               end
               # Moves/copies an issue to a new project and tracker
               # Returns the moved/copied issue on success, false on failure
               def move_to(new_project, new_tracker = nil, options = {})
                 options ||= {}
                 issue = options[:copy] ? self.clone : self
                 transaction do
                   if new_project && issue.project_id != new_project.id
                     # delete issue relations
                     unless Setting.cross_project_issue_relations?
                       issue.relations_from.clear
                       issue.relations_to.clear
                     end
                     # issue is moved to another project
                     # reassign to the category with same name if any
                     new_category = issue.category.nil? ? nil : new_project.issue_categories.find_by_name(issue.category.name)
                     issue.category = new_category
                     # Keep the fixed_version if it's still valid in the new_project
                     unless new_project.shared_versions.include?(issue.fixed_version)
                       issue.fixed_version = nil
                     end
                     issue.project = new_project
                   end
                   if new_tracker
                     issue.tracker = new_tracker
                   end
                   if options[:copy]
                     issue.custom_field_values = self.custom_field_values.inject({}) {|h,v| h[v.custom_field_id] = v.value; h}
                     issue.status = if options[:attributes] && options[:attributes][:status_id]
                                      IssueStatus.find_by_id(options[:attributes][:status_id])
                                    else
                                      self.status
                                    end
                   end
                   # Allow bulk setting of attributes on the issue
                   if options[:attributes]
                     issue.attributes = options[:attributes]
                   end
                   if issue.save
                     unless options[:copy]
                       # Manually update project_id on related time entries
                       TimeEntry.update_all("project_id = #{new_project.id}", {:issue_id => id})
                     end
                   else
                     Issue.connection.rollback_db_transaction
                     return false
                   end
                 end
                 return issue
               end
               def priority_id=(pid)
                 self.priority = nil
                 write_attribute(:priority_id, pid)
               end
               def tracker_id=(tid)
                 self.tracker = nil
                 write_attribute(:tracker_id, tid)
                 result = write_attribute(:tracker_id, tid)
                 @custom_field_values = nil
                 result
               end
               # Overrides attributes= so that tracker_id gets assigned first
               def attributes_with_tracker_first=(new_attributes, *args)
                 return if new_attributes.nil?
                 new_tracker_id = new_attributes['tracker_id'] || new_attributes[:tracker_id]
                 if new_tracker_id
                   self.tracker_id = new_tracker_id
                 end
-                self.attributes_without_tracker_first = new_attributes, *args
+                send :attributes_without_tracker_first=, new_attributes, *args
               end
               alias_method_chain :attributes=, :tracker_first
               def estimated_hours=(h)
                 write_attribute :estimated_hours, (h.is_a?(String) ? h.to_hours : h)
               end
               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
               def self.use_status_for_done_ratio?
                 Setting.issue_done_ratio == 'issue_status'
               end
               def self.use_field_for_done_ratio?
                 Setting.issue_done_ratio == 'issue_field'
               end
               def validate
                 if self.due_date.nil? && @attributes['due_date'] && !@attributes['due_date'].empty?
                   errors.add :due_date, :not_a_date
                 end
                 if self.due_date and self.start_date and self.due_date < self.start_date
                   errors.add :due_date, :greater_than_start_date
                 end
                 if start_date && soonest_start && start_date < soonest_start
                   errors.add :start_date, :invalid
                 end
                 if fixed_version
                   if !assignable_versions.include?(fixed_version)
                     errors.add :fixed_version_id, :inclusion
                   elsif reopened? && fixed_version.closed?
                     errors.add_to_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?)
                   unless project.trackers.include?(tracker)
                     errors.add :tracker_id, :inclusion
                   end
                 end
               end
               def before_create
                 # default assignment based on category
                 if assigned_to.nil? && category && category.assigned_to
                   self.assigned_to = category.assigned_to
                 end
               end
               # 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
               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
               def after_save
                 # Reload is needed in order to get the right status
                 reload
                 # Update start/due dates of following issues
                 relations_from.each(&:set_issue_to_dates)
                 # Close duplicates if the issue was closed
                 if @issue_before_change && !@issue_before_change.closed? && self.closed?
                   duplicates.each do |duplicate|
                     # Reload is need in case the duplicate was updated by a previous duplicate
                     duplicate.reload
                     # Don't re-close it if it's already closed
                     next if duplicate.closed?
                     # Same user and notes
                     duplicate.init_journal(@current_journal.user, @current_journal.notes)
                     duplicate.update_attribute :status, self.status
                   end
                 end
               end
               def init_journal(user, notes = "")
                 @current_journal ||= Journal.new(:journalized => self, :user => user, :notes => notes)
                 @issue_before_change = self.clone
                 @issue_before_change.status = self.status
                 @custom_values_before_change = {}
                 self.custom_values.each {|c| @custom_values_before_change.store c.custom_field_id, c.value }
                 # Make sure updated_on is updated when adding a note.
                 updated_on_will_change!
                 @current_journal
               end
               # Return true if the issue is closed, otherwise false
               def closed?
                 self.status.is_closed?
               end
               # Return true if the issue is being reopened
               def reopened?
                 if !new_record? && status_id_changed?
                   status_was = IssueStatus.find_by_id(status_id_was)
                   status_new = IssueStatus.find_by_id(status_id)
                   if status_was && status_new && status_was.is_closed? && !status_new.is_closed?
                     return true
                   end
                 end
                 false
               end
               # Returns true if the issue is overdue
               def overdue?
                 !due_date.nil? && (due_date < Date.today) && !status.is_closed?
               end
               # Users the issue can be assigned to
               def assignable_users
                 project.assignable_users
               end
               # Versions that the issue can be assigned to
               def assignable_versions
                 @assignable_versions ||= (project.shared_versions.open + [Version.find_by_id(fixed_version_id_was)]).compact.uniq.sort
               end
               # Returns true if this issue is blocked by another issue that is still open
               def blocked?
                 !relations_to.detect {|ir| ir.relation_type == 'blocks' && !ir.issue_from.closed?}.nil?
               end
               # Returns an array of status that user is able to apply
               def new_statuses_allowed_to(user)
                 statuses = status.find_new_statuses_allowed_to(user.roles_for_project(project), tracker)
                 statuses << status unless statuses.empty?
                 statuses = statuses.uniq.sort
                 blocked? ? statuses.reject {|s| s.is_closed?} : statuses
               end
               # Returns the mail adresses of users that should be notified
               def recipients
                 notified = project.notified_users
                 # Author and assignee are always notified unless they have been locked
                 notified << author if author && author.active?
                 notified << assigned_to if assigned_to && assigned_to.active?
                 notified.uniq!
                 # Remove users that can not view the issue
                 notified.reject! {|user| !visible?(user)}
                 notified.collect(&:mail)
               end
               # Returns the total number of hours spent on this issue.
               #
               # Example:
               #   spent_hours => 0
               #   spent_hours => 50
               def spent_hours
                 @spent_hours ||= time_entries.sum(:hours) || 0
               end
               def relations
                 (relations_from + relations_to).sort
               end
               def all_dependent_issues
                 dependencies = []
                 relations_from.each do |relation|
                   dependencies << relation.issue_to
                   dependencies += relation.issue_to.all_dependent_issues
                 end
                 dependencies
               end
               # Returns an array of issues that duplicate this one
               def duplicates
                 relations_to.select {|r| r.relation_type == IssueRelation::TYPE_DUPLICATES}.collect {|r| r.issue_from}
               end
               # Returns the due date or the target due date if any
               # Used on gantt chart
               def due_before
                 due_date || (fixed_version ? fixed_version.effective_date : nil)
               end
               # Returns the time scheduled for this issue.
               #
               # Example:
               #   Start Date: 2/26/09, End Date: 3/04/09
               #   duration => 6
               def duration
                 (start_date && due_date) ? due_date - start_date : 0
               end
               def soonest_start
                 @soonest_start ||= relations_to.collect{|relation| relation.successor_soonest_start}.compact.min
               end
               def to_s
                 "#{tracker} ##{id}: #{subject}"
               end
               # Returns a string of css classes that apply to the issue
               def css_classes
                 s = "issue status-#{status.position} priority-#{priority.position}"
                 s << ' closed' if closed?
                 s << ' overdue' if overdue?
                 s << ' created-by-me' if User.current.logged? && author_id == User.current.id
                 s << ' assigned-to-me' if User.current.logged? && assigned_to_id == User.current.id
                 s
               end
               # Unassigns issues from +version+ if it's no longer shared with issue's project
               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
               # Unassigns issues from versions that are no longer shared
               # after +project+ was moved
               def self.update_versions_from_hierarchy_change(project)
                 moved_project_ids = project.self_and_descendants.reload.collect(&:id)
                 # Update issues of the moved projects and issues assigned to a version of a moved project
                 Issue.update_versions(["#{Version.table_name}.project_id IN (?) OR #{Issue.table_name}.project_id IN (?)", moved_project_ids, moved_project_ids])
               end
               private
               # Update issues so their versions are not pointing to a
               # fixed_version that is not shared with the issue's project
               def self.update_versions(conditions=nil)
                 # Only need to update issues with a fixed_version from
                 # a different project and that is not systemwide shared
                 Issue.all(:conditions => merge_conditions("#{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'",
                                                             conditions),
                           :include => [:project, :fixed_version]
                           ).each do |issue|
                   next if issue.project.nil? || issue.fixed_version.nil?
                   unless issue.project.shared_versions.include?(issue.fixed_version)
                     issue.init_journal(User.current)
                     issue.fixed_version = nil
                     issue.save
                   end
                 end
               end
               # Callback on attachment deletion
               def attachment_removed(obj)
                 journal = init_journal(User.current)
                 journal.details << JournalDetail.new(:property => 'attachment',
                                                      :prop_key => obj.id,
                                                      :old_value => obj.filename)
                 journal.save
               end
               # Saves the changes in a Journal
               # Called after_save
               def create_journal
                 if @current_journal
                   # attributes changes
                   (Issue.column_names - %w(id description lock_version created_on updated_on)).each {|c|
                     @current_journal.details << JournalDetail.new(:property => 'attr',
                                                                   :prop_key => c,
                                                                   :old_value => @issue_before_change.send(c),
                                                                   :value => send(c)) unless send(c)==@issue_before_change.send(c)
                   }
                   # custom fields changes
                   custom_values.each {|c|
                     next if (@custom_values_before_change[c.custom_field_id]==c.value ||
                               (@custom_values_before_change[c.custom_field_id].blank? && c.value.blank?))
                     @current_journal.details << JournalDetail.new(:property => 'cf',
                                                                   :prop_key => c.custom_field_id,
                                                                   :old_value => @custom_values_before_change[c.custom_field_id],
                                                                   :value => c.value)
                   }
                   @current_journal.save
                 end
               end
             end