resque-multi-step 1.0.0

data/resque-multi-step.gemspec

@@ -0,0 +1,81 @@
+# 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 = %q{resque-multi-step}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Peter Williams", "Morgan Whitney"]
+  s.date = %q{2010-10-04}
+  s.description = %q{Provides multi-step tasks with finalization and progress tracking}
+  s.email = %q{pezra@barelyenough.org}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "lib/resque-multi-step.rb",
+     "lib/resque/plugins/multi_step_task.rb",
+     "lib/resque/plugins/multi_step_task/assure_finalization.rb",
+     "lib/resque/plugins/multi_step_task/atomic_counters.rb",
+     "lib/resque/plugins/multi_step_task/constantization.rb",
+     "lib/resque/plugins/multi_step_task/finalization_job.rb",
+     "lib/resque_mutli_step.rb",
+     "resque-multi-step-task.gemspec",
+     "resque-multi-step.gemspec",
+     "spec/acceptance/acceptance_jobs.rb",
+     "spec/acceptance/job_handling_spec.rb",
+     "spec/acceptance/spec_helper.rb",
+     "spec/resque-multi-step_spec.rb",
+     "spec/resque/plugins/multi_step_task/finalization_job_spec.rb",
+     "spec/resque/plugins/multi_step_task_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/pezra/resque-multi-step}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Provides multi-step tasks with finalization and progress tracking}
+  s.test_files = [
+    "spec/acceptance/acceptance_jobs.rb",
+     "spec/acceptance/job_handling_spec.rb",
+     "spec/acceptance/spec_helper.rb",
+     "spec/resque/plugins/multi_step_task/finalization_job_spec.rb",
+     "spec/resque/plugins/multi_step_task_spec.rb",
+     "spec/resque-multi-step_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::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<redis-namespace>, ["~> 0.8.0"])
+      s.add_runtime_dependency(%q<resque>, ["~> 1.10"])
+      s.add_runtime_dependency(%q<resque-fairly>, ["~> 1.0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<redis-namespace>, ["~> 0.8.0"])
+      s.add_dependency(%q<resque>, ["~> 1.10"])
+      s.add_dependency(%q<resque-fairly>, ["~> 1.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<redis-namespace>, ["~> 0.8.0"])
+    s.add_dependency(%q<resque>, ["~> 1.10"])
+    s.add_dependency(%q<resque-fairly>, ["~> 1.0"])
+  end
+end
+

data/spec/acceptance/acceptance_jobs.rb

@@ -0,0 +1,31 @@
+module MultiStepAcceptance
+  class WaitJob
+    def self.perform(duration)
+      sleep duration
+    end
+  end
+  
+  class CounterJob
+    def self.perform(key)
+      Resque.redis.incr key
+    end
+  end
+  
+  class FailJob
+    def self.perform
+      raise "boom"
+    end
+  end
+
+  class FailOnceJob
+    def self.perform(key)
+      if Resque.redis.exists(key)
+        return
+      else
+        Resque.redis.set(key, 'was here')
+        raise "boom"
+      end
+    end
+  end
+  
+end

data/spec/acceptance/job_handling_spec.rb

@@ -0,0 +1,121 @@
+require File.expand_path("spec_helper", File.dirname(__FILE__))
+require 'resque/plugins/multi_step_task'
+
+# These tests are inherently sensitive to timing.  There are sleeps a
+# the appropriate places to reduce/eliminate false failures where
+# possible.  However, a failure does not always indicate a bug.  Run
+# the test multiple times before accepting failures at face value.
+
+describe "Acceptance: Successful task" do 
+  let(:task) {
+    Resque::Plugins::MultiStepTask.create("testing") do |task|
+      task.add_job MultiStepAcceptance::CounterJob, "testing counter"
+    end
+  }
+
+  before do 
+    Resque.redis.del "testing counter"
+    task
+    sleep 1
+  end
+
+  it "processes its job" do 
+    Resque.redis.get("testing counter").to_i.should == 1
+  end
+
+  it "removes queue when done" do 
+    Resque.queues.should_not include(task.queue_name)
+  end
+end
+
+describe "Acceptance: Successful tasks" do 
+  let(:task) {
+    Resque::Plugins::MultiStepTask.create("testing") do |task|
+      task.add_job MultiStepAcceptance::WaitJob, 1
+    end
+  }
+
+  before {task}
+
+  it "create queue" do 
+    Resque.queues.should include(task.queue_name)
+  end
+
+  it "queues jobs in its queue" do 
+    Resque.peek(task.queue_name).should_not be_nil
+  end
+
+end
+
+describe "Acceptance: Task with step failure" do 
+  let(:task) {
+    Resque::Plugins::MultiStepTask.create("testing") do |task|
+      task.add_job MultiStepAcceptance::FailJob
+    end
+  }
+
+  before do
+    Resque::Failure.clear
+    task
+    sleep 1
+  end
+
+  it "put job in fail list" do 
+    Resque::Failure.count.should == 1
+  end
+
+end
+
+describe "Acceptance: Task with finalization failure" do 
+  let(:task) {
+    Resque.redis.del "testing counter"
+    Resque::Plugins::MultiStepTask.create("testing") do |task|
+      task.add_finalization_job MultiStepAcceptance::FailJob
+    end
+  }
+
+  before do
+    Resque::Failure.clear
+    task
+    sleep 1
+  end
+  
+  it "put job in fail list" do 
+    5.times {sleep 1 if Resque::Failure.count < 1}
+
+    Resque::Failure.count.should == 1
+  end
+end
+
+describe "Acceptance: Task with retried finalization failure" do 
+  let(:task) {
+    Resque.redis.del "testing counter"
+    Resque::Plugins::MultiStepTask.create("testing") do |task|
+      task.add_finalization_job MultiStepAcceptance::FailOnceJob, "fin-job"
+      task.add_finalization_job MultiStepAcceptance::CounterJob,"testing counter"
+    end
+  }
+
+  before do
+    Resque::Failure.clear
+    Resque.redis.del "testing counter"
+    
+    task
+    sleep 1
+    
+    Resque::Failure.requeue 0
+    sleep 1
+  end
+
+  it "completes task" do 
+    lambda {
+      Resque::Plugins::MultiStepTask.find(task.task_id)
+    }.should raise_error(Resque::Plugins::MultiStepTask::NoSuchMultiStepTask)
+  end
+
+
+  it "runs following finalization jobs" do 
+    Resque.redis.get("testing counter").to_i.should == 1
+  end
+  
+end

data/spec/acceptance/spec_helper.rb

@@ -0,0 +1,13 @@
+require File.expand_path("../spec_helper", File.dirname(__FILE__))
+
+$LOAD_PATH << File.dirname(__FILE__)
+require 'acceptance_jobs'
+
+$worker_pid = fork
+if $worker_pid.nil?
+  # in child
+  exec "rake resque:work 'QUEUES=*' 'NAMESPACE=resque-multi-step-task-testing' INTERVAL=1 VERBOSE=1"
+end
+
+# wait for worker to come up
+sleep 4

data/spec/resque/plugins/multi_step_task/finalization_job_spec.rb

@@ -0,0 +1,34 @@
+require File.expand_path("../../../spec_helper", File.dirname(__FILE__))
+
+module  Resque::Plugins
+  class MultiStepTask
+    describe FinalizationJob do 
+      let(:task){MultiStepTask.create("some-task")}
+      
+      before do
+        task.finalizable!
+      end
+
+      it "queues next finalization job when done" do 
+        Resque::Job.should_receive(:create).with(anything, Resque::Plugins::MultiStepTask::FinalizationJob, task.task_id, 'TestJob', 42)
+        
+        task.add_finalization_job(TestJob, 42)
+
+        FinalizationJob.perform(task.task_id, 'TestJob', 0)
+      end
+
+      it "cleans up on the last job" do 
+        task.should_receive(:nuke)
+        MultiStepTask.stub!(:find).and_return(task)
+        
+        FinalizationJob.perform(task.task_id, 'TestJob', 0)
+      end
+    end
+  end
+end
+
+module ::TestJob
+  def self.perform(*args)
+    # no op
+  end
+end

data/spec/resque/plugins/multi_step_task_spec.rb

@@ -0,0 +1,235 @@
+require File.expand_path("../../spec_helper", File.dirname(__FILE__))
+
+module  Resque::Plugins
+  describe MultiStepTask, "class" do 
+    it "allows creating new tasks" do 
+      MultiStepTask.create("brand-new-task").should be_kind_of(MultiStepTask)
+    end
+
+    it "allows creating new tasks with job specification block" do 
+      MultiStepTask.create("brand-new-task") do |task|
+        task.add_job(TestJob)
+      end.should be_kind_of(MultiStepTask)
+    end
+    
+    it "uniquifies task queues when creating new task with same slug as and existing one" do 
+      a = MultiStepTask.create("some-task")
+      b = MultiStepTask.create("some-task")
+      
+      a.queue_name.should_not == b.queue_name
+    end 
+
+    it "allows finding existing tasks" do 
+      task_id = MultiStepTask.create("some-task").task_id
+      
+      MultiStepTask.find(task_id).should be_kind_of(MultiStepTask)
+      MultiStepTask.find(task_id).task_id.should == task_id
+    end
+
+    it "raises exception on #find for non-existent task" do 
+      lambda{
+        MultiStepTask.find('nonexistent-task')
+      }.should raise_error(MultiStepTask::NoSuchMultiStepTask)
+    end
+
+    it "allows mode to be set to :sync" do 
+      MultiStepTask.mode = :sync
+      MultiStepTask.should be_synchronous
+    end
+
+    it "allows mode to be set to :async" do 
+      MultiStepTask.mode = :async
+      MultiStepTask.should_not be_synchronous
+    end
+  end
+
+  describe MultiStepTask do 
+    let(:task) {MultiStepTask.create("some-task")}
+
+    it "allows jobs to be added to task" do 
+      lambda {
+        task.add_job(TestJob)
+      }.should_not raise_error
+    end
+
+    it "queues added job" do
+      Resque::Job.should_receive(:create).with(task.queue_name, Resque::Plugins::MultiStepTask, task.task_id, 'TestJob')
+      task.add_job(TestJob)
+    end
+
+    it "allows finalization jobs to be added" do 
+      task.add_finalization_job(TestJob)
+    end
+
+    it "allows itself to become finalizable" do
+      task.finalizable!
+      task.should be_finalizable
+    end
+
+    it "queues assure finalization job when it becomes finalizable" do
+      Resque::Job.should_receive(:create).with(task.queue_name, ::Resque::Plugins::MultiStepTask::AssureFinalization, task.task_id)
+      task.finalizable!
+    end
+
+    it "knows total job count" do 
+      task.add_job(TestJob)
+
+      task.total_job_count.should == 1
+    end
+
+    it "includes finalization jobs in total job count" do 
+      task.add_job(TestJob)
+      task.add_finalization_job(TestJob, "my", "args")
+
+      task.total_job_count.should == 2
+    end
+  end
+
+  describe MultiStepTask, "synchronous mode" do 
+    let(:task){MultiStepTask.create("some-task")}
+
+    before do 
+      MultiStepTask.mode = :sync
+    end
+    
+    after do
+      MultiStepTask.mode = :async
+    end
+
+    it "runs job when added" do
+      TestJob.should_receive(:perform).with("my", "args")
+      task.add_job(TestJob, "my", "args")
+    end
+
+    it "runs finalization job when added" do
+      TestJob.should_receive(:perform).with("my", "args")
+      task.add_finalization_job(TestJob, "my", "args")
+      task.finalizable!
+    end
+
+    it "runs finalization jobs last" do
+      TestJob.should_receive(:perform).with("my", "args").ordered
+      MyFinalJob.should_receive(:perform).with("final", "args").ordered
+
+      task.add_finalization_job(MyFinalJob, "final", "args")
+      task.add_job(TestJob, "my", "args")
+      task.finalizable!
+    end
+  end
+  
+  describe MultiStepTask, "finalization" do 
+    let(:task){MultiStepTask.create("some-task")}
+
+    before do
+      task.finalizable!
+    end
+
+    it "queue finalization jobs" do 
+      Resque::Job.should_receive(:create).with(anything, Resque::Plugins::MultiStepTask::FinalizationJob, task.task_id, 'TestJob', 42)
+
+      task.add_finalization_job(TestJob, 42)
+      task.finalize!
+    end
+
+    it "initiates finalization at end of last job" do 
+      task.add_finalization_job(TestJob, 42)
+
+      Resque::Job.should_receive(:create).with(anything, Resque::Plugins::MultiStepTask::FinalizationJob, task.task_id, 'TestJob', 42)
+      Resque::Job.reserve(task.queue_name).perform
+    end
+
+    it "removes queue from resque" do 
+      task.add_job(TestJob)  # creates queue
+      MultiStepTask.perform(task.task_id, 'TestJob')  # simulate runing final job
+
+      Resque.queues.should_not include(task.task_id)
+    end
+
+    it "fails if finalization has already been run" do 
+      task.finalize!
+      lambda{task.finalize!}.should raise_error(::Resque::Plugins::MultiStepTask::FinalizationAlreadyBegun)
+    end
+
+    it "fails if task is not yet finalizable" do 
+      task = MultiStepTask.create("some-task")
+      lambda{task.finalize!}.should raise_error(::Resque::Plugins::MultiStepTask::NotReadyForFinalization)
+    end
+
+    it "fails if task has errors" do 
+      TestJob.should_receive(:perform).and_raise('boo')
+      task = MultiStepTask.create("some-task")
+      MultiStepTask.perform(task.task_id, 'TestJob') rescue nil
+
+      lambda{task.finalize!}.should raise_error(::Resque::Plugins::MultiStepTask::NotReadyForFinalization)
+    end
+
+  end
+
+  describe MultiStepTask, "performing job" do 
+    let(:task){MultiStepTask.create("some-task")}
+
+    it "invokes specified job when #perform is called" do 
+      TestJob.should_receive(:perform).with(42, 'aaa')
+
+      MultiStepTask.perform(task.task_id, 'TestJob', 42, 'aaa')
+    end
+
+    it "increments completed count on job success" do 
+      lambda{
+        MultiStepTask.perform(task.task_id, 'TestJob', 42, 'aaa')
+      }.should change(task, :completed_count).by(1)
+    end
+  end
+
+  describe MultiStepTask, "performing job that fails" do 
+    let(:task){MultiStepTask.create("some-task")}
+
+    before do
+      TestJob.should_receive(:perform).and_raise('boo')
+    end
+
+    it "increments failed count" do 
+      lambda{
+        MultiStepTask.perform(task.task_id, 'TestJob', 42, 'aaa') rescue nil
+      }.should change(task, :failed_count).by(1)
+    end
+
+    it "does not increment completed count" do 
+      lambda{
+        MultiStepTask.perform(task.task_id, 'TestJob', 42, 'aaa') rescue nil
+      }.should_not change(task, :completed_count).by(1)
+    end
+
+    it "bubbles raised exception job up to resque" do 
+      lambda{
+        MultiStepTask.perform(task.task_id, 'TestJob', 42, 'aaa')
+      }.should raise_exception("boo")
+    end
+
+    it "knows it is incomplete because of failures" do
+      task.increment_normal_job_count
+      MultiStepTask.perform(task.task_id, 'TestJob', 42, 'aaa') rescue nil
+      
+      task.should be_incomplete_because_of_errors
+    end
+
+    it "knows it is complete when failures have occurred and have been retried successfully" do
+      MultiStepTask.perform(task.task_id, 'TestJob', 42, 'aaa') rescue nil
+      
+      task.should_not be_incomplete_because_of_errors
+    end
+  end
+end
+
+module ::TestJob
+  def self.perform(*args)
+    # no op
+  end
+end
+
+module ::MyFinalJob
+  def self.perform(*args)
+    # no op
+  end
+end
+

data/spec/resque-multi-step_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ResqueMultiStepTask" do
+  it "defines MultiStepTask" do 
+    defined?(Resque::Plugins::MultiStepTask).should be_true
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--format=specdoc

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'resque-multi-step'
+require 'spec'
+require 'spec/autorun'
+require 'pp'
+
+Spec::Runner.configure do |config|
+  config.before do 
+    # Tests are jailed to a testing namespace and that space does
+    # contains in left over data from previous runs.
+    Resque.redis.namespace = "resque-multi-step-task-testing"
+    Resque.redis.keys('*').each{|k| Resque.redis.del k}
+
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification 
+name: resque-multi-step
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Peter Williams
+- Morgan Whitney
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-04 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: redis-namespace
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 0
+        version: 0.8.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: resque
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 10
+        version: "1.10"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: resque-fairly
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id004
+description: Provides multi-step tasks with finalization and progress tracking
+email: pezra@barelyenough.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/resque-multi-step.rb
+- lib/resque/plugins/multi_step_task.rb
+- lib/resque/plugins/multi_step_task/assure_finalization.rb
+- lib/resque/plugins/multi_step_task/atomic_counters.rb
+- lib/resque/plugins/multi_step_task/constantization.rb
+- lib/resque/plugins/multi_step_task/finalization_job.rb
+- lib/resque_mutli_step.rb
+- resque-multi-step-task.gemspec
+- resque-multi-step.gemspec
+- spec/acceptance/acceptance_jobs.rb
+- spec/acceptance/job_handling_spec.rb
+- spec/acceptance/spec_helper.rb
+- spec/resque-multi-step_spec.rb
+- spec/resque/plugins/multi_step_task/finalization_job_spec.rb
+- spec/resque/plugins/multi_step_task_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/pezra/resque-multi-step
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Provides multi-step tasks with finalization and progress tracking
+test_files: 
+- spec/acceptance/acceptance_jobs.rb
+- spec/acceptance/job_handling_spec.rb
+- spec/acceptance/spec_helper.rb
+- spec/resque/plugins/multi_step_task/finalization_job_spec.rb
+- spec/resque/plugins/multi_step_task_spec.rb
+- spec/resque-multi-step_spec.rb
+- spec/spec_helper.rb