ruote 2.1.7 → 2.1.8

data/lib/ruote/storage/composite_storage.rb

@@ -0,0 +1,134 @@
+#--
+# 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/storage/base'
+
+
+module Ruote
+
+  #
+  # This storage allows for mixing of storage implementation or simply
+  # mixing of storage physical backend.
+  #
+  #   opts = {}
+  #
+  #   engine =
+  #     Ruote::Engine.new(
+  #       Ruote::Worker.new(
+  #         Ruote::CompositeStorage.new(
+  #           Ruote::FsStorage.new('ruote_work', opts),
+  #           'msgs' => Ruote::HashStorage.new(opts))))
+  #
+  # In this example, everything goes to the FsStorage, except the messages
+  # (msgs) that go to an in-memory storage.
+  #
+  class CompositeStorage
+
+    include StorageBase
+
+    def initialize (default_storage, storages)
+
+      @default_storage = default_storage
+      @storages = storages
+
+      prepare_base_methods
+    end
+
+    def put (doc, opts={})
+
+      storage(doc['type']).put(doc, opts)
+    end
+
+    def get (type, key)
+
+      storage(type).get(type, key)
+    end
+
+    def delete (doc)
+
+      storage(type).delete(doc)
+    end
+
+    def get_many (type, key=nil, opts={})
+
+      storage(type).get_many(type, key, opts)
+    end
+
+    def ids (type)
+
+      storage(type).ids(type)
+    end
+
+    def purge!
+
+      TYPES.collect { |t| storage(t) }.uniq.each { |s| s.purge! }
+    end
+
+    def purge_type! (type)
+
+      storage(type).purge_type!(type)
+    end
+
+    #def add_type (type)
+    #end
+
+    protected
+
+    STORAGE_BASE_METHODS = {
+      'put_msg' => 'msgs',
+      'get_msgs' => 'msgs',
+      'find_root_expression' => 'expressions',
+      'get_schedules' => 'schedules',
+      'put_schedule' => 'schedules'
+    }
+
+    TYPES = %w[
+      variables
+      msgs
+      expressions
+      errors
+      schedules
+      configurations
+      workitems
+    ]
+
+    def prepare_base_methods
+
+      singleton = class << self; self; end
+
+      STORAGE_BASE_METHODS.each do |method, type|
+
+        singleton.send(:define_method, method) do |*args|
+          storage(type).send(method, *args)
+        end
+      end
+    end
+
+    def storage (type)
+
+      @storages[type] || @default_storage
+    end
+  end
+end
+

data/lib/ruote/storage/fs_storage.rb

@@ -38,15 +38,29 @@ require 'rufus/cloche'
 
 module Ruote
 
+  # A basic FS-bound ruote storage. Leverages rufus-cloche
+  # (http://github.com/jmettraux/rufus-cloche).
+  #
+  # Warning : for JRuby 1.4.0 on Ubuntu, passing the cloche_nolock option set
+  # to true seems necessary.
+  # See http://groups.google.com/group/openwferu-users/t/d82516ed3bdd8f23
+  #
   class FsStorage
 
     include StorageBase
 
+    # Creates a FsStorage pointing to the given dir.
+    #
+    # The options are classical engine configuration, but the 'cloche_nolock'
+    # option is read by the storage and followed.
+    #
     def initialize (dir, options={})
 
       FileUtils.mkdir_p(dir)
 
-      @cloche = Rufus::Cloche.new(:dir => dir)
+      @cloche = Rufus::Cloche.new(
+        :dir => dir, :nolock => options['cloche_nolock'])
+
       @options = options
 
       @cloche.put(@options.merge('type' => 'configurations', '_id' => 'engine'))

data/lib/ruote/util/dollar.rb

@@ -24,6 +24,7 @@
 
 
 require 'rufus/dollar' # gem 'rufus-dollar'
+require 'ruote/util/lookup'
 require 'ruote/util/treechecker'
 
 

data/lib/ruote/util/misc.rb

@@ -27,7 +27,11 @@ module Ruote
 
   # Will be set to true if the Ruby runtime is on Windows
   #
-  WIN = RUBY_PLATFORM.match(/mswin|mingw/) != nil
+  WIN = (RUBY_PLATFORM.match(/mswin|mingw/) != nil)
+
+  # Will be set to true if the Ruby runtime is JRuby
+  #
+  JAVA = (RUBY_PLATFORM.match(/java/) != nil)
 
   # Prints the current call stack to stdout
   #

data/lib/ruote/util/time.rb

@@ -75,9 +75,7 @@ module Ruote
       #
       # duration
 
-      duration = s.to_f rescue Rufus.parse_time_string(s)
-
-      Time.now.utc.to_f + duration
+      Time.now.utc.to_f + Rufus.parse_time_string(s)
     end
 
     case at
