ruote 2.1.11 → 2.2.0

data/lib/ruote/log/storage_history.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
@@ -32,11 +32,23 @@ module Ruote
   # 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)
+  #
+  # Note that, by default, the history is an in-memory history (and it is
+  # useless when there are multiple workers).
+  #
   class StorageHistory
 
     DATE_REGEX = /!(\d{4}-\d{2}-\d{2})!/
 
-    def initialize (context, options={})
+    def initialize(context, options={})
 
       @context = context
       @options = options
@@ -50,7 +62,22 @@ module Ruote
       end
     end
 
-    def by_process (wfid)
+    # 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
@@ -73,7 +100,12 @@ module Ruote
       [ first, last ]
     end
 
-    def by_date (date)
+    # 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')
 
@@ -97,7 +129,7 @@ module Ruote
     # This is the method called by the workqueue. Incoming engine events
     # are 'processed' here.
     #
-    def notify (msg)
+    def notify(msg)
 
       msg = msg.dup
         # a shallow copy is sufficient

data/lib/ruote/log/test_logger.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
@@ -36,7 +36,7 @@ module Ruote
 
     attr_accessor :noisy
 
-    def initialize (context)
+    def initialize(context)
 
       @context = context
 
@@ -61,7 +61,7 @@ module Ruote
       @noisy = false
     end
 
-    def notify (msg)
+    def notify(msg)
 
       puts(pretty_print(msg)) if @noisy
 
@@ -84,7 +84,7 @@ module Ruote
     # while the first thread is waiting, the first thread's
     # interests are lost and the first thread will never wake up.
     #
-    def wait_for (interests)
+    def wait_for(interests)
 
       @waiting << [ Thread.current, interests ]
 
@@ -104,12 +104,12 @@ module Ruote
       @seen.collect { |msg| pretty_print(msg) }.join("\n")
     end
 
-    def color= (c)
+    def color=(c)
 
       @color = c
     end
 
-    def self.pp (msg)
+    def self.pp(msg)
 
       @logger ||= TestLogger.new(nil)
       puts @logger.send(:pretty_print, msg)
@@ -126,7 +126,7 @@ module Ruote
       end
     end
 
-    def check_msg (msg)
+    def check_msg(msg)
 
       wakeup = []
 
@@ -158,38 +158,40 @@ module Ruote
     # Returns true if all interests being waited for have been satisfied,
     # false otherwise.
     #
-    def matches (interests, msg)
+    def matches(interests, msg)
 
       action = msg['action']
 
       interests.each do |interest|
 
-        satisfied = if interest == :inactive
+        satisfied = case interest
 
-          (FINAL_ACTIONS.include?(action) && @context.worker.inactive?)
+          when :inactive
 
-        elsif interest == :empty
+            (FINAL_ACTIONS.include?(action) && @context.worker.inactive?)
 
-          (action == 'terminated' && @context.storage.empty?('expressions'))
+          when :empty
 
-        elsif interest.is_a?(Symbol) # participant
+            (action == 'terminated' && @context.storage.empty?('expressions'))
 
-          (action == 'dispatch' && msg['participant_name'] == interest.to_s)
+          when Symbol
 
-        elsif interest.is_a?(Fixnum)
+            (action == 'dispatch' && msg['participant_name'] == interest.to_s)
 
-          interests.delete(interest)
+          when Fixnum
 
-          if (interest > 1)
-            interests << (interest - 1)
-            false
-          else
-            true
-          end
+            interests.delete(interest)
 
-        else # wfid
+            if (interest > 1)
+              interests << (interest - 1)
+              false
+            else
+              true
+            end
 
-          (FINAL_ACTIONS.include?(action) && msg['wfid'] == interest)
+          else # wfid
+
+            (FINAL_ACTIONS.include?(action) && msg['wfid'] == interest)
         end
 
         interests.delete(interest) if satisfied

data/lib/ruote/log/wait_logger.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
@@ -30,11 +30,13 @@ module Ruote
   #
   # A helper logger for quickstart examples.
   #
+  # Keeps a maximum of 147 messages.
+  #
   class WaitLogger < TestLogger
 
     attr_accessor :noisy
 
-    def initialize (context)
+    def initialize(context)
 
       @context = context
       @color = 33
@@ -48,7 +50,7 @@ module Ruote
       @waiting = []
     end
 
-    def notify (msg)
+    def notify(msg)
 
       puts(pretty_print(msg)) if @noisy
 

data/lib/ruote/part/block_participant.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
@@ -67,35 +67,46 @@ module Ruote
     include LocalParticipant
 
     attr_accessor :context
-    attr_accessor :do_not_thread
 
-    def initialize (block, opts)
+    def initialize(opts)
 
       @opts = opts
-      @block = block
-      @do_not_thread = false
     end
 
-    def consume (workitem)
+    def do_not_thread
 
-      r = if @block.arity == 1
+      @opts['do_not_thread']
+    end
+
+    def consume(workitem)
+
+      block = @opts['block']
+
+      @context.treechecker.block_check(block)
+        # raises in case of 'security' violation
+
+      #block = eval(block, @context.send(:binding))
+        # doesn't work with ruby 1.9.2-p136
+      block = eval(block, @context.instance_eval { binding })
+        # works OK with ruby 1.8.7-249 and 1.9.2-p136
+
+      r = if block.arity == 1
 
