openwferu 0.9.16 → 0.9.17

data/lib/openwfe/omixins.rb

@@ -80,13 +80,15 @@ module OpenWFE
             #
             # A small method for ensuring we have a workflow instance id.
             #
-            def to_wfid (fei_or_wfid)
-                wfid = fei_or_wfid
-                wfid = wfid.parent_wfid if wfid.kind_of?(FlowExpressionId)
-                wfid.to_s
-            end
+            def extract_wfid (o, parent=false)
 
-            alias :extract_wfid :to_wfid
+                case o
+                    #when String then o
+                    when FlowExpressionId then o.wfid(parent)
+                    when FlowExpression then o.fei.wfid(parent)
+                    else o.to_s
+                end
+            end
     end
     
 end

data/lib/openwfe/orest/xmlcodec.rb

@@ -1,6 +1,6 @@
 #
 #--
-# Copyright (c) 2005-2007, John Mettraux, OpenWFE.org
+# Copyright (c) 2005-2008, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -32,7 +32,7 @@
 #
 
 #
-# "hecho en Costa Rica"
+# "hecho en Costa Rica" (with just the PickAxe at hand)
 #
 
 require 'base64'
@@ -243,13 +243,13 @@ module OpenWFE
                 #
                 # atomic types
 
-                return xmlElt.text \
+                return xmlElt.text.strip \
                     if xmlElt.name == E_STRING
-                return Integer(xmlElt.text) \
+                return Integer(xmlElt.text.strip) \
                     if xmlElt.name == E_INTEGER
-                return Integer(xmlElt.text) \
+                return Integer(xmlElt.text.strip) \
                     if xmlElt.name == E_LONG
-                return Float(xmlElt.text) \
+                return Float(xmlElt.text.strip) \
                     if xmlElt.name == E_DOUBLE
                 return parse_boolean(xmlElt.text) \
                     if xmlElt.name == E_BOOLEAN
@@ -315,6 +315,9 @@ module OpenWFE
                 #puts "decodeEntry() k >#{key}< v >#{val}<"
                 #puts "decodeEntry() subject '#{val}'" if key == '__subject__' 
 
+                key = key.strip if key.is_a?(String)
+                val = val.strip if val.is_a?(String)
+
                 map[key] = val
             end
 
@@ -631,19 +634,20 @@ module OpenWFE
 
         #return xml if xml.is_a?(String)
 
-        if decl and (not xml[0].is_a?(REXML::XMLDecl))
-            xml << REXML::XMLDecl.new()
-        end
+        xml << REXML::XMLDecl.new \
+            if decl and (not xml[0].is_a?(REXML::XMLDecl))
 
-        s = ""
-        xml.write(s, 0)
-        return s
+        #s = ""
+        #xml.write(s, 0)
+        #return s
+        xml.to_s
     end
 
     #
     # An alias for OpenWFE::xmldoc_to_string()
     #
     def OpenWFE.xml_to_s (xml, decl=true)
+
         OpenWFE::xmldoc_to_string(xml, decl)
     end
 

data/lib/openwfe/participants.rb

@@ -0,0 +1,38 @@
+#
+#--
+# Copyright (c) 2007, John Mettraux, OpenWFE.org
+# All rights reserved.
+# 
+# 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 
+#   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 
+# POSSIBILITY OF SUCH DAMAGE.
+#++
+#
+
+# just for nicer looking examples
+
+#require 'openwfe/participants/participants'
+require 'openwfe/worklist/storeparticipant'
+

data/lib/openwfe/participants/participant.rb

@@ -1,6 +1,6 @@
 #
 #--
-# Copyright (c) 2006-2007, John Mettraux, OpenWFE.org
+# Copyright (c) 2006-2008, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 

data/lib/openwfe/participants/participantmap.rb

@@ -1,6 +1,6 @@
 #
 #--
-# Copyright (c) 2006-2007, John Mettraux, OpenWFE.org
+# Copyright (c) 2006-2008, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -42,7 +42,7 @@ require 'openwfe/service'
 require 'openwfe/util/observable'
 require 'openwfe/participants/participants'
 
-include OpenWFE
+#include OpenWFE
 
 
 module OpenWFE
@@ -53,8 +53,7 @@ module OpenWFE
     class ParticipantMap < Service
         include OwfeObservable
 
-        attr_accessor \
-            :participants
+        attr_accessor :participants
 
         def initialize (service_name, application_context)
 
@@ -77,9 +76,18 @@ module OpenWFE
         # This method is called by the engine's own register_participant()
         # method.
         #
-        # The participant instance is returned by this method call
+        # The participant instance is returned by this method call.
         #
-        def register_participant (regex, participant=nil, &block)
+        # 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)
+
+            participant = params[:participant]
+            position = params[:position]
 
             if not participant
 
@@ -94,7 +102,7 @@ module OpenWFE
                 "participant class is #{participant.class}"
             end
 
-            if participant.kind_of?(Class)
+            if participant.is_a?(Class)
 
                 ldebug { "register_participant() class #{participant}" }
 
@@ -132,9 +140,15 @@ module OpenWFE
             regex.instance_variable_set '@original_string', original_string
 
             participant.application_context = @application_context \
-                if participant.respond_to? :application_context=
+                if participant.respond_to?(:application_context=)
+
+            # now add the participant to the list
+
+            entry = [ regex, participant ]
+
+            index = (position == :first) ? 0 : -1
 
-            @participants << [ regex, participant ]
+            @participants.insert index, entry
 
             participant
         end
@@ -196,7 +210,7 @@ module OpenWFE
 
             workitem.dispatch_time = Time.now
 
-            participant.consume(workitem)
+            participant.consume workitem
 
             onotify :dispatch, :after_consume, workitem
         end

data/lib/openwfe/participants/participants.rb

@@ -1,6 +1,6 @@
 #
 #--
-# Copyright (c) 2006-2007, John Mettraux, OpenWFE.org
+# Copyright (c) 2006-2008, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -175,7 +175,7 @@ module OpenWFE
 
             reply_to_engine(workitem) \
                 if workitem.kind_of? InFlowWorkItem
-            # else it's a cancel item
+            # else it's a cancel ite
         end
     end
 
@@ -350,7 +350,8 @@ module OpenWFE
 
             get_expression_pool.launch_template(
                 get_flow_expression(workitem),
-                0, #sub_id
+                nil, # new environment
+                0, # sub_id
                 @template, 
                 workitem) 
                 #params)

data/lib/openwfe/participants/soapparticipants.rb

@@ -1,6 +1,6 @@
 #
 #--
-# Copyright (c) 2007, John Mettraux, OpenWFE.org
+# Copyright (c) 2007-2008, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 

data/lib/openwfe/participants/socketparticipants.rb

@@ -1,6 +1,6 @@
 #
 #--
-# Copyright (c) 2007, John Mettraux, OpenWFE.org
+# Copyright (c) 2007-2008, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 

data/lib/openwfe/rudefinitions.rb

@@ -85,6 +85,9 @@ module OpenWFE
         def get_wfid_generator
             @application_context[S_WFID_GENERATOR]
         end
+        def get_expool
+            @application_context[S_EXPRESSION_POOL]
+        end
         def get_expression_pool
             @application_context[S_EXPRESSION_POOL]
         end
@@ -111,12 +114,11 @@ module OpenWFE
         # (there is usually a cache and a persisted exp storage).
         #
         def get_expression_storages
-            result = []
-            @application_context.each do |k, v|
-                result << v \
-                    if OpenWFE::starts_with(k.to_s, S_EXPRESSION_STORAGE)
+
+            @application_context.inject([]) do |r, (k, v)|
+                r << v if OpenWFE::starts_with(k.to_s, S_EXPRESSION_STORAGE)
+                r
             end
-            result
         end
     end
 

data/lib/openwfe/storage/yamlcustom.rb

@@ -1,6 +1,6 @@
 #
 #--
-# Copyright (c) 2007, John Mettraux, OpenWFE.org
+# Copyright (c) 2007-2008, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -101,16 +101,16 @@ module OpenWFE
         end
     end
     
-    #
+    #--
     # opening for tuning yaml persistence
     #
-    class XmlRawExpression
-
-        def to_yaml_properties
-            l = super()
-            l.delete("@raw_representation")
-            l
-        end
-    end
+    #class XmlRawExpression
+    #    def to_yaml_properties
+    #        l = super()
+    #        l.delete("@raw_representation")
+    #        l
+    #    end
+    #end
+    #++
 end    
 

