ruote 0.9.20 → 2.1.1

data/lib/openwfe/engine/lookup_methods.rb

@@ -1,156 +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.
-#++
-
-
-module OpenWFE
-
-  #
-  # Engine methods for looking up variables and fields (workitem attributes)
-  #
-  module LookupMethods
-
-    #
-    # Looks up a process variable in a process.
-    # If fei_or_wfid is not given, will simply look in the
-    # 'engine environment' (where the top level variables '//' do reside).
-    #
-    def lookup_variable (var_name, fei_or_wfid=nil)
-
-      return get_expression_pool.fetch_engine_environment[var_name] \
-        unless fei_or_wfid
-
-      fetch_exp(fei_or_wfid).lookup_variable(var_name)
-    end
-
-    #
-    # Returns the variables set for a process or an expression.
-    #
-    # If a process (wfid) is given, variables of the process environment
-    # will be returned, else variables in the environment valid for the
-    # expression (fei) will be returned.
-    #
-    # If nothing (or nil) is given, the variables set in the engine
-    # environment will be returned.
-    #
-    def get_variables (fei_or_wfid=nil)
-
-      return get_expression_pool.fetch_engine_environment.variables \
-        unless fei_or_wfid
-
-      fetch_exp(fei_or_wfid).get_environment.variables
-    end
-
-    #
-    # A method for looking up process instances. It expects some options /
-    # parameters. The scope is rather wide, it may look among fields
-    # (attributes) of workitems and variables of processes.
-    #
-    # Returns an array of wfid (workflow instance ids)
-    #
-    # :value or :val ::
-    #   matches processes with a field or variable with the given value
-    # :name ::
-    #   matches processes containing a field or a variable with that name
-    # :variable_name or :var_name or :v_name ::
-    #   matches processes with a variable with that name
-    # :field_name or :f_name ::
-    #   matches processes with a workitem field named like this
-    # :wfid_prefix ::
-    #   matches processes whose wfid (process instance id) begins with the given
-    #   value
-    # :wfid ::
-    #   matches the process instance whose wfid (process instance id) is given
-    #   here
-    #
-    def lookup_processes (options)
-
-      val = options[:value] || options[:val]
-
-      vf = options[:vf]
-      var = options[:variable] || options[:var] || options[:v] || vf
-      field = options[:field] || options[:f] || vf
-
-      raise "specify at least :variable or :field" \
-        if (var == nil) and (field == nil)
-
-      opts = {
-        :wfid => options[:wfid],
-        :wfid_prefix => options[:wfid_prefix]
-      }
-
-      # do look up...
-
-      opts[:include_classes] = Environment if field == nil
-
-      exps = get_expression_storage.find_expressions(opts)
-
-      result = exps.find_all do |exp|
-        v_match?(exp, var, val) || f_match?(exp, field, val)
-      end
-
-      result.collect { |exp| exp.fei.wfid }
-    end
-
-    protected
-
-      def f_match? (exp, field, value)
-
-        return false unless field
-        return false unless exp.respond_to?(:applied_workitem)
-
-        h_match?(exp.applied_workitem.attributes, field, value, true)
-      end
-
-      def v_match? (exp, var, value)
-
-        return false unless var
-        return false unless exp.is_a?(Environment)
-        return false if exp.fei.wfid == '0' # (engine environment)
-
-        h_match?(exp.variables, var, value)
-      end
-
-      def h_match? (h, k, v, recursive=false)
-
-        val = h[k]
-
-        if val != nil
-          case v
-            when nil then return true
-            when Regexp then return true if v.match(val)
-            else return true if v == val
-          end
-        end
-
-        return false unless recursive
-
-        h.values.each do |val|
-          return true if val.is_a?(Hash) and h_match?(val, k, v, true)
-        end
-
-        false
-      end
-  end
-end
-

data/lib/openwfe/engine/participant_methods.rb

