ruote 0.9.19 → 0.9.20

data/lib/openwfe/flowexpressionid.rb

@@ -1,42 +1,29 @@
-#
 #--
-# Copyright (c) 2005-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) 2005-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 and Costa Rica.
 #++
-#
 
-#
-# "hecho en Costa Rica"
-# enhanced in Japan
-#
-# john.mettraux@openwfe.org
-#
+
+require 'yaml'
 
 
 module OpenWFE
@@ -75,13 +62,20 @@ module OpenWFE
     alias :wfname :workflow_definition_name
     alias :wfrevision :workflow_definition_revision
 
-    #--
+    #
     # a trick : returns self...
     #
-    #def fei
-    #  self
-    #end
-    #++
+    def fei
+      self
+    end
+
+    #
+    # Returns a String that can be used to identify the FlowExpression[Id]
+    # in a storage.
+    #
+    def as_string_key
+      "#{@workflow_instance_id} #{@expression_name} #{@expression_id}"
+    end
 
     #
     # This method return @workflow_instance_id. If parent is set to
@@ -130,22 +124,49 @@ module OpenWFE
     #
     # Rebuilds a FlowExpressionId from its Hash representation.
     #
-    def FlowExpressionId.from_h (h)
+    def self.from_h (h)
 
-      FIELDS.inject FlowExpressionId.new do |fei, f|
-        fei.instance_variable_set("@#{f}", h[f] || h[f.to_s])
-        fei
+      FIELDS.inject(FlowExpressionId.new) do |fei, f|
+        fei.instance_variable_set("@#{f}", h[f] || h[f.to_s]); fei
       end
     end
 
+    #
+    # Builds a new FlowExpressionId out of a hash (overriding some defaults)
+    #
+    def self.new_fei (h={})
+
+      from_h({
+        :owfe_version => OPENWFERU_VERSION,
+        :engine_id => 'engine',
+        :workflow_definition_url => 'no-url',
+        :workflow_definition_name => 'no-name',
+        :workflow_definition_revision => '0',
+        :workflow_instance_id => '-1',
+        :expression_name => 'no-exp',
+        :expression_id => '0'
+      }.merge(h))
+    end
+
+    #
+    # full blown hash
+    #
     def hash
 
       to_s.hash
     end
 
+    #
+    # short hash (used by the cached expression storage among others)
+    #
+    def short_hash
+
+      "#{wfid} #{expid} #{expname}".hash
+    end
+
     def == (other)
 
-      return false if not other.kind_of?(FlowExpressionId)
+      return false unless other.is_a?(FlowExpressionId)
 
       #return self.to_s == other.to_s
         # no perf gain
@@ -179,10 +200,9 @@ module OpenWFE
       o = other_fei.dup
       o.expression_name = @expression_name
       o.expression_id = @expression_id
-
       return false unless self == o
 
-      OpenWFE::starts_with other_fei.expression_id, @expression_id
+      other_fei.expid[0, @expression_id.length] == @expression_id
     end
 
     #
@@ -214,8 +234,8 @@ module OpenWFE
     #
     def to_web_s
 
-      wid = wfid.gsub("\.", "_")
-      eid = expid.gsub("\.", "_")
+      wid = wfid.gsub("\.", '_')
+      eid = expid.gsub("\.", '_')
 
       URI.escape("#{wid}__#{eid}")
     end
@@ -226,9 +246,9 @@ module OpenWFE
     #
     def self.split_web_s (s)
 
-      i = s.rindex("__")
+      i = s.rindex('__')
 
-      [ s[0..i-1].gsub("\_", "."), s[i+2..-1].gsub("\_", ".") ]
+      [ s[0..i-1].gsub("\_", '.'), s[i+2..-1].gsub("\_", '.') ]
     end
 
     #
@@ -247,21 +267,21 @@ module OpenWFE
     #
     def parent_workflow_instance_id
 
-      FlowExpressionId.to_parent_wfid workflow_instance_id
+      FlowExpressionId.to_parent_wfid(workflow_instance_id)
     end
 
     alias :parent_wfid :parent_workflow_instance_id
 
     #
