status_workflow 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a93bf66014b35a93bc1b23d36acba7374f81e4f
-  data.tar.gz: 53143e1a773298c5d6b60156aefc01638f2e7c49
+  metadata.gz: 130b12c5b45db744a86537b671118ce01f0b1be9
+  data.tar.gz: 912a5a9530aa43e9cf1c0c96af814352f2acbf49
 SHA512:
-  metadata.gz: 914fa3e10e9d3ca35fea3cc79f963e8d5023daa714155cd8db34a642e223c8a9d47024e5da58a93f628a202f31d750d679d1c4c45e77be9b5d3e7c500c8cc619
-  data.tar.gz: 042ea0d80d56d10d7a47b4474423284159106db9e0abd2a238081f07b61b369cad6125fb33d4906bfc31ee5f0b3a88606c1e72f02c3d2a065f7c8553509fce88
+  metadata.gz: f943c7f5188f83493092bd7474878f8f4f47acdc262c1cd08d4fe581d4a1056bf38b4f537b5eab8713af0016e34c2602d1a389ad39c0ae95f3a6c7a99117edd2
+  data.tar.gz: 484a3306cb84e9f2bfe0f100c51dac8c9cbbccc798943bf5d6f36b07c0e1bf560c15ad0580b1ae19cbc9dd4fda2c6d97e22ceba6341b92a1b1c92ad0159409b1

data/CHANGELOG

@@ -1,3 +1,13 @@
+3.0.0 / 2018-10-24
+
+Breaking changes
+
+  * error -> status_error column name
+
+Enhancements
+
+  * status_workflow(alt: { a: [:b] }) if you want to use alt_status
+
 2.0.0 / 2018-09-30
 
 Breaking changes

data/README.md

@@ -4,11 +4,15 @@
 
 Basic state machine using Redis for locking.
 
+## Usage
+
 ```
 require 'redis'
 StatusWorkflow.redis = Redis.new
 ```
 
