clockwork 0.3.4 → 0.4.0

data/Gemfile

@@ -1,5 +1,7 @@
 source :rubygems
 
+gem 'tzinfo'
+
 group :development, :test do
   gem 'jeweler'
   gem 'contest'

data/Gemfile.lock

@@ -11,6 +11,7 @@ GEM
     mocha (0.10.0)
       metaclass (~> 0.0.1)
     rake (0.9.2)
+    tzinfo (0.3.32)
 
 PLATFORMS
   ruby
@@ -19,3 +20,4 @@ DEPENDENCIES
   contest
   jeweler
   mocha
+  tzinfo

data/README.md

@@ -119,6 +119,41 @@ You can set more than one timing:
     every(1.hour, 'reminders.send', :at => ['12:00', '18:00'])
     # send reminders at noon and evening
 
+You can also specify a timezone (default is the local timezone):
+
+    every(1.day, 'reminders.send', :at => '00:00', :tz => 'UTC')
+    # Runs the job each day at midnight, UTC.
+    # The value for :tz can be anything supported by [TZInfo](http://tzinfo.rubyforge.org/)
+
+
+Configuration
+-----------------------
+
+Clockwork exposes a couple of configuration options you may change:
+
+### :logger
+
+By default Clockwork logs to STDOUT. In case you prefer to make it to use our
+own logger implementation you have to specify the `logger` configuration option. See example below.
+
+### :sleep_timeout
+
+Clockwork wakes up once a second (by default) and performs its duties. If that
+is the rare case you need to tweak the number of seconds it sleeps then you have
+the `sleep_timeout` configuration option to set like shown below.
+
+### :tz
+
+This is the default timezone to use for all events.  When not specified this defaults to the local
+timezone.  Specifying :tz in the the parameters for an event overrides anything set here.
+
+### Configuration example
+
+    Clockwork.configure do |config|
+      config[:sleep_timeout] = 5
+      config[:logger] = Logger.new(log_file_path)
+      config[:tz] = 'EST'
+    end
 
 Anatomy of a clock file
 -----------------------

data/VERSION

@@ -1 +1 @@
-0.3.4
+0.4.0

data/lib/clockwork.rb

@@ -1,3 +1,6 @@
+require 'logger'
+require 'tzinfo'
+
 module Clockwork
 
   @@events = []
@@ -58,18 +61,34 @@ module Clockwork
       @at = At.parse(options[:at])
       @last = nil
       @block = block
+      if options[:if]
+        if options[:if].respond_to?(:call)
+          @if = options[:if]
+        else
+          raise ArgumentError.new(':if expects a callable object, but #{options[:if]} does not respond to call')
+        end
+      end
+
+      tz = options[:tz] || Clockwork.config[:tz]
+      @timezone = TZInfo::Timezone.get(tz) if tz
     end
 
     def to_s
       @job
     end
 
+    def convert_timezone(t)
+      @timezone ? @timezone.utc_to_local(t.dup.utc) : t
+    end
+
     def time?(t)
-      ellapsed_ready = (@last.nil? or (t - @last).to_i >= @period)
-      ellapsed_ready and (@at.nil? or @at.ready?(t))
+      t = convert_timezone(t)
+      elapsed_ready = (@last.nil? or (t - @last).to_i >= @period)
+      elapsed_ready and (@at.nil? or @at.ready?(t)) and (@if.nil? or @if.call(t))
     end
 
     def run(t)
+      t = convert_timezone(t)
       @last = t
       @block.call(@job)
     rescue => e
@@ -77,7 +96,7 @@ module Clockwork
     end
 
     def log_error(e)
-      STDERR.puts exception_message(e)
+      Clockwork.config[:logger].error(e)
     end
 
     def exception_message(e)
@@ -92,8 +111,22 @@ module Clockwork
     end
   end
 
+  def configure
+    yield(config)
+  end
+   
+  def config
+    @@configuration
+  end
+
   extend self
 
+  def default_configuration
+    { :sleep_timeout => 1, :logger => Logger.new(STDOUT) }
+  end
+
+  @@configuration = default_configuration
+
   def handler(&block)
     @@handler = block
   end
@@ -121,12 +154,12 @@ module Clockwork
     log "Starting clock for #{@@events.size} events: [ " + @@events.map { |e| e.to_s }.join(' ') + " ]"
     loop do
       tick
-      sleep 1
+      sleep(config[:sleep_timeout])
     end
   end
 
   def log(msg)
