openwferu 0.9.14 → 0.9.15

data/README.txt

@@ -2,6 +2,7 @@
 
 == Prerequisites
 Ruby 1.8.5 or later
+RubyGems 0.9.4 or later
 
 == Installation
 Installation can be handled by Ruby gems.  This will pull in any libraries

data/lib/openwfe/expool/errorjournal.rb

@@ -312,7 +312,7 @@ module OpenWFE
 
         def initialize (service_name, application_context)
 
-            require 'openwfe/storage/yamlextras'
+            require 'openwfe/storage/yamlcustom'
 
             super
 

data/lib/openwfe/expool/expstorage.rb

@@ -47,6 +47,47 @@ require 'openwfe/flowexpressionid'
 
 module OpenWFE
 
+    #
+    # This module contains the observe_expool method which binds the
+    # storage to the expression pool.
+    # It also features a to_s method for the expression storages including
+    # it.
+    #
+    module ExpressionStorageBase
+
+        def observe_expool
+
+            get_expression_pool.add_observer(:update) do |channel, fei, fe|
+                ldebug { ":update  for #{fei}" }
+                self[fei] = fe
+            end
+            get_expression_pool.add_observer(:remove) do |channel, fei|
+                ldebug { ":delete  for #{fei}" }
+                self.delete(fei)
+            end
+        end
+
+        def to_s
+
+            s = "\n\n==== #{self.class} ===="
+
+            self.each do |k, v|
+                s << "\n"
+                if v.kind_of?(RawExpression)
+                    s << "*raw" 
+                else
+                    s << "  "
+                end
+                #s << v.to_s
+                s << v.fei.to_s
+                s << "    key/value mismatch !" if k != v.fei
+            end
+            s << "\n==== . ====\n"
+
+            s
+        end
+    end
+
     #
     # This cache uses a LruHash (Least Recently Used) to store expressions.
     # If an expression is not cached, the 'real storage' is consulted.
@@ -54,7 +95,9 @@ module OpenWFE
     # "expressionStorage.1"
     #
     class CacheExpressionStorage
-        include ServiceMixin, OwfeServiceLocator
+        include ServiceMixin
+        include OwfeServiceLocator
+        include ExpressionStorageBase
 
         #
         # under 20 stored expressions, the unit tests for the 
@@ -82,17 +125,7 @@ module OpenWFE
 
             @real_storage = nil
 
-            #
-            # expstorage observes expool :
-
-            get_expression_pool.add_observer(:update) do |channel, fei, fe|
-                ldebug { ":update  for #{fei}" }
-                self[fei] = fe
-            end
-            get_expression_pool.add_observer(:remove) do |channel, fei|
-                ldebug { ":delete  for #{fei}" }
-                self.delete(fei)
-            end
+            observe_expool
         end
 
         def [] (fei)
@@ -171,14 +204,6 @@ module OpenWFE
             get_real_storage.each(wfid_prefix, &block)
         end
 
-        #
-        # Displays a human-friendly view on this storage
-        #
-        def to_s
-
-            expstorage_to_s(self)
-        end
-
         protected
 
             #
@@ -201,35 +226,17 @@ module OpenWFE
     # No memory limit, puts everything in a Hash
     #
     class InMemoryExpressionStorage < Hash
-        include ServiceMixin, OwfeServiceLocator
+        include ServiceMixin
+        include OwfeServiceLocator
+        include ExpressionStorageBase
         
         def initialize (service_name, application_context)
 
             service_init(service_name, application_context)
 
-            #
-            # expstorage observes expool :
-
-            get_expression_pool.add_observer(:update) do |channel, fei, fe|
-                #ldebug { ":update  for #{fei}" }
-                self[fei] = fe
-            end
-            get_expression_pool.add_observer(:remove) do |channel, fei|
-                #ldebug { ":delete  for #{fei}" }
-                self.delete fei
-            end
+            observe_expool
         end
 
-        #def []= (fei, fe)
-        #    super fei.hash, fe
-        #end
-        #def [] (fei)
-        #    super fei.hash
-        #end
-        #def delete (fei)
-        #    super fei.hash
-        #end
-
         alias :purge :clear
 
         #
@@ -258,37 +265,8 @@ module OpenWFE
             end
         end
 
