delayed_cron_job 0.7.4 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 853453d17f852e33afef72373ceec5a6fe462679272e5aa8a2cee37bccf26f3b
-  data.tar.gz: e88869f8b206ad9acd3214eb63ee4366e61c8113fc29084e8d8edaf1fd85db22
+  metadata.gz: 06776f6ef3c8e55b7e737ecd6e2eb0739c8185c72f108bd6bde3ec59aa44780e
+  data.tar.gz: 50af71b765e892796d0b04866e2a99558664f0c236ebaca532b3d15355843eee
 SHA512:
-  metadata.gz: b7bdef74835bd41fe795bc61889361bea65521b7c1771c6e2c29ef693fe15afeeafe74fecb0152a2be7aa40483578866ceec03711e24b71eafa7c66e454c05ad
-  data.tar.gz: 991d3d78e52d7932e96d99dacb0bd869bf5ac314fb0a2e89fa5b9d2c0063a63f595b22fad950bf72397003d3621bfabbe79e4e2863b41fee9bac410cb1043286
+  metadata.gz: efffba2bfd9c55a156e649fa70adb9150717f1ed41831b8031791155054d6740c42119f82f57224323c47908d24a50621698bf872157ebb71a3bc1c4d3d2c61d
+  data.tar.gz: 4869d5b81626d2b29e8037cc371ce02deb846981f6bdf26a463fa893c60dc7e6577bc24312dc96056f38d3aac522280a0f56672b5642f9aea80ce4f26f22358b

data/.travis.yml

@@ -2,6 +2,8 @@ language: ruby
 
 rvm:
  - "2.5.8"
+ - "2.7.2"
+ - "3.0.0"
 
 sudo: false
 

data/README.md

@@ -1,6 +1,6 @@
 # Delayed::Cron::Job
 
