ruote 2.1.4 → 2.1.5

data/CHANGELOG.txt

@@ -1,7 +1,27 @@
 
 = ruote - CHANGELOG.txt
 
-== ruote - 2.1.4          released 2010/01/11
+
+== ruote - 2.1.5    released 2010/01/28
+
+- fixed StorageParticipant a to b flow, fix by Torsten
+- fixed StorageParticipant#cancel
+- dollar : made sure of ${fei} and ${wfid}
+- implemented ProcessStatus#to_dot
+- if a participant implementation cancel method returns false,
+  reply_to_parent will not get called
+- changes about errors without [stored] expressions, they now appear in process
+  statuses
+- EngineParticipant implemented
+- 'ruby_eval_allowed' instead of :ruby_eval_allowed
+- ${v:customer.address.1} deep trick now ok (as it was ok for fields)
+- added d() to the $ notation : echo "${r: d('f:toto') }"
+- Engine#kill_process(wfid) can cure errored participant expressions
+- made sure ${r:wi} and ${r:workitem} is and instance of Ruote::Workitem
+- implemented StorageParticipant#by_field
+
+
+== ruote - 2.1.4    released 2010/01/11
 
 - implemented StorageHistory
 - using yyyy-mm-dd instead of yyyy/mm/dd for Ruote.time_to_utc_s(t)
@@ -9,19 +29,19 @@
 - Engine#add_service now returning just bound service
 
 
-== ruote - 2.1.3          released 2010/01/04
+== ruote - 2.1.3    released 2010/01/04
 
 - fixed issue with Rufus.is_cron_string (thanks Torsten)
 - fixed issue with FlowExpression#cancel (Kenneth)
 
 
-== ruote - 2.1.2          released 2010/01/03
+== ruote - 2.1.2    released 2010/01/03
 
 - fixed issue when initializing engine without worker. Thanks Matt Nichols.
 
 
-== ruote - 2.1.1          released 2009/12/31
+== ruote - 2.1.1    released 2009/12/31
 
-== OpenWFEru - 0.9.2      released 2007/01/26
-== openwfe-ruby - 1.7.0   released 2006/05/08
+== OpenWFEru - 0.9.2       released 2007/01/26
+== openwfe-ruby - 1.7.0    released 2006/05/08
 

data/CREDITS.txt

@@ -15,12 +15,12 @@ Kenneth Kalmer  http://www.opensourcery.co.za
 Contributors
 ------------
 
+Torsten Schoenebaum - ActiveResourceParticipant and much more
 Matt Nichols - http://github.com/mattnichols
 Nicholas Faiz - http://github.com/biv
 Chris Beer - http://github.com/cbeer
 Enrico Bianco - http://github.com/enricob
 Andrew Timberlake - timeout 'at'
-Torsten Schoenebaum - ActiveResourceParticipant and more
 Raphael Simon - error handling mechanism design and QA
 Maarten Oelering - bug reports and test cases
 Nick Petrella - socket listener issues and Python interactivity, dollar patch

data/TODO.txt

@@ -171,6 +171,19 @@
 [o] maybe cancel should have a safely / redo_reply thing
 [o] implement Storage#clear!(type)
 [o] ruote/util/time.rb utc_to_s 'YYYY/MM/DD' --> 'YYYY-MM-DD' (regex friendly)
+[x] store participant bytecode/AST ?
+[o] ${r:puts(d("f:nada"))}
+[o] :ruby_eval_allowed vs 'ruby_eval_allowed'
+[o] check : what if a reply on a concurrence wants to save, whereas the
+    concurrence terminated (got removed) meanwhile ?
+    the reply returns true...
+[o] implement StorageHistory
+[x] nuke FsHistory ? keep
+[o] EngineParticipant
+[x] expstorage.to_dot
+[o] process_status.to_dot
+[o] EngineParticipant : don't wait in case of forget (reply could NEVER come !)
+[x] align :forget behaviour on EngineParticipant forget... OK as it is
 
 [ ] exp : exp (restricted form of eval ?)
 [ ] exp : case (is it necessary ?)
@@ -197,8 +210,6 @@
 
 [ ] participant dispatch thread throttling ?
 
