Class: Task

Inherits:
ActiveRecord::Base
  • Object
show all
Extended by:
UserSystem
Includes:
UserSystem
Defined in:
app/models/task.rb

Constant Summary collapse

COMPLETED = 
'COMPLETED'
POSTPONED = 
'POSTPONED'
MOVED = 
'MOVED'
ABORTED = 
'ABORTED'

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.find_descendant(period_id, ancestor_task_id) ⇒ Object 



72
73
74
75
76
77
78
 
# File 'app/models/task.rb', line 72

def self.find_descendant(period_id, ancestor_task_id)
  candidate_tasks = Task.find :all, 
      :conditions => ["id = ? OR previous_task_id = ?", ancestor_task_id, ancestor_task_id]
  candidate_tasks = candidate_tasks.select {|t| t.root_task.period_id == period_id}
  logger.error "Multiple descendants in period: #{period_id} #{ancestor_task_id}" if candidate_tasks.size > 1
  candidate_tasks[0]
end

.find_open ⇒ Object 



54
55
56
 
# File 'app/models/task.rb', line 54

def self.find_open
  find(:all, :conditions => 'finished_at IS NULL', :order => 'description')
end

.find_started ⇒ Object 



58
59
60
61
62
63
64
65
66
 
# File 'app/models/task.rb', line 58

def self.find_started
  if current_user
    user_clause = " OR user_id = #{current_user.id}"
  end
  conditions = "start_time IS NOT NULL AND completed_at IS NULL AND (user_id IS NULL#{user_clause})"
  Work.find(:all, :conditions => conditions).map {|work| work.task}.compact.sort_by do |t|
    [t.root_task.project.name, t.root_task.period ? t.root_task.period.end_on : 0, t.position || 0]
  end
end

.recent_conditions ⇒ Object 



68
69
70
 
# File 'app/models/task.rb', line 68

def self.recent_conditions
  return "finished_at >= '#{1.week.ago.iso8601}'"
end

Instance Method Details

#abort ⇒ Object 



392
393
394
 
# File 'app/models/task.rb', line 392

def abort
  finish(Task::ABORTED, false)
end

#active? ⇒ Boolean

Returns:

  • (Boolean) 


243
244
245
 
# File 'app/models/task.rb', line 243

def active?
  finished_at.nil? || work_started? || active_children?
end

#active_children? ⇒ Boolean

Returns:

  • (Boolean) 


247
248
249
 
# File 'app/models/task.rb', line 247

def active_children?
  children.detect {|child| child.active?}
end

#ancestor_id ⇒ Object 



421
422
423
 
# File 'app/models/task.rb', line 421

def ancestor_id
  previous_task_id || id
end

#check_finished(subtask_finsihed_at, resolution, save_work) ⇒ Object 



235
236
237
238
239
240
241
 
# File 'app/models/task.rb', line 235

def check_finished(subtask_finsihed_at, resolution, save_work)
  return if self.finished_at
  children.each do |child_task|
    return if child_task.active?
  end
  finish(resolution, save_work)
end

#completed? ⇒ Boolean

Returns:

  • (Boolean) 


255
256
257
 
# File 'app/models/task.rb', line 255

def completed?
  finished_at || completed_children?
end

#completed_children? ⇒ Boolean

Returns:

  • (Boolean) 


259
260
261
 
# File 'app/models/task.rb', line 259

def completed_children?
  children.detect {|child| child.completed?}
end

#depth ⇒ Object 



323
324
325
326
327
328
329
330
331
 
# File 'app/models/task.rb', line 323

def depth
  root_task = self 
  depth = 0
  while !root_task.root?
    root_task = root_task.parent
    depth += 1
  end
  depth
end

#description_with_id ⇒ Object 



409
410
411
 
# File 'app/models/task.rb', line 409

def description_with_id
  "##{id}: #{description}"
end

#description_with_parents ⇒ Object 



413
414
415
416
417
418
419
 
# File 'app/models/task.rb', line 413

def description_with_parents
  if parent.nil?
    "#{project.name}: #{description}"
  else
    "#{parent.description_with_parents} - #{description}"
  end
end

#done ⇒ Object 



116
117
118
 
# File 'app/models/task.rb', line 116

def done
  nil
end

#done=(hours_done) ⇒ Object 



120
121
122
123
124
125
126
127
128
129
 
# File 'app/models/task.rb', line 120

def done=(hours_done)
  return unless hours_done && hours_done != '' && BigDecimal(hours_done) != 0
  return if end_work(hours_done)
  new_work = Work.new
  new_work.hours = hours_done
  new_work.task_id = self.id
  new_work.completed_at = DateTime.now
  new_work.save!
  works << new_work
end

#enable_customer? ⇒ Boolean

Returns:

  • (Boolean) 


305
306
307
 
# File 'app/models/task.rb', line 305

def enable_customer?
  root_task.project.enable_customer?
end

#enable_invoicing? ⇒ Boolean

Returns:

  • (Boolean) 