-    # Returns "" if this expression id belongs to a top process,
+    # Returns '' if this expression id belongs to a top process,
     # returns something like ".0" or ".1.3" if this exp id belongs to
     # an expression in a subprocess.
     # (Only used in some unit tests for now)
     #
     def sub_instance_id
 
-      i = workflow_instance_id.index(".")
-      return "" unless i
+      i = workflow_instance_id.index('.')
+      return '' unless i
       workflow_instance_id[i..-1]
     end
 
@@ -277,7 +297,7 @@ module OpenWFE
     #
     def last_sub_instance_id
 
-      i = workflow_instance_id.rindex(".")
+      i = workflow_instance_id.rindex('.')
       return nil unless i
       workflow_instance_id[i+1..-1]
     end
@@ -288,7 +308,7 @@ module OpenWFE
     #
     def is_in_parent_process?
 
-      (sub_instance_id == "")
+      (sub_instance_id == '')
     end
 
     #
@@ -312,15 +332,13 @@ module OpenWFE
 
       fei = FlowExpressionId.new
 
-      ss = string.split(" ")
-
-      #require 'pp'; puts; pp ss
+      ss = string.split
 
-      ss = ss[1..-1] if ss[0] == "("
+      ss = ss[1..-1] if ss[0] == '('
 
       fei.owfe_version = ss[1]
 
-      ssRawEngineId = ss[2].split("/")
+      ssRawEngineId = ss[2].split('/')
       fei.engine_id = ssRawEngineId[0]
       #fei.initial_engine_id = ssRawEngineId[1]
 
@@ -332,7 +350,7 @@ module OpenWFE
       fei.expression_id = ss[8][0..-2]
 
       fei.expression_id = fei.expression_id[0..-2] \
-        if fei.expression_id[-1, 1] == ")"
+        if fei.expression_id[-1, 1] == ')'
 
       fei
     end
@@ -342,7 +360,7 @@ module OpenWFE
     #
     def self.from_s (string)
 
-      to_fei string
+      to_fei(string)
     end
 
     #
@@ -351,7 +369,26 @@ module OpenWFE
     #
     def self.to_parent_wfid (wfid)
 
-      wfid.split(".").first
+      wfid.split('.').first
+    end
+
+    #
+    # custom yaml serialization
+
+    yaml_as("tag:ruby.yaml.org,2002:#{self}")
+
+    def to_yaml (opts={}) #:nodoc#
+      YAML::quick_emit(self.object_id, opts) do |out|
+        out.map(taguri) { |map| map.add('s', to_s) }
+      end
+    end
+
+    def self.yaml_new (klass, tag, val) #:nodoc#
+      begin
+        FlowExpressionId.to_fei(val['s'])
+      rescue Exception => e
+        raise "failed to decode FlowExpressionId out of '#{s}', #{e}"
+      end
     end
   end
 

data/lib/openwfe/listeners/listener.rb

@@ -1,41 +1,27 @@
-#
 #--
-# 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:
+# 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/logging'
 require 'openwfe/workitem'
@@ -50,47 +36,50 @@ module OpenWFE
   # behaviours.
   #
   module WorkItemListener
-    include Contextual, Logging, OwfeServiceLocator
+
+    include Contextual
+    include Logging
+    include OwfeServiceLocator
 
     protected
 
-      #
-      # Simply considers the object as a workitem and feeds it to the
-      # engine.
-      #
-      def handle_item (item)
+    #
+    # Simply considers the object as a workitem and feeds it to the
+    # engine.
+    #
+    def handle_item (item)
 
-        filter_items item
+      filter_items(item)
 
-        get_engine.reply item
-      end
+      get_engine.reply(item)
+    end
 
