ruote 2.1.4 → 2.1.5

data/lib/ruote/util/dollar.rb

@@ -76,8 +76,9 @@ module Ruote
 
     def [] (key)
 
+      return @fexp.fei.to_storage_id if key == 'fei'
       return @fexp.fei.wfid if key == 'wfid'
-      return @fexp.fei.parent_wfid if key == 'parent_wfid'
+      return @fexp.fei.sub_wfid if key == 'sub_wfid'
       return @fexp.fei.expid if key == 'expid'
 
       pr, k = extract_prefix(key)
@@ -149,10 +150,12 @@ module Ruote
     #
     def call_ruby (ruby_code)
 
-      return '' if @fexp.context[:ruby_eval_allowed] != true
+      return '' if @fexp.context['ruby_eval_allowed'] != true
 
-      wi = @workitem
-      workitem = @workitem
+      engine_id = @fexp.context.engine_id
+
+      wi = Ruote::Workitem.new(@workitem)
+      workitem = wi
 
       fe = @fexp
       fexp = @fexp
@@ -168,7 +171,22 @@ module Ruote
 
       eval(ruby_code, binding()).to_s
     end
-  end
 
+    # This 'd' function can be called from inside ${r:...} notations.
+    #
+    #   pdef = Ruote.process_definition do
+    #     sequence do
+    #       set 'f:toto' => 'person'
+    #       echo "${r:d('f:toto')}"
+    #     end
+    #   end
+    #
+    # will yield "person".
+    #
+    def d (s)
+
+      Rufus.dsub("${#{s}}", self)
+    end
+  end
 end
 

data/lib/ruote/worker.rb

@@ -27,7 +27,7 @@ require 'ruote/fei'
 
 module Ruote
 
-  VERSION = '2.1.4'
+  VERSION = '2.1.5'
 
   class Worker
 
@@ -137,6 +137,7 @@ module Ruote
         '_id' => "err_#{Ruote.to_storage_id(fei)}",
         'message' => ex.inspect,
         'trace' => ex.backtrace.join("\n"),
+        'fei' => fei,
         'msg' => msg
       ) if fei
     end
@@ -154,7 +155,7 @@ module Ruote
 
         @last_time = now
 
-        @storage.get_schedules(delta, now).each do|sche|
+        @storage.get_schedules(delta, now).each do |sche|
           trigger(sche)
         end
       end
@@ -283,8 +284,9 @@ module Ruote
 
       exp_hash = {
         'fei' => msg['fei'] || {
-          'engine_id' => @context['engine_id'] || 'engine',
+          'engine_id' => @context.engine_id,
           'wfid' => msg['wfid'],
+          'sub_wfid' => msg['sub_wfid'],
           'expid' => '0' },
         'parent_id' => msg['parent_id'],
         'original_tree' => tree,
@@ -303,6 +305,23 @@ module Ruote
         exp_class = Ruote::Exp::SequenceExpression
       end
 
+      if exp_class == Ruote::Exp::SubprocessExpression && tree[1]['engine']
+        #
+        # the subprocess has to be transformed into an EngineParticipant...
+
+        exp_class = Ruote::Exp::ParticipantExpression
+
+        atts = tree[1]
+
+        if ref = atts.find { |k, v| v.nil? }
+          ref = ref.first
+          atts.delete(ref)
+        end
+
+        atts['pdef'] = atts['ref'] || ref
+        atts['ref'] = atts.delete('engine')
+      end
+
       raise_unknown_expression_error(exp_hash) unless exp_class
 
       exp = exp_class.new(@context, exp_hash.merge!('original_tree' => tree))
@@ -313,7 +332,7 @@ module Ruote
     def raise_unknown_expression_error (exp_hash)
 
       exp_hash['state'] = 'failed'
-      exp_hash['has_error'] = true
+      #exp_hash['has_error'] = true
 
       Ruote::Exp::RawExpression.new(@context, exp_hash).persist_or_raise
         # undigested expression is stored
@@ -340,12 +359,14 @@ module Ruote
         tree[1]['ref'] = key
         tree[1]['original_ref'] = tree[0] if key != tree[0]
 
-        tree[0] = sub ? 'subprocess' : 'participant'
+        if sub
+
+          [ Ruote::Exp::SubprocessExpression, [ 'subprocess', *tree[1..2] ] ]
 
-        [ sub ?
-            Ruote::Exp::SubprocessExpression :
-            Ruote::Exp::ParticipantExpression,
-          tree ]
+        else
+
+          [ Ruote::Exp::ParticipantExpression, [ 'participant', *tree[1..2] ] ]
+        end
       else
 
         [ nil, tree ]

data/ruote.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruote}
-  s.version = "2.1.4"
+  s.version = "2.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Mettraux", "Kenneth Kalmer"]
-  s.date = %q{2010-01-11}
+  s.date = %q{2010-01-28}
   s.description = %q{
 ruote is an open source ruby workflow engine.
     }
