reliable-msg 1.0.1 → 1.1.0

data/test/test-queue.rb

@@ -1,8 +1,8 @@
 #
-# = test-queue.rb - Queue manager test cases
+# = test-queue.rb - Queue API test cases
 #
 # Author:: Assaf Arkin  assaf@labnotes.org
-# Documentation:: http://trac.labnotes.org/cgi-bin/trac.cgi/wiki/RubyReliableMessaging
+# Documentation:: http://trac.labnotes.org/cgi-bin/trac.cgi/wiki/Ruby/ReliableMessaging
 # Copyright:: Copyright (c) 2005 Assaf Arkin
 # License:: MIT and/or Creative Commons Attribution-ShareAlike
 #
@@ -84,8 +84,12 @@ class TestQueue < Test::Unit::TestCase
         restart.call if restart
         msg = @queue.get(ReliableMsg::Queue.selector { name == 'bar' })
         assert msg && msg.id == id2, "Failed to retrieve message by selector"
+        msg = @queue.get(ReliableMsg::Queue.selector { name == 'baz' })
+        assert msg.nil?, "Retrieved non-existent message" # Tests reloading selector
         msg = @queue.get(ReliableMsg::Queue.selector { name == 'foo' })
         assert msg && msg.id == id1, "Failed to retrieve message by selector"
+        msg = @queue.get(ReliableMsg::Queue.selector { name == 'baz' })
+        assert msg.nil?, "Retrieved non-existent message" # Tests reloading selector
         assert @queue.get.nil?, "Phantom message in queue"
     end
 
@@ -113,7 +117,7 @@ class TestQueue < Test::Unit::TestCase
 
         # Test that we can receive message more than once, but once we try more than
         # max_deliveries, the message moves to the DLQ.
-        id1 = @queue.put 'test message', :max_retries=>1, :delivery=>:repeated
+        id1 = @queue.put 'test message', :max_deliveries=>2, :delivery=>:repeated
         restart.call if restart
         begin
             @queue.get do |msg|
@@ -136,7 +140,7 @@ class TestQueue < Test::Unit::TestCase
         assert msg && msg.id == id1, "Message not moved to DLQ"
 
         # Test that message discarded when delivery mode is best_effort.
-        id1 = @queue.put 'test message', :max_retries=>0, :delivery=>:best_effort
+        id1 = @queue.put 'test message', :max_deliveries=>1, :delivery=>:best_effort
         restart.call if restart
         begin
             @queue.get do |msg|
@@ -150,7 +154,7 @@ class TestQueue < Test::Unit::TestCase
         assert @dlq.get.nil?, "Message incorrectly moved to DLQ"
 
         # Test that message is moved to DLQ when delivery mode is exactly_once.
-        id1 = @queue.put 'test message', :max_retries=>2, :delivery=>:once
+        id1 = @queue.put 'test message', :max_deliveries=>2, :delivery=>:once
         restart.call if restart
         begin
             @queue.get do |msg|
@@ -166,6 +170,32 @@ class TestQueue < Test::Unit::TestCase
         assert msg && msg.id == id1, "Message not moved to DLQ"
     end
 
+
+    def test_backout
+        @queue.put "backout test", :delivery=>:repeated
+        backout = [ 1, 2, 3, 4 ]
+        redelivery = nil
+        done = false
+        while !done
+            selector = ReliableMsg::Queue::selector { redelivery.nil? || backout[redelivery - 1] + created <= now }
+            begin
+                more = @queue.get selector do |msg|
+                    assert redelivery == msg.headers[:redelivery], "Unexpected redelivery header"
+                    redelivery = (redelivery || 0) + 1
+                    raise "Reject message"
+                    true
+                end
+            rescue Exception=>error
+                assert error.message == "Reject message", "Unexpected ... exception"
+                more = true
+            end while more
+            while msg = @dlq.get
+                done = true
+            end
+            sleep 2
+        end
+    end
+
 private
     def clear complain
         # Empty test queue and DLQ.

