ruote 0.9.18

data/lib/openwfe/expressions/fe_save.rb

@@ -0,0 +1,274 @@
+#
+#--
+# 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:
+# 
+# . 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 
+#   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 
+# POSSIBILITY OF SUCH DAMAGE.
+#++
+#
+
+#
+# "made in Japan"
+#
+# John Mettraux at openwfe.org
+#
+
+require 'openwfe/workitem'
+require 'openwfe/expressions/merge'
+
+
+#
+# save and restore
+#
+
+module OpenWFE
+
+    #
+    # Saves a copy of the current workitem to a variable or saves the
+    # attributes of the current workitem into a field (of that current 
+    # workitem).
+    #
+    #    save :to_variable => "/wix"
+    #        #
+    #        # saves a copy of the current workitem to the process
+    #        # level variable "wix"
+    #
+    #    save :to_field => "old_version"
+    #        #
+    #        # saves a copy of the current workitem attributes in the
+    #        # field 'old_version' of that current workitem.
+    #
+    # 'save' is often used in conjuntion with 'restore' 
+    # (RestoreWorkItemExpression).
+    #
+    class SaveWorkItemExpression < FlowExpression
+
+        names :save
+
+        def apply (workitem)
+
+            field = lookup_string_attribute :to_field, workitem
+            variable = lookup_string_attribute :to_variable, workitem
+
+            wi = workitem.dup
+
+            if field
+
+                workitem.set_attribute field, wi.attributes
+
+            elsif variable
+
+                set_variable variable, wi
+            end
+
+            # else, simply don't save
+
+            reply_to_parent workitem
+        end
+    end
+
+    #
+    # "restore" is often used in conjunction with "save" 
+    # (SaveWorkItemExpression).
+    #
+    # It can restore a workitem saved to a variable (it will actually
+    # restore the payload of that workitem) or transfer the content of a field
+    # as top attribute field.
+    #
+    #     restore :from_variable => "freezed_workitem"
+    #         #
+    #         # takes the freezed payload at 'freezed_workitem' and makes it
+    #         # the payload of the current workitem
+    #
+    #     restore :from_field => "some_data"
+    #         #
+    #         # replaces the payload of the current workitem with the hash
+    #         # found in the field "some_data"
+    #
+    #     restore :from_variable => "v", :to_field => "f"
+    #         #
+    #         # will copy the payload saved under variable "v" as the value
+    #         # of the field "f"
+    #
+    #     restore :from_variable => "v", :merge_lead => :current
+    #         #
+    #         # will restore the payload of the workitem saved under v
+    #         # but if fields of v are already present in the current workitem
+    #         # the current values will be kept
+    #
+    #     restore :from_variable => "v", :merge_lead => :restored
+    #         #
+    #         # will restore the payload of the workitem saved under v
+    #         # but the workitem v payload will have priority.
+    #
+    # Beware : you should not restore from a field that is not a hash. The
+    # top level attributes (payload) of a workitem should always be a hash.
+    #
+    # Since OpenWFEru 0.9.17, the 'set-fields' alias can be used for restore.
+    #
+    #     sequence do
+    #         set_fields :value => { 
+    #             "customer" => { "name" => "Zigue", "age" => 34 },
+    #             "approved" => false }
+    #         _print "${f:customer.name} (${f:customer.age}) ${f:approved}"
+    #     end
+    #
+    # Along with this new alias, the expression now behave much like the 'set'
+    # expression, but still, targets the whole workitem payload.
+    #
+    # Note that "set-fields" can be used outside of the body of a process
+    # definition (along with "set") to separate 'data preparation' from
+    # actual process definition.
+    #
+    #     class Test44b6 < ProcessDefinition
+    #         set_fields :value => { 
+    #             "customer" => { "name" => "Zigue", "age" => 34 },
+    #             "approved" => false }
+    #         sequence do
+    #             _print "${f:customer.name} (${f:customer.age}) ${f:approved}"
+    #         end
+    #     end
+    #
+    # Using set_fields at the beginning of a process can be useful for setting
+    # up forms (keys without values for now).
+    #
+    #     set_fields :value => {
+    #         "name" => "",
+    #         "address" => "",
+    #         "email" => ""
+    #     }
+    #
+    class RestoreWorkItemExpression < FlowExpression
+        include MergeMixin
+        include ValueMixin
+
+        names :restore, :set_fields
+
+        is_definition
+            # so that in can be placed outside of process definition bodies
+
+
+        def reply (workitem)
+
+            from_field = lookup_string_attribute :from_field, workitem
+            from_variable = lookup_string_attribute :from_variable, workitem
+
+            merge_lead = lookup_sym_attribute :merge_lead, workitem
+
+            merge_lead = nil \
+                unless [ nil, :current, :restored ].include?(merge_lead)
+
+            value = workitem.attributes[FIELD_RESULT]
+
+            source = if from_field
+
+                att = workitem.lookup_attribute from_field
+
+                lwarn {
+                    "apply() field '#{from_field}' is NOT a hash, " +
+                    "restored anyway"
+                } unless att.kind_of?(Hash)
+
+                att
+
+            elsif from_variable
+
+                lookup_variable from_variable
+
+            elsif value
+
+                value
+
+            else
+
+                nil
+            end
+
+            if source
+
+                workitem = if merge_lead
+                    do_merge merge_lead, workitem, source
+                else
+                    do_overwrite workitem, source
+                end
+            end
+            # else, don't restore anything
+
+            reply_to_parent workitem
+        end
+
+        protected
+
+            #
+            # The default case, restored values simply overwrite current
+            # values.
+            #
+            def do_overwrite (workitem, source)
+
+                return workitem unless source
+
+                attributes = if source.kind_of?(WorkItem)
+                    OpenWFE::fulldup source.attributes
+                else
+                    source
+                end
+
+                to_field = lookup_string_attribute :to_field, workitem
+
+                if to_field
+                    workitem.set_attribute to_field, attributes
+                else
+                    workitem.attributes = attributes
+                end
+
+                workitem
+            end
+
+            #
+            # If the attribute 'merge-lead' (or 'merge_lead') is specified,
+            # the workitems get merged.
+            #
+            def do_merge (merge_lead, workitem, source)
+
+                if source.kind_of?(Hash)
+                    wi = InFlowWorkItem.new
+                    wi.attributes = source
+                    source = wi
+                end
+
+                wiTarget, wiSource = if merge_lead == :current
+                    [ source, workitem ]
+                else
+                    [ workitem, source ]
+                end
+
+                merge_workitems wiTarget, wiSource
+            end
+    end
+
+end
+

