simplificator-fsm 0.3.0 → 0.3.2

data/README.markdown

@@ -1,6 +1,11 @@
 # fsm
 
-FSM is a simple finite state machine
+FSM is a simple finite state machine gem. You can define your State Machine with a "DSL".
+
+## Status
+FSM is still under development so the interface can/might/will change, features will be added (and perhaps removed again)
+But if you are interested in this project, then use it and tell us what you think/need/want/like/don't like. We are open
+for suggestions!
 
 ## Usage
     class Water
@@ -11,8 +16,7 @@ FSM is a simple finite state machine
         # you can add :enter / :exit callbacks (callback can be a String, Symbol or Proc)
         # these callbacks are triggered on any transition from/to this state.
         
-        state(:gas)
-        state(:liquid)
+        states(:gas, :liquid) # shortcut to define several states but you can not specify callbacks
         state(:solid, :enter => :on_enter_solid, :exit => :on_exit_solid)
         
         # define all valid transitions (arguments are name of transition, from state name, to state name)
@@ -20,8 +24,7 @@ FSM is a simple finite state machine
         # guards prevent transition when they return nil/false
         transition(:heat_up, :solid, :liquid, :event => :on_heat, :guard => :guard_something)
         transition(:heat_up, :liquid, :gas, :event => :on_heat)     # look mam.... two transitions with same name
-        transition(:cool_down, :gas, :liquid, :event => :on_cool)
-        transition(:cool_down, :liquid, :solid, :event => :on_cool)
+        transition(:cool_down, [:gas, :liquid], :liquid, :event => :on_cool)
         
         # define the attribute which is used to store the state (defaults to :state)
         state(:state_of_material)
