rufus-scheduler 3.8.2 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fbe0f73068129b96196031b141f480f830e3110e35d3c5eaa2206530b1ae536
-  data.tar.gz: bec310a43820928b8d342b5b3602edf8cb27aaca8995e0a18073d70dfd3839f8
+  metadata.gz: ec5b405be33c70ef390f2d8c47be112c7cf05c32eda58a0a764bbf42fae1b5d6
+  data.tar.gz: c03f4dc830c7041a530d899d69d91f7409ba481bbd12241152543b0eae20fc23
 SHA512:
-  metadata.gz: 3e8edfd4df2ddbb0f8026ffa13fff69f9f4bd045da1638fe5ac38610992e0f7d173b20a27ad1833760d6fee62d41b5b160978e107dbc55a1b9d07dfaa62444ad
-  data.tar.gz: 412bb7e80546c5cd13bf8875f928ce6920a9e62774d296db83935adbfee56069cbb2729bb4640962351297cd55b8b5cfb92facfec38e7cb92b3ef9f7446c7283
+  metadata.gz: e5d992e7ad0a23530320731348c3c890b90d0184851d7faf807a36e4c6dd5d879579a478478055beab569e14603f129a7ad15022f2bf6b297a3e9f27cb31fb4c
+  data.tar.gz: 85be36f54b76add7704907a3a7d43339a392d49fc05e03b62dc28e20a88eeb03cd132f64e1f3a1378f2e6e3128d57fb7fa4fe6f6ccd89fdd8b1d24fe93312583

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 # CHANGELOG.md
 
 
+### rufus-scheduler 3.9.0 - released 2023-06-02
+
+* Add note about Chronic and "Wed at 2pm", gh-340
+* Let AtJob and InJob accept discard_past:
+* Enforce discard_past for At and In jobs, gh-339
+
+
 ### rufus-scheduler 3.8.2 - released 2022-07-12
 
 * Prevent error in shutdown when @thread is current Thread, gh-337

data/LICENSE.txt

@@ -1,5 +1,5 @@
 
-Copyright (c) 2005-2022, John Mettraux, jmettraux@gmail.com
+Copyright (c) 2005-2023, 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

data/Makefile

@@ -1,8 +1,8 @@
 
-NAME = \
-  $(shell ruby -e "s = eval(File.read(Dir['*.gemspec'][0])); puts s.name")
-VERSION = \
-  $(shell ruby -e "s = eval(File.read(Dir['*.gemspec'][0])); puts s.version")
+NAME != \
+  ruby -e "s = eval(File.read(Dir['*.gemspec'][0])); puts s.name"
+VERSION != \
+  ruby -e "s = eval(File.read(Dir['*.gemspec'][0])); puts s.version"
 
 count_lines:
 	find lib -name "*.rb" | xargs cat | ruby -e "p STDIN.readlines.count { |l| l = l.strip; l[0, 1] != '#' && l != '' }"

data/README.md

