simplificator-fsm 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 pascalbetz
+
+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

@@ -0,0 +1,7 @@
+= fsm
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 pascalbetz. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "fsm"
+    gem.summary = %Q{A simple finite state machine (FSM) gem.}
+    gem.email = "info@simplificator.com"
+    gem.homepage = "http://github.com/simplificator/fsm"
+    gem.authors = ["simplificator"]
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fsm #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 0

data/lib/fsm.rb

@@ -0,0 +1,41 @@
+require File.join(File.dirname(__FILE__), 'fsm', 'errors')
+require File.join(File.dirname(__FILE__), 'fsm', 'machine')
+require File.join(File.dirname(__FILE__), 'fsm', 'machine_config')
+require File.join(File.dirname(__FILE__), 'fsm', 'state')
+require File.join(File.dirname(__FILE__), 'fsm', 'transition')
+require File.join(File.dirname(__FILE__), 'fsm', 'executable')
+
+module FSM
+  module ClassMethods
+    def define_fsm(&block)
+      raise "FSM is already defined. Call define_fsm only once" if Machine[self]
+      machine = Machine.new(self)
+      Machine[self] = machine
+      config = MachineConfig.new(machine)
+      config.process(&block)
+      machine.post_process
+    end
+    
+
+  end
+  
+  module InstanceMethods
+    #
+    # Which states are reachable from the current state
+    def reachable_state_names
+      Machine[self.class].reachable_states.map() {|item| item.name}
+    end
+    
+    def available_transition_names
+      Machine[self.class].available_transitions.map() {|item| item.name}
+    end
+  end
+  
+  def self.included(receiver)
+    receiver.class_eval do 
+      extend(ClassMethods)
+      include(InstanceMethods)
+    end
+  end  
+  
+end

data/lib/fsm/errors.rb

@@ -0,0 +1,6 @@
+module FSM
+  class InvalidStateTransition < RuntimeError
+  end
+  class UnknownState < RuntimeError
+  end
+end

data/lib/fsm/executable.rb

@@ -0,0 +1,28 @@
+module FSM
+  #
+  # Execute an action specified by either String, Sylbol or Proc.
+  # Symbol and String represent methods which are called on the target object, Proc will get executed 
+  # and receives at least the target as parameter
+  class Executable
+    # Create a new Executable
+    # if args is true, then arguments are passed on to the target method or the Proc, if false nothing 
+    # will get passed
+    def initialize(thing, args = false)
+      @thing = thing
+      @has_arguments = args
+    end
+    
+    # execute this executable on the given target
+    def execute(target, args)
+      case @thing
+      when String, Symbol:
+        @has_arguments ? target.send(@thing, *args) : target.send(@thing)
+      when Proc:
+        @has_arguments ? @thing.call(target, *args) : @thing.call(target)
+      when Nil:
+      else
+        raise "Unknown Thing #{@thing}"
+      end
+    end
+  end
+end

data/lib/fsm/machine.rb

