rufus-scheduler 3.0.8 → 3.2.0

data/lib/rufus/scheduler.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2006-2014, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2006-2015, 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
@@ -25,8 +25,7 @@
 require 'date' if RUBY_VERSION < '1.9.0'
 require 'time'
 require 'thread'
-require 'tzinfo'
-require 'fileutils'
+#require 'tzinfo'
 
 
 module Rufus
@@ -34,11 +33,13 @@ module Rufus
   class Scheduler
 
     require 'rufus/scheduler/util'
+    require 'rufus/scheduler/zotime'
     require 'rufus/scheduler/jobs'
     require 'rufus/scheduler/cronline'
     require 'rufus/scheduler/job_array'
+    require 'rufus/scheduler/locks'
 
-    VERSION = '3.0.8'
+    VERSION = '3.2.0'
 
     #
     # A common error class for rufus-scheduler
@@ -93,7 +94,17 @@ module Rufus
 
       @thread_key = "rufus_scheduler_#{self.object_id}"
 
-      lock || return
+      @scheduler_lock =
+        if lockfile = opts[:lockfile]
+          Rufus::Scheduler::FileLock.new(lockfile)
+        else
+          opts[:scheduler_lock] || Rufus::Scheduler::NullLock.new
+        end
+
+      @trigger_lock = opts[:trigger_lock] || Rufus::Scheduler::NullLock.new
+
+      # If we can't grab the @scheduler_lock, don't run.
+      @scheduler_lock.lock || return
 
       start
     end
@@ -324,6 +335,49 @@ module Rufus
       @jobs[job_id]
     end
 
+    # Returns true if the scheduler has acquired the [exclusive] lock and
+    # thus may run.
+    #
+    # Most of the time, a scheduler is run alone and this method should
+    # return true. It is useful in cases where among a group of applications
+    # only one of them should run the scheduler. For schedulers that should
+    # not run, the method should return false.
+    #
+    # Out of the box, rufus-scheduler proposes the
+    # :lockfile => 'path/to/lock/file' scheduler start option. It makes
+    # it easy for schedulers on the same machine to determine which should
+    # run (the first to write the lockfile and lock it). It uses "man 2 flock"
+    # so it probably won't work reliably on distributed file systems.
+    #
+    # If one needs to use a special/different locking mechanism, the scheduler
+    # accepts :scheduler_lock => lock_object. lock_object only needs to respond
+    # to #lock
+    # and #unlock, and both of these methods should be idempotent.
+    #
+    # Look at rufus/scheduler/locks.rb for an example.
+    #
+    def lock
+
+      @scheduler_lock.lock
+    end
+
+    # Sister method to #lock, is called when the scheduler shuts down.
+    #
+    def unlock
+
+      @trigger_lock.unlock
+      @scheduler_lock.unlock
+    end
+
+    # Callback called when a job is triggered. If the lock cannot be acquired,
+    # the job won't run (though it'll still be scheduled to run again if
+    # necessary).
+    #
+    def confirm_lock
+
+      @trigger_lock.lock
+    end
+
     # Returns true if this job is currently scheduled.
     #
     # Takes extra care to answer true if the job is a repeat job
@@ -331,9 +385,9 @@ module Rufus
     #
     def scheduled?(job_or_job_id)
 
-      job, job_id = fetch(job_or_job_id)
+      job, _ = fetch(job_or_job_id)
 
-      !! (job && job.next_time != nil)
+      !! (job && job.unscheduled_at.nil? && job.next_time != nil)
     end
 
     # Lists all the threads associated with this scheduler.
@@ -387,7 +441,7 @@ module Rufus
       if format == :timeline
         a = []
         h.each { |j, ts| ts.each { |t| a << [ t, j ] } }
-        a.sort_by { |(t, j)| t }
+        a.sort_by { |(t, _)| t }
       else
         h
       end
@@ -423,7 +477,8 @@ module Rufus
       stderr.puts("  #{pre}     opts:")
       stderr.puts("  #{pre}       #{@opts.inspect}")
       stderr.puts("  #{pre}       frequency: #{self.frequency}")
-      stderr.puts("  #{pre}       lockfile: #{@lockfile.inspect}")
+      stderr.puts("  #{pre}       scheduler_lock: #{@scheduler_lock.inspect}")
+      stderr.puts("  #{pre}       trigger_lock: #{@trigger_lock.inspect}")
       stderr.puts("  #{pre}     uptime: #{uptime} (#{uptime_s})")
       stderr.puts("  #{pre}     down?: #{down?}")
       stderr.puts("  #{pre}     threads: #{self.threads.size}")
