ruote 2.1.11 → 2.2.0

data/lib/ruote/workitem.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
@@ -39,7 +39,7 @@ module Ruote
 
     attr_reader :h
 
-    def initialize (h)
+    def initialize(h)
 
       @h = h
       class << @h; include Ruote::HashDot; end
@@ -47,10 +47,10 @@ module Ruote
       #class << @h['fields']
       #  alias_method :__get, :[]
       #  alias_method :__set, :[]=
-      #  def [] (key)
+      #  def [](key)
       #    __get(key.to_s)
       #  end
-      #  def []= (key, value)
+      #  def []=(key, value)
       #    __set(key.to_s, value)
       #  end
       #end
@@ -118,7 +118,7 @@ module Ruote
     #
     # Remember : the fields must be a JSONifiable hash.
     #
-    def fields= (fields)
+    def fields=(fields)
 
       @h['fields'] = fields
     end
@@ -137,7 +137,7 @@ module Ruote
     #
     # See #result
     #
-    def result= (r)
+    def result=(r)
 
       fields['__result__'] = r
     end
@@ -151,7 +151,7 @@ module Ruote
 
     # Warning : equality is based on fei and not on payload !
     #
-    def == (other)
+    def ==(other)
 
       return false if other.class != self.class
       self.h['fei'] == other.h['fei']
@@ -182,7 +182,7 @@ module Ruote
     #
     #   workitem.fields['toto']['address']
     #
-    def lookup (key, container_lookup=false)
+    def lookup(key, container_lookup=false)
 
       Ruote.lookup(@h['fields'], key, container_lookup)
     end
@@ -200,7 +200,7 @@ module Ruote
     # 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)
+    def set_field(key, value)
 
       Ruote.set(@h['fields'], key, value)
     end
@@ -254,13 +254,66 @@ module Ruote
     # __command__ is read by the 'cursor' and the 'iterator' expressions
     # when a workitem reaches it (apply and reply).
     #
-    def command= (com)
+    def command=(com)
 
       com = com.is_a?(Array) ? com : com.split(' ')
-      com[1] = com[1].to_i if com[1]
+      com = [ com.first, com.last ]
+      com[1] = com[1].to_i if com[1] and com[0] != 'jump'
 
       @h['fields']['__command__'] = com
     end
+
+    # Shortcut for wi.fields['__tags__']
+    #
+    def tags
+
+      @h['fields']['__tags__'] || []
+    end
+
+    # Used by FlowExpression when entering a tag.
+    #
+    def self.add_tag(hworkitem, tag)
+
+      (hworkitem['fields']['__tags__'] ||= []) << tag
+    end
+
+    # Used by FlowExpression when leaving a tag.
+    #
+    def self.remove_tag(hworkitem, tag)
+
+      # it's a bit convoluted... trying to cope with potential inconsistencies
+      #
+      # normally, it should only be a tags.pop(), but since user have
+      # access to the workitem and its fields... better be safe than sorry
+
+      tags = (hworkitem['fields']['__tags__'] || [])
+
+      if index = tags.rindex(tag)
+        tags.delete_at(index)
+      end
+    end
+
+    # Encodes this workitem as JSON. If pretty is set to true, will output
+    # prettified JSON.
+    #
+    def as_json(pretty=false)
+
+      pretty ? Rufus::Json.pretty_encode(@h) : Rufus::Json.encode(@h)
+    end
+
+    # Given a JSON String, decodes and returns a Ruote::Workitem instance.3
+    # If the decode thing is not an object/hash, will raise an ArgumentError.
+    #
+    def self.from_json(json)
+
+      h = Rufus::Json.decode(json)
+
+      raise ArgumentError(
+        "Arg not a JSON hash/object, but a #{h.class}. Cannot create workitem"
+      ) unless h.is_a?(Hash)
+
+      self.new(h)
+    end
   end
 end
 

data/ruote.gemspec

@@ -1,310 +1,39 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 Gem::Specification.new do |s|
-  s.name = %q{ruote}
-  s.version = "2.1.11"
 
