MINT-scxml 1.0.0

data/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+gem "MINT-statemachine", "1.2.3" 
+gem "rspec", "1.3.1"
+gem "rake","0.9.2"
+gem "hoe", "2.9.6"

data/Gemfile.lock

@@ -0,0 +1,18 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    MINT-statemachine (1.2.3)
+    hoe (2.9.6)
+      rake (~> 0.8)
+    rake (0.9.2)
+    rspec (1.3.1)
+
+PLATFORMS
+  ruby
+  x86-mingw32
+
+DEPENDENCIES
+  MINT-statemachine (= 1.2.3)
+  hoe (= 2.9.6)
+  rake (= 0.9.2)
+  rspec (= 1.3.1)

data/History.txt

@@ -0,0 +1,4 @@
+=== 1.0.0 / 2011-11-01
+
+* First version
+

data/MINT-scxml.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{MINT-scxml}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Jessica H. Colnago, Sebastian Feuerstack}]
+  s.date = %q{2011-11-01}
+  s.description = %q{}
+  s.email = %q{Sebastian@Feuerstack.org}
+  s.extra_rdoc_files = [%q{History.txt}, %q{Manifest.txt}, %q{README.txt}]
+  s.files = [%q{.autotest}, %q{.idea/workspace.xml}, %q{Gemfile}, %q{Gemfile.lock}, %q{History.txt}, %q{MINT-scxml.gemspec}, %q{Manifest.txt}, %q{README.rdoc}, %q{README.txt}, %q{Rakefile}, %q{lib/MINT-scxml.rb}, %q{lib/MINT-scxml/scxml-parser.rb}, %q{spec/atm_spec.rb}, %q{spec/parser_spec.rb}, %q{spec/spec.opts}, %q{spec/spec_helper.rb}, %q{spec/test_handgestures_spec.rb}, %q{spec/testmachines/atm_enhanced.rb}, %q{spec/testmachines/handgestures-scxmlgui.png}, %q{spec/testmachines/handgestures-scxmlgui.scxml}, %q{spec/testmachines/multiplestates.rb}, %q{spec/testmachines/traffic_light_enhanced.rb}, %q{spec/testmachines/vending_machine1.rb}, %q{spec/testmachines/vending_machine2.rb}, %q{spec/testmachines/vending_machine3.rb}, %q{spec/testmachines/vending_machine4.rb}, %q{spec_helper.rb}, %q{statemachines/AICommand_scxml_spec.rb}, %q{statemachines/AIO_scxml_spec.rb}, %q{statemachines/aui-scxml/AIC.scxml}, %q{statemachines/aui-scxml/AICommand.scxml}, %q{statemachines/aui-scxml/AICommand2.scxml}, %q{statemachines/aui-scxml/AIO.scxml}, %q{statemachines/aui/AIC.rb}, %q{statemachines/aui/AIChoiceElement.rb}, %q{statemachines/aui/AICommand.rb}, %q{statemachines/aui/AIIN.rb}, %q{statemachines/aui/AIINContinous.rb}, %q{statemachines/aui/AIMultiChoice.rb}, %q{statemachines/aui/AIMultiChoiceElement.rb}, %q{statemachines/aui/AIOUTContinous.rb}, %q{statemachines/aui/AISingleChoice.rb}, %q{statemachines/aui/AISingleChoiceElement.rb}, %q{statemachines/aui/aio.rb}, %q{statemachines/specs/AICommand_spec.rb}, %q{statemachines/specs/AIINContinous_spec.rb}, %q{statemachines/specs/AIMultiChoiceElement_spec.rb}, %q{statemachines/specs/AIMultiChoice_spec.rb}, %q{statemachines/specs/AIOUTContinous_spec.rb}, %q{statemachines/specs/AIO_spec.rb}, %q{statemachines/specs/AISingleChoiceElement_spec.rb}, %q{statemachines/specs/AISingleChoice_spec.rb}, %q{.gemtest}]
+  s.homepage = %q{http://www.multi-access.de}
+  s.rdoc_options = [%q{--main}, %q{README.rdoc}]
+  s.require_paths = [%q{lib}]
+  s.rubyforge_project = %q{MINT-scxml}
+  s.rubygems_version = %q{1.8.5}
+  s.summary = %q{}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<MINT-statemachine>, ["~> 1.2.3"])
+      s.add_development_dependency(%q<hoe>, ["~> 2.9"])
+    else
+      s.add_dependency(%q<MINT-statemachine>, ["~> 1.2.3"])
+      s.add_dependency(%q<hoe>, ["~> 2.9"])
+    end
+  else
+    s.add_dependency(%q<MINT-statemachine>, ["~> 1.2.3"])
+    s.add_dependency(%q<hoe>, ["~> 2.9"])
+  end
+end

