ruote 0.9.19 → 0.9.20

data/README.txt

@@ -1,26 +1,36 @@
-= OpenWFEru
+
+= Ruote (OpenWFEru)
 
 == Overview
 
-OpenWFEru is an open source workflow and BPM engine written in Ruby.
+Ruote is an open source workflow engine written in Ruby.
 
 "Ruote" is the nickname of the engine/system, as "OpenWFEru" is quite hard to spell.
 
 The quickstart is at : http://openwferu.rubyforge.org/quickstart.html
 
 
+== License
+
+is the MIT one.
+
+
 == Links
 
 http://openwferu.rubyforge.org
 http://rubyforge.org/projects/openwferu
 
+http://jmettraux.wordpress.com (blog)
+
 
 == feedback
 
-user mailing list :        http://groups.google.com/group/openwferu-users
-developers mailing list :  http://groups.google.com/group/openwferu-dev
+mailing list :   http://groups.google.com/group/openwferu-users
+
+issue tracker :  http://rubyforge.org/tracker/?atid=10023&group_id=2609&func=browse
+
+irc :            irc.freenode.net #ruote
 
-issue tracker :            http://rubyforge.org/tracker/?atid=10023&group_id=2609&func=browse
 
-irc :                      irc.freenode.net #ruote
+author : jmettraux@gmail.com
 

data/examples/engine_template.rb

@@ -1,13 +1,12 @@
 
 require 'rubygems'
   #
-  # if OpenWFEru was installed via 'gem'
+  # if ruote was installed via  sudo gem install ruote
 
 #
-# setting up an OpenWFEru engine, step by step
+# setting up a ruote engine, step by step
 
-require 'openwfe/engine/engine'
-require 'openwfe/engine/file_persisted_engine'
+require 'openwfe/engine/fs_engine'
 require 'openwfe/participants/participants'
 
 
@@ -90,17 +89,11 @@ require 'openwfe/participants/participants'
   # might be ideal for an embedded workflow engine with short lived
   # process definitions to run
 
-#engine = OpenWFE::FilePersistedEngine.new
-#engine = OpenWFE::FilePersistedEngine.new(application_context)
+engine = OpenWFE::FsPersistedEngine.new
+#engine = OpenWFE::FsPersistedEngine.new(application_context)
   #
   # a file persisted engine, slow, used only within unit tests
   # do not use
-
-engine = OpenWFE::CachedFilePersistedEngine.new
-#engine = OpenWFE::CachedFilePersistedEngine.new(application_context)
-  #
-  # a file persisted engine, with an in-memory cache.
-  # use that
   #
   # persistence is done by default under ./work/
 
@@ -135,24 +128,6 @@ end
   # dumps all the process history in a file name "history.log"
   # in the work directory
 
-# -- process journaling
-
-#require 'openwfe/expool/journal'
-#engine.init_service("journal", Journal)
-  #
-  # activates 'journaling',
-  #
-  # see http://openwferu.rubyforge.org/journal.html
-  #
-  # Journaling has a cost in terms of performace.
-  # Journaling should be used only in case you might want to migrate
-  # [segments of] running processes.
-  #
-#engine.application_context[:keep_journals] = true
-  #
-  # if set to true, the journal of terminated processes will be kept
-  # (but moved by default to ./work/journal/done/)
-
 
 #
 # === some LISTENERS
@@ -163,18 +138,6 @@ end
 
 #require 'openwfe/listeners/listeners'
 
-#sl = OpenWFE::SocketListener.new(
-#  "socket_listener", @engine.application_context, 7008)
-#engine.add_workitem_listener(sl)
-  #
-  # adding a simple SocketListener on port 7008
-
-#require 'openwfe/listeners/socketlisteners'
-#
-#engine.add_workitem_listener(OpenWFE::SocketListener)
-  #
-  # adding a SocketListener on the default port 7007
-
 #engine.add_workitem_listener(OpenWFE::FileListener, "500")
   #
   # listening for workitems (coming as within YAML files dropped in the
@@ -235,7 +198,7 @@ end
   # the workitem to it over TCP
 
 
-engine.reschedule
+engine.reload
   #
   # this method has to be called after all the participants have been
   # added, it looks for temporal expressions (sleep, cron, ...) to

