collectiveidea-delayed_job 1.8.0 → 1.8.1

data/README.textile

@@ -11,16 +11,113 @@ It is a direct extraction from Shopify where the job table is responsible for a
 * updating solr, our search server, after product changes
 * batch imports 
 * spam checks 
-            
-h2. Setup
-            
+
+h2. Installation
+
+To install as a gem, add the following to @config/environment.rb@:
+
+<pre>
+config.gem 'collectiveidea-delayed_job', :lib => 'delayed_job',
+  :source => 'http://gems.github.com'
+</pre>
+
+Rake tasks are not automatically loaded from gems, so you'll need to add the following to your Rakefile:
+
+<pre>
+begin
+  require 'delayed/tasks'
+rescue LoadError
+  STDERR.puts "Run `rake gems:install` to install delayed_job"
+end
+</pre>
+
+To install as a plugin:
+
+<pre>
+script/plugin install git://github.com/collectiveidea/delayed_job.git
+</pre>
+
+After delayed_job is installed, run:
+
+<pre>
+script/generate delayed_job
+rake db:migrate
+</pre>
+
+h2. Upgrading to 1.8
+
+If you are upgrading from a previous release, you will need to generate the new @script/delayed_job@:
+
+<pre>
+script/generate delayed_job --skip-migration
+</pre>
+
+h2. Queuing Jobs
+
+Call @#send_later(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
+</pre>
+
+If a method should always be run in the background, you can call @#handle_asynchronously@ after the method declaration:
+
+<pre>
+class Device
+  def deliver
+    # long running method
+  end
+  handle_asynchronously :deliver
+end
+
+device = Device.new
+device.deliver
+</pre>
+
+h2. Running Jobs
+
+@script/delayed_job@ can be used to manage a background process which will start working off jobs.
+
+<pre>
+$ ruby script/delayed_job -e production start
+$ ruby script/delayed_job -e production stop
+
+# Runs two workers in separate processes.
+$ ruby script/delayed_job -e production -n 2 start
+$ ruby script/delayed_job -e production stop
+</pre>
+
+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@. 
+
+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. 
+
+<pre>
+class NewsletterJob < Struct.new(:text, :emails)
+  def perform
+    emails.each { |e| NewsletterMailer.deliver_text_to_email(text, e) }
+  end    
+end  
+  
+Delayed::Job.enqueue NewsletterJob.new('lorem ipsum...', Customers.find(:all).collect(&:email))
+</pre>
+
+h2. Gory Details
+
 The library evolves around a delayed_jobs table which looks as follows: 
 
   create_table :delayed_jobs, :force => true do |table|
     table.integer  :priority, :default => 0      # Allows some jobs to jump to the front of the queue
     table.integer  :attempts, :default => 0      # Provides for retries, but still fail eventually.
     table.text     :handler                      # YAML-encoded string of the object that will do work
-    table.string   :last_error                   # reason for last failure (See Note below)
+    table.text   :last_error                   # reason for last failure (See Note below)
     table.datetime :run_at                       # When to run. Could be Time.now for immediately, or sometime in the future.
     table.datetime :locked_at                    # Set when a client is working on this object
     table.datetime :failed_at                    # Set when all retries have failed (actually, by default, the record is deleted instead)
@@ -41,58 +138,34 @@ Delayed::Job.destroy_failed_jobs = false. The failed jobs will be marked with no
 
 Here is an example of changing job parameters in Rails:
 
-  # config/initializers/delayed_job_config.rb
-  Delayed::Job.destroy_failed_jobs = false
-  silence_warnings do
-    Delayed::Job.const_set("MAX_ATTEMPTS", 3)
-    Delayed::Job.const_set("MAX_RUN_TIME", 5.minutes)
-  end
-
-Note: If your error messages are long, consider changing last_error field to a :text instead of a :string (255 character limit).
-
-
-h2. Usage
+<pre>
+# config/initializers/delayed_job_config.rb
+Delayed::Job.destroy_failed_jobs = false
+silence_warnings do
+  Delayed::Job.const_set("MAX_ATTEMPTS", 3)
+  Delayed::Job.const_set("MAX_RUN_TIME", 5.minutes)
+end
+</pre>
 
