ruote 2.2.0 → 2.3.0

data/lib/ruote/fs.rb

@@ -0,0 +1,3 @@
+
+require 'ruote/storage/fs_storage.rb'
+

data/lib/ruote/id/mnemo_wfid_generator.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2011, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2012, 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,21 +22,44 @@
 # Made in Japan.
 #++
 
-require 'rufus/mnemo' # gem install rufus-mnemo
-require 'ruote/id/wfid_generator'
+require 'digest/md5'
+require 'rufus/mnemo'
 
 
 module Ruote
 
-  class MnemoWfidGenerator < WfidGenerator
+  #
+  # The default wfid generator.
+  #
+  class MnemoWfidGenerator
+
+    def initialize(context)
+
+      @context = context
+
+      @here = "#{Ruote.local_ip}!#{Process.pid}"
+      @counter = 0
+      #@mutex = Mutex.new
+    end
 
     def generate
 
-      raw = get_raw
+      t = Time.now.utc
+      time = t.strftime('%Y%m%d-%H%M')
+      ms = t.to_f % 60.0
+
+      #c = @mutex.synchronize { @counter = (@counter + 1) % 100_000 }
+      @counter = (@counter + 1) % 100_000
+        #
+        # no need to worry about skipping a beat, no mutex.
+
+      s = "#{ms}!#{Thread.current.object_id}!#{@here}!#{@counter}"
+      s = Digest::MD5.hexdigest(s)
 
-      m = ((raw.to_f % 60 * 60 * 24) * 1000).to_i
+      x = Rufus::Mnemo.from_i(s[0, 6].to_i(16))
+      y = Rufus::Mnemo.from_i(s[6, 6].to_i(16))
 
-      "#{raw.strftime('%Y%m%d')}-#{Rufus::Mnemo.from_integer(m)}"
+      "#{time}-#{x}-#{y}"
     end
   end
 end

data/lib/ruote/id/wfid_generator.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2011, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2012, 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,59 +22,38 @@
 # Made in Japan.
 #++
 
+require 'digest/md5'
+
 
 module Ruote
 
+  #
+  # An example of wfid generator.
+  #
   class WfidGenerator
 
     def initialize(context)
 
       @context = context
 
-      @last =
-        @context.storage.get('variables', 'last_wfid') ||
-        { 'type' => 'variables', '_id' => 'last_wfid', 'raw' => Time.now.utc.to_f }
+      @here = "#{Ruote.local_ip}!#{Process.pid}"
+      @counter = 0
+      #@mutex = Mutex.new
     end
 
     def generate
 
-      raw = get_raw
-
-      "#{raw.strftime('%Y%m%d%H%M%S')}-#{raw.usec}"
-    end
-
-    protected
-
-    def get_raw
-
-      lraw = @last['raw'] + 0.01
-
-      raw = Time.now.utc
-      raw = raw + 0.01 while raw.to_f <= lraw
-
-      @last['raw'] = raw.to_f
-
-      last = @context.storage.put(@last, :update_rev => true)
+      t = Time.now.utc
+      time = t.strftime('%Y%m%d-%H%M%S')
+      ms = t.to_f % 1.0
 
-      if last == true
-        #
-        # 'last' is gone, have to put new one
-        @last.delete('_rev')
-        get_raw
+      #c = @mutex.synchronize { @counter = (@counter + 1) % 10_000 }
+      c = @counter = (@counter + 1) % 10_000
 
-      elsif last
-        #
-        # put failed, have to re-ask
-        #
-        @last = last
-        get_raw
+      x = "#{ms}!#{Thread.current.object_id}!#{@here}!#{c}"
+      x = Digest::MD5.hexdigest(x)
 
-      else
-        #
-        # put successful, we can build a new wfid
-        #
-        raw
-      end
+      "#{time}-#{x}"
     end
   end
 end

data/lib/ruote/log/default_history.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2011, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2012, 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
@@ -29,11 +29,21 @@ 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.
+  # This class includes Enumerable.
+  #
+  # NOTE:
+  #
+  # 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.
   #
   class DefaultHistory
 
+    include Enumerable
+
     DATE_REGEX = /!(\d{4}-\d{2}-\d{2})!/
     DEFAULT_MAX_SIZE = 1000
 
@@ -43,9 +53,6 @@ module Ruote
       @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.
@@ -55,6 +62,13 @@ module Ruote
       @history
     end
 
+    # Enabling Enumerable...
+    #
+    def each(&block)
+
+      @history.each(&block)
+    end
+
     # Returns all the wfids for which some piece of history is kept.
     #
     def wfids
@@ -103,10 +117,10 @@ module Ruote
       @history.clear
     end
 
-    # This is the method called by the workqueue. Incoming engine events
-    # are 'processed' here.
+    # This method is called by the worker via the context. Successfully
+    # processed msgs are passed here.
     #
-    def notify(msg)
+    def on_msg(msg)
 
       msg = Ruote.fulldup(msg)
       msg['seen_at'] = Ruote.now_to_utc_s

data/lib/ruote/log/fancy_printing.rb

