stateflow 0.0.4 → 0.1.0

data/Manifest

@@ -7,9 +7,15 @@ examples/test.rb
 init.rb
 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
+spec/spec_helper.rb
+spec/stateflow_spec.rb
+stateflow.gemspec

data/README.rdoc

@@ -3,9 +3,9 @@
 == TODO
 
 * More Persistence layers
-* Tests
+* More Tests
 
-This is the basics of the gem. THIS IS NOT PRODUCTION READY UNTIL TESTS ARE DONE. Please check out the examples directory for usage until this README gets fleshed out. Feel free to fork and modify as you please.
+This is the basics of the gem. Please check out the examples directory or tests for usage until this README gets fleshed out. Feel free to fork and modify as you please.
 
 == INSTALL
 
@@ -13,14 +13,16 @@ This is the basics of the gem. THIS IS NOT PRODUCTION READY UNTIL TESTS ARE DONE
 
 == Usage
 
-As you can see below, Stateflow's API is very similar to AASM, but allows for a more dynamic state transition flow. Stateflow supports persistence/storage with MongoMapper, and ActiveRecord. Request any others or push them to me.
+As you can see below, Stateflow's API is very similar to AASM, but allows for a more dynamic state transition flow. Stateflow supports persistence/storage with Mongoid, MongoMapper, and ActiveRecord. Request any others or push them to me.
 
 Stateflow defaults to ActiveRecord but you can set the persistence layer with:
 
   Stateflow.persistence = :mongo_mapper
 OR
   Stateflow.persistence = :active_record
-  
+OR
+  Stateflow.persistence = :mongoid
+
 Stateflow allows dynamic :to transitions with :decide. The result :decide returns needs to be one of the states listed in the :to array, otherwise it wont allow the transition. Please view the advanced example below for usage.
 
 You can set the default column with the state_column function in the stateflow block. The default state column is "state".
@@ -29,10 +31,11 @@ You can set the default column with the state_column function in the stateflow b
 
 == Basic Example
 
-Please note these examples need a persistence layer to operate. I might allow non persistent stateflows in the future.
-
   require 'rubygems'
   require 'stateflow'
+  
+  # No persistence
+  Stateflow.persistence :none
 
   class Robot
     include Stateflow
@@ -54,6 +57,9 @@ Please note these examples need a persistence layer to operate. I might allow no
 
   require 'rubygems'
   require 'stateflow'
+  
+  # No persistence
+  Stateflow.persistence :none
 
   class Test
     include Stateflow
@@ -89,7 +95,7 @@ Please note these examples need a persistence layer to operate. I might allow no
     end
   
     def likes_ice_cream?
-      rand(10) > 5 ? :mixeds : :hate
+      rand(10) > 5 ? :mixed : :hate
     end
   
     def exit_love

data/Rakefile

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

data/lib/stateflow.rb

@@ -49,9 +49,9 @@ module Stateflow
     end
     
     private
-    def fire_event(event)
-      event = machine.events[event.to_sym]
-      raise Exception.new("No event matches #{event}") if event.nil?
+    def fire_event(event_name)
+      event = machine.events[event_name.to_sym]
+      raise Stateflow::NoEventFound.new("No event matches #{event_name}") if event.nil?
       event.fire(current_state, self)
     end
   end
@@ -61,4 +61,5 @@ module Stateflow
   autoload :Event, 'stateflow/event'
   autoload :Transition, 'stateflow/transition'
   autoload :Persistence, 'stateflow/persistence'
+  autoload :Exception, 'stateflow/exception'
 end

data/lib/stateflow/event.rb

@@ -1,7 +1,4 @@
 module Stateflow
-  class NoTransitionFound < Exception; end
-  class NoStateFound < Exception; end
-  
   class Event
     attr_accessor :name, :transitions
     

data/lib/stateflow/exception.rb

@@ -0,0 +1,5 @@
+module Stateflow
+  class NoTransitionFound < Exception; end
+  class NoStateFound < Exception; end
+  class NoEventFound < Exception; end
+end

data/lib/stateflow/persistence.rb

@@ -6,10 +6,16 @@ module Stateflow
           Stateflow::Persistence::MongoMapper.install(base)
         when :active_record
           Stateflow::Persistence::ActiveRecord.install(base)
+        when :mongoid
+          Stateflow::Persistence::Mongoid.install(base)
+        when :none
+          Stateflow::Persistence::None.install(base)
       end
     end
     
     autoload :MongoMapper, 'stateflow/persistence/mongo_mapper'
     autoload :ActiveRecord, 'stateflow/persistence/active_record'
+    autoload :Mongoid, 'stateflow/persistence/mongoid'
+    autoload :None, 'stateflow/persistence/none'
   end
 end

