resque-scheduler 4.0.0 → 4.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YWQ5NjY1MDg2NGNmODVkNWQxZDNmOWJjNzAxMWRjMGNjZWFhM2RiNg==
-  data.tar.gz: !binary |-
-    ZWZiZjMwYWRkMzRlOWQxYzViN2EzOGU0MDAwMTAzMTM4NTY5OTNkZQ==
+SHA1:
+  metadata.gz: b1c100ee487f2bbb303e4bd2efae46172ac89322
+  data.tar.gz: eccb0c76e7ed34839c8c585fa6751bc3c114f521
 SHA512:
-  metadata.gz: !binary |-
-    YWY0MjRlNjcyOWZjODM5YWNlYjFlNDM5ZGU1NjFjYmQwZDQ2NDY0YWFiMmJh
-    ZTkwMWJiYzljMGQ4MTI1MDY0NjA2ZWM1NGNjNjgwZDU1ZTIxZDk4N2ZmNjk4
-    ZWFjZjhkOTEyOWJmMDQ2YjBiY2MxMzBkYTg1ZjEzOGYzZDJhNDc=
-  data.tar.gz: !binary |-
-    OTQ4NjVhMjZjYTEwMDYyOGMwODBkMmQ2MGUyNDIzYTgyNjI1NmNhZjg2MzRm
-    NWI3Mjk2MGM4N2E2MjhkY2IwNjlkYjZlYWZmY2Q2ZTFhY2Y0ZWUxNmY3MmM4
-    ODkwZjE3MjljOTVlZWM2ZjZhZmRmMTQwYjM3ZDk0OGFmNTA3ODY=
+  metadata.gz: 9c8b1b82cf0d16eed3f711cfba27787232b4b282f8e329e98708f3a4a348a43b416acf74879165b3e1671b7a83c2d7a1aad25884ba5de5c64736c1a099a38696
+  data.tar.gz: ccd696fa8683b597401da6e0adbeaf5edf58ded176fd61a63ad8fbec9f6e5e052b0432e79b4c974f57778454553ce8bf4c25a5e024f3e23a44c807dc551ee2af

data/.rubocop.yml

@@ -14,3 +14,5 @@ Style/DoubleNegation:
   Enabled: false
 Metrics/PerceivedComplexity:
   Enabled: false
+Metrics/ClassLength:
+  Max: 110

data/.rubocop_todo.yml

@@ -1,5 +1,6 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-12-21 12:37:35 -0500 using RuboCop version 0.28.0.
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-02-10 07:59:57 -0500 using RuboCop version 0.35.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -8,50 +9,55 @@
 # Offense count: 2
 # Configuration parameters: AllowSafeAssignment.
 Lint/AssignmentInCondition:
-  Enabled: false
+  Exclude:
+    - 'lib/resque/scheduler/delaying_extensions.rb'
+    - 'lib/resque/scheduler/env.rb'
 
-# Offense count: 16
+# Offense count: 15
 Metrics/AbcSize:
-  Max: 42
+  Max: 36
 
-# Offense count: 2
-# Configuration parameters: CountComments.
-Metrics/ClassLength:
-  Max: 105
-
-# Offense count: 4
+# Offense count: 3
 Metrics/CyclomaticComplexity:
   Max: 12
 
-# Offense count: 18
+# Offense count: 1
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 87
+
+# Offense count: 19
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 34
 
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/ModuleLength:
+  Max: 294
+
 # Offense count: 1
 Style/CaseEquality:
-  Enabled: false
+  Exclude:
+    - 'lib/resque/scheduler.rb'
 
 # Offense count: 1
 Style/EachWithObject:
-  Enabled: false
+  Exclude:
+    - 'lib/resque/scheduler.rb'
 
 # Offense count: 3
 # Configuration parameters: Exclude.
 Style/FileName:
-  Enabled: false
+  Exclude:
+    - 'examples/config/initializers/resque-web.rb'
+    - 'lib/resque-scheduler.rb'
+    - 'test/resque-web_test.rb'
 
 # Offense count: 6
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
-  Enabled: false
-
-# Offense count: 6
-# Configuration parameters: MaxLineLength.
-Style/IfUnlessModifier:
-  Enabled: false
-
-# Offense count: 1
-# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
-Style/Next:
-  Enabled: false
+  Exclude:
+    - 'lib/resque/scheduler.rb'
+    - 'lib/resque/scheduler/lock/basic.rb'
+    - 'test/support/redis_instance.rb'

