ruote-maestrodev 2.2.1

data/lib/ruote/id/mnemo_wfid_generator.rb

@@ -0,0 +1,43 @@
+#--
+# 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.
+#++
+
+require 'rufus/mnemo' # gem install rufus-mnemo
+require 'ruote/id/wfid_generator'
+
+
+module Ruote
+
+  class MnemoWfidGenerator < WfidGenerator
+
+    def generate
+
+      raw = get_raw
+
+      m = ((raw.to_f % 60 * 60 * 24) * 1000).to_i
+
+      "#{raw.strftime('%Y%m%d')}-#{Rufus::Mnemo.from_integer(m)}"
+    end
+  end
+end
+

data/lib/ruote/id/wfid_generator.rb

@@ -0,0 +1,81 @@
+#--
+# 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
+
+  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 }
+    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)
+
+      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
+        #
+        raw
+      end
+    end
+  end
+end
+

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 worthless 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

@@ -0,0 +1,176 @@
+#--
+# 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 container for the pretty printing logic of TestLogger.
+  #
+  module PrettyLogging
+
+    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 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['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'] = 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
+
+      #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
+
+      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'
+        else act
+      end
+      act = case act
+        when 'la' 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 'rc' then color('4;33', act)
+        when 'di' then color('4;33', act)
+        when 'dd' then color('4;33', 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)
+        else act
+      end
+
+      tail = 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}#{act} * #{i}",
+          true
+        ) +
+        "\n" +
+        color(
+          @color,
+          tail.join("\n"),
+          true)
+
+      else
+
+        pa = %w[ receive dispatch ].include?(msg['action']) ?
+          color('34', msg['participant_name']) + ' ' : ''
+
+        color(
+          @color,
+          "#{@count} #{ei} #{'  ' * depth}#{act} * #{pa}#{i} #{rest.inspect}",
+          true)
+      end
+    end
+  end
+end
+

data/lib/ruote/log/storage_history.rb

@@ -0,0 +1,159 @@
+#--
+# 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
+
+  #
+  # Logs the ruote engine history to the storage underlying the worker.
+  #
+  # Warning : don't use this history implementation when the storage is
+  # HashStorage. It will fill up your memory... Keeping history for a
+  # transient ruote is a bit overkill (IMHO).
+  #
+  # == using the StorageHistory
+  #
+  #   engine.add_service(
+  #     'history', 'ruote/log/storage_history', 'Ruote::StorageHistory')
+  #
+  #   # ...
+  #
+  #   process_history = engine.history.by_wfid(wfid0)
+  #
+  #
+  # == final note
+  #
+  # By default, the history is an in-memory history (see Ruote::DefaultHistory)
+  # (and it is worthless when there are multiple workers).
+  #
+  class StorageHistory
+
+    DATE_REGEX = /!(\d{4}-\d{2}-\d{2})!/
+
+    def initialize(context, options={})
+
+      @context = context
+      @options = options
+
+      if @context.worker
+
+        # only care about logging if there is a worker present
+
+        @context.storage.add_type('history')
+        @context.worker.subscribe(:all, self)
+      end
+    end
+
+    # Returns all the wfids for which there are history items (msgs) stored.
+    #
+    def wfids
+
+      wfids = @context.storage.ids('history').collect { |id|
+        id.split('!').last
+      }.uniq.sort
+
+      wfids.delete('no_wfid')
+
+      wfids
+    end
+
+    # Returns all the msgs for a given wfid (process instance id).
+    #
+    def by_process(wfid)
+
+      @context.storage.get_many('history', wfid)
+    end
+    alias :by_wfid :by_process
+
+    # Returns an array [ most recent date, oldest date ] (Time instances).
+    #
+    def range
+
+      ids = @context.storage.ids('history')
+
+      #p ids.sort == ids
+
+      fm = DATE_REGEX.match(ids.first)[1]
+      lm = DATE_REGEX.match(ids.last)[1]
+
+      first = Time.parse("#{fm} 00:00:00 UTC")
+      last = Time.parse("#{lm} 00:00:00 UTC") + 24 * 3600
+
+      [ first, last ]
+    end
+
+    # Returns all the history events for a given day.
+    #
+    # Takes as argument whatever is a datetime when turned to a string and
+    # parsed.
+    #
+    def by_date(date)
+
+      date = Time.parse(date.to_s).strftime('%Y-%m-%d')
+
+      @context.storage.get_many('history', /!#{date}!/)
+    end
+
+    #def history_to_tree (wfid)
+    #  # (NOTE why not ?)
+    #end
+
+    # The history system doesn't implement purge! so that when purge! is called
+    # on the engine, the history is not cleared.
+    #
+    # Call this *dangerous* clear! method to clean out any history file.
+    #
+    def clear!
+
+      @context.storage.purge_type!('history')
+    end
+
+    # This is the method called by the workqueue. Incoming engine events
+    # are 'processed' here.
+    #
+    def notify(msg)
+
+      msg = msg.dup
+        # a shallow copy is sufficient
+
+      si = if fei = msg['fei']
+        Ruote::FlowExpressionId.to_storage_id(fei)
+      else
+        msg['wfid'] || 'no_wfid'
+      end
+
+      _id = msg['_id']
+      msg['original_id'] = _id
+      msg['_id'] = "#{_id}!#{si}"
+
+      msg['type'] = 'history'
+      msg['original_put_at'] = msg['put_at']
+
+      msg.delete('_rev')
+
+      @context.storage.put(msg)
+    end
+  end
+end
+