ruote 0.9.19 → 0.9.20

data/lib/openwfe/exceptions.rb

@@ -1,51 +0,0 @@
-#
-#--
-# 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:
-#
-# . Redistributions of source code must retain the above copyright notice, this
-#   list of conditions and the following disclaimer.
-#
-# . 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.
-#
-# . 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.
-#
-# 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
-#
-# john.mettraux@openwfe.org
-#
-
-
-module OpenWFE
-
-  #
-  # The exception thrown at launch time, when there are parameter missing
-  # or whose value isn't matching what is required.
-  #
-  class ParameterException < Exception
-  end
-
-end
-

data/lib/openwfe/expool/parser.rb

@@ -1,278 +0,0 @@
-#
-#--
-# 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:
-#
-# . Redistributions of source code must retain the above copyright notice, this
-#   list of conditions and the following disclaimer.
-#
-# . 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.
-#
-# . 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.
-#
-# 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"
-#
-# John Mettraux at openwfe.org
-#
-
-require 'openwfe/rexml'
-require 'openwfe/service'
-require 'openwfe/contextual'
-require 'openwfe/util/treechecker'
-require 'openwfe/expressions/rprocdef'
-
-
-module OpenWFE
-
-  #
-  # A process definition parser.
-  #
-  # Currently supports XML, Ruby process pdefinitions, YAML and JSON.
-  #
-  class DefParser < Service
-    include OwfeServiceLocator
-
-    #
-    # a static version of the parse method,
-    # by default checks the tree if it's Ruby code that is passed.
-    #
-    def self.parse (pdef, use_ruby_treechecker=true)
-
-      #
-      # preparing a small ad-hoc env (app context) for this parsing
-
-      ac = { :use_ruby_treechecker => use_ruby_treechecker }
-
-      ac[:s_tree_checker] = TreeChecker.new(:s_tree_checker, ac)
-      ac[:s_def_parser] = DefParser.new(:s_def_parser, ac)
-
-      ac[:s_def_parser].parse(pdef)
-    end
-
-    #
-    # the classical initialize() of Ruote services
-    #
-    def initialize (service_name, application_context)
-      super
-    end
-
-    #
-    # in : a process pdefinition
-    # out : a tree [ name, attributes, children ]
-    #
-    def parse (pdef)
-
-      return pdef \
-        if pdef.is_a?(Array)
-
-      return parse_string(pdef) \
-        if pdef.is_a?(String)
-
-      return pdef.do_make \
-        if pdef.is_a?(ProcessDefinition) or pdef.is_a?(Class)
-
-      return pdef.to_a \
-        if pdef.is_a?(SimpleExpRepresentation)
-          # for legacy stuff
-
-      raise "cannot handle pdefinition of class #{pdef.class.name}"
-    end
-
-    def parse_string (pdef)
-
-      pdef = pdef.strip
-
-      return parse_xml(pdef) \
-        if pdef[0, 1] == '<'
-
-      return YAML.load(s) \
-        if pdef.match(/^--- ./)
-
-      #
-      # else it's some ruby code to eval
-
-      get_tree_checker.check pdef
-
-      # green for eval...
-
-      ProcessDefinition.eval_ruby_process_definition pdef
-    end
-
-    #
-    # The process definition is expressed as XML, turn that into
-    # an expression tree.
-    #
-    def parse_xml (xml)
-
-      xml = REXML::Document.new(xml) \
-        if xml.is_a?(String)
-
-      xml = xml.root \
-        if xml.is_a?(REXML::Document)
-
-      if xml.is_a?(REXML::Text)
-
-        s = xml.to_s.strip
-
-        return s if s.length > 0
-
-        return nil
-      end
-
-      return nil if xml.is_a?(REXML::Comment)
-
-      # then it's a REXML::Element
-
-      rep = [
-        xml.name,
-        xml.attributes.inject({}) { |r, (k, v)| r[k] = v; r },
-        [] ]
-
-      xml.children.each do |c|
-
-        r = parse_xml c
-
-        rep.last << r if r
-      end
-
-      rep
-    end
-  end
-
-  #
-  # A set of methods for manipulating / querying a process expression tree
-  #
-  module ExpressionTree
-
-    #
-    # Extracts the description out of a process definition tree.
-    #
-    # TODO #14964 : add language support here
-    #
-    def self.get_description (tree)
-
-      #return tree.last.first.to_s if tree.first == 'description'
-      #tree.last.each do |child|
-      #  d = get_description(child)
-      #  return d if d
-      #end
-      #nil
-
-      tree.last.each do |child|
-        next unless child.is_a?(Array)
-        return child.last.first if child.first == 'description'
-      end
-
-      nil
-    end
-
-    #
-    # Returns a string containing the ruby code that generated this
-    # raw representation tree.
-    #
-    def self.to_code_s (tree, indentation = 0)
-
-      s = ""
-      tab = "  "
-      ind = tab * indentation
-
-      s << ind
-      s << OpenWFE::make_safe(tree.first)
-
-      sa = ""
-      tree[1].each do |k, v|
-        #v = "'#{v}'" if v.is_a?(String)
-        #v = ":#{v}" if v.is_a?(Symbol)
-        v = v.inspect
-        sa << ", :#{OpenWFE::to_underscore(k)} => #{v}"
-      end
-      s << sa[1..-1] if sa.length > 0
-
-      if tree.last.length > 0
-        if tree.last.size == 1 and tree.last.first.class == String
-          # maybe could work for things that are not string either...
-          s << " '#{tree.last.first}'"
-        else
-          s << " do\n"
-          tree.last.each do |child|
-            #if child.respond_to?(:to_code_s)
-            if child.is_a?(Array) and child.size == 3 # and ...
-              s << to_code_s(child, indentation + 1)
-            else
-              s << ind
-              s << tab
-              s << "'#{child.to_s}'" # inspect instead of to_s ?
-            end
-            s << "\n"
-          end
-          s << ind
-          s << "end"
-        end
-      end
-
-      s
-    end
-
-    #
-    # Turns the expression tree into an XML process definition
-    #
-    def self.to_xml (tree)
-
-      elt = REXML::Element.new tree.first.to_s
-
-      tree[1].each do |k, v|
-
-        elt.attributes[k] = v
-      end
-
-      tree.last.each do |child|
-
-        #if child.kind_of?(SimpleExpRepresentation)
-        if child.is_a?(Array) and child.size == 3
-
-          elt << to_xml(child)
-        else
-
-          elt << REXML::Text.new(child.to_s)
-        end
-      end
-
-      elt
-    end
-
-    #
-    # Returns an XML string
-    #
-    def self.to_s (tree, indent=-1)
-
-      d = REXML::Document.new
-      d << to_xml(tree)
-      s = ""
-      d.write s, indent
-      s
-    end
-  end
-end
-

