stateflow 0.2.3 → 0.3.0

data/CHANGELOG.rdoc

@@ -1,3 +1,9 @@
+= Version 0.3.0
+* Added a non bang method for events (Check README)
+* Added tests to persistence layers (About time!)
+* Changed the way the persistence layers save to model
+* Protected state column is now supported!
+
 = Version 0.2.3
 * Silence depreciation warnings (Fixing irritating issue)
 
@@ -12,4 +18,4 @@
 * Changed the persistence layers to use write_attribute, instead of update_attribute - Thanks to achirkunov
 
 = Version 0.1.2
-* Fixed Mongoid support - Thanks bmartin for pointing that out
+* Fixed Mongoid support - Thanks bmartin for pointing that out

data/README.rdoc

@@ -35,18 +35,18 @@ You can set the default column with the state_column function in the stateflow b
 
   require 'rubygems'
   require 'stateflow'
-  
+
   # No persistence
   Stateflow.persistence :none
 
   class Robot
     include Stateflow
-  
+
     stateflow do
       initial :green
-    
+
       state :green, :yellow, :red
-    
+
       event :change_color do
         transitions :from => :green, :to => :yellow
         transitions :from => :yellow, :to => :red
@@ -54,61 +54,65 @@ You can set the default column with the state_column function in the stateflow b
       end
     end
   end
-  
+
 == Advanced Example
 
   require 'rubygems'
   require 'stateflow'
-  
+
   # No persistence
   Stateflow.persistence :none
 
   class Test
     include Stateflow
-  
+
     stateflow do
-    
+
       initial :love
-    
+
       state :love do
         enter lambda { |t| p "Entering love" }
         exit :exit_love
       end
-    
+
       state :hate do
         enter lambda { |t| p "Entering hate" }
         exit lambda { |t| p "Exiting hate" }
       end
-    
+
       state :mixed do
         enter lambda { |t| p "Entering mixed" }
         exit lambda { |t| p "Exiting mixed" }
       end
-    
+
       event :b do
         transitions :from => :love, :to => :hate, :if => :no_ice_cream
         transitions :from => :hate, :to => :love
       end
-    
+
       event :a do
         transitions :from => :love, :to => [:hate, :mixed], :decide => :likes_ice_cream?
         transitions :from => [:hate, :mixed], :to => :love
       end
     end
-  
+
     def likes_ice_cream?
       rand(10) > 5 ? :mixed : :hate
     end
-  
+
     def exit_love
       p "Exiting love"
     end
-  
+
     def no_ice_cream
       rand(4) > 2 ? true : false
     end
   end
-  
+
+== Bang event vs non-bang event
+
+Bang events will save the model after call, where the non bang event will just update the state and call the transitions. (ie. model.change! vs model.change)
+
 == Extra's
 
 * When transitioning states, the previous state from which you have transitioned to can be accessed via `_previous_state`. See tests for more information.

data/Rakefile

@@ -2,11 +2,11 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('stateflow', '0.2.3') do |p|
+Echoe.new('stateflow', '0.3.0') do |p|
   p.description    = "State machine that allows dynamic transitions for business workflows"
   p.url            = "http://github.com/ryanza/stateflow"
   p.author         = "Ryan Oberholzer"
   p.email          = "ryan@platform45.com"
   p.ignore_pattern = ["tmp/*", "script/*"]
-  p.development_dependencies = ["rspec"]
-end
+  p.development_dependencies = ["rspec", "activerecord", "mongoid >=2.0.0.beta.20", "sqlite3-ruby"]
+end

data/lib/stateflow.rb

@@ -27,8 +27,12 @@ module Stateflow
       end
       
       @machine.events.keys.each do |key|
+        define_method "#{key}" do
+          fire_event(key, :save => false)
+        end
+        
         define_method "#{key}!" do
-          fire_event(key)
+          fire_event(key, :save => true)
         end
       end
     end
@@ -41,8 +45,8 @@ module Stateflow
       @current_state ||= load_from_persistence.nil? ? machine.initial_state : machine.states[load_from_persistence.to_sym]
     end
     
-    def current_state=(new_state)
-      save_to_persistence(new_state.name.to_s)
+    def set_current_state(new_state, options)
+      save_to_persistence(new_state.name.to_s, options)
       @current_state = new_state
     end
     
@@ -51,10 +55,10 @@ module Stateflow
     end
     
     private
-    def fire_event(event_name)
+    def fire_event(event_name, options = {})
       event = machine.events[event_name.to_sym]
       raise Stateflow::NoEventFound.new("No event matches #{event_name}") if event.nil?
-      event.fire(current_state, self)
+      event.fire(current_state, self, options)
     end
   end
   

data/lib/stateflow/event.rb

@@ -10,7 +10,7 @@ module Stateflow
       instance_eval(&transitions)
     end
     
-    def fire(current_state, klass)
+    def fire(current_state, klass, options)
       transition = @transitions.select{ |t| t.from.include? current_state.name }.first
       raise NoTransitionFound.new("No transition found for event #{@name}") if transition.nil?
       
@@ -20,7 +20,7 @@ module Stateflow
       raise NoStateFound.new("Invalid state #{transition.to.to_s} for transition.") if new_state.nil?
       
       current_state.execute_action(:exit, klass)
-      klass.current_state = new_state
+      klass.set_current_state(new_state, options)
       
       klass._previous_state = current_state.name.to_s
       new_state.execute_action(:enter, klass)

data/lib/stateflow/persistence/active_record.rb

@@ -13,8 +13,9 @@ module Stateflow
           self.send machine.state_column.to_sym
         end
 
-        def save_to_persistence(new_state)
-          self.update_attribute(machine.state_column.to_sym, new_state)
+        def save_to_persistence(new_state, options)
+          self.send("#{machine.state_column}=".to_sym, new_state)
+          self.save if options[:save]
         end
         
         def ensure_initial_state
@@ -23,4 +24,4 @@ module Stateflow
       end
     end
   end
-end
+end

data/lib/stateflow/persistence/mongo_mapper.rb

@@ -11,8 +11,9 @@ module Stateflow
           self.send machine.state_column.to_sym
         end
 
-        def save_to_persistence(new_state)
-          self.update_attributes(machine.state_column.to_sym => new_state)
+        def save_to_persistence(new_state, options)
+          self.send("#{machine.state_column}=".to_sym, new_state)
+          self.save if options[:save]
         end
         
         def ensure_initial_state
@@ -21,4 +22,4 @@ module Stateflow
       end
     end
   end
-end
+end

data/lib/stateflow/persistence/mongoid.rb

@@ -11,8 +11,9 @@ module Stateflow
           self.send machine.state_column.to_sym
         end
 
-        def save_to_persistence(new_state)
-          self.update_attributes(machine.state_column.to_sym => new_state)
+        def save_to_persistence(new_state, options = {})
+          self.send("#{machine.state_column}=".to_sym, new_state)
+          self.save if options[:save]
         end
 
         def ensure_initial_state

data/lib/stateflow/persistence/none.rb

@@ -12,10 +12,10 @@ module Stateflow
           @state
         end
 
-        def save_to_persistence(new_state)
+        def save_to_persistence(new_state, options)
           @state = new_state
         end
       end
     end
   end
-end
+end

data/spec/spec_helper.rb

@@ -2,11 +2,3 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'stateflow'
-
-require 'spec'
-require 'spec/autorun'
-
-Stateflow.persistence = :none
-
-Spec::Runner.configure do |config|
-end

data/spec/stateflow_spec.rb

@@ -1,13 +1,15 @@
 require 'spec_helper'
 
+Stateflow.persistence = :none
+
 class Robot
   include Stateflow
-  
+
   stateflow do
     initial :green
-    
+
     state :green, :yellow, :red
-    
+
     event :change_color do
       transitions :from => :green, :to => :yellow
       transitions :from => :yellow, :to => :red
@@ -16,32 +18,32 @@ class Robot
   end
 end
 
-class Car 
+class Car
   include Stateflow
-  
+
   stateflow do
     initial :parked
-    
+
     state :parked do
       enter do
         "Entering parked"
       end
-      
+
       exit do
         "Exiting parked"
       end
     end
-    
+
     state :driving do
       enter do
         "Entering parked"
       end
     end
-    
+
     event :drive do
       transitions :from => :parked, :to => :driving
     end
-    
+
     event :park do
       transitions :from => :driving, :to => :parked
     end
@@ -50,10 +52,10 @@ end
 
 class Bob
   include Stateflow
-  
+
   stateflow do
     state :yellow, :red, :purple
-    
+
     event :change_hair_color do
       transitions :from => :purple, :to => :yellow
       transitions :from => :yellow, :to => :red
@@ -64,47 +66,47 @@ end
 
 class Dater
   include Stateflow
-  
+
   stateflow do
     state :single, :dating, :married
-    
+
     event :take_out do
       transitions :from => :single, :to => :dating
     end
-    
+
     event :gift do
       transitions :from => :dating, :to => [:single, :married], :decide => :girls_mood?
     end
