clockwork 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6614568ab73c78b0be1866b355ba1cd288cce5a6
-  data.tar.gz: a083d36f8fc30fb7b55f86278b1fd1e3577d4915
+  metadata.gz: 8b02d894da4c82ef8a9799121d77b83390b0a27f
+  data.tar.gz: 7f70396d6f476bf30e3c8f7b1e82c66da165afb5
 SHA512:
-  metadata.gz: dffa0ee3bcd26a2febaafebac063f71a46857001654b3748b292601f4134a9f64c0186b626bb72bc4c4d39eaec1a41e3c162d6ca5b64d53de248176854cd7915
-  data.tar.gz: 169d1db6499306e74dd86c89767e92818ffcc3d55873ac9dd04ddec9fe8b2d5648cb685e1dfbac4d3ad7bff4e467fcd2046e9c4cb0c680aef079906b354fd76a
+  metadata.gz: 12574d7a801709ee5bc6d0215eab7c1c7fe8cfe227f641bee7a8d01c2f805eb6b5043b6ad052f5e4f97c12734b0ad575c8095b163a4ce39075c4dcda92f06aa6
+  data.tar.gz: 1bb1cea7c8346e9dcf98b76d582c5a54802fe1769ab1065fb8aaa1396767fb627040b7a9486daad52036bdc05eb6d3debfd15761a8fa500ba2e488a3379825df

data/.travis.yml

@@ -6,6 +6,7 @@ rvm:
   - 2.0.0
   - 2.1
   - 2.2
+  - ruby-2.3.1
   - jruby-19mode
   - # rbx-2.2.7
 gemfile:

data/README.md

