ruote 2.3.0.1 → 2.3.0.2

data/lib/ruote/exp/fe_cron.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_cursor.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
@@ -304,17 +304,16 @@ module Ruote::Exp
 
       tree_children.each_with_index do |c, i|
 
-        exp_name = c[0]
-        ref = c[1]['ref']
-        tag = c[1]['tag']
+        found = [
+          c[0],                                      # exp_name
+          c[1]['ref'],                               # ref
+          c[1]['tag'],                               # tag
+          (c[1].find { |k, v| v.nil? } || []).first  # participant 'xxx'
+        ].find do |v|
+          v ? (dsub(v, workitem) == arg) : false
+        end
 
-        ref = dsub(ref, workitem) if ref
-        tag = dsub(tag, workitem) if tag
-
-        next if exp_name != arg && ref != arg && tag != arg
-
-        pos = i
-        break
+        if found then pos = i; break; end
       end
 
       pos ? pos : position

data/lib/ruote/exp/fe_define.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_echo.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_equals.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_error.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_filter.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_forget.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_given.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_if.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
@@ -26,20 +26,100 @@
 module Ruote::Exp
 
   #
-  # Here are examples of the 'if' expression in use :
+  # The 'if' construct found in many programming languages.
+  #
+  # == _if ?
+  #
+  # Why the "_if" in all the examples below? Well, all the examples are using
+  # the Ruby DSL, using 'if' alone isn't possible, the Ruby parser would think
+  # it's the Ruby's own if...
+  #
+  # But process definitions written in Radial
+  # (see http://jmettraux.github.com/2012-09-03-ruote-2.3.0.html) don't have
+  # this restriction:
+  #
+  #   if '${customer} == fred'
+  #     salesman_henry  # then clause
+  #     salesman_josh   # else clause
+  #
+  # == then / else clauses
+  #
+  # The 'if' expression accepts two or three children branches, in pseudo-code
+  # it looks like:
+  #
+  #   _if do
+  #     <condition>
+  #     <then clause>
+  #   end
+  #
+  #   # or
+  #
+  #   _if <condition> do
+  #     <then clause>
+  #   end
+  #
+  #   # or
+  #
+  #   _if do
+  #     <condition>
+  #     <then clause>
+  #     <else clause>
+  #   end
+  #
+  #   # or
+  #
+  #   _if <condition> do
+  #     <then clause>
+  #     <else clause>
+  #   end
+  #
+  # This piece of process definition:
+  #
+  #   _if '${customer} == fred' do
+  #     salesman_henry
+  #     salesman_josh
+  #   end
+  #
+  # is thus interpreted as:
+  #
+  #   _if '${customer} == fred' do
+  #     salesman_henry  # then clause
+  #     salesman_josh   # else clause
+  #   end
+  #
+  # If the intent was to express a sequence henry - josh, it should be
+  # written as:
+  #
+  #   _if '${customer} == fred' do
+  #     sequence do # then clause
+  #       salesman_henry
+  #       salesman_josh
+  #     end
+  #   end
+  #
+  # Note this can be alternatively written as:
+  #
+  #   sequence :if => '${customer} == fred' do
+  #     salesman_henry
+  #     salesman_josh
+  #   end
+  #
+  # == examples
+  #
+  # Here are some examples:
   #
   #   _if do
   #     equals :field_value => 'customer', :other_value => 'British Petroleum'
   #     participant :ref => 'Allister'
   #   end
   #
-  # and :
+  # and:
   #
   #   _if :test => '${f:customer} == British Petroleum' do
   #     participant :ref => 'Allister'
   #   end
   #
-  # An else clause is accepted :
+  # An else clause is accepted:
   #
   #   _if do
   #     equals :field_value => 'customer', :other_value => 'British Petroleum'
@@ -47,14 +127,14 @@ module Ruote::Exp
   #     participant :ref => 'Bernardo'
   #   end
   #
-  # or :
+  # or:
   #
   #   _if :test => '${f:customer} == British Petroleum' do
   #     participant :ref => 'Allister'
   #     participant :ref => 'Bernardo'
   #   end
   #
