ruote 0.9.20 → 2.1.1

data/lib/openwfe/expressions/fe_cron.rb

@@ -1,197 +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'
-
-
-module OpenWFE
-
-  #
-  # Scheduling subprocesses for repeating execution
-  #
-  #   <cron tab="0 9-17 * * mon-fri">
-  #     <send-reminder/>
-  #   </cron>
-  #
-  # In this short process definition snippet, the subprocess "send-reminder"
-  # will get triggered once per hour (minute 0) from 0900 to 1700 and
-  # this, from monday to friday.
-  #
-  # It's possible to specify 'every' instead of 'tab' :
-  #
-  #   cron :every => "10m3s" do
-  #     send_reminder
-  #   end
-  #
-  # The subprocess 'send_reminder' will thus be triggered every ten minutes
-  # and three seconds.
-  #
-  # The cron expression never replies [to its parent expression].
-  # The classical usage for it is with a concurrence set to expect only
-  # one reply :
-  #
-  #   concurrence :count => 1 do
-  #     participant :toto
-  #     cron :every => "10m" do
-  #       send_reminder_email :target => "toto@headlost.org.uk"
-  #     end
-  #   end
-  #
-  # The sub process 'send_reminder_email' will thus be triggered every 10
-  # minutes while concurrence is waiting for the answer (reply) of the
-  # participant :toto.
-  #
-  # If the process instance containing a cron is paused, the cron won't get
-  # triggered until the process is resumed.
-  #
-  # === scheduler tags
-  #
-  # Scheduler tags can be set like this :
-  #
-  #   cron :every => "10s", :scheduler_tags => "pesky_job" do
-  #     participant :ref => "toto"
-  #   end
-  #
-  # This is an advanced feature that most users won't need.
-  #
-  class CronExpression < TimeExpression
-
-    names :cron
-
-    #
-    # The cron 'tab', something like "0 9-17 * * mon-fri"
-    #
-    attr_accessor :tab
-
-    #
-    # If 'tab' is not, then 'every' should, the expression will trigger
-    # at the frequency specified here (like for example "10m3s).
-    #
-    attr_accessor :every
-
-    #
-    # Keeping track of how many times the cron fired.
-    #
-    attr_accessor :counter
-
-
-    def apply (workitem)
-
-      return reply_to_parent(workitem) if has_no_expression_child
-
-      @counter = -1
-
-      @applied_workitem = workitem.dup
-      @applied_workitem.flow_expression_id = nil
-
-      @tab = lookup_attribute(:tab, workitem)
-      @every = lookup_attribute(:every, workitem)
-
-      determine_scheduler_tags
-
-      #
-      # schedule self
-
-      reschedule(get_scheduler)
-    end
-
-    def reply (workitem)
-      # discard silently...
-    end
-
-    #
-    # This is the method called each time the scheduler triggers
-    # this cron. The contained segment of process will get
-    # executed.
-    #
-    def trigger (params)
-
-      return if paused?
-
-      ldebug { "trigger() cron : #{@fei.to_debug_s}" }
-
-      #@raw_child.application_context = @application_context
-        # done in expool.tlaunch_child()
-
-      begin
-
-        @counter += 1
-        store_itself
-          #
-          # note : one variant would be to give Time.now.to_f as a sub_id...
-          # then no need to store...
-          #
-          # but it's good to have a counter to keep track of the number of
-          # executions
-
-        child_fei = get_expression_pool.tlaunch_child(
-          self,
-          first_expression_child,
-          @counter,
-          @applied_workitem.dup,
-          :register_child => false)
-            #
-            # register_child is set to false, cron doesn't keep
-            # track of its spawned children
-
-      rescue
-
-        lerror do
-          "trigger() cron caught exception\n#{OpenWFE::exception_to_s($!)}"
-        end
-      end
-    end
-
-    #
-    # This method is called at the first schedule of this expression
-    # or each time the engine is restarted and this expression has
-    # to be rescheduled.
-    #
-    def reschedule (scheduler)
-
-      @scheduler_job_id = "#{@fei.wfid}__#{@scheduler_job_id}"
-
-      method, arg0 = if @tab
-        [ :schedule, @tab ]
-      else
-        [ :schedule_every, @every ]
-      end
-
-      get_scheduler.send(
-        method,
-        arg0,
-        {
-          :schedulable => self,
-          :job_id => @scheduler_job_id,
-          :tags => @scheduler_tags })
-
-      #ldebug { "reschedule() name is   '#{@name}'" }
-      ldebug { "reschedule() job id is '#{@scheduler_job_id}'" }
-    end
-  end
-
-end
-

