openwferu 0.9.2 → 0.9.3

data/lib/openwfe/util/schedulers.rb

@@ -50,15 +50,23 @@ module OpenWFE
     # infrastructure (so that one could easily use it without OpenWFE)
     #
     class SchedulerService < Scheduler
-        include ServiceMixin
+        include ServiceMixin, Logging
 
         def initialize (service_name, application_context)
+
             super()
-            @service_name = service_name
-            @application_context = application_context
+
+            service_init(service_name, application_context)
+
+            ldebug { "initialize() SchedulerService #{self.object_id}" }
 
             start()
         end
+
+        def stop
+            linfo { "stop() for scheduler #{self.object_id}" }
+            do_stop
+        end
     end
 
 end

data/lib/openwfe/util/stoppable.rb

@@ -0,0 +1,69 @@
+#
+#--
+# 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.
+#++
+#
+# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
+#
+
+#
+# "made in Japan"
+#
+# John Mettraux at openwfe.org
+#
+
+
+module OpenWFE
+
+    #
+    # A simple mixin for adding a stopped instance variable and some
+    # methods around it to a class (or an object).
+    #
+    module Stoppable
+
+        def initialize
+            @stopped = false
+        end
+
+        def do_stop
+            @stopped = true
+        end
+
+        def do_restart
+            @stopped = false
+        end
+
+        def is_stopped?
+            @stopped
+        end
+    end
+
+end
+

data/lib/openwfe/utils.rb

@@ -95,7 +95,7 @@ module OpenWFE
     #
     # an automatic dup implementation attempt
     #
-    def OpenWFE.dup (object)
+    def OpenWFE.fulldup (object)
 
         return nil if object == nil
 
@@ -103,25 +103,27 @@ module OpenWFE
         return object if object.kind_of? TrueClass
         return object if object.kind_of? FalseClass
 
+        return object.dup if object.kind_of? String
+
         o = object.class.new
 
         #
         # some kind of collection ?
 
-        if object.kind_of?(Array)
+        if object.kind_of? Array
             object.each do |i|
-                o << dup(i)
+                o << fulldup(i)
             end
-        elsif object.kind_of?(Hash)
+        elsif object.kind_of? Hash
             object.each do |k, v|
-                o[copy(k)] = dup(v)
+                o[copy(k)] = fulldup(v)
             end
         end
 
         #
         # duplicate the attributes of the object
 
-        object.instance_variables.each do | v |
+        object.instance_variables.each do |v|
 
             #puts "v is #{v}"
 
@@ -129,11 +131,11 @@ module OpenWFE
 
             #puts "value is '#{value}'"
 
-            value = dup(value)
+            value = fulldup(value)
 
             begin
                 o.instance_variable_set(v, value)
-            rescue Exception => e
+            rescue
                 # ignore, must be readonly
             end
         end
@@ -142,24 +144,11 @@ module OpenWFE
     end
 
     def OpenWFE.to_underscore (string)
-        replace_char(string, "-", "_")
+        string.gsub("-", "_")
     end
 
     def OpenWFE.to_dash (string)
-        replace_char(string, "_", "-")
-    end
-
-    def OpenWFE.replace_char (string, from, to)
-        s = ""
-        0.upto(string.length) do |i|
-            c = string[i, 1]
-            s << if c == from
-                to
-            else
-                c
-            end
-        end
-        return s
+        string.gsub("_", "-")
     end
 
     #
@@ -171,7 +160,7 @@ module OpenWFE
         # method to the String class, but that could be intrusive
         # (as OpenWFE is meant at first as an embeddable workflow engine).
         #
-        return false if not string
+        return false unless string
         return false if string.length < start.length
         return string[0, start.length] == start
     end
@@ -180,7 +169,7 @@ module OpenWFE
     # Returns true if the given string ends with the '_end' string.
     #
     def OpenWFE.ends_with (string, _end)
-        return false if not string
+        return false unless string
         return false if string.length < _end.length
         return string[-_end.length..-1] == _end
     end

data/lib/openwfe/workitem.rb

@@ -116,6 +116,10 @@ module OpenWFE
 
             super(m, args)
         end
+
+        def dup
+            return OpenWFE::fulldup(self)
+        end
     end
 
     #
@@ -136,7 +140,8 @@ module OpenWFE
         #
         # Just a handy alias for flow_expression_id
         #
-        alias fei flow_expression_id
+        alias :fei :flow_expression_id
+        alias :fei= :flow_expression_id=
     end
 
     #
@@ -153,10 +158,6 @@ module OpenWFE
             #
             # special : added by the ruby lib, not given by the worklist
 
-        def dup
-            return OpenWFE::dup(self)
-        end
-
         #
         # Outputting the workitem in a human readable format
         #
@@ -183,6 +184,11 @@ module OpenWFE
     # receiving a cancel item.
     #
     class CancelItem < InFlowItem
+
+        def initialize (workitem)
+            super()
+            @flow_expression_id = workitem.fei.dup
+        end
     end
 
     #
@@ -234,7 +240,7 @@ module OpenWFE
             :expression_id
         
         def dup
-            return OpenWFE::dup(self)
+            return OpenWFE::fulldup(self)
         end
     end
 

data/lib/openwfe/worklist/storeparticipant.rb

@@ -0,0 +1,145 @@
+#
+#--
+# 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"
+#
+# Alain Hoang at openwfe.org
+#
+
+require 'openwfe/participants/participant'
+
+
+module OpenWFE
+
+    #
+    # A mixin gathering the methods a workitem store participant needs.
+    #
+    # Two kinds of methods are involved here, the ones used by the engine
+    # (its participant map) and the ones used by 'workflow clients'.
+    # Thus consume() and cancel() are triggered by the engine, and
+    # save() and forward() are at the disposal of 'workflow clients'.
+    #
+    # A 'workflow client' is supposed to use methods similar to hash methods
+    # to retrieve workitems, like in
+    #
+    #     storeparticipant.each do |fei, workitem|
+    #         puts "workitem : #{fei.to_s}"
+    #         do_some_work(workitem)
+    #     end
+    #
+    #
+    module StoreParticipantMixin
+        include LocalParticipant
+
+        #def initialize ()
+        #end
+
+        #
+        # Called by the engine (the participant expression) when handing
+        # out a workitem (to this participant).
+        #
+        def consume (workitem)
+
+            self[workitem.flow_expression_id] = workitem
+        end
+
+        #
+        # Called by the participant expression when this participant is
+        # 'cancelled' within a flow. The workitem then gets removed.
+        #
+        def cancel (cancelitem)
+
+            ldebug do 
+                "cancel() removing workitem  #{cancelitem.flow_expression_id}"
+            end
+
+            self.delete(cancelitem.flow_expression_id)
+        end
+
+        #
+        # The workitem is to be stored again within the store participant,
+        # it will probably be reused later. Don't send back to engine yet.
+        #
+        def save (workitem)
+
+            raise "Workitem not found in #{self.class}, cannot save." \
+                unless self.has_key? workitem.flow_expression_id
+
+            self[workitem.flow_expression_id] = workitem
+        end
+
+        #
+        # The workflow client is done with the workitem, send it back to
+        # the engine and make sure it's not in the store participant anymore.
+        #
+        def forward (workitem)
+
+            raise "Workitem not found in #{self.class}, cannot forward." \
+                unless self.has_key? workitem.flow_expression_id
+
+            self.delete(workitem.flow_expression_id)
+            reply_to_engine(workitem)
+        end
+
+        #
+        # 'proceed' is just an alias for 'forward'
+        #
+        alias :proceed :forward
+
+        #
+        # Returns all the workitems for a given workflow isntance id.
+        #
+        def list_workitems (workflow_instance_id)
+
+            result = []
+            self.each_value do |workitem|
+                result << workitem \
+                    if workitem.fei.parent_wfid == workflow_instance_id
+            end
+
+            result
+        end
+    end
+
+    #
+    # The simplest workitem store possible, gathers the workitem in a 
+    # hash (this class is an extension of Hash).
+    #
+    class HashParticipant < Hash
+        include StoreParticipantMixin
+
+        # that's all...
+    end
+end

data/test/{crontest.rb → cron_test.rb}

@@ -8,14 +8,15 @@
 #
 
 require 'test/unit'
-require 'otime'
-require 'ru/util/scheduler'
+
+require 'openwfe/util/otime'
+require 'openwfe/util/scheduler'
+
 
 #
-# testing otime and the scheduler
+# testing otime and the scheduler (its cron aspect)
 #
-
-class TimeTest < Test::Unit::TestCase
+class CronTest < Test::Unit::TestCase
 
     #def setup
     #end
@@ -29,7 +30,7 @@ class TimeTest < Test::Unit::TestCase
         scheduler = OpenWFE::Scheduler.new()
         scheduler.start
 
-        sid = scheduler.schedule('* * * * *', CounterSchedulable.new, nil)
+        sid = scheduler.schedule('* * * * *', nil, CounterSchedulable.new, nil)
 
         assert \
             sid,

data/test/cronline_test.rb

@@ -0,0 +1,51 @@
+
+#
+# Testing OpenWFE
+#
+# John Mettraux at openwfe.org
+#
+# Sun Oct 29 16:18:25 JST 2006
+#
+
+require 'pp'
+require 'test/unit'
+
+require 'openwfe/util/scheduler'
+
+
+#
+# testing the Scheduler's CronLine system
+#
+class CronLineTest < Test::Unit::TestCase
+
+    #def setup
+    #end
+
+    #def teardown
+    #end
+
+    def do_cltest (line, array)
+        cl = OpenWFE::CronLine.new(line)
+
+        unless cl.to_array == array
+            puts
+            pp cl.to_array
+            puts "   should be"
+            pp array
+        end
+
+        assert \
+            cl.to_array == array
+    end
+
+    def test_cron_line_0
+        do_cltest "* * * * *", [ nil, nil, nil, nil, nil ]
+        do_cltest "10-12 * * * *", [ [10, 11, 12], nil, nil, nil, nil ]
+        do_cltest "* * * * sun,mon", [ nil, nil, nil, nil, [7, 1] ]
+        do_cltest "* * * * mon-wed", [ nil, nil, nil, nil, [1, 2, 3] ]
+
+        #do_cltest "* * * * sun,mon-tue", [ nil, nil, nil, nil, [7, 1, 2] ]
+        #do_cltest "* * * * 7-1", [ nil, nil, nil, nil, [7, 1, 2] ]
+    end
+
+end