ruote 0.9.20 → 2.1.1

data/lib/openwfe/expressions/fe_participant.rb

@@ -1,231 +0,0 @@
-#--
-# Copyright (c) 2006-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.
-#++
-
-
-require 'openwfe/utils'
-require 'openwfe/rudefinitions'
-require 'openwfe/expressions/filter'
-require 'openwfe/expressions/timeout'
-
-
-module OpenWFE
-
-  #
-  # Participants sit at the edge between the engine and the external
-  # world. The participant expression transmit the workitem applied
-  # to it to the Participant instance it looks up in the participant map
-  # tied to the engine.
-  #
-  #  direct reference to participant alpha :
-  #
-  #   <participant ref="alpha" />
-  #
-  #  the name of the participant is the value found in
-  #  the field 'target' :
-  #
-  #   <participant field-ref="target" />
-  #   <participant ref="${f:target}" />
-  #
-  #  the name of the participant is the value found in
-  #  the variable 'target' :
-  #
-  #   <participant variable-ref="target" />
-  #   <participant ref="${target}" />
-  #
-  #  direct reference to participant 'alpha'
-  #  if a subprocess named 'alpha' has been defined, the
-  #  subprocess will be called instead :
-  #
-  #   <alpha />
-  #
-  # The Participant expressions includes the FilterMixin and thus
-  # understands and applies the "filter" attribute.
-  #
-  # Since OpenWFEru 0.9.9, the attributes of the participant expression are
-  # set inside a hash field named 'params' just available to the participant.
-  # Thus in
-  #
-  #   <participant ref="toto" task="play golf" location="Minami Center" />
-  #
-  # participant 'toto' will receive a workitem with a field named 'params'
-  # containing the hash
-  # { "ref"=>"toto", "task"=>"play golf", "location"=>"Minami Center" }.
-  #
-  # When the workitem gets back from the participant, the field 'params' is
-  # deleted.
-  #
-  # The participant expressions include the TimeoutMixin, it means that
-  # a timeout can be stated :
-  #
-  #   <participant ref="toto" timeout="2w1d" />
-  #
-  # If after 2 weeks and 1 day (15 days), participant "toto" hasn't replied,
-  # the workitem will get cancelled and the flow will resume (behind the
-  # scene, participant "toto", will receive a CancelItem instance bearing
-  # the same FlowExpressionId as the initial workitem and the participant
-  # implementation is responsible for the cancel application).
-  #
-  # The participant expression accepts an optional 'if' (or 'unless')
-  # attribute. It's used for conditional execution of the participant :
-  #
-  #   participant :ref => "toto", :if => "${weather} == raining"
-  #     # the participant toto will receive a workitem only if
-  #     # it's raining
-  #
-  #   boss :unless => "#{f:matter} == 'very trivial'"
-  #     # the boss will not participate in the proces if the matter
-  #     # is 'very trivial'
-  #
-  class ParticipantExpression < FlowExpression
-    include FilterMixin
-    include TimeoutMixin
-    include ConditionMixin
-
-    names :participant
-
-    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)
-
-      @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)
-
-      raise "pexp : no participant named #{@participant_name.inspect}" \
-        unless participant
-
-      workitem.unset_result
-      remove_timedout_flag(workitem)
-
-      @applied_workitem = workitem.dup
-
-      schedule_timeout(workitem)
-
-      filter_in(workitem)
-
-      store_itself
-
-      workitem.params = lookup_attributes(workitem)
-
-      # after the store_itself()
-
-      get_participant_map.dispatch(
-        participant, @participant_name, workitem)
-
-      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)
-        #
-        # for 'listen' expressions waiting for replies
-
-      unschedule_timeout(workitem)
-
-      workitem.attributes.delete('params')
-
-      filter_out(workitem)
-
-      super(workitem)
-    end
-
-    #
-    # The cancel() method of a ParticipantExpression is particular : it
-    # will emit a CancelItem instance towards the participant itself
-    # to notify it of the cancellation.
-    #
-    def cancel
-
-      unschedule_timeout(nil)
-
-      cancel_participant
-
-      trigger_on_cancel # if any
-
-      @applied_workitem
-    end
-
-    #
-    # Upon timeout, the ParticipantExpression will cancel itself and
-    # the flow will resume.
-    #
-    def trigger (scheduler)
-
-      linfo { "trigger() timeout requested for #{@fei.to_debug_s}" }
-
-      begin
-
-        #@scheduler_job_id = nil
-          #
-          # so that cancel won't unschedule without need
-
-        cancel_participant
-
-        set_timedout_flag(@applied_workitem)
-
-        reply_to_parent(@applied_workitem)
-
-      rescue
-
-        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
-
-      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)
-
-      cancelitem = CancelItem.new(@applied_workitem)
-
-      get_participant_map.dispatch(participant, @participant_name, cancelitem)
-    end
-  end
-
-end
-

data/lib/openwfe/expressions/fe_reserve.rb

@@ -1,192 +0,0 @@
-#--
-# Copyright (c) 2007-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 'reserve' expression ensures that its nested child expression
-  # executes while a reserved mutex is set.
-  #
-  # Thus
-  #
-  #   concurrence do
-  #     reserve :mutex => :m0 do
-  #       sequence do
-  #         participant :alpha
-  #         participant :bravo
-  #       end
-  #     end
-  #     reserve :mutex => :m0 do
-  #       participant :charly
-  #     end
-  #     participant :delta
-  #   end
-  #
-  # The sequence will not but run while the participant charly is active
-  # and vice versa. The participant delta is not concerned.
-  #
-  # The mutex is a regular variable name, thus a mutex named "//toto" could
-  # be used to prevent segments of totally different process instances from
-  # running.
-  #
-  class ReserveExpression < FlowExpression
-
-    names :reserve
-
-    #
-    # The name of the mutex this expressions uses.
-    # It's a variable name, that means it can be prefixed with
-    # {nothing} (local scope), '/' (process scope) and '//' (engine /
-    # global scope).
-    #
-    attr_accessor :mutex_name
-
-    #
-    # An instance variable for storing the applied workitem if the 'reserve'
-    # cannot be entered immediately.
-    #
-    attr_accessor :applied_workitem
-
-
-    def apply (workitem)
-
-      return reply_to_parent(workitem) if has_no_expression_child
-
-      @mutex_name = lookup_string_attribute(:mutex, workitem)
-
-      mutex = lookup_variable(@mutex_name) || FlowMutex.new(@mutex_name)
-
-      mutex.register(self, workitem)
-    end
-
-    def reply (workitem)
-
-      lookup_variable(@mutex_name).release(self)
-
-      reply_to_parent(workitem)
-    end
-
-    #
-    # takes care of exiting the critical section once the children
-    # have been cancelled
-    #
-    def cancel
-
-      super
-
-      lookup_variable(@mutex_name).release(self)
-    end
-
-    #
-    # Called by the FlowMutex to enter the 'reserved/critical' section.
-    #
-    def enter (workitem=nil)
-
-      apply_child(first_expression_child, workitem || @applied_workitem)
-    end
-  end
-
-  #
-  # A FlowMutex is a process variable (thus serializable) that keeps
-  # track of the expressions in a critical section (1!) or waiting for
-  # entering it.
-  #
-  #--
-  # The current syncrhonization scheme is 1 thread mutex for all the
-  # FlowMutex. Shouldn't be too costly and the operations under sync are
-  # quite tiny.
-  #++
-  #
-  class FlowMutex
-
-    #--
-    # Granularity level ? "big rock". Only one FlowMutex operation
-    # a a time for the whole business process engine...
-    #
-    #@@class_mutex = Mutex.new
-    #++
-
-    attr_accessor :mutex_name
-    attr_accessor :feis
-
-    def initialize (mutex_name)
-
-      @mutex_name = mutex_name
-      @feis = []
-    end
-
-    def register (fexp, workitem)
-
-      @feis << fexp.fei
-
-      fexp.set_variable(@mutex_name, self)
-
-      if @feis.size == 1
-        #
-        # immediately let the expression enter the critical section
-        #
-        #fexp.store_itself
-        fexp.enter(workitem)
-      else
-        #
-        # later...
-        #
-        fexp.applied_workitem = workitem
-        fexp.store_itself
-      end
-    end
-
-    def release (releaser)
-
-      next_fei = nil
-
-      current_fei = @feis.delete_at 0
-
-      releaser.set_variable(@mutex_name, self)
-
-      log.warn "release() BAD! c:#{current_fei} r:#{releaser.fei}" \
-        if releaser.fei != current_fei
-
-      next_fei = @feis.first
-
-      return unless next_fei
-
-      releaser.get_expression_pool.fetch_expression(next_fei).enter
-    end
-
-    #--
-    # Used by the ReserveExpression when looking up for a FlowMutex
-    # and registering into it.
-    #
-    #def self.synchronize (&block)
-    #  @@class_mutex.synchronize do
-    #    block.call
-    #  end
-    #end
-    #++
-  end
-
-end
-

data/lib/openwfe/expressions/fe_save.rb

@@ -1,255 +0,0 @@
-#--
-# Copyright (c) 2007-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.
-#++
-
-require 'openwfe/workitem'
-require 'openwfe/expressions/merge'
-
-
-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
-
-      wi_target, wi_source = if merge_lead == :current
-        [ source, workitem ]
-      else
-        [ workitem, source ]
-      end
-
-      merge_workitems(wi_target, wi_source)
-    end
-  end
-
-end
-