data/lib/openwfe/expressions/fe_cursor.rb

@@ -1,200 +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/flowexpression'
-require 'openwfe/expressions/fe_command'
-
-
-module OpenWFE
-
-  #
-  # The 'cursor' is much like a sequence, but you can go
-  # back and forth within it, as it reads the field '\_\_cursor_command__' (or
-  # the field specified in the 'command-field' attribute) at each
-  # transition (each time it's supposed to move from one child expression to
-  # the next).
-  #
-  #   cursor do
-  #     participant "alpha"
-  #     skip :step => "2"
-  #     participant "bravo"
-  #     participant "charly"
-  #     set :field => "__cursor_command__", value => "2"
-  #     participant "delta"
-  #     participant "echo"
-  #     skip 2
-  #     participant "fox"
-  #     #
-  #     # in that cursor example, only the participants alpha, charly and
-  #     # echo will be handed a workitem
-  #     # (notice the last 'skip' with its light syntax)
-  #     #
-  #   end
-  #
-  # As you can see, you can directly set the value of the field
-  # '\_\_cursor_command__' or use a CursorCommandExpression like 'skip' or
-  # 'jump'.
-  #
-  # == 'rewind-if' / 'break-if'
-  #
-  # Since Ruote 0.9.20 (december 2008), the 'cursor' (or 'loop') expression
-  # accepts an 'rewind-if' or 'break-if' attribute.
-  #
-  #   Test0 = OpenWFE.process_definition :name => 'ft_9c', :revision => '0' do
-  #     cursor :rewind_if => "${f:restart}" do
-  #       alpha
-  #       bravo
-  #       charly
-  #     end
-  #   end
-  #
-  # This process will be rewound (jump back to 'alpha') if alpha, bravo or
-  # charly set the field 'restart' to 'true'.
-  # (remember to reset the field if you don't want to rewind/break again and
-  # again...)
-  #
-  # Note that 'rewind-unless' and 'break-unless' are understood as well.
-  #
-  class CursorExpression < FlowExpression
-    include CommandMixin
-
-    names :cursor
-
-    #
-    # the integer identifier for the current loop
-    #
-    attr_accessor :loop_id
-
-    #
-    # what is the index of the child we're currently executing
-    #
-    attr_accessor :current_child_id
-
-
-    def apply (workitem)
-
-      new_environment
-
-      @loop_id = 0
-      @current_child_id = -1
-
-      reply(workitem)
-    end
-
-    def reply (workitem)
-
-      return reply_to_parent(workitem) if raw_children.size < 1
-        #
-        # well, currently, no infinite empty loop allowed
-
-      command, step = determine_command_and_step(workitem)
-
-      #ldebug { "reply() command is '#{command} #{step}'" }
-
-      return reply_to_parent(workitem) if BREAK_COMMANDS.include?(command)
-
-      if command == C_REWIND or command == C_CONTINUE
-
-        @current_child_id = 0
-
-      elsif command and command.match("^#{C_JUMP}")
-
-        @current_child_id = step
-        @current_child_id = 0 if @current_child_id < 0
-
-        @current_child_id = raw_children.length - 1 \
-          if @current_child_id >= raw_children.length
-
-      else # C_SKIP or C_BACK
-
-        @current_child_id = @current_child_id + step
-
-        @current_child_id = 0 if @current_child_id < 0
-
-        if @current_child_id >= raw_children.length
-
-          return reply_to_parent(workitem) unless is_loop
-
-          @loop_id += 1
-          @current_child_id = 0
-        end
-      end
-
-      template = raw_children[@current_child_id]
-
-      #
-      # launch the next child as a template
-
-      @children.clear if @children
-      apply_child(@current_child_id, workitem)
-
-      #store_itself
-        # now done in apply_child()
-    end
-
-    #
-    # Returns false, the child class LoopExpression does return true.
-    #
-    def is_loop
-
-      false
-    end
-
-  end
-
-  #
-  # The 'loop' expression is like 'cursor' but it doesn't exit until
-  # it's broken (with 'break' or 'cancel').
-  #
-  #   <loop>
-  #     <participant ref="toto" />
-  #     <break if="${f:done} == true" />
-  #   </loop>
-  #
-  # or, in a Ruby process definition :
-  #
-  #   _loop do
-  #     participant "toto"
-  #     _break :if => "${f:done} == true"
-  #   end
-  #
-  # (notice the _ (underscores) to distinguish the OpenWFEru expressions
-  # from the native Ruby ones).
-  #
-  class LoopExpression < CursorExpression
-
-    names :loop, :repeat
-
-    #
-    # Returns true as, well, it's a loop...
-    #
-    def is_loop
-
-      true
-    end
-  end
-
-end
-

