rufus-scheduler 2.0.1 → 2.0.2

data/CHANGELOG.txt

@@ -2,6 +2,15 @@
 = rufus-scheduler CHANGELOG.txt
 
 
+== rufus-scheduler - 2.0.2    not yet released
+
+- unified JobQueue and CronJobQueue, and handed @last_second management to the
+  latter
+- #trigger_block method for easier override
+- passing :job => job among Schedulable trigger parameters
+
+
+== rufus-scheduler - 2.0.1    released 2009/05/07
 == rufus-scheduler - 2.0.0    released 2009/05/07
 
 - initial release

data/CREDITS.txt

@@ -10,6 +10,7 @@
 
 == Feedback
 
+- Aldric (readme errors)
 - Kenneth Kalmer (daemon-kit)
 - Chris Evans, :timeout tests on JRuby
 - Tim Uckun, :timeout concept

data/README.rdoc

@@ -42,7 +42,7 @@ The usage is similar to the one of the old rufus-scheduler. There are a few diff
   end
 
   scheduler.cron '0 22 * * 1-5' do
-    # every day of the week at 00:22
+    # every day of the week at 22:00 (10pm)
     puts 'activate security system'
   end
 
@@ -50,10 +50,6 @@ The usage is similar to the one of the old rufus-scheduler. There are a few diff
     puts 'check blood pressure'
   end
 
-  # ...
-
-  scheduler.stop
-
 
 This code summons a plain version of the scheduler, this can be made more explicit via :
 

data/TODO.txt

@@ -49,3 +49,6 @@
 [o] check :blocking and every (reschedule blocking...)
 [o] document :thread_name scheduler option
 
+[o] unify cron_jobs#trigger_matching_jobs(now) and jobs#job_to_trigger
+[o] pluggable job queues
+

data/lib/rufus/sc/jobqueues.rb

@@ -50,16 +50,14 @@ module Scheduler
       @jobs = []
     end
 
-    # Returns the next job to trigger. Returns nil if none eligible.
+    # Triggers all the jobs that are scheduled for 'now'.
     #
-    def job_to_trigger
+    def trigger_matching_jobs
 
-      @mutex.synchronize do
-        if @jobs.size > 0 && Time.now.to_f >= @jobs.first.at
-          @jobs.shift
-        else
-          nil
-        end
+      now = Time.now
+
+      while job = job_to_trigger(now)
+        job.trigger
       end
     end
 
@@ -104,51 +102,56 @@ module Scheduler
     protected
 
     def delete (job_id)
+
       j = @jobs.find { |j| j.job_id == job_id }
       @jobs.delete(j) if j
-      j
+    end
+
+    # Returns the next job to trigger. Returns nil if none eligible.
+    #
+    def job_to_trigger (now)
+
+      @mutex.synchronize do
+        if @jobs.size > 0 && now.to_f >= @jobs.first.at
+          @jobs.shift
+        else
+          nil
+        end
+      end
     end
   end
 
   #
   # Tracking cron jobs.
   #
-  # (mostly synchronizing access to the map of cron jobs)
-  #
-  class CronJobQueue
+  class CronJobQueue < JobQueue
 
     def initialize
 
-      @mutex = Mutex.new
-      @jobs = {}
+      super
+      @last_cron_second = nil
     end
 
-    def unschedule (job_id)
+    def trigger_matching_jobs
 
-      @mutex.synchronize { @jobs.delete(job_id) }
-    end
+      now = Time.now
 
-    def trigger_matching_jobs (now)
+      return if now.sec == @last_cron_second
+      @last_cron_second = now.sec
+        #
+        # ensuring the crons are checked within 1 second (not 1.2 second)
 
-      js = @mutex.synchronize { @jobs.values }
-        # maybe this sync is a bit paranoid
+      jobs = @mutex.synchronize { @jobs.dup }
 
-      js.each { |job| job.trigger_if_matches(now) }
+      jobs.each { |job| job.trigger_if_matches(now) }
     end
 
     def << (job)
 
-      @mutex.synchronize { @jobs[job.job_id] = job }
-    end
-
-    def size
-
-      @jobs.size
-    end
-
-    def to_h
-
-      @jobs.dup
+      @mutex.synchronize do
+        delete(job.job_id)
+        @jobs << job
+      end
     end
   end
 

data/lib/rufus/sc/jobs.rb

@@ -33,7 +33,7 @@ module Scheduler
 
     # A reference to the scheduler owning this job
     #
-    attr_reader :scheduler
+    attr_accessor :scheduler
 
     # The initial, raw, scheduling info (at / in / every / cron)
     #
