super_state 0.3.0 → 0.4.0

data/Rakefile

@@ -45,7 +45,7 @@ spec = Gem::Specification.new do |s|
 
   # Change these as appropriate
   s.name              = "super_state"
-  s.version           = "0.3.0"
+  s.version           = "0.4.0"
   s.summary           = "Super Simple State Machine"
   s.author            = "Matthew Rudy Jacobs"
   s.email             = "MatthewRudyJacobs@gmail.com"

data/lib/super_state.rb

@@ -17,7 +17,7 @@ module SuperState
       # the initial_state only takes effect when we say record.valid?
       before_validation :set_initial_super_state, :on => :create
       
-      validate :ensure_super_state
+      validate :validate_super_state
     end
   end
   
@@ -105,12 +105,23 @@ module SuperState
       self.current_super_state.humanize
     end
     
-    def ensure_super_state
+    def validate_super_state
       unless self.class.__super_states.include?(self.current_super_state)
         errors[self.class.super_state_column] << "is not a valid super state"
       end
     end
     
+    def ensure_super_state!(state_name)
+      self.transaction do
+        self.lock!
+
+        unless self.current_super_state == SuperState.canonicalise(state_name)
+          raise BadState, "the super state is not what we expected"
+        end
+          
+        yield
+      end
+    end
   end
   
   class BadState < ArgumentError ; end

data/test/super_state_test.rb

@@ -17,6 +17,37 @@ class SuperStateTest < Test::Unit::TestCase
     assert record.valid?
   end
   
+  test "ensure_super_state! - when the state has changed" do
+    record = Something.create!
+    assert record.start?
+    
+    # lets suppose a 2nd process has already kicked this off
+    
+    other = Something.find(record.id)
+    other.kick_off!
+    
+    # but the original is still in the start state
+    
+    assert record.start?
+    
+    assert_raise SuperState::BadState do
+      record.ensure_super_state!(:start) do
+        record.kick_off!
+      end
+    end
+  end
+  
+  test "ensure_super_state! - when the state is what we expect" do
+    record = Something.create!
+    assert record.start?
+    
+    record.ensure_super_state!(:start) do
+      record.kick_off!
+    end
+    assert record.middle?
+    assert record.reload.middle?
+  end
+  
   test "abstract the tests" do
     puts "this has been abstracted from a live project"
     puts "as such the tests have not yet been abstracted"

data/test/test_helper.rb

@@ -27,6 +27,8 @@ class Something < ActiveRecord::Base
   super_state :middle
   super_state :end
   
+  state_transition :kick_off, :start  => :middle
+  state_transition :finish,   :middle => :end
 end
 
 ActiveRecord::Schema.define(:version => 0) do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: super_state
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 15
   prerelease: 
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Matthew Rudy Jacobs
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-15 00:00:00 +08:00
+date: 2011-04-26 00:00:00 +08:00
 default_executable: 
 dependencies: []