ruote 2.1.11 → 2.2.0

data/lib/ruote/util/hashdot.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
@@ -27,7 +27,7 @@ module Ruote
 
   module HashDot
 
-    def method_missing (m, *args)
+    def method_missing(m, *args)
 
       m = m.to_s
 
@@ -62,9 +62,9 @@ module Ruote
 
   module WithH
 
-    def self.included (target)
+    def self.included(target)
 
-      def target.h_reader (*names)
+      def target.h_reader(*names)
         names.each do |name|
           define_method(name) do
             @h[name.to_s]

data/lib/ruote/util/look.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
@@ -79,11 +79,7 @@ module Ruote
         next if uninteresting.include?(o.class)
 
         stats = h[o.class.to_s] ||= [ 0, 0, 0 ]
-        size = begin
-          Marshal.dump(o).size
-        rescue Exception => e
-          1
-        end
+        size = (Marshal.dump(o).size rescue 1)
 
         stats[0] += 1
         stats[1] = size if size > stats[1]

data/lib/ruote/util/lookup.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
@@ -29,7 +29,9 @@ module Ruote
   #
   #   p Ruote.lookup(h, 'a.b.1') # => 3
   #
-  def Ruote.lookup (collection, key, container_lookup=false)
+  def Ruote.lookup(collection, key, container_lookup=false)
+
+    return collection if key == '.'
 
     key, rest = pop_key(key)
     value = flookup(collection, key)
@@ -48,7 +50,7 @@ module Ruote
   #
   #   h #=> { 'customer' => { 'name' => 'bravo' } }
   #
-  def Ruote.set (collection, key, value)
+  def Ruote.set(collection, key, value)
 
     k, c = lookup(collection, key, true)
 
@@ -66,7 +68,7 @@ module Ruote
   #   h # => { 'customer' => { 'name' => 'alpha' } }
   #   r # => '1st'
   #
-  def Ruote.unset (collection, key)
+  def Ruote.unset(collection, key)
 
     k, c = lookup(collection, key, true)
 
@@ -81,14 +83,14 @@ module Ruote
 
   protected # well...
 
-  def Ruote.pop_key (key)
+  def Ruote.pop_key(key)
 
     ks = key.is_a?(String) ? key.split('.') : key
 
     [ narrow_key(ks.first), ks[1..-1] ]
   end
 
-  def Ruote.narrow_key (key)
+  def Ruote.narrow_key(key)
 
     return 0 if key == '0'
 
@@ -98,7 +100,7 @@ module Ruote
     key
   end
 
-  def Ruote.flookup (collection, key)
+  def Ruote.flookup(collection, key)
 
     value = (collection[key] rescue nil)
 

data/lib/ruote/util/misc.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,7 +35,7 @@ module Ruote
 
   # Prints the current call stack to stdout
   #
-  def self.p_caller (*msg)
+  def self.p_caller(*msg)
 
     puts
     puts "  == #{msg.inspect} =="
@@ -45,7 +45,7 @@ module Ruote
 
   # Deep object duplication
   #
-  def self.fulldup (object)
+  def self.fulldup(object)
 
     return object.fulldup if object.respond_to?(:fulldup)
       # trusting client objects providing a fulldup() implementation
@@ -82,7 +82,7 @@ module Ruote
       value = fulldup(value)
       begin
         o.instance_variable_set(v, value)
-      rescue Exception => e
+      rescue => e
         # ignore, must be readonly
       end
     end
@@ -94,21 +94,21 @@ module Ruote
   #
   # TODO : wouldn't it be better to simply use URI.parse() ?
   #
-  def self.is_uri? (s)
+  def self.is_uri?(s)
 
     s && (s.index('/') || s.match(/\.[^ ]+$/))
   end
 
   # Returns a neutralized version of s, suitable as a filename.
   #
-  def self.neutralize (s)
+  def self.neutralize(s)
 
     s.to_s.strip.gsub(/[ \/:;\*\\\+\?]/, '_')
   end
 
   # Tries to return an Integer or a Float from the given input. Returns
   #
