state_machine_job 0.0.6 → 0.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjU1OTk3MjUyZjViM2JhMzczZTk2MGFmZTc3YjU5YzY1NzI1ZjBiZg==
+    MjBhMmYyZDQ1ZmFkMDczYzI1OGZmYjY5YmZjYmYxMGRlZTU2ZDJhZQ==
   data.tar.gz: !binary |-
-    NDA4OTYxMmI4MjA3YWM1ZDg2ZDVhZmJlYWQ4YWQ1ZWQ1NjA2OGY5Nw==
+    NTZmMjhhYzU5Y2Q2YzA0M2ZiM2M3MjFhZmNlYjU3YjdlMjM2YjJmNg==
 SHA512:
   metadata.gz: !binary |-
-    OGI4MWY0MDFlYmY1ZmY2NjI3YzUzNDk4MzAxNzZkYWFmOGZlNzI5NTViYTFk
-    MmI2ODZmY2MxNTAwNTYyYmI0YTMzNzQyYTk5OWE4ZDcyZTA3ZWI1OWRlYzMw
-    NjRjZDFlZDI2NDVjYzNmNzc3OTBjN2Y4MDdkZTA1ZDdmNDc0N2U=
+    ZjAxNTY4YzQ5OGI0MmIzYjA5YzFkYWYwZDFmZmZlYjJkYjVhNzFhZjkwYjZj
+    Yzg4NDEyZGRjOTM0MmU5OGQxOWRmNGJjN2FlYzg2YmYzNmQxNWVkZDlhMDUw
+    YTE4ZjlhZGI5OWMwYjBhNTc4Mjg3OTI2MzM0ZGI5YzM2NWUwMWM=
   data.tar.gz: !binary |-
-    MjhkYjU5NThmMzI0M2JmZjJmZWJhYjI3MGQzMjdjNjliOGJmMGFmMDcxNzg3
-    ZmNlZmQ5YjIxYTg1MjUzNTM2ZGUzNzc3NDczNDU5ZTAyOWQ1ZTE1YjNhNDQ1
-    ZWJkODI3NGY2ZGY2NmFkZjJkMzk5YTA2MzEwMjcyZTc5NGViYzQ=
+    ZDc0MDZiNTVkMDI0MGJjNTgxYjRjODFkMGRjYmFjYzIxYzI2YjhmNDRjNmFj
+    NmU1YTQwNDQ1NWQ1NzJkNmFlNzI2MDQxZDQ5YjY5ODk0MzViODkxM2E5ODZj
+    MTc2OTU1MDQwYjc3YzEwNDcwMjQ2MjlhZjMxOWFhZjg1MmM3Nzg=

data/README.md

@@ -12,6 +12,9 @@ Add this line to your application's Gemfile:
 
     gem 'state_machine_job'
 
+Requires the [resque-logger](https://github.com/salizzar/resque-logger) 
+gem to be present and configured.
+
 ## Usage
 
 Extend your resque job with the `StateMachineJob` mixin and provide a
@@ -48,10 +51,6 @@ Now you can wire up the job in a state machine using the
       job SomeJob do
         on_enter 'running'
 
-        payload do |record|
-          {:some_attribute => record.some_attribute}
-        end
-
         result :ok => 'done'
         result :error => 'failed'
       end
@@ -84,7 +83,7 @@ method using the `payload` method:
 `perform_with_result` is now called with the given hash of options as
 the second parameter.
 
-### Retrying Jobs
+### Retrying Jobs after a Delay
 
 You can tell the state machine to retry a job based on its result:
 
@@ -98,4 +97,28 @@ You can tell the state machine to retry a job based on its result:
 
 When `perform_with_result` returns the result `:pending`, the state
 machine will remain in the `runnning` state and enqueue a delayed
-job. This functionality requires the `resque-scheduler` gem.
+job. This functionality requires the [`resque-scheduler`](https://github.com/resque/resque-scheduler) 
+gem.
+
+### Retrying Jobs Based on State
+
+You can tell the state machine to retry a job if a transition to a
+certain state occures while a job is running:
+
+    event :run do
+      transition 'idle' => 'running'
+      transition 'running' => 'rerun_requested'
+    end
+
+    job SomeJob do
+      on_enter 'running'
+
+      result :ok, :state => 'done', :retry_if_state => 'rerun_requested'
+      result :error => 'failed'
+    end
+
+If the `run` event is invoked while the job is already running, you
+can transition to a state signaling that the job will need to run
+again once it has finished.  In example, passing the `:retry_if_state`
+option causes the state machine to transition back to the `running`
+state once the job finishes with result `:ok`.

data/lib/state_machine_job/macro.rb

@@ -19,9 +19,23 @@ module StateMachineJob
           return result(job_result.first.first, :state => job_result.first.last)
         end
 
+        if options[:retry_if_state] && options[:retry_after]
+          raise('Combining the :retry_after and :retry_on_state options is not supported at the moment.')
+        end
+
+        if options[:retry_if_state] && !@on_enter_state
+          raise('The on_enter call must appear above any result using the :retry_if_state option.')
+        end
+
+        on_enter_state = @on_enter_state
+
         if options[:state]
           @state_machine.event(job_result_event_name(job_result)) do
-            transition any => options[:state]
+            if options[:retry_if_state]
+              transition options[:retry_if_state] => on_enter_state
+            end
+
+            transition all => options[:state]
           end
         elsif options[:retry_after]
           @state_machine.define_helper :instance, retry_job_method_name(job_result) do |machine, object|
@@ -32,6 +46,7 @@ module StateMachineJob
 
       def on_enter(state)
         job, state_machine, queue = @job, @state_machine, @queue
+        @on_enter_state = state
 
         @state_machine.after_transition @state_machine.any => state do |object|
           queue.enqueue(job, object.class.name, object.id, @payload.call(object))

data/lib/state_machine_job/version.rb

@@ -1,3 +1,3 @@
 module StateMachineJob
-  VERSION = '0.0.6'
+  VERSION = '0.1.0'
 end

data/spec/state_machine_job/macro_spec.rb

@@ -144,5 +144,121 @@ module StateMachineJob
 
       expect(object.state).to eq('done')
     end
+
+    describe ':retry_if_state option' do
+      it 'returns to on_enter state if state matches option when job finishes' do
+        queue = double('queue')
+        object = Class.new do
+          def id
+            43
+          end
+
+          state_machine :initial => :idle  do
+            extend StateMachineJob::Macro
+
+            state :idle
+            state :running
+            state :done
+            state :failed
+
+            event :run do
+              transition :idle => :running
+              transition :running => :rerun_required
+            end
+
+            job TestJob, queue do
+              on_enter :running
+              result :ok, :state => :done, :retry_if_state => :rerun_required
+            end
+          end
+        end.new
+
+        expect(queue).to receive(:enqueue).with(TestJob, nil, 43, {})
+
+        object.state = :running
+        object.run
+        object.state_machine_job_test_job_ok
+
+        expect(object.state).to eq('running')
+      end
+
+      it 'returns to result state if state does not match option when job finishes' do
+        queue = double('queue')
+        object = Class.new do
+          def id
+            43
+          end
+
+          state_machine :initial => :idle  do
+            extend StateMachineJob::Macro
+
+            state :idle
+            state :running
+            state :done
+            state :failed
+
+            event :run do
+              transition :idle => :running
+              transition :running => :rerun_required
+            end
+
+            job TestJob, queue do
+              on_enter :running
+              result :ok, :state => :done, :retry_if_state => :rerun_required
+            end
+          end
+        end.new
+
+        object.state = :running
+        object.state_machine_job_test_job_ok
+
+        expect(object.state).to eq('done')
+      end
+
+      it 'raises descriptive error when on_enter is used after result' do
+        expect {
+          Class.new do
+            state_machine :initial => :idle  do
+              extend StateMachineJob::Macro
+
+              job TestJob do
+                result :ok, :state => :done, :retry_if_state => :rerun_required
+                on_enter :running
+              end
+            end
+          end
+        }.to raise_error(/on_enter call must appear above any result/)
+      end
+
+      it 'raises descriptive error when used in combination with :retry_after option' do
+        expect {
+          Class.new do
+            state_machine :initial => :idle  do
+              extend StateMachineJob::Macro
+
+              job TestJob do
+                on_enter :running
+                result :ok, :state => :done, :retry_if_state => :rerun_required, :retry_after => 100
+              end
+            end
+          end
+        }.to raise_error(/not supported/)
+      end
+    end
+
+    it 'does not raise exception if on_enter is used after result without :retry_if_state option' do
+      expect {
+        Class.new do
+          state_machine :initial => :idle  do
+            extend StateMachineJob::Macro
+
+            job TestJob do
+              result :ok, :state => :done
+              on_enter :running
+            end
+          end
+        end
+      }.not_to raise_error
+    end
   end
 end

metadata

@@ -1,23 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: state_machine_job
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - Codevise Solutions Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-01 00:00:00.000000000 Z
+date: 2014-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  type: :development
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -26,12 +26,12 @@ dependencies:
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
-  type: :development
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -40,12 +40,12 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  type: :development
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -54,12 +54,12 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
-  type: :development
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -68,12 +68,12 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: resque
-  type: :runtime
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -82,12 +82,12 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: resque-logger
-  type: :runtime
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -96,12 +96,12 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: state_machine
-  type: :runtime
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -148,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Resque jobs class for rails state machines.