-        def to_s
-            expstorage_to_s(self)
-        end
-
         alias :real_each :each
 
     end
 
-    #
-    # a small help method for expression storages...
-    #
-    # TODO : put that in a module !
-    #
-    def expstorage_to_s (expstorage)
-
-        s = "\n\n==== #{expstorage.class} ===="
-
-        expstorage.each do |k, v|
-            s << "\n"
-            if v.kind_of?(RawExpression)
-                s << "*raw" 
-            else
-                s << "  "
-            end
-            #s << v.to_s
-            s << v.fei.to_s
-            s << "    key/value mismatch !" if k != v.fei
-        end
-        s << "\n==== . ====\n"
-
-        s
-    end
-
 end

data/lib/openwfe/expool/journal.rb

@@ -45,7 +45,7 @@ require 'openwfe/omixins'
 require 'openwfe/rudefinitions'
 require 'openwfe/flowexpressionid'
 require 'openwfe/util/otime'
-require 'openwfe/storage/yamlextras'
+require 'openwfe/storage/yamlcustom'
 require 'openwfe/expool/journal_replay'
 
 

data/lib/openwfe/expool/yamlexpstorage.rb

@@ -39,7 +39,7 @@
 #
 
 require 'openwfe/utils'
-require 'openwfe/storage/yamlextras'
+require 'openwfe/storage/yamlcustom'
 require 'openwfe/storage/yamlfilestorage'
 
 require 'openwfe/expressions/flowexpression'
@@ -59,12 +59,13 @@ module OpenWFE
     #
     class YamlFileExpressionStorage  < YamlFileStorage
         include OwfeServiceLocator
+        include ExpressionStorageBase
         
         def initialize (service_name, application_context)
 
             super(service_name, application_context, '/expool')
 
-            observe_expool()
+            observe_expool
         end
 
         #
@@ -146,24 +147,6 @@ module OpenWFE
 
         protected
 
-            #
-            # The actual binding of this storage as an observer of the
-            # expression pool is done here.
-            # It gives the opportunity to override this method with variants
-            # (for example for delayed execution)
-            #
-            def observe_expool
-
-                get_expression_pool.add_observer(:update) do |channel, fei, fe|
-                    #ldebug { ":update  for #{fei.to_debug_s}" }
-                    self[fei] = fe
-                end
-                get_expression_pool.add_observer(:remove) do |channel, fei|
-                    #ldebug { ":remove  for #{fei.to_debug_s}" }
-                    self.delete(fei)
-                end
-            end
-            
             def compute_file_path (fei)
                 
                 return @basepath + "/engine_environment.yaml" \
@@ -198,30 +181,17 @@ module OpenWFE
     end
 
     #
-    # With this extension of YmalFileExpressionStorage, persistence occurs
-    # in a separate thread, for a snappier response.
+    # This mixin gathers all the logic for a threaded expression storage,
+    # one that doesn't immediately stores workitems (removes overriding
+    # operations).
+    # Using this threaded storage brings a very important perf benefit.
     #
-    class ThreadedYamlFileExpressionStorage < YamlFileExpressionStorage
+    module ThreadedStorageMixin
 
-        FREQ = "400" # milliseconds
+        THREADED_FREQ = "427" # milliseconds
             #
             # the frequency at which the event queue should be processed
 
-        #
-        # TODO : make this configurable (param in the apcontext ?)
-
-        def initialize (service_name, application_context)
-
-            super
-
-            @events = {}
-            @op_count = 0
-
-            start_processing_thread()
-                #
-                # which sets @thread_id
-        end
-
         #
         # Will take care of stopping the 'queue processing' thread.
         #
@@ -263,8 +233,11 @@ module OpenWFE
             #
             def start_processing_thread
 
-                @thread_id = get_scheduler.schedule_every(FREQ) do
-                    process_queue()
+                @events = {}
+                @op_count = 0
+
+                @thread_id = get_scheduler.schedule_every THREADED_FREQ do
+                    process_queue
                 end
             end
 
@@ -352,4 +325,21 @@ module OpenWFE
                 end
             end
     end
+
+    #
+    # With this extension of YmalFileExpressionStorage, persistence occurs
+    # in a separate thread, for a snappier response.
+    #
+    class ThreadedYamlFileExpressionStorage < YamlFileExpressionStorage
+        include ThreadedStorageMixin
+
+        def initialize (service_name, application_context)
+
+            super
+
+            start_processing_thread()
+                #
+                # which sets @thread_id
+        end
+    end
 end