data/lib/openwfe/expressions/fe_define.rb

@@ -1,146 +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/expressions/flowexpression'
-require 'openwfe/expressions/fe_sequence'
-
-
-module OpenWFE
-
-  #
-  # The <process-definition> expression.
-  #
-  #   <process-definition name="myprocess" revision="2">
-  #     <sequence>
-  #       <participant ref="alpha" />
-  #       <subprocess ref="sub0" />
-  #     </sequence>
-  #     <process-definition name="sub0">
-  #       <participant ref="bravo" />
-  #     </process-definition>
-  #   </process-definition>
-  #
-  # In a Ruby process definition :
-  #
-  #   class Test0 < OpenWFE::ProcessDefinition
-  #
-  #     sequence do
-  #       sub0
-  #       sub1
-  #       sub2
-  #       sub3
-  #     end
-  #
-  #     process_definition :name => "sub0" do
-  #       _print "sub0"
-  #     end
-  #     define :name => "sub1" do
-  #       _print "sub1"
-  #     end
-  #     process_definition "sub2" do
-  #       _print "sub2"
-  #     end
-  #     define "sub3" do
-  #       _print "sub3"
-  #     end
-  #   end
-  #
-  # It is most often used with its "process-definition" name, but "define"
-  # and "workflow-definition" are accepted as well.
-  #
-  class DefineExpression < SequenceExpression
-
-    is_definition
-
-    names :define, :process_definition, :workflow_definition
-
-    #
-    # A pointer to the body expression of this process definition.
-    #
-    attr_accessor :body_index
-
-    #
-    # keeping track of whether the body of the process got started or not
-    #
-    attr_accessor :applied_body
-
-    #
-    # Called at the end of the 'evaluation', the 'apply' operation on
-    # the body of the definition is done here.
-    #
-    def reply_to_parent (workitem)
-
-      return super(workitem) if @body_index == nil or @applied_body
-        # no body or body just got applied
-
-      # apply body of process definition now
-
-      @applied_body = true
-
-      #store_itself
-        # now done in apply_child()
-
-      apply_child(@body_index, workitem)
-    end
-
-    protected
-
-      def next_child_index (returning_fei)
-
-        child_index = super
-
-        return nil unless child_index
-
-        child = raw_children[child_index]
-
-        if child.is_a?(Array) && ( ! [ 'param', 'parameter' ].include?(child[0]))
-
-          if get_expression_map.get_class(child[0]) == DefineExpression
-
-            name = child[1]['name'] || child[2].first
-
-            raise "process definition without a 'name' attribute" \
-              unless name
-
-            set_variable(name.to_s, child)
-
-          elsif get_expression_map.is_definition?(child[0])
-
-            return child_index # let it get 'applied'
-
-          elsif @body_index == nil
-
-            @body_index = child_index
-            store_itself
-          end
-
-        end
-
-        next_child_index(child_index)
-      end
-  end
-
-end
-