ruote 0.9.19 → 0.9.20

data/lib/openwfe/expressions/fe_set.rb

@@ -1,41 +1,27 @@
-#
 #--
-# Copyright (c) 2006-2008, John Mettraux, OpenWFE.org
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
+# Copyright (c) 2006-2009, John Mettraux, jmettraux@gmail.com
 #
-# . Redistributions of source code must retain the above copyright notice, this
-#   list of conditions and the following disclaimer.
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
 #
-# . Redistributions in binary form must reproduce the above copyright notice,
-#   this list of conditions and the following disclaimer in the documentation
-#   and/or other materials provided with the distribution.
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
 #
-# . Neither the name of the "OpenWFE" nor the names of its contributors may be
-#   used to endorse or promote products derived from this software without
-#   specific prior written permission.
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
 #
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-# POSSIBILITY OF SUCH DAMAGE.
+# Made in Japan.
 #++
-#
 
-#
-# "made in Japan"
-#
-# John Mettraux at openwfe.org
-#
 
 require 'openwfe/workitem'
 require 'openwfe/flowexpressionid'
@@ -84,20 +70,17 @@ module OpenWFE
 
     names :set
 
-
     def reply (workitem)
 
       vkey = lookup_variable_attribute(workitem)
       fkey = lookup_field_attribute(workitem)
 
-      value = workitem.attributes[FIELD_RESULT]
-
-      #puts "value is '#{value}'"
+      value = workitem.get_result
 
       if vkey
-        set_variable vkey, value
+        set_variable(vkey, value)
       elsif fkey
-        workitem.set_attribute fkey, value
+        workitem.set_attribute(fkey, value)
       else
         raise "'variable' or 'field' attribute missing from 'set' expression"
       end
@@ -117,7 +100,6 @@ module OpenWFE
 
     names :unset
 
-
     def apply (workitem)
 
       vkey = lookup_variable_attribute(workitem)
@@ -126,12 +108,12 @@ module OpenWFE
       if vkey
         delete_variable(vkey)
       elsif fkey
-        workitem.unset_attribute fkey
+        workitem.unset_attribute(fkey)
       else
         raise "attribute 'variable' or 'field' is missing for 'unset' expression"
       end
 
-      reply_to_parent workitem
+      reply_to_parent(workitem)
     end
   end
 

data/lib/openwfe/expressions/fe_step.rb

@@ -1,41 +1,27 @@
-#
 #--
-# Copyright (c) 2008, John Mettraux, OpenWFE.org
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
+# Copyright (c) 2008-2009, John Mettraux, jmettraux@gmail.com
 #
-# . Redistributions of source code must retain the above copyright notice, this
-#   list of conditions and the following disclaimer.
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
 #
-# . Redistributions in binary form must reproduce the above copyright notice,
-#   this list of conditions and the following disclaimer in the documentation
-#   and/or other materials provided with the distribution.
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
 #
-# . Neither the name of the "OpenWFE" nor the names of its contributors may be
-#   used to endorse or promote products derived from this software without
-#   specific prior written permission.
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
 #
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-# POSSIBILITY OF SUCH DAMAGE.
+# Made in Japan.
 #++
-#
 
-#
-# "made in Japan"
-#
-# John Mettraux at openwfe.org
-#
 
 require 'openwfe/expressions/flowexpression'
 
@@ -120,7 +106,8 @@ module OpenWFE
       @default = lookup_attribute(
         :default, workitem, :to_s => true)
 
-      store_itself
+      #store_itself
+        # now done in tlaunch_child()
 
       # launching the 'step' itself
 
@@ -131,16 +118,14 @@ module OpenWFE
       ]
 
       get_expression_pool.tlaunch_child(
-        self, template, 0, workitem, true) #, vars=nil
+        self, template, 0, workitem, :register_child => true)
     end
 
     def reply (workitem)
 
-      outcome = workitem.fields.delete 'outcome'
+      outcome = workitem.fields.delete('outcome')
       outcome = outcome.to_s if outcome
 
-      #p [ outcome, @outcomes, @default ]
-
       outcome = @default \
         if @outcomes and (not @outcomes.include?(outcome))
 
@@ -153,7 +138,7 @@ module OpenWFE
         [], # children
       ]
 
-      get_expression_pool.substitute_and_apply self, template, workitem
+      get_expression_pool.substitute_and_apply(self, template, workitem)
     end
   end
 

data/lib/openwfe/expressions/fe_subprocess.rb

@@ -1,41 +1,27 @@
-#
 #--
-# Copyright (c) 2006-2008, John Mettraux, OpenWFE.org
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
+# Copyright (c) 2006-2009, John Mettraux, jmettraux@gmail.com
 #
-# . Redistributions of source code must retain the above copyright notice, this
-#   list of conditions and the following disclaimer.
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
 #
-# . Redistributions in binary form must reproduce the above copyright notice,
-#   this list of conditions and the following disclaimer in the documentation
-#   and/or other materials provided with the distribution.
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
 #
