lib/openwfe/expressions/fe_cursor.rb in ruote-0.9.19 vs lib/openwfe/expressions/fe_cursor.rb in ruote-0.9.20

@@ -1,45 +1,30 @@
-#
 #--
-# Copyright (c) 2007-2008, John Mettraux, OpenWFE.org
-# All rights reserved.
+# Copyright (c) 2007-2009, John Mettraux, [e-mail]
 #
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
+# 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 of source code must retain the above copyright notice, this
-#   list of conditions and the following disclaimer.
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
 #
-# . 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 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.
 #
-# . 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
-# POSSIBILITY OF SUCH DAMAGE.
+# Made in Japan.
 #++
-#
 
-#
-# "made in Japan"
-#
-# John Mettraux at openwfe.org
-#
 
-require 'openwfe/expressions/condition'
 require 'openwfe/expressions/flowexpression'
 require 'openwfe/expressions/fe_command'
 
 
 module OpenWFE
@@ -70,58 +55,67 @@
   #
   # As you can see, you can directly set the value of the field
   # '\_\_cursor_command__' or use a CursorCommandExpression like 'skip' or
   # 'jump'.
   #
+  # == 'rewind-if' / 'break-if'
+  #
+  # Since Ruote 0.9.20 (december 2008), the 'cursor' (or 'loop') expression
+  # accepts an 'rewind-if' or 'break-if' attribute.
+  #
+  #   Test0 = OpenWFE.process_definition :name => 'ft_9c', :revision => '0' do
+  #     cursor :rewind_if => "${f:restart}" do
+  #       alpha
+  #       bravo
+  #       charly
+  #     end
+  #   end
+  #
+  # This process will be rewound (jump back to 'alpha') if alpha, bravo or
+  # charly set the field 'restart' to 'true'.
+  # (remember to reset the field if you don't want to rewind/break again and
+  # again...)
+  #
+  # Note that 'rewind-unless' and 'break-unless' are understood as well.
+  #
   class CursorExpression < FlowExpression
     include CommandMixin
 
     names :cursor
 
-    uses_template
-
     #
     # the integer identifier for the current loop
     #
     attr_accessor :loop_id
 
     #
     # what is the index of the child we're currently executing
     #
     attr_accessor :current_child_id
 
-    #
-    # keeping track of the current child (if any)
-    #
-    attr_accessor :current_child_fei
 
-
     def apply (workitem)
 
       new_environment
 
       @loop_id = 0
-
       @current_child_id = -1
 
-      reply workitem
+      reply(workitem)
     end
 
     def reply (workitem)
 
-      return reply_to_parent(workitem) \
-        if raw_children.size < 1
-          #
-          # well, currently, no infinite empty loop allowed
+      return reply_to_parent(workitem) if raw_children.size < 1
+        #
+        # well, currently, no infinite empty loop allowed
 
-      command, step = determine_command_and_step workitem
+      command, step = determine_command_and_step(workitem)
 
-      ldebug { "reply() command is '#{command} #{step}'" }
+      #ldebug { "reply() command is '#{command} #{step}'" }
 
-      if command == C_BREAK or command == C_CANCEL
-        return reply_to_parent(workitem)
-      end
+      return reply_to_parent(workitem) if BREAK_COMMANDS.include?(command)
 
       if command == C_REWIND or command == C_CONTINUE
 
         @current_child_id = 0
 
@@ -137,51 +131,32 @@
 
         @current_child_id = @current_child_id + step
 
         @current_child_id = 0 if @current_child_id < 0
 
-        #if @current_child_id >= @children.length
         if @current_child_id >= raw_children.length
 
           return reply_to_parent(workitem) unless is_loop
 
           @loop_id += 1
           @current_child_id = 0
         end
       end
 
-      #template_fei = @children[@current_child_id]
       template = raw_children[@current_child_id]
 
       #
       # launch the next child as a template
 
-      @current_child_fei = get_expression_pool.tlaunch_child(
-        self,
-        template,
-        @current_child_id,
-        workitem,
-        false) # not registering child
+      @children.clear if @children
+      apply_child(@current_child_id, workitem)
 
-      store_itself
+      #store_itself
+        # now done in apply_child()
     end
 
     #
-    # takes care of cancelling the current child if necessary
-    #
-    def cancel
-
-      cfei = current_child_fei
-      get_expression_pool.cancel(cfei) if cfei
-
-      get_expression_pool.cancel(@current_child_fei) \
-        if @current_child_fei
-
-      super
-    end
-
-    #
     # Returns false, the child class LoopExpression does return true.
     #
     def is_loop
 
       false
@@ -208,10 +183,10 @@
   # (notice the _ (underscores) to distinguish the OpenWFEru expressions
   # from the native Ruby ones).
   #
   class LoopExpression < CursorExpression
 
-    names :loop
+    names :loop, :repeat
 
     #
     # Returns true as, well, it's a loop...
     #
     def is_loop