@@ -86,5 +84,17 @@ module Ruote
       else at
     end
   end
+
+  # Waiting for a better implementation of it in rufus-scheduler 2.0.4
+  #
+  def self.is_cron_string (s)
+
+    ss = s.split(' ')
+
+    return false if ss.size < 5 || ss.size > 6
+    return false if s.match(/\d{4}/)
+
+    true
+  end
 end
 

data/lib/ruote/version.rb

@@ -23,6 +23,6 @@
 #++
 
 module Ruote
-  VERSION = '2.1.7'
+  VERSION = '2.1.8'
 end
 

data/lib/ruote/worker.rb

@@ -201,7 +201,7 @@ module Ruote
 
       msg = Ruote.fulldup(schedule['msg'])
 
-      return false unless @storage.reserve(schedule)
+      return false unless @storage.delete(schedule).nil?
 
       @storage.put_msg(msg.delete('action'), msg)
 
@@ -212,7 +212,7 @@ module Ruote
 
       return false if cannot_handle(msg)
 
-      return false unless @storage.reserve(msg)
+      return false unless @storage.delete(msg).nil?
 
       begin
 

data/ruote.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruote}
-  s.version = "2.1.7"
+  s.version = "2.1.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Mettraux", "Kenneth Kalmer", "Torsten Schoenebaum"]
-  s.date = %q{2010-02-15}
+  s.date = %q{2010-03-15}
   s.description = %q{
 ruote is an open source ruby workflow engine.
     }
@@ -100,6 +100,7 @@ ruote is an open source ruby workflow engine.
      "lib/ruote/participant.rb",
      "lib/ruote/receiver/base.rb",
      "lib/ruote/storage/base.rb",
+     "lib/ruote/storage/composite_storage.rb",
      "lib/ruote/storage/fs_storage.rb",
      "lib/ruote/storage/hash_storage.rb",
      "lib/ruote/subprocess.rb",
@@ -226,7 +227,9 @@ ruote is an open source ruby workflow engine.
      "test/unit/ut_15_util.rb",
      "test/unit/ut_16_parser.rb",
      "test/unit/ut_18_engine.rb",
+     "test/unit/ut_19_part_template.rb",
      "test/unit/ut_1_fei.rb",
+     "test/unit/ut_20_composite_storage.rb",
      "test/unit/ut_2_wfidgen.rb",
      "test/unit/ut_3_wait_logger.rb",
      "test/unit/ut_4_expmap.rb",
@@ -240,7 +243,7 @@ ruote is an open source ruby workflow engine.
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{ruote}
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{an open source ruby workflow engine}
   s.test_files = [
     "test/test.rb"
@@ -252,41 +255,44 @@ ruote is an open source ruby workflow engine.
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<rufus-json>, [">= 0.2.0"])
-      s.add_runtime_dependency(%q<rufus-cloche>, [">= 0.1.14"])
+      s.add_runtime_dependency(%q<rufus-cloche>, [">= 0.1.16"])
       s.add_runtime_dependency(%q<rufus-dollar>, [">= 0"])
       s.add_runtime_dependency(%q<rufus-lru>, [">= 0"])
       s.add_runtime_dependency(%q<rufus-mnemo>, [">= 1.1.0"])
-      s.add_runtime_dependency(%q<rufus-scheduler>, [">= 2.0.3"])
+      s.add_runtime_dependency(%q<rufus-scheduler>, [">= 2.0.5"])
       s.add_runtime_dependency(%q<rufus-treechecker>, [">= 1.0.3"])