@@ -127,13 +127,7 @@ module Scheduler
 
         begin
 
-          #args = prepare_args
-          #@block.call(*args)
-
-          #@block.call(self)
-
-          @block.respond_to?(:call) ?
-            @block.call(self) : @block.trigger(@params)
+          trigger_block
 
           @job_thread = nil
 
@@ -158,6 +152,15 @@ module Scheduler
       end
     end
 
+    # Simply encapsulating the block#call/trigger operation, for easy
+    # override.
+    #
+    def trigger_block
+
+      @block.respond_to?(:call) ?
+        @block.call(self) : @block.trigger(@params.merge(:job => self))
+    end
+
     # Unschedules this job.
     #
     def unschedule

data/lib/rufus/sc/scheduler.rb

@@ -33,7 +33,7 @@ module Rufus::Scheduler
 
   # This gem's version
   #
-  VERSION = '2.0.1'
+  VERSION = '2.0.2'
 
   #
   # It's OK to pass an object responding to :trigger when scheduling a job
@@ -104,8 +104,8 @@ module Rufus::Scheduler
 
       @options = opts
 
-      @jobs = JobQueue.new
-      @cron_jobs = CronJobQueue.new
+      @jobs = get_queue(:at, opts)
+      @cron_jobs = get_queue(:cron, opts)
 
       @frequency = @options[:frequency] || 0.330
     end
@@ -207,6 +207,7 @@ module Rufus::Scheduler
         puts '=' * 80
         puts "scheduler caught exception :"
         puts exception
+        exception.backtrace.each { |l| puts l }
         puts '=' * 80
       end
     end
@@ -245,6 +246,23 @@ module Rufus::Scheduler
 
     protected
 
+    # Returns a job queue instance.
+    #
+    # (made it into a method for easy override)
+    #
+    def get_queue (type, opts)
+
+      q = if type == :cron
+        opts[:cron_job_queue] || Rufus::Scheduler::CronJobQueue.new
+      else
+        opts[:job_queue] || Rufus::Scheduler::JobQueue.new
+      end
+
+      q.scheduler = self if q.respond_to?(:scheduler=)
+
+      q
+    end
+
     def combine_opts (schedulable, opts)
 
       if schedulable.respond_to?(:trigger)
@@ -263,28 +281,9 @@ module Rufus::Scheduler
     # triggered.
     #
     def step
-      cron_step
-      at_step
-    end
-
-    # calls every second
-    #
-    def cron_step
 
-      now = Time.now
-      return if now.sec == @last_cron_second
-      @last_cron_second = now.sec
-        #
-        # ensuring the crons are checked within 1 second (not 1.2 second)
-
-      @cron_jobs.trigger_matching_jobs(now)
-    end
-
-    def at_step
-
-      while job = @jobs.job_to_trigger
-        job.trigger
-      end
+      @cron_jobs.trigger_matching_jobs
+      @jobs.trigger_matching_jobs
     end
 
     def add_job (job)
@@ -374,6 +373,27 @@ module Rufus::Scheduler
   #  # use a Queue and a worker thread for the 'blocking' jobs
   #end
 
+  #
+  # A rufus-scheduler that steps only when the ruby process receives the
+  # 10 / USR1 signal.
+  #
+  class SignalScheduler < SchedulerCore
+
+    def initialize (opts={})
+
+      super(opts)
+
+      trap(@options[:signal] || 10) do
+        step
+      end
+    end
+
+    def stop
+
+      trap(@options[:signal] || 10)
+    end
+  end
+
   #
   # A rufus-scheduler that uses an EventMachine periodic timer instead of a
   # loop.
@@ -386,7 +406,7 @@ module Rufus::Scheduler
         'EventMachine missing, "require \'eventmachine\'" might help'
       ) unless defined?(EM)
 
-      super
+      super(opts)
     end
 
     def start

data/lib/rufus/scheduler.rb

@@ -49,7 +49,7 @@ module Rufus::Scheduler
   #
   def self.is_cron_string (s)
 
-    s.match('.+ .+ .+ .+ .+') # well...
+    s.match(/.+ .+ .+ .+ .+/) # well...
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rufus-scheduler
 version: !ruby/object:Gem::Version 
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors: 
 - John Mettraux
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-07 00:00:00 +09:00
+date: 2009-10-28 00:00:00 +09:00
 default_executable: 
 dependencies: []
 
@@ -62,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: rufus
-rubygems_version: 1.3.2
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: job scheduler for Ruby (at, cron, in and every jobs)