-    
+
     event :blank_decision do
       transitions :from => :single, :to => [:single, :married], :decide => :girls_mood?
     end
-    
+
     event :fail do
       transitions :from => :dating, :to => [:single, :married]
     end
   end
-  
+
   def girls_mood?
   end
 end
 
 class Priority
   include Stateflow
-  
+
   stateflow do
     initial :medium
     state :low, :medium, :high
-    
+
     event :low do
       transitions :from => any, :to => :low
     end
-    
-    event :medium do 
+
+    event :medium do
       transitions :from => any, :to => :medium
-    end    
-    
-    event :high do 
+    end
+
+    event :high do
       transitions :from => any, :to => :high
     end
   end
@@ -112,176 +114,185 @@ end
 
 class Stater
   include Stateflow
-    
+
   stateflow do
     initial :bill
-    
+
     state :bob, :bill
-    
+
     event :lolcats do
       transitions :from => :bill, :to => :bob
     end
   end
 end
-  
+
 
 describe Stateflow do
   describe "class methods" do
     it "should respond to stateflow block to setup the intial stateflow" do
       Robot.should respond_to(:stateflow)
     end
-    
+
     it "should respond to the machine attr accessor" do
       Robot.should respond_to(:machine)
     end
   end
-  
+
   describe "instance methods" do
     before(:each) do
       @r = Robot.new
     end
-    
+
     it "should respond to current state" do
       @r.should respond_to(:current_state)
     end
-    
+
     it "should respond to the current state setter" do
-      @r.should respond_to(:current_state=)
+      @r.should respond_to(:set_current_state)
     end
-    
+
     it "should respond to the current machine" do
       @r.should respond_to(:machine)
     end
-    
+
     it "should respond to load from persistence" do
       @r.should respond_to(:load_from_persistence)
     end
-    
+
     it "should respond to save to persistence" do
       @r.should respond_to(:save_to_persistence)
     end
   end
-  
+
   describe "initial state" do
     it "should set the initial state" do
       robot = Robot.new
       robot.current_state.name.should == :green
     end
-    
+
     it "should return true for green?" do
       robot = Robot.new
       robot.green?.should be_true
     end
-    
+
     it "should return false for yellow?" do
       robot = Robot.new
       robot.yellow?.should be_false
     end
-    
+
     it "should return false for red?" do
       robot = Robot.new
       robot.red?.should be_false
     end
-    
+
     it "should set the initial state to the first state set" do
       bob = Bob.new
       bob.current_state.name.should == :yellow
       bob.yellow?.should be_true
     end
   end
-  
+
   it "robot class should contain red, yellow and green states" do
     robot = Robot.new
     robot.machine.states.keys.should include(:red, :yellow, :green)
   end
-  
+
   describe "firing events" do
-    it "should call the fire method on event" do
-      robot = Robot.new
-      robot.machine.events[:change_color].should_receive(:fire)
-      robot.change_color!
-    end
-    
-    it "should call the fire_event method" do
-      robot = Robot.new
-      robot.should_receive(:fire_event).with(:change_color)
-      robot.change_color!
-    end
-    
+    let(:robot) { Robot.new }
+    let(:event) { :change_color }
+    subject { robot }
+
     it "should raise an exception if the event does not exist" do
-      robot = Robot.new
       lambda { robot.send(:fire_event, :fake) }.should raise_error(Stateflow::NoEventFound)
     end
-    
-    it "should fire the event" do
-      robot = Robot.new
-      robot.should_receive(:fire_event).with(:change_color)
-      robot.change_color!
+
+    shared_examples_for "an entity supporting state changes" do
+      context "when firing" do
+        after(:each) { subject.send(event_method) }
+        it "should call the fire method on event" do
+          subject.machine.events[event].should_receive(:fire)
+        end
+
+        it "should call the fire_event method" do
+          subject.should_receive(:fire_event).with(event, {:save=>persisted})
+        end
+      end
+
+      it "should update the current state" do
+        subject.current_state.name.should == :green
+        subject.send(event_method)
+        subject.current_state.name.should == :yellow
+      end
     end
-    
-    it "should update the event" do
-      robot = Robot.new
-      robot.current_state.name.should == :green
-      robot.change_color!
-      robot.current_state.name.should == :yellow
+
+    describe "bang event" do
+      let(:event_method) { :change_color! }
+      let(:persisted)    { true }
+      it_should_behave_like "an entity supporting state changes"
+    end
+
+    describe "non-bang event" do
+      let(:event_method) { :change_color }
+      let(:persisted)    { false }
+      it_should_behave_like "an entity supporting state changes"
     end