-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. 
-
-  class NewsletterJob < Struct.new(:text, :emails)
-    def perform
-      emails.each { |e| NewsletterMailer.deliver_text_to_email(text, e) }
-    end    
-  end  
-  
-  Delayed::Job.enqueue NewsletterJob.new('lorem ipsum...', Customers.find(:all).collect(&:email))
-           
-There is also a second way to get jobs in the queue: send_later. 
-
-  
-  BatchImporter.new(Shop.find(1)).send_later(:import_massive_csv, massive_csv)                                                    
-  
-
-This will simply create a Delayed::PerformableMethod job in the jobs table which serializes all the parameters you pass to it. There are some special smarts for active record objects
-which are stored as their text representation and loaded from the database fresh when the job is actually run later.
-                                                                                                                              
-                                                                                                                    
-h2. Running the jobs
+h3. Cleaning up
 
-Run @script/generate delayed_job@ to add @script/delayed_job@. This script can then be used to manage a process which will start working off jobs.
+You can invoke @rake jobs:clear@ to delete all jobs in the queue.
 
-  # Runs two workers in separate processes.
-  $ ruby script/delayed_job -e production -n 2 start
-  $ ruby script/delayed_job -e production stop
+h2. How to contribute
 
-You can invoke @rake jobs:work@ which will start working off jobs. You can cancel the rake task with @CTRL-C@. 
+If you find what looks like a bug:
 
-Workers can be running on any computer, as long as they have access to the database and their clock is in sync. You can even
-run multiple workers on per computer, but you must give each one a unique name. (TODO: put in an example)
-Keep in mind that each worker will check the database at least every 5 seconds.
+# Check the GitHub issue tracker to see if anyone else has had the same issue.
+   http://github.com/collectiveidea/delayed_job/issues/
+# If you don't see anything, create an issue with information on how to reproduce it.
 
-Note: The rake task will exit if the database has any network connectivity problems.
+If you want to contribute an enhancement or a fix:
 
-h3. Cleaning up
-
-You can invoke @rake jobs:clear@ to delete all jobs in the queue.
+# Fork the project on github.
+   http://github.com/collectiveidea/delayed_job/
+# Make your changes with tests.
+# 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
 

data/VERSION

@@ -1 +1 @@
-1.8.0
+1.8.1

data/delayed_job.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{delayed_job}
-  s.version = "1.8.0"
+  s.version = "1.8.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tobias L\303\274tke"]
-  s.date = %q{2009-07-19}
+  s.date = %q{2009-09-06}
   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.}
   s.email = %q{tobi@leetsoft.com}
   s.extra_rdoc_files = [
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
      "lib/delayed/job.rb",
      "lib/delayed/message_sending.rb",
      "lib/delayed/performable_method.rb",
+     "lib/delayed/tasks.rb",
      "lib/delayed/worker.rb",
      "lib/delayed_job.rb",
      "recipes/delayed_job.rb",
@@ -34,8 +35,7 @@ Gem::Specification.new do |s|
      "spec/delayed_method_spec.rb",
      "spec/job_spec.rb",
      "spec/story_spec.rb",
-     "tasks/jobs.rake",
-     "tasks/tasks.rb"
+     "tasks/jobs.rake"
   ]
   s.homepage = %q{http://github.com/tobi/delayed_job/tree/master}
   s.rdoc_options = ["--main", "README.textile", "--inline-source", "--line-numbers"]

data/generators/delayed_job/delayed_job_generator.rb

@@ -1,11 +1,22 @@
 class DelayedJobGenerator < Rails::Generator::Base
+  default_options :skip_migration => false
   
   def manifest
     record do |m|
       m.template 'script', 'script/delayed_job', :chmod => 0755
-      m.migration_template "migration.rb", 'db/migrate',
-                           :migration_file_name => "create_delayed_jobs"
+      unless options[:skip_migration]
+        m.migration_template "migration.rb", 'db/migrate',
+                             :migration_file_name => "create_delayed_jobs"
+      end
     end
   end
   
+protected
+
+  def add_options!(opt)
+    opt.separator ''
+    opt.separator 'Options:'
+    opt.on("--skip-migration", "Don't generate a migration") { |v| options[:skip_migration] = v }
+  end
+  
 end

data/generators/delayed_job/templates/script

@@ -1,7 +1,5 @@
 #!/usr/bin/env ruby
 
-# Daemons sets pwd to /, so we have to explicitly set RAILS_ROOT
-RAILS_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-
-require File.join(File.dirname(__FILE__), *%w(.. vendor plugins delayed_job lib delayed command))
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'config', 'environment'))
+require 'delayed/command'
 Delayed::Command.new(ARGV).daemonize

