simple_machine 1.0.0 → 1.0.1

data/README.rdoc

@@ -15,16 +15,24 @@ After requiring 'simple_machine' inject state machine in your class like this:
 
   class Phone
     include SimpleMachine  
-	  implement_state_machine_for :my_state do
-		initial_state :off
-		other_states :ready, :dialing, :busy
-		allow_transition :turn_on,  :from => :off,     :to => :ready
-		allow_transition :dial,     :from => :ready,   :to => :dialing
-		allow_transition :hangup,   :from => :dialing, :to => :ready 
-		allow_transition :hangup,   :from => :busy,    :to => :ready
-		allow_transition :turn_off, :from => :ready,   :to => :off
-	  end	
-	end
+    implement_state_machine_for :my_state do
+      initial_state :off
+      other_states :ready, :dialing, :busy
+      allow_transition :turn_on,  :from => :off,     :to => :ready
+      allow_transition :dial,     :from => :ready,   :to => :dialing
+      allow_transition :hangup,   :from => :dialing, :to => :ready 
+      allow_transition :hangup,   :from => :busy,    :to => :ready
+      allow_transition :turn_off, :from => :ready,   :to => :off do
+        # self is set to phone instance
+        puts my_state #=> :ready  
+        # do something before transition ...
+        true # state will be changed to :off if block returns true  
+      end
+      after_transition do
+        # self is set to phone instance
+        puts "New state is '#{my_state}'"
+      end
+    end	
   end
 
 This chunk of code produces following effects:
@@ -56,11 +64,16 @@ In this case even if +dial+ is allowed transition from +ready+ state this is wha
 
 === Callback
 
-After each transition callback is invoked in parent class if it is defined:
+After each transition callback is invoked if it is defined:
 
   class Phone
-    def after_my_state_changed
-      puts "New my state is '#{self.my_state}'"
+    include SimpleMachine  
+    implement_state_machine_for :my_state do
+      # ...
+      after_transition do
+        # self is set to phone instance
+        puts "New state is '#{my_state}'"
+      end
     end
   end
 

data/lib/simple_machine.rb

@@ -38,7 +38,10 @@ module SimpleMachine
         result = @defined_transitions[from_state].inject(false) { |sum, hash| sum || hash[:transition] == transition }
         return result
       end
-      def allow_transition(transition, options)
+      def after_transition(&block)
+        @after_transition = block
+      end
+      def allow_transition(transition, options, &block)
         @defined_transitions ||= {}
         raise "Unknown source state #{options[:from]}. Please define it first as initial_state or in other_states." unless all_states.include?(options[:from])
         raise "Unknown target state #{options[:to]}. Please define it first as initial_state or in other_states." unless all_states.include?(options[:to])
@@ -47,6 +50,8 @@ module SimpleMachine
         @defined_transitions[options[:from]] = [] unless @defined_transitions.has_key?(options[:from])
         @defined_transitions[options[:from]] << { :transition => transition, :target_state => options[:to] }     
         
+        transition_block = block_given? ? block : false
+        
         class_eval do
           define_method "can_#{transition}?" do
             allowed_transitions.include? transition
@@ -58,11 +63,17 @@ module SimpleMachine
             else
               raise "Invalid transition ##{transition.to_s.gsub '_', ' '} from '#{current_state}' state"
             end unless allowed_transitions.include? transition
-            variable = "@#{self.class.parents_state_field_name}"
-            result = @owner.instance_eval { instance_variable_set variable, options[:to] }
-            callback_method = "after_#{self.class.parents_state_field_name}_changed".to_sym
-            @owner.send callback_method if @owner.respond_to? callback_method
-            result
+            
+            if !transition_block or @owner.instance_eval( &transition_block )
+              variable = "@#{self.class.parents_state_field_name}"
+              result = @owner.instance_eval { instance_variable_set variable, options[:to] }
+              # after_transition callback
+              after_transition_block = self.class.instance_eval { @after_transition }
+              @owner.instance_eval &after_transition_block if after_transition_block
+              result
+            else
+              false
+            end
           end
         end   
       end
@@ -70,7 +81,7 @@ module SimpleMachine
   end
 
   module ClassMethods
-      
+
     def implement_state_machine_for(state_field_name, &block)
       machine_property_name = "#{state_field_name}_machine".to_sym
       default_state_field_name = "#{state_field_name}_default_state".to_sym

data/spec/spec_simple_machine.rb

@@ -108,9 +108,50 @@ describe SimpleMachine, "for :dispatch_state field on Job, when state machine is
           
             job.dispatch_state.should be(:assigned)
           end
-          it "calls job#after_dispatch_state_changed callback if defined" do
-            Job.any_instance.expects(:after_dispatch_state_changed)
-            Job.new.dispatch_state_machine.assign
+          it "calls after_transition callback if defined" do
+            rspec = self
+            job = Job.new
+            @inner_state_machine_class.after_transition do
+              puts "After transition"
+              dispatch_state.should rspec.be(:assigned)
+              self.should rspec.be(job)
+            end
+            job.dispatch_state_machine.assign.should be(:assigned)
+            
+            @inner_state_machine_class.instance_eval { instance_variable_set :@after_transition, nil }
+          end
+          context "when block is given" do
+            before :each do
+              @inner_state_machine_class.expects(:defined_transition?).with(:assign, :waiting).returns(false)
+            end
+            it "executes block" do
+              rspec = self
+              job = Job.new
+              @inner_state_machine_class.allow_transition :assign, :from => :waiting, :to => :assigned do
+                dispatch_state.should rspec.be(:waiting)
+                self.should rspec.be(job)
+                true
+              end
+              
+              job.dispatch_state_machine.assign.should be(:assigned)
+            end
+            it "changes state if block returned true" do
+              @inner_state_machine_class.allow_transition :assign, :from => :waiting, :to => :assigned do              
+                true
+              end
+            
+              job = Job.new
+              job.dispatch_state_machine.assign.should be(:assigned)
+            end
+            it "doesn't change state if block returned false" do
+              @inner_state_machine_class.allow_transition :assign, :from => :waiting, :to => :assigned do              
+                false
+              end
+            
+              job = Job.new
+              job.dispatch_state_machine.assign.should be(false)
+              job.dispatch_state.should be(:waiting)
+            end
           end
         end
         context "when it is not valid transition from current state" do
@@ -159,7 +200,10 @@ describe SimpleMachine, "for :dispatch_state field on Job, when state machine is
   end
   context "when there are more job instances" do
     before :all do
+      Job.new.dispatch_state_machine.class.expects(:defined_transition?).with(:assign, :waiting).returns false
+      Job.new.dispatch_state_machine.class.expects(:defined_transition?).with(:accept, :assigned)
       Job.implement_state_machine_for :dispatch_state do
+        allow_transition :assign, :from => :waiting, :to => :assigned
         allow_transition :accept, :from => :assigned, :to => :accepted
       end
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: simple_machine
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Milan Burmaja
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-13 00:00:00 +01:00
+date: 2010-12-16 00:00:00 +01:00
 default_executable: 
 dependencies: []