@@ -1,141 +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.
-#++
-
-
-module OpenWFE
-
-  #
-  # The methods of the engine about participants (register, unregister,
-  # lookup, ...)
-  #
-  module ParticipantMethods
-
-    #
-    # Registers a participant in this [embedded] engine.
-    # This method is a shortcut to the ParticipantMap method
-    # with the same name.
-    #
-    #   engine.register_participant "user-.*", HashParticipant
-    #
-    # or
-    #
-    #   require 'openwfe/participants/mail_participants'
-    #
-    #   engine.register_participant(
-    #     'user-toto',
-    #     OpenWFE::MailParticipant.new(
-    #       :smtp_server => "mailhost.ourcompany.co.jp",
-    #       :smtp_port => 25,
-    #       :from_address => "bpms@our.ourcompany.co.jp"
-    #     ) { |workitem|
-    #       s = ""
-    #       s << "Dear #{workitem.name},\n"
-    #       s << "\n"
-    #       s << "it's #{Time.new.to_s} and you've got mail"
-    #       s
-    #     })
-    #
-    # or
-    #
-    #   engine.register_participant "user-.*" do |wi|
-    #     puts "participant '#{wi.participant_name}' received a workitem"
-    #     #
-    #     # and did nothing with it
-    #     # as a block participant implicitely returns the workitem
-    #     # to the engine
-    #   end
-    #
-    # Returns the participant instance.
-    #
-    # The participant parameter can be set to hash like in
-    #
-    #   engine.register_participant(
-    #     "alpha",
-    #     { :participant => HashParticipant, :position => :first })
-    #
-    # or
-    #
-    #   engine.register_participant("alpha", :position => :first) do
-    #     puts "first !"
-    #   end
-    #
-    # There are some times where you have to position a participant first
-    # (especially with the regex technique).
-    #
-    # some participants have an 'initialize' method whose unique parameter
-    # is a option hash
-    #
-    #   engine.register_participant(
-    #     "investors",
-    #     InvestorParticipant,
-    #     { :money => 'lots of it', :clues => 'none' })
-    #
-    def register_participant (regex, participant=nil, options={}, &block)
-
-      params = participant.class == Hash ?
-        participant : { :participant => participant }
-
-      params = params.merge(options)
-
-      get_participant_map.register_participant(regex, params, &block)
-    end
-
-    #
-    # Given a participant name, returns the participant in charge
-    # of handling workitems for that name.
-    # May be useful in some embedded contexts.
-    #
-    def get_participant (participant_name)
-
-      get_participant_map.lookup_participant(participant_name)
-    end
-
-    #
-    # Removes the first participant matching the given name from the
-    # participant map kept by the engine.
-    #
-    # If 'participant_name' is an integer, will remove the participant
-    # at that position in the participant list.
-    #
-    def unregister_participant (participant_name)
-
-      get_participant_map.unregister_participant(participant_name)
-    end
-
-    #
-    # Returns the list of participants registered in the engine.
-    # In the resolution order.
-    #
-    # Returns a list of [ regex, participant ] pairs.
-    #
-    def participants
-
-      get_participant_map.participants
-    end
-    #alias :list_participants :participants
-      # deprecated
-  end
-
-end
-

data/lib/openwfe/engine/status_methods.rb

