resque-multi-step 1.1.3 → 2.0.0

data/History.txt

@@ -1,3 +1,8 @@
+Version 2.0.0
+=====
+
+Add support to reference the original multi-step-task job from within the job classes.
+
 Version 1.1.3
 =====
 

data/README.md

@@ -57,6 +57,28 @@ Then you can look it up using the `.find` method on `MultiStepTask`.
       redirect_to blog_url(blog)
     end
 
+As of version 2.0.0, you can also get a handle on the original multi-step 
+task. This is useful if you need to add another job on the fly, that needs
+to happen before the finalization.
+
+    class ConvertPostToPirateTalk
+      def self.perform(post_id)
+        p = Post.find(post_id)
+        p.convert_to_pirate_talk
+        p.save
+        
+        if p.has_comments?
+          p.comments.each do |c|
+            # #multi_step_task is a class method defined on the class
+            # before invoking #perform as a convenience. you can also
+            # use #multi_step_task_id to just get the resque key.
+            multi_step_task.add_job ConvertCommentToPirateTalk, c.id
+          end
+        end
+      end
+    end
+
+
 Finalization
 ----
 
@@ -91,7 +113,7 @@ Details
 MultiStepTask creates a queue in resque for each task.  To process
 multi-step jobs you will need at least one Resque worker with
 `QUEUES=*`.  This combined with [resque-fairly][] provides fair
-scheduling of the constituent jobs.  
+scheduling of the constituent jobs.
 
 Having a queue per multi-step task means that is easy to determine to
 what task a particular job belongs. It also provides a nice way to see
@@ -99,6 +121,8 @@ what is going on in the system at any given time.  Just got to
 resque-web and look the queue list.  Use meaningful slugs for your
 tasks and you get a quick birds-eye view of what is going on.
 
+As of version 2.0.0 MultiStepTask requires ruby 1.9 or higher.
+
 Note on Patches/Pull Requests
 ----
  
@@ -106,9 +130,8 @@ Note on Patches/Pull Requests
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a
   future version unintentionally.
-* Update history to reflect the change.
-* Commit, do not mess with rakefile, version.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Update history to reflect the change, increment the version properly as described at <http://semver.org/>.
+* Commit
 * Send me a pull request. Bonus points for topic branches.
 
 Mailing List

data/Rakefile

@@ -1,6 +1,5 @@
 require 'rubygems'
 require 'rake'
-require 'rcov'
 
 begin
   require 'jeweler'
@@ -25,13 +24,12 @@ begin
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
-   
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |t|
-    t.libs << 'lib' << 'spec'
-    t.pattern = 'spec/**/*_spec.rb'
-    t.verbose = true
-end
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|

data/VERSION

@@ -1 +1 @@
-1.1.3
+2.0.0

data/lib/resque/plugins/multi_step_task.rb

@@ -104,7 +104,11 @@ module Resque
             logger.debug("[Resque Multi-Step-Task] Executing #{job_module_name} job for #{task_id} at #{start_time} (args: #{args})")
 
             # perform the task
-            constantize(job_module_name).perform(*args)
+            klass = constantize(job_module_name)
+            klass.singleton_class.class_eval "def multi_step_task; @@task ||= MultiStepTask.find('#{task_id}'); end"
+            klass.singleton_class.class_eval "def multi_step_task_id; @@task_id ||= '#{task_id}'; end"
+
+            klass.perform(*args)
 
             logger.debug("[Resque Multi-Step-Task] Finished executing #{job_module_name} job for #{task_id} at #{Time.now}, taking #{(Time.now - start_time)} seconds.")
           rescue Exception => e

data/lib/resque/plugins/multi_step_task/finalization_job.rb

@@ -12,7 +12,10 @@ module Resque
           task = MultiStepTask.find(task_id)
           
           begin
-            constantize(job_module_name).perform(*args)
+            klass = constantize(job_module_name)
+            klass.singleton_class.class_eval "def multi_step_task; @@task ||= MultiStepTask.find('#{task_id}'); end"
+            klass.singleton_class.class_eval "def multi_step_task_id; @@task_id ||= '#{task_id}'; end"
+            klass.perform(*args)
           rescue Exception
             task.increment_failed_count
             raise

data/resque-multi-step.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{resque-multi-step}
-  s.version = "1.1.3"
+  s.name = "resque-multi-step"
+  s.version = "2.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{2011-05-23}
-  s.description = %q{Provides multi-step tasks with finalization and progress tracking}
-  s.email = %q{pezra@barelyenough.org}
+  s.date = "2012-06-14"
+  s.description = "Provides multi-step tasks with finalization and progress tracking"
+  s.email = "pezra@barelyenough.org"
   s.extra_rdoc_files = [
     "LICENSE",
     "README.md"
@@ -40,22 +40,12 @@ Gem::Specification.new do |s|
     "spec/spec.opts",
     "spec/spec_helper.rb"
   ]
-  s.homepage = %q{http://github.com/pezra/resque-multi-step}
+  s.homepage = "http://github.com/pezra/resque-multi-step"
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  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-multi-step_spec.rb",
-    "spec/resque/plugins/multi_step_task/finalization_job_spec.rb",
-    "spec/resque/plugins/multi_step_task_spec.rb",
-    "spec/spec_helper.rb"
-  ]
+  s.rubygems_version = "1.8.16"
+  s.summary = "Provides multi-step tasks with finalization and progress tracking"
 
   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

data/spec/acceptance/acceptance_jobs.rb

@@ -27,5 +27,12 @@ module MultiStepAcceptance
       end
     end
   end
+
+  class BackRefJob
+    def self.perform
+      str = multi_step_task_id
+      mst = multi_step_task
+    end
+  end
   
 end

data/spec/acceptance/job_handling_spec.rb

@@ -121,3 +121,28 @@ describe "Acceptance: Task with retried finalization failure" do
   end
   
 end
+
+describe "Acceptance: Task needing to reference the original Multi-Step-Task" do
+  let(:task) do 
+    Resque::Plugins::MultiStepTask.create("testing") do |task|
+      task.add_job MultiStepAcceptance::BackRefJob
+      task.add_finalization_job MultiStepAcceptance::BackRefJob
+    end
+  end
+
+  before do
+    Resque.redis.del "testing"
+    task
+    sleep 1
+  end
+  
+  it "does not fail" do 
+    5.times {sleep 1 if Resque::Failure.count < 1}
+
+    Resque::Failure.count.should == 0
+  end
+
+  it "completes successfully and removes the queue" do 
+    Resque.queues.should_not include(task.queue_name)
+  end
+end

metadata

@@ -1,98 +1,80 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: resque-multi-step
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 1
-  - 3
-  version: 1.1.3
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Peter Williams
 - Morgan Whitney
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-23 00:00:00 -06:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-06-14 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2169769520 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: redis-namespace
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2169769520
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: &2169768960 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: yajl-ruby
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2169768960
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: &2169768480 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: resque
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2169768480
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: &2169768000 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: resque-fairly
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *2169768000
+- !ruby/object:Gem::Dependency
+  name: resque-fairly
+  requirement: &2169767520 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id005
+  prerelease: false
+  version_requirements: *2169767520
 description: Provides multi-step tasks with finalization and progress tracking
 email: pezra@barelyenough.org
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.md
-files: 
+files:
 - .document
 - History.txt
 - LICENSE
@@ -115,43 +97,28 @@ files:
 - 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: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.16
 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-multi-step_spec.rb
-- spec/resque/plugins/multi_step_task/finalization_job_spec.rb
-- spec/resque/plugins/multi_step_task_spec.rb
-- spec/spec_helper.rb
+test_files: []