delayed_job 4.1.1 → 4.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 226d8094c23242fff24504c004ec32a007561ec2
-  data.tar.gz: 57c4fcad04cbb3202e310b7cac10a5c476d4817b
+  metadata.gz: 4f13f44eb18f5903178447ab50ddd453895632b3
+  data.tar.gz: 20c22a692ca3d8084a85fdb3e401f209d822eb3b
 SHA512:
-  metadata.gz: 967992dc5cdff3bce673aae3de9c442cd7387d3dc5d09c3c6d5ffad4c14714e134687baf6cdcd9408b962d45da1d37418fba91ea6b943263cc98969e744f6ebd
-  data.tar.gz: a713c81fad5e6454edafeb65455b7233f74fef09e420e0c5359394d8e640aee75c295c232e4ac4c5b23b5d9876b58dca7c3b9495589dc074776b8d228b5650a0
+  metadata.gz: a2d9edf1e02e8fd824a5016a7761e049b0b3ae90509231d021858475dbfa7fe5695cf3a150b4564fe998e0d6fa11e39bde9017c0022ae899452a46f52d192c58
+  data.tar.gz: a0a6875d0e951fbd0a3f442e2b699605bb36074b4c38ececaec501b721717ea64800fa191ed1ebae1b528ba7e8f7d8caee1c53115dc741870e7dc034ed916211

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+4.1.2 - 2016-05-16
+* Added Delayed::Worker.queue_attributes
+* Limit what we require in ActiveSupport
+* Fix pid file creation when there is no tmp directory
+* Rails 5 support
+
 4.1.1 - 2015-09-24
 ==================
 * Fix shared specs for back-ends that reload objects

data/README.md