@@ -1,8 +1,8 @@
-Clockwork - a clock process to replace cron [![Build Status](https://secure.travis-ci.org/tomykaira/clockwork.png?branch=master)](http://travis-ci.org/tomykaira/clockwork) [![Dependency Status](https://gemnasium.com/tomykaira/clockwork.png)](https://gemnasium.com/tomykaira/clockwork)
+Clockwork - a clock process to replace cron [![Build Status](https://api.travis-ci.org/Rykian/clockwork.png?branch=master)](https://travis-ci.org/Rykian/clockwork) [![Dependency Status](https://gemnasium.com/Rykian/clockwork.png)](https://gemnasium.com/Rykian/clockwork)
 ===========================================
 
 Cron is non-ideal for running scheduled application tasks, especially in an app
-deployed to multiple machines.  [More details.](http://adam.heroku.com/past/2010/4/13/rethinking_cron/)
+deployed to multiple machines.  [More details.](http://adam.herokuapp.com/past/2010/4/13/rethinking_cron/)
 
 Clockwork is a cron replacement.  It runs as a lightweight, long-running Ruby
 process which sits alongside your web processes (Mongrel/Thin) and your worker
@@ -69,8 +69,8 @@ to do the work.  It avoids locking by running as a single process, but this
 makes it impossible to parallelize.  For doing the work, you should be using a
 job queueing system, such as
 [Delayed Job](http://www.therailsway.com/2009/7/22/do-it-later-with-delayed-job),
-[Beanstalk/Stalker](http://adam.heroku.com/past/2010/4/24/beanstalk_a_simple_and_fast_queueing_backend/),
-[RabbitMQ/Minion](http://adam.heroku.com/past/2009/9/28/background_jobs_with_rabbitmq_and_minion/),
+[Beanstalk/Stalker](http://adam.herokuapp.com/past/2010/4/24/beanstalk_a_simple_and_fast_queueing_backend/),
+[RabbitMQ/Minion](http://adam.herokuapp.com/past/2009/9/28/background_jobs_with_rabbitmq_and_minion/),
 [Resque](http://github.com/blog/542-introducing-resque), or
 [Sidekiq](https://github.com/mperham/sidekiq).  This design allows a
 simple clock process with no locks, but also offers near infinite horizontal
@@ -92,7 +92,7 @@ end
 Using a queueing system which doesn't require that your full application be
 loaded is preferable, because the clock process can keep a tiny memory
 footprint.  If you're using DJ or Resque, however, you can go ahead and load
-your full application enviroment, and use per-event blocks to call DJ or Resque
+your full application environment, and use per-event blocks to call DJ or Resque
 enqueue methods.  For example, with DJ/Rails:
 
 ```ruby
@@ -162,7 +162,7 @@ When one of the events is ready to be run (based on it's `frequency`, and possib
 
     - (optionally) `at` return any acceptable clockwork `:at` string
 
-    - (optionally) `name` returning the name for the event (used to identify it in the Clcockwork output)
+    - (optionally) `name` returning the name for the event (used to identify it in the Clockwork output)
 
     - (optionally) `if?` returning either true or false, depending on whether the database event should run at the given time (this method will be passed the time as a parameter, much like the standard clockwork `:if`)
 
@@ -463,8 +463,8 @@ every(1.day, 'check.leap.year') do
 end
 ```
 
-In addition, Clockwork also supports `:before_tick` and `after_tick` callbacks.
-They are optional, and run every tick (a tick being whatever your `:sleep_timeout`
+In addition, Clockwork also supports `:before_tick`, `:after_tick`, `:before_run`, and `:after_run` callbacks.
+All callbacks are optional. The `tick` callbacks run every tick (a tick being whatever your `:sleep_timeout`
 is set to, default is 1 second):
 
 ```ruby
@@ -475,6 +475,14 @@ end
 on(:after_tick) do
   puts "tock"
 end
+
+on(:before_run) do |event, t|
+  puts "job_started: #{event}"
+end
+
+on(:after_run) do |event, t|
+  puts "job_finished: #{event}"
+end
 ```
 
 Finally, you can use tasks synchronised from a database as described in detail above:

data/bin/clockwork

@@ -11,9 +11,4 @@ file = "./#{file}" unless file.match(/^[\/.]/)
 
 require file
 
-trap('INT') do
-  puts "\rExiting"
-  exit
-end
-
 Clockwork::run

data/clockwork.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "clockwork"
-  s.version = "2.0.0"
+  s.version = "2.0.1"
 
   s.authors = ["Adam Wiggins", "tomykaira"]
   s.license = 'MIT'
@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = [
     "README.md"
   ]
-  s.homepage = "http://github.com/tomykaira/clockwork"
+  s.homepage = "http://github.com/Rykian/clockwork"
   s.summary = "A scheduler process to replace cron."
 
   s.files         = `git ls-files`.split($/)
@@ -25,4 +25,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "daemons"
   s.add_development_dependency "minitest", "~> 5.8"
   s.add_development_dependency "mocha"
+  s.add_development_dependency "test-unit"
 end

data/lib/clockwork/manager.rb

@@ -9,6 +9,9 @@ module Clockwork
       @callbacks = {}
       @config = default_configuration
       @handler = nil
+      @mutex = Mutex.new
+      @condvar = ConditionVariable.new
+      @finish = false
     end
 
     def thread_available?
@@ -60,10 +63,68 @@ module Clockwork
 
     def run
       log "Starting clock for #{@events.size} events: [ #{@events.map(&:to_s).join(' ')} ]"
-      loop do
-        tick
-        interval = config[:sleep_timeout] - Time.now.subsec + 0.001
-        sleep(interval) if interval > 0
+
+      sig_read, sig_write = IO.pipe
+
+      %w[INT TERM HUP].each do |sig|
+        trap sig do
+          sig_write.puts(sig)
+        end
+      end
+
+      run_tick_loop
+
+      while io = IO.select([sig_read])
+        sig = io.first[0].gets.chomp
+        handle_signal(sig)
+      end
+    end
+
+    def handle_signal(sig)
+      logger.debug "Got #{sig} signal"
+      case sig
+      when 'INT'
+        shutdown
+      when 'TERM'
+        # Heroku sends TERM signal, and waits 10 seconds before exit
+        graceful_shutdown
+      when 'HUP'
+        graceful_shutdown
+      end
+    end
+
+    def shutdown
+      logger.info 'Shutting down'
+      stop_tick_loop
+      exit(0)
+    end
+
+    def graceful_shutdown
+      logger.info 'Gracefully shutting down'
+      stop_tick_loop
+      wait_tick_loop_finishes
+      exit(0)
+    end
+
+    def stop_tick_loop
+      @finish = true
+    end
+
+    def wait_tick_loop_finishes
+      @mutex.synchronize do # wait by synchronize
+        @condvar.signal
+      end
+    end
+
+    def run_tick_loop
+      Thread.new do
+        @mutex.synchronize do
+          until @finish
+            tick
+            interval = config[:sleep_timeout] - Time.now.subsec + 0.001
+            @condvar.wait(@mutex, interval) if interval > 0
+          end
+        end
       end
     end
 
@@ -81,6 +142,10 @@ module Clockwork
       events
     end
 
+    def logger
+      config[:logger]
+    end
+
     def log_error(e)
       config[:logger].error(e)
     end

data/test/clockwork_test.rb

@@ -9,6 +9,7 @@ describe Clockwork do
       config[:sleep_timeout] = 0
       config[:logger] = Logger.new(@log_output)
     end
+    IO.stubs(:select)
   end
 
   after do
@@ -21,7 +22,7 @@ describe Clockwork do
       run = job == 'myjob'
     end
     Clockwork.every(1.minute, 'myjob')
-    Clockwork.manager.expects(:loop).yields.then.returns
+    Clockwork.manager.stubs(:run_tick_loop).returns(Clockwork.manager.tick)
     Clockwork.run
 
     assert run
@@ -34,7 +35,7 @@ describe Clockwork do
       run = job == 'an event'
     end
     Clockwork.every(1.minute, 'an event')
-    Clockwork.manager.expects(:loop).yields.then.returns
+    Clockwork.manager.stubs(:run_tick_loop).returns(Clockwork.manager.tick)
     Clockwork.run
     assert run
     assert @log_output.string.include?("Triggering 'an event'")
@@ -47,7 +48,7 @@ describe Clockwork do
       run = job == event_object
     end
     Clockwork.every(1.minute, event_object)
-    Clockwork.manager.expects(:loop).yields.then.returns
+    Clockwork.manager.stubs(:run_tick_loop).returns(Clockwork.manager.tick)
     Clockwork.run
     assert run
   end
@@ -59,14 +60,14 @@ describe Clockwork do
       config[:sleep_timeout] = 0
       config[:logger] = Logger.new(@log_output)
     end
-    Clockwork.manager.expects(:loop).yields.then.returns
+    Clockwork.manager.stubs(:run_tick_loop).returns(Clockwork.manager.tick)
     Clockwork.run
     assert @log_output.string.include?('0 events')
   end
 
   it 'should pass all arguments to every' do
     Clockwork.every(1.second, 'myjob', if: lambda { |_| false }) {  }
-    Clockwork.manager.expects(:loop).yields.then.returns
+    Clockwork.manager.stubs(:run_tick_loop).returns(Clockwork.manager.tick)
     Clockwork.run
     assert @log_output.string.include?('1 events')
     assert !@log_output.string.include?('Triggering')
@@ -77,7 +78,7 @@ describe Clockwork do
     module ::Clockwork
       every(1.second, 'myjob') { $called = true }
     end
-    Clockwork.manager.expects(:loop).yields.then.returns
+    Clockwork.manager.stubs(:run_tick_loop).returns(Clockwork.manager.tick)
     Clockwork.run
     assert $called
   end

data/test/samples/signal_test.rb

@@ -0,0 +1,19 @@
+require 'clockwork'
+
+module Clockwork
+  LOGFILE = File.expand_path('../../tmp/signal_test.log', __FILE__)
+
+  handler do |job|
+    File.write(LOGFILE, 'start')
+    sleep 0.1
+    File.write(LOGFILE, 'done')
+  end
+
+  configure do |config|
+    config[:sleep_timeout] = 0
+    config[:logger] = Logger.new(StringIO.new)
+  end
+
+  every(1.seconds, 'run.me.every.1.seconds')
+end
+

data/test/signal_test.rb

@@ -0,0 +1,34 @@
+require 'test/unit'
+require 'mocha/setup'
+require 'fileutils'
+
+class SignalTest < Test::Unit::TestCase
+  CMD     = File.expand_path('../../bin/clockwork', __FILE__)
+  SAMPLE  = File.expand_path('../samples/signal_test.rb', __FILE__)
+  LOGFILE = File.expand_path('../tmp/signal_test.log', __FILE__)
+
+  setup do
+    FileUtils.mkdir_p(File.dirname(LOGFILE))
+    @pid = spawn(CMD, SAMPLE)
+    until File.exist?(LOGFILE)
+      sleep 0.1
+    end
+  end
+
+  teardown do
+    FileUtils.rm_r(File.dirname(LOGFILE))
+  end
+
+  test 'should gracefully shutdown with SIGTERM' do
+    Process.kill(:TERM, @pid)
+    sleep 0.2
+    assert_equal 'done', File.read(LOGFILE)
+  end
+
+  test 'should forcely shutdown with SIGINT' do
+    Process.kill(:INT, @pid)
+    sleep 0.2
+    assert_equal 'start', File.read(LOGFILE)
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clockwork
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Adam Wiggins
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-15 00:00:00.000000000 Z
+date: 2017-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo
@@ -109,6 +109,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 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:
@@ -152,7 +166,9 @@ files:
 - test/database_events/test_helpers.rb
 - test/event_test.rb
 - test/manager_test.rb
-homepage: http://github.com/tomykaira/clockwork
+- test/samples/signal_test.rb
+- test/signal_test.rb
+homepage: http://github.com/Rykian/clockwork
 licenses:
 - MIT
 metadata: {}
@@ -185,3 +201,5 @@ test_files:
 - test/database_events/test_helpers.rb
 - test/event_test.rb
 - test/manager_test.rb
+- test/samples/signal_test.rb
+- test/signal_test.rb