ruote 0.9.20 → 2.1.1

data/lib/ruote/workitem.rb

@@ -0,0 +1,176 @@
+#--
+# 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/misc'
+require 'ruote/util/lookup'
+require 'ruote/util/hashdot'
+
+
+module Ruote
+
+  class Workitem
+
+    attr_reader :h
+
+    def initialize (h)
+
+      @h = h
+      class << @h; include Ruote::HashDot; end
+    end
+
+    def to_h
+
+      @h
+    end
+
+    def fei
+
+      FlowExpressionId.new(h.fei)
+    end
+
+    def dup
+
+      Ruote.fulldup(self)
+    end
+
+    def participant_name
+
+      @h['participant_name']
+    end
+
+    def fields
+
+      @h['fields']
+    end
+
+    # A shortcut to the value in the field named __result__
+    #
+    # This field is used by the if expression for instance to determine
+    # if it should branch to its 'then' or its 'else'.
+    #
+    def result
+
+      fields['__result__']
+    end
+
+    # Sets the value of the 'special' field __result__
+    #
+    # See #result
+    #
+    def result= (r)
+
+      fields['__result__'] = r
+    end
+  end
+
+  #
+  # TODO : clean me out !
+  #
+  class BakWorkitem
+
+    attr_accessor :fei
+    attr_accessor :fields
+    attr_accessor :participant_name
+
+    alias :f :fields
+    alias :attributes :fields
+    alias :attributes= :fields=
+
+    def initialize (fields={})
+
+      @fei = nil
+      @fields = fields
+    end
+
+    # For a simple key
+    #
+    #   workitem.lookup('toto')
+    #
+    # is equivalent to
+    #
+    #   workitem.fields['toto']
+    #
+    # but for a complex key
+    #
+    #   workitem.lookup('toto.address')
+    #
+    # is equivalent to
+    #
+    #   workitem.fields['toto']['address']
+    #
+    def lookup (key, container_lookup=false)
+
+      Ruote.lookup(@fields, key, container_lookup)
+    end
+
+    # 'lf' for 'lookup field'
+    #
+    alias :lf :lookup
+
+    # Like #lookup allows for nested lookups, #set_field can be used
+    # to set sub fields directly.
+    #
+    #   workitem.set_field('customer.address.city', 'Pleasantville')
+    #
+    # Warning : if the customer and address field and subfield are not present
+    # or are not hashes, set_field will simply create a "customer.address.city"
+    # field and set its value to "Pleasantville".
+    #
+    def set_field (key, value)
+
+      Ruote.set(@fields, key, value)
+    end
+
+    # Returns a deep copy of this workitem instance.
+    #
+    def dup
+
+      Ruote.fulldup(self)
+    end
+
+    # Turns a workitem into a Ruby Hash (useful for JSON serializations)
+    #
+    def to_h
+
+      h = {}
+      h['fei'] = @fei.to_h
+      h['participant_name'] = @participant_name
+      h['fields'] = @fields
+
+      h
+    end
+
+    # Turns back a Ruby Hash into a workitem (well, attempts to)
+    #
+    def self.from_h (h)
+
+      wi = Workitem.new(h['fields'])
+      wi.fei = FlowExpressionId.from_h(h['fei'])
+      wi.participant_name = h['participant_name']
+
+      wi
+    end
+  end
+end
+

data/phil.txt

@@ -0,0 +1,14 @@
+
+persist then dispatch
+
+==
+
+concurrence (and concurrent-iterator) :
+
+  persist, then fire all children
+  prepare all children then fire them !!!
+
+==
+
+it can't be perfect, but there can be tools for fixing the consequences of those flaws.
+

data/ruote.gemspec