-      #
-      # The base implementation is just empty, feel free to override it
-      # if you need to filter workitems.
-      #
-      # One example :
-      #
-      #   class MyListener
-      #     include WorkItemListener
-      #
-      #     protected
-      #
-      #       #
-      #       # MyListener doesn't accept launchitems
-      #       #
-      #       def filter_items (item)
-      #         raise "launchitems not allowed" \
-      #           if item.is_a?(OpenWFE::LaunchItem)
-      #       end
-      #   end
-      #
-      def filter_items (item)
+    #
+    # The base implementation is just empty, feel free to override it
+    # if you need to filter workitems.
+    #
+    # One example :
+    #
+    #   class MyListener
+    #     include WorkItemListener
+    #
+    #     protected
+    #
+    #       #
+    #       # MyListener doesn't accept launchitems
+    #       #
+    #       def filter_items (item)
+    #         raise "launchitems not allowed" \
+    #           if item.is_a?(OpenWFE::LaunchItem)
+    #       end
+    #   end
+    #
+    def filter_items (item)
 
-        #raise(
-        #  "listener of class '#{self.class.name}' "+
-        #  "doesn't accept launchitems")
-      end
+      #raise(
+      #  "listener of class '#{self.class.name}' "+
+      #  "doesn't accept launchitems")
+    end
   end
 
 end

data/lib/openwfe/listeners/listeners.rb

@@ -1,43 +1,28 @@
-#
 #--
-# 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 'find'
 require 'yaml'
 require 'fileutils'
 
@@ -60,25 +45,41 @@ module OpenWFE
   #
   #   require 'openwfe/listeners/listeners'
   #
-  #   engine.add_workitem_listener(OpenWFE::FileListener, "500")
+  #   engine.add_workitem_listener(
+  #     OpenWFE::FileListener,
+  #     :frequency => '500',
+  #     :folder => '/var/in')
   #
-  # In this example, the directory ./work/in/ will be polled every 500
+  # In this example, the directory /var/in/ will be polled every 500
   # milliseconds for incoming workitems (or launchitems).
   #
+  # The default folder is ./work/in/
+  # The listener will make sure to create the folder if not present.
+  #
   # You can override the load_object(path) method to manage other formats
   # then YAML.
   #
   class FileListener < Service
+
     include WorkItemListener
     include Rufus::Schedulable
 
     attr_reader :workdir
 
-    def initialize (service_name, application_context)
+    def initialize (service_name, options)
 
       super
 
-      @workdir = get_work_directory + "/in/"
+      @workdir = options[:folder] || 'in/'
+
+      @workdir = "#{get_work_directory}/#{@workdir}" \
+        unless @workdir.match(/^\//)
+
+      FileUtils.mkdir_p(@workdir) \
+        unless File.exist?(@workdir)
+
+      raise("workdir #{@workdir} is not a directory, cannot setup listener") \
+        unless File.directory?(@workdir)
 
       linfo { "new() workdir is '#{@workdir}'" }
     end
@@ -88,17 +89,14 @@ module OpenWFE
     # extract the workitem in them and feed it back to the engine.
     #
     def trigger (params)
-      # no synchronization for now
-
-      ldebug { "trigger()" }
 
-      FileUtils.makedirs(@workdir) unless File.exist?(@workdir)
+      #ldebug { "trigger()" }
 
-      Find.find(@workdir) do |path|
+      FileUtils.mkdir_p(@workdir) unless File.exist?(@workdir)
 
-        next if File.stat(path).directory?
+      Dir["#{@workdir}/*.yaml"].each do |path|
 
-        ldebug { "trigger() considering file '#{path}'" }
+        #ldebug { "trigger() considering file '#{path}'" }
 
         begin
 
@@ -119,20 +117,18 @@ module OpenWFE
 
     protected
 
-      #
-      # Turns a file into a Ruby instance.
-      # This base implementation does it via YAML.
-      #
-      def load_object (path)
-
-        return nil unless path.match ".*\.yaml$"
-
-        object = YAML.load_file path
-
-        File.delete path
+    #
+    # Turns a file into a Ruby instance.
+    # This base implementation does it via YAML.
+    #
+    # (override at will)
+    #
+    def load_object (path)
 
-        object
-      end
+      o = YAML.load_file(path)
+      File.delete(path)
+      o
+    end
   end
 
 end