data/Manifest.txt

@@ -0,0 +1,49 @@
+Gemfile
+Gemfile.lock
+History.txt
+MINT-scxml.gemspec
+Manifest.txt
+README.rdoc
+Rakefile
+lib/MINT-scxml.rb
+lib/MINT-scxml/scxml-parser.rb
+spec/atm_spec.rb
+spec/parser_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+spec/test_handgestures_spec.rb
+spec/testmachines/atm_enhanced.rb
+spec/testmachines/handgestures-scxmlgui.png
+spec/testmachines/handgestures-scxmlgui.scxml
+spec/testmachines/multiplestates.rb
+spec/testmachines/traffic_light_enhanced.rb
+spec/testmachines/vending_machine1.rb
+spec/testmachines/vending_machine2.rb
+spec/testmachines/vending_machine3.rb
+spec/testmachines/vending_machine4.rb
+spec_helper.rb
+statemachines/AICommand_scxml_spec.rb
+statemachines/AIO_scxml_spec.rb
+statemachines/aui-scxml/AIC.scxml
+statemachines/aui-scxml/AICommand.scxml
+statemachines/aui-scxml/AICommand2.scxml
+statemachines/aui-scxml/AIO.scxml
+statemachines/aui/AIC.rb
+statemachines/aui/AIChoiceElement.rb
+statemachines/aui/AICommand.rb
+statemachines/aui/AIIN.rb
+statemachines/aui/AIINContinous.rb
+statemachines/aui/AIMultiChoice.rb
+statemachines/aui/AIMultiChoiceElement.rb
+statemachines/aui/AIOUTContinous.rb
+statemachines/aui/AISingleChoice.rb
+statemachines/aui/AISingleChoiceElement.rb
+statemachines/aui/aio.rb
+statemachines/specs/AICommand_spec.rb
+statemachines/specs/AIINContinous_spec.rb
+statemachines/specs/AIMultiChoiceElement_spec.rb
+statemachines/specs/AIMultiChoice_spec.rb
+statemachines/specs/AIOUTContinous_spec.rb
+statemachines/specs/AIO_spec.rb
+statemachines/specs/AISingleChoiceElement_spec.rb
+statemachines/specs/AISingleChoice_spec.rb

data/README.rdoc

@@ -0,0 +1,50 @@
+= MINT Statemachine SCXML parser
+
+* http://www.multi-access.de
+
+== DESCRIPTION:
+
+This gem implements a state chart XML (SCXML) parser that generates a ruby statemachine.
+
+== FEATURES/PROBLEMS:
+
+* Currently only supports the very basic set of SCXML
+
+== SYNOPSIS:
+
+  See tests
+
+== REQUIREMENTS:
+
+* Depends on MINT-statemachine gem
+
+== INSTALL:
+
+* sudo gem install MINT-scxml
+
+== DEVELOPERS:
+
+After checking out the source, run:
+
+  $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+== LICENSE:
+
+Copyright (C) 2010,2011 Sebastian Feuerstack, Jessica H. Colnago
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