data/lib/openwfe/expressions/flowexpression.rb

@@ -62,13 +62,54 @@ module OpenWFE
     class FlowExpression < ObjectWithMeta
         include Contextual, Logging, OwfeServiceLocator
 
-        attr_accessor \
-            :fei,
-            :parent_id,
-            :environment_id,
-            :attributes,
-            :children,
-            :apply_time 
+        #
+        # The 'flow expression id' the unique identifier within a
+        # workflow instance for this expression instance.
+        #
+        attr_accessor :fei
+
+        #
+        # The 'flow expression id' of the parent expression.
+        # Will yield 'nil' if this expression is the root of its process
+        # instance.
+        #
+        attr_accessor :parent_id
+
+        #
+        # The 'flow expression id' of the environment this expression works
+        # with.
+        #
+        attr_accessor :environment_id
+
+        #
+        # The attributes of the expression, as found in the process definition.
+        #
+        #     <participant ref='toto' timeout='1d10h' />
+        #
+        # The attributes will be ref => "toto" and timeout => "1d10h" (yes,
+        # 'attributes' contains a hash.
+        #
+        attr_accessor :attributes
+
+        #
+        # An array of 'flow expression id' instances. These are the ids of
+        # the expressions children to this one.
+        #
+        #     <sequence>
+        #         <participant ref="toto" />
+        #         <participant ref="bert" />
+        #     </sequence>
+        #
+        # The expression instance for 'sequence' will hold the feis of toto and
+        # bert in its children array.
+        #
+        attr_accessor :children
+
+        #
+        # When the FlowExpression instance is applied, this time stamp is set
+        # to the current date.
+        #
+        attr_accessor :apply_time 
 
 
         def initialize (fei, parent_id, env_id, app_context, attributes)

data/lib/openwfe/listeners/socketlisteners.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
 #
 # "made in Japan"

data/lib/openwfe/participants/participant.rb

@@ -48,13 +48,24 @@ module OpenWFE
     # The 'participant' concept is displayed as a module, so that 
     # other pieces of code may easily 'mix it in'.
     #
+    # Participant extensions should at least provide a consume(workitem)
+    # method.
+    # As an option, it can provide a cancel(cancelitem) method.
+    #
+    # The engine will transmit instances of OpenWFE:WorkItem via the
+    # consume method.
+    #
+    # If there is a cancel method available and an OpenWFE::CancelItem instance
+    # is emitted (cancelling a process or part of it), it will be fed to
+    # the participant only via the cancel method.
+    #
+    # If there is no cancel method, the participant will not get notified
+    # of the cancellation.
+    #
     module Participant
 
         #
-        # A participant will be receiving workitems via this method.
-        # It may also receive cancelitems via this method.
-        # If the participant provides a cancel(cancelitem) method, cancel
-        # items will be fed to this cancel() and not to consume().
+        # A Participant will be receiving OpenWFE::WorkItem's via this method.
         #
         def consume (workitem)
 

data/lib/openwfe/participants/participantmap.rb

@@ -57,7 +57,8 @@ module OpenWFE
             :participants
 
         def initialize (service_name, application_context)
-            super(service_name, application_context)
+
+            super
 
             @participants = []
 
@@ -184,15 +185,8 @@ module OpenWFE
 
             workitem.participant_name = participant_name
 
-            if (workitem.kind_of?(CancelItem) and 
-                participant.respond_to?(:cancel))
-
-                participant.cancel(workitem)
-
-                onotify :dispatch, :cancel, workitem
-
-                return
-            end
+            return cancel(participant, workitem) \
+                if workitem.is_a?(CancelItem)
 
             onotify :dispatch, :before_consume, workitem
 
@@ -209,6 +203,24 @@ module OpenWFE
         # and replies.
         #
         public :onotify
+
+        protected
+
+            #
+            # Will call the cancel method of the participant if it has
+            # one, or will simply discard the cancel item else.
+            #
+            def cancel (participant, cancel_item)
+
+                participant.cancel(cancel_item) \
+                    if participant.respond_to?(:cancel)
+
+                onotify :dispatch, :cancel, cancel_item
+                    #
+                    # maybe it'd be better to specifically log that
+                    # a participant has no cancel() method, but it's OK
+                    # like that for now.
+            end
     end
 
 end

data/lib/openwfe/storage/yamlcustom.rb

@@ -0,0 +1,113 @@
+#
+#--
+# 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.
+#++
+#
+
+#
+# "made in Japan"
+#
+# John Mettraux at openwfe.org
+#
+
+require 'yaml'
+
+
+module OpenWFE
+    
+    #
+    # reopening some classes in order to facilitate their
+    # yaml serialization
+    #
+    
+    #
+    # opening for tuning yaml persistence
+    #
+    class FlowExpression
+
+        def to_yaml_properties
+
+            l = super()
+
+            l.delete("@application_context")
+
+            #l.delete("@timeout_job_id")
+            #l.delete("@scheduler_job_id")
+                # scheduler ids should not get persisted
+
+            l
+        end
+    end
+
+    #
+    # making sure that the FlowExpressionId is serialized as a unique String
+    #
+    class FlowExpressionId
+
+        yaml_as "tag:ruby.yaml.org,2002:#{self}"
+
+        #def to_yaml (opts={})
+        #    @s = to_s
+        #    super
+        #end
+        #def to_yaml_properties
+        #    [ "@s" ]
+        #end
+
+        def to_yaml (opts={})
+            YAML::quick_emit(self.object_id, opts) do |out|
+                out.map(taguri) do |map|
+                    map.add("s", to_s)
+                end
+            end
+        end
+
+        def FlowExpressionId.yaml_new (klass, tag, val)
+            s = val["s"]
+            begin
+                FlowExpressionId.to_fei(s)
+            rescue Exception => e
+                raise "failed to decode FlowExpressionId out of '#{s}'"
+            end
+        end
+    end
+    
+    #
+    # opening for tuning yaml persistence
+    #
+    class XmlRawExpression
+        def to_yaml_properties
+            l = super()
+            l.delete("@raw_representation")
+            l
+        end
+    end
+end    
+

data/lib/openwfe/util/otime.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: otime.rb 3509 2006-10-21 12:00:52Z jmettraux $
-#
 
 #
 # "hecho en Costa Rica"

data/lib/openwfe/version.rb

@@ -32,5 +32,5 @@
 #
 
 module OpenWFE
-    OPENWFERU_VERSION = '0.9.14'
+    OPENWFERU_VERSION = '0.9.15'
 end

data/test/ft_26b_load.rb

@@ -50,7 +50,6 @@ class FlowTest26b < Test::Unit::TestCase
         n = 1000
         n.times do |i|
             @engine.launch(LaunchItem.new(TestDefinition0))
-            
         end
         
         puts "launched #{n} items"
@@ -76,11 +75,11 @@ class FlowTest26b < Test::Unit::TestCase
     end
     
     def join_until_idle ()
-      storage = @engine.get_expression_storage
-      while storage.size > 1
-        sleep 1
-        puts "storage.size:#{storage.size}"
-      end
+        storage = @engine.get_expression_storage
+        while storage.size > 1
+            sleep 1
+            puts "storage.size:#{storage.size}"
+        end
     end
 
 end

data/test/obs_test.rb

@@ -25,7 +25,7 @@ class ObsTest < Test::Unit::TestCase
     #end
 
     class Observed
-        include OpenWFE::Observable
+        include OpenWFE::OwfeObservable
 
         attr_reader :observers
 

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
+rubygems_version: 0.9.4
 specification_version: 1
 name: openwferu
 version: !ruby/object:Gem::Version 
-  version: 0.9.14
-date: 2007-09-18 00:00:00 +09:00
+  version: 0.9.15
+date: 2007-09-24 00:00:00 +09:00
 summary: an open source ruby workflow and bpm engine
 require_paths: 
 - lib
@@ -122,6 +122,7 @@ files:
 - lib/openwfe/rest/restclient.rb
 - lib/openwfe/rest/worklistclient.rb
 - lib/openwfe/rest/xmlcodec.rb
+- lib/openwfe/storage/yamlcustom.rb
 - lib/openwfe/storage/yamlfilestorage.rb
 - lib/openwfe/tools/flowtracer.rb
 - lib/openwfe/util/dollar.rb