-  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-10-01}
-  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/barley.rb",
-     "examples/flickr_report.rb",
-     "examples/pong.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/exp/command.rb",
-     "lib/ruote/exp/commanded.rb",
-     "lib/ruote/exp/condition.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_ref.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/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/pretty.rb",
-     "lib/ruote/log/storage_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/engine_participant.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/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/composite_storage.rb",
-     "lib/ruote/storage/fs_storage.rb",
-     "lib/ruote/storage/hash_storage.rb",
-     "lib/ruote/svc/dispatch_pool.rb",
-     "lib/ruote/svc/dollar_sub.rb",
-     "lib/ruote/svc/error_handler.rb",
-     "lib/ruote/svc/expression_map.rb",
-     "lib/ruote/svc/participant_list.rb",
-     "lib/ruote/svc/tracker.rb",
-     "lib/ruote/svc/treechecker.rb",
-     "lib/ruote/tree_dot.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/subprocess.rb",
-     "lib/ruote/util/time.rb",
-     "lib/ruote/util/tree.rb",
-     "lib/ruote/version.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/crunner.sh",
-     "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_30_ref.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_33_participant_subprocess_priority.rb",
-     "test/functional/ft_34_cursor_rewind.rb",
-     "test/functional/ft_35_add_service.rb",
-     "test/functional/ft_36_storage_history.rb",
-     "test/functional/ft_37_engine_participant.rb",
-     "test/functional/ft_38_participant_more.rb",
-     "test/functional/ft_39_wait_for.rb",
-     "test/functional/ft_3_participant_registration.rb",
-     "test/functional/ft_40_wait_logger.rb",
-     "test/functional/ft_41_participants.rb",
-     "test/functional/ft_42_storage_copy.rb",
-     "test/functional/ft_43_participant_on_reply.rb",
-     "test/functional/ft_44_var_participant.rb",
-     "test/functional/ft_45_participant_accept.rb",
-     "test/functional/ft_46_launch_single.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/functional/vertical.rb",
-     "test/path_helper.rb",
-     "test/pdef.xml",
-     "test/test.rb",
-     "test/test_helper.rb",
-     "test/unit/storage.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_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",
-     "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.6}
-  s.summary = %q{an open source ruby workflow engine}
-  s.test_files = [
-    "test/test.rb"
+  s.name = 'ruote'
+  s.version = File.read('lib/ruote/version.rb').match(/VERSION = '([^']+)'/)[1]
+  s.platform = Gem::Platform::RUBY
+  s.authors = [ 'John Mettraux', 'Kenneth Kalmer', 'Torsten Schoenebaum' ]
+  s.email = [ 'jmettraux@gmail.com' ]
+  s.homepage = 'http://ruote.rubyforge.org'
+  s.rubyforge_project = 'ruote'
+  s.summary = 'an open source Ruby workflow engine'
+  s.description = %{
+ruote is an open source Ruby workflow engine
+  }
+
+  #s.files = `git ls-files`.split("\n")
+  s.files = Dir[
+    'Rakefile',
+    'lib/**/*.rb', 'spec/**/*.rb', 'test/**/*.rb',
+    '*.gemspec', '*.txt', '*.rdoc', '*.md'
   ]
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.add_runtime_dependency 'sourcify', '0.4.2'
+  s.add_runtime_dependency 'rufus-json', '>= 0.2.5'
+  s.add_runtime_dependency 'rufus-cloche', '>= 0.1.20'
+  s.add_runtime_dependency 'rufus-dollar', '>= 1.0.4'
+  s.add_runtime_dependency 'rufus-mnemo', '>= 1.1.0'
+  s.add_runtime_dependency 'rufus-scheduler', '>= 2.0.8'
+  s.add_runtime_dependency 'rufus-treechecker', '>= 1.0.4'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'json'
+  s.add_development_dependency 'builder'
+  s.add_development_dependency 'mailtrap'
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rufus-json>, [">= 0.2.5"])
-      s.add_runtime_dependency(%q<rufus-cloche>, [">= 0.1.20"])
-      s.add_runtime_dependency(%q<rufus-dollar>, [">= 0"])
-      s.add_runtime_dependency(%q<rufus-mnemo>, [">= 1.1.0"])
-      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<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.5"])
-      s.add_dependency(%q<rufus-cloche>, [">= 0.1.20"])
-      s.add_dependency(%q<rufus-dollar>, [">= 0"])
-      s.add_dependency(%q<rufus-mnemo>, [">= 1.1.0"])
-      s.add_dependency(%q<rufus-scheduler>, [">= 2.0.5"])
-      s.add_dependency(%q<rufus-treechecker>, [">= 1.0.3"])
-      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.5"])
-    s.add_dependency(%q<rufus-cloche>, [">= 0.1.20"])
-    s.add_dependency(%q<rufus-dollar>, [">= 0"])
-    s.add_dependency(%q<rufus-mnemo>, [">= 1.1.0"])
-    s.add_dependency(%q<rufus-scheduler>, [">= 2.0.5"])
-    s.add_dependency(%q<rufus-treechecker>, [">= 1.0.3"])
-    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
+  s.require_path = 'lib'
 end