ruote 0.9.20 → 2.1.1

data/lib/openwfe/expressions/iterator.rb

@@ -1,206 +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
-
-  #
-  # Iterator instances keep track of the position of an iteration.
-  # This class is meant to be used both by <iterator> and
-  # <concurrent-iterator>.
-  #
-  class Iterator
-
-    ITERATOR_COUNT = '__ic__'
-    ITERATOR_POSITION = '__ip__'
-
-    attr_accessor :iteration_index
-    attr_accessor :iteration_list
-    attr_accessor :to_field
-    attr_accessor :to_variable
-    attr_accessor :value_separator
-
-    #
-    # Builds a new iterator, serving a given iterator_expression.
-    # The second parameter is the workitem (as applied to the iterator
-    # expression).
-    #
-    def initialize (iterator_expression, workitem)
-
-      @to_field = iterator_expression\
-        .lookup_attribute(:to_field, workitem)
-      @to_variable = iterator_expression\
-        .lookup_attribute(:to_variable, workitem)
-
-      @value_separator = iterator_expression\
-        .lookup_attribute(:value_separator, workitem)
-
-      @value_separator = /,\s*/ unless @value_separator
-
-      @iteration_index = 0
-
-      #raw_list = iterator_expression.lookup_vf_attribute(
-      #  workitem, :value, :prefix => :on)
-      #raw_list ||= iterator_expression.lookup_attribute(:on, workitem)
-
-      raw_list =
-        iterator_expression.lookup_vf_attribute(
-          workitem, :value, :prefix => :on) ||
-        iterator_expression.lookup_vf_attribute(
-          workitem, nil, :prefix => :on)
-
-      @iteration_list = extract_iteration_list raw_list
-
-      workitem.attributes[ITERATOR_COUNT] = @iteration_list.length
-    end
-
-    #
-    # Has the iteration a next element ?
-    #
-    def has_next?
-
-      @iteration_index < @iteration_list.size
-    end
-
-    #
-    # Returns the size of this iterator, or rather, the size of the
-    # underlying iteration list.
-    #
-    def size
-
-      @iteration_list.size
-    end
-
-    #
-    # Prepares the iterator expression and the workitem for the next
-    # iteration.
-    #
-    def next (workitem)
-
-      position_at(workitem, @iteration_index)
-    end
-
-    #
-    # Positions the iterator back at position 0.
-    #
-    def rewind (workitem)
-
-      position_at(workitem, 0)
-    end
-
-    #
-    # Jumps to a given position in the iterator
-    #
-    def jump (workitem, index)
-
-      index = if index < 0
-        0
-      elsif index >= @iteration_list.size
-        @iteration_list.size
-      else
-        index
-      end
-
-      position_at(workitem, index)
-    end
-
-    #
-    # Jumps a certain number of positions in the iterator.
-    #
-    def skip (workitem, offset)
-
-      jump(workitem, @iteration_index + offset)
-    end
-
-    #
-    # The current index (whereas @iteration_index already points to
-    # the next element).
-    #
-    def index
-
-      @iteration_index - 1
-    end
-
-    protected
-
-      #
-      # Positions the iterator absolutely.
-      #
-      def position_at (workitem, position)
-
-        result = {}
-
-        value = @iteration_list[position]
-
-        return nil if (value == nil)
-
-        if @to_field
-          workitem.attributes[@to_field] = value
-        else
-          result[@to_variable] = value
-        end
-
-        workitem.attributes[ITERATOR_POSITION] = position
-        result[ITERATOR_POSITION] = position
-
-        @iteration_index = position + 1
-
-        result
-      end
-
-      #
-      # Extracts the iteration list from any value.
-      #
-      def extract_iteration_list (raw_list)
-
-        if is_suitable_list?(raw_list)
-          raw_list
-        else
-          extract_list_from_string raw_list.to_s
-        end
-      end
-
-      #
-      # Returns true if the given instance can be directly
-      # used as a list.
-      #
-      def is_suitable_list? (instance)
-
-        (not instance.is_a?(String)) and \
-        instance.respond_to? :[] and \
-        instance.respond_to? :length
-      end
-
-      #
-      # Extracts the list from the string (comma separated list
-      # usually).
-      #
-      def extract_list_from_string (s)
-
-        s.split @value_separator
-      end
-  end
-
-end
-

