delayed_job 2.0.3 → 2.0.4

data/.gitignore

@@ -1,2 +1,3 @@
+.rvmrc
 *.gem
 *.swp

data/CHANGELOG

@@ -0,0 +1,50 @@
+2.0.4 - 2010-11-14
+* Fix issue where dirty tracking prevented job from being properly unlocked
+* Add delayed_job_args variable for Capistrano recipe to allow configuration of started workers (e.g. "-n 2 --max-priority 10")
+* Added options to handle_asynchronously
+* Added Delayed::Worker.default_priority
+* Allow private methods to be delayed
+* Fixes for Ruby 1.9
+* Added -m command line option to start a monitor process
+* normalize logging in worker
+* Deprecate #send_later and #send_at in favor of new #delay method
+* Added @#delay@ to Object that allows you to delay any method and pass options:
+    options = {:priority => 19, :run_at => 5.minutes.from_now}
+    UserMailer.delay(options).deliver_confirmation(@user)
+
+2.0.3 - 2010-04-16
+
+* Fix initialization for Rails 2.x
+
+2.0.2 - 2010-04-08
+
+* Fixes to Mongo Mapper backend [ "14be7a24":http://github.com/collectiveidea/delayed_job/commit/14be7a24, "dafd5f46":http://github.com/collectiveidea/delayed_job/commit/dafd5f46, "54d40913":http://github.com/collectiveidea/delayed_job/commit/54d40913 ]
+* DataMapper backend performance improvements [ "93833cce":http://github.com/collectiveidea/delayed_job/commit/93833cce, "e9b1573e":http://github.com/collectiveidea/delayed_job/commit/e9b1573e, "37a16d11":http://github.com/collectiveidea/delayed_job/commit/37a16d11, "803f2bfa":http://github.com/collectiveidea/delayed_job/commit/803f2bfa ]
+* Fixed Delayed::Command to create tmp/pids directory [ "8ec8ca41":http://github.com/collectiveidea/delayed_job/commit/8ec8ca41 ]
+* Railtie to perform Rails 3 initialization [ "3e0fc41f":http://github.com/collectiveidea/delayed_job/commit/3e0fc41f ]
+* Added on_permanent_failure hook [ "d2f14cd6":http://github.com/collectiveidea/delayed_job/commit/d2f14cd6 ]
+
+2.0.1 - 2010-04-03
+* Bug fix for using ActiveRecord backend with daemon [martinbtt]
+
+2.0.0 - 2010-04-03
+* Multiple backend support (See README for more details)
+* Added MongoMapper backend [zbelzer, moneypools]
+* Added DataMapper backend [lpetre]
+* Reverse priority so the jobs table can be indexed. Lower numbers have higher priority. The default priority is 0, so increase it for jobs that are not important.
+* Move most of the heavy lifting from Job to Worker (#work_off, #reschedule, #run, #min_priority, #max_priority, #max_run_time, #max_attempts, #worker_name) [albus522]
+* Remove EvaledJob. Implement your own if you need this functionality.
+* Only use Time.zone if it is set. Closes #20
+* Fix for last_error recording when destroy_failed_jobs = false, max_attempts = 1
+* Implemented worker name_prefix to maintain dynamic nature of pid detection
+* Some Rails 3 compatibility fixes [fredwu]
+
+1.8.5 - 2010-03-15
+
+* Set auto_flushing=true on Rails logger to fix logging in production
+* Fix error message when trying to send_later on a method that doesn't exist
+* Don't use rails_env in capistrano if it's not set. closes #22
+* Delayed job should append to delayed_job.log not overwrite
+* Version bump to 1.8.5
+* fixing Time.now to be Time.zone.now if set to honor the app set local TimeZone
+* Replaced @Worker::SLEEP@, @Job::MAX_ATTEMPTS@, and @Job::MAX_RUN_TIME@ with class methods that can be overridden.

data/README.textile

@@ -1,6 +1,6 @@
 h1. Delayed::Job
 
-Delated_job (or DJ) encapsulates the common pattern of asynchronously executing longer tasks in the background. 
+Delated_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. Amongst those tasks are:
 
@@ -9,11 +9,13 @@ It is a direct extraction from Shopify where the job table is responsible for a
 * http downloads
 * updating smart collections
 * updating solr, our search server, after product changes
-* batch imports 
-* spam checks 
+* batch imports
+* spam checks
 
 h2. Installation
 
+This version is for Rails 2.x only.  For rails 3 support, install delayed_job 2.1.
+
 To install as a gem, add the following to @config/environment.rb@:
 
 <pre>
@@ -53,8 +55,12 @@ $ rake db:migrate
 
 h3. MongoMapper
 
+You must use @MongoMapper.setup@ in the initializer:
+
 <pre>
-# config/initializers/delayed_job.rb
+config = YAML::load(File.read(Rails.root.join('config/mongo.yml')))
+MongoMapper.setup(config, Rails.env)
+
 Delayed::Worker.backend = :mongo_mapper
 </pre>
 
@@ -68,14 +74,14 @@ Delayed::Worker.backend.auto_upgrade!
 
 h2. Queuing Jobs
 
-Call @#send_later(method, params)@ on any object and it will be processed in the background.
+Call @.delay.method(params)@ on any object and it will be processed in the background.
 
 <pre>
 # without delayed_job
 Notifier.deliver_signup(@user)
 
 # with delayed_job
-Notifier.send_later :deliver_signup, @user
+Notifier.delay.deliver_signup @user
 </pre>
 
 If a method should always be run in the background, you can call @#handle_asynchronously@ after the method declaration:
@@ -92,6 +98,39 @@ device = Device.new
 device.deliver
 </pre>
 
+handle_asynchronously can take as options anything you can pass to delay. In addition the values can be Proc objects allowing call time evaluation of the value. For some examples:
+
+<pre>
+class LongTasks
+  def send_mailer
+    # Some other code
+  end
+  handle_asynchronously :send_mailer, :priority => 20
+
+  def in_the_future
+    # Some other code
+  end
+  # 5.minutes.from_now will be evaluated when in_the_future is called
+  handle_asynchronously :in_the_future, :run_at => Proc.new { 5.minutes.from_now }
+
+  def self.when_to_run
+    2.hours.from_now
+  end
+
+  def call_a_class_method
+    # Some other code
+  end
+  handle_asynchronously :call_a_class_method, :run_at => Proc.new { when_to_run }
+
+  attr_reader :how_important
+
+  def call_an_instance_method
+    # Some other code
+  end
+  handle_asynchronously :call_an_instance_method, :priority => Proc.new {|i| i.how_important }
+end
+</pre>
+
 h2. Running Jobs
 
 @script/delayed_job@ can be used to manage a background process which will start working off jobs.  Make sure you've run `script/generate delayed_job`.
@@ -107,19 +146,19 @@ $ RAILS_ENV=production script/delayed_job stop
 
 Workers can be running on any computer, as long as they have access to the database and their clock is in sync. Keep in mind that each worker will check the database at least every 5 seconds.
 
-You can also invoke @rake jobs:work@ which will start working off jobs. You can cancel the rake task with @CTRL-C@. 
+You can also invoke @rake jobs:work@ which will start working off jobs. You can cancel the rake task with @CTRL-C@.
 
 h2. Custom Jobs
 
-Jobs are simple ruby objects with a method called perform. Any object which responds to perform can be stuffed into the jobs table. Job objects are serialized to yaml so that they can later be resurrected by the job runner. 
+Jobs are simple ruby objects with a method called perform. Any object which responds to perform can be stuffed into the jobs table. Job objects are serialized to yaml so that they can later be resurrected by the job runner.
 
 <pre>
 class NewsletterJob < Struct.new(:text, :emails)
   def perform
     emails.each { |e| NewsletterMailer.deliver_text_to_email(text, e) }
-  end    
-end  
-  
+  end
+end
+
 Delayed::Job.enqueue NewsletterJob.new('lorem ipsum...', Customers.find(:all).collect(&:email))
 </pre>
 
@@ -129,17 +168,17 @@ You can also add an optional on_permanent_failure method which will run if the j
 class ParanoidNewsletterJob < NewsletterJob
   def perform
     emails.each { |e| NewsletterMailer.deliver_text_to_email(text, e) }
-  end    
+  end
 
   def on_permanent_failure
     page_sysadmin_in_the_middle_of_the_night
   end
-end  
+end
 </pre>
 
 h2. Gory Details
 
-The library evolves around a delayed_jobs table which looks as follows: 
+The library evolves around a delayed_jobs table which looks as follows:
 
 <pre>
 create_table :delayed_jobs, :force => true do |table|
@@ -200,14 +239,7 @@ If you want to contribute an enhancement or a fix:
 # Commit the changes without making changes to the Rakefile, VERSION, or any other files that aren't related to your enhancement or fix
 # Send a pull request.
 
-h3. Changes
-
-* 1.7.0: Added failed_at column which can optionally be set after a certain amount of failed job attempts. By default failed job attempts are destroyed after about a month. 
-
-* 1.6.0: Renamed locked_until to locked_at. We now store when we start a given job instead of how long it will be locked by the worker. This allows us to get a reading on how long a job took to execute.                    
-
-* 1.5.0: Job runners can now be run in parallel. Two new database columns are needed: locked_until and locked_by. This allows us to use   pessimistic locking instead of relying on row level locks. This enables us to run as many worker processes as we need to speed up queue processing.
+h3. Changelog
 
-* 1.2.0: Added #send_later to Object for simpler job creation
+See http://wiki.github.com/collectiveidea/delayed_job/changelog for a list of changes.
 
-* 1.0.0: Initial release

data/Rakefile

@@ -13,13 +13,13 @@ Jeweler::Tasks.new do |s|
   s.homepage = "http://github.com/collectiveidea/delayed_job"
   s.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.\n\nThis gem is collectiveidea's fork (http://github.com/collectiveidea/delayed_job)."
   s.authors  = ["Brandon Keepers", "Tobias Lütke"]
-  
+
   s.has_rdoc = true
   s.rdoc_options = ["--main", "README.textile", "--inline-source", "--line-numbers"]
   s.extra_rdoc_files = ["README.textile"]
-  
+
   s.test_files = Dir['spec/*_spec.rb']
-  
+
   s.add_dependency "daemons"
   s.add_development_dependency "rspec"
   s.add_development_dependency "sqlite3-ruby"
@@ -33,14 +33,13 @@ Jeweler::Tasks.new do |s|
 end
 
 require 'spec/rake/spectask'
-
-task :default => :spec
-
 desc 'Run the specs'
 Spec::Rake::SpecTask.new(:spec) do |t|
   t.libs << 'lib'
   t.pattern = 'spec/*_spec.rb'
-  t.verbose = true
+  t.verbose = false
 end
+
 task :spec => :check_dependencies
+task :default => :spec
 

data/VERSION

@@ -1 +1 @@
-2.0.3
+2.0.4

data/benchmarks.rb

@@ -26,7 +26,7 @@ Benchmark.bm(10) do |x|
     Delayed::Worker.backend = backend
   
     n = 10000
-    n.times { "foo".send_later :length }
+    n.times { "foo".delay.length }
 
     x.report(backend.to_s) { Delayed::Worker.new(:quiet => true).work_off(n) }
   end  

data/delayed_job.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{delayed_job}
-  s.version = "2.0.3"
+  s.version = "2.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brandon Keepers", "Tobias L\303\274tke"]
-  s.date = %q{2010-04-16}
+  s.date = %q{2010-11-14}
   s.description = %q{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.
 
 This gem is collectiveidea's fork (http://github.com/collectiveidea/delayed_job).}
@@ -19,6 +19,8 @@ This gem is collectiveidea's fork (http://github.com/collectiveidea/delayed_job)
   ]
   s.files = [
     ".gitignore",
+     ".rvmrc",
+     "CHANGELOG",
      "MIT-LICENSE",
      "README.textile",
      "Rakefile",
@@ -50,6 +52,7 @@ This gem is collectiveidea's fork (http://github.com/collectiveidea/delayed_job)
      "spec/backend/mongo_mapper_job_spec.rb",
      "spec/backend/shared_backend_spec.rb",
      "spec/delayed_method_spec.rb",
+     "spec/message_sending_spec.rb",
      "spec/performable_method_spec.rb",
      "spec/sample_jobs.rb",
      "spec/setup/active_record.rb",
@@ -63,10 +66,11 @@ This gem is collectiveidea's fork (http://github.com/collectiveidea/delayed_job)
   s.homepage = %q{http://github.com/collectiveidea/delayed_job}
   s.rdoc_options = ["--main", "README.textile", "--inline-source", "--line-numbers"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Database-backed asynchronous priority queue system -- Extracted from Shopify}
   s.test_files = [
     "spec/delayed_method_spec.rb",
+     "spec/message_sending_spec.rb",
      "spec/performable_method_spec.rb",
      "spec/story_spec.rb",
      "spec/worker_spec.rb"
@@ -76,7 +80,7 @@ This gem is collectiveidea's fork (http://github.com/collectiveidea/delayed_job)
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<daemons>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])

data/lib/delayed/backend/active_record.rb

@@ -63,8 +63,10 @@ module Delayed
             self.class.update_all(["locked_at = ?", now], ["id = ? and locked_by = ?", id, worker])
           end
           if affected_rows == 1
-            self.locked_at    = now
-            self.locked_by    = worker
+            self.locked_at = now
+            self.locked_by = worker
+            self.locked_at_will_change!
+            self.locked_by_will_change!
             return true
           else
             return false

data/lib/delayed/backend/base.rb

@@ -16,7 +16,7 @@ module Delayed
             raise ArgumentError, 'Cannot enqueue items which do not respond to perform'
           end
     
-          priority = args.first || 0
+          priority = args.first || Delayed::Worker.default_priority
           run_at   = args[1]
           self.create(:payload_object => object, :priority => priority.to_i, :run_at => run_at)
         end
@@ -42,10 +42,6 @@ module Delayed
       end
       alias_method :failed, :failed?
 
-      def payload_object
-        @payload_object ||= deserialize(self['handler'])
-      end
-
       def name
         @name ||= begin
           payload = payload_object
@@ -61,6 +57,10 @@ module Delayed
         self['handler'] = object.to_yaml
       end
       
+      def payload_object
+        @payload_object ||= deserialize(self['handler'])
+      end
+
       # Moved into its own method so that new_relic can trace it.
       def invoke_job
         payload_object.perform
@@ -108,4 +108,4 @@ module Delayed
     
     end
   end
-end
+end

data/lib/delayed/command.rb

@@ -14,6 +14,7 @@ module Delayed
       }
       
       @worker_count = 1
+      @monitor = false
       
       opts = OptionParser.new do |opts|
         opts.banner = "Usage: #{File.basename($0)} [options] start|stop|restart|run"
@@ -40,6 +41,11 @@ module Delayed
         opts.on('-i', '--identifier=n', 'A numeric identifier for the worker.') do |n|
           @options[:identifier] = n
         end
+        opts.on('-m', '--monitor', 'Start monitor process.') do
+          @monitor = true
+        end
+        
+
       end
       @args = opts.parse!(args)
     end
@@ -68,7 +74,7 @@ module Delayed
     end
     
     def run_process(process_name, dir)
-      Daemons.run_proc(process_name, :dir => dir, :dir_mode => :normal, :ARGV => @args) do |*args|
+      Daemons.run_proc(process_name, :dir => dir, :dir_mode => :normal, :monitor => @monitor, :ARGV => @args) do |*args|
         run process_name
       end
     end
@@ -79,7 +85,7 @@ module Delayed
       # Re-open file handles
       @files_to_reopen.each do |file|
         begin
-          file.reopen file.path
+          file.reopen file.path, "a+"
           file.sync = true
         rescue ::Exception
         end

data/lib/delayed/message_sending.rb

@@ -1,22 +1,53 @@
 module Delayed
+  class DelayProxy < ActiveSupport::BasicObject
+    def initialize(target, options)
+      @target = target
+      @options = options
+    end
+
+    def method_missing(method, *args)
+      Job.create({
+        :payload_object => PerformableMethod.new(@target, method.to_sym, args),
+        :priority       => ::Delayed::Worker.default_priority
+      }.merge(@options))
+    end
+  end
+
   module MessageSending
+    def delay(options = {})
+      DelayProxy.new(self, options)
+    end
+    alias __delay__ delay
+    
     def send_later(method, *args)
-      Delayed::Job.enqueue Delayed::PerformableMethod.new(self, method.to_sym, args)
+      warn "[DEPRECATION] `object.send_later(:method)` is deprecated. Use `object.delay.method"
+      __delay__.__send__(method, *args)
     end
 
     def send_at(time, method, *args)
-      Delayed::Job.enqueue(Delayed::PerformableMethod.new(self, method.to_sym, args), 0, time)
+      warn "[DEPRECATION] `object.send_at(time, :method)` is deprecated. Use `object.delay(:run_at => time).method"
+      __delay__(:run_at => time).__send__(method, *args)
     end
     
     module ClassMethods
-      def handle_asynchronously(method)
+      def handle_asynchronously(method, opts = {})
         aliased_method, punctuation = method.to_s.sub(/([?!=])$/, ''), $1
-        with_method, without_method = "#{aliased_method}_with_send_later#{punctuation}", "#{aliased_method}_without_send_later#{punctuation}"
+        with_method, without_method = "#{aliased_method}_with_delay#{punctuation}", "#{aliased_method}_without_delay#{punctuation}"
         define_method(with_method) do |*args|
-          send_later(without_method, *args)
+          curr_opts = opts.clone
+          curr_opts.each_key do |key|
+            if (val = curr_opts[key]).is_a?(Proc)
+              curr_opts[key] = if val.arity == 1
+                val.call(self)
+              else
+                val.call
+              end
+            end
+          end
+          delay(curr_opts).__send__(without_method, *args)
         end
-        alias_method_chain method, :send_later
+        alias_method_chain method, :delay
       end
     end
   end                               
-end
+end

data/lib/delayed/performable_method.rb

@@ -16,7 +16,7 @@ module Delayed
     end
 
     def initialize(object, method, args)
-      raise NoMethodError, "undefined method `#{method}' for #{object.inspect}" unless object.respond_to?(method)
+      raise NoMethodError, "undefined method `#{method}' for #{object.inspect}" unless object.respond_to?(method, true)
 
       self.object = dump(object)
       self.args   = args.map { |a| dump(a) }

data/lib/delayed/recipes.rb

@@ -13,6 +13,10 @@ Capistrano::Configuration.instance.load do
       fetch(:rails_env, false) ? "RAILS_ENV=#{fetch(:rails_env)}" : ''
     end
     
+    def args
+      fetch(:delayed_job_args, "")
+    end
+    
     desc "Stop the delayed_job process"
     task :stop, :roles => :app do
       run "cd #{current_path};#{rails_env} script/delayed_job stop"
@@ -20,12 +24,12 @@ Capistrano::Configuration.instance.load do
 
     desc "Start the delayed_job process"
     task :start, :roles => :app do
-      run "cd #{current_path};#{rails_env} script/delayed_job start"
+      run "cd #{current_path};#{rails_env} script/delayed_job start #{args}"
     end
 
     desc "Restart the delayed_job process"
     task :restart, :roles => :app do
-      run "cd #{current_path};#{rails_env} script/delayed_job restart"
+      run "cd #{current_path};#{rails_env} script/delayed_job restart #{args}"
     end
   end
 end

data/lib/delayed/worker.rb

@@ -3,10 +3,11 @@ require 'active_support/core_ext/numeric/time'
 
 module Delayed
   class Worker
-    cattr_accessor :min_priority, :max_priority, :max_attempts, :max_run_time, :sleep_delay, :logger
+    cattr_accessor :min_priority, :max_priority, :max_attempts, :max_run_time, :default_priority, :sleep_delay, :logger
     self.sleep_delay = 5
     self.max_attempts = 25
     self.max_run_time = 4.hours
+    self.default_priority = 0
     
     # By default failed jobs are destroyed after too many attempts. If you want to keep them around
     # (perhaps to inspect the reason for the failure), set this to false.
@@ -66,7 +67,7 @@ module Delayed
     end
 
     def start
-      say "*** Starting job worker #{name}"
+      say "Starting job worker"
 
       trap('TERM') { say 'Exiting...'; $exit = true }
       trap('INT')  { say 'Exiting...'; $exit = true }
@@ -120,8 +121,7 @@ module Delayed
         Timeout.timeout(self.class.max_run_time.to_i) { job.invoke_job }
         job.destroy
       end
-      # TODO: warn if runtime > max_run_time ?
-      say "* [JOB] #{name} completed after %.4f" % runtime
+      say "#{job.name} completed after %.4f" % runtime
       return true  # did work
     rescue Exception => e
       handle_failed_job(job, e)
@@ -137,10 +137,10 @@ module Delayed
         job.unlock
         job.save!
       else
-        say "* [JOB] PERMANENTLY removing #{job.name} because of #{job.attempts} consecutive failures.", Logger::INFO
+        say "PERMANENTLY removing #{job.name} because of #{job.attempts} consecutive failures.", Logger::INFO
 
         if job.payload_object.respond_to? :on_permanent_failure
-          say "* [JOB] Running on_permanent_failure hook"
+          say "Running on_permanent_failure hook"
           job.payload_object.on_permanent_failure
         end
 
@@ -149,6 +149,7 @@ module Delayed
     end
 
     def say(text, level = Logger::INFO)
+      text = "[Worker(#{name})] #{text}"
       puts text unless @quiet
       logger.add level, "#{Time.now.strftime('%FT%T%z')}: #{text}" if logger
     end
@@ -157,7 +158,7 @@ module Delayed
     
     def handle_failed_job(job, error)
       job.last_error = error.message + "\n" + error.backtrace.join("\n")
-      say "* [JOB] #{name} failed with #{error.class.name}: #{error.message} - #{job.attempts} failed attempts", Logger::ERROR
+      say "#{job.name} failed with #{error.class.name}: #{error.message} - #{job.attempts} failed attempts", Logger::ERROR
       reschedule(job)
     end
     
@@ -169,10 +170,10 @@ module Delayed
       # this leads to a more even distribution of jobs across the worker processes
       job = Delayed::Job.find_available(name, 5, self.class.max_run_time).detect do |job|
         if job.lock_exclusively!(self.class.max_run_time, name)
-          say "* [Worker(#{name})] acquired lock on #{job.name}"
+          say "acquired lock on #{job.name}"
           true
         else
-          say "* [Worker(#{name})] failed to acquire exclusive lock for #{job.name}", Logger::WARN
+          say "failed to acquire exclusive lock for #{job.name}", Logger::WARN
           false
         end
       end

data/spec/backend/mongo_mapper_job_spec.rb

@@ -6,11 +6,11 @@ describe Delayed::Backend::MongoMapper::Job do
   before(:all) do
     @backend = Delayed::Backend::MongoMapper::Job
   end
-  
+
   before(:each) do
     MongoMapper.database.collections.each(&:remove)
   end
-  
+
   it_should_behave_like 'a backend'
 
   describe "indexes" do
@@ -22,36 +22,36 @@ describe Delayed::Backend::MongoMapper::Job do
       @backend.collection.index_information.detect { |index| index[0] == 'locked_by_1' }.should_not be_nil
     end
   end
-  
+
   describe "delayed method" do
     class MongoStoryReader
       def read(story)
         "Epilog: #{story.tell}"
       end
     end
-    
+
     class MongoStory
       include ::MongoMapper::Document
       key :text, String
-      
+
       def tell
         text
       end
     end
-    
+
     it "should ignore not found errors because they are permanent" do
       story = MongoStory.create :text => 'Once upon a time...'
-      job = story.send_later(:tell)
+      job = story.delay.tell
       story.destroy
       lambda { job.invoke_job }.should_not raise_error
     end
 
     it "should store the object as string" do
       story = MongoStory.create :text => 'Once upon a time...'
-      job = story.send_later(:tell)
+      job = story.delay.tell
 
       job.payload_object.class.should   == Delayed::PerformableMethod
-      job.payload_object.object.should  == "LOAD;MongoStory;#{story.id}"
+      job.payload_object.object.should  == story
       job.payload_object.method.should  == :tell
       job.payload_object.args.should    == []
       job.payload_object.perform.should == 'Once upon a time...'
@@ -59,19 +59,19 @@ describe Delayed::Backend::MongoMapper::Job do
 
     it "should store arguments as string" do
       story = MongoStory.create :text => 'Once upon a time...'
-      job = MongoStoryReader.new.send_later(:read, story)
+      job = MongoStoryReader.new.delay.read(story)
       job.payload_object.class.should   == Delayed::PerformableMethod
       job.payload_object.method.should  == :read
-      job.payload_object.args.should    == ["LOAD;MongoStory;#{story.id}"]
+      job.payload_object.args.should    == [story]
       job.payload_object.perform.should == 'Epilog: Once upon a time...'
     end
   end
-  
+
   describe "before_fork" do
     after do
       MongoMapper.connection.connect_to_master
     end
-    
+
     it "should disconnect" do
       lambda do
         Delayed::Backend::MongoMapper::Job.before_fork
@@ -83,12 +83,12 @@ describe Delayed::Backend::MongoMapper::Job do
     before do
       MongoMapper.connection.close
     end
-    
+
     it "should call reconnect" do
       lambda do
         Delayed::Backend::MongoMapper::Job.after_fork
       end.should change { !!MongoMapper.connection.connected? }.from(false).to(true)
     end
   end
-  
+
 end

data/spec/backend/shared_backend_spec.rb

@@ -6,6 +6,7 @@ shared_examples_for 'a backend' do
   before do
     Delayed::Worker.max_priority = nil
     Delayed::Worker.min_priority = nil
+    Delayed::Worker.default_priority = 99
     SimpleJob.runs = 0
   end
   
@@ -32,6 +33,11 @@ shared_examples_for 'a backend' do
     @job.priority.should == 5
   end
 
+  it "should use default priority when it is not set" do
+    @job = @backend.enqueue SimpleJob.new
+    @job.priority.should == 99
+  end
+
   it "should be able to set run_at when enqueuing items" do
     later = @backend.db_time_now + 5.minutes
     @job = @backend.enqueue SimpleJob.new, 5, later
@@ -173,12 +179,12 @@ shared_examples_for 'a backend' do
     end
 
     it "should be the method that will be called if its a performable method object" do
-      @job = Story.send_later(:create)
+      @job = Story.delay.create
       @job.name.should == "Story.create"
     end
 
     it "should be the instance method that will be called if its a performable method object" do
-      @job = Story.create(:text => "...").send_later(:save)
+      @job = Story.create(:text => "...").delay.save
       @job.name.should == 'Story#save'
     end
   end
@@ -244,18 +250,9 @@ shared_examples_for 'a backend' do
   end
   
   context "large handler" do
-    @@text = %{Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus eu vehicula augue. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Quisque odio lectus, volutpat sed dictum rutrum, interdum aliquam neque. Vivamus quis velit nisi, quis dictum purus. Duis magna nisi, faucibus nec molestie vitae, dictum eget odio. Nunc nulla mauris, vestibulum at dapibus nec, dapibus et lectus. Nullam sapien lacus, consectetur eget mattis in, rhoncus sed ipsum. Nullam nec nibh nisl. Integer ut erat in arcu feugiat semper. Nulla gravida sapien quam. Vestibulum pharetra elementum posuere. Fusce mattis justo auctor nibh facilisis vitae consectetur nibh vehicula.
-
-    Ut at pharetra justo. Donec dictum ornare tortor in feugiat. Sed ac purus sem. Aenean dignissim, erat vel bibendum mollis, elit neque mollis mauris, vitae pretium diam enim non leo. Aliquam aliquet, odio id iaculis varius, metus nibh fermentum sapien, a euismod turpis lectus sit amet turpis. Morbi sapien est, scelerisque in placerat in, varius nec mauris. Aliquam erat volutpat. Quisque suscipit tincidunt libero, sed tincidunt libero iaculis et. Vivamus sed faucibus elit. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus dignissim sem sed tortor semper et lacinia leo viverra. Nulla nec quam at arcu ullamcorper imperdiet vitae in ligula. Quisque placerat vulputate orci sit amet tempor. Duis sed quam nulla. Cras quis mi nibh, at euismod velit. Etiam nec nunc libero, sed condimentum diam.
-
-    Duis nec mauris in est suscipit viverra a in nibh. Suspendisse nec nulla tortor. Etiam et nulla tellus. Nam feugiat adipiscing commodo. Curabitur scelerisque varius lacus non hendrerit. Vivamus nec enim non turpis auctor tempus sit amet in nisi. Sed ligula nulla, condimentum sed tempor vel, imperdiet id mauris. Quisque mollis ante eu magna tempus porttitor. Integer est libero, consectetur sed tristique a, scelerisque id risus. Donec lacinia justo eget diam fringilla vitae egestas dolor feugiat. Vivamus massa ante, mattis et hendrerit nec, dictum vitae nulla. Pellentesque at nisl et odio suscipit ullamcorper cursus quis enim. Ut nec tellus molestie erat dignissim mollis. Curabitur quis ipsum sapien, sed tincidunt massa. Vestibulum volutpat pretium fringilla.
-
-    Integer at lorem sit amet nibh suscipit euismod et ut ante. Maecenas feugiat hendrerit dolor, eget egestas velit consequat eget. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Suspendisse ut nunc odio. Vivamus semper, sem vitae sollicitudin auctor, leo mi vulputate augue, eget venenatis libero nunc ut dolor. Phasellus vulputate, metus et dapibus tempus, tellus arcu ullamcorper leo, porttitor dictum lectus turpis blandit sapien. Pellentesque et accumsan justo. Maecenas elit nisi, tincidunt eget consequat a, laoreet et magna. Pellentesque venenatis felis ut massa ultrices bibendum. Duis vulputate tempor leo at bibendum. Curabitur aliquet, turpis sit amet porta porttitor, nibh mi vehicula dolor, suscipit aliquet mi augue quis magna. Praesent tellus turpis, malesuada at ultricies id, feugiat a urna. Curabitur sed mi magna.
-
-    Quisque adipiscing dignissim mollis. Aenean blandit, diam porttitor bibendum bibendum, leo neque tempus risus, in rutrum dolor elit a lorem. Aenean sollicitudin scelerisque ullamcorper. Nunc tristique ultricies nunc et imperdiet. Duis vitae egestas mauris. Suspendisse odio nisi, accumsan vel volutpat nec, aliquam vitae odio. Praesent elementum fermentum suscipit. Quisque quis tellus eu tellus bibendum luctus a quis nunc. Praesent dictum velit sed lacus dapibus ut ultricies mauris facilisis. Vivamus bibendum, ipsum sit amet facilisis consequat, leo lectus aliquam augue, eu consectetur magna nunc gravida sapien. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Duis tempor nisl ac odio molestie ut tincidunt purus varius. Nunc quis lorem nibh, vestibulum cursus lorem. Nunc sit amet est ut magna suscipit tempor vitae a augue.}
-
     before do
-      @job = @backend.enqueue Delayed::PerformableMethod.new(@@text, :length, {})
+      text = "Lorem ipsum dolor sit amet. " * 1000
+      @job = @backend.enqueue Delayed::PerformableMethod.new(text, :length, {})
     end
     
     it "should have an id" do

data/spec/delayed_method_spec.rb

@@ -1,25 +1,9 @@
 require 'spec_helper'
 
-describe 'random ruby objects' do
+describe Object do
   before       { Delayed::Job.delete_all }
 
-  it "should respond_to :send_later method" do
-    Object.new.respond_to?(:send_later)
-  end
-
-  it "should raise a ArgumentError if send_later is called but the target method doesn't exist" do
-    lambda { Object.new.send_later(:method_that_deos_not_exist) }.should raise_error(NoMethodError)
-  end
-
-  it "should add a new entry to the job table when send_later is called on it" do
-    lambda { Object.new.send_later(:to_s) }.should change { Delayed::Job.count }.by(1)
-  end
-
-  it "should add a new entry to the job table when send_later is called on the class" do
-    lambda { Object.send_later(:to_s) }.should change { Delayed::Job.count }.by(1)
-  end
-
-  it "should call send later on methods which are wrapped with handle_asynchronously" do
+  it "should call #delay on methods which are wrapped with handle_asynchronously" do
     story = Story.create :text => 'Once upon...'
   
     Delayed::Job.count.should == 0
@@ -29,31 +13,34 @@ describe 'random ruby objects' do
     Delayed::Job.count.should == 1
     job =  Delayed::Job.first
     job.payload_object.class.should   == Delayed::PerformableMethod
-    job.payload_object.method.should  == :whatever_without_send_later
+    job.payload_object.method.should  == :whatever_without_delay
     job.payload_object.args.should    == [1, 5]
     job.payload_object.perform.should == 'Once upon...'
   end
 
-  context "send_at" do
-    it "should queue a new job" do
-      lambda do
-        "string".send_at(1.hour.from_now, :length)
-      end.should change { Delayed::Job.count }.by(1)
+  context "delay" do
+    it "should raise a ArgumentError if target method doesn't exist" do
+      lambda { Object.new.delay.method_that_does_not_exist }.should raise_error(NoMethodError)
+    end
+
+    it "should add a new entry to the job table when delay is called on it" do
+      lambda { Object.new.delay.to_s }.should change { Delayed::Job.count }.by(1)
+    end
+
+    it "should add a new entry to the job table when delay is called on the class" do
+      lambda { Object.delay.to_s }.should change { Delayed::Job.count }.by(1)
     end
     
-    it "should schedule the job in the future" do
-      time = 1.hour.from_now.utc.to_time
-      job = "string".send_at(time, :length)
-      job.run_at.to_i.should == time.to_i
+    it "should set job options" do
+      run_at = 1.day.from_now
+      job = Object.delay(:priority => 20, :run_at => run_at).to_s
+      job.run_at.should == run_at
+      job.priority.should == 20
     end
     
-    it "should store payload as PerformableMethod" do
-      job = "string".send_at(1.hour.from_now, :count, 'r')
-      job.payload_object.class.should   == Delayed::PerformableMethod
-      job.payload_object.method.should  == :count
-      job.payload_object.args.should    == ['r']
-      job.payload_object.perform.should == 1
+    it "should save args for original method" do
+      job = 3.delay.+(5)
+      job.payload_object.args.should == [5]
     end
   end
-
 end

data/spec/message_sending_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe Delayed::MessageSending do
+  describe "handle_asynchronously" do
+    class Story < ActiveRecord::Base
+      def tell!(arg)
+      end
+      handle_asynchronously :tell!
+    end
+    
+    it "should alias original method" do
+      Story.new.should respond_to(:tell_without_delay!)
+      Story.new.should respond_to(:tell_with_delay!)
+    end
+    
+    it "should create a PerformableMethod" do
+      story = Story.create!
+      lambda {
+        job = story.tell!(1)
+        job.payload_object.class.should   == Delayed::PerformableMethod
+        job.payload_object.method.should  == :tell_without_delay!
+        job.payload_object.args.should    == [1]
+      }.should change { Delayed::Job.count }
+    end
+
+    describe 'with options' do
+      class Fable
+        class << self
+          attr_accessor :importance
+        end
+        def tell
+        end
+        handle_asynchronously :tell, :priority => Proc.new { self.importance }
+      end
+
+      it 'should set the priority based on the Fable importance' do
+        Fable.importance = 10
+        job = Fable.new.tell
+        job.priority.should == 10
+
+        Fable.importance = 20
+        job = Fable.new.tell
+        job.priority.should == 20
+      end
+
+      describe 'using a proc with parament' do
+        class Yarn
+          attr_accessor :importance
+          def spin
+          end
+          handle_asynchronously :spin, :priority => Proc.new {|y| y.importance }
+        end
+
+        it 'should set the priority based on the Fable importance' do
+          job = Yarn.new.tap {|y| y.importance = 10 }.spin
+          job.priority.should == 10
+
+          job = Yarn.new.tap {|y| y.importance = 20 }.spin
+          job.priority.should == 20
+        end
+      end
+    end
+  end
+
+  context "delay" do
+    it "should create a new PerformableMethod job" do
+      lambda {
+        job = "hello".delay.count('l')
+        job.payload_object.class.should   == Delayed::PerformableMethod
+        job.payload_object.method.should  == :count
+        job.payload_object.args.should    == ['l']
+      }.should change { Delayed::Job.count }.by(1)
+    end
+
+    it "should set default priority" do
+      Delayed::Worker.default_priority = 99
+      job = Object.delay.to_s
+      job.priority.should == 99
+      Delayed::Worker.default_priority = 0
+    end
+
+    it "should set job options" do
+      run_at = Time.parse('2010-05-03 12:55 AM')
+      job = Object.delay(:priority => 20, :run_at => run_at).to_s
+      job.run_at.should == run_at
+      job.priority.should == 20
+    end
+  end
+end

data/spec/performable_method_spec.rb

@@ -38,5 +38,16 @@ describe Delayed::PerformableMethod do
     p.method.should  == :read
     p.args.should    == ["LOAD;Story;#{story.id}"]
     p.perform.should == 'Epilog: Once upon...'
-  end                 
+  end
+
+  it "should not raise NoMethodError if target method is private" do
+    clazz = Class.new do
+      def private_method
+      end
+      private :private_method
+    end
+    lambda {
+      Delayed::PerformableMethod.new(clazz.new, :private_method, [])
+    }.should_not raise_error(NoMethodError)
+  end
 end

data/spec/spec_helper.rb

@@ -4,6 +4,8 @@ require 'rubygems'
 require 'spec'
 require 'logger'
 
+gem 'rails', '~>2.3.5'
+
 require 'delayed_job'
 require 'sample_jobs'
 

data/spec/story_spec.rb

@@ -11,7 +11,7 @@ describe "A story" do
   end
 
   it "should not return its result if it storytelling is delayed" do
-    @story.send_later(:tell).should_not == 'Once upon a time...'
+    @story.delay.tell.should_not == 'Once upon a time...'
   end
 
 end

data/spec/worker_spec.rb

@@ -104,6 +104,7 @@ describe Delayed::Worker do
           # reset defaults
           Delayed::Worker.destroy_failed_jobs = true
           Delayed::Worker.max_attempts = 25
+          Delayed::Job.delete_all
 
           @job = Delayed::Job.enqueue ErrorJob.new
         end
@@ -120,13 +121,15 @@ describe Delayed::Worker do
         end
     
         it "should re-schedule jobs after failing" do
-          @worker.run(@job)
+          @worker.work_off
           @job.reload
           @job.last_error.should =~ /did not work/
           @job.last_error.should =~ /sample_jobs.rb:8:in `perform'/
           @job.attempts.should == 1
           @job.run_at.should > Delayed::Job.db_time_now - 10.minutes
           @job.run_at.should < Delayed::Job.db_time_now + 10.minutes
+          @job.locked_at.should be_nil
+          @job.locked_by.should be_nil
         end
       end
   

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: delayed_job
 version: !ruby/object:Gem::Version 
+  hash: 7
   prerelease: false
   segments: 
   - 2
   - 0
-  - 3
-  version: 2.0.3
+  - 4
+  version: 2.0.4
 platform: ruby
 authors: 
 - Brandon Keepers
@@ -15,16 +16,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-16 00:00:00 -04:00
+date: 2010-11-14 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: daemons
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -34,9 +37,11 @@ dependencies:
   name: rspec
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -46,9 +51,11 @@ dependencies:
   name: sqlite3-ruby
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -58,9 +65,11 @@ dependencies:
   name: mongo_mapper
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -70,9 +79,11 @@ dependencies:
   name: dm-core
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -82,9 +93,11 @@ dependencies:
   name: dm-observer
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -94,9 +107,11 @@ dependencies:
   name: dm-aggregates
   prerelease: false
   requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -106,9 +121,11 @@ dependencies:
   name: dm-validations
   prerelease: false
   requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -118,9 +135,11 @@ dependencies:
   name: do_sqlite3
   prerelease: false
   requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -130,9 +149,11 @@ dependencies:
   name: database_cleaner
   prerelease: false
   requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -151,6 +172,8 @@ extra_rdoc_files:
 - README.textile
 files: 
 - .gitignore
+- .rvmrc
+- CHANGELOG
 - MIT-LICENSE
 - README.textile
 - Rakefile
@@ -182,6 +205,7 @@ files:
 - spec/backend/mongo_mapper_job_spec.rb
 - spec/backend/shared_backend_spec.rb
 - spec/delayed_method_spec.rb
+- spec/message_sending_spec.rb
 - spec/performable_method_spec.rb
 - spec/sample_jobs.rb
 - spec/setup/active_record.rb
@@ -204,28 +228,33 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Database-backed asynchronous priority queue system -- Extracted from Shopify
 test_files: 
 - spec/delayed_method_spec.rb
+- spec/message_sending_spec.rb
 - spec/performable_method_spec.rb
 - spec/story_spec.rb
 - spec/worker_spec.rb