ruote 0.9.19 → 0.9.20

data/lib/openwfe/expressions/fe_iterator.rb

@@ -1,41 +1,27 @@
-#
 #--
-# Copyright (c) 2007-2008, John Mettraux, OpenWFE.org
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
+# Copyright (c) 2007-2009, John Mettraux, jmettraux@gmail.com
 #
-# . Redistributions of source code must retain the above copyright notice, this
-#   list of conditions and the following disclaimer.
+# 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:
 #
-# . Redistributions in binary form must reproduce the above copyright notice,
-#   this list of conditions and the following disclaimer in the documentation
-#   and/or other materials provided with the distribution.
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
 #
-# . Neither the name of the "OpenWFE" nor the names of its contributors may be
-#   used to endorse or promote products derived from this software without
-#   specific prior written permission.
+# 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.
 #
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-# POSSIBILITY OF SUCH DAMAGE.
+# Made in Japan.
 #++
-#
 
-#
-# "made in Japan"
-#
-# John Mettraux at openwfe.org
-#
 
 require 'openwfe/expressions/flowexpression'
 require 'openwfe/expressions/iterator'
@@ -78,8 +64,6 @@ module OpenWFE
 
     names :iterator
 
-    uses_template
-
     #
     # an Iterator instance that holds the list of values being iterated
     # upon.
@@ -88,20 +72,18 @@ module OpenWFE
 
     def apply (workitem)
 
-      return reply_to_parent(workitem) \
-        if raw_children.length < 1
+      return reply_to_parent(workitem) if has_no_expression_child
 
       @iterator = Iterator.new(self, workitem)
 
-      return reply_to_parent(workitem) \
-        if @iterator.size < 1
+      return reply_to_parent(workitem) if @iterator.size < 1
 
-      reply workitem
+      reply(workitem)
     end
 
     def reply (workitem)
 
-      command, step = determine_command_and_step workitem
+      command, step = determine_command_and_step(workitem)
 
       vars = if not command
 
@@ -134,10 +116,11 @@ module OpenWFE
         raw_children.first,
         @iterator.index,
         workitem,
-        true, # registering child
-        vars)
+        :register_child => true,
+        :variables => vars)
 
-      store_itself
+      #store_itself
+        # now done in tlaunch_child()
     end
   end
 

data/lib/openwfe/expressions/fe_listen.rb

@@ -1,41 +1,27 @@
-#
 #--
-# Copyright (c) 2007-2008, John Mettraux, OpenWFE.org
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
+# Copyright (c) 2007-2009, John Mettraux, jmettraux@gmail.com
 #
-# . Redistributions of source code must retain the above copyright notice, this
-#   list of conditions and the following disclaimer.
+# 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:
 #
-# . Redistributions in binary form must reproduce the above copyright notice,
-#   this list of conditions and the following disclaimer in the documentation
-#   and/or other materials provided with the distribution.
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
 #
-# . Neither the name of the "OpenWFE" nor the names of its contributors may be
-#   used to endorse or promote products derived from this software without
-#   specific prior written permission.
+# 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.
 #
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-# POSSIBILITY OF SUCH DAMAGE.
+# Made in Japan.
 #++
-#
 
-#
-# "made in Japan"
-#
-# John Mettraux at openwfe.org
-#
 
 require 'openwfe/expressions/merge'
 require 'openwfe/expressions/timeout'
@@ -46,17 +32,8 @@ require 'openwfe/expressions/flowexpression'
 module OpenWFE
 
   #
-  # The "listen" expression can be viewed in two ways :
-  #
-  # 1)
-  # It's a hook into the participant map to intercept apply or reply
-  # operations on participants.
-  #
-  # 2)
-  # It allows OpenWFE[ru] to be a bit closer to the 'ideal' process-calculus
-  # world (http://en.wikipedia.org/wiki/Process_calculi)
-  #
-  # Anyway...
+  # An expression for listening to participant activity in the engine
+  # (across process instances).
   #
   #   <listen to="alice">
   #     <subprocess ref="notify_bob" />
@@ -118,7 +95,7 @@ module OpenWFE
   # method) workitems that don't belong to a process intance (ie workitems
   # that have a nil flow_expression_id). So it's entirely feasible to
   # send 'notifications only' workitems to the OpenWFEru engine.
