ruby-state-mach 0.0.1 → 0.0.2

data/History.txt

@@ -2,3 +2,8 @@
 
 * 1 major enhancement:
   * Initial release
+
+== 0.0.2 2009-08-11
+
+* 1 minor enhancement:
+  * Docs

data/README.rdoc

@@ -1,26 +1,56 @@
 = ruby-state-machine
 
-* FIX (url)
+* http://rubyforge.org/projects/ruby-state-mach/
 
 == DESCRIPTION:
 
-FIX (describe your package)
+An enhanced state machine gem for ruby (doesn't require Rails). Provides more robust DSL state declaration syntax than other state machines. Multiple "actions" per event (i.e., next state, labmda, or a "decider".
 
 == FEATURES/PROBLEMS:
 
-* FIX (list of features or problems)
+
 
 == SYNOPSIS:
 
-  FIX (code sample of usage)
+  class StateMachineFixture
+    include StateMachine
+    attr_accessor :test_val, :prev_test_val, :proc_val, :force_decide_nil, :name_for_decider
 
-== REQUIREMENTS:
 
-* FIX (list of requirements)
+    state_machine :states => [:a_state, :b_state, :c_state, :d_state], :events => [:w_event, :x_event, :y_event, :z_event]
+    state_transition :state=>:a_state, :event=>:w_event, :next=>{:state=>:b_state, :action=>lambda{|o, args| o.increment_value(5)} }
+    state_transition :state=>:a_state, :event=>:x_event, :next=>:c_state
+    state_transition :state=>:a_state, :event=>:y_event, :next=>:a_state
+    state_transition :state=>:a_state, :event=>:z_event, :next=>:b_state
+
+    state_transition :state=>:b_state, :event=>:w_event, :next=>:b_state
+    state_transition :state=>:b_state, :event=>:y_event, :next=>:c_state
+    state_transition :state=>:b_state, :event=>:z_event, :next=>:a_state
+
+    state_transition :state=>:c_state, :event=>:x_event, :next=>:b_state
+    state_transition :state=>:c_state, :event=>:y_event, :next=>{:state=>:a_state, :action=>lambda{|o, args| o.increment_value(-3)}}
+
+    state_transition :state=>:c_state, :event=>:w_event, :decider => :c_state_decider, 
+      :next=>[
+        {:state=>:a_state, :action=>lambda{|o, args| o.increment_value(7)} }, 
+        {:state=>:b_state, :action=>lambda{|o, args| o.increment_value(-10)} }
+      ]
+
+    state_transition :state=>:c_state, :event=>:z_event , :decider => :named_action_decider, 
+        :next=>[
+          {:name=>"foo", :state=>:a_state, :action=>lambda{|o, args| o.increment_value(7)} }, 
+          {:name=>"bar", :state=>:d_state, :action=>lambda{|o, args| o.increment_value(-10)} }
+        ]
+
+    state_transition :state=>:d_state, :event=>:x_event, :next=>:stay
+  
+
+== REQUIREMENTS:
+  Ruby
 
 == INSTALL:
 
-* FIX (sudo gem install, anything else)
+* sudo gem install ruby-state-mach
 
 == LICENSE:
 

data/lib/ruby-state-machine.rb

@@ -2,5 +2,5 @@ $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 module RubyStateMachine
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-state-mach
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - stevenmiers
@@ -32,7 +32,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.8.0
     version: 
-description: FIX (describe your package)
+description: An enhanced state machine gem for ruby (doesn't require Rails). Provides more robust DSL state declaration syntax than other state machines. Multiple "actions" per event (i.e., next state, labmda, or a "decider".
 email: 
 - steven.miers@gmail.com
 executables: []
@@ -57,7 +57,7 @@ files:
 - test/test_helper.rb
 - test/test_state_machine.rb
 has_rdoc: true
-homepage: FIX (url)
+homepage: http://rubyforge.org/projects/ruby-state-mach/
 post_install_message: PostInstall.txt
 rdoc_options: 
 - --main
@@ -82,7 +82,7 @@ rubyforge_project: ruby-state-mach
 rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
-summary: FIX (describe your package)
+summary: An enhanced state machine gem for ruby (doesn't require Rails)
 test_files: 
 - test/test_helper.rb
 - test/test_state_machine.rb