clockwork 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 384e3245517c1613d4551a8d401f1f398a5900ee
-  data.tar.gz: 92d176c5595e3a0c2d456710bc9d527d99f12b0c
+  metadata.gz: a05228ef038356c69ac45b0cd26eba0d9571905c
+  data.tar.gz: 1202fe6dfa6d4ed81a7850968f99d2512bf5dc5b
 SHA512:
-  metadata.gz: 02583e06f9b53687229298b169c703f9be058e507ad95014286538fb5d537c9ecec57f9732903c56ae397dcb605f18ba77998d406248d23465fb34e945692233
-  data.tar.gz: d72f9f576ecf78cc7870cb317cea3a182052c0b937034e4befa7df483b9711699feb34ca835f5e1f89f2f3bd919a150b45660cf9eafa568360f71c420010c0bc
+  metadata.gz: 8353beebe55670202cce99d785d646bfe239e78271f1e211b0e9379d44c785e938f17004c18e8222ec0cad389bdc35b3f5633d767555e45900d9c24c5ba8ae9f
+  data.tar.gz: c0d61cafe0c731f02f6b9c4dde2786901cf3f0b11be6e1fd86d8fadb1f73cd14493120f1d805563322e35ece1b41587a7c3c2e472712cc1db45078ff729ec9cc

data/README.md

