ruote 2.1.9 → 2.1.10

data/lib/ruote/storage/fs_storage.rb

@@ -38,6 +38,7 @@ require 'rufus/cloche'
 
 module Ruote
 
+  #
   # A basic FS-bound ruote storage. Leverages rufus-cloche
   # (http://github.com/jmettraux/rufus-cloche).
   #

data/lib/ruote/storage/hash_storage.rb

@@ -57,7 +57,8 @@ module Ruote
 
         pre = get(doc['type'], doc['_id'])
 
-        if pre && ( ! opts[:update_rev]) && pre['_rev'] != doc['_rev']
+        #if pre && ( ! opts[:update_rev]) && pre['_rev'] != doc['_rev']
+        if pre && pre['_rev'] != doc['_rev']
           return pre
         end
 

data/lib/ruote/util/lookup.rb

@@ -34,8 +34,9 @@ module Ruote
     key, rest = pop_key(key)
     value = flookup(collection, key)
 
+    return [ key, collection ] if container_lookup && rest.size == 0
     return [ rest.first, value ] if container_lookup && rest.size == 1
-    return value if rest.empty?
+    return value if rest.size == 0
     return nil if value == nil
 
     lookup(value, rest)
@@ -59,7 +60,26 @@ module Ruote
     end
   end
 
-  protected
+  #   h = { 'customer' => { 'name' => 'alpha', 'rank' => '1st' } }
+  #   r = Ruote.unset(h, 'customer.rank')
+  #
+  #   h # => { 'customer' => { 'name' => 'alpha' } }
+  #   r # => '1st'
+  #
+  def Ruote.unset (collection, key)
+
+    k, c = lookup(collection, key, true)
+
+    return collection.delete(key) unless c
+
+    if c.is_a?(Array)
+      c.delete_at(Integer(k)) rescue nil
+    else
+      c.delete(k)
+    end
+  end
+
+  protected # well...
 
   def Ruote.pop_key (key)
 

data/lib/ruote/util/misc.rb

@@ -58,11 +58,11 @@ module Ruote
     rescue TypeError => te
     end
 
-    if object.is_a?(REXML::Element)
-      d = REXML::Document.new object.to_s
-      return d if object.kind_of?(REXML::Document)
-      return d.root
-    end
+    #if object.is_a?(REXML::Element)
+    #  d = REXML::Document.new object.to_s
+    #  return d if object.kind_of?(REXML::Document)
+    #  return d.root
+    #end
       # avoiding "TypeError: singleton can't be dumped"
 
     o = object.class.allocate

data/lib/ruote/version.rb

@@ -23,6 +23,6 @@
 #++
 
 module Ruote
-  VERSION = '2.1.9'
+  VERSION = '2.1.10'
 end
 

data/lib/ruote/worker.rb

@@ -27,9 +27,14 @@ require 'ruote/fei'
 
 module Ruote
 
+  #
+  # Workers fetch 'msgs' and 'schedules' from the storage and process them.
+  #
+  # Read more at http://ruote.rubyforge.org/configuration.html
+  #
   class Worker
 
-    EXP_ACTIONS = %w[ reply cancel fail receive ]
+    EXP_ACTIONS = %w[ reply cancel fail receive dispatched ]
       # 'apply' is comprised in 'launch'
       # 'receive' is a ParticipantExpression alias for 'reply'
 
@@ -43,10 +48,12 @@ module Ruote
 
     def initialize (storage)
 
-      @storage = storage
-
       @subscribers = []
-      @context = Ruote::Context.new(@storage, self)
+        # must be ready before the storage is created
+        # services like Logger to subscribe to the worker
+
+      @storage = storage
+      @context = Ruote::Context.new(storage, self)
 
       @last_time = Time.at(0.0).utc # 1970...
 
@@ -54,7 +61,7 @@ module Ruote
       @run_thread = nil
 
       @msgs = []
-      @sleep_time = 0.001
+      @sleep_time = 0.000
     end
 
     def run
@@ -66,7 +73,7 @@ module Ruote
 
     def run_in_thread
 