-  # Note that any expression accepts an :if attribute :
+  # Note that any expression accepts an :if attribute:
   #
   #   participant :ref => 'Al', :if => '${f:customer} == British Petroleum'
   #
@@ -68,7 +148,7 @@ module Ruote::Exp
   #     subprocess 'regular_course'
   #   end
   #
-  # When using Ruby to generate the process definition tree, you can simply do :
+  # When using Ruby to generate the process definition tree, you can simply do:
   #
   #   _if '${f:customer.name} == Fred' do
   #     subprocess 'premium_course'

data/lib/ruote/exp/fe_inc.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_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/fe_listen.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_lose.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_noop.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_on_error.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_once.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_participant.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
@@ -144,12 +144,7 @@ module Ruote::Exp
       #
       # trigger on_apply if the participant sports it
 
-      pa = @context.plist.instantiate(
-        h.participant, :if_respond_to? => :on_apply)
-
-      Ruote.participant_send(
-        pa, :on_apply, 'workitem' => Ruote::Workitem.new(h.applied_workitem)
-      ) if pa
+      trigger_callback(:on_apply, h.applied_workitem)
 
       #
       # dispatch to participant
@@ -202,15 +197,7 @@ module Ruote::Exp
 
     def reply(workitem)
 
-      pinfo =
-        h.participant ||
-        @context.plist.lookup_info(h.participant_name, workitem)
-
-      pa = @context.plist.instantiate(pinfo, :if_respond_to? => :on_reply)
-
-      Ruote.participant_send(
-        pa, :on_reply, 'workitem' => Ruote::Workitem.new(workitem)
-      ) if pa
+      trigger_callback(:on_reply, workitem)
 
       super(workitem)
     end
@@ -222,8 +209,54 @@ module Ruote::Exp
       super(workitem)
     end
 
+    # Overrides FlowExpression#handle_on_error. Attempts to call a
+    # potential #on_error method in the participant implementation.
+    #
+    # If that method exists and returns something true-ish, will not call
+    # the super #handle_on_error, it will directly reply to the parent.
+    #
+    def handle_on_error(msg, err)
+
+      r = trigger_callback(:on_error, msg, err)
+
+      if r
+        reply_to_parent(msg['workitem'])
+        true # yes, we've dealt with the error.
+      else
+        super(msg, err)
+      end
+    end
+
     protected
 
+    # Used to trigger #on_apply, #on_reply, #on_cancel and #on_error in
+    # the participant implementation.
+    #
+    def trigger_callback(meth, wi_or_msg, err=nil)
+
+      wi, msg, err = if err
+        [ wi_or_msg['workitem'], wi_or_msg, err ]
+      elsif wi_or_msg['workitem']
+        [ wi_or_msg['workitem'], wi_or_msg, nil ]
+      else
+        [ wi_or_msg, nil, nil ]
+      end
+
+      pinfo =
+        h.participant ||
+        @context.plist.lookup_info(h.participant_name, wi)
+
+      pa = @context.plist.instantiate(pinfo, :if_respond_to? => meth)
+
+      return nil unless pa
+
+      args = { 'workitem' => Ruote::Workitem.new(wi) }
+      args['error'] = err if err
+      args['msg'] = msg if msg
+
+      Ruote.participant_send(pa, meth, args)
+    end
+
     # Once the dispatching work (done by the dispatch pool) is done, a
     # 'dispatched' msg is sent, we have to flag the participant expression
     # as 'dispatched' => true

data/lib/ruote/exp/fe_read.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_redo.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_ref.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_registerp.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_reserve.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_restore.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
@@ -23,9 +23,6 @@
 #++
 
 
-require 'ruote/exp/merge'
-
-
 module Ruote::Exp
 
   #
@@ -55,9 +52,6 @@ module Ruote::Exp
   #
   class RestoreExpression < FlowExpression
 
-    include MergeMixin
-      # still have to implement something about merge...
-
     names :restore, :set_fields
 
     def apply