ruote 2.1.11 → 2.2.0

data/lib/ruote/storage/hash_storage.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
@@ -39,17 +39,19 @@ module Ruote
 
     attr_reader :h
 
-    def initialize (options={})
+    def initialize(options={})
 
       super()
         # since were including MonitorMixin, this super() is necessary
 
+      @options = options
+
       purge!
 
       put(options.merge('type' => 'configurations', '_id' => 'engine'))
     end
 
-    def put (doc, opts={})
+    def put(doc, opts={})
 
       i = @h.size
 
@@ -79,16 +81,23 @@ module Ruote
 
         nil
       end
+
+    rescue => e
+      puts "=" * 80
+      File.open('doc.json', 'wb') do |f|
+        f.puts Rufus::Json.pretty_encode(doc)
+      end
+      raise e
     end
 
-    def get (type, key)
+    def get(type, key)
 
       synchronize do
         Ruote.fulldup(@h[type][key])
       end
     end
 
-    def delete (doc)
+    def delete(doc)
 
       drev = doc['_rev']
 
@@ -102,20 +111,15 @@ module Ruote
 
         doc['_rev'] ||= 0
 
-        if prev['_rev'] == drev
+        return prev if prev['_rev'] != drev
 
-          @h[doc['type']].delete(doc['_id'])
-
-          nil
-
-        else
+        @h[doc['type']].delete(doc['_id'])
 
-          prev
-        end
+        nil # success
       end
     end
 
-    def get_many (type, key=nil, opts={})
+    def get_many(type, key=nil, opts={})
 
       # NOTE : no dup here for now
 
@@ -145,7 +149,7 @@ module Ruote
 
     # Returns a sorted list of all the ids for a given type.
     #
-    def ids (type)
+    def ids(type)
 
       @h[type].keys.sort
     end
@@ -173,17 +177,17 @@ module Ruote
       @h['configurations']['engine'] = @options
     end
 
-    def add_type (type)
+    def add_type(type)
 
       @h[type] = {}
     end
 
-    def purge_type! (type)
+    def purge_type!(type)
 
       @h[type] = {}
     end
 
-    def dump (type)
+    def dump(type)
 
       s = "=== #{type} ===\n"
 
@@ -195,6 +199,13 @@ module Ruote
         end
       end
     end
+
+    # Shuts this storage down.
+    #
+    def shutdown
+
+      # nothing to do
+    end
   end
 end
 

data/lib/ruote/svc/dispatch_pool.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
@@ -34,12 +34,12 @@ module Ruote
   #
   class DispatchPool
 
-    def initialize (context)
+    def initialize(context)
 
       @context = context
     end
 
-    def handle (msg)
+    def handle(msg)
 
       case msg['action']
         when 'dispatch'
@@ -47,13 +47,13 @@ module Ruote
         when 'dispatch_cancel'
           dispatch_cancel(msg)
         else
-          # simply discard message
+          # simply discard the message
       end
     end
 
     protected
 
-    def dispatch_cancel (msg)
+    def dispatch_cancel(msg)
 
       flavour = msg['flavour']
 
@@ -61,7 +61,7 @@ module Ruote
 
       begin
         participant.cancel(Ruote::FlowExpressionId.new(msg['fei']), flavour)
-      rescue Exception => e
+      rescue => e
         raise(e) if flavour != 'kill'
       end
 
@@ -71,19 +71,21 @@ module Ruote
         'workitem' => msg['workitem'])
     end
 
-    def dispatch (msg)
+    def dispatch(msg)
 
       participant = @context.plist.lookup(
         msg['participant'] || msg['participant_name'], msg['workitem'])
 
-      if participant.respond_to?(:do_not_thread) && participant.do_not_thread
+      if do_not_thread(participant, msg)
         do_dispatch(participant, msg)
       else
         do_threaded_dispatch(participant, msg)
       end
     end
 
-    def do_dispatch (participant, msg)
+    # The actual dispatching (call to Participant#consume).
+    #
+    def do_dispatch(participant, msg)
 
       workitem = Ruote::Workitem.new(msg['workitem'])
 
@@ -91,12 +93,23 @@ module Ruote
 
       participant.consume(workitem)
 
-      @context.storage.put_msg('dispatched', 'fei' => msg['fei'])
-        # once the consume is done, asynchronously flag the
-        # participant expression as 'dispatched'
+      @context.storage.put_msg(
+        'dispatched',
+        'fei' => msg['fei'],
+        'participant_name' => workitem.participant_name)
+          # once the consume is done, asynchronously flag the
+          # participant expression as 'dispatched'
     end
 
-    def do_threaded_dispatch (participant, msg)
+    # Wraps the call to do_dispatch in a thread.
+    #
+    def do_threaded_dispatch(participant, msg)
+
+      msg = Rufus::Json.dup(msg)
+        #
+        # the thread gets its own copy of the message
+        # (especially important if the main thread does something with
+        # the message 'during' the dispatch)
 
       # Maybe at some point a limit on the number of dispatch threads
       # would be OK.
@@ -107,11 +120,25 @@ module Ruote
 
           do_dispatch(participant, msg)
 
-        rescue Exception => exception
+        rescue => exception
           @context.error_handler.msg_handle(msg, exception)
         end
       end
     end
+
+    # Returns true if the participant doesn't want the #consume to happen
+    # in a new Thread.
+    #
+    def do_not_thread(participant, msg)
+
+      return false unless participant.respond_to?(:do_not_thread)
+
+      if participant.method(:do_not_thread).arity == 0
+        participant.do_not_thread
+      else
+        participant.do_not_thread(Ruote::Workitem.new(msg['workitem']))
+      end
+    end
   end
 end
 

data/lib/ruote/svc/dollar_sub.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
@@ -40,7 +40,7 @@ module Ruote
   #
   class DollarSubstitution
 
-    def initialize (context)
+    def initialize(context)
 
       @context = context
     end
@@ -50,11 +50,14 @@ module Ruote
     #
     # With help from Nick Petrella (2008/03/20)
     #
-    def s (text, flow_expression, workitem)
+    def s(text, flow_expression, workitem)
 
       if text.is_a?(String)
 
-        Rufus.dsub(text, dict_class.new(flow_expression, workitem))
+        literal_sub(
+          Rufus.dsub(text, dict_class.new(flow_expression, workitem)),
+          flow_expression,
+          workitem)
 
       elsif text.is_a?(Array)
 
@@ -82,6 +85,26 @@ module Ruote
 
       ::Ruote::Dollar::Dict
     end
+
+    protected
+
+    # If the final text is of the form "$f:x" or "$v:y" will lookup the
+    # x field or the y variable. If the lookup is successful (not nil) will
+    # return the, not the text.
+    #
+    def literal_sub(s, fexp, wi)
+
+      result = case s
+        when /^\$([^{}:])$/, /^\$(?:field|fld|f):([^{}]+)$/
+          Ruote.lookup(wi['fields'], $~[1])
+        when /^\$(?:variable|var|v):([^{}]+)$/
+          fexp.lookup_variable($~[1])
+        else
+          s
+      end
+
+      result.nil? ? s : result
+    end
   end
 
 
@@ -100,18 +123,20 @@ module Ruote
       attr_reader :fexp
       attr_reader :workitem
 
-      def initialize (flowexpression, workitem)
+      def initialize(flowexpression, workitem)
 
         @fexp = flowexpression
         @workitem = workitem
       end
 
-      def [] (key)
+      def [](key)
 
         return @fexp.fei.to_storage_id if key == 'fei'
         return @fexp.fei.wfid if key == 'wfid'
-        return @fexp.fei.sub_wfid if key == 'sub_wfid'
+        return @fexp.fei.subid if key == 'subid'
+        return @fexp.fei.subid if key == 'sub_wfid' # deprecated in 2.1.12
         return @fexp.fei.expid if key == 'expid'
+        return @fexp.fei.engine_id if key == 'engine_id'
 
         pr, k = extract_prefix(key)
 
@@ -128,7 +153,7 @@ module Ruote
         lookup(pr[1, 1], k)
       end
 
-      def []= (key, value)
+      def []=(key, value)
 
         pr, k = extract_prefix(key)
         pr = pr[0, 1]
@@ -143,7 +168,7 @@ module Ruote
         end
       end
 
-      def has_key? (key)
+      def has_key?(key)
 
         pr, k = extract_prefix(key)
 
@@ -154,7 +179,7 @@ module Ruote
 
       protected
 
-      def lookup (pr, key)
+      def lookup(pr, key)
 
         case pr
           when 'v' then @fexp.lookup_variable(key)
@@ -164,7 +189,7 @@ module Ruote
         end
       end
 
-      def extract_prefix (key)
+      def extract_prefix(key)
 
         i = key.index(':')
 
