zscheduler 0.0.3 → 0.0.4

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjYwMDdkYjY2MjM2MzA5ZTc1ODJiZmI4MWZjMzE2ZDgyYjgzMGQxYg==
+  data.tar.gz: !binary |-
+    ZmYzMjA3MmQ1NDAzNjk0NjcxYjEwMTQwZDU4MjY3NzM1NGRjOTFjNw==
+SHA512:
+  metadata.gz: !binary |-
+    ZmNlZTYxOTQyOWI5YjcyOWQ3ZGZiOTQyNmZlNjg0NmQ5NjExYzNmYTI4Njdm
+    MTBkN2MwZDE2OTI2YWI1OWQ4Njc4NzhlOGI3YTM3OTc2OTg5Yzg0ZjZjODlk
+    MWY0YTg5MTZmODQyMmIyMTQzMTJkYzhkYzNjZTQzMGQ1NjVlOTI=
+  data.tar.gz: !binary |-
+    YzViNTMxNGJlNjVkOGNiOWM1YTFlZDkyYjRmYWI1MDBiZTcxNzMyZDEwMjI0
+    NWNiNzBiZmMzMmYzYmQyNzYwYzhiYmIyZGUwNzI1NmU1YWZhNDY4MzgyODBi
+    MWJkNTQxZWY1ZDljOTE3N2FjMGZiODJkYzVhZWNjYmY0NzhmZTY=

data/lib/zscheduler/version.rb

@@ -1,3 +1,3 @@
 module Zscheduler
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/zscheduler.rb

@@ -3,34 +3,115 @@ require 'zscheduler/version'
 
 module Zscheduler
   class << self
+    # EM::Timer, EM::PeriodicTimer wrapper
+    class Timer < Struct.new(:timer)
+      # Cancel timer
+      def cancel
+        self.timer.cancel
+      end
+    end
 
+    # Start new scheduler
+    # @param [Hash] options
+    # @option options [True,False] :now (false) execute the block now
+    # @option options [True,False] :on_shutdown (false) execute the block on shutdown
+    # @option options [True,False] :on_thread (false) execute the block on a separated thread
+    # @option options [Time] :start_at (nil) start the scheduler in a given time
+    # @option options [Time] :start_in (nil) start the scheduler in a given delay ( seconds )
+    # @return [Timer] EventMachine timer wrapper
+    # @example
+    #   # Simple timer
+    #   Zscheduler.every(10) do
+    #     puts "Running every 10 seconds"
+    #   end
+    #
+    #   # Run the block and then start the scheduler
+    #   Zscheduler.every(10,now: true) do
+    #     puts "Running every 10 seconds"
+    #   end
+    #
+    #   # Run the block every 10 seconds and on shutdown
+    #   Zscheduler.every(10,on_shutdown: true) do
+    #     puts "Running every 10 seconds and on shutdown"
+    #   end
+    #
+    #   # Start the scheduler in a given time
+    #   Zscheduler.every(10,start_at: Time.now + 5) do
+    #     puts "Will run 5 seconds from now and then for every 10 seconds"
+    #   end
+    #
+    #   Zscheduler.every(10,start_in: 5) do
+    #     puts "Will run 5 seconds from now and then for every 10 seconds"
+    #   end
+    #
+    #   # Run the block on a separated thread
+    #   Zscheduler.every(10,on_thread: true) do
+    #     puts "I'm running on a separated thread"
+    #   end
+    #
     def every(frequency,options = {}, &block)
       block_given? or raise ArgumentError, "no block was given..."
+      start_reactor
 
-      reactor_running? or start_reactor
+      add_shutdown_hook(&block) if options[:on_shutdown]
+      block.call if options[:immediately] || options[:now]
 
-      add_shutdown_hook &block if options[:on_shutdown]
-      block.call if options[:immediately]
+      options[:start_in] = (options[:start_at] - Time.now) if options[:start_at]
 
-      timers.push EM::PeriodicTimer.new(Integer frequency) do
-        options[:on_thread] ? Thread.new(&block) : block.call
+      action = proc { options[:on_thread] ? Thread.new(&block) : block.call }
+      periodic = proc { EM::PeriodicTimer.new(frequency.to_i,&action) }
+
+      obj = Timer.new
+      obj.timer = if options[:start_in]
+        EM::Timer.new(options[:start_in]) do
+          action.call
+          obj.timer = periodic.call
+        end
+      else
+        periodic.call
       end
 
-      timers.last
+      timers.push obj
+      obj
     end
 
+    # Run callback once
+    # @param [Time,Integer] seconds
+    # @example
+    #   Zscheduler.once(Time.now + 10) do
+    #     puts "I'm running 10 seconds from now"
+    #   end
+    #
+    #   # Same as above
+    #   Zscheduler.once(10) do
+    #     puts "I'm running 10 seconds from now"
+    #   end
+    def once(seconds, &block)
+      start_reactor
+      seconds = (seconds - Time.now) if seconds.kind_of?(Time)
+      timers.push(Timer.new(EM::Timer.new(seconds.to_i,&block))).last
+    end
+
+    # Stop the scheduler, cancel all timers and run all the shutdown hooks
     def stop
       timers.each(&:cancel)
       shutdown_hooks.each(&:call)
       wrapper and EM.stop
     end
 
-    alias_method :showdown, :stop
+    alias_method :shutdown, :stop
 
+    # Add a new shutdown hook
+    # @example
+    #   Zscheduler.add_shutdown_hook do
+    #     puts "someone called to Zscheduler.stop"
+    #   end
+    #   Zscheduler.stop
     def add_shutdown_hook(&block)
       shutdown_hooks.push block
     end
 
+    # Sleep until Zscheduler stops
     def join
       (wrapper or EM.reactor_thread).join
     end
@@ -38,13 +119,10 @@ module Zscheduler
     private
 
     def start_reactor
-      @wrapper = Thread.new { EventMachine.run }
+      return if EM.reactor_running?
+      @wrapper = Thread.new(&EM.method(:run))
       wrapper.abort_on_exception = true
-      Thread.pass until reactor_running?
-    end
-
-    def reactor_running?
-      EventMachine.reactor_running?
+      Thread.pass until EM.reactor_running?
     end
 
     def wrapper

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: zscheduler
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.0.4
 platform: ruby
 authors:
 - Eran Barak Levi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-09 00:00:00.000000000 Z
+date: 2014-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,26 +35,26 @@ files:
 - lib/zscheduler.rb
 homepage: http://github.com/eranb/zscheduler
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.8.5
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: zscheduler
-rubygems_version: 1.8.25
+rubygems_version: 2.1.9
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: minimalistic scheduler on top of event-machine
 test_files: []
+has_rdoc: