ruote 0.9.20 → 2.1.1

data/lib/openwfe/expressions/fe_error.rb

@@ -1,103 +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.
-#++
-
-
-module OpenWFE
-
-  #
-  # The 'error' expression provokes an error to occur in a process instance.
-  # The error might then be treated by an error handler ('on_error' attribute)
-  # or simply registered in the error journal and manually replayed.
-  #
-  #   sequence do
-  #     participant :ref => 'unit1'
-  #     error 'missing info', :if => "${f:customer} == ''"
-  #     participant :ref => 'unit2'
-  #   end
-  #
-  # In this hypothetical example, the error is triggered if the field customer
-  # is empty.
-  #
-  # == replaying
-  #
-  # The error expression can be replayed without further ado (though it is
-  # expected that the problem it raised attention to has be fixed). At replay
-  # the expression will simply let the process instance resume.
-  #
-  # == on_error
-  #
-  # This expression can be used to let a process interrupt itself (replay case)
-  # or to force the process into a 'fail path' (out of the 'happy path')
-  #
-  #   class MyDef0 < OpenWFE::ProcessDefinition
-  #
-  #     sequence :on_error => 'fail_path' do
-  #
-  #       participant :ref => 'unit1'
-  #       error 'missing info', :if => "${f:customer} == ''"
-  #       participant :ref => 'unit2'
-  #     end
-  #
-  #     process_definition :name => 'fail_path' do
-  #       # ... problem resolution subprocess ...
-  #     end
-  #   end
-  #
-  #
-  class ErrorExpression < FlowExpression
-    include ValueMixin
-    include ConditionMixin
-
-    #names :error, :exception
-    names :error
-
-    #
-    # is set to true when the expression got applied once (and raised
-    # its error).
-    #
-    attr_accessor :triggered
-
-
-    def reply (workitem)
-
-      return reply_to_parent(workitem) if @triggered
-        #
-        # when error is 'replayed' simply reply to parent to let flow resume
-
-      conditional = eval_condition(:if, workitem, :unless)
-
-      return reply_to_parent(workitem) if conditional == false
-
-      text = workitem.get_result.to_s
-
-      @triggered = true
-
-      store_itself # making sure @triggered is saved
-
-      raise(ForcedError.new(text))
-    end
-  end
-
-end
-

data/lib/openwfe/expressions/fe_filter.rb

@@ -1,112 +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/filter'
-
-
-module OpenWFE
-
-  #
-  # This expression applies a filter to the workitem used by the process
-  # segment nested within it.
-  #
-  #   class TestFilter48a0 < ProcessDefinition
-  #     sequence do
-  #
-  #       set :field => "readable", :value => "bible"
-  #       set :field => "writable", :value => "sand"
-  #       set :field => "randw", :value => "notebook"
-  #       set :field => "hidden", :value => "playboy"
-  #
-  #       alice
-  #
-  #       filter :name => "filter0" do
-  #         sequence do
-  #           bob
-  #           charly
-  #         end
-  #       end
-  #
-  #       doug
-  #     end
-  #
-  #     filter_definition :name => "filter0" do
-  #       field :regex => "readable", :permissions => "r"
-  #       field :regex => "writable", :permissions => "w"
-  #       field :regex => "randw", :permissions => "rw"
-  #       field :regex => "hidden", :permissions => ""
-  #     end
-  #   end
-  #
-  # In this example, the filter 'filter0' is applied upon entering bob and
-  # charly's sequence.
-  #
-  # Please note that the filter will not be enforced between bob and charly,
-  # it is enforced just before entering the sequence and just after leaving
-  # it.
-  #
-  # Note also that the ParticipantExpression accepts a 'filter' attribute,
-  # thus :
-  #
-  #   <filter name="filter0">
-  #     <participant ref="toto" />
-  #   </filter>
-  #
-  # can be simplified to :
-  #
-  #   <participant ref="toto" filter="filter0" />
-  #
-  class FilterExpression < FlowExpression
-    include FilterMixin
-
-    names :filter
-
-    attr_accessor :applied_workitem, :filter
-
-
-    def apply (workitem)
-
-      return reply_to_parent(workitem) if has_no_expression_child
-
-      @applied_workitem = workitem.dup
-
-      filter_in(workitem, :name)
-
-      #store_itself
-        # now done in apply_child()
-
-      apply_child(first_expression_child, workitem)
-    end
-
-    def reply (workitem)
-
-      filter_out(workitem)
-
-      reply_to_parent(workitem)
-    end
-  end
-
-end
-

