ruote 0.9.19 → 0.9.20

data/lib/openwfe/expressions/fe_do.rb

@@ -1,55 +1,39 @@
-#
 #--
-# 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/utils'
+require 'openwfe/expressions/value'
 require 'openwfe/expressions/flowexpression'
 
 
-#
-# redo / undo (cancel)
-#
-
 module OpenWFE
 
   #
-  # Every expression in OpenWFEru accepts a 'tag' attribute. This tag
+  # Every expression in Ruote accepts a 'tag' attribute. This tag
   # can later be referenced by an 'undo' or 'redo' expression.
+  #
   # Tags are active as soon as an expression is applied and they vanish
   # when the expression replies to its parent expression or is cancelled.
   #
@@ -71,84 +55,111 @@ module OpenWFE
   # 'side_job' gets undone (cancelled). If the sequence 'side_job' was
   # already over, the "undo" will have no effect.
   #
+  # Note that since Ruote 0.9.20, it's OK to simply write :
+  #
+  #   undo "side_job"
+  #
+  # Since Ruote 0.9.20, putting a condition on 'undo' is accepted :
+  #
+  #   undo 'side_job', :if => '${f:something_went_wrong} == true'
+  #
   class UndoExpression < FlowExpression
+    include ValueMixin
+    include ConditionMixin
 
-    names :undo
+    names :undo#, :cancel
 
-    def apply (workitem)
+    def reply (workitem)
 
-      tag = lookup_tag(workitem)
+      conditional = eval_condition(:if, workitem, :unless)
 
-      undo_self = false
+      return reply_to_parent(workitem) if conditional == false
 
-      if tag
-        #OpenWFE::call_in_thread(fei.expression_name, self) do
-        process_tag tag
-        #end
+      if tag = lookup_tag(workitem)
 
-        undo_self = tag.fei.ancestor_of?(@fei)
-      end
+        get_workqueue.push(self, :process_tag, tag, workitem)
 
-      reply_to_parent(workitem) unless undo_self
+      else
+
+        reply_to_parent(workitem)
+      end
     end
 
     #
     # Calls the expression pool cancel() method upon the tagged
     # expression.
     #
-    def process_tag (tag)
+    def process_tag (tag, workitem)
 
-      ldebug do
-        "process_tag() #{fei.to_debug_s} to undo #{tag.fei.to_debug_s}"
-      end
-
-      #get_expression_pool.cancel_and_reply_to_parent(
-      #  tag.raw_expression.fei, tag.workitem)
+      ldebug { "process_tag() #{fei.to_debug_s} to undo #{tag.fei.to_debug_s}" }
 
       exp = get_expression_pool.fetch_expression(tag.raw_expression.fei)
 
+      #
+      # cancel target
+
       get_expression_pool.cancel(tag.raw_expression.fei)
 
       get_expression_pool.reply_to_parent(exp, tag.workitem, false)
         #
         # 'remove' is set to false, cancel already removed the
         # expression
-    end
 
-    #def reply (workitem)
-    #end
+      undoing_self = tag.fei.ancestor_of?(@fei)
+
+      reply_to_parent(workitem) unless undoing_self
+    end
 
     protected
 
-      def lookup_tag (workitem)
+    def lookup_tag (workitem)
 
-        tagname = lookup_attribute :ref, workitem
+      tagname = workitem.get_result || lookup_attribute(:ref, workitem)
+      tagname = tagname.to_s
 
-        tag = lookup_variable tagname
+      return nil unless tagname
 
-        lwarn { "lookup_tag() no tag named '#{tagname}' found" } \
-          unless tag
+      tag = lookup_variable(tagname)
 
-        tag
-      end
+      lwarn { "lookup_tag() no tag named '#{tagname}' found" } unless tag
+
+      tag
+    end
   end
 
   #
-  # Every expression in OpenWFEru accepts a 'tag' attribute. This tag
+  # Every expression in Ruote accepts a 'tag' attribute. This tag
   # can later be referenced by an 'undo' or 'redo' expression.
   #
+  # Tags are active as soon as an expression is applied and they vanish
+  # when the expression replies to its parent expression or is cancelled.
+  #
   # Calling for the undo of a non-existent tag throws no error, the flow
   # simply resumes.
   #
+  #   concurrence do
+  #     sequence :tag => 'side_job' do
+  #       participant 'alice'
+  #       participant 'bob'
+  #     end
+  #     _redo :ref => 'side_job'
+  #   end
+  #
+  # Note that since Ruote 0.9.20, it's OK to simply write :
+  #
+  #   _redo "that_step"
+  #
+  # and condition on redo are accepted as well :
+  #
+  #   <redo ref="that_step" if="${f:misaligned} == true" />
+  #
   class RedoExpression < UndoExpression
 
     names :redo
 
