delayed_job_recurring 0.3.6 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56a419fef66a6f253c1a663f68c8b2014e168b6c
-  data.tar.gz: b48e38fab7cd43a9e9a3d172350dce9825f9f13c
+  metadata.gz: fff505d7e12a6ba0aad2e7f8dd6ead4986a30980
+  data.tar.gz: 12910c837cc398f16dae86c1acaa8387a8b36e18
 SHA512:
-  metadata.gz: 407dee43ba1a8e56e68889b6286471886e11105169b08057657f309e28419c7b35c5cdca8004e0c8fbdd3d81c5552cc0d9536b4f04098c8a5c1fad29a8c8fb62
-  data.tar.gz: 561c484ace963a6e0aa9216a54c425980d6309f09ac7fecaa64e6c60b9d8c5d97e3e23a56b2bd208460f355ca5b6b1d6dbd7dc912542676e0b75f7f2f441e0f1
+  metadata.gz: bde7769c64e1e7202481cb79f455a652ddf6ad952fc0fe59167e39c070f67ebf7748f487fb124874312ede5ea2125dac6bee441b5a0a8a05eb3af26344701675
+  data.tar.gz: 2d7759c1d9860038b5a3ea7dbd53702ab44ad7243b0c9537f30cdfc2f32ad8e362c5f55da777a93aca4fad8dec98a0fdb3a596bb55d4872df285e962d7d79722

data/README.md

@@ -28,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
+  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
@@ -54,6 +83,18 @@ 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.

data/lib/delayed/recurring_job.rb

@@ -41,8 +41,7 @@ module Delayed
       enqueue_opts[:queue] = @schedule_options[:queue] if @schedule_options[:queue]
 
       Delayed::Job.transaction do
-        self.class.jobs.destroy_all
-
+        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
@@ -161,29 +160,40 @@ 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]
+          query[0] = "#{query[0]} AND handler LIKE ?"
+          query << "%#{matching_key}: #{matching_value}%"
+        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
+        unschedule(options)
         new.schedule!(options)
       end
 
-      def scheduled?
-        jobs.count > 0
+      def scheduled?(options = {})
+        jobs(options).count > 0
       end
 
       def inherited(subclass)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delayed_job_recurring
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.7
 platform: ruby
 authors:
 - Tony Novak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-31 00:00:00.000000000 Z
+date: 2017-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -44,28 +44,28 @@ dependencies:
     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