delayed_job_groups 0.2.0

data/.gitignore

@@ -0,0 +1,4 @@
+delayed_job.sqlite3
+*.swp
+*.swo
+pkg

data/Gemfile

@@ -0,0 +1,12 @@
+source :rubygems
+
+gem 'rails'
+gem 'delayed_job', :git => 'http://github.com/collectiveidea/delayed_job.git'
+
+group :test do
+  gem 'rspec-rails'
+  gem 'sqlite3-ruby'  
+  gem 'autotest'
+  gem 'autotest-fsevent'
+  gem 'autotest-growl'  
+end

data/Gemfile.lock

@@ -0,0 +1,106 @@
+GIT
+  remote: http://github.com/collectiveidea/delayed_job.git
+  revision: aba9905764c2a13a110a272137d1ad9798fd55e0
+  specs:
+    delayed_job (2.1.0.pre2)
+      activesupport (~> 3.0)
+      daemons
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.1)
+      actionpack (= 3.0.1)
+      mail (~> 2.2.5)
+    actionpack (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.12)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.1)
+      activesupport (= 3.0.1)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+    activesupport (3.0.1)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    autotest (4.4.1)
+    autotest-fsevent (0.2.3)
+      sys-uname
+    autotest-growl (0.2.6)
+    builder (2.1.2)
+    daemons (1.1.0)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.4.2)
+    mail (2.2.9)
+      activesupport (>= 2.3.6)
+      i18n (~> 0.4.1)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rails (3.0.1)
+      actionmailer (= 3.0.1)
+      actionpack (= 3.0.1)
+      activerecord (= 3.0.1)
+      activeresource (= 3.0.1)
+      activesupport (= 3.0.1)
+      bundler (~> 1.0.0)
+      railties (= 3.0.1)
+    railties (3.0.1)
+      actionpack (= 3.0.1)
+      activesupport (= 3.0.1)
+      rake (>= 0.8.4)
+      thor (~> 0.14.0)
+    rake (0.8.7)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+    rspec-rails (2.0.1)
+      rspec (~> 2.0.0)
+    sqlite3-ruby (1.3.1)
+    sys-uname (0.8.4)
+    thor (0.14.3)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest
+  autotest-fsevent
+  autotest-growl
+  delayed_job!
+  rails
+  rspec-rails
+  sqlite3-ruby

data/README.markdown

@@ -0,0 +1,78 @@
+delayed job groups
+==================
+
+Adds grouping to jobs. Only 1 job in each group will be executed regardless of the number of workers.
+
+
+Requires
+--------
+
+* rails 3
+* Latest version of delayed_job from github - current release(v2.1.0.pre2) does not support enqueue hooks
+* active_record backend - other backends aren't supported'
+
+
+Install
+-------
+
+    # Gemfile
+    gem 'delayed_job_groups', :require => false
+  
+    # application.rb
+    AppName::Application.initialize!
+    require 'delayed_job_groups; # must be loaded after delayed job has guessed backend 
+
+Add migration to add lock_group column
+
+    # db/migrate/xxx_add_lock_group_to_delayed_jobs
+    class AddLockGroupToDelayedJobs < ActiveRecord::Migration
+      def self.up
+        add_column :delayed_jobs, :lock_group, :string
+      end
+
+      def self.down
+        remove_column :delayed_jobs, :lock_group
+      end
+    end
+
+
+Usage
+-----
+
+Job groups are strings. You need to specify what the job_group should be in a block. Delayed job will only perform 1 job from each group at a time.
+
+### Job groups for standard jobs ###
+
+	 class ResizeImageJob < Struct.new(:format)
+		 job_group{ |resize_image_job| resize_image_job.format }
+		
+		 def perform
+			 resize_to format
+		 end
+	 end
+
+	
+### Job groups when using delay() ###
+
+	 class Person < ActiveRecord::Base
+		 job_group{ |person| person.role }
+		
+		 def send_welcome
+		    ...
+		 end
+	 end
+	
+	 Person.create(:role => "admin").delay.send_welcome
+	
+### Job groups when methods are declared asynchonous ###
+
+	 class Person < ActiveRecord::Base
+		 job_group{ |person| person.role }
+
+		 def send_welcome
+		    ...
+		 end
+		 handle_asynchronously :send_welcome
+	 end
+
+	 Person.create(:role => "admin").send_welcome