data/lib/openwfe/expressions/fe_sequence.rb

@@ -0,0 +1,117 @@
+#
+#--
+# 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:
+#
+# . 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
+#   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
+# POSSIBILITY OF SUCH DAMAGE.
+#++
+#
+
+#
+# "made in Japan"
+#
+# John Mettraux at openwfe.org
+#
+
+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
+
+        def reply (workitem)
+
+            cfei = next_child workitem.fei
+
+            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
+
+            get_expression_pool.apply cfei, workitem
+        end
+
+        protected
+
+            #
+            # 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
+
+                loop do
+
+                    break if next_id >= @children.length
+
+                    child = @children[next_id]
+
+                    return child if child.is_a?(FlowExpressionId)
+
+                    next_id += 1
+                end
+
+                nil
+            end
+    end
+
+end
+

data/lib/openwfe/expressions/fe_set.rb

@@ -0,0 +1,139 @@
+#
+#--
+# 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:
+#
+# . 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
+#   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
+# POSSIBILITY OF SUCH DAMAGE.
+#++
+#
+
+#
+# "made in Japan"
+#
+# John Mettraux at openwfe.org
+#
+
+require 'openwfe/workitem'
+require 'openwfe/flowexpressionid'
+require 'openwfe/expressions/flowexpression'
+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
+    end
+
+    #
+    # 'unset' removes a field or a variable.
+    #
+    #     unset :field => "price"
+    #     unset :variable => "eval_result"
+    #
+    class UnsetValueExpression < FlowExpression
+        include ValueMixin
+
+        names :unset
+
+
+        def apply (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
+
+            reply_to_parent workitem
+        end
+    end
+
+end
+