ruote 2.3.0.1 → 2.3.0.2

data/lib/ruote/fei.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
@@ -25,6 +25,7 @@
 require 'digest/md5'
 
 require 'ruote/version'
+require 'ruote/extract'
 require 'ruote/workitem'
 require 'ruote/util/misc'
 require 'ruote/util/hashdot'
@@ -32,63 +33,6 @@ require 'ruote/util/hashdot'
 
 module Ruote
 
-  # A shortcut for
-  #
-  #   Ruote::FlowExpressionId.to_storage_id(fei)
-  #
-  def self.to_storage_id(fei)
-
-    Ruote::FlowExpressionId.to_storage_id(fei)
-  end
-
-  # A shorter shortcut for
-  #
-  #   Ruote::FlowExpressionId.to_storage_id(fei)
-  #
-  def self.sid(fei)
-
-    Ruote::FlowExpressionId.to_storage_id(fei)
-  end
-
-  # A shortcut for
-  #
-  #   Ruote::FlowExpressionId.is_a_fei?(o)
-  #
-  def self.is_a_fei?(o)
-
-    Ruote::FlowExpressionId.is_a_fei?(o)
-  end
-
-  # Will do its best to return a wfid (String) or a fei (Hash instance)
-  # extract from the given o argument.
-  #
-  def self.extract_id(o)
-
-    return o if o.is_a?(String) and o.index('!').nil? # wfid
-
-    Ruote::FlowExpressionId.extract_h(o)
-  end
-
-  # Given something, tries to return the fei (Ruote::FlowExpressionId) in it.
-  #
-  def self.extract_fei(o)
-
-    Ruote::FlowExpressionId.extract(o)
-  end
-
-  # Given an object, will return the wfid (workflow instance id) nested into
-  # it (or nil if it can't find or doesn't know how to find).
-  #
-  # The wfid is a String instance.
-  #
-  def self.extract_wfid(o)
-
-    return o.strip == '' ? nil : o if o.is_a?(String)
-    return o.wfid if o.respond_to?(:wfid)
-    return o['wfid'] || o.fetch('fei', {})['wfid'] if o.respond_to?(:[])
-    nil
-  end
-
   # This function is used to generate the subids. Each flow
   # expression receives such an id (it's useful for cursors, loops and
   # forgotten branches).
@@ -162,11 +106,13 @@ module Ruote
 
     def self.to_storage_id(hfei)
 
-      hfei.respond_to?(:to_storage_id) ?
-        hfei.to_storage_id :
-        "#{hfei['expid']}!#{hfei['subid'] || hfei['sub_wfid']}!#{hfei['wfid']}"
-
       # TODO : for 2.1.13, remove the subid || sub_wfid trick
+
+      if hfei.respond_to?(:to_storage_id)
+        hfei.to_storage_id
+      else
+        "#{hfei['expid']}!#{hfei['subid'] || hfei['sub_wfid']}!#{hfei['wfid']}"
+      end
     end
 
     # Turns the result of to_storage_id back to a FlowExpressionId instance.
@@ -217,16 +163,6 @@ module Ruote
 
     alias eql? ==
 
-    SUBS = %w[ subid sub_wfid ]
-    IDS = %w[ engine_id expid wfid ]
-
-    # Returns true if the h is a representation of a FlowExpressionId instance.
-    #
-    def self.is_a_fei?(h)
-
-      h.respond_to?(:keys) && (h.keys - SUBS).sort == IDS
-    end
-
     # Returns child_id... For an expid of '0_1_4', this will be 4.
     #
     def self.child_id(h)
@@ -285,7 +221,8 @@ module Ruote
           'engine_id' => ss[-4] || 'engine',
           'expid' => ss[-3],
           'subid' => ss[-2],
