delayed_job_recurring 0.3.4 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 290117f54a785d30a82b864887404a17726190ed
-  data.tar.gz: 81e2bab83a90f6022e9345a27595d0f57c688b1b
+SHA256:
+  metadata.gz: d2df13749a11ec5a5a5fef3f60eb7c7a1216e13a6b93a6e084392a30b0fabefd
+  data.tar.gz: 98bbe52c01ef1a79e4ce2c512a47d91e4a9380b8d119fc05605e13a27f805425
 SHA512:
-  metadata.gz: 195de5c332484916371e1389c485204e98274428cd093423e0b8058823aa6f8067a0f10c1437ff7b79b83b643eb30df27c705bb2ff12e8baadf356f157b01f51
-  data.tar.gz: e6210b3ba0b09c7bfecfbddba72f779305a51645792adb01f6da8a1ebf2f9f8940b04c36933a588018c2bf5ab8a74ee04b393c4b6f6fbf8d6c08845c5cf7f8bf
+  metadata.gz: ec8ae92ce900948c73831b5b965e603032ee645e134b410af15f1e1b5392b5b3630252acac34ced89e3ff71d1334a37b7bd3fed212dabcc47d2ab37ee44d1294
+  data.tar.gz: bb8f9c77c3d0417b1e35861d7f81c8e8c82eb10963bdb32ffeef0b14f87cdfa2c8430259ddd8b7d494922434f6d38b1f8cb9f587f10373155218adec14cf36ae

data/README.md

@@ -1,4 +1,5 @@
 # delayed\_job\_recurring