-[ ] expstorage.to_dot
-
 [ ] tailcall
 [ ] subprocesses participants (alias ?)
 
@@ -277,15 +288,15 @@
 [ ] at expression ?
 [ ] listen to participants/errors/tags {in|out}
 
-[ ] implement StorageHistory
-[ ] nuke FsHistory ?
-
 [ ] remove abort_on_exception=true
 
-[ ] check : what if a reply on a concurrence wants to save, whereas the
-    concurrence terminated (got removed) meanwhile ?
-    the reply returns true...
-
 [ ] shell ? irb ? Shell.new(storage)
 [ ] focus on fulldup or json.dup (via fulldup ?)
 
+[ ] ruote-dm 2.1
+
+[ ] implement pause engine
+[ ] implement pause process
+
+[ ] engine.on_error = 'participant_name'
+

data/examples/ruote_quickstart.rb

@@ -9,8 +9,9 @@ require 'ruote/storage/fs_storage'
 
 engine = Ruote::Engine.new(
   Ruote::Worker.new(
-    Ruote::FsStorage.new("ruote_work")))
-    #Ruote::HashStorage.new))
+    Ruote::FsStorage.new(
+      'ruote_work',
+      's_logger' => [ 'ruote/log/test_logger', 'Ruote::TestLogger' ])))
 
 # registering participants
 

data/lib/ruote.rb

@@ -2,5 +2,6 @@
 require 'ruote/storage/hash_storage'
 require 'ruote/worker'
 require 'ruote/engine'
+require 'ruote/participant'
 require 'ruote/parser/ruby_dsl'
 

data/lib/ruote/context.rb

@@ -52,6 +52,11 @@ module Ruote
       initialize_services
     end
 
+    def engine_id
+
+      @conf['engine_id'] || 'engine'
+    end
+
     def [] (key)
 
       @conf[key]

data/lib/ruote/engine.rb

@@ -113,14 +113,7 @@ module Ruote
         exp.unpersist_or_raise if exp
       end
 
-      #@storage.delete(err.to_h) # remove error
-        #
-        # done when the expression gets deleted
-        #
-        # but
-        #
-        # is there a case, 5 lines above, where there is no expression
-        # to delete ?
+      @storage.delete(err.to_h) # remove error
 
       @storage.put_msg(action, msg) # trigger replay
     end
@@ -141,12 +134,12 @@ module Ruote
     #
     def process (wfid)
 
-      exps = @storage.get_many('expressions', /#{wfid}$/)
+      exps = @storage.get_many('expressions', /!#{wfid}$/)
+      errs = @storage.get_many('errors', /!#{wfid}$/)
 
-      return nil if exps.size < 1
+      return nil if exps.empty? && errs.empty?
 
-      ProcessStatus.new(
-        @context, exps, @storage.get_many('errors', /#{wfid}$/))
+      ProcessStatus.new(@context, exps, errs)
     end
 
     # Returns an array of ProcessStatus instances.

data/lib/ruote/engine/process_error.rb

@@ -68,6 +68,19 @@ module Ruote
     def to_h
       @h
     end
+
+    protected
+
+    def to_dot (opts)
+
+      i = fei.to_storage_id
+      label = "error : #{message.gsub(/"/, "'")}"
+
+      [
+        "\"err_#{i}\" [ label = \"#{label}\" ];",
+        "\"err_#{i}\" -> \"#{i}\" [ style = \"dotted\" ];"
+      ]
+    end
   end
 end
 

data/lib/ruote/engine/process_status.rb

@@ -47,9 +47,11 @@ module Ruote
 
       @expressions = expressions.collect { |e|
         Ruote::Exp::FlowExpression.from_h(context, e) }
+      @expressions.sort! { |a, b| a.fei.expid <=> b.fei.expid }
 
       @errors = errors.collect { |e|
         ProcessError.new(e) }
+      @errors.sort! { |a, b| a.fei.expid <=> b.fei.expid }
     end
 
     # Returns the expression at the root of the process instance.
@@ -100,7 +102,11 @@ module Ruote
     #
     def wfid
 
-      root_expression.fei.wfid
+      begin
+        root_expression.fei.wfid
+      rescue
+        @errors.first.fei.wfid
+      end
     end
 
     def definition_name
@@ -144,12 +150,23 @@ module Ruote
       end
       s << "   errors : #{@errors.size}\n"
       @errors.each do |e|
+        s << "     #{e.fei.to_storage_id} :\n" if e.fei
         s << "     #{e.inspect}\n"
       end
 
       s
     end
 
+    def to_dot (opts={})
+
+      s = [ "digraph \"process wfid #{wfid}\" {" ]
+      @expressions.each { |e| s.push(*e.send(:to_dot, opts)) }
+      @errors.each { |e| s.push(*e.send(:to_dot, opts)) }
+      s << "}"
+
+      s.join("\n")
+    end
+
     def to_h
 
       h = {}

data/lib/ruote/exp/condition.rb

@@ -73,11 +73,6 @@ module Ruote::Exp
       s ? s.to_s.gsub('&amp;', '&').gsub('&gt;', '>').gsub('&lt;', '<') : nil
     end
 
-    #def self.ruby_eval (s)
-    #  treechecker.check_conditional(s)
-    #  eval(s)
-    #end
-
     def self.to_b (o)
 
       o = o.strip if o.is_a?(String)

data/lib/ruote/exp/fe_participant.rb

@@ -162,14 +162,20 @@ module Ruote::Exp
 
     def cancel (flavour)
 
-      # TODO : if flavour is 'kill', why not not trigger participant.cancel ?
-
       participant = @context.plist.lookup(h.participant_name)
-      participant.cancel(fei, flavour)
-        # TODO should this be threaded ?
-        # TODO should errors be intercepted here ?
 
-      reply_to_parent(h.applied_workitem)
+      r = if flavour == 'kill'
+        begin
+          participant.cancel(fei, 'kill')
+        rescue Exception => e
+          # intercept anything
+          nil
+        end
+      else
+        participant.cancel(fei, flavour)
+      end
+
+      reply_to_parent(h.applied_workitem) if r != false
     end
 
     def reply_to_parent (workitem)

data/lib/ruote/exp/fe_subprocess.rb

@@ -22,6 +22,8 @@
 # Made in Japan.
 #++
 
+require 'ruote/subprocess'
+
 
 module Ruote::Exp
 
@@ -116,7 +118,7 @@ module Ruote::Exp
   #
   #   subprocess :ref => 'http://pdefs.example.org/account/def1.xml'
   #
-  # Remember that the :remote_definition_allowed option of the engine has
+  # Remember that the 'remote_definition_allowed' option of the engine has
   # to be set to true for the latter to work, else the engine will refuse
   # to load definitions over HTTP.
   #
@@ -155,7 +157,7 @@ module Ruote::Exp
 
       raise "no subprocess referred in #{tree}" unless ref
 
-      pos, subtree = lookup_subprocess(ref)
+      pos, subtree = Ruote.lookup_subprocess(self, ref)
 
       vars = compile_atts
       vars.merge!('tree' => tree_children.first)
@@ -163,41 +165,6 @@ module Ruote::Exp
 
       launch_sub(pos, subtree, :variables => vars)
     end
-
-    protected
-
-    def lookup_subprocess (ref)
-
-      val = lookup_variable(ref)
-
-      # a classical subprocess stored in a variable ?
-
-      return [ '0', val ] if is_tree?(val)
-      return val if is_pos_tree?(val)
-
-      # maybe subprocess :ref => 'uri'
-
-      subtree = @context.parser.parse(ref) rescue nil
-
-      _, subtree = Ruote::Exp::DefineExpression.reorganize(subtree) \
-        if subtree && Ruote::Exp::DefineExpression.is_definition?(subtree)
-
-      return [ '0', subtree ] if is_tree?(subtree)
-
-      # no luck ...
-
-      raise "no subprocess named '#{ref}' found"
-    end
-
-    def is_tree? (a)
-
-      a.is_a?(Array) && a[1].is_a?(Hash) && a.size == 3
-    end
-
-    def is_pos_tree? (a)
-
-      a.is_a?(Array) && a.size == 2 && a[0].is_a?(String) && is_tree?(a[1])
-    end
   end
 end
 

data/lib/ruote/exp/fe_when.rb

@@ -133,7 +133,7 @@ module Ruote::Exp
   #
   # == ${ruby:'hello'}
   #
-  # Remember that, if the engine's :ruby_eval_allowed is set to true, the
+  # Remember that, if the engine's 'ruby_eval_allowed' is set to true, the
   # condition may contain Ruby code.
   #
   #   _when '${r:"hell" + "o"} == hello'

data/lib/ruote/exp/flowexpression.rb

@@ -145,6 +145,21 @@ module Ruote::Exp
 
     def self.do_action (context, msg)
 
+      fei = msg['fei']
+      action = msg['action']
+
+      if action == 'reply' && fei['engine_id'] != context.engine_id
+
+        ep = context.plist.lookup(fei['engine_id'])
+
+        raise(
+          "no EngineParticipant found under name '#{fei['engine_id']}'"
+        ) unless ep
+
+        ep.reply(fei, msg['workitem'])
+        return
+      end
+
       fexp = nil
 
       3.times do
@@ -154,7 +169,7 @@ module Ruote::Exp
       end
         # this retry system is only useful with ruote-couch
 
-      fexp.send("do_#{msg['action']}", msg) if fexp
+      fexp.send("do_#{action}", msg) if fexp
     end
 
     def do_apply
@@ -184,15 +199,6 @@ module Ruote::Exp
 
     def reply_to_parent (workitem, delete=true)
 
-      #if delete && h.state.nil?
-      #  p @msg
-      #  if @msg && @msg['action'] == 'reply'
-      #    do_unpersist || return
-      #  else
-      #    unpersist_or_raise
-      #  end
-      #end
-
       if h.tagname
 
         unset_variable(h.tagname)
@@ -291,16 +297,16 @@ module Ruote::Exp
     #
     def do_cancel (msg)
 
-      return if h.state == 'cancelling'
-        # cancel on cancel gets discarded
-
-      @msg = Ruote.fulldup(msg)
-
       flavour = msg['flavour']
 
+      return if h.state == 'cancelling' && flavour != 'kill'
+        # cancel on cancel gets discarded
+
       return if h.state == 'failed' && flavour == 'timeout'
         # do not timeout expressions that are "in error" (failed)
 
+      @msg = Ruote.fulldup(msg)
+
       h.state = case flavour
         when 'kill' then 'dying'
         when 'timeout' then 'timing_out'
@@ -490,8 +496,46 @@ module Ruote::Exp
       tree[2]
     end
 
+    # Generates a sub_wfid, without hitting storage.
+    #
+    # There's a better implementation for sure...
+    #
+    def get_next_sub_wfid
+
+      i = [
+        $$, Time.now.to_f.to_s, self.hash.to_s, @h['fei'].inspect
+      ].join('-').hash
+
+      (i < 0 ? "1#{i * -1}" : "0#{i}").to_s
+    end
+
     protected
 
+    def to_dot (opts)
+
+      i = fei()
+
+      label = "#{[ i.wfid, i.sub_wfid, i.expid].join(" ")} #{tree.first}"
+      label += " (#{h.state})" if h.state
+
+      a = []
+      a << "\"#{i.to_storage_id}\" [ label=\"#{label}\" ];"
+
+      # parent
+
+      if h.parent_id
+        a << "\"#{i.to_storage_id}\" -> \"#{parent_id.to_storage_id}\";"
+      end
+
+      # children
+
+      h.children.each do |cfei|
+        a << "\"#{i.to_storage_id}\" -> \"#{Ruote.to_storage_id(cfei)}\";"
+      end
+
+      a
+    end
+
     def pre_apply_child (child_index, workitem, forget)
 
       child_fei = h.fei.merge('expid' => "#{h.fei['expid']}_#{child_index}")
@@ -519,19 +563,6 @@ module Ruote::Exp
       @context.storage.put_msg('apply', msg)
     end
 
-    # Generates a sub_wfid, without hitting storage.
-    #
-    # There's a better implementation for sure...
-    #
-    def get_next_sub_wfid
-
-      i = [
-        $$, Time.now.to_f.to_s, self.hash.to_s, @h['fei'].inspect
-      ].join('-').hash
-
-      (i < 0 ? "1#{i * -1}" : "0#{i}").to_s
-    end
-
     def register_child (fei)
 
       h.children << fei