@@ -0,0 +1,265 @@
+#--
+# Copyright (c) 2005-2012, 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.
+#++
+
+
+class Ruote::WaitLogger
+
+  # fancy msg logic
+
+  protected
+
+  #--
+  # <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 fei_to_s(fei, wfid)
+    [
+      fei['expid'],
+      fei['subid'][0, 5] + '...',
+      fei['wfid'] != wfid ? fei['wfid'] : ''
+    ].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'])
+
+    Ruote::Reader.to_expid_radial(t).split("\n").inject('') do |s, l|
+      m = l.match(/^(\s*[0-9_]+)(.+)$/)
+      s << "\n  "
+      s << color(33, m[1])
+      s << color(32, m[2])
+      s
+    end
+  end
+
+  def fancy_print(msg, noisy=true)
+
+    @count = (@count + 1) % 10
+
+    ei = [
+      self.object_id.to_s[-2..-1],
+      Thread.current['worker_name'].to_s[0, 2]
+    ].join(':')
+
+    fei = msg['fei']
+    depth = fei ? fei['expid'].split('_').size : 0
+
+    i = fei ?
+      [ fei['wfid'], (fei['subid'] || '')[0, 5], fei['expid'] ].join(' ') :
+      msg['wfid']
+    wfid = fei ? fei['wfid'] : 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'] = fei_to_s(v, wfid)
+    end
+    if v = rest.delete('workitem')
+      rest[:wi] = [
+        v['fei'] ? fei_to_s(v['fei'], wfid) : nil,
+        v['fields'].size ]
+    end
+    if v = rest.delete('supplanted')
+      rest[:supplanted] = '...'
+    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
+      end
+    end
+
+    #rest.delete(:t) if fei.nil? && msg['action'] == 'launch'
+      #
+      # don't do that since the radial display is reorganized and this
+      # tree is not.
+
+    if v = rest.delete('participant')
+      rest['part'] = v.first == 'Ruote::BlockParticipant' ? v.first : v
+    end
+
+    act = msg['action'][0, 2]
+    act = case msg['action']
+      when 'receive' then 'rc'
+      when 'dispatched' then 'dd'
+      when 'dispatch_cancel' then 'dc'
+      when 'dispatch_pause' then 'dp'
+      when 'dispatch_resume' then 'dr'
+      when 'pause', 'pause_process' then 'pz'
+      when 'resume', 'resume_process' then 'rz'
+      when 'regenerate' then 'rg'
+      when 'reput' then 'rp'
+      when 'respark' then 'sk'
+      else act
+    end
+    act = case act
+      when 'la', 'rg', 'sk' then color('4;32', act)
+      when 'te' then color('4;31', act)
+      when 'ce' then color('31', act)
+      when 'ca' then color('31', act)
+      when 'dc' then color('4;31', act)
+      when 'pz' then color('4;31', act)
+      when 'rz' then color('4;32', act)
+      when 'dp' then color('4;31', act)
+      when 'dr' then color('4;32', act)
+      when 'rp' then color('32', act)
+      when 'er', 'ra' then color('31', act)
+      when 'di', 'dd', 'rc' then color('4;33', act)
+      else act
+    end
+    unless ACTIONS.include?(msg['action'])
+      rest['action'] = msg['action']
+      act = color('36', msg['action'][0, 2])
+    end
+
+    tm = Time.now
+    tm = tm.strftime('%M:%S.') + ('%03d' % ((tm.to_f % 1.0) * 1000.0).to_i)
+    tm = color(37, tm, false)
+
+    s = if %w[ error_intercepted raise ].include?(msg['action'])
+      #
+      # display backtraces
+
+      rst = insp(
+        rest.reject { |k, v| %w[ error msg ].include?(k) },
+        :trim => %[ updated_tree ])[1..-2]
+
+      tail = []
+      tail << "  #{wfid} * class:  #{rest['error']['class']}"
+      tail << "  #{wfid} * msg:    #{rest['error']['message']}"
+
+      trace = rest['error']['trace']
+      trace = trace[0, 2] + [ '...' ] if msg['action'] == 'raise'
+
+      trace.each { |line| tail << "  #{wfid} #{line}" }
+
+      color(
+        @color,
+        "#{@count} #{tm} #{ei} #{'  ' * depth}#{act} * #{i} #{rst}",
+        true
+      ) +
+      "\n" +
+      color(
+        @color,
+        tail.join("\n"),
+        true)
+
+    else
+      #
+      # regular "lines"
+
+      pa = if %w[ receive dispatch dispatch_cancel ].include?(msg['action'])
+        color('34', rest.delete('participant_name')) + ' '
+      else
+        ''
+      end
+
+      rest = insp(rest, :trim => %[ updated_tree ])[1..-2]
+
+      color(
+        @color,
+        "#{@count} #{tm} #{ei} #{'  ' * depth}#{act} * #{i} #{pa}#{rest}",
+        true)
+    end
+
+    s << radial_tree(msg) if fei.nil? && msg['action'] == 'launch'
+
+    s
+
+  rescue => e
+    "* fancy_print fail\n" +
+    "** msg: #{msg.inspect}\n" +
+    "** err: #{e.to_s} / #{e.backtrace.first}"
+  end
+end
+