-      #Thread.abort_on_exception = true
+      Thread.abort_on_exception = true
         # TODO : remove me at some point
 
       @running = true
@@ -82,62 +89,40 @@ module Ruote
     def shutdown
 
       @running = false
-      @run_thread.join if @run_thread
+
+      return unless @run_thread
+
+      begin
+        @run_thread.join
+      rescue Exception => e
+      end
     end
 
-    # This method is public, since it's used by the DispatchPool when
-    # reporting an error that occurred in the dispatch/consume thread of
-    # a participant.
+    # Returns true if the engine system is inactive, ie if all the process
+    # instances are terminated or are stuck in an error.
     #
-    def handle_exception (msg, fexp, ex)
-
-      wfid = msg['wfid'] || (msg['fei']['wfid'] rescue nil)
-      fei = msg['fei'] || (fexp.h.fei rescue nil)
-
-      # debug only
-
-      if ARGV.include?('-d')
-
-        puts "\n== worker intercepted error =="
-        puts
-        p ex
-        ex.backtrace[0, 10].each { |l| puts l }
-        puts "..."
-        puts
-        puts "-- msg --"
-        msg.keys.sort.each { |k|
-          puts "    #{k.inspect} =>\n#{msg[k].inspect}"
-        }
-        puts "-- . --"
-        puts
-      end
+    # NOTE : for now, if a branch of a process is in errors while another is
+    # still running, this methods will still consider the process instance
+    # as inactive (and it will return true if all the processes are considered
+    # inactive).
+    #
+    def inactive?
 
-      # on_error ?
+      # the cheaper tests first
 
-      if not(fexp) && fei
-        fexp = Ruote::Exp::FlowExpression.fetch(@context, fei)
-      end
+      return false if @msgs.size > 0
+      return false unless @context.storage.empty?('schedules')
+      return false unless @context.storage.empty?('msgs')
 
-      return if fexp && fexp.handle_on_error
+      wfids = @context.storage.get_many('expressions').collect { |exp|
+        exp['fei']['wfid']
+      }.sort.uniq
 
-      # emit 'msg'
+      error_wfids = @context.storage.get_many('errors').collect { |err|
+        err['fei']['wfid']
+      }.sort.uniq
 
-      @storage.put_msg(
-        'error_intercepted',
-        'message' => ex.inspect,
-        'wfid' => wfid,
-        'msg' => msg)
-
-      # fill error in the error journal
-
-      @storage.put(
-        'type' => 'errors',
-        '_id' => "err_#{Ruote.to_storage_id(fei)}",
-        'message' => ex.inspect,
-        'trace' => ex.backtrace.join("\n"),
-        'fei' => fei,
-        'msg' => msg
-      ) if fei
+      (wfids - error_wfids == [])
     end
 
     protected
@@ -186,14 +171,14 @@ module Ruote
         break if Time.now.utc - @last_time >= 0.8
       end
 
-      #puts processed.to_s
+      #p processed
 
       if processed == 0
         @sleep_time += 0.001
         @sleep_time = 0.499 if @sleep_time > 0.499
         sleep(@sleep_time)
       else
-        @sleep_time = 0.001
+        @sleep_time = 0.000
       end
     end
 
@@ -201,7 +186,7 @@ module Ruote
 
       msg = Ruote.fulldup(schedule['msg'])
 
-      return false unless @storage.delete(schedule).nil?
+      return false unless @storage.reserve(schedule)
 
       @storage.put_msg(msg.delete('action'), msg)
 
@@ -212,7 +197,7 @@ module Ruote
 
       return false if cannot_handle(msg)
 
-      return false unless @storage.delete(msg).nil?
+      return false unless @storage.reserve(msg)
 
       begin
 
@@ -242,9 +227,9 @@ module Ruote
 
         notify(msg)
 
-      rescue Exception => ex
+      rescue Exception => exception
 
-        handle_exception(msg, nil, ex)
+        @context.error_handler.msg_handle(msg, exception)
       end
 
       true
@@ -260,6 +245,10 @@ module Ruote
       end
     end
 
