ruote 2.1.6 → 2.1.7

data/CHANGELOG.txt

@@ -2,6 +2,20 @@
 = ruote - CHANGELOG.txt
 
 
+== ruote - 2.1.7    released 2010/02/15
+
+- now works on WinXP, Ruby 1.8.7
+- reformed msgs ids and adapted Ruote::StorageHistory
+- engine.register_participant(x, Ruote::StorageParticipant) now returning
+  a instance of the participant, for easy query
+- StorageParticipant, added #query(criteria), thanks Torsten and Brett
+- Ruote::Workitem #lookup('deep.field') and #set_field('deep.field') are back
+- Ruote::Workitem added == and hash (list.uniq friendly), thanks Brett
+- Engine#configure(key, value), thanks Torsten
+- Ruote.to_tree (lightweight version of Ruote.process_definition)
+- ParticipantList#names, thanks Kenneth
+
+
 == ruote - 2.1.6    released 2010/02/08
 
 - welcoming ruote-dm (datamapper persistency)

data/CREDITS.txt

@@ -8,14 +8,15 @@ Ruote (OpenWFEru) is an open source Ruby workflow (and sometimes BPM) engine.
 The main project team
 ---------------------
 
-John Mettraux  http://jmettraux.wordpress.com
-Kenneth Kalmer  http://www.opensourcery.co.za
+John Mettraux - http://jmettraux.wordpress.com
+Kenneth Kalmer - http://www.opensourcery.co.za
+Torsten Schoenebaum - http://github.com/tosch
 
 
 Contributors
 ------------
 
-Torsten Schoenebaum - ActiveResourceParticipant and much more
+Brett Anthoine - http://github.com/anb
 Matt Nichols - http://github.com/mattnichols
 Nicholas Faiz - http://github.com/biv
 Chris Beer - http://github.com/cbeer

data/Rakefile

@@ -19,12 +19,12 @@ ruote is an open source ruby workflow engine.
     }
     gem.email = 'jmettraux@gmail.com'
     gem.homepage = 'http://ruote.rubyforge.org'
-    gem.authors = [ 'John Mettraux', 'Kenneth Kalmer' ]
+    gem.authors = [ 'John Mettraux', 'Kenneth Kalmer', 'Torsten Schoenebaum' ]
     gem.rubyforge_project = 'ruote'
     gem.test_file = 'test/test.rb'
 
-    gem.add_dependency 'rufus-json'
-    gem.add_dependency 'rufus-cloche', '>= 0.1.13'
+    gem.add_dependency 'rufus-json', '>= 0.2.0'
+    gem.add_dependency 'rufus-cloche', '>= 0.1.14'
     gem.add_dependency 'rufus-dollar'
     gem.add_dependency 'rufus-lru'
     gem.add_dependency 'rufus-mnemo', '>= 1.1.0'
@@ -35,6 +35,7 @@ ruote is an open source ruby workflow engine.
     gem.add_development_dependency 'yard'
     gem.add_development_dependency 'builder'
     gem.add_development_dependency 'mailtrap'
+    gem.add_development_dependency 'jeweler'
 
     # Gem::Specification http://www.rubygems.org/read/chapter/20
   end

data/TODO.txt

@@ -184,6 +184,13 @@
 [o] process_status.to_dot
 [o] EngineParticipant : don't wait in case of forget (reply could NEVER come !)
 [x] align :forget behaviour on EngineParticipant forget... OK as it is
+[o] engine.re_apply(fei, wi) (thanks Torsten)... :wi => x, :tree => y...
+[o] ruote-dm 2.1
+[o] :tree => Ruote.to_tree { participant 'alpha' }
+[o] implement == eql? hash for workitem
+[o] StorageParticipant#query(wfid, participant_name, {fields})
+[x] break fs_history, prepare for dm_history
+[o] part = engine.register_participant :alpha, StorageParticipant should work...
 
 [ ] exp : exp (restricted form of eval ?)
 [ ] exp : case (is it necessary ?)
