MINT-scxml 1.1.0 → 1.1.2

data/Gemfile

@@ -1,5 +1,5 @@
 source :rubygems
-gem "MINT-statemachine","1.3.0"
+gem "MINT-statemachine", "1.3.2"
 gem "rspec","2.8.0"
 gem "rake","0.9.2"
 gem "hoe", "2.9.6"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    MINT-statemachine (1.3.0)
+    MINT-statemachine (1.3.2)
     diff-lcs (1.1.3)
     hoe (2.9.6)
       rake (~> 0.8)
@@ -20,7 +20,7 @@ PLATFORMS
   x86-mingw32
 
 DEPENDENCIES
-  MINT-statemachine (= 1.3.0)
+  MINT-statemachine (= 1.3.2)
   hoe (= 2.9.6)
   rake (= 0.9.2)
   rspec (= 2.8.0)

data/History.txt

@@ -1,3 +1,12 @@
+=== 1.1.2 / 2013-02-28
+
+* Another bugfix for spontaneous transitions to parallel states, now depends on MINT-statemachine version 1.3.2
+* improved documentation
+
+=== 1.1.1 / 2013-02-26
+
+* Bugfix for spontaneous transitions to parallel states.
+
 === 1.1.0 / 2012-11-20
 
 * (Sebastian) fixed bug: root statemachine was wrongly set for states that are nested inside parallel

data/README.rdoc

@@ -4,36 +4,63 @@
 
 == DESCRIPTION:
 