+    # Should always return false. Except when the message is a 'dispatch'
+    # and it's for a participant only available to an 'engine_worker'
+    # (block participants, stateful participants)
+    #
     def cannot_handle (msg)
 
       return false if msg['action'] != 'dispatch'
@@ -322,6 +311,7 @@ module Ruote
       raise_unknown_expression_error(exp_hash) unless exp_class
 
       exp = exp_class.new(@context, exp_hash.merge!('original_tree' => tree))
+
       exp.initial_persist
       exp.do_apply
     end
@@ -357,11 +347,8 @@ module Ruote
         tree[1]['original_ref'] = tree[0] if key != tree[0]
 
         if sub
-
           [ Ruote::Exp::SubprocessExpression, [ 'subprocess', *tree[1..2] ] ]
-
         else
-
           [ Ruote::Exp::ParticipantExpression, [ 'participant', *tree[1..2] ] ]
         end
       else

data/lib/ruote/workitem.rb

@@ -43,13 +43,47 @@ module Ruote
 
       @h = h
       class << @h; include Ruote::HashDot; end
+
+      #class << @h['fields']
+      #  alias_method :__get, :[]
+      #  alias_method :__set, :[]=
+      #  def [] (key)
+      #    __get(key.to_s)
+      #  end
+      #  def []= (key, value)
+      #    __set(key.to_s, value)
+      #  end
+      #end
+        # indifferent access, not activated for now
     end
 
+    # Returns the underlying Hash instance.
+    #
     def to_h
 
       @h
     end
 
+    # Returns the String id for this workitem (something like
+    # "0_0!!20100507-wagamama").
+    #
+    # It's in fact a shortcut for
+    #
+    #   Ruote::FlowExpressionId.to_storage_id(h.fei)
+    #
+    def sid
+
+      Ruote::FlowExpressionId.to_storage_id(h.fei)
+    end
+
+    # Returns the "workflow instance id" (unique process instance id) of
+    # the process instance which issued this workitem.
+    #
+    def wfid
+
+      h.fei['wfid']
+    end
+
     # Returns a Ruote::FlowExpressionId instance.
     #
     def fei
@@ -170,6 +204,36 @@ module Ruote
 
       Ruote.set(@h['fields'], key, value)
     end
+
+    # Shortcut for wi.fields['__timed_out__']
+    #
+    def timed_out
+
+      @h['fields']['__timed_out__']
+    end
+
+    # Shortcut for wi.fields['__error__']
+    #
+    def error
+
+      @h['fields']['__error__']
+    end
+
+    # Shortcut for wi.fields['params']
+    #
+    # When a participant is invoked like in
+    #
+    #    participant :ref => 'toto', :task => 'x"
+    #
+    # then
+    #
+    #    p workitem.params
+    #      # => { 'ref' => 'toto', 'task' => 'x' }
+    #
+    def params
+
+      @h['fields']['params']
+    end
   end
 end
 

data/ruote.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruote}
-  s.version = "2.1.9"
+  s.version = "2.1.10"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Mettraux", "Kenneth Kalmer", "Torsten Schoenebaum"]
-  s.date = %q{2010-03-23}
+  s.date = %q{2010-06-15}
   s.description = %q{
 ruote is an open source ruby workflow engine.
     }
@@ -35,6 +35,7 @@ ruote is an open source ruby workflow engine.
      "lib/ruote/engine.rb",
      "lib/ruote/engine/process_error.rb",
      "lib/ruote/engine/process_status.rb",
+     "lib/ruote/error_handler.rb",
      "lib/ruote/evt/tracker.rb",
      "lib/ruote/exp/command.rb",
      "lib/ruote/exp/commanded.rb",
@@ -79,7 +80,6 @@ ruote is an open source ruby workflow engine.
      "lib/ruote/fei.rb",
      "lib/ruote/id/mnemo_wfid_generator.rb",
      "lib/ruote/id/wfid_generator.rb",