-          'wfid' => ss[-1] }
+          'wfid' => ss[-1]
+        }
       end
 
       raise ArgumentError.new(

data/lib/ruote/id/mnemo_wfid_generator.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/id/wfid_generator.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/log/default_history.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
@@ -33,12 +33,14 @@ module Ruote
   #
   # NOTE:
   #
-  # this default history is worthless when there are multiple workers.
+  # This default history is worthless when there are multiple workers.
   # It only keeps track of the msgs processed by the worker in the same
   # context. Msgs processed by other workers (in different Ruby runtimes) are
   # not seen (they are tracked by the DefaultHistory next to those workers).
   #
   # By default, this history keeps track of the latest 1'000 msgs.
+  # This can be changed by passing a 'history_max_size' option to the storage
+  # when initializing ruote ('history_max_size' => 0) is acceptable.
   #
   class DefaultHistory
 
@@ -52,6 +54,8 @@ module Ruote
       @context = context
       @options = options
 
+      @max_size = context['history_max_size'] || DEFAULT_MAX_SIZE
+
       @history = []
     end
 
@@ -122,14 +126,24 @@ module Ruote
     #
     def on_msg(msg)
 
+      return if @max_size < 1
+
       msg = Ruote.fulldup(msg)
       msg['seen_at'] = Ruote.now_to_utc_s
 
       @history << msg
 
-      while (@history.size > (@options[:max_size] || DEFAULT_MAX_SIZE)) do
+      while (@history.size > @max_size) do
         @history.shift
       end
+
+    rescue => e
+
+      $stderr.puts '>' + '-' * 79
+      $stderr.puts "#{self.class} issue, skipping"
+      $stderr.puts e.inspect
+      $stderr.puts e.backtrace[0, 2]
+      $stderr.puts '<' + '-' * 79
     end
   end
 end

data/lib/ruote/log/fancy_printing.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
@@ -77,29 +77,6 @@ class Ruote::WaitLogger
     ].join('!')
   end
 
-  def insp(o, opts={})
-
-    case o
-      when nil
-        'nil'
-      when Hash
-        trim = opts[:trim] || []
-        '{' +
-        o.reject { |k, v|
-          v.nil? && trim.include?(k.to_s)
-        }.collect { |k, v|
-          "#{k}: #{insp(v)}"
-        }.join(', ') +
-        '}'
-      when Array
-        '[' + o.collect { |e| insp(e) }.join(', ') + ']'
-      when String
-        o.match(/\s/) ? o.inspect : o
-      else
-        o.inspect
-    end
-  end
-
   def radial_tree(msg)
 
     _, t = Ruote::Exp::DefineExpression.reorganize(msg['tree'])
@@ -117,10 +94,13 @@ class Ruote::WaitLogger
 
     @count = (@count + 1) % 10
 
-    ei = [
-      self.object_id.to_s[-2..-1],
-      Thread.current['worker_name'].to_s[0, 2]
-    ].join(':')
+    wo = Ruote.current_worker
+    woi = [ wo.object_id.to_s[-2..-1] ]
+    if wo.class != Ruote::Worker || wo.name != 'worker'
+      woi << wo.class.name.split('::').last[0, 2]
+      woi << wo.name[0, 2]
+    end
+    woi = woi.join(':')
 
     fei = msg['fei']
     depth = fei ? fei['expid'].split('_').size : 0
@@ -210,7 +190,7 @@ class Ruote::WaitLogger
       #
       # display backtraces
 
