ruote 0.9.20 → 2.1.1

data/lib/openwfe/participants/participant.rb

@@ -1,142 +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/logging'
-require 'openwfe/contextual'
-require 'openwfe/rudefinitions'
-
-
-module OpenWFE
-
-  #
-  # The 'participant' concept is displayed as a module, so that
-  # other pieces of code may easily 'mix it in'.
-  #
-  # Participant extensions should at least provide a consume(workitem)
-  # method.
-  # As an option, it can provide a cancel(cancelitem) method.
-  #
-  # The engine will transmit instances of OpenWFE:WorkItem via the
-  # consume method.
-  #
-  # If there is a cancel method available and an OpenWFE::CancelItem instance
-  # is emitted (cancelling a process or part of it), it will be fed to
-  # the participant only via the cancel method.
-  #
-  # If there is no cancel method, the participant will not get notified
-  # of the cancellation.
-  #
-  module Participant
-
-    #
-    # A Participant will be receiving OpenWFE::WorkItem's via this method.
-    #
-    def consume (workitem)
-
-      raise NotImplementedError.new(
-        "implementation for method consume() "+
-        "is missing in class '#{self.class}'")
-    end
-
-    #--
-    # (optional)
-    #
-    #def cancel (cancelitem)
-    #end
-    #++
-
-    #
-    # By default, returns false. When returning true the dispatch to the
-    # participant will not be done in his own thread.
-    #
-    # Since ActiveRecord 2.2, ActiveParticipant returns true (well, this
-    # method was introduced for ActiveParticipant and AR 2.2)
-    #
-    def do_not_thread
-      false
-    end
-  end
-
-  #
-  # Local participants provide handy methods like reply_to_engine() to
-  # further implementations of the Participant concept.
-  #
-  module LocalParticipant
-
-    include Participant
-    include Contextual
-    include Logging
-    include OwfeServiceLocator
-
-    #
-    # Returns the FlowExpression instance that triggered this
-    # participant.
-    # A ParticipantExpression instance will most likely be returned.
-    #
-    def get_flow_expression (workitem)
-
-      return nil unless @application_context
-
-      get_expression_pool.fetch_expression(workitem.flow_expression_id)
-    end
-
-    #
-    # A convenience method for calling block passed to participants
-    # for templates (mail participants) or execution (BlockParticipant).
-    #
-    # Allows for such blocks :
-    #
-    #   { |workitem| ... }
-    #   { |participant_expression, workitem| ... }
-    #   { |participant_expression, participant, workitem| ... }
-    #
-    # For 0 or more than 3 arguments, the block will be called without
-    # arguments.
-    #
-    def call_block (block, workitem)
-
-      if block.arity == 1
-        block.call(workitem)
-      elsif block.arity == 2
-        block.call(get_flow_expression(workitem), workitem)
-      elsif block.arity == 3
-        block.call(get_flow_expression(workitem), self, workitem)
-      else
-        block.call
-      end
-    end
-
-    #
-    # Participants use this method to reply to their engine when
-    # their job is done.
-    #
-    def reply_to_engine (workitem)
-
-      get_engine.reply(workitem)
-    end
-  end
-
-end
-

data/lib/openwfe/participants/participant_map.rb