data/.travis.yml

@@ -2,13 +2,13 @@ language: ruby
 sudo: false
 rvm:
 - 1.9.3
-- 2.1.5
+- 2.3.0
 - jruby-19mode
 - rbx
 env:
   global:
-  - RESQUE_SCHEDULER_DISABLE_TEST_REDIS_SERVER=1
   - JRUBY_OPTS='-Xcext.enabled=true'
+  - COVERAGE=1
 matrix:
   allow_failures:
   - rvm: jruby-19mode
@@ -16,11 +16,6 @@ matrix:
 services:
 - redis-server
 notifications:
-  email:
-    recipients:
-    - daniel.buch+resque-scheduler@gmail.com
-    on_success: change
-    on_failure: change
   irc:
     channels:
     - 'chat.freenode.net#resque'
@@ -34,5 +29,5 @@ deploy:
   on:
     tags: true
     repo: resque/resque-scheduler
-    rvm: 2.1.5
+    rvm: 2.3.0
     all_branches: true

data/AUTHORS.md

@@ -20,6 +20,7 @@ Resque Scheduler authors
 - David Doan
 - David Yang
 - Denis Yagofarov
+- dtaniwaki
 - Evan Tahler
 - Eugene Batogov
 - Giovanni Cappellotto
@@ -36,6 +37,7 @@ Resque Scheduler authors
 - Joshua Szmajda
 - Justin Weiss
 - Les Hill
+- Luke Rodgers
 - Manuel Meurer
 - Matt Aimonetti
 - Matt Simpson
@@ -56,6 +58,7 @@ Resque Scheduler authors
 - Scott Francis
 - Sebastian Kippe
 - Spring MC
+- tbprojects
 - Tim Liner
 - Tony Lewis
 - Tom Crayford

data/README.md

@@ -91,7 +91,7 @@ namespace :resque do
     require 'jobs'
   end
 
-  task :scheduler_setup => :setup_schedule
+  task :scheduler => :setup_schedule
 end
 ```
 
@@ -180,7 +180,7 @@ a worker is available (just like any other resque job).
 
 NOTE: The job does not fire **exactly** at the time supplied.  Rather, once that
 time is in the past, the job moves from the delayed queue to the actual resque
-work queue and will be completed as workers as free to process it.
+work queue and will be completed as workers are free to process it.
 
 Also supported is `Resque.enqueue_at` which takes a timestamp to queue the
 job, and `Resque.enqueue_at_with_queue` which takes both a timestamp and a
@@ -220,6 +220,17 @@ Resque.remove_delayed_selection { |args| args[0]['account_id'] == current_accoun
 Resque.remove_delayed_selection { |args| args[0]['user_id'] == current_user.id }
 ```
 
+If you need to enqueue immediately a delayed job based on some matching arguments, but don't wish to specify each argument from when the job was created, you can do like so:
+
+``` ruby
+# after you've enqueued a job like:
+Resque.enqueue_at(5.days.from_now, SendFollowUpEmail, :account_id => current_account.id, :user_id => current_user.id)
+# enqueue immediately jobs matching just the account:
+Resque.enqueue_delayed_selection { |args| args[0]['account_id'] == current_account.id }
+# or enqueue immediately jobs matching just the user:
+Resque.enqueue_delayed_selection { |args| args[0]['user_id'] == current_user.id }
+```
+
 ### Scheduled Jobs (Recurring Jobs)
 
 Scheduled (or recurring) jobs are logically no different than a standard cron
@@ -439,7 +450,7 @@ end
 *>= 2.0.1 only.  Prior to 2.0.1, it is not recommended to run multiple resque-scheduler processes and will result in duplicate jobs.*
 
 You may want to have resque-scheduler running on multiple machines for
-redudancy.  Electing a master and failover is built in and default.  Simply
+redundancy.  Electing a master and failover is built in and default.  Simply
 run resque-scheduler on as many machine as you want pointing to the same
 redis instance and schedule.  The scheduler processes will use redis to
 elect a master process and detect failover when the master dies.  Precautions are

