soveran-micromachine 0.0.4 → 0.0.5

data/README.markdown

@@ -0,0 +1,63 @@
+MicroMachine
+============
+
+Minimal Finite State Machine.
+
+Description
+-----------
+
+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.
+
+But if all you want is a finite state machine, look no further: this is only
+15 lines of code and provides everything a finite state machine must have, and
+nothing more.
+
+Usage
+-----
+
+    require 'micromachine'
+
+    fsm = 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 }
+
+    fsm.fire(:confirm)  #=> true
+    fsm.fire(:ignore)   #=> false
+    fsm.fire(:reset)    #=> true
+    fsm.fire(:ignore)   #=> true
+
+Installation
+------------
+
+    $ gem sources -a http://gems.github.com (you only have to do this once)
+    $ sudo gem install soveran-micromachine
+
+License
+-------
+
+Copyright (c) 2009 Michel Martens for Citrusbyte
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/example/micromachine_sample.rb

@@ -1,24 +1,24 @@
 require File.join(File.dirname(__FILE__), '../lib/micromachine')
 
 fsm = MicroMachine.new(:pending)
-fsm.events[:confirm]  = { :pending => :confirmed }
-fsm.events[:ignore]   = { :pending => :ignored }
-fsm.events[:reset]    = { :confirmed => :pending, :ignored => :pending }
+fsm.transitions_for[:confirm]  = { :pending => :confirmed }
+fsm.transitions_for[:ignore]   = { :pending => :ignored }
+fsm.transitions_for[:reset]    = { :confirmed => :pending, :ignored => :pending }
 
 puts "Should print Confirmed, Reset and Ignored."
 
-if fsm.fire(:confirm)
+if fsm.trigger(:confirm)
   puts "Confirmed"
 end
 
-if fsm.fire(:ignore)
+if fsm.trigger(:ignore)
   puts "Ignored"
 end
 
-if fsm.fire(:reset)
+if fsm.trigger(:reset)
   puts "Reset"
 end
 
-if fsm.fire(:ignore)
+if fsm.trigger(:ignore)
   puts "Ignored"
 end

data/example/micromachine_sample_gem.rb

@@ -2,24 +2,24 @@ require 'rubygems'
 require 'micromachine'
 
 fsm = MicroMachine.new(:pending)
-fsm.events[:confirm]  = { :pending => :confirmed }
-fsm.events[:ignore]   = { :pending => :ignored }
-fsm.events[:reset]    = { :confirmed => :pending, :ignored => :pending }
+fsm.transitions_for[:confirm]  = { :pending => :confirmed }
+fsm.transitions_for[:ignore]   = { :pending => :ignored }
+fsm.transitions_for[:reset]    = { :confirmed => :pending, :ignored => :pending }
 
 puts "Should print Confirmed, Reset and Ignored."
 
-if fsm.fire(:confirm)
+if fsm.trigger(:confirm)
   puts "Confirmed"
 end
 
-if fsm.fire(:ignore)
+if fsm.trigger(:ignore)
   puts "Ignored"
 end
 
-if fsm.fire(:reset)
+if fsm.trigger(:reset)
   puts "Reset"
 end
 
-if fsm.fire(:ignore)
+if fsm.trigger(:ignore)
   puts "Ignored"
 end

data/lib/micromachine.rb

@@ -4,27 +4,27 @@
 #
 #   fsm = MicroMachine.new(:new) # Initial state.
 #
-#   fsm.events[:confirm] = { :new => :confirmed }
-#   fsm.events[:ignore] = { :new => :ignored }
-#   fsm.events[:reset] = { :confirmed => :new, :ignored => :new }
+#   fsm.transitions_for[:confirm] = { :new => :confirmed }
+#   fsm.transitions_for[:ignore] = { :new => :ignored }
+#   fsm.transitions_for[:reset] = { :confirmed => :new, :ignored => :new }
 #
-#   fsm.fire(:confirm)  #=> true
-#   fsm.fire(:ignore)   #=> false
-#   fsm.fire(:reset)    #=> true
-#   fsm.fire(:ignore)   #=> true
+#   fsm.trigger(:confirm)  #=> true
+#   fsm.trigger(:ignore)   #=> false
+#   fsm.trigger(:reset)    #=> true
+#   fsm.trigger(:ignore)   #=> true
 #
 class MicroMachine
-  attr :events
+  attr :transitions_for
   attr :state
 
   def initialize initial_state
     @state = initial_state
-    @events = Hash.new
+    @transitions_for = Hash.new
   end
 
-  def fire event
-    if events[event][@state]
-      @state = events[event][@state]
+  def trigger event
+    if transitions_for[event][@state]
+      @state = transitions_for[event][@state]
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: soveran-micromachine
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Michel Martens
@@ -19,25 +19,20 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
 - lib/micromachine.rb
-- README.rdoc
+- README.markdown
 - LICENSE
 - Rakefile
 - example/micromachine_sample.rb
 - example/micromachine_sample_gem.rb
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/soveran/micromachine
 post_install_message: 
-rdoc_options: 
-- --line-numbers
-- --inline-source
-- --title
-- micromachine
-- --main
-- README.rdoc
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/README.rdoc

@@ -1,27 +0,0 @@
-= MicroMachine
-
-Minimal Finite State Machine.
-
-== Usage
-
-
-  require 'micromachine'
-
-  fsm = MicroMachine.new(:new) # Initial state.
-
-  fsm.events[:confirm] = { :new => :confirmed }
-  fsm.events[:ignore] = { :new => :ignored }
-  fsm.events[:reset] = { :confirmed => :new, :ignored => :new }
-
-  fsm.fire(:confirm)  #=> true
-  fsm.fire(:ignore)   #=> false
-  fsm.fire(:reset)    #=> true
-  fsm.fire(:ignore)   #=> true
-
-== Installation
-
-  $ gem sources -a http://gems.github.com (you only have to do this once)
-  $ sudo gem install soveran-micromachine
-
-Copyright (c) 2009 Michel Martens.
-Released under the MIT license.