-  def self.narrow_to_number (o)
+  def self.narrow_to_number(o)
 
     return o if [ Fixnum, Bignum, Float ].include?(o.class)
 
@@ -119,9 +119,41 @@ module Ruote
 
   # (simpler than the one from active_support)
   #
-  def self.constantize (s)
+  def self.constantize(s)
 
     s.split('::').inject(Object) { |c, n| n == '' ? c : c.const_get(n) }
   end
+
+#  # Upon receiving something like
+#  #
+#  #   "(?-mix:nada)"
+#  #
+#  # will return
+#  #
+#  #   /nada/
+#  #
+#  def self.regex_from_s(s)
+#
+#    if s.is_a?(String) && m = s.match(/^\(\?-mix:(.+)\)$/)
+#      Regexp.new(m[1])
+#    else
+#      nil
+#    end
+#  end
+
+  REGEX_IN_STRING = /^\s*\/(.*)\/\s*$/
+
+  #   regex_or_s("/nada/") #==> /nada/
+  #   regex_or_s("nada") #==> "nada"
+  #   regex_or_s(/nada/) #==> /nada/
+  #
+  def self.regex_or_s(s)
+
+    if s.is_a?(String) && m = REGEX_IN_STRING.match(s)
+      Regexp.new(m[1])
+    else
+      s
+    end
+  end
 end
 

data/lib/ruote/util/ometa.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

data/lib/ruote/util/serializer.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
@@ -82,19 +82,19 @@ module Ruote
       :marshal => MARSHAL, :marshal64 => MARSHAL64, :yaml => YAML
     }
 
-    def initialize (flavour)
+    def initialize(flavour)
 
       @flavour = FLAVOURS[flavour] || MARSHAL64
 
       @flavour[0].call # initializes the flavour
     end
 
-    def encode (o)
+    def encode(o)
 
       @flavour[1].call(o)
     end
 
-    def decode (s)
+    def decode(s)
 
       @flavour[2].call(s)
     end

data/lib/ruote/util/subprocess.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,7 +32,7 @@ module Ruote
   # This method is used by the 'subprocess' expression and by the
   # EngineParticipant.
   #
-  def self.lookup_subprocess (fexp, ref)
+  def self.lookup_subprocess(fexp, ref)
 
     val = fexp.lookup_variable(ref)
 
@@ -43,10 +43,11 @@ module Ruote
 
     # maybe subprocess :ref => 'uri'
 
-    subtree = fexp.context.parser.parse(ref) rescue nil
+    subtree = fexp.context.reader.read(ref) rescue nil
 
-    _, subtree = Ruote::Exp::DefineExpression.reorganize(subtree) \
-      if subtree && Ruote::Exp::DefineExpression.is_definition?(subtree)
+    if subtree && is_definition_tree?(subtree)
+      _, subtree = Ruote::Exp::DefineExpression.reorganize(subtree)
+    end
 
     return [ '0', subtree ] if is_tree?(subtree)
 
@@ -55,14 +56,33 @@ module Ruote
     raise "no subprocess named '#{ref}' found"
   end
 
-  def self.is_tree? (a)
+  # Returns true if the argument is a process definition tree (whose root
+  # is 'define', 'process_definition' or 'workflow_definition'.
+  #
+  def self.is_definition_tree?(arg)
+
+    Ruote::Exp::DefineExpression.is_definition?(arg) && is_tree?(arg)
+  end
 
-    a.is_a?(Array) && a[1].is_a?(Hash) && a.size == 3
+  # Returns true if the given argument is a process definition tree
+  # (its root doesn't need to be 'define' or 'process_definition' though).
+  #
+  def self.is_tree?(arg)
+
+    arg.is_a?(Array) && arg.size == 3 &&
+    arg[0].is_a?(String) && arg[1].is_a?(Hash) && arg[2].is_a?(Array) &&
+    (arg.last.empty? || arg.last.find { |e| ! is_tree?(e) }.nil?)
   end
 
