lib/openwfe/flowexpressionid.rb in ruote-0.9.18 vs lib/openwfe/flowexpressionid.rb in ruote-0.9.19

@@ -1,34 +1,34 @@
 #
 #--
 # Copyright (c) 2005-2008, John Mettraux, OpenWFE.org
 # All rights reserved.
-# 
-# Redistribution and use in source and binary forms, with or without 
+#
+# 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 
+#   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 
+#
+# 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.
 #++
 #
 
 #
@@ -39,319 +39,321 @@
 #
 
 
 module OpenWFE
 
-    #
-    # A FlowExpressionId is a unique identifier for a FlowExpression (an atomic
-    # piece of a process instance).
-    # 
-    # As workitems move through a workflow among the expressions and are emitted
-    # outside of the business process engine via 'participant expressions', 
-    # these workitems are identified by the FlowExpressionId of the participant
-    # expression that pushed them out (and is usually waiting for them 
-    # to come back).
-    #
-    class FlowExpressionId
+  #
+  # A FlowExpressionId is a unique identifier for a FlowExpression (an atomic
+  # piece of a process instance).
+  #
+  # As workitems move through a workflow among the expressions and are emitted
+  # outside of the business process engine via 'participant expressions',
+  # these workitems are identified by the FlowExpressionId of the participant
+  # expression that pushed them out (and is usually waiting for them
+  # to come back).
+  #
+  class FlowExpressionId
 
-        FIELDS = [ 
-            :owfe_version, 
-            :engine_id, 
-            #:initial_engine_id,
-            :workflow_definition_url,
-            :workflow_definition_name,
-            :workflow_definition_revision,
-            :workflow_instance_id,
-            :expression_name,
-            :expression_id
-        ]
+    FIELDS = [
+      :owfe_version,
+      :engine_id,
+      #:initial_engine_id,
+      :workflow_definition_url,
+      :workflow_definition_name,
+      :workflow_definition_revision,
+      :workflow_instance_id,
+      :expression_name,
+      :expression_id
+    ]
 
-        FIELDS.each { |f| attr_accessor f }
+    FIELDS.each { |f| attr_accessor f }
 
-        alias :expid :expression_id
-        alias :expid= :expression_id=
+    alias :expid :expression_id
+    alias :expid= :expression_id=
 
-        alias :expname :expression_name
-        alias :wfurl :workflow_definition_url
-        alias :wfname :workflow_definition_name
-        alias :wfrevision :workflow_definition_revision
+    alias :expname :expression_name
+    alias :wfurl :workflow_definition_url
+    alias :wfname :workflow_definition_name
+    alias :wfrevision :workflow_definition_revision
 
-        #--
-        # a trick : returns self...
-        #
-        #def fei
-        #    self
-        #end
-        #++
+    #--
+    # a trick : returns self...
+    #
+    #def fei
+    #  self
+    #end
+    #++
 
-        #
-        # This method return @workflow_instance_id. If parent is set to
-        # true, if will return the same result as 
-        # parent_workflow_instance_id().
-        #
-        def wfid (parent=false)
+    #
+    # This method return @workflow_instance_id. If parent is set to
+    # true, if will return the same result as
+    # parent_workflow_instance_id().
+    #
+    def wfid (parent=false)
 
-            if parent
-                parent_workflow_instance_id
-            else
-                workflow_instance_id
-            end
-        end
-        alias :wfid= :workflow_instance_id=
+      if parent
+        parent_workflow_instance_id
+      else
+        workflow_instance_id
+      end
+    end
+    alias :wfid= :workflow_instance_id=
 
-        #
-        # the old 'initial_engine_id' is now deprecated, the methods
-        # are still around though.
-        #
-        def initial_engine_id= (s)
+    #
+    # the old 'initial_engine_id' is now deprecated, the methods
+    # are still around though.
+    #
+    def initial_engine_id= (s)
 
-            # silently discard
-        end
-        def initial_engine_id
+      # discard silently
+    end
+    def initial_engine_id
 
-            @engine_id
-        end
+      @engine_id
+    end
 
-        #
-        # Overrides the classical to_s()
-        #
-        def to_s
-            "(fei #{@owfe_version} #{@engine_id} #{wfurl} #{wfname} #{wfrevision} #{wfid} #{expname} #{expid})"
-        end
+    #
+    # Overrides the classical to_s()
+    #
+    def to_s
 
