ruote 2.3.0.1 → 2.3.0.2

data/lib/ruote/dboard/process_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/dboard/process_status.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
@@ -140,9 +140,9 @@ module Ruote
 
       return nil if @expressions.empty?
 
-      @expressions.each_with_object({}) do |exp, h|
+      @expressions.each_with_object({}) { |exp, h|
         h[exp.fei] = exp.variables if exp.variables
-      end
+      }
     end
 
     # Returns a hash tagname => fei of tags set at the root of the process
@@ -152,11 +152,7 @@ module Ruote
     #
     def tags
 
-      if variables
-        Hash[variables.select { |k, v| FlowExpressionId.is_a_fei?(v) }]
-      else
-        nil
-      end
+      variables ? Hash[variables.select { |k, v| Ruote.is_a_fei?(v) }] : nil
     end
 
     # Returns a hash tagname => array of feis of all the tags set in the process
@@ -165,7 +161,7 @@ module Ruote
     def all_tags
 
       all_variables.remap do |(fei, vars), h|
-        vars.each { |k, v| (h[k] ||= []) << v if FlowExpressionId.is_a_fei?(v) }
+        vars.each { |k, v| (h[k] ||= []) << v if Ruote.is_a_fei?(v) }
       end
     end
 
@@ -380,6 +376,7 @@ module Ruote
       vars = variables rescue nil
       avars = (all_variables || {}).remap { |(k, v), h| h[Ruote.sid(k)] = v }
 
+
       s = [ "== #{self.class} ==" ]
       s << ''
       s << "  wfid:           #{wfid}"
@@ -388,9 +385,15 @@ module Ruote
       s << "  last_active:    #{last_active}"
       s << "  launched_time:  #{launched_time}"
       s << ''
+
       s << "  expressions: #{@expressions.size}"
       s << ''
       @expressions.each do |e|
+
+        eflags = %w[
+          flanking forgotten attached
+        ].each_with_object([]) { |f, a| a << f if e.h[f] }
+
         s << "     #{e.fei.to_storage_id}"
         s << "       | #{e.name}"
         s << "       | _rev: #{e.h._rev.inspect}"
@@ -400,9 +403,11 @@ module Ruote
           s << "       | . child-> #{Ruote.sid(ce)}"
         end if e.children.any?
         s << "       | timers: #{e.h.timers.collect { |t| t[1] }}" if e.h.timers
-        s << "       | (flanking)" if e.h.flanking
+        s << "       | tagname: #{e.h.tagname}" if e.h.tagname
+        s << "       | (#{eflags.join(', ')})" if eflags.any?
         s << "       `-parent--> #{e.h.parent_id ? e.parent_id.to_storage_id : 'nil'}"
       end
+
       s << ''
       s << "  schedules: #{@schedules.size}"
       if @schedules.size > 0
@@ -414,6 +419,7 @@ module Ruote
         end
         s << ''
       end
+
       s << "  stored workitems: #{@stored_workitems.size}"
 
       s << ''
@@ -494,32 +500,45 @@ module Ruote
     # Returns nil if there are no expressions (happens in the case of an
     # orphan workitem)
     #
-    def current_tree
-
-      return nil if @expressions.empty?
-
-      h = Ruote.decompose_tree(original_tree)
-
-      @expressions.sort { |e0, e1|
-
-        e0.fei.expid <=> e1.fei.expid
-
-      }.each { |e|
-
-        trigger = e.tree[1]['_triggered']
-
-        tree = if trigger && trigger != 'on_re_apply'
-          t = original_tree_from_parent(e).dup
-          t[1]['_triggered'] = trigger
-          t
-        else
-          e.tree
-        end
-
-        h.merge!(Ruote.decompose_tree(tree, e.fei.expid))
-      }
+    def current_tree(fexp=root_expression)
+
+      return nil unless fexp
+
+      t = Ruote.fulldup(fexp.tree)
+
+      fexp.children.each do |cfei|
+
+        cexp = fexp(cfei)
+        next unless cexp
+
+        ct = current_tree(cexp)
+
+        #trigger = ct[1]['_triggered']
+        #if trigger && trigger != 'on_re_apply'
+        #    #
+        #  # ignore any on_cancel / on_error / ...
+        #  #
+        #  #ct = t[2][cexp.child_id]
+        #  # loses any change in the re_applied tree
+        #    #
+        #  # just flag the original tree as _triggered
+        #  # loses any change in the re_applied tree
+        #  #
+        #  #ct = t[2][cexp.child_id]
+        #  #ct[1]['_triggered'] = trigger
+        #    #
+        #  # extracts the new tree, discards the layers around it
+        #  #
+        #  ot = t[2][cexp.child_id]
+        #  ct = ct[2][0][2][0]
+        #  ct[1]['_triggered'] = [ trigger, ot[1][trigger] ].join('/')
+        #end
+          # return the real current tree, do not tweak with it!
+
+        t[2][cexp.child_id] = ct
+      end
 
