ruote 2.3.0.1 → 2.3.0.2

data/lib/ruote/exp/fe_save.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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

data/lib/ruote/exp/fe_sequence.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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

data/lib/ruote/exp/fe_set.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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

data/lib/ruote/exp/fe_stall.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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

data/lib/ruote/exp/fe_subprocess.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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

data/lib/ruote/exp/fe_that.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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

data/lib/ruote/exp/fe_undo.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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

data/lib/ruote/exp/fe_unregisterp.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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

data/lib/ruote/exp/fe_wait.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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

data/lib/ruote/exp/flow_expression.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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
@@ -174,6 +174,14 @@ module Ruote::Exp
         nil
     end
 
+    # Returns the child_id for this expression. (The rightmost part of the
+    # fei.expid).
+    #
+    def child_id
+
+      fei.child_id
+    end
+
     # Fetches the parent expression, or returns nil if there is no parent
     # expression.
     #
@@ -227,6 +235,14 @@ module Ruote::Exp
       root(stubborn).fei
     end
 
+    # Concurrent expressions (expressions that apply more than one child
+    # at a time) are supposed to return true here.
+    #
+    def is_concurrent?
+
+      false
+    end
+
     # Turns this FlowExpression instance into a Hash (well, just hands back
     # the base hash behind it).
     #
@@ -242,6 +258,25 @@ module Ruote::Exp
       @awi ||= Ruote::Workitem.new(h.applied_workitem)
     end
 
+    # Given an index, returns the child fei (among the currently registered
+    # children feis) whose fei.expid ends with this index (whose child_id
+    # is equal to that index).
+    #
+    # Returns nil if not found or a child fei as a Hash.
+    #
+    def cfei_at(i)
+
+      children.find { |cfei| Ruote.extract_child_id(cfei) == i }
+    end
+
+    # Returns the list of child_ids (last part of the fei.expid) for the
+    # currently registered (active) children.
+    #
+    def child_ids
+
+      children.collect { |cfei| Ruote.extract_child_id(cfei) }
+    end
+
     # Instantiates expression back from hash.
     #
     def self.from_h(context, h)
@@ -336,6 +371,16 @@ module Ruote::Exp
     #
     def do_apply(msg)
 
+      if msg['state'] == 'paused'
+
+        return pause_on_apply(msg)
+      end
+
+      if msg['flavour'].nil? && (aw = attribute(:await))
+
+        return await(aw, msg)
+      end
+
       unless Condition.apply?(attribute(:if), attribute(:unless))
 
         return do_reply_to_parent(h.applied_workitem)
@@ -385,6 +430,52 @@ module Ruote::Exp
       apply
     end
 
+    # Called by #do_apply when msg['state'] == 'paused'. Covers the
+    # "apply/launch it but it's immediately paused" case. Freezes the
+    # apply message in h.paused_apply and saves the expression.
+    #
+    def pause_on_apply(msg)
+
+      msg['state'] = nil
+
+      h.state = 'paused'
+      h.paused_apply = msg
+
+      persist_or_raise
+    end
+
+    # If the expression has an :await attribute, the expression gets
+    # into a special "awaiting" state until the condition in the value
+    # of :await gets triggered and the trigger calls resume on the
+    # expression.
+    #
+    def await(att, msg)
+
+      action, condition =
+        Ruote::Exp::AwaitExpression.extract_await_ac(:await => att)
+
+      raise ::ArgumentError.new(
+        ":await does not understand #{att.inspect}"
+      ) if action == nil
+
+      msg.merge!('flavour' => 'awaiting')
+
+      h.state = 'awaiting'
+      h.paused_apply = msg
+
+      persist_or_raise
+
+      @context.tracker.add_tracker(
+        h.fei['wfid'],
+        action,
+        Ruote.to_storage_id(h.fei),
+        condition,
+        { '_auto_remove' => true,
+          'action' => 'resume',
+          'fei' => h.fei,
+          'flavour' => 'awaiting' })
+    end
+
     # FlowExpression call this method when they're done and they want their
     # parent expression to take over (it will end up calling the #reply of
     # the parent expression).
@@ -456,7 +547,13 @@ module Ruote::Exp
 
         trigger('on_reply', workitem)
 
-      elsif (h.lost || h.flanking) && h.state.nil?
+      elsif h.flanking && h.state.nil?
+        #
+        # do vanish
+
+        do_unpersist
+
+      elsif h.lost && h.state.nil?
         #
         # do not reply, sit here (and wait for cancellation probably)
 
@@ -483,7 +580,7 @@ module Ruote::Exp
         (do_unpersist || return) if delete
           # remove expression from storage
 
-        if h.parent_id
+        if h.parent_id && ! h.attached
 
           @context.storage.put_msg(
             'reply',
@@ -495,15 +592,18 @@ module Ruote::Exp
         else
 
           @context.storage.put_msg(
-            h.forgotten ? 'ceased' : 'terminated',
+            (h.forgotten || h.attached) ? 'ceased' : 'terminated',
             'wfid' => h.fei['wfid'],
             'fei' => h.fei,
             'workitem' => workitem,
             'variables' => h.variables,
             'flavour' => flavour)
 
-          if h.state.nil? && h.on_terminate == 'regenerate' && ! h.forgotten
-
+          if
+            h.state.nil? &&
+            h.on_terminate == 'regenerate' &&
+            ! (h.forgotten || h.attached)
+          then
             @context.storage.put_msg(
               'regenerate',
               'wfid' => h.fei['wfid'],
@@ -717,9 +817,14 @@ module Ruote::Exp
     #
     def do_resume(msg)
 
-      return if h.state != 'paused'
+      return unless h.state == 'paused' || h.state == 'awaiting'
 
       h['state'] = nil
+
+      m = h.delete('paused_apply')
+      return do_apply(m) if m
+        # if it's a paused apply, pipe it directly to #do_apply
+
       replies = h.delete('paused_replies') || []
 
       do_persist || return
@@ -744,6 +849,10 @@ module Ruote::Exp
         'subid' => Ruote.generate_subid(h.fei.inspect),
         'expid' => pos)
 
+      if ci = opts[:child_id]
+        i['subid'] = "#{i['subid']}k#{ci}"
+      end
+
       #p '=== launch_sub ==='
       #p [ :launcher, h.fei['expid'], h.fei['subid'], h.fei['wfid'] ]
       #p [ :launched, i['expid'], i['subid'], i['wfid'] ]
@@ -916,7 +1025,7 @@ module Ruote::Exp
 
       tag = attribute(:tag)
 
-      return unless tag
+      return unless tag && tag.strip.size > 0
 
       h.tagname = tag
       h.full_tagname = applied_workitem.tags.join('/')

data/lib/ruote/exp/iterator.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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

data/lib/ruote/exp/ro_attributes.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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

data/lib/ruote/exp/ro_filters.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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

data/lib/ruote/exp/ro_on_x.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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
@@ -205,7 +205,9 @@ module Ruote::Exp
     def schedule_retries(handler, err)
 
       retries = handler.split(/\s*,\s*/)
+
       after, action = retries.shift.split(/:/)
+      (after, action = '0', after) if action.nil?
 
       # deal with "* 3"
 
@@ -299,7 +301,7 @@ module Ruote::Exp
         workitem = h.supplanted['applied_workitem']
       end
 
-      if on == 'on_error' && handler.respond_to?(:match) && handler.match(/:/)
+      if on == 'on_error' && handler.respond_to?(:match) && handler.match(/[,:\*]/)
         return schedule_retries(handler, err)
       end
 

data/lib/ruote/exp/ro_persist.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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

data/lib/ruote/exp/ro_timers.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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

data/lib/ruote/exp/ro_variables.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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

data/lib/ruote/extract.rb

@@ -0,0 +1,125 @@
+#--
+# Copyright (c) 2005-2013, 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.
+#++
+
+
+#--
+#
+# Various Ruote.xxx methods.
+#
+#++
+module Ruote
+
+  # A shortcut for
+  #
+  #   Ruote::FlowExpressionId.to_storage_id(fei)
+  #
+  def self.to_storage_id(fei)
+
+    Ruote::FlowExpressionId.to_storage_id(fei)
+  end
+
+  # A shorter shortcut for
+  #
+  #   Ruote::FlowExpressionId.to_storage_id(fei)
+  #
+  def self.sid(fei)
+
+    Ruote::FlowExpressionId.to_storage_id(fei)
+  end
+
+  SUBS = %w[ subid sub_wfid ]
+  IDS = %w[ engine_id expid wfid ]
+
+  # Returns true if the h is a representation of a FlowExpressionId instance.
+  #
+  def self.is_a_fei?(o)
+
+    return true if o.is_a?(Ruote::FlowExpressionId)
+    return false unless o.is_a?(Hash)
+
+    (o.keys - SUBS).sort == IDS
+  end
+
+  # Will do its best to return a wfid (String) or a fei (Hash instance)
+  # extract from the given o argument.
+  #
+  def self.extract_id(o)
+
+    return o if o.is_a?(String) and o.index('!').nil? # wfid
+
+    Ruote::FlowExpressionId.extract_h(o)
+  end
+
+  # Given something, tries to return the fei (Ruote::FlowExpressionId) in it.
+  #
+  def self.extract_fei(o)
+
+    Ruote::FlowExpressionId.extract(o)
+  end
+
+  # Given something that might be a fei, extract the child_id (the last
+  # portion of the expid in the fei).
+  #
+  def self.extract_child_id(o)
+
+    fei = Ruote::FlowExpressionId.extract(o)
+
+    fei ? fei.child_id : nil
+  end
+
+  # Given an object, will return the wfid (workflow instance id) nested into
+  # it (or nil if it can't find or doesn't know how to find).
+  #
+  # The wfid is a String instance.
+  #
+  def self.extract_wfid(o)
+
+    return o.strip == '' ? nil : o if o.is_a?(String)
+    return o.wfid if o.respond_to?(:wfid)
+    return o['wfid'] || o.fetch('fei', {})['wfid'] if o.respond_to?(:[])
+    nil
+  end
+
+  # Given a context and a fei (FlowExpressionId or Hash) or a flow expression
+  # (Ruote::Exp::FlowExpression or Hash) return the desired
+  # Ruote::Exp::FlowExpression instance.
+  #
+  def self.extract_fexp(context, fei_or_fexp)
+
+    return fei_or_fexp if fei_or_fexp.is_a?(Ruote::Exp::FlowExpression)
+
+    fei = case fei_or_fexp
+      when Ruote::FlowExpressionId then fei_or_fexp
+      when Hash, String then extract_fei(fei_or_fexp)
+      else nil
+    end
+
+    raise ArgumentError.new(
+      "failed to extract flow expression out of #{fei_or_fexp.class} instance"
+    ) unless fei
+
+    Ruote::Exp::FlowExpression.fetch(context, fei)
+  end
+end
+