+You need an object that has `status`, `status_changed_at`, and `status_error`.
+
 Expects but does not require ActiveRecord (you just have to respond to `#reload`, `#id`, and `#update_columns`)
 
 ```
@@ -39,6 +43,28 @@ means:
 * from fed, i can go to sleep or run
 * from run, i can go to sleep
 
+If you want >1 status, you do
+
+```
+  include StatusWorkflow
+  status_workflow(
+    nil => {
+      sleep: [:feeding],
+      feeding: [:fed],
+      fed: [:sleep, :run],
+      run: [:sleep],
+    },
+    alt: {
+      sleep2: [:feeding2],
+      feeding2: [:fed2],
+      fed2: [:sleep2, :run2],
+      run2: [:sleep2],
+    }
+  )
+```
+
+You need an object that has `alt_status`, `alt_status_changed_at`, and `alt_status_error`.
+
 ## Sponsor
 
 <p><a href="https://www.faraday.io"><img src="https://s3.amazonaws.com/faraday-assets/files/img/logo.svg" alt="Faraday logo"/></a></p>

data/lib/status_workflow/version.rb

@@ -1,3 +1,3 @@
 module StatusWorkflow
-  VERSION = '2.0.0'
+  VERSION = '3.0.0'
 end

data/lib/status_workflow.rb

@@ -22,11 +22,15 @@ module StatusWorkflow
   LOCK_EXPIRY = 4
   LOCK_CHECK_RATE = 0.2
 
-  def status_transition!(intermediate_to_status, final_to_status)
+  def status_transition!(intermediate_to_status, final_to_status, prefix = nil)
     intermediate_to_status = intermediate_to_status&.to_s
     final_to_status = final_to_status&.to_s
+    prefix_ = prefix ? "#{prefix}_" : nil
+    status_column = "#{prefix_}status"
+    status_changed_at_column = "#{status_column}_changed_at"
+    error_column = "#{status_column}_error"
     lock_obtained_at = nil
-    lock_key = "status_workflow/#{self.class.name}/#{id}"
+    lock_key = "status_workflow/#{self.class.name}/#{id}/#{status_column}"
     # Give ourselves 8 seconds to get the lock, checking every 0.2 seconds
     Timeout.timeout(LOCK_ACQUISITION_TIMEOUT, nil, "#{lock_key} timeout waiting for lock") do
       until StatusWorkflow.redis.set(lock_key, true, nx: true, ex: LOCK_EXPIRY)
@@ -38,10 +42,10 @@ module StatusWorkflow
     initial_to_status = intermediate_to_status || final_to_status
     begin
       # depend on #can_enter_X to reload
-      send "can_enter_#{initial_to_status}?", true
+      send "#{prefix_}can_enter_#{initial_to_status}?", true
       raise TooSlow, "#{lock_key} lost lock after checking status" if Time.now - lock_obtained_at > LOCK_EXPIRY
       if intermediate_to_status
-        update_columns status: intermediate_to_status, status_changed_at: Time.now
+        update_columns status_column => intermediate_to_status, status_changed_at_column => Time.now
         raise TooSlow, "#{lock_key} lost lock after setting intermediate status #{intermediate_to_status}" if Time.now - lock_obtained_at > LOCK_EXPIRY
       end
       # If a block was given, start a heartbeat thread
@@ -51,23 +55,23 @@ module StatusWorkflow
             loop do
               StatusWorkflow.redis.expire lock_key, LOCK_EXPIRY
               lock_obtained_at = Time.now
-              sleep LOCK_EXPIRY/2
+              sleep LOCK_EXPIRY/2.0
             end
           end
           yield
         rescue
           # If the block errors, set status to error and record the backtrace
           error = (["#{$!.class} #{$!.message}"] + $!.backtrace).join("\n")
-          update_columns status: 'error', status_changed_at: Time.now, error: error
+          update_columns status_column => 'error', status_changed_at_column => Time.now, error_column => error
           raise
         end
       end
       # Success!
       if intermediate_to_status
-        send "can_enter_#{final_to_status}?", true
+        send "#{prefix_}can_enter_#{final_to_status}?", true
         raise TooSlow, "#{lock_key} lost lock after checking final status" if Time.now - lock_obtained_at > LOCK_EXPIRY
       end
-      update_columns status: final_to_status, status_changed_at: Time.now
+      update_columns status_column => final_to_status, status_changed_at_column => Time.now
     ensure
       raise TooSlow, "#{lock_key} lost lock" if Time.now - lock_obtained_at > LOCK_EXPIRY
       StatusWorkflow.redis.del lock_key
@@ -77,27 +81,41 @@ module StatusWorkflow
   end
 
   module ClassMethods
-    def status_workflow(transitions)
-      transitions.inject({}) do |memo, (from_status, to_statuses)|
-        to_statuses.each do |to_status|
-          memo[to_status] ||= Set.new
-          memo[to_status] << from_status
-        end
-        memo
-      end.each do |to_status, from_statuses|
-        define_method "enter_#{to_status}!" do
-          status_transition! nil, to_status
+    def status_workflow(workflows)
+      if workflows.first.last.is_a?(Array)
+        # default mode: use just status
+        workflows = { nil => workflows }
+      end
+      workflows.each do |prefix, transitions|
+        if prefix
+          # no this is not a mistake, the localvar is prefix_
+          prefix_ = "#{prefix}_"
+          define_method "#{prefix_}status_transition!" do |*args, &blk|
+            status_transition!(*(args+[prefix]), &blk)
+          end
         end
-        define_method "can_enter_#{to_status}?" do |raise_error = false|
-          reload
-          memo = from_statuses.include? status&.to_sym
-          if raise_error and not memo
-            raise InvalidTransition, "can't enter #{to_status} from #{status}, expected #{from_statuses.to_a.join('/')}"
+        transitions.inject({}) do |memo, (from_status, to_statuses)|
+          to_statuses.each do |to_status|
+            memo[to_status] ||= Set.new
+            memo[to_status] << from_status
           end
           memo
-        end
-        define_method "enter_#{to_status}_if_possible" do
-          begin; send("enter_#{to_status}!"); rescue InvalidTransition; false; end
+        end.each do |to_status, from_statuses|
+          define_method "#{prefix_}enter_#{to_status}!" do
+            send "#{prefix_}status_transition!", nil, to_status
+          end
+          define_method "#{prefix_}can_enter_#{to_status}?" do |raise_error = false|
+            reload
+            status = read_attribute "#{prefix_}status"
+            memo = from_statuses.include? status&.to_sym
+            if raise_error and not memo
+              raise InvalidTransition, "can't enter #{to_status} from #{status}, expected #{from_statuses.to_a.join('/')}"
+            end
+            memo
+          end
+          define_method "#{prefix_}enter_#{to_status}_if_possible" do
+            begin; send("#{prefix_}enter_#{to_status}!"); rescue InvalidTransition; false; end
+          end
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: status_workflow
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Seamus Abshere
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-30 00:00:00.000000000 Z
+date: 2018-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis