openwferu 0.9.15 → 0.9.16

data/lib/openwfe/participants/participants.rb

@@ -40,6 +40,7 @@
 require 'yaml'
 
 require 'openwfe/utils'
+require 'openwfe/util/dollar'
 require 'openwfe/participants/participant'
 
 
@@ -169,7 +170,8 @@ module OpenWFE
 
             result = call_block @block, workitem
 
-            workitem.set_result(result) if result
+            workitem.set_result(result) \
+                if result and result != workitem
 
             reply_to_engine(workitem) \
                 if workitem.kind_of? InFlowWorkItem
@@ -225,6 +227,9 @@ module OpenWFE
     # 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
 
@@ -232,6 +237,7 @@ module OpenWFE
         # Simply discards the incoming workitem
         #
         def consume (workitem)
+
             reply_to_engine workitem
         end
     end
@@ -351,5 +357,44 @@ module OpenWFE
         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
 

data/lib/openwfe/participants/socketparticipants.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
 #
 # "made in Japan"
@@ -43,13 +41,10 @@ require 'yaml'
 require 'socket'
 require 'timeout'
 
-require 'openwfe/rest/xmlcodec'
+require 'openwfe/orest/xmlcodec'
 require 'openwfe/participants/participant'
 
 
-#
-# some base participant implementations
-#
 module OpenWFE
 
     #

data/lib/openwfe/service.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
 #
 # "made in Japan"
@@ -45,11 +43,18 @@ require 'openwfe/contextual'
 
 module OpenWFE
 
+    #
+    # Most of the functionalities of an OpenWFEru service are implemented
+    # here as a mixin. It's then easy to either extend Service or include
+    # ServiceMixin, to compose an OpenWFEru service class.
+    #
     module ServiceMixin
         include Contextual, Logging
 
-        attr_accessor \
-            :service_name
+        #
+        # The name of the service
+        #
+        attr_accessor :service_name
 
         #
         # Inits the service by setting the service name and the application
@@ -74,14 +79,18 @@ module OpenWFE
         end
     end
 
+    #
+    # A service has a service_name and a link to its application_context.
+    # Via the application_context, it can lookup other services (if it
+    # knows their names).
+    #
     class Service
         include ServiceMixin
 
         def initialize (service_name, application_context)
 
-            service_init(service_name, application_context)
+            service_init service_name, application_context
         end
-
     end
 
     #def register (service)

data/lib/openwfe/storage/yamlcustom.rb

@@ -82,6 +82,7 @@ module OpenWFE
         #end
 
         def to_yaml (opts={})
+
             YAML::quick_emit(self.object_id, opts) do |out|
                 out.map(taguri) do |map|
                     map.add("s", to_s)
@@ -90,6 +91,7 @@ module OpenWFE
         end
 
         def FlowExpressionId.yaml_new (klass, tag, val)
+
             s = val["s"]
             begin
                 FlowExpressionId.to_fei(s)
@@ -103,6 +105,7 @@ module OpenWFE
     # opening for tuning yaml persistence
     #
     class XmlRawExpression
+
         def to_yaml_properties
             l = super()
             l.delete("@raw_representation")

data/lib/openwfe/storage/yamlfilestorage.rb

@@ -84,6 +84,8 @@ module OpenWFE
         def []= (fei, object)
             synchronize do
 
+                #linfo { "[]= #{fei}" }
+
                 fei_path = compute_file_path(fei)
 
                 fei_parent_path = File.dirname(fei_path)
@@ -195,7 +197,7 @@ module OpenWFE
             #
             def each_object_path (&block)
 
-                return unless block
+                #return unless block
 
                 synchronize do
                     Find.find(@basepath) do |path|

data/lib/openwfe/util/dollar.rb

@@ -58,6 +58,8 @@ module OpenWFE
     #
     def OpenWFE.dsub (text, dict)
 
+        text = text.to_s
+
         #puts "### text is >#{text}<"
         #puts "### dict is of class #{dict.class.name}"
 
@@ -89,13 +91,13 @@ module OpenWFE
 
         #puts "### value 0 is '#{value}'"
 
-        if value
-            value = value.to_s 
+        value = if value
+            value.to_s 
         else
-            if dict.has_key? key
-                value = "false"
+            if dict.has_key?(key)
+                "false"
             else
-                value = ""
+                ""
             end
         end
 
@@ -104,16 +106,17 @@ module OpenWFE
         #puts "pre is  >#{text[0..i-1]}<"
         #puts "post is >#{text[j+1..-1]}<"
 
-        pre = ""
-        if i > 0 
-            pre = text[0..i-1]
+        pre = if i > 0 
+            text[0..i-1]
+        else
+            ""
         end
 
