stateflow 0.0.1

data/LICENCE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Ryan Oberholzer
+ 
+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/Manifest

@@ -0,0 +1,11 @@
+LICENCE
+Manifest
+README.rdoc
+Rakefile
+examples/test.rb
+init.rb
+lib/stateflow.rb
+lib/stateflow/event.rb
+lib/stateflow/machine.rb
+lib/stateflow/state.rb
+lib/stateflow/transition.rb

data/README.rdoc

@@ -0,0 +1,21 @@
+= Stateflow
+
+== TODO
+
+* Persistence layers
+* Tests
+
+This is the basics of the gem. THIS IS NOT PRODUCTION READY UNTIL TESTS ARE DONE. Please check out the examples directory for usage until this readme gets fleshed out. Feel free to fork and modify as you please.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with Rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Ryan Oberholzer. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('stateflow', '0.0.1') do |p|
+  p.description    = "State machine that allows dynamic transitions for business workflows"
+  p.url            = "http://github.com/ryanza/stateflow"
+  p.author         = "Ryan Oberholzer"
+  p.email          = "ryan@platform45.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end

data/examples/test.rb

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'stateflow'
+
+class Test
+  include Stateflow
+  
+  stateflow do
+    
+    initial :love
+    
+    state :love do
+      enter lambda { |t| p "Entering love" }
+      exit :exit_love
+    end
+    
+    state :hate do
+      enter lambda { |t| p "Entering hate" }
+      exit lambda { |t| p "Exiting hate" }
+    end
+    
+    state :mixed do
+      enter lambda { |t| p "Entering mixed" }
+      exit lambda { |t| p "Exiting mixed" }
+    end
+    
+    event :b do
+      transitions :from => :love, :to => :hate, :if => :no_ice_cream
+      transitions :from => :hate, :to => :love
+    end
+    
+    event :a do
+      transitions :from => :love, :to => [:hate, :mixed], :decide => :likes_ice_cream?
+      transitions :from => [:hate, :mixed], :to => :love
+    end
+  end
+  
+  def likes_ice_cream?
+    rand(10) > 5 ? :mixed : :hate
+  end
+  
+  def exit_love
+    p "Exiting love"
+  end
+  
+  def no_ice_cream
+    rand(4) > 2 ? true : false
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'stateflow'

data/lib/stateflow.rb

@@ -0,0 +1,61 @@
+module Stateflow
+  def self.included(base)
+    base.send :include, InstanceMethods
+    base.extend ClassMethods
+  end
+  
+  def self.persistence
+    @@persistence ||= "active_record"
+  end
+  
+  def self.persistence=(persistence)
+    @@persistence = persistence
+  end
+  
+  module ClassMethods
+    attr_reader :machine
+    
+    def stateflow(&block)
+      @machine = Stateflow::Machine.new(&block)
+      
+      @machine.states.values.each do |state|
+        state_name = state.name
+        define_method "#{state_name}?" do
+          state_name == current_state.name
+        end
+      end
+      
+      @machine.events.keys.each do |key|
+        define_method "#{key}!" do
+          fire_event(key)
+        end
+      end
+    end
+  end
+  
+  module InstanceMethods
+    def current_state
+      @current_state ||= machine.initial_state
+    end
+    
+    def current_state=(new_state)
+      @current_state = new_state
+    end
+    
+    def machine
+      self.class.machine
+    end
+    
+    private
+    def fire_event(event)
+      event = machine.events[event.to_sym]
+      raise Exception.new("No event matches #{event}") if event.nil?
+      event.fire(current_state, self)
+    end
+  end
+  
+  autoload :Machine, 'stateflow/machine'
+  autoload :State, 'stateflow/state'
+  autoload :Event, 'stateflow/event'
+  autoload :Transition, 'stateflow/transition'
+end

data/lib/stateflow/event.rb

@@ -0,0 +1,36 @@
+module Stateflow
+  class NoTransitionFound < Exception; end
+  class NoStateFound < Exception; end
+  
+  class Event
+    attr_accessor :name, :transitions
+    
+    def initialize(name, &transitions)
+      @name = name
+      @transitions = Array.new
+      
+      instance_eval(&transitions)
+    end
+    
+    def fire(current_state, klass)
+      transition = @transitions.select{ |t| t.from.include? current_state.name }.first
+      raise NoTransitionFound.new("No transition found for event #{@name}") if transition.nil?
+      
+      return false unless transition.can_transition?(klass)
+      
+      new_state = klass.machine.states[transition.find_to_state(klass)]
+      raise NoStateFound.new("Invalid state #{transition.to.to_s} for transition.") if new_state.nil?
+      
+      current_state.execute_action(:exit, klass)
+      klass.current_state = new_state
+      new_state.execute_action(:enter, klass)
+      true
+    end
+    
+    private
+    def transitions(args = {})
+      transition = Stateflow::Transition.new(args)
+      @transitions << transition
+    end
+  end
+end

