ruote 2.3.0.1 → 2.3.0.2

data/lib/ruote/observer.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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/part/block_participant.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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/part/code_participant.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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/part/engine_participant.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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/part/local_participant.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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
@@ -57,6 +57,14 @@ module Ruote
     #
     attr_accessor :flavour
 
+    # Set right before a call to #on_error
+    #
+    attr_accessor :error
+
+    # Set right before a call to #on_error
+    #
+    attr_accessor :msg
+
     # Returns the current workitem if no fei is given.
     # If a fei is given, it will return the applied workitem for that fei
     # (if any).

data/lib/ruote/part/no_op_participant.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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/part/null_participant.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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/part/participant.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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/part/rev_participant.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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/part/smtp_participant.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, Alain Hoang and John Mettraux.
+# Copyright (c) 2005-2013, Alain Hoang and John Mettraux.
 #
 # 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/part/storage_participant.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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
@@ -106,6 +106,23 @@ module Ruote
       r.is_a?(Hash) ? Ruote::Workitem.new(r) : r
     end
 
+    # Added for https://groups.google.com/forum/?fromgroups#!topic/openwferu-users/5bpV2yfKwM0
+    #
+    # Makes sure the workitem get saved to the storage. Fails if the workitem
+    # is already gone.
+    # Returns nil in case of success.
+    #
+    def do_update(workitem=@workitem)
+
+      r = update(workitem)
+
+      fail ArgumentError.new("workitem is gone") if r == true
+      return nil if r.nil?
+
+      r.h['fields'] = workitem.fields
+      do_update(r)
+    end
+
     # Removes the document/workitem from the storage.
     #
     # Warning: this method is called by the engine (worker), i.e. not by you.

data/lib/ruote/part/template.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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/reader.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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/reader/json.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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/reader/radial.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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
@@ -63,16 +63,16 @@ module Ruote
 
       rule(:string) {
         str('"') >> (
-          str('\\') >> any | str('"').absent? >> any
+          str('\\') >> any | match('[^"]')
         ).repeat.as(:string) >> str('"') |
         str("'") >> (
-          str('\\') >> any | str("'").absent? >> any
+          str('\\') >> any | match("[^']")
         ).repeat.as(:string) >> str("'")
       }
 
       rule(:regex) {
         str('/') >> (
-          str('\\') >> any | str('/').absent? >> any
+          str('\\') >> any | match("[^\/]")
         ).repeat.as(:regex) >> str('/')
       }
 

data/lib/ruote/reader/ruby_dsl.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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/reader/xml.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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/receiver/base.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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
@@ -129,8 +129,20 @@ module Ruote
     #
     def launch(process_definition, fields={}, variables={}, root_stash=nil)
 
+      puts caller.select { |l|
+        ! (l.match(/test\/unit[\.\/]/) or l.match(/\/rspec-core-/))
+      } if @context.logger.noisy
+        #
+        # this is useful when noisy and running through a set of tests
+
       wfid = fields[:wfid] || @context.wfidgen.generate
 