@@ -1,245 +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/workitem'
-require 'openwfe/service'
-require 'openwfe/util/observable'
-require 'openwfe/participants/participants'
-
-
-module OpenWFE
-
-  #
-  # A very simple directory of participants
-  #
-  class ParticipantMap < Service
-
-    include OwfeServiceLocator
-    include OwfeObservable
-
-    attr_accessor :participants
-
-    def initialize (service_name, application_context)
-
-      super
-
-      @participants = []
-      @observers = {}
-    end
-
-    #
-    # Returns how many participants are currently registered here.
-    #
-    def size
-
-      @participants.size
-    end
-
-    #
-    # Adds a participant to this map.
-    # This method is called by the engine's own register_participant()
-    # method.
-    #
-    # The participant instance is returned by this method call.
-    #
-    # The know params are :participant (a participant instance or
-    # class) and :position (which can be null or :first).
-    #
-    # By default (if :position is not set to :first), the participant
-    # will appear at the bottom of the participant list.
-    #
-    def register_participant (regex, params, &block)
-
-      #params = params.is_a?(Hash) ? params : { :participant => params }
-
-      participant = params[:participant]
-      position = params[:position]
-
-      if not participant
-
-        raise "please provide a participant instance or a block" unless block
-
-        participant = BlockParticipant.new(block)
-      end
-
-      ldebug { "register_participant() participant.class #{participant.class}" }
-
-      participant = instantiate_participant(regex, participant, params) \
-        if participant.is_a?(Class)
-
-      participant.application_context = @application_context \
-        if participant.respond_to?(:application_context=)
-
-      original_string = regex.to_s
-
-      unless regex.kind_of?(Regexp)
-
-        regex = regex.to_s
-        regex = '^' + regex unless regex[0, 1] == '^'
-        regex = regex  + '$' unless regex[-1, 1] == '$'
-
-        ldebug { "register_participant() '#{regex}'" }
-
-        regex = Regexp.new(regex)
-      end
-
-      class << regex
-        attr_reader :original_string
-      end
-      regex.instance_variable_set('@original_string', original_string)
-
-      # now add the participant to the list
-
-      entry = [ regex, participant ]
-
-      index = (position == :first) ? 0 : -1
-
-      @participants.insert(index, entry)
-
-      participant
-    end
-
-    #
-    # Looks up a participant given a participant_name.
-    # Will return the first participant whose name matches.
-    #
-    def lookup_participant (participant_name)
-
-      participant_name = participant_name.to_s
-
-      @participants.each do |tuple|
-        return tuple[1] if tuple[0].match(participant_name)
-      end
-
-      nil
-    end
-
-    #
-    # Deletes the first participant matching the given name.
-    #
-    # If 'participant_name' is an integer, will remove the participant
-    # at that position in the participant list.
-    #
-    def unregister_participant (participant_name)
-
-      return (@participants.delete_at(participant_name) != nil) \
-        if participant_name.is_a?(Integer)
-
-      participant_name = participant_name.to_s
-
-      par = @participants.find do |tuple|
-        tuple[0].original_string == participant_name
-      end
-      @participants.delete(par) if par
-
-      (par != nil)
-    end
-
-    #
-    # Dispatches to the given participant (participant name (string) or
-    # The workitem will be fed to the consume() method of that participant.
-    # If it's a cancelitem and the participant has a cancel() method,
-    # it will get called instead.
-    #
-    def dispatch (participant, participant_name, workitem)
-
-      participant ||= lookup_participant(participant_name)
-        # participant may be null (AliasParticipant)
-
-      raise "pmap : no participant named '#{participant_name}'" \
-        unless participant
-
-      workitem.participant_name = participant_name
-
-      if participant.respond_to?(:do_not_thread) and participant.do_not_thread
-        do_dispatch(participant, workitem)
-      else
-        Thread.new { do_dispatch(participant, workitem) }
-      end
-    end
-
-    #
-    # The method onotify (from Observable) is made public so that
-    # ParticipantExpression instances may notify the pmap of applies
-    # and replies.
-    #
-    public :onotify
-
-    protected
-
-    #
-    # The participant to register has been passed as a class... Have to
-    # instantiate it...
-    #
-    def instantiate_participant (regex, klass, options)
-
-      [
-        [ regex, @application_context ], [], [ options ]
-      ].each do |args|
-        begin
-          return klass.new(*args)
-        rescue Exception => e
-        end
-      end
-    end
-
-    #
-    # The actual dispatch work is here, along with error catching
-    #
-    def do_dispatch (participant, workitem)
-
-      return do_cancel(participant, workitem) if workitem.is_a?(CancelItem)
-
-      onotify(:dispatch, :before_consume, workitem)
-
-      workitem.dispatch_time = Time.now
-
-      participant.consume(workitem)
-
-      onotify(:dispatch, :after_consume, workitem)
-
-    rescue Exception => e
-
-      get_expression_pool.handle_error(e, workitem.fei, :apply, workitem)
-    end
-
-    #
-    # Will call the cancel method of the participant if it has
-    # one, or will simply discard the cancel item else.
-    #
-    def do_cancel (participant, cancel_item)
-
-      participant.cancel(cancel_item) if participant.respond_to?(:cancel)
-
-      onotify(:dispatch, :cancel, cancel_item)
-        #
-        # maybe it'd be better to specifically log that
-        # a participant has no cancel() method, but it's OK
-        # like that for now.
-    end
-  end
-
-end
-

data/lib/openwfe/participants/participants.rb