-  # (see http://openwferu.rubyforge.org/svn/trunk/openwfe-ruby/test/ft_54b_listen.rb)
+  # (see http://github.com/jmettraux/ruote/tree/master/test/ft_54b_listen.rb)
   #
   # This expression has been aliased 'intercept'
   # and 'receive'. It also accepts the 'on' parameter as an alias parameter
@@ -129,6 +106,10 @@ module OpenWFE
   # with a copy of the workitem that 'applied' (activated) the listen
   # expression.
   #
+  # Since Ruote 0.9.20, a 'wfid' attribute is available. When set to :current
+  # or 'current', it indicates that the listen is only concerned with the
+  # current process instance. It's handy for defining intra process listens.
+  #
   class ListenExpression < FlowExpression
     include TimeoutMixin
     include ConditionMixin
@@ -136,8 +117,6 @@ module OpenWFE
 
     names :listen, :intercept, :receive
 
-    uses_template
-
     #
     # the channel on which this expression 'listens'
     #
@@ -175,56 +154,49 @@ module OpenWFE
 
     def apply (workitem)
 
-      #if @children.size < 1
-      #  reply_to_parent workitem
-      #  return
-      #end
-        #
-        # 'listen' now blocks if there is no children
+      #return reply_to_parent(workitem) if has_no_expression_child
+        # 'listen' blocks if there is no children
 
-      @participant_regex = lookup_string_attribute(:to, workitem)
+      #
+      # participant regex
 
-      @participant_regex = lookup_string_attribute(:on, workitem) \
-        unless @participant_regex
+      @participant_regex =
+        lookup_string_attribute(:to, workitem) ||
+        lookup_string_attribute(:on, workitem)
 
       raise "attribute 'to' is missing for expression 'listen'" \
         unless @participant_regex
 
-      ldebug { "apply() listening to '#{@participant_regex}'" }
-
       #
-      # once
+      # wfid
 
-      @once = lookup_boolean_attribute :once, workitem, true
+      @wfid_regex =
+        lookup_string_attribute(:wfid, workitem).to_s.strip == 'current'
 
-      @once = true if raw_children.size < 1
-        # a 'blocking listen' can only get triggered once.
+      #
+      # once
 
-      ldebug { "apply() @once is #{@once}" }
+      @once =
+        has_no_expression_child ||
+        lookup_boolean_attribute(:once, workitem, true)
 
       #
       # merge
 
-      merge = lookup_boolean_attribute :merge, workitem, false
-
-      ldebug { "apply() merge is #{@merge}" }
+      merge = lookup_boolean_attribute(:merge, workitem, false)
 
       @applied_workitem = workitem.dup if merge
 
       #
       # upon
 
-      @upon = lookup_sym_attribute(
-        :upon, workitem, :default => :apply)
-
+      @upon = lookup_sym_attribute(:upon, workitem, :default => :apply)
       @upon = (@upon == :reply) ? :reply : :apply
 
-      ldebug { "apply() @upon is #{@upon}" }
-
       @call_count = 0
 
-      determine_timeout
-      reschedule get_scheduler
+      determine_timeout(nil) # workitem set to nil, no stamp needed.
+      reschedule(get_scheduler)
 
       store_itself
     end
@@ -248,14 +220,13 @@ module OpenWFE
     #
     def trigger (params)
 
-      reply_to_parent workitem
+      reply_to_parent(workitem)
     end
 
     #
     # This is the method called when a 'listenable' workitem comes in
     #
     def call (channel, *args)
-      #synchronize do
 
       upon = args[0]
 
@@ -265,7 +236,18 @@ module OpenWFE
 
       workitem = args[1].dup
 
-      conditional = eval_condition :where, workitem
+      if @wfid_regex
+
+        wfid = workitem.fei.wfid(true)
+
+        if @wfid_regex == true
+          return if wfid != self.fei.wfid(true)
+        else
+          return unless wfid.match(@wfid_regex)
+        end
+      end
+
+      conditional = eval_condition(:where, workitem)
         #
         # note that the values if the incoming workitem (not the
         # workitem at apply time) are used for the evaluation
@@ -291,51 +273,25 @@ module OpenWFE
       #
       # eventual merge
 