@@ -79,7 +82,7 @@ FSM supports the dot format of graphviz (http://www.graphviz.org/).
 If you have the graphviz tools installed (the dot executable must be on the path) then
 you can export a graph to png like this
     # Export to water.png in the current dir
-    Water.graph    
+    Water.draw_graph    
     # Export in another format. (see graphviz documentation for supported file formats)
     Water.draw_graph(:format => :foo)
     # Change the extension (defaults to the format)

data/Rakefile

@@ -9,6 +9,7 @@ begin
     gem.email = "info@simplificator.com"
     gem.homepage = "http://github.com/simplificator/fsm"
     gem.authors = ["simplificator"]
+    gem.files.exclude '**/*.sqlite3', '*.sqlite3'
 
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
 :minor: 3
-:patch: 0
+:patch: 2

data/lib/fsm/builder.rb

@@ -27,8 +27,10 @@ module FSM
     #  * to_name: name of the target state (symbol)
     #  * options
     #  
-    def transition(name, from_name, to_name, options = {})
-      @machine.transition(name, from_name, to_name, options)
+    def transition(name, from_names, to_name, options = {})
+      Array(from_names).each do |from_name|
+        @machine.transition(name, from_name, to_name, options)
+      end
       nil # do not expose FSM details
     end
     
@@ -48,6 +50,10 @@ module FSM
       nil # do not expose FSM details
     end
     
-    
+    def states(*names)
+      names.each do |name|
+        state(name)
+      end
+    end
   end
 end

data/lib/fsm/machine.rb

@@ -39,8 +39,7 @@ module FSM
     end
     
     def self.get_current_state_name(target)
-      value = target.send(Machine[target.class].current_state_attribute_name)
-      (value && value.is_a?(String)) ? value.intern : value
+      target.send(Machine[target.class].current_state_attribute_name) || self.initial_state_name
     end
     
     def self.set_current_state_name(target, value)

data/lib/fsm/state.rb

@@ -54,11 +54,10 @@ module FSM
     end
     
     def to_dot(options = {})
-      
-      if final?
-        attrs = "style=bold"
-      elsif initial?
+      if initial?
         attrs = "style=bold, label=\"#{self.name}\\n(initial)\""
+      elsif final?  
+        attrs = "style=bold"
       else
         attrs = ""
       end

data/lib/fsm/state_attribute_interceptor.rb

@@ -0,0 +1,35 @@
+module FSM
+  class StateAttributeInterceptor
+    def self.add_interceptor(klass)
+      state_attribute_name = Machine[klass].current_state_attribute_name
+      hierarchy = klass.ancestors.map {|ancestor| ancestor.to_s}
+      
+      if hierarchy.include?("ActiveRecord::Base")
+        bar(klass)
+      else 
+        foo(klass)
+      end
+     
+    end
+    
+    private
+    def self.bar(klass)
+      klass.instance_eval() do
+        define_method(Machine[klass].current_state_attribute_name) do
+          value = read_attribute(Machine[self.class].current_state_attribute_name) || Machine[self.class].initial_state_name
+          value.is_a?(String) ? value.intern : value
+        end
+      end
+    end
+    
+    def self.foo(klass)
+      klass.instance_eval() do 
+        alias_method "fsm_state_attribute", Machine[klass].current_state_attribute_name
+        define_method(Machine[klass].current_state_attribute_name) do
+          value = fsm_state_attribute || Machine[self.class].initial_state_name
+          value.is_a?(String) ? value.intern : value
+        end
+      end
+    end
+  end
+end

data/lib/fsm.rb

@@ -1,4 +1,4 @@
-%w[options errors machine state transition executable builder].each do |item|
+%w[options errors machine state transition executable builder state_attribute_interceptor].each do |item|
   require File.join(File.dirname(__FILE__), 'fsm', item)
 end
 
@@ -8,13 +8,15 @@ module FSM
       raise 'FSM is already defined. Call define_fsm only once' if Machine[self]
       builder = Builder.new(self)
       Machine[self] = builder.process(&block)
-      self.instance_eval() do 
-        alias_method "fsm_state_attribute", Machine[self].current_state_attribute_name
-        define_method(Machine[self].current_state_attribute_name) do
-          value = fsm_state_attribute
-          value ? value : Machine[self.class].initial_state_name
-        end
-      end
+      
+      # TODO: check if all states are reachable
+      # TODO: other checks? islands?
+      
+      # create alias for state attribute method to intercept it 
+      # intercept
+      FSM::StateAttributeInterceptor.add_interceptor(self)
+      
+      
     end
     
     def draw_graph(options = {})

data/test/ar_test.rb

@@ -0,0 +1,10 @@
+require 'test_helper_ar'
+class ArTest < Test::Unit::TestCase
+  context 'AR' do
+    
+    should 'bla' do
+      o = Order.new
+      assert_equal  :open, o.state
+    end
+  end
+end

data/test/test_helper.rb

@@ -5,6 +5,3 @@ require 'shoulda'
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'fsm'
-
-class Test::Unit::TestCase
-end

data/test/test_helper_ar.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+require 'rubygems'
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(  
+  :adapter  => 'sqlite3',   
+  :database => 'test.sqlite3',   
+  :timeout => 5000
+)
+
+
+begin
+  ActiveRecord::Base.connection.drop_table(:orders)
+rescue
+  # no such table
+end
+
+ActiveRecord::Base.connection.create_table(:orders) do |table|
+  table.string(:state, :null => false, :limit => 10, :default => 'open')
+end
+class Order < ActiveRecord::Base
+  include FSM
+  define_fsm do 
+    states :open, :closed, :delivered
+  end
+end
+
+ActiveRecord::Base.logger = Logger.new(STDOUT)
+ActiveRecord::Base.logger.level = Logger::DEBUG # change to DEBUG if you want to see something :-)

data/test/water_sample_test.rb

@@ -8,8 +8,7 @@ class Water
     # now define all the states
     # you can add :enter / :exit callbacks (callback can be a String, Symbol or Proc)
     # these callbacks are triggered on any transition from/to this state and do not receive any arguments
-    state(:gas)
-    state(:liquid)
+    states(:gas, :liquid)
     state(:solid, :enter => :on_enter_solid, :exit => :on_exit_solid)
     
     # define all valid transitions (name, from, to). This will define a method with the given name.
@@ -60,8 +59,6 @@ class Water
     self.temperature -= delta
   end
 end
-# Draw the the state graph
-#Water.draw_graph(:format => :svg)
 
 class WaterSampleTest < Test::Unit::TestCase
   context 'Water' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: simplificator-fsm
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors: 
 - simplificator
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-25 00:00:00 -07:00
+date: 2009-05-28 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -34,12 +34,15 @@ files:
 - lib/fsm/machine.rb
 - lib/fsm/options.rb
 - lib/fsm/state.rb
+- lib/fsm/state_attribute_interceptor.rb
 - lib/fsm/transition.rb
+- test/ar_test.rb
 - test/executable_test.rb
 - test/invoice_sample_test.rb
 - test/options_test.rb
 - test/state_test.rb
 - test/test_helper.rb
+- test/test_helper_ar.rb
 - test/transition_test.rb
 - test/water_sample_test.rb
 has_rdoc: true
@@ -69,10 +72,12 @@ signing_key:
 specification_version: 3
 summary: A simple finite state machine (FSM) gem.
 test_files: 
+- test/ar_test.rb
 - test/executable_test.rb
 - test/invoice_sample_test.rb
 - test/options_test.rb
 - test/state_test.rb
 - test/test_helper.rb
+- test/test_helper_ar.rb
 - test/transition_test.rb
 - test/water_sample_test.rb