ruote 0.9.18 → 0.9.19

data/lib/openwfe/expressions/fe_sequence.rb

@@ -42,76 +42,86 @@ require 'openwfe/expressions/flowexpression'
 
 module OpenWFE
 
-    #
-    # This expression sequentially executes each of its children expression.
-    # For a more sophisticated version of it, see the 'cursor' expression
-    # (fe_cursor.rb).
-    #
-    #     <sequence>
-    #         <participant ref="alice" />
-    #         <participant ref="service_b" />
-    #     </sequence>
-    #
-    # In a Ruby process definition, it looks like :
-    #
-    #     sequence do
-    #         participant "alice"
-    #         participant "service_b"
-    #     end
-    #
-    class SequenceExpression < FlowExpression
-
-        names :sequence
-
-
-        def apply (workitem)
-
-            reply workitem
-        end
+  #
+  # This expression sequentially executes each of its children expression.
+  # For a more sophisticated version of it, see the 'cursor' expression
+  # (fe_cursor.rb).
+  #
+  #   <sequence>
+  #     <participant ref="alice" />
+  #     <participant ref="service_b" />
+  #   </sequence>
+  #
+  # In a Ruby process definition, it looks like :
+  #
+  #   sequence do
+  #     participant "alice"
+  #     participant "service_b"
+  #   end
+  #
+  class SequenceExpression < FlowExpression
+
+    names :sequence
+
+
+    def apply (workitem)
+
+      reply workitem
+    end
 
-        def reply (workitem)
+    def reply (workitem)
 
-            cfei = next_child workitem.fei
+      cfei = next_child workitem.fei
 
-            return reply_to_parent(workitem) \
-                unless cfei
+      return reply_to_parent(workitem) \
+        unless cfei
 
-            #ldebug do
-            #    "reply() self : \n#{self.to_s}\n" +
-            #    "reply() next is #{@current_child_id} : #{cfei.to_debug_s}"
-            #end
+      #ldebug do
+      #  "reply() self : \n#{self.to_s}\n" +
+      #  "reply() next is #{@current_child_id} : #{cfei.to_debug_s}"
+      #end
 
-            get_expression_pool.apply cfei, workitem
-        end
+      get_expression_pool.apply cfei, workitem
+    end
 
-        protected
+    protected
 
-            #
-            # Returns the flowExpressionId of the next child to apply, or
-            # nil if the sequence is over.
-            #
-            def next_child (current_fei)
+      #
+      # Returns the flowExpressionId of the next child to apply, or
+      # nil if the sequence is over.
+      #
+      def next_child (current_fei)
 
-                next_id = if (current_fei == self.fei)
-                    0
-                else
-                    @children.index(current_fei) + 1
-                end
+        # using @current_id as 'memo' of the current position
 
-                loop do
+        @current_id = nil \
+          if @current_id and (@children[@current_id] != current_fei)
+            #
+            # the list of children changed, forget the current position
+            # will have to redetermine it ...
+
+        @current_id = if @current_id
+          @current_id + 1
+        elsif current_fei == self.fei
+          0
+        else
+          @children.index(current_fei) + 1
+        end
 
-                    break if next_id >= @children.length
+        loop do
 
-                    child = @children[next_id]
+          break if @current_id >= @children.length
 
-                    return child if child.is_a?(FlowExpressionId)
+          child = @children[@current_id]
 
-                    next_id += 1
-                end
+          return child if child.is_a?(FlowExpressionId)
 
-                nil
-            end
-    end
+          @current_id += 1
+        end
+
+        nil
+      end
+  end
 
 end
 

data/lib/openwfe/expressions/fe_set.rb

@@ -45,95 +45,95 @@ require 'openwfe/expressions/value'
 
 module OpenWFE
 
