ruote 2.1.11 → 2.2.0

data/lib/ruote/{parser → reader}/xml.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
@@ -31,16 +31,16 @@ module Ruote
   #
   # Turns an XML string into a process definition tree.
   #
-  module XmlParser
+  module XmlReader
 
     #
-    # A helper class to store the temporary tree while it gets parsed.
+    # A helper class to store the temporary tree while it gets read.
     #
     class Node
 
       attr_reader :parent, :attributes, :children
 
-      def initialize (parent, name, attributes)
+      def initialize(parent, name, attributes)
 
         @parent = parent
         @name = name
@@ -54,6 +54,7 @@ module Ruote
       end
 
       def to_a
+
         [ @name, @attributes, @children.collect { |c| c.to_a } ]
       end
     end
@@ -61,7 +62,7 @@ module Ruote
     #
     # Parses the XML string into a process definition tree (array of arrays).
     #
-    def self.parse (s)
+    def self.read(s)
 
       parser = REXML::Parsers::SAX2Parser.new(s)
 

data/lib/ruote/receiver/base.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
@@ -37,7 +37,7 @@ module Ruote
     # This method pipes back a workitem into the engine, letting it resume
     # in its flow, hopefully.
     #
-    def receive (workitem)
+    def receive(workitem)
 
       workitem = workitem.to_h if workitem.respond_to?(:to_h)
 
@@ -57,20 +57,20 @@ module Ruote
     #
     # process_definition must be a result of Ruote.process_definition call
     # or XML or JSON serialized process definition, as accepted by
-    # Ruote::Parser#parse.
+    # Ruote::Reader#read.
     #
     # fields are workflow parameters that will be placed in workitem.fields.
     #
     # variables contain engine variables.
     #
-    def launch (process_definition, fields={}, variables={})
+    def launch(process_definition, fields={}, variables={})
 
       wfid = @context.wfidgen.generate
 
       @context.storage.put_msg(
         'launch',
         'wfid' => wfid,
-        'tree' => @context.parser.parse(process_definition),
+        'tree' => @context.reader.read(process_definition),
         'workitem' => { 'fields' => fields },
         'variables' => variables)
 
@@ -82,9 +82,9 @@ module Ruote
     # Not aliasing so that if someone changes the receive implementation,
     # reply is affected as well.
     #
-    def reply (workitem)
+    def reply(workitem)
 
-      receive (workitem)
+      receive(workitem)
     end
 
     # Wraps a call to receive(workitem)
@@ -92,9 +92,9 @@ module Ruote
     # Not aliasing so that if someone changes the receive implementation,
     # reply_to_engine is affected as well.
     #
-    def reply_to_engine (workitem)
+    def reply_to_engine(workitem)
 
-      receive (workitem)
+      receive(workitem)
     end
 
     # A receiver signs a workitem when it comes back.
@@ -109,7 +109,7 @@ module Ruote
     # Convenience method, given a workitem or a fei, returns the
     # corresponding flow expession.
     #
