ruote 2.2.0 → 2.3.0

data/lib/ruote/workitem.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2011, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2012, 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
@@ -88,7 +88,7 @@ module Ruote
     #
     def fei
 
-      FlowExpressionId.new(h.fei)
+      FlowExpressionId.new(@h['fei'])
     end
 
     # Returns a complete copy of this workitem.
@@ -107,6 +107,45 @@ module Ruote
       @h['participant_name']
     end
 
+    # Returns the name of the workflow to which this workitem belongs, or nil.
+    #
+    def wf_name; @h['wf_name']; end
+
+    # Returns the revision of the workflow to which this workitem belongs,
+    # or nil.
+    #
+    def wf_revision; @h['wf_revision']; end
+
+    # Returns the UTC time string indicating when the workflow was launched.
+    #
+    def wf_launched_at; @h['wf_launched_at']; end
+
+    alias launched_at wf_launched_at
+    alias definition_name wf_name
+    alias definition_revision wf_revision
+
+    # Returns the name of the sub-workflow the workitem is currently in.
+    # (If it's in the main flow, it will return the name of the main flow,
+    # if that flow has a name...)
+    #
+    def sub_wf_name; @h['sub_wf_name']; end
+
+    # The equivalent of #sub_wf_name for revisions.
+    #
+    def sub_wf_revision; @h['sub_wf_revision']; end
+
+    # Returns the UTC time string indicating when the sub-workflow was launched.
+    #
+    def sub_wf_launched_at; @h['sub_wf_launched_at']; end
+
+    # Used by some participants, returns the "owner" of the workitem. Mostly
+    # used when reserving workitems.
+    #
+    def owner
+
+      @h['owner']
+    end
+
     # Returns the payload, ie the fields hash.
     #
     def fields
@@ -205,6 +244,32 @@ module Ruote
       Ruote.set(@h['fields'], key, value)
     end
 
+    # Shortcut for #lookup(key)
+    #
+    #   workitem.fields['customer']['city']
+    #     # or
+    #   workitem.lookup('customer.city')
+    #     # or
+    #   workitem['customer.city']
+    #
+    def [](key)
+
+      lookup(key.to_s)
+    end
+
+    # Shortcut for #set_field(key, value)
+    #
+    #   workitem.fields['customer']['city'] = 'Toronto'
+    #     # or
+    #   workitem.set_field('customer.city', 'Toronto')
+    #     # or
+    #   workitem['customer.city'] = 'Toronto'
+    #
+    def []=(key, value)
+
+      set_field(key.to_s, value)
+    end
+
     # Shortcut for wi.fields['__timed_out__']
     #
     def timed_out
@@ -232,7 +297,63 @@ module Ruote
     #
     def params
 
-      @h['fields']['params']
+      @h['fields']['params'] || {}
+    end
+
+    # When a participant is invoked like in
+    #
+    #    accounting 'do_invoice', :customer => 'acme corp'
+    #
+    # then
+    #
+    #    p workitem.params
+    #      # => { 'ref' => 'accounting', 'do_invoice' => nil, 'customer' => 'acme corp' }
+    #
+    # and
+    #
+    #    p workitem.param_text
+    #      # => 'do_invoice'
+    #
+    # It returns nil when there is no text passed directly.
+    #
+    def param_text
+
+      (params.find { |k, v| v.nil? } || []).first
+    end
+
+    # Sometimes a value is passed as a[n expression] parameter or as a
+    # workitem field, with priority to the parameter.
+    #
+    #   sequence do
+    #     set 'f:country' => 'uruguay'
+    #     participant 'toto'
+    #       # in toto, workitem.param_or_field(:country) will yield 'uruguay'
+    #     participant 'toto', :country => 'argentina'
+    #       # workitem.param_or_field(:country) will yield 'argentina'
+    #   end
+    #
+    def param_or_field(key)
+
+      key = key.to_s
+
+      (@h['fields']['params'] || {})[key] || @h['fields'][key]
+    end
+
+    # Like #param_or_field, but priority is given to the field.
+    #
+    def field_or_param(key)
+
+      key = key.to_s
+
+      @h['fields'][key] || (@h['fields']['params'] || {})[key]
+    end
+
+    # Shortcut to the temporary/trailing fields
+    #
+    # http://groups.google.com/group/openwferu-users/browse_thread/thread/981dba6204f31ccc
+    #
+    def t
+      @h['fields']['t'] ||= {}
     end
 
     # (advanced)