@@ -264,8 +271,6 @@
 
 [ ] engine.force_reply_to_parent(fei) ?
 
-[ ] break fs_history, prepare for dm_history
-
 [ ] :on_timeout => :rewind (break, jump to x)...
 [ ] rewind 'x' where x is a tagname (command x)
 
@@ -293,14 +298,12 @@
 [ ] shell ? irb ? Shell.new(storage)
 [ ] focus on fulldup or json.dup (via fulldup ?)
 
-[ ] ruote-dm 2.1
-
 [ ] implement pause engine
 [ ] implement pause process
 
 [ ] engine.on_error = 'participant_name'
 
-[ ] "open days" plugin / service / lambda ? is_open_day?(d)
+[ ] "business days" plugin
 
-[ ] engine.re_apply(fei, wi) (thanks Torsten)... :wi => x, :tree => y...
+[ ] issue with ruote-kit and inpa participants...
 

data/lib/ruote/context.rb

@@ -34,6 +34,8 @@ module Ruote
   #
   class Context
 
+    SERVICE_PREFIX = /^s\_/
+
     attr_reader :storage
     attr_accessor :worker
     attr_accessor :engine
@@ -41,7 +43,6 @@ module Ruote
     def initialize (storage, worker_or_engine)
 
       @storage = storage
-      @conf = default_conf.merge(@storage.get_configuration('engine') || {})
 
       @worker, @engine = if worker_or_engine.kind_of?(Ruote::Engine)
         [ worker_or_engine.worker, worker_or_engine ]
@@ -54,29 +55,37 @@ module Ruote
 
     def engine_id
 
-      @conf['engine_id'] || 'engine'
+      get_conf['engine_id'] || 'engine'
     end
 
     def [] (key)
 
-      @conf[key]
+      SERVICE_PREFIX.match(key) ? @services[key] : get_conf[key]
     end
 
     def []= (key, value)
 
-      @conf[key] = value
+      raise(
+        ArgumentError.new('use context#add_service to register services')
+      ) if SERVICE_PREFIX.match(key)
+
+      cf = get_conf
+      cf[key] = value
+      @storage.put(cf)
+
+      value
     end
 
     def keys
 
-      @conf.keys
+      get_conf.keys
     end
 
     def add_service (key, *args)
 
       path, klass, opts = args
 
-      key = "s_#{key}" unless key.match(/^s\_/)
+      key = "s_#{key}" unless SERVICE_PREFIX.match(key)
 
       service = if klass
 
@@ -85,13 +94,13 @@ module Ruote
         aa = [ self ]
         aa << opts if opts
 
-        @conf[key] = Ruote.constantize(klass).new(*aa)
+        @services[key] = Ruote.constantize(klass).new(*aa)
       else
 
-        @conf[key] = path
+        @services[key] = path
       end
 
