ruote 0.9.19 → 0.9.20

data/lib/openwfe/expressions/{expressionmap.rb → expression_map.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 'openwfe/expressions/raw'
 require 'openwfe/expressions/environment'
@@ -48,7 +34,7 @@ require 'openwfe/expressions/fe_sequence'
 require 'openwfe/expressions/fe_subprocess'
 require 'openwfe/expressions/fe_concurrence'
 require 'openwfe/expressions/fe_participant'
-require 'openwfe/expressions/fe_sleep'
+#require 'openwfe/expressions/fe_sleep'
 require 'openwfe/expressions/fe_cron'
 require 'openwfe/expressions/fe_when'
 require 'openwfe/expressions/fe_wait'
@@ -60,6 +46,7 @@ require 'openwfe/expressions/fe_iterator'
 require 'openwfe/expressions/fe_fqv'
 require 'openwfe/expressions/fe_cancel'
 require 'openwfe/expressions/fe_do'
+require 'openwfe/expressions/fe_error'
 require 'openwfe/expressions/fe_save'
 require 'openwfe/expressions/fe_filter_definition'
 require 'openwfe/expressions/fe_filter'
@@ -79,7 +66,7 @@ module OpenWFE
 
     def initialize
 
-      super
+      #super
 
       @expressions = {}
       @ancestors = {}
@@ -108,7 +95,7 @@ module OpenWFE
 
       register EqualsExpression
 
-      register SleepExpression
+      #register SleepExpression
       register CronExpression
       register WhenExpression
       register WaitExpression
@@ -137,6 +124,8 @@ module OpenWFE
       register UndoExpression
       register RedoExpression
 
+      register ErrorExpression
+
       register SaveWorkItemExpression
       register RestoreWorkItemExpression
 
@@ -160,10 +149,6 @@ module OpenWFE
         # only used by get_expression_names()
 
       register_ancestors RawExpression
-      #register_ancestors XmlRawExpression
-      #register_ancestors ProgRawExpression
-        #
-        # just register the ancestors for those two
     end
 
     #
@@ -206,11 +191,10 @@ module OpenWFE
       return expression_class.expression_names \
         if expression_class.method_defined?(:expression_names)
 
-      names = []
-      @expressions.each do |k, v|
-        names << k if v.ancestors.include? expression_class
+      @expressions.inject([]) do |names, (k, v)|
+        names << k if v.ancestors.include?(expression_class)
+        names
       end
-      names
     end
 
     #
@@ -222,12 +206,14 @@ module OpenWFE
       @ancestors[ancestor]
     end
 
+    #
+    # Returns a string representation for this expression map.
+    #
     def to_s
-      s = ""
-      @expressions.keys.sort.each do |name|
-        s << "- '#{name}' -> '#{@expressions[name].to_s}'\n"
+
+      @expressions.keys.sort.inject('') do |s, name|
+        s << "- '#{name}' -> '#{@expressions[name].to_s}'\n"; s
       end
-      s
     end
 
     #
@@ -242,20 +228,20 @@ module OpenWFE
         name = OpenWFE::to_dash(name)
         @expressions[name] = expression_class
       end
-      register_ancestors expression_class
+      register_ancestors(expression_class)
     end
 
     protected
 
-      #
-      # registers all the ancestors of an expression class
-      #
-      def register_ancestors (expression_class)
+    #
+    # registers all the ancestors of an expression class
+    #
+    def register_ancestors (expression_class)
 
-        expression_class.ancestors.each do |ancestor|
-          (@ancestors[ancestor] ||= []) << expression_class
-        end
+      expression_class.ancestors.each do |ancestor|
+        (@ancestors[ancestor] ||= []) << expression_class
       end
+    end
   end
 
 end

data/lib/openwfe/expressions/expression_tree.rb

@@ -0,0 +1,265 @@
+#--
+# Copyright (c) 2008-2009, John Mettraux, jmettraux@gmail.com
+#
+# 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:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# 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.
+#
+# Made in Japan.
+#++
+
+
+module OpenWFE
+
+  #
+  # A set of methods for manipulating / querying a process expression tree
+  #
+  module ExpressionTree
+
+    #
+    # Returns true if the argument is a leaf.
+    #
+    def self.is_not_a_node? (o)
+
+      (( ! o.is_a?(Array)) || o.size != 3 || ( ! o.first.is_a?(String)))
+    end
+
+    #
+    # Extracts the description out of a process definition tree.
+    #
+    # TODO #14964 : add language support here
+    #
+    def self.get_description (tree)
+
+      tree.last.each do |child|
+        next unless child.is_a?(Array)
+        return child.last.first if child.first == 'description'
+      end
+
+      nil
+    end
+
+    #
+    # Returns a string containing the ruby code that generated this
+    # raw representation tree.
+    #
+    def self.to_code_s (tree, indentation = 0)
+
+      s = ''
+      tab = '  '
+      ind = tab * indentation
+
+      s << ind
+      s << OpenWFE::make_safe(tree.first)
+
+      if single_string_child = (
+        tree.last.size == 1 and tree.last.first.class == String
+      )
+        s << " '#{tree.last.first}'"
+      end
+
+      sa = tree[1].inject('') do |r, (k, v)|
+        r << ", :#{OpenWFE::to_underscore(k)} => #{v.inspect}"
+      end
+      sa = sa[1..-1] unless single_string_child
+      s << sa if sa
+
+      if tree.last.length > 0
+        if tree.last.size == 1 and tree.last.first.class == String
+          # do nothing (already done)
+        else
+          s << " do\n"
+          tree.last.each do |child|
+            #if child.respond_to?(:to_code_s)
+            if child.is_a?(Array) and child.size == 3 # and ...
+              s << to_code_s(child, indentation + 1)
+            else
+              s << ind
+              s << tab
+              s << "'#{child.to_s}'" # inspect instead of to_s ?
+            end
+            s << "\n"
+          end
+          s << ind
+          s << "end"
+        end
+      end
+
+      s
+    end
+
+    #
+    # Turns the expression tree into an XML process definition
+    #
+    def self.to_xml (tree)
+
+      elt = REXML::Element.new tree.first.to_s
+
+      tree[1].each do |k, v|
+
+        if k == 'value' and (not v.is_a?(String))
+          elt << OpenWFE::Xml::to_rexml(v)
+        else
+          elt.attributes[k] = v
+        end
+      end
+
+      tree.last.each do |child|
+
+        #if child.kind_of?(SimpleExpRepresentation)
+        if child.is_a?(Array) and child.size == 3
+
+          elt << to_xml(child)
+        else
+
+          elt << REXML::Text.new(child.to_s)
+        end
+      end
+
+      elt
+    end
+
+    #
+    # Returns an XML string
+    #
+    def self.to_s (tree, indent=-1)
+
+      d = REXML::Document.new
+      d << to_xml(tree)
+      s = ''
+      d.write(s, indent)
+      s
+    end
+
+    #
+    # This method is called by the expression pool when it is about
+    # to launch a process, it will interpret the 'parameter' statements
+    # in the process definition and raise an exception if the requirements
+    # are not met.
+    #
+    def self.check_parameters (tree, workitem)
+
+      extract_parameters(tree).each { |param| param.check(workitem) }
+    end
+
+    protected
+
+    #
+    # Extracts the [pseudo-]expression parameters at the top of the given
+    # tree.
+    #
+    def self.extract_parameters (tree)
+
+      r = []
+      tree.last.each do |child|
+
+        next if OpenWFE::ExpressionTree.is_not_a_node?(child)
+
+        name = child.first.to_sym
+        next unless (name == :parameter or name == :param)
+
+        attributes = child[1]
+
+        r << ProcessParameter.new(attributes)
+      end
+      r
+    end
+  end
+
+  protected
+
+  #
+  # Encapsulating
+  #   <parameter field="x" default="y" type="z" match="m" />
+  #
+  # Somehow I hate that param thing, Ruote is not a strongly typed language
+  # ... Anyway Pat seems to use it.
+  #
+  class ProcessParameter
+
+    def initialize (attributes)
+
+      @field = to_s(attributes['field'])
+      @match = to_s(attributes['match'])
+      @default = to_s(attributes['default'])
+      @type = to_s(attributes['type'])
+    end
+
+    #
+    # Will raise an exception if this param requirement is not
+    # met by the workitem.
+    #
+    def check (workitem)
+
+      raise(
+        ArgumentError.new("'parameter'/'param' without a 'field' attribute")
+      ) unless @field
+
+      field_value = workitem.attributes[@field]
+      field_value ||= @default
+
+      raise(
+        ArgumentError.new("field '#{@field}' is missing")
+      ) unless field_value
+
+      check_match(field_value)
+
+      enforce_type(workitem, field_value)
+    end
+
+    protected
+
+    #
+    # Used in the constructor to flatten everything to strings.
+    #
+    def to_s (o)
+      o ? o.to_s : nil
+    end
+
+    #
+    # Will raise an exception if it cannot coerce the type
+    # of the value to the one desired.
+    #
+    def enforce_type (workitem, value)
+
+      value = if not @type
+        value
+      elsif @type == 'string'
+        value.to_s
+      elsif @type == 'int' or @type == 'integer'
+        Integer(value)
+      elsif @type == 'float'
+        Float(value)
+      else
+        raise
+          "unknown type '#{@type}' for field '#{@field}'"
+      end
+
+      workitem.attributes[@field] = value
+    end
+
+    def check_match (value)
+
+      return unless @match
+
+      raise(
+        ArgumentError.new("value of field '#{@field}' doesn't match")
+      ) unless value.to_s.match(@match)
+    end
+  end
+end
+

data/lib/openwfe/expressions/fe_cancel.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/expressions/condition'
 require 'openwfe/expressions/flowexpression'
@@ -80,22 +64,18 @@ module OpenWFE
 
     names :cancel_process, :cancel_flow
 
-    #
-    # apply / reply
-
     def apply (workitem)
 
       conditional = eval_condition(:if, workitem, :unless)
         #
         # for example : <cancel-process if="${approved} == false"/>
 
-      return reply_to_parent(workitem) \
-        if conditional == false
+      return reply_to_parent(workitem) if conditional == false
 
       #
       # else, do cancel the process
 
-      get_expression_pool.cancel_process self
+      get_expression_pool.cancel_process(self)
 
       # no need to reply to parent
     end