Module: Clockwork

Extended by:
Clockwork
Included in:
Clockwork
Defined in:
lib/clockwork.rb

Defined Under Namespace

Classes: At, Event, NoHandlerDefined

Constant Summary collapse

@@events = 
[]
@@configuration = 
default_configuration

Instance Method Summary collapse

Instance Method Details

#clear! ⇒ Object 



202
203
204
205
206
 
# File 'lib/clockwork.rb', line 202

def clear!
  @@events = []
  @@handler = nil
  @@configuration = Clockwork.default_configuration
end

#config ⇒ Object 



142
143
144
 
# File 'lib/clockwork.rb', line 142

def config
  @@configuration
end

#configure {|config| ... } ⇒ Object

Yields:



138
139
140
 
# File 'lib/clockwork.rb', line 138

def configure
  yield(config)
end

#default_configuration ⇒ Object 



148
149
150
 
# File 'lib/clockwork.rb', line 148

def default_configuration
  { :sleep_timeout => 1, :logger => Logger.new(STDOUT), :max_threads => 10 }
end

#every(period, job, options = {}, &block) ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/clockwork.rb', line 165

def every(period, job, options={}, &block)
  if options[:at].respond_to?(:each)
    each_options = options.clone
    options[:at].each do |at|
      each_options[:at] = at
      register(period, job, block, each_options)
    end
  else
    register(period, job, block, options)
  end
end

#get_handler ⇒ Object

Raises:



160
161
162
163
 
# File 'lib/clockwork.rb', line 160

def get_handler
  raise NoHandlerDefined unless (defined?(@@handler) and @@handler)
  @@handler
end

#handler(&block) ⇒ Object 



154
155
156
 
# File 'lib/clockwork.rb', line 154

def handler(&block)
  @@handler = block
end

#log(msg) ⇒ Object 



185
186
187
 
# File 'lib/clockwork.rb', line 185

def log(msg)
  config[:logger].info(msg)
end

#run ⇒ Object 



177
178
179
180
181
182
183
 
# File 'lib/clockwork.rb', line 177

def run
  log "Starting clock for #{@@events.size} events: [ " + @@events.map { |e| e.to_s }.join(' ') + " ]"
  loop do
    tick
    sleep(config[:sleep_timeout])
  end
end

#tick(t = Time.now) ⇒ Object 



189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/clockwork.rb', line 189

def tick(t=Time.now)
  to_run = @@events.select do |event|
    event.time?(t)
  end

  to_run.each do |event|
    log "Triggering '#{event}'"
    event.run(t)
  end

  to_run
end