-  def self.is_pos_tree? (a)
+  # Mainly used by Ruote.lookup_subprocess, returns true if the argument is
+  # is an array [ position, tree ].
+  #
+  def self.is_pos_tree?(arg)
 
-    a.is_a?(Array) && a.size == 2 && a[0].is_a?(String) && is_tree?(a[1])
+    arg.is_a?(Array) &&
+    arg.size == 2 &&
+    arg[0].is_a?(String) &&
+    is_tree?(arg[1])
   end
 end
 

data/lib/ruote/util/time.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
@@ -45,7 +45,7 @@ module Ruote
   #
   # like "2009/11/23 11:11:50.947109 UTC"
   #
-  def self.time_to_utc_s (t)
+  def self.time_to_utc_s(t)
 
     "#{t.utc.strftime('%Y-%m-%d %H:%M:%S')}.#{sprintf('%06d', t.usec)} UTC"
   end
@@ -63,7 +63,7 @@ module Ruote
   #
   # (my prose is weak)
   #
-  def self.s_to_at (s)
+  def self.s_to_at(s)
 
     at = if s.index(' ')
       #
@@ -87,7 +87,7 @@ module Ruote
 
   # Waiting for a better implementation of it in rufus-scheduler 2.0.4
   #
-  def self.is_cron_string (s)
+  def self.is_cron_string(s)
 
     ss = s.split(' ')
 

data/lib/ruote/util/tree.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
@@ -28,7 +28,7 @@ module Ruote
   # Turning a tree into a numbered string view
   #
   #   require 'ruote/util/tree'
-  #   require 'ruote/parser/ruby_dsl'
+  #   require 'ruote/reader/ruby_dsl'
   #
   #   pdef = Ruote.process_definition :name => 'def0' do
   #     sequence do
@@ -47,7 +47,7 @@ module Ruote
   #     #        0_0_0  alpha {}
   #     #        0_0_1  bravo {}
   #
-  def Ruote.tree_to_s (tree, expid='0')
+  def Ruote.tree_to_s(tree, expid='0')
 
     d = expid.split('_').size - 1
     s = "#{' ' * d * 2}#{expid}  #{tree[0]} #{tree[1].inspect}\n"

data/lib/ruote/version.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
@@ -23,6 +23,6 @@
 #++
 
 module Ruote
-  VERSION = '2.1.11'
+  VERSION = '2.2.0'
 end
 

data/lib/ruote/worker.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
@@ -47,7 +47,9 @@ module Ruote
     attr_reader :run_thread
     attr_reader :running
 
-    def initialize (storage)
+    # Given a storage, creates a new instance of a Worker.
+    #
+    def initialize(storage)
 
       @subscribers = []
         # must be ready before the storage is created
@@ -93,17 +95,21 @@ module Ruote
       @run_thread.join if @run_thread
     end
 
-    def subscribe (actions, subscriber)
+    # Loggers and trackers call this method when subscribing for events /
+    # actions in this worker.
+    #
+    def subscribe(actions, subscriber)
 
       @subscribers << [ actions, subscriber ]
     end
 
+    # Shuts down this worker (makes sure it won't fetch further messages
+    # and schedules).
+    #
     def shutdown
 
       @running = false
 
-      return unless @run_thread
-
       begin
         @run_thread.join
       rescue Exception => e
@@ -138,6 +144,9 @@ module Ruote
 
     protected
 
+    # One worker step, fetches schedules and triggers those whose time has
+    # came, then fetches msgs and processes them.
+    #
     def step
 
       now = Time.now.utc
@@ -149,9 +158,7 @@ module Ruote
 
         @last_time = now
 
-        @storage.get_schedules(delta, now).each do |sche|
-          trigger(sche)
-        end
+        @storage.get_schedules(delta, now).each { |sche| trigger(sche) }
       end
 
       # msgs
@@ -193,7 +200,14 @@ module Ruote
       end
     end
 