data/lib/stateflow/machine.rb

@@ -0,0 +1,28 @@
+module Stateflow
+  class Machine
+    attr_accessor :states, :initial_state, :events
+    
+    def initialize(&machine)
+      @states, @events = Hash.new, Hash.new
+      instance_eval(&machine)
+    end
+
+    private
+    def initial(name)
+      @initial_state_name = name
+    end
+    
+    def state(*names, &options)
+      names.each do |name|
+        state = Stateflow::State.new(name, &options)
+        @initial_state = state if @states.empty? || @initial_state_name == name
+        @states[name.to_sym] = state
+      end
+    end
+    
+    def event(name, &transitions)
+      event = Stateflow::Event.new(name, &transitions)
+      @events[name.to_sym] = event
+    end
+  end
+end

data/lib/stateflow/state.rb

@@ -0,0 +1,31 @@
+module Stateflow
+  class State
+    attr_accessor :name, :options
+    
+    def initialize(name, &options)
+      @name = name
+      @options = Hash.new
+      
+      instance_eval(&options) if options
+    end
+    
+    def enter(method = nil, &block)
+      @options[:enter] = method.nil? ? block : method
+    end
+    
+    def exit(method = nil, &block)
+      @options[:exit] = method.nil? ? block : method
+    end
+    
+    def execute_action(action, base)
+      action = @options[action.to_sym]
+      
+      case action
+      when Symbol, String
+        base.send(action)
+      when Proc
+        action.call(base)
+      end
+    end
+  end
+end

data/lib/stateflow/transition.rb

@@ -0,0 +1,38 @@
+module Stateflow
+  class IncorrectTransition < Exception; end
+  
+  class Transition
+    attr_reader :from, :to, :if, :decide
+    
+    def initialize(args)
+      @from = [args[:from]].flatten
+      @to = args[:to]
+      @if = args[:if]
+      @decide = args[:decide]
+    end 
+    
+    def can_transition?(base)
+      return true unless @if
+      execute_action(@if, base)
+    end
+    
+    def find_to_state(base)
+      raise IncorrectTransition.new("Array of destinations and no decision") if @to.is_a?(Array) && @decide.nil?
+      return @to unless @to.is_a?(Array)
+      
+      to = execute_action(@decide, base)
+      
+      @to.include?(to) ? to : (raise NoStateFound.new("Decision did not return a state that was set in the 'to' argument"))
+    end
+      
+    private
+    def execute_action(action, base)
+      case action
+      when Symbol, String
+        base.send(action)
+      when Proc
+        action.call(base)
+      end
+    end
+  end
+end

data/stateflow.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{stateflow}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Oberholzer"]
+  s.date = %q{2010-03-22}
+  s.description = %q{State machine that allows dynamic transitions for business workflows}
+  s.email = %q{ryan@platform45.com}
+  s.extra_rdoc_files = ["README.rdoc", "lib/stateflow.rb", "lib/stateflow/event.rb", "lib/stateflow/machine.rb", "lib/stateflow/state.rb", "lib/stateflow/transition.rb"]
+  s.files = ["LICENCE", "Manifest", "README.rdoc", "Rakefile", "examples/test.rb", "init.rb", "lib/stateflow.rb", "lib/stateflow/event.rb", "lib/stateflow/machine.rb", "lib/stateflow/state.rb", "lib/stateflow/transition.rb", "stateflow.gemspec"]
+  s.homepage = %q{http://github.com/ryanza/stateflow}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Stateflow", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{stateflow}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{State machine that allows dynamic transitions for business workflows}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: stateflow
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ryan Oberholzer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-22 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: State machine that allows dynamic transitions for business workflows
+email: ryan@platform45.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/stateflow.rb
+- lib/stateflow/event.rb
+- lib/stateflow/machine.rb
+- lib/stateflow/state.rb
+- lib/stateflow/transition.rb
+files: 
+- LICENCE
+- Manifest
+- README.rdoc
+- Rakefile
+- examples/test.rb
+- init.rb
+- lib/stateflow.rb
+- lib/stateflow/event.rb
+- lib/stateflow/machine.rb
+- lib/stateflow/state.rb
+- lib/stateflow/transition.rb
+- stateflow.gemspec
+has_rdoc: true
+homepage: http://github.com/ryanza/stateflow
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Stateflow
+- --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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: stateflow
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: State machine that allows dynamic transitions for business workflows
+test_files: []
+