-      self.class.class_eval %{ def #{key[2..-1]}; @conf['#{key}']; end }
+      self.class.class_eval %{ def #{key[2..-1]}; @services['#{key}']; end }
 
       service
     end
@@ -101,7 +110,7 @@ module Ruote
       @storage.shutdown if @storage.respond_to?(:shutdown)
       @worker.shutdown if @worker
 
-      @conf.values.each do |s|
+      @services.values.each do |s|
 
         s.shutdown if s.respond_to?(:shutdown)
       end
@@ -109,13 +118,20 @@ module Ruote
 
     protected
 
+    def get_conf
+
+      @storage.get_configuration('engine') || {}
+    end
+
     def initialize_services
 
-      @conf.keys.each do |key|
+      @services = {}
+
+      default_conf.merge(get_conf).each do |key, value|
 
-        next unless key.match(/^s\_/)
+        next unless SERVICE_PREFIX.match(key)
 
-        add_service(key, *@conf[key])
+        add_service(key, *value)
       end
     end
 

data/lib/ruote/engine.rb

@@ -319,6 +319,20 @@ module Ruote
 
       @context.add_service(name, path_or_instance, classname, opts)
     end
+
+    # Sets a configuration option. Examples:
+    #
+    #   # allow remote workflow definitions (for subprocesses or when launching
+    #   # processes)
+    #   @engine.configure('remote_definition_allowed', true)
+    #
+    #   # allow ruby_eval
+    #   @engine.configure('ruby_eval_allowed', true)
+    #
+    def configure (config_key, value)
+
+      @context[config_key] = value
+    end
   end
 
   #

data/lib/ruote/exp/flowexpression.rb

@@ -507,6 +507,10 @@ module Ruote::Exp
       tree[2]
     end
 
+    # A tiny class-bound counter used when generating subprocesses ids.
+    #
+    @@sub_wfid_counter = -1
+
     # Generates a sub_wfid, without hitting storage.
     #
     # There's a better implementation for sure...
@@ -517,6 +521,9 @@ module Ruote::Exp
         $$, Time.now.to_f.to_s, self.hash.to_s, @h['fei'].inspect
       ].join('-').hash
 
+      @@sub_wfid_counter = (@@sub_wfid_counter + 1) % 1000
+      i = i * 1000 + (@@sub_wfid_counter)
+
       (i < 0 ? "1#{i * -1}" : "0#{i}").to_s
     end
 

data/lib/ruote/fei.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2009, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2005-2010, 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,7 +39,20 @@ module Ruote
   end
 
   #
-  # TODO : document me
+  # The FlowExpressionId (fei for short) is an process expression identifier.
+  # Each expression when instantiated gets a unique fei.
+  #
+  # Feis are also used in workitems, where the fei is the fei of the
+  # [participant] expression that emitted the workitem.
+  #
+  # Feis can thus indicate the position of a workitem in a process tree.
+  #
+  # Feis contain four pieces of information :
+  #
+  # * wfid : workflow instance id, the identifier for the process instance
+  # * sub_wfid : the identifier for the sub process within the main instance
+  # * expid : the expression id, where in the process tree
+  # * engine_id : only relevant in multi engine scenarii (defaults to 'engine')
   #
   class FlowExpressionId
 
@@ -66,12 +79,10 @@ module Ruote
     end
 
     def to_storage_id
-
       "#{@h['expid']}!#{@h['sub_wfid']}!#{@h['wfid']}"
     end
 
     def self.to_storage_id (hfei)
-
       "#{hfei['expid']}!#{hfei['sub_wfid']}!#{hfei['wfid']}"
     end
 
@@ -88,12 +99,10 @@ module Ruote
     # '0_5_7', the child_id will be '7'.
     #
     def child_id
-
       h.expid.split(CHILD_SEP).last.to_i
     end
 
     def hash
-
       to_storage_id.hash
     end
 
@@ -117,7 +126,6 @@ module Ruote
     # Returns child_id... For an expid of '0_1_4', this will be 4.
     #
     def self.child_id (h)
-
       h['expid'].split(CHILD_SEP).last.to_i
     end
 

data/lib/ruote/id/wfid_generator.rb

@@ -47,7 +47,10 @@ module Ruote
 
     def get_raw
 
+      lraw = @last['raw'] + 0.01
+
       raw = Time.now.utc
+      while raw.to_f <= lraw; raw = raw + 0.01; end
 
       @last['raw'] = raw.to_f
 

data/lib/ruote/log/fs_history.rb

@@ -122,7 +122,7 @@ module Ruote
     #
     def by_date (date)
 
-      date = Time.parse(date.to_s).strftime('%F')
+      date = Time.parse(date.to_s).strftime('%Y-%m-%d')
 
       lines = File.readlines(File.join(@path, "history_#{date}.json")) rescue []
 
@@ -158,7 +158,7 @@ module Ruote
       rotate_if_necessary
 
       @file.puts(Rufus::Json.encode(
-        [ "#{@last.strftime('%F %T')}.#{"%06d" % @last.usec}", msg ]))
+        [ "#{@last.strftime('%Y-%m-%d %T')}.#{"%06d" % @last.usec}", msg ]))
       @file.flush
     end
 