+[![Build Status](https://travis-ci.org/amitree/delayed_job_recurring.svg)](https://travis-ci.org/amitree/delayed_job_recurring)
 
 Extends delayed\_job to support recurring jobs.
 
@@ -27,12 +28,41 @@ class MyTask
 end
 ```
 
-And schedule it. In a rails app, you might put this in an initializer:
+Finally, schedule it:
 
 ```ruby
 MyTask.schedule! # run every day at 11am Pacific time (accounting for daylight savings)
 ```
 
+The best practice is to add your `MyTask.schedule!` lines to a rake file, e.g.
+
+```ruby
+# lib/tasks/recurring_jobs.rake
+
+namespace :recurring do
+  task init: :environment do
+    MyTask.schedule!
+    MyOtherTask.schedule!
+
+    if Rails.env.production?
+      MyProductionOnlyTask.schedule!
+    end
+  end
+end
+```
+
+and invoke this job by running `rake recurring:init` on each deployment.
+
+Alternatively, if your app only has one instance running, you can put your
+`schedule!` calls into an initializer, and then your jobs will be automatically
+scheduled when your app starts. However, if you have more than one instance of
+your app running in production, this will lead to a race condition and you will
+end up with duplicate recurring jobs in the queue.
+
+## ActiveJob
+
+Note: your task class should **not** inherit from ActiveJob::Base.
+
 ## Advanced usage
 
 ### Passing options to schedule
@@ -44,7 +74,7 @@ MyTask.schedule(run_at: '12:00')
 ### Running at multiples times each day
 
 ```ruby
-MyTask.schedule(run_every: 1.day, run_at: ['11:00', '6:00pm']
+MyTask.schedule(run_every: 1.day, run_at: ['11:00', '6:00pm'])
 ```
 
 ### Running on specific days of the week
@@ -53,6 +83,22 @@ MyTask.schedule(run_every: 1.day, run_at: ['11:00', '6:00pm']
 MyTask.schedule(run_every: 1.week, run_at: ['sunday 8:00am', 'wednesday 8:00am'])
 ```
 
+### Scheduling multiple jobs of same class
+
+By default, before scheduling a new job, the old jobs scheduled with the same class will be unscheduled.
+
+To schedule multiple jobs with same class, pass an unique matching param `job_matching_param` and value for that matching param in each job as below:
+
+```ruby
+MyTask.schedule(run_at: '12:00', job_matching_param: 'schedule_id', schedule_id: 2)
+```
+
+This allows you to schedule multiple jobs with same class if value of the unique matching param(which is `schedule_id` in above example) is different in each job.
+
 ## Thanks!
 
 Many thanks to @ginjo and @kares for their work!  This code was derived from https://gist.github.com/ginjo/3688965.
+
+## Contributing
+
+[![Open Source Helpers](https://www.codetriage.com/amitree/delayed_job_recurring/badges/users.svg)](https://www.codetriage.com/amitree/delayed_job_recurring)

data/lib/delayed/recurring_job.rb

@@ -23,13 +23,17 @@ module Delayed
 
     # Schedule this "repeating" job
     def schedule! options = {}
-      options = options.dup
+      options = options.dup.reverse_merge(@schedule_options || {})
+
+      if options[:new_instance] && !options.delete(:reentry)
+        return self.class.new.schedule! options.merge(reentry: true)
+      end
 
       if run_every = options.delete(:run_every)
         options[:run_interval] = serialize_duration(run_every)
       end
 
-      @schedule_options = options.reverse_merge(@schedule_options || {}).reverse_merge(
+      @schedule_options = options.reverse_merge(
         run_at: self.class.run_at,
         timezone: self.class.timezone,
         run_interval: serialize_duration(self.class.run_every),
@@ -40,10 +44,13 @@ module Delayed
       enqueue_opts = { priority: @schedule_options[:priority], run_at: next_run_time }
       enqueue_opts[:queue] = @schedule_options[:queue] if @schedule_options[:queue]
 
-      if Gem.loaded_specs['delayed_job'].version.to_s.first.to_i < 3
-        Delayed::Job.enqueue self, enqueue_opts[:priority], enqueue_opts[:run_at]
-      else
-        Delayed::Job.enqueue self, enqueue_opts
+      Delayed::Job.transaction do
+        self.class.jobs(@schedule_options).destroy_all
+        if Gem.loaded_specs['delayed_job'].version.to_s.first.to_i < 3
+          Delayed::Job.enqueue self, enqueue_opts[:priority], enqueue_opts[:run_at]
+        else
+          Delayed::Job.enqueue self, enqueue_opts
+        end
       end
     end
 
@@ -157,77 +164,59 @@ module Delayed
       end
 
       # Show all jobs for this schedule
-      def jobs
-        ::Delayed::Job.where("(handler LIKE ?) OR (handler LIKE ?)", "--- !ruby/object:#{name} %", "--- !ruby/object:#{name}\n%")
+      def jobs(options = {})
+        options = options.with_indifferent_access
+
+        # Construct dynamic query with 'job_matching_param' if present
+        query = ["((handler LIKE ?) OR (handler LIKE ?))", "--- !ruby/object:#{name} %", "--- !ruby/object:#{name}\n%"]
+        if options[:job_matching_param].present?
+          matching_key = options[:job_matching_param]
+          matching_value = options[matching_key]
+          matching_yaml = yaml_quote(matching_value)
+          query[0] = "#{query[0]} AND handler LIKE ?"
+          query << "%#{matching_key}: #{matching_yaml}%"
+        end
+
+        ::Delayed::Job.where(query)
       end
 
       # Remove all jobs for this schedule (Stop the schedule)
-      def unschedule
-        jobs.each{|j| j.destroy}
+      def unschedule(options = {})
+        jobs(options).each{|j| j.destroy}
       end
 
       # Main interface to start this schedule (adds it to the jobs table).
       # Pass in a time to run the first job (nil runs the first job at run_interval from now).
       def schedule(options = {})
-        schedule!(options) unless scheduled?
+        schedule!(options) unless scheduled?(options)
       end
 
       def schedule!(options = {})
         return unless Delayed::Worker.delay_jobs
-        unschedule
-        new.schedule!(options)
+        unschedule(options)
+        new.schedule!(options.merge(new_instance: true))
       end
 
-      def scheduled?
-        jobs.count > 0
+      def scheduled?(options = {})
+        jobs(options).count > 0
       end
 
       def inherited(subclass)
-        %i(@run_at @run_interval @tz @priority).each do |var|
+        [:@run_at, :@run_interval, :@tz, :@priority].each do |var|
           next unless instance_variable_defined? var
           subclass.instance_variable_set var, self.instance_variable_get(var)
           subclass.instance_variable_set "#{var}_inherited", true
         end
       end
 
+    private
+      def yaml_quote(value)
+        # In order to ensure matching indentation, place the element inside a
+        # two-level hash (the first level mimicking 'schedule_options', the second
+        # for #{job_matching_param}), and strip out the leading "---\n:a:\n  :a: "
+        # but keep the trailing newline.
+        ({a: {a: value}}).to_yaml[14..-1]
+      end
     end # ClassMethods
   end # RecurringJob
-
-  module Task
-    # Creates a new class wrapper around a block of code to be scheduled.
-    def self.new(name, options, &block)
-      task_class = Class.new
-      task_class.class_eval do
-        include Delayed::RecurringJob
-
-        def display_name
-          self.class.name
-        end
-
-        def perform
-          block.call
-        end
-      end
-
-      Object.const_set(name, task_class) if name
-      task_class.schedule(options)
-      return task_class
-    end
-
-    # Schedule a block of code on-the-fly.
-    # This is a friendly wrapper for using Task.new without an explicit constant assignment.
-    # Delayed::Task.schedule('MyNewTask', run_every: 10.minutes, run_at: 1.minute.from_now){do_some_stuff_here}
-    # or
-    # Delayed::Task.schedule(run_every: 10.minutes, run_at: 1.minute.from_now){do_some_stuff_here}
-    def self.schedule(name_or_options={}, options={}, &block)
-      case name_or_options
-      when Hash
-        name, options = nil, name_or_options
-      else
-        name = name_or_options
-      end
-
-      self.new name, options, &block
-    end
-  end  # Task
 end # Delayed

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delayed_job_recurring
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.9
 platform: ruby
 authors:
 - Tony Novak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-22 00:00:00.000000000 Z
+date: 2020-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,34 +24,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.6.0
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 3.6.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 3.6.1
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -100,28 +114,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: delayed_job_active_record
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
 description: Extends delayed_job to support recurring jobs, including timezone support
 email: engineering@amitree.com
 executables: []
@@ -142,17 +156,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Recurring jobs for delayed_job