ruote 0.9.19 → 0.9.20

data/lib/openwfe/expressions/fe_misc.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/value'
@@ -83,7 +69,7 @@ module OpenWFE
       set_variable(DESC, text) unless lookup_variable(DESC)
         # set default if not set
 
-      reply_to_parent workitem
+      reply_to_parent(workitem)
     end
   end
 
@@ -111,7 +97,7 @@ module OpenWFE
   class PrintExpression < FlowExpression
     include ValueMixin
 
-    names :print
+    names :print, :echo
 
     def reply (workitem)
 
@@ -126,7 +112,7 @@ module OpenWFE
         puts text
       end
 
-      reply_to_parent workitem
+      reply_to_parent(workitem)
     end
   end
 
@@ -162,7 +148,17 @@ module OpenWFE
   #   end
   #
   # Don't embed too much Ruby into your process definitions, it might
-  # hurt...
+  # hurt... It's probably better to embed some ruby code in a BlockParticipant,
+  # like in
+  #
+  #   engine.register_participant :compute_total do |workitem|
+  #     sum = workitem.items.inject(0) do |sum, item|
+  #       sum += item['count'] * item['price']
+  #     end
+  #   end
+  #
+  # 2 advantages : not too much ruby code in the process definition, and the
+  # participant can be reused for another process.
   #
   # Reval can also be used with the 'code' attribute (or 'field-code' or
   # 'variable-code') :
@@ -171,6 +167,11 @@ module OpenWFE
   #
   # to eval the Ruby code held in the field named "f0".
   #
+  # Note that currently, the actual evaluation of the ruby code is done in
+  # the work thread, so while this ruby code is executing, there is no
+  # chance for other process instances to progress. Using a block participant
+  # (like explained a few paragraphs up here) avoids this problem altogether.
+  #
   class RevalExpression < FlowExpression
     include ValueMixin
 
@@ -188,14 +189,14 @@ module OpenWFE
       wi = workitem
         # so that the ruby code being evaluated sees 'wi' and 'workitem'
 
-      get_tree_checker.check code
+      get_tree_checker.check(code)
 
-      result = eval code, binding()
+      result = eval(code, binding())
 
       workitem.set_result(result) \
         if result != nil  # as 'false' is a valid result
 
-      reply_to_parent workitem
+      reply_to_parent(workitem)
     end
   end
 
@@ -224,10 +225,9 @@ module OpenWFE
 
     names :eval
 
-
     def reply (workitem)
 
-      raise "dynamic evaluation of process definitions is not allowed" \
+      raise 'dynamic evaluation of process definitions is not allowed' \
         if @application_context[:dynamic_eval_allowed] != true
 
       df = lookup_vf_attribute(workitem, 'def') || workitem.get_result
@@ -236,29 +236,10 @@ module OpenWFE
         #
         # currently, 'nothing to eval' means, 'just go on'
 
-      ldebug { "apply() def is >#{df}<" }
-
-      raw_expression = build_raw_expression df
-
-      #puts
-      #puts "======================================"
-      #puts raw_expression.to_s
-      #puts raw_expression.raw_representation
-      #puts "======================================"
-      #puts
+      tree = get_def_parser.determine_rep(df)
 
-      raw_expression.apply workitem
+      get_expression_pool.substitute_and_apply(self, tree, workitem)
     end
-
-    protected
-
-      def build_raw_expression (df)
-
-        procdf = get_expression_pool.determine_rep df
-
-        RawExpression.new_raw(
-          fei, parent_id, environment_id, application_context, procdf)
-      end
   end
 
   #
@@ -298,19 +279,6 @@ module OpenWFE
 
     names :exp
 
-    #--
-    #def initialize (fei, parent_id, env_id, app_context, att)
-    #  #
-    #  # this responds to the FlowExpression constructor...
-    #  super fei, parent_id, env_id, app_context, nil
-    #    #
-    #    # but this triggers the RawExpression constructor :)
-    #  @attributes = att
-    #    #
-    #    # as this is not done by the RawExpression constructor
-    #end
-    #++
-
     def apply (workitem)
 
       @applied_workitem = workitem
@@ -320,52 +288,45 @@ module OpenWFE
 
     protected
 
-      #
-      # Evaluates the 'name' attribute, if it's not present or empty,
-      # will return the value for the 'default' attribute.
-      #
-      def expression_name
+    #
+    # Evaluates the 'name' attribute, if it's not present or empty,
+    # will return the value for the 'default' attribute.
+    #
+    def expression_name
 
-        n = lookup_attribute :name, @applied_workitem
+      n = lookup_attribute(:name, @applied_workitem)
 
-        return lookup_attribute(:default, @applied_workitem) \
-          if (not n) or (n.strip == '')
-
-        n
-      end
-
-      #
-      # If the 'attributes' attribute is present, will return its
-      # value. Else, will simply return the attributes of the 'exp'
-      # expression itself ('name' and 'default' included).
-      #
-      def extract_attributes
+      return lookup_attribute(:default, @applied_workitem) \
+        if (not n) or (n.strip == '')
+      n
+    end
 
-        att = lookup_vf_attribute @applied_workitem, :attributes
-          # will currently only work with an attribute hash
-          # whose keys are strings... symbols :(
+    #
+    # If the 'attributes' attribute is present, will return its
+    # value. Else, will simply return the attributes of the 'exp'
+    # expression itself ('name' and 'default' included).
+    #
+    def extract_attributes
 
-        att || @attributes
-      end
+      att = lookup_vf_attribute(@applied_workitem, :attributes)
+        # will currently only work with an attribute hash
+        # whose keys are strings... symbols :(
 
