ruote 0.9.19 → 0.9.20

data/lib/openwfe/participants/participants.rb

@@ -1,41 +1,27 @@
-#
 #--
-# Copyright (c) 2006-2008, 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:
+# Copyright (c) 2006-2009, John Mettraux, jmettraux@gmail.com
 #
-# . Redistributions of source code must retain the above copyright notice, this
-#   list of conditions and the following disclaimer.
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
 #
-# . 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.
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
 #
-# . 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.
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
 #
-# 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.
 #++
-#
 
-#
-# "made in Japan"
-#
-# John Mettraux at openwfe.org
-#
 
 require 'yaml'
 
@@ -67,7 +53,7 @@ module OpenWFE
     #
     def initialize (context_or_dir=nil)
 
-      @workdir = get_work_directory(context_or_dir) + "/out/"
+      @workdir = get_work_directory(context_or_dir) + '/out/'
 
       @reply_anyway = false
     end
@@ -77,7 +63,7 @@ module OpenWFE
     #
     def consume (workitem)
 
-      FileUtils.makedirs(@workdir) unless File.exist?(@workdir)
+      FileUtils.mkdir_p(@workdir) unless File.exist?(@workdir)
 
       file_name = @workdir + determine_file_name(workitem)
 
@@ -93,8 +79,8 @@ module OpenWFE
     #
     def dump_to_file (file_name, workitem)
 
-      File.open(file_name, "w") do |file|
-        file.print encode_workitem(workitem)
+      File.open(file_name, 'w') do |file|
+        file.print(encode_workitem(workitem))
       end
     end
 
@@ -111,19 +97,19 @@ module OpenWFE
       OpenWFE::ensure_for_filename(
         "#{fei.wfid}_#{fei.expression_id}__" +
         "#{fei.workflow_definition_name}__" +
-        "#{fei.workflow_definition_revision}" +
+        "#{fei.workflow_definition_revision}__" +
         "#{workitem.participant_name}.yaml")
     end
 
     protected
 
-      #
-      # By default, uses YAML to serialize the workitem
-      # (of course you can override this method).
-      #
-      def encode_workitem (wi)
-        YAML.dump wi
-      end
+    #
+    # By default, uses YAML to serialize the workitem
+    # (of course you can override this method).
+    #
+    def encode_workitem (wi)
+      YAML.dump(wi)
+    end
   end
 
   #
@@ -157,25 +143,20 @@ module OpenWFE
     include LocalParticipant
 
     def initialize (block0=nil, &block1)
-      @block = if block1
-        block1
-      else
-        block0
-      end
-      raise "Missing a block parameter" \
-        unless @block
+
+      @block = block1 ? block1 : block0
+
+      raise 'Missing a block parameter' unless @block
     end
 
     def consume (workitem)
 
-      result = call_block @block, workitem
+      result = call_block(@block, workitem)
 
-      workitem.set_result(result) \
-        if result and result != workitem
+      workitem.set_result(result) if result and result != workitem
 
-      reply_to_engine(workitem) \
-        if workitem.kind_of? InFlowWorkItem
-      # else it's a cancel ite
+      reply_to_engine(workitem) if workitem.kind_of?(InFlowWorkItem)
+        # else it's a cancel item
     end
   end
 
@@ -238,7 +219,7 @@ module OpenWFE
     #
     def consume (workitem)
 
-      reply_to_engine workitem
+      reply_to_engine(workitem)
     end
   end
 
@@ -337,7 +318,7 @@ module OpenWFE
 
       super()
 
-      template_uri = OpenWFE::parse_known_uri object
+      template_uri = OpenWFE::parse_known_uri(object)
 
       @template = template_uri || object
     end
@@ -348,13 +329,6 @@ module OpenWFE
     #
     def consume (workitem)
 
-      #get_expression_pool.launch_template(
-      #  get_flow_expression(workitem),
-      #  nil, # new environment
-      #  0, # sub_id
-      #  @template,
-      #  workitem)
-      #  #params)
       get_expression_pool.launch_subprocess(
         get_flow_expression(workitem),
         @template,
@@ -378,11 +352,11 @@ module OpenWFE
     #
     def eval_template (workitem)
 
-      fe = get_flow_expression workitem
+      fe = get_flow_expression(workitem)
 
       template = if @block_template
 
-        call_block @block_template, workitem
+        call_block(@block_template, workitem)
 
       elsif @template
 
@@ -397,9 +371,9 @@ module OpenWFE
         nil
       end
 
-      return "(no template given)" unless template
+      return '(no template given)' unless template
 
-      OpenWFE::dosub template, fe, workitem
+      OpenWFE::dosub(template, fe, workitem)
     end
   end
 

data/lib/openwfe/participants/{soapparticipants.rb → soap_participants.rb}

@@ -1,41 +1,27 @@
-#
 #--
-# Copyright (c) 2007-2008, 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:
+# Copyright (c) 2007-2009, John Mettraux, jmettraux@gmail.com
 #
-# . Redistributions of source code must retain the above copyright notice, this
-#   list of conditions and the following disclaimer.
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
 #
-# . 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.
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
 #
-# . 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.
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
 #
-# 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.
 #++
-#
 
-#
-# "made in Japan"
-#
-# John Mettraux at openwfe.org
-#
 
 require 'soap/rpc/driver'
 
@@ -67,8 +53,8 @@ module OpenWFE
   class SoapParticipant
     include LocalParticipant
 
-    def initialize \
-      (endpoint_url, namespace, method_name, params, param_prefix="")
+    def initialize (
+      endpoint_url, namespace, method_name, params, param_prefix='')
 
       super()
 
@@ -105,7 +91,7 @@ module OpenWFE
     def prepare_call_params (workitem)
 
       @params.collect do |param|
-        get_param workitem, param
+        get_param(workitem, param)
       end
     end
 
@@ -117,7 +103,7 @@ module OpenWFE
     #
     def handle_call_result (result, workitem)
 
-      workitem.attributes["__result__"] = result
+      workitem.set_result(result)
     end
 
     protected
@@ -126,7 +112,7 @@ module OpenWFE
 
         param_name = @param_prefix + param_name if @param_prefix
 
-        workitem.attributes[param_name] || ""
+        workitem.attributes[param_name] || ''
       end
 
   end

data/lib/openwfe/participants/{storeparticipants.rb → store_participants.rb}

@@ -1,45 +1,31 @@
-#
 #--
-# Copyright (c) 2007-2008, 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:
+# Copyright (c) 2007-2009, John Mettraux, jmettraux@gmail.com
 #
-# . Redistributions of source code must retain the above copyright notice, this
-#   list of conditions and the following disclaimer.
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
 #
-# . 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.
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
 #
-# . 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.
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
 #
-# 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.
 #++
-#
 
-#
-# "made in Japan"
-#
-# John Mettraux at openwfe.org
-#
 
 require 'openwfe/utils'
 require 'openwfe/omixins'
-require 'openwfe/storage/yamlfilestorage'
+require 'openwfe/participants/yaml_filestorage'
 require 'openwfe/participants/participant'
 
 
@@ -63,6 +49,7 @@ module OpenWFE
   #
   #
   module StoreParticipantMixin
+
     include LocalParticipant
     include FeiMixin
 
@@ -81,6 +68,8 @@ module OpenWFE
     def consume (workitem)
 
       self[workitem.flow_expression_id] = workitem
+
+      notify_waiting_threads
     end
     alias :push :consume
 
@@ -90,11 +79,9 @@ module OpenWFE
     #
     def cancel (cancelitem)
 
-      ldebug do
-        "cancel() removing workitem  #{cancelitem.flow_expression_id}"
-      end
+      ldebug { "cancel() removing workitem  #{cancelitem.flow_expression_id}" }
 
-      self.delete(cancelitem.flow_expression_id)
+      delete(cancelitem.flow_expression_id)
     end
 
     #
@@ -116,10 +103,9 @@ module OpenWFE
     def forward (workitem)
 
       raise "Workitem not found in #{self.class}, cannot forward." \
-        unless self.has_key? workitem.flow_expression_id
+        unless self.has_key?(workitem.flow_expression_id)
 
-      #self.delete(workitem.flow_expression_id)
-      self.delete(workitem)
+      delete(workitem)
 
       reply_to_engine(workitem)
     end
@@ -134,10 +120,8 @@ module OpenWFE
     # identifier.
     #
     def delete (wi_or_fei)
-      #fei = wi_or_fei
-      #fei = fei.fei if fei.is_a? InFlowWorkItem
-      #super fei
-      super extract_fei(wi_or_fei)
+
+      super(extract_fei(wi_or_fei))
     end
 
     #
@@ -145,6 +129,7 @@ module OpenWFE
     # store participant.
     #
     def delegate (wi_or_fei, other_store_participant)
+
       wi = delete(wi_or_fei)
       other_store_participant.push(wi)
     end
@@ -156,13 +141,9 @@ module OpenWFE
     #
     def list_workitems (workflow_instance_id=nil)
 
-      result = []
-      self.each_value do |workitem|
-        result << workitem \
-          if (not workflow_instance_id) or workitem.fei.parent_wfid == workflow_instance_id
-      end
-
-      result
+      workflow_instance_id ?
+        self.values.select { |wi| wi.fei.parent_wfid == workflow_instance_id } :
+        self.values
     end
 
     #
@@ -173,14 +154,28 @@ module OpenWFE
     #
     def first_workitem
 
-      result = nil
+      self.values.first
+    end
 
-      self.each_value do |workitem|
-        result = workitem
-        break
-      end
+    #
+    # Joins this participant, ie wait until a workitem arrives in it
+    #
+    def join (force_wait=false)
+      return if self.size > 0 && (not force_wait)
+      (@waiting_threads ||= []) << Thread.current
+      Thread.stop
+    end
+
+    protected
 
-      return result
+    #
+    # This method is called each time a workitem comes in. Waiting threads
+    # get woken up.
+    #
+    def notify_waiting_threads
+      return unless @waiting_threads
+      @waiting_threads.each { |t| t.wakeup }
+      @waiting_threads.clear
     end
   end
 
@@ -233,9 +228,9 @@ module OpenWFE
 
       @dirname = OpenWFE::ensure_for_filename(dirname.to_s)
 
-      service_name = self.class.name + "__" + @dirname
+      service_name = self.class.name + '__' + @dirname
 
-      path = "/participants/" + @dirname
+      path = '/participants/' + @dirname
 
       super(service_name, application_context, path)
     end
@@ -245,10 +240,10 @@ module OpenWFE
       def compute_file_path (fei)
 
         @basepath +
-        fei.workflow_instance_id + "__" +
-        fei.workflow_definition_name + "_" +
-        fei.workflow_definition_revision + "__" +
-        fei.expression_id + ".yaml"
+        fei.workflow_instance_id + '__' +
+        fei.workflow_definition_name + '_' +
+        fei.workflow_definition_revision + '__' +
+        fei.expression_id + '.yaml'
       end
   end
 end