-      Ruote.recompose_tree(h)
+      t
     end
 
     # Used by Ruote::Dashboard#process and #processes
@@ -566,21 +585,15 @@ module Ruote
       }.compact
     end
 
-    #--
-    #def self.from_h(h)
-    #  self.new(
-    #    nil,
-    #    *%w[ expressions workitems errors schedules trackers ].map { |k| h[k] })
-    #end
-    #++
-
-    protected
-
-    def original_tree_from_parent(e)
+    # Given a fei, returns the flow expression with that fei (only looks
+    # in the expressions stored here, in this ProcessStatus instance, doesn't
+    # query the storage).
+    #
+    def fexp(fei)
 
-      parent = @expressions.find { |exp| exp.fei == e.parent_id }
+      fei = Ruote.extract_fei(fei)
 
-      parent ? parent.tree[2][e.fei.child_id] : e.tree
+      @expressions.find { |e| e.fei == fei }
     end
   end
 end

data/lib/ruote/engine.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/command.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/commanded.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/condition.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
@@ -37,6 +37,7 @@ module Ruote::Exp
     class ConditionError < RuntimeError
 
       def initialize(code)
+
         super(
           "couldn't interpret >#{code}<, " +
           "if it comes from a ${xx} construct, please use ${\"xx} or ${'yy}")

data/lib/ruote/exp/fe_add_branches.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_apply.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_await.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
@@ -212,49 +212,59 @@ module Ruote::Exp
   # Note: the :where guard is always about the event's workitem (not the
   # workitem as it reached the 'await' expression).
   #
+  #
+  # == note: the "await" attribute
+  #
+  # (since ruote 3.2.1)
+  #
+  # "listen" and "await" are both ruote expressions. There is also an
+  # attribute common to all the expressions: :await.
+  #
+  #   concurrence do
+  #     sequence do
+  #       alice
+  #       sequence :tag => 'stage2' do
+  #         bob
+  #       end
+  #     end
+  #     sequence do
+  #       charly
+  #       diana :await => 'left_tag:stage2'
+  #       eliza
+  #     end
+  #     frank
+  #   end
+  #
+  # The expressions with an await attribute suspends its application until
+  # the awaited event happens.
+  #
+  # This await attribute, defaults to "left_tag:", so
+  #
+  #   diana :await => 'stage2'
+  #     # is equivalent to
+  #   diana :await => 'left_tag:stage2'
+  #
   class AwaitExpression < FlowExpression
 
     names :await
 
-    INS = %w[ in entered reached]
-    OUTS = %w[ out left ]
-
-    SPLIT_R = /^(#{(INS + OUTS).join('|')})_(tag|participant)s?$/
-    SINGLE_R = /^(tag)s|(participant|error)s?$/ # not 'tag' alone
-
     def apply
 
       #
       # gathering info
 
-      direction, type, value = attributes.collect { |k, v|
-        if m = SPLIT_R.match(k)
-          [ m[1], m[2], v ]
-        elsif m = SINGLE_R.match(k)
-          [ 'in', m[1] || m[2], v ]
-        else
-          nil
-        end
-      }.compact.first
+      action, condition = self.class.extract_await_ac(attributes)
 
       raise ArgumentError.new(
         "couldn't determine which event to listen to from: " +
         attributes.inspect
-      ) unless direction
+      ) unless action
 
       global = (attribute(:global).to_s == 'true')
-      global = false if type == 'error'
+      global = false if action == 'error_intercepted'
 
       h.amerge = attribute(:merge).to_s
 