data/examples/quickstart.rb

@@ -0,0 +1,87 @@
+
+require 'rubygems'
+require 'openwfe/engine' # sudo gem install ruote
+require 'atom/feed' # sudo gem install atom-tools
+
+#
+# starting a transient engine (no need to make it persistent)
+
+
+engine = OpenWFE::Engine.new(:definition_in_launchitem_allowed => true)
+
+#
+# a process that fetches the latest pictures from flickr.com and submits
+# them concurrently to three users for review
+
+class MyProcess < OpenWFE::ProcessDefinition
+
+  sequence do
+
+    get_pictures
+
+    concurrence :merge_type => 'mix' do
+      # pass the picture list to three users concurrently
+      # make sure to let their choice appear in the final workitem
+      # at the end of the concurrence
+
+      user_alice
+      user_bob
+      user_charly
+    end
+
+    show_results
+      # display the pictures chosen by the users
+  end
+end
+
+#
+# fetching the flickr.com pictures via Atom
+
+engine.register_participant :get_pictures do |workitem|
+
+  feed = Atom::Feed.new(
+    "http://api.flickr.com/services/feeds/photos_public.gne"+
+    "?tags=#{workitem.tags.join(',')}&format=atom")
+  feed.update!
+  workitem.pictures = feed.entries.inject([]) do |a, entry|
+    a << [ entry.title, entry.authors.first.name, entry.links.first.href ]
+  end
+end
+
+#
+# the users (well, here, just randomly picking a picture)
+
+engine.register_participant 'user-.*' do |workitem|
+
+  workitem.fields[workitem.participant_name] =
+    workitem.pictures[(rand * workitem.pictures.length).to_i]
+end
+
+#
+# the final participant, it displays the user choices
+
+engine.register_participant :show_results do |workitem|
+  puts
+  puts ' users selected those images : '
+  puts
+  workitem.attributes.each do |k, v|
+    next unless k.match(/^user-.*$/)
+    puts "- #{k} :: #{v.last}"
+  end
+  puts
+end
+
+#
+# launching the process, requesting pictures tagged 'cat' and 'fish'
+
+li = OpenWFE::LaunchItem.new(MyProcess)
+li.tags = [ 'cat', 'fish' ]
+
+fei = engine.launch(li)
+
+#
+# workflow engines are asynchronous beasts, have to wait for them
+# (here we wait for a particular process)
+
+engine.wait_for(fei)
+

data/examples/quotereporter.rb

@@ -6,9 +6,8 @@
 require 'rubygems'
 
 require 'openwfe/engine/engine'
-require 'openwfe/expressions/raw_prog'
 require 'openwfe/participants/soapparticipants'
-require 'openwfe/participants/atomparticipants'
+require 'openwfe/extras/participants/atomfeed_participants'
 
 
 #
@@ -18,50 +17,42 @@ require 'openwfe/participants/atomparticipants'
 # define the flow as a Ruby class
 
 class QuoteLookupFlow < OpenWFE::ProcessDefinition
-  def make
-    process_definition :name => "quote_lookup", :revision => "0.1" do
-      sequence do
-
-        #
-        # lookup quotes
-
-        iterator :on_field_value => "symbols", :to_field => "symbol" do
-          sequence do
-
-            set \
-              :field => "quote_${f:__ip__}_name",
-              :field_value => "symbol"
-
-            participant :quote_service
-
-            set \
-              :field => "quote_${f:__ip__}_value",
-              :field_value => "__result__"
-          end
-        end
-
-        #
-        # update feed
-
-        set :field => "atom_entry_title" do
-          "quote feed at ${r:Time.now}"
-        end
-          #
-          # wrapping some ruby code for eval at runtime
-          # with ${r: ruby code ... }
-
-        participant :feed
-
-        #participant :ref => "puts_workitem"
-        #participant :ref => :puts_workitem
-        #participant "puts_workitem"
-        #participant :puts_workitem
-        puts_workitem
-          #
-          # the five notations are equivalent
-      end
-    end
-  end
+ sequence do
+
+   #
+   # lookup quotes
+
+   iterator :on_field_value => "symbols", :to_field => "symbol" do
+     sequence do
+
+       set :field => "quote_${f:__ip__}_name", :field_value => "symbol"
+
+       participant :quote_service
+
+       set :field => "quote_${f:__ip__}_value", :field_value => "__result__"
+     end
+   end
+
+   #
+   # update feed
+
+   set :field => "atom_entry_title" do
+     "quote feed at ${r:Time.now}"
+   end
+     #
+     # wrapping some ruby code for eval at runtime
+     # with ${r: ruby code ... }
+
+   participant :feed
+
+   #participant :ref => "puts_workitem"
+   #participant :ref => :puts_workitem
+   #participant "puts_workitem"
+   #participant :puts_workitem
+   puts_workitem
+     #
+     # the five notations are equivalent
+ end
 end
 
 #
