barebone-fsm 0.0.1.2 → 0.0.1.3

data/README.rdoc

@@ -78,6 +78,8 @@ The api is not stable yet, it may go trhough lots of changes before the first st
 I am open to any suggestion or request to support custom features.
 
 == Changes
+* Version: 0.0.1.3
+  * Minor fixes on the usage examples
 * Version: 0.0.1.2
   * @state instance variable for FSM is dropped in favour of the #state instance method.
   * #state method and index operator [] now accept nil arguement for state name, which returns the current state.

data/lib/barebone-fsm.rb

@@ -18,14 +18,14 @@
 #
 module FSM
 
-  # == Overview
-  # ---
   # FSMState class represents a state of the finite state machine.
   # 
   # == Usage
-  # ---
   #   state = FSMState.new :state_name
-  #   state.event(:event_name) {|st, ev| puts "#{ev} triggered on state #{st}"; :new_state} # creates the event when block is given
+  #   state.event(:event_name) do # creates the event when block is given
+  #     puts "#{@event} triggered on state #{@state}"
+  #     :new_state
+  #   end  
   #   puts state
   #   state.event :event_name # triggers the event when block is absent
   #
@@ -73,8 +73,6 @@ module FSM
     
   end
 
-  # == Overview
-  # ---
   # This class implements the finite-state machine.
   # FSM class exposes the states it contains and can trigger an event.
   # States are created on the fly first time it's referenced through index operator [].
@@ -85,9 +83,8 @@ module FSM
   # This can be either the default state if defined or the first referenced state.
   #
   # == Usage
-  # ---
   #   fsm = FSM.new :default_state
-  #   fsm[:default_state].event(:first_event) do |st, ev| # the state is defined and referenced at the same time
+  #   fsm[:default_state].event(:first_event) do # the state is defined and referenced at the same time
   #     puts "The first transition from the default_state to state_name"
   #     :state_name # the next state is defined here
   #   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: barebone-fsm
 version: !ruby/object:Gem::Version
-  version: 0.0.1.2
+  version: 0.0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-19 00:00:00.000000000 Z
+date: 2013-01-20 00:00:00.000000000 Z
 dependencies: []
 description: A barebone implementation of finite state machine keeping simplicity
   in mind.