-[![Build Status](https://travis-ci.org/codez/delayed_cron_job.svg)](https://travis-ci.org/codez/delayed_cron_job)
+[![Build Status](https://app.travis-ci.com/codez/delayed_cron_job.svg?branch=master)](https://app.travis-ci.com/codez/delayed_cron_job)
 
 Delayed::Cron::Job is an extension to Delayed::Job that allows you to set
 cron expressions for your jobs to run repeatedly.
@@ -39,8 +39,7 @@ MyJob.set(cron: '*/5 * * * *').perform_later
 ```
 
 Any crontab compatible cron expressions are supported (see `man 5 crontab`).
-The credits for the `Cronline` class used go to
-[rufus-scheduler](https://github.com/jmettraux/rufus-scheduler).
+Cron parsing is handled by [Fugit](https://github.com/floraison/fugit).
 
 ## Scheduling
 
@@ -103,7 +102,7 @@ class NoonJob < CronJob
 end
 ```
 
-### Scheduling "trigger"
+### Automatic Scheduling after db:migrate
 
 Jobs with a `cron` definition are rescheduled automatically only when a job
 instance finished its work. So there needs to be an initial scheduling of all
@@ -120,7 +119,7 @@ namespace :db do
     # Need to load all jobs definitions in order to find subclasses
     glob = Rails.root.join('app', 'jobs', '**', '*_job.rb')
     Dir.glob(glob).each { |file| require file }
-    CronJob.subclasses.each { |job| job.schedule }
+    CronJob.subclasses.each(&:schedule)
   end
 end
 
@@ -178,5 +177,5 @@ jobs.
 ## License
 
 Delayed::Cron::Job is released under the terms of the MIT License.
-Copyright 2014-2020 Pascal Zumkehr. See [LICENSE](LICENSE) for further
+Copyright 2014-2021 Pascal Zumkehr. See [LICENSE](LICENSE) for further
 information.

data/delayed_cron_job.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "delayed_job", ">= 4.1"
+  spec.add_dependency "fugit", ">= 1.5"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"

data/lib/delayed_cron_job/backend/updatable_cron.rb

@@ -9,7 +9,8 @@ module DelayedCronJob
 
       def set_next_run_at
         if cron.present?
-          self.run_at = Cronline.new(cron).next_time(Delayed::Job.db_time_now)
+          now = Delayed::Job.db_time_now
+          self.run_at = Fugit::Cron.do_parse(cron).next_time(now).to_local_time
         end
       end
 

data/lib/delayed_cron_job/version.rb

@@ -1,3 +1,3 @@
 module DelayedCronJob
-  VERSION = '0.7.4'
+  VERSION = '0.8.0'
 end

data/lib/delayed_cron_job.rb

@@ -1,6 +1,6 @@
 require 'delayed_job'
 require 'English'
-require 'delayed_cron_job/cronline'
+require 'fugit'
 require 'delayed_cron_job/plugin'
 require 'delayed_cron_job/version'
 require 'delayed_cron_job/backend/updatable_cron'
@@ -49,4 +49,4 @@ if defined?(::ActiveJob)
     ActiveJob::QueueAdapters::DelayedJobAdapter.send(:include, DelayedCronJob::ActiveJob::QueueAdapter)
   end
 
-end
+end

data/spec/active_job_spec.rb

@@ -21,7 +21,7 @@ describe ActiveJob do
   let(:now)     { Delayed::Job.db_time_now }
   let(:next_run) do
     run = now.hour * 60 + now.min >= 65 ? now + 1.day : now
-    Time.utc(run.year, run.month, run.day, 1, 5)
+    Time.zone.local(run.year, run.month, run.day, 1, 5)
   end
 
   context 'with cron' do
@@ -66,4 +66,4 @@ describe ActiveJob do
       expect(delayed_job.cron).to eq(cron)
     end
   end
-end
+end

data/spec/delayed_cron_job_spec.rb

@@ -25,7 +25,7 @@ describe DelayedCronJob do
   let(:now)     { Delayed::Job.db_time_now }
   let(:next_run) do
     run = now.hour * 60 + now.min >= 65 ? now + 1.day : now
-    Time.utc(run.year, run.month, run.day, 1, 5)
+    Time.zone.local(run.year, run.month, run.day, 1, 5)
   end
 
   context 'with cron' do
@@ -116,14 +116,20 @@ describe DelayedCronJob do
     end
 
     it 'uses correct db time for next run' do
-      if Time.now != now
-        job = Delayed::Job.enqueue(handler, cron: '* * * * *')
-        run = now.hour == 23 && now.min == 59 ? now + 1.day : now
-        hour = now.min == 59 ? (now.hour + 1) % 24 : now.hour
-        run_at = Time.utc(run.year, run.month, run.day, hour, (now.min + 1) % 60)
-        expect(job.run_at).to eq(run_at)
-      else
-        pending 'This test only makes sense in non-UTC time zone'
+      local_zone = Time.zone
+      begin
+        Time.zone = nil
+        if Time.now != now
+          job = Delayed::Job.enqueue(handler, cron: '* * * * *')
+          run = now.hour == 23 && now.min == 59 ? now + 1.day : now
+          hour = now.min == 59 ? (now.hour + 1) % 24 : now.hour
+          run_at = Time.utc(run.year, run.month, run.day, hour, (now.min + 1) % 60)
+          expect(job.run_at).to eq(run_at)
+        else
+          pending 'This test only makes sense in non-UTC time zone'
+        end
+      ensure
+        Time.zone = local_zone
       end
     end
 

data/spec/spec_helper.rb

@@ -21,6 +21,8 @@ require 'delayed_cron_job'
 Delayed::Worker.logger = Logger.new('/tmp/dj.log')
 ENV['RAILS_ENV'] = 'test'
 
+Time.zone = EtOrbi.get_tzone(:local)
+
 ActiveJob::Base.queue_adapter = :delayed_job
 
 ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => 'file::memory:?cache=shared'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delayed_cron_job
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.8.0
 platform: ruby
 authors:
 - Pascal Zumkehr
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-11 00:00:00.000000000 Z
+date: 2021-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: delayed_job
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: fugit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -131,7 +145,6 @@ files:
 - lib/delayed_cron_job/active_job/queue_adapter.rb
 - lib/delayed_cron_job/backend/active_record/railtie.rb
 - lib/delayed_cron_job/backend/updatable_cron.rb
-- lib/delayed_cron_job/cronline.rb
 - lib/delayed_cron_job/plugin.rb
 - lib/delayed_cron_job/version.rb
 - lib/generators/delayed_job/cron_generator.rb
@@ -158,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: An extension to Delayed::Job that allows you to set cron expressions for

data/lib/delayed_cron_job/cronline.rb

@@ -1,465 +0,0 @@
-#--
-# Copyright (c) 2006-2014, 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 DelayedCronJob
-
-  #
-  # A 'cron line' is a line in the sense of a crontab
-  # (man 5 crontab) file line.
-  #
-  class Cronline
-
-    # The string used for creating this cronline instance.
-    #
-    attr_reader :original
-
-    attr_reader :seconds
-    attr_reader :minutes
-    attr_reader :hours
-    attr_reader :days
-    attr_reader :months
-    attr_reader :weekdays
-    attr_reader :monthdays
-    attr_reader :timezone
-
-    def initialize(line)
-
-      raise ArgumentError.new(
-        "not a string: #{line.inspect}"
-      ) unless line.is_a?(String)
-
-      @original = line
-
-      items = line.split
-
-      @timezone = (TZInfo::Timezone.get(items.last) rescue nil)
-      items.pop if @timezone
-
-      raise ArgumentError.new(
-        "not a valid cronline : '#{line}'"
-      ) unless items.length == 5 or items.length == 6
-
-      offset = items.length - 5
-
-      @seconds = offset == 1 ? parse_item(items[0], 0, 59) : [ 0 ]
-      @minutes = parse_item(items[0 + offset], 0, 59)
-      @hours = parse_item(items[1 + offset], 0, 24)
-      @days = parse_item(items[2 + offset], 1, 31)
-      @months = parse_item(items[3 + offset], 1, 12)
-      @weekdays, @monthdays = parse_weekdays(items[4 + offset])
-
-      [ @seconds, @minutes, @hours, @months ].each do |es|
-
-        raise ArgumentError.new(
-          "invalid cronline: '#{line}'"
-        ) if es && es.find { |e| ! e.is_a?(Integer) }
-      end
-    end
-
-    # Returns true if the given time matches this cron line.
-    #
-    def matches?(time)
-
-      time = Time.at(time) unless time.kind_of?(Time)
-
-      time = @timezone.utc_to_local(time.getutc) if @timezone
-
-      return false unless sub_match?(time, :sec, @seconds)
-      return false unless sub_match?(time, :min, @minutes)
-      return false unless sub_match?(time, :hour, @hours)
-      return false unless date_match?(time)
-      true
-    end
-
-    # Returns the next time that this cron line is supposed to 'fire'
-    #
-    # This is raw, 3 secs to iterate over 1 year on my macbook :( brutal.
-    # (Well, I was wrong, takes 0.001 sec on 1.8.7 and 1.9.1)
-    #
-    # This method accepts an optional Time parameter. It's the starting point
-    # for the 'search'. By default, it's Time.now
-    #
-    # Note that the time instance returned will be in the same time zone that
-    # the given start point Time (thus a result in the local time zone will
-    # be passed if no start time is specified (search start time set to
-    # Time.now))
-    #
-    #   Rufus::Scheduler::CronLine.new('30 7 * * *').next_time(
-    #     Time.mktime(2008, 10, 24, 7, 29))
-    #   #=> Fri Oct 24 07:30:00 -0500 2008
-    #
-    #   Rufus::Scheduler::CronLine.new('30 7 * * *').next_time(
-    #     Time.utc(2008, 10, 24, 7, 29))
-    #   #=> Fri Oct 24 07:30:00 UTC 2008
-    #
-    #   Rufus::Scheduler::CronLine.new('30 7 * * *').next_time(
-    #     Time.utc(2008, 10, 24, 7, 29)).localtime
-    #   #=> Fri Oct 24 02:30:00 -0500 2008
-    #
-    # (Thanks to K Liu for the note and the examples)
-    #
-    def next_time(from=Time.now)
-
-      time = local_time(from)
-      time = round_to_seconds(time)
-
-      # start at the next second
-      time = time + 1
-
-      loop do
-        unless date_match?(time)
-          dst = time.isdst
-          time += (24 - time.hour) * 3600 - time.min * 60 - time.sec
-          time -= 3600 if time.isdst != dst # not necessary for winter, but...
-          next
-        end
-        unless sub_match?(time, :hour, @hours)
-          time += (60 - time.min) * 60 - time.sec; next
-        end
-        unless sub_match?(time, :min, @minutes)
-          time += 60 - time.sec; next
-        end
-        unless sub_match?(time, :sec, @seconds)
-          time += 1; next
-        end
-
-        break
-      end
-
-      global_time(time, from.utc?)
-
-    rescue TZInfo::PeriodNotFound
-
-      next_time(from + 3600)
-    end
-
-    # Returns the previous time the cronline matched. It's like next_time, but
-    # for the past.
-    #
-    def previous_time(from=Time.now)
-
-      time = local_time(from)
-      time = round_to_seconds(time)
-
-      # start at the previous second
-      time = time - 1
-
-      loop do
-        unless date_match?(time)
-          time -= time.hour * 3600 + time.min * 60 + time.sec + 1; next
-        end
-        unless sub_match?(time, :hour, @hours)
-          time -= time.min * 60 + time.sec + 1; next
-        end
-        unless sub_match?(time, :min, @minutes)
-          time -= time.sec + 1; next
-        end
-        unless sub_match?(time, :sec, @seconds)
-          time -= 1; next
-        end
-
-        break
-      end
-
-      global_time(time, from.utc?)
-
-    rescue TZInfo::PeriodNotFound
-
-      previous_time(time)
-    end
-
-    # Returns an array of 6 arrays (seconds, minutes, hours, days,
-    # months, weekdays).
-    # This method is used by the cronline unit tests.
-    #
-    def to_array
-
-      [
-        @seconds,
-        @minutes,
-        @hours,
-        @days,
-        @months,
-        @weekdays,
-        @monthdays,
-        @timezone ? @timezone.name : nil
-      ]
-    end
-
-    # Returns a quickly computed approximation of the frequency for this
-    # cron line.
-    #
-    # #brute_frequency, on the other hand, will compute the frequency by
-    # examining a whole, that can take more than seconds for a seconds
-    # level cron...
-    #
-    def frequency
-
-      return brute_frequency unless @seconds && @seconds.length > 1
-
-      delta = 60
-      prev = @seconds[0]
-
-      @seconds[1..-1].each do |sec|
-        d = sec - prev
-        delta = d if d < delta
-      end
-
-      delta
-    end
-
-    # Returns the shortest delta between two potential occurences of the
-    # schedule described by this cronline.
-    #
-    # .
-    #
-    # For a simple cronline like "*/5 * * * *", obviously the frequency is
-    # five minutes. Why does this method look at a whole year of #next_time ?
-    #
-    # Consider "* * * * sun#2,sun#3", the computed frequency is 1 week
-    # (the shortest delta is the one between the second sunday and the third
-    # sunday). This method takes no chance and runs next_time for the span
-    # of a whole year and keeps the shortest.
-    #
-    # Of course, this method can get VERY slow if you call on it a second-
-    # based cronline...
-    #
-    # Since it's a rarely used method, I haven't taken the time to make it
-    # smarter/faster.
-    #
-    # One obvious improvement would be to cache the result once computed...
-    #
-    # See https://github.com/jmettraux/rufus-scheduler/issues/89
-    # for a discussion about this method.
-    #
-    def brute_frequency
-
-      delta = 366 * DAY_S
-
-      t0 = previous_time(Time.local(2000, 1, 1))
-
-      loop do
-
-        break if delta <= 1
-        break if delta <= 60 && @seconds && @seconds.size == 1
-
-        t1 = next_time(t0)
-        d = t1 - t0
-        delta = d if d < delta
-
-        break if @months == nil && t1.month == 2
-        break if t1.year == 2001
-
-        t0 = t1
-      end
-
-      delta
-    end
-
-    protected
-
-    WEEKDAYS = %w[ sun mon tue wed thu fri sat ]
-    DAY_S = 24 * 3600
-    WEEK_S = 7 * DAY_S
-
-    def parse_weekdays(item)
-
-      return nil if item == '*'
-
-      items = item.downcase.split(',')
-
-      weekdays = nil
-      monthdays = nil
-
-      items.each do |it|
-
-        if m = it.match(/^(.+)#(l|-?[12345])$/)
-
-          raise ArgumentError.new(
-            "ranges are not supported for monthdays (#{it})"
-          ) if m[1].index('-')
-
-          expr = it.gsub(/#l/, '#-1')
-
-          (monthdays ||= []) << expr
-
-        else
-
-          expr = it.dup
-          WEEKDAYS.each_with_index { |a, i| expr.gsub!(/#{a}/, i.to_s) }
-
-          raise ArgumentError.new(
-            "invalid weekday expression (#{it})"
-          ) if expr !~ /^0*[0-7](-0*[0-7])?$/
-
-          its = expr.index('-') ? parse_range(expr, 0, 7) : [ Integer(expr) ]
-          its = its.collect { |i| i == 7 ? 0 : i }
-
-          (weekdays ||= []).concat(its)
-        end
-      end
-
-      weekdays = weekdays.uniq if weekdays
-
-      [ weekdays, monthdays ]
-    end
-
-    def parse_item(item, min, max)
-
-      return nil if item == '*'
-
-      r = item.split(',').map { |i| parse_range(i.strip, min, max) }.flatten
-
-      raise ArgumentError.new(
-        "found duplicates in #{item.inspect}"
-      ) if r.uniq.size < r.size
-
-      r
-    end
-
-    RANGE_REGEX = /^(\*|\d{1,2})(?:-(\d{1,2}))?(?:\/(\d{1,2}))?$/
-
-    def parse_range(item, min, max)
-
-      return %w[ L ] if item == 'L'
-
-      item = '*' + item if item.match(/^\//)
-
-      m = item.match(RANGE_REGEX)
-
-      raise ArgumentError.new(
-        "cannot parse #{item.inspect}"
-      ) unless m
-
-      sta = m[1]
-      sta = sta == '*' ? min : sta.to_i
-
-      edn = m[2]
-      edn = edn ? edn.to_i : sta
-      edn = max if m[1] == '*'
-
-      inc = m[3]
-      inc = inc ? inc.to_i : 1
-
-      raise ArgumentError.new(
-        "#{item.inspect} is not in range #{min}..#{max}"
-      ) if sta < min || edn > max
-
-      r = []
-      val = sta
-
-      loop do
-        v = val
-        v = 0 if max == 24 && v == 24
-        r << v
-        break if inc == 1 && val == edn
-        val += inc
-        break if inc > 1 && val > edn
-        val = min if val > max
-      end
-
-      r.uniq
-    end
-
-    def sub_match?(time, accessor, values)
-
-      value = time.send(accessor)
-
-      return true if values.nil?
-      return true if values.include?('L') && (time + DAY_S).day == 1
-
-      return true if value == 0 && accessor == :hour && values.include?(24)
-
-      values.include?(value)
-    end
-
-    def monthday_match?(date, values)
-
-      return true if values.nil?
-
-      today_values = monthdays(date)
-
-      (today_values & values).any?
-    end
-
-    def date_match?(date)
-
-      return false unless sub_match?(date, :day, @days)
-      return false unless sub_match?(date, :month, @months)
-      return false unless sub_match?(date, :wday, @weekdays)
-      return false unless monthday_match?(date, @monthdays)
-      true
-    end
-
-    def monthdays(date)
-
-      pos = 1
-      d = date.dup
-
-      loop do
-        d = d - WEEK_S
-        break if d.month != date.month
-        pos = pos + 1
-      end
-
-      neg = -1
-      d = date.dup
-
-      loop do
-        d = d + WEEK_S
-        break if d.month != date.month
-        neg = neg - 1
-      end
-
-      [ "#{WEEKDAYS[date.wday]}##{pos}", "#{WEEKDAYS[date.wday]}##{neg}" ]
-    end
-
-    def local_time(time)
-
-      @timezone ? @timezone.utc_to_local(time.getutc) : time
-    end
-
-    def global_time(time, from_in_utc)
-
-      if @timezone
-        time =
-          begin
-            @timezone.local_to_utc(time)
-          rescue TZInfo::AmbiguousTime
-            @timezone.local_to_utc(time, time.isdst)
-          end
-        time = time.getlocal unless from_in_utc
-      end
-
-      time
-    end
-
-    def round_to_seconds(time)
-
-      # Ruby 1.8 doesn't have #round
-      time.respond_to?(:round) ? time.round : time - time.usec * 1e-6
-    end
-  end
-end