data/Rakefile.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "delayed_job_groups"
+    gem.summary = %Q{Adds job groups to delayed_job}
+    gem.description = %Q{Adds job groups to delayed_job}
+    gem.email = "oliver@opsb.co.uk"
+    gem.homepage = "http://github.com/opsb/delayed_job_groups"
+    gem.authors = ["opsb"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/delayed_job_groups.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile.rb, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{delayed_job_groups}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["opsb"]
+  s.date = %q{2010-11-02}
+  s.description = %q{Adds job groups to delayed_job}
+  s.email = %q{oliver@opsb.co.uk}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "Gemfile",
+     "Gemfile.lock",
+     "README.markdown",
+     "Rakefile.rb",
+     "VERSION",
+     "delayed_job_groups.gemspec",
+     "lib/delayed_job_groups.rb",
+     "lib/delayed_job_groups/active_record_groups.rb",
+     "lib/delayed_job_groups/delayed_job_groups.rb",
+     "spec/database.yml",
+     "spec/delayed_job_groups_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/opsb/delayed_job_groups}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Adds job groups to delayed_job}
+  s.test_files = [
+    "spec/delayed_job_groups_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/delayed_job_groups/active_record_groups.rb

@@ -0,0 +1,23 @@
+class ActiveRecord::Base
+  class << self
+    def job_group(&block)
+      @lock_group_factory = block
+    end
+    
+    def has_job_groups?
+      !!@lock_group_factory
+    end
+
+    def lock_group(payload)
+      @lock_group_factory.call(payload)
+    end    
+  end
+  
+  def enqueue(job)
+    target = job.payload_object.class == ::Delayed::PerformableMethod ? job.payload_object.object : job.payload_object    
+    if target.class.has_job_groups?
+      job.lock_group = target.class.lock_group(target)
+      job.save
+    end
+  end  
+end

data/lib/delayed_job_groups/delayed_job_groups.rb

@@ -0,0 +1,14 @@
+require 'delayed_job'
+
+class Delayed::Backend::ActiveRecord::Job
+  scope :in_unlocked_group, lambda{
+    delayed_jobs = self.table_name
+    unlocked_groups_select = "select distinct #{delayed_jobs}.lock_group from #{delayed_jobs} where #{delayed_jobs}.locked_by is not null"
+    where("#{delayed_jobs}.lock_group not in (#{unlocked_groups_select}) or #{delayed_jobs}.lock_group is null")
+  }
+  scope :orig_ready_to_run, scopes[:ready_to_run]
+  scope :ready_to_run, lambda{ |*args|
+    orig_ready_to_run(*args).
+    in_unlocked_group
+  }
+end

data/lib/delayed_job_groups.rb

@@ -0,0 +1,2 @@
+require File.dirname(__FILE__) + '/delayed_job_groups/active_record_groups'
+require File.dirname(__FILE__) + '/delayed_job_groups/delayed_job_groups'

data/spec/database.yml

@@ -0,0 +1,3 @@
+sqlite:
+  adapter: sqlite3
+  database: delayed_job.sqlite3

data/spec/delayed_job_groups_spec.rb

@@ -0,0 +1,93 @@
+require 'spec/spec_helper'
+
+ActiveRecord::Schema.define do
+  create_table :grouped_jobs, :force => true do |table|
+    table.string :repository
+  end
+  create_table :simple_jobs, :force => true do |table|
+  end
+  create_table :users, :force => true do |table|
+    table.string :role
+  end
+end
+
+class GroupedJob < ActiveRecord::Base
+  job_group{ |simple_job| simple_job.repository }
+
+  def perform
+    puts "running grouped job"
+  end
+end
+
+class SimpleJob < ActiveRecord::Base
+  def perform
+    puts "running simple job"
+  end
+end
+
+class User < ActiveRecord::Base
+  job_group{ |user| user.role }  
+  def send_welcome_email
+    puts "thanking user"
+  end
+  handle_asynchronously :send_welcome_email  
+  def expensive_operation
+    puts "working hard"
+  end
+end
+
+describe Delayed::Job do
+  MAX_RUN_TIME = 4000 # seconds? TBC
+  WORKER = 'name_of_worker'
+  
+  context "with 2 jobs in the same group, one locked, one unlocked and 1 job in a different group" do
+    before do
+      2.times{ Delayed::Job.enqueue GroupedJob.new(:repository => "repo1") }
+      1.times{ Delayed::Job.enqueue GroupedJob.new(:repository => "repo2") }
+      Delayed::Job.first.lock_exclusively!(MAX_RUN_TIME, WORKER)      
+    end
+    
+    it "should find no jobs that are ready to run" do
+      Delayed::Job.ready_to_run(WORKER, MAX_RUN_TIME).count.should == 1
+    end
+  end
+  
+  context "job with no group" do
+    before do
+      Delayed::Job.enqueue SimpleJob.new
+    end
+    it "should still be queuable" do
+      Delayed::Job.ready_to_run(WORKER, MAX_RUN_TIME).count.should == 1
+    end
+  end
+  
+  context "with 2 jobs in the same group, from methods declared as asynchronous, one unlocked and 1 job in a different group" do
+    before do
+      2.times do
+        User.create(:role => "admin").send_welcome_email
+      end
+      1.times{ Delayed::Job.enqueue GroupedJob.new(:repository => "repo2") }      
+      Delayed::Job.first.lock_exclusively!(MAX_RUN_TIME, WORKER)
+      
+    end
+    
+    it "should find no jobs that are ready to run" do
+      Delayed::Job.ready_to_run(WORKER, MAX_RUN_TIME).count.should == 1
+    end
+  end
+  
+  context "with 2 jobs in the same group, from delay() calls, one unlocked and 1 job in a different group" do
+    before do
+      2.times do
+        User.create(:role => "admin").delay.expensive_operation
+      end
+      1.times{ Delayed::Job.enqueue GroupedJob.new(:repository => "repo2") }      
+      Delayed::Job.first.lock_exclusively!(MAX_RUN_TIME, WORKER)
+      
+    end
+    
+    it "should find no jobs that are ready to run" do
+      Delayed::Job.ready_to_run(WORKER, MAX_RUN_TIME).count.should == 1
+    end
+  end  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,56 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+require 'bundler/setup'
+require 'logger'
+
+
+
+ENV['RAILS_ENV'] = 'test'
+require 'rails'
+
+require 'active_record'
+config = YAML.load(File.read('spec/database.yml'))
+ActiveRecord::Base.configurations = {'test' => config['sqlite']}
+ActiveRecord::Base.establish_connection
+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   :lock_group
+    table.timestamps
+    
+    table.integer :queue_id
+  end
+end
+
+require 'rspec'
+require 'delayed_job'
+
+Delayed::Worker.logger = Logger.new('/tmp/dj.log')
+ActiveRecord::Base.logger = Delayed::Worker.logger
+Delayed::Worker.backend = :active_record
+
+require 'delayed_job_groups'
+RSpec.configure do |config|
+  config.before do
+    ActiveRecord::Base.connection.increment_open_transactions
+    ActiveRecord::Base.connection.transaction_joinable = false
+    ActiveRecord::Base.connection.begin_db_transaction
+  end
+  config.after do
+    if ActiveRecord::Base.connection.open_transactions != 0
+      ActiveRecord::Base.connection.rollback_db_transaction
+      ActiveRecord::Base.connection.decrement_open_transactions
+    end
+    ActiveRecord::Base.clear_active_connections!
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: delayed_job_groups
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- opsb
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-02 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: Adds job groups to delayed_job
+email: oliver@opsb.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.markdown
+- Rakefile.rb
+- VERSION
+- delayed_job_groups.gemspec
+- lib/delayed_job_groups.rb
+- lib/delayed_job_groups/active_record_groups.rb
+- lib/delayed_job_groups/delayed_job_groups.rb
+- spec/database.yml
+- spec/delayed_job_groups_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/opsb/delayed_job_groups
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.7
+signing_key: 
+specification_version: 3
+summary: Adds job groups to delayed_job
+test_files: 
+- spec/delayed_job_groups_spec.rb
+- spec/spec_helper.rb