ruote 2.1.6 → 2.1.7

data/lib/ruote/parser/ruby_dsl.rb

@@ -27,16 +27,69 @@ module Ruote
 
   # Not really a parser, more an AST builder.
   #
+  #   pdef = Ruote.define :name => 'take_out_garbage' do
+  #     sequence do
+  #       take_out_regular_garbage
+  #       take_out_glass
+  #       take_out_paper
+  #     end
+  #   end
+  #
+  #   engine.launch(pdef)
+  #
   def self.define (*attributes, &block)
 
     RubyDsl.create_branch('define', attributes, &block)
   end
 
+  # Same as Ruote.define()
+  #
+  #   pdef = Ruote.process_definition :name => 'take_out_garbage' do
+  #     sequence do
+  #       take_out_regular_garbage
+  #       take_out_paper
+  #     end
+  #   end
+  #
+  #   engine.launch(pdef)
+  #
   def self.process_definition (*attributes, &block)
 
     define(*attributes, &block)
   end
 
+  # Similar in purpose to Ruote.define and Ruote.process_definition but
+  # instead of returning a [process] definition, returns the tree.
+  #
+  #   tree = Ruote.process_definition :name => 'take_out_garbage' do
+  #     sequence do
+  #       take_out_regular_garbage
+  #       take_out_paper
+  #     end
+  #   end
+  #
+  #   p tree
+  #     # => [ 'sequence', {}, [ [ 'take_out_regular_garbage', {}, [] ], [ 'take_out_paper', {}, [] ] ] ],
+  #
+  # This is useful when modifying a process instance via methods like re_apply :
+  #
+  #   engine.re_apply(
+  #     fei,
+  #     :tree => Ruote.to_tree {
+  #       sequence do
+  #         participant 'alfred'
+  #         participant 'bob'
+  #       end
+  #     })
+  #       #
+  #       # cancels the segment of process at fei and replaces it with
+  #       # a simple alfred-bob sequence.
+  #
+  def self.to_tree (&block)
+
+    RubyDsl.create_branch('x', {}, &block).last.first
+  end
+
   # :nodoc:
   #
   module RubyDsl

data/lib/ruote/part/participant_list.rb

@@ -93,6 +93,9 @@ module Ruote
 
       else
 
+        return Ruote::StorageParticipant.new(@context) \
+          if entry.last.first == 'Ruote::StorageParticipant'
+
         nil
       end
     end
@@ -177,6 +180,13 @@ module Ruote
       pa
     end
 
+    # Return a list of names (regex) for the registered participants
+    #
+    def names
+
+      get_list['list'].map { |re, pa| re }
+    end
+
     # Shuts down the 'instantiated participants' (engine worker participants)
     # if they respond to #shutdown.
     #

data/lib/ruote/part/storage_participant.rb

@@ -146,16 +146,17 @@ module Ruote
 
     # Return all workitems for the specified wfid
     #
-    def by_wfid( wfid )
+    def by_wfid (wfid)
 