data/test/test-rails.rb

@@ -0,0 +1,59 @@
+#
+# = test-rails.rb - Rails integration test cases
+#
+# Author:: Assaf Arkin  assaf@labnotes.org
+# Documentation:: http://trac.labnotes.org/cgi-bin/trac.cgi/wiki/Ruby/ReliableMessaging
+# Copyright:: Copyright (c) 2005 Assaf Arkin
+# License:: MIT and/or Creative Commons Attribution-ShareAlike
+#
+#--
+#++
+
+require 'test/unit'
+require 'reliable-msg'
+
+class TestRails < Test::Unit::TestCase
+
+    begin
+        class TestController < ActionController::Base
+            queue :queue1
+            queue :queue2, "queue2"
+            queue "queue3"
+
+            topic :topic1
+            topic :topic2, "topic2"
+            topic "topic3"
+        end
+
+
+        def setup
+            @controller = TestController.new
+        end
+
+        def test_queue
+            queue = @controller.queue1
+            assert queue.instance_of?(ReliableMsg::Queue) && queue.name == "queue1", "Queue1 not set propertly"
+            queue = @controller.queue2
+            assert queue.instance_of?(ReliableMsg::Queue) && queue.name == "queue2", "Queue2 not set propertly"
+            queue = @controller.queue
+            assert queue.instance_of?(ReliableMsg::Queue) && queue.name == "queue3", "Queue3 not set propertly"
+        end
+
+        def test_topic
+            topic = @controller.topic1
+            assert topic.instance_of?(ReliableMsg::Topic) && topic.name == "topic1", "Topic1 not set propertly"
+            topic = @controller.topic2
+            assert topic.instance_of?(ReliableMsg::Topic) && topic.name == "topic2", "Topic2 not set propertly"
+            topic = @controller.topic
+            assert topic.instance_of?(ReliableMsg::Topic) && topic.name == "topic3", "Topic3 not set propertly"
+        end
+    rescue NameError => error
+        raise error unless error.name == :ActionController
+
+        def test_nothing
+            puts "ActionController not found: Rails integration test not run"
+        end
+    end
+
+end
+

data/test/test-topic.rb

@@ -0,0 +1,102 @@
+#
+# = test-topic.rb - Topic API test cases
+#
+# Author:: Assaf Arkin  assaf@labnotes.org
+# Documentation:: http://trac.labnotes.org/cgi-bin/trac.cgi/wiki/Ruby/ReliableMessaging
+# Copyright:: Copyright (c) 2005 Assaf Arkin
+# License:: MIT and/or Creative Commons Attribution-ShareAlike
+#
+#--
+#++
+
+require 'test/unit'
+require 'reliable-msg'
+
+class TestTopic < Test::Unit::TestCase
+
+    class AbortTransaction < Exception
+    end
+
+    def setup
+        @topic = ReliableMsg::Topic.new 'test-topic'
+        @manager = ReliableMsg::QueueManager.new
+        @manager.start
+        @restart = proc do
+            @manager.stop
+            @manager.start
+        end
+    end
+
+    def teardown
+        @manager.stop
+    end
+
+    def test_single
+        # Run test case without restrating queue manager (from cache).
+        _test_single
+        # Run test case by restarting queue manager (test recovery).
+        _test_single @restart
+    end
+
+    def _test_single restart = nil
+        # Put one message, check that we can retrieve it. Check that we
+        # can only retrieve it once. Then put another message, repeat.
+        msg1 = UUID.new
+        msg2 = UUID.new
+        @topic.put msg1
+        restart.call if restart
+        msg = @topic.get
+        assert msg && msg.object == msg1, "Failed to retrieve last message on topic"
+        assert @topic.get.nil?, "Retrieved last message on topic twice"
+        @topic.put msg2
+        restart.call if restart
+        msg = @topic.get
+        assert msg && msg.object == msg2, "Failed to retrieve last message on topic"
+        assert @topic.get.nil?, "Retrieved last message on topic twice"
+        # Test that someone else can retrieve the message.
+        new_topic = ReliableMsg::Topic.new @topic.name
+        msg = new_topic.get
+        assert msg && msg.object == msg2, "Failed to retrieve last message on topic"
+    end
+
+    def test_selector
+        # Run test case without restrating queue manager (from cache).
+        _test_selector
+        # Run test case by restarting queue manager (test recovery).
+        _test_selector @restart
+    end
+
+    def _test_selector restart = nil
+        msg1 = UUID.new
+        @topic.put msg1, :name=>"foo"
+        restart.call if restart
+        msg = @topic.get(ReliableMsg::Queue.selector { name == 'bar' })
+        assert msg.nil?, "Retrieve message with non-matching selector"
+        msg = @topic.get(ReliableMsg::Queue.selector { name == 'foo' })
+        assert msg && msg.object == msg1, "Failed to retrieve message with selector"
+    end
+
+    def test_non_expires
+        # Run test case without restrating queue manager (from cache).
+        _test_non_expires
+        # Run test case by restarting queue manager (test recovery).
+        _test_non_expires @restart
+    end
+
+    def _test_non_expires restart = nil
+        # Test that we can receive message that has not yet expired (30 second delay),
+        # but cannot receive message that has expires (1 second, we wait for 2).
+        msg1 = UUID.new
+        msg2 = UUID.new
+        @topic.put msg1, :expires=>30
+        restart.call if restart
+        msg = @topic.get
+        assert msg && msg.object == msg1, "Failed to retrieve message"
+        @topic.put msg2, :expires=>1
+        restart.call if restart
+        sleep 2
+        msg = @topic.get
+        assert msg.nil?, "Incorrectly retrieved expired message"
+    end
+end
+