data/lib/resque/scheduler.rb

@@ -129,23 +129,20 @@ module Resque
           interval_defined = false
           interval_types = %w(cron every)
           interval_types.each do |interval_type|
-            if !config[interval_type].nil? && config[interval_type].length > 0
-              args = optionizate_interval_value(config[interval_type])
-              if args.is_a?(::String)
-                args = [args, nil, job: true]
+            next unless !config[interval_type].nil? && config[interval_type].length > 0
+            args = optionizate_interval_value(config[interval_type])
+            args = [args, nil, job: true] if args.is_a?(::String)
+
+            job = rufus_scheduler.send(interval_type, *args) do
+              if master?
+                log! "queueing #{config['class']} (#{name})"
+                Resque.last_enqueued_at(name, Time.now.to_s)
+                handle_errors { enqueue_from_config(config) }
               end
-
-              job = rufus_scheduler.send(interval_type, *args) do
-                if master?
-                  log! "queueing #{config['class']} (#{name})"
-                  Resque.last_enqueued_at(name, Time.now.to_s)
-                  handle_errors { enqueue_from_config(config) }
-                end
-              end
-              @scheduled_jobs[name] = job
-              interval_defined = true
-              break
             end
+            @scheduled_jobs[name] = job
+            interval_defined = true
+            break
           end
           unless interval_defined
             log! "no #{interval_types.join(' / ')} found for " \

data/lib/resque/scheduler/cli.rb

@@ -136,7 +136,9 @@ module Resque
 
       def options
         @options ||= {}.tap do |o|
-          CLI_OPTIONS_ENV_MAPPING.map { |key, envvar| o[key] = env[envvar] }
+          CLI_OPTIONS_ENV_MAPPING.each do |key, envvar|
+            o[key] = env[envvar] if env.include?(envvar)
+          end
         end
       end
     end

data/lib/resque/scheduler/configuration.rb

@@ -13,7 +13,7 @@ module Resque
 
       def env
         return @env if @env
-        @env ||= Rails.env if defined?(Rails)
+        @env ||= Rails.env if defined?(Rails) && Rails.respond_to?(:env)
         @env ||= ENV['RAILS_ENV']
         @env
       end

data/lib/resque/scheduler/delaying_extensions.rb

@@ -158,7 +158,35 @@ module Resque
       def remove_delayed_selection(klass = nil)
         fail ArgumentError, 'Please supply a block' unless block_given?
 
-        destroyed = 0
+        found_jobs = find_delayed_selection(klass) { |args| yield(args) }
+        found_jobs.reduce(0) do |sum, encoded_job|
+          sum + remove_delayed_job(encoded_job)
+        end
+      end
+
+      # Given a block, enqueue jobs now that return true from a block
+      #
+      # This allows for enqueuing of delayed jobs that have arguments matching
+      # certain criteria
+      def enqueue_delayed_selection(klass = nil)
+        fail ArgumentError, 'Please supply a block' unless block_given?
+
+        found_jobs = find_delayed_selection(klass) { |args| yield(args) }
+        found_jobs.reduce(0) do |sum, encoded_job|
+          decoded_job = decode(encoded_job)
+          klass = Util.constantize(decoded_job['class'])
+          sum + enqueue_delayed(klass, *decoded_job['args'])
+        end
+      end
+
+      # Given a block, find jobs that return true from a block
+      #
+      # This allows for finding of delayed jobs that have arguments matching
+      # certain criteria
+      def find_delayed_selection(klass = nil, &block)
+        fail ArgumentError, 'Please supply a block' unless block_given?
+
+        found_jobs = []
         start = nil
         while start = search_first_delayed_timestamp_in_range(start, nil)
           job = "delayed:#{start}"
@@ -167,19 +195,13 @@ module Resque
           while index >= 0
             payload = Resque.redis.lindex(job, index)
             decoded_payload = decode(payload)
-            job_class = decoded_payload['class']
-            relevant_class = (klass.nil? || klass.to_s == job_class)
-            if relevant_class && yield(decoded_payload['args'])
-              removed = remove_delayed_job(payload)
-              destroyed += removed
-              index -= removed
-            else
-              index -= 1
+            if payload_matches_selection?(decoded_payload, klass, &block)
+              found_jobs.push(payload)
             end
