delayed_job_active_record 0.2.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2005 Tobias Luetke
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOa AND
+NONINFRINGEMENT. IN NO EVENT SaALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,16 @@
+# DelayedJob ActiveRecord Backend
+
+Please note! This is a pre-release version intended for use only with DelayedJob 3.0
+
+## Installation
+
+Add the gems to your Gemfile:
+
+    gem 'delayed_job'
+    gem 'delayed_job_active_record'
+
+Run `bundle install`
+
+If you're using Rails, run the generator to create the migration for the delayed_job table: `rails g delayed_job:active_record`
+
+That's it. Use [delayed_job as normal](http://github.com/collectiveidea/delayed_job).

data/lib/delayed/backend/active_record.rb

@@ -0,0 +1,98 @@
+require 'active_record'
+require 'active_record/version'
+module Delayed
+  module Backend
+    module ActiveRecord
+      # A job object that is persisted to the database.
+      # Contains the work object as a YAML field.
+      class Job < ::ActiveRecord::Base
+        include Delayed::Backend::Base
+        set_table_name :delayed_jobs
+
+        before_save :set_default_run_at
+        
+        def self.rails3?
+          ::ActiveRecord::VERSION::MAJOR == 3
+        end
+        
+        if rails3?
+          scope :ready_to_run, lambda{|worker_name, max_run_time|
+            where('(run_at <= ? AND (locked_at IS NULL OR locked_at < ?) OR locked_by = ?) AND failed_at IS NULL', db_time_now, db_time_now - max_run_time, worker_name)
+          }
+          scope :by_priority, order('priority ASC, run_at ASC')
+        else
+          named_scope :ready_to_run, lambda {|worker_name, max_run_time|
+            { :conditions => ['(run_at <= ? AND (locked_at IS NULL OR locked_at < ?) OR locked_by = ?) AND failed_at IS NULL', db_time_now, db_time_now - max_run_time, worker_name] }
+          }
+          named_scope :by_priority, :order => 'priority ASC, run_at ASC'
+        end
+
+        def self.before_fork
+          ::ActiveRecord::Base.clear_all_connections!
+        end
+
+        def self.after_fork
+          ::ActiveRecord::Base.establish_connection
+        end
+
+        # When a worker is exiting, make sure we don't have any locked jobs.
+        def self.clear_locks!(worker_name)
+          update_all("locked_by = null, locked_at = null", ["locked_by = ?", worker_name])
+        end
+
+        # Find a few candidate jobs to run (in case some immediately get locked by others).
+        def self.find_available(worker_name, limit = 5, max_run_time = Worker.max_run_time)
+          scope = self.ready_to_run(worker_name, max_run_time)
+          scope = scope.scoped(:conditions => ['priority >= ?', Worker.min_priority]) if Worker.min_priority
+          scope = scope.scoped(:conditions => ['priority <= ?', Worker.max_priority]) if Worker.max_priority
+          scope = scope.scoped(:conditions => ["queue IN (?)", Worker.queues]) if Worker.queues.any?
+
+          ::ActiveRecord::Base.silence do
+            scope.by_priority.all(:limit => limit)
+          end
+        end
+
+        # Lock this job for this worker.
+        # Returns true if we have the lock, false otherwise.
+        def lock_exclusively!(max_run_time, worker)
+          now = self.class.db_time_now
+          affected_rows = if locked_by != worker
+            # We don't own this job so we will update the locked_by name and the locked_at
+            self.class.update_all(["locked_at = ?, locked_by = ?", now, worker], ["id = ? and (locked_at is null or locked_at < ?) and (run_at <= ?)", id, (now - max_run_time.to_i), now])
+          else
+            # We already own this job, this may happen if the job queue crashes.
+            # Simply resume and update the locked_at
+            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_will_change!
+            self.locked_by_will_change!
+            return true
+          else
+            return false
+          end
+        end
+
+        # Get the current time (GMT or local depending on DB)
+        # Note: This does not ping the DB to get the time, so all your clients
+        # must have syncronized clocks.
+        def self.db_time_now
+          if Time.zone
+            Time.zone.now
+          elsif ::ActiveRecord::Base.default_timezone == :utc
+            Time.now.utc
+          else
+            Time.now
+          end
+        end
+        
+        def reload(*args)
+          reset
+          super
+        end
+      end
+    end
+  end
+end

data/lib/delayed_job_active_record.rb

@@ -0,0 +1,5 @@
+require 'active_record'
+require 'delayed_job'
+require 'delayed/backend/active_record'
+
+Delayed::Worker.backend = :active_record

data/lib/generators/delayed_job/active_record_generator.rb

@@ -0,0 +1,17 @@
+require 'generators/delayed_job/delayed_job_generator'
+require 'rails/generators/migration'
+require 'rails/generators/active_record/migration'
+
+# Extend the DelayedJobGenerator so that it creates an AR migration
+module DelayedJob
+  class ActiveRecordGenerator < ::DelayedJobGenerator
+    include Rails::Generators::Migration
+    extend ActiveRecord::Generators::Migration
+    
+    self.source_paths << File.join(File.dirname(__FILE__), 'templates')
+    
+    def create_migration_file
+      migration_template 'migration.rb', 'db/migrate/create_delayed_jobs.rb'
+    end
+  end
+end

data/lib/generators/delayed_job/templates/migration.rb