-    
+
     describe "before filters" do
       before(:each) do
         @car = Car.new
       end
-      
+
       it "should call the exit state before filter on the exiting old state" do
         @car.machine.states[:parked].should_receive(:execute_action).with(:exit, @car)
         @car.drive!
       end
-      
+
       it "should call the enter state before filter on the entering new state" do
         @car.machine.states[:driving].should_receive(:execute_action).with(:enter, @car)
         @car.drive!
       end
     end
   end
-  
-  describe "persistence" do 
+
+  describe "persistence" do
     it "should attempt to persist the new state and the name should be a string" do
       robot = Robot.new
-      robot.should_receive(:save_to_persistence).with("yellow")
+      robot.should_receive(:save_to_persistence).with("yellow", {:save=>true})
       robot.change_color!
     end
-    
+
     it "should attempt to read the initial state from the persistence" do
       robot = Robot.new
-      
+
       def robot.load_from_persistence
         :red
       end
-      
+
       robot.current_state.name.should == :red
     end
   end
-  
+
   describe "dynamic to transitions" do
     it "should raise an error without any decide argument" do
       date = Dater.new
-      
+
       def date.load_from_persistence
         :dating
       end
-      
+
       lambda { date.fail! }.should raise_error(Stateflow::IncorrectTransition)
     end
-    
+
     it "should raise an error if the decision method does not return a valid state" do
       date = Dater.new
-      
+
       def date.girls_mood?
         :lol
       end
-      
+
       lambda { date.blank_decision! }.should raise_error(Stateflow::NoStateFound, "Decision did not return a state that was set in the 'to' argument")
     end
-    
+
     it "should raise an error if the decision method returns blank/nil" do
       date = Dater.new
 
@@ -290,27 +301,27 @@ describe Stateflow do
 
       lambda { date.blank_decision! }.should raise_error(Stateflow::NoStateFound, "Decision did not return a state that was set in the 'to' argument")
     end
-    
+
     it "should calculate the decide block or method and transition to the correct state" do
       date = Dater.new
-      
+
       def date.load_from_persistence
         :dating
       end
-      
+
       date.current_state.name.should == :dating
-      
+
       def date.girls_mood?
         :single
       end
-      
+
       date.gift!
-      
+
       date.current_state.name.should == :single
     end
   end
-  
-  describe "transitions from any" do 
+
+  describe "transitions from any" do
     it "should properly change state" do
       priority = Priority.new
       priority.low!
@@ -321,12 +332,12 @@ describe Stateflow do
       priority.should be_high
     end
   end
-  
+
   describe "previous state" do
     it "should display the previous state" do
       stater = Stater.new
       stater.lolcats!
-      
+
       stater._previous_state.should == "bill"
       stater.current_state == "bob"
     end

data/stateflow.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{stateflow}
-  s.version = "0.2.3"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ryan Oberholzer"]
-  s.date = %q{2010-11-16}
+  s.date = %q{2010-12-08}
   s.description = %q{State machine that allows dynamic transitions for business workflows}
   s.email = %q{ryan@platform45.com}
   s.extra_rdoc_files = ["CHANGELOG.rdoc", "README.rdoc", "lib/stateflow.rb", "lib/stateflow/event.rb", "lib/stateflow/exception.rb", "lib/stateflow/machine.rb", "lib/stateflow/persistence.rb", "lib/stateflow/persistence/active_record.rb", "lib/stateflow/persistence/mongo_mapper.rb", "lib/stateflow/persistence/mongoid.rb", "lib/stateflow/persistence/none.rb", "lib/stateflow/state.rb", "lib/stateflow/transition.rb"]
@@ -24,10 +24,19 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<activerecord>, [">= 0"])
+      s.add_development_dependency(%q<mongoid>, [">= 2.0.0.beta.20"])
+      s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
     else
       s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<activerecord>, [">= 0"])
+      s.add_dependency(%q<mongoid>, [">= 2.0.0.beta.20"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
     end
   else
     s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<activerecord>, [">= 0"])
+    s.add_dependency(%q<mongoid>, [">= 2.0.0.beta.20"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: stateflow
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
   - 3
-  version: 0.2.3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Ryan Oberholzer
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-16 00:00:00 +02:00
+date: 2010-12-08 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,6 +32,52 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 62196427
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 20
+        version: 2.0.0.beta.20
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: State machine that allows dynamic transitions for business workflows
 email: ryan@platform45.com
 executables: []