openwferu 0.9.12 → 0.9.12.863

data/lib/openwfe/rest/osocket.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: codec.rb 2515 2006-04-26 18:38:39Z jmettraux $
-#
 
 require 'socket'
 
@@ -94,7 +92,8 @@ module OpenWFE
     #
     def OpenWFE.dispatch_workitem (host, port, workitem)
 
-        sXml = OpenWFE.xml_encode(workitem)
+        #sXml = OpenWFE.xml_encode(workitem)
+        sXml = OpenWFE::XmlCodec::encode workitem
 
         socket = TCPSocket.new(host, port)
         socket.puts "xmlCoder #{sXml.length}"

data/lib/openwfe/rest/xmlcodec.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: codec.rb 2865 2006-06-23 14:54:07Z jmettraux $
-#
 
 #
 # "hecho en Costa Rica"

data/lib/openwfe/rudefinitions.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
 #
 # "made in Japan"
@@ -69,21 +67,6 @@ module OpenWFE
 
     DEFAULT_WORK_DIRECTORY = 'work'
 
-    #
-    # Returns the work directory for the OpenWFE[ru] application context
-    # (if any).
-    #
-    def OpenWFE.get_work_directory (dir=nil)
-
-        dir = DEFAULT_WORK_DIRECTORY unless @application_context
-        dir = @application_context[:work_directory] unless dir
-        dir = DEFAULT_WORK_DIRECTORY unless dir
-
-        FileUtils.makedirs(dir) unless File.exist?(dir)
-
-        dir
-    end
-
     #
     # A mixin for easy OpenWFE service lookup
     # (assumes the presence of an application context instance var)

data/lib/openwfe/storage/yamlfilestorage.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
 #
 # "made in Japan"
@@ -50,17 +48,15 @@ require 'openwfe/service'
 
 require 'openwfe/expressions/flowexpression'
 require 'openwfe/expressions/raw_xml'
-
-    #
+    #--
     # making sure classes in those files are loaded
     # before their yaml persistence is tuned
     # (else the reopening of the class is interpreted as
     # a definition of the class...)
+    #++
 
 module OpenWFE
   
-
-  
     #
     # Stores OpenWFEru related objects into yaml encoded files.
     # This storage is meant to look and feel like a Hash.
@@ -76,8 +72,7 @@ module OpenWFE
 
             service_init(service_name, application_context)
 
-            @basepath = path
-            #@basepath = OpenWFE::clean_path(@basepath) 
+            @basepath = get_work_directory + path
             @basepath += "/" unless @basepath[-1, 1] == "/"
 
             FileUtils.makedirs @basepath 

data/lib/openwfe/util/observable.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: definitions.rb 2725 2006-06-02 13:26:32Z jmettraux $
-#
 
 #
 # "made in Japan"
@@ -55,9 +53,13 @@ module OpenWFE
         #
         # An observer is an instance which responds to call(channel, *args)
         #
+        # Returns the observer object (or the block's Proc object), could
+        # be useful when removing the observer.
+        #
         def add_observer (channel, observer=nil, &callback)
             observer = callback unless observer
             (@observers[channel] ||= []) << observer
+            observer
         end
 
         #

data/lib/openwfe/util/otime.rb

@@ -51,7 +51,8 @@ module OpenWFE
     # Returns the current time as an ISO date string
     #
     def OpenWFE.now ()
-        return to_iso8601_date(Time.new())
+
+        to_iso8601_date(Time.new())
     end
 
     def OpenWFE.to_iso8601_date (date)
@@ -67,7 +68,7 @@ module OpenWFE
         s = date.to_s # this is costly
         s[10] = " "
 
-        return s
+        s
     end
 
     #
@@ -89,7 +90,7 @@ module OpenWFE
     #
     def OpenWFE.to_ruby_time (iso_date)
 
-        return DateTime.parse(iso_date)
+        DateTime.parse(iso_date)
     end
 
     #def OpenWFE.parse_date (date)
@@ -102,7 +103,7 @@ module OpenWFE
 
         t = Time.new()
         t = t.to_f * 1000
-        return t.to_i
+        t.to_i
     end
 
     #
@@ -154,7 +155,7 @@ module OpenWFE
             result = result + (value * multiplier)
         end
 
-        return result
+        result
     end
 
     #
@@ -163,7 +164,7 @@ module OpenWFE
     def OpenWFE.is_digit? (c)
         return false if not c.kind_of?(String)
         return false if c.length > 1
-        return (c >= "0" and c <= "9")
+        (c >= "0" and c <= "9")
     end
 
     #
@@ -185,7 +186,7 @@ module OpenWFE
 
         begin
 
