ruote 2.1.7 → 2.1.8

data/CHANGELOG.txt

@@ -2,6 +2,19 @@
 = ruote - CHANGELOG.txt
 
 
+== ruote - 2.1.8    released 2010/03/15
+
+- participant#schedule_timeout workaround for issue with JRuby 1.4.0 (1.8.7)
+- implemented Ruote::CompositeStorage
+- leveraging rufus-cloche 0.1.16 and the 'cloche_nolock' option (FsStorage)
+- SmtpParticipant and ruote/part/template.rb reorganization
+- StorageParticipant when returned by engine#register was unusable. Fixed.
+- string keys for SmtpParticipant. Thanks Gonzalo
+- fixed every('10m') bug. Thanks Gonzalo Suarez
+- Ruote::FlowExpressionId.from_id(s) more permissive
+- concurrence (and concurrent-iterator) :merge_type => :stack
+
+
 == ruote - 2.1.7    released 2010/02/15
 
 - now works on WinXP, Ruby 1.8.7

data/CREDITS.txt

@@ -38,7 +38,8 @@ Richard Jennings
 Feedback
 --------
 
-Francisco Kiko - "is set" issue
+Gonzalo Suarez - many help
+Francisco Kiko - many help
 David Goldhirsch - EM participant block
 dlamotte - set :val => nil
 jpr5 + asm

data/Rakefile

@@ -24,15 +24,16 @@ ruote is an open source ruby workflow engine.
     gem.test_file = 'test/test.rb'
 
     gem.add_dependency 'rufus-json', '>= 0.2.0'
-    gem.add_dependency 'rufus-cloche', '>= 0.1.14'
+    gem.add_dependency 'rufus-cloche', '>= 0.1.16'
     gem.add_dependency 'rufus-dollar'
     gem.add_dependency 'rufus-lru'
     gem.add_dependency 'rufus-mnemo', '>= 1.1.0'
-    gem.add_dependency 'rufus-scheduler', '>= 2.0.3'
+    gem.add_dependency 'rufus-scheduler', '>= 2.0.5'
     gem.add_dependency 'rufus-treechecker', '>= 1.0.3'
 
-    gem.add_development_dependency 'json'
+    gem.add_development_dependency 'rake'
     gem.add_development_dependency 'yard'
+    gem.add_development_dependency 'json'
     gem.add_development_dependency 'builder'
     gem.add_development_dependency 'mailtrap'
     gem.add_development_dependency 'jeweler'

data/TODO.txt

@@ -191,6 +191,8 @@
 [o] StorageParticipant#query(wfid, participant_name, {fields})
 [x] break fs_history, prepare for dm_history
 [o] part = engine.register_participant :alpha, StorageParticipant should work...
+[o] concurrence :merge_type => 'stack'
+[o] CompositeStorage.new('msgs' => AmqpStorage.new(''), ...)
 
 [ ] exp : exp (restricted form of eval ?)
 [ ] exp : case (is it necessary ?)
@@ -301,9 +303,17 @@
 [ ] implement pause engine
 [ ] implement pause process
 
-[ ] engine.on_error = 'participant_name'
+[ ] engine.on_error = 'participant_name' // 'subprocess_name'
 
 [ ] "business days" plugin
 
 [ ] issue with ruote-kit and inpa participants...
 