-      workitem = merge_workitems @applied_workitem.dup, workitem \
+      workitem = merge_workitems(@applied_workitem.dup, workitem) \
         if @applied_workitem
 
       #
       # reply or launch nested child expression
 
-      return reply_to_parent(workitem) \
-        if raw_children.size < 1
-          #
-          # was just a "blocking listen"
-
-      #parent = @once ? self : nil
-      #get_expression_pool.launch_template(
-      #  parent,
-      #  nil,
-      #  @call_count - 1,
-      #  @children[0],
-      #  workitem,
-      #  nil)
-
-      if @once
-
-        # triggering just once
-
-        get_expression_pool.tlaunch_child(
-          self,
-          raw_children.first,
-          @call_count - 1,
-          workitem,
-          true) # registering child
-
-      else
-
-        # triggering multiple times
-
-        get_expression_pool.tlaunch_orphan(
-          self,
-          raw_children.first,
-          @call_count - 1,
-          workitem,
-          true) # registering child (in case of cancel)
-      end
+      return reply_to_parent(workitem) if has_no_expression_child
+        # was just a "blocking listen"
 
-      store_itself
-      #end
+      get_expression_pool.tlaunch_child(
+        self,
+        raw_children.first,
+        @call_count - 1,
+        workitem,
+        :orphan => (not @once),
+        :register_child => true) # (in case of cancel)
+
+      #store_itself
+        # now done in tlaunch_child()
     end
 
     #
@@ -355,7 +311,7 @@ module OpenWFE
       #
       def start_observing
 
-        get_participant_map.add_observer @participant_regex, self
+        get_participant_map.add_observer(@participant_regex, self)
       end
 
       #
@@ -363,7 +319,7 @@ module OpenWFE
       #
       def stop_observing
 
-        get_participant_map.remove_observer self
+        get_participant_map.remove_observer(self)
       end
   end
 

data/lib/openwfe/expressions/fe_losfor.rb

@@ -1,41 +1,27 @@
-#
 #--
-# Copyright (c) 2006-2008, John Mettraux, OpenWFE.org
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
+# Copyright (c) 2006-2009, John Mettraux, jmettraux@gmail.com
 #
-# . Redistributions of source code must retain the above copyright notice, this
-#   list of conditions and the following disclaimer.
+# 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:
 #
-# . Redistributions in binary form must reproduce the above copyright notice,
-#   this list of conditions and the following disclaimer in the documentation
-#   and/or other materials provided with the distribution.
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
 #
-# . Neither the name of the "OpenWFE" nor the names of its contributors may be
-#   used to endorse or promote products derived from this software without
-#   specific prior written permission.
+# 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.
 #
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-# POSSIBILITY OF SUCH DAMAGE.
+# Made in Japan.
 #++
-#
 
-#
-# "made in Japan"
-#
-# John Mettraux at openwfe.org
-#
 
 require 'openwfe/expressions/flowexpression'
 
@@ -64,18 +50,21 @@ module OpenWFE
 
     def apply (workitem)
 
-      get_expression_pool.apply(children[0], workitem) \
-        if (@children and @children.length > 0)
+      child = first_expression_child
+
+      return unless child
+
+      apply_child(child, workitem)
     end
 
     def reply (workitem)
 
-      get_expression_pool.remove self
+      get_expression_pool.remove(self)
     end
   end
 
   #
-  # This expression triggers its child (in its own thread) and then
+  # This expression triggers its child and then
   # forgets about it. It immediately replies to its parent expression.
   #
   # The brother expression 'lose' triggers its child but never replies to its
@@ -90,16 +79,18 @@ module OpenWFE
 
     def apply (workitem)
 
-      if (@children and @children.length > 0)
-
-        wi = workitem.dup
+      child = first_expression_child
 
-        child = @children[0]
-        get_expression_pool.forget self, child
-        get_expression_pool.apply child, wi
-      end
+      get_expression_pool.tlaunch_child(
+        self,
+        child,
+        raw_children.index(child),
+        workitem.dup,
+        :orphan => true,
+        :dup_environment => true
+      ) if child
 
-      reply_to_parent workitem
+      reply_to_parent(workitem)
     end
 
     def reply (workitem)