openwferu 0.9.15 → 0.9.16

data/lib/openwfe/expressions/raw.rb

@@ -57,6 +57,8 @@ module OpenWFE
 
             super(fei, parent_id, env_id, application_context, nil)
 
+            #linfo { "initialize() '#{fei.expression_name}'" }
+
             @raw_representation = raw_representation
 
             #new_environment() if not @environment_id
@@ -92,8 +94,6 @@ module OpenWFE
 
             expression.children = extract_children()
 
-            expression.store_itself()
-
             expression
         end
 
@@ -108,11 +108,8 @@ module OpenWFE
             expression = instantiate_real_expression(
                 workitem, exp_name, exp_class, attributes)
 
-            #expression.apply_time = OpenWFE::now()
-                #
-                # This method is extremely costly, now avoiding it
-
             expression.apply_time = Time.now
+            expression.store_itself
 
             expression.apply workitem
         end
@@ -207,15 +204,17 @@ module OpenWFE
 
                     if participant_name
                         exp_name = participant_name
-                        exp_class = OpenWFE::ParticipantExpression
+                        exp_class = ParticipantExpression
                         attributes['ref'] = participant_name
                     end
 
-                elsif var_value.is_a?(OpenWFE::FlowExpressionId)
+                elsif var_value.is_a?(FlowExpressionId) \
+                    or var_value.is_a?(RawExpression)
 
-                    exp_class = OpenWFE::SubProcessRefExpression
+                    exp_class = SubProcessRefExpression
                     attributes['ref'] = exp_name
                 end
+                # else, it's a standard expression
 
                 [ exp_name, exp_class, attributes ]
             end
@@ -237,30 +236,32 @@ module OpenWFE
                     else
                         "description__#{k}"
                     end
-                    set_variable vname, description
+                    set_variable vname, description.to_s
                 end
 
                 return if ds.length < 1
 
-                set_variable "description", ds[0][1] \
+                set_variable "description", ds[0][1].to_s \
                     unless default
             end
 
-            def extract_attributes ()
-                raise NotImplementedError.new("'abstract method' sorry")
-            end
-            def extract_children ()
-                raise NotImplementedError.new("'abstract method' sorry")
-            end
-            def extract_descriptions ()
-                raise NotImplementedError.new("'abstract method' sorry")
-            end
-            def extract_parameters ()
-                raise NotImplementedError.new("'abstract method' sorry")
-            end
-            def extract_text_children ()
-                raise NotImplementedError.new("'abstract method' sorry")
-            end
+            #--
+            #def extract_attributes ()
+            #    raise NotImplementedError.new("'abstract method' sorry")
+            #end
+            #def extract_children ()
+            #    raise NotImplementedError.new("'abstract method' sorry")
+            #end
+            #def extract_descriptions ()
+            #    raise NotImplementedError.new("'abstract method' sorry")
+            #end
+            #def extract_parameters ()
+            #    raise NotImplementedError.new("'abstract method' sorry")
+            #end
+            #def extract_text_children ()
+            #    raise NotImplementedError.new("'abstract method' sorry")
+            #end
+            #++
 
             #
             # Expressions can get tagged. Tagged expressions can easily
@@ -268,7 +269,7 @@ module OpenWFE
             #
             def consider_tag (workitem, new_expression)
 
-                tagname = new_expression.lookup_attribute(:tag, workitem)
+                tagname = new_expression.lookup_string_attribute :tag, workitem
 
                 return unless tagname
 
@@ -313,10 +314,10 @@ module OpenWFE
 
                 def initialize (field, match, default, type)
 
-                    @field = field
-                    @match = match
-                    @default = default
-                    @type = type
+                    @field = to_s field
+                    @match = to_s match
+                    @default = to_s default
+                    @type = to_s type
                 end
 
                 #
@@ -347,6 +348,14 @@ module OpenWFE
 
                 protected
 
+                    #
+                    # Used in the constructor to flatten everything to strings.
+                    #
+                    def to_s (o)
+                        return nil unless o
+                        o.to_s
+                    end
+
                     #
                     # Will raise an exception if it cannot coerce the type
                     # of the value to the one desired.

data/lib/openwfe/expressions/raw_prog.rb

@@ -107,10 +107,14 @@ module OpenWFE
 
             #puts " ... params.class is #{params.class}"
 
