ruby-state-mach 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2009-08-11
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,11 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/ruby-state-machine.rb
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_state_machine.rb

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on ruby-state-machine, see http://ruby-state-machine.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,48 @@
+= ruby-state-machine
+
+* FIX (url)
+
+== DESCRIPTION:
+
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 FIXME full name
+
+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/Rakefile

@@ -0,0 +1,28 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/ruby-state-machine'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('ruby-state-mach', RubyStateMachine::VERSION) do |p|
+  p.developer('stevenmiers', 'steven.miers@gmail.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+  # p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+  # ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/lib/ruby-state-machine.rb

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

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/ruby-state-machine.rb'}"
+puts "Loading ruby-state-machine gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/ruby-state-machine'

data/test/test_state_machine.rb

@@ -0,0 +1,212 @@
+require 'test/unit'
+#require "#{File.dirname(__FILE__)}/../init"
+
+require 'ruby-state-machine/state_machine'
+
+# Fixture for testing state machine:
+class StateMachineFixture
+  include StateMachine
+  attr_accessor :test_val, :prev_test_val, :proc_val, :force_decide_nil, :name_for_decider
+  
+  
+  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
+  
+  def initialize
+    super
+    @test_val = nil
+    @proc_val = 0
+    @force_decide_nil = false
+    @name_for_decider = "foo"
+  end
+  
+  def increment_value(by)
+    @proc_val += by
+  end
+  
+  def bush(term)
+    @prev_test_val = @test_val
+    @test_val=term
+    send_event(:w_event)
+  end
+  
+  def c_state_decider(args)
+    if @force_decide_nil
+      # Hack to test nil decider:
+      nil
+    else
+      refined = (@test_val and @prev_test_val and @test_val.index(@prev_test_val)==0)    
+      refined ? :b_state : :a_state
+    end
+  end
+  
+  def named_action_decider(args)
+    @name_for_decider
+  end
+    
+end
+
+# Test state machine:
+class StateMachineTest < Test::Unit::TestCase
+
+  def test_states
+    assert_equal(:d_state, StateMachineFixture.states.last)
+  end
+
+  def test_events
+    assert_equal(:w_event, StateMachineFixture.events.first)
+  end
+  
+  def test_next_states
+    assert_equal(:b_state, StateMachineFixture.next_state(:a_state, :w_event))
+    assert_equal(:c_state, StateMachineFixture.next_state(:a_state, :x_event))
+    assert_equal(:b_state, StateMachineFixture.next_state(:b_state, :w_event))
+    assert_equal(:a_state, StateMachineFixture.next_state(:b_state, :z_event))
+    assert_equal(:a_state, StateMachineFixture.next_state(:c_state, :y_event))
+    assert_equal(:b_state, StateMachineFixture.next_state(:c_state, :x_event))    
+    assert_nil(StateMachineFixture.next_state(:b_state, :x_event))
+  end
+  
+  def test_event_sending
+    sm = StateMachineFixture.new
+    assert_equal(:a_state, sm.current_state)
+    sm.send_event(:w_event)
+    
+    assert_equal(:b_state, sm.current_state)
+    assert_raise(StateMachine::InvalidStateError){sm.send_event(:x_event)}
+
+    sm.send_event(:w_event)    
+    assert_equal(:b_state, sm.current_state)
+
+    sm.send_event(:z_event)    
+    assert_equal(:a_state, sm.current_state)
+    
+    sm.send_event(:x_event)    
+    assert_equal(:c_state, sm.current_state)    
+  end
+  
+  def test_action_calling
+    sm = StateMachineFixture.new
+    assert_equal(0, sm.proc_val)
+    assert_equal(:a_state, sm.current_state)
+    sm.send_event(:w_event)
+    assert_equal(5, sm.proc_val)
+
+    sm.send_event(:y_event)
+    assert_equal(5, sm.proc_val)
+    
+    sm.send_event(:y_event)    
+    assert_equal(2, sm.proc_val)    
+  end
+  
+  def test_decider
+    sm = StateMachineFixture.new
+    assert_equal(:a_state, sm.current_state)
+    sm.send_event(:x_event)
+    sm.bush("foo")
+    assert_equal(:a_state, sm.current_state)
+    sm.bush("foobar")
+    assert_equal(:b_state, sm.current_state)
+    sm.send_event(:y_event)
+    sm.bush("barfoo")
+    assert_equal(:a_state, sm.current_state)    
+  end
+  
+  def test_nil_decider
+    sm = StateMachineFixture.new
+    assert_equal(:a_state, sm.current_state)
+    sm.send_event(:x_event)        
+    assert_equal(:c_state, sm.current_state)
+    sm.force_decide_nil=true
+    assert_raise(StateMachine::InvalidStateError){sm.send_event(:w_event)}    
+  end
+  
+  def test_multiple_actions_without_decider
+    assert_raise(ArgumentError) do
+      StateMachineFixture.state_transition :state=>:c_state, :event=>:z_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)} }
+        ]
+    end    
+  end
+  
+  def test_named_actions_in_decider
+    sm = StateMachineFixture.new
+    assert_equal(:a_state, sm.current_state)
+    sm.send_event(:x_event)        
+    assert_equal(:c_state, sm.current_state)
+    sm.send_event(:z_event)            
+    
+    # Default value (foo) for named decider:
+    assert_equal(:a_state, sm.current_state)
+
+    # Back to a_state:
+    sm.send_event(:x_event)        
+    assert_equal(:c_state, sm.current_state)
+
+    # Alt value (bar) for named decider:
+    sm.name_for_decider = 'bar'
+    sm.send_event(:z_event)            
+    assert_equal(:d_state, sm.current_state)    
+  end
+  
+  def test_stay_state
+    sm = StateMachineFixture.new
+    
+    # Get to :d state:
+    sm.send_event(:x_event)        
+    sm.name_for_decider = 'bar'
+    sm.send_event(:z_event)        
+    assert_equal(:d_state, sm.current_state)
+    
+    # Send event & make sure we are still in :d state:
+    sm.send_event(:x_event)            
+    assert_equal(:d_state, sm.current_state)     
+  end
+  
+  def test_event_history
+    sm = StateMachineFixture.new
+    assert_equal(0, sm.event_history.size)     
+    sm.send_event(:x_event)        
+    assert_equal(1, sm.event_history.size)     
+    assert_equal([:x_event], sm.event_history)     
+    sm.send_event(:y_event)        
+    assert_equal(2, sm.event_history.size)     
+    assert_equal([:x_event, :y_event], sm.event_history)     
+    sm.send_event(:y_event)        
+    assert_equal(3, sm.event_history.size)     
+    assert_equal([:x_event, :y_event, :y_event], sm.event_history)
+
+    # Should max out at 10:
+    15.times{sm.send_event(:z_event)}
+    assert_equal(10, sm.event_history.size)     
+    assert_equal(Array.new(10, :z_event), sm.event_history)
+    
+  end
+  
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: ruby-state-mach
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- stevenmiers
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-11 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: FIX (describe your package)
+email: 
+- steven.miers@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/ruby-state-machine.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_helper.rb
+- test/test_state_machine.rb
+has_rdoc: true
+homepage: FIX (url)
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: ruby-state-mach
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: FIX (describe your package)
+test_files: 
+- test/test_helper.rb
+- test/test_state_machine.rb