@@ -0,0 +1,22 @@
+class CreateDelayedJobs < ActiveRecord::Migration
+  def self.up
+    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.text     :last_error                   # reason for last failure (See Note below)
+      table.datetime :run_at                       # When to run. Could be Time.zone.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)
+      table.string   :locked_by                    # Who is working on this object (if locked)
+      table.string   :queue                        # The name of the queue this job is in
+      table.timestamps
+    end
+	
+    add_index :delayed_jobs, [:priority, :run_at], :name => 'delayed_jobs_priority'
+  end
+  
+  def self.down
+    drop_table :delayed_jobs  
+  end
+end

data/spec/database.yml

@@ -0,0 +1,8 @@
+sqlite:
+  adapter: sqlite3
+  database: ":memory:"
+
+mysql:
+  adapter: mysql
+  database: delayed_job
+  uesrname: root

data/spec/delayed/backend/active_record_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'delayed/backend/active_record'
+
+describe Delayed::Backend::ActiveRecord::Job do
+  after do
+    Time.zone = nil
+  end
+
+  it_should_behave_like 'a delayed_job backend'
+
+  context "db_time_now" do
+    it "should return time in current time zone if set" do
+      Time.zone = 'Eastern Time (US & Canada)'
+      %w(EST EDT).should include(Delayed::Job.db_time_now.zone)
+    end
+
+    it "should return UTC time if that is the AR default" do
+      Time.zone = nil
+      ActiveRecord::Base.default_timezone = :utc
+      Delayed::Backend::ActiveRecord::Job.db_time_now.zone.should == 'UTC'
+    end
+
+    it "should return local time if that is the AR default" do
+      Time.zone = 'Central Time (US & Canada)'
+      ActiveRecord::Base.default_timezone = :local
+      %w(CST CDT).should include(Delayed::Backend::ActiveRecord::Job.db_time_now.zone)
+    end
+  end
+
+  describe "after_fork" do
+    it "should call reconnect on the connection" do
+      ActiveRecord::Base.should_receive(:establish_connection)
+      Delayed::Backend::ActiveRecord::Job.after_fork
+    end
+  end
+  
+  describe "enqueue" do
+    it "should allow enqueue hook to modify job at DB level" do
+      later = described_class.db_time_now + 20.minutes
+      job = Delayed::Backend::ActiveRecord::Job.enqueue :payload_object => EnqueueJobMod.new
+      Delayed::Backend::ActiveRecord::Job.find(job.id).run_at.should be_within(1).of(later)
+    end
+  end
+end

data/spec/delayed/serialization/active_record_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe ActiveRecord do
+  it 'should load classes with non-default primary key' do
+    lambda {
+      YAML.load(Story.create.to_yaml)
+    }.should_not raise_error    
+  end
+
+  it 'should load classes even if not in default scope' do
+    lambda {
+      YAML.load(Story.create(:scoped => false).to_yaml)
+    }.should_not raise_error    
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,53 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+require 'logger'
+
+require 'delayed_job_active_record'
+require 'delayed/backend/shared_spec'
+
+Delayed::Worker.logger = Logger.new('/tmp/dj.log')
+ENV['RAILS_ENV'] = 'test'
+
+config = YAML.load(File.read('spec/database.yml'))
+# ActiveRecord::Base.configurations = {'test' => config['sqlite']}
+ActiveRecord::Base.establish_connection config['sqlite']
+ActiveRecord::Base.logger = Delayed::Worker.logger
+ActiveRecord::Migration.verbose = false
+
+ActiveRecord::Schema.define do
+  create_table :delayed_jobs, :force => true do |table|
+    table.integer  :priority, :default => 0
+    table.integer  :attempts, :default => 0
+    table.text     :handler
+    table.text     :last_error
+    table.datetime :run_at
+    table.datetime :locked_at
+    table.datetime :failed_at
+    table.string   :locked_by
+    table.string   :queue
+    table.timestamps
+  end
+
+  add_index :delayed_jobs, [:priority, :run_at], :name => 'delayed_jobs_priority'
+
+  create_table :stories, :primary_key => :story_id, :force => true do |table|
+    table.string :text
+    table.boolean :scoped, :default => true
+  end
+end
+
+# Purely useful for test cases...
+class Story < ActiveRecord::Base
+  set_primary_key :story_id
+  def tell; text; end
+  def whatever(n, _); tell*n; end
+  default_scope where(:scoped => true)
+
+  handle_asynchronously :whatever
+end
+
+# Add this directory so the ActiveSupport autoloading works
+ActiveSupport::Dependencies.autoload_paths << File.dirname(__FILE__)

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification 
+name: delayed_job_active_record
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Matt Griffin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-29 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: activerecord
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: delayed_job
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 961916020
+        segments: 
+        - 3
+        - 0
+        - 0
+        - pre
+        version: 3.0.0.pre
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rspec
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rake
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 8
+        version: "0.8"
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: sqlite3
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+description: ActiveRecord backend for DelayedJob, originally authored by Tobias Luetke
+email: 
+- matt@griffinonline.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- lib/delayed/backend/active_record.rb
+- lib/delayed_job_active_record.rb
+- lib/generators/delayed_job/active_record_generator.rb
+- lib/generators/delayed_job/templates/migration.rb
+- spec/database.yml
+- spec/delayed/backend/active_record_spec.rb
+- spec/delayed/serialization/active_record_spec.rb
+- spec/spec_helper.rb
+- LICENSE
+- README.md
+homepage: http://github.com/collectiveidea/delayed_job_active_record
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.md
+- --inline-source
+- --line-numbers
+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.8.6
+signing_key: 
+specification_version: 3
+summary: ActiveRecord backend for DelayedJob
+test_files: 
+- spec/database.yml
+- spec/delayed/backend/active_record_spec.rb
+- spec/delayed/serialization/active_record_spec.rb
+- spec/spec_helper.rb