-      s.add_development_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
       s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<json>, [">= 0"])
       s.add_development_dependency(%q<builder>, [">= 0"])
       s.add_development_dependency(%q<mailtrap>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
     else
       s.add_dependency(%q<rufus-json>, [">= 0.2.0"])
-      s.add_dependency(%q<rufus-cloche>, [">= 0.1.14"])
+      s.add_dependency(%q<rufus-cloche>, [">= 0.1.16"])
       s.add_dependency(%q<rufus-dollar>, [">= 0"])
       s.add_dependency(%q<rufus-lru>, [">= 0"])
       s.add_dependency(%q<rufus-mnemo>, [">= 1.1.0"])
-      s.add_dependency(%q<rufus-scheduler>, [">= 2.0.3"])
+      s.add_dependency(%q<rufus-scheduler>, [">= 2.0.5"])
       s.add_dependency(%q<rufus-treechecker>, [">= 1.0.3"])
-      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
       s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
       s.add_dependency(%q<builder>, [">= 0"])
       s.add_dependency(%q<mailtrap>, [">= 0"])
       s.add_dependency(%q<jeweler>, [">= 0"])
     end
   else
     s.add_dependency(%q<rufus-json>, [">= 0.2.0"])
-    s.add_dependency(%q<rufus-cloche>, [">= 0.1.14"])
+    s.add_dependency(%q<rufus-cloche>, [">= 0.1.16"])
     s.add_dependency(%q<rufus-dollar>, [">= 0"])
     s.add_dependency(%q<rufus-lru>, [">= 0"])
     s.add_dependency(%q<rufus-mnemo>, [">= 1.1.0"])
-    s.add_dependency(%q<rufus-scheduler>, [">= 2.0.3"])
+    s.add_dependency(%q<rufus-scheduler>, [">= 2.0.5"])
     s.add_dependency(%q<rufus-treechecker>, [">= 1.0.3"])
-    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
     s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
     s.add_dependency(%q<builder>, [">= 0"])
     s.add_dependency(%q<mailtrap>, [">= 0"])
     s.add_dependency(%q<jeweler>, [">= 0"])

data/test/bm/seq_thousand.rb

@@ -25,7 +25,7 @@ class BmSeqThousandTest < Test::Unit::TestCase
 
     noisy
 
-    assert_trace pdef, [ 'a' ] * n
+    assert_trace [ 'a' ] * n, pdef
   end
 end
 

data/test/functional/base.rb

@@ -51,16 +51,14 @@ module FunctionalBase
     assert_equal count, c
   end
 
-  #   assert_trace(pdef, *expected_traces)
-  #   assert_trace(pdef, fields, *expected_traces)
+  #   assert_trace(*expected_traces, pdef)
+  #   assert_trace(*expected_traces, fields, pdef)
   #
-  def assert_trace (pdef, *expected_traces)
+  def assert_trace (*args)
 
-    fields = expected_traces.first.is_a?(Hash) ? expected_traces.shift : {}
-
-    expected_traces = expected_traces.collect do |et|
-      et.is_a?(Array) ? et.join("\n") : et
-    end
+    pdef = args.pop
+    fields = args.last.is_a?(Hash) ? args.pop : {}
+    expected_traces = args.collect { |et| et.is_a?(Array) ? et.join("\n") : et }
 
     wfid = @engine.launch(pdef, fields)
 

data/test/functional/crunner.rb

@@ -4,6 +4,8 @@ tnumber = ARGV.find { |a| a.match(/^\d+/) } || 2
 
 i = 0
 
+puts `ruby -v`
+
 loop do
 
   t = Dir["test/functional/ct_#{tnumber}_*.rb"].first

data/test/functional/eft_0_process_definition.rb

@@ -16,8 +16,8 @@ class EftProcessDefinitionTest < Test::Unit::TestCase
   def test_empty_procdef
 
     assert_trace(
-      Ruote.define(:name => 'test_1') { },
-      '')
+      '',
+      Ruote.define(:name => 'test_1') { })
   end
 
   def test_sub_definition

data/test/functional/eft_10_cancel_process.rb

@@ -23,7 +23,7 @@ class EftCancelProcessTest < Test::Unit::TestCase
 
     #noisy
 
-    assert_trace(pdef, 'a')
+    assert_trace('a', pdef)
 
     #assert_equal 3, logger.log.select { |e| e[1] == :entered_tag }.size
   end
@@ -40,7 +40,7 @@ class EftCancelProcessTest < Test::Unit::TestCase
 
     #noisy
 
-    assert_trace(pdef, "a\nb")
+    assert_trace("a\nb", pdef)
   end
 end
 

data/test/functional/eft_11_wait.rb

@@ -27,7 +27,7 @@ class EftWaitTest < Test::Unit::TestCase
     ts = []
     @engine.register_participant(:alpha) { ts << Time.now }
 
-    assert_trace pdef, 'done.'
+    assert_trace 'done.', pdef
 
     #p [ ts[1].sec, ts[0].sec ]
     assert [ 2, 3 ].include?((ts[1].sec - ts[0].sec) % 60)
@@ -73,7 +73,7 @@ class EftWaitTest < Test::Unit::TestCase
     ts = []
     @engine.register_participant(:alpha) { ts << Time.now }
 
-    assert_trace pdef, 'done.'
+    assert_trace 'done.', pdef
 
     #p ts
     assert ts[1] - ts[0] > 1.0, "#{ts[1] - ts[0]} should be > 1.0"
@@ -91,7 +91,7 @@ class EftWaitTest < Test::Unit::TestCase
 
     #noisy
 
-    assert_trace pdef, %w[ a b ]
+    assert_trace %w[ a b ], pdef
   end
 end
 

data/test/functional/eft_12_listen.rb

@@ -148,7 +148,7 @@ class EftListenTest < Test::Unit::TestCase
       @tracer << "other:#{wi.fields['other']}\n"
     end
 
-    assert_trace(pdef, "alpha\nname:William Mandella other:nothing")
+    assert_trace("alpha\nname:William Mandella other:nothing", pdef)
   end
 
   def test_where