openwferu 0.9.3 → 0.9.4

data/lib/openwfe/utils.rb

@@ -211,6 +211,70 @@ module OpenWFE
             return (Time.now.to_f - @start) * 1000
         end
     end
+
+    #
+    # This method is used within the InFlowWorkItem and the CsvTable classes.
+    #
+    def OpenWFE.lookup_attribute (container, key)
+
+        key, rest = pop_key(key)
+        value = container[key]
+
+        return value unless rest
+
+        return nil unless value
+
+        return lookup_attribute(value, rest)
+    end
+
+    #
+    # This method is used within the InFlowWorkItem and the CsvTable classes.
+    #
+    def OpenWFE.has_attribute? (container, key)
+
+        key, rest = pop_key(key)
+
+        if not rest
+
+            return container.has_key?(key) \
+                if container.respond_to?(:has_key?)
+
+            return false
+        end
+
+        return has_attribute?(rest, key)
+    end
+
+    #
+    # This method is used within the InFlowWorkItem and the CsvTable classes.
+    #
+    def OpenWFE.set_attribute (container, key, value)
+
+        i = key.rindex(".")
+
+        if not i
+            container[key] = value
+            return
+        end
+
+        container = lookup_attribute(container, key[0..i-1])
+        container[key[i+1..-1]] = value
+    end
+
+    protected
+
+        def pop_key (key)
+            i = key.index(".")
+            return narrow(key), nil unless i
+            return narrow(key[0..i-1]), key[i+1..-1]
+        end
+
+        def narrow (key)
+            return 0 if key == "0"
+            i = key.to_i
+            return i if i != 0
+            return key
+        end
     
 end
 

data/lib/openwfe/version.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.
+#++
+#
+# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
+#
+
+module OpenWFE
+    OPENWFERU_VERSION = '0.9.4'
+end

data/lib/openwfe/workitem.rb

@@ -117,9 +117,62 @@ module OpenWFE
             super(m, args)
         end
 
+        #
+        # Produces a deep copy of the workitem
+        #
         def dup
             return OpenWFE::fulldup(self)
         end
+
+        #
+        # A smarter alternative to
+        #
+        #     value = workitem.attributes[x]
+        #
+        # Via this method, nested values can be reached. For example :
+        #
+        #     wi = InFlowWorkItem.new()
+        #     wi.attributes = {
+        #         "field0" => "value0",
+        #         "field1" => [ 0, 1, 2, 3, [ "a", "b", "c" ]],
+        #         "field2" => {
+        #             "a" => "AA", 
+        #             "b" => "BB", 
+        #             "c" => [ "C0", "C1", "C3" ]
+        #         },
+        #         "field3" => 3,
+        #         "field99" => nil
+        #     }
+        #
+        # will verify the following assertions :
+        #
+        #     assert wi.lookup_attribute("field3") == 3
+        #     assert wi.lookup_attribute("field1.1") == 1
+        #     assert wi.lookup_attribute("field1.4.1") == "b"
+        #     assert wi.lookup_attribute("field2.c.1") == "C1"
+        #
+        def lookup_attribute (key)
+            OpenWFE.lookup_attribute(@attributes, key)
+        end
+
+        #
+        # The partner to the lookup_attribute() method. Behaves like it.
+        #
+        def has_attribute? (key)
+            OpenWFE.has_attribute?(@attributes, key)
+        end
+
+        #
+        # set_attribute() accomodates itself with nested key constructs.
+        #
+        def set_attribute (key, value)
+            OpenWFE.set_attribute(@attributes, key, value)
+        end
+
+        alias :lookup_field :lookup_attribute
+        alias :has_field? :has_attribute?
+        alias :set_field :set_attribute
+
     end
 
     #

data/lib/openwfe/worklist/storeparticipant.rb

@@ -35,9 +35,10 @@
 #
 # "made in Japan"
 #
-# Alain Hoang at openwfe.org
+# John Mettraux at openwfe.org
 #
 
+require 'openwfe/storage/yamlfilestorage'
 require 'openwfe/participants/participant'
 
 
@@ -119,14 +120,16 @@ module OpenWFE
         alias :proceed :forward
 
         #
-        # Returns all the workitems for a given workflow isntance id.
+        # Returns all the workitems for a given workflow instance id.
+        # If no workflow_instance_id is given, all the workitems will be
+        # returned.
         #
-        def list_workitems (workflow_instance_id)
+        def list_workitems (workflow_instance_id=nil)
 
             result = []
             self.each_value do |workitem|
                 result << workitem \
-                    if workitem.fei.parent_wfid == workflow_instance_id
+                    if (not workflow_instance_id) or workitem.fei.parent_wfid == workflow_instance_id
             end
 
             result
@@ -142,4 +145,16 @@ module OpenWFE
 
         # that's all...
     end
+
+    #
+    # TODO : finish me
+    #
+    class YamlParticipant  < YamlFileStorage
+        include StoreParticipantMixin
+
+        def initialize
+            workpath = application_context[:work_directory] + "/participants"
+            super(service_name, application_context, workpath)
+        end
+    end
 end

data/test/csv_test.rb

@@ -0,0 +1,285 @@
+#
+# Testing OpenWFEru
+#
+# John Mettraux at openwfe.org
+#
+# Sun Oct 29 15:41:44 JST 2006
+#
+
+require 'test/unit'
+
+#require 'pp'
+
+require 'openwfe/workitem'
+require 'openwfe/participants/csvparticipant'
+
+#require 'rutest_utils'
+
+include OpenWFE
+
+
+
+class CsvTest < Test::Unit::TestCase
+
+    #def setup
+    #end
+
+    #def teardown
+    #end
+
+    CSV0 = \
+"""
+,,
+in:fx,in:fy,out:fz
+,,
+a,b,0
+c,d,1
+e,f,2
+"""
+
+    def test_csv_0
+
+        wi = InFlowWorkItem.new()
+
+        wi.fx = "c"
+        wi.fy = "d"
+
+        do_test(CSV0, wi, { "fz" => "1" }, false)
+
+        wi.attributes.clear()
+        wi.fx = "a"
+        wi.fy = "d"
+
+        do_test(CSV0, wi, { "fz" => nil }, false)
+    end
+
+    CSV1 = \
+"""
+,,
+in:fx,in:fy,out:fz
+,,
+a,${f:fx},0
+c,d,${f:fx}
+e,f,${r:3+4}
+"""
+
+    def test_csv_1
+
+        wi = InFlowWorkItem.new()
+
+        wi.fx = "c"
+        wi.fy = "d"
+
+        do_test(CSV1, wi, { "fz" => "c" }, false)
+
+        wi.attributes.clear()
+        wi.fx = "e"
+        wi.fy = "f"
+
+        do_test(CSV1, wi, { "fz" => "7" }, false)
+
+        wi.attributes.clear()
+        wi.fx = "a"
+        wi.fy = "a"
+
+        do_test(CSV1, wi, { "fz" => "0" }, false)
+    end
+
+    CSV2 = \
+"""
+in:fx, in:fy, out:fz
+,,
+a,     b,     0
+c,     d,     1
+e,     f,     2
+"""
+
+    def test_csv_2
+
+        wi = InFlowWorkItem.new()
+
+        wi.fx = "c"
+        wi.fy = "d"
+
+        do_test(CSV2, wi, { "fz" => "1" }, false)
+
+        wi.attributes.clear()
+        wi.fx = "a"
+        wi.fy = "d"
+
+        do_test(CSV2, wi, { "fz" => nil }, false)
+    end
+
+    CSV3 = \
+"""
+in:weather, in:month, out:take_umbrella?
+,,
+raining,    ,         yes
+sunny,      ,         no
+cloudy,     june,     yes
+cloudy,     may,      yes
+cloudy,     ,         no
+"""
+
+    def test_csv_3
+
+        wi = InFlowWorkItem.new()
+
+        wi.weather = "raining"
+        wi.month = "december"
+
+        do_test(CSV3, wi, { "take_umbrella?" => "yes" }, false)
+
+        wi.attributes.clear()
+        wi.weather = "cloudy"
+        wi.month = "june"
+
+        do_test(CSV3, wi, { "take_umbrella?" => "yes" }, false)
+
+        wi.attributes.clear()
+        wi.weather = "cloudy"
+        wi.month = "march"
+
+        do_test(CSV3, wi, { "take_umbrella?" => "no" }, false)
+    end
+
+    def test_csv_3b
+
+        h = {}
+        h["weather"] = "raining"
+        h["month"] = "december"
+        do_test(CSV3, h, { "take_umbrella?" => "yes" }, false)
+
+        h = {}
+        h["weather"] = "cloudy"
+        h["month"] = "june"
+        do_test(CSV3, h, { "take_umbrella?" => "yes" }, false)
+
+        h = {}
+        h["weather"] = "cloudy"
+        h["month"] = "march"
+        do_test(CSV3, h, { "take_umbrella?" => "no" }, false)
+    end
+
+    def test_csv_3c
+
+         table = CsvTable.new("""
+             in:topic,in:region,out:team_member
+             sports,europe,Alice
+             sports,,Bob
+             finance,america,Charly
+             finance,europe,Donald
+             finance,,Ernest
+             politics,asia,Fujio
+             politics,america,Gilbert
+             politics,,Henry
+             ,,Zach
+         """)
+         
+         h = {}
+         h["topic"] = "politics"
+         table.transform(h)
+         
+         assert h["team_member"] == "Henry"
+    end
+
+#    CSV4 = \
+#'''
+#"in:weather", "in:month", "out:take_umbrella?"
+#"","",""
+#"raining","","yes"
+#"sunny","","no"
+#"cloudy","june","yes"
+#"cloudy","may","yes"
+#"cloudy","","no"
+#'''
+
+    #def test_csv_4
+    #    h = {}
+    #    h["weather"] = "raining"
+    #    h["month"] = "december"
+    #    do_test(CSV4, h, { "take_umbrella?" => "yes" }, false)
+    #    h = {}
+    #    h["weather"] = "cloudy"
+    #    h["month"] = "june"
+    #    do_test(CSV4, h, { "take_umbrella?" => "yes" }, false)
+    #    h = {}
+    #    h["weather"] = "cloudy"
+    #    h["month"] = "march"
+    #    do_test(CSV4, h, { "take_umbrella?" => "no" }, false)
+    #end
+
+    CSV5 = \
+"""
+through,ignorecase,,
+,,,
+in:fx, in:fy, out:fX, out:fY
+,,,
+a,     ,      true,
+,      a,     ,       true
+b,     ,      false,
+,      b,     ,       false
+"""
+
+    def test_csv_5
+
+        wi = InFlowWorkItem.new()
+        wi.fx = "a"
+        wi.fy = "a"
+        do_test(CSV5, wi, { "fX" => "true", "fY" => "true" }, false)
+
+        wi.attributes.clear
+        wi.fx = "a"
+        wi.fy = "b"
+        do_test(CSV5, wi, { "fX" => "true", "fY" => "false" }, false)
+
+        wi.attributes.clear
+        wi.fx = "A"
+        wi.fy = "b"
+        do_test(CSV5, wi, { "fX" => "true", "fY" => "false" }, false)
+    end
+
+    protected
+
+        def do_test (table_data, wi, expected_result, verbose=false)
+
+            table = CsvTable.new(table_data)
+
+            if verbose
+                puts
+                puts "before :"
+                puts wi
+            end
+
+            wi = if wi.kind_of? Hash
+                table.transform(wi)
+            else
+                table.transform_wi(nil, wi)
+            end
+
+            if verbose
+                puts
+                puts "after :"
+                puts wi
+            end
+
+            expected_result.each do |k, v|
+
+                #if wi.attributes[k] != v
+                #end
+
+                value = if wi.kind_of? Hash
+                    wi[k]
+                else
+                    wi.attributes[k]
+                end
+
+                assert \
+                    value == v,
+                    "attribute '#{k}' should be set to '#{v}' "+
+                    "but is set to '#{value}'"
+            end
+        end
+
+end
+

