Class: Cronjobber::Task

Inherits:
ActiveRecord::Base
  • Object
show all
Defined in:
app/models/cronjobber/task.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*arg) ⇒ Task

Returns a new instance of Task.



6
7
8
9
 
# File 'app/models/cronjobber/task.rb', line 6

def initialize *arg
  raise "#{self.class.name} is abstract" if self.class == Cronjobber::Task
  super
end

Instance Attribute Details

#status ⇒ Object

Returns the value of attribute status.



4
5
6
 
# File 'app/models/cronjobber/task.rb', line 4

def status
  @status
end

Class Method Details

.cronjob_enqueue(key = nil) ⇒ Object 



19
20
21
 
# File 'app/models/cronjobber/task.rb', line 19

def self.cronjob_enqueue(key=nil)
  self.delay.cronjob_perform_delayed(key)
end

.cronjob_name ⇒ Object 



11
12
13
 
# File 'app/models/cronjobber/task.rb', line 11

def self.cronjob_name
  self.name.underscore
end

.cronjob_perform ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'app/models/cronjobber/task.rb', line 23

def self.cronjob_perform
  cronjob = self.current_cronjob
  key = DateTime.now.to_i
  
  unless cronjob.lock!(key)
    cronjob.status = "locked"
    return cronjob
  end
  
  unless cronjob.should_run?
    cronjob.status = "skipped"
    cronjob.unlock!
    return cronjob
  end
  
  if self.cronjob_delayed
    cronjob.status = "enqueued"
    cronjob.last_error = nil
    cronjob.save!
    self.cronjob_enqueue(key)
  else
    cronjob.send(self.cronjob_method)
    cronjob.status = "performed"
    cronjob.unlock!
  end
  
  return cronjob
rescue Exception => exception
  cronjob.status = "exception"
  cronjob.unlock!(exception)
  return cronjob
end

.cronjob_perform_delayed(key) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'app/models/cronjobber/task.rb', line 56

def self.cronjob_perform_delayed(key)
  cronjob = self.current_cronjob
  
  if cronjob.locked?(key.to_s)
    cronjob.status = "locked"
  else
    cronjob.send(self.cronjob_method)
    cronjob.status = "performed"
    cronjob.unlock!
  end
  return cronjob
rescue Exception => exception
  cronjob.status = "exception"
  cronjob.unlock!(exception)
  return cronjob
end

.cronjob_timepoint(t1, t2) ⇒ Object 



106
107
108
109
110
111
112
113
114
 
# File 'app/models/cronjobber/task.rb', line 106

def self.cronjob_timepoint t1, t2
  result = []
  (t1 - 1.day).to_date.upto((t2 + 1.day).to_date) do |date|
    self.cronjob_timesteps.each do |time|
      result << Time.parse([date.year, date.month, date.day].join("-") + " " + time.to_s) 
    end
  end
  result.sort.uniq.select { |time| (time > t1 && time <= t2) }.first
end

.current_cronjob ⇒ Object 



15
16
17
 
# File 'app/models/cronjobber/task.rb', line 15

def self.current_cronjob
  self.find_by_name(self.cronjob_name) || self.create!(:name => self.cronjob_name)
end

Instance Method Details

#format ⇒ Object 



144
145
146
 
# File 'app/models/cronjobber/task.rb', line 144

def format
  "#{self.class.cronjob_name} # #{self.status} # #{self.duration}ms # #{self.last_error.to_s[0..64]}"
end

#lock!(key = nil) ⇒ Object 



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

def lock!(key=nil)
  !self.locked? && self.update_attributes!(:locked_at => DateTime.now, :locking_key => key) 
end

#locked?(key = nil) ⇒ Boolean

Returns:

  • (Boolean) 


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

def locked?(key=nil)
  if key && self.locking_key.to_s == key.to_s
    false
  else
    !self.locked_at.nil?
  end
end

#run ⇒ Object 



140
141
142
 
# File 'app/models/cronjobber/task.rb', line 140

def run
  
end

#should_run?(at_time = nil) ⇒ Boolean

Returns:

  • (Boolean) 


116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'app/models/cronjobber/task.rb', line 116

def should_run?(at_time=nil)
  t1 = self.run_at || Time.now
  t2 = at_time || Time.now

  if self.class.cronjob_frequency.to_i == 0
    if self.class.cronjob_timesteps.empty?
      true
    else
      self.class.cronjob_timepoint(t1, t2).present?
    end
  else
    if self.class.cronjob_timesteps.empty?
      (t2 - self.class.cronjob_frequency.to_i.seconds) >= t1
    else
      t3 = Time.parse("#{t1.year}-#{t1.month}-#{t1.day} #{self.class.cronjob_timesteps.first}")
      until t3 > t2 do
        t3 += self.class.cronjob_frequency
        return true if t3 > t1 && t3 <= t2
      end
      false
    end
  end
end

#unlock!(exception = nil) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'app/models/cronjobber/task.rb', line 85

def unlock! exception=nil
  self.class.transaction do
    if exception
      self.last_error = [exception.message, exception.backtrace].flatten.join("\n")
      self.total_failures = self.total_failures.to_i + 1
    else
      self.last_error = nil
    end
    
    if self.status == "performed"
      self.total_runs = self.total_runs.to_i + 1
      self.duration = (Time.now - self.locked_at.to_time) * 1000 if self.locked_at
      self.run_at = Time.now
    end

    self.locked_at = nil
    self.locking_key = nil
    self.save!
  end
end