ruote 2.1.10 → 2.1.11

data/lib/ruote/log/storage_history.rb

@@ -52,7 +52,7 @@ module Ruote
 
     def by_process (wfid)
 
-      @context.storage.get_many('history', /!#{wfid}$/)
+      @context.storage.get_many('history', wfid)
     end
     alias :by_wfid :by_process
 

data/lib/ruote/log/test_logger.rb

@@ -22,13 +22,15 @@
 # Made in Japan.
 #++
 
-#require 'ruote/util/tree'
+require 'ruote/log/pretty'
 
 
 module Ruote
 
   class TestLogger
 
+    include PrettyLogging
+
     attr_reader :seen
     attr_reader :log
 
@@ -52,20 +54,15 @@ module Ruote
 
       @seen = []
       @log = []
-      @waiting = nil
+      @waiting = []
 
       @count = -1
       @color = 33
       @noisy = false
-
-      # NOTE
-      # in case of troubles, why not have the wait_for has an event ?
     end
 
     def notify (msg)
 
-      #@context.storage.put(event.merge('type' => 'archived_msgs'))
-
       puts(pretty_print(msg)) if @noisy
 
       @seen << msg
@@ -74,13 +71,26 @@ module Ruote
       check_waiting
     end
 
+    # Blocks until one or more interests are satisfied.
+    #
+    # interests must be an array of interests. Please refer to
+    # Engine#wait_for documentation for allowed values of each interest.
+    #
+    # If multiple interests are given, wait_for blocks until
+    # all of the interests are satisfied.
+    #
+    # wait_for may only be used by one thread at a time. If one
+    # thread calls wait_for and later another thread calls wait_for
+    # while the first thread is waiting, the first thread's
+    # interests are lost and the first thread will never wake up.
+    #
     def wait_for (interests)
 
-      @waiting = [ Thread.current, interests ]
+      @waiting << [ Thread.current, interests ]
 
       check_waiting
 
-      Thread.stop if @waiting
+      Thread.stop if @waiting.find { |w| w.first == Thread.current }
 
       # and when this thread gets woken up, go on and return __result__
 
@@ -109,39 +119,52 @@ module Ruote
 
     def check_waiting
 
-      return unless @waiting
+      return if @waiting.size < 1
 
       while msg = @seen.shift
-
-        break if check_msg(msg)
+        check_msg(msg)
       end
     end
 
     def check_msg (msg)
 
-      if check_interest(msg)
+      wakeup = []
 
-        thread = @waiting.first
-        @waiting = nil
-        thread['__result__'] = msg
-        thread.wakeup
+      @waiting.each do |thread, interests|
 
-        true
-      else
+        wakeup << thread if matches(interests, msg)
+      end
 
-        false
+      @waiting.delete_if { |t, i| i.size < 1 }
+
+      wakeup.each do |thread|
+
+        thread['__result__'] = msg
+        thread.wakeup
       end
     end
 
     FINAL_ACTIONS = %w[ terminated ceased error_intercepted ]
 
-    def check_interest (msg)
+    # Checks whether message msg matches any of interests being waited for.
+    #
+    # Some interests look for actions on particular workflows (e.g.,
+    # waiting for some workflow to finish). Other interests are not
+    # attached to any particular workflow (e.g., :inactive waits until
+    # the engine finishes processing all active and pending workflows)
+    # but are still satisfied when actions happen on workflows (e.g.,
+    # the last workflow being run finishes).
+    #
+    # Returns true if all interests being waited for have been satisfied,
+    # false otherwise.
+    #
+    def matches (interests, msg)
 
       action = msg['action']
 
-      @waiting.last.each do |interest|
+      interests.each do |interest|
 
-        satisfied =  if interest == :inactive
+        satisfied = if interest == :inactive
 
           (FINAL_ACTIONS.include?(action) && @context.worker.inactive?)
 
@@ -155,9 +178,10 @@ module Ruote
 
         elsif interest.is_a?(Fixnum)
 
-          @waiting[-1] = @waiting[-1] - [ interest ]
+          interests.delete(interest)
+
           if (interest > 1)
-            @waiting[-1] << (interest - 1)
+            interests << (interest - 1)
             false
           else
             true
@@ -168,109 +192,10 @@ module Ruote
           (FINAL_ACTIONS.include?(action) && msg['wfid'] == interest)
         end
 
-        @waiting[-1] = @waiting[-1] - [ interest ] if satisfied
-      end
-
-      @waiting.last.size < 1
-    end
-
-    # <ESC>[{attr1};...;{attrn}m
-    #
-    # 0 Reset all attributes
-    # 1 Bright
-    # 2 Dim
-    # 4 Underscore
-    # 5 Blink
-    # 7 Reverse
-    # 8 Hidden
-    #
-    # Foreground Colours
-    # 30 Black
-    # 31 Red
-    # 32 Green
-    # 33 Yellow
-    # 34 Blue
-    # 35 Magenta
-    # 36 Cyan
-    # 37 White
-    #
-    # Background Colours
-    # 40 Black
-    # 41 Red
-    # 42 Green
-    # 43 Yellow
-    # 44 Blue
-    # 45 Magenta
-    # 46 Cyan
-    # 47 White
-
-    def color (mod, s, clear=false)
-
-      return s if Ruote::WIN
-      return s unless STDOUT.tty?
-
-      "[#{mod}m#{s}#{clear ? '' : "[#{@color}m"}"
-    end
-
-    def pretty_print (msg)
-
-      @count += 1
-      @count = 0 if @count > 9
-
-      ei = self.object_id.to_s[-2..-1]
-
-      fei = msg['fei']
-      depth = fei ? fei['expid'].split('_').size : 0
-
-      i = fei ?
-        [ fei['wfid'], fei['sub_wfid'], fei['expid'] ].join(' ') :
-        msg['wfid']
-
-      rest = msg.dup
-      %w[
-        _id put_at _rev
-        type action
-        fei wfid variables
-      ].each { |k| rest.delete(k) }
-
-      if v = rest['parent_id']
-        rest['parent_id'] = Ruote.to_storage_id(v)
-      end
-      if v = rest.delete('workitem')
-        rest[:wi] = [
-          v['fei'] ? Ruote.to_storage_id(v['fei']) : nil,
-          v['fields'].size ]
-      end
-
-      { 'tree' => :t, 'parent_id' => :pi }.each do |k0, k1|
-        if v = rest.delete(k0)
-          rest[k1] = v
-        end
-      end
-
-      action = msg['action'][0, 2]
-      action = case msg['action']
-        when 'receive' then 'rc'
-        when 'dispatched' then 'dd'
-        when 'dispatch_cancel' then 'dc'
-        else action
-      end
-      action = case action
-        when 'la' then color('4;32', action)
-        when 'te' then color('4;31', action)
-        when 'ce' then color('31', action)
-        when 'ca' then color('31', action)
-        when 'rc' then color('4;33', action)
-        when 'di' then color('4;33', action)
-        when 'dd' then color('4;33', action)
-        when 'dc' then color('4;31', action)
-        else action
+        interests.delete(interest) if satisfied
       end
 
-      color(
-        @color,
-        "#{@count} #{ei} #{'  ' * depth}#{action} * #{i} #{rest.inspect}",
-        true)
+      interests.size < 1
     end
   end
 end

data/lib/ruote/log/wait_logger.rb

@@ -37,33 +37,28 @@ module Ruote
     def initialize (context)
 
       @context = context
-      @waiting = nil
       @color = 33
 
       @context.worker.subscribe(:all, self) if @context.worker
 
       @noisy = false
       @count = -1
+
+      @seen = []
+      @waiting = []
     end
 
     def notify (msg)
 
       puts(pretty_print(msg)) if @noisy
 
-      return unless @waiting
-
-      check_msg(msg)
-    end
-
-    def wait_for (interests)
-
-      @waiting = [ Thread.current, interests ]
-
-      Thread.stop
+      #return if @waiting.size < 1
+      #check_msg(msg)
 
-      # and when this thread gets woken up, go on and return __result__
+      @seen << msg
+      @seen.shift if @seen.size > 147
 
-      Thread.current['__result__']
+      check_waiting
     end
   end
 end

data/lib/ruote/parser/ruby_dsl.rb

@@ -22,6 +22,8 @@
 # Made in Japan.
 #++
 
+require 'ruote/util/ometa'
+
 
 module Ruote
 
@@ -94,7 +96,7 @@ module Ruote
   #
   module RubyDsl
 
-    class BranchContext
+    class BranchContext < Ruote::BlankSlate
 
       def initialize (name, attributes)
 
@@ -117,9 +119,7 @@ module Ruote
 
     def self.create_branch (name, attributes, &block)
 
-      while name[0, 1] == '_'
-        name = name[1..-1]
-      end
+      name = name[1..-1] while name[0, 1] == '_'
 
       h = attributes.inject({}) { |h1, a|
         a.is_a?(Hash) ? h1.merge!(a) : h1[a] = nil

data/lib/ruote/parser.rb

@@ -55,7 +55,7 @@ module Ruote
       (return Rufus::Json.decode(definition)) rescue nil
       (return ruby_eval(definition)) rescue nil
 
-      if definition.index("\n") == nil
+      if definition.index("\n").nil? && definition.index(' ').nil?
 
         raise ArgumentError.new(
           "remote process definitions are not allowed"
@@ -77,7 +77,7 @@ module Ruote
       unless @parser
 
         require 'ostruct'
-        require 'ruote/util/treechecker'
+        require 'ruote/svc/treechecker'
 
         @parser = Ruote::Parser.new(
           OpenStruct.new('treechecker' => Ruote::TreeChecker.new({})))

data/lib/ruote/part/block_participant.rb

@@ -45,7 +45,7 @@ module Ruote
   #   end
   #
   #
-  # == do_not_thead
+  # == do_not_thread
   #
   # By default, this participant (like most other participants) is executed
   # in its own thread (in a Ruby runtime where EventMachine is running,

data/lib/ruote/part/engine_participant.rb

@@ -22,7 +22,7 @@
 # Made in Singapore.
 #++
 
-require 'ruote/subprocess'
+require 'ruote/util/subprocess'
 require 'ruote/part/local_participant'
 
 

data/lib/ruote/part/storage_participant.rb

@@ -138,7 +138,7 @@ module Ruote
     #
     def size
 
-      fetch_all.size
+      fetch_all(:count => true)
     end
 
     # Iterates over the workitems stored in here.
@@ -150,9 +150,9 @@ module Ruote
 
     # Returns all the workitems stored in here.
     #
-    def all
+    def all (opts={})
 
-      fetch_all.map { |hwi| Ruote::Workitem.new(hwi) }
+      fetch_all(opts).map { |hwi| Ruote::Workitem.new(hwi) }
     end
 
     # A convenience method (especially when testing), returns the first
@@ -169,22 +169,24 @@ module Ruote
     #
     def by_wfid (wfid)
 
-      @context.storage.get_many('workitems', /!#{wfid}$/).map { |hwi|
+      @context.storage.get_many('workitems', wfid).collect { |hwi|
         Ruote::Workitem.new(hwi)
       }
     end
 
     # Returns all workitems for the specified participant name
     #
-    def by_participant (participant_name)
+    def by_participant (participant_name, opts={})
 
       hwis = if @context.storage.respond_to?(:by_participant)
 
-        @context.storage.by_participant('workitems', participant_name)
+        @context.storage.by_participant('workitems', participant_name, opts)
 
       else
 
-        fetch_all.select { |wi| wi['participant_name'] == participant_name }
+        fetch_all(opts).select { |wi|
+          wi['participant_name'] == participant_name
+        }
       end
 
       hwis.collect { |hwi| Ruote::Workitem.new(hwi) }
@@ -230,7 +232,7 @@ module Ruote
     # constraints for fields.
     #
     # 'offset' and 'limit' are reserved as well. They should prove useful
-    # for pagination.
+    # for pagination. 'skip' can be used instead of 'offset'.
     #
     # Note : the criteria is AND only, you'll have to do ORs (aggregation)
     # by yourself.
@@ -239,32 +241,28 @@ module Ruote
 
       cr = criteria.inject({}) { |h, (k, v)| h[k.to_s] = v; h }
 
-      return @context.storage.query_workitems(cr).collect { |h|
-        Ruote::Workitem.new(h)
-      } if @context.storage.respond_to?(:query_workitems)
+      if @context.storage.respond_to?(:query_workitems)
+        return @context.storage.query_workitems(cr)
+      end
 
-      offset = cr.delete('offset')
-      limit = cr.delete('limit')
+      opts = {}
+      opts[:skip] = cr.delete('offset') || cr.delete('skip')
+      opts[:limit] = cr.delete('limit')
+      opts[:count] = cr.delete('count')
 
       wfid = cr.delete('wfid')
       pname = cr.delete('participant_name') || cr.delete('participant')
 
-      hwis = if wfid
-        @context.storage.get_many('workitems', /!#{wfid}$/)
-      else
-        fetch_all
-      end
+      hwis = wfid ?
+        @context.storage.get_many('workitems', wfid, opts) : fetch_all(opts)
 
-      hwis = hwis.select { |hwi|
+      return hwis if opts[:count]
+
+      hwis.select { |hwi|
         Ruote::StorageParticipant.matches?(hwi, pname, cr)
       }.collect { |hwi|
         Ruote::Workitem.new(hwi)
       }
-
-      offset = offset || 0
-      limit = limit || hwis.length
-
-      hwis[offset, limit]
     end
 
     # Cleans this participant out completely
@@ -294,11 +292,12 @@ module Ruote
     # Fetches all the workitems. If there is a @store_name, will only fetch
     # the workitems in that store.
     #
-    def fetch_all
-
-      key = @store_name ? /^wi!#{@store_name}::/ : nil
+    def fetch_all (opts={})
 
-      @context.storage.get_many('workitems', key)
+      @context.storage.get_many(
+        'workitems',
+        @store_name ? /^wi!#{@store_name}::/ : nil,
+        opts)
     end
 
     # Computes the id for the document representing the document in the storage.

data/lib/ruote/part/template.rb

@@ -23,7 +23,6 @@
 #++
 
 require 'rufus/json'
-require 'ruote/util/dollar'
 
 
 module Ruote
@@ -34,8 +33,14 @@ module Ruote
   # (Currently only used by the SmtpParticipant, could prove useful for
   # custom participants)
   #
+  # This module expects to find the ruote @context available (probably
+  # accessible thanks to the Ruote::LocalParticipant module, see
+  # Ruote::SmtpParticipant as an example).
+  #
   module TemplateMixin
 
+    # Do the rendering.
+    #
     def render_template (template, flow_expression, workitem)
 
       template = (File.read(template) rescue nil) if is_a_file?(template)
@@ -45,7 +50,7 @@ module Ruote
       template = template.to_s
       workitem = workitem.to_h if workitem.respond_to?(:to_h)
 
-      Ruote.dosub(template, flow_expression, workitem)
+      @context.dollar_sub.s(template, flow_expression, workitem)
     end
 
     # Simply returns a pretty-printed view of the workitem
@@ -57,7 +62,7 @@ module Ruote
       s = []
       s << "workitem for #{workitem['participant_name']}"
       s << ''
-      s << Rufus::Json.encode(workitem['fei'])
+      s << Rufus::Json.pretty_encode(workitem['fei'])
       s << ''
       workitem['fields'].keys.sort.each do |key|
         s << " - '#{key}'  ==>  #{Rufus::Json.encode(workitem['fields'][key])}"

data/lib/ruote/receiver/base.rb

@@ -55,6 +55,14 @@ module Ruote
     # This method is mostly used from the Ruote::Engine class (which includes
     # this mixin).
     #
+    # process_definition must be a result of Ruote.process_definition call
+    # or XML or JSON serialized process definition, as accepted by
+    # Ruote::Parser#parse.
+    #
+    # fields are workflow parameters that will be placed in workitem.fields.
+    #
+    # variables contain engine variables.
+    #
     def launch (process_definition, fields={}, variables={})
 
       wfid = @context.wfidgen.generate
@@ -98,16 +106,26 @@ module Ruote
       self.class.to_s
     end
 
-    protected
-
-    # Convenience method, fetches the flow expression (ParticipantExpression)
-    # that emitted that workitem.
+    # Convenience method, given a workitem or a fei, returns the
+    # corresponding flow expession.
     #
-    def fetch_flow_expression (workitem)
+    def fetch_flow_expression (workitem_or_fei)
 
-      Ruote::Exp::FlowExpression.fetch(@context, workitem.fei.to_h)
+      Ruote::Exp::FlowExpression.fetch(
+        @context,
+        Ruote::FlowExpressionId.extract_h(workitem_or_fei))
     end
 
+    # For example :
+    #
+    #   fexp = engine.fexp(fei)
+    #     # or
+    #   fexp = engine.fexp(workitem)
+    #
+    alias fexp fetch_flow_expression
+
+    protected
+
     # Stashes values in the participant expression (in the storage).
     #
     #   put(workitem.fei, 'key' => 'value', 'colour' => 'blue')