@@ -18,43 +18,16 @@ Create clock.rb:
 
 ```ruby
 require 'clockwork'
-include Clockwork
-
-handler do |job|
-  puts "Running #{job}"
-end
-
-every(10.seconds, 'frequent.job')
-every(3.minutes, 'less.frequent.job')
-every(1.hour, 'hourly.job')
-
-every(1.day, 'midnight.job', :at => '00:00')
-```
-
-Run it with the clockwork binary:
-
-```
-$ clockwork clock.rb
-Starting clock for 4 events: [ frequent.job less.frequent.job hourly.job midnight.job ]
-Triggering frequent.job
-```
-
-If you would not like to taint the namespace with `include Clockwork`, you can use
-it as the module (thanks to [hoverlover](https://github.com/hoverlover/clockwork/)).
-
-```ruby
-require 'clockwork'
-
 module Clockwork
-
-  configure do |config|
-    config[:tz] = "America/Chicago"
-  end
-
   handler do |job|
     puts "Running #{job}"
   end
 
+  # handler receives the time when job is prepared to run in the 2nd argument
+  # handler do |job, time|
+  #   puts "Running #{job}, at #{time}"
+  # end
+
   every(10.seconds, 'frequent.job')
   every(3.minutes, 'less.frequent.job')
   every(1.hour, 'hourly.job')
@@ -63,6 +36,14 @@ module Clockwork
 end
 ```
 
+Run it with the clockwork binary:
+
+```
+$ clockwork clock.rb
+Starting clock for 4 events: [ frequent.job less.frequent.job hourly.job midnight.job ]
+Triggering frequent.job
+```
+
 If you need to load your entire environment for your jobs, simply add:
 
 ```ruby
@@ -100,10 +81,12 @@ For example, if you're using Beanstalk/Staker:
 ```ruby
 require 'stalker'
 
-handler { |job| Stalker.enqueue(job) }
+module Clockwork
+  handler { |job| Stalker.enqueue(job) }
 
-every(1.hour, 'feeds.refresh')
-every(1.day, 'reminders.send', :at => '01:30')
+  every(1.hour, 'feeds.refresh')
+  every(1.day, 'reminders.send', :at => '01:30')
+end
 ```
 
 Using a queueing system which doesn't require that your full application be
@@ -221,11 +204,13 @@ jobs.
 ### Configuration example
 
 ```ruby
-Clockwork.configure do |config|
-  config[:sleep_timeout] = 5
-  config[:logger] = Logger.new(log_file_path)
-  config[:tz] = 'EST'
-  config[:max_threads] = 15
+module Clockwork
+  configure do |config|
+    config[:sleep_timeout] = 5
+    config[:logger] = Logger.new(log_file_path)
+    config[:tz] = 'EST'
+    config[:max_threads] = 15
+  end
 end
 ```
 
@@ -234,8 +219,10 @@ end
 You can add error_handler to define your own logging or error rescue.
 
 ```ruby
-Clockwork.error_handler do |error|
-  Airbrake.notify_or_ignore(error)
+module Clockwork
+  error_handler do |error|
+    Airbrake.notify_or_ignore(error)
+  end
 end
 ```
 
@@ -246,6 +233,14 @@ Current specifications are as follows.
 
 Any suggestion about these specifications is welcome.
 
+Old style
+---------
+
+`include Clockwork` is old style.
+That is still supported, but not recommended, because it taint global namespace.
+
+
+
 Anatomy of a clock file
 -----------------------
 
@@ -324,6 +319,28 @@ clockworkd -c YOUR_CLOCK.rb start
 
 For more details, see help shown by `clockworkd`.
 
+Issues and Pull requests
+------------------------
+
+Let us know bugs you found as an issue from [Issues · tomykaira/clockwork](https://github.com/tomykaira/clockwork/issues).
+
+For a bug fix or a feature request, please send a pull-request.
+Do not forget to add tests to show how your feature works, or what bug is fixed.
+All existing tests and new tests must pass (TravisCI is watching).
+
+We want to provide simple and customizable core, so superficial changes will not be merged (e.g. supporting new event registration style).
+In most case, directly operating `Manager` realizes an idea, without touching the core.
+If you get up with a new usage, please create a gist page or an article on your website, then add to the following "Use cases" section.
+This tool is already used in various environment, so backward-incompatible requests will be mostly rejected.
+
+Use cases
+---------
+
+Feel free to add your idea or experience and send a pull-request.
+
+- [Sending errors to Airbrake](https://github.com/tomykaira/clockwork/issues/58)
+- [Read events from a database](https://github.com/tomykaira/clockwork/issues/25)
+
 Meta
 ----
 

data/bin/clockworkd

@@ -48,6 +48,9 @@ opts = OptionParser.new do |opts|
     @options[:file] = "./#{@options[:file]}" unless @options[:file].match(/^[\/.]/)
     @options[:file] = File.expand_path(@options[:file])
   end
+  opts.on('-d', '--dir=DIR', 'Directory to change to once the process starts') do |dir|
+    @options[:current_dir] = File.expand_path(dir)
+  end
 end
 
 @args = opts.parse!(ARGV)
@@ -79,6 +82,9 @@ else
 end
 
 Daemons.run_proc(process_name, :dir => @options[:pid_dir], :dir_mode => :normal, :monitor => @options[:monitor], :log_dir => @options[:log_dir], :log_output => @options[:log_output], :ARGV => @args) do |*args|
+  # daemons changes the current working directory to '/' when a new process is
+  # forked. We change it back to the project root directory here.
+  Dir.chdir(@options[:current_dir]) if @options[:current_dir]
   require @options[:file]
 
   Clockwork::run

data/clockwork.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "clockwork"
-  s.version = "0.6.2"
+  s.version = "0.7.0"
 
   s.authors = ["Adam Wiggins", "tomykaira"]
   s.license = 'MIT'

data/example.rb

@@ -1,16 +1,17 @@
 require 'clockwork'
-include Clockwork
 
-handler do |job|
-  puts "Queueing job: #{job}"
-end
+module Clockwork
+  handler do |job|
+    puts "Queueing job: #{job}"
+  end
 
-every(10.seconds, 'run.me.every.10.seconds')
-every(1.minute, 'run.me.every.minute')
-every(1.hour, 'run.me.every.hour')
+  every(10.seconds, 'run.me.every.10.seconds')
+  every(1.minute, 'run.me.every.minute')
+  every(1.hour, 'run.me.every.hour')
 
-every(1.day, 'run.me.at.midnight', :at => '00:00')
+  every(1.day, 'run.me.at.midnight', :at => '00:00')
 
-every(1.day, 'custom.event.handler', :at => '00:30') do
-  puts 'This event has its own handler'
+  every(1.day, 'custom.event.handler', :at => '00:30') do
+    puts 'This event has its own handler'
+  end
 end

data/lib/clockwork.rb

@@ -6,38 +6,52 @@ require 'clockwork/event'
 require 'clockwork/manager'
 
 module Clockwork
-  extend self
-
-  @@manager = Manager.new
-
-  def configure(&block)
-    @@manager.configure(&block)
+  class << self
+    def included(klass)
+      klass.send "include", Methods
+      klass.extend Methods
+    end
+
+    def manager
+      @manager ||= Manager.new
+    end
+
+    def manager=(manager)
+      @manager = manager
+    end
   end
 
-  def handler(&block)
-    @@manager.handler(&block)
-  end
+  module Methods
+    def configure(&block)
+      Clockwork.manager.configure(&block)
+    end
 
-  def error_handler(&block)
-    @@manager.error_handler(&block)
-  end
+    def handler(&block)
+      Clockwork.manager.handler(&block)
+    end
 
-  def on(event, options={}, &block)
-    @@manager.on(event, options, &block)
-  end
+    def error_handler(&block)
+      Clockwork.manager.error_handler(&block)
+    end
 
-  def every(period, job, options={}, &block)
-    @@manager.every(period, job, options, &block)
-  end
+    def on(event, options={}, &block)
+      Clockwork.manager.on(event, options, &block)
+    end
 
-  def run
-    @@manager.run
-  end
+    def every(period, job, options={}, &block)
+      Clockwork.manager.every(period, job, options, &block)
+    end
+
+    def run
+      Clockwork.manager.run
+    end
 
-  def clear!
-    @@manager = Manager.new
+    def clear!
+      Clockwork.manager = Manager.new
+    end
   end
 
+  extend Methods
 end
 
 unless 1.respond_to?(:seconds)

data/lib/clockwork/event.rb

@@ -48,7 +48,7 @@ module Clockwork
     end
 
     def execute
-      @block.call(@job)
+      @block.call(@job, @last)
     rescue => e
       log_error e
       handle_error e

data/test/clockwork_test.rb

@@ -59,4 +59,17 @@ class ClockworkTest < Test::Unit::TestCase
     assert string_io.string.include?('1 events')
     assert !string_io.string.include?('Triggering')
   end
+
+  test 'support module re-open style' do
+    $called = false
+    module ::Clockwork
+      every(1.second, 'myjob') { $called = true }
+    end
+    set_string_io_logger
+    runner = run_in_thread
+    sleep 1
+    runner.kill
+
+    assert $called
+  end
 end

data/test/manager_test.rb

@@ -89,6 +89,23 @@ class ManagerTest < Test::Unit::TestCase
     assert_equal 2, $set_me
   end
 
+  test "should pass time to the general handler" do
+    received = nil
+    now = Time.now
+    @manager.handler { |job, time| received = time }
+    @manager.every(1.minute, 'myjob')
+    @manager.tick(now)
+    assert_equal now, received
+  end
+
+  test "should pass time to the event-specific handler" do
+    received = nil
+    now = Time.now
+    @manager.every(1.minute, 'myjob') { |job, time| received = time }
+    @manager.tick(now)
+    assert_equal now, received
+  end
+
   test "exceptions are trapped and logged" do
     @manager.handler { raise 'boom' }
     @manager.every(1.minute, 'myjob')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clockwork
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Adam Wiggins
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-19 00:00:00.000000000 Z
+date: 2013-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo