ruote 0.9.20 → 2.1.1

data/lib/openwfe/expressions/fe_sequence.rb

@@ -1,102 +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'
-
-
-module OpenWFE
-
-  #
-  # This expression sequentially executes each of its children expression.
-  # For a more sophisticated version of it, see the 'cursor' expression
-  # (fe_cursor.rb).
-  #
-  #   <sequence>
-  #     <participant ref="alice" />
-  #     <participant ref="service_b" />
-  #   </sequence>
-  #
-  # In a Ruby process definition, it looks like :
-  #
-  #   sequence do
-  #     participant "alice"
-  #     participant "service_b"
-  #   end
-  #
-  class SequenceExpression < FlowExpression
-
-    names :sequence
-
-    def apply (workitem)
-
-      reply(workitem)
-    end
-
-    def reply (workitem)
-
-      child_index = next_child_index(workitem.fei)
-
-      return reply_to_parent(workitem) unless child_index
-
-      @children.clear if @children
-        # keeping track of only 1 child, it's a sequence ...
-
-      apply_child(child_index, workitem)
-    end
-
-    protected
-
-    #
-    # Returns the child_index (in the raw_children array) of the next child
-    # to apply, or nil if the sequence is over.
-    #
-    def next_child_index (returning_fei)
-
-      next_id = if returning_fei.is_a?(Integer)
-        returning_fei + 1
-      elsif returning_fei == self.fei
-        0
-      else
-        returning_fei.child_id.to_i + 1
-      end
-
-      loop do
-
-        break if next_id > raw_children.length
-
-        raw_child = raw_children[next_id]
-
-        return next_id \
-          if raw_child.is_a?(Array) or raw_child.is_a?(FlowExpressionId)
-
-        next_id += 1
-      end
-
-      nil
-    end
-  end
-
-end
-

data/lib/openwfe/expressions/fe_set.rb

@@ -1,121 +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/workitem'
-require 'openwfe/flowexpressionid'
-require 'openwfe/expressions/flowexpression'
-require 'openwfe/expressions/value'
-
-
-module OpenWFE
-
-  #
-  # The 'set' expression is used to set the value of a (process) variable or
-  # a (workitem) field.
-  #
-  #   <set field="price" value="CHF 12.00" />
-  #   <set variable="/stage" value="3" />
-  #   <set variable="/stage" field-value="f_stage" />
-  #   <set field="stamp" value="${r:Time.now.to_i}" />
-  #
-  # (Notice the usage of the dollar notation in the last exemple).
-  #
-  # 'set' expressions may be placed outside of a process-definition body,
-  # they will be evaluated sequentially before the body gets applied
-  # (executed).
-  #
-  # Shorter attributes are OK :
-  #
-  #   <set f="price" val="CHF 12.00" />
-  #   <set v="/stage" val="3" />
-  #   <set v="/stage" field-val="f_stage" />
-  #   <set f="stamp" val="${r:Time.now.to_i}" />
-  #
-  #   set :f => "price", :val => "USD 12.50"
-  #   set :v => "toto", :val => "elvis"
-  #
-  # In case you need the value not to be evaluated if it contains
-  # dollar expressions, you can do
-  #
-  #   set :v => "v0", :val => "my ${template} thing", :escape => true
-  #
-  # to prevent evaluation (i.e. to escape).
-  #
-  class SetValueExpression < FlowExpression
-    include ValueMixin
-
-    is_definition
-
-    names :set
-
-    def reply (workitem)
-
-      vkey = lookup_variable_attribute(workitem)
-      fkey = lookup_field_attribute(workitem)
-
-      value = workitem.get_result
-
-      if vkey
-        set_variable(vkey, value)
-      elsif fkey
-        workitem.set_attribute(fkey, value)
-      else
-        raise "'variable' or 'field' attribute missing from 'set' expression"
-      end
-
-      reply_to_parent(workitem)
-    end
-  end
-
-  #
-  # 'unset' removes a field or a variable.
-  #
-  #   unset :field => "price"
-  #   unset :variable => "eval_result"
-  #
-  class UnsetValueExpression < FlowExpression
-    include ValueMixin
-
-    names :unset
-
-    def apply (workitem)
-
-      vkey = lookup_variable_attribute(workitem)
-      fkey = lookup_field_attribute(workitem)
-
-      if vkey
-        delete_variable(vkey)
-      elsif fkey
-        workitem.unset_attribute(fkey)
-      else
-        raise "attribute 'variable' or 'field' is missing for 'unset' expression"
-      end
-
-      reply_to_parent(workitem)
-    end
-  end
-
-end
-

data/lib/openwfe/expressions/fe_step.rb

@@ -1,146 +0,0 @@
-#--
-# Copyright (c) 2008-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'
-
-
-module OpenWFE
-
-  #
-  # This expression takes its root in this "trouble ticket blog post" :
-  #
-  #   http://jmettraux.wordpress.com/2008/01/04/the-trouble-ticket-process/
-  #
-  # In this post, the "step" was implemented directly in the OpenWFEru
-  # process definition language.
-  #
-  # It's been turned into an expression and it's not limited anymore to
-  # the concept "state is a participant, transition points to a subprocess",
-  # state can now point to a subprocess as well as to a participant, idem
-  # for a transition.
-  #
-  # In other words, this "step" expression allows you to write
-  # state-transition process definitions in OpenWFEru (the Ruote workflow
-  # engine). But don't abuse it. Classical OpenWFEru constructs can
-  # do most of the job.
-  #
-  # An interesting aspect of the "step" expression is that it can remove
-  # the need for some "if" expression constructs (well the fact
-  #
-  #   class ProcDef0 < OpenWFE::ProcessDefinition
-  #
-  #     sequence do
-  #
-  #     step "Alfred", :outcomes => [ 'blue_pen', 'red_pen' ]
-  #       # Alfred gets to choose between a blue pen and a red pen
-  #
-  #     participant "Bob"
-  #       # flow resumes with Bob in a classical way (sequence)
-  #     end
-  #
-  #     define "blue_pen" do
-  #     # ... Alfred buying a blue pen
-  #     end
-  #     define "red_pen" do
-  #     # ... Alfred buying a red pen
-  #     end
-  #   end
-  #
-  # in XML it would look like :
-  #
-  #   <sequence>
-  #    <step ref="Alfred" outcomes="blue_pen, red_pen" />
-  #    <participant ref="Bob" />
-  #   </sequence>
-  #
-  # You can specify a default outcome (else if the outcome doesn't correspond
-  # to a participant or a subprocess, the flow will cease) :
-  #
-  #   <step ref="toto" outcomes="left, right" default="right" />
-  #
-  # For some more discussions about Ruote and state-transition see
-  #
-  #   http://groups.google.com/group/openwferu-dev/t/16e713c1313cb2fa
-  #
-  class StepExpression < FlowExpression
-
-    names :step
-
-    attr_accessor :outcomes
-    attr_accessor :default
-
-
-    def apply (workitem)
-
-      step =
-        lookup_attribute(:ref, workitem) ||
-        fetch_text_content(workitem)
-
-      # keeping track of outcomes and default as found at apply time
-
-      @outcomes = lookup_array_attribute(
-        :outcomes, workitem, :to_s => true)
-
-      @default = lookup_attribute(
-        :default, workitem, :to_s => true)
-
-      #store_itself
-        # now done in tlaunch_child()
-
-      # launching the 'step' itself
-
-      template = [
-        step.to_s, # expression name
-        lookup_attributes(workitem), # attributes
-        [], # children
-      ]
-
-      get_expression_pool.tlaunch_child(
-        self, template, 0, workitem, :register_child => true)
-    end
-
-    def reply (workitem)
-
-      outcome = workitem.fields.delete('outcome')
-      outcome = outcome.to_s if outcome
-
-      outcome = @default \
-        if @outcomes and (not @outcomes.include?(outcome))
-
-      return reply_to_parent(workitem) \
-        unless outcome
-
-      template = [
-        outcome.to_s, # expression name
-        {}, # attributes
-        [], # children
-      ]
-
-      get_expression_pool.substitute_and_apply(self, template, workitem)
-    end
-  end
-
-end
-

