ruote 2.1.11 → 2.2.0

data/lib/ruote/fei.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2010, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2011, 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
@@ -22,6 +22,8 @@
 # Made in Japan.
 #++
 
+require 'digest/md5'
+
 require 'ruote/version'
 require 'ruote/workitem'
 require 'ruote/util/misc'
@@ -34,7 +36,7 @@ module Ruote
   #
   #   Ruote::FlowExpressionId.to_storage_id(fei)
   #
-  def self.to_storage_id (fei)
+  def self.to_storage_id(fei)
 
     Ruote::FlowExpressionId.to_storage_id(fei)
   end
@@ -43,11 +45,40 @@ module Ruote
   #
   #   Ruote::FlowExpressionId.to_storage_id(fei)
   #
-  def self.sid (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
+
+  # This function is used to generate the subids. Each flow
+  # expression receives such an id (it's useful for cursors, loops and
+  # forgotten branches).
+  #
+  def self.generate_subid(salt)
+
+    Digest::MD5.hexdigest(
+      "#{rand}-#{salt}-#{$$}-#{Thread.current.object_id}#{Time.now.to_f}")
+  end
+
   #
   # The FlowExpressionId (fei for short) is an process expression identifier.
   # Each expression when instantiated gets a unique fei.
@@ -60,7 +91,7 @@ module Ruote
   # Feis contain four pieces of information :
   #
   # * wfid : workflow instance id, the identifier for the process instance
-  # * sub_wfid : the identifier for the sub process within the main instance
+  # * subid : a unique identifier for expressions (useful in loops)
   # * expid : the expression id, where in the process tree
   # * engine_id : only relevant in multi engine scenarii (defaults to 'engine')
   #
@@ -70,44 +101,39 @@ module Ruote
 
     attr_reader :h
 
-    def initialize (h)
+    def initialize(h)
 
       @h = h
       class << h; include Ruote::HashDot; end
-    end
-
-    def expid
-      @h['expid']
-    end
 
-    def wfid
-      @h['wfid']
+      @h['subid'] = @h.delete('sub_wfid') if @h['sub_wfid']
+        # TODO : for 2.1.13, remove this
     end
 
-    def sub_wfid
-      @h['sub_wfid']
-    end
+    def expid; @h['expid']; end
+    def wfid; @h['wfid']; end
+    def engine_id; @h['engine_id']; end
+    def subid; @h['subid']; end
 
-    def engine_id
-      @h['engine_id']
-    end
+    alias sub_wfid subid
 
     def to_storage_id
-      "#{@h['expid']}!#{@h['sub_wfid']}!#{@h['wfid']}"
+      "#{@h['expid']}!#{@h['subid']}!#{@h['wfid']}"
     end
-
     alias sid to_storage_id
 
-    def self.to_storage_id (hfei)
+    def self.to_storage_id(hfei)
 
       hfei.respond_to?(:to_storage_id) ?
         hfei.to_storage_id :
-        "#{hfei['expid']}!#{hfei['sub_wfid']}!#{hfei['wfid']}"
+        "#{hfei['expid']}!#{hfei['subid'] || hfei['sub_wfid']}!#{hfei['wfid']}"
+
+      # TODO : for 2.1.13, remove the subid || sub_wfid trick
     end
 
     # Turns the result of to_storage_id back to a FlowExpressionId instance.
     #
-    def self.from_id (s, engine_id='engine')
+    def self.from_id(s, engine_id='engine')
 
       extract("#{engine_id}!#{s}")
     end
@@ -116,14 +142,19 @@ module Ruote
     # '0_5_7', the child_id will be '7'.
     #
     def child_id
+
       h.expid.split(CHILD_SEP).last.to_i
     end
 
     def hash
+
       to_storage_id.hash
     end
 
-    def == (other)
+    # Returns true if the other is a FlowExpressionId instance and it
+    # points to the same expression as this one.
+    #
+    def ==(other)
 
       return false unless other.is_a?(Ruote::FlowExpressionId)
 
@@ -132,27 +163,34 @@ 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)
+    def self.is_a_fei?(h)
 
-      h.respond_to?(:keys) &&
-      (h.keys - [ 'sub_wfid' ]).sort == %w[ engine_id expid wfid ]
+      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)
+    def self.child_id(h)
+
       h['expid'].split(CHILD_SEP).last.to_i
     end
 
     def to_h
+
       @h
     end
 
-    def self.direct_child? (parent_fei, other_fei)
+    # Returns true if other_fei is the fei of a child expression of
+    # parent_fei.
+    #
+    def self.direct_child?(parent_fei, other_fei)
 
-      %w[ sub_wfid wfid engine_id ].each do |k|
+      %w[ wfid engine_id ].each do |k|
         return false if parent_fei[k] != other_fei[k]
       end
 
@@ -166,7 +204,7 @@ module Ruote
     #
     # Uses .extract_h
     #
-    def self.extract (arg)
+    def self.extract(arg)
 
       FlowExpressionId.new(extract_h(arg))
     end
@@ -174,7 +212,7 @@ module Ruote
     # Attempts at extracting a FlowExpressionId (as a Hash instance) from the
     # given argument (workitem, string, ...)
     #
-    def self.extract_h (arg)
+    def self.extract_h(arg)
 
       if arg.is_a?(Hash)
         return arg if arg['expid']