data/lib/openwfe/storage/yamlfilestorage.rb

@@ -1,6 +1,6 @@
 #
 #--
-# Copyright (c) 2006-2007, Nicolas Modryzk and John Mettraux, OpenWFE.org
+# Copyright (c) 2006-2008, Nicolas Modryzk and John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -47,7 +47,7 @@ require 'openwfe/utils'
 require 'openwfe/service'
 
 require 'openwfe/expressions/flowexpression'
-require 'openwfe/expressions/raw_xml'
+#require 'openwfe/expressions/raw_xml'
     #--
     # making sure classes in those files are loaded
     # before their yaml persistence is tuned
@@ -125,9 +125,9 @@ module OpenWFE
             
                 fei_path = compute_file_path(fei)
 
-                #ldebug do 
-                #    "delete()\n   for #{fei.to_debug_s}\n   at #{fei_path}"
-                #end
+                ldebug do 
+                    "delete()\n   for #{fei.to_debug_s}\n   at #{fei_path}"
+                end
                 
                 File.delete(fei_path)
             end
@@ -195,19 +195,19 @@ module OpenWFE
             #
             # Passes each object path to the given block
             #
-            def each_object_path (&block)
+            def each_object_path (path=@basepath, &block)
 
                 #return unless block
 
                 synchronize do
-                    Find.find(@basepath) do |path|
+                    Find.find(path) do |p|
 
-                        next unless File.exist? path
-                        next if File.stat(path).directory?
-                        next unless OpenWFE::ends_with(path, ".yaml")
+                        next unless File.exist?(p)
+                        next if File.stat(p).directory?
+                        next unless OpenWFE::ends_with(p, ".yaml")
 
-                        ldebug { "each_object_path() considering #{path}" }
-                        block.call path
+                        ldebug { "each_object_path() considering #{p}" }
+                        block.call p
                     end
                 end
             end

data/lib/openwfe/tools/flowtracer.rb

@@ -1,6 +1,6 @@
 #
 #--
-# Copyright (c) 2007, John Mettraux, OpenWFE.org
+# Copyright (c) 2007-2008, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -42,15 +42,16 @@
 require 'openwfe/workitem'
 require 'openwfe/engine/engine'
 
-include OpenWFE
+#include OpenWFE
 
 
 module OpenWFE
 
     def trace_flow (process_definition)
-        li = LaunchItem.new(process_definition)
 
-        engine = Engine.new()
+        li = LaunchItem.new process_definition
+
+        engine = Engine.new
 
         i = 0
 
@@ -73,7 +74,7 @@ module OpenWFE
             i = i + 1
         end
 
-        engine.launch(li)
+        engine.launch li
     end
 
 end

data/lib/openwfe/util/dollar.rb

@@ -1,6 +1,6 @@
 #
 #--
-# Copyright (c) 2006-2007, John Mettraux, OpenWFE.org
+# Copyright (c) 2006-2008, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -37,8 +37,11 @@
 # John Mettraux at openwfe.org
 #
 
+#require 'rubygems'
+require 'rufus/dollar' # gem 'rufus-dollar'
+require 'rufus/eval' # gem 'rufus-eval'
+
 require 'openwfe/utils'
-require 'openwfe/util/safe'
 
 #
 # 'dollar notation' implementation in Ruby
@@ -46,99 +49,36 @@ require 'openwfe/util/safe'
 
 module OpenWFE
 
-    DSUB_SAFETY_LEVEL = 3
+    DSUB_SAFETY_LEVEL = 4
         #
         # Ruby code ${ruby:...} will be evaluated with this
         # safety level.
         # (see http://www.rubycentral.com/book/taint.html )
 