-# . Neither the name of the "OpenWFE" nor the names of its contributors may be
-#   used to endorse or promote products derived from this software without
-#   specific prior written permission.
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
 #
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-# POSSIBILITY OF SUCH DAMAGE.
+# Made in Japan.
 #++
-#
 
-#
-# "made in Japan"
-#
-# John Mettraux at openwfe.org
-#
 
 require 'openwfe/utils'
 
@@ -113,44 +99,35 @@ module OpenWFE
 
       conditional = eval_condition(:if, workitem, :unless)
 
-      return reply_to_parent(workitem) \
-        if conditional == false
+      return reply_to_parent(workitem) if conditional == false
 
-      ref = lookup_ref workitem
+      template = if self.respond_to?(:hint)
 
-      raise "'subprocess' expression misses a 'ref', 'field-ref' or 'variable-ref' attribute" unless ref
+        hint
 
-      template_uri = OpenWFE::parse_known_uri ref
+      else
 
-      template = template_uri || lookup_variable(ref)
+        ref = lookup_ref(workitem)
 
-      raise "did not find any subprocess named '#{ref}'" \
-        if not template
+        raise "'subprocess' expression misses a 'ref', 'field-ref' or 'variable-ref' attribute" unless ref
 
-      forget = lookup_boolean_attribute :forget, workitem
+        OpenWFE::parse_known_uri(ref) || lookup_variable(ref)
+      end
 
-      params = lookup_attributes workitem
+      raise "did not find any subprocess named '#{ref}'" unless template
 
-      text = fetch_text_content workitem, false
-      params["0"] = text if text
+      forget = lookup_boolean_attribute(:forget, workitem)
 
-      #puts
-      #puts " ... params are #{params.keys.join(', ')}"
-      #puts " ... values are #{params.values.join(', ')}"
+      params = lookup_attributes(workitem)
 
-      #requester = if forget
-      #  @fei.workflow_instance_id
-      #else
-      #  @fei
-      #end
-      #sub_fei = get_expression_pool.launch_template(
-      #  requester, nil, get_next_sub_id, template, workitem, params)
+      text = fetch_text_content(workitem, false)
+      params['0'] = text if text
 
       sub_fei = get_expression_pool.launch_subprocess(
         self, template, forget, workitem, params)
 
       if forget
-        reply_to_parent workitem.dup
+        reply_to_parent(workitem.dup)
       else
         @subprocess_fei = sub_fei.dup
         store_itself # to keep track of @subprocess_fei
@@ -162,8 +139,10 @@ module OpenWFE
     #
     def cancel
 
+      trigger_on_cancel # if any
+
       return nil unless @subprocess_fei
-      get_expression_pool.cancel @subprocess_fei
+      get_expression_pool.cancel(@subprocess_fei)
     end
   end
 

data/lib/openwfe/expressions/fe_timeout.rb

@@ -1,43 +1,27 @@
-#
 #--
-# Copyright (c) 2007-2008, John Mettraux, OpenWFE.org
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
+# Copyright (c) 2007-2009, John Mettraux, jmettraux@gmail.com
 #
-# . Redistributions of source code must retain the above copyright notice, this
-#   list of conditions and the following disclaimer.
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
 #
-# . Redistributions in binary form must reproduce the above copyright notice,
-#   this list of conditions and the following disclaimer in the documentation
-#   and/or other materials provided with the distribution.
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
 #
-# . Neither the name of the "OpenWFE" nor the names of its contributors may be
-#   used to endorse or promote products derived from this software without
-#   specific prior written permission.
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
 #
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-# POSSIBILITY OF SUCH DAMAGE.
+# Made in Japan.
 #++
-#
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
-#
-# "made in Japan"
-#
-# John Mettraux at openwfe.org
-#
 
 require 'openwfe/expressions/timeout'
 
@@ -67,16 +51,13 @@ module OpenWFE
 
     def apply (workitem)
 
-      if @children.size < 1
-        reply_to_parent workitem
-        return
-      end
+      return reply_to_parent(workitem) if has_no_expression_child
 
       @applied_workitem = workitem.dup
 
-      schedule_timeout :after
+      schedule_timeout(workitem, :after)
 
-      get_expression_pool.apply @children[0], workitem
+      apply_child(first_expression_child, workitem)
     end
 
     #
@@ -85,7 +66,7 @@ module OpenWFE
     #
     def reply (workitem)
 
-      unschedule_timeout
+      unschedule_timeout(workitem)
 
       super
     end
@@ -98,9 +79,12 @@ module OpenWFE
 
       get_expression_pool.cancel(@children[0]) if @applied_workitem
 
-      unschedule_timeout
+      unschedule_timeout(nil)
 
-      super
+      trigger_on_cancel # if any
+
+      #super
+      @applied_workitem
     end
 
     #
@@ -111,11 +95,11 @@ module OpenWFE
 
       ldebug { "trigger() timeout requested for #{@fei.to_debug_s}" }
 
-      set_timedout_flag @applied_workitem
+      set_timedout_flag(@applied_workitem)
 
       cancel
 
-      reply_to_parent @applied_workitem
+      reply_to_parent(@applied_workitem)
     end
   end
 

data/lib/openwfe/expressions/fe_wait.rb

