resque_empty_queue 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.idea

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2010 Zendesk
+
+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 PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL 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.markdown

@@ -0,0 +1,4 @@
+resque_empty_queue
+===============
+
+Blah blah blah

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "resque_empty_queue"
+    gem.summary = 'resque_empty_queue is an extension to the Resque queue system runs a job after a queue has been emptied.'
+    gem.description = 'resque_empty_queue is an extension to the Resque queue system runs a job after a queue has been emptied.'
+    gem.email = "michael.pearce@bookrenter.com"
+    gem.homepage = "http://github.com/michaelgpearce/resque_empty_queue"
+    gem.authors = ["Michael G. Pearce", "J. A. Wheeler"]
+    gem.add_dependency "resque", ">=1.6.0"
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_development_dependency "mocha", ">=0.9.8"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "resque_empty_queue #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/resque/empty_queue.rb

@@ -0,0 +1,5 @@
+require 'resque'
+ 
+module Resque
+end
+

data/lib/resque/empty_queue_job.rb

@@ -0,0 +1,11 @@
+module Resque
+  class EmptyQueueJob
+    def self.wait_for_empty_queue(queue_name)
+      @queue_name = queue_name
+    end
+
+    def self.queue_name
+      return @queue_name
+    end
+  end
+end

data/lib/resque/empty_queue_retry_job.rb

@@ -0,0 +1,19 @@
+module Resque
+  class EmptyQueueRetryJob
+    @queue = :resque_empty_queue
+
+    def self.perform(empty_queue_job_class_name, *args)
+      klass = eval(empty_queue_job_class_name)
+      if queue_is_empty?(klass)
+        Resque.enqueue(klass, *args)
+      else
+        # TODO: use resque-scheduler to enqueue in the future
+        Resque.enqueue_in(5, self, klass.name, *args)
+      end
+    end
+
+    def self.queue_is_empty?(klass)
+      return Resque.size(klass.queue_name) == 0
+    end
+  end
+end

data/lib/resque/resque.rb

@@ -0,0 +1,36 @@
+require "resque/empty_queue"
+
+module Resque
+  extend self
+
+  # Raised when trying to create a job that does not yet have an empty associated job queue
+  class EmptyQueueError < RuntimeError;
+  end
+
+  def enqueue_with_empty_queue(klass, *args)
+    if !empty_queue_job?(klass) || should_execute_empty_queue_job?(klass, *args)
+      enqueue_without_empty_queue(klass, *args)
+    else
+      # queue not empty
+      enqueue_without_empty_queue(EmptyQueueRetryJob, klass.name, *args)
+    end
+  end
+
+  alias_method :enqueue_without_empty_queue, :enqueue
+  alias_method :enqueue, :enqueue_with_empty_queue
+
+  private
+
+  def should_execute_empty_queue_job?(klass, *args)
+    return true if queue_is_empty?(klass)
+    return false
+  end
+
+  def queue_is_empty?(klass)
+    return Resque.size(klass.queue_name) == 0
+  end
+
+  def empty_queue_job?(klass)
+    klass.ancestors.include?(Resque::EmptyQueueJob)
+  end
+end

data/lib/resque_empty_queue.rb

@@ -0,0 +1,6 @@
+require 'resque_scheduler'
+
+require "resque/resque"
+require "resque/empty_queue"
+require "resque/empty_queue_job"
+require "resque/empty_queue_retry_job"

data/resque_empty_queue.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = 'resque_empty_queue'
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ['Michael G. Pearce', 'J. A. Wheeler']
+  s.date = '2010-07-07'
+  s.description = 'resque_empty_queue is an extension to the Resque queue system runs a job after a queue has been emptied.'
+  s.email = %q{michael.pearce@bookrenter.com, andrew.wheeler@bookrenter.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/resque_empty_queue.rb",
+     "lib/resque/resque.rb",
+     "lib/resque/empty_queue.rb",
+     "lib/resque/empty_queue_job.rb",
+     "lib/resque/empty_queue_retry_job.rb",
+     "resque_empty_queue.gemspec",
+     "test/resque/resque_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = 'http://github.com/michaelgpearce/resque_empty_queue'
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = 'resque_empty_queue is an extension to the Resque queue system runs a job after a queue has been emptied.'
+  s.test_files = [
+    "test/resque/resque_test.rb",
+     "test/test_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::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<resque>, [">= 1.6.0"])
+      s.add_runtime_dependency(%q<resque-scheduler>, [">= 0"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0.9.8"])
+    else
+      s.add_dependency(%q<resque>, [">= 1.6.0"])
+      s.add_dependency(%q<resque-scheduler>, [">= 0"])
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0.9.8"])
+    end
+  else
+    s.add_dependency(%q<resque>, [">= 1.6.0"])
+    s.add_dependency(%q<resque-scheduler>, [">= 0"])
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0.9.8"])
+  end
+end
+

data/test/resque/resque_test.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class ResqueTest < Test::Unit::TestCase
+
+  context "Resque" do
+    setup do
+      Resque.redis.flushall
+      @bogus_args = "bogus_arg"
+    end
+
+    context "#enqueue" do
+
+      context "the queue is not empty" do
+        setup do
+          Resque.enqueue(QueuedJob, @bogus_args)
+        end
+
+        should "not add another job to the queue and raise an exception" do
+          assert_raises(Resque::EmptyQueueError) { Resque.enqueue(DefaultEmptyQueueJob, @bogus_args) }
+        end
+      end
+
+      context "the queue is empty" do
+        should "raise an exception on a duplicate indentifier" do
+          Resque.expects(:enqueue_without_empty_queue).once
+          Resque.enqueue(DefaultEmptyQueueJob, @bogus_args)
+        end
+      end
+
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'resque/resque'
+require 'resque/empty_queue'
+require 'resque/empty_queue_job'
+
+class Test::Unit::TestCase
+end
+
+#fixture classes
+class DefaultEmptyQueueJob < Resque::EmptyQueueJob
+  wait_for_empty_queue :some_queue
+  @queue = :empty_queue
+
+  def self.perform(some_id, some_other_thing)
+    puts "default empty queue perform"
+  end
+end
+
+class QueuedJob
+  @queue = :some_queue
+
+  def self.perform(some_id, some_other_thing)
+    sleep(2)
+    puts "queued job perform"
+  end
+end
+

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification 
+name: resque_empty_queue
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Michael G. Pearce
+- J. A. Wheeler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-07 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: resque
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: resque-scheduler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  type: :development
+  version_requirements: *id004
+description: resque_empty_queue is an extension to the Resque queue system runs a job after a queue has been emptied.
+email: michael.pearce@bookrenter.com, andrew.wheeler@bookrenter.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/resque_empty_queue.rb
+- lib/resque/resque.rb
+- lib/resque/empty_queue.rb
+- lib/resque/empty_queue_job.rb
+- lib/resque/empty_queue_retry_job.rb
+- resque_empty_queue.gemspec
+- test/resque/resque_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/michaelgpearce/resque_empty_queue
+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: resque_empty_queue is an extension to the Resque queue system runs a job after a queue has been emptied.
+test_files: 
+- test/resque/resque_test.rb
+- test/test_helper.rb