@@ -181,11 +206,15 @@ module Ruote
 
       # TODO : rdoc me
       #
-      def ruby_eval (ruby_code)
+      def ruby_eval(ruby_code)
 
-        return '' if @fexp.context['ruby_eval_allowed'] != true
+        raise ArgumentError.new(
+          "'ruby_eval_allowed' is set to false, cannot evaluate >" +
+          ruby_code +
+          "< (http://ruote.rubyforge.org/dollar.html)"
+        ) if @fexp.context['ruby_eval_allowed'] != true
 
-        @fexp.context.treechecker.check(ruby_code)
+        @fexp.context.treechecker.dollar_check(ruby_code)
 
         RubyContext.new(self).instance_eval(ruby_code)
       end
@@ -198,7 +227,7 @@ module Ruote
 
       attr_reader :workitem
 
-      def initialize (dict)
+      def initialize(dict)
 
         @dict = dict
         @workitem = Ruote::Workitem.new(@dict.workitem)
@@ -207,8 +236,10 @@ module Ruote
       # The FlowExpression for which the rendering/substitution is occurring.
       #
       def flow_expression
+
         @dict.fexp
       end
+
       alias fe flow_expression
       alias fexp flow_expression
 
@@ -216,6 +247,7 @@ module Ruote
       # rendering/substitution is occurring.
       #
       def fei
+
         @dict.fexp.fei
       end
 
@@ -224,6 +256,7 @@ module Ruote
       # The engine_id, if any.
       #
       def engine_id
+
         @dict.fexp.context.engine_id
       end
 
@@ -238,7 +271,7 @@ module Ruote
       #
       # will yield "person".
       #
-      def d (s)
+      def d(s)
 
         Rufus.dsub("${#{s}}", @dict)
       end
@@ -251,7 +284,7 @@ module Ruote
       #
       # Else the regular NoMethodError will be raised.
       #
-      def method_missing (m, *args)
+      def method_missing(m, *args)
 
         if args.length < 1 && v = @workitem.fields[m.to_s]
           return v

data/lib/ruote/svc/error_handler.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
@@ -35,14 +35,14 @@ module Ruote
   #
   class ErrorHandler
 
-    def initialize (context)
+    def initialize(context)
 
       @context = context
     end
 
     # As used by the dispatch pool and the worker.
     #
-    def msg_handle (msg, exception)
+    def msg_handle(msg, exception)
 
       fexp = Ruote::Exp::FlowExpression.fetch(
         @context, msg['fei'] || msg['workitem']['fei']
@@ -53,7 +53,7 @@ module Ruote
 
     # As used by some receivers (see ruote-beanstalk's receiver).
     #
-    def action_handle (action, fei, exception)
+    def action_handle(action, fei, exception)
 
       fexp = Ruote::Exp::FlowExpression.fetch(@context, fei)
 
@@ -70,7 +70,7 @@ module Ruote
 
     # As used by the worker.
     #
-    def handle (msg, fexp, exception)
+    def handle(msg, fexp, exception)
 
       wfid = msg['wfid'] || (msg['fei']['wfid'] rescue nil)
       fei = msg['fei'] || (fexp.h.fei rescue nil)
@@ -88,8 +88,11 @@ module Ruote
         puts "..."
         puts
         puts "-- msg --"
+        key_length = msg.keys.collect { |k| k.length }.max + 1
         msg.keys.sort.each { |k|
-          puts "    #{k.inspect} =>\n#{msg[k].inspect}"
+          v = msg[k]
+          v = (Ruote.sid(v) rescue nil) if k == 'fei' || k == 'parent_id'
+          printf("%*s : %s\n", key_length, k, v.inspect)
         }
         puts "-- . --"
         puts
@@ -100,15 +103,20 @@ module Ruote
       return if fexp && fexp.handle_on_error(msg, exception)
 
       # emit 'msg'
+      #
+      # (this message might get intercepted by a tracker)
 
       @context.storage.put_msg(
         'error_intercepted',
-        'error_class' => exception.class.name,
-        'error_message' => exception.message,
-        'error_backtrace' => exception.backtrace,
-        # for backward compatibility
-        'message' => exception.inspect,
+        'error' => {
+          'fei' => fei,
+          'at' => Ruote.now_to_utc_s,
+          'class' => exception.class.name,
+          'message' => exception.message,
+          'trace' => backtrace
+        },
         'wfid' => wfid,
+        'fei' => fei,
         'msg' => msg)
 
       # fill error in the error journal