-      action = if type == 'tag'
-        INS.include?(direction) ? 'entered_tag' : 'left_tag'
-      elsif type == 'participant'
-        INS.include?(direction) ? 'dispatch' : 'receive'
-      else # error
-        'error_intercepted'
-      end
-
       persist_or_raise
 
       #
@@ -264,7 +274,7 @@ module Ruote::Exp
         global ? nil : h.fei['wfid'],
         action,
         Ruote.to_storage_id(h.fei),
-        determine_condition(type, value),
+        condition,
         { 'action' => 'reply',
           'fei' => h.fei,
           'workitem' => 'replace',
@@ -284,12 +294,13 @@ module Ruote::Exp
 
       wi = h.applied_workitem.dup
 
-      wi['fields'] = case h.amerge
-        when 'ignore', 'drop' then wi['fields']
-        when 'incoming' then wi['fields'].merge(workitem['fields'])
-        when 'awaiting' then workitem['fields'].merge(wi['fields'])
-        else workitem['fields'] # 'override'
-      end
+      wi['fields'] =
+        case h.amerge
+          when 'ignore', 'drop' then wi['fields']
+          when 'incoming' then wi['fields'].merge(workitem['fields'])
+          when 'awaiting' then workitem['fields'].merge(wi['fields'])
+          else workitem['fields'] # 'override'
+        end
 
       #
       # actual trigger
@@ -323,34 +334,72 @@ module Ruote::Exp
       super(workitem)
     end
 
-    # Matches Ruby class names, like "Ruote::ForcedError" or "::ArgumentError"
-    #
-    KLASS_R = /^(::)?([A-Z][a-z]+)+(::([A-Z][a-z]+)+)*$/
+    INS = %w[ in entered reached ]
+    OUTS = %w[ out left ]
+
+    SPLIT_R =
+      /^(?:(#{(INS + OUTS).join('|')})_)?(tag|participant|error)s?$/
+
+    # attribute wait regex
+    AAWAIT_R =
+      /^(?:(#{(INS + OUTS).join('|')})_)?(tag|participant)s?\s*:\s*(.+)$/
+
+    # matches Ruby class names, like "Ruote::ForcedError" or "::ArgumentError"
+    KLASS_R =
+      /^(::)?([A-Z][a-z]+)+(::([A-Z][a-z]+)+)*$/
 
-    # Builds the condition used by the tracker service to filter msgs.
+    # Made into a class method, so that the :await common attribute can
+    # use it when parsing :await...
     #
-    def determine_condition(type, value)
+    def self.extract_await_ac(atts)
+
+      direction, type, value =
+        atts.collect { |k, v|
+          if k == :await && m = AAWAIT_R.match(v)
+            [ m[1] || 'in', m[2], m[3] ]
+          elsif k == :await && v.index(':').nil?
+            [ 'left', 'tag', v ]
+          elsif m = SPLIT_R.match(k)
+            [ m[1] || 'in', m[2], v ]
+          else
+            nil
+          end
+        }.compact.first
+
+      return nil if direction == nil
+
+      action =
+        if type == 'tag'
+          INS.include?(direction) ? 'entered_tag' : 'left_tag'
+        elsif type == 'participant'
+          INS.include?(direction) ? 'dispatch' : 'receive'
+        else # error
+          'error_intercepted'
+        end
 
       value = Ruote.comma_split(value)
 
-      if type == 'participant'
+      condition =
+        if type == 'participant'
 
-        { 'participant_name' => value }
+          { 'participant_name' => value }
 
-      elsif type == 'error'
+        elsif type == 'error'
 
-        # array or comma string or string ?
+          # array or comma string or string ?
 
-        h = { 'class' => [], 'message' => [] }
+          h = { 'class' => [], 'message' => [] }
 
-        value.each { |e| (KLASS_R.match(e) ? h['class'] : h['message']) << e }
+          value.each { |e| (KLASS_R.match(e) ? h['class'] : h['message']) << e }
 
-        h.delete_if { |k, v| v == nil or v == [] }
+          h.delete_if { |k, v| v == nil or v == [] }
 
-      else # 'tag'
+        else # 'tag'
 
-        { (value.first.to_s.match(/\//) ? 'full_tag' : 'tag') => value }
-      end
+          { (value.first.to_s.match(/\//) ? 'full_tag' : 'tag') => value }
+        end
+
+      [ action, condition ]
     end
   end
 end