ruote-maestrodev 2.2.1

data/lib/ruote/log/test_logger.rb

@@ -0,0 +1,208 @@
+#--
+# Copyright (c) 2005-2011, 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 'ruote/log/pretty'
+
+
+module Ruote
+
+  class TestLogger
+
+    include PrettyLogging
+
+    attr_reader :seen
+    attr_reader :log
+
+    attr_accessor :noisy
+
+    def initialize(context)
+
+      @context = context
+
+      if @context.worker
+        #
+        # this is a worker context, DO log
+        #
+        @context.worker.subscribe(:all, self)
+      #else
+        #
+        # this is not a worker context, DO NOT log, but be ready to
+        # be queried
+        #
+      end
+
+      @seen = []
+      @log = []
+      @waiting = []
+
+      @count = -1
+      @color = 33
+      @noisy = false
+    end
+
+    def notify(msg)
+
+      puts(pretty_print(msg)) if @noisy
+
+      if msg['action'] != 'noop'
+        @seen << msg
+        @log << msg
+      end
+
+      check_waiting
+    end
+
+    # Blocks until one or more interests are satisfied.
+    #
+    # interests must be an array of interests. Please refer to
+    # Engine#wait_for documentation for allowed values of each interest.
+    #
+    # If multiple interests are given, wait_for blocks until
+    # all of the interests are satisfied.
+    #
+    # wait_for may only be used by one thread at a time. If one
+    # thread calls wait_for and later another thread calls wait_for
+    # while the first thread is waiting, the first thread's
+    # interests are lost and the first thread will never wake up.
+    #
+    def wait_for(interests)
+
+      @waiting << [ Thread.current, interests ]
+
+      #check_waiting
+      @context.storage.put_msg('noop', {})
+        #
+        # forces the #check_waiting via #notify
+        # (ie let it happen in the worker)
+
+      Thread.stop if @waiting.find { |w| w.first == Thread.current }
+
+      # and when this thread gets woken up, go on and return __result__
+
+      Thread.current['__result__']
+    end
+
+    # Debug only : dumps all the seen events to STDOUTS
+    #
+    def dump
+
+      @seen.collect { |msg| pretty_print(msg) }.join("\n")
+    end
+
+    def color=(c)
+
+      @color = c
+    end
+
+    def self.pp(msg)
+
+      @logger ||= TestLogger.new(nil)
+      puts @logger.send(:pretty_print, msg)
+    end
+
+    protected
+
+    def check_waiting
+
+      while @waiting.any? and msg = @seen.shift
+        check_msg(msg)
+      end
+    end
+
+    def check_msg(msg)
+
+      wakeup = []
+
+      @waiting.each do |thread, interests|
+
+        wakeup << thread if matches(interests, msg)
+      end
+
+      @waiting.delete_if { |t, i| i.size < 1 }
+
+      wakeup.each do |thread|
+
+        thread['__result__'] = msg
+        thread.wakeup
+      end
+    end
+
+    FINAL_ACTIONS = %w[ terminated ceased error_intercepted ]
+
+    # Checks whether message msg matches any of interests being waited for.
+    #
+    # Some interests look for actions on particular workflows (e.g.,
+    # waiting for some workflow to finish). Other interests are not
+    # attached to any particular workflow (e.g., :inactive waits until
+    # the engine finishes processing all active and pending workflows)
+    # but are still satisfied when actions happen on workflows (e.g.,
+    # the last workflow being run finishes).
+    #
+    # Returns true if all interests being waited for have been satisfied,
+    # false otherwise.
+    #
+    def matches(interests, msg)
+
+      action = msg['action']
+
+      interests.each do |interest|
+
+        satisfied = case interest
+
+          when :inactive
+
+            (FINAL_ACTIONS.include?(action) && @context.worker.inactive?)
+
+          when :empty
+
+            (action == 'terminated' && @context.storage.empty?('expressions'))
+
+          when Symbol
+
+            (action == 'dispatch' && msg['participant_name'] == interest.to_s)
+
+          when Fixnum
+
+            interests.delete(interest)
+
+            if (interest > 1)
+              interests << (interest - 1)
+              false
+            else
+              true
+            end
+
+          else # wfid
+
+            (FINAL_ACTIONS.include?(action) && msg['wfid'] == interest)
+        end
+
+        interests.delete(interest) if satisfied
+      end
+
+      interests.size < 1
+    end
+  end
+end
+

data/lib/ruote/log/wait_logger.rb

