ruote 0.9.20 → 2.1.1

data/lib/openwfe/expressions/fe_timeout.rb

@@ -1,107 +0,0 @@
-#--
-# Copyright (c) 2007-2009, 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
-# 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:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# 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.
-#
-# Made in Japan.
-#++
-
-
-require 'openwfe/expressions/timeout'
-
-
-module OpenWFE
-
-  #
-  # The timeout concept begun with the participant expression. When a
-  # participant doesn't reply for a certain amount of time, a specified
-  # timeout can get triggered.
-  # Sometimes something more complex than a single participant needs a
-  # timeout setting, this expression sets a timeout for the expression[s]
-  # nested within it.
-  #
-  #   <timeout after="2d">
-  #     <sequence>
-  #       (...)
-  #     </sequence>
-  #   </timeout>
-  #
-  class TimeoutExpression < FlowExpression
-    include TimeoutMixin
-
-    names :timeout
-
-    attr_accessor :applied_workitem
-
-    def apply (workitem)
-
-      return reply_to_parent(workitem) if has_no_expression_child
-
-      @applied_workitem = workitem.dup
-
-      schedule_timeout(workitem, :after)
-
-      apply_child(first_expression_child, workitem)
-    end
-
-    #
-    # The child expression replies, make sure to unschedule the timeout
-    # before replying (to our own parent expression).
-    #
-    def reply (workitem)
-
-      unschedule_timeout(workitem)
-
-      super
-    end
-
-    #
-    # Cancel order : cancels the child expression (if applied) and
-    # unschedule the timeout (if any).
-    #
-    def cancel
-
-      get_expression_pool.cancel(@children[0]) if @applied_workitem
-
-      unschedule_timeout(nil)
-
-      trigger_on_cancel # if any
-
-      #super
-      @applied_workitem
-    end
-
-    #
-    # The timeout trigger, cancels the nested process segment (the
-    # nested expression).
-    #
-    def trigger (scheduler)
-
-      ldebug { "trigger() timeout requested for #{@fei.to_debug_s}" }
-
-      set_timedout_flag(@applied_workitem)
-
-      cancel
-
-      reply_to_parent(@applied_workitem)
-    end
-  end
-
-end
-

data/lib/openwfe/expressions/fe_wait.rb

@@ -1,183 +0,0 @@
-#--
-# Copyright (c) 2006-2009, 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
-# 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:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# 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.
-#
-# Made in Japan.
-#++
-
-
-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.
-  # This expression accepts a timeout (else it will block ad eternam).
-  #
-  #   sequence do
-  #     wait :until => "${done} == true"
-  #     participant :toto
-  #   end
-  #
-  # Participant 'toto' will receive a workitem after the variable 'done' is
-  # set to true (somewhere else in the process definition).
-  #
-  #   sequence do
-  #     wait :runtil => "Time.new.to_i % 7 == 0"
-  #     participant :toto
-  #   end
-  #
-  # Participant 'toto' will receive a workitem after a certain condition
-  # expressed directly in Ruby evaluates to true.
-  #
-  # 'wait' is different than 'when' : when it times out (if a timeout is set,
-  # 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, :sleep
-    conditions :until
-
-    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
-

data/lib/openwfe/expressions/fe_when.rb

@@ -1,118 +0,0 @@
-#--
-# Copyright (c) 2006-2009, 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
-# 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:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# 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.
-#
-# Made in Japan.
-#++
-
-
-require 'openwfe/utils'
-require 'openwfe/expressions/time'
-require 'openwfe/expressions/timeout'
-require 'openwfe/expressions/condition'
-
-
-module OpenWFE
-
-  #
-  # The 'when' expression will trigger a consequence when a condition
-  # is met, like in
-  #
-  #   <when test="${variable:over} == true">
-  #     <participant ref="toto" />
-  #   </when>
-  #
-  # where the participant "toto" will receive a workitem when the (local)
-  # variable "over" has the value true.
-  #
-  # This is also possible :
-  #
-  #   <when>
-  #     <equals field-value="done" other-value="true" />
-  #     <participant ref="toto" />
-  #   </when>
-  #
-  # The 'when' expression by defaults, evaluates every 10 seconds its
-  # condition clause.
-  # A different frequency can be stated via the "frequency" attribute :
-  #
-  #   _when :test => "${completion_level} == 4", :frequency => "1s"
-  #     participant "next_stage"
-  #   end
-  #
-  # will check for the completion_level value every second. The scheduler
-  # itself is by default 'waking up' every 250 ms, so setting a frequency to
-  # something smaller than that value might prove useless.
-  # (Note than in the Ruby process definition, the 'when' got escaped to
-  # '_when' not to conflict with the 'when' keyword of the Ruby language).
-  #
-  # The when expression understands the 'timeout' attribute like the
-  # participant expression does. Thus
-  #
-  #   _when :test => "${cows} == 'do fly'", :timeout => "1y"
-  #     participant "me"
-  #   end
-  #
-  # will timeout after one year (participant "me" will not receive a
-  # workitem).
-  #
-  class WhenExpression < WaitingExpression
-
-    names :when
-    conditions :test
-
-    attr_accessor \
-      :consequence_triggered,
-      :condition_sub_id
-
-    def apply (workitem)
-
-      return reply_to_parent(workitem) if has_no_expression_child
-
-      @condition_sub_id = -1
-      @consequence_triggered = false
-
-      super(workitem)
-    end
-
-    def reply (workitem)
-
-      return reply_to_parent(workitem) if @consequence_triggered
-
-      super(workitem)
-    end
-
-    protected
-
-      def apply_consequence (workitem)
-
-        @consequence_triggered = true
-
-        store_itself
-
-        i = 1
-        i = 0 if @children.size == 1
-
-        get_expression_pool.apply(@children[i], workitem)
-      end
-  end
-
-end
-

data/lib/openwfe/expressions/filter.rb

@@ -1,85 +0,0 @@
-#--
-# Copyright (c) 2007-2009, 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
-# 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:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# 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.
-#
-# Made in Japan.
-#++
-
-
-module OpenWFE
-
-  #
-  # This mixin adds filtering capabilities to a FlowExpression.
-  #
-  # It's used by the 'participant' and 'filter' expressions.
-  #
-  module FilterMixin
-
-    attr_accessor :filter
-
-    #
-    # Used when the workitem enters the 'filtered zone'. Will replace
-    # the attributes of the workitem with filtered ones.
-    # Assumes the original workitem is kept under @applied_workitem.
-    #
-    def filter_in (workitem, filter_attribute_name=:filter)
-
-      @filter = get_filter(filter_attribute_name, workitem)
-
-      return unless @filter
-
-      workitem.attributes = @filter.filter_in(workitem.attributes)
-      workitem.filter = @filter.dup
-    end
-
-    #
-    # Prepares the workitem for leaving the 'filtered zone'. Makes sure
-    # hidden and unwritable fields haven't been tampered with. Enforces
-    # the 'add_ok', 'remove_ok', 'closed' filter directives.
-    # Assumes the original workitem is kept under @applied_workitem.
-    #
-    def filter_out (incoming_workitem)
-
-      return unless @filter
-
-      incoming_workitem.filter = nil
-
-      incoming_workitem.attributes = @filter.filter_out(
-        @applied_workitem.attributes, incoming_workitem.attributes)
-    end
-
-    protected
-
-      #
-      # Fetches the filter pointed at via the 'filter' attribute
-      # of the including expression class.
-      #
-      def get_filter (filter_attribute_name, workitem)
-
-        filter_name = lookup_attribute(filter_attribute_name, workitem)
-
-        return nil unless filter_name
-
-        lookup_variable(filter_name)
-      end
-  end
-
-end
-