-    #
-    # The 'set' expression is used to set the value of a (process) variable or
-    # a (workitem) field.
-    #
-    #     <set field="price" value="CHF 12.00" />
-    #     <set variable="/stage" value="3" />
-    #     <set variable="/stage" field-value="f_stage" />
-    #     <set field="stamp" value="${r:Time.now.to_i}" />
-    #
-    # (Notice the usage of the dollar notation in the last exemple).
-    #
-    # 'set' expressions may be placed outside of a process-definition body,
-    # they will be evaluated sequentially before the body gets applied
-    # (executed).
-    #
-    # Shorter attributes are OK :
-    #
-    #     <set f="price" val="CHF 12.00" />
-    #     <set v="/stage" val="3" />
-    #     <set v="/stage" field-val="f_stage" />
-    #     <set f="stamp" val="${r:Time.now.to_i}" />
-    #
-    #     set :f => "price", :val => "USD 12.50"
-    #     set :v => "toto", :val => "elvis"
-    #
-    # In case you need the value not to be evaluated if it contains
-    # dollar expressions, you can do
-    #
-    #     set :v => "v0", :val => "my ${template} thing", :escape => true
-    #
-    # to prevent evaluation (i.e. to escape).
-    #
-    class SetValueExpression < FlowExpression
-        include ValueMixin
-
-        is_definition
-
-        names :set
-
-
-        def reply (workitem)
-
-            vkey = lookup_variable_attribute(workitem)
-            fkey = lookup_field_attribute(workitem)
-
-            value = workitem.attributes[FIELD_RESULT]
-
-            #puts "value is '#{value}'"
-
-            if vkey
-                set_variable vkey, value
-            elsif fkey
-                workitem.set_attribute fkey, value
-            else
-                raise "'variable' or 'field' attribute missing from 'set' expression"
-            end
-
-            reply_to_parent(workitem)
-        end
+  #
+  # The 'set' expression is used to set the value of a (process) variable or
+  # a (workitem) field.
+  #
+  #   <set field="price" value="CHF 12.00" />
+  #   <set variable="/stage" value="3" />
+  #   <set variable="/stage" field-value="f_stage" />
+  #   <set field="stamp" value="${r:Time.now.to_i}" />
+  #
+  # (Notice the usage of the dollar notation in the last exemple).
+  #
+  # 'set' expressions may be placed outside of a process-definition body,
+  # they will be evaluated sequentially before the body gets applied
+  # (executed).
+  #
+  # Shorter attributes are OK :
+  #
+  #   <set f="price" val="CHF 12.00" />
+  #   <set v="/stage" val="3" />
+  #   <set v="/stage" field-val="f_stage" />
+  #   <set f="stamp" val="${r:Time.now.to_i}" />
+  #
+  #   set :f => "price", :val => "USD 12.50"
+  #   set :v => "toto", :val => "elvis"
+  #
+  # In case you need the value not to be evaluated if it contains
+  # dollar expressions, you can do
+  #
+  #   set :v => "v0", :val => "my ${template} thing", :escape => true
+  #
+  # to prevent evaluation (i.e. to escape).
+  #
+  class SetValueExpression < FlowExpression
+    include ValueMixin
+
+    is_definition
+
+    names :set
+
+
+    def reply (workitem)
+
+      vkey = lookup_variable_attribute(workitem)
+      fkey = lookup_field_attribute(workitem)
+
+      value = workitem.attributes[FIELD_RESULT]
+
+      #puts "value is '#{value}'"
+
+      if vkey
+        set_variable vkey, value
+      elsif fkey
+        workitem.set_attribute fkey, value
+      else
+        raise "'variable' or 'field' attribute missing from 'set' expression"
+      end
+
+      reply_to_parent(workitem)
     end
+  end
 
-    #
-    # 'unset' removes a field or a variable.
-    #
-    #     unset :field => "price"
-    #     unset :variable => "eval_result"
-    #
-    class UnsetValueExpression < FlowExpression
-        include ValueMixin
+  #
+  # 'unset' removes a field or a variable.
+  #
+  #   unset :field => "price"
+  #   unset :variable => "eval_result"
+  #
+  class UnsetValueExpression < FlowExpression
+    include ValueMixin
 
-        names :unset
+    names :unset
 
 
-        def apply (workitem)
+    def apply (workitem)
 
-            vkey = lookup_variable_attribute(workitem)
-            fkey = lookup_field_attribute(workitem)
+      vkey = lookup_variable_attribute(workitem)
+      fkey = lookup_field_attribute(workitem)
 