@@ -0,0 +1,64 @@
+#--
+# Copyright (c) 2005-2011, 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 'ruote/log/test_logger'
+
+
+module Ruote
+
+  #
+  # A helper logger for quickstart examples.
+  #
+  # Keeps a maximum of 147 messages.
+  #
+  class WaitLogger < TestLogger
+
+    attr_accessor :noisy
+
+    def initialize(context)
+
+      @context = context
+      @color = 33
+
+      @context.worker.subscribe(:all, self) if @context.worker
+
+      @noisy = false
+      @count = -1
+
+      @seen = []
+      @waiting = []
+    end
+
+    def notify(msg)
+
+      puts(pretty_print(msg)) if @noisy
+
+      @seen << msg if msg['action'] != 'noop'
+      @seen.shift if @seen.size > 147
+
+      check_waiting
+    end
+  end
+end
+

data/lib/ruote/part/block_participant.rb

@@ -0,0 +1,137 @@
+#--
+# Copyright (c) 2005-2011, 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 Ruote
+
+  #
+  # One of the simplest participants. Simply passes a workitem to a block
+  # of ruby code.
+  #
+  #   engine.register_participant :alpha do |workitem|
+  #     workitem.fields['time'] = Time.now
+  #   end
+  #
+  # This participant implicitely replies to the engine when the block execution
+  # is over.
+  #
+  # You can pass the flow_expression (participant expression) as well.
+  #
+  #   engine.register_participant :alpha do |workitem, flow_exp|
+  #     workitem.fields['amount'] = flow_exp.lookup_variable('amount')
+  #   end
+  #
+  #
+  # == do_not_thread
+  #
+  # By default, this participant (like most other participants) is executed
+  # in its own thread.
+  #
+  class BlockParticipant
+
+    include LocalParticipant
+
+    attr_accessor :context
+
+    def initialize(opts)
+
+      @opts = opts
+    end
+
+    def consume(workitem)
+
+      block = get_block('on_workitem', 'block')
+
+      r = if block.arity == 1
+
+        block.call(workitem)
+
+      else
+
+        block.call(
+          workitem, Ruote::Exp::FlowExpression.fetch(@context, workitem.h.fei))
+      end
+
+      if r != nil && r != workitem
+        workitem.result = (Rufus::Json.dup(r) rescue nil)
+      end
+
+      reply_to_engine(workitem)
+    end
+
+    def cancel(fei, flavour)
+
+      if block = get_block('on_cancel')
+        block.call(fei, flavour)
+      end
+    end
+
+    def on_reply(workitem)
+
+      if block = get_block('on_reply')
+        block.call(workitem)
+      end
+    end
+
+    def accept?(workitem)
+
+      if block = get_block('accept?')
+        block.call(workitem)
+      else
+        true
+      end
+    end
+
+    def do_not_thread(workitem)
+
+      dnt = @opts['do_not_thread']
+
+      return dnt unless dnt.is_a?(String)
+
+      block = get_block('do_not_thread')
+
+      block.call(workitem)
+    end
+
+    protected
+
+    def get_block(*keys)
+
+      key = keys.find { |k| @opts[k] }
+
+      return nil unless key
+
+      block = @opts[key]
+
+      @context.treechecker.block_check(block)
+        # raises in case of 'security' violation
+
+      #eval(block, @context.send(:binding))
+        # doesn't work with ruby 1.9.2-p136
+      eval(block, @context.instance_eval { binding })
+        # works OK with ruby 1.8.7-249 and 1.9.2-p136
+    end
+  end
+end
+

data/lib/ruote/part/code_participant.rb

@@ -0,0 +1,81 @@
+#--
+# Copyright (c) 2005-2011, 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 Ruote
+
+  #
+  # TODO
+  #
+  class CodeParticipant
+
+    include LocalParticipant
+
+    attr_accessor :context
+
+    def initialize(opts)
+
+      @opts = opts
+    end
+
+    def context=(con)
+
+      @context = con
+
+      @context.treechecker.code_check(@opts['code'])
+
+      instance_eval(@opts['code'])
+
+      #instance_eval do
+      #  alias code_consume consume
+      #  def consume(workitem)
+      #    code_consume(workitem)
+      #  rescue => e
+      #    raise e
+      #  end
+      #  # what about doing that with other methods
+      #end
+    end
+
+    protected
+
+#    def get_block(*keys)
+#
+#      key = keys.find { |k| @opts[k] }
+#
+#      return nil unless key
+#
+#      block = @opts[key]
+#
+#      @context.treechecker.block_check(block)
+#        # raises in case of 'security' violation
+#
+#      #eval(block, @context.send(:binding))
+#        # doesn't work with ruby 1.9.2-p136
+#      eval(block, @context.instance_eval { binding })
+#        # works OK with ruby 1.8.7-249 and 1.9.2-p136
+#    end
+  end
+end
+