metadata

@@ -1,63 +1,76 @@
-!ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.3
 specification_version: 1
 name: reliable-msg
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
-date: 2005-11-11 00:00:00 -08:00
+  version: 1.1.0
+date: 2005-11-26
 summary: Reliable messaging and persistent queues for building asynchronous applications in Ruby
 require_paths: 
-- lib
+  - lib
 email: assaf@labnotes.org
-homepage: http://trac.labnotes.org/cgi-bin/trac.cgi/wiki/RubyReliableMessaging
-rubyforge_project: 
-description: This package provides reliable messaging and persistent queues for building asynchronous applications in Ruby.  It supports transaction processing, message selectors, priorities, delivery semantics, remote queue managers, disk-based and MySQL message stores and more.
+homepage: http://trac.labnotes.org/cgi-bin/trac.cgi/wiki/Ruby/ReliableMessaging
+rubyforge_project: reliable-msg
+description: "This package provides reliable messaging and persistent queues for building
+  asynchronous applications in Ruby.  It supports transaction processing, message
+  selectors, priorities, delivery semantics, remote queue managers, disk-based and
+  MySQL message stores and more."
 autorequire: reliable-msg.rb
 default_executable: queues
 bindir: bin
 has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
+    - 
+      - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
   version: 
 platform: ruby
-signing_key: 
-cert_chain: 
 authors: 
-- Assaf Arkin
+  - Assaf Arkin
 files: 
-- bin/queues
-- test/test-queue.rb
-- test/test-uuid.rb
-- lib/reliable-msg
-- lib/reliable-msg.rb
-- lib/uuid.rb
-- lib/reliable-msg/cli.rb
-- lib/reliable-msg/message-store.rb
-- lib/reliable-msg/mysql.sql
-- lib/reliable-msg/queue-manager.rb
-- lib/reliable-msg/queue.rb
-- lib/reliable-msg/selector.rb
-- README
-- MIT-LICENSE
-- Rakefile
+  - bin/queues
+  - test/test-queue.rb
+  - test/test-rails.rb
+  - test/test-topic.rb
+  - lib/reliable-msg
+  - lib/reliable-msg.rb
+  - lib/reliable-msg/cli.rb
+  - lib/reliable-msg/client.rb
+  - lib/reliable-msg/message-store.rb
+  - lib/reliable-msg/mysql.sql
+  - lib/reliable-msg/queue-manager.rb
+  - lib/reliable-msg/queue.rb
+  - lib/reliable-msg/rails.rb
+  - lib/reliable-msg/selector.rb
+  - lib/reliable-msg/topic.rb
+  - README
+  - MIT-LICENSE
+  - Rakefile
+  - changelog.txt
 test_files: []