-      @context.storage.get_many('workitems', /!#{wfid}$/).map { |hwi| Ruote::Workitem.new(hwi) }
+      @context.storage.get_many('workitems', /!#{wfid}$/).map { |hwi|
+        Ruote::Workitem.new(hwi)
+      }
     end
 
     # Returns all workitems for the specified participant name
     #
     def by_participant (participant_name)
 
-
       hwis = if @context.storage.respond_to?(:by_participant)
 
         @context.storage.by_participant('workitems', participant_name)
@@ -194,6 +195,56 @@ module Ruote
       hwis.collect { |hwi| Ruote::Workitem.new(hwi) }
     end
 
+    # Queries the store participant for workitems.
+    #
+    # Some examples :
+    #
+    #   part.query(:wfid => @wfid).size
+    #   part.query('place' => 'nara').size
+    #   part.query('place' => 'heiankyou').size
+    #   part.query(:wfid => @wfid, :place => 'heiankyou').size
+    #
+    # There are two 'reserved' criterion : 'wfid' and 'participant'
+    # ('participant_name' as well). The rest of the criteria are considered
+    # constraints for fields.
+    #
+    # 'offset' and 'limit' are reserved as well. They should prove useful
+    # for pagination.
+    #
+    # Note : the criteria is AND only, you'll have to do ORs (aggregation)
+    # by yourself.
+    #
+    def query (criteria)
+
+      cr = criteria.inject({}) { |h, (k, v)| h[k.to_s] = v; h }
+
+      return @context.storage.query_workitems(cr) \
+        if @context.storage.respond_to?(:query_workitems)
+
+      offset = cr.delete('offset')
+      limit = cr.delete('limit')
+
+      wfid = cr.delete('wfid')
+      pname = cr.delete('participant_name') || cr.delete('participant')
+
+      hwis = if wfid
+        @context.storage.get_many('workitems', /!#{wfid}$/)
+      else
+        fetch_all
+      end
+
+      hwis = hwis.select { |hwi|
+        Ruote::StorageParticipant.matches?(hwi, pname, cr)
+      }.collect { |hwi|
+        Ruote::Workitem.new(hwi)
+      }
+
+      offset = offset || 0
+      limit = limit || hwis.length
+
+      hwis[offset, limit]
+    end
+
     # Cleans this participant out completely
     #
     def purge!
@@ -201,8 +252,26 @@ module Ruote
       fetch_all.each { |hwi| @context.storage.delete( hwi ) }
     end
 
+    # Used by #query when filtering workitems.
+    #
+    def self.matches? (hwi, pname, criteria)
+
+      return false if pname && hwi['participant_name'] != pname
+
+      fields = hwi['fields']
+
+      criteria.each do |fname, fvalue|
+        return false if fields[fname] != fvalue
+      end
+
+      true
+    end
+
     protected
 
+    # Fetches all the workitems. If there is a @store_name, will only fetch
+    # the workitems in that store.
+    #
     def fetch_all
 
       key = @store_name ? /^wi!#{@store_name}::/ : nil
@@ -210,6 +279,8 @@ module Ruote
       @context.storage.get_many('workitems', key)
     end
 
+    # Computes the id for the document representing the document in the storage.
+    #
     def to_id (fei)
 
       a = [ Ruote.to_storage_id(fei) ]

data/lib/ruote/storage/base.rb

@@ -55,13 +55,16 @@ module Ruote
 
       # merge! is way faster than merge (no object creation probably)
 
-      t = Time.now
-      t = "#{t.to_i}.#{"%06d" % t.usec}"
+      @counter ||= 0
 
-      msg = options.merge!(
-        'type' => 'msgs',
-        '_id' => "#{$$}-#{Thread.current.object_id}-#{t}",
-        'action' => action)
+      t = Time.now.utc
+      ts = "#{t.strftime('%Y-%m-%d')}!#{t.to_i}.#{'%06d' % t.usec}"
+      _id = "#{$$}!#{Thread.current.object_id}!#{ts}!#{'%03d' % @counter}"
+
+      @counter = (@counter + 1) % 1000
+        # some platforms (windows) have shallow usecs, so adding that counter...
+
+      msg = options.merge!('type' => 'msgs', '_id' => _id, 'action' => action)
 
       msg.delete('_rev')
         # in case of message replay

data/lib/ruote/storage/hash_storage.rb

@@ -30,6 +30,8 @@ require 'monitor'
 
 module Ruote
 
+  # An in-memory storage.
+  #
   class HashStorage
 
     include StorageBase
@@ -40,14 +42,17 @@ module Ruote
     def initialize (options={})
 
       super()
-
-      @options = options
+        # since were including MonitorMixin, this super() is necessary
 
       purge!
+
+      put(options.merge('type' => 'configurations', '_id' => 'engine'))
     end
 
     def put (doc, opts={})
 
+      i = @h.size
+
       synchronize do
 
         pre = get(doc['type'], doc['_id'])

data/lib/ruote/util/misc.rb

@@ -25,6 +25,10 @@
 
 module Ruote
 
+  # Will be set to true if the Ruby runtime is on Windows
+  #
+  WIN = RUBY_PLATFORM.match(/mswin|mingw/) != nil
+
   # Prints the current call stack to stdout
   #
   def self.p_caller (*msg)

data/lib/ruote/version.rb

@@ -23,6 +23,6 @@
 #++
 
 module Ruote
-  VERSION = '2.1.6'
+  VERSION = '2.1.7'
 end
 

data/lib/ruote/workitem.rb

@@ -29,6 +29,12 @@ require 'ruote/util/hashdot'
 
 module Ruote
 
+  #
+  # A workitem can be thought of an "execution token", but with a payload
+  # (fields).
+  #
+  # The payload/fields MUST be JSONifiable.
+  #
   class Workitem
 
     attr_reader :h
@@ -44,27 +50,41 @@ module Ruote
       @h
     end
 
+    # Returns a Ruote::FlowExpressionId instance.
+    #
     def fei
 
       FlowExpressionId.new(h.fei)
     end
 
+    # Returns a complete copy of this workitem.
+    #
     def dup
 
-      Ruote.fulldup(self)
+      Workitem.new(Rufus::Json.dup(@h))
     end
 
+    # The participant for which this item is destined. Will be nil when
+    # the workitem is transiting inside of its process instance (as opposed
+    # to when it's being delivered outside of the engine).
+    #
     def participant_name
 
       @h['participant_name']
     end
 
+    # Returns the payload, ie the fields hash.
+    #
     def fields
 
       @h['fields']
     end
 
-    def fields=( fields )
+    # Sets all the fields in one sweep.
+    #
+    # Remember : the fields must be a JSONifiable hash.
+    #
+    def fields= (fields)
 
       @h['fields'] = fields
     end
@@ -87,25 +107,22 @@ module Ruote
 
       fields['__result__'] = r
     end
-  end
 
-  #
-  # TODO : clean me out !
-  #
-  class BakWorkitem
+    # Warning : equality is based on fei and not on payload !
+    #
+    def == (other)
 
-    attr_accessor :fei
-    attr_accessor :fields
-    attr_accessor :participant_name
+      return false if other.class != self.class
+      self.h['fei'] == other.h['fei']
+    end
 
-    alias :f :fields
-    alias :attributes :fields
-    alias :attributes= :fields=
+    alias eql? ==
 
-    def initialize (fields={})
+    # Warning : hash is fei's hash.
+    #
+    def hash
 
-      @fei = nil
-      @fields = fields
+      self.h['fei'].hash
     end
 
     # For a simple key
@@ -126,7 +143,7 @@ module Ruote
     #
     def lookup (key, container_lookup=false)
 
-      Ruote.lookup(@fields, key, container_lookup)
+      Ruote.lookup(@h['fields'], key, container_lookup)
     end
 
     # 'lf' for 'lookup field'
@@ -144,37 +161,7 @@ module Ruote
     #
     def set_field (key, value)
 
-      Ruote.set(@fields, key, value)
-    end
-
-    # Returns a deep copy of this workitem instance.
-    #
-    def dup
-
-      Ruote.fulldup(self)
-    end
-
-    # Turns a workitem into a Ruby Hash (useful for JSON serializations)
-    #
-    def to_h
-
-      h = {}
-      h['fei'] = @fei.to_h
-      h['participant_name'] = @participant_name
-      h['fields'] = @fields
-
-      h
-    end
-
-    # Turns back a Ruby Hash into a workitem (well, attempts to)
-    #
-    def self.from_h (h)
-
-      wi = Workitem.new(h['fields'])
-      wi.fei = FlowExpressionId.from_h(h['fei'])
-      wi.participant_name = h['participant_name']
-
-      wi
+      Ruote.set(@h['fields'], key, value)
     end
   end
 end

data/ruote.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruote}
-  s.version = "2.1.6"
+  s.version = "2.1.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["John Mettraux", "Kenneth Kalmer"]
-  s.date = %q{2010-02-08}
+  s.authors = ["John Mettraux", "Kenneth Kalmer", "Torsten Schoenebaum"]
+  s.date = %q{2010-02-15}
   s.description = %q{
 ruote is an open source ruby workflow engine.
     }
@@ -251,8 +251,8 @@ ruote is an open source ruby workflow engine.
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rufus-json>, [">= 0"])
-      s.add_runtime_dependency(%q<rufus-cloche>, [">= 0.1.13"])
+      s.add_runtime_dependency(%q<rufus-json>, [">= 0.2.0"])
+      s.add_runtime_dependency(%q<rufus-cloche>, [">= 0.1.14"])
       s.add_runtime_dependency(%q<rufus-dollar>, [">= 0"])
       s.add_runtime_dependency(%q<rufus-lru>, [">= 0"])
       s.add_runtime_dependency(%q<rufus-mnemo>, [">= 1.1.0"])