data/lib/openwfe/expressions/fe_subprocess.rb

@@ -1,150 +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'
-
-
-module OpenWFE
-
-  #
-  # This expression is used to launch/call a subprocess.
-  #
-  # For example :
-  #
-  #   <process-definition name="subtest0" revision="0">
-  #     <sequence>
-  #       <subprocess ref="sub0" a="A" b="B" c="C" />
-  #       <sub0 a="A" b="B" c="C" />
-  #     </sequence>
-  #
-  #     <process-definition name="sub0">
-  #       <print>${a}${b}${c}</print>
-  #     </process-definition>
-  #
-  #   </process-definition>
-  #
-  # It's totally OK to have URLs as referenced processes :
-  #
-  #   require 'openwfe/def'
-  #
-  #   class AnotherDefinition0 < OpenWFE::ProcessDefinition
-  #    sequence do
-  #      participant :ref => "toto"
-  #      subprocess :ref => "http://company.process.server/def0.rb"
-  #    end
-  #   end
-  #
-  # (but the engine parameter :remove_definitions_allowed must be set to true,
-  # as it's dangerous to fetch process definitions from other [untrusted]
-  # hosts)
-  #
-  # The 'subprocess' expression accepts a 'forget' attribute :
-  #
-  #   class AnotherDefinition1 < OpenWFE::ProcessDefinition
-  #     sequence do
-  #       subprocess :ref => "my_subprocess", :forget => true
-  #       participant :ref => "ringo"
-  #     end
-  #     process-definition :name => "my_subprocess" do
-  #       participant :ref => "fake steve jobs"
-  #     end
-  #   end
-  #
-  # Note that a 'forgotten subprocess' will not have access to the variables
-  # of its parent process.
-  #
-  # The 'subprocess' expression accepts an 'if' (or 'unless') attribute :
-  #
-  #   subprocess :ref => "interview_process", :if => "${f:screened}"
-  #     # will trigger the subprocess only if the field screened
-  #     # contains the string 'true' or the boolean 'true'
-  #
-  #   interview_process :if => "${f:screened}"
-  #     # idem
-  #
-  #   interview_process :unless => "${f:has_had_problem_with_justice_?}"
-  #     # well...
-  #
-  class SubProcessRefExpression < FlowExpression
-    include ConditionMixin
-
-    names :subprocess
-
-    attr_accessor :subprocess_fei
-
-
-    def apply (workitem)
-
-      conditional = eval_condition(:if, workitem, :unless)
-
-      return reply_to_parent(workitem) if conditional == false
-
-      template = if self.respond_to?(:hint)
-
-        hint
-
-      else
-
-        ref = lookup_ref(workitem)
-
-        raise "'subprocess' expression misses a 'ref', 'field-ref' or 'variable-ref' attribute" unless ref
-
-        OpenWFE::parse_known_uri(ref) || lookup_variable(ref)
-      end
-
-      raise "did not find any subprocess named '#{ref}'" unless template
-
-      forget = lookup_boolean_attribute(:forget, workitem)
-
-      params = lookup_attributes(workitem)
-
-      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)
-      else
-        @subprocess_fei = sub_fei.dup
-        store_itself # to keep track of @subprocess_fei
-      end
-    end
-
-    #
-    # Takes care of cancelling the subprocess as well if any
-    #
-    def cancel
-
-      trigger_on_cancel # if any
-
-      return nil unless @subprocess_fei
-      get_expression_pool.cancel(@subprocess_fei)
-    end
-  end
-
-end
-