-        @block.call(workitem)
+        block.call(workitem)
       else
 
-        @block.call(
+        block.call(
           workitem, Ruote::Exp::FlowExpression.fetch(@context, workitem.h.fei))
       end
 
       if r != nil && r != workitem
-        #workitem.result = r
         workitem.result = (Rufus::Json.dup(r) rescue nil)
       end
 
       reply_to_engine(workitem)
     end
 
-    def cancel (fei, flavour)
+    def cancel(fei, flavour)
 
       # do nothing
     end

data/lib/ruote/part/engine_participant.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
@@ -105,7 +105,7 @@ module Ruote
 
     include LocalParticipant
 
-    def initialize (opts)
+    def initialize(opts)
 
       if pa = opts['storage_path']
         require pa
@@ -118,7 +118,7 @@ module Ruote
       @storage = Ruote.constantize(kl).new(opts['storage_args'])
     end
 
-    def consume (workitem)
+    def consume(workitem)
 
       wi = workitem.to_h
       fexp = Ruote::Exp::FlowExpression.fetch(@context, wi['fei'])
@@ -129,7 +129,6 @@ module Ruote
       @storage.put_msg(
         'launch',
         'wfid' => wi['fei']['wfid'],
-        'sub_wfid' => fexp.get_next_sub_wfid,
         'parent_id' => forget ? nil : wi['fei'],
         'tree' => determine_tree(fexp, params),
         'workitem' => wi,
@@ -142,7 +141,7 @@ module Ruote
         # is unpersisted immediately
     end
 
-    def cancel (fei, flavour)
+    def cancel(fei, flavour)
 
       exps = @storage.get_many('expressions', /^0![^!]+!#{fei.wfid}$/)
 
@@ -158,7 +157,7 @@ module Ruote
         # participant expression will NOT reply to its parent
     end
 
-    def reply (fei, workitem)
+    def reply(fei, workitem)
 
       @storage.put_msg(
         'reply',
@@ -168,7 +167,7 @@ module Ruote
 
     protected
 
-    def determine_tree (fexp, params)
+    def determine_tree(fexp, params)
 
       pdef = params['def'] || params['pdef'] || params['tree']
 

data/lib/ruote/part/local_participant.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
@@ -51,7 +51,7 @@ module Ruote
     #
     # Without one of those options, the method is a "reject".
     #
-    def re_dispatch (workitem, opts={})
+    def re_dispatch(workitem, opts={})
 
       msg = {
         'action' => 'dispatch',
@@ -82,11 +82,11 @@ module Ruote
     #   class RetryParticipant
     #     include Ruote::LocalParticipant
     #
-    #     def initialize (opts)
+    #     def initialize(opts)
     #       @opts = opts
     #     end
     #
-    #     def consume (workitem)
+    #     def consume(workitem)
     #       begin
     #         do_the_job
     #         reply(workitem)
@@ -95,7 +95,7 @@ module Ruote
     #       end
     #     end
     #
-    #     def cancel (fei, flavour)
+    #     def cancel(fei, flavour)
     #       unschedule_re_dispatch(fei)
     #     end
     #   end
@@ -103,7 +103,7 @@ module Ruote
     # Note how unschedule_re_dispatch is used in the cancel method. Warning,
     # this example could loop forever...
     #
-    def unschedule_re_dispatch (fei)
+    def unschedule_re_dispatch(fei)
 
       fexp = Ruote::Exp::FlowExpression.fetch(
         @context, Ruote::FlowExpressionId.extract_h(fei))
@@ -113,12 +113,6 @@ module Ruote
       end
     end
 
-    # WARNING : this method is only for 'stateless' participants, ie
-    # participants that are registered in the engine by passing their class
-    # and a set of options, like in
-    #
-    #   engine.register_participant 'alpha', MyParticipant, 'info' => 'none'
-    #
     # This reject method replaces the workitem in the [internal] message queue
     # of the ruote engine (since it's a local participant, it has access to
     # the storage and it's thus easy).

data/lib/ruote/part/no_op_participant.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
@@ -38,7 +38,7 @@ module Ruote
 
     include LocalParticipant
 
-    def initialize (opts=nil)
+    def initialize(opts=nil)
 
       @items = {}
     end
@@ -46,12 +46,12 @@ module Ruote
     #
     # No operation : simply replies immediately to the engine.
     #
-    def consume (workitem)
+    def consume(workitem)
 
       reply_to_engine(workitem)
     end
 
-    def cancel (fei, flavour)
+    def cancel(fei, flavour)
 
       # nothing to do
     end

data/lib/ruote/part/null_participant.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
@@ -37,17 +37,17 @@ module Ruote
 
     include LocalParticipant
 
-    def initialize (opts=nil)
+    def initialize(opts=nil)
     end
 
     # Does nothing, discards the workitem it receives.
     #
-    def consume (workitem)
+    def consume(workitem)
     end
 
     # Does nothing.
     #
-    def cancel (fei, flavour)
+    def cancel(fei, flavour)
     end
   end
 end