data/lib/openwfe/expool/paused_error.rb

@@ -1,77 +0,0 @@
-#
-#--
-# 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:
-#
-# . Redistributions of source code must retain the above copyright notice, this
-#   list of conditions and the following disclaimer.
-#
-# . 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.
-#
-# . 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.
-#
-# 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"
-#
-# John Mettraux at openwfe.org
-#
-
-module OpenWFE
-
-  #
-  # This error is raised when an expression belonging to a paused
-  # process is applied or replied to.
-  #
-  class PausedError < RuntimeError
-
-    attr_reader :wfid
-
-    def initialize (wfid)
-
-      super "process '#{wfid}' is paused"
-      @wfid = wfid
-    end
-
-    #
-    # Returns a hash for this PausedError instance.
-    # (simply returns the hash of the paused process' wfid).
-    #
-    def hash
-
-      @wfid.hash
-    end
-
-    #
-    # Returns true if the other is a PausedError issued for the
-    # same process instance (wfid).
-    #
-    def == (other)
-
-      return false unless other.is_a?(PausedError)
-
-      (@wfid == other.wfid)
-    end
-  end
-end
-

data/lib/openwfe/expool/yamlexpstorage.rb

@@ -1,224 +0,0 @@
-#
-#--
-# Copyright (c) 2006-2008, Nicolas Modryzk and 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:
-#
-# . Redistributions of source code must retain the above copyright notice, this
-#   list of conditions and the following disclaimer.
-#
-# . 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.
-#
-# . 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.
-#
-# 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"
-#
-# Nicolas Modrzyk at openwfe.org
-# John Mettraux at openwfe.org
-#
-
-require 'openwfe/utils'
-require 'openwfe/storage/yamlcustom'
-require 'openwfe/storage/yamlfilestorage'
-require 'openwfe/expool/threadedexpstorage'
-
-require 'openwfe/expressions/flowexpression'
-#require 'openwfe/expressions/raw_xml'
-  #--
-  # making sure classes in those files are loaded
-  # before their yaml persistence is tuned
-  # (else the reopening of the class is interpreted as
-  # a definition of the class...)
-  #++
-
-
-module OpenWFE
-
-  #
-  # YAML expression storage. Expressions (atomic pieces of process instances)
-  # are stored in a hierarchy of YAML files.
-  #
-  class YamlFileExpressionStorage < YamlFileStorage
-    include OwfeServiceLocator
-    include ExpressionStorageBase
-
-    def initialize (service_name, application_context)
-
-      super service_name, application_context, '/expool'
-
-      observe_expool
-    end
-
-    #
-    # Find expressions matching various criteria.
-    # (See Engine#list_process_status for an explanation)
-    #
-    def find_expressions (options)
-
-      wfid_prefix = options[:wfid_prefix]
-      wfid_regex = nil
-      wfid_regex = Regexp.new("^"+wfid_prefix) if wfid_prefix
-
-      options.delete :wfid_prefix
-        # no need to check this in further does_match? calls
-
-      result = []
-
-      each_object_path do |path|
-
-        unless path[-23..-1] == 'engine_environment.yaml'
-
-          a = self.class.split_file_path path
-
-          next unless a
-            # not an expression file
-
-          wfid = a[0]
-
-          next if wfid_regex and (not wfid_regex.match(wfid))
-        end
-
-        fexp = load_object path
-
-        next unless does_match?(options, fexp)
-
-        result << fexp
-      end
-
-      result
-    end
-
-    def fetch_root (wfid)
-
-      fei = FlowExpressionId.new
-      fei.wfid = wfid
-      fei.expid = "0"
-      fei.expression_name = "process-definition"
-
-      root = self[fei]
-
-      return root if root
-
-      #
-      # direct hit missed, scanning...
-
-      each_object_path(compute_dir_path(wfid)) do |p|
-
-        a = self.class.split_file_path p
-        next unless a
-
-        next unless a[0] == wfid
-
-        fexp = load_object p
-
-        return fexp if fexp.is_a?(DefineExpression)
-      end
-
-      nil
-    end
-
-    #
-    # Returns a human-readable list of the current YAML file paths.
-    # (one expression per path).
-    #
-    def to_s
-
-      s = "\n\n==== #{self.class} ===="
-      s << "\n"
-      each_object_path do |path|
-        s << path
-        s << "\n"
-      end
-      s << "==== . ====\n"
-      s
-    end
-
-    #
-    # Returns nil (if the path doesn't match an stored expression path)
-    # or an array [ workflow_instance_id, expression_id, expression_name ].
-    #
-    # This is a class method (not an instance one).
-    #
-    def self.split_file_path (path)
-
-      md = path.match %r{.*/(.*)__([\d.]*)_(.*).yaml}
-      return nil unless md
-      [ md[1], md[2], md[3] ]
-    end
-
-    protected
-
-      def compute_dir_path (wfid)
-
-        wfid = FlowExpressionId.to_parent_wfid wfid
-
-        a_wfid = get_wfid_generator.split_wfid wfid
-
-        @basepath + a_wfid[-2] + "/" + a_wfid[-1] + "/"
-      end
-
-      def compute_file_path (fei)
-
-        return @basepath + "/engine_environment.yaml" \
-          if fei.workflow_instance_id == "0"
-
-        wfid = fei.parent_workflow_instance_id
-
-        compute_dir_path(wfid) +
-        fei.workflow_instance_id + "__" +
-        fei.expression_id + "_" +
-        fei.expression_name + ".yaml"
-      end
-
-      #--
-      # Returns true if the path points to a file containing an
-      # expression whose name is in the list of expression names
-      # corresponding to the given kind (class) of expressions.
-      #
-      #def matches (path, kind)
-      #  exp_names = get_expression_map.get_expression_names(kind)
-      #  exp_names.each do |exp_name|
-      #    return true \
-      #      if OpenWFE::ends_with(path, "_#{exp_name}.yaml")
-      #  end
-      #  false
-      #end
-      #++
-  end
-
-  #
-  # With this extension of YmalFileExpressionStorage, persistence occurs
-  # in a separate thread, for a snappier response.
-  #
-  class ThreadedYamlFileExpressionStorage < YamlFileExpressionStorage
-    include ThreadedStorageMixin
-
-    def initialize (service_name, application_context)
-
-      super
-
-      start_queue
-    end
-  end
-end