soveran-micromachine 0.0.5 → 0.0.6

data/README.markdown

@@ -19,16 +19,22 @@ Usage
 
     require 'micromachine'
 
-    fsm = MicroMachine.new(:new) # Initial state.
+    machine = MicroMachine.new(:new) # Initial state.
 
-    fsm.transitions_for[:confirm] = { :new => :confirmed }
-    fsm.transitions_for[:ignore]  = { :new => :ignored }
-    fsm.transitions_for[:reset]   = { :confirmed => :new, :ignored => :new }
+    machine.transitions_for[:confirm] = { :new => :confirmed }
+    machine.transitions_for[:ignore]  = { :new => :ignored }
+    machine.transitions_for[:reset]   = { :confirmed => :new, :ignored => :new }
 
-    fsm.fire(:confirm)  #=> true
-    fsm.fire(:ignore)   #=> false
-    fsm.fire(:reset)    #=> true
-    fsm.fire(:ignore)   #=> true
+    machine.trigger(:confirm)  #=> true
+    machine.trigger(:ignore)   #=> false
+    machine.trigger(:reset)    #=> true
+    machine.trigger(:ignore)   #=> true
+
+It can also have callbacks when entering some state:
+
+    machine.on(:confirmed) do
+      puts "Confirmed"
+    end
 
 Installation
 ------------

data/Rakefile

@@ -7,14 +7,19 @@ gem_spec_file = 'micromachine.gemspec'
 
 gem_spec = eval(File.read(gem_spec_file)) rescue nil
 
+task :default => :test
+
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
 Rake::GemPackageTask.new(gem_spec) do |pkg|
   pkg.need_zip = false
   pkg.need_tar = false
   rm_f FileList['pkg/**/*.*']
 end if gem_spec
 
-task :default => :gem
-
 desc "Generate the gemspec file."
 task :gemspec do
   require 'erb'

data/lib/micromachine.rb

@@ -2,17 +2,22 @@
 #
 # Usage:
 #
-#   fsm = MicroMachine.new(:new) # Initial state.
+#   machine = MicroMachine.new(:new) # Initial state.
 #
-#   fsm.transitions_for[:confirm] = { :new => :confirmed }
-#   fsm.transitions_for[:ignore] = { :new => :ignored }
-#   fsm.transitions_for[:reset] = { :confirmed => :new, :ignored => :new }
+#   machine.transitions_for[:confirm] = { :new => :confirmed }
+#   machine.transitions_for[:ignore]  = { :new => :ignored }
+#   machine.transitions_for[:reset]   = { :confirmed => :new, :ignored => :new }
 #
-#   fsm.trigger(:confirm)  #=> true
-#   fsm.trigger(:ignore)   #=> false
-#   fsm.trigger(:reset)    #=> true
-#   fsm.trigger(:ignore)   #=> true
+#   machine.trigger(:confirm)  #=> true
+#   machine.trigger(:ignore)   #=> false
+#   machine.trigger(:reset)    #=> true
+#   machine.trigger(:ignore)   #=> true
 #
+# It also handles callbacks that are executed when entering a different state.
+#
+#   machine.on(:confirmed) do
+#     puts "Confirmed"
+#   end
 class MicroMachine
   attr :transitions_for
   attr :state
@@ -20,11 +25,18 @@ class MicroMachine
   def initialize initial_state
     @state = initial_state
     @transitions_for = Hash.new
+    @callbacks = Hash.new { |hash, key| hash[key] = [] }
+  end
+
+  def on key, &block
+    @callbacks[key] << block
   end
 
   def trigger event
     if transitions_for[event][@state]
       @state = transitions_for[event][@state]
+      @callbacks[@state].each { |callback| callback.call }
+      true
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: soveran-micromachine
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - Michel Martens