-            if params.kind_of? Hash 
+            if params.kind_of?(Hash)
                 params.each do |k, v|
-                    #attributes[k.to_s] = v.to_s
-                    attributes[OpenWFE::symbol_to_name(k.to_s)] = v.to_s
+                    if k == '0'
+                        string_child = v.to_s
+                    else
+                        #attributes[OpenWFE::symbol_to_name(k.to_s)] = v.to_s
+                        attributes[OpenWFE::symbol_to_name(k.to_s)] = v
+                    end
                 end
             elsif params
                 string_child = params.to_s
@@ -223,9 +227,10 @@ module OpenWFE
             def ProcessDefinition.pack_args (args)
 
                 return args[0] if args.length == 1
+
                 a = {}
                 args.each_with_index do |arg, index|
-                    if arg.is_a? Hash
+                    if arg.is_a?(Hash)
                         a = a.merge(arg)
                         break
                     end
@@ -254,6 +259,7 @@ module OpenWFE
             end
 
             def ProcessDefinition.as_revision (s)
+
                 s.gsub("_", ".")
             end
 
@@ -330,6 +336,7 @@ module OpenWFE
         protected 
 
             def extract_attributes ()
+
                 raw_representation.attributes
             end
 
@@ -356,7 +363,7 @@ module OpenWFE
                 result = []
                 raw_representation.children.each do |child|
 
-                    if child.kind_of? SimpleExpRepresentation
+                    if child.kind_of?(SimpleExpRepresentation)
 
                         cname = child.name.intern
 
@@ -373,7 +380,7 @@ module OpenWFE
                         rawexp = ProgRawExpression\
                             .new(cfei, @fei, efei, @application_context, child)
 
-                        get_expression_pool.update(rawexp)
+                        get_expression_pool.update rawexp
 
                         i = i + 1
 
@@ -387,8 +394,9 @@ module OpenWFE
             end
 
             def extract_text_children ()
+
                 raw_representation.children.collect do |child|
-                    next if child.is_a? SimpleExpRepresentation
+                    next if child.is_a?(SimpleExpRepresentation)
                     child.to_s
                 end
             end
@@ -398,9 +406,9 @@ module OpenWFE
                 r = []
                 raw_representation.children.each do |child|
 
-                    next unless child.is_a? SimpleExpRepresentation
+                    next unless child.is_a?(SimpleExpRepresentation)
 