data/Rakefile

@@ -0,0 +1,31 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+# Hoe.plugin :compiler
+# Hoe.plugin :cucumberfeatures
+# Hoe.plugin :gem_prelude_sucks
+# Hoe.plugin :inline
+# Hoe.plugin :manifest
+Hoe.plugin :newgem
+# Hoe.plugin :racc
+# Hoe.plugin :rubyforge
+# Hoe.plugin :website
+
+Hoe.spec 'MINT-scxml' do
+  self.developer 'Jessica H. Colnago, Sebastian Feuerstack', 'Sebastian@Feuerstack.org'
+  self.rubyforge_name       = self.name # TODO this is default value
+  self.extra_deps         = [['MINT-statemachine','~> 1.2.3']]
+  self.email = "Sebastian@Feuerstack.org"
+
+  # HEY! If you fill these out in ~/.hoe_template/Rakefile.erb then
+  # you'll never have to touch them again!
+  # (delete this comment too, of course)
+
+  # developer('FIX', 'FIX@example.com')
+
+  # self.rubyforge_name = 'scxml-gemx' # if different than 'scxml-gem'
+end
+
+# vim: syntax=ruby

data/lib/MINT-scxml.rb

@@ -0,0 +1,5 @@
+class SCXML_MINT
+  VERSION = '1.0.0'
+end
+
+require "MINT-scxml/scxml-parser"

data/lib/MINT-scxml/scxml-parser.rb