@@ -262,9 +262,10 @@ ruote is an open source ruby workflow engine.
       s.add_development_dependency(%q<yard>, [">= 0"])
       s.add_development_dependency(%q<builder>, [">= 0"])
       s.add_development_dependency(%q<mailtrap>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
     else
-      s.add_dependency(%q<rufus-json>, [">= 0"])
-      s.add_dependency(%q<rufus-cloche>, [">= 0.1.13"])
+      s.add_dependency(%q<rufus-json>, [">= 0.2.0"])
+      s.add_dependency(%q<rufus-cloche>, [">= 0.1.14"])
       s.add_dependency(%q<rufus-dollar>, [">= 0"])
       s.add_dependency(%q<rufus-lru>, [">= 0"])
       s.add_dependency(%q<rufus-mnemo>, [">= 1.1.0"])
@@ -274,10 +275,11 @@ ruote is an open source ruby workflow engine.
       s.add_dependency(%q<yard>, [">= 0"])
       s.add_dependency(%q<builder>, [">= 0"])
       s.add_dependency(%q<mailtrap>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
     end
   else
-    s.add_dependency(%q<rufus-json>, [">= 0"])
-    s.add_dependency(%q<rufus-cloche>, [">= 0.1.13"])
+    s.add_dependency(%q<rufus-json>, [">= 0.2.0"])
+    s.add_dependency(%q<rufus-cloche>, [">= 0.1.14"])
     s.add_dependency(%q<rufus-dollar>, [">= 0"])
     s.add_dependency(%q<rufus-lru>, [">= 0"])
     s.add_dependency(%q<rufus-mnemo>, [">= 1.1.0"])
@@ -287,6 +289,7 @@ ruote is an open source ruby workflow engine.
     s.add_dependency(%q<yard>, [">= 0"])
     s.add_dependency(%q<builder>, [">= 0"])
     s.add_dependency(%q<mailtrap>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
   end
 end