-                    name = child.name.intern
+                    name = child.name.to_sym
                     next unless (name == :parameter or name == :param)
 
                     r << Parameter.new(
@@ -425,6 +433,7 @@ module OpenWFE
         #
         KEYWORDS = [
             :if, :do, :redo, :undo, :print, :sleep, :loop, :break, :when
+            #:until, :while
         ]
 
         #

data/lib/openwfe/expressions/raw_xml.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
 #
 # "made in Japan"
@@ -55,12 +53,7 @@ module OpenWFE
         def initialize \
             (fei, parent_id, env_id, application_context, raw_representation)
 
-            super(
-                fei, 
-                parent_id, 
-                env_id, 
-                application_context, 
-                raw_representation)
+            super
 
             @raw_representation_s = raw_representation.to_s
         end

data/lib/openwfe/expressions/simplerep.rb

@@ -48,6 +48,8 @@ module OpenWFE
     # A raw representation for a process definition, programmatic
     # process definitions are turned into trees of instances of this class.
     #
+    # It's just an s-expression somehow.
+    #
     class SimpleExpRepresentation
 
         attr_reader \
@@ -80,6 +82,24 @@ module OpenWFE
             ProgRawExpression
         end
 
+        #
+        # Finds the first child named 'description' and returns its
+        # first child as a String.
+        #
+        # TODO : manage languages, as specified in OpenWFE.
+        #
+        def get_description
+
+            return @children.first.to_s if @name == 'description'
+
+            @children.each do |child|
+                d = child.get_description
+                return d if d
+            end
+
+            nil
+        end
+
         #
         # Returns an XML string, containing the equivalent process definition
         # in the classical OpenWFE process definition language.
@@ -125,14 +145,16 @@ module OpenWFE
         def self.from_xml (xml)
 
             xml = REXML::Document.new(xml) \
-                if xml.is_a? String
+                if xml.is_a?(String)
 
             xml = xml.root \
-                if xml.is_a? REXML::Document
+                if xml.is_a?(REXML::Document)
 
-            if xml.is_a? REXML::Text
-                s = xml.to_s
-                return s if s.strip.length > 1
+            if xml.is_a?(REXML::Text)
+                #s = xml.to_s
+                #return s if s.strip.length > 1
+                s = xml.to_s.strip
+                return s if s.length > 0
                 return nil
             end
 

data/lib/openwfe/expressions/time.rb

@@ -53,15 +53,26 @@ module OpenWFE
     class TimeExpression < FlowExpression
         include Schedulable
 
-        attr_accessor \
-            :applied_workitem,
-            :scheduler_job_id
+        #
+        # The workitem received at apply time
+        #
+        attr_accessor :applied_workitem
+
+        #
+        # The job_id in the scheduler for this expression
+        #
+        attr_accessor :scheduler_job_id
+
+        #
+        # The tags (if any) for the job in the scheduler
+        #
+        attr_accessor :scheduler_tags
 
         #
         # Makes sure to cancel any scheduler job associated with this
         # expression
         #
-        def cancel ()
+        def cancel
             synchronize do
 
                 ldebug { "cancel()..." }
@@ -78,13 +89,27 @@ module OpenWFE
         # If the expression has been scheduled, a call to this method
         # will make sure it's unscheduled (removed from the scheduler).
         #
-        def unschedule ()
+        def unschedule
 
             ldebug { "unschedule() @scheduler_job_id is #{@scheduler_job_id}" }
 
             get_scheduler.unschedule(@scheduler_job_id) \
                 if @scheduler_job_id
         end
+
+        protected
+
+            def determine_scheduler_tags
+
+                st = lookup_attribute :scheduler_tags, @applied_workitem
+
+                @scheduler_tags = if st 
+                    st.split(",").collect { |s| s.strip }
+                else
+                    []
+                end
+                @scheduler_tags << self.class.name
+            end
     end
 
     #
@@ -94,7 +119,8 @@ module OpenWFE
     # concentrated here.
     #
     class WaitingExpression < TimeExpression
-        include ConditionMixin, TimeoutMixin
+        include ConditionMixin
+        include TimeoutMixin
 
         attr_accessor :frequency
 
@@ -119,20 +145,21 @@ module OpenWFE
 
         def apply (workitem)
 
-            remove_timedout_flag(workitem)
+            remove_timedout_flag workitem
 
             @applied_workitem = workitem.dup
 
-            @frequency = 
-                lookup_attribute(:frequency, workitem, DEFAULT_FREQUENCY)
-            @frequency = 
-                OpenWFE::parse_time_string(@frequency)
+            @frequency = lookup_attribute(
+                :frequency, workitem, :default => DEFAULT_FREQUENCY)
+            @frequency = OpenWFE::parse_time_string(
+                @frequency)
 
-            determine_timeout()
+            determine_timeout
+            determine_scheduler_tags
 
-            store_itself()
+            store_itself
 
-            trigger()
+            trigger
         end
 
         def reply (workitem)
@@ -176,7 +203,10 @@ module OpenWFE
 
             scheduler.schedule_in(
                 @frequency, 
-                { :schedulable => self, :job_id => @scheduler_job_id })
+                { 
+                    :schedulable => self, 
+                    :job_id => @scheduler_job_id,
+                    :tags => @scheduler_tags })
 
             ldebug { "reschedule() @scheduler_job_id is #{@scheduler_job_id}" }
 

data/lib/openwfe/expressions/timeout.rb

@@ -139,7 +139,8 @@ module OpenWFE
                     @timeout_at, 
                     { :schedulable => self, 
                       :job_id => @timeout_job_id,
-                      :do_timeout! => true })
+                      :do_timeout! => true,
+                      :tags => [ "timeout", self.class.name ] })
 
                 ldebug do 
                     "to_reschedule() will timeout at " +

data/lib/openwfe/expressions/wtemplate.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-#  $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
 #
 # "made in Japan"
@@ -56,9 +54,11 @@ module OpenWFE
         # (templates) before replying to its parent.
         #
         def reply_to_parent (workitem)
+
             @children.each do |child|
                 get_expression_pool.remove(child)
             end
+
             super(workitem)
         end
     end