@@ -1,381 +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 'yaml'
-
-require 'openwfe/utils'
-require 'openwfe/util/dollar'
-require 'openwfe/participants/participant'
-
-
-#
-# some base participant implementations
-#
-module OpenWFE
-
-  #
-  # Just dumps the incoming workitem in a file as a YAML String.
-  #
-  # By default, this participant will not reply to the engine once
-  # the workitem got dumped to its file, but you can set its
-  # reply_anyway field to true to make it reply anyway...
-  #
-  class FileParticipant
-    include LocalParticipant
-
-    attr_accessor :reply_anyway, :workdir
-
-    #
-    # The constructor expects as a unique optional param either the
-    # application_context either the 'output' dir for the participant.
-    #
-    def initialize (context_or_dir=nil)
-
-      @workdir = get_work_directory(context_or_dir) + '/out/'
-
-      @reply_anyway = false
-    end
-
-    #
-    # The method called by the engine for each incoming workitem.
-    #
-    def consume (workitem)
-
-      FileUtils.mkdir_p(@workdir) unless File.exist?(@workdir)
-
-      file_name = @workdir + determine_file_name(workitem)
-
-      dump_to_file(file_name, workitem)
-
-      reply_to_engine(workitem) if @reply_anyway
-    end
-
-    #
-    # This method does the actual job of dumping the workitem (as some
-    # YAML to a file).
-    # It can be easily overriden.
-    #
-    def dump_to_file (file_name, workitem)
-
-      File.open(file_name, 'w') do |file|
-        file.print(encode_workitem(workitem))
-      end
-    end
-
-    #
-    # You can override this method to control into which file (name)
-    # each workitem gets dumped.
-    # You could even have a unique file for all workitems transiting
-    # through this participant.
-    #
-    def determine_file_name (workitem)
-
-      fei = workitem.fei
-
-      OpenWFE::ensure_for_filename(
-        "#{fei.wfid}_#{fei.expression_id}__" +
-        "#{fei.workflow_definition_name}__" +
-        "#{fei.workflow_definition_revision}__" +
-        "#{workitem.participant_name}.yaml")
-    end
-
-    protected
-
-    #
-    # By default, uses YAML to serialize the workitem
-    # (of course you can override this method).
-    #
-    def encode_workitem (wi)
-      YAML.dump(wi)
-    end
-  end
-
-  #
-  # This participant is used by the register_participant() method of
-  # Engine class.
-  #
-  #   engine.register_participant("the_boss") do |workitem|
-  #     puts "the boss received a workitem"
-  #   end
-  #
-  # After the block executes, the BlockParticipant immediately replies
-  # to the engine.
-  #
-  # You can pass a block with two arguments : flow_expression and workitem
-  # to BlockParticipant, it will automatically adapt.
-  #
-  #   engine.register_participant("the_boss") do |fexp, wi|
-  #     puts "the boss received a workitem from exp #{fexp.fei.to_s}"
-  #   end
-  #
-  # Having the FlowExpression instance at hand allows for advanced tricks,
-  # beware...
-  #
-  # It's also OK to register a block participant without params :
-  #
-  #   engine.register_participant :alice do
-  #     puts "Alice received a workitem"
-  #   end
-  #
-  class BlockParticipant
-    include LocalParticipant
-
-    def initialize (block0=nil, &block1)
-
-      @block = block1 ? block1 : block0
-
-      raise 'Missing a block parameter' unless @block
-    end
-
-    def consume (workitem)
-
-      result = call_block(@block, workitem)
-
-      workitem.set_result(result) if result and result != workitem
-
-      reply_to_engine(workitem) if workitem.kind_of?(InFlowWorkItem)
-        # else it's a cancel item
-    end
-  end
-
-  #
-  # Simply aliasing a participant.
-  #
-  #   engine.register_participant "toto" do |workitem|
-  #     workitem.toto_message = "toto was here"
-  #   end
-  #   engine.register_participant "user_.*", AliasParticipant.new("toto")
-  #
-  # Workitems for participant whose name starts with 'user_' will be handled
-  # by participant 'toto'.
-  # Note that you can't use use a regex as the aliased name ("toto" in the
-  # example).
-  #
-  class AliasParticipant
-    include LocalParticipant
-
-    attr_reader :aliased_name
-
-    def initialize (aliased_name)
-
-      @aliased_name = aliased_name
-    end
-
-    def consume (workitem)
-
-      get_participant_map.dispatch(nil, @aliased_name, workitem)
-    end
-  end
-
-  #
-  # The NullParticipant never replies, it simply discards the workitems
-  # it receives.
-  #
-  class NullParticipant
-    include LocalParticipant
-
-    #
-    # Simply discards the incoming workitem
-    #
-    def consume (workitem)
-      # does nothing and does not reply to the engine.
-    end
-  end
-
-  #
-  # The NoOperationParticipant immediately replies to the engine upon
-  # receiving a workitem.
-  #
-  # Is used in testing. Could also be useful during the 'development'
-  # phase of a business process, as an empty placeholder.
-  #
-  class NoOperationParticipant
-    include LocalParticipant
-
-    #
-    # Simply discards the incoming workitem
-    #
-    def consume (workitem)
-
-      reply_to_engine(workitem)
-    end
-  end
-
-  #
-  # The PrintParticipant will just emit its name to the
-  # test tracer if any or to the stdout else.
-  # Used by some unit tests.
-  #
-  class PrintParticipant
-    include LocalParticipant
-
-    def consume (workitem)
-
-      tracer = @application_context['__tracer']
-
-      if tracer
-        tracer << workitem.participant_name
-        tracer << "\n"
-      else
-        puts workitem.participant_name
-      end
-
-      reply_to_engine(workitem)
-    end
-  end
-
-  #
-  # Links a process under a participant [name].
-  #
-  # Turns top level processes into participants
-  #
-  # Some examples :
-  #
-  #   require 'engine/participants/participants'
-  #
-  #   engine.register_participant(
-  #     "transmit_to_accounting",
-  #     "http://company.process.server.ie/processes/acc0.xml")
-  #
-  #   engine.register_participant(
-  #     "hr_resume_review_process",
-  #     "file:/var/processes/hr_resume_review_process.rb")
-  #
-  # Some more examples :
-  #
-  #   class RegistrationProcess < OpenWFE::ProcessDefinition
-  #     sequence do
-  #       participant :ref => "Alice"
-  #       participant :ref => "Bob"
-  #     end
-  #   end
-  #
-  #   # later in the code ...
-  #
-  #   engine.register_participant("registration", RegistrationProcess)
-  #
-  # Or directly with some XML string :
-  #
-  #   engine.register_participant("registration", '''
-  #     <process-definition name="registration" revision="0.1">
-  #       <sequence>
-  #         <participant ref="Alice" />
-  #         <participant ref="Bob" />
-  #       </sequence>
-  #     </process-definition>
-  #   '''.strip)
-  #
-  # It's then easy to call the subprocess as if it were a participant :
-  #
-  #   sequence do
-  #     participant :ref => "registration"
-  #       # or
-  #     participant "registration"
-  #       # or simply
-  #     registration
-  #   end
-  #
-  # Note that the 'subprocess' expression may be used as well :
-  #
-  #   sequence do
-  #     subprocess ref => "http://dms.company.org/processes/proc1.rb"
-  #   end
-  #
-  # But you can't use the URL as an expression name for writing nice,
-  # concise, process definitions.
-  #
-  class ProcessParticipant
-    include LocalParticipant
-
-    #
-    # The 'object' may be the URL of a process definition or the process
-    # definition itself as an XML string or a Ruby process definition
-    # (as a class or in a String).
-    #
-    def initialize (object)
-
-      super()
-
-      template_uri = OpenWFE::parse_known_uri(object)
-
-      @template = template_uri || object
-    end
-
-    #
-    # This is the method called by the engine when it has a workitem
-    # for this participant.
-    #
-    def consume (workitem)
-
-      get_expression_pool.launch_subprocess(
-        get_flow_expression(workitem),
-        @template,
-        false, # don't forget
-        workitem,
-        nil) # no params for the new subprocess env
-    end
-  end
-
-  #
-  # This mixin provides an eval_template() method. This method assumes
-  # the target class has a @block_template and a @template, it also
-  # assumes the class includes the module LocalParticipant.
-  #
-  # This mixin is used for example in the MailParticipant class.
-  #
-  module TemplateMixin
-
-    #
-    # Given a workitem, expands the template and returns it as a String.
-    #
-    def eval_template (workitem)
-
-      fe = get_flow_expression(workitem)
-
-      template = if @block_template
-
-        call_block(@block_template, workitem)
-
-      elsif @template
-
-        template = if @template.kind_of?(File)
-          @template.readlines
-        else
-          @template.to_s
-        end
-
-      else
-
-        nil
-      end
-
-      return '(no template given)' unless template
-
-      OpenWFE::dosub(template, fe, workitem)
-    end
-  end
-
-end
-