@@ -0,0 +1,278 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ruote}
+  s.version = "2.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Mettraux", "Kenneth Kalmer"]
+  s.date = %q{2009-12-31}
+  s.description = %q{
+ruote is an open source ruby workflow engine.
+    }
+  s.email = %q{jmettraux@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG.txt",
+     "CREDITS.txt",
+     "LICENSE.txt",
+     "README.rdoc",
+     "Rakefile",
+     "TODO.txt",
+     "examples/flickr_report.rb",
+     "examples/ruote_quickstart.rb",
+     "examples/web_first_page.rb",
+     "lib/ruote.rb",
+     "lib/ruote/context.rb",
+     "lib/ruote/engine.rb",
+     "lib/ruote/engine/process_error.rb",
+     "lib/ruote/engine/process_status.rb",
+     "lib/ruote/evt/tracker.rb",
+     "lib/ruote/exp/command.rb",
+     "lib/ruote/exp/commanded.rb",
+     "lib/ruote/exp/condition.rb",
+     "lib/ruote/exp/expression_map.rb",
+     "lib/ruote/exp/fe_add_branches.rb",
+     "lib/ruote/exp/fe_apply.rb",
+     "lib/ruote/exp/fe_cancel_process.rb",
+     "lib/ruote/exp/fe_command.rb",
+     "lib/ruote/exp/fe_concurrence.rb",
+     "lib/ruote/exp/fe_concurrent_iterator.rb",
+     "lib/ruote/exp/fe_cron.rb",
+     "lib/ruote/exp/fe_cursor.rb",
+     "lib/ruote/exp/fe_define.rb",
+     "lib/ruote/exp/fe_echo.rb",
+     "lib/ruote/exp/fe_equals.rb",
+     "lib/ruote/exp/fe_error.rb",
+     "lib/ruote/exp/fe_forget.rb",
+     "lib/ruote/exp/fe_if.rb",
+     "lib/ruote/exp/fe_inc.rb",
+     "lib/ruote/exp/fe_iterator.rb",
+     "lib/ruote/exp/fe_listen.rb",
+     "lib/ruote/exp/fe_noop.rb",
+     "lib/ruote/exp/fe_participant.rb",
+     "lib/ruote/exp/fe_redo.rb",
+     "lib/ruote/exp/fe_reserve.rb",
+     "lib/ruote/exp/fe_restore.rb",
+     "lib/ruote/exp/fe_save.rb",
+     "lib/ruote/exp/fe_sequence.rb",
+     "lib/ruote/exp/fe_set.rb",
+     "lib/ruote/exp/fe_subprocess.rb",
+     "lib/ruote/exp/fe_undo.rb",
+     "lib/ruote/exp/fe_wait.rb",
+     "lib/ruote/exp/fe_when.rb",
+     "lib/ruote/exp/flowexpression.rb",
+     "lib/ruote/exp/iterator.rb",
+     "lib/ruote/exp/merge.rb",
+     "lib/ruote/exp/raw.rb",
+     "lib/ruote/exp/ro_attributes.rb",
+     "lib/ruote/exp/ro_persist.rb",
+     "lib/ruote/exp/ro_variables.rb",
+     "lib/ruote/fei.rb",
+     "lib/ruote/id/mnemo_wfid_generator.rb",
+     "lib/ruote/id/wfid_generator.rb",
+     "lib/ruote/log/fs_history.rb",
+     "lib/ruote/log/test_logger.rb",
+     "lib/ruote/log/wait_logger.rb",
+     "lib/ruote/parser.rb",
+     "lib/ruote/parser/ruby_dsl.rb",
+     "lib/ruote/parser/xml.rb",
+     "lib/ruote/part/block_participant.rb",
+     "lib/ruote/part/dispatch_pool.rb",
+     "lib/ruote/part/hash_participant.rb",
+     "lib/ruote/part/local_participant.rb",
+     "lib/ruote/part/no_op_participant.rb",
+     "lib/ruote/part/null_participant.rb",
+     "lib/ruote/part/participant_list.rb",
+     "lib/ruote/part/smtp_participant.rb",
+     "lib/ruote/part/storage_participant.rb",
+     "lib/ruote/part/template.rb",
+     "lib/ruote/participant.rb",
+     "lib/ruote/receiver/base.rb",
+     "lib/ruote/storage/base.rb",
+     "lib/ruote/storage/fs_storage.rb",
+     "lib/ruote/storage/hash_storage.rb",
+     "lib/ruote/tree_dot.rb",
+     "lib/ruote/util/dollar.rb",
+     "lib/ruote/util/hashdot.rb",
+     "lib/ruote/util/look.rb",
+     "lib/ruote/util/lookup.rb",
+     "lib/ruote/util/misc.rb",
+     "lib/ruote/util/ometa.rb",
+     "lib/ruote/util/serializer.rb",
+     "lib/ruote/util/time.rb",
+     "lib/ruote/util/tree.rb",
+     "lib/ruote/util/treechecker.rb",
+     "lib/ruote/worker.rb",
+     "lib/ruote/workitem.rb",
+     "phil.txt",
+     "ruote.gemspec",
+     "test/README.rdoc",
+     "test/bm/ci.rb",
+     "test/bm/ici.rb",
+     "test/bm/juuman.rb",
+     "test/bm/load_26c.rb",
+     "test/bm/mega.rb",
+     "test/bm/seq_thousand.rb",
+     "test/bm/t.rb",
+     "test/functional/base.rb",
+     "test/functional/concurrent_base.rb",
+     "test/functional/crunner.rb",
+     "test/functional/ct_0_concurrence.rb",
+     "test/functional/ct_1_iterator.rb",
+     "test/functional/ct_2_cancel.rb",
+     "test/functional/eft_0_process_definition.rb",
+     "test/functional/eft_10_cancel_process.rb",
+     "test/functional/eft_11_wait.rb",
+     "test/functional/eft_12_listen.rb",
+     "test/functional/eft_13_iterator.rb",
+     "test/functional/eft_14_cursor.rb",
+     "test/functional/eft_15_loop.rb",
+     "test/functional/eft_16_if.rb",
+     "test/functional/eft_17_equals.rb",
+     "test/functional/eft_18_concurrent_iterator.rb",
+     "test/functional/eft_19_reserve.rb",
+     "test/functional/eft_1_echo.rb",
+     "test/functional/eft_20_save.rb",
+     "test/functional/eft_21_restore.rb",
+     "test/functional/eft_22_noop.rb",
+     "test/functional/eft_23_apply.rb",
+     "test/functional/eft_24_add_branches.rb",
+     "test/functional/eft_25_command.rb",
+     "test/functional/eft_26_error.rb",
+     "test/functional/eft_27_inc.rb",
+     "test/functional/eft_28_when.rb",
+     "test/functional/eft_29_cron.rb",
+     "test/functional/eft_2_sequence.rb",
+     "test/functional/eft_3_participant.rb",
+     "test/functional/eft_4_set.rb",
+     "test/functional/eft_5_subprocess.rb",
+     "test/functional/eft_6_concurrence.rb",
+     "test/functional/eft_7_forget.rb",
+     "test/functional/eft_8_undo.rb",
+     "test/functional/eft_9_redo.rb",
+     "test/functional/ft_0_worker.rb",
+     "test/functional/ft_10_dollar.rb",
+     "test/functional/ft_11_recursion.rb",
+     "test/functional/ft_12_launchitem.rb",
+     "test/functional/ft_13_variables.rb",
+     "test/functional/ft_14_re_apply.rb",
+     "test/functional/ft_15_timeout.rb",
+     "test/functional/ft_16_participant_params.rb",
+     "test/functional/ft_17_conditional.rb",
+     "test/functional/ft_18_kill.rb",
+     "test/functional/ft_19_alias.rb",
+     "test/functional/ft_1_process_status.rb",
+     "test/functional/ft_20_storage_participant.rb",
+     "test/functional/ft_21_forget.rb",
+     "test/functional/ft_22_process_definitions.rb",
+     "test/functional/ft_23_load_defs.rb",
+     "test/functional/ft_24_block_participants.rb",
+     "test/functional/ft_25_receiver.rb",
+     "test/functional/ft_26_participant_timeout.rb",
+     "test/functional/ft_27_var_indirection.rb",
+     "test/functional/ft_28_null_noop_participants.rb",
+     "test/functional/ft_29_part_template.rb",
+     "test/functional/ft_2_errors.rb",
+     "test/functional/ft_30_smtp_participant.rb",
+     "test/functional/ft_31_part_blocking.rb",
+     "test/functional/ft_32_history.rb",
+     "test/functional/ft_33_participant_subprocess_priority.rb",
+     "test/functional/ft_34_cursor_rewind.rb",
+     "test/functional/ft_35_add_service.rb",
+     "test/functional/ft_3_participant_registration.rb",
+     "test/functional/ft_4_cancel.rb",
+     "test/functional/ft_5_on_error.rb",
+     "test/functional/ft_6_on_cancel.rb",
+     "test/functional/ft_7_tags.rb",
+     "test/functional/ft_8_participant_consumption.rb",
+     "test/functional/ft_9_subprocesses.rb",
+     "test/functional/restart_base.rb",
+     "test/functional/rt_0_wait.rb",
+     "test/functional/rt_1_listen.rb",
+     "test/functional/rt_2_errors.rb",
+     "test/functional/rt_3_when.rb",
+     "test/functional/rt_4_cron.rb",
+     "test/functional/rt_5_timeout.rb",
+     "test/functional/rtest.rb",
+     "test/functional/storage_helper.rb",
+     "test/functional/test.rb",
+     "test/mpc_test.rb",
+     "test/path_helper.rb",
+     "test/pdef.xml",
+     "test/test.rb",
+     "test/test_helper.rb",
+     "test/unit/storages.rb",
+     "test/unit/test.rb",
+     "test/unit/ut_0_ruby_parser.rb",
+     "test/unit/ut_11_lookup.rb",
+     "test/unit/ut_13_serializer.rb",
+     "test/unit/ut_14_is_uri.rb",
+     "test/unit/ut_15_util.rb",
+     "test/unit/ut_16_parser.rb",
+     "test/unit/ut_17_storage.rb",
+     "test/unit/ut_1_fei.rb",
+     "test/unit/ut_2_wfidgen.rb",
+     "test/unit/ut_3_wait_logger.rb",
+     "test/unit/ut_4_expmap.rb",
+     "test/unit/ut_5_tree.rb",
+     "test/unit/ut_6_condition.rb",
+     "test/unit/ut_7_workitem.rb",
+     "test/unit/ut_8_tree_to_dot.rb",
+     "test/unit/ut_9_xml_parser.rb"
+  ]
+  s.homepage = %q{http://ruote.rubyforge.org}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{ruote}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{an open source ruby workflow engine}
+  s.test_files = [
+    "test/test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rufus-cloche>, [">= 0.1.6"])
+      s.add_runtime_dependency(%q<rufus-dollar>, [">= 0"])
+      s.add_runtime_dependency(%q<rufus-json>, [">= 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-treechecker>, [">= 1.0.3"])
+      s.add_development_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<rufus-cloche>, [">= 0.1.6"])
+      s.add_dependency(%q<rufus-dollar>, [">= 0"])
+      s.add_dependency(%q<rufus-json>, [">= 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-treechecker>, [">= 1.0.3"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rufus-cloche>, [">= 0.1.6"])
+    s.add_dependency(%q<rufus-dollar>, [">= 0"])
+    s.add_dependency(%q<rufus-json>, [">= 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-treechecker>, [">= 1.0.3"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+