-            if vkey
-                delete_variable(vkey)
-            elsif fkey
-                workitem.unset_attribute fkey
-            else
-                raise "attribute 'variable' or 'field' is missing for 'unset' expression"
-            end
+      if vkey
+        delete_variable(vkey)
+      elsif fkey
+        workitem.unset_attribute fkey
+      else
+        raise "attribute 'variable' or 'field' is missing for 'unset' expression"
+      end
 
-            reply_to_parent workitem
-        end
+      reply_to_parent workitem
     end
+  end
 
 end
 

data/lib/openwfe/expressions/fe_sleep.rb

@@ -2,31 +2,31 @@
 #--
 # Copyright (c) 2006-2008, John Mettraux, OpenWFE.org
 # All rights reserved.
-# 
-# Redistribution and use in source and binary forms, with or without 
+#
+# Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
-# 
+#
 # . Redistributions of source code must retain the above copyright notice, this
-#   list of conditions and the following disclaimer.  
-# 
-# . Redistributions in binary form must reproduce the above copyright notice, 
-#   this list of conditions and the following disclaimer in the documentation 
+#   list of conditions and the following disclaimer.
+#
+# . 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.
-# 
+#
 # . 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.
-# 
-# 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 
+#
+# 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.
 #++
 #
@@ -43,124 +43,131 @@ require 'openwfe/expressions/time'
 
 module OpenWFE
 
+  #
+  # The 'sleep' expression expects one attribute, either 'for', either
+  # 'until'.
+  #
+  #   <sequence>
+  #     <sleep for="10m12s" />
+  #     <participant ref="alpha" />
+  #   </sequence>
+  #
+  # will wait for 10 minutes and 12 seconds before sending a workitem
+  # to participant 'alpha'.
+  #
+  # In a Ruby process definition, that might look like :
+  #
+  #   sleep :for => "3m"
+  #   sleep "3m"
+  #     #
+  #     # both meaning 'sleep for 3 minutes'
+  #
+  #   sleep :until => "Mon Dec 03 10:41:58 +0900 2007"
+  #     #
+  #     # sleep until the given point in time
+  #
+  # If the 'until' attribute points to a time in the past, the sleep
+  # expression will simply let the process resume.
+  #
+  # === scheduler tags
+  #
+  # Scheduler tags can be set like this :
+  #
+  #   sleep "10y", :scheduler_tags => "la_belle_au_bois_dormant"
+  #
+  # This is an advanced feature that most users won't need.
+  #
+  class SleepExpression < TimeExpression
+
+    names :sleep
+
+    attr_accessor :awakening_time
+
+    def apply (workitem)
+
+      sfor = lookup_string_attribute(:for, workitem)
+      suntil = lookup_string_attribute(:until, workitem)
+
+      sfor = fetch_text_content(workitem) \
+        if sfor == nil and suntil == nil
+
+      #ldebug { "apply() sfor is '#{sfor}'" }
+      #ldebug { "apply() suntil is '#{suntil}'" }
+
+      tuntil = nil
+
+      if suntil
+
+        tuntil = suntil
+
+      elsif sfor
+
+        tfor = Rufus::parse_time_string(sfor)
+        #ldebug { "apply() tfor is '#{tfor}'" }
+        tuntil = Time.new.to_f + tfor
+      end
+
+      #ldebug { "apply() tuntil is '#{tuntil}'" }
+
+      return reply_to_parent(workitem) \
+        if not tuntil
+
+      @awakening_time = tuntil
+      @applied_workitem = workitem.dup
+
+      determine_scheduler_tags
+
+      reschedule(get_scheduler)
+    end
+
     #
-    # The 'sleep' expression expects one attribute, either 'for', either
-    # 'until'.
-    #
-    #     <sequence>
-    #         <sleep for="10m12s" />
-    #         <participant ref="alpha" />
-    #     </sequence>
-    #
-    # will wait for 10 minutes and 12 seconds before sending a workitem
-    # to participant 'alpha'.
-    #
-    # In a Ruby process definition, that might look like :
-    #
-    #     sleep :for => "3m"
-    #     sleep "3m"
-    #         #
-    #         # both meaning 'sleep for 3 minutes'
-    #
-    #     sleep :until => "Mon Dec 03 10:41:58 +0900 2007"
-    #         #
-    #         # sleep until the given point in time
-    #
-    # If the 'until' attribute points to a time in the past, the sleep
-    # expression will simply let the process resume.
-    # 
+    # This is the method called by the Scheduler instance attached to
+    # the workflow engine when the 'sleep' of this expression is
+    # over
     #