@@ -3,7 +3,6 @@
 
 [![tests](https://github.com/jmettraux/rufus-scheduler/workflows/test/badge.svg)](https://github.com/jmettraux/rufus-scheduler/actions)
 [![Gem Version](https://badge.fury.io/rb/rufus-scheduler.svg)](https://badge.fury.io/rb/rufus-scheduler)
-[![Join the chat at https://gitter.im/floraison/fugit](https://badges.gitter.im/floraison/fugit.svg)](https://gitter.im/floraison/fugit?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 Job scheduler for Ruby (at, cron, in and every jobs).
 
@@ -106,7 +105,7 @@ I'll drive you right to the [tracks](#so-rails).
 * Rufus::Scheduler::TimeOutError renamed to Rufus::Scheduler::TimeoutError
 * Introduction of "interval" jobs. Whereas "every" jobs are like "every 10 minutes, do this", interval jobs are like "do that, then wait for 10 minutes, then do that again, and so on"
 * Introduction of a lockfile: true/filename mechanism to prevent multiple schedulers from executing
-* "discard_past" is on by default. If the scheduler (its host) sleeps for 1 hour and a `every '10m'` job is on, it will trigger once at wakeup, not 6 times (discard_past was false by default in rufus-scheduler 2.x). No intention to re-introduce `discard_past: false` in 3.0 for now.
+* "discard_past" is on by default. If the scheduler (its host) sleeps for 1 hour and a `every '10m'` job is on, it will trigger once at wakeup, not 6 times (discard_past was false by default in rufus-scheduler 2.x).
 * Introduction of Scheduler #on_pre_trigger and #on_post_trigger callback points
 
 
@@ -120,12 +119,6 @@ Go read [how to report bugs effectively](https://www.chiark.greenend.org.uk/~sgt
 
 Update: [help_help.md](https://gist.github.com/jmettraux/310fed75f568fd731814) might help help you.
 
-### on Gitter
-
-You can find help via chat over at [https://gitter.im/floraison/fugit](https://gitter.im/floraison/fugit). It's [fugit](https://github.com/floraison/fugit), [et-orbi](https://github.com/floraison/et-orbi), and rufus-scheduler combined chat room.
-
-Please be courteous.
-
 ### issues
 
 Yes, issues can be reported in [rufus-scheduler issues](https://github.com/jmettraux/rufus-scheduler/issues), I'd actually prefer bugs in there. If there is nothing wrong with rufus-scheduler, a [Stack Overflow question](https://stackoverflow.com/questions/ask?tags=rufus-scheduler+ruby) is better.
@@ -198,7 +191,34 @@ Interval jobs trigger, execute and then trigger again after the interval elapsed
 
 Cron jobs are based on the venerable cron utility (```man 5 crontab```). They trigger following a pattern given in (almost) the same language cron uses.
 
-####
+### Chronic and "Wed at 2pm"
+
+By default, rufus-scheduler relies on Ruby to parse strings like "Wed at 2pm". But most of the time, when calling this on Thursday, the day before is "invoked". Relying on [Chronic](https://github.com/mojombo/chronic) might solve the issue.
+
+Compare
+
+```ruby
+require 'rufus-scheduler'
+
+scheduler = Rufus::Scheduler.new
+
+scheduler.at('Wed at 2pm') do
+  # ... might point in the past and thus get triggered immediately
+end
+```
+
+with
+
+```ruby
+require 'chronic'
+require 'rufus-scheduler'
+
+scheduler = Rufus::Scheduler.new
+
+scheduler.at('Wed at 2pm') do
+  # ... will point to a time in the future and trigger appropriately
+end
+```
 
 ### #schedule_x vs #x
 
@@ -561,6 +581,43 @@ job.times = 10
   # 10 days and it will be over
 ```
 
+### discard_past: false/true/:fail
+
+`in` and `at` accept a `discard_past:` option since rufus-scheduler 3.9.0:
+
+```ruby
+require 'rufus-scheduler'
+
+scheduler = Rufus::Scheduler.new
+
+scheduler.in(-3600, discard_past: true) {}
+  # the job will never get scheduled
+
+scheduler.in(-3600, discard_past: false) {}
+  # the job will trigger immediately
+
+scheduler.in(-3600, discard_past: :fail) {}
+  # will raise an error...
+```
+
+Please note that `discard_past` can be set at the scheduler level:
+
+```ruby
+require 'rufus-scheduler'
+
+s0 = Rufus::Scheduler.new(discard_past: true) # default
+
+s1 = Rufus::Scheduler.new(discard_past: false)
+  # or
+s1 = Rufus::Scheduler.new
+s1.discard_past = false
+
+s2 = Rufus::Scheduler.new(discard_past: :fail)
+  # or
+s2 = Rufus::Scheduler.new
+s2.discard_past = :fail
+```
+
 
 ## Job methods
 

data/lib/rufus/scheduler/jobs_core.rb

@@ -67,6 +67,8 @@ class Rufus::Scheduler::Job
     @unscheduled_at = nil
     @last_time = nil
 
+    @discard_past = opts[:discard_past]
+
     @locals = opts[:locals] || opts[:l] || {}
     @local_mutex = Mutex.new
 
@@ -74,9 +76,7 @@ class Rufus::Scheduler::Job
     @name = opts[:name] || opts[:n]
 
     fail(
-      ArgumentError,
-      'missing block or callable to schedule',
-      caller[2..-1]
+      ArgumentError, 'missing block or callable to schedule', caller[2..-1]
     ) unless @callable
 
     @tags = Array(opts[:tag] || opts[:tags]).collect { |t| t.to_s }
@@ -103,6 +103,14 @@ class Rufus::Scheduler::Job
   end
   alias location source_location
 
+  # Returns true if the job is scheduled in the past.
+  # Used for OneTimeJob when discard_past == true
+  #
+  def past?
+
+    false # by default
+  end
+
   # Will fail with an ArgumentError if the job frequency is higher than
   # the scheduler frequency.
   #
@@ -365,5 +373,16 @@ class Rufus::Scheduler::Job
 
     @scheduler.work_queue << [ self, time ]
   end
+
+  # Scheduler level < Job level < this resume()'s level
+  #
+  def discard_past?
+
+    dp = @scheduler.discard_past
+    dp = @discard_past if @discard_past != nil
+    dp = @resume_discard_past if @resume_discard_past != nil
+
+    dp
+  end
 end
 

data/lib/rufus/scheduler/jobs_one_time.rb

@@ -8,6 +8,14 @@ class Rufus::Scheduler::OneTimeJob < Rufus::Scheduler::Job
     (time >= time0 && time <= time1) ? [ time ] : []
   end
 
+  # Used when discard_past? is set to true or :fail at scheduler or job level...
+  #
+  def past?
+
+    @next_time &&
+    @next_time < Time.now - @scheduler.frequency
+  end
+
   protected
 
   def determine_id
@@ -20,7 +28,7 @@ class Rufus::Scheduler::OneTimeJob < Rufus::Scheduler::Job
     ].map(&:to_s).join('_')
   end
 
-  # There is no next_time for one time jobs, hence the false.
+  # There is no "next time" for one time jobs, hence the false.
   #
   def set_next_time(trigger_time, is_post=false, now=nil)
 

data/lib/rufus/scheduler/jobs_repeat.rb

@@ -93,7 +93,6 @@ class Rufus::Scheduler::RepeatJob < Rufus::Scheduler::Job
   def resume(opts={})
 
     @resume_discard_past = opts[:discard_past]
-#p [ :@resume_discard_past, @resume_discard_past ]
     @paused_at = nil
   end
 
@@ -145,17 +144,6 @@ class Rufus::Scheduler::RepeatJob < Rufus::Scheduler::Job
       a << next_time_from(a.last)
       a }
   end
-
-  protected
-
-  def discard_past?
-
-    dp = @scheduler.discard_past
-    dp = @discard_past if @discard_past != nil
-    dp = @resume_discard_past if @resume_discard_past != nil
-
-    dp
-  end
 end
 
 #
@@ -180,7 +168,6 @@ class Rufus::Scheduler::EveryJob < Rufus::Scheduler::EvInJob
     super(scheduler, duration, opts, block)
 
     @frequency = Rufus::Scheduler.parse_in(@original)
-    @discard_past = opts[:discard_past]
 
     fail ArgumentError.new(
       "cannot schedule #{self.class} with a frequency " +

data/lib/rufus/scheduler.rb

@@ -9,7 +9,7 @@ module Rufus; end
 
 class Rufus::Scheduler
 
-  VERSION = '3.8.2'
+  VERSION = '3.9.0'
 
   EoTime = ::EtOrbi::EoTime
 
@@ -722,6 +722,14 @@ class Rufus::Scheduler
       end
 
     job = job_class.new(self, t, opts, block || callable)
+
+    if job.past? && (d = job.send(:discard_past?))
+      fail ArgumentError.new(
+        "scheduling in the past and discard_past set to :fail"
+          ) if d == :fail
+      return
+    end
+
     job.check_frequency
 
     @jobs.push(job)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rufus-scheduler
 version: !ruby/object:Gem::Version
-  version: 3.8.2
+  version: 3.9.0
 platform: ruby
 authors:
 - John Mettraux
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-12 00:00:00.000000000 Z
+date: 2023-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fugit
@@ -88,7 +88,7 @@ metadata:
   bug_tracker_uri: https://github.com/jmettraux/rufus-scheduler/issues
   homepage_uri: https://github.com/jmettraux/rufus-scheduler
   source_code_uri: https://github.com/jmettraux/rufus-scheduler
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -103,8 +103,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.33
+signing_key:
 specification_version: 4
 summary: job scheduler for Ruby (at, cron, in and every jobs)
 test_files: []