ruote 0.9.20 → 2.1.1

data/lib/ruote/log/test_logger.rb

@@ -0,0 +1,254 @@
+#--
+# Copyright (c) 2005-2010, 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/util/tree'
+
+
+module Ruote
+
+  class TestLogger
+
+    attr_reader :seen
+    attr_reader :log
+
+    attr_accessor :noisy
+
+    def initialize (context)
+
+      @context = context
+
+      if @context.respond_to?(: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 = nil
+
+      @count = -1
+      @color = 33
+      @noisy = false
+
+      # NOTE
+      # in case of troubles, why not have the wait_for has an event ?
+    end
+
+    def notify (msg)
+
+      #@context.storage.put(event.merge('type' => 'archived_msgs'))
+
+      puts(pretty_print(msg)) if @noisy
+
+      @seen << msg
+      @log << msg
+
+      check_waiting
+    end
+
+    def wait_for (*interests)
+
+      @waiting = [ Thread.current, interests ]
+
+      check_waiting
+
+      Thread.stop if @waiting
+
+      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
+
+      return unless @waiting
+
+      while msg = @seen.shift
+
+        break if check_msg(msg)
+      end
+    end
+
+    def check_msg (msg)
+
+      if check_interest(msg)
+
+        thread = @waiting.first
+        @waiting = nil
+        thread['__result__'] = msg
+        thread.wakeup
+
+        true
+      else
+
+        false
+      end
+    end
+
+    def check_interest (msg)
+
+      over = false
+
+      action = msg['action']
+
+      Array(@waiting.last).each do |interest|
+
+        over = if interest.is_a?(Symbol) # participant
+
+          (action == 'dispatch' && msg['participant_name'] == interest.to_s)
+
+        elsif interest.is_a?(Fixnum)
+
+          interest = interest - 1
+          @waiting = [ @waiting.first, interest ]
+
+          (interest < 1)
+
+        else # wfid
+
+          %w[ terminated ceased error_intercepted ].include?(action) &&
+          msg['wfid'] == interest
+        end
+
+        break if over
+      end
+
+      over
+    end
+
+    # <ESC>[{attr1};...;{attrn}m
+    #
+    # 0 Reset all attributes
+    # 1 Bright
+    # 2 Dim
+    # 4 Underscore
+    # 5 Blink
+    # 7 Reverse
+    # 8 Hidden
+    #
+    # Foreground Colours
+    # 30 Black
+    # 31 Red
+    # 32 Green
+    # 33 Yellow
+    # 34 Blue
+    # 35 Magenta
+    # 36 Cyan
+    # 37 White
+    #
+    # Background Colours
+    # 40 Black
+    # 41 Red
+    # 42 Green
+    # 43 Yellow
+    # 44 Blue
+    # 45 Magenta
+    # 46 Cyan
+    # 47 White
+
+    def color (mod, s, clear=false)
+
+      return s unless STDOUT.tty?
+
+      "[#{mod}m#{s}#{clear ? '' : "[#{@color}m"}"
+    end
+
+    def pretty_print (msg)
+
+      @count += 1
+      @count = 0 if @count > 9
+
+      ei = self.object_id.to_s[-2..-1]
+
+      fei = msg['fei']
+      depth = fei ? fei['expid'].split('_').size : 0
+
+      i = fei ?
+        [ fei['wfid'], fei['sub_wfid'], fei['expid'] ].join(' ') :
+        msg['wfid']
+
+      rest = msg.dup
+      %w[
+        _id put_at _rev
+        type action
+        fei wfid variables
+      ].each { |k| rest.delete(k) }
+
+      if v = rest['parent_id']
+        rest['parent_id'] = Ruote.to_storage_id(v)
+      end
+      if v = rest.delete('workitem')
+        rest[:wi] = [
+          v['fei'] ? Ruote.to_storage_id(v['fei']) : nil,
+          v['fields'].size ]
+      end
+
+      { 'tree' => :t, 'parent_id' => :pi }.each do |k0, k1|
+        if v = rest.delete(k0)
+          rest[k1] = v
+        end
+      end
+
+      action = msg['action'][0, 2]
+      action = 'rc' if msg['action'] == 'receive'
+      action = color('4;32', action) if action == 'la'
+      action = color('4;31', action) if action == 'te'
+      action = color('31', action) if action == 'ce'
+      action = color('31', action) if action == 'ca'
+      action = color('4;33', action) if action == 'rc'
+      action = color('4;33', action) if action == 'di'
+
+      color(
+        @color,
+        "#{@count} #{ei} #{'  ' * depth}#{action} * #{i} #{rest.inspect}",
+        true)
+    end
+  end
+end
+

data/lib/ruote/log/wait_logger.rb

@@ -0,0 +1,67 @@
+#--
+# Copyright (c) 2005-2010, 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.
+  #
+  class WaitLogger < TestLogger
+
+    attr_accessor :noisy
+
+    def initialize (context)
+
+      @context = context
+      @waiting = nil
+      @color = 33
+
+      @context.worker.subscribe(:all, self) if @context.respond_to?(:worker)
+
+      @noisy = false
+    end
+
+    def notify (msg)
+
+      puts(pretty_print(msg)) if @noisy
+
+      return unless @waiting
+
+      check_msg(msg)
+    end
+
+    def wait_for (interest)
+
+      @waiting = [ Thread.current, interest ]
+
+      Thread.stop
+
+      Thread.current['__result__']
+    end
+  end
+end
+

data/lib/ruote/parser.rb

@@ -0,0 +1,205 @@
+#--
+# Copyright (c) 2005-2010, 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 'uri'
+require 'open-uri'
+require 'rufus/json'
+require 'ruote/parser/ruby_dsl' # just making sure it's loaded
+require 'ruote/parser/xml'
+
+
+module Ruote
+
+  #
+  # A process definition parser.
+  #
+  class Parser
+
+    def initialize (context)
+
+      @context = context
+    end
+
+    # Turns the input into a ruote syntax tree (raw process definition).
+    # This method is used by engine.launch(x) for example.
+    #
+    def parse (definition)
+
+      return definition if definition.is_a?(Array) and definition.size == 3
+
+      (return XmlParser.parse(definition)) rescue nil
+      (return Rufus::Json.decode(definition)) rescue nil
+      (return ruby_eval(definition)) rescue nil
+
+      if definition.index("\n") == nil
+
+        u = URI.parse(definition)
+
+        raise ArgumentError.new(
+          "remote process definitions are not allowed"
+        ) if u.scheme != nil && @context['remote_definition_allowed'] != true
+
+        return parse(open(definition).read)
+      end
+
+      raise ArgumentError.new(
+        "doesn't know how to parse definition (#{definition.class})")
+    end
+
+    # Class method for parsing process definition (XML, Ruby, from file or
+    # from a string, ...) to syntax trees. Used by ruote-fluo for example.
+    #
+    def self.parse (d)
+
+      unless @parser
+
+        require 'ostruct'
+        require 'ruote/util/treechecker'
+
+        @parser = Ruote::Parser.new(
+          OpenStruct.new('treechecker' => Ruote::TreeChecker.new({})))
+      end
+
+      @parser.parse(d)
+    end
+
+    # Turns the given process definition tree (ruote syntax tree) to an XML
+    # String.
+    #
+    # Mainly used by ruote-fluo.
+    #
+    def self.to_xml (tree, options={})
+
+      require 'builder'
+
+      # TODO : deal with "participant 'toto'"
+
+      builder(options) do |xml|
+
+        atts = tree[1].dup
+
+        t = atts.find { |k, v| v == nil }
+        if t
+          atts.delete(t.first)
+          atts['ref'] = t.first
+        end
+
+        atts = atts.inject({}) { |h, (k, v)| h[k.to_s.gsub(/\_/, '-')] = v; h }
+
+        if tree[2].empty?
+          xml.tag!(tree[0], atts)
+        else
+          xml.tag!(tree[0], atts) do
+            tree[2].each { |child| to_xml(child, options) }
+          end
+        end
+      end
+    end
+
+    # Turns the given process definition tree (ruote syntax tree) to a Ruby
+    # process definition (a String containing that ruby process definition).
+    #
+    # Mainly used by ruote-fluo.
+    #
+    def self.to_ruby (tree, level=0)
+
+      expname = tree[0]
+
+      expname = 'Ruote.process_definition' if level == 0 && expname == 'define'
+
+      s = "#{'  ' * level}#{expname}#{atts_to_ruby(tree[1])}"
+
+      return "#{s}\n" if tree[2].empty?
+
+      s << " do\n"
+      tree[2].each { |child| s << to_ruby(child, level + 1) }
+      s << "#{'  ' * level}end\n"
+
+      s
+    end
+
+    # Turns the process definition tree (ruote syntax tree) to a JSON String.
+    #
+    def self.to_json (tree)
+
+      tree.to_json
+    end
+
+    protected
+
+    # Evaluates the ruby string in the code, but at fist, thanks to the
+    # treechecker, makes sure it doesn't code malicious ruby code (at least
+    # tries very hard).
+    #
+    def ruby_eval (s)
+
+      @context.treechecker.check(s)
+      eval(s)
+
+    rescue Exception => e
+      #puts '=' * 80
+      #p s
+      #puts '-' * 80
+      #puts e
+      #e.backtrace.each { |l| puts l }
+      raise ArgumentError.new('probably not ruby')
+    end
+
+    # A convenience method when building XML
+    #
+    def self.builder (options={}, &block)
+
+      if b = options[:builder]
+        block.call(b)
+      else
+        b = Builder::XmlMarkup.new(:indent => (options[:indent] || 0))
+        options[:builder] = b
+        b.instruct! unless options[:instruct] == false
+        block.call(b)
+        b.target!
+      end
+    end
+
+    # As used by to_ruby.
+    #
+    def self.atts_to_ruby (atts)
+
+      return '' if atts.empty?
+
+      s = []
+
+      t = atts.find { |k, v| v == nil }
+      s << t.first.inspect if t
+
+      s = atts.inject(s) { |a, (k, v)|
+        a << ":#{k} => #{v.inspect}" if t.nil? || k != t.first
+        a
+      }.join(', ')
+
+      s.length > 0 ? " #{s}" : s
+    end
+  end
+end
+