-
 rdoc_options: 
-- --main
-- README
-- --title
-- Reliable Messaging for Ruby
-- --line-numbers
+  - "--main"
+  - README
+  - "--title"
+  - Reliable Messaging for Ruby
+  - "--line-numbers"
 extra_rdoc_files: 
-- README
+  - README
 executables: 
-- queues
+  - queues
 extensions: []
-
 requirements: 
-- MySQL for database store, otherwise uses the file system
-dependencies: []
-
+  - "MySQL for database store, otherwise uses the file system"
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: uuid
+    version_requirement: 
+    version_requirements: !ruby/object:Gem::Version::Requirement 
+      requirements: 
+        - 
+          - ">="
+          - !ruby/object:Gem::Version 
+            version: 1.0.0
+      version: 

data/lib/uuid.rb

@@ -1,384 +0,0 @@
-#
-# = uuid.rb - UUID generator
-#
-# Author:: Assaf Arkin  assaf@labnotes.org
-# Documentation:: http://trac.labnotes.org/cgi-bin/trac.cgi/wiki/RubyReliableMessaging
-# Copyright:: Copyright (c) 2005 Assaf Arkin
-# License:: MIT and/or Creative Commons Attribution-ShareAlike
-#
-#--
-# Changes:
-#   11/07/05 -- Incorporated into reliable-msg package
-#++
-
-
-require 'thread'
-require 'yaml'
-require 'singleton'
-require 'logger'
-
-
-
-# == Generating UUIDs
-#
-# Call UUID.new to generate and return a new UUID. The method returns a string in one of three
-# formats. The default format is 36 characters long, and contains the 32 hexadecimal octets and
-# hyphens separating the various value parts. The <tt>:compact</tt> format omits the hyphens,
-# while the <tt>:urn</tt> format adds the <tt>:urn:uuid</tt> prefix.
-#
-# For example:
-#  10.times do
-#    p UUID.new
-#  end
-#
-# ---
-# == UUIDs in Brief
-#
-# UUID (universally unique identifier) are guaranteed to be unique across time and space.
-#
-# A UUID is 128 bit long, and consists of a 60-bit time value, a 16-bit sequence number and
-# a 48-bit node identifier.
-#
-# The time value is taken from the system clock, and is monotonically incrementing. However,
-# since it is possible to set the system clock backward, a sequence number is added. The
-# sequence number is incremented each time the UUID generator is started. The combination
-# guarantees that identifiers created on the same machine are unique with a high degree of
-# probability.
-#
-# Note that due to the structure of the UUID and the use of sequence number, there is no
-# guarantee that UUID values themselves are monotonically incrementing. The UUID value
-# cannot itself be used to sort based on order of creation.
-#
-# To guarantee that UUIDs are unique across all machines in the network, use the IEEE 802
-# MAC address of the machine's network interface card as the node identifier. Network interface
-# cards have unique MAC address that are 47-bit long (the last bit acts as a broadcast flag).
-# Use +ipconfig+ (Windows), or +ifconfig+ (Unix) to find the MAC address (aka physical address)
-# of a network card. It takes the form of six pairs of hexadecimal digits, separated by hypen or
-# colon, e.g. '<tt>08-0E-46-21-4B-35</tt>'
-#
-# For more information see {RFC 4122}[http://www.ietf.org/rfc/rfc4122.txt].
-#
-# == Configuring the UUID generator
-#
-# The UUID generator requires a state file which maintains the MAC address and next sequence
-# number to use. By default, the UUID generator will use the file <tt>uuid.state</tt> contained
-# in the current directory, or in the installation directory.
-#
-# Use UUID.config to specify a different location for the UUID state file. If the UUID state file
-# does not exist, you can create one manually, or use UUID.config with the options <tt>:sequence</tt>
-# and <tt>:mac_addr</tt>.
-#
-# A UUID state file looks like:
-#   ---
-#   last_clock: "0x28227f76122d80"
-#   mac_addr: 08-0E-46-21-4B-35
-#   sequence: "0x1639"
-#
-#
-#--
-# === Time-based UUID
-#
-# The UUID specification prescribes the following format for representing UUIDs. Four octets encode
-# the low field of the time stamp, two octects encode the middle field of the timestamp, and two
-# octets encode the high field of the timestamp with the version number. Two octets encode the
-# clock sequence number and six octets encode the unique node identifier.
-#
-# The timestamp is a 60 bit value holding UTC time as a count of 100 nanosecond intervals since
-# October 15, 1582. UUIDs generated in this manner are guaranteed not to roll over until 3400 AD.
-#
-# The clock sequence is used to help avoid duplicates that could arise when the clock is set backward
-# in time or if the node ID changes. Although the system clock is guaranteed to be monotonic, the
-# system clock is not guaranteed to be monotonic across system failures. The UUID cannot be sure
-# that no UUIDs were generated with timestamps larger than the current timestamp.
-#
-# If the clock sequence can be determined at initialization, it is incremented by one. The clock sequence
-# MUST be originally (i.e. once in the lifetime of a system) initialized to a random number to minimize the
-# correlation across systems. The initial value must not be correlated to the node identifier.
-#
-# The node identifier must be unique for each UUID generator. This is accomplished using the IEEE 802
-# network card address. For systems with multiple IEEE 802 addresses, any available address can be used.
-# For systems with no IEEE address, a 47 bit random value is used and the multicast bit is set so it will
-# never conflict with addresses obtained from network cards.
-#
-# === UUID state file
-#
-# The UUID state is contained in the UUID state file. The file name can be specified when configuring
-# the UUID generator with UUID.config. The default is to use the file +uuid.state+ in the current directory,
-# or the installation directory.
-#
-# The UUID state file is read once when the UUID generator is first used (or configured). The sequence
-# number contained in the UUID is read and used, and the state file is updated to the next sequence
-# number. The MAC address is also read from the state file. The current clock time (in 100ns resolution)
-# is stored in the state file whenever the sequence number is updated, but is never read.
-#
-# If the UUID generator detects that the system clock has been moved backwards, it will obtain a new
-# sequence in the same manner. So it is possible that the UUID state file will be updated while the
-# application is running.
-#++
-module UUID
-
-    PACKAGE = "uuid" #:nodoc:
-
-    # Default state file.
-    STATE_FILE = "uuid.state"
-
-    # Clock multiplier. Converts Time (resolution: seconds) to UUID clock (resolution: 10ns)
-    CLOCK_MULTIPLIER = 10000000 #:nodoc:
-
-    # Clock gap is the number of ticks (resolution: 10ns) between two Ruby Time ticks.
-    CLOCK_GAPS = 100000 #:nodoc:
-
-    # Version number stamped into the UUID to identify it as time-based.
-    VERSION_CLOCK = 0x0100 #:nodoc:
-
-    # Formats supported by the UUID generator.
-    FORMATS = {:compact=>"%08x%04x%04x%04x%012x", :default=>"%08x-%04x-%04x-%04x-%012x", :urn=>"urn:uuid:%08x-%04x-%04x-%04x-%012x"} #:nodoc:
-
-    # Length (in characters) of UUIDs generated for each of the formats.
-    FORMATS_LENGTHS = {:compact=>32, :default=>36, :urn=>45} #:nodoc:
-
-    ERROR_INVALID_SEQUENCE = "Invalid sequence number: found '%s', expected 4 hexdecimal digits" #:nodoc:
-
-    ERROR_NOT_A_SEQUENCE = "Not a sequence number: expected integer between 0 and 0xFFFF" #:nodoc:
-
-    ERROR_INVALID_MAC_ADDR = "Invalid MAC address: found '%s', expected a number in the format XX-XX-XX-XX-XX-XX" #:nodoc:
-
-    INFO_INITIALIZED = "Initialized UUID generator with sequence number 0x%04x and MAC address %s" #:nodoc:
-
-    ERROR_INITIALIZED_RANDOM_1 = "Initialized UUID generator with random sequence number/MAC address." #:nodoc:
-
-    ERROR_INITIALIZED_RANDOM_2 = "UUIDs are not guaranteed to be unique. Please create a uuid.state file as soon as possible." #:nodoc:
-
-    IFCONFIG_PATTERN = /[^:\-](?:[0-9A-Za-z][0-9A-Za-z][:\-]){5}[0-9A-Za-z][0-9A-Za-z][^:\-]/ #:nodoc:
-
-    @@mutex = Mutex.new
-    @@last_clock = @@logger = @@state_file = nil
-
-    # Generates and returns a new UUID string.
-    #
-    # The argument +format+ specifies which formatting template to use:
-    # * <tt>:default</tt> -- Produces 36 characters, including hyphens separating the UUID value parts
-    # * <tt>:compact</tt> -- Produces a 32 digits (hexadecimal) value with no hyphens
-    # * <tt>:urn</tt> -- Aadds the prefix <tt>urn:uuid:</tt> to the <tt>:default</tt> format
-    #
-    # For example:
-    #  print UUID.new :default
-    # or just
-    #  print UUID.new
-    #
-    # :call-seq:
-    #   UUID.new([format])  -> string
-    #
-    def new format = nil
-        # Determine which format we're using for the UUID string.
-        template = FORMATS[format || :default] or
-            raise RuntimeError, "I don't know the format '#{format}'"
-
-        # The clock must be monotonically increasing. The clock resolution is at best 100 ns
-        # (UUID spec), but practically may be lower (on my setup, around 1ms). If this method
-        # is called too fast, we don't have a monotonically increasing clock, so the solution is
-        # to just wait.
-        # It is possible for the clock to be adjusted backwards, in which case we would end up
-        # blocking for a long time. When backward clock is detected, we prevent duplicates by
-        # asking for a new sequence number and continue with the new clock.
-        clock = @@mutex.synchronize do
-            # Initialize UUID generator if not already initialized. Uninitizlied UUID generator has no
-            # last known clock.
-            next_sequence unless @@last_clock
-            clock = (Time.new.to_f * CLOCK_MULTIPLIER).to_i & 0xFFFFFFFFFFFFFFF0
-            if clock > @@last_clock
-                @@drift = 0
-                @@last_clock = clock
-            elsif clock = @@last_clock
-                drift = @@drift += 1
-                if drift < 10000
-                    @@last_clock += 1
-                else
-                    Thread.pass
-                    nil
-                end
-            else
-                next_sequence
-                @@last_clock = clock
-            end
-        end while not clock
-        sprintf template, clock & 0xFFFFFFFF, (clock >> 32)& 0xFFFF, ((clock >> 48) & 0xFFFF | VERSION_CLOCK),
-            @@sequence & 0xFFFF, @@mac_hex & 0xFFFFFFFFFFFF
-    end
-
-    alias uuid new
-    module_function :uuid, :new
-
-    # Configures the UUID generator. Use this method to specify the UUID state file, logger, etc.
-    #
-    # The method accepts the following options:
-    # * <tt>:state_file</tt> -- Specifies the location of the state file. If missing, the default
-    #   is <tt>uuid.state</tt>
-    # * <tt>:logger<tt> -- The UUID generator will use this logger to report the state information (optional).
-    # * <tt>:sequence</tt> -- Specifies the sequence number (0 to 0xFFFF) to use. Required to
-    #   create a new state file, ignored if the state file already exists.
-    # * <tt>:mac_addr</tt> -- Specifies the MAC address (xx-xx-xx-xx-xx) to use. Required to
-    #   create a new state file, ignored if the state file already exists.
-    #
-    # For example, to create a new state file:
-    #  UUID.config :state_file=>'my-uuid.state', :sequence=>rand(0x10000), :mac_addr=>'0C-0E-35-41-60-65'
-    # To use an existing state file and log to +STDOUT+:
-    #  UUID.config :state_file=>'my-uuid.state', :logger=>Logger.new(STDOUT)
-    #
-    # :call-seq:
-    #   UUID.config(config)
-    #
-    def self.config options
-        options ||= {}
-        @@mutex.synchronize do
-            @@logger = options[:logger]
-            next_sequence options
-        end
-    end
-
-    # Create a uuid.state file by finding the IEEE 802 NIC MAC address for this machine.
-    # Works for UNIX (ifconfig) and Windows (ipconfig). Creates the uuid.state file in the
-    # installation directory (typically the GEM's lib).
-    def self.setup
-        file = File.expand_path(File.dirname(__FILE__))
-        file = File.basename(file) == 'lib' ? file = File.join(file, '..', STATE_FILE) : file = File.join(file, STATE_FILE)
-        file = File.expand_path(file)
-        if File.exist? file
-            puts "#{PACKAGE}: Found an existing UUID state file: #{file}"
-        else
-            puts "#{PACKAGE}: No UUID state file found, attempting to create one for you:"
-            # Run ifconfig for UNIX, or ipconfig for Windows.
-            config = ""
-            begin
-                Kernel.open "|ifconfig" do |input|
-                    input.each_line { |line| config << line }
-                end
-            rescue
-            end
-            begin
-                Kernel.open "|ipconfig /all" do |input|
-                    input.each_line { |line| config << line }
-                end
-            rescue
-            end
-
-            addresses = config.scan(IFCONFIG_PATTERN).collect { |addr| addr[1..-2] }
-            if addresses.empty?
-                puts "Could not find any IEEE 802 NIC MAC addresses for this machine."
-                puts "You need to create the uuid.state file manually."
-            else
-                puts "Found the following IEEE 802 NIC MAC addresses on your computer:"
-                addresses.each { |addr| puts "  #{addr}" }
-                puts "Selecting the first address #{addresses[0]} for use in your UUID state file."
-                File.open file, "w" do |output|
-                    output.puts "mac_addr: #{addresses[0]}"
-                    output.puts format("sequence: \"0x%04x\"", rand(0x10000))
-                end
-                puts "Created a new UUID state file: #{file}"
-            end
-        end
-        file
-    end
-
-private
-    def self.state plus_one = false
-        return nil unless @@sequence && @@mac_addr
-        {"sequence"=>sprintf("0x%04x", (plus_one ? @@sequence + 1 : @@sequence) & 0xFFFF), "last_clock"=>sprintf("0x%x", @@last_clock || (Time.new.to_f * CLOCK_MULTIPLIER).to_i),  "mac_addr" => @@mac_addr}
-    end
-
-    def self.next_sequence config = nil
-        # If called to advance the sequence number (config is nil), we have a state file that we're able to use.
-        # If called from configuration, use the specified or default state file.
-        state_file = (config && config[:state_file]) || @@state_file
-        unless state_file
-            state_file = if File.exist?(STATE_FILE)
-                STATE_FILE
-            else
-                file = File.expand_path(File.dirname(__FILE__))
-                file = File.basename(file) == 'lib' ? file = File.join(file, '..', STATE_FILE) : file = File.join(file, STATE_FILE)
-                setup unless File.exist?(file)
-            end
-        end
-        begin
-            File.open state_file, "r+" do |file|
-                # Lock the file for exclusive access, just to make sure it's not being read while we're
-                # updating its contents.
-                file.flock(File::LOCK_EX)
-                state = YAML::load file
-                # Get the sequence number. Must be a valid 16-bit hexadecimal value.
-                sequence = state['sequence']
-                if sequence
-                    raise RuntimeError, format(ERROR_INVALID_SEQUENCE, sequence) unless sequence.is_a?(String) and sequence =~ /[0-9a-fA-F]{4}/
-                    sequence = sequence.hex & 0xFFFF
-                else
-                    sequence = rand(0x10000)
-                end
-                # Get the MAC address. Must be 6 pairs of hexadecimal octets. Convert MAC address into
-                # a 48-bit value with the higher bit being zero.
-                mac_addr = state['mac_addr']
-                raise RuntimeError, format(ERROR_INVALID_MAC_ADDR, mac_addr) unless mac_addr.is_a?(String) and mac_addr =~ /([0-9a-fA-F]{2}[:\-]){5}[0-9a-fA-F]{2}/
-                mac_hex = mac_addr.scan(/[0-9a-fA-F]{2}/).join.hex & 0x7FFFFFFFFFFF
-
-                # If everything is OK, proceed to the next step. Grab the sequence number and store
-                # the new state. Start at beginning of file, and truncate file when done.
-                @@mac_addr, @@mac_hex, @@sequence, @@state_file = mac_addr, mac_hex, sequence, state_file
-                file.pos = 0
-                YAML::dump state(true), file
-                file.truncate file.pos
-            end
-            # Initialized.
-            if @@logger
-                @@logger.info format(INFO_INITIALIZED, @@sequence, @@mac_addr)
-            else
-                warn "#{PACKAGE}: " + format(INFO_INITIALIZED, @@sequence, @@mac_addr)
-            end
-            @@last_clock, @@drift = (Time.new.to_f * CLOCK_MULTIPLIER).to_i, 0
-        rescue Errno::ENOENT=>error
-            if !config
-                # Generate random values.
-                @@mac_hex, @@sequence, @@state_file = rand(0x800000000000) | 0xF00000000000, rand(0x10000), nil
-                # Initialized.
-                if @@logger
-                    @@logger.error ERROR_INITIALIZED_RANDOM_1
-                    @@logger.error ERROR_INITIALIZED_RANDOM_2
-                else
-                    warn "#{PACKAGE}: " + ERROR_INITIALIZED_RANDOM_1
-                    warn "#{PACKAGE}: " + ERROR_INITIALIZED_RANDOM_2
-                end
-                @@last_clock, @@drift = (Time.new.to_f * CLOCK_MULTIPLIER).to_i, 0
-            else
-                # No state file. If we were called for configuration with valid sequence number and MAC address,
-                # attempt to create state file. See code above for how we interpret these values.
-                sequence = config[:sequence]
-                raise RuntimeError, format(ERROR_NOT_A_SEQUENCE, sequence) unless sequence.is_a?(Integer)
-                sequence &= 0xFFFF
-                mac_addr = config[:mac_addr]
-                raise RuntimeError, format(ERROR_INVALID_MAC_ADDR, mac_addr) unless mac_addr.is_a?(String) and mac_addr =~ /([0-9a-fA-F]{2}[:\-]){5}[0-9a-fA-F]{2}/
-                mac_hex = mac_addr.scan(/[0-9a-fA-F]{2}/).join.hex & 0x7FFFFFFFFFFF
-                File.open state_file, "w" do |file|
-                    file.flock(File::LOCK_EX)
-                    @@mac_addr, @@mac_hex, @@sequence, @@state_file = mac_addr, mac_hex, sequence, state_file
-                    file.pos = 0
-                    YAML::dump state(true), file
-                    file.truncate file.pos
-                end
-                # Initialized.
-                if @@logger
-                    @@logger.info format(INFO_INITIALIZED, @@sequence, @@mac_addr)
-                else
-                    warn "#{PACKAGE}: " + format(INFO_INITIALIZED, @@sequence, @@mac_addr)
-                end
-                @@last_clock, @@drift = (Time.new.to_f * CLOCK_MULTIPLIER).to_i, 0
-            end
-        rescue Exception=>error
-            @@last_clock = nil
-            raise error
-        end
-    end
-
-end
-
-
-if __FILE__ == $0
-    UUID.setup
-end