@@ -468,61 +523,6 @@ module Rufus
       end
     end
 
-    # Returns true if the scheduler has acquired the [exclusive] lock and
-    # thus may run.
-    #
-    # Most of the time, a scheduler is run alone and this method should
-    # return true. It is useful in cases where among a group of applications
-    # only one of them should run the scheduler. For schedulers that should
-    # not run, the method should return false.
-    #
-    # Out of the box, rufus-scheduler proposes the
-    # :lockfile => 'path/to/lock/file' scheduler start option. It makes
-    # it easy for schedulers on the same machine to determine which should
-    # run (to first to write the lockfile and lock it). It uses "man 2 flock"
-    # so it probably won't work reliably on distributed file systems.
-    #
-    # If one needs to use a special/different locking mechanism, providing
-    # overriding implementation for this #lock and the #unlock complement is
-    # easy.
-    #
-    def lock
-
-      @lockfile = nil
-
-      return true unless f = @opts[:lockfile]
-
-      raise ArgumentError.new(
-        ":lockfile argument must be a string, not a #{f.class}"
-      ) unless f.is_a?(String)
-
-      FileUtils.mkdir_p(File.dirname(f))
-
-      f = File.new(f, File::RDWR | File::CREAT)
-      locked = f.flock(File::LOCK_NB | File::LOCK_EX)
-
-      return false unless locked
-
-      now = Time.now
-
-      f.print("pid: #{$$}, ")
-      f.print("scheduler.object_id: #{self.object_id}, ")
-      f.print("time: #{now}, ")
-      f.print("timestamp: #{now.to_f}")
-      f.flush
-
-      @lockfile = f
-
-      true
-    end
-
-    # Sister method to #lock, is called when the scheduler shuts down.
-    #
-    def unlock
-
-      @lockfile.flock(File::LOCK_UN) if @lockfile
-    end
-
     def terminate_all_jobs
 
       jobs.each { |j| j.unschedule }
@@ -592,11 +592,11 @@ module Rufus
 
         job = t[:rufus_scheduler_job]
         to = t[:rufus_scheduler_timeout]
+        ts = t[:rufus_scheduler_time]
 
-        next unless job && to
+        next unless job && to && ts
           # thread might just have become inactive (job -> nil)
 
-        ts = t[:rufus_scheduler_time]
         to = to.is_a?(Time) ? to : ts + to
 
         next if to > Time.now
@@ -629,7 +629,7 @@ module Rufus
 
       job = job_class.new(self, t, opts, block || callable)
 
-      raise ArgumentError.new(
+      fail ArgumentError.new(
         "job frequency (#{job.frequency}) is higher than " +
         "scheduler frequency (#{@frequency})"
       ) if job.respond_to?(:frequency) && job.frequency < @frequency

data/rufus-scheduler.gemspec

@@ -22,42 +22,17 @@ job scheduler for Ruby (at, cron, in and every jobs).
   #s.files = `git ls-files`.split("\n")
   s.files = Dir[
     'Rakefile',
-    'lib/**/*.rb', 'spec/**/*.rb', 'test/**/*.rb',
+    'lib/**/*.rb', #'spec/**/*.rb', 'test/**/*.rb',
     '*.gemspec', '*.txt', '*.rdoc', '*.md'
   ]
 
-  s.add_runtime_dependency 'tzinfo'
+  #s.add_runtime_dependency 'tzinfo'
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec', '>= 2.13.0'
   s.add_development_dependency 'chronic'
+  s.add_development_dependency 'tzinfo'
 
   s.require_path = 'lib'
-
-  s.post_install_message =
-    %{
-***
-
-Thanks for installing rufus-scheduler #{s.version}
-
-It might not be 100% compatible with rufus-scheduler 2.x.
-
-If you encounter issues with this new rufus-scheduler, especially
-if your app worked fine with previous versions of it, you can
-
-A) Forget it and peg your Gemfile to rufus-scheduler 2.0.24
-
-and / or
-
-B) Take some time to carefully report the issue at
-   https://github.com/jmettraux/rufus-scheduler/issues
-
-For general help about rufus-scheduler, ask via:
-http://stackoverflow.com/questions/ask?tags=rufus-scheduler+ruby
-
-Cheers.
-
-***
-    }
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rufus-scheduler
 version: !ruby/object:Gem::Version