data/lib/openwfe/expressions/raw.rb

@@ -1,330 +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/rudefinitions'
-require 'openwfe/expressions/flowexpression'
-
-
-module OpenWFE
-
-  #
-  # A class storing bits (trees) of process definitions just
-  # parsed. Upon application (apply()) these raw expressions get turned
-  # into real expressions.
-  #
-  class RawExpression < FlowExpression
-
-    #
-    # A [static] method for creating new RawExpression instances.
-    #
-    def self.new_raw (fei, parent_id, env_id, app_context, raw_tree)
-
-      re = self.new
-
-      re.fei = fei
-      re.parent_id = parent_id
-      re.environment_id = env_id
-      re.application_context = app_context
-      re.attributes = nil
-      re.children = []
-      re.apply_time = nil
-
-      re.raw_representation = raw_tree
-      re
-    end
-
-    #
-    # When a raw expression is applied, it gets turned into the
-    # real expression which then gets applied.
-    #
-    def apply (workitem)
-
-      exp_class, val = determine_real_expression_class
-
-      expression = instantiate_real_expression(workitem, exp_class, val)
-
-      expression.apply_time = Time.now
-      expression.store_itself
-
-      expression.apply(workitem)
-    end
-
-    #--
-    #def reply (workitem)
-    # no implementation necessary
-    #end
-    #++
-
-    def is_definition?
-
-      get_expression_map.is_definition?(expression_name())
-    end
-
-    def expression_class
-
-      get_expression_map.get_class(expression_name())
-    end
-
-    def definition_name
-
-      (raw_representation[1]['name'] || raw_children.first).to_s
-    end
-
-    def expression_name
-
-      raw_representation.first
-    end
-
-    #
-    # Forces the raw expression to load the attributes and set them
-    # in its @attributes instance variable.
-    # Currently only used by FilterDefinitionExpression.
-    #
-    def load_attributes
-
-      @attributes = raw_representation[1]
-    end
-
-    #
-    # This method has been made public in order to have quick look
-    # at the attributes of an expression before it's really
-    # 'instantiated'.
-    #
-    # (overriden by ExpExpression)
-    #
-    def extract_attributes
-
-      raw_representation[1]
-    end
-
-    #
-    # This method is called by the expression pool when it is about
-    # to launch a process, it will interpret the 'parameter' statements
-    # in the process definition and raise an exception if the requirements
-    # are not met.
-    #
-    def check_parameters (workitem)
-
-      #extract_parameters.each { |param| param.check(workitem) }
-      ExpressionTree.check_parameters(raw_representation, workitem)
-    end
-
-    protected
-
-    #
-    # Looks up a key as a variable or a participant.
-    #
-    def lookup (kind, key, underscore=false)
-
-      val = (kind == :variable) ?
-        lookup_variable(key) : get_participant_map.lookup_participant(key)
-
-      return lookup(:participant, val) || lookup(:variable, val) \
-        if kind == :variable and val.is_a?(String) # alias lookup
-
-      return val, key if val
-
-      return nil if underscore
-
-      lookup(kind, OpenWFE::to_underscore(key), true)
-    end
-
-    #
-    # Determines if this raw expression points to a classical
-    # expression, a participant or a subprocess, or nothing at all...
-    #
-    def determine_real_expression_class
-
-      exp_name = expression_name()
-
-      val, key =
-        lookup(:variable, exp_name) ||
-        expression_class() ||
-        lookup(:participant, exp_name)
-          # priority to variables
-
-      if val.is_a?(Array)
-
-        [ SubProcessRefExpression, val ]
-
-      elsif val.respond_to?(:consume)
-
-        [ ParticipantExpression, key ]
-
-      else
-
-        [ val, nil ]
-      end
-    end
-
-    def instantiate_real_expression (workitem, exp_class, val)
-
-      raise "unknown expression '#{expression_name}'" unless exp_class
-
-      exp = exp_class.new
-      exp.fei = @fei
-      exp.parent_id = @parent_id
-      exp.environment_id = @environment_id
-      exp.application_context = @application_context
-      exp.attributes = extract_attributes()
-
-      exp.raw_representation = @raw_representation
-      exp.raw_rep_updated = @raw_rep_updated
-
-      consider_tag(workitem, exp)
-      consider_on_error(workitem, exp)
-      consider_on_cancel(workitem, exp)
-
-      if val
-        class << exp
-          attr_accessor :hint
-        end
-        exp.hint = val
-      end # later sparing a variable/participant lookup
-
-      exp
-    end
-
-    #
-    # Expressions can get tagged. Tagged expressions can easily
-    # be cancelled (undone) or redone.
-    #
-    def consider_tag (workitem, new_expression)
-
-      tagname = new_expression.lookup_string_attribute(:tag, workitem)
-
-      return unless tagname
-
-      #ldebug { "consider_tag() tag is '#{tagname}'" }
-
-      set_variable(tagname, Tag.new(self, workitem))
-        #
-        # keep copy of raw expression and workitem as applied
-
-      new_expression.attributes['tag'] = tagname
-        #
-        # making sure that the value of tag doesn't change anymore
-    end
-
-    #
-    # A small class wrapping a tag (a raw expression and the workitem
-    # it received at apply time.
-    #
-    class Tag
-
-      attr_reader :raw_expression, :workitem
-
-      def flow_expression_id
-        @raw_expression.fei
-      end
-      alias :fei :flow_expression_id
-
-      def initialize (raw_expression, workitem)
-
-        @raw_expression = raw_expression.dup
-        @workitem = workitem.dup
-      end
-    end
-
-    #
-    # manages 'on-error' expression tags
-    #
-    def consider_on_error (workitem, new_expression)
-
-      on_error = new_expression.lookup_string_attribute(:on_error, workitem)
-
-      return unless on_error
-
-      on_error = on_error.to_s
-
-      handlers = lookup_variable('error_handlers') || []
-
-      handlers << [ fei.dup, on_error ]
-        # not using a hash to preserve insertion order
-        # "deeper last"
-
-      set_variable('error_handlers', handlers)
-
-      new_expression.attributes['on_error'] = on_error
-        #
-        # making sure that the value of tag doesn't change anymore
-    end
-
-    #
-    # manages 'on-cancel'
-    #
-    def consider_on_cancel (workitem, new_expression)
-
-      on_cancel = new_expression.lookup_string_attribute(:on_cancel, workitem)
-
-      return unless on_cancel
-
-      new_expression.attributes['on_cancel'] = [ on_cancel, workitem.dup ]
-        #
-        # storing the on_cancel value (a participant name or a subprocess
-        # name along with a copy of the workitem as applied among the
-        # attributes of the new expression)
-        #
-        # (note 'on_cancel' and not 'on-cancel' as we're specifically storing
-        # more info and not just the initial string value of the attribute)
-    end
-  end
-
-  private
-
-  #
-  # OpenWFE process definitions do use some
-  # Ruby keywords... The workaround is to put an underscore
-  # just before the name to 'escape' it.
-  #
-  # 'undo' isn't reserved by Ruby, but lets keep it in line
-  # with 'do' and 'redo' that are.
-  #
-  KEYWORDS = [
-    :if, :do, :redo, :undo, :print, :sleep, :loop, :break, :when
-    #:until, :while
-  ]
-
-  #
-  # Ensures the method name is not conflicting with Ruby keywords
-  # and turn dashes to underscores.
-  #
-  def OpenWFE.make_safe (method_name)
-
-    method_name = OpenWFE::to_underscore(method_name)
-
-    KEYWORDS.include?(method_name.to_sym) ? "_#{method_name}" : method_name
-  end
-
-  def OpenWFE.to_expression_name (method_name)
-
-    method_name = method_name.to_s
-    method_name = method_name[1..-1] if method_name[0, 1] == '_'
-    method_name = OpenWFE::to_dash(method_name)
-    method_name
-  end
-
-end
-