ruote 2.1.11 → 2.2.0

data/lib/ruote/part/smtp_participant.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2010, Alain Hoang and John Mettraux.
+# Copyright (c) 2005-2011, Alain Hoang and John Mettraux.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -80,12 +80,12 @@ module Ruote
     include LocalParticipant
     include TemplateMixin
 
-    def initialize (opts)
+    def initialize(opts)
 
       @opts = opts.inject({}) { |h, (k, v)| h[k.to_s] = v; h }
     end
 
-    def consume (workitem)
+    def consume(workitem)
 
       to = workitem.fields['email_target'] || @opts['to']
       to = Array(to)
@@ -105,7 +105,7 @@ module Ruote
       reply_to_engine(workitem) if @opts['notification']
     end
 
-    def cancel (fei, flavour)
+    def cancel(fei, flavour)
 
       # does nothing
       #

data/lib/ruote/part/storage_participant.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2010, John Mettraux, jmettraux@gmail.com
+# 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
@@ -57,26 +57,26 @@ module Ruote
 
     attr_accessor :context
 
-    def initialize (engine_or_options={}, options=nil)
+    def initialize(engine_or_options={}, options=nil)
 
       if engine_or_options.respond_to?(:context)
         @context = engine_or_options.context
       elsif engine_or_options.is_a?(Ruote::Context)
         @context = engine_or_options
       else
-        options = engine_or_options
+        @options = engine_or_options
       end
 
-      options ||= {}
+      @options ||= {}
 
-      @store_name = options['store_name']
+      @store_name = @options['store_name']
     end
 
     # No need for a separate thread when delivering to this participant.
     #
     def do_not_thread; true; end
 
-    def consume (workitem)
+    def consume(workitem)
 
       doc = workitem.to_h
 
@@ -94,7 +94,7 @@ module Ruote
 
     # Removes the document/workitem from the storage
     #
-    def cancel (fei, flavour)
+    def cancel(fei, flavour)
 
       doc = fetch(fei)
 
@@ -103,14 +103,14 @@ module Ruote
       cancel(fei, flavour) if r != nil
     end
 
-    def [] (fei)
+    def [](fei)
 
       doc = fetch(fei)
 
       doc ? Ruote::Workitem.new(doc) : nil
     end
 
-    def fetch (fei)
+    def fetch(fei)
 
       hfei = Ruote::FlowExpressionId.extract_h(fei)
 
@@ -119,7 +119,10 @@ module Ruote
 
     # Removes the workitem from the in-memory hash and replies to the engine.
     #
-    def reply (workitem)
+    # TODO : should it raise if the workitem can't be found ?
+    # TODO : should it accept just the fei ?
+    #
+    def reply(workitem)
 
       # TODO: change method name (receiver mess cleanup)
 
@@ -143,14 +146,14 @@ module Ruote
 
     # Iterates over the workitems stored in here.
     #
-    def each (&block)
+    def each(&block)
 
       all.each { |wi| block.call(wi) }
     end
 
     # Returns all the workitems stored in here.
     #
-    def all (opts={})
+    def all(opts={})
 
       fetch_all(opts).map { |hwi| Ruote::Workitem.new(hwi) }
     end
@@ -167,7 +170,7 @@ module Ruote
 
     # Return all workitems for the specified wfid
     #