-    def fetch_flow_expression (workitem_or_fei)
+    def fetch_flow_expression(workitem_or_fei)
 
       Ruote::Exp::FlowExpression.fetch(
         @context,
@@ -124,6 +124,28 @@ module Ruote
     #
     alias fexp fetch_flow_expression
 
+    # A convenience methods for advanced users (like Oleg).
+    #
+    # Given a fei (flow expression id), fetches the workitem as stored in
+    # the expression with that fei.
+    # This is the "applied workitem", if the workitem is currently handed to
+    # a participant, this method will return the workitem as applied, not
+    # the workitem as saved by the participant/user in whatever worklist it
+    # uses. If you need that workitem, do the vanilla thing and ask it to
+    # the [storage] participant or its worklist.
+    #
+    # The fei might be a string fei (result of fei.to_storage_id), a
+    # FlowExpressionId instance or a hash.
+    #
+    # on_terminate processes are not triggered for on_error processes.
+    # on_error processes are triggered for on_terminate processes as well.
+    #
+    def applied_workitem(fei)
+
+      Ruote::Workitem.new(fexp(fei).h.applied_workitem)
+    end
+    alias workitem applied_workitem
+
     protected
 
     # Stashes values in the participant expression (in the storage).
@@ -139,7 +161,7 @@ module Ruote
     # http://groups.google.com/group/openwferu-users/t/2e6a95708c10847b for the
     # justification.
     #
-    def put (fei, hash)
+    def put(fei, hash)
 
       fexp = Ruote::Exp::FlowExpression.fetch(@context, fei.to_h)
 
@@ -161,7 +183,7 @@ module Ruote
     # put & get are useful for a participant that needs to communicate
     # between its consume and its cancel.
     #
-    def get (fei, key=nil)
+    def get(fei, key=nil)
 
       fexp = Ruote::Exp::FlowExpression.fetch(@context, fei.to_h)
 
@@ -180,7 +202,7 @@ module Ruote
 
     # Accepts context, worker, engine or storage as first argument.
     #
-    def initialize (cwes, options={})
+    def initialize(cwes, options={})
 
       @context = cwes.context
       @options = options

data/lib/ruote/storage/base.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
@@ -37,7 +37,7 @@ module Ruote
       @context ||= Ruote::Context.new(self)
     end
 
-    def context= (c)
+    def context=(c)
 
       @context = c
     end
@@ -45,7 +45,7 @@ module Ruote
     # Attempts to delete a document, returns true if the deletion
     # succeeded. This is used with msgs to reserve work on them.
     #
-    def reserve (doc)
+    def reserve(doc)
 
       delete(doc).nil?
     end
@@ -54,7 +54,7 @@ module Ruote
     # configurations
     #++
 
-    def get_configuration (key)
+    def get_configuration(key)
 
       get('configurations', key)
     end
@@ -63,7 +63,7 @@ module Ruote
     # messages
     #++
 
-    def put_msg (action, options)
+    def put_msg(action, options)
 
       msg = prepare_msg_doc(action, options)
 
@@ -93,7 +93,7 @@ module Ruote
       }
     end
 
-    def empty? (type)
+    def empty?(type)
 
       (get_many(type, nil, :count => true) == 0)
     end
@@ -102,7 +102,7 @@ module Ruote
     # expressions
     #++
 
