rufus-scheduler 1.0.14 → 2.0.0

data/lib/rufus/scheduler.rb

@@ -1,3 +1,55 @@
+#--
+# Copyright (c) 2006-2009, John Mettraux, jmettraux@gmail.com
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+# Made in Japan.
+#++
 
-require 'rufus/scheduler/scheduler'
+
+require 'rufus/sc/scheduler'
+
+
+module Rufus::Scheduler
+
+  # A quick way to get a scheduler up an running
+  #
+  #   require 'rubygems'
+  #   s = Rufus::Scheduler.start_new
+  #
+  # If EventMachine is present and running will create an EmScheduler, else
+  # it will create a PlainScheduler instance.
+  #
+  def self.start_new (opts={})
+
+    if defined?(EM) and EM.reactor_running?
+      EmScheduler.start_new(opts)
+    else
+      PlainScheduler.start_new(opts)
+    end
+  end
+
+  # Returns true if the given string seems to be a cron string.
+  #
+  def self.is_cron_string (s)
+
+    s.match('.+ .+ .+ .+ .+') # well...
+  end
+end
 

data/spec/spec.rb

@@ -0,0 +1,14 @@
+
+#
+# specifying rufus-scheduler
+#
+# Fri Mar 20 22:54:46 JST 2009
+#
+
+specs = Dir["#{File.dirname(__FILE__)}/*_spec.rb"]
+
+#specs = specs - [ 'spec/stress_schedule_unschedule_spec.rb' ]
+  # this spec was a bit longish (11m) now it's OK (66.78s)
+
+specs.each { |path| load(path) }
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rufus-scheduler
 version: !ruby/object:Gem::Version 
-  version: 1.0.14
+  version: 2.0.0
 platform: ruby
 authors: 
 - John Mettraux
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-01 00:00:00 +09:00
+date: 2009-05-07 00:00:00 +09:00
 default_executable: 
 dependencies: []
 
@@ -20,23 +20,26 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README.txt
+- README.rdoc
 - CHANGELOG.txt
 - CREDITS.txt
+- LICENSE.txt
 files: 
 - lib/rufus/otime.rb
-- lib/rufus/scheduler/cronline.rb
-- lib/rufus/scheduler/jobs.rb
-- lib/rufus/scheduler/otime.rb
-- lib/rufus/scheduler/scheduler.rb
+- lib/rufus/sc/cronline.rb
+- lib/rufus/sc/jobqueues.rb
+- lib/rufus/sc/jobs.rb
+- lib/rufus/sc/rtime.rb
+- lib/rufus/sc/scheduler.rb
 - lib/rufus/scheduler.rb
 - lib/rufus-scheduler.rb
 - CHANGELOG.txt
 - CREDITS.txt
 - LICENSE.txt
-- README.txt
+- TODO.txt
+- README.rdoc
 has_rdoc: true
-homepage: http://openwferu.rubyforge.org/scheduler.html
+homepage: http://rufus.rubyforge.org/
 licenses: []
 
 post_install_message: 
@@ -62,6 +65,6 @@ rubyforge_project: rufus
 rubygems_version: 1.3.2
 signing_key: 
 specification_version: 3
-summary: scheduler for Ruby (at, cron and every jobs), formerly known as 'openwferu-scheduler'
+summary: job scheduler for Ruby (at, cron, in and every jobs)
 test_files: 
-- test/test.rb
+- spec/spec.rb

data/README.txt