@@ -173,7 +173,7 @@ module Ruote
 
       @file.close rescue nil
 
-      fn = [ 'history', @last.strftime('%F') ].join('_') + '.json'
+      fn = [ 'history', @last.strftime('%Y-%m-%d') ].join('_') + '.json'
 
       @file = File.open(File.join(@path, fn), 'a')
     end

data/lib/ruote/log/storage_history.rb

@@ -34,6 +34,8 @@ module Ruote
   #
   class StorageHistory
 
+    DATE_REGEX = /!(\d{4}-\d{2}-\d{2})!/
+
     def initialize (context, options={})
 
       @context = context
@@ -60,17 +62,20 @@ module Ruote
 
       ids = @context.storage.ids('history')
 
-      first = Time.parse("#{ids.first.split('!')[0]} 00:00:00 UTC")
-      last = Time.parse("#{ids.last.split('!')[0]} 00:00:00 UTC") + 24 * 3600
+      fm = DATE_REGEX.match(ids.first)[1]
+      lm = DATE_REGEX.match(ids.last)[1]
+
+      first = Time.parse("#{fm} 00:00:00 UTC")
+      last = Time.parse("#{lm} 00:00:00 UTC") + 24 * 3600
 
       [ first, last ]
     end
 
     def by_date (date)
 
-      date = Time.parse(date.to_s).strftime('%F')
+      date = Time.parse(date.to_s).strftime('%Y-%m-%d')
 
-      @context.storage.get_many('history', /^#{date}!/)
+      @context.storage.get_many('history', /!#{date}!/)
     end
 
     #def history_to_tree (wfid)
@@ -101,12 +106,13 @@ module Ruote
         msg['wfid'] || 'no_wfid'
       end
 
-      t = Time.parse(msg['put_at'])
+      _id = msg['_id']
+      msg['original_id'] = _id
+      msg['_id'] = "#{_id}!#{si}"
 
-      msg['original_id'] = msg['_id']
-      msg['_id'] = "#{t.strftime('%F')}!#{t.to_i}_#{"%06d" % t.usec}!#{si}"
       msg['type'] = 'history'
       msg['original_put_at'] = msg['put_at']
+
       msg.delete('_rev')
 
       @context.storage.put(msg)

data/lib/ruote/log/test_logger.rb

@@ -148,6 +148,11 @@ module Ruote
           interest = interest - 1
           @waiting = [ @waiting.first, interest ]
 
+          #@debug ||= {}
+          #c = @debug[action] ||= 0
+          #@debug[action] = c+1
+          #p [ interest, @debug ]
+
           (interest < 1)
 
         else # wfid
@@ -194,6 +199,7 @@ module Ruote
 
     def color (mod, s, clear=false)
 
+      return s if Ruote::WIN
       return s unless STDOUT.tty?
 
       "[#{mod}m#{s}#{clear ? '' : "[#{@color}m"}"

data/lib/ruote/parser.rb

@@ -35,6 +35,8 @@ module Ruote
   #
   # A process definition parser.
   #
+  # Can parse XML, JSON, Ruby (and more) process definition representations.
+  #
   class Parser
 
     def initialize (context)
@@ -55,11 +57,9 @@ module Ruote
 
       if definition.index("\n") == nil
 
-        u = URI.parse(definition)
-
         raise ArgumentError.new(
           "remote process definitions are not allowed"
-        ) if u.scheme != nil && @context['remote_definition_allowed'] != true
+        ) if Ruote::Parser.remote?(definition) && @context['remote_definition_allowed'] != true
 
         return parse(open(definition).read)
       end
@@ -147,6 +147,15 @@ module Ruote
       tree.to_json
     end
 
+    # Returns true if the defintion is a remote URI
+    #
+    def self.remote? (definition)
+
+      u = URI.parse(definition)
+
+      (u.scheme != nil) && ( ! ('A'..'Z').include?(u.scheme))
+    end
+
     protected
 
     # Evaluates the ruby string in the code, but at fist, thanks to the