-    def process_tag (tag)
+    def process_tag (tag, workitem)
 
-      ldebug do
-        "process_tag() #{fei.to_debug_s} to redo #{tag.fei.to_debug_s}"
-      end
+      ldebug { "process_tag() #{fei.to_debug_s} to redo #{tag.fei.to_debug_s}" }
 
       #
       # cancel
@@ -160,7 +171,9 @@ module OpenWFE
 
       tag.raw_expression.application_context = @application_context
 
-      get_expression_pool.apply tag.raw_expression, tag.workitem
+      get_expression_pool.apply(tag.raw_expression, tag.workitem)
+
+      reply_to_parent(workitem)
     end
   end
 

data/lib/openwfe/expressions/fe_equals.rb

@@ -1,51 +1,33 @@
-#
 #--
-# 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/workitem'
 require 'openwfe/flowexpressionid'
 require 'openwfe/expressions/flowexpression'
 
 
-#
-# expressions like 'set' and 'unset' and their utility methods
-#
-
 module OpenWFE
 
   #

data/lib/openwfe/expressions/fe_error.rb

@@ -0,0 +1,103 @@
+#--
+# Copyright (c) 2008-2009, John Mettraux, jmettraux@gmail.com
+#
+# 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:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# 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.
+#
+# Made in Japan.
+#++
+
+
+module OpenWFE
+
+  #
+  # The 'error' expression provokes an error to occur in a process instance.
+  # The error might then be treated by an error handler ('on_error' attribute)
+  # or simply registered in the error journal and manually replayed.
+  #
+  #   sequence do
+  #     participant :ref => 'unit1'
+  #     error 'missing info', :if => "${f:customer} == ''"
+  #     participant :ref => 'unit2'
+  #   end
+  #
+  # In this hypothetical example, the error is triggered if the field customer
+  # is empty.
+  #
+  # == replaying
+  #
+  # The error expression can be replayed without further ado (though it is
+  # expected that the problem it raised attention to has be fixed). At replay
+  # the expression will simply let the process instance resume.
+  #
+  # == on_error
+  #
+  # This expression can be used to let a process interrupt itself (replay case)
+  # or to force the process into a 'fail path' (out of the 'happy path')
+  #
+  #   class MyDef0 < OpenWFE::ProcessDefinition
+  #
+  #     sequence :on_error => 'fail_path' do
+  #
+  #       participant :ref => 'unit1'
+  #       error 'missing info', :if => "${f:customer} == ''"
+  #       participant :ref => 'unit2'
+  #     end
+  #
+  #     process_definition :name => 'fail_path' do
+  #       # ... problem resolution subprocess ...
+  #     end
+  #   end
+  #
+  #
+  class ErrorExpression < FlowExpression
+    include ValueMixin
+    include ConditionMixin
+
+    #names :error, :exception
+    names :error
+
+    #
+    # is set to true when the expression got applied once (and raised
+    # its error).
+    #
+    attr_accessor :triggered
+
+
+    def reply (workitem)
+
+      return reply_to_parent(workitem) if @triggered
+        #
+        # when error is 'replayed' simply reply to parent to let flow resume
+
+      conditional = eval_condition(:if, workitem, :unless)
+
+      return reply_to_parent(workitem) if conditional == false
+
+      text = workitem.get_result.to_s
+
+      @triggered = true
+
+      store_itself # making sure @triggered is saved
+
+      raise(ForcedError.new(text))
+    end
+  end
+
+end
+

data/lib/openwfe/expressions/fe_filter.rb

@@ -1,43 +1,27 @@
-#
 #--
-# Copyright (c) 2007, 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.
 #++
-#
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
-#
-# "made in Japan"
-#
-# John Mettraux at openwfe.org
-#
 
 require 'openwfe/expressions/filter'
 
@@ -102,26 +86,25 @@ module OpenWFE
     attr_accessor :applied_workitem, :filter
 
 
-    def apply workitem
+    def apply (workitem)
 
-      if @children.length < 1
-        reply_to_parent workitem
-        return
-      end
+      return reply_to_parent(workitem) if has_no_expression_child
 
       @applied_workitem = workitem.dup
-      filter_in workitem, :name
 
-      store_itself
+      filter_in(workitem, :name)
+
+      #store_itself
+        # now done in apply_child()
 
-      get_expression_pool.apply @children[0], workitem
+      apply_child(first_expression_child, workitem)
     end
 
-    def reply workitem
+    def reply (workitem)
 
-      filter_out workitem
+      filter_out(workitem)
 
-      reply_to_parent workitem
+      reply_to_parent(workitem)
     end
   end