@@ -191,7 +229,9 @@ module Ruote
 
         return {
           'engine_id' => ss[-4] || 'engine',
-          'expid' => ss[-3], 'sub_wfid' => ss[-2], 'wfid' => ss[-1] }
+          'expid' => ss[-3],
+          'subid' => ss[-2],
+          'wfid' => ss[-1] }
       end
 
       raise ArgumentError.new(

data/lib/ruote/id/mnemo_wfid_generator.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2010, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2011, 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-2010, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2011, 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
@@ -27,7 +27,7 @@ module Ruote
 
   class WfidGenerator
 
-    def initialize (context)
+    def initialize(context)
 
       @context = context
 
@@ -54,14 +54,21 @@ module Ruote
 
       @last['raw'] = raw.to_f
 
-      last = @context.storage.put(@last)
+      last = @context.storage.put(@last, :update_rev => true)
 
-      if last
+      if last == true
+        #
+        # 'last' is gone, have to put new one
+        @last.delete('_rev')
+        get_raw
+
+      elsif last
         #
         # put failed, have to re-ask
         #
         @last = last
         get_raw
+
       else
         #
         # put successful, we can build a new wfid

data/lib/ruote/log/default_history.rb

@@ -0,0 +1,122 @@
+#--
+# Copyright (c) 2005-2011, 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
+
+  #
+  # A default history implementation, only keeps the most recent stuff
+  # in memory.
+  #
+  # NOTE : this default history is useless when there are multiple workers.
+  # It only keeps track of the 'local' worker if there is one present.
+  #
+  class DefaultHistory
+
+    DATE_REGEX = /!(\d{4}-\d{2}-\d{2})!/
+    DEFAULT_MAX_SIZE = 1000
+
+    def initialize(context, options={})
+
+      @context = context
+      @options = options
+
+      @history = []
+
+      @context.worker.subscribe(:all, self) if @context.worker
+        # only care about logging if there is a worker present
+    end
+
+    # Returns all the msgs (events), most recent one is last.
+    #
+    def all
+
+      @history
+    end
+
+    # Returns all the wfids for which some piece of history is kept.
+    #
+    def wfids
+
+      @history.collect { |msg|
+        msg['wfid'] || (msg['fei']['wfid'] rescue nil)
+      }.compact.uniq.sort
+    end
+
+    # Returns all the msgs (events) for a given wfid. (Well, all the msgs
+    # that are kept.
+    #
+    def by_process(wfid)
+
+      @history.select { |msg|
+        (msg['wfid'] || (msg['fei']['wfid'] rescue nil)) == wfid
+      }
+    end
+    alias by_wfid by_process
+
+    # Returns an array [ most recent date, oldest date ] (Time instances).
+    #
+    def range
+
+      now = Time.now
+
+      [ (Time.parse(@history.first['seen_at']) rescue now),
+        (Time.parse(@history.last['seen_at']) rescue now) ]
+    end
+
+    def by_date(date)
+
+      d = Time.parse(date.to_s).utc.strftime('%Y-%m-%d')
+
+      @history.select { |m| Time.parse(m['seen_at']).strftime('%Y-%m-%d') == d }
+    end
+
+    #def history_to_tree (wfid)
+    #  # (NOTE why not ?)
+    #end
+
+    # Forgets all the stored msgs.
+    #
+    def clear!
+
+      @history.clear
+    end
+
+    # This is the method called by the workqueue. Incoming engine events
+    # are 'processed' here.
+    #
+    def notify(msg)
+
+      msg = Ruote.fulldup(msg)
+      msg['seen_at'] = Ruote.now_to_utc_s
+
+      @history << msg
+
+      while (@history.size > (@options[:max_size] || DEFAULT_MAX_SIZE)) do
+        @history.shift
+      end
+    end
+  end
+end
+

data/lib/ruote/log/pretty.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2010, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2011, 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
@@ -64,7 +64,7 @@ module Ruote
     # 47 White
     #++
 
-    def color (mod, s, clear=false)
+    def color(mod, s, clear=false)
 
       return s if Ruote::WIN
       return s unless STDOUT.tty?
@@ -72,7 +72,7 @@ module Ruote
       "[#{mod}m#{s}#{clear ? '' : "[#{@color}m"}"
     end
 
-    def pretty_print (msg)
+    def pretty_print(msg)
 
       @count += 1
       @count = 0 if @count > 9
@@ -83,8 +83,9 @@ module Ruote
       depth = fei ? fei['expid'].split('_').size : 0
 
       i = fei ?
-        [ fei['wfid'], fei['sub_wfid'], fei['expid'] ].join(' ') :
+        [ fei['wfid'], (fei['subid'] || '')[0, 5], fei['expid'] ].join(' ') :
         msg['wfid']
+      wfid = fei ? fei['wfid'] : msg['wfid']
 
       rest = msg.dup
       %w[
@@ -102,6 +103,10 @@ module Ruote
           v['fields'].size ]
       end
 
+      #if t = rest.delete('tree')
+      #  rest[:t] = color(37, t.inspect, true)
+      #end
+
       { 'tree' => :t, 'parent_id' => :pi }.each do |k0, k1|
         if v = rest.delete(k0)
           rest[k1] = v
@@ -127,10 +132,33 @@ module Ruote
         else action
       end
 
-      color(
-        @color,
-        "#{@count} #{ei} #{'  ' * depth}#{action} * #{i} #{rest.inspect}",
-        true)
+      if msg['action'] == 'error_intercepted'
+
+        tail = []
+        tail << "  #{wfid} #{rest['error']['class']}"
+        tail << "  #{wfid} #{rest['error']['message']}"
+        rest['error']['trace'].each do |line|
+          tail << "  #{wfid} #{line}"
+        end
+
+        color(
+          @color,
+          "#{@count} #{ei} #{'  ' * depth}#{action} * #{i}",
+          true
+        ) +
+        "\n" +
+        color(
+          @color,
+          tail.join("\n"),
+          true)
+
+      else
+
+        color(
+          @color,
+          "#{@count} #{ei} #{'  ' * depth}#{action} * #{i} #{rest.inspect}",
+          true)
+      end
     end
   end
 end