@@ -87,6 +87,7 @@ ruote is an open source ruby workflow engine.
      "lib/ruote/parser/xml.rb",
      "lib/ruote/part/block_participant.rb",
      "lib/ruote/part/dispatch_pool.rb",
+     "lib/ruote/part/engine_participant.rb",
      "lib/ruote/part/hash_participant.rb",
      "lib/ruote/part/local_participant.rb",
      "lib/ruote/part/no_op_participant.rb",
@@ -100,6 +101,7 @@ ruote is an open source ruby workflow engine.
      "lib/ruote/storage/base.rb",
      "lib/ruote/storage/fs_storage.rb",
      "lib/ruote/storage/hash_storage.rb",
+     "lib/ruote/subprocess.rb",
      "lib/ruote/tree_dot.rb",
      "lib/ruote/util/dollar.rb",
      "lib/ruote/util/hashdot.rb",
@@ -189,6 +191,7 @@ ruote is an open source ruby workflow engine.
      "test/functional/ft_34_cursor_rewind.rb",
      "test/functional/ft_35_add_service.rb",
      "test/functional/ft_36_storage_history.rb",
+     "test/functional/ft_37_engine_participant.rb",
      "test/functional/ft_3_participant_registration.rb",
      "test/functional/ft_4_cancel.rb",
      "test/functional/ft_5_on_error.rb",

data/test/functional/eft_27_inc.rb

@@ -93,7 +93,7 @@ class EftIncTest < Test::Unit::TestCase
 
   def test_inc_array
 
-    @engine.context[:ruby_eval_allowed] = true
+    @engine.context['ruby_eval_allowed'] = true
 
     pdef = Ruote.process_definition do
       sequence do
@@ -113,7 +113,7 @@ class EftIncTest < Test::Unit::TestCase
 
   def test_inc_array_head
 
-    @engine.context[:ruby_eval_allowed] = true
+    @engine.context['ruby_eval_allowed'] = true
 
     pdef = Ruote.process_definition do
       sequence do
@@ -133,7 +133,7 @@ class EftIncTest < Test::Unit::TestCase
 
   def test_inc_array_missing
 
-    @engine.context[:ruby_eval_allowed] = true
+    @engine.context['ruby_eval_allowed'] = true
 
     pdef = Ruote.process_definition do
       sequence do
@@ -174,7 +174,7 @@ class EftIncTest < Test::Unit::TestCase
 
   def test_dec_array
 
-    @engine.context[:ruby_eval_allowed] = true
+    @engine.context['ruby_eval_allowed'] = true
 
     pdef = Ruote.process_definition do
       sequence do
@@ -198,7 +198,7 @@ class EftIncTest < Test::Unit::TestCase
 
   def test_dec_to
 
-    @engine.context[:ruby_eval_allowed] = true
+    @engine.context['ruby_eval_allowed'] = true
 
     pdef = Ruote.process_definition do
       sequence do
@@ -219,7 +219,7 @@ class EftIncTest < Test::Unit::TestCase
 
   def test_dec_val
 
-    @engine.context[:ruby_eval_allowed] = true
+    @engine.context['ruby_eval_allowed'] = true
 
     pdef = Ruote.process_definition do
       sequence do

data/test/functional/ft_10_dollar.rb

@@ -43,6 +43,25 @@ class FtDollarTest < Test::Unit::TestCase
     assert_trace(pdef, %w[ a b0 c0 d0 ])
   end
 