+[ ] let the storage participant leverage Ruote::FlowExpressionId.from_id(s)
+
+[ ] participant :ref => '${f:nada}', :or => 'xyz'
+    (look at OpenWFE manual, this feature already existed in there)
+    http://www.openwfe.org/manual/ch06s02.html#expression_participant
+    else-ref... list of participants...
+    ref="alpha && bravo", ref="alpha||bravo" (|| parallel :( )
+

data/lib/ruote/exp/fe_concurrence.rb

@@ -90,7 +90,7 @@ module Ruote::Exp
   # highest and lowest refer to the position in the list of branch. It's useful
   # to set a fixed winner.
   #
-  #   concurrence :merge => highest do
+  #   concurrence :merge => :highest do
   #     alpha
   #     bravo
   #   end
@@ -109,6 +109,30 @@ module Ruote::Exp
   # a new field for each branch. The name of each field is the index of the
   # branch from '0' to ...
   #
+  # :stack will stack the workitems coming back from the concurrence branches
+  # in an array whose order is determined by the :merge attributes. The array
+  # is placed in the 'stack' field of the resulting workitem.
+  # Note that the :stack merge_type also creates a 'stack_attributes' field
+  # and populates it with the expanded attributes of the concurrence.
+  #
+  # Thus
+  #
+  #   sequence do
+  #     concurrence :merge => :highest, :merge_type => :stack do
+  #       reviewer1
+  #       reviewer2
+  #     end
+  #     editor
+  #   end
+  #
+  # will see the 'editor' receive a workitem whose fields look like :
+  #
+  #   { 'stack' => [{ ... reviewer1 fields ... }, { ... reviewer2 fields ... }],
+  #     'stack_attributes' => { 'merge'=> 'highest', 'merge_type' => 'stack' } }
+  #
+  # This could prove useful for participant having to deal with multiple merge
+  # strategy results.
+  #
   #
   # === :over_if (and :over_unless)
   #
@@ -140,7 +164,7 @@ module Ruote::Exp
       h.ccount = nil if h.ccount < 1
 
       h.cmerge = att(:merge, %w[ first last highest lowest ])
-      h.cmerge_type = att(:merge_type, %w[ override mix isolate ])
+      h.cmerge_type = att(:merge_type, %w[ override mix isolate stack ])
       h.remaining = att(:remaining, %w[ cancel forget ])
 
       h.workitems = (h.cmerge == 'first' || h.cmerge == 'last') ? [] : {}

data/lib/ruote/exp/fe_participant.rb

@@ -201,7 +201,7 @@ module Ruote::Exp
 
       timeout =
         attribute(:timeout) ||
-        (p_info.respond_to?(:timeout) ? p_info.timeout : nil) ||
+        (p_info.timeout rescue nil) ||
         (p_info.is_a?(Array) ? p_info.last['timeout'] : nil)
 
       do_schedule_timeout(timeout)

data/lib/ruote/exp/merge.rb

@@ -45,18 +45,25 @@ module Ruote::Exp
 
       return source if type == 'override'
 
-      source['fields'] = {
-        index.to_s => source['fields']
-      } if target == nil && type == 'isolate'
-        #
-        # index.to_s since JSON wants string keys.
+      if target == nil
+        case type
+          when 'isolate'
+            source['fields'] = { index.to_s => source['fields'] }
+          when 'stack'
+            source['fields'] = { 'stack' => [ source['fields'] ] }
+        end
+      end
 
       return source unless target
 
-      if type == 'mix'
-        target['fields'].merge!(source['fields'])
-      else # 'isolate'
-        target['fields'][index.to_s] = source['fields']
+      case type
+        when 'mix'
+          target['fields'].merge!(source['fields'])
+        when 'stack'
+          target['fields']['stack'] << source['fields']
+          target['fields']['stack_attributes'] = expand_atts
+        else # 'isolate'
+          target['fields'][index.to_s] = source['fields']
       end
 
       target

data/lib/ruote/fei.rb

@@ -92,7 +92,7 @@ module Ruote
 
       FlowExpressionId.new(
         'engine_id' => engine_id,
-        'expid' => ss[0], 'sub_wfid' => ss[1], 'wfid' => ss[2])
+        'expid' => ss[-3], 'sub_wfid' => ss[-2], 'wfid' => ss[-1])
     end
 
     # Returns the last number in the expid. For instance, if the expid is

data/lib/ruote/parser.rb

@@ -65,7 +65,8 @@ module Ruote
       end
 
       raise ArgumentError.new(
-        "doesn't know how to parse definition (#{definition.class})")
+        "doesn't know how to parse definition (#{definition.class}) " +
+        "or error in process definition")
     end
 
     # Class method for parsing process definition (XML, Ruby, from file or

data/lib/ruote/part/smtp_participant.rb