@@ -1,7 +1,7 @@
 **If you're viewing this at https://github.com/collectiveidea/delayed_job,
 you're reading the documentation for the master branch.
 [View documentation for the latest release
-(4.0.6).](https://github.com/collectiveidea/delayed_job/tree/v4.0.6)**
+(4.1.2).](https://github.com/collectiveidea/delayed_job/tree/v4.1.2)**
 
 Delayed::Job
 ============
@@ -205,6 +205,21 @@ Delayed::Job.enqueue job, :queue => 'tracking'
 handle_asynchronously :tweet_later, :queue => 'tweets'
 ```
 
+You can configure default priorities for named queues:
+
+```ruby
+Delayed::Worker.queue_attributes = {
+  high_priority: { priority: -10 },
+  low_priority: { priority: 10 }
+}
+```
+
+Configured queue priorities can be overriden by passing priority to the delay method
+
+```ruby
+object.delay(:queue => 'high_priority', priority: 0).method
+```
+
 Running Jobs
 ============
 `script/delayed_job` can be used to manage a background process which will
@@ -425,6 +440,8 @@ The default behavior is to read 5 jobs from the queue when finding an available
 
 By default all jobs will be queued without a named queue. A default named queue can be specified by using `Delayed::Worker.default_queue_name`.
 
+If no jobs are found, the worker sleeps for the amount of time specified by the sleep delay option. Set `Delayed::Worker.sleep_delay = 60` for a 60 second sleep time.
+
 It is possible to disable delayed jobs for testing purposes. Set `Delayed::Worker.delay_jobs = false` to execute all jobs realtime.
 
 Or `Delayed::Worker.delay_jobs` can be a Proc that decides whether to execute jobs inline on a per-job basis:

data/delayed_job.gemspec

@@ -1,15 +1,17 @@
+# -*- encoding: utf-8 -*-
+
 Gem::Specification.new do |spec|
-  spec.add_dependency 'activesupport', ['>= 3.0', '< 5.0']
+  spec.add_dependency 'activesupport', ['>= 3.0', '< 5.1']
   spec.authors        = ['Brandon Keepers', 'Brian Ryckbost', 'Chris Gaffney', 'David Genord II', 'Erik Michaels-Ober', 'Matt Griffin', 'Steve Richert', 'Tobias Lütke']
   spec.description    = 'Delayed_job (or DJ) encapsulates the common pattern of asynchronously executing longer tasks in the background. It is a direct extraction from Shopify where the job table is responsible for a multitude of core tasks.'
   spec.email          = ['brian@collectiveidea.com']
   spec.files          = %w[CHANGELOG.md CONTRIBUTING.md LICENSE.md README.md Rakefile delayed_job.gemspec]
-  spec.files += Dir.glob('{contrib,lib,recipes,spec}/**/*')
+  spec.files          += Dir.glob('{contrib,lib,recipes,spec}/**/*') # rubocop:disable SpaceAroundOperators
   spec.homepage       = 'http://github.com/collectiveidea/delayed_job'
   spec.licenses       = ['MIT']
   spec.name           = 'delayed_job'
   spec.require_paths  = ['lib']
   spec.summary        = 'Database-backed asynchronous priority queue system -- Extracted from Shopify'
   spec.test_files     = Dir.glob('spec/**/*')
-  spec.version        = '4.1.1'
+  spec.version        = '4.1.2'
 end

data/lib/delayed/backend/base.rb

@@ -7,28 +7,12 @@ module Delayed
 
       module ClassMethods
         # Add a job to the queue
-        def enqueue(*args) # rubocop:disable CyclomaticComplexity
-          options = args.extract_options!
-          options[:payload_object] ||= args.shift
-          options[:priority] ||= Delayed::Worker.default_priority
-
-          if options[:queue].nil?
-            if options[:payload_object].respond_to?(:queue_name)
-              options[:queue] = options[:payload_object].queue_name
-            end
-            options[:queue] ||= Delayed::Worker.default_queue_name
-          end
-
-          if args.size > 0
-            warn '[DEPRECATION] Passing multiple arguments to `#enqueue` is deprecated. Pass a hash with :priority and :run_at.'
-            options[:priority] = args.first || options[:priority]
-            options[:run_at]   = args[1]
-          end
-
-          unless options[:payload_object].respond_to?(:perform)
-            raise ArgumentError, 'Cannot enqueue items which do not respond to perform'
-          end
+        def enqueue(*args)
+          job_options = Delayed::Backend::JobPreparer.new(*args).prepare
+          enqueue_job(job_options)
+        end
 
+        def enqueue_job(options)
           new(options).tap do |job|
             Delayed::Worker.lifecycle.run_callbacks(:enqueue, job) do
               job.hook(:enqueue)
@@ -66,7 +50,7 @@ module Delayed
       attr_reader :error
       def error=(error)
         @error = error
-        self.last_error = "#{error.message}\n#{error.backtrace.join("\n")}" if self.respond_to?(:last_error=)
+        self.last_error = "#{error.message}\n#{error.backtrace.join("\n")}" if respond_to?(:last_error=)
       end
 
       def failed?
@@ -74,7 +58,7 @@ module Delayed
       end
       alias_method :failed, :failed?
 
-      ParseObjectFromYaml = /\!ruby\/\w+\:([^\s]+)/ # rubocop:disable ConstantName
+      ParseObjectFromYaml = %r{\!ruby/\w+\:([^\s]+)} # rubocop:disable ConstantName
 
       def name
         @name ||= payload_object.respond_to?(:display_name) ? payload_object.display_name : payload_object.class.name

data/lib/delayed/backend/job_preparer.rb

@@ -0,0 +1,51 @@
+module Delayed
+  module Backend
+    class JobPreparer
+      attr_reader :options, :args
+
+      def initialize(*args)
+        @options = args.extract_options!
+        @args = args
+      end
+
+      def prepare
+        set_payload
+        set_queue_name
+        set_priority
+        handle_deprecation
+        options
+      end
+
+    private
+
+      def set_payload
+        options[:payload_object] ||= args.shift
+      end
+
+      def set_queue_name
+        if options[:queue].nil? && options[:payload_object].respond_to?(:queue_name)
+          options[:queue] = options[:payload_object].queue_name
+        else
+          options[:queue] ||= Delayed::Worker.default_queue_name
+        end
+      end
+
+      def set_priority
+        queue_attribute = Delayed::Worker.queue_attributes[options[:queue]]
+        options[:priority] ||= (queue_attribute && queue_attribute[:priority]) || Delayed::Worker.default_priority
+      end
+
+      def handle_deprecation
+        if args.size > 0
+          warn '[DEPRECATION] Passing multiple arguments to `#enqueue` is deprecated. Pass a hash with :priority and :run_at.'
+          options[:priority] = args.first || options[:priority]
+          options[:run_at]   = args[1]
+        end
+
+        unless options[:payload_object].respond_to?(:perform)
+          raise ArgumentError, 'Cannot enqueue items which do not respond to perform'
+        end
+      end
+    end
+  end
+end

data/lib/delayed/backend/shared_spec.rb

@@ -1,6 +1,6 @@
 require File.expand_path('../../../../spec/sample_jobs', __FILE__)
 
-require 'active_support/core_ext'
+require 'active_support/core_ext/numeric/time'
 
 shared_examples_for 'a delayed_job backend' do
   let(:worker) { Delayed::Worker.new }
@@ -279,6 +279,7 @@ shared_examples_for 'a delayed_job backend' do
     after do
       Delayed::Worker.max_priority = nil
       Delayed::Worker.min_priority = nil
+      Delayed::Worker.queue_attributes = {}
     end
 
     it 'fetches jobs ordered by priority' do
@@ -314,6 +315,18 @@ shared_examples_for 'a delayed_job backend' do
       end
       expect(described_class.reserve(worker)).to be_nil
     end
+
+    it 'sets job priority based on queue_attributes configuration' do
+      Delayed::Worker.queue_attributes = {'job_tracking' => {:priority => 4}}
+      job = described_class.enqueue :payload_object => NamedQueueJob.new
+      expect(job.priority).to eq(4)
+    end
+
+    it 'sets job priority based on the passed in priority overrideing queue_attributes configuration' do
+      Delayed::Worker.queue_attributes = {'job_tracking' => {:priority => 4}}
+      job = described_class.enqueue :payload_object => NamedQueueJob.new, :priority => 10
+      expect(job.priority).to eq(10)
+    end
   end
 
   context 'clear_locks!' do

data/lib/delayed/command.rb

@@ -5,6 +5,7 @@ unless ENV['RAILS_ENV'] == 'test'
     raise "You need to add gem 'daemons' to your Gemfile if you wish to use it."
   end
 end
+require 'fileutils'
 require 'optparse'
 require 'pathname'
 
@@ -32,7 +33,7 @@ module Delayed
           exit 1
         end
         opt.on('-e', '--environment=NAME', 'Specifies the environment to run this delayed jobs under (test/development/production).') do |_e|
-          STDERR.puts 'The -e/--environment option has been deprecated and has no effect. Use RAILS_ENV and see http://github.com/collectiveidea/delayed_job/issues/#issue/7'
+          STDERR.puts 'The -e/--environment option has been deprecated and has no effect. Use RAILS_ENV and see http://github.com/collectiveidea/delayed_job/issues/7'
         end
         opt.on('--min-priority N', 'Minimum priority of jobs to run.') do |n|
           @options[:min_priority] = n
@@ -82,7 +83,7 @@ module Delayed
 
     def daemonize # rubocop:disable PerceivedComplexity
       dir = @options[:pid_dir]
-      Dir.mkdir(dir) unless File.exist?(dir)
+      FileUtils.mkdir_p(dir) unless File.exist?(dir)
 
       if worker_pools
         setup_pools
@@ -142,11 +143,7 @@ module Delayed
       @worker_pools ||= []
 
       queues, worker_count = pool.split(':')
-      if ['*', '', nil].include?(queues)
-        queues = []
-      else
-        queues = queues.split(',')
-      end
+      queues = ['*', '', nil].include?(queues) ? [] : queues.split(',')
       worker_count = (worker_count || 1).to_i rescue 1
       @worker_pools << [queues, worker_count]
     end

data/lib/delayed/lifecycle.rb

@@ -10,7 +10,7 @@ module Delayed
       :error      => [:worker, :job],
       :failure    => [:worker, :job],
       :invoke_job => [:job]
-    }
+    }.freeze
 
     def initialize
       @callbacks = EVENTS.keys.each_with_object({}) do |e, hash|

