micromachine 1.0.0 → 1.0.1

data/README.md

@@ -11,7 +11,7 @@ all provide a nice DSL for declaring events, exceptions, callbacks,
 and all kinds of niceties in general.
 
 But if all you want is a finite state machine, look no further: this
-is only 22 lines of code and provides everything a finite state
+has less than 50 lines of code and provides everything a finite state
 machine must have, and nothing more.
 
 Usage
@@ -22,9 +22,10 @@ require 'micromachine'
 
 machine = MicroMachine.new(:new) # Initial state.
 
-machine.transitions_for[:confirm] = { :new => :confirmed }
-machine.transitions_for[:ignore]  = { :new => :ignored }
-machine.transitions_for[:reset]   = { :confirmed => :new, :ignored => :new }
+# Define the possible transitions for each event.
+machine.when(:confirm, :new => :confirmed)
+machine.when(:ignore, :new => :ignored)
+machine.when(:reset, :confirmed => :new, :ignored => :new)
 
 machine.trigger(:confirm)  #=> true
 machine.state              #=> :confirmed
@@ -39,6 +40,15 @@ machine.trigger(:ignore)   #=> true
 machine.state              #=> :ignored
 ```
 
+The `when` helper is syntactic sugar for assigning to the
+`transitions_for` hash. This code is equivalent:
+
+``` ruby
+machine.transitions_for[:confirm] = { :new => :confirmed }
+machine.transitions_for[:ignore]  = { :new => :ignored }
+machine.transitions_for[:reset]   = { :confirmed => :new, :ignored => :new }
+```
+
 You can also ask if an event will trigger a change in state. Following
 the example above:
 
@@ -103,9 +113,9 @@ class Event < ActiveRecord::Base
     @confirmation ||= begin
       fsm = MicroMachine.new(confirmation_state || "pending")
 
-      fsm.transitions_for[:confirm] = { "pending" => "confirmed" }
-      fsm.transitions_for[:cancel] = { "confirmed" => "cancelled" }
-      fsm.transitions_for[:reset] = { "confirmed" => "pending", "cancelled" => "pending" }
+      fsm.when(:confirm, "pending" => "confirmed")
+      fsm.when(:cancel, "confirmed" => "cancelled")
+      fsm.when(:reset, "confirmed" => "pending", "cancelled" => "pending")
 
       fsm
     end
@@ -143,9 +153,9 @@ class Event < ActiveRecord::Base
     @confirmation ||= begin
       fsm = MicroMachine.new(confirmation_state || "pending")
 
-      fsm.transitions_for[:confirm] = { "pending" => "confirmed" }
-      fsm.transitions_for[:cancel] = { "confirmed" => "cancelled" }
-      fsm.transitions_for[:reset] = { "confirmed" => "pending", "cancelled" => "pending" }
+      fsm.when(:confirm, "pending" => "confirmed")
+      fsm.when(:cancel, "confirmed" => "cancelled")
+      fsm.when(:reset, "confirmed" => "pending", "cancelled" => "pending")
 
       fsm.on(:any) { self.confirmation_state = confirmation.state }
 

data/lib/micromachine.rb

@@ -14,6 +14,10 @@ class MicroMachine
     @callbacks[key] << block
   end
 
+  def when(event, transitions)
+    transitions_for[event] = transitions
+  end
+
   def trigger event
     if trigger?(event)
       @state = transitions_for[event][@state]
@@ -31,6 +35,10 @@ class MicroMachine
     raise InvalidEvent
   end
 
+  def events
+    transitions_for.keys
+  end
+
   def ==(some_state)
     state == some_state
   end

data/micromachine.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'micromachine'
-  s.version = '1.0.0'
+  s.version = '1.0.1'
   s.summary = %{Minimal Finite State Machine.}
   s.description = %Q{There are many finite state machine implementations for Ruby, and they all provide a nice DSL for declaring events, exceptions, callbacks, and all kinds of niceties in general.\n\nBut if all you want is a finite state machine, look no further: this is only 22 lines of code and provides everything a finite state machine must have, and nothing more.}
   s.author = "Michel Martens"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: micromachine
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-28 00:00:00.000000000 Z
+date: 2012-03-29 00:00:00.000000000 Z
 dependencies: []
 description: ! 'There are many finite state machine implementations for Ruby, and
   they all provide a nice DSL for declaring events, exceptions, callbacks, and all