+            index -= 1
           end
         end
-
-        destroyed
+        found_jobs
       end
 
       # Given a timestamp and job (klass + args) it removes all instances and
@@ -283,6 +305,13 @@ module Resque
         timestamp.to_i unless timestamp.nil?
       end
 
+      def payload_matches_selection?(decoded_payload, klass)
+        return false if decoded_payload.nil?
+        job_class = decoded_payload['class']
+        relevant_class = (klass.nil? || klass.to_s == job_class)
+        relevant_class && yield(decoded_payload['args'])
+      end
+
       def plugin
         Resque::Scheduler::Plugin
       end

data/lib/resque/scheduler/env.rb

@@ -56,33 +56,21 @@ module Resque
 
       def setup_scheduler_configuration
         Resque::Scheduler.configure do |c|
-          if options.key?(:app_name)
-            c.app_name = options[:app_name]
-          end
+          c.app_name = options[:app_name] if options.key?(:app_name)
 
-          if options.key?(:dynamic)
-            c.dynamic = !!options[:dynamic]
-          end
+          c.dynamic = !!options[:dynamic] if options.key?(:dynamic)
 
-          if options.key(:env)
-            c.env = options[:env]
-          end
+          c.env = options[:env] if options.key(:env)
 
-          if options.key?(:logfile)
-            c.logfile = options[:logfile]
-          end
+          c.logfile = options[:logfile] if options.key?(:logfile)
 
-          if options.key?(:logformat)
-            c.logformat = options[:logformat]
-          end
+          c.logformat = options[:logformat] if options.key?(:logformat)
 
           if psleep = options[:poll_sleep_amount] && !psleep.nil?
             c.poll_sleep_amount = Float(psleep)
           end
 
-          if options.key?(:verbose)
-            c.verbose = !!options[:verbose]
-          end
+          c.verbose = !!options[:verbose] if options.key?(:verbose)
         end
       end
 

data/lib/resque/scheduler/server.rb

@@ -1,12 +1,17 @@
 # vim:fileencoding=utf-8
 require 'resque-scheduler'
 require 'resque/server'
+require 'tilt/erb'
 require 'json'
 
 # Extend Resque::Server to add tabs
 module Resque
   module Scheduler
     module Server
+      unless defined?(::Resque::Scheduler::Server::VIEW_PATH)
+        VIEW_PATH = File.join(File.dirname(__FILE__), 'server', 'views')
+      end
+
       def self.included(base)
         base.class_eval do
           helpers { include HelperMethods }
@@ -121,10 +126,6 @@ module Resque
       end
 
       module HelperMethods
-        def render_partial(partial)
-          erb partial, layout: false
-        end
-
         def format_time(t)
           t.strftime('%Y-%m-%d %H:%M:%S %z')
         end
@@ -175,7 +176,7 @@ module Resque
 
           s << ' ('
           meta = every.last.map do |key, value|
-            "#{key.to_s.gsub(/_/, ' ')} #{value}"
+            "#{key.to_s.tr('_', ' ')} #{value}"
           end
           s << meta.join(', ') << ')'
         end
@@ -203,6 +204,11 @@ module Resque
           Resque.schedule[name]['rails_env']
         end
 
+        def scheduler_view(filename, options = {}, locals = {})
+          source = File.read(File.join(VIEW_PATH, "#{filename}.erb"))
+          erb source, options, locals
+        end
+
         private
 
         def working_jobs_for_worker(worker)

data/lib/resque/scheduler/server/views/delayed.erb

@@ -1,7 +1,7 @@
 <h1>Delayed Jobs</h1>
 <%- size = resque.delayed_queue_schedule_size %>
 
-<%= render_partial File.read(File.join(File.dirname(__FILE__), 'server/views/search_form.erb')) %>
+<%= scheduler_view :search_form, layout: false %>
 
 <p class='intro'>
   This list below contains the timestamps for scheduled delayed jobs.
@@ -57,4 +57,3 @@
 <% end %>
 
 <%= partial :next_more, :start => start, :size => size %>
-