@@ -0,0 +1,98 @@
+module FSM
+  class Machine
+    attr_accessor(:current_state, :states, :state_attribute)
+    
+    def initialize(klass)
+      @klass = klass
+      self.states = {}
+      self.state_attribute = :state
+    end
+    
+    def self.[](includer)
+      (@machines ||= {})[includer]
+    end
+
+    def self.[]=(*args)
+      (@machines ||= {})[args.first] = args.last
+    end
+    
+    def state(name, options = {})
+      raise "State is already defined: '#{name}'" if self.states[name]
+      self.states[name] = State.new(name, options)
+      initial(name) unless self.current_state
+      nil
+    end
+    
+    def initial(name)
+      self.current_state = self.states[name]
+      raise UnknownState.new("Unknown state '#{name}'. Define states first with state(name)") unless self.current_state
+      nil
+    end
+    
+    def transition(name, from_name, to_name, options = {})
+      raise ArgumentError.new("name, from_name and to_name are required") if name.nil? || from_name.nil? || to_name.nil?
+      raise UnknownState.new("Unknown source state '#{from}'") unless self.states[from_name]
+      raise UnknownState.new("Unknown target state '#{to}'") unless self.states[to_name]
+      define_transition_method(name, to_name)
+      from_state = self.states[from_name]
+      to_state = self.states[to_name]
+      transition = Transition.new(name, from_state, to_state, options)
+      from_state.transitions[to_state.name] = transition
+      nil
+    end
+    
+    def attribute(name)
+      self.state_attribute = name
+    end
+    
+    def reachable_states()
+      self.states.map do |name, state|
+        state.to_states if state == current_state
+      end.flatten.compact
+    end
+    
+    def available_transitions()
+      current_state.transitions.values  
+    end
+    
+    
+    def post_process
+      define_state_attribute_methods(self.state_attribute)
+    end
+    
+    
+    
+    private
+    
+    def define_state_attribute_methods(name)
+      @klass.instance_eval do
+        define_method("#{name}") do 
+          Machine[self.class].current_state.name
+        end
+        
+        define_method("#{name}=") do |value|
+          Machine[self.class].current_state = Machine[self.class].states[value]
+          raise("Unknown State #{value}") unless Machine[self.class].current_state
+        end
+      end
+    end
+    
+    def define_transition_method(name, to_name)
+      @klass.instance_eval do
+        define_method(name) do |*args|
+          from_state = Machine[self.class].current_state
+          to_state = Machine[self.class].states[to_name]
+          transition = from_state.transitions[to_name]
+          raise InvalidStateTransition.new("No transition defined from #{from_state.name} -> #{to_state.name}") unless transition
+          
+          from_state.exit(self)
+          transition.fire_event(self, args)
+          to_state.enter(self)
+          Machine[self.class].current_state = to_state
+        end
+      end
+    end
+
+
+  end
+end

data/lib/fsm/machine_config.rb

@@ -0,0 +1,21 @@
+module FSM
+  class MachineConfig
+    CONFIG_METHODS = %w[state transition initial attribute]
+    instance_methods.each do |m| 
+      undef_method m unless  m == '__send__' || m == '__id__' || m == 'instance_eval'
+    end
+    
+    def initialize(target)
+      @target = target
+    end
+    
+    def process(&block)
+      instance_eval(&block)
+    end
+    
+    def method_missing(sym, *args, &block)
+      raise "Unknown config method '#{sym}'. Only #{CONFIG_METHODS.map() {|item| "'#{item}'" }.join(', ')} are known" unless CONFIG_METHODS.include?(sym.to_s)
+      @target.__send__(sym, *args, &block)
+    end
+  end
+end

data/lib/fsm/state.rb

@@ -0,0 +1,38 @@
+module FSM
+  #
+  # A State has a name and a list of outgoing transitions.
+  # 
+  class State
+    attr_reader(:name, :transitions)
+    
+    # name: a symbol which identifies this state
+    # options
+    #  * :enter : a symbol or string or Proc
+    #  * :exit : a symbol or string or Proc
+    def initialize(name, options = {})
+      @name = name
+      @enter = Executable.new options[:enter]
+      @exit = Executable.new options[:exit]
+      @transitions = {}
+    end
+    
+    # Called when this state is entered
+    def enter(target)
+      @enter.execute(target, nil)
+    end
+    # Called when this state is exited
+    def exit(target)
+      @exit.execute(target, nil)
+    end    
+    
+    # All states that are reachable form this state by one hop
+    def to_states
+      self.transitions.map { |to_name, transition| transition.to}
+    end
+    
+    def to_s
+      "State '#{self.name}' (#{self.object_id})"
+    end
+
+  end
+end

data/lib/fsm/transition.rb

@@ -0,0 +1,18 @@
+module FSM
+  class Transition
+    attr_accessor(:name, :from, :to, :event)
+    def initialize(name, from, to, options = {})
+      self.name = name
+      self.from = from
+      self.to = to
+      self.event = Executable.new options[:event], true
+    end
+    
+    def fire_event(target, args)
+      self.event.execute(target, args)
+    end    
+    def to_s
+      "Transition from #{self.from.name} -> #{self.to.name} with event #{self.event}"
+    end    
+  end
+end

data/test/fsm_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class FsmTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fsm'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: simplificator-fsm
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- simplificator
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-14 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: info@simplificator.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/fsm.rb
+- lib/fsm/errors.rb
+- lib/fsm/executable.rb
+- lib/fsm/machine.rb
+- lib/fsm/machine_config.rb
+- lib/fsm/state.rb
+- lib/fsm/transition.rb
+- test/fsm_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/simplificator/fsm
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: A simple finite state machine (FSM) gem.
+test_files: 
+- test/fsm_test.rb
+- test/test_helper.rb