barebone-fsm 0.0.2 → 0.0.2.1

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013, Md. Imrul Hassan
+
+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/README.rdoc

@@ -1,9 +1,9 @@
 == Overview
-This module implements a basic finite-state machine (FSM).
+This module, barebone-fsm, implements a basic finite-state machine (FSM).
 An FSM consists of a finite number of states,
 with one of them being the current state of the FSM.
 Transitions are defined between states, which are triggered on events.
-For details on FSM, see this wiki page: {FSM}[http://en.wikipedia.org/wiki/Finite-state_machine].
+For details on FSM, see this wiki page: {http://en.wikipedia.org/wiki/Finite-state_machine FSM}.
 
 The motivation behind the module was to implement a very basic barebone FSM in Ruby.
 Features are kept at minimum as well as the code.
@@ -12,7 +12,8 @@ Only two classes for the FSM are defined as the following:
 * FSMState -> the state class
 
 Author:: Md. Imrul Hassan (mailto:mihassan@gmail.com)
-Copyright:: Copyright: Md. Imrul Hassan, 2013
+Copyright:: Copyright (c) 2013, Md. Imrul Hassan
+License:: Barebone-fsm is released under the MIT license. Please check the {file:MIT-LICENSE LICENSE} file for more details.
 
 == Features
 Apart from having support for states and events, this module offers the following features:

data/example/door.rb

@@ -0,0 +1,51 @@
+require '../lib/barebone-fsm'
+
+fsm = FSM::FSM.new(:default)
+
+fsm.build do
+
+  state :default do
+    event :open do
+      puts "#{@x} transition: default->open"
+      :open
+    end
+    event :close do
+      puts "#{@x} transition: default->close"
+      :close
+    end
+  end
+
+  state :open do
+    event :close do
+      @x ||= 0
+      @x+=1
+      puts "#{@x} transition: open->close"
+      :close
+    end
+  end
+
+  state :close do
+    event :open do
+      @x ||= 0
+      @x+=1
+      puts "#{@x} transition: close->open"
+      :open
+    end
+  end
+
+end
+
+puts fsm
+
+fsm.run do
+  
+  event :close
+  event :open
+  event :close
+  event :undefined
+  event :open
+  event :close
+
+end
+
+puts fsm

data/example/microwave.rb

@@ -0,0 +1,49 @@
+require '../lib/barebone-fsm'
+
+fsm = FSM::FSM.new
+
+fsm.build do
+
+  state :stopped do
+    event :open do
+      puts "[#{@state}]->#{@event}"
+      :open
+    end
+    event :start do
+      puts "[#{@state}]->#{@event}"
+      :started
+    end
+  end
+  
+  state :open do
+    event :close do
+      puts "[#{@state}]->#{@event}"
+      :stopped
+    end
+  end
+  
+  state :started do
+    event :open do
+      puts "[#{@state}]->#{@event}"
+      :open
+    end
+    event :stop do
+      puts "[#{@state}]->#{@event}"
+      :stopped
+    end
+  end
+
+end
+
+fsm.run do
+  
+  event :open
+  event :close
+  event :start
+  event :open
+  event :close
+  event :start
+  event :stop
+end
+
+puts fsm

data/lib/barebone-fsm.rb

@@ -91,12 +91,15 @@ module FSM
   #   end
   #
   class FSM
+    
     attr_writer :event
+    
+    # Creates a new FSM object with an optional default state set.
     def initialize(default_state=nil) 
       @states = {}
       if default_state then
-        @state = @default = default_state 
-        @states[@state] = FSMState.new(self, @state)
+        @default = default_state 
+        @states[@default] = FSMState.new(self, @default)
       end
     end
     

data/spec/barebone-fsm_spec.rb

@@ -0,0 +1,58 @@
+require '../lib/barebone-fsm'
+
+describe FSM::FSM do
+  
+  context "with default state" do
+    
+    before :each do
+      @fsm = FSM::FSM.new :default
+    end
+    
+    it "should set the default state" do
+      @fsm.build do
+        state :start do
+        end
+      end
+      @fsm[].state.should be_eql(:start)
+      @fsm.run do
+        event :undefined
+      end
+      @fsm[].state.should be_eql(:default)
+    end
+  
+  end
+  
+  context "without default state" do
+    
+    before :each do
+      @fsm = FSM::FSM.new
+    end
+    
+    it "should not set the default state" do
+      @fsm.build do
+        state :start do
+        end
+      end
+      @fsm[].state.should be_eql(:start)
+      @fsm.run do
+        event :undefined
+      end
+      @fsm[].state.should be_eql(:start)
+    end
+    
+  end
+  
+  it "should create states on the fly" do
+    @fsm = FSM::FSM.new
+    @fsm[:new_state].state.should eq(:new_state)
+    @fsm.state(:another_state).state.should eq(:another_state)
+  end
+  
+  it "should set current state to the first accessed state" do
+    @fsm = FSM::FSM.new
+    @fsm[:new_state].state.should eq(:new_state)
+    @fsm.state(:another_state).state.should eq(:another_state)
+    @fsm.state().state.should eq(:new_state)
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: barebone-fsm
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ bindir: bin
 cert_chain: []
 date: 2013-01-20 00:00:00.000000000 Z
 dependencies: []
-description: A barebone implementation of finite state machine keeping simplicity
+description: A barebone implementation of the finite state machine keeping simplicity
   in mind.
 email: mihassan@gmail.com
 executables: []
@@ -19,10 +19,15 @@ extensions: []
 extra_rdoc_files:
 - README.rdoc
 files:
+- example/door.rb
+- example/microwave.rb
+- spec/barebone-fsm_spec.rb
 - lib/barebone-fsm.rb
 - README.rdoc
-homepage: http://rubygems.org/gems/barebone-fsm
-licenses: []
+- MIT-LICENSE
+homepage: https://github.com/mihassan/barebone-fsm/
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths: