ruote 0.9.19 → 0.9.20

data/lib/openwfe/expressions/fe_cron.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/utils'
 require 'openwfe/expressions/time'
@@ -95,8 +81,6 @@ module OpenWFE
 
     names :cron
 
-    uses_template
-
     #
     # The cron 'tab', something like "0 9-17 * * mon-fri"
     #
@@ -116,28 +100,26 @@ module OpenWFE
 
     def apply (workitem)
 
-      return reply_to_parent(workitem) \
-        if raw_children.size < 1
+      return reply_to_parent(workitem) if has_no_expression_child
 
-      @counter = 0
-      #@engine_cron = false
+      @counter = -1
 
       @applied_workitem = workitem.dup
       @applied_workitem.flow_expression_id = nil
 
-      @tab = lookup_attribute :tab, workitem
-      @every = lookup_attribute :every, workitem
+      @tab = lookup_attribute(:tab, workitem)
+      @every = lookup_attribute(:every, workitem)
 
       determine_scheduler_tags
 
       #
       # schedule self
 
-      reschedule get_scheduler
+      reschedule(get_scheduler)
     end
 
     def reply (workitem)
-      # discard silently... should never get called though
+      # discard silently...
     end
 
     #
@@ -152,32 +134,33 @@ module OpenWFE
       ldebug { "trigger() cron : #{@fei.to_debug_s}" }
 
       #@raw_child.application_context = @application_context
-        # done in expool.launch_template()
+        # done in expool.tlaunch_child()
 
       begin
 
-        #template = @raw_child
-        #template, _fei = get_expression_pool.fetch @children[0]
-        template = raw_children.first
+        @counter += 1
+        store_itself
+          #
+          # note : one variant would be to give Time.now.to_f as a sub_id...
+          # then no need to store...
+          #
+          # but it's good to have a counter to keep track of the number of
+          # executions
 
         child_fei = get_expression_pool.tlaunch_child(
-          self, template, @counter, @applied_workitem.dup, false)
+          self,
+          first_expression_child,
+          @counter,
+          @applied_workitem.dup,
+          :register_child => false)
             #
             # register_child is set to false, cron doesn't keep
             # track of its spawned children
 
-        #
-        # update count and store self
-
-        @counter += 1
-
-        store_itself
-
       rescue
 
         lerror do
-          "trigger() cron caught exception\n"+
-          OpenWFE::exception_to_s($!)
+          "trigger() cron caught exception\n#{OpenWFE::exception_to_s($!)}"
         end
       end
     end

data/lib/openwfe/expressions/fe_cursor.rb

@@ -1,43 +1,28 @@
-#
 #--
-# 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/condition'
 require 'openwfe/expressions/flowexpression'
 require 'openwfe/expressions/fe_command'
 
@@ -72,13 +57,31 @@ module OpenWFE
   # '\_\_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
     #
@@ -89,37 +92,28 @@ module OpenWFE
     #
     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
 
@@ -139,7 +133,6 @@ module OpenWFE
 
         @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
@@ -149,34 +142,16 @@ module OpenWFE
         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
-
-      store_itself
-    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
+      @children.clear if @children
+      apply_child(@current_child_id, workitem)
 
-      super
+      #store_itself
+        # now done in apply_child()
     end
 
     #
@@ -210,7 +185,7 @@ module OpenWFE
   #
   class LoopExpression < CursorExpression
 
-    names :loop
+    names :loop, :repeat
 
     #
     # Returns true as, well, it's a loop...

data/lib/openwfe/expressions/fe_define.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'
 require 'openwfe/expressions/fe_sequence'
@@ -93,18 +79,12 @@ module OpenWFE
     #
     # A pointer to the body expression of this process definition.
     #
-    attr_accessor :body_fei
+    attr_accessor :body_index
 
-    #--
-    # Evaluates the definition, but doesn't apply its body, will
-    # simply return the body fei.
     #
-    #def evaluate (workitem)
-    #  @eval_only = true
-    #  apply workitem
-    #  @body_fei
-    #end
-    #++
+    # keeping track of whether the body of the process got started or not
+    #
+    attr_accessor :applied_body
 
     #
     # Called at the end of the 'evaluation', the 'apply' operation on
@@ -112,79 +92,53 @@ module OpenWFE
     #
     def reply_to_parent (workitem)
 
-      #return if @eval_only
+      return super(workitem) if @body_index == nil or @applied_body
+        # no body or body just got applied
 
-      #puts "/// \n   bf #{@body_fei} \n   wi.fei #{workitem.fei}"
+      # apply body of process definition now
 
-      return super(workitem) \
-        if @body_fei == nil or @body_fei == workitem.fei
-        #unless @body_fei
+      @applied_body = true
 
-      #_fei = @body_fei
-      #@body_fei = nil
       #store_itself
-      #get_expression_pool.apply _fei, workitem
+        # now done in apply_child()
 
-      get_expression_pool.apply @body_fei, workitem
+      apply_child(@body_index, workitem)
     end
 
-    #
-    # Overrides the set_variable in FlowExpression to
-    # make sure to intercept requests for binding subprocesses
-    # at the engine level and to store a copy of the raw expression,
-    # not only the flow expression id.
-    #
-    def set_variable (name, fei)
+    protected
 
-      if name[0, 2] == "//"
+      def next_child_index (returning_fei)
 
-        raw_exp = get_expression_pool.fetch_expression(fei).dup
-        raw_exp.parent_id = nil
-        raw_exp.fei = raw_exp.fei.dup
-        fei = raw_exp.fei
-        fei.wfid = get_wfid_generator.generate
+        child_index = super
 
-        raw_exp.store_itself
-      end
+        return nil unless child_index
 
-      super name, fei
-    end
+        child = raw_children[child_index]
 
-    protected
+        if child.is_a?(Array) && ( ! [ 'param', 'parameter' ].include?(child[0]))
+
+          if get_expression_map.get_class(child[0]) == DefineExpression
 
-      #
-      # Determines the flowExpressionId of the next child to apply.
-      #
-      def next_child (current_fei)
+            name = child[1]['name'] || child[2].first
 
-        next_fei = super
+            raise "process definition without a 'name' attribute" \
+              unless name
 
-        return nil unless next_fei
+            set_variable(name.to_s, child)
 
-        rawchild = get_expression_pool.fetch_expression next_fei
+          elsif get_expression_map.is_definition?(child[0])
 
-        return next_child(next_fei) unless rawchild
+            return child_index # let it get 'applied'
 
-        unless rawchild.is_definition?
+          elsif @body_index == nil
 
-          unless @body_fei
-            @body_fei = next_fei
+            @body_index = child_index
             store_itself
           end
-          return next_child(next_fei)
-        end
-
-        exp_class = get_expression_map.get_class rawchild
 
-        if exp_class == DefineExpression
-          set_variable rawchild.definition_name, next_fei
-          return next_child(next_fei)
         end
 
-        next_fei
-          #
-          # expression is a 'set', a 'filter-definition' or
-          # something like that, let it get applied
+        next_child_index(child_index)
       end
   end