data/lib/openwfe/flowexpressionid.rb

@@ -46,16 +46,17 @@ module OpenWFE
     # 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 waiting for them to come back).
+    # 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,
+            #:initial_engine_id,
             :workflow_definition_url,
             :workflow_definition_name,
             :workflow_definition_revision,
@@ -79,17 +80,30 @@ module OpenWFE
         alias :wfname :workflow_definition_name
         alias :wfrevision :workflow_definition_revision
 
+        #
+        # 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
+
+            @engine_id
+        end
+
         #
         # Overrides the classical to_s()
         #
-        def to_s ()
-            "(fei #{@owfe_version} #{@engine_id}/#{@initial_engine_id} #{@workflow_definition_url} #{@workflow_definition_name} #{@workflow_definition_revision} #{@workflow_instance_id} #{@expression_name} #{@expression_id})"
+        def to_s
+            "(fei #{@owfe_version} #{@engine_id} #{@workflow_definition_url} #{@workflow_definition_name} #{@workflow_definition_revision} #{@workflow_instance_id} #{@expression_name} #{@expression_id})"
         end
 
         #
         # Returns a hash version of this FlowExpressionId instance.
         #
-        def to_h ()
+        def to_h
 
             h = {}
             FIELDS.each { |f| h[f] = instance_eval("@#{f.to_s}") }
@@ -107,6 +121,7 @@ module OpenWFE
         end
 
         def hash ()
+
             to_s().hash()
         end
 
@@ -124,10 +139,10 @@ module OpenWFE
             @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 and 
-            @initial_engine_id == other.initial_engine_id
+            @engine_id == other.engine_id
+            #@initial_engine_id == other.initial_engine_id
                 #
-                # Make sure to put on top of the 'and' the things that
+                # Made sure to put on top of the 'and' the things that
                 # change the most...
         end
 
@@ -190,6 +205,7 @@ module OpenWFE
         # the expression_id, in a string.
         #
         def to_env_s
+
             "i#{sub_instance_id}  #{@expression_id}"
         end
 
@@ -199,6 +215,7 @@ module OpenWFE
         # return "1234".
         #
         def parent_workflow_instance_id
+
             i = workflow_instance_id.index(".")
             return workflow_instance_id unless i
             workflow_instance_id[0..i-1]
@@ -213,11 +230,38 @@ module OpenWFE
         # (Only used in some unit tests for now)
         #
         def sub_instance_id
+
             i = workflow_instance_id.index(".")
             return "" unless i
             workflow_instance_id[i..-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
+
+            i = workflow_instance_id.rindex(".")
+            return nil unless i
+            workflow_instance_id[i+1..-1]
+        end
+
+        #
+        # Returns true if this flow expression id belongs to a process
+        # which is not a subprocess.
+        #
+        def is_in_parent_process?
+
+            (sub_instance_id == "")
+        end
+
         #
         # Returns the last part of the expression_id. For example, if
         # the expression_id is "0.1.0.4", "4" will be returned.
@@ -226,6 +270,7 @@ module OpenWFE
         # backing from the children expressions.
         #
         def child_id
+
             i = @expression_id.rindex(".")
             return @expression_id unless i
             @expression_id[i+1..-1]
@@ -234,9 +279,9 @@ module OpenWFE
         #
         # This class method parses a string into a FlowExpressionId instance
         #
-        def FlowExpressionId.to_fei (string)
+        def self.to_fei (string)
 
-            fei = FlowExpressionId.new()
+            fei = FlowExpressionId.new
 
             ss = string.split(" ")
 
@@ -247,8 +292,8 @@ module OpenWFE
             fei.owfe_version = ss[1]
 
             ssRawEngineId = ss[2].split("/")
-            fei.engine_id= ssRawEngineId[0]
-            fei.initial_engine_id= ssRawEngineId[1]
+            fei.engine_id = ssRawEngineId[0]
+            #fei.initial_engine_id = ssRawEngineId[1]
 
             fei.workflow_definition_url = ss[3]
             fei.workflow_definition_name = ss[4]
@@ -266,8 +311,9 @@ module OpenWFE
         #
         # An alias for to_fei(string)
         #
-        def FlowExpressionId.from_s (string)
-            FlowExpressionId.to_fei(string)
+        def self.from_s (string)
+
+            to_fei string
         end
     end