data/lib/delayed/message_sending.rb

@@ -1,5 +1,3 @@
-require 'active_support/core_ext/module/aliasing'
-
 module Delayed
   class DelayProxy < Delayed::Compatibility.proxy_object_class
     def initialize(payload_class, target, options)
@@ -30,7 +28,7 @@ module Delayed
     end
 
     module ClassMethods
-      def handle_asynchronously(method, opts = {})
+      def handle_asynchronously(method, opts = {}) # rubocop:disable PerceivedComplexity
         aliased_method = method.to_s.sub(/([?!=])$/, '')
         punctuation = $1 # rubocop:disable PerlBackrefs
         with_method = "#{aliased_method}_with_delay#{punctuation}"
@@ -47,7 +45,17 @@ module Delayed
           end
           delay(curr_opts).__send__(without_method, *args)
         end
-        alias_method_chain method, :delay
+
+        alias_method without_method, method
+        alias_method method, with_method
+
+        if public_method_defined?(without_method)
+          public method
+        elsif protected_method_defined?(without_method)
+          protected method
+        elsif private_method_defined?(without_method)
+          private method
+        end
       end
     end
   end

data/lib/delayed/performable_method.rb

@@ -1,11 +1,7 @@
-require 'active_support/core_ext/module/delegation'
-
 module Delayed
   class PerformableMethod
     attr_accessor :object, :method_name, :args
 