-    class SleepExpression < TimeExpression
-
-        names :sleep
-
-        attr_accessor :awakening_time
-
-        def apply (workitem)
+    def trigger (params)
 
-            sfor = lookup_string_attribute(:for, workitem)
-            suntil = lookup_string_attribute(:until, workitem)
+      ldebug do
+        "trigger() #{@fei.to_debug_s} waking up (#{Time.new.to_f}) "+
+        "(scheduler #{get_scheduler.object_id})"
+      end
 
-            sfor = fetch_text_content(workitem) \
-                if sfor == nil and suntil == nil
-
-            #ldebug { "apply() sfor is '#{sfor}'" }
-            #ldebug { "apply() suntil is '#{suntil}'" }
-
-            tuntil = nil
-
-            if suntil
-
-                tuntil = suntil
-
-            elsif sfor
-
-                tfor = Rufus::parse_time_string(sfor)
-                #ldebug { "apply() tfor is '#{tfor}'" }
-                tuntil = Time.new.to_f + tfor
-            end
-
-            #ldebug { "apply() tuntil is '#{tuntil}'" }
-
-            return reply_to_parent(workitem) \
-                if not tuntil
-
-            @awakening_time = tuntil
-            @applied_workitem = workitem.dup
-
-            determine_scheduler_tags
-
-            reschedule(get_scheduler)
-        end
-
-        #
-        # This is the method called by the Scheduler instance attached to
-        # the workflow engine when the 'sleep' of this expression is 
-        # over
-        #
-        def trigger (params)
-
-            ldebug do 
-                "trigger() #{@fei.to_debug_s} waking up (#{Time.new.to_f}) "+
-                "(scheduler #{get_scheduler.object_id})"
-            end
+      reply_to_parent(@applied_workitem)
+    end
 
-            reply_to_parent(@applied_workitem)
-        end
+    #
+    # [Re]schedules this expression, effectively registering it within
+    # the scheduler.
+    # This method is called when the expression is applied and each
+    # time the owning engine restarts.
+    #
+    def reschedule (scheduler)
 
-        #
-        # [Re]schedules this expression, effectively registering it within
-        # the scheduler.
-        # This method is called when the expression is applied and each
-        # time the owning engine restarts.
-        #
-        def reschedule (scheduler)
+      return unless @awakening_time
 
-            return unless @awakening_time
+      ldebug do
+        "[re]schedule() " +
+        "will sleep until '#{@awakening_time}' " +
+        "(#{Rufus::to_iso8601_date(@awakening_time)})"
+      end
 
-            ldebug do 
-                "[re]schedule() " + 
-                "will sleep until '#{@awakening_time}' " +
-                "(#{Rufus::to_iso8601_date(@awakening_time)})"
-            end
+      @scheduler_job_id = "sleep_#{self.fei.to_s}"
 
-            @scheduler_job_id = "sleep_#{self.fei.to_s}"
-            
-            scheduler.schedule_at(
-                @awakening_time,
-                { 
-                    :schedulable => self, 
-                    :job_id => @scheduler_job_id,
-                    :tags => @scheduler_tags })
+      scheduler.schedule_at(
+        @awakening_time,
+        {
+          :schedulable => self,
+          :job_id => @scheduler_job_id,
+          :tags => @scheduler_tags })
 
-            ldebug do 
-                "[re]schedule() @scheduler_job_id is '#{@scheduler_job_id}' "+
-                " (scheduler #{scheduler.object_id})"
-            end
+      ldebug do
+        "[re]schedule() @scheduler_job_id is '#{@scheduler_job_id}' "+
+        " (scheduler #{scheduler.object_id})"
+      end
 
-            store_itself
-        end
+      store_itself
     end
+  end
 
 end