-     "lib/ruote/log/fs_history.rb",
      "lib/ruote/log/storage_history.rb",
      "lib/ruote/log/test_logger.rb",
      "lib/ruote/log/wait_logger.rb",
@@ -131,6 +131,7 @@ ruote is an open source ruby workflow engine.
      "test/functional/base.rb",
      "test/functional/concurrent_base.rb",
      "test/functional/crunner.rb",
+     "test/functional/crunner.sh",
      "test/functional/ct_0_concurrence.rb",
      "test/functional/ct_1_iterator.rb",
      "test/functional/ct_2_cancel.rb",
@@ -189,13 +190,17 @@ ruote is an open source ruby workflow engine.
      "test/functional/ft_2_errors.rb",
      "test/functional/ft_30_smtp_participant.rb",
      "test/functional/ft_31_part_blocking.rb",
-     "test/functional/ft_32_fs_history.rb",
      "test/functional/ft_33_participant_subprocess_priority.rb",
      "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_38_participant_more.rb",
+     "test/functional/ft_39_wait_for.rb",
      "test/functional/ft_3_participant_registration.rb",
+     "test/functional/ft_40_participant_on_reply.rb",
+     "test/functional/ft_41_participants.rb",
+     "test/functional/ft_42_storage_copy.rb",
      "test/functional/ft_4_cancel.rb",
      "test/functional/ft_5_on_error.rb",
      "test/functional/ft_6_on_cancel.rb",
@@ -212,7 +217,7 @@ ruote is an open source ruby workflow engine.
      "test/functional/rtest.rb",
      "test/functional/storage_helper.rb",
      "test/functional/test.rb",
-     "test/mpc_test.rb",
+     "test/functional/vertical.rb",
      "test/path_helper.rb",
      "test/pdef.xml",
      "test/test.rb",
@@ -243,7 +248,7 @@ ruote is an open source ruby workflow engine.
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{ruote}
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.5}
   s.summary = %q{an open source ruby workflow engine}
   s.test_files = [
     "test/test.rb"
@@ -254,8 +259,8 @@ ruote is an open source ruby workflow engine.
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rufus-json>, [">= 0.2.0"])
-      s.add_runtime_dependency(%q<rufus-cloche>, [">= 0.1.16"])
+      s.add_runtime_dependency(%q<rufus-json>, [">= 0.2.2"])
+      s.add_runtime_dependency(%q<rufus-cloche>, [">= 0.1.17"])
       s.add_runtime_dependency(%q<rufus-dollar>, [">= 0"])
       s.add_runtime_dependency(%q<rufus-lru>, [">= 0"])
       s.add_runtime_dependency(%q<rufus-mnemo>, [">= 1.1.0"])
@@ -268,8 +273,8 @@ ruote is an open source ruby workflow engine.
       s.add_development_dependency(%q<mailtrap>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
     else
-      s.add_dependency(%q<rufus-json>, [">= 0.2.0"])
-      s.add_dependency(%q<rufus-cloche>, [">= 0.1.16"])
+      s.add_dependency(%q<rufus-json>, [">= 0.2.2"])
+      s.add_dependency(%q<rufus-cloche>, [">= 0.1.17"])
       s.add_dependency(%q<rufus-dollar>, [">= 0"])
       s.add_dependency(%q<rufus-lru>, [">= 0"])
       s.add_dependency(%q<rufus-mnemo>, [">= 1.1.0"])
@@ -283,8 +288,8 @@ ruote is an open source ruby workflow engine.
       s.add_dependency(%q<jeweler>, [">= 0"])
     end
   else
-    s.add_dependency(%q<rufus-json>, [">= 0.2.0"])
-    s.add_dependency(%q<rufus-cloche>, [">= 0.1.16"])
+    s.add_dependency(%q<rufus-json>, [">= 0.2.2"])
+    s.add_dependency(%q<rufus-cloche>, [">= 0.1.17"])
     s.add_dependency(%q<rufus-dollar>, [">= 0"])
     s.add_dependency(%q<rufus-lru>, [">= 0"])
     s.add_dependency(%q<rufus-mnemo>, [">= 1.1.0"])