-    puts msg
+    config[:logger].info(msg)
   end
 
   def tick(t=Time.now)
@@ -135,7 +168,7 @@ module Clockwork
     end
 
     to_run.each do |event|
-      log "Triggering #{event}"
+      log "Triggering '#{event}'"
       event.run(t)
     end
 
@@ -145,6 +178,7 @@ module Clockwork
   def clear!
     @@events = []
     @@handler = nil
+    @@configuration = Clockwork.default_configuration
   end
 
   private

data/test/clockwork_test.rb

@@ -169,4 +169,78 @@ class ClockworkTest < Test::Unit::TestCase
     Clockwork.tick(t = Time.now)
     assert_equal t, event.last
   end
+
+  test "should be configurable" do
+    Clockwork.configure do |config|
+      config[:sleep_timeout] = 200
+      config[:logger] = "A Logger"
+    end
+
+    assert_equal 200, Clockwork.config[:sleep_timeout]
+    assert_equal "A Logger", Clockwork.config[:logger]
+  end
+
+  test "configuration should have reasonable defaults" do
+    assert_equal 1, Clockwork.config[:sleep_timeout]
+    assert Clockwork.config[:logger].is_a?(Logger)
+  end
+
+  test "should be able to specify a different timezone than local" do
+    Clockwork.every(1.day, 'myjob', :at => '10:00', :tz => 'UTC')
+
+    assert_wont_run 'jan 1 2010 10:00:00 EST'
+    assert_will_run 'jan 1 2010 10:00:00 UTC'
+  end
+
+  test "should be able to specify a different timezone than local for multiple times" do
+    Clockwork.every(1.day, 'myjob', :at => ['10:00', '8:00'], :tz => 'UTC')
+
+    assert_wont_run 'jan 1 2010 08:00:00 EST'
+    assert_will_run 'jan 1 2010 08:00:00 UTC'
+    assert_wont_run 'jan 1 2010 10:00:00 EST'
+    assert_will_run 'jan 1 2010 10:00:00 UTC'
+  end
+
+  test "should be able to configure a default timezone to use for all events" do
+    Clockwork.configure { |config| config[:tz] = 'UTC' }
+    Clockwork.every(1.day, 'myjob', :at => '10:00')
+
+    assert_wont_run 'jan 1 2010 10:00:00 EST'
+    assert_will_run 'jan 1 2010 10:00:00 UTC'
+  end
+
+  test "should be able to override a default timezone in an event" do
+    Clockwork.configure { |config| config[:tz] = 'UTC' }
+    Clockwork.every(1.day, 'myjob', :at => '10:00', :tz => 'EST')
+
+    assert_will_run 'jan 1 2010 10:00:00 EST'
+    assert_wont_run 'jan 1 2010 10:00:00 UTC'
+  end
+
+  test ":if true then always run" do
+    Clockwork.every(1.second, 'myjob', :if => lambda { |_| true })
+
+    assert_will_run 'jan 1 2010 16:20:00'
+  end
+
+  test ":if false then never run" do
+    Clockwork.every(1.second, 'myjob', :if => lambda { |_| false })
+
+    assert_wont_run 'jan 1 2010 16:20:00'
+  end
+
+  test ":if the first day of month" do
+    Clockwork.every(1.second, 'myjob', :if => lambda { |t| t.day == 1 })
+
+    assert_will_run 'jan 1 2010 16:20:00'
+    assert_wont_run 'jan 2 2010 16:20:00'
+    assert_will_run 'feb 1 2010 16:20:00'
+  end
+
+  test ":if is not callable then raise ArgumentError" do
+    assert_raise(ArgumentError) do
+      Clockwork.every(1.second, 'myjob', :if => true)
+    end
+  end
+
 end

metadata

@@ -2,7 +2,7 @@
 name: clockwork
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors: 
 - Adam Wiggins
@@ -10,21 +10,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-14 00:00:00 Z
+date: 2012-03-31 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: jeweler
+  name: tzinfo
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: contest
+  name: jeweler
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -35,7 +35,7 @@ dependencies:
   prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: mocha
+  name: contest
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -45,6 +45,17 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
 description: A scheduler process to replace cron, using a more flexible Ruby syntax running as a single long-running process.  Inspired by rufus-scheduler and resque-scheduler.
 email: adam@heroku.com
 executables: 
@@ -75,6 +86,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: -383118451
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
@@ -85,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: clockwork
-rubygems_version: 1.8.6
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: A scheduler process to replace cron.