status_workflow 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31fac79b181eaf226d6f199406c58b23f2860674
-  data.tar.gz: abb35fc730390397b21692c0a0f398a9628253e1
+  metadata.gz: 1a93bf66014b35a93bc1b23d36acba7374f81e4f
+  data.tar.gz: 53143e1a773298c5d6b60156aefc01638f2e7c49
 SHA512:
-  metadata.gz: e7f31170e7845fcd47a2f0f9ab5e68c08b6a7eae0226f784b8060d563a4ffa812ca21d7ff79230e248fb899d2a325d57299ce830ade5ffb4776d412247889a85
-  data.tar.gz: 271e5943314d59d02ca2a8e48e2cd5750077fbea2986605c2ca3d0074de16efca5bbb407cbd5fc76b6d1316bb4a80629c8ddff2d877b574a9d9e7da5c1b9f50c
+  metadata.gz: 914fa3e10e9d3ca35fea3cc79f963e8d5023daa714155cd8db34a642e223c8a9d47024e5da58a93f628a202f31d750d679d1c4c45e77be9b5d3e7c500c8cc619
+  data.tar.gz: 042ea0d80d56d10d7a47b4474423284159106db9e0abd2a238081f07b61b369cad6125fb33d4906bfc31ee5f0b3a88606c1e72f02c3d2a065f7c8553509fce88

data/.gitignore

@@ -11,3 +11,4 @@
 # rspec failure tracking
 .rspec_status
 *.gem
+Gemfile.lock

data/CHANGELOG

@@ -1,3 +1,13 @@
+2.0.0 / 2018-09-30
+
+Breaking changes
+
+  * Get rid of block form on enter_X!
+
+Enhancements
+
+  * Add `status_transition!(intermediate_status, final_status)`
+
 1.0.1 / 2018-09-28
 
 Enhancements

data/lib/status_workflow.rb

@@ -4,6 +4,7 @@ require 'set'
 
 module StatusWorkflow
   class InvalidTransition < StandardError; end
+  class TooSlow < StandardError; end
 
   def self.included(klass)
     klass.extend ClassMethods
@@ -21,6 +22,60 @@ module StatusWorkflow
   LOCK_EXPIRY = 4
   LOCK_CHECK_RATE = 0.2
 
+  def status_transition!(intermediate_to_status, final_to_status)
+    intermediate_to_status = intermediate_to_status&.to_s
+    final_to_status = final_to_status&.to_s
+    lock_obtained_at = nil
+    lock_key = "status_workflow/#{self.class.name}/#{id}"
+    # 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)
+        sleep LOCK_CHECK_RATE
+      end
+      lock_obtained_at = Time.now
+    end
+    heartbeat = nil
+    initial_to_status = intermediate_to_status || final_to_status
+    begin
+      # depend on #can_enter_X to reload
+      send "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
+        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
+      if block_given?
+        begin
+          heartbeat = Thread.new do
+            loop do
+              StatusWorkflow.redis.expire lock_key, LOCK_EXPIRY
+              lock_obtained_at = Time.now
+              sleep LOCK_EXPIRY/2
+            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
+          raise
+        end
+      end
+      # Success!
+      if intermediate_to_status
+        send "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
+    ensure
+      raise TooSlow, "#{lock_key} lost lock" if Time.now - lock_obtained_at > LOCK_EXPIRY
+      StatusWorkflow.redis.del lock_key
+      heartbeat.kill if heartbeat
+    end
+    true
+  end
+
   module ClassMethods
     def status_workflow(transitions)
       transitions.inject({}) do |memo, (from_status, to_statuses)|
@@ -30,49 +85,16 @@ module StatusWorkflow
         end
         memo
       end.each do |to_status, from_statuses|
-        define_method "enter_#{to_status}!" do |&blk|
-          lock_key = "status_workflow/#{self.class.name}/#{id}"
-          # Give ourselves 8 seconds to get the lock, checking every 0.2 seconds
-          Timeout.timeout(LOCK_ACQUISITION_TIMEOUT, nil, "timeout waiting for #{self.class.name}/#{id} lock") do
-            until StatusWorkflow.redis.set(lock_key, true, nx: true, ex: LOCK_EXPIRY)
-              sleep LOCK_CHECK_RATE
-            end
-          end
-          heartbeat = nil
-          begin
-            # Give ourselves 2 seconds to check the status of the lock
-            Timeout.timeout(2, nil, "timeout waiting for #{self.class.name}/#{id} status check") do
-              # depend on #can_enter_X to reload
-              raise InvalidTransition, "can't enter #{to_status} from #{status}, expected #{from_statuses.to_a.join('/')}" unless send("can_enter_#{to_status}?")
-            end
-            # If a block was given, start a heartbeat thread
-            if blk
-              begin
-                heartbeat = Thread.new do
-                  loop do
-                    StatusWorkflow.redis.expire lock_key, LOCK_EXPIRY
-                    sleep LOCK_EXPIRY/2
-                  end
-                end
-                blk.call
-              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
-                raise
-              end
-            end
-            # Success!
-            update_columns status: to_status, status_changed_at: Time.now
-          ensure
-            StatusWorkflow.redis.del lock_key
-            heartbeat.kill if heartbeat
-          end
-          true
+        define_method "enter_#{to_status}!" do
+          status_transition! nil, to_status
         end
-        define_method "can_enter_#{to_status}?" do
+        define_method "can_enter_#{to_status}?" do |raise_error = false|
           reload
-          from_statuses.include? status&.to_sym
+          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 "enter_#{to_status}_if_possible" do
           begin; send("enter_#{to_status}!"); rescue InvalidTransition; false; end

data/lib/status_workflow/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: status_workflow
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Seamus Abshere
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-28 00:00:00.000000000 Z
+date: 2018-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -135,7 +135,6 @@ files:
 - CHANGELOG
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,67 +0,0 @@
-PATH
-  remote: .
-  specs:
-    status_workflow (1.0.0)
-      redis
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (5.2.1)
-      activesupport (= 5.2.1)
-    activerecord (5.2.1)
-      activemodel (= 5.2.1)
-      activesupport (= 5.2.1)
-      arel (>= 9.0)
-    activesupport (5.2.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    arel (9.0.0)
-    coderay (1.1.2)
-    concurrent-ruby (1.0.5)
-    database_cleaner (1.7.0)
-    diff-lcs (1.3)
-    i18n (1.1.0)
-      concurrent-ruby (~> 1.0)
-    method_source (0.9.0)
-    minitest (5.11.3)
-    pg (1.1.3)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rake (10.5.0)
-    redis (4.0.2)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord
-  bundler (~> 1.16)
-  database_cleaner
-  pg
-  pry
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  status_workflow!
-
-BUNDLED WITH
-   1.16.5