ruote 0.9.19 → 0.9.20

data/lib/openwfe/expressions/rprocdef.rb

@@ -1,41 +1,27 @@
-#
 #--
-# Copyright (c) 2007-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:
+# Copyright (c) 2007-2009, John Mettraux, jmettraux@gmail.com
 #
-# . Redistributions of source code must retain the above copyright notice, this
-#   list of conditions and the following disclaimer.
+# 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:
 #
-# . 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.
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
 #
-# . 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.
+# 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.
 #
-# 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.
 #++
-#
 
-#
-# "made in Japan"
-#
-# John Mettraux at openwfe.org
-#
 
 require 'openwfe/util/treechecker'
 require 'openwfe/utils'
@@ -44,6 +30,43 @@ require 'openwfe/expressions/raw'
 
 module OpenWFE
 
+  #
+  # A shorthand for writing process definitions like :
+  #
+  #   Test2 = OpenWFE.process_definition :name => 'ft_11b', :revision => '2' do
+  #     sequence do
+  #       participant 'alpha'
+  #       sleep '3d'
+  #       participant 'bravo'
+  #     end
+  #   end
+  #
+  # This will store in the constant Test2 the process definition in its
+  # 'raw' (tree) form :
+  #
+  #   ["process-definition", {"name"=>"ft_11b", "revision"=>"2"}, [
+  #     ["sequence", {}, [
+  #       ["participant", {}, ["alpha"]],
+  #       ["sleep", {}, ["3d"]],
+  #       ["participant", {}, ["bravo"]]]]]]
+  #
+  def self.process_definition (*args, &block)
+
+    pd = ProcessDefinition.new
+    pd.instance_eval(&block)
+
+    [
+      'process-definition',
+      lambda() { |a|
+        atts = a.last.is_a?(Hash) ? a.last : {}
+        atts['name'] = a.first unless a.first.is_a?(Hash)
+        atts.inject({}) { |h, (k, v)| h[OpenWFE.symbol_to_name(k)] = v; h }
+      }.call(args),
+      #[ ProcessDefinition.new.instance_eval(&block) ]
+      pd.context.top_expressions
+    ]
+  end
+
   #
   # Extend this class to create a programmatic process definition.
   #
@@ -63,7 +86,6 @@ module OpenWFE
   #   li = OpenWFE::LaunchItem.new(MyProcessDefinition)
   #   engine.launch(li)
   #
-  #
   class ProcessDefinition
 
     def self.metaclass; class << self; self; end; end
@@ -78,7 +100,9 @@ module OpenWFE
 
     def method_missing (m, *args, &block)
 
-      #puts "__i_method_missing >>>#{m}<<<<"
+      #p [ :method_missing, m ]
+
+      return nil if m == :make
 
       ProcessDefinition.make_expression(
         @context,
@@ -89,8 +113,7 @@ module OpenWFE
 
     def self.method_missing (m, *args, &block)
 
-      @ccontext = Context.new \
-        if (not @ccontext) or @ccontext.discarded?
+      @ccontext = Context.new if (not @ccontext) or @ccontext.discarded?
 
       ProcessDefinition.make_expression(
         @ccontext,
@@ -106,11 +129,8 @@ module OpenWFE
     def self.make_expression (context, exp_name, params, &block)
 
       string_child = nil
-      #attributes = OpenWFE::SymbolHash.new
       attributes = Hash.new
 
-      #puts " ... params.class is #{params.class}"
-
       if params.kind_of?(Hash)
 
         params.each do |k, v|
@@ -147,12 +167,11 @@ module OpenWFE
 
       return exp unless block
 
-      context.push_parent_expression exp
+      context.push_parent_expression(exp)
 
       result = block.call
 
-      exp.last << result \
-        if result and result.kind_of?(String)
+      exp.last << result if result and result.is_a?(String)
 
       context.pop_parent_expression
 
@@ -180,6 +199,7 @@ module OpenWFE
 
         instance.make
         instance.context
+
       else
 
         pdef = self.new
@@ -193,8 +213,8 @@ module OpenWFE
         extract_name_and_revision(self.metaclass.to_s[8..-2])
 
       top_expression = [
-        "process-definition",
-        { "name" => name, "revision" => revision },
+        'process-definition',
+        { 'name' => name, 'revision' => revision },
         context.top_expressions
       ]
 
@@ -227,30 +247,24 @@ module OpenWFE
         # checks for 'illicit' ruby code before the eval
         # (now done in the DefParser)
 
-      code, is_wrapped = wrap_code code
+      o = eval(code, binding())
 
-      o = eval code, binding()
-
-      o = extract_class(code) \
-        if (o == nil) or o.is_a?(Array)
-        #if (o == nil) or o.is_a?(SimpleExpRepresentation)
-          #
-          # grab the first process definition class found
-          # in the given code
-
-      result = o.do_make
+      klass = extract_class(code)
+        #
+        # grab the first process definition class found
+        # in the given code
 
-      return result.last.first if is_wrapped
+      return o unless klass
 
-      result
+      klass.do_make
     end
 
     protected
 
       ClassNameRex = Regexp.compile(
         " *class *([a-zA-Z0-9]*) *< .*ProcessDefinition")
-      ProcessDefinitionRex = Regexp.compile(
-        "^class *[a-zA-Z0-9]* *< .*ProcessDefinition")
+      #ProcessDefinitionRex = Regexp.compile(
+      #  "^class *[a-zA-Z0-9]* *< .*ProcessDefinition")
       ProcessNameAndDefRex = Regexp.compile(
         "([^0-9_]*)_*([0-9].*)$")
       ProcessNameRex = Regexp.compile(
@@ -258,18 +272,6 @@ module OpenWFE
       EndsInDefinitionRex = Regexp.compile(
         ".*Definition$")
 
-      def self.wrap_code (code)
-
-        return [ code, false ] if ProcessDefinitionRex.match(code)
-
-        s =  "class NoName0 < ProcessDefinition"
-        s << "\n"
-        s << code
-        s << "\nend"
-
-        [ s, true ]
-      end
-
       def self.pack_args (args)
 
         return args[0] if args.length == 1
@@ -287,7 +289,7 @@ module OpenWFE
 
       def self.extract_name_and_revision (s)
 
-        i = s.rindex("::")
+        i = s.rindex('::')
         s = s[i+2..-1] if i
 
         m = ProcessNameAndDefRex.match s
@@ -307,7 +309,7 @@ module OpenWFE
 
       def self.as_revision (s)
 
-        s.gsub("_", ".")
+        s.gsub('_', '.')
       end
 
       class Context
@@ -356,12 +358,13 @@ module OpenWFE
         #
         def top_expression
 
-          return nil if @top_expressions.size > 1
-
           exp = @top_expressions.first
 
-          return exp if exp.first == "process-definition"
-          nil
+          return nil unless exp
+
+          exp_name = OpenWFE::to_underscore(exp[0])
+
+          DefineExpression.expression_names.include?(exp_name) ? exp : nil
         end
       end
   end

data/lib/openwfe/expressions/time.rb

@@ -1,41 +1,27 @@
-#
 #--
-# 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:
+# Copyright (c) 2006-2009, John Mettraux, jmettraux@gmail.com
 #
-# . Redistributions of source code must retain the above copyright notice, this
-#   list of conditions and the following disclaimer.
+# 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:
 #
-# . 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.
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
 #
-# . 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.
+# 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.
 #
-# 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.
 #++
-#
 
-#
-# "made in Japan"
-#
-# John Mettraux at openwfe.org
-#
 
 require 'rufus/otime'
 require 'openwfe/expressions/timeout'
@@ -99,20 +85,20 @@ module OpenWFE
 
     protected
 
-      #
-      # looks up potential scheduler tags in the expression
-      # attributes
-      #
-      def determine_scheduler_tags
+    #
+    # looks up potential scheduler tags in the expression
+    # attributes
+    #
+    def determine_scheduler_tags
 
-        @scheduler_tags = lookup_array_attribute(
-          :scheduler_tags, @applied_workitem) || []
+      @scheduler_tags = lookup_array_attribute(
+        :scheduler_tags, @applied_workitem) || []
 
-        @scheduler_tags << self.class.name
+      @scheduler_tags << self.class.name
 
-        @scheduler_tags << fei.to_short_s
-        @scheduler_tags << fei.parent_wfid
-      end
+      @scheduler_tags << fei.to_short_s
+      @scheduler_tags << fei.parent_wfid
+    end
   end
 
   #
@@ -127,13 +113,13 @@ module OpenWFE
 
     attr_accessor :frequency
 
-    uses_template
+    #uses_template
 
     #
     # By default, classes extending this class do poll for their
     # condition every 10 seconds.
     #
-    DEFAULT_FREQUENCY = "10s"
+    DEFAULT_FREQUENCY = '10s'
 
     #
     # Don't go under 300 milliseconds.
@@ -167,7 +153,7 @@ module OpenWFE
       @frequency = MIN_FREQUENCY \
         if @frequency < MIN_FREQUENCY
 
-      determine_timeout
+      determine_timeout(workitem)
       determine_scheduler_tags
 
       condition_attribute = determine_condition_attribute(
@@ -184,15 +170,16 @@ module OpenWFE
       get_expression_pool.tprepare_child(
         self,
         consequence,
-        0,
-        true, # please register child
-        nil   # no vars
+        0, # sub_id
+        :register_child => true,
+        :dont_store_parent => true
       ) if consequence
 
       #
       # go east...
 
       store_itself
+        # as :dont_store_parent => true ...
 
       trigger
     end
@@ -202,9 +189,9 @@ module OpenWFE
       result = workitem.get_result
 
       if result
-        apply_consequence workitem
+        apply_consequence(workitem)
       else
-        reschedule get_scheduler
+        reschedule(get_scheduler)
       end
     end
 
@@ -214,7 +201,7 @@ module OpenWFE
     #
     def cancel
 
-      unschedule_timeout
+      unschedule_timeout(nil)
       super()
     end
 
@@ -226,8 +213,8 @@ module OpenWFE
         #
         # do timeout...
         #
-        set_timedout_flag @applied_workitem
-        reply_to_parent @applied_workitem
+        set_timedout_flag(@applied_workitem)
+        reply_to_parent(@applied_workitem)
         return
       end
 
@@ -255,73 +242,72 @@ module OpenWFE
     def reply_to_parent (workitem)
 
       unschedule
-      unschedule_timeout
+      unschedule_timeout(workitem)
 
-      super workitem
+      super(workitem)
     end
 
     protected
 
-      #
-      # The code for the condition evalution is here.
-      #
-      # This method is overriden by the WhenExpression.
-      #
-      def evaluate_condition
+    #
+    # The code for the condition evalution is here.
+    #
+    # This method is overriden by the WhenExpression.
+    #
+    def evaluate_condition
 
-        condition_attribute = determine_condition_attribute(
-          self.class.condition_attributes)
+      condition_attribute = determine_condition_attribute(
+        self.class.condition_attributes)
 
-        if condition_attribute
+      if condition_attribute
 
-          c = eval_condition condition_attribute, @applied_workitem
+        c = eval_condition(condition_attribute, @applied_workitem)
 
-          do_reply c
-          return
-        end
+        do_reply(c)
+        return
+      end
 
-        # else, condition is nested as a child
+      # else, condition is nested as a child
 
-        #if @children.size < 1
-        if raw_children.size < 1
-          #
-          # no condition attribute and no child attribute,
-          # simply reply to parent
-          #
-          reply_to_parent @applied_workitem
-          return
-        end
+      if has_no_expression_child
+        #
+        # no condition attribute and no child attribute,
+        # simply reply to parent
+        #
+        reply_to_parent(@applied_workitem)
+        return
+      end
 
-        # trigger the first child (the consequence child)
+      # trigger the first child (the consequence child)
 
-        get_expression_pool.tlaunch_child(
-          self,
-          raw_children.first,
-          (Time.new.to_f * 1000).to_i,
-          @applied_workitem.dup,
-          false) # not registering as a child
-      end
+      get_expression_pool.tlaunch_child(
+        self,
+        raw_children.first,
+        (Time.new.to_f * 1000).to_i,
+        @applied_workitem.dup,
+        :register_child => false)
+    end
 
-      #
-      # Used when replying to self after an attribute condition
-      # got evaluated
-      #
-      def do_reply (result)
+    #
+    # Used when replying to self after an attribute condition
+    # got evaluated
+    #
+    def do_reply (result)
 
-        @applied_workitem.set_result result
-        reply @applied_workitem
-      end
+      @applied_workitem.set_result(result)
+      reply(@applied_workitem)
+    end
 
-      #
-      # This method is overriden by WhenExpression. WaitExpression
-      # doesn't override it.
-      # This default implementation simply directly replies to
-      # the parent expression.
-      #
-      def apply_consequence (workitem)
+    #
+    # This method is overriden by WhenExpression. WaitExpression
+    # doesn't override it.
+    # This default implementation simply directly replies to
+    # the parent expression.
+    #
+    def apply_consequence (workitem)
 
-        reply_to_parent workitem
-      end
+      reply_to_parent(workitem)
+    end
   end
 
 end