clockwork 0.6.0 → 0.6.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2e720594452bfaa38dfa5531dd7b8de45423f4b3
+  data.tar.gz: f0258265ef190bccce9fb5360e733a03c38ce4ba
+SHA512:
+  metadata.gz: 138b331deb24d582e1da4126a8f661bec5e101b2a251068b5cd12f3da422a672bf0e6d00c3d1c6bed4d0955e536138063bb7d707e7a7cc3ac6d8c1ae84f3f2ac
+  data.tar.gz: deb399044bf8266c9f9d0d70f9aec93f01f7c092b6f931cbf73bcc13a8569f393a07243803cd1bccffe981ccc7c210058448b5249cbdd9ee15d263006f407a42

data/README.md

@@ -139,10 +139,11 @@ You can omit 0 of the hour:
 every(1.day, 'reminders.send', :at => '1:30')
 ```
 
-The wildcard for hour is supported:
+The wildcard for hour and minute is supported:
 
 ```ruby
 every(1.hour, 'reminders.send', :at => '**:30')
+every(10.seconds, 'frequent.job', :at => '9:**')
 ```
 
 You can set more than one timing:

data/clockwork.gemspec

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

data/lib/clockwork.rb

@@ -18,6 +18,10 @@ module Clockwork
     @@manager.handler(&block)
   end
 
+  def on(event, options={}, &block)
+    @@manager.on(event, options, &block)
+  end
+
   def every(period, job, options={}, &block)
     @@manager.every(period, job, options, &block)
   end
@@ -29,6 +33,7 @@ module Clockwork
   def clear!
     @@manager = Manager.new
   end
+
 end
 
 unless 1.respond_to?(:seconds)

data/lib/clockwork/at.rb

@@ -20,6 +20,8 @@ module Clockwork
         new($2.to_i, $1.to_i)
       when /^\*{1,2}:(\d\d)$/
         new($1.to_i)
+      when /^(\d{1,2}):\*\*$/
+        new(NOT_SPECIFIED, $1.to_i)
       else
         raise FailedToParse, at
       end
@@ -30,7 +32,7 @@ module Clockwork
     attr_writer :min, :hour, :wday
 
     def initialize(min, hour=NOT_SPECIFIED, wday=NOT_SPECIFIED)
-      if min.nil? || min < 0 || min > 59 ||
+      if (min != NOT_SPECIFIED && (min < 0 || min > 59)) ||
           (hour != NOT_SPECIFIED && (hour < 0 || hour > 23)) ||
           (wday != NOT_SPECIFIED && (wday < 0 || wday > 6))
         raise ArgumentError
@@ -41,7 +43,7 @@ module Clockwork
     end
 
     def ready?(t)
-      t.min == @min and
+      (@min == NOT_SPECIFIED or t.min == @min) and
         (@hour == NOT_SPECIFIED or t.hour == @hour) and
         (@wday == NOT_SPECIFIED or t.wday == @wday)
     end

data/lib/clockwork/manager.rb

@@ -6,6 +6,7 @@ module Clockwork
 
     def initialize
       @events = []
+      @callbacks = {}
       @config = default_configuration
       @handler = nil
     end
@@ -31,18 +32,23 @@ module Clockwork
       @handler
     end
 
+    def on(event, options={}, &block)
+      raise "Unsupported callback #{event}" unless [:before_tick, :after_tick, :before_run, :after_run].include?(event.to_sym)
+      (@callbacks[event.to_sym]||=[]) << block
+    end
+
     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
+        every_with_multiple_times(period, job, options, &block)
       else
         register(period, job, block, options)
       end
     end
 
+    def fire_callbacks(event, *args)
+      @callbacks[event].nil? || @callbacks[event].all? { |h| h.call(*args) }
+    end
+
     def run
       log "Starting clock for #{@events.size} events: [ " + @events.map { |e| e.to_s }.join(' ') + " ]"
       loop do
@@ -52,15 +58,21 @@ module Clockwork
     end
 
     def tick(t=Time.now)
-      to_run = @events.select do |event|
-        event.time?(t)
-      end
+      if (fire_callbacks(:before_tick))
+        to_run = @events.select do |event|
+          event.time?(t)
+        end
 
-      to_run.each do |event|
-        log "Triggering '#{event}'"
-        event.run(t)
+        to_run.each do |event|
+          if (fire_callbacks(:before_run, event, t))
+            log "Triggering '#{event}'"
+            event.run(t)
+            fire_callbacks(:after_run, event, t)
+          end
+        end
       end
 
+      fire_callbacks(:after_tick)
       to_run
     end
 
@@ -87,5 +99,13 @@ module Clockwork
 
       options
     end
+    
+    def every_with_multiple_times(period, job, options={}, &block)
+      each_options = options.clone
+      options[:at].each do |at|
+        each_options[:at] = at
+        register(period, job, block, each_options)
+      end
+    end
   end
 end

data/test/at_test.rb

@@ -24,7 +24,7 @@ class AtTest < Test::Unit::TestCase
     assert !at.ready?(time_in_day(8, 21))
   end
 
-  test '**:20' do
+  test '**:20 with two stars' do
     at = Clockwork::At.parse('**:20')
 
     assert !at.ready?(time_in_day(15, 19))
@@ -36,7 +36,7 @@ class AtTest < Test::Unit::TestCase
     assert !at.ready?(time_in_day(16, 21))
   end
 
-  test '**:20' do
+  test '*:20 with one star' do
     at = Clockwork::At.parse('*:20')
 
     assert !at.ready?(time_in_day(15, 19))
@@ -48,6 +48,26 @@ class AtTest < Test::Unit::TestCase
     assert !at.ready?(time_in_day(16, 21))
   end
 
+  test '16:**' do
+    at = Clockwork::At.parse('16:**')
+
+    assert !at.ready?(time_in_day(15, 59))
+    assert  at.ready?(time_in_day(16, 00))
+    assert  at.ready?(time_in_day(16, 30))
+    assert  at.ready?(time_in_day(16, 59))
+    assert !at.ready?(time_in_day(17, 00))
+  end
+
+  test '8:**' do
+    at = Clockwork::At.parse('8:**')
+
+    assert !at.ready?(time_in_day(7, 59))
+    assert  at.ready?(time_in_day(8, 00))
+    assert  at.ready?(time_in_day(8, 30))
+    assert  at.ready?(time_in_day(8, 59))
+    assert !at.ready?(time_in_day(9, 00))
+  end
+
   test 'Saturday 12:00' do
     at = Clockwork::At.parse('Saturday 12:00')
 
@@ -57,7 +77,7 @@ class AtTest < Test::Unit::TestCase
     assert  at.ready?(Time.new(2010, 1, 9, 12, 00))
   end
 
-  test 'Saturday 12:00' do
+  test 'sat 12:00' do
     at = Clockwork::At.parse('sat 12:00')
 
     assert !at.ready?(Time.new(2010, 1, 1, 12, 00))

data/test/manager_test.rb

@@ -269,4 +269,74 @@ class ManagerTest < Test::Unit::TestCase
     end
   end
 
+  describe "callbacks" do
+    test "should not accept unknown callback name" do
+      assert_raise(RuntimeError, "Unsupported callback unknown_callback") do
+        @manager.on(:unknown_callback) do
+          true
+        end
+      end
+    end
+
+    test "should run before_tick callback once on tick" do
+      counter = 0
+      @manager.on(:before_tick) do
+        counter += 1
+      end
+      @manager.tick
+      assert_equal 1, counter
+    end
+
+    test "should not run events if before_tick returns false" do
+      @manager.on(:before_tick) do
+        false
+      end
+      @manager.every(1.second, 'myjob') { raise "should not run" }
+      @manager.tick
+    end
+
+    test "should run before_run twice if two events are registered" do
+      counter = 0
+      @manager.on(:before_run) do
+        counter += 1
+      end
+      @manager.every(1.second, 'myjob')
+      @manager.every(1.second, 'myjob2')
+      @manager.tick
+      assert_equal 2, counter
+    end
+
+    test "should run even jobs only" do
+      counter = 0
+      ran = false
+      @manager.on(:before_run) do
+        counter += 1
+        counter % 2 == 0
+      end
+      @manager.every(1.second, 'myjob') { raise "should not ran" }
+      @manager.every(1.second, 'myjob2') { ran = true }
+      @manager.tick
+      assert ran
+    end
+
+    test "should run after_run callback for each event" do
+      counter = 0
+      @manager.on(:after_run) do
+        counter += 1
+      end
+      @manager.every(1.second, 'myjob')
+      @manager.every(1.second, 'myjob2')
+      @manager.tick
+      assert_equal 2, counter
+    end
+
+    test "should run after_tick callback once" do
+      counter = 0
+      @manager.on(:after_tick) do
+        counter += 1
+      end
+      @manager.tick
+      assert_equal 1, counter
+    end
+  end
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clockwork
 version: !ruby/object:Gem::Version
-  version: 0.6.0
-  prerelease: 
+  version: 0.6.1
 platform: ruby
 authors:
 - Adam Wiggins
@@ -10,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-06 00:00:00.000000000 Z
+date: 2013-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -23,7 +21,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -31,23 +28,20 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -55,7 +49,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -63,65 +56,57 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: daemons
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: contest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: A scheduler process to replace cron, using a more flexible Ruby syntax
@@ -157,33 +142,26 @@ files:
 homepage: http://github.com/tomykaira/clockwork
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1040886093
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1040886093
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A scheduler process to replace cron.
 test_files:
 - test/at_test.rb