-            return DateTime.new(
+            DateTime.new(
                 time.year, 
                 time.month, 
                 time.day, 
@@ -204,7 +205,7 @@ module OpenWFE
             #    "\n....y:#{time.year} M:#{time.month} d:#{time.day} "+
             #    "h:#{time.hour} m:#{time.min} s:#{s} o:#{o}"
 
-            return DateTime.new(
+            DateTime.new(
                 time.year, 
                 time.month, 
                 time.day, 
@@ -223,7 +224,7 @@ module OpenWFE
         to_ttime(dtime.new_offset(DateTime.now.offset-offset), :local)
     end
 
-    def to_ttime (d, method)
+    def OpenWFE.to_ttime (d, method)
         usec = (d.sec_fraction * 3600 * 24 * (10**6)).to_i
         Time.send(method, d.year, d.month, d.day, d.hour, d.min, d.sec, usec)
     end

data/lib/openwfe/util/safe.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: utils.rb 3454 2006-10-08 16:51:00Z jmettraux $
-#
 
 #
 # "made in Japan"
@@ -39,13 +37,12 @@
 # john.mettraux@openwfe.org
 #
 
-#require 'tmpdir'
 require 'open-uri'
 
 
 module OpenWFE
 
-    #
+    #--
     # Runs some remote code (uri) at a different $SAFE level.
     #
     #def OpenWFE.load_safely (uri, safe_level)
@@ -56,7 +53,7 @@ module OpenWFE
     #    source << open(uri).read
     #    load_eval_safely(source, safe_level)
     #end
-
+    #
     #
     # Makes sure that a piece of Ruby code is run at certain safe level.
     # Saves in a temp file that is reloaded in its own anonymous namespace.
@@ -80,6 +77,7 @@ module OpenWFE
     #        # ignore
     #    end
     #end
+    #++
 
     #
     # Runs some code within an instance's realm at a certain safety level.
@@ -149,7 +147,12 @@ module OpenWFE
 
     protected
 
-    def on_jruby?
+    #
+    # Returns true if the JRUBY_VERSION is defined.
+    # (beware : something else than JRuby may have defined it).
+    #
+    def OpenWFE.on_jruby?
+
         defined?(JRUBY_VERSION) != nil
     end
     

data/lib/openwfe/util/scheduler.rb

@@ -104,14 +104,31 @@ module OpenWFE
     # This attribute is best used indirectly : the method 
     # join_until_no_more_jobs() wraps it.
     #
+    # Since OpenWFEru 0.9.13, the :scheduler_precision can be set when
+    # instantiating the scheduler.
+    #
+    #     scheduler = OpenWFE::Scheduler.new(:scheduler_precision => 0.500)
+    #     scheduler.start
+    #         #
+    #         # instatiates a scheduler that checks its jobs twice per second
+    #         # (the default is 4 times per second (0.250))
+    #
     class Scheduler
         include MonitorMixin
 
-        attr_accessor \
-            :precision,
-            :exit_when_no_more_jobs
+        #
+        # By default, the precision is 0.250, with means the scheduler
+        # will check for jobs to execute 4 times per second.
+        #
+        attr_accessor :precision
+
+        #
+        # As its name implies.
+        #
+        attr_accessor :stopped
+
 
-        def initialize
+        def initialize (params={})
 
             super()
 
@@ -121,15 +138,19 @@ module OpenWFE
             @scheduler_thread = nil
 
             @precision = 0.250
-                #
-                # every 250ms, the scheduler wakes up
+                # every 250ms, the scheduler wakes up (default value)
+            begin
+                @precision = Float(params[:scheduler_precision])
+            rescue Exception => e
+                # let precision at its default value
+            end
 
             @exit_when_no_more_jobs = false
             @dont_reschedule_every = false
 
             @last_cron_minute = -1
 
-            @stopped = false
+            @stopped = true
         end
 
         #
@@ -137,6 +158,8 @@ module OpenWFE
         #
         def sstart
 
+            @stopped = false
+
             @scheduler_thread = Thread.new do
 
                 if defined?(JRUBY_VERSION)
@@ -189,6 +212,21 @@ module OpenWFE
         # Schedules a job by specifying at which time it should trigger.
         # Returns the a job_id that can be used to unschedule the job.
         #
+        # This method returns a job identifier which can be used to unschedule()
+        # the job.
+        #
+        # If the job is specified in the past, it will be triggered immediately
+        # but not scheduled.
+        # To avoid the triggering, the parameter :discard_past may be set to 
+        # true :
+        #
+        #     jobid = scheduler.schedule_at(yesterday, :discard_past => true) do
+        #         puts "you'll never read this message"
+        #     end
+        #
+        # And 'jobid' will hold a nil (not scheduled).
+        #     
+        #
         def schedule_at (at, params={}, &block)
 
             params = prepare_params(params)
@@ -201,6 +239,9 @@ module OpenWFE
         # Schedules a job by stating in how much time it should trigger.
         # Returns the a job_id that can be used to unschedule the job.
         #
+        # This method returns a job identifier which can be used to unschedule()
+        # the job.
+        #
         def schedule_in (duration, params={}, &block)
 
             duration = duration_to_f(duration)
@@ -223,6 +264,9 @@ module OpenWFE
         #         end
         #     end
         #
+        # This method returns a job identifier which can be used to unschedule()
+        # the job.
+        #
         def schedule_every (freq, params={}, &block)
 
             f = duration_to_f freq
@@ -282,7 +326,7 @@ module OpenWFE
         #
         # Schedules a cron job, the 'cron_line' is a string
         # following the Unix cron standard (see "man 5 crontab" in your command 
-        # line).
+        # line, or http://www.google.com/search?q=man%205%20crontab).
         #
         # For example :
         #
@@ -301,6 +345,9 @@ module OpenWFE
         # Returns the job id attributed to this 'cron job', this id can
         # be used to unschedule the job.
         #
+        # This method returns a job identifier which can be used to unschedule()
+        # the job.
+        #
         def schedule (cron_line, params={}, &block)
             synchronize do
 
@@ -401,6 +448,10 @@ module OpenWFE
                 params
             end
 
+            #
+            # The core method behind schedule_at and schedule_in (and also
+            # schedule_every). It's protected, don't use it directly.
+            #
             def sschedule_at (at, params={}, &block)
                 synchronize do
 
@@ -431,7 +482,7 @@ module OpenWFE
                     unschedule(job_id) if job_id 
 
                     if at < (Time.new.to_f + @precision)
-                        job.trigger()
+                        job.trigger() unless params[:discard_past]
                         return nil
                     end
 

data/lib/openwfe/util/schedulers.rb

@@ -54,7 +54,7 @@ module OpenWFE
 
         def initialize (service_name, application_context)
 
-            super()
+            super(application_context)
 
             service_init(service_name, application_context)
 

data/lib/openwfe/util/workqueue.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id$
-#
 
 #
 # "made in Japan"
@@ -150,7 +148,6 @@ module OpenWFE
                     # do_process_workelement method
             end
 
-            #
             # TODO : have a pool of workers handle that
 
             #q.size

data/lib/openwfe/utils.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: utils.rb 3454 2006-10-08 16:51:00Z jmettraux $
-#
 
 #
 # "hecho en Costa Rica" and "made in Japan"
@@ -56,10 +54,6 @@ module OpenWFE
 
         return xmlElt.elements[1] if not elementName
 
-        #xmlElt.elements.each do |elt|
-        #    return elt if elt.name == elementName
-        #end
-        #return nil
         xmlElt.elements.detect { |elt| elt.name == elementName }
     end
 
@@ -199,10 +193,32 @@ module OpenWFE
     # No exception is thrown by this method.
     #
     def OpenWFE.parse_uri (string)
+
         begin
             return URI::parse(string)
         rescue Exception => e
         end
+
+        nil
+    end
+
+    #
+    # Returns a URI instance if the given ref is a http, https, file or ftp
+    # URI. Returns nil else.
+    # The sister method parse_uri() is OK with things like mailto:, gopher:, ...
+    #
+    def OpenWFE.parse_known_uri (ref)
+
+        uri = OpenWFE::parse_uri(ref.to_s)
+
+        return nil unless uri
+
+        return uri if uri.scheme == "file"
+        return uri if uri.scheme == "http"
+        return uri if uri.scheme == "https"
+        return uri if uri.scheme == "ftp"
+            # what else ...
+
         nil
     end
 
@@ -378,7 +394,7 @@ module OpenWFE
 
         return nil unless value
 
-        return lookup_attribute(value, rest)
+        lookup_attribute(value, rest)
     end
 
     #
@@ -388,7 +404,7 @@ module OpenWFE
 
         key, rest = pop_key(key)
 
-        if not rest
+        unless rest
 
             return container.has_key?(key) \
                 if container.respond_to?(:has_key?)
@@ -396,7 +412,7 @@ module OpenWFE
             return false
         end
 
-        return has_attribute?(rest, key)
+        has_attribute?(rest, key)
     end
 
     #
@@ -448,14 +464,14 @@ module OpenWFE
         def pop_key (key)
             i = key.index(".")
             return narrow(key), nil unless i
-            return narrow(key[0..i-1]), key[i+1..-1]
+            [ narrow(key[0..i-1]), key[i+1..-1] ]
         end
 
         def narrow (key)
             return 0 if key == "0"
             i = key.to_i
             return i if i != 0
-            return key
+            key
         end
     
 end

data/lib/openwfe/version.rb

@@ -34,5 +34,5 @@
 #
 
 module OpenWFE
-    OPENWFERU_VERSION = '0.9.12'
+    OPENWFERU_VERSION = '0.9.12.863'
 end

data/lib/openwfe/workitem.rb

@@ -30,8 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-# $Id: workitem.rb 3556 2006-11-13 04:15:52Z jmettraux $
-#
 
 #
 # "hecho en Costa Rica"
@@ -351,11 +349,39 @@ module OpenWFE
         alias :wfdurl= :workflow_definition_url=
 
         #
-        # This constructor will build an empty launchitem.
+        # This constructor will build an empty LaunchItem.
+        #
         # If the optional parameter process_definition is set, the
         # definition will be embedded in the launchitem attributes
         # for retrieval by the engine.
         #
+        # There are several ways to specify the process definition.
+        # Here are some examples:
+        #
+        #   # Use a Ruby class that extends OpenWFE::ProcessDefinition
+        #   LaunchItem.new(MyProcessDefinition)
+        #
+        #   # Provide an XML process definition as a string
+        #   definition = """
+        #     <process-definition name="x" revision="y">
+        #       <sequence>
+        #         <participant ref="alpha" />
+        #         <participant ref="bravo" />
+        #       </sequence>
+        #     </process-definition>
+        #   """.strip
+        #   LaunchItem.new(definition)
+        #
+        #   # Load an XML process definition from a local file
+        #   require 'uri'
+        #   LaunchItem.new(URI.new("file:///tmp/my_process_definition.xml"))
+        #
+        #   # If you initialized your engine with 
+        #   # {:remote_definitions_allowed => true}, then you can also load an
+        #   # XML process definition from a remote url
+        #   require 'uri'
+        #   LaunchItem.new(URI.new("http://foo.bar/my_process_definition.xml"))
+        #
         def initialize (process_definition=nil)
 
             super()

data/lib/openwfe/worklist/storeparticipant.rb

@@ -30,7 +30,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #++
 #
-#
 
 #
 # "made in Japan"
@@ -40,7 +39,6 @@
 
 require 'openwfe/utils'
 require 'openwfe/omixins'
-require 'openwfe/rudefinitions'
 require 'openwfe/storage/yamlfilestorage'
 require 'openwfe/participants/participant'
 
@@ -233,13 +231,11 @@ module OpenWFE
         #
         def initialize (dirname, application_context)
 
-            workdir = OpenWFE::get_work_directory
-
             @dirname = OpenWFE::ensure_for_filename(dirname.to_s)
 
             service_name = self.class.name + "__" + @dirname
 
-            path = workdir + "/participants/" + @dirname
+            path = "/participants/" + @dirname
 
             super(service_name, application_context, path)
         end

data/test/console_test.rb

@@ -4,10 +4,7 @@ b = 2
 
 require 'openwfe/util/irb'
 
-#trap 'INT' do
-#    OpenWFE::start_irb_session binding()
-#end
-OpenWFE::bind_console(binding())
+OpenWFE::trap_int_irb(binding())
 
 sleep(30)
 

data/test/file_persisted_engine_test.rb

@@ -0,0 +1,64 @@
+#
+#--
+# Copyright (c) 2007, Urbacon Ltd.
+# 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.
+#++
+#
+#
+
+#
+# "made in Canada"
+#
+# Matt Zukowski at roughest.net
+# John Mettraux at openwfe.org
+#
+
+require 'test/unit'
+
+require 'fileutils'
+
+require 'openwfe/engine/file_persisted_engine'
+
+# Tests to assert correct functionality of the FilePersistedEngine.
+class FilePersistedEngineTest < Test::Unit::TestCase
+  
+  # Test to make sure that persistence data is stored in the specified 
+  # working directory.
+  def test_custom_working_directory
+    workdir = "test_custom_working_directory-#{Time.now.to_i}-#{rand(99999)}"
+    FileUtils.rm_rf(workdir) if File.exists?(workdir)
+    
+    engine = FilePersistedEngine.new(:work_directory => workdir)
+    
+    assert File.exists?(workdir),
+      "Custom working directory '#{workdir}' was not created by #{engine.class} during testing!"
+      
+    FileUtils.rm_rf(workdir)
+  end
+end