@@ -1,47 +1,37 @@
-#
 #--
-# Copyright (c) 2007, John Mettraux, OpenWFE.org
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
+# Copyright (c) 2006-2009, John Mettraux, jmettraux@gmail.com
 #
-# . Redistributions of source code must retain the above copyright notice, this
-#   list of conditions and the following disclaimer.
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
 #
-# . Redistributions in binary form must reproduce the above copyright notice,
-#   this list of conditions and the following disclaimer in the documentation
-#   and/or other materials provided with the distribution.
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
 #
-# . Neither the name of the "OpenWFE" nor the names of its contributors may be
-#   used to endorse or promote products derived from this software without
-#   specific prior written permission.
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
 #
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-# POSSIBILITY OF SUCH DAMAGE.
+# Made in Japan.
 #++
-#
-
-#
-# "made in Japan"
-#
-# John Mettraux at openwfe.org
-#
-
-require 'openwfe/expressions/fe_when'
 
 
 module OpenWFE
 
+  #
+  # Since Ruote 0.9.20, 'sleep' got merged into 'wait' (according to Kenneth
+  # 'wait' sounds less lazy than 'sleep')
+  #
+  # The expression names are interchangeable.
+  #
+  # = wait
   #
   # The 'wait' expression simply blocks/waits until the given condition
   # evaluates to true.
@@ -67,11 +57,127 @@ module OpenWFE
   # the wait ceases and the flow resumes. On a timeout, 'when' will not
   # execute its nested 'consequence' child.
   #
+  #
+  # = sleep
+  #
+  # The 'sleep' expression expects one attribute, either 'for', either
+  # 'until'.
+  #
+  #   <sequence>
+  #     <sleep for="10m12s" />
+  #     <participant ref="alpha" />
+  #   </sequence>
+  #
+  # will wait for 10 minutes and 12 seconds before sending a workitem
+  # to participant 'alpha'.
+  #
+  # In a Ruby process definition, that might look like :
+  #
+  #   _sleep :for => "3m"
+  #   _sleep "3m"
+  #     #
+  #     # both meaning 'sleep for 3 minutes'
+  #
+  #   _sleep :until => "Mon Dec 03 10:41:58 +0900 2007"
+  #     #
+  #     # sleep until the given point in time
+  #
+  # If the 'until' attribute points to a time in the past, the sleep
+  # expression will simply let the process resume.
+  #
+  # _sleep needs to be used instead of 'sleep', so it doesn't conflict
+  # with Ruby's builtin sleep method.
+  #
+  # === scheduler tags
+  #
+  # Scheduler tags can be set like this :
+  #
+  #   _sleep "10y", :scheduler_tags => "la_belle_au_bois_dormant"
+  #
+  # This is an advanced feature (that most users won't need).
+  #
+  # === sleeping for 8 hours
+  #
+  # If you tell a process instance to sleep for 8 hours, then shutdown the
+  # engine for 4 hours, at restart, it will sleep until the 8 hours have
+  # passed (so it will sleep for four hours).
+  #
+  # If the engine is stopped for more than eight hours, at restart, the process
+  # instance will immediately resume (sleep overdone).
+  #
   class WaitExpression < WaitingExpression
 
-    names :wait
+    names :wait, :sleep
     conditions :until
-  end
 
+    attr_accessor :until
+
+    def apply (workitem)
+
+      #
+      # is it a sleep ?
+
+      sfor = lookup_string_attribute(:for, workitem)
+      suntil = lookup_string_attribute(:until, workitem)
+
+      sfor = fetch_text_content(workitem) if sfor == nil and suntil == nil
+
+      @until = if suntil
+        Rufus.to_ruby_time(suntil) rescue nil
+      elsif sfor
+        (Time.new.to_f + Rufus::parse_time_string(sfor)) rescue nil
+      else
+        nil # just to be sure
+      end
+
+      @until ? apply_sleep(workitem) : super(workitem)
+    end
+
+    def reschedule (scheduler)
+
+      @until ? reschedule_sleep : super(scheduler)
+    end
+
+    def trigger (params={})
+
+      @until ? reply_to_parent(@applied_workitem) : super(params)
+    end
+
+    protected
+
+    def apply_sleep (workitem) #:nodoc#
+
+      @applied_workitem = workitem.dup
+
+      determine_scheduler_tags
+
+      reschedule(get_scheduler)
+    end
+
+    def reschedule_sleep #:nodoc#
+
+      ldebug do
+        "[re]schedule() " +
+        "will sleep until '#{@until}' " +
+        "(#{Rufus::to_iso8601_date(@until)})"
+      end
+
+      @scheduler_job_id = "sleep_#{self.fei.to_s}"
+
+      store_itself
+
+      get_scheduler.schedule_at(
+        @until,
+        {
+          :schedulable => self,
+          :job_id => @scheduler_job_id,
+          :tags => @scheduler_tags })
+
+      ldebug do
+        "[re]schedule() @scheduler_job_id is '#{@scheduler_job_id}' "+
+        " (scheduler #{scheduler.object_id})"
+      end
+    end
+  end
 end