@@ -31,8 +31,7 @@ require 'ruote/part/template'
 module Ruote
 
   #
-  # A very stupid SMTP participant, doesn't even care about formatting its
-  # messages. This class is meant as a base for more complex email participants.
+  # A very stupid SMTP participant.
   #
   # == options
   #
@@ -43,10 +42,11 @@ module Ruote
   # * :template - a String template for the mail message
   # * :notification - when set to true, the flow will resume immediately after having sent the email
   #
+  #
   # == :template
   #
   #   @engine.register_participant(
-  #     :no_good_notification
+  #     :no_good_notification,
   #     Ruote::SmtpParticipant,
   #     :server => 'smtp.example.com'
   #     :port => 25,
@@ -59,33 +59,18 @@ module Ruote
   # process definitions (in this example, the workitem field email_subject will
   # be used as the subject of the email...)
   #
-  # == block template
-  #
-  # Whereas the :template option accepts a String, the block template may
-  # be useful when more complex templates are to be computed.
   #
-  #   @engine.register_participant(
-  #     :no_good_notification
-  #     Ruote::SmtpParticipant,
-  #     :server => 'smtp.example.com'
-  #     :port => 25,
-  #     :to => 'toto@example.com',
-  #     :from => 'john@example.com',
-  #     :notification => true
-  #   ) do
+  # == :to or workitem.fields['email_target']
   #
-  #     s = []
-  #     s << "From: the boss"
-  #     s << "Date: ${r:Time.now.rfc2822}"
-  #     s << "Subject: ${f:email_subject}\n"
-  #     s << ""
-  #     3.times { s << "this is no good." }
+  # The target of the email is either given via the workitem field
+  # 'email_target', either by the option :to. The workitem field takes
+  # precedence if both are present.
   #
-  #     s.join("\n")
-  #   end
+  # This parameter/option may be either a single (string) email address, either
+  # an array of (string) email addresses.
   #
   #
-  # == mail listener
+  # == final note : mail listener
   #
   # This participant cannot read POP/IMAP accounts for you. You have to
   # use a mail listener or get a web reply by placing a link in the message...
@@ -95,33 +80,29 @@ module Ruote
     include LocalParticipant
     include TemplateMixin
 
-    def initialize (opts={}, &block)
-
-      @server = opts[:server] || '127.0.0.1'
-      @port = opts[:port] || 25
+    def initialize (opts)
 
-      @from = opts[:from]
-      @to = opts[:to]
-
-      @template = opts[:template]
-      @block_template = block
-
-      @notification = opts[:notification]
+      @opts = opts.inject({}) { |h, (k, v)| h[k.to_s] = v; h }
     end
 
     def consume (workitem)
 
-      to = workitem.fields['email_target'] || @to
+      to = workitem.fields['email_target'] || @opts['to']
       to = Array(to)
 
       text = render_template(
-        Ruote::Exp::FlowExpression.fetch(@context, workitem.fei.to_h), workitem)
+        @opts['template'],
+        Ruote::Exp::FlowExpression.fetch(@context, workitem.fei.to_h),
+        workitem)
+
+      server = @opts['server'] || '127.0.0.1'
+      port = @opts['port'] || 25
 
-      Net::SMTP.start(@server, @port) do |smtp|
-        smtp.send_message(text, @from, *to)
+      Net::SMTP.start(server, port) do |smtp|
+        smtp.send_message(text, @opts['from'] || 'ruote@example.org', *to)
       end
 
-      reply_to_engine(workitem) if @notification
+      reply_to_engine(workitem) if @opts['notification']
     end
 
     def cancel (fei, flavour)

data/lib/ruote/part/storage_participant.rb

@@ -31,7 +31,24 @@ module Ruote
   # A participant that stores the workitem in the same storage used by the
   # engine and the worker(s).
   #