-  version: 3.0.8
+  version: 3.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,17 +9,17 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-08 00:00:00.000000000 Z
+date: 2015-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: tzinfo
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -28,13 +28,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,15 +42,15 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.13.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: chronic
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,9 +58,9 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: chronic
+  name: tzinfo
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -83,50 +83,25 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Rakefile
-- lib/rufus-scheduler.rb
-- lib/rufus/scheduler.rb
 - lib/rufus/scheduler/cronline.rb
-- lib/rufus/scheduler/util.rb
-- lib/rufus/scheduler/jobs.rb
 - lib/rufus/scheduler/job_array.rb
-- spec/job_spec.rb
-- spec/schedule_in_spec.rb
-- spec/spec_helper.rb
-- spec/job_array_spec.rb
-- spec/schedule_interval_spec.rb
-- spec/job_at_spec.rb
-- spec/schedule_at_spec.rb
-- spec/error_spec.rb
-- spec/schedule_cron_spec.rb
-- spec/job_interval_spec.rb
-- spec/job_repeat_spec.rb
-- spec/lockfile_spec.rb
-- spec/schedule_every_spec.rb
-- spec/threads_spec.rb
-- spec/cronline_spec.rb
-- spec/job_in_spec.rb
-- spec/parse_spec.rb
-- spec/scheduler_spec.rb
-- spec/custom_locks_spec.rb
-- spec/basics_spec.rb
-- spec/job_cron_spec.rb
-- spec/job_every_spec.rb
+- lib/rufus/scheduler/jobs.rb
+- lib/rufus/scheduler/locks.rb
+- lib/rufus/scheduler/util.rb
+- lib/rufus/scheduler/zones.rb
+- lib/rufus/scheduler/zotime.rb
+- lib/rufus/scheduler.rb
+- lib/rufus-scheduler.rb
 - rufus-scheduler.gemspec
 - CHANGELOG.txt
-- TODO.txt
-- LICENSE.txt
 - CREDITS.txt
+- LICENSE.txt
+- TODO.txt
 - README.md
 homepage: http://github.com/jmettraux/rufus-scheduler
 licenses:
 - MIT
-post_install_message: ! "\n***\n\nThanks for installing rufus-scheduler 3.0.8\n\nIt
-  might not be 100% compatible with rufus-scheduler 2.x.\n\nIf you encounter issues
-  with this new rufus-scheduler, especially\nif your app worked fine with previous
-  versions of it, you can\n\nA) Forget it and peg your Gemfile to rufus-scheduler
-  2.0.24\n\nand / or\n\nB) Take some time to carefully report the issue at\n   https://github.com/jmettraux/rufus-scheduler/issues\n\nFor
-  general help about rufus-scheduler, ask via:\nhttp://stackoverflow.com/questions/ask?tags=rufus-scheduler+ruby\n\nCheers.\n\n***\n
-  \   "
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -144,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: rufus
-rubygems_version: 1.8.23
+rubygems_version: 1.8.23.2
 signing_key: 
 specification_version: 3
 summary: job scheduler for Ruby (at, cron, in and every jobs)

data/spec/basics_spec.rb

@@ -1,49 +0,0 @@
-
-#
-# Specifying rufus-scheduler
-#
-# Sun Jun  1 05:52:24 JST 2014
-#
-
-require 'spec_helper'
-
-
-describe 'basics' do
-
-  def tts(time)
-
-    time.strftime('%Y-%m-%d %H:%M:%S %z') + (time.dst? ? ' dst' : '')
-  end
-
-  describe 'Time.new' do
-
-    it 'accepts a timezone final argument' do
-
-      pending if jruby? or ruby18?
-
-      expect(
-        tts(Time.new(2014, 1, 1, 1, 0, 0, '+01:00'))
-      ).to eq('2014-01-01 01:00:00 +0100')
-      expect(
-        tts(Time.new(2014, 8, 1, 1, 0, 0, '+01:00'))
-      ).to eq('2014-08-01 01:00:00 +0100')
-      expect(
-        tts(Time.new(2014, 8, 1, 1, 0, 0, '+01:00'))
-      ).to eq('2014-08-01 01:00:00 +0100')
-    end
-  end
-
-  describe 'Time.local' do
-
-    it 'works as expected' do
-
-      expect(
-        tts(in_zone('Europe/Berlin') { Time.local(2014, 1, 1, 1, 0, 0) })
-      ).to eq('2014-01-01 01:00:00 +0100')
-      expect(
-        tts(in_zone('Europe/Berlin') { Time.local(2014, 8, 1, 1, 0, 0) })
-      ).to eq('2014-08-01 01:00:00 +0200 dst')
-    end
-  end
-end
-