clockwork 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4da3864c6de51bceab841eca257ffbc2926525a3
-  data.tar.gz: ff3ff9e0e1bef436a100785f818e57253bcc6f1c
+  metadata.gz: aeec7e9d85ccbc4235df4e959852c62964bd756c
+  data.tar.gz: b17b8d59d78d23e19813fee904a5f32817566f4f
 SHA512:
-  metadata.gz: 0bbbb9668d0b1aa9526217188e50d6d5e44b493c25c7be369f98371038667434bbcd392a615ba73ec120001da0f0a89bb3faaf395245228484566029bdb6def5
-  data.tar.gz: dc8a6b4a47b174293f92e91066fb74d7c4ab1ad1310eb5c6c11d6706e381f8e435095e9b8d4f5ebbe8c9ed85bc7617f87b695c7153172a5f219c920e0997b91b
+  metadata.gz: 46e85795da235c9ad95081f33d871e58712fd37cfaca1ba02239722a8bbeb109aea00538c9e8a852ad8f752f5847a494098da15a7c6ec1e34daea1d9b23ac031
+  data.tar.gz: 68ba156bc2bd8400fe74f10420f543eeb547167b14bc35ef108357674074b2b8cd0e834daddfa04802425b88c08c1e9e307148ed84862075ed28ae068fa52644

data/.gitignore

@@ -2,3 +2,4 @@ pkg
 tmp
 /.bundle
 Gemfile.lock
+.ruby-version

data/README.md

@@ -327,6 +327,9 @@ own logger implementation you have to specify the `logger` configuration option.
 Clockwork wakes up once a second and performs its duties. To change the number of seconds Clockwork
 sleeps, set the `sleep_timeout` configuration option as shown below in the example.
 