@@ -242,7 +363,7 @@ module Ruote
     # __command__ is read by the 'cursor' and the 'iterator' expressions
     # when a workitem reaches it (apply and reply).
     #
-    def commmand
+    def command
 
       @h['fields']['__command__']
     end
@@ -270,27 +391,14 @@ module Ruote
       @h['fields']['__tags__'] || []
     end
 
-    # Used by FlowExpression when entering a tag.
+    # How many times was this workitem re_dispatched ?
     #
-    def self.add_tag(hworkitem, tag)
-
-      (hworkitem['fields']['__tags__'] ||= []) << tag
-    end
-
-    # Used by FlowExpression when leaving a tag.
+    # It's used by LocalParticipant re_dispatch mostly, or by participant
+    # which poll a resource and re_dispatch after a while.
     #
-    def self.remove_tag(hworkitem, tag)
+    def re_dispatch_count
 
-      # it's a bit convoluted... trying to cope with potential inconsistencies
-      #
-      # normally, it should only be a tags.pop(), but since user have
-      # access to the workitem and its fields... better be safe than sorry
-
-      tags = (hworkitem['fields']['__tags__'] || [])
-
-      if index = tags.rindex(tag)
-        tags.delete_at(index)
-      end
+      @h['re_dispatch_count'] || 0
     end
 
     # Encodes this workitem as JSON. If pretty is set to true, will output
@@ -314,6 +422,33 @@ module Ruote
 
       self.new(h)
     end
+
+    protected
+
+    # Used by FlowExpression when entering a tag.
+    #
+    def add_tag(tag)
+
+      (@h['fields']['__tags__'] ||= []) << tag
+    end
+
+    # Used by FlowExpression when leaving a tag.
+    #
+    def remove_tag(tag)
+
+      # it's a bit convoluted... trying to cope with potential inconsistencies
+      #
+      # normally, it should only be a tags.pop(), but since user have
+      # access to the workitem and its fields... better be safe than sorry
+
+      tags = (@h['fields']['__tags__'] || [])
+
+      if index = tags.rindex(tag)
+        tags.delete_at(index)
+      end
+
+      @h['fields']['__left_tag__'] = tag
+    end
   end
 end
 

data/ruote.gemspec

@@ -1,9 +1,12 @@
-# encoding: utf-8
 
 Gem::Specification.new do |s|
 
   s.name = 'ruote'