+  def test_nested_v
+
+    pdef = Ruote.process_definition do
+      sequence do
+        set(
+          :var => 'v0',
+          :val => {
+            'name' => 'toto',
+            'address' => [ 'e-street', 'atlantic_city' ] })
+        echo 'a:${v:v0.name}'
+        echo 'b:${v:v0.address.1}'
+      end
+    end
+
+    #noisy
+
+    assert_trace(pdef, %w[ a:toto b:atlantic_city ])
+  end
+
   def test_f
 
     pdef = Ruote.process_definition do
@@ -82,9 +101,73 @@ class FtDollarTest < Test::Unit::TestCase
 
     #noisy
 
-    @engine.context[:ruby_eval_allowed] = true
+    @engine.context['ruby_eval_allowed'] = true
 
     assert_trace(pdef, '>3<')
   end
+
+  def test_r_and_wi
+
+    pdef = Ruote.process_definition do
+      sequence do
+        set 'f:toto' => 'person'
+        echo "${r:wi.fields['toto']}"
+        echo "${r:workitem.fields['toto']}"
+      end
+    end
+
+    #noisy
+
+    @engine.context['ruby_eval_allowed'] = true
+
+    assert_trace pdef, "person\nperson"
+  end
+
+  def test_r_and_d
+
+    pdef = Ruote.process_definition do
+      sequence do
+        set 'f:toto' => 'person'
+        echo "${r:d('f:toto')}"
+      end
+    end
+
+    #noisy
+
+    @engine.context['ruby_eval_allowed'] = true
+
+    assert_trace pdef, 'person'
+  end
+
+  def test_nested
+
+    pdef = Ruote.process_definition do
+      sequence do
+        set 'f:a' => 'a'
+        set 'v:a' => 'AA'
+        echo '${v:${f:a}}'
+      end
+    end
+
+    #noisy
+
+    assert_trace pdef, 'AA'
+  end
+
+  def test_wfid
+
+    pdef = Ruote.process_definition do
+      sequence do
+        echo '${fei}'
+        echo '${wfid}'
+      end
+    end
+
+    wfid = @engine.launch(pdef)
+
+    @engine.wait_for(wfid)
+
+    assert_equal "0_0_0!!#{wfid}\n#{wfid}", @tracer.to_s
+  end
 end
 

data/test/functional/ft_1_process_status.rb

@@ -432,5 +432,48 @@ class FtProcessStatusTest < Test::Unit::TestCase
     assert_equal 'alpha', h['participant_name']
     assert_equal ["participant", {"ref"=>"alpha"}, []], h['original_tree']
   end
+
+  def test_to_dot
+
+    pdef = Ruote.process_definition :name => 'my process' do
+      concurrence do
+        participant :ref => 'alpha'
+        participant :ref => 'bravo'
+      end
+    end
+
+    alpha = @engine.register_participant :alpha, Ruote::HashParticipant.new
+
+    wfid = @engine.launch(pdef)
+
+    wait_for(:alpha)
+
+    ps = @engine.process(wfid)
+
+    #puts
+    #puts ps.to_dot
+
+    dot = ps.to_dot
+    dot = dot.gsub(wfid, 'wfid').strip
+
+    assert_equal(
+      %{
+digraph "process wfid wfid" {
+"0!!wfid" [ label="wfid  0 define" ];
+"0!!wfid" -> "0_0!!wfid";
+"0_0!!wfid" [ label="wfid  0_0 concurrence" ];
+"0_0!!wfid" -> "0!!wfid";
+"0_0!!wfid" -> "0_0_0!!wfid";
+"0_0!!wfid" -> "0_0_1!!wfid";
+"0_0_0!!wfid" [ label="wfid  0_0_0 participant" ];
+"0_0_0!!wfid" -> "0_0!!wfid";
+"0_0_1!!wfid" [ label="wfid  0_0_1 participant" ];
+"0_0_1!!wfid" -> "0_0!!wfid";
+"err_0_0_1!!wfid" [ label = "error : #<ArgumentError: no participant named 'bravo'>" ];
+"err_0_0_1!!wfid" -> "0_0_1!!wfid" [ style = "dotted" ];
+}
+      }.strip,
+      dot)
+  end
 end
 

data/test/functional/ft_20_storage_participant.rb

@@ -36,6 +36,10 @@ class FtStorageParticipantTest < Test::Unit::TestCase
 
     assert_equal Ruote::Workitem, wi.class
 
+    wi = alpha[alpha.first.fei]
+
+    assert_equal Ruote::Workitem, wi.class
+
     alpha.reply(wi)
 
     wait_for(wfid)