309
310
311
 
# File 'app/models/task.rb', line 309

def enable_invoicing?
  root_task.project.enable_invoicing?
end

#enable_subtasks? ⇒ Boolean

Returns:

  • (Boolean) 


297
298
299
 
# File 'app/models/task.rb', line 297

def enable_subtasks?
  root_task.project.enable_subtasks?
end

#enable_users? ⇒ Boolean

Returns:

  • (Boolean) 


301
302
303
 
# File 'app/models/task.rb', line 301

def enable_users?
  root_task.project.enable_users?
end

#estimate(new_todo) ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'app/models/task.rb', line 88

def estimate(new_todo)
  return unless new_todo && new_todo != ''
  new_todo = new_todo.to_i
  if new_todo == 0
    finish(Task::COMPLETED, false)
  end
  previous_estimate = estimates.last
  new_estimate = Estimate.new
  if previous_estimate
    return if new_todo == previous_estimate.todo
  else
    return if new_todo == initial_estimate
  end
  now = Time.now
  if previous_estimate && (now < previous_estimate.created_at || now.strftime('%Y-%m-%DT%H:%M:%S') == previous_estimate.created_at.strftime('%Y-%m-%DT%H:%M:%S'))
    previous_estimate.todo = new_todo
    previous_estimate.user = current_user
    previous_estimate.save!
  else
    new_estimate.task_id = self.id
    new_estimate.todo = new_todo
    new_estimate.created_at = now
    new_estimate.user = current_user
    new_estimate.save!
    estimates << new_estimate
  end
end

#estimate_data(date, actual = false) ⇒ Object 



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

def estimate_data(date, actual=false)
  if children.empty?
    return 0 if actual && (resolution == ABORTED || resolution == POSTPONED)
    return 0 if finished_at && (date >= finished_at.to_date)
    estimate = Estimate.find(:first, :conditions => "task_id = #{id} AND created_at < '#{(date+1).to_s}'", :order => 'created_at DESC,id DESC')
    if estimate
      estimate.todo
    elsif actual || created_at < (date+1).to_time
      initial_estimate
    else
      0
    end
  else
    total = BigDecimal('0')
    children.each {|child_task| total += child_task.estimate_data(date, actual)}
    total
  end
end

#finish(resolution, save_work) ⇒ Object 



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

def finish(resolution, save_work)
  unless finished_at || work_started?
    self.finished_at = Time.now
    self.resolution = resolution
    remove_from_list
    self.position = nil
    save!
    estimate(0) if save_work
    parent.check_finished(self.finished_at, resolution, save_work) if parent
  end
end

#finished? ⇒ Boolean

Returns:

  • (Boolean) 


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

def finished?
  completed?
end

#grab ⇒ Object 



215
216
217
 
# File 'app/models/task.rb', line 215

def grab
  self.users << current_user
end

#invoicing? ⇒ Boolean

Returns:

  • (Boolean) 


281
282
283
 
# File 'app/models/task.rb', line 281

def invoicing?
  root_task.project.enable_invoicing?
end

#leaf? ⇒ Boolean

Returns:

  • (Boolean) 


267
268
269
 
# File 'app/models/task.rb', line 267

def leaf?
  children.size == 0
end

#loggable? ⇒ Boolean

Returns:

  • (Boolean) 


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

def loggable?
  active? && leaf?
end

#move_to_period(new_period) ⇒ Object 



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'app/models/task.rb', line 159

def move_to_period(new_period)
  raise "Cannot move finished tasks" unless active?
  return self if new_period == period
  
  self.remove_from_list
  self.position = nil
  
  if self.period
    old_todo = self.todo
    if parent
      parent.move_to_period new_period
    end
    if leaf?
      self.finish((new_period.nil? || (new_period.party == self.period.party)) ? Task::POSTPONED : Task::MOVED, true)
    end
    existing_task = Task.find_descendant(new_period && new_period.id, ancestor_id)
    if existing_task ||= Task.find_by_period_id_and_previous_task_id(new_period && new_period.id, ancestor_id)
      raise "mismatch" unless existing_task.project == root_task.project
      raise "Mismatch" unless existing_task.period == new_period
      existing_task.open
      existing_task.previous_task_id = self.previous_task_id || self.id
      existing_task.description = self.description
      existing_task.users = self.users
      existing_task.save!
      existing_task.estimate(old_todo)
      return existing_task
    else
      new_task = Task.new
      new_task.previous_task_id = ancestor_id
      if parent
        new_parent = Task.find_descendant(new_period.id, parent.ancestor_id)
        new_task.parent = new_parent
      else
        new_task.project = root_task.project
        new_task.period = new_period
      end
      new_task.description = self.description
      new_task.initial_estimate = self.initial_estimate
      new_task.position = nil
      new_task.users = self.users
      new_task.save!
      new_task.insert_at 1
      new_task.estimate(old_todo)
      return new_task
    end
  else
    self.period_id = new_period && new_period.id
    self.period = new_period
    self.insert_at(1)
    self.position = 1
    self.move_to_bottom
    self.save!
    return self
  end