-  # Does not thread by default.
+  #   part = engine.register_participant 'alfred', Ruote::StorageParticipant
+  #
+  #   # ... a bit later
+  #
+  #   puts "workitems still open : "
+  #   part.each do |workitem|
+  #     puts "#{workitem.fei.wfid} - #{workitem.fields['params']['task']}"
+  #   end
+  #
+  #   # ... when done with a workitem
+  #
+  #   part.reply(workitem)
+  #     # this will remove the workitem from the storage and hand it back
+  #     # to the engine
+  #
+  # Does not thread by default (the engine will not spawn a dedicated thread
+  # to handle the delivery to this participant, the workitem will get stored
+  # via the main engine thread and basta).
   #
   class StorageParticipant
 
@@ -44,6 +61,8 @@ module Ruote
 
       if engine_or_options.respond_to?(:context)
         @context = engine_or_options.context
+      elsif engine_or_options.is_a?(Ruote::Context)
+        @context = engine_or_options
       else
         options = engine_or_options
       end

data/lib/ruote/part/template.rb

@@ -22,41 +22,57 @@
 # Made in Japan.
 #++
 
+require 'rufus/json'
+require 'ruote/util/dollar'
+
 
 module Ruote
 
   #
-  # This mixin expects that the class that includes it has a @template
-  # or a @block_template instance variable.
+  # Template rendering helper.
+  #
+  # (Currently only used by the SmtpParticipant, could prove useful for
+  # custom participants)
   #
   module TemplateMixin
 
-    def render_template (flow_expression, workitem)
+    def render_template (template, flow_expression, workitem)
 
-      template = if @block_template
+      template = (File.read(template) rescue nil) if is_a_file?(template)
 
-        case @block_template.arity
-          when 1 then @block_template.call(workitem)
-          when 2 then @block_template.call(workitem, flow_expression)
-          else @block_template.call(workitem, flow_expression, self)
-        end
+      return render_default_template(workitem) unless template
 
-      elsif @template
+      template = template.to_s
+      workitem = workitem.to_h if workitem.respond_to?(:to_h)
 
-        @template.is_a?(File) ? @template.read : @template.to_s
+      Ruote.dosub(template, flow_expression, workitem)
+    end
 
-      else
+    # Simply returns a pretty-printed view of the workitem
+    #
+    def render_default_template (workitem)
 
-        nil
+      workitem = workitem.to_h if workitem.respond_to?(:to_h)
+
+      s = []
+      s << "workitem for #{workitem['participant_name']}"
+      s << ''
+      s << Rufus::Json.encode(workitem['fei'])
+      s << ''
+      workitem['fields'].keys.sort.each do |key|
+        s << " - '#{key}'  ==>  #{Rufus::Json.encode(workitem['fields'][key])}"
       end
+      s.join("\n")
+    end
 
-      raise(
-        ArgumentError.new('no @template or @block_template found')
-      ) unless template
+    protected
 
-      workitem = workitem.to_h if workitem.respond_to?(:to_h)
+    def is_a_file? (s)
 
-      Ruote.dosub(template, flow_expression, workitem)
+      return false unless s
+      return false if s.index("\n")
+
+      File.exist?(s)
     end
   end
 end

data/lib/ruote/storage/base.rb

@@ -32,12 +32,6 @@ module Ruote
   #
   module StorageBase
 
-    def reserve (doc)
-
-      #(delete(doc) != true)
-      delete(doc).nil?
-    end
-
     #--
     # configurations
     #++
@@ -143,8 +137,8 @@ module Ruote
     def put_schedule (flavour, owner_fei, s, msg)
 
       at = if s.is_a?(Time) # at or every
-        at
-      elsif is_cron_string(s) # cron
+        s
+      elsif Ruote.is_cron_string(s) # cron
         Rufus::CronLine.new(s).next_time(Time.now + 1)
       else # at or every
         Ruote.s_to_at(s)
@@ -210,18 +204,6 @@ module Ruote
 
       scheds.select { |sched| sched['at'] <= now }
     end
-
-    # Waiting for a better implementation of it in rufus-scheduler 2.0.4
-    #
-    def is_cron_string (s)
-
-      ss = s.split(' ')
-
-      return false if ss.size < 5 || ss.size > 6
-      return false if s.match(/\d{4}/)
-
-      true
-    end
   end
 end