@@ -93,19 +97,27 @@ class FtStorageParticipantTest < Test::Unit::TestCase
     assert_equal 2, alpha.by_wfid(wfid).size
   end
 
-  def test_find_by_participant
-
-    pdef = Ruote.process_definition :name => 'def0' do
-      concurrence do
+  CON_AL_BRAVO = Ruote.process_definition :name => 'con_al_bravo' do
+    set 'f:place' => 'heiankyou'
+    concurrence do
+      sequence do
+        set 'f:character' => 'minamoto no hirosama'
         alpha
+      end
+      sequence do
+        set 'f:character' => 'seimei'
+        set 'f:adversary' => 'doson'
         bravo
       end
     end
+  end
+
+  def test_find_by_participant
 
     @engine.register_participant :alpha, Ruote::StorageParticipant
     @engine.register_participant :bravo, Ruote::StorageParticipant
 
-    wfid = @engine.launch(pdef)
+    wfid = @engine.launch(CON_AL_BRAVO)
 
     wait_for(:bravo)
 
@@ -116,5 +128,112 @@ class FtStorageParticipantTest < Test::Unit::TestCase
     assert_equal 1, part.by_participant('alpha').size
     assert_equal 1, part.by_participant('bravo').size
   end
+
+  def test_by_field
+
+    @engine.register_participant :alpha, Ruote::StorageParticipant
+    @engine.register_participant :bravo, Ruote::StorageParticipant
+
+    wfid = @engine.launch(CON_AL_BRAVO)
+
+    wait_for(:bravo)
+
+    part = Ruote::StorageParticipant.new
+    part.context = @engine.context
+
+    assert_equal 2, part.size
+    assert_equal 2, part.by_field('place').size
+    assert_equal 2, part.by_field('character').size
+    assert_equal 1, part.by_field('adversary').size
+  end
+
+  def test_by_field_and_value
+
+    @engine.register_participant :alpha, Ruote::StorageParticipant
+    @engine.register_participant :bravo, Ruote::StorageParticipant
+
+    wfid = @engine.launch(CON_AL_BRAVO)
+
+    wait_for(:bravo)
+
+    part = Ruote::StorageParticipant.new
+    part.context = @engine.context
+
+    assert_equal 2, part.size
+    assert_equal 0, part.by_field('place', 'nara').size
+    assert_equal 2, part.by_field('place', 'heiankyou').size
+    assert_equal 1, part.by_field('character', 'minamoto no hirosama').size
+  end
+
+  def test_initialize_engine_then_opts
+
+    @engine.register_participant :alpha, Ruote::StorageParticipant
+
+    wfid = @engine.launch(Ruote.process_definition do
+      alpha
+    end)
+
+    wait_for(:alpha)
+
+    part = Ruote::StorageParticipant.new(@engine)
+
+    assert_equal 1, part.size
+  end
+
+  def test_cancel
+
+    pdef = Ruote.process_definition :name => 'def0' do
+      alpha
+    end
+
+    @engine.register_participant :alpha, Ruote::StorageParticipant
+
+    #noisy
+
+    wfid = @engine.launch(pdef)
+
+    wait_for(:alpha)
+
+    @engine.cancel_process(wfid)
+
+    wait_for(wfid)
+
+    assert_nil @engine.process(wfid)
+    assert_equal 0, Ruote::StorageParticipant.new(@engine).size
+  end
+
+  def test_shared_participant
+
+    @engine.register_participant 'step_.*', Ruote::StorageParticipant
+
+    wfid = @engine.launch(
+      Ruote.process_definition { sequence { step_one; step_two } })
+
+    wait_for(:step_one)
+
+    participant = Ruote::StorageParticipant.new(@engine)
+
+    items = participant.by_wfid(wfid)
+
+    assert_equal 1, participant.size
+    assert_equal 1, items.size
+    assert_equal 'step_one', items.first.participant_name
+
+    participant.reply(items.first)
+
+    wait_for(:step_two)
+
+    items = participant.by_wfid(wfid)
+
+    assert_equal 1, participant.size
+    assert_equal 1, items.size
+    assert_equal 'step_two', items.first.participant_name
+
+    participant.reply(items.first)
+
+    wait_for(wfid)
+
+    assert_nil @engine.process(wfid)
+  end
 end