end

#old_period ⇒ Object 



313
 
# File 'app/models/task.rb', line 313

alias_method :old_period, :period

#old_project ⇒ Object 



318
 
# File 'app/models/task.rb', line 318

alias_method :old_project, :project

#open ⇒ Object 



137
138
139
140
141
142
143
144
145
146
 
# File 'app/models/task.rb', line 137

def open
  if finished_at
    self.finished_at = nil
    self.resolution = nil
    self.position = nil
    insert_at 1
    estimate(initial_estimate)
    parent.open if parent
  end
end

#period ⇒ Object 



314
315
316
 
# File 'app/models/task.rb', line 314

def period
  old_period || root_task.old_period
end

#project ⇒ Object 



319
320
321
 
# File 'app/models/task.rb', line 319

def project
  old_project || root_task.old_project
end

#release ⇒ Object 



219
220
221
 
# File 'app/models/task.rb', line 219

def release
  self.users.delete current_user
end

#reopen ⇒ Object 



148
149
150
151
152
153
154
155
156
157
 
# File 'app/models/task.rb', line 148

def reopen
  if period && period.passed?
    raise "You cannot reopen a task in a period that is passed."
  else
    open
    save!
    children.each {|child_task| child_task.reopen}
  end
  self
end

#root? ⇒ Boolean

Returns:

  • (Boolean) 


271
272
273
 
# File 'app/models/task.rb', line 271

def root?
  parent.nil?
end

#root_task ⇒ Object 



275
276
277
278
279
 
# File 'app/models/task.rb', line 275

def root_task
  root_task = self 
  root_task = root_task.parent while root_task.parent
  root_task
end

#self_with_children ⇒ Object 



80
81
82
 
# File 'app/models/task.rb', line 80

def self_with_children
  [self] << children.map {|t| t.self_with_children}.flatten
end

#start_work ⇒ Object 



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'app/models/task.rb', line 362

def start_work
  return if work_started?
  open
  grab if current_user
  new_work = works.new
  
  # TODO (uwe): Only needed for rails 1.2.x branch.  Remove when moving to 1.3 or 2.0.
  new_work.task = self
  
  new_work.started_on = Time.previous_quarter.to_date
  new_work.start_time = Time.previous_quarter.time_of_day
  if current_user
    last_work = current_user.works.select {|w| w.completed_at}.last
  else
    last_work = Work.find(:first, :conditions => 'completed_at IS NOT NULL', :order => 'completed_at DESC')
  end
  if last_work && last_work.completed_at > new_work.started_on.at(new_work.start_time)
    new_work.started_at = last_work.completed_at
  end
  
  new_work.user = current_user
  new_work.project_id = project.id
  new_work.save!
  works << new_work
end

#started_work ⇒ Object 



400
401
402
403
404
405
406
407
 
# File 'app/models/task.rb', line 400

def started_work
  started_works = works.select {|work| work.start_time && work.completed_at.nil?}
  if current_user
    started_by_user = started_works.select {|work| work.user == current_user}.last
    return started_by_user if started_by_user
  end
  started_works.select {|work| work.user.nil?}.last
end

#todo ⇒ Object 



84
85
86
 
# File 'app/models/task.rb', line 84

def todo
  estimates.last ? estimates.last.todo : initial_estimate
end

#total_done ⇒ Object 



131
132
133
134
135
 
# File 'app/models/task.rb', line 131

def total_done
  total = BigDecimal('0')
  works.each {|work| total += work.hours}
  total
end

#track_done? ⇒ Boolean

Returns:

  • (Boolean) 


285
286
287
 
# File 'app/models/task.rb', line 285

def track_done?
  project.track_done?
end

#track_times? ⇒ Boolean

Returns:

  • (Boolean) 


289
290
291
 
# File 'app/models/task.rb', line 289

def track_times?
  project.try :track_times?
end

#track_todo? ⇒ Boolean

Returns:

  • (Boolean) 


293
294
295
 
# File 'app/models/task.rb', line 293

def track_todo?
  root_task.project.track_todo?
end

#work_data(date) ⇒ Object 



352
353
354
355
356
357
358
359
360
 
# File 'app/models/task.rb', line 352

def work_data(date)
  return 0 if resolution == ABORTED
  relevant_works = Work.find(:all, :conditions => "task_id = #{id} AND completed_at < '#{(date+1).to_s}'")
  total = BigDecimal('0')
  relevant_works.each do |work|
    total += work.hours
  end
  total
end

#work_started? ⇒ Boolean

Returns:

  • (Boolean) 


396
397
398
 
# File 'app/models/task.rb', line 396

def work_started?
  !started_work.nil? 
end

#works_with_children ⇒ Object 



388
389
390
 
# File 'app/models/task.rb', line 388

def works_with_children
  works << children.map {|t| t.works_with_children}.flatten
end