@@ -0,0 +1,228 @@
+# -*- coding: raw-text -*-
+require 'rubygems'
+require "bundler/setup"
+require 'statemachine'
+require 'rexml/document'
+require 'rexml/streamlistener'
+
+
+class State
+  attr_accessor :id, :initial
+end
+
+class Transition
+  attr_accessor :event, :target, :cond
+end
+
+class StatemachineParser < Statemachine::StatemachineBuilder
+  include REXML
+  include StreamListener
+
+  def initialize(context = nil, logger = nil, queue = nil)
+    super()
+    @actions = Array.new
+    @current_transition = nil
+    @current_state = nil
+    @current_element = nil
+    @parallel = nil
+    @state = Array.new
+    @statemachine.messenger = logger
+    @statemachine.message_queue = queue
+    @statemachine.context= context
+    @substate = Array.new
+    @transitions = Array.new
+    @history_states = Array.new
+    @history_target = Array.new
+    @history_state = nil
+    @history = false
+    @is_parallel = false
+    @scxml_state = false
+    @parallel_state = Array.new
+  end
+
+  def build_from_scxml(filename)
+    source = File.new filename
+    Document.parse_stream(source, self)
+    @statemachine.reset
+	return @statemachine
+  end
+
+  # parses scxml directly from string parameter stringbuffer
+  def build_from_scxml_string(stringbuffer)
+    Document.parse_stream(stringbuffer, self)
+    @statemachine.reset
+    return @statemachine
+  end
+
+  def tag_start(name, attributes)
+    case name
+      when 'scxml'
+        if attributes['name']
+          @scxml_state = true
+          state = nil
+          @current_state = State.new
+          @current_state.id = attributes['name']
+          @current_state.initial = attributes['initial']
+          state = Statemachine::SuperstateBuilder.new(attributes['name'].to_sym, @subject, @statemachine)
+          if (@current_state.initial != nil)
+            state.startstate(@current_state.initial.to_sym)
+          end
+          @state.push(state)
+        end
+      when 'parallel'
+        @parallel = Statemachine::ParallelStateBuilder.new(attributes['id'].to_sym, @subject, @statemachine)
+        @is_parallel = true
+        # If there is a state that encapsulates the parallel state, change it to a superstate
+        if (not @state.empty? and @state.last.is_a? Statemachine::StateBuilder)
+              state = Statemachine::SuperstateBuilder.new(@state.last.subject.id, @state.last.subject.superstate, @state.last.subject.statemachine)
+              @state.pop            # pops the old one
+              @state.push(state)    # pushes the new one
+        end
+      when 'state'
+        @current_state = State.new
+        @current_state.id = attributes['id']
+        @current_state.initial = attributes['initial']
+        if (@state.empty?)  # It is not a substate
+           if (@current_state.initial != nil) # AND it is a superstate
+             state = Statemachine::SuperstateBuilder.new(attributes['id'].to_sym, @subject, @statemachine)
+             state.startstate(@current_state.initial.to_sym)
+           else  # AND it is a state
+             state = Statemachine::StateBuilder.new(attributes['id'].to_sym, @subject, @statemachine)
+           end
+        else # It is a substate
+          if (@current_state.initial != nil) # AND it is a superstate
+            state = Statemachine::SuperstateBuilder.new(attributes['id'].to_sym, @state.last.subject, @statemachine)
+            state.startstate(@current_state.initial.to_sym)
+          else # AND it is a subsubstate
+            if (@state.last.is_a? Statemachine::StateBuilder) # but it's parent is not a superstate yet
+              state = Statemachine::SuperstateBuilder.new(@state.last.subject.id, @state.last.subject.superstate, @state.last.subject.statemachine)
+              @state.pop            # pops the old one
+              @state.push(state)    # pushes the new one
+              if @is_parallel
+                 @parallel_state.pop
+                 @parallel_state.push(state)
+              end
+            end
+            state = Statemachine::StateBuilder.new(attributes['id'].to_sym, @state.last.subject, @statemachine)
+          end
+        end
+        @state.push(state)
+        @parallel_state.push(state) if @is_parallel
+      when 'transition'
+        @current_transition = Transition.new
+        @current_transition.event = attributes['event']
+        @current_transition.target = attributes['target']
+        if attributes['cond']
+          @current_transition.cond = attributes['cond']
+        else
+          @current_transition.cond = true
+        end
+        @transitions.push(@current_transition)
+      when 'onentry'
+      when 'onexit'
+      when 'history'
+        @history=true
+        @history_states.push(@state.last.subject.id)
+        @history_state = @state.last.subject.id
+      when 'log'
+        @actions.push(["log", attributes['expr']])
+      when 'send'
+        @actions.push(["send", attributes['target'], attributes['event']])
+      when 'invoke'
+        @actions.push(["invoke", attributes['src'].to_sym])
+      else
+        @current_element = name
+      end
+  end
+
+  def tag_end(name)
+    case name
+      when 'parallel'
+        @statemachine.add_state(@parallel.subject)
+        @is_parallel = false
+      when 'state'
+        if (@state.last.is_a? Statemachine::SuperstateBuilder)
+          s = statemachine.get_state(@state.last.subject.id)
+
+          # Changing the state's id
+          if (s.id == @history_state)
+            s.id = (s.id.to_s + "_H").to_sym
+            s.default_history=@history_target.last.to_sym
+            @history_target.pop
+          end
+
+          # Adds the superstate's transitions to all its substates
+          @substate.each{|j|
+            if (s)
+              s1 = statemachine.get_state(j.subject.id)
+              s.transitions.each {|v,k|
+                if (s1)
+                  s1.add(k)
+                end
+              }
+            end
+          }
+        end
+        # In case of parallel statemachines the outmost states will become parallel statemachines
+        # only considering parallel on a root level
+
+        if @parallel_state.size == 1 and @parallel.is_a? Statemachine::ParallelStateBuilder
+          statemachine_aux = Statemachine::Statemachine.new(@parallel_state.last.subject)
+          @substate.each do |j|
+            statemachine_aux.add_state(j.subject)
+            @statemachine.remove_state(j.subject)
+          end
+          statemachine_aux.reset
+          @parallel.subject.add_statemachine(statemachine_aux)
+        end
+        @substate.push(@state.last)
+
+        if (@state.size == 1 and not @scxml_state) or (@state.size == 2 and @scxml_state) or (@parallel_state.size == 1)
+          @substate = []
+          # TODO make this better. Too inefficient
+          while (!(@history_states.size == 0))
+            # change every transitions where @history_states.last was the target state to history_states.last+"_H"
+            # for every history state
+            @statemachine.states.each_value do |s|
+               s.transitions.each_value do |t|
+                 if (t.destination_id == @history_states.last)
+                   t.destination_id = (t.destination_id.to_s + "_H").to_s
+                 end
+               end
+            end
+            @history_states.pop
+          end
+        end
+        @state.pop
+        @parallel_state.pop if @is_parallel
+      when 'transition'
+        if (@transitions.last.event == nil)
+          if @history
+            @history_target.push(@transitions.last.target)
+            @history = false
+          else
+            # TODO spontaneous transitions
+          end
+        else
+          if (@transitions.last.target != nil)     # if it has a target state
+            @state.last.event(@transitions.last.event.to_sym, @transitions.last.target.to_sym, @actions, @transitions.last.cond)
+          else                                     # it is its own target state
+            @state.last.event(@transitions.last.event.to_sym, @state.last.subject.id.to_sym, @actions, @transitions.last.cond)
+          end
+        end
+        @actions=[]
+        @transitions.pop
+      when 'onentry'
+        @state.last.on_entry(@actions)
+        @actions=[]
+      when 'onexit'
+        @state.last.on_exit(@actions)
+        @actions=[]
+      when 'history'
+        @history = false
+    end
+  end
+
+  def xmldecl(version, encoding, standalone)
+  end
+end