-    delegate :method, :to => :object
-
     def initialize(object, method_name, args)
       raise NoMethodError, "undefined method `#{method_name}' for #{object.inspect}" unless object.respond_to?(method_name, true)
 
@@ -30,6 +26,10 @@ module Delayed
       object.send(method_name, *args) if object
     end
 
+    def method(sym)
+      object.method(sym)
+    end
+
     def method_missing(symbol, *args)
       object.send(symbol, *args)
     end

data/lib/delayed/psych_ext.rb

@@ -31,7 +31,7 @@ module Delayed
         return revive(Psych.load_tags[object.tag], object) if Psych.load_tags[object.tag]
 
         case object.tag
-        when /^!ruby\/object/
+        when %r{^!ruby/object}
           result = super
           if defined?(ActiveRecord::Base) && result.is_a?(ActiveRecord::Base)
             klass = result.class
@@ -44,7 +44,7 @@ module Delayed
           else
             result
           end
-        when /^!ruby\/ActiveRecord:(.+)$/
+        when %r{^!ruby/ActiveRecord:(.+)$}
           klass = resolve_class(Regexp.last_match[1])
           payload = Hash[*object.children.map { |c| accept c }]
           id = payload['attributes'][klass.primary_key]
@@ -54,7 +54,7 @@ module Delayed
           rescue ActiveRecord::RecordNotFound => error
             raise Delayed::DeserializationError, "ActiveRecord::RecordNotFound, class: #{klass}, primary key: #{id} (#{error.message})"
           end
-        when /^!ruby\/Mongoid:(.+)$/
+        when %r{^!ruby/Mongoid:(.+)$}
           klass = resolve_class(Regexp.last_match[1])
           payload = Hash[*object.children.map { |c| accept c }]
           id = payload['attributes']['_id']
@@ -63,7 +63,7 @@ module Delayed
           rescue Mongoid::Errors::DocumentNotFound => error
             raise Delayed::DeserializationError, "Mongoid::Errors::DocumentNotFound, class: #{klass}, primary key: #{id} (#{error.message})"
           end
-        when /^!ruby\/DataMapper:(.+)$/
+        when %r{^!ruby/DataMapper:(.+)$}
           klass = resolve_class(Regexp.last_match[1])
           payload = Hash[*object.children.map { |c| accept c }]
           begin

data/lib/delayed/worker.rb

@@ -1,20 +1,22 @@
 require 'timeout'
+require 'active_support/dependencies'
 require 'active_support/core_ext/numeric/time'
 require 'active_support/core_ext/class/attribute_accessors'
-require 'active_support/core_ext/kernel'
-require 'active_support/core_ext/enumerable'
+require 'active_support/hash_with_indifferent_access'
+require 'active_support/core_ext/hash/indifferent_access'
 require 'logger'
 require 'benchmark'
 
 module Delayed
   class Worker # rubocop:disable ClassLength
-    DEFAULT_LOG_LEVEL        = 'info'
+    DEFAULT_LOG_LEVEL        = 'info'.freeze
     DEFAULT_SLEEP_DELAY      = 5
     DEFAULT_MAX_ATTEMPTS     = 25
     DEFAULT_MAX_RUN_TIME     = 4.hours
     DEFAULT_DEFAULT_PRIORITY = 0
     DEFAULT_DELAY_JOBS       = true
