delayed_job_active_record 0.3.3 → 0.4.0

data/CONTRIBUTING.md

@@ -0,0 +1,14 @@
+## How to contribute
+
+If you find what looks like a bug:
+
+* Search the [mailing list](http://groups.google.com/group/delayed_job) to see if anyone else had the same issue.
+* Check the [GitHub issue tracker](http://github.com/collectiveidea/delayed_job_active_record/issues/) to see if anyone else has reported issue.
+* If you don't see anything, create an issue with information on how to reproduce it.
+
+If you want to contribute an enhancement or a fix:
+
+* Fork the project on github.
+* Make your changes with tests.
+* Commit the changes without making changes to the Rakefile or any other files that aren't related to your enhancement or fix
+* Send a pull request.

data/{LICENSE → LICENSE.md}

@@ -1,4 +1,4 @@
-Copyright (c) 2005 Tobias Luetke
+Copyright (c) 2005 Tobias Lütke
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,4 +1,4 @@
-# DelayedJob ActiveRecord Backend [![Build Status](http://travis-ci.org/collectiveidea/delayed_job_active_record.png)](https://travis-ci.org/collectiveidea/delayed_job_active_record) [![Dependency Status](https://gemnasium.com/collectiveidea/delayed_job_active_record.png)](https://gemnasium.com/collectiveidea/delayed_job_active_record)
+# DelayedJob ActiveRecord Backend [![Build Status](https://travis-ci.org/collectiveidea/delayed_job_active_record.png)](https://travis-ci.org/collectiveidea/delayed_job_active_record) [![Dependency Status](https://gemnasium.com/collectiveidea/delayed_job_active_record.png)](https://gemnasium.com/collectiveidea/delayed_job_active_record)
 
 ## Installation
 
@@ -12,7 +12,7 @@ If you're using Rails, run the generator to create the migration for the delayed
 
     rails g delayed_job:active_record
     rake db:migrate
-    
+
 ## Upgrading from 2.x to 3.0.0
 
 If you're upgrading from Delayed Job 2.x, run the upgrade generator to create a migration to add a column to your delayed_jobs table.
@@ -21,18 +21,3 @@ If you're upgrading from Delayed Job 2.x, run the upgrade generator to create a
     rake db:migrate
 
 That's it. Use [delayed_job as normal](http://github.com/collectiveidea/delayed_job).
-
-## How to contribute
-
-If you find what looks like a bug:
-
-* Search the [mailing list](http://groups.google.com/group/delayed_job) to see if anyone else had the same issue.
-* Check the [GitHub issue tracker](http://github.com/collectiveidea/delayed_job_active_record/issues/) to see if anyone else has reported issue.
-* If you don't see anything, create an issue with information on how to reproduce it.
-
-If you want to contribute an enhancement or a fix:
-
-* Fork the project on github.
-* Make your changes with tests.
-* Commit the changes without making changes to the Rakefile or any other files that aren't related to your enhancement or fix
-* Send a pull request.

data/Rakefile

@@ -0,0 +1,12 @@
+# -*- encoding: utf-8 -*-
+require 'rubygems'
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+desc 'Run the specs'
+RSpec::Core::RakeTask.new do |r|
+  r.verbose = false
+end
+
+task :default => :spec

data/delayed_job_active_record.gemspec

@@ -0,0 +1,19 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.add_dependency   'activerecord', ['>= 2.1.0', '< 4']
+  spec.add_dependency   'delayed_job', '~> 3.0'
+  spec.authors        = ["Brian Ryckbost", "Matt Griffin", "Erik Michaels-Ober"]
+  spec.description    = 'ActiveRecord backend for Delayed::Job, originally authored by Tobias Lütke'
+  spec.email          = ['bryckbost@gmail.com', 'matt@griffinonline.org', 'sferik@gmail.com']
+  spec.files          = %w(CONTRIBUTING.md LICENSE.md README.md Rakefile delayed_job_active_record.gemspec)
+  spec.files         += Dir.glob("lib/**/*.rb")
+  spec.files         += Dir.glob("spec/**/*")
+  spec.homepage       = 'http://github.com/collectiveidea/delayed_job_active_record'
+  spec.licenses       = ['MIT']
+  spec.name           = 'delayed_job_active_record'
+  spec.require_paths  = ['lib']
+  spec.summary        = 'ActiveRecord backend for DelayedJob'
+  spec.test_files     = Dir.glob("spec/**/*")
+  spec.version        = '0.4.0'
+end

data/lib/delayed/backend/active_record.rb

@@ -12,26 +12,19 @@ module Delayed
 
         before_save :set_default_run_at
 
-        def self.rails3?
-          ::ActiveRecord::VERSION::MAJOR == 3
+        def self.set_delayed_job_table_name
+          delayed_job_table_name = "#{::ActiveRecord::Base.table_name_prefix}delayed_jobs"
+          self.table_name = delayed_job_table_name
         end
 
-        delayed_job_table_name = "#{::ActiveRecord::Base.table_name_prefix}delayed_jobs"
+        self.set_delayed_job_table_name
 
-        if rails3?
-          self.table_name = delayed_job_table_name
-          def self.ready_to_run(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)
-          end
-          def self.by_priority
-            order('priority ASC, run_at ASC')
-          end
-        else
-          set_table_name delayed_job_table_name
-          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'
+        def self.ready_to_run(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)
+        end
+
+        def self.by_priority
+          order('priority ASC, run_at ASC')
         end
 
         def self.before_fork
@@ -47,15 +40,32 @@ module Delayed
           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?
+        def self.reserve(worker, max_run_time = Worker.max_run_time)
+          # scope to filter to records that are "ready to run"
+          readyScope = self.ready_to_run(worker.name, max_run_time)
+
+          # scope to filter to the single next eligible job (locking it for update http://www.postgresql.org/docs/9.0/static/sql-select.html#SQL-FOR-UPDATE-SHARE)
+          nextScope = readyScope.scoped
+          nextScope = nextScope.scoped(:conditions => ['priority >= ?', Worker.min_priority]) if Worker.min_priority
+          nextScope = nextScope.scoped(:conditions => ['priority <= ?', Worker.max_priority]) if Worker.max_priority
+          nextScope = nextScope.scoped(:conditions => ["queue IN (?)", Worker.queues]) if Worker.queues.any?
+          nextScope = nextScope.scoped.by_priority.limit(1).lock(true)
+          nextScope = nextScope.scoped.select('id')
 
-          ::ActiveRecord::Base.silence do
-            scope.by_priority.all(:limit => limit)
+          now = self.db_time_now
+
+          if ::ActiveRecord::Base.connection.adapter_name == "PostgreSQL"
+            # This works on PostgreSQL and uses 1 less query, but uses SQL not supported nativly through ActiveRecord
+            quotedTableName = ::ActiveRecord::Base.connection.quote_column_name(self.table_name)
+            reserved = self.find_by_sql(["UPDATE #{quotedTableName} SET locked_at = ?, locked_by = ? WHERE id IN (#{nextScope.to_sql}) RETURNING *",now,worker.name])
+            return reserved[0]
+          else
+            # This works on any database and uses seperate queries to lock and return the job
+            # Databases like PostgreSQL and MySQL that support "SELECT .. FOR UPDATE" (ActiveRecord Pessimistic locking) don't need the second application
+            # of 'readyScope' but it doesn't hurt and it ensures that the job being locked still meets ready_to_run criteria.
+            count = readyScope.where(:id => nextScope).update_all(:locked_at => now, :locked_by => worker.name)
+            return nil if count == 0
+            return self.where(:locked_at => now, :locked_by => worker.name).first
           end
         end
 
@@ -74,8 +84,7 @@ module Delayed
           if affected_rows == 1
             self.locked_at = now
             self.locked_by = worker
-            self.locked_at_will_change!
-            self.locked_by_will_change!
+            self.changed_attributes.clear
             return true
           else
             return false

data/spec/delayed/backend/active_record_spec.rb

@@ -2,43 +2,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'
+  it_behaves_like 'a delayed_job backend'
 
   context "db_time_now" do
-    it "should return time in current time zone if set" do
+    after do
+      Time.zone = nil
+      ActiveRecord::Base.default_timezone = :local
+    end
+
+    it "returns 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)
+      expect(%(EST EDT)).to include(Delayed::Job.db_time_now.zone)
     end
 
-    it "should return UTC time if that is the AR default" do
+    it "returns 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'
+      expect(Delayed::Backend::ActiveRecord::Job.db_time_now.zone).to eq 'UTC'
     end
 
-    it "should return local time if that is the AR default" do
+    it "returns 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)
+      expect(%w(CST CDT)).to include(Delayed::Backend::ActiveRecord::Job.db_time_now.zone)
     end
   end
 
   describe "after_fork" do
-    it "should call reconnect on the connection" do
+    it "calls 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
+    it "allows 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)
+      expect(Delayed::Backend::ActiveRecord::Job.find(job.id).run_at).to be_within(1).of(later)
     end
   end
 
@@ -51,28 +52,28 @@ describe Delayed::Backend::ActiveRecord::Job do
       Delayed::Backend::ActiveRecord::Job.send(:attr_accessible, *Delayed::Backend::ActiveRecord::Job.new.attributes.keys)
     end
 
-    it "should still be accessible" do
+    it "is still accessible" do
       job = Delayed::Backend::ActiveRecord::Job.enqueue :payload_object => EnqueueJobMod.new
-      Delayed::Backend::ActiveRecord::Job.find(job.id).handler.should_not be_blank
+      expect(Delayed::Backend::ActiveRecord::Job.find(job.id).handler).to_not be_blank
     end
   end
 
   context "ActiveRecord::Base.table_name_prefix" do
-    def reload_job_class_definition
-      # If this can be done in a more sane manner, please fix it
-      load File.join File.dirname(__FILE__), '..', '..', '..', 'lib', 'delayed', 'backend', 'active_record.rb'
-    end
-
-    it "when prefix is not set, should use 'delayed_jobs' as table name" do
+    it "when prefix is not set, use 'delayed_jobs' as table name" do
       ::ActiveRecord::Base.table_name_prefix = nil
-      reload_job_class_definition
-      Delayed::Backend::ActiveRecord::Job.table_name.should eq 'delayed_jobs'
+      Delayed::Backend::ActiveRecord::Job.set_delayed_job_table_name
+
+      expect(Delayed::Backend::ActiveRecord::Job.table_name).to eq 'delayed_jobs'
     end
 
-    it "when prefix is set, should prepend it before default table name" do
+    it "when prefix is set, prepend it before default table name" do
       ::ActiveRecord::Base.table_name_prefix = 'custom_'
-      reload_job_class_definition
-      Delayed::Backend::ActiveRecord::Job.table_name.should eq 'custom_delayed_jobs'
+      Delayed::Backend::ActiveRecord::Job.set_delayed_job_table_name
+
+      expect(Delayed::Backend::ActiveRecord::Job.table_name).to eq 'custom_delayed_jobs'
+
+      ::ActiveRecord::Base.table_name_prefix = nil
+      Delayed::Backend::ActiveRecord::Job.set_delayed_job_table_name
     end
   end
 end

data/spec/delayed/serialization/active_record_spec.rb

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

data/spec/spec_helper.rb

@@ -40,7 +40,7 @@ end
 
 # Purely useful for test cases...
 class Story < ActiveRecord::Base
-  set_primary_key :story_id
+  self.primary_key = :story_id
   def tell; text; end
   def whatever(n, _); tell*n; end
   default_scope where(:scoped => true)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: delayed_job_active_record
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-30 00:00:00.000000000 Z
+date: 2013-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -51,64 +51,21 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-description: ActiveRecord backend for DelayedJob, originally authored by Tobias Luetke
+description: ActiveRecord backend for Delayed::Job, originally authored by Tobias
+  Lütke
 email:
 - bryckbost@gmail.com
 - matt@griffinonline.org
 - sferik@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.md
+extra_rdoc_files: []
 files:
+- CONTRIBUTING.md
+- LICENSE.md
+- README.md
+- Rakefile
+- delayed_job_active_record.gemspec
 - lib/delayed/backend/active_record.rb
 - lib/delayed_job_active_record.rb
 - lib/generators/delayed_job/active_record_generator.rb
@@ -119,16 +76,11 @@ files:
 - 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: []
+licenses:
+- MIT
 post_install_message: 
-rdoc_options:
-- --main
-- README.md
-- --inline-source
-- --line-numbers
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -139,7 +91,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4543581460881455669
+      hash: -1678145937006917333
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -148,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4543581460881455669
+      hash: -1678145937006917333
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23