ruote 2.1.11 → 2.2.0

data/lib/ruote/exp/iterator.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2010, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2011, 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
@@ -56,7 +56,7 @@ module Ruote::Exp
       split_list(lookup_val_prefix('on'))
     end
 
-    def split_list (list)
+    def split_list(list)
 
       if list.is_a?(String)
 

data/lib/ruote/exp/merge.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2010, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2011, 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
@@ -41,7 +41,7 @@ module Ruote::Exp
     # in the target workitem. The name of this field is the child_id of the
     # source workitem (a string from '0' to '99999' and beyond)
     #
-    def merge_workitems (index, target, source, type)
+    def merge_workitems(index, target, source, type)
 
       return source if type == 'override'
 

data/lib/ruote/exp/ro_attributes.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2010, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2011, 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
@@ -26,7 +26,7 @@
 module Ruote::Exp
 
   #
-  # Those methods are mixed in FlowExpression. They were put here to offload
+  # Those methods are added in FlowExpression. They were put here to offload
   # FlowExpression and especially, to gather them around their attribute topic.
   #
   class FlowExpression
@@ -34,7 +34,7 @@ module Ruote::Exp
     # Given a list of attribute names, returns the first attribute name for
     # which there is a value.
     #
-    def has_attribute (*args)
+    def has_attribute(*args)
 
       args.each { |a| a = a.to_s; return a if attributes[a] != nil }
 
@@ -45,7 +45,7 @@ module Ruote::Exp
 
     # Looks up the value for attribute n.
     #
-    def attribute (n, workitem=h.applied_workitem, options={})
+    def attribute(n, workitem=h.applied_workitem, options={})
 
       n = n.to_s
 
@@ -72,7 +72,7 @@ module Ruote::Exp
     # in the array list 'values'. If not, the default value is returned.
     # By default, the default value is the first element of 'values'.
     #
-    def att (key, values, opts={})
+    def att(key, values, opts={})
 
       default = opts[:default] || values.first
 
@@ -92,7 +92,7 @@ module Ruote::Exp
     # prefix = 'on' => will lookup on, on_val, on_value, on_v, on_var,
     # on_variable, on_f, on_fld, on_field...
     #
-    def lookup_val_prefix (prefix, att_options={})
+    def lookup_val_prefix(prefix, att_options={})
 
       lval(
         [ prefix ] + [ 'val', 'value' ].map { |s| "#{prefix}_#{s}" },
@@ -101,7 +101,7 @@ module Ruote::Exp
         att_options)
     end
 
-    def lookup_val (att_options={})
+    def lookup_val(att_options={})
 
       lval(
         VV,
@@ -113,7 +113,7 @@ module Ruote::Exp
     # Returns a Hash containing all attributes set for an expression with
     # their values resolved.
     #
-    def compile_atts (opts={})
+    def compile_atts(opts={})
 
       attributes.keys.inject({}) { |r, k|
         r[k] = attribute(k, h.applied_workitem, opts)
@@ -127,7 +127,7 @@ module Ruote::Exp
     #
     #   set "f:${v:field_name}" => "${v:that_variable}"
     #
-    def expand_atts (opts={})
+    def expand_atts(opts={})
 
       attributes.keys.inject({}) { |r, k|
         kk = @context.dollar_sub.s(k, self, h.applied_workitem)
@@ -148,7 +148,9 @@ module Ruote::Exp
     #
     # will yield 'alpha'.
     #
-    def attribute_text (workitem=h.applied_workitem)
+    # Note : an empty text returns '', not the nil value.
+    #
+    def attribute_text(workitem=h.applied_workitem)
 
       text = attributes.keys.find { |k| attributes[k] == nil }
 
@@ -167,12 +169,12 @@ module Ruote::Exp
     #
     VV = %w[ val value ]
 
-    def s_cartesian (a0, a1)
+    def s_cartesian(a0, a1)
 
       a0.inject([]) { |a, e0| a + a1.collect { |e1| "#{e0}_#{e1}" } }
     end
 
-    def lval (vals, vars, flds, att_options)
+    def lval(vals, vars, flds, att_options)
 
       if k = has_att(*vals)
 

data/lib/ruote/exp/ro_filters.rb

@@ -0,0 +1,136 @@
+#--
+# Copyright (c) 2005-2011, 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 Ruote::Exp
+
+  #
+  # The methods about the :filter attribute are placed in FlowExpression
+  # from here.
+  #
+  class FlowExpression
+
+    protected
+
+    # The :filter attribute work is done here, at apply (in) and at reply (out).
+    #
+    def filter(workitem=nil)
+
+      filter = lookup_filter(workitem)
+
+      return unless filter
+
+      unless filter.is_a?(Array)
+        #
+        # filter is a participant
+
+        def filter.receive(wi); end
+          # making sure the participant never replies to the engine
+
+        hwi = workitem || h.applied_workitem
+
+        if filter.respond_to?(:filter)
+          hwi['fields'] = filter.filter(hwi['fields'], workitem ? 'out' : 'in')
+        else
+          hwi['fields']['__filter_direction__'] = workitem ? 'out' : 'in'
+          filter.consume(Ruote::Workitem.new(hwi))
+        end
+
+        hwi['fields'].delete('__filter_direction__')
+
+        return
+      end
+
+      #
+      # filter is a not a participnat
+
+      unless workitem # in
+
+        h.fields_pre_filter =
+          Rufus::Json.dup(h.applied_workitem['fields'])
+        h.applied_workitem['fields'] =
+          Ruote.filter(filter, h.applied_workitem['fields'], {})
+
+      else # out
+
+        workitem['fields'] =
+          Ruote.filter(
+            filter, workitem['fields'], :double_tilde => h.fields_pre_filter)
+      end
+    end
+
+    # Used by #filter, deals with the various ways to pass filters
+    # (directly, via a variable, via a participant, in and out, ...)
+    #
+    # Returns nil, if there is no filter. Raises an ArgumentError if the
+    # filter is not usable. Returns the instantiated participant if the
+    # filter points to one.
+    #
+    def lookup_filter(workitem)
+
+      f = attribute(:filter)
+
+      return nil unless f
+
+      3.times { f = narrow_filter(f, workitem) }
+
+      raise ArgumentError.new(
+        "found no filter corresponding to '#{f}'"
+      ) unless f
+
+      f
+    end
+
+    # Called successively to dig for the filter (Array or Participant).
+    #
+    def narrow_filter(fi, workitem)
+
+      if fi.is_a?(Array) or fi.respond_to?(:consume) or fi.respond_to?(:filter)
+
+        fi
+
+      elsif fi.is_a?(Hash)
+
+        workitem ? fi['out'] || fi['reply'] : fi['in'] || fi['apply']
+
+      elsif fi.is_a?(String)
+
+        filter =
+          lookup_variable(fi) ||
+          @context.plist.lookup(fi, workitem || h.applied_workitem)
+
+        if filter.respond_to?(:consume) or filter.respond_to?(:filter)
+          (workitem || h.applied_workitem)['participant_name'] = fi
+        end
+
+        filter
+
+      else
+
+        nil
+      end
+    end
+  end
+end
+

data/lib/ruote/exp/ro_persist.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2010, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2011, 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
@@ -42,12 +42,11 @@ module Ruote::Exp
 
       r = @context.storage.put(@h, :update_rev => true)
 
-      raise(
-        "initial_persist failed for " +
-        "#{Ruote.to_storage_id(h.fei)} #{tree.first}"
-      ) if r != nil
+      #t = Thread.current.object_id.to_s[-3..-1]
+      #puts "+ per #{h.fei['expid']} #{tree[0]} r#{h._rev} t#{t} -> #{r.class}"
+      #Ruote.p_caller('+ per')
 
-      nil
+      raise_or_return('initial_persist failed', r)
     end
 
     def try_persist
@@ -55,8 +54,8 @@ module Ruote::Exp
       r = @context.storage.put(@h)
 
       #t = Thread.current.object_id.to_s[-3..-1]
-      #puts "+ per #{h.fei['expid']} #{tree.first} #{h._rev} #{t} -> #{r.class}"
-      #Ruote.p_caller('+ per') #if r != nil || h.fei['expid'] == '0_0'
+      #puts "+ per #{h.fei['expid']} #{tree[0]} r#{h._rev} t#{t} -> #{r.class}"
+      #Ruote.p_caller('+ per')
 
       r
     end
@@ -66,8 +65,8 @@ module Ruote::Exp
       r = @context.storage.delete(@h)
 
       #t = Thread.current.object_id.to_s[-3..-1]
-      #puts "- unp #{h.fei['expid']} #{tree.first} #{h._rev} #{t} -> #{r.class}"
-      #Ruote.p_caller('- unp') #if r != nil || h.fei['expid'] == '0_0'
+      #puts "- unp #{h.fei['expid']} #{tree[0]} r#{h._rev} t#{t} -> #{r.class}"
+      #Ruote.p_caller('- unp')
 
       return r if r
 
@@ -81,56 +80,73 @@ module Ruote::Exp
       nil
     end
 
-    #--
-    # duplication ahead
-    #++
-
     def persist_or_raise
 
-      r = try_persist
-
-      raise(
-        "persist failed for " +
-        "#{Ruote.to_storage_id(h.fei)} #{tree.first} #{r.class}"
-      ) if r
+      p_or_raise(true)
     end
 
     def unpersist_or_raise
 
-      r = try_unpersist
-
-      raise(
-        "unpersist failed for " +
-        "#{Ruote.to_storage_id(h.fei)} #{tree.first} #{r.class}"
-      ) if r
+      p_or_raise(false)
     end
 
-    alias :persist :persist_or_raise
-    alias :unpersist :unpersist_or_raise
+    alias persist persist_or_raise
+    alias unpersist unpersist_or_raise
 
     def do_persist
 
-      do_p(:persist)
+      do_p(true)
     end
 
     def do_unpersist
 
-      do_p(:unpersist)
+      do_p(false)
     end
 
     protected
 
-    def do_p (pers)
+    def raise_or_return(msg, r)
+
+      msg = msg.is_a?(String) ?
+        msg : (msg ? 'persist' : 'unpersist') + ' failed'
+
+      raise(
+        "#{msg} for " +
+        "#{Ruote.to_storage_id(h.fei)} #{tree[0]} #{tree[1].inspect} " +
+        'r(' + (r == true ? 'gone' : "rev : #{r['_rev']}") + ')'
+      ) if r
+
+      r
+    end
+
+    # Does persist or unpersist, returns nothing in particular.
+    #
+    # Will raise a runtime error if it fails (ie if it happens, there
+    # is something wrong with the storage implementation or the engine).
+    #
+    def p_or_raise(pers)
+
+      r = pers ? try_persist : try_unpersist
+
+      raise_or_return(pers, r)
+    end
+
+    # Does persist or unpersist, if successful then return true. If the
+    # expression is gone, return false.
+    # If there is a 'fresher' version of the expression, re-attempt and return
+    # false.
+    #
+    def do_p(pers)
 
-      case r = self.send("try_#{pers}")
+      case r = pers ? try_persist : try_unpersist
         when true
-          false # don't go on
+          false # do not go on
         when Hash
           self.h = r
           self.send("do_#{@msg['action']}", @msg)
-          false # don't go on
+          false # do not go on
         else
-          true # success, please go on
+          true # success, do go on
       end
     end
   end

data/lib/ruote/exp/ro_variables.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2010, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2011, 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
@@ -52,7 +52,7 @@ module Ruote::Exp
     # Looks up the value of a variable in expression tree
     # (seen from a leaf, it looks more like a stack than a tree)
     #
-    def lookup_variable (var, prefix=nil)
+    def lookup_variable(var, prefix=nil)
 
       var, prefix = split_prefix(var, prefix)
 
@@ -91,31 +91,20 @@ module Ruote::Exp
     # Sets a variable to a given value.
     # (will set at the appropriate level).
     #
-    def set_variable (var, val)
+    def set_variable(var, val)
 
       fexp, v = locate_var(var)
 
-      raise(
-        ArgumentError.new("cannot set var at engine level : #{var}")
-      ) if fexp.nil?
-
-      fexp.un_set_variable(:set, v, val, true)
+      fexp.un_set_variable(:set, v, val, (fexp.h.fei != h.fei)) if fexp
     end
 
     # Unbinds a variables.
     #
-    def unset_variable (var)
+    def unset_variable(var)
 
       fexp, v = locate_var(var)
 
-      raise(
-        ArgumentError.new("cannot set var at engine level : #{var}")
-      ) if fexp.nil?
-
-      should_persist = (fexp.h.fei != h.fei)
-        # don't use a ticket when expression wants to modify its own vars
-
-      fexp.un_set_variable(:unset, v, nil, should_persist)
+      fexp.un_set_variable(:unset, v, nil, (fexp.h.fei != h.fei)) if fexp
     end
 
     # TODO : redoc rewrite needed
@@ -123,7 +112,7 @@ module Ruote::Exp
     # This method is mostly used by the worker when looking up
     # a process name or participant name bound under a variable.
     #
-    def iterative_var_lookup (k)
+    def iterative_var_lookup(k)
 
       v = lookup_variable(k)
 
@@ -138,7 +127,7 @@ module Ruote::Exp
     #
     # val should be nil in case of 'unset'.
     #
-    def un_set_variable (op, var, val, should_persist)
+    def un_set_variable(op, var, val, should_persist)
 
       if op == :set
         Ruote.set(h.variables, var, val)
@@ -146,14 +135,12 @@ module Ruote::Exp
         Ruote.unset(h.variables, var)
       end
 
-      return unless should_persist
-
-      if r = try_persist # persist failed, have to retry
+      if should_persist && r = try_persist # persist failed, have to retry
 
         @h = r
         un_set_variable(op, var, val, true)
 
-      else # success
+      else # success (even when should_persist == false)
 
         @context.storage.put_msg("variable_#{op}", 'var' => var, 'fei' => h.fei)
       end
@@ -164,7 +151,7 @@ module Ruote::Exp
     # Used by lookup_variable and set_variable to extract the
     # prefix in a variable name
     #
-    def split_prefix (var, prefix)
+    def split_prefix(var, prefix)
 
       if prefix.nil?
         var = var.to_s
@@ -179,7 +166,7 @@ module Ruote::Exp
     # Returns the flow expression that owns a variable (or the one
     # that should own it) and the var without its potential / prefixes.
     #
-    def locate_var (var, prefix=nil)
+    def locate_var(var, prefix=nil)
 
       var, prefix = split_prefix(var, prefix)
 
@@ -189,9 +176,13 @@ module Ruote::Exp
       # no prefix...
 
       return [ self, var ] if h.variables
-      return parent.locate_var(var, prefix) if h.parent_id
 
-      raise "uprooted var lookup, something went wrong"
+      if par = parent
+        return parent.locate_var(var, prefix) rescue nil
+      end
+
+      #raise "uprooted var lookup, something went wrong"
+      [ nil, nil ]
     end
   end
 end