@@ -1,382 +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
-
-  #
-  # ProcessStatus represents information about the status of a workflow
-  # process instance.
-  #
-  # The status is mainly a list of expressions and a hash of errors.
-  #
-  # Instances of this class are obtained via Engine.process_status().
-  #
-  class ProcessStatus
-
-    #
-    # the String workflow instance id of the Process.
-    #
-    attr_reader :wfid
-
-    #
-    # The list of the expressions currently active in the process instance.
-    #
-    # For instance, if your process definition is currently in a
-    # concurrence, more than one expressions may be listed here.
-    #
-    attr_reader :expressions
-
-    #
-    # The list of all the expressions in the process (active or not).
-    #
-    attr_reader :all_expressions
-
-    #
-    # A list of all the applied workitems found in the process
-    # (participant expressions, for example, do keep a copy of the workitem
-    # they dispatched to the actual participant.
-    #
-    attr_reader :applied_workitems
-
-    #
-    # A hash whose values are ProcessError instances, the keys
-    # are FlowExpressionId instances (fei) (identifying the expressions
-    # that are concerned with the error)
-    #
-    attr_reader :errors
-
-    #
-    # The time at which the process got launched.
-    #
-    attr_reader :launch_time
-
-    #
-    # The variables hash as set in the process environment (the process
-    # scope).
-    #
-    attr_reader :variables
-
-    #
-    # The jobs registered for that process instance in the rufus
-    # scheduler used by the engine.
-    #
-    attr_accessor :scheduled_jobs
-
-    #
-    # Is the process currently in pause ?
-    #
-    attr_accessor :paused
-
-    #
-    # When was this ProcessStatus instance generated ?
-    #
-    attr_accessor :timestamp
-
-    #
-    # Builds an empty ProcessStatus instance.
-    #
-    def initialize
-
-      @wfid = nil
-      @expressions = nil
-      @all_expressions = []
-      @applied_workitems = []
-      @errors = {}
-      @launch_time = nil
-      @variables = nil
-      @scheduled_jobs = nil
-      @paused = false
-      @timestamp = Time.now
-
-      @all_expressions.extend(RepresentationMixin)
-    end
-
-    #
-    # Returns the workflow definition name for this process.
-    #
-    def wfname
-
-      @expressions.first.fei.wfname
-    end
-
-    alias :workflow_definition_name :wfname
-
-    #
-    # Returns the workflow definition revision for this process.
-    #
-    def wfrevision
-
-      @expressions.first.fei.wfrevision
-    end
-
-    alias :workflow_definition_revision :wfrevision
-
-    #
-    # Returns the count of concurrent branches currently active for
-    # this process. The typical 'sequential only' process will
-    # have a return value of 1 here.
-    #
-    def branches
-
-      @expressions.size
-    end
-
-    #
-    # Returns a list of the expression ids of the workitem currently active
-    # for this process
-    #
-    def workitem_expids
-
-      @expressions.collect { |exp| exp.fei.expid }
-    end
-
-    #
-    # Returns the tags currently set in this process.
-    #
-    def tags
-
-      return [] unless @variables
-
-      @variables.keys.select do |k|
-        @variables[k].is_a?(OpenWFE::RawExpression::Tag)
-      end
-    end
-
-    #
-    # Returns true if the process is in pause.
-    #
-    def paused?
-
-      #@expressions.first.paused?
-      @paused
-    end
-
-    #
-    # Returns the tree (representation of the process definition) as it
-    # currently is (in-flight modifications taken into account).
-    #
-    def current_tree
-
-      #@all_expressions.representation
-      @all_expressions.tree
-    end
-
-    #
-    # Returns the tree (representation of the process definition) as it
-    # was when the process instance was launched (in-flight modifications
-    # are NOT taken into account).
-    #
-    def initial_tree
-
-      #@all_expressions.find_root_expression.raw_representation
-      @all_expressions.initial_tree
-    end
-
-    #
-    # this method is used by Engine.get_process_status() when
-    # it prepares its results.
-    #
-    def << (item)
-
-      if item.is_a?(FlowExpression)
-
-        fei = item.fei
-
-        @wfid ||= fei.parent_wfid
-
-        @variables = item.variables if (
-          item.is_a?(Environment) and
-          fei.sub_instance_id == '' and
-          fei.expid == '0')
-
-        @launch_time ||= item.apply_time \
-          if item.fei.expid == '0' and item.fei.is_in_parent_process?
-
-        @all_expressions << item
-
-        wi = nil
-        wi = item.applied_workitem if item.respond_to?(:applied_workitem)
-        @applied_workitems << wi if wi
-
-      else
-
-        @errors[item.fei] = item
-      end
-    end
-
-    #--
-    # A lighter version
-    #
-    #def to_h
-    #end
-    #
-    #  moved to lib/openwfe/representations.rb
-    #++
-
-    protected
-
-      #
-      # Prepares the @expressions instance variable. This method
-      # is only called by the process_status method of the Engine.
-      #
-      def pack_expressions
-
-        @expressions = []
-
-        @all_expressions.sort_by { |fe|
-          "#{fe.fei.wfid} #{fe.fei.expid}"
-        }.each do |fe|
-
-          next unless fe.apply_time
-            # no Environment instances allowed
-
-          @expressions.delete_if { |e| e.fei == fe.parent_id }
-
-          @expressions << fe
-        end
-      end
-  end
-
-  #
-  # Simply adding a timestamp
-  #
-  module StatusesMixin
-
-    attr_accessor :timestamp
-  end
-
-  #
-  # This mixin is only included by the Engine class. It contains all
-  # the methods about ProcessStatus.
-  #
-  # Note : it caches process status to avoid too big a load on the
-  # expression storage, the weeping mecha stays here.
-  #
-  module StatusMethods
-
-    def init_status_cache
-
-      @status_cache = LruHash.new(30)
-      @all_status_cache = nil
-
-      get_expression_pool.add_observer(:all) do |event, *args|
-        fei = args.find { |a| a.is_a?(FlowExpressionId) }
-        @status_cache.delete(fei.wfid) if fei
-        @all_status_cache = nil if fei or event == :launch
-      end
-    end
-
-    #
-    # Returns a hash of ProcessStatus instances. The keys of the hash
-    # are workflow instance ids.
-    #
-    # A ProcessStatus is a description of the state of a process instance.
-    # It enumerates the expressions where the process is currently
-    # located (waiting certainly) and the errors the process currently
-    # has (hopefully none).
-    #
-    # the :wfid_prefix option is useful when you want to list all the process
-    # for a year (:wfid_prefix => '2007'), a month (:wfid_prefix => '200705') or
-    # a day (:wfid_prefix => '20070529').
-    #
-    def process_statuses (options={})
-
-      all = (options == {})
-
-      return @all_status_cache if all and @all_status_cache
-
-      init_status_cache unless @status_cache
-
-      options = { :wfid_prefix => options } if options.is_a?(String)
-
-      expressions = get_expression_storage.find_expressions(options)
-
-      result = expressions.inject({}) do |r, fe|
-        (r[fe.fei.parent_wfid] ||= ProcessStatus.new) << fe; r
-      end
-
-      result.values.each do |ps|
-
-        ps.paused = (get_expool.paused_instances[ps.wfid] != nil)
-
-        get_error_journal.get_error_log(ps.wfid).each { |er| ps << er }
-
-        ps.send(:pack_expressions) # letting it protected
-
-        ps.scheduled_jobs = get_scheduler.find_jobs(ps.wfid)
-      end
-
-      result.delete('0')
-      @status_cache.delete('0')
-
-      #
-      # done
-
-      result.extend(StatusesMixin)
-      result.timestamp = Time.now
-
-      @all_status_cache = result if all
-
-      result
-    end
-
-    # list_process_status() will be deprecated at release 1.0.0
-    #alias :list_process_status :process_statuses
-
-    #
-    # Like process_statuses, but returns an Array (of ProcessStatus instances)
-    # instead of a Hash.
-    #
-    def processes (options={})
-
-      process_statuses(options).values
-    end
-
-    #
-    # Returns the process status of one given process instance.
-    #
-    def process_status (wfid)
-
-      init_status_cache unless @status_cache
-
-      (r = @status_cache[wfid]) and return r
-
-      wfid = extract_wfid(wfid, true)
-
-      #process_statuses(:wfid_prefix => wfid).values.first
-      process_statuses(:wfid => wfid).values.first
-    end
-
-    #
-    # Returns true if the process is in pause.
-    #
-    def is_paused? (wfid)
-
-      (get_expression_pool.paused_instances[wfid] != nil)
-    end
-  end
-
-end
-