-  s.version = File.read('lib/ruote/version.rb').match(/VERSION = '([^']+)'/)[1]
+
+  s.version = File.read(
+    File.expand_path('../lib/ruote/version.rb', __FILE__)
+  ).match(/ VERSION *= *['"]([^'"]+)/)[1]
+
   s.platform = Gem::Platform::RUBY
   s.authors = [ 'John Mettraux', 'Kenneth Kalmer', 'Torsten Schoenebaum' ]
   s.email = [ 'jmettraux@gmail.com' ]
@@ -21,17 +24,20 @@ ruote is an open source Ruby workflow engine
     '*.gemspec', '*.txt', '*.rdoc', '*.md'
   ]
 
-  s.add_runtime_dependency 'sourcify', '0.4.2'
-  s.add_runtime_dependency 'rufus-json', '>= 0.2.5'
-  s.add_runtime_dependency 'rufus-cloche', '>= 0.1.20'
+  s.add_runtime_dependency 'blankslate', '>= 2.1.2.4'
+  s.add_runtime_dependency 'parslet', '>= 1.4.0'
+    # blankslate 2.1.2.3 is to avoid...
+
+  s.add_runtime_dependency 'sourcify', '0.5.0'
+  s.add_runtime_dependency 'rufus-json', '>= 1.0.1'
+  s.add_runtime_dependency 'rufus-cloche', '>= 1.0.2'
   s.add_runtime_dependency 'rufus-dollar', '>= 1.0.4'
-  s.add_runtime_dependency 'rufus-mnemo', '>= 1.1.0'
-  s.add_runtime_dependency 'rufus-scheduler', '>= 2.0.8'
-  s.add_runtime_dependency 'rufus-treechecker', '>= 1.0.4'
+  s.add_runtime_dependency 'rufus-mnemo', '>= 1.2.2'
+  s.add_runtime_dependency 'rufus-scheduler', '>= 2.0.16'
+  s.add_runtime_dependency 'rufus-treechecker', '>= 1.0.8'
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'json'
-  s.add_development_dependency 'builder'
   s.add_development_dependency 'mailtrap'
 
   s.require_path = 'lib'

data/test/bm/ci.rb

@@ -12,7 +12,6 @@ require 'rubygems'
 
 require File.dirname(__FILE__) + '/../path_helper'
 require File.dirname(__FILE__) + '/../functional/engine_helper'
-require 'ruote/log/test_logger'
 
 ac = {
   #:definition_in_launchitem_allowed => true
@@ -28,7 +27,6 @@ engine = determine_engine_class(ac).new(ac)
 #N = 1_000
 N = 300
 
-engine.add_service(:s_logger, Ruote::TestLogger)
 #engine.context[:noisy] = true
 
 Benchmark.benchmark(' ' * 20 + Benchmark::Tms::CAPTION, 20) do |bench|

data/test/bm/ici.rb

@@ -11,7 +11,6 @@ require 'rubygems'
 
 require File.dirname(__FILE__) + '/../path_helper'
 require File.dirname(__FILE__) + '/../functional/engine_helper'
-require 'ruote/log/test_logger'
 
 ac = {
   #:definition_in_launchitem_allowed => true
@@ -27,7 +26,6 @@ engine = determine_engine_class(ac).new(ac)
 N = 1_000
 #N = 300
 
-engine.add_service(:s_logger, Ruote::TestLogger)
 #engine.context[:noisy] = true
 
 launched = nil

data/test/bm/load_26c.rb

@@ -14,7 +14,6 @@ require 'rubygems'
 
 require File.dirname(__FILE__) + '/../path_helper'
 require File.dirname(__FILE__) + '/../functional/engine_helper'
-require 'ruote/log/test_logger'
 
 ac = {
   #:definition_in_launchitem_allowed => true
@@ -37,8 +36,6 @@ engine.register_participant("count") do |workitem|
   #print '.'
 end
 
-engine.add_service(:s_logger, Ruote::TestLogger)
-
 Benchmark.benchmark(' ' * 20 + Benchmark::Tms::CAPTION, 20) do |bench|
 
   bench.report('run') do

data/test/bm/mega.rb

@@ -7,9 +7,7 @@ require 'ruote/worker'
 require 'ruote/part/storage_participant'
 require 'ruote/storage/hash_storage'
 require 'ruote/storage/fs_storage'
-require 'ruote/log/test_logger'
 
-#opts = { 's_logger' => [ 'ruote/log/test_logger', 'Ruote::TestLogger' ] }
 opts = {}
 
 storage = if ARGV.include?('--fs')

data/test/functional/base.rb

@@ -7,32 +7,34 @@
 
 require 'fileutils'
 
-require File.join(File.dirname(__FILE__), '..', 'test_helper.rb')
-require File.join(File.dirname(__FILE__), 'storage_helper.rb')
+require File.expand_path('../../test_helper', __FILE__)
+require File.expand_path('../storage_helper', __FILE__)
+require File.expand_path('../signals', __FILE__)
 
 require 'ruote'
 
 
-trap 'USR2' do
-
-  require 'irb'
-  require 'irb/completion'
-
-  IRB.setup(nil)
-  ws = IRB::WorkSpace.new(binding)
-  irb = IRB::Irb.new(ws)
-  IRB::conf[:MAIN_CONTEXT] = irb.context
-  irb.eval_input
-end
-
-puts "pid #{$$}"
+#
+# Most of the functional tests extend this class.
+#
+module FunctionalBase
 
+  # For functional tests that want to provide their own setup or teardown
+  # and still have an opportunity to call this base's setup/teardown
+  #
+  def self.included(target)
 
-module FunctionalBase
+    target.class_eval do
+      alias base_setup setup
+      alias base_teardown teardown
+    end
+  end
 
   def setup
 
-    p self.class if ARGV.include?('-T') or ARGV.include?('-N')
+    if ARGV.include?('-T') || ARGV.include?('-N') || ENV['NOISY'] == 'true'
+      p self.class
+    end
 
     #require 'ruote/util/look'
     #Ruote::Look.dump_lsof
@@ -40,48 +42,56 @@ module FunctionalBase
       #
       # uncomment this when "too many open files"
 
-    @engine =
-      Ruote::Engine.new(
-        Ruote::Worker.new(
-          determine_storage(
-            's_logger' => [ 'ruote/log/test_logger', 'Ruote::TestLogger' ])))
+    sto = determine_storage({})
+
+    @dashboard = Ruote::Dashboard.new(
+      sto.class.name.match(/Worker$/) ? sto : Ruote::Worker.new(sto))
+
+    @engine = @dashboard
+      # for 'backward compatibility'
 
     $_test = self
-    $_engine = @engine
+    $_dashboard = @dashboard
       #
       # handy when hijacking (https://github.com/ileitch/hijack)
       # or flinging USR2 at the test process
 
     @tracer = Tracer.new
 
-    tracer = @tracer
-    @engine.context.instance_eval { @tracer = tracer }
-
-    @engine.add_service('tracer', @tracer)
-    @engine.add_service('stash', {})
+    Ruote::BlockParticipant.class_eval do
+      def tracer
+        @context.tracer
+      end
+      def stash
+        @context.stash
+      end
+    end
 
-    noisy if ARGV.include?('-N')
+    @dashboard.add_service('tracer', @tracer)
+    @dashboard.add_service('stash', {})
 
-    #noisy # uncommented, it makes all the tests noisy
+    noisy if ARGV.include?('-N') || ENV['NOISY'].to_s == 'true'
   end
 
   def teardown
 
-    @engine.shutdown
-    @engine.context.storage.purge!
-    @engine.context.storage.close if @engine.context.storage.respond_to?(:close)
+    return if @dashboard.nil?
+
+    @dashboard.shutdown
+    @dashboard.context.storage.purge!
+    @dashboard.context.storage.close if @dashboard.context.storage.respond_to?(:close)
   end
 
   def stash
 
-    @engine.context.stash
+    @dashboard.context.stash
   end
 
   def assert_log_count(count, &block)
 
-    c = @engine.context.logger.log.select(&block).size
+    c = @dashboard.context.logger.log.select(&block).size
 
-    #logger.to_stdout if ( ! @engine.context[:noisy]) && c != count
+    #logger.to_stdout if ( ! @dashboard.context[:noisy]) && c != count
 
     assert_equal count, c
   end
@@ -100,7 +110,7 @@ module FunctionalBase
     fields = args.last.is_a?(Hash) ? args.pop : {}
     expected_traces = args.collect { |et| et.is_a?(Array) ? et.join("\n") : et }
 
-    wfid = @engine.launch(pdef, fields)
+    wfid = @dashboard.launch(pdef, fields)
 
     r = wait_for(wfid)
 
@@ -122,7 +132,7 @@ module FunctionalBase
 
   def logger
 
-    @engine.context.logger
+    @dashboard.context.logger
   end
 
   protected
@@ -130,12 +140,12 @@ module FunctionalBase
   def noisy(on=true)
 
     puts "\nnoisy " + caller[0] if on
-    @engine.context.logger.noisy = true
+    @dashboard.context.logger.noisy = true
   end
 
   def wait_for(*wfid_or_part)
 
-    @engine.wait_for(*wfid_or_part)
+    @dashboard.wait_for(*wfid_or_part)
   end
 
   def assert_engine_clean(wfid)
@@ -146,7 +156,7 @@ module FunctionalBase
 
   def assert_no_errors(wfid)
 
-    errors = @engine.storage.get_many('errors', /#{wfid}$/)
+    errors = @dashboard.storage.get_many('errors', /#{wfid}$/)
 
     return if errors.size == 0
 
@@ -167,7 +177,7 @@ module FunctionalBase
 
   def assert_no_remaining_expressions(wfid)
 
-    expcount = @engine.storage.get_many('expressions').size
+    expcount = @dashboard.storage.get_many('expressions').size
     return if expcount == 0
 
     tf, _, tn = caller[2].split(':')
@@ -183,7 +193,7 @@ module FunctionalBase
     puts
     puts 'left :'
     puts
-    puts @engine.context.storage.dump('expressions')
+    puts @dashboard.context.storage.dump('expressions')
     puts
     puts '-' * 80
 
@@ -203,6 +213,7 @@ module FunctionalBase
   end
 end
 
+#
 # Re-opening workitem for a shortcut to a '_trace' field
 #
 class Ruote::Workitem
@@ -211,6 +222,9 @@ class Ruote::Workitem
   end
 end
 
+#
+# Our tracer class.
+#
 class Tracer
   attr_reader :s
   def initialize