-        return dsub("#{pre}#{value}#{text[j+1..-1]}", dict)
+        dsub("#{pre}#{value}#{text[j+1..-1]}", dict)
     end
 
     def OpenWFE.unescape (text)
-        return text.gsub("\\\\\\$\\{", "\\${")
+        text.gsub("\\\\\\$\\{", "\\${")
     end
 
     #
@@ -121,9 +124,13 @@ module OpenWFE
     # a flow expression and a workitem (fields and variables).
     #
     def OpenWFE.dosub (text, flow_expression, workitem)
-        return dsub(text, FlowDict.new(flow_expression, workitem))
+        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
 
         def initialize (flow_expression, workitem)
@@ -149,7 +156,7 @@ module OpenWFE
             return call_ruby(k) if p == 'r'
             # TODO : implement constant lookup
 
-            return @workitem.lookup_attribute(key)
+            @workitem.lookup_attribute(key)
         end
 
         def has_key? (key)
@@ -168,7 +175,7 @@ module OpenWFE
             return true if p == 'r'
             # TODO : implement constant lookup
 
-            return @workitem.has_attribute?(key)
+            @workitem.has_attribute?(key)
         end
 
         protected
@@ -176,7 +183,7 @@ module OpenWFE
             def extract_prefix (key)
                 i = key.index(':')
                 return 'v', key if not i
-                return key[0..0], key[i+1..-1]
+                [ key[0..0], key[i+1..-1] ]
             end
 
             def call_function (function_name)

data/lib/openwfe/util/lru.rb

@@ -64,33 +64,41 @@ module OpenWFE
         end
 
         def maxsize= (newsize)
+
             remove_lru() while @hash.size > newsize
             @maxsize = newsize
         end
 
         def maxsize
-            return @maxsize
+
+            @maxsize
         end
 
         def size
-            return @lru_keys.size
+            @lru_keys.size
         end
         alias :length :size
 
         def keys
-            return @hash.keys
+
+            @hash.keys
         end
+
         def values
-            return @values
+
+            @hash.values
         end
 
         def clear
+
             @hash.clear
             @lru_keys.clear
         end
 
         def each (&block)
+
             return unless block
+
             @hash.each do |k, v|
                 block.call(k, v)
             end
@@ -100,31 +108,39 @@ module OpenWFE
         # Returns the keys with the lru in front.
         #
         def ordered_keys
-            return @lru_keys
+
+            @lru_keys
         end
 
         def [] (key)
+
             value = @hash[key]
             return nil unless value
             touch(key)
-            return value
+
+            value
         end
 
         def []= (key, value)
+
             remove_lru() while @hash.size >= @maxsize
             @hash[key] = value
             touch(key)
-            return value
+
+            value
         end
 
         def delete (key)
+
             value = @hash.delete(key)
             @lru_keys.delete(key)
-            return value
+
+            value
         end
 
         def include? (key)
-            return @hash.include?(key)
+
+            @hash.include?(key)
         end
 
         protected
@@ -134,6 +150,7 @@ module OpenWFE
             # The bottom being the lru place.
             #
             def touch (key)
+
                 @lru_keys.delete(key)
                 @lru_keys << key
             end
@@ -143,9 +160,11 @@ module OpenWFE
             # Returns nil if the cache is currently empty.
             #
             def remove_lru ()
+
                 return nil if @lru_keys.size < 1
                 key = @lru_keys.delete_at(0)
-                return @hash.delete(key)
+
+                @hash.delete(key)
             end
     end
 end

data/lib/openwfe/util/observable.rb

@@ -57,6 +57,7 @@ module OpenWFE
         # be useful when removing the observer.
         #
         def add_observer (channel, observer=nil, &callback)
+
             observer = callback unless observer
             (@observers[channel] ||= []) << observer
             observer
@@ -105,6 +106,8 @@ module OpenWFE
 
             def do_notify (target_channel, channel, *args)
 
+                #ldebug { "do_notify() @observers.size is #{@observers.size}" }
+
                 if target_channel.is_a?(String)
 
                     observers = []
@@ -132,7 +135,7 @@ module OpenWFE
                     obs.call channel, *args
                 end
 
-                observers.size > 0
+                (observers.size > 0)
                     #
                     # returns true if at least one observer was called
             end

data/lib/openwfe/util/otime.rb

@@ -53,6 +53,9 @@ module OpenWFE
         to_iso8601_date(Time.new())
     end
 
+    #
+    # As the name implies.
+    #
     def OpenWFE.to_iso8601_date (date)
 
         if date.kind_of? Float