-        #
-        # Returns a hash version of this FlowExpressionId instance.
-        #
-        def to_h
+      "(fei #{@owfe_version} #{@engine_id} #{wfurl} #{wfname} #{wfrevision} #{wfid} #{expname} #{expid})"
+    end
 
-            FIELDS.inject({}) { |r, f| r[f] = instance_eval("@#{f.to_s}"); r }
-        end
+    #
+    # Returns a hash version of this FlowExpressionId instance.
+    #
+    def to_h
 
-        #
-        # Rebuilds a FlowExpressionId from its Hash representation.
-        #
-        def FlowExpressionId.from_h (h)
+      FIELDS.inject({}) { |r, f| r[f] = instance_eval("@#{f.to_s}"); r }
+    end
 
-            FIELDS.inject FlowExpressionId.new do |fei, f| 
-                fei.instance_variable_set("@#{f}", h[f] || h[f.to_s])
-                fei
-            end
-        end
+    #
+    # Rebuilds a FlowExpressionId from its Hash representation.
+    #
+    def FlowExpressionId.from_h (h)
 
-        def hash
+      FIELDS.inject FlowExpressionId.new do |fei, f|
+        fei.instance_variable_set("@#{f}", h[f] || h[f.to_s])
+        fei
+      end
+    end
 
-            to_s.hash
-        end
+    def hash
 
-        def == (other)
+      to_s.hash
+    end
 
-            return false if not other.kind_of?(FlowExpressionId)
+    def == (other)
 
-            #return self.to_s == other.to_s
-                # no perf gain
+      return false if not other.kind_of?(FlowExpressionId)
 
-            @workflow_instance_id == other.workflow_instance_id and
-            @expression_id == other.expression_id and
-            @workflow_definition_url == other.workflow_definition_url and
-            @workflow_definition_revision == other.workflow_definition_revision and
-            @workflow_definition_name == other.workflow_definition_name and
-            @expression_name == other.expression_name and
-            @owfe_version == other.owfe_version and 
-            @engine_id == other.engine_id
-            #@initial_engine_id == other.initial_engine_id
-                #
-                # Made sure to put on top of the 'and' the things that
-                # change the most...
-        end
+      #return self.to_s == other.to_s
+        # no perf gain
 
+      @workflow_instance_id == other.workflow_instance_id and
+      @expression_id == other.expression_id and
+      @workflow_definition_url == other.workflow_definition_url and
+      @workflow_definition_revision == other.workflow_definition_revision and
+      @workflow_definition_name == other.workflow_definition_name and
+      @expression_name == other.expression_name and
+      @owfe_version == other.owfe_version and
+      @engine_id == other.engine_id
+      #@initial_engine_id == other.initial_engine_id
         #
-        # Returns true if this other FlowExpressionId is nested within
-        # this one.
-        #
-        # For example (fei TestTag 3 20070331-goyunodabu 0.0.0 sequence)
-        # is an ancestor of (fei TestTag 3 20070331-goyunodabu 0.0.0.1 redo)
-        #
-        # This current implementation doesn't cross the subprocesses 
-        # boundaries.
-        #
-        def ancestor_of? (other_fei)
+        # Made sure to put on top of the 'and' the things that
+        # change the most...
+    end
 
-            o = other_fei.dup
-            o.expression_name = @expression_name
-            o.expression_id = @expression_id
+    #
+    # Returns true if this other FlowExpressionId is nested within
+    # this one.
+    #
+    # For example (fei TestTag 3 20070331-goyunodabu 0.0.0 sequence)
+    # is an ancestor of (fei TestTag 3 20070331-goyunodabu 0.0.0.1 redo)
+    #
+    # This current implementation doesn't cross the subprocesses
+    # boundaries.
+    #
+    def ancestor_of? (other_fei)
 
-            return false unless self == o
+      o = other_fei.dup
+      o.expression_name = @expression_name
+      o.expression_id = @expression_id
 
-            OpenWFE::starts_with other_fei.expression_id, @expression_id
-        end
+      return false unless self == o
 
-        #
-        # Returns a deep copy of this FlowExpressionId instance.
-        #
-        def dup
+      OpenWFE::starts_with other_fei.expression_id, @expression_id
+    end
 
-            OpenWFE::fulldup(self)
-        end
+    #
+    # Returns a deep copy of this FlowExpressionId instance.
+    #
+    def dup
 
-        alias eql? ==
+      OpenWFE::fulldup(self)
+    end
 