-    DEFAULT_QUEUES           = []
+    DEFAULT_QUEUES           = [].freeze
+    DEFAULT_QUEUE_ATTRIBUTES = HashWithIndifferentAccess.new.freeze
     DEFAULT_READ_AHEAD       = 5
 
     cattr_accessor :min_priority, :max_priority, :max_attempts, :max_run_time,
@@ -25,7 +27,7 @@ module Delayed
     # Named queue into which jobs are enqueued by default
     cattr_accessor :default_queue_name
 
-    cattr_reader :backend
+    cattr_reader :backend, :queue_attributes
 
     # name_prefix is ignored if name is set directly
     attr_accessor :name_prefix
@@ -38,12 +40,11 @@ module Delayed
       self.default_priority  = DEFAULT_DEFAULT_PRIORITY
       self.delay_jobs        = DEFAULT_DELAY_JOBS
       self.queues            = DEFAULT_QUEUES
+      self.queue_attributes  = DEFAULT_QUEUE_ATTRIBUTES
       self.read_ahead        = DEFAULT_READ_AHEAD
       @lifecycle             = nil
     end
 
-    reset
-
     # Add or remove plugins in this list before the worker is instantiated
     self.plugins = [Delayed::Plugins::ClearLocks]
 
@@ -70,6 +71,11 @@ module Delayed
       silence_warnings { ::Delayed.const_set(:Job, backend) }
     end
 
+    # rubocop:disable ClassVars
+    def self.queue_attributes=(val)
+      @@queue_attributes = val.with_indifferent_access
+    end
+
     def self.guess_backend
       warn '[DEPRECATION] guess_backend is deprecated. Please remove it from your code.'
     end
@@ -170,7 +176,7 @@ module Delayed
             end
           end
 
-          count = @result.sum
+          count = @result[0] + @result[1]
 
           if count.zero?
             if self.class.exit_on_complete
@@ -319,3 +325,5 @@ module Delayed
     end
   end
 end
+
+Delayed::Worker.reset

data/lib/delayed_job.rb

@@ -1,4 +1,3 @@
-require 'active_support'
 require 'delayed/compatibility'
 require 'delayed/exceptions'
 require 'delayed/message_sending'
@@ -14,6 +13,7 @@ require 'delayed/lifecycle'
 require 'delayed/plugin'
 require 'delayed/plugins/clear_locks'
 require 'delayed/backend/base'
+require 'delayed/backend/job_preparer'
 require 'delayed/worker'
 require 'delayed/deserialization_error'
 require 'delayed/railtie' if defined?(Rails::Railtie)

data/spec/delayed/command_spec.rb

@@ -159,8 +159,7 @@ describe Delayed::Command do
   describe 'running worker pools defined by multiple --pool arguments' do
     it 'should run the correct worker processes' do
       command = Delayed::Command.new(['--pool=*:1', '--pool=test_queue:4', '--pool=mailers,misc:2'])
-
-      expect(Dir).to receive(:mkdir).with('./tmp/pids').once
+      expect(FileUtils).to receive(:mkdir_p).with('./tmp/pids').once
 
       [
         ['delayed_job.0', {:quiet => true, :pid_dir => './tmp/pids', :log_dir => './log', :queues => []}],

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: delayed_job
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 4.1.2
 platform: ruby
 authors:
 - Brandon Keepers
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-24 00:00:00.000000000 Z
+date: 2016-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -26,7 +26,7 @@ dependencies:
         version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -36,7 +36,7 @@ dependencies:
         version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
 description: Delayed_job (or DJ) encapsulates the common pattern of asynchronously
   executing longer tasks in the background. It is a direct extraction from Shopify
   where the job table is responsible for a multitude of core tasks.
@@ -57,6 +57,7 @@ files:
 - contrib/delayed_job_rails_4_multiple.monitrc
 - delayed_job.gemspec
 - lib/delayed/backend/base.rb
+- lib/delayed/backend/job_preparer.rb
 - lib/delayed/backend/shared_spec.rb
 - lib/delayed/command.rb
 - lib/delayed/compatibility.rb
@@ -118,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Database-backed asynchronous priority queue system -- Extracted from Shopify