data/lib/stateflow/persistence/mongoid.rb

@@ -0,0 +1,24 @@
+module Stateflow
+  module Persistence
+    module Mongoid
+      def self.install(base)
+        base.respond_to?(:before_validation_on_create) ? base.before_validation_on_create(:ensure_initial_state) : base.before_validation(:ensure_initial_state, :on => :create)
+        base.send :include, InstanceMethods
+      end
+      
+      module InstanceMethods
+        def load_from_persistence
+          self.send machine.state_column.to_sym
+        end
+
+        def save_to_persistence(new_state)
+          self.update_attributes(machine.state_column.to_sym => new_state)
+        end
+        
+        def ensure_initial_state
+          send("#{self.machine.state_column.to_s}=", self.current_state.name.to_s) if send(self.machine.state_column.to_s).blank?
+        end
+      end
+    end
+  end
+end

data/lib/stateflow/persistence/none.rb

@@ -0,0 +1,21 @@
+module Stateflow
+  module Persistence
+    module None
+      def self.install(base)
+        base.send :include, InstanceMethods
+      end
+      
+      module InstanceMethods
+        attr_accessor :state
+        
+        def load_from_persistence
+          @state
+        end
+
+        def save_to_persistence(new_state)
+          @state = new_state
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$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

@@ -0,0 +1,277 @@
+require 'spec_helper'
+
+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
+      transitions :from => :red, :to => :green
+    end
+  end
+end
+
+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
+  end
+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
+      transitions :from => :red, :to => :purple
+    end
+  end
+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
+
+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=)
+    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
+    
+    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!
+    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
+    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 
+    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.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
+
+      def date.girls_mood?
+      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 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
+end
+

data/stateflow.gemspec

@@ -2,20 +2,20 @@
 
 Gem::Specification.new do |s|
   s.name = %q{stateflow}
-  s.version = "0.0.4"
+  s.version = "0.1.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-04-15}
+  s.date = %q{2010-05-04}
   s.description = %q{State machine that allows dynamic transitions for business workflows}
   s.email = %q{ryan@platform45.com}
-  s.extra_rdoc_files = ["README.rdoc", "lib/stateflow.rb", "lib/stateflow/event.rb", "lib/stateflow/machine.rb", "lib/stateflow/persistence.rb", "lib/stateflow/persistence/active_record.rb", "lib/stateflow/persistence/mongo_mapper.rb", "lib/stateflow/state.rb", "lib/stateflow/transition.rb"]
-  s.files = ["LICENCE", "Manifest", "README.rdoc", "Rakefile", "examples/robot.rb", "examples/test.rb", "init.rb", "lib/stateflow.rb", "lib/stateflow/event.rb", "lib/stateflow/machine.rb", "lib/stateflow/persistence.rb", "lib/stateflow/persistence/active_record.rb", "lib/stateflow/persistence/mongo_mapper.rb", "lib/stateflow/state.rb", "lib/stateflow/transition.rb", "stateflow.gemspec"]
-  s.homepage = %q{http://github.com/ryanza/stateflow}
+  s.extra_rdoc_files = ["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"]
+  s.files = ["LICENCE", "Manifest", "README.rdoc", "Rakefile", "examples/robot.rb", "examples/test.rb", "init.rb", "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", "spec/spec_helper.rb", "spec/stateflow_spec.rb", "stateflow.gemspec"]
+  s.homepage = %q{http://github.com/platform45/stateflow}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Stateflow", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{stateflow}
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{State machine that allows dynamic transitions for business workflows}
 
   if s.respond_to? :specification_version then
@@ -23,8 +23,11 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
     else
+      s.add_dependency(%q<rspec>, [">= 0"])
     end
   else
+    s.add_dependency(%q<rspec>, [">= 0"])
   end
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: stateflow
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Ryan Oberholzer
@@ -9,10 +14,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-15 00:00:00 +02:00
+date: 2010-05-04 00:00:00 +02:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
 description: State machine that allows dynamic transitions for business workflows
 email: ryan@platform45.com
 executables: []
@@ -23,10 +39,13 @@ extra_rdoc_files:
 - 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
 files: 
@@ -39,15 +58,20 @@ files:
 - init.rb
 - 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
+- spec/spec_helper.rb
+- spec/stateflow_spec.rb
 - stateflow.gemspec
 has_rdoc: true
-homepage: http://github.com/ryanza/stateflow
+homepage: http://github.com/platform45/stateflow
 licenses: []
 
 post_install_message: 
@@ -64,18 +88,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 2
       version: "1.2"
-  version: 
 requirements: []
 
 rubyforge_project: stateflow
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: State machine that allows dynamic transitions for business workflows