-This gem implements a state chart XML (SCXML) parser that generates a ruby statemachine.
+This gem implements all core constucts of the state chart XML (SCXML) specification of the W3C.
+(http://www.w3.org/TR/scxml/)
+
+Instead of implementing an interpreter, this gem implements a parser that create a ruby statemachine instance based
+on the MINT-statemachine gem (https://github.com/sfeu/statemachine).
 
 == FEATURES/PROBLEMS:
 
-* Currently only supports the very basic set of SCXML
+We currently do not support the definition of a data model. Instead the ruby class that contains the statemachine
+instance can be used to store data. Conditions can be defined using ruby inside the SCXML definition and member
+functionc can be called using SCXML script or invoke.
+
+== EXAMPLE:
+
+Parses an SCXML string and creates a statemachine instance in @sm. The messenger object
+can be used to capture the SCXML log messenges (using the log statement).
+
+    @messenger = mock("messenger" )
+
+    parser = StatemachineParser.new(nil,@messenger)
+
+    scxml = <<EOS
+ <scxml name="SCXML" xmlns="http://www.w3.org/2005/07/scxml">
+  <state id="state1">
+     <transition event="event1" target="state2"/>
+     <transition event="event4" target="state2">
+        <log expr="transition executing"/>
+     </transition>
+  </state>
 
-== SYNOPSIS:
+  <state id="state2">
+     <transition event="event2" target="state3"/>
+  </state>
+
+  <state id="state3">
+     <transition event="event3" target="state1"/>
+  </state>
+  </scxml>
+ EOS
+
+          @sm = parser.build_from_scxml_string scxml
+          @sm.reset
 
   See tests
 
 == REQUIREMENTS:
 
-* Depends on MINT-statemachine gem
+* Depends on MINT-statemachine gem (https://github.com/sfeu/statemachine)
 
 == 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-2012 Sebastian Feuerstack, Jessica H. Colnago
+Copyright (C) 2010-2013 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

data/lib/MINT-scxml.rb

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

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

@@ -19,27 +19,59 @@ class StatemachineParser < Statemachine::StatemachineBuilder
 
   def initialize(context = nil, logger = nil, queue = nil)
     super()
-    @current_transition = nil
-    @current_state = nil
-    @current_element = nil
-    @parallel = nil
-    @history_state = nil
+
     @statemachine.messenger = logger
     @statemachine.message_queue = queue
     @statemachine.context= context
-    @actions = Array.new
+
+    # The current variables are used to temporarily store the value of the _"type"
+    # in order to acquire the necessary data before adding the to its proper stack
+    @current_transition = nil
+    @current_state = nil
+    @current_element = nil
+
+    # Stacks
+    # These stacks (created as Arrays but used as stacks: push & pop) are used
+    # to store and treat the structure of the scxml file read.
+    # Some require auxiliary stacks due to the necessity of different treatments
+    # in different situations (e.g.: substate_aux is necessary due to the fact that
+    # a parallel state's superstate can have substates that would only be treated when
+    # the superstate is closed, which only happens after the parallel state is treated.
+    # Which in turn can have its own set of substates).
+    # Obs: These variables are used as stacks due to two basic situations: the ability of
+    #      nested elements in statemachines and the need to create a single structure to be
+    #      passed to element's constructors.
+    @actions = Array.new            # stores the actions to later be added to the transition they belong.
     @actions_aux = Array.new
-    @state = Array.new
-    @substate = Array.new
-    @transitions = Array.new
+    @state = Array.new              # stores the order of nested states to be treated and used further on.
+    @substate = Array.new           # similar to state, it stores the substates in order to later be added
+                                    # and have the proper transition treatment related to its parent state
+    @substate_aux = Array.new
+    @transitions = Array.new        # stores the transitions in order to be later added to its proper state.
+          # so on and so forth.
+    @parallel_state = Array.new
     @history_states = Array.new
     @history_target = Array.new
-    @parallel_state = Array.new
+
+    # These variables are used to store the value of the element that gives its
+    # name in order to be used as parameters or "situation check" in future parts
+    # of the parser.
+    @parallel = nil
+    @history_state = nil
+
+    # These variables are used to help in the creation of actions that have if clauses.
     @if_actions = Array.new
     @if_actions_aux = Array.new
     @if = Array.new
     @tag = Array.new
     @cond = Array.new
+
+    # These boolean variables are used to determine in which case we are on
+    # so to treat each case properly.
+    #   If a history state was read, if inside a parallel state and if it has
+    #   an outermost scxml_state (the latter implicates on different treatments due
+    #   to the fact that it is added to the states stack and therefore it might not be
+    #   empty as expected in certain situations)
     @history = false
     @is_parallel = false
     @scxml_state = false
@@ -104,6 +136,11 @@ class StatemachineParser < Statemachine::StatemachineBuilder
         end
       when 'parallel'
         @is_parallel = true
+        # If the parent superstate of the parallel state has substates, save them for later
+        if not @substate.empty?
+          @substate_aux = @substate
+          @substate = []
+        end
         # 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)
@@ -237,6 +274,8 @@ class StatemachineParser < Statemachine::StatemachineBuilder
       when 'parallel'
         @statemachine.add_state(@parallel.subject)
         @is_parallel = false
+        @substate = @substate_aux
+        @substate_aux = []
       when 'state'
         if @state.last.is_a? Statemachine::SuperstateBuilder
           s = statemachine.get_state(@state.last.subject.id)

data/spec/parser_spec.rb

@@ -644,7 +644,112 @@ EOS
             @sm.disconnect
             @log.should=="Goodbye cruel world!"
           end
+
+
+        end
+      end
+    end
+
+    describe "with spontaneous transitions to parallel states" do
+      it "should enter using spontaneous transitions " do
+
+        class ActivationCallback
+          attr_reader :called
+          attr_reader :new_states
+          attr_reader :abstract_states
+          attr_reader :atomic_states
+
+          def initialize
+            @called = []
+            @new_states = []
+            @abstract_states = []
+            @atomic_states =[]
+
+          end
+          def activate(new_states,abstract_states, atomic_states)
+            @called << true
+            @new_states<<  new_states
+            @abstract_states << abstract_states
+            @atomic_states <<  atomic_states
+            puts "activate #{@new_states.last} #{@abstract_states.last} #{@atomic_states.last}"
+          end
         end
+
+        @callback = ActivationCallback.new
+
+
+        def isInstant?
+          true
+        end
+
+        def isContinuous?
+          true
+        end
+
+        def isOnChange?
+          false
+        end
+
+        def evaluate
+          true
+        end
+        parser = StatemachineParser.new(nil,nil)
+
+        scxml = <<EOS
+<scxml initial="inactive" name="StateObservation" version="0.9" xmlns="http://www.w3.org/2005/07/scxml"><!--   node-size-and-position x=0.0 y=0.0 w=868.0 h=725.0  -->
+  <state id="inactive"><!--   node-size-and-position x=180.0 y=40.0 w=80.0 h=50.0  -->
+    <transition event="start" target="active"><!--   edge-path [active]  x=170.0 y=120.0 pointx=0.0 pointy=-29.0 offsetx=-12.0 offsety=14.0  --></transition>
+  </state>
+  <state id="active" initial="init"><!--   node-size-and-position x=160.0 y=140.0 w=610.0 h=450.0  -->
+    <transition event="stop" target="inactive"></transition>
+    <state id="init"><!--   node-size-and-position x=20.0 y=30.0 w=60.0 h=40.0  -->
+      <transition cond="isInstant? or isContinuous?" target="instant_evaluation">
+        <script>evaluate</script>
+      </transition>
+      <transition cond="isOnChange?" target="subscribing"></transition>
+    </state>
+    <state id="instant_evaluation"><!--   node-size-and-position x=180.0 y=30.0 w=130.0 h=40.0  -->
+      <transition cond="(not @result.nil?) and @result.length&gt;0" target="true">
+        <invoke src="@varmap.merge! @result" type="x-mint"></invoke>
+      </transition>
+      <transition cond="@result.nil?" target="false"></transition>
+    </state>
+    <parallel id="running"><!--   node-size-and-position x=40.0 y=130.0 w=480.0 h=300.0  -->
+      <state id="result" initial="false"><!--   node-size-and-position x=200.0 y=60.0 w=270.0 h=90.0  -->
+        <state id="true"><!--   node-size-and-position x=170.0 y=40.0 w=50.0 h=30.0  -->
+          <transition event="false" target="false"></transition>
+        </state>
+        <state id="false"><!--   node-size-and-position x=10.0 y=40.0 w=80.0 h=30.0  -->
+          <transition event="true" target="true"><!--   edge-path [true]  x=130.0 y=40.0 pointx=0.0 pointy=14.0 offsetx=17.0 offsety=4.0  --></transition>
+        </state>
+      </state>
+      <state id="subscription" initial="check"><!--   node-size-and-position x=30.0 y=40.0 w=150.0 h=250.0  -->
+        <state id="subscribing"><!--   node-size-and-position x=40.0 y=110.0 w=80.0 h=40.0  -->
+          <onentry>@subscribed=true</onentry>
+          <transition event="subscribed" target="subscribed"></transition>
+        </state>
+        <state id="subscribed"><!--   node-size-and-position x=40.0 y=190.0 w=80.0 h=40.0  --></state>
+        <state id="check"><!--   node-size-and-position x=40.0 y=30.0 w=80.0 h=40.0  -->
+          <transition cond="isOnChange? or isContinuous?" target="subscribing"></transition>
+        </state>
+      </state>
+    </parallel>
+  </state>
+</scxml>
+EOS
+
+        @sm = parser.build_from_scxml_string scxml
+        @sm.reset
+        @sm.activation=@callback.method(:activate)
+        @sm.context = self
+        @sm.start
+
+        @callback.called.length.should == 4
+
+        @callback.new_states[0].should == [:active,:init]
+        @callback.new_states[1].should == [:instant_evaluation]
+        @callback.new_states[2].should == [:running, :result, :subscription, :false, :check]
+        @callback.new_states[3].should == [:subscribing]
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: MINT-scxml
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-20 00:00:00.000000000Z
+date: 2013-02-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: MINT-statemachine
-  requirement: &73711550 !ruby/object:Gem::Requirement
+  requirement: &87413670 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,49 +21,25 @@ dependencies:
         version: 1.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *73711550
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: &73710560 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.10'
-  type: :development
-  prerelease: false
-  version_requirements: *73710560
-- !ruby/object:Gem::Dependency
-  name: newgem
-  requirement: &73710050 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.5.3
-  type: :development
-  prerelease: false
-  version_requirements: *73710050
+  version_requirements: *87413670
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &73709310 !ruby/object:Gem::Requirement
+  requirement: &87413430 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '2.9'
   type: :development
   prerelease: false
-  version_requirements: *73709310
-description: This gem implements a state chart XML (SCXML) parser that generates a
-  ruby statemachine.
+  version_requirements: *87413430
+description: ''
 email: Sebastian@Feuerstack.org
 executables: []
 extensions: []
 extra_rdoc_files:
 - History.txt
 - Manifest.txt
-- README.rdoc
 files:
 - Gemfile
 - Gemfile.lock
@@ -102,12 +78,12 @@ files:
 - statemachines/specs/AISingleChoiceElement_spec.rb
 - statemachines/specs/AISingleChoice_spec.rb
 - .gemtest
-homepage: http://www.multi-access.de
+homepage: 
 licenses: []
 post_install_message: 
 rdoc_options:
 - --main
-- README.rdoc
+- README.txt
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -116,6 +92,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -834397197
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -127,6 +106,5 @@ rubyforge_project: MINT-scxml
 rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
-summary: This gem implements a state chart XML (SCXML) parser that generates a ruby
-  statemachine.
+summary: ''
 test_files: []