data/spec/atm_spec.rb

@@ -0,0 +1,69 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe 'ATM' do
+  before (:each) do
+        
+    @atm = Statemachine.build do
+      startstate :ocioso
+      superstate :operando do
+        state :esperando_senha do
+          event :senha, :senha_inserida
+          on_entry Proc.new{puts "Digite a senha"}
+        end
+        state :senha_inserida do
+          event :senha_errada, :esperando_senha, Proc.new {puts "Senha incorreta.";true}
+          event :senha_correta, :esperando_opcao
+          on_entry :verifica_senha
+        end
+        state :esperando_opcao do
+          event :opcao, :opcao_escolhida
+          on_entry Proc.new{puts "Digite a sua escolha"}
+        end
+        state :opcao_escolhida do
+          event :saldo, :exibindo_saldo
+          event :saque, :emitindo_quantia 
+          event :invalida, :esperando_opcao
+          on_entry :verifica_escolha
+        end
+        state :exibindo_saldo do
+          event :nova_opcao, :esperando_opcao
+          on_entry :saldo
+          
+        end
+        state :emitindo_quantia do
+          event :nova_opcao, :esperando_opcao
+          on_entry :emitindo
+        end
+        
+        event :cancelar, :ocioso, Proc.new {puts "Saindo...";true}
+      end
+
+      state :ocioso do
+        event :cartao, :esperando_senha
+        event :cancelar, :ocioso
+      end
+      stub_context :verbose => true # this is an nternal  verbose stub context from statemachine that prints out action invocations.
+    end
+    
+    # uncomment the next line to start testing your code 
+    # @atm = Statemachine.build_from_scxml "testmachines/atm_enhanced.xml" 
+  end
+
+  it "should start with the correct state >ocioso<" do
+   @atm.state.should equal(:ocioso)
+  end
+  
+  it "should support transitions" do
+    @atm.cartao
+    @atm.state.should==:esperando_senha
+    @atm.senha
+    @atm.state.should==:senha_inserida
+    @atm.senha_errada
+    @atm.state.should==:esperando_senha
+    @atm.senha
+    @atm.senha_correta
+    @atm.opcao
+    @atm.state.should==:opcao_escolhida
+  end
+end
+