-    def find_root_expression (wfid)
+    def find_root_expression(wfid)
 
       get_many('expressions', wfid).sort_by { |fexp|
         fexp['fei']['expid']
@@ -120,7 +120,7 @@ module Ruote
     # come up with different implementations (think CouchDB,  which could
     # provide a view for it).
     #
-    def expression_wfids (opts)
+    def expression_wfids(opts)
 
       wfids = ids('expressions').collect { |fei| fei.split('!').last }.uniq.sort
 
@@ -146,7 +146,7 @@ module Ruote
     # ats and crons
     #++
 
-    def get_schedules (delta, now)
+    def get_schedules(delta, now)
 
       # TODO : bring that 'optimization' back in,
       #        maybe every minute, if min != last_min ...
@@ -169,7 +169,7 @@ module Ruote
     # Places schedule in storage. Returns the id of the 'schedule' document.
     # If the schedule got triggered immediately, nil is returned.
     #
-    def put_schedule (flavour, owner_fei, s, msg)
+    def put_schedule(flavour, owner_fei, s, msg)
 
       doc = prepare_schedule_doc(flavour, owner_fei, s, msg)
 
@@ -182,7 +182,9 @@ module Ruote
       doc['_id']
     end
 
-    def delete_schedule (schedule_id)
+    def delete_schedule(schedule_id)
+
+      return if schedule_id.nil?
 
       s = get('schedules', schedule_id)
       delete(s) if s
@@ -192,12 +194,12 @@ module Ruote
     # engine variables
     #++
 
-    def get_engine_variable (k)
+    def get_engine_variable(k)
 
       get_engine_variables['variables'][k]
     end
 
-    def put_engine_variable (k, v)
+    def put_engine_variable(k, v)
 
       vars = get_engine_variables
       vars['variables'][k] = v
@@ -213,7 +215,7 @@ module Ruote
     #
     # Of course, the target storage may be a different implementation.
     #
-    def copy_to (target, opts={})
+    def copy_to(target, opts={})
 
       counter = 0
 
@@ -252,7 +254,7 @@ module Ruote
 
     # Used by put_msg
     #
-    def prepare_msg_doc (action, options)
+    def prepare_msg_doc(action, options)
 
       # merge! is way faster than merge (no object creation probably)
 
@@ -275,7 +277,7 @@ module Ruote
 
     # Used by put_schedule
     #
-    def prepare_schedule_doc (flavour, owner_fei, s, msg)
+    def prepare_schedule_doc(flavour, owner_fei, s, msg)
 
       at = if s.is_a?(Time) # at or every
         s
@@ -313,7 +315,7 @@ module Ruote
 
     # Returns all the ats whose due date arrived (now or earlier)
     #
-    def filter_schedules (schedules, now)
+    def filter_schedules(schedules, now)
 
       now = Ruote.time_to_utc_s(now)
 
@@ -333,7 +335,7 @@ module Ruote
     # It's a class method meant to be used by the various storage
     # implementations.
     #
-    def self.key_match? (keys, doc)
+    def self.key_match?(keys, doc)
 
       _id = doc.is_a?(Hash) ? doc['_id'] : doc
 

data/lib/ruote/storage/composite_storage.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,7 @@ module Ruote
 
     include StorageBase
 
-    def initialize (default_storage, storages)
+    def initialize(default_storage, storages)
 
       @default_storage = default_storage
       @storages = storages
@@ -55,27 +55,27 @@ module Ruote
       prepare_base_methods
     end
 
-    def put (doc, opts={})
+    def put(doc, opts={})
 
       storage(doc['type']).put(doc, opts)
     end
 
-    def get (type, key)
+    def get(type, key)
 
       storage(type).get(type, key)
     end
 
-    def delete (doc)
+    def delete(doc)
 
-      storage(type).delete(doc)
+      storage(doc['type']).delete(doc)
     end
 
-    def get_many (type, key=nil, opts={})
+    def get_many(type, key=nil, opts={})
 
       storage(type).get_many(type, key, opts)
     end
 
-    def ids (type)
+    def ids(type)
 
       storage(type).ids(type)
     end
@@ -85,7 +85,7 @@ module Ruote
       TYPES.collect { |t| storage(t) }.uniq.each { |s| s.purge! }
     end
 
-    def purge_type! (type)
+    def purge_type!(type)
 
       storage(type).purge_type!(type)
     end
@@ -125,7 +125,7 @@ module Ruote
       end
     end
 
-    def storage (type)
+    def storage(type)
 
       @storages[type] || @default_storage
     end

data/lib/ruote/storage/fs_storage.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
@@ -57,7 +57,7 @@ module Ruote
     # The options are classical engine configuration, but the 'cloche_nolock'
     # option is read by the storage and followed.
     #
-    def initialize (dir, options={})
+    def initialize(dir, options={})
 
       FileUtils.mkdir_p(dir)
 
@@ -69,22 +69,22 @@ module Ruote
       @cloche.put(@options.merge('type' => 'configurations', '_id' => 'engine'))
     end
 
-    def put (doc, opts={})
+    def put(doc, opts={})
 
       @cloche.put(doc.merge!('put_at' => Ruote.now_to_utc_s), opts)
     end
 
-    def get (type, key)
+    def get(type, key)
 
       @cloche.get(type, key)
     end
 
-    def delete (doc)
+    def delete(doc)
 
       @cloche.delete(doc)
     end
 
-    def get_many (type, key=nil, opts={})
+    def get_many(type, key=nil, opts={})
 
       if key
         key = Array(key)
@@ -95,7 +95,7 @@ module Ruote
       @cloche.get_many(type, key, opts)
     end
 
-    def ids (type)
+    def ids(type)
 
       @cloche.ids(type)
     end
@@ -109,15 +109,15 @@ module Ruote
 
     # No need for that here (FsStorage adds type on the fly).
     #
-    def add_type (type)
+    def add_type(type)
     end
 
-    def purge_type! (type)
+    def purge_type!(type)
 
       @cloche.purge_type!(type)
     end
 
-    def dump (type)
+    def dump(type)
 
       s = "=== #{type} ===\n"
 
@@ -128,6 +128,13 @@ module Ruote
         end
       end
     end
+
+    # Shuts this storage down.
+    #
+    def shutdown
+
+      # nothing to do
+    end
   end
 end