delayed_job_groups_mongoid 0.2.2

data/Gemfile

@@ -0,0 +1,18 @@
+source :rubygems
+
+gem 'rails'
+gem 'delayed_job', '2.1.1'
+gem 'delayed_job_mongoid', '1.0.0'
+gem 'mongoid', '2.0.0.beta.20'
+gem 'bson_ext'
+
+
+group :test do
+  gem 'rspec-rails'
+  gem 'sqlite3-ruby'  
+  gem 'autotest'
+  gem 'autotest-fsevent'
+  gem 'autotest-growl'  
+  gem 'database_cleaner'  
+  gem 'ruby-debug'
+end

data/README.markdown

@@ -0,0 +1,74 @@
+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'
+
+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/delayed_job_groups_mongoid.gemspec

@@ -0,0 +1,39 @@
+# 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_mongoid}
+  s.version = "0.2.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["opsb"]
+  s.date = %q{2010-11-04}
+  s.description = %q{Adds job groups to delayed_job}
+  s.email = %q{oliver@opsb.co.uk}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = Dir.glob("lib/**/*") + %w(Gemfile delayed_job_groups_mongoid.gemspec README.markdown)  
+  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.rb

@@ -0,0 +1,7 @@
+module DelayedJobGroups
+  class Railtie < Rails::Railtie
+    initializer "delayed_job_groups.initialize" do |app|
+      require File.dirname(__FILE__) + '/delayed_job_groups/init.rb'  
+    end
+  end
+end

data/lib/delayed_job_groups/init.rb

@@ -0,0 +1,3 @@
+require 'delayed_job'
+require File.dirname(__FILE__) + '/mongoid_groups'
+require File.dirname(__FILE__) + '/job_groups'

data/lib/delayed_job_groups/job_groups.rb

@@ -0,0 +1,29 @@
+module JobGroups
+  
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+  
+  module ClassMethods
+    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)
+    payload = job.payload_object
+    target = payload.class == ::Delayed::PerformableMethod ? payload.object : payload    
+    if target.class.has_job_groups?
+      job.lock_group = target.class.lock_group(target)
+      job.save
+    end
+  end  
+end

data/lib/delayed_job_groups/mongoid_groups.rb

@@ -0,0 +1,41 @@
+require 'delayed_job'
+
+
+module Delayed
+  class Backend::Mongoid::Job
+    field :lock_group
+    scope :in_unlocked_group, lambda{ where(:lock_group.nin => self.locked_groups) }
+    
+    def self.locked_groups
+      Delayed::Job.only(:lock_group).where(:locked_by.ne => nil).map{|grouping| grouping[:lock_group]}
+    end
+
+    def self.find_available(worker_name, limit = 5, max_run_time = Worker.max_run_time)
+      right_now = db_time_now
+
+      conditions = {:run_at  => {"$lte" => right_now}, :failed_at => nil}
+      (conditions[:priority] ||= {})['$gte'] = Worker.min_priority.to_i if Worker.min_priority
+      (conditions[:priority] ||= {})['$lte'] = Worker.max_priority.to_i if Worker.max_priority
+
+
+      where = "this.locked_at == null || this.locked_at < #{make_date(right_now - max_run_time)}"
+      results = self.in_unlocked_group.where(conditions.merge(:locked_by => worker_name)).limit(-limit).order_by([['priority', 1], ['run_at', 1]]).to_a
+      results += self.in_unlocked_group.where(conditions.merge('$where' => where)).limit(-limit+results.size).order_by([['priority', 1], ['run_at', 1]]).to_a if results.size < limit
+      results
+    end
+
+  end
+end
+
+__END__
+
+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
+}

data/spec/delayed_job_groups_spec.rb

@@ -0,0 +1,107 @@
+require 'spec/spec_helper'
+
+
+class GroupedJob
+  include Mongoid::Document  
+  include JobGroups
+  field :repository
+  
+  job_group{ |simple_job| simple_job.repository }
+
+  def perform
+    puts "running grouped job"
+  end
+end
+
+class SimpleJob
+  include Mongoid::Document  
+  include JobGroups
+    
+  def perform
+    puts "running simple job"
+  end
+end
+
+class User
+  include Mongoid::Document  
+  include JobGroups
+    
+  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 "a job" do
+    before do
+      Delayed::Job.enqueue GroupedJob.new(:repository => "repo1")
+    end
+    
+    it "should have a job group" do
+      Delayed::Job.first.lock_group.should == "repo1"
+    end
+  end
+  
+  context "with 2 jobs in the same group, one locked, one unlocked and 1 job in a different group" do
+    before do
+      group_a_job1 = GroupedJob.new(:repository => "repo1")
+      group_a_job2 = GroupedJob.new(:repository => "repo1")
+      @group_b_job1 = GroupedJob.new(:repository => "repo2")
+      
+      [group_a_job1, @group_b_job1].each{ |job| Delayed::Job.enqueue job }
+      queued_job = Delayed::Job.enqueue group_a_job2
+      queued_job.lock_exclusively!(MAX_RUN_TIME, WORKER)      
+    end
+    
+    it "should find no unlocked jobs" do
+      Delayed::Job.find_available(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.find_available(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.find_available(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.find_available(WORKER, MAX_RUN_TIME).count.should == 1
+    end
+  end  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,41 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+require 'bundler/setup'
+require 'logger'
+require 'mongoid'
+
+
+
+ENV['RAILS_ENV'] = 'test'
+require 'rails'
+
+Mongoid.configure do |config|
+  name = "delayed_job_groups_mongoid"
+  host = "localhost"
+  config.master = Mongo::Connection.new.db(name)
+  config.slaves = [
+    Mongo::Connection.new(host, 27017, :slave_ok => true).db(name)
+  ]
+  config.persist_in_safe_mode = false
+end
+
+
+require 'rspec'
+require 'delayed_job'
+
+Delayed::Worker.logger = Logger.new('/tmp/dj.log')
+
+Delayed::Worker.backend = :mongoid
+
+
+require 'delayed_job_groups/init.rb'
+RSpec.configure do |config|
+  require 'database_cleaner'
+  DatabaseCleaner.strategy = :truncation
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end  
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true  
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: delayed_job_groups_mongoid
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 2
+  version: 0.2.2
+platform: ruby
+authors: 
+- opsb
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-04 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: 
+- lib/delayed_job_groups/init.rb
+- lib/delayed_job_groups/job_groups.rb
+- lib/delayed_job_groups/mongoid_groups.rb
+- lib/delayed_job_groups.rb
+- Gemfile
+- delayed_job_groups_mongoid.gemspec
+- README.markdown
+- 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