data/lib/delayed/command.rb

@@ -1,4 +1,3 @@
-require 'rubygems'
 require 'daemons'
 require 'optparse'
 
@@ -44,14 +43,14 @@ module Delayed
     
     def run(worker_name = nil)
       Dir.chdir(RAILS_ROOT)
-      require File.join(RAILS_ROOT, 'config', 'environment')
       
-      # Replace the default logger
-      logger = Logger.new(File.join(RAILS_ROOT, 'log', 'delayed_job.log'))
-      logger.level = ActiveRecord::Base.logger.level
-      ActiveRecord::Base.logger = logger
-      ActiveRecord::Base.clear_active_connections!
-      Delayed::Worker.logger = logger
+      # Replace the default logger…too bad Rails doesn't make this easier
+      Rails.logger.instance_eval do
+        @log.reopen File.join(RAILS_ROOT, 'log', 'delayed_job.log')
+      end
+      Delayed::Worker.logger = Rails.logger
+      ActiveRecord::Base.connection.reconnect!
+      
       Delayed::Job.worker_name = "#{worker_name} #{Delayed::Job.worker_name}"
       
       Delayed::Worker.new(@options).start  

data/lib/delayed/message_sending.rb

@@ -6,9 +6,10 @@ module Delayed
     
     module ClassMethods
       def handle_asynchronously(method)
-        without_name = "#{method}_without_send_later"
-        define_method("#{method}_with_send_later") do |*args|
-          send_later(without_name, *args)
+        aliased_method, punctuation = method.to_s.sub(/([?!=])$/, ''), $1
+        with_method, without_method = "#{aliased_method}_with_send_later#{punctuation}", "#{aliased_method}_without_send_later#{punctuation}"
+        define_method(with_method) do |*args|
+          send_later(without_method, *args)
         end
         alias_method_chain method, :send_later
       end

data/lib/delayed_job.rb

@@ -9,5 +9,5 @@ Object.send(:include, Delayed::MessageSending)
 Module.send(:include, Delayed::MessageSending::ClassMethods)
 
 if defined?(Merb::Plugins)
-  Merb::Plugins.add_rakefiles File.dirname(__FILE__) / '..' / 'tasks' / 'tasks'
+  Merb::Plugins.add_rakefiles File.dirname(__FILE__) / 'delayed' / 'tasks'
 end

data/tasks/jobs.rake

@@ -1 +1 @@
-require File.join(File.dirname(__FILE__), 'tasks')
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'delayed', 'tasks'))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: collectiveidea-delayed_job
 version: !ruby/object:Gem::Version 
-  version: 1.8.0
+  version: 1.8.1
 platform: ruby
 authors: 
 - "Tobias L\xC3\xBCtke"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-19 00:00:00 -07:00
+date: 2009-09-06 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -36,6 +36,7 @@ files:
 - lib/delayed/job.rb
 - lib/delayed/message_sending.rb
 - lib/delayed/performable_method.rb
+- lib/delayed/tasks.rb
 - lib/delayed/worker.rb
 - lib/delayed_job.rb
 - recipes/delayed_job.rb
@@ -44,9 +45,9 @@ files:
 - spec/job_spec.rb
 - spec/story_spec.rb
 - tasks/jobs.rake
-- tasks/tasks.rb
 has_rdoc: false
 homepage: http://github.com/tobi/delayed_job/tree/master
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --main
@@ -70,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Database-backed asynchronous priority queue system -- Extracted from Shopify