data/lib/openwfe/expressions/fe_filter_definition.rb

@@ -1,151 +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/filterdef'
-
-
-module OpenWFE
-
-  #
-  # This expression binds a filter definition into a variable.
-  #
-  #   class TestFilter48a0 < ProcessDefinition
-  #     sequence do
-  #
-  #       set :field => "readable", :value => "bible"
-  #       set :field => "writable", :value => "sand"
-  #       set :field => "randw", :value => "notebook"
-  #       set :field => "hidden", :value => "playboy"
-  #
-  #       alice
-  #
-  #       filter :name => "filter0" do
-  #         sequence do
-  #           bob
-  #           charly
-  #         end
-  #       end
-  #
-  #       doug
-  #     end
-  #
-  #     filter_definition :name => "filter0" do
-  #       field :regex => "readable", :permissions => "r"
-  #       field :regex => "writable", :permissions => "w"
-  #       field :regex => "randw", :permissions => "rw"
-  #       field :regex => "hidden", :permissions => ""
-  #     end
-  #   end
-  #
-  # In that example, the filter definition is done for filter 'filter0'.
-  #
-  # A filter definition accepts 4 attributes :
-  #
-  # * 'name' - simply naming the filter, the filter is then bound as a variable. This is the only mandatory attribute.
-  #
-  # * 'closed' - by default, set to 'false'. A closed filter will not allow modifications to unspecified fields.
-  #
-  # * 'add' - by default, set to 'true'. When true, this filter accepts adding new fields to the filtered workitem.
-  #
-  # * 'remove' - by default, set to 'true'. When true, this filter accepts removing fields to the filtered workitem.
-  #
-  #
-  # Inside of the process definition, fields are identified via regular
-  # expressions ('regex'), a 'permissions' string is then expected with four
-  # possible values "rw", "w", "r" and "".
-  #
-  class FilterDefinitionExpression < FlowExpression
-
-    is_definition
-
-    names :filter_definition
-
-
-    #
-    # Will build the filter and bind it as a variable.
-    #
-    def apply (workitem)
-
-      filter = build_filter(workitem)
-      filter_name = lookup_attribute(:name, workitem)
-
-      set_variable(filter_name, filter) if filter_name and filter
-
-      reply_to_parent(workitem)
-    end
-
-    protected
-
-      #
-      # Builds the filter (as described in the process definition)
-      # and returns it.
-      #
-      def build_filter (workitem)
-
-        filter = FilterDefinition.new
-
-        # filter attributes
-
-        type = lookup_downcase_attribute(:type, workitem)
-        closed = lookup_downcase_attribute(:closed, workitem)
-
-        filter.closed = (type == 'closed' or closed == 'true')
-
-        add = lookup_downcase_attribute(:add, workitem)
-        remove = lookup_downcase_attribute(:remove, workitem)
-
-        filter.add_allowed = (add == 'true')
-        filter.remove_allowed = (remove == 'true')
-
-        # field by field
-
-        raw_expression_children.each do |rawchild|
-
-          add_field(filter, rawchild, workitem)
-        end
-
-        filter
-      end
-
-      #
-      # builds and add a field (a line) of the filter.
-      #
-      def add_field (filter, rawchild, workitem)
-
-        rawexp = RawExpression.new_raw(
-          nil, nil, @environment_id, @application_context, rawchild)
-        rawexp.load_attributes
-
-        regex = rawexp.lookup_attribute(:regex, workitem)
-        regex = rawexp.lookup_attribute(:name, workitem) unless regex
-
-        permissions = rawexp.lookup_downcase_attribute(:permissions, workitem)
-
-        filter.add_field(regex, permissions)
-      end
-  end
-
-end
-

data/lib/openwfe/expressions/fe_fqv.rb

