openwferu 0.9.5 → 0.9.6

data/lib/openwfe/utils.rb

@@ -39,6 +39,10 @@
 # john.mettraux@openwfe.org
 #
 
+require 'tmpdir'
+require 'open-uri'
+
+
 module OpenWFE
 
     #
@@ -152,6 +156,18 @@ module OpenWFE
         string.gsub("_", "-")
     end
 
+    #
+    # Returns an URI if the string is one, else returns nil.
+    # No exception is thrown by this method.
+    #
+    def OpenWFE.parse_uri (string)
+        begin
+            return URI::parse(string)
+        rescue Exception => e
+        end
+        return nil
+    end
+
     #
     # Returns true if the given string starts with the 'start' string.
     #
@@ -209,9 +225,16 @@ module OpenWFE
     #     end
     #
     def OpenWFE.call_in_thread (caller_name, caller_object=nil, &block)
+
         return unless block
+
         Thread.new do
             begin
+                #$SAFE = safe_level
+                    #
+                    # doesn't work : the block inherits the safety level
+                    # of its surroundings, it's a closure, ne ?
+
                 block.call
             rescue Exception => e
                 msg = "#{caller_name} caught an exception\n" + exception_to_s(e)

data/lib/openwfe/version.rb

@@ -34,5 +34,5 @@
 #
 
 module OpenWFE
-    OPENWFERU_VERSION = '0.9.5'
+    OPENWFERU_VERSION = '0.9.6'
 end

data/lib/openwfe/workitem.rb

@@ -71,6 +71,21 @@ module OpenWFE
         alias :fields :attributes
         alias :fields= :attributes=
 
+        def to_h
+            h = {}
+            h[:type] = self.class.name
+            h[:last_modified] = @last_modified
+            h[:attributes] = @attributes
+            h
+        end
+
+        def WorkItem.from_h (h)
+            wi = eval("#{h[:type]}.new")
+            wi.last_modified = h[:last_modified]
+            wi.attributes = h[:attributes]
+            wi
+        end
+
         #
         # In order to simplify code like :
         #
@@ -195,6 +210,20 @@ module OpenWFE
         #
         alias :fei :flow_expression_id
         alias :fei= :flow_expression_id=
+
+        def to_h
+            h = super
+            h[:flow_expression_id] = @flow_expression_id.to_h
+            h[:participant_name] = @participant_name
+            h
+        end
+
+        def InFlowItem.from_h (h)
+            wi = super
+            wi.flow_expression_id = FlowExpressionId.from_h(h[:flow_expression_id])
+            wi.participant_name = h[:participant_name]
+            wi
+        end
     end
 
     #
@@ -226,7 +255,30 @@ module OpenWFE
                 s << "    * '#{k}' --> '#{v}'\n"
             end
             s << "  <<<#{self.class}<<<"
-            return s
+            s
+        end
+
+        #
+        # For some easy YAML encoding, turns the workitem into a Hash
+        # (Any YAML-enabled platform can thus read it).
+        #
+        def to_h
+            h = super
+            h[:dispatch_time] = @dispatch_time
+            h[:history] = @history
+            h[:filter] = @filter
+            h
+        end
+
+        #
+        # Rebuilds an InFlowWorkItem from its hash version.
+        #
+        def InFlowWorkItem.from_h (h)
+            wi = super
+            wi.dispatch_time = h[:dispatch_time]
+            wi.history = h[:history]
+            wi.filter = h[:filter]
+            wi
         end
     end
 
@@ -251,9 +303,15 @@ module OpenWFE
     #
     class LaunchItem < WorkItem
 
+        DEF = "__definition"
+        FIELD_DEF = "field:#{DEF}"
+
         attr_accessor :workflow_definition_url
             #, :description_map
 
+        alias :wfdurl :workflow_definition_url
+        alias :wfdurl= :workflow_definition_url=
+
         #
         # This constructor will build an empty launchitem.
         # If the optional parameter process_definition is set, the
@@ -265,12 +323,37 @@ module OpenWFE
             super()
 
             if process_definition
-                @workflow_definition_url = "field:__definition"
-                @attributes['__definition'] = process_definition
+                @workflow_definition_url = FIELD_DEF
+                @attributes[DEF] = process_definition
             end
         end
+
+        #
+        # Turns the LaunchItem instance into a simple 'hash' (easily
+        # serializable to other formats).
+        #
+        def to_h
+            h = super
+            h[:workflow_definition_url] = @workflow_definition_url
+            h
+        end
+
+        def LaunchItem.from_h (h)
+            li = super
+            li.workflow_definition_url = h[:workflow_definition_url]
+            li
+        end
     end
 
+    #
+    # Turns a hash into its corresponding workitem (InFlowWorkItem, CancelItem,
+    # LaunchItem).
+    #
+    def OpenWFE.workitem_from_h (h)
+        wi_class = h[:type]
+        wi_class = eval(wi_class)
+        wi_class.from_h(h)
+    end
 
     #
     # HISTORY ITEM

data/lib/openwfe/worklist/storeparticipant.rb

@@ -39,6 +39,7 @@
 #
 
 require 'openwfe/utils'
+require 'openwfe/rudefinitions'
 require 'openwfe/storage/yamlfilestorage'
 require 'openwfe/participants/participant'
 
@@ -135,12 +136,42 @@ module OpenWFE
 
             return result
         end
+
+        #
+        # Returns the first workitem at hand.
+        # As a StoreParticipant is usually implemented with a hash, two
+        # consecutive calls to this method might not return the same workitem
+        # (except if the store is empty or contains 1! workitem).
+        #
+        def first_workitem ()
+
+            result = nil
+
+            self.each_value do |workitem|
+                result = workitem
+                break
+            end
+
+            return result
+        end
     end
 
     #
     # The simplest workitem store possible, gathers the workitem in a 
     # hash (this class is an extension of Hash).
     #
+    # Some examples :
+    #
+    #     engine.register_participant(:alice, OpenWFE::HashParticipant)
+    #     engine.register_participant("bob", OpenWFE::HashParticipant)
+    #
+    #     hp = engine.register_participant(:charly, OpenWFE::HashParticipant)
+    #     #...
+    #     puts "there are currently #{hp.size} workitems for Charly"
+    #
+    #     hp = OpenWFE::HashParticipant.new
+    #     engine.register_participant("debbie", hp)
+    #
     class HashParticipant < Hash
         include StoreParticipantMixin
 
@@ -151,6 +182,15 @@ module OpenWFE
     # Implementation of a store participant stores the workitems in
     # yaml file in a dedicated directory.
     #
+    # It's quite easy to register a YamlParticipant :
+    #
+    #     yp = engine.register_participant(:alex, YamlParticipant)
+    #
+    #     puts yp.dirname
+    #
+    # should yield "./work/participants/alex/" (if the key :work_directory
+    # in engine.application_context is unset)
+    #
     class YamlParticipant  < YamlFileStorage
         include StoreParticipantMixin
 
@@ -163,14 +203,14 @@ module OpenWFE
         #
         def initialize (dirname, application_context)
 
+            workdir = application_context[:work_directory]
+            workdir = OpenWFE::DEFAULT_WORK_DIRECTORY unless workdir
+
             @dirname = OpenWFE::ensure_for_filename(dirname.to_s)
 
             service_name = @self.class.name + "__" + @dirname
 
-            path =
-                application_context[:work_directory] + 
-                "/participants/" +
-                @dirname
+            path = workdir + "/participants/" + @dirname
 
             super(service_name, application_context, path)
         end

data/test/csv_test.rb

@@ -11,7 +11,7 @@ require 'test/unit'
 #require 'pp'
 
 require 'openwfe/workitem'
-require 'openwfe/participants/csvparticipant'
+require 'openwfe/participants/csvparticipants'
 
 #require 'rutest_utils'
 

data/test/eno_test.rb

@@ -11,7 +11,7 @@ require 'openwfe/workitem'
 require 'openwfe/engine/engine'
 require 'openwfe/expressions/raw_prog'
 require 'openwfe/participants/participants'
-require 'openwfe/participants/enoparticipant'
+require 'openwfe/participants/enoparticipants'
 require 'flowtestbase'
 
 include OpenWFE

data/test/fei_test.rb

@@ -8,9 +8,10 @@
 #
 
 require 'test/unit'
+require 'rutest_utils'
 require 'openwfe/workitem'
 require 'openwfe/flowexpressionid'
-require 'openwfe/rudefinitions'
+#require 'openwfe/rudefinitions'
 
 
 class FeiTest < Test::Unit::TestCase
@@ -132,20 +133,6 @@ class FeiTest < Test::Unit::TestCase
 
     protected
 
-        def new_fei ()
-            fei = OpenWFE::FlowExpressionId.new()
-            fei.owfe_version = OpenWFE::OPENWFERU_VERSION
-            fei.engine_id = 'this'
-            fei.initial_engine_id = 'that'
-            fei.workflow_definition_url = 'http://test/test.xml'
-            fei.workflow_definition_name = 'test'
-            fei.workflow_definition_revision = '1.0'
-            fei.workflow_instance_id = '123456'
-            fei.expression_name = 'do-test'
-            fei.expression_id = '0.0'
-            return fei
-        end
-
         def puts_hash (h)
             puts
             h.each do |k, v|

data/test/flowtestbase.rb

@@ -45,7 +45,7 @@ module FlowTestBase
 
     def setup
 
-        @engine = eval("#{$WORKFLOW_ENGINE_CLASS}").new()
+        @engine = $WORKFLOW_ENGINE_CLASS.new()
 
         @tracer = Tracer.new
         @engine.application_context["__tracer"] = @tracer
@@ -102,7 +102,11 @@ module FlowTestBase
 
             # register unique tracing participant
 
-            li = OpenWFE::LaunchItem.new(flowDef)
+            li = if flowDef.kind_of? OpenWFE::LaunchItem
+                flowDef
+            else
+                OpenWFE::LaunchItem.new(flowDef)
+            end
 
             @engine.launch(li)
 

data/test/ft_11_ppd.rb

@@ -388,5 +388,36 @@ toto
 toto""")
     end
 
+
+    #
+    # Test 11
+    #
+
+    class TestDefinition11 < ProcessDefinition
+        def make
+            sequence do
+                [ :b, :b, :b ].each do |p|
+                    participant p
+                end
+                participant "b"
+            end
+        end
+    end
+
+    #def xxxx_ppd_11
+    def test_ppd_11
+
+        @engine.register_participant(:b) do |workitem|
+            @tracer << "b\n"
+        end
+
+        dotest(
+            TestDefinition11,
+            """b
+b
+b
+b""")
+    end
+
 end
 

data/test/ft_13_eno.rb

@@ -9,7 +9,7 @@
 
 require 'openwfe/expressions/raw_prog'
 require 'openwfe/participants/participants'
-require 'openwfe/participants/enoparticipant'
+require 'openwfe/participants/enoparticipants'
 require 'flowtestbase'
 
 

data/test/ft_14b_subprocess.rb

@@ -7,6 +7,7 @@
 # Mon Oct  9 22:19:44 JST 2006
 #
 
+require 'openwfe/def'
 require 'flowtestbase'
 
 
@@ -19,6 +20,10 @@ class FlowTest14b < Test::Unit::TestCase
     #def teardown
     #end
 
+
+    #
+    # TEST 0
+
     def test_subprocess_ref_0
     #def xxxx_subprocess_ref_0
         dotest(\
@@ -37,5 +42,74 @@ class FlowTest14b < Test::Unit::TestCase
 ABC''')
     end
 
+
+    #
+    # TEST 1
+
+    class SubTest1 < OpenWFE::ProcessDefinition
+        def make
+
+            sub1 "toto", :a => "A"
+
+            process_definition :name => :sub1 do
+                _print "${0} ${a}"
+            end
+        end
+    end
+
+    #def xxxx_sub_1
+    def test_sub_1
+        dotest(SubTest1, "toto A")
+    end
+
+
+    #
+    # TEST 1b
+
+    def test_subprocess_ref_1b
+    #def xxxx_subprocess_ref_1b
+        dotest(\
+'''<process-definition name="subtest0" revision="0">
+
+    <sequence>
+        <subprocess ref="sub0" a="A">zero</subprocess>
+        <sub0 a="A">rei</sub0>
+    </sequence>
+
+    <process-definition name="sub0">
+        <print>${0} ${a}</print>
+    </process-definition>
+
+</process-definition>''', 
+        """zero A
+rei A""")
+    end
+
+
+    #
+    # TEST 2
+
+    class SubTest2 < OpenWFE::ProcessDefinition
+        def make
+
+            sequence do
+                sub1 do 
+                    "a"
+                end
+                sub1 "c", "d"
+            end
+
+            process_definition :name => :sub1 do
+                _print "${0} ${1}"
+            end
+        end
+    end
+
+    #def xxxx_sub_2
+    def test_sub_2
+        dotest(SubTest2, """a 
+c d""")
+    end
+
 end