-    #
-    # Performs 'dollar substitution' on a piece of text with a given 
-    # dictionary.
-    #
-    def OpenWFE.dsub (text, dict)
-
-        text = text.to_s
-
-        #puts "### text is >#{text}<"
-        #puts "### dict is of class #{dict.class.name}"
-
-        #return nil unless text
-
-        j = text.index("}")
-
-        return text if not j
-
-        t = text[0, j]
-
-        i = t.rindex("${")
-        ii = t.rindex("\\${")
-
-        #puts "i  is #{i}"
-        #puts "ii is #{ii}"
-
-        return text if not i
-
-        return unescape(text) if (i) and (i != 0) and (ii == i-1)
-            #
-            # found "\${"
-
-        key = text[i+2..j-1]
-
-        #puts "### key is '#{key}'"
-
-        value = dict[key]
-
-        #puts "### value 0 is '#{value}'"
-
-        value = if value
-            value.to_s 
-        else
-            if dict.has_key?(key)
-                "false"
-            else
-                ""
-            end
-        end
-
-        #puts "### value 1 is '#{value}'"
-
-        #puts "pre is  >#{text[0..i-1]}<"
-        #puts "post is >#{text[j+1..-1]}<"
-
-        pre = if i > 0 
-            text[0..i-1]
-        else
-            ""
-        end
-
-        dsub("#{pre}#{value}#{text[j+1..-1]}", dict)
-    end
-
-    def OpenWFE.unescape (text)
-        text.gsub("\\\\\\$\\{", "\\${")
-    end
-
     #
     # Performs 'dollar substitution' on a piece of text with as input
     # a flow expression and a workitem (fields and variables).
     #
     def OpenWFE.dosub (text, flow_expression, workitem)
-        dsub(text, FlowDict.new(flow_expression, workitem))
+
+        Rufus::dsub(text, FlowDict.new(flow_expression, workitem))
     end
 
     #
     # Wrapping a process expression and the current workitem as a
     # Hash object ready for lookup at substitution time.
     #
-    class FlowDict < Hash
+    class FlowDict
+
+        def initialize (flow_expression, workitem, default_prefix='v')
 
-        def initialize (flow_expression, workitem)
             @flow_expression = flow_expression
             @workitem = workitem
+            @default_prefix = default_prefix
         end
 
         def [] (key)
+
             p, k = extract_prefix(key)
 
             #puts "### p, k is '#{p}', '#{k}'"
@@ -149,17 +89,31 @@ module OpenWFE
 
             if p == 'v'
                 return '' unless @flow_expression
-                return @flow_expression.lookup_variable(k) 
+                return @flow_expression.lookup_variable(k)
             end
 
-            return call_function(k) if p == 'c'
+            #return call_function(k) if p == 'c'
             return call_ruby(k) if p == 'r'
-            # TODO : implement constant lookup
 
-            @workitem.lookup_attribute(key)
+            @workitem.lookup_attribute key
+        end
+
+        def []= (key, value)
+
+            pr, k = extract_prefix(key)
+
+            if pr == 'f'
+
+                @workitem.set_attribute k, value
+
+            elsif @flow_expression
+
+                @flow_expression.set_variable k, value
+            end
         end
 
         def has_key? (key)
+
             p, k = extract_prefix(key)
 
             return false if k == ''
@@ -171,9 +125,8 @@ module OpenWFE
                 return (@flow_expression.lookup_variable(k) != nil)
             end
 
-            return true if p == 'c'
+            #return true if p == 'c'
             return true if p == 'r'
-            # TODO : implement constant lookup
 
             @workitem.has_attribute?(key)
         end
@@ -182,14 +135,18 @@ module OpenWFE
 
             def extract_prefix (key)
                 i = key.index(':')
-                return 'v', key if not i
+                return @default_prefix, key if not i
                 [ key[0..0], key[i+1..-1] ]
             end
 
-            def call_function (function_name)
-                #"function '#{function_name}' is not implemented"
-                "functions are not yet implemented"
-            end
+            #--
+            #def call_function (function_name)
+            #    #"function '#{function_name}' is not implemented"
+            #    "functions are not yet implemented"
+            #        #
+            #        # no need for them... we have Ruby :)
+            #end
+            #++
 
             def call_ruby (ruby_code)
 
@@ -221,7 +178,7 @@ module OpenWFE
                 #eval(ruby_code, binding).to_s
                 #eval(ruby_code).to_s
 
-                OpenWFE::eval_safely(
+                Rufus::eval_safely(
                     ruby_code, DSUB_SAFETY_LEVEL, binding()).to_s
             end
     end