data/test/fei_test.rb

@@ -134,7 +134,7 @@ class FeiTest < Test::Unit::TestCase
 
         def new_fei ()
             fei = OpenWFE::FlowExpressionId.new()
-            fei.owfe_version = OpenWFE::OPENWFE_VERSION
+            fei.owfe_version = OpenWFE::OPENWFERU_VERSION
             fei.engine_id = 'this'
             fei.initial_engine_id = 'that'
             fei.workflow_definition_url = 'http://test/test.xml'

data/test/file_persistence_test.rb

@@ -79,8 +79,8 @@ class FilePersistenceTest < Test::Unit::TestCase
         
         def new_fei (definition_name = nil)
 
-            fei = OpenWFE::FlowExpressionId.new()
-            fei.owfe_version = OPENWFE_VERSION
+            fei = FlowExpressionId.new()
+            fei.owfe_version = OPENWFERU_VERSION
             fei.engine_id = 'this'
             fei.initial_engine_id = 'that'
             fei.workflow_definition_url = 'http://test/test.xml'

data/test/flowtestbase.rb

@@ -19,12 +19,19 @@ require 'rutest_utils'
 
 include OpenWFE
 
+persistence = ENV["__persistence__"]
 
-$WORKFLOW_ENGINE_CLASS = Engine \
-    if not $WORKFLOW_ENGINE_CLASS
+
+$WORKFLOW_ENGINE_CLASS = Engine
+if persistence == "FilePersistedEngine"
+    require "openwfe/engine/file_persisted_engine"
+    $WORKFLOW_ENGINE_CLASS = FilePersistedEngine
+end
+    
 
 puts
 puts "testing with engine of class " + $WORKFLOW_ENGINE_CLASS.to_s
+#puts "testing with engine of class " + ENV["workflow_engine_class"]
 puts
 
 class FlowTestBase < Test::Unit::TestCase
@@ -34,7 +41,7 @@ class FlowTestBase < Test::Unit::TestCase
 
     def setup
 
-        @engine = $WORKFLOW_ENGINE_CLASS.new()
+        @engine = eval("#{$WORKFLOW_ENGINE_CLASS}").new()
 
         @tracer = Tracer.new
         @engine.application_context["__tracer"] = @tracer

data/test/ft_0.rb

@@ -25,13 +25,6 @@ class FlowTest0 < FlowTestBase
 </process-definition>''', "ok")
     end
 
-    def test_participant
-        dotest(\
-'''<process-definition name="n" revision="0">
-    <participant ref="test-alpha" />
-</process-definition>''', "test-alpha")
-    end
-
     def test_dollar_notation_0
         dotest(\
 '''<process-definition name="n" revision="0">

data/test/ft_0d_participant.rb

@@ -0,0 +1,29 @@
+
+#
+# Testing OpenWFE
+#
+# John Mettraux at openwfe.org
+#
+# Mon Oct  9 22:19:44 JST 2006
+#
+
+require 'flowtestbase'
+
+
+class FlowTest0d < FlowTestBase
+
+    #def setup
+    #end
+
+    #def teardown
+    #end
+
+    def test_participant
+        dotest(\
+'''<process-definition name="n" revision="0">
+    <participant ref="test-alpha" />
+</process-definition>''', "test-alpha")
+    end
+
+end
+

data/test/ft_11_ppd.rb

@@ -8,7 +8,8 @@
 #
 
 require 'flowtestbase'
-require 'openwfe/expressions/raw_prog'
+#require 'openwfe/expressions/raw_prog'
+require 'openwfe/def'
 
 include OpenWFE
 
@@ -337,5 +338,29 @@ b""")
             "toto")
     end
 
+
+    #
+    # Test 9
+    #
+
+    class TestDefinition9 < ProcessDefinition
+        def make
+            process_definition :name => "test8", :revision => "0" do
+                _toto
+                process_definition :name => "toto" do
+                    _print "toto"
+                end
+            end
+        end
+    end
+
+    def test_ppd_9
+    #def xxxx_ppd_9
+
+        dotest(
+            TestDefinition9,
+            "toto")
+    end
+
 end
 

data/test/ft_12_blockparticipant.rb

@@ -19,6 +19,7 @@ class FlowTest12 < FlowTestBase
     #def teardown
     #end
 
+
     #
     # Test 0
     #
@@ -34,12 +35,38 @@ class FlowTest12 < FlowTestBase
         end
     end
 
-    def test_block_participant
+    def test_bp_0
         dotest(
             BpDef0,
             """the block participant received a workitem
 done.""")
     end
 
+
+    #
+    # Test 1
+    #
+
+    class BpDef1 < OpenWFE::ProcessDefinition
+        def make
+            process_definition :name => "test1", :revision => "0" do
+                bp1a
+            end
+        end
+    end
+
+    def test_bp_1
+
+        @engine.register_participant("bp1a") do |fexp, wi|
+            @tracer << "bp1a : "
+            @tracer << fexp.class.name
+            @tracer << "\n"
+        end
+
+        dotest(
+            BpDef1,
+            """bp1a : OpenWFE::ParticipantExpression""")
+    end
+
 end