simple_state_machine 0.3.4 → 0.4.0

data/README.rdoc

@@ -36,6 +36,14 @@ This will prevent the state from being changed.
     end
   end
 
+=== Example usage with exceptions
+You can rescue exceptions and specify the failure state
+
+  def download_data
+    Service.download_data
+  end
+  event :download_data, :pending => :downloaded,
+        Service::ConnectionError => :download_failed
 
 == More complete implementation
 

data/VERSION

@@ -1 +1 @@
-0.3.4
+0.4.0

data/lib/simple_state_machine/simple_state_machine.rb

@@ -49,7 +49,7 @@ module SimpleStateMachine
     end
     
     def add_transition event_name, from, to
-      transition = Transition.new(event_name.to_s, from.to_s, to.to_s)
+      transition = Transition.new(event_name, from, to)
       transitions << transition
       transition
     end
@@ -67,17 +67,32 @@ module SimpleStateMachine
       @subject = subject
     end
 
-    # returns the next state for the subject for event_name
+    # Returns the next state for the subject for event_name
     def next_state(event_name)
-      transition = transitions.select{|t| t.event_name.to_s == event_name.to_s && @subject.send(state_method).to_s == t.from.to_s}.first
+      transition = transitions.select{|t| t.is_transition_for?(event_name) && @subject.send(state_method).to_s == t.from.to_s}.first
       transition ? transition.to : nil
     end
 
-    # transitions to the next state if next_state exists
-    # calls illegal_event_callback event_name if no next_state is found
+    # Returns the error state for the subject for event_name and error
+    def error_state(event_name, error)
+      transition = transitions.select{|t| t.is_error_transition_for?(event_name, error) }.first
+      transition ? transition.to : nil
+    end
+
+    # Transitions to the next state if next_state exists.
+    # Calls illegal_event_callback event_name if no next_state is found
     def transition(event_name)
       if to = next_state(event_name)
-        result = yield
+        begin
+          result = yield
+        rescue => e
+          if error_state = error_state(event_name, e)
+            @subject.send("#{state_method}=", error_state)
+            return result
+          else
+            raise
+          end
+        end
         # TODO refactor out to AR module
         if defined?(::ActiveRecord) && @subject.is_a?(::ActiveRecord::Base)
           if @subject.errors.entries.empty?
@@ -116,7 +131,21 @@ module SimpleStateMachine
   
   end
 
-  class Transition < Struct.new(:event_name, :from, :to)
+  class Transition 
+    attr_reader :event_name, :from, :to
+    def initialize(event_name, from, to)
+      @event_name = event_name.to_s
+      @from       = from.is_a?(Class) ? from : from.to_s
+      @to         = to.to_s
+    end
+
+    def is_transition_for?(event_name)
+      self.event_name == event_name.to_s
+    end
+
+    def is_error_transition_for?(event_name, error)
+      is_transition_for?(event_name) && error.class == from
+    end
   end
 
   ##

data/simple_state_machine.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{simple_state_machine}
-  s.version = "0.3.4"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marek de Heus", "Petrik de Heus"]
-  s.date = %q{2010-09-04}
+  s.date = %q{2010-09-06}
   s.description = %q{A simple DSL to decorate existing methods with logic that guards state transitions.}
   s.email = ["FIX@example.com"]
   s.extra_rdoc_files = [

data/spec/simple_state_machine_spec.rb

@@ -42,6 +42,20 @@ describe SimpleStateMachine do
       example.should be_state2
     end
 
+    it "changes state to error_state when error should be caught" do
+      class_with_error = Class.new(SimpleExample)
+      class_with_error.instance_eval do
+        define_method :raise_error do
+          raise
+        end
+        event :raise_error, :state1 => :state2, RuntimeError => :failed
+      end
+      example = class_with_error.new
+      example.should be_state1
+      example.raise_error
+      example.should be_failed
+    end
+    
     it "raise an error if an invalid state_transition is called" do
       example = SimpleExample.new
       lambda { example.event2 }.should raise_error(SimpleStateMachine::Error, "You cannot 'event2' when state is 'state1'")

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: simple_state_machine
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
   - 4
-  version: 0.3.4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Marek de Heus
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-04 00:00:00 +02:00
+date: 2010-09-06 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency