ruote 0.9.19 → 0.9.20

data/lib/openwfe/expool/history.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 'openwfe/service'
 require 'openwfe/omixins'
@@ -74,14 +60,24 @@ module OpenWFE
 
       super
 
-      get_expression_pool.add_observer(:all) do |event, *args|
-        handle :expool, event, *args
+      @expool_observer = get_expression_pool.add_observer(:all) do |evt, *args|
+        handle(:expool, evt, *args)
       end
-      get_participant_map.add_observer(:all) do |event, *args|
-        handle :pmap, event, *args
+      @pmap_observer = get_participant_map.add_observer(:all) do |evt, *args|
+        handle(:pmap, evt, *args)
       end
     end
 
+    #
+    # Mainly, stops observing the expool and the participant map
+    #
+    def stop
+
+      super
+
+      stop_observing
+    end
+
     #
     # filter events, eventually logs them
     #
@@ -106,7 +102,7 @@ module OpenWFE
 
       # ok, do log now
 
-      log source, event, *args
+      log(source, event, *args)
     end
 
     #
@@ -140,7 +136,7 @@ module OpenWFE
       args.inject([]) { |r, a|
         r << a if a.is_a?(Symbol) or a.is_a?(String)
         r
-      }.join(" ")
+      }.join(' ')
     end
 
     #
@@ -150,12 +146,26 @@ module OpenWFE
 
       args.find { |a| a.is_a?(WorkItem) }
     end
+
+    protected
+
+      #
+      # Removes the observers on the expool and the participant map
+      #
+      # (called by stop())
+      #
+      def stop_observing
+
+        get_expression_pool.remove_observer(@expool_observer)
+        get_participant_map.remove_observer(@pmap_observer)
+      end
   end
 
   #
   # A base implementation for InMemoryHistory and FileHistory.
   #
   class History
+
     include HistoryMixin
 
     def initialize (service_name, application_context)
@@ -219,7 +229,7 @@ module OpenWFE
     # Returns all the entries as a String.
     #
     def to_s
-      @output.inject("") { |r, entry| r << entry.to_s }
+      @output.inject('') { |r, entry| r << entry.to_s }
     end
   end
 
@@ -253,7 +263,13 @@ module OpenWFE
       @output
     end
 
+    #
+    # Stops observing the expool and close the output file
+    #
     def stop
+
+      stop_observing
+
       @output.close
     end
   end

data/lib/openwfe/expool/journal.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 'monitor'
 require 'fileutils'
@@ -44,7 +30,6 @@ require 'openwfe/service'
 require 'openwfe/omixins'
 require 'openwfe/rudefinitions'
 require 'openwfe/flowexpressionid'
-require 'openwfe/storage/yamlcustom'
 require 'openwfe/expool/journal_replay'
 
 
@@ -54,6 +39,7 @@ module OpenWFE
   # Keeping a replayable track of the events in an OpenWFEru engine
   #
   class Journal < Service
+
     include MonitorMixin
     include OwfeServiceLocator
     include JournalReplay
@@ -61,18 +47,18 @@ module OpenWFE
 
     attr_reader :workdir, :donedir
 
-    FREQ = "1m"
+    FREQ = '1m'
       #
       # once per minute, makes sure the buckets are flushed
 
     def initialize (service_name, application_context)
 
-      super
+      super # necessary since we're extending MonitorMixin
 
       @buckets = {}
 
-      @workdir = get_work_directory + "/journal"
-      @donedir = @workdir + "/done"
+      @workdir = get_work_directory + '/journal'
+      @donedir = @workdir + '/done'
 
       FileUtils.makedirs(@donedir) unless File.exist?(@donedir)
 
@@ -183,7 +169,7 @@ module OpenWFE
       end
 
       def get_path (wfid)
-        @workdir + "/" + wfid.to_s + ".journal"
+        "#{@workdir}/#{wfid.to_s}.journal"
       end
 
       #
@@ -210,7 +196,7 @@ module OpenWFE
         alias :length :size
 
         def flush
-          File.open(@path, "a+") do |f|
+          File.open(@path, 'a+') do |f|
             @events.each do |e|
               f.puts e
             end

data/lib/openwfe/expool/journal_replay.rb

@@ -1,43 +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.
 #++
-#
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
-#
-# "made in Japan"
-#
-# John Mettraux at openwfe.org
-#
 
 require 'openwfe/flowexpressionid'
 
@@ -294,9 +278,8 @@ module OpenWFE
 
         def to_s
 
-          s = " ===== offset : #{@offset}  #{@date} =====\n"
+          s = "=== offset : #{@offset}  #{@date} ===\n"
 
-          s << "\n"
           s << "static :\n"
           @static.each do |e|
             s << " - #{e[0]}   #{extract_fei(e[2]).to_short_s}\n"
@@ -308,7 +291,8 @@ module OpenWFE
             s << " - #{e[0]}   #{extract_fei(e[2]).to_short_s}\n"
           end
 
-          #s << "\n"
+          s << "=== . ===\n\n"
+
           #s <<  "participants :\n"
           #@participants.each do |fei, v|
           #  s << " - #{fei.to_short_s}\n"

data/lib/openwfe/expool/representation.rb

@@ -1,41 +1,27 @@
-#
 #--
-# Copyright (c) 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) 2008-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
-#
 
 module OpenWFE
 
@@ -54,68 +40,66 @@ module OpenWFE
     # Computes and returns the up-to-date representation of
     # the process definition (on the fly changes included)
     #
-    def representation
+    # A 'representation' is an array
+    # [ expression_name, attributes, children_expression ] where
+    # expression_name is a String, attributes a Hash and children_expression
+    # an Array of representations.
+    #
+    def tree
+
+      get_updated_rep(find_root_expression)
+    end
+
+    #
+    # Returns the tree as it was when the process instance was launched.
+    #
+    # (Where as tree() includes 'in-flight' manipulations)
+    #
+    def initial_tree
+
+      find_root_expression.raw_representation
+    end
+
+    #
+    # Returns the root expression (the one with no parent expression)
+    # among the expressions in self (Array of FlowExpression instances).
+    #
+    def find_root_expression
+
+      self.find do |fexp|
+        fexp.fei.expid == '0' &&
+        ( ! fexp.is_a?(OpenWFE::Environment)) &&
+        fexp.fei.is_in_parent_process?
+      end
+    end
 
-      root_exp = find_root_expression
+    #
+    # Returns an expression given its FlowExpressionId.
+    #
+    def find_expression (fei)
 
-      update_rep root_exp
+      self.find { |fexp| fexp.fei == fei }
     end
 
     protected
 
       #
-      # if a child expression is present (in the process stack)
+      # If a child expression is present (in the process stack)
       # makes sure to take its current representation and include
       # it in the parent representation.
       #
-      def update_rep (flow_expression)
+      def get_updated_rep (flow_expression)
 
         rep = flow_expression.raw_representation.dup
-        children = flow_expression.children
-
-        index = -1
-
-        rep[2] = rep.last.inject([]) { |r, c|
-
-          index += 1
-
-          r << if c.is_a?(Array)
-
-            child_fei = flow_expression.children[index]
-            child_exp = find_expression child_fei
-
-            if child_exp
-              update_rep(child_exp)
-            else
-              #c[1]['__gone__'] = true
-                #
-                # not a good idea
-                # have to differentiate between 'replied'
-                # expressions and removed expressions
-              c
-            end
-          else
+        rep[2] = rep[2].dup
 
-            c
-          end
-
-        } if children and children.size > 0
-
-        rep
-      end
-
-      def find_root_expression
-
-        self.find do |fexp|
-          fexp.fei.expid == '0' &&
-          ( ! fexp.is_a?(OpenWFE::Environment)) &&
-          fexp.fei.is_in_parent_process?
+        (flow_expression.children || []).each do |fei|
+          fexp = find_expression(fei)
+          next unless fexp
+          rep[2][fei.child_id.to_i] = get_updated_rep(fexp)
         end
-      end
 
-      def find_expression (fei)
-
-        self.find { |fexp| fexp.fei == fei }
+        rep
       end
   end
 end