-    def by_wfid (wfid)
+    def by_wfid(wfid)
 
       @context.storage.get_many('workitems', wfid).collect { |hwi|
         Ruote::Workitem.new(hwi)
@@ -176,7 +179,7 @@ module Ruote
 
     # Returns all workitems for the specified participant name
     #
-    def by_participant (participant_name, opts={})
+    def by_participant(participant_name, opts={})
 
       hwis = if @context.storage.respond_to?(:by_participant)
 
@@ -201,7 +204,7 @@ module Ruote
     # CouchStorage), the others will load all the workitems and then filter
     # them.
     #
-    def by_field (field, value=nil)
+    def by_field(field, value=nil)
 
       hwis = if @context.storage.respond_to?(:by_field)
 
@@ -237,7 +240,7 @@ module Ruote
     # Note : the criteria is AND only, you'll have to do ORs (aggregation)
     # by yourself.
     #
-    def query (criteria)
+    def query(criteria)
 
       cr = criteria.inject({}) { |h, (k, v)| h[k.to_s] = v; h }
 
@@ -269,12 +272,12 @@ module Ruote
     #
     def purge!
 
-      fetch_all.each { |hwi| @context.storage.delete( hwi ) }
+      fetch_all.each { |hwi| @context.storage.delete(hwi) }
     end
 
     # Used by #query when filtering workitems.
     #
-    def self.matches? (hwi, pname, criteria)
+    def self.matches?(hwi, pname, criteria)
 
       return false if pname && hwi['participant_name'] != pname
 
@@ -287,12 +290,29 @@ module Ruote
       true
     end
 
+    # Mostly a test method. Returns a Hash were keys are participant names
+    # and values are lists of workitems.
+    #
+    def per_participant
+
+      inject({}) { |h, wi| (h[wi.participant_name] ||= []) << wi; h }
+    end
+
+    # Mostly a test method. Returns a Hash were keys are participant names
+    # and values are integers, the count of workitems for a given participant
+    # name.
+    #
+    def per_participant_count
+
+      per_participant.inject({}) { |h, (k, v)| h[k] = v.size; h }
+    end
+
     protected
 
     # Fetches all the workitems. If there is a @store_name, will only fetch
     # the workitems in that store.
     #
-    def fetch_all (opts={})
+    def fetch_all(opts={})
 
       @context.storage.get_many(
         'workitems',
@@ -302,7 +322,7 @@ module Ruote
 
     # Computes the id for the document representing the document in the storage.
     #
-    def to_id (fei)
+    def to_id(fei)
 
       a = [ Ruote.to_storage_id(fei) ]
 

data/lib/ruote/part/template.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2010, John Mettraux, jmettraux@gmail.com
+# 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
@@ -41,7 +41,7 @@ module Ruote
 
     # Do the rendering.
     #
-    def render_template (template, flow_expression, workitem)
+    def render_template(template, flow_expression, workitem)
 
       template = (File.read(template) rescue nil) if is_a_file?(template)
 
@@ -55,7 +55,7 @@ module Ruote
 
     # Simply returns a pretty-printed view of the workitem
     #
-    def render_default_template (workitem)
+    def render_default_template(workitem)
 
       workitem = workitem.to_h if workitem.respond_to?(:to_h)
 
@@ -72,7 +72,7 @@ module Ruote
 
     protected
 
-    def is_a_file? (s)
+    def is_a_file?(s)
 
       return false unless s
       return false if s.index("\n")

data/lib/ruote/participant.rb

@@ -1,5 +1,4 @@
 
-require 'ruote/part/hash_participant'
 require 'ruote/part/storage_participant'
 require 'ruote/part/no_op_participant'
 require 'ruote/part/null_participant'

data/lib/ruote/{parser.rb → reader.rb}

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2010, John Mettraux, jmettraux@gmail.com
+# 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
@@ -26,20 +26,21 @@
 require 'uri'
 require 'open-uri'
 require 'rufus/json'
-require 'ruote/parser/ruby_dsl' # just making sure it's loaded
-require 'ruote/parser/xml'
+require 'ruote/reader/ruby_dsl' # just making sure it's loaded
+require 'ruote/reader/xml'
+require 'ruote/util/subprocess'
 
 
 module Ruote
 
   #
-  # A process definition parser.
+  # A process definition reader.
   #
-  # Can parse XML, JSON, Ruby (and more) process definition representations.
+  # Can reader XML, JSON, Ruby (and more) process definition representations.
   #
-  class Parser
+  class Reader
 
-    def initialize (context)
+    def initialize(context)
 
       @context = context
     end
@@ -47,11 +48,11 @@ module Ruote
     # Turns the input into a ruote syntax tree (raw process definition).
     # This method is used by engine.launch(x) for example.
     #
-    def parse (definition)
+    def read(definition)
 
-      return definition if definition.is_a?(Array) and definition.size == 3
+      return definition if Ruote.is_tree?(definition)
 
-      (return XmlParser.parse(definition)) rescue nil
+      (return XmlReader.read(definition)) rescue nil
       (return Rufus::Json.decode(definition)) rescue nil
       (return ruby_eval(definition)) rescue nil
 
@@ -59,31 +60,31 @@ module Ruote
 
         raise ArgumentError.new(
           "remote process definitions are not allowed"
-        ) if Ruote::Parser.remote?(definition) && @context['remote_definition_allowed'] != true
+        ) if Ruote::Reader.remote?(definition) && @context['remote_definition_allowed'] != true
 
-        return parse(open(definition).read)
+        return read(open(definition).read)
       end
 
       raise ArgumentError.new(
-        "doesn't know how to parse definition (#{definition.class}) " +
+        "doesn't know how to read definition (#{definition.class}) " +
         "or error in process definition")
     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)
+    def self.read(d)
 
-      unless @parser
+      unless @reader
 
         require 'ostruct'
         require 'ruote/svc/treechecker'
 