-      rst = insp(
+      rst = Ruote.insp(
         rest.reject { |k, v| %w[ error msg ].include?(k) },
         :trim => %[ updated_tree ])[1..-2]
 
@@ -225,7 +205,7 @@ class Ruote::WaitLogger
 
       color(
         @color,
-        "#{@count} #{tm} #{ei} #{'  ' * depth}#{act} * #{i} #{rst}",
+        "#{@count} #{tm} #{woi} #{'  ' * depth}#{act} * #{i} #{rst}",
         true
       ) +
       "\n" +
@@ -244,11 +224,11 @@ class Ruote::WaitLogger
         ''
       end
 
-      rest = insp(rest, :trim => %[ updated_tree ])[1..-2]
+      rest = Ruote.insp(rest, :trim => %[ updated_tree ])[1..-2]
 
       color(
         @color,
-        "#{@count} #{tm} #{ei} #{'  ' * depth}#{act} * #{i} #{pa}#{rest}",
+        "#{@count} #{tm} #{woi} #{'  ' * depth}#{act} * #{i} #{pa}#{rest}",
         true)
     end
 

data/lib/ruote/log/storage_history.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/log/wait_logger.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
@@ -38,7 +38,7 @@ module Ruote
   #
   # The logic behind Ruote::Dashboard#wait_for is implemented here.
   #
-  # This logger keeps track of the last 147 events. This number can
+  # This logger keeps track of the last 56 events. This number can
   # be tweaked via the 'wait_logger_max' storage option
   # (http://ruote.rubyforge.org/configuration.html)
   #
@@ -51,7 +51,7 @@ module Ruote
   # === options (storage initialization options)
   #
   # wait_logger_max(Integer)::
-  #   defaults to 147, max number of recent records to keep track of
+  #   defaults to 77, max number of recent records to keep track of
   # wait_logger_timeout(Integer)::
   #   defaults to 60 (seconds), #wait_for times out after how many seconds?
   #
@@ -84,7 +84,7 @@ module Ruote
       @color = 33
       @noisy = false
 
-      @log_max = context['wait_logger_max'] || 147
+      @log_max = context['wait_logger_max'] || 77
       @timeout = context['wait_logger_timeout'] || 60 # in seconds
 
       @check_mutex = Mutex.new
@@ -178,8 +178,12 @@ module Ruote
       while @waiting.any? and msg = @seen.shift
 
         @waiting.delete_if do |thread, interests|
-          thread['__result__'] = msg if matches(interests, msg)
-          (interests.size < 1)
+          if matches(interests, msg)
+            thread['__result__'] = msg
+            true
+          else
+            false
+          end
         end
       end
     end
@@ -267,7 +271,11 @@ module Ruote
         interests.delete(interest) if satisfied
       end
 
-      (interests.size < 1)
+      if interests.include?(:or_error)
+        (interests.size < 2)
+      else
+        (interests.size < 1)
+      end
     end
   end
 end

data/lib/ruote/merge.rb

@@ -0,0 +1,123 @@
+#--
+# 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
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+# Made in Japan.
+#++
+
+
+module Ruote
+
+  #--
+  # Gathering methods for merging workitems.
+  #++
+
+  # Merge workitem 'source' into workitem 'target'.
+  #
+  # If type is 'override', the source will prevail and be returned.
+  #
+  # If type is 'mix', the source fields will be merged into the target fields.
+  #
+  # If type is 'isolate', the source fields will be placed in a separte field
+  # in the target workitem. The name of this field is the child_id of the
+  # source workitem (a string from '0' to '99999' and beyond)
+  #
+  # The 'concat' type merges hashes and concats arrays. The 'union' type
+  # behaves much like 'concat', but it makes sure to remove duplicates.
+  #
+  # Warning: 'union' will remove duplicates that were present _before_ the
+  # merge.
+  #
+  def self.merge_workitem(index, target, source, merge_type)
+
+    if merge_type == 'override'
+
+      return source
+    end
+
+    if target == nil
+
+      case merge_type
+
+        when 'stack'
+
+          source['fields'] = { 'stack' => [ source['fields'] ] }
+
+        when 'isolate'
+
+          source['fields'] = { (index || 0).to_s => source['fields'] }
+
+        #when 'mix'
+           # do nothing
+        #when 'union', 'concat'
+           # do nothing
+      end
+
+      return source
+    end
+
+    # else, regular merge
+
+    case merge_type
+
+      when 'mix'
+
+        target['fields'].merge!(source['fields'])
+
+      when 'stack'
+
+        target['fields']['stack'] << source['fields']
+
+      when 'isolate'
+
+        index ||= target['fields'].keys.select { |k| k.match(/^\d+$/) }.size
+        target['fields'][index.to_s] = source['fields']
+
+      when 'union', 'concat', 'deep'
+
+        source['fields'].each do |k, sv|
+
+          tv = target['fields'][k]
+
+          if sv.is_a?(Array) and tv.is_a?(Array)
+            tv.concat(sv)
+            tv.uniq! if merge_type == 'union'
+          elsif sv.is_a?(Hash) and tv.is_a?(Hash)
+            merge_type == 'deep' ? deep_merge!(tv, sv) : tv.merge!(sv)
+          else
+            target['fields'][k] = sv
+          end
+        end
+    end
+
+    target
+  end
+
+  # Inspired by the one found in ActiveSupport, though not strictly
+  # equivalent.
+  #
+  def self.deep_merge!(target, source)
+
+    target.merge!(source) do |k, o, n|
+      o.is_a?(Hash) && n.is_a?(Hash) ? deep_merge!(o, n) : n
+    end
+  end
+end
+