-      #--
-      #def extract_descriptions
-      #  []
-      #end
-      #++
+      att || @attributes
+    end
 
-      def extract_children
-        @children
-      end
+    def extract_children
+      @children
+    end
 
-      def extract_parameters
-        []
-      end
+    def extract_parameters
+      []
+    end
   end
 
   #
   # This expression simply emits a message to the application
-  # log (by default logs/openwferu.log).
+  # log (by default logs/ruote.log).
   #
   #   <sequence>
   #     <log>before participant alpha</log>

data/lib/openwfe/expressions/fe_participant.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/rudefinitions'
@@ -43,10 +29,6 @@ require 'openwfe/expressions/filter'
 require 'openwfe/expressions/timeout'
 
 
-#
-# The participant expression, in its own file
-#
-
 module OpenWFE
 
   #
@@ -125,79 +107,60 @@ module OpenWFE
     attr_accessor :participant_name
     attr_accessor :applied_workitem
 
-
     def apply (workitem)
 
-      conditional = eval_condition :if, workitem, :unless
-
-      return super_reply_to_parent(workitem) \
-        if conditional == false
-          #
-          # skip expression
-          # <participant ref="x" if="y" /> (where y evals to false)
+      conditional = eval_condition(:if, workitem, :unless)
 
-      @participant_name = lookup_ref workitem
+      return super_reply_to_parent(workitem) if conditional == false
+        #
+        # skip expression
+        # <participant ref="x" if="y" /> (where y evals to false)
 
-      @participant_name = fetch_text_content workitem \
-        unless @participant_name
+      @participant_name ||= self.respond_to?(:hint) ? hint : nil
+      @participant_name ||= lookup_ref(workitem) || fetch_text_content(workitem)
 
-      participant =
-        get_participant_map.lookup_participant @participant_name
+      participant = get_participant_map.lookup_participant(@participant_name)
 
-      raise "No participant named '#{@participant_name}'" \
+      raise "pexp : no participant named #{@participant_name.inspect}" \
         unless participant
 
-      remove_timedout_flag workitem
+      workitem.unset_result
+      remove_timedout_flag(workitem)
 
       @applied_workitem = workitem.dup
 
-      schedule_timeout
+      schedule_timeout(workitem)
 
-      filter_in workitem
+      filter_in(workitem)
 
       store_itself
 
-      workitem.params = lookup_attributes workitem
-
-      #
-      # threading AFTER the store_itself()
-      #
-      Thread.new do
-        begin
-
-          # these two pmap calls were combined, but with the :reply
-          # notification in reply_to_parent() it feels more
-          # elegant like that
+      workitem.params = lookup_attributes(workitem)
 
-          get_participant_map.dispatch(
-            participant, @participant_name, workitem)
+      # after the store_itself()
 
-          get_participant_map.onotify(
-            @participant_name, :apply, workitem)
+      get_participant_map.dispatch(
+        participant, @participant_name, workitem)
 
-        rescue Exception => e
-
-          get_expression_pool.notify_error(
-            e, fei, :apply, workitem)
-        end
-      end
+      get_participant_map.onotify(
+        @participant_name, :apply, workitem)
     end
 
     alias :super_reply_to_parent :reply_to_parent
 
     def reply_to_parent (workitem)
 
-      get_participant_map.onotify @participant_name, :reply, workitem
+      get_participant_map.onotify(@participant_name, :reply, workitem)
         #
         # for 'listen' expressions waiting for replies
 
-      unschedule_timeout()
+      unschedule_timeout(workitem)
 
-      workitem.attributes.delete "params"
+      workitem.attributes.delete('params')
 
-      filter_out workitem
+      filter_out(workitem)
 
-      super workitem
+      super(workitem)
     end
 
     #
@@ -207,10 +170,12 @@ module OpenWFE
     #
     def cancel
 
-      unschedule_timeout
+      unschedule_timeout(nil)
 
       cancel_participant
 
+      trigger_on_cancel # if any
+
       @applied_workitem
     end
 
@@ -230,39 +195,36 @@ module OpenWFE
 
         cancel_participant
 
-        set_timedout_flag @applied_workitem
+        set_timedout_flag(@applied_workitem)
 
-        reply_to_parent @applied_workitem
+        reply_to_parent(@applied_workitem)
 
       rescue
 
-        lerror do
-          "trigger() problem while timing out\n"+
-          OpenWFE::exception_to_s($!)
-        end
+        lerror {
+          "trigger() problem while timing out\n#{OpenWFE::exception_to_s($!)}"
+        }
       end
     end
 
     protected
 
-      #
-      # Have to cancel the workitem on the participant side
-      #
-      def cancel_participant
+    #
+    # Have to cancel the workitem on the participant side
+    #
+    def cancel_participant
 
-        return unless @applied_workitem
-          #
-          # if there is an applied workitem, it means there
-          # is a participant to cancel...
+      return unless @applied_workitem
+        #
+        # if there is an applied workitem, it means there
+        # is a participant to cancel...
 
-        participant = \
-          get_participant_map.lookup_participant(@participant_name)
+      participant = get_participant_map.lookup_participant(@participant_name)
 
-        cancelitem = CancelItem.new(@applied_workitem)
+      cancelitem = CancelItem.new(@applied_workitem)
 
-        get_participant_map.dispatch(
-          participant, @participant_name, cancelitem)
-      end
+      get_participant_map.dispatch(participant, @participant_name, cancelitem)
+    end
   end
 
 end