@@ -1,231 +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 'json' # gem 'json_pure'
-
-require 'openwfe/util/xml'
-require 'openwfe/util/json'
-require 'openwfe/expressions/flowexpression'
-
-
-module OpenWFE
-
-  #
-  # This expression implementation gathers the 'f', 'q' and 'v' expressions,
-  # along with their fullname 'field', 'variable' and 'quote'.
-  #
-  # These expressions place the value of the corresponding, field, variable
-  # or quoted (direct value) in the 'result' field of the current workitem.
-  #
-  #   sequence do
-  #
-  #     set :field => "f0", :value => "fox"
-  #     set :variable => "v0", :value => "vixen"
-  #
-  #     set :field => "f1" do
-  #       v "v0"
-  #     end
-  #     set :variable => "v1" do
-  #       f "f0"
-  #     end
-  #     set :variable => "v2" do
-  #       f "f0"
-  #     end
-  #   end
-  #
-  # Well, this is perhaps not the best example.
-  #
-  class FqvExpression < FlowExpression
-
-    names :f, :q, :v, :field, :quote, :variable
-
-    #
-    # apply / reply
-
-    def apply (workitem)
-
-      name = @fei.expression_name[0, 1]
-      text = fetch_text_content(workitem)
-
-      method = MAP[name]
-
-      result = self.send method, text, workitem
-
-      workitem.set_result(result) if result != nil
-
-      reply_to_parent workitem
-    end
-
-    protected
-
-      MAP = {
-        'f' => :field,
-        'q' => :quote,
-        'v' => :variable
-      }
-
-      def field (text, workitem)
-        workitem.attributes[text]
-      end
-
-      def quote (text, workitem)
-        text
-      end
-
-      def variable (text, workitem)
-        self.lookup_variable(text)
-      end
-  end
-
-  #
-  # The 'a' or 'attribute' expression. Directly describing some
-  # variable or list content in XML, YAML or JSON.
-  #
-  #   _set :field => "list" do
-  #     _a """
-  #       <array>
-  #         <string>a</string>
-  #         <string>b</string>
-  #         <number>3</number>
-  #         <string>d</string>
-  #         <null/>
-  #         <false/>
-  #         <string>it's over</string>
-  #       </array>
-  #     """
-  #   end
-  #
-  # or
-  #
-  #   _set :field => "list" do
-  #     _attribute """
-  #   ---
-  #   - a
-  #   - b
-  #   - c
-  #     """
-  #    end
-  #
-  # Note that it's actually easier to write :
-  #
-  #   _set :field => "list" do
-  #     reval "[ 'a', 'b', 'c' ]"
-  #   end
-  #
-  # but it's less secure. The best way might be :
-  #
-  #   set :field => "list", :value => [ 'a', 'b', 'c' ]
-  #
-  # Yet another way, as this <a> expression accepts JSON :
-  #
-  #   set :field => 'list' do
-  #     a '[1,2,false,"my name"]'
-  #   end
-  #
-  # or
-  #
-  #   <process-definition name="test" revision="44b9">
-  #     <set-fields>
-  #       <a>{"customer":{"name":"Zigue","age":34},"approved":false}</a>
-  #     </set-fields>
-  #     <sequence>
-  #       <print>${f:customer.name} (${f:customer.age}) ${f:approved}</print>
-  #     </sequence>
-  #   </process-definition>
-  #
-  #
-  class AttributeExpression < FlowExpression
-
-    names :a, :attribute
-
-    XML_REGEX = /<.*>/
-
-
-    def apply (workitem)
-
-      child = raw_children.first
-
-      text = if child.is_a?(String)
-
-        fetch_text_content(workitem)
-
-      elsif child.is_a?(Array)
-
-        ExpressionTree.to_s(child)
-
-      else
-
-        child.to_s
-      end
-
-      text = text.strip
-
-      result = if text[0, 3] == '---'
-
-        from_yaml(text)
-
-      elsif text.match(XML_REGEX)
-
-        from_xml(text)
-      end
-
-      result = OpenWFE::Json::from_json(text) if result == nil
-        # warning : if 'json' or 'active_support' are not present
-        # from_json() will always return nil
-
-      workitem.set_result(result) if result != nil
-
-      reply_to_parent(workitem)
-    end
-
-    protected
-
-      def from_yaml (text)
-
-        begin
-
-          YAML.load(text)
-
-        rescue Exception => e
-          linfo { "from_yaml() failed : #{e}" }
-          nil
-        end
-      end
-
-      def from_xml (text)
-
-        begin
-
-          OpenWFE::Xml.from_xml(text)
-
-        rescue Exception => e
-          linfo { "from_xml() failed : #{e}" }
-          nil
-        end
-      end
-  end
-
-end
-