@@ -1,118 +0,0 @@
-
-= rufus-scheduler
-
-This gem was formerly known as 'openwferu-scheduler'. It has been repackaged as 'rufus-scheduler'. Old 'require' paths have been kept for backward compatibility (no need to update your code).
-
-The new license is MIT (not much of a change, the previous license was BSD).
-
-
-== getting it
-
-    sudo gem install rufus-scheduler
-
-or at
-
-http://rubyforge.org/frs/?group_id=4812
-
-
-== usage
-
-(the rdoc is at http://rufus.rubyforge.org/rufus-scheduler/)
-
-some examples :
-
-    require 'rubygems'
-    require 'rufus/scheduler'
-
-    scheduler = Rufus::Scheduler.start_new
-
-    scheduler.in("3d") do
-      regenerate_monthly_report()
-    end
-      #
-      # will call the regenerate_monthly_report method
-      # in 3 days from now
-
-     scheduler.every "10m10s" do
-       check_score(favourite_team) # every 10 minutes and 10 seconds
-     end
-
-     scheduler.cron "0 22 * * 1-5" do
-       log.info "activating security system..."
-       activate_security_system()
-     end
-
-     job_id = scheduler.at "Sun Oct 07 14:24:01 +0900 2009" do
-       init_self_destruction_sequence()
-     end
-
-     scheduler.join # join the scheduler (prevents exiting)
-
-
-For all the scheduling related information, see the Rufus::Scheduler class rdoc itself (http://rufus.rubyforge.org/rufus-scheduler/classes/Rufus/Scheduler.html) or the original OpenWFEru scheduler documentation at http://openwferu.rubyforge.org/scheduler.html
-
-Apart from scheduling, There are also two interesting methods in this gem, they are named parse_time_string and to_time_string :
-
-    require 'rubygems'
-    require 'rufus/otime' # gem 'rufus_scheduler'
-
-    Rufus.parse_time_string "500"        # => 0.5
-    Rufus.parse_time_string "1000"       # => 1.0
-    Rufus.parse_time_string "1h"         # => 3600.0
-    Rufus.parse_time_string "1h10s"      # => 3610.0
-    Rufus.parse_time_string "1w2d"       # => 777600.0
-
-    Rufus.to_time_string 60                   # => '1m'
-    Rufus.to_time_string 3661                 # => '1h1m1s'
-    Rufus.to_time_string 7 * 24 * 3600        # => '1w'
-
-
-Something about the rufus-scheduler, threads and ActiveRecord connections (warning : I'm mostly clueless about Rails) :
-
-http://jmettraux.wordpress.com/2008/09/14/the-scheduler-and-the-active_record/
-
-
-== dependencies
-
-None.
-
-
-== mailing list
-
-On the rufus-ruby list[http://groups.google.com/group/rufus-ruby] :
-
-    http://groups.google.com/group/rufus-ruby
-
-
-== issue tracker
-
-http://rubyforge.org/tracker/?atid=18584&group_id=4812&func=browse
-
-
-== irc
-
-irc.freenode.net #ruote
-
-
-== source
-
-http://github.com/jmettraux/rufus-scheduler
-
-    git clone git://github.com/jmettraux/rufus-scheduler.git
-
-
-== author
-
-John Mettraux, jmettraux@gmail.com
-http://jmettraux.wordpress.com
-
-
-== the rest of Rufus
-
-http://rufus.rubyforge.org
-
-
-== license
-
-MIT
-

data/lib/rufus/scheduler/jobs.rb

@@ -1,334 +0,0 @@
-#--
-# Copyright (c) 2006-2009, John Mettraux, jmettraux@gmail.com
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#
-# Made in Japan.
-#++
-
-
-module Rufus
-
-  JOB_ID_LOCK = Mutex.new
-
-  #
-  # The parent class for scheduled jobs.
-  #
-  class Job
-
-    @@last_given_id = 0
-      #
-      # as a scheduler is fully transient, no need to
-      # have persistent ids, a simple counter is sufficient
-
-    #
-    # The identifier for the job
-    #
-    attr_accessor :job_id
-
-    #
-    # An array of tags
-    #
-    attr_accessor :tags
-
-    #
-    # The block to execute at trigger time
-    #
-    attr_accessor :block
-
-    #
-    # A reference to the scheduler
-    #
-    attr_reader :scheduler
-
-    #
-    # Keeping a copy of the initialization params of the job.
-    #
-    attr_reader :params
-
-    #
-    # if the job is currently executing, this field points to
-    # the 'trigger thread'
-    #
-    attr_reader :trigger_thread
-
-
-    def initialize (scheduler, job_id, params, &block)
-
-      @scheduler = scheduler
-      @block = block
-
-      if job_id
-        @job_id = job_id
-      else
-        JOB_ID_LOCK.synchronize do
-          @job_id = @@last_given_id
-          @@last_given_id = @job_id + 1
-        end
-      end
-
-      @params = params
-
-      #@tags = Array(tags).collect { |tag| tag.to_s }
-        # making sure we have an array of String tags
-
-      @tags = Array(params[:tags])
-        # any tag is OK
-    end
-
-    #
-    # Returns true if this job sports the given tag
-    #
-    def has_tag? (tag)
-
-      @tags.include?(tag)
-    end
-
-    #
-    # Removes (cancels) this job from its scheduler.
-    #
-    def unschedule
-
-      @scheduler.unschedule(@job_id)
-    end
-
-    #
-    # Triggers the job (in a dedicated thread).
-    #
-    def trigger
-
-      t = Thread.new do
-
-        @trigger_thread = Thread.current
-          # keeping track of the thread
-
-        begin
-
-          do_trigger
-
-        rescue Exception => e
-
-          @scheduler.send(:log_exception, e)
-        end
-
-        #@trigger_thread = nil if @trigger_thread == Thread.current
-        @trigger_thread = nil
-          # overlapping executions, what to do ?
-      end
-
-      if t.alive? and (to = @params[:timeout])
-        @scheduler.in(to, :tags => 'timeout') do
-          @trigger_thread.raise(Rufus::TimeOutError) if t.alive?
-        end
-      end
-    end
-
-    def call_block
-
-      args = case @block.arity
-        when 0 then []
-        when 1 then [ @params ]
-        when 2 then [ @job_id, @params ]
-        else [ @job_id, schedule_info, @params ]
-      end
-
-      @block.call(*args)
-    end
-  end
-
-  #
-  # An 'at' job.
-  #
-  class AtJob < Job
-
-    #
-    # The float representation (Time.to_f) of the time at which
-    # the job should be triggered.
-    #
-    attr_accessor :at
-
-
-    def initialize (scheduler, at, at_id, params, &block)
-
-      super(scheduler, at_id, params, &block)
-      @at = at
-    end
-
-    #
-    # Returns the Time instance at which this job is scheduled.
-    #
-    def schedule_info
-
-      Time.at(@at)
-    end
-
-    #
-    # next_time is last_time (except for EveryJob instances). Returns
-    # a Time instance.
-    #
-    def next_time
-
-      schedule_info
-    end
-
-    protected
-
-    #
-    # Triggers the job (calls the block)
-    #
-    def do_trigger
-
-      call_block
-
-      @scheduler.instance_variable_get(:@non_cron_jobs).delete(@job_id)
-    end
-  end
-
-  #
-  # An 'every' job is simply an extension of an 'at' job.
-  #
-  class EveryJob < AtJob
-
-    #
-    # Returns the frequency string used to schedule this EveryJob,
-    # like for example "3d" or "1M10d3h".
-    #
-    def schedule_info
-
-      @params[:every]
-    end
-
-    protected
-
-    #
-    # triggers the job, then reschedules it if necessary
-    #
-    def do_trigger
-
-      hit_exception = false
-
-      begin
-
-        call_block
-
-      rescue Exception => e
-
-        @scheduler.send(:log_exception, e)
-
-        hit_exception = true
-      end
-
-      if \
-        @scheduler.instance_variable_get(:@exit_when_no_more_jobs) or
-        (@params[:dont_reschedule] == true) or
-        (hit_exception and @params[:try_again] == false)
-
-        @scheduler.instance_variable_get(:@non_cron_jobs).delete(job_id)
-          # maybe it'd be better to wipe that reference from here anyway...
-
-        return
-      end
-
-      #
-      # ok, reschedule ...
-
-      params[:job] = self
-
-      @at = @at + Rufus.duration_to_f(params[:every])
-
-      @scheduler.send(:do_schedule_at, @at, params)
-    end
-  end
-
-  #
-  # A cron job.
-  #
-  class CronJob < Job
-
-    #
-    # The CronLine instance representing the times at which
-    # the cron job has to be triggered.
-    #
-    attr_accessor :cron_line
-
-    def initialize (scheduler, cron_id, line, params, &block)
-
-      super(scheduler, cron_id, params, &block)
-
-      if line.is_a?(String)
-
-        @cron_line = CronLine.new(line)
-
-      elsif line.is_a?(CronLine)
-
-        @cron_line = line
-
-      else
-
-        raise(
-          "Cannot initialize a CronJob " +
-          "with a param of class #{line.class}")
-      end
-    end
-
-    #
-    # This is the method called by the scheduler to determine if it
-    # has to fire this CronJob instance.
-    #
-    def matches? (time)
-    #def matches? (time, precision)
-
-      #@cron_line.matches?(time, precision)
-      @cron_line.matches?(time)
-    end
-
-    #
-    # Returns the original cron tab string used to schedule this
-    # Job. Like for example "60/3 * * * Sun".
-    #
-    def schedule_info
-
-      @cron_line.original
-    end
-
-    #
-    # Returns a Time instance : the next time this cron job is
-    # supposed to "fire".
-    #
-    # 'from' is used to specify the starting point for determining
-    # what will be the next time. Defaults to now.
-    #
-    def next_time (from=Time.now)
-
-      @cron_line.next_time(from)
-    end
-
-    protected
-
-    #
-    # As the name implies.
-    #
-    def do_trigger
-
-      call_block
-    end
-  end
-
-end
-