-        def to_debug_s
-            "(fei #{wfname} #{wfrevision} #{wfid} #{expid} #{expname})"
-        end
+    alias eql? ==
 
-        #
-        # Returns a very short string representation (fei wfid expid expname).
-        #
-        def to_short_s
-            "(fei #{wfid} #{expid} #{expname})"
-        end
+    def to_debug_s
+      "(fei #{wfname} #{wfrevision} #{wfid} #{expid} #{expname})"
+    end
 
-        #
-        # Returns a URI escaped string with just the wfid and the expid, like
-        # '20070917-dupibodasa__0.0.1'
-        #
-        # Useful for unique identifier in URIs.
-        #
-        def to_web_s
+    #
+    # Returns a very short string representation (fei wfid expid expname).
+    #
+    def to_short_s
+      "(fei #{wfid} #{expid} #{expname})"
+    end
 
-            eid = expid.gsub("\.", "_")
+    #
+    # Returns a URI escaped string with just the wfid and the expid, like
+    # '20070917-dupibodasa__0.0.1'
+    #
+    # Useful for unique identifier in URIs.
+    #
+    def to_web_s
 
-            URI.escape "#{wfid}__#{eid}"
-        end
+      wid = wfid.gsub("\.", "_")
+      eid = expid.gsub("\.", "_")
 
-        #
-        # Splits the web fei into the workflow instance id and the expression
-        # id.
-        #
-        def self.split_web_s (s)
+      URI.escape("#{wid}__#{eid}")
+    end
 
-            i = s.rindex("__")
+    #
+    # Splits the web fei into the workflow instance id and the expression
+    # id.
+    #
+    def self.split_web_s (s)
 
-            [ s[0..i-1], s[i+2..-1].gsub("\_", ".") ]
-        end
+      i = s.rindex("__")
 
-        #
-        # Yet another debugging method. Just returns the sub_instance_id and
-        # the expression_id, in a string.
-        #
-        def to_env_s
+      [ s[0..i-1].gsub("\_", "."), s[i+2..-1].gsub("\_", ".") ]
+    end
 
-            "i#{sub_instance_id}  #{@expression_id}"
-        end
+    #
+    # Yet another debugging method. Just returns the sub_instance_id and
+    # the expression_id, in a string.
+    #
+    def to_env_s
 
-        #
-        # Returns the workflow instance id without any subflow indices.
-        # For example, if the wfid is "1234.0.1", this method will
-        # return "1234".
-        #
-        def parent_workflow_instance_id
+      "i#{sub_instance_id}  #{@expression_id}"
+    end
 
-            FlowExpressionId.to_parent_wfid workflow_instance_id
-        end
+    #
+    # Returns the workflow instance id without any subflow indices.
+    # For example, if the wfid is "1234.0.1", this method will
+    # return "1234".
+    #
+    def parent_workflow_instance_id
 
-        alias :parent_wfid :parent_workflow_instance_id
+      FlowExpressionId.to_parent_wfid workflow_instance_id
+    end
 
-        #
-        # Returns "" if this expression id belongs to a top process,
-        # returns something like ".0" or ".1.3" if this exp id belongs to
-        # an expression in a subprocess.
-        # (Only used in some unit tests for now)
-        #
-        def sub_instance_id
+    alias :parent_wfid :parent_workflow_instance_id
 
-            i = workflow_instance_id.index(".")
-            return "" unless i
-            workflow_instance_id[i..-1]
-        end
+    #
+    # Returns "" if this expression id belongs to a top process,
+    # returns something like ".0" or ".1.3" if this exp id belongs to
+    # an expression in a subprocess.
+    # (Only used in some unit tests for now)
+    #
+    def sub_instance_id
 
-        #
-        # If this flow expression id belongs to a sub instance, a call to 
-        # this method will return the last number of the sub instanceid.
-        #
-        # For example, in the case of the instance "20071114-dukikomino.1", "1"
-        # will be returned. For "20071114-dukikomino.1.0", "0" will be returned.
-        #
-        # If the flow expression id doesn't belong to a sub instance, nil
-        # will be returned.
-        #
-        def last_sub_instance_id
+      i = workflow_instance_id.index(".")
+      return "" unless i
+      workflow_instance_id[i..-1]
+    end
 