+      fields = Rufus::Json.dup(fields)
+      variables = Rufus::Json.dup(variables)
+      root_stash = Rufus::Json.dup(root_stash)
+        #
+        # making sure symbols are turned to strings
+
       @context.storage.put_msg(
         'launch',
         'wfid' => wfid,

data/lib/ruote/storage/base.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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
@@ -55,19 +55,12 @@ module Ruote
       delete(doc).nil?
     end
 
-    # A helper for the #worker method, it returns that dummy worker
-    # when there is no reference to the calling worker in the current
-    # thread's local variables.
-    #
-    DUMMY_WORKER = OpenStruct.new(
-      :name => 'worker', :identity => 'unknown', :state => 'running')
-
     # Warning, this is not equivalent to doing @context.worker, this method
     # fetches the worker from the local thread variables.
     #
     def worker
 
-      Thread.current['ruote_worker'] || DUMMY_WORKER
+      Ruote.current_worker
     end
 
     #--
@@ -164,7 +157,10 @@ module Ruote
     # trackers
     #++
 
-    def get_trackers
+    # Some storage implementation might need the wfid information when
+    # adding or removing trackers.
+    #
+    def get_trackers(wfid=nil)
 
       get('variables', 'trackers') ||
         { '_id' => 'trackers', 'type' => 'variables', 'trackers' => {} }
@@ -341,7 +337,7 @@ module Ruote
 
       at = if s.is_a?(Time) # at or every
         s
-      elsif Ruote.is_cron_string(s) # cron
+      elsif Ruote.cron_string?(s) # cron
         Rufus::CronLine.new(s).next_time(Time.now + 1)
       else # at or every
         Ruote.s_to_at(s)
@@ -400,9 +396,7 @@ module Ruote
       end
     end
 
-    # (Only used by ruote-couch 2.2.x)
-    #
-    # TODO: remove me at some point
+    # Used by ruote-couch and ruote-asw
     #
     def self.key_match?(keys, doc)
 

data/lib/ruote/storage/composite_storage.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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/storage/fs_storage.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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/storage/hash_storage.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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
@@ -77,6 +77,7 @@ module Ruote
 
         doc['put_at'] = Ruote.now_to_utc_s
         doc['_rev'] = doc['_rev'] + 1
+        doc = Ruote.keys_to_s(doc)
 
         @h[doc['type']][doc['_id']] = Rufus::Json.dup(doc)
 

data/lib/ruote/svc/dispatch_pool.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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
@@ -41,22 +41,24 @@ module Ruote
 
     def handle(msg)
 
-      case msg['action']
-        when 'dispatch' then dispatch(msg)
-        when 'dispatch_cancel' then dispatch_cancel(msg)
-        when 'dispatch_pause', 'dispatch_resume' then dispatch_pause(msg)
-        else # simply discard the message
-      end
+      return unless msg['action'].match(/^dispatch/)
+
+      send(msg['action'], msg)
     end
 
     protected
 
+    # Dispatching the msg.
+    #
     def dispatch(msg)
 
       participant = @context.plist.lookup(
         msg['participant'] || msg['participant_name'], msg['workitem'])
 
-      if (@context['participant_threads_enabled'] == false) || do_not_thread?(participant, msg)
+      if
+        @context['participant_threads_enabled'] == false ||
+        do_not_thread?(participant, msg)
+      then
         do_dispatch(participant, msg)
       else
         do_threaded_dispatch(participant, msg)
@@ -65,7 +67,10 @@ module Ruote
 
     # The actual dispatching (call to Participant#consume or #on_workitem).
     #
-    def do_dispatch(participant, msg)
+    # No error rescuing so it might be interesting for some extension
+    # classes (like in ruote-swf).
+    #
+    def do_raw_dispatch(participant, msg)
 
       workitem = Ruote::Workitem.new(msg['workitem'])
 
@@ -83,6 +88,16 @@ module Ruote
           # participant expression as 'dispatched'
     end
 
+    # The raw dispatch work, wrapped in error handling.
+    #
+    def do_dispatch(participant, msg)
+
+      do_raw_dispatch(participant, msg)
+
+    rescue => err
+      @context.error_handler.msg_handle(msg, err)
+    end
+
     # Wraps the call to do_dispatch in a thread.
     #
     def do_threaded_dispatch(participant, msg)
@@ -97,15 +112,7 @@ module Ruote
       # would be OK.
       # Or maybe it's the job of an extension / subclass
 
-      Thread.new do
-        begin
-
-          do_dispatch(participant, msg)
-
-        rescue => exception
-          @context.error_handler.msg_handle(msg, exception)
-        end
-      end
+      Thread.new { do_dispatch(participant, msg) }
     end
 
     # Returns true if the participant doesn't want the #consume to happen
@@ -165,6 +172,10 @@ module Ruote
         action,
         'fei' => Ruote::FlowExpressionId.new(msg['fei']), :default => false)
     end
+
+    # Route to dispatch_pause which handles both pause and resume.
+    #
+    alias dispatch_resume dispatch_pause
   end
 
   # Given a participant, a method name or an array of method names and

data/lib/ruote/svc/dollar_sub.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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
@@ -91,20 +91,17 @@ module Ruote
     #
     def literal_sub(s, fexp, wi)
 
-      result = case s
-        when /^\$([^{}:])$/, /^\$(?:field|fld|f):([^{}]+)$/
-          Ruote.lookup(wi['fields'], $~[1])
-        when /^\$(?:variable|var|v):([^{}]+)$/
+      case s
+        when /^\$(?:variable|var|v):([^{}\s\$]+)$/
           fexp.lookup_variable($~[1])
+        when /^\$([^{}:\s\$]+)$/, /^\$(?:field|fld|f):([^{}\s\$]+)$/
+          Ruote.lookup(wi['fields'], $~[1])
         else
           s
       end
-
-      result.nil? ? s : result
     end
   end
 
-
   #
   # A mini-namespace Ruote::Dollar for Dict and RubyContext, just to separate
   # them from the rest of Ruote.

data/lib/ruote/svc/error_handler.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2013, 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