-        @parser = Ruote::Parser.new(
+        @reader = Ruote::Reader.new(
           OpenStruct.new('treechecker' => Ruote::TreeChecker.new({})))
       end
 
-      @parser.parse(d)
+      @reader.read(d)
     end
 
     # Turns the given process definition tree (ruote syntax tree) to an XML
@@ -91,7 +92,7 @@ module Ruote
     #
     # Mainly used by ruote-fluo.
     #
-    def self.to_xml (tree, options={})
+    def self.to_xml(tree, options={})
 
       require 'builder'
 
@@ -125,7 +126,7 @@ module Ruote
     #
     # Mainly used by ruote-fluo.
     #
-    def self.to_ruby (tree, level=0)
+    def self.to_ruby(tree, level=0)
 
       expname = tree[0]
 
@@ -144,14 +145,14 @@ module Ruote
 
     # Turns the process definition tree (ruote syntax tree) to a JSON String.
     #
-    def self.to_json (tree)
+    def self.to_json(tree)
 
       tree.to_json
     end
 
     # Returns true if the defintion is a remote URI
     #
-    def self.remote? (definition)
+    def self.remote?(definition)
 
       u = URI.parse(definition)
 
@@ -164,23 +165,27 @@ module Ruote
     # treechecker, makes sure it doesn't code malicious ruby code (at least
     # tries very hard).
     #
-    def ruby_eval (s)
+    def ruby_eval(s)
 
-      @context.treechecker.check(s)
+      @context.treechecker.definition_check(s)
       eval(s)
 
     rescue Exception => e
+      #
+      # have to catch everything (SyntaxError included)
+
       #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)
+    def self.builder(options={}, &block)
 
       if b = options[:builder]
         block.call(b)
@@ -195,7 +200,7 @@ module Ruote
 
     # As used by to_ruby.
     #
-    def self.atts_to_ruby (atts)
+    def self.atts_to_ruby(atts)
 
       return '' if atts.empty?
 

data/lib/ruote/{parser → reader}/ruby_dsl.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2010, John Mettraux, jmettraux@gmail.com
+# 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
@@ -27,7 +27,7 @@ require 'ruote/util/ometa'
 
 module Ruote
 
-  # Not really a parser, more an AST builder.
+  # Not really a reader, more an AST builder.
   #
   #   pdef = Ruote.define :name => 'take_out_garbage' do
   #     sequence do
@@ -39,7 +39,7 @@ module Ruote
   #
   #   engine.launch(pdef)
   #
-  def self.define (*attributes, &block)
+  def self.define(*attributes, &block)
 
     RubyDsl.create_branch('define', attributes, &block)
   end
@@ -55,7 +55,7 @@ module Ruote
   #
   #   engine.launch(pdef)
   #
-  def self.process_definition (*attributes, &block)
+  def self.process_definition(*attributes, &block)
 
     define(*attributes, &block)
   end
@@ -87,7 +87,7 @@ module Ruote
   #       # cancels the segment of process at fei and replaces it with
   #       # a simple alfred-bob sequence.
   #
-  def self.to_tree (&block)
+  def self.to_tree(&block)
 
     RubyDsl.create_branch('x', {}, &block).last.first
   end
@@ -98,17 +98,16 @@ module Ruote
 
     class BranchContext < Ruote::BlankSlate
 
-      def initialize (name, attributes)
+      def initialize(name, attributes)
 
         @name = name
         @attributes = attributes
         @children = []
       end
 
-      def method_missing (m, *args, &block)
+      def method_missing(m, *args, &block)
 
-        @children.push(
-          Ruote::RubyDsl.create_branch(m.to_s, args, &block))
+        @children.push(Ruote::RubyDsl.create_branch(m.to_s, args, &block))
       end
 
       def to_a
@@ -117,22 +116,40 @@ module Ruote
       end
     end
 
-    def self.create_branch (name, attributes, &block)
+    def self.create_branch(name, attributes, &block)
 
       name = name[1..-1] while name[0, 1] == '_'
 
       h = attributes.inject({}) { |h1, a|
+
         a.is_a?(Hash) ? h1.merge!(a) : h1[a] = nil
+
         h1
+
       }.inject({}) { |h1, (k, v)|
-        h1[k.to_s] = v.is_a?(Symbol) ? v.to_s : v
+
+        k = k.is_a?(Regexp) ? k.inspect : k.to_s
+        h1[k] = to_json(v)
+
         h1
       }
 
       c = BranchContext.new(name, h)
       c.instance_eval(&block) if block
+
       c.to_a
     end
+
+    def self.to_json(v)
+
+      case v
+        when Symbol; v.to_s
+        when Regexp; v.inspect
+        when Array; v.collect { |e| to_json(e) }
+        when Hash; v.inject({}) { |h, (k, v)| h[k.to_s] = to_json(v); h }
+        else v
+      end
+    end
   end
 end