-            i = workflow_instance_id.rindex(".")
-            return nil unless i
-            workflow_instance_id[i+1..-1]
-        end
+    #
+    # If this flow expression id belongs to a sub instance, a call to
+    # this method will return the last number of the sub instanceid.
+    #
+    # For example, in the case of the instance "20071114-dukikomino.1", "1"
+    # will be returned. For "20071114-dukikomino.1.0", "0" will be returned.
+    #
+    # If the flow expression id doesn't belong to a sub instance, nil
+    # will be returned.
+    #
+    def last_sub_instance_id
 
-        #
-        # Returns true if this flow expression id belongs to a process
-        # which is not a subprocess.
-        #
-        def is_in_parent_process?
+      i = workflow_instance_id.rindex(".")
+      return nil unless i
+      workflow_instance_id[i+1..-1]
+    end
 
-            (sub_instance_id == "")
-        end
+    #
+    # Returns true if this flow expression id belongs to a process
+    # which is not a subprocess.
+    #
+    def is_in_parent_process?
 
-        #
-        # Returns the last part of the expression_id. For example, if
-        # the expression_id is "0.1.0.4", "4" will be returned.
-        #
-        # This method is used in "concurrence" when merging workitems coming
-        # backing from the children expressions.
-        #
-        def child_id
+      (sub_instance_id == "")
+    end
 
-            i = @expression_id.rindex(".")
-            return @expression_id unless i
-            @expression_id[i+1..-1]
-        end
+    #
+    # Returns the last part of the expression_id. For example, if
+    # the expression_id is "0.1.0.4", "4" will be returned.
+    #
+    # This method is used in "concurrence" when merging workitems coming
+    # backing from the children expressions.
+    #
+    def child_id
 
-        #
-        # This class method parses a string into a FlowExpressionId instance
-        #
-        def self.to_fei (string)
+      i = @expression_id.rindex(".")
+      return @expression_id unless i
+      @expression_id[i+1..-1]
+    end
 
-            fei = FlowExpressionId.new
+    #
+    # This class method parses a string into a FlowExpressionId instance
+    #
+    def self.to_fei (string)
 
-            ss = string.split(" ")
+      fei = FlowExpressionId.new
 
-            #require 'pp'; puts; pp ss
+      ss = string.split(" ")
 
-            ss = ss[1..-1] if ss[0] == "("
+      #require 'pp'; puts; pp ss
 
-            fei.owfe_version = ss[1]
+      ss = ss[1..-1] if ss[0] == "("
 
-            ssRawEngineId = ss[2].split("/")
-            fei.engine_id = ssRawEngineId[0]
-            #fei.initial_engine_id = ssRawEngineId[1]
+      fei.owfe_version = ss[1]
 
-            fei.workflow_definition_url = ss[3]
-            fei.workflow_definition_name = ss[4]
-            fei.workflow_definition_revision = ss[5]
-            fei.workflow_instance_id = ss[6]
-            fei.expression_name = ss[7]
-            fei.expression_id = ss[8][0..-2]
+      ssRawEngineId = ss[2].split("/")
+      fei.engine_id = ssRawEngineId[0]
+      #fei.initial_engine_id = ssRawEngineId[1]
 
-            fei.expression_id = fei.expression_id[0..-2] \
-                if fei.expression_id[-1, 1] == ")"
+      fei.workflow_definition_url = ss[3]
+      fei.workflow_definition_name = ss[4]
+      fei.workflow_definition_revision = ss[5]
+      fei.workflow_instance_id = ss[6]
+      fei.expression_name = ss[7]
+      fei.expression_id = ss[8][0..-2]
 
-            fei
-        end
+      fei.expression_id = fei.expression_id[0..-2] \
+        if fei.expression_id[-1, 1] == ")"
 
-        #
-        # An alias for to_fei(string)
-        #
-        def self.from_s (string)
+      fei
+    end
 
-            to_fei string
-        end
+    #
+    # An alias for to_fei(string)
+    #
+    def self.from_s (string)
 
-        #
-        # If wfid is already a 'parent wfid' (no sub id), returns it. Else
-        # returns the parent wfid (whatever is before the first ".").
-        #
-        def self.to_parent_wfid (wfid)
+      to_fei string
+    end
 
-            wfid.split(".").first
-        end
+    #
+    # If wfid is already a 'parent wfid' (no sub id), returns it. Else
+    # returns the parent wfid (whatever is before the first ".").
+    #
+    def self.to_parent_wfid (wfid)
+
+      wfid.split(".").first
     end
+  end
 
 end