+From 1.1.0, Clockwork does not accept `sleep_timeout` less than 1 seconds.
+This restriction is introduced to solve more severe bug [#135](https://github.com/tomykaira/clockwork/pull/135).
+
 ### :tz
 
 This is the default timezone to use for all events.  When not specified this defaults to the local
@@ -466,7 +469,7 @@ topography:
 * App server 1: 3 web (thin start), 3 workers (rake jobs:work), 1 clock (clockwork clock.rb)
 * App server 2: 3 web (thin start), 3 workers (rake jobs:work)
 
-You should use Monit, God, Upstart, or Inittab to keep your clock process
+You should use [Monit](http://mmonit.com/monit/), [God](https://github.com/mojombo/god), [Upstart](http://upstart.ubuntu.com/), or [Inittab](http://www.tldp.org/LDP/sag/html/config-init.html) to keep your clock process
 running the same way you keep your web and workers running.
 
 Daemonization
@@ -474,7 +477,7 @@ Daemonization
 
 Thanks to @fddayan, `clockworkd` executes clockwork script as a daemon.
 
-You will need the `daemons` gem to use `clockworkd`.  It is not automatically installed, please install by yourself.
+You will need the [daemons gem](https://github.com/ghazel/daemons) to use `clockworkd`.  It is not automatically installed, please install by yourself.
 
 Then,
 
@@ -482,7 +485,7 @@ Then,
 clockworkd -c YOUR_CLOCK.rb start
 ```
 
-For more details, see help shown by `clockworkd`.
+For more details, you can run `clockworkd -h`.
 
 Issues and Pull requests
 ------------------------

data/clockwork.gemspec

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

data/lib/clockwork/event.rb

@@ -58,7 +58,7 @@ module Clockwork
     end
 
     def elapsed_ready(t)
-      @last.nil? || (t - @last).to_i >= @period
+      @last.nil? || (t - @last.to_i).to_i >= @period
     end
 
     def validate_if_option(if_option)

data/lib/clockwork/manager.rb

@@ -17,6 +17,9 @@ module Clockwork
 
     def configure
       yield(config)
+      if config[:sleep_timeout] < 1
+        config[:logger].warn 'sleep_timeout must be >= 1 second'
+      end
     end
 
     def default_configuration
@@ -55,7 +58,8 @@ module Clockwork
       log "Starting clock for #{@events.size} events: [ #{@events.map(&:to_s).join(' ')} ]"
       loop do
         tick
-        sleep(config[:sleep_timeout])
+        interval = config[:sleep_timeout] - Time.now.subsec + 0.001
+        sleep(interval) if interval > 0
       end
     end
 

data/test/clockwork_test.rb

@@ -4,8 +4,10 @@ require 'mocha/setup'
 
 class ClockworkTest < Test::Unit::TestCase
   setup do
+    @log_output = StringIO.new
     Clockwork.configure do |config|
       config[:sleep_timeout] = 0
+      config[:logger] = Logger.new(@log_output)
     end
   end
 
@@ -13,17 +15,8 @@ class ClockworkTest < Test::Unit::TestCase
     Clockwork.clear!
   end
 
-  def set_string_io_logger
-    string_io = StringIO.new
-    Clockwork.configure do |config|
-      config[:logger] = Logger.new(string_io)
-    end
-    string_io
-  end
-
   test 'should run events with configured logger' do
     run = false
-    string_io = set_string_io_logger
     Clockwork.handler do |job|
       run = job == 'myjob'
     end
@@ -31,12 +24,11 @@ class ClockworkTest < Test::Unit::TestCase
     Clockwork.manager.expects(:loop).yields.then.returns
     Clockwork.run
     assert run
-    assert string_io.string.include?('Triggering')
+    assert @log_output.string.include?('Triggering')
   end
 
   test 'should log event correctly' do
     run = false
-    string_io = set_string_io_logger
     Clockwork.handler do |job|
       run = job == 'an event'
     end
@@ -44,13 +36,12 @@ class ClockworkTest < Test::Unit::TestCase
     Clockwork.manager.expects(:loop).yields.then.returns
     Clockwork.run
     assert run
-    assert string_io.string.include?("Triggering 'an event'")
+    assert @log_output.string.include?("Triggering 'an event'")
   end
 
   test 'should pass event without modification to handler' do
     event_object = Object.new
     run = false
-    string_io = set_string_io_logger
     Clockwork.handler do |job|
       run = job == event_object
     end
@@ -65,20 +56,19 @@ class ClockworkTest < Test::Unit::TestCase
     Clockwork.clear!
     Clockwork.configure do |config|
       config[:sleep_timeout] = 0
+      config[:logger] = Logger.new(@log_output)
     end
-    string_io = set_string_io_logger
     Clockwork.manager.expects(:loop).yields.then.returns
     Clockwork.run
-    assert string_io.string.include?('0 events')
+    assert @log_output.string.include?('0 events')
   end
 
   test 'should pass all arguments to every' do
     Clockwork.every(1.second, 'myjob', if: lambda { |_| false }) {  }
-    string_io = set_string_io_logger
     Clockwork.manager.expects(:loop).yields.then.returns
     Clockwork.run
-    assert string_io.string.include?('1 events')
-    assert !string_io.string.include?('Triggering')
+    assert @log_output.string.include?('1 events')
+    assert !@log_output.string.include?('Triggering')
   end
 
   test 'support module re-open style' do
@@ -86,7 +76,6 @@ class ClockworkTest < Test::Unit::TestCase
     module ::Clockwork
       every(1.second, 'myjob') { $called = true }
     end
-    set_string_io_logger
     Clockwork.manager.expects(:loop).yields.then.returns
     Clockwork.run
     assert $called

data/test/manager_test.rb

@@ -60,6 +60,14 @@ class ManagerTest < Test::Unit::TestCase
     assert_will_run(t+60*60*24*7)
   end
 
+  test "won't drift later and later" do
+    @manager.every(1.hour, 'myjob')
+
+    assert_will_run(Time.parse("10:00:00.5"))
+    assert_wont_run(Time.parse("10:59:59.999"))
+    assert_will_run(Time.parse("11:00:00.0"))
+  end
+
   test "aborts when no handler defined" do
     manager = Clockwork::Manager.new
     assert_raise(Clockwork::Manager::NoHandlerDefined) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clockwork
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Adam Wiggins
@@ -136,7 +136,6 @@ extra_rdoc_files:
 - README.md
 files:
 - ".gitignore"
-- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - LICENSE

data/.ruby-version

@@ -1 +0,0 @@
-2.1.0