-    def trigger (schedule)
+    # Given a schedule, attempts to trigger it.
+    #
+    # It first tries to
+    # reserve the schedule. If the reservation fails (another worker
+    # was successful probably), false is returned. The schedule is
+    # triggered if the reservation was successful, true is returned.
+    #
+    def trigger(schedule)
 
       msg = Ruote.fulldup(schedule['msg'])
 
@@ -204,9 +218,17 @@ module Ruote
       true
     end
 
-    def process (msg)
-
-      return false if cannot_handle(msg)
+    # Processes one msg.
+    #
+    # Will return false immediately if the msg reservation failed (another
+    # worker grabbed the message.
+    #
+    # Else will execute the action ordered in the msg, and return true.
+    #
+    # Exceptions in execution are intercepted here and passed to the
+    # engine's (context's) error_handler.
+    #
+    def process(msg)
 
       return false unless @storage.reserve(msg)
 
@@ -238,7 +260,7 @@ module Ruote
 
         notify(msg)
 
-      rescue Exception => exception
+      rescue => exception
 
         @context.error_handler.msg_handle(msg, exception)
       end
@@ -246,7 +268,10 @@ module Ruote
       true
     end
 
-    def notify (msg)
+    # Given a successfully executed msg, now notifies all the subscribers
+    # interested in the kind of action the msg ordered.
+    #
+    def notify(msg)
 
       @subscribers.each do |actions, subscriber|
 
@@ -256,20 +281,12 @@ module Ruote
       end
     end
 
-    # Should always return false. Except when the message is a 'dispatch'
-    # and it's for a participant only available to an 'engine_worker'
-    # (block participants, stateful participants)
-    #
-    def cannot_handle (msg)
-
-      return false if msg['action'] != 'dispatch'
-
-      @context.engine.nil? && msg['for_engine_worker?']
-    end
-
     # Works for both the 'launch' and the 'apply' msgs.
     #
-    def launch (msg)
+    # Creates a new expression, gives and applies it with the
+    # workitem contained in the msg.
+    #
+    def launch(msg)
 
       tree = msg['tree']
       variables = msg['variables']
@@ -283,7 +300,7 @@ module Ruote
         'fei' => msg['fei'] || {
           'engine_id' => @context.engine_id,
           'wfid' => msg['wfid'],
-          'sub_wfid' => msg['sub_wfid'],
+          'subid' => Ruote.generate_subid(msg.inspect),
           'expid' => '0' },
         'parent_id' => msg['parent_id'],
         'original_tree' => tree,
@@ -296,7 +313,6 @@ module Ruote
 
         exp_class = Ruote::Exp::RefExpression
 
-      #elsif msg['action'] == 'launch' && exp_class == Ruote::Exp::DefineExpression
       elsif is_launch?(msg, exp_class)
 
         def_name, tree = Ruote::Exp::DefineExpression.reorganize(tree)
@@ -307,17 +323,24 @@ module Ruote
       exp = exp_class.new(@context, exp_hash.merge!('original_tree' => tree))
 
       exp.initial_persist
-      exp.do_apply
+      exp.do_apply(msg)
     end
 
-    def is_launch? (msg, exp_class)
+    # Returns true if the msg is a "launch" (ie not a simply "apply").
+    #
+    def is_launch?(msg, exp_class)
 
       return false if exp_class != Ruote::Exp::DefineExpression
       return true if msg['action'] == 'launch'
       (msg['trigger'] == 'on_re_apply')
     end
 
-    def cancel_process (msg)
+    # Handles a 'cancel_process' msg (translates it into a "cancel root
+    # expression of that process" msg).
+    #
+    # Also works for 'kill_process' msgs.
+    #
+    def cancel_process(msg)
 
       root = @storage.find_root_expression(msg['wfid'])
 
@@ -332,7 +355,7 @@ module Ruote
         'flavour' => flavour)
     end
 
-    alias :kill_process :cancel_process
+    alias kill_process cancel_process
   end
 end