@@ -69,7 +60,7 @@ end
 #
 # a simple in memory engine, no persistence whatsoever for now.
 
-engine = OpenWFE::Engine.new
+engine = OpenWFE::Engine.new({ :definition_in_launchitem_allowed  => true })
 
 #
 # The Participants
@@ -95,7 +86,7 @@ engine.register_participant("quote_service", quote_service)
 #
 # The feed is outputted in the current working directory ./atom_feed.xml
 #
-feed = OpenWFE::AtomParticipant.new(10) do
+feed = OpenWFE::Extras::AtomFeedParticipant.new(10) do
   | flow_expression, participant, workitem |
 
   #
@@ -134,7 +125,7 @@ end
 #
 # launching (not lunching)
 
-launchitem = LaunchItem.new(QuoteLookupFlow)
+launchitem = OpenWFE::LaunchItem.new(QuoteLookupFlow)
   #
   # Passing the process definition class as the unique
   # LaunchItem parameter
@@ -155,3 +146,5 @@ engine.launch(launchitem)
 #   sleep (3600) # one hour
 # end
 
+engine.join
+

data/examples/simple.rb

@@ -0,0 +1,56 @@
+
+require 'rubygems'
+require 'openwfe/engine' # sudo gem install ruote
+
+#
+# define a process, just a sequence, from Alice to Bob
+
+#process_definition = OpenWFE.process_definition :name => 'test' do
+class Pdef < OpenWFE::ProcessDefinition
+  sequence do
+    participant 'alice'
+    participant 'bob'
+  end
+end
+
+#
+# instantiate a ruote engine, the default (transient) one is OK.
+# allow it to fetch process definitions from lauchitems.
+#
+# more info about engines and persistence flavour at
+#
+# http://openwferu.rubyforge.org/persistence.html
+
+engine = OpenWFE::Engine.new(:definition_in_launchitem_allowed => true)
+
+#
+# register two very basic participants 'alice' and 'bob',
+# use a BlockParticipant (simply wrapping some ruby code inside of a
+# participant).
+#
+# more info about participants at
+#
+# http://openwferu.rubyforge.org/participants.html
+
+engine.register_participant 'alice' do |workitem|
+  puts '~alice~'
+  workitem.fields['message'] = 'hello from Alice !'
+end
+engine.register_participant 'bob' do |workitem|
+  puts '~bob~'
+  puts "the message says '#{workitem.fields['message']}'"
+end
+
+#
+# launch the process (let the engine interpret the process definition and
+# create a process instance)
+
+#fei = engine.launch(process_definition)
+fei = engine.launch(Pdef)
+
+#
+# wait for the process instance to terminate before exiting this tiny ruby
+# program
+
+engine.wait_for(fei)
+

data/lib/openwfe.rb

@@ -1,41 +1,27 @@
-#
 #--
 # Copyright (c) 2005-2007, John Mettraux and Alain Hoang, 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:
-#
-# . Redistributions of source code must retain the above copyright notice, this
-#   list of conditions and the following disclaimer.
-#
-# . 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.
 #
-# . 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.
-#
-# 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.
+# 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.
 #++
-#
-# = openwferu -- Open Workflow Engine in Ruby
-#
-# This is the main file for the openwferu engine.  It is normally
-# referenced as a library via a require statement.
-#
 
 require 'openwfe/engine/engine'
-#require 'openwfe/engine/file_persisted_engine'
+require 'openwfe/engine/fs_engine'