state_machine_job 0.1.0 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MjBhMmYyZDQ1ZmFkMDczYzI1OGZmYjY5YmZjYmYxMGRlZTU2ZDJhZQ==
+    ZGViMzAyYTY5MDM0ODM1YTEyZWQ4ODI5OGMyMjE1NWUxYjcwYTQzYQ==
   data.tar.gz: !binary |-
-    NTZmMjhhYzU5Y2Q2YzA0M2ZiM2M3MjFhZmNlYjU3YjdlMjM2YjJmNg==
+    NTlhMzgwNzk4OWJhZDNjMWE1YWJmOTAyOWIwNzkxOGZlZWYxMDY1OA==
 SHA512:
   metadata.gz: !binary |-
-    ZjAxNTY4YzQ5OGI0MmIzYjA5YzFkYWYwZDFmZmZlYjJkYjVhNzFhZjkwYjZj
-    Yzg4NDEyZGRjOTM0MmU5OGQxOWRmNGJjN2FlYzg2YmYzNmQxNWVkZDlhMDUw
-    YTE4ZjlhZGI5OWMwYjBhNTc4Mjg3OTI2MzM0ZGI5YzM2NWUwMWM=
+    NmQ4NjU2Mzc0NjZiOThjMmVkYTkwODYzYTQwZmVhZGFhNWNmNmM1ZDAxNzUz
+    NDJiNDVlY2VmMjY4OWVmYzUwYmE2MWMzYjA4OTk4NjEyNzc3ZjIyZTU2MjA0
+    M2VlNmUxNjRmNzdmM2NkZGNkOTZmYjhjMmUwMTNlZmFkZGQ5ZjY=
   data.tar.gz: !binary |-
-    ZDc0MDZiNTVkMDI0MGJjNTgxYjRjODFkMGRjYmFjYzIxYzI2YjhmNDRjNmFj
-    NmU1YTQwNDQ1NWQ1NzJkNmFlNzI2MDQxZDQ5YjY5ODk0MzViODkxM2E5ODZj
-    MTc2OTU1MDQwYjc3YzEwNDcwMjQ2MjlhZjMxOWFhZjg1MmM3Nzg=
+    YzFjNDZhYWU4YmNkYjMzMGI3ZDE3NmY2NmQ5YjI1ZGU5Mjk5ODY4NzZmNGQ4
+    MWM1OWIyNzhjZDAzMDA5NjMwMzdhZWM4NGU4M2EzY2U5YjE0YzRhODg1NzAy
+    MDdhOWRkODI4ZDUyYjVlOGZlNTRmYWI2M2JiZjBiOTA1ZTViNDM=

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# CHANGELOG
+
+### Version 0.2.0
+
+* `:if` option for job `result` to change to different states based on
+  conditionals.
+* Raise an exception if the shorthand `result` signature is used with
+  further options which would be ignored.
+
+### Version 0.1.0
+
+* `:retry_if_state` option to rerun jobs on completion if the state
+  changed since the job was scheduled.

data/README.md

@@ -12,7 +12,7 @@ Add this line to your application's Gemfile:
 
     gem 'state_machine_job'
 
-Requires the [resque-logger](https://github.com/salizzar/resque-logger) 
+Requires the [resque-logger](https://github.com/salizzar/resque-logger)
 gem to be present and configured.
 
 ## Usage
@@ -83,6 +83,26 @@ method using the `payload` method:
 `perform_with_result` is now called with the given hash of options as
 the second parameter.
 
+### Changing to States With Conditions
+
+One job result can lead to different states based on a conditional.
+When the job finishes with the given result, the state machine
+transitions to the first state whose conditional evaluates to true.
+
+    job SomeJob do
+      on_enter 'running'
+
+      result :ok, :state => 'special', :if => lambda { |record| record.some_condition? }
+      result :ok, :state => 'other', :if => :other_condition?
+      result :ok, :state => 'done'
+
+      result :error => 'failed'
+    end
+
+A conditional can either be a lambda which optionally accepting the
+record as parameter or a symbol specifying a method to call on the
+record.
+
 ### Retrying Jobs after a Delay
 
 You can tell the state machine to retry a job based on its result:
@@ -97,7 +117,7 @@ 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`](https://github.com/resque/resque-scheduler) 
+job. This functionality requires the [`resque-scheduler`](https://github.com/resque/resque-scheduler)
 gem.
 
 ### Retrying Jobs Based on State
@@ -122,3 +142,7 @@ 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`.
+
+## See also
+
+[CHANGELOG](https://github.com/codevise/state_machine_job/blob/master/CHANGELOG.md)

data/lib/state_machine_job/macro.rb

@@ -16,6 +16,10 @@ module StateMachineJob
 
       def result(job_result, options = {})
         if job_result.is_a?(Hash)
+          if job_result.size > 1
+            raise("Use an explicit :state option when passing additional options.\n\n      result :ok, :state => :done, :if => ...\n  NOT result :ok => :done, :if => ...\n\n")
+          end
+
           return result(job_result.first.first, :state => job_result.first.last)
         end
 
@@ -27,6 +31,10 @@ module StateMachineJob
           raise('The on_enter call must appear above any result using the :retry_if_state option.')
         end
 
+        if options[:if] && options[:retry_after]
+          raise('Combining the :retry_after and :if options is not supported at the moment.')
+        end
+
         on_enter_state = @on_enter_state
 
         if options[:state]
@@ -35,7 +43,7 @@ module StateMachineJob
               transition options[:retry_if_state] => on_enter_state
             end
 
-            transition all => options[:state]
+            transition(all => options[:state], :if => options[:if])
           end
         elsif options[:retry_after]
           @state_machine.define_helper :instance, retry_job_method_name(job_result) do |machine, object|

data/lib/state_machine_job/version.rb

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

data/spec/state_machine_job/macro_spec.rb

@@ -145,6 +145,104 @@ module StateMachineJob
       expect(object.state).to eq('done')
     end
 
+    it 'result raises descriptive error when trying to use hash only signature with additional options' do
+      expect {
+        Class.new do
+          state_machine :initial => :idle  do
+            extend StateMachineJob::Macro
+
+            job TestJob do
+              on_enter :running
+              result :ok => :done, :if => true
+            end
+          end
+        end
+      }.to raise_error(/Use an explicit :state option/)
+    end
+
+    describe ':if option' do
+      it 'allows skipping matching results' 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 :other
+
+            event :run do
+              transition :idle => :running
+            end
+
+            job TestJob, queue do
+              on_enter :running
+              result :ok, :state => :done, :if => lambda { false }
+              result :ok, :state => :other
+            end
+          end
+        end.new
+
+        object.state = :running
+        object.state_machine_job_test_job_ok
+
+        expect(object.state).to eq('other')
+      end
+
+      it 'uses matching results if condition is truthy' 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 :other
+
+            event :run do
+              transition :idle => :running
+            end
+
+            job TestJob, queue do
+              on_enter :running
+              result :ok, :state => :done, :if => lambda { true }
+              result :ok, :state => :other
+            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 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, :if => true, :retry_after => 100
+              end
+            end
+          end
+        }.to raise_error(/not supported/)
+      end
+    end
+
     describe ':retry_if_state option' do
       it 'returns to on_enter state if state matches option when job finishes' do
         queue = double('queue')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: state_machine_job
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Codevise Solutions Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-16 00:00:00.000000000 Z
+date: 2014-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -117,6 +117,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md