uuid 1.0.3 → 1.0.4

data/CHANGELOG

@@ -1,20 +1,19 @@
-Release 1.0.3 (Nov 8, 2006)
+1.0.4 (1/2/2006)
+* Changed:  By default creates the uuid.state file in the working directory,
+            not in the installation directory, which requires sudo privileges (e.g. gem).
 
+1.0.3 (1/8/2006)
 * Fixed:    Work around YAML bug in serializing that occurs when MAC address
             consists only of decimal digits. Credit: ebuprofen"
 
-Release 1.0.2 (Jul 28, 2006)
-
+1.0.2 (1/28/2006)
 * Changed:  Constants are not conditionally defined (removes warnings when
             using in Rails.
 
-Release 1.0.1 (Jul 26, 2006)
-
+1.0.1 (1/26/2006)
 * Added:    Regular expressions to test if a string is a UUID.
 * Changed:  When used in ActiveRecord, adds as callback instead of overriding
             save.
 
-Release 1.0.0 (Nov 20, 2005)
-
+1.0.0 (1/20/2005)
 * Changed:  Separated form reliable-msg into its own package.
-

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2005,2006 Assaf Arkin
+Copyright (c) 2005,2007 Assaf Arkin
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,11 +1,35 @@
 # Adapted from the rake Rakefile.
 
 require "rubygems"
-Gem::manage_gems
 require "rake/testtask"
 require "rake/rdoctask"
 require "rake/gempackagetask"
 
+VERSION_FILE = "lib/uuid.rb"
+# Create the GEM package.
+spec = Gem::Specification.new do |spec|
+  spec.name = "uuid"
+  spec.version = File.read(__FILE__.pathmap("%d/#{VERSION_FILE}")).scan(/VERSION\s*=\s*(['"])(.*)\1/)[0][1]
+  spec.summary = "UUID generator"
+  spec.description = <<-EOF
+    UUID generator for producing universally unique identifiers based
+    on RFC 4122 (http://www.ietf.org/rfc/rfc4122.txt).
+EOF
+  spec.author = "Assaf Arkin"
+  spec.email = "assaf@labnotes.org"
+  spec.homepage = "http://trac.labnotes.org/cgi-bin/trac.cgi/wiki/Ruby/UuidGenerator"
+  spec.files = FileList["{bin,test,lib,docs}/**/*", "README", "MIT-LICENSE", "Rakefile", "CHANGELOG"].to_a
+  spec.require_path = "lib"
+  spec.autorequire = "uuid.rb"
+  spec.bindir = "bin"
+  spec.executables = ["uuid-setup"]
+  spec.default_executable = "uuid-setup"
+  spec.has_rdoc = true
+  spec.rdoc_options << "--main" << "README" << "--title" <<  "UUID generator" << "--line-numbers"
+  spec.extra_rdoc_files = ["README"]
+  spec.rubyforge_project = "reliable-msg"
+end
+
 
 desc "Default Task"
 task :default => [:test, :rdoc]
@@ -13,19 +37,104 @@ task :default => [:test, :rdoc]
 
 desc "Run all test cases"
 Rake::TestTask.new do |test|
-    test.verbose = true
-    test.test_files = ["test/test-uuid.rb"]
-    #test.warning = true
+  test.verbose = true
+  test.test_files = ["test/*.rb"]
+  #test.warning = true
 end
 
-
 # Create the documentation.
 Rake::RDocTask.new do |rdoc|
-    rdoc.main = "README"
-    rdoc.rdoc_files.include("README", "lib/**/*.rb")
-    rdoc.title = "UUID generator"
+  rdoc.main = "README"
+  rdoc.rdoc_files.include("README", "lib/**/*.rb")
+  rdoc.title = "UUID generator"
+end
+
+gem = Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_tar = true
+  pkg.need_zip = true
+end
+
+desc "Install the package locally"
+task :install=>:package do |task|
+  system "gem", "install", "pkg/#{spec.name}-#{spec.version}.gem"
+end
+
+desc "Uninstall previously installed packaged"
+task :uninstall do |task|
+  system "gem", "uninstall", spec.name, "-v", spec.version.to_s
+end
+
+
+desc "Look for TODO and FIXME tags in the code"
+task :todo do
+  FileList["**/*.rb"].egrep /#.*(FIXME|TODO|TBD)/
+end
+
+
+# --------------------------------------------------------------------
+# Creating a release
+
+
+namespace :upload do
+  task :packages=>["rake:rdoc", "rake:package"] do |task|
+    require 'rubyforge'
+
+    # Read the changes for this release.
+    pattern = /(^(\d+\.\d+(?:\.\d+)?)\s+\(\d+\/\d+\/\d+\)\s*((:?^[^\n]+\n)*))/
+    changelog = File.read(__FILE__.pathmap("%d/CHANGELOG"))
+    changes = changelog.scan(pattern).inject({}) { |hash, set| hash[set[1]] = set[2] ; hash }
+    current = changes[spec.version.to_s]
+    if !current && spec.version.to_s =~ /\.0$/
+      current = changes[spec.version.to_s.split(".")[0..-2].join(".")] 
+    end
+    fail "No changeset found for version #{spec.version}" unless current
+
+    puts "Uploading #{spec.name} #{spec.version}"
+    files = %w( gem tgz zip ).map { |ext| "pkg/#{spec.name}-#{spec.version}.#{ext}" }
+    rubyforge = RubyForge.new
+    rubyforge.login    
+    File.open(".changes", 'w'){|f| f.write(current)}
+    rubyforge.userconfig.merge!("release_changes" => ".changes",  "preformatted" => true)
+    rubyforge.add_release spec.rubyforge_project.downcase, spec.name.downcase, spec.version, *files
+    rm ".changes"
+    puts "Release #{spec.version} uploaded"
+  end
 end
 
+namespace :release do
+  task :ready? do
+    require 'highline'
+    require 'highline/import'
+
+    puts "This version: #{spec.version}"
+    puts
+    puts "Top 4 lines form CHANGELOG:"
+    puts File.readlines("CHANGELOG")[0..3].map { |l| "  #{l}" }
+    puts
+    ask("Top-entry in CHANGELOG file includes today's date?") =~ /yes/i or
+      fail "Please update CHANGELOG to include the right date"
+  end
+
+  task :post do
+    # Practical example of functional read but not comprehend code:
+    next_version = spec.version.to_ints.zip([0, 0, 1]).map { |a| a.inject(0) { |t,i| t + i } }.join(".")
+    puts "Updating #{VERSION_FILE} to next version number: #{next_version}"
+    ver_file = File.read(__FILE__.pathmap("%d/#{VERSION_FILE}")).
+      sub(/(VERSION\s*=\s*)(['"])(.*)\2/) { |line| "#{$1}#{$2}#{next_version}#{$2}" } 
+    File.open(__FILE__.pathmap("%d/#{VERSION_FILE}"), "w") { |file| file.write ver_file }
+    puts "Adding entry to CHANGELOG"
+    changelog = File.read(__FILE__.pathmap("%d/CHANGELOG"))
+    File.open(__FILE__.pathmap("%d/CHANGELOG"), "w") { |file| file.write "#{next_version} (Pending)\n\n#{changelog}" }
+  end
+
+  task :meat=>["clobber", "test", "upload:packages"]
+end
+
+desc "Upload release to RubyForge including docs, tag SVN"
+task :release=>[ "release:ready?", "release:meat", "release:post" ]
+
+=begin
+
 # Handle version number.
 class Version
 
@@ -83,45 +192,8 @@ end
 version = Version.new "lib/uuid.rb", ENV["version"]
 
 
-# Create the GEM package.
-gem_spec = Gem::Specification.new do |spec|
-  spec.name = "uuid"
-  spec.version = version.next
-  spec.summary = "UUID generator"
-  spec.description = <<-EOF
-        UUID generator for producing universally unique identifiers based
-        on RFC 4122 (http://www.ietf.org/rfc/rfc4122.txt).
-EOF
-  spec.author = "Assaf Arkin"
-  spec.email = "assaf@labnotes.org"
-  spec.homepage = "http://trac.labnotes.org/cgi-bin/trac.cgi/wiki/Ruby/UuidGenerator"
-  spec.files = FileList["{bin,test,lib,docs}/**/*", "README", "MIT-LICENSE", "Rakefile", "CHANGELOG"].to_a
-  spec.require_path = "lib"
-  spec.autorequire = "uuid.rb"
-  spec.bindir = "bin"
-  spec.executables = ["uuid-setup"]
-  spec.default_executable = "uuid-setup"
-  spec.has_rdoc = true
-  spec.rdoc_options << "--main" << "README" << "--title" <<  "UUID generator" << "--line-numbers"
-  spec.extra_rdoc_files = ["README"]
-  spec.rubyforge_project = "reliable-msg"
-end
-
-gem = Rake::GemPackageTask.new(gem_spec) do |pkg|
-  pkg.need_tar = true
-  pkg.need_zip = true
-end
 
 
-desc "Look for TODO and FIXME tags in the code"
-task :todo do
-  FileList["**/*.rb"].egrep /#.*(FIXME|TODO|TBD)/
-end
-
-
-# --------------------------------------------------------------------
-# Creating a release
-
 desc "Make a new release"
 task :release => [:test, :prerelease, :clobber, :update_version, :package] do
   puts
@@ -145,4 +217,4 @@ task :update_version => [:prerelease] do
     version.update
   end
 end
-
+=end

data/bin/uuid-setup

@@ -2,6 +2,6 @@ begin
   require 'uuid'
 rescue LoadError
   require 'rubygems'
-  require_gem 'uuid'
+  require 'uuid'
 end
 UUID::setup

data/lib/uuid.rb

@@ -3,7 +3,7 @@
 #
 # Author:: Assaf Arkin  assaf@labnotes.org
 # Documentation:: http://trac.labnotes.org/cgi-bin/trac.cgi/wiki/Ruby/UuidGenerator
-# Copyright:: Copyright (c) 2005,2006 Assaf Arkin
+# Copyright:: Copyright (c) 2005,2007 Assaf Arkin
 # License:: MIT and/or Creative Commons Attribution-ShareAlike
 
 
@@ -13,7 +13,6 @@ 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
@@ -57,7 +56,7 @@ require 'logger'
 #
 # 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.
+# in the current 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>
@@ -69,7 +68,6 @@ require 'logger'
 #   mac_addr: 08-0E-46-21-4B-35
 #   sequence: "0x1639"
 #
-#
 #--
 # === Time-based UUID
 #
@@ -98,8 +96,7 @@ require 'logger'
 # === 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 generator with UUID.config. The default is to use the file +uuid.state+ in the current 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
@@ -111,186 +108,116 @@ require 'logger'
 # application is running.
 #++
 module UUID
+ 
+  VERSION = '1.0.4'
 
-  unless const_defined?(:VERSION)
-    VERSION = '1.0.3'
-
-    PACKAGE = "uuid"
+  # Regular expression to identify a 36 character UUID. Can be used for a partial match.
+  REGEXP = /[[:xdigit:]]{8}[:-][[:xdigit:]]{4}[:-][[:xdigit:]]{4}[:-][[:xdigit:]]{4}[:-][[:xdigit:]]{12}/
 
-    # Default state file.
-    STATE_FILE = "uuid.state"
+  # Regular expression to identify a 36 character UUID. Can only be used for a full match.
+  REGEXP_FULL = /^[[:xdigit:]]{8}[:-][[:xdigit:]]{4}[:-][[:xdigit:]]{4}[:-][[:xdigit:]]{4}[:-][[:xdigit:]]{12}$/
 
-    # Clock multiplier. Converts Time (resolution: seconds) to UUID clock (resolution: 10ns)
-    CLOCK_MULTIPLIER = 10000000 #:nodoc:
+  # Regular expression to identify a 32 character UUID, no hyphens (compact) full match.
+  REGEXP_COMPACT = /^[[:xdigit:]]{32}$/
 
-    # Clock gap is the number of ticks (resolution: 10ns) between two Ruby Time ticks.
-    CLOCK_GAPS = 100000 #:nodoc:
+  # Default state file.
+  STATE_FILE = 'uuid.state'
 
-    # Version number stamped into the UUID to identify it as time-based.
-    VERSION_CLOCK = 0x0100 #:nodoc:
+  # Clock multiplier. Converts Time (resolution: seconds) to UUID clock (resolution: 10ns)
+  CLOCK_MULTIPLIER = 10000000 #: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:
+  # Clock gap is the number of ticks (resolution: 10ns) between two Ruby Time ticks.
+  CLOCK_GAPS = 100000 #:nodoc:
 
-    # Length (in characters) of UUIDs generated for each of the formats.
-    FORMATS_LENGTHS = {:compact=>32, :default=>36, :urn=>45} #:nodoc:
+  # Version number stamped into the UUID to identify it as time-based.
+  VERSION_CLOCK = 0x0100 #:nodoc:
 
-    ERROR_INVALID_SEQUENCE = "Invalid sequence number: found '%s', expected 4 hexdecimal digits" #: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:
 
-    ERROR_NOT_A_SEQUENCE = "Not a sequence number: expected integer between 0 and 0xFFFF" #:nodoc:
+  # Length (in characters) of UUIDs generated for each of the formats.
+  FORMATS_LENGTHS = { :compact=>32, :default=>36, :urn=>45 } #:nodoc:
 
-    ERROR_INVALID_MAC_ADDR = "Invalid MAC address: found '%s', expected a number in the format XX-XX-XX-XX-XX-XX" #:nodoc:
+  ERROR_INVALID_SEQUENCE = "Invalid sequence number: found '%s', expected 4 hexdecimal digits" #:nodoc:
 
-    INFO_INITIALIZED = "Initialized UUID generator with sequence number 0x%04x and MAC address %s" #:nodoc:
+  ERROR_NOT_A_SEQUENCE = "Not a sequence number: expected integer between 0 and 0xFFFF" #:nodoc:
 
-    ERROR_INITIALIZED_RANDOM_1 = "Initialized UUID generator with random sequence number/MAC address." #:nodoc:
+  ERROR_INVALID_MAC_ADDR = "Invalid MAC address: found '%s', expected a number in the format XX-XX-XX-XX-XX-XX" #:nodoc:
 
-    ERROR_INITIALIZED_RANDOM_2 = "UUIDs are not guaranteed to be unique. Please create a uuid.state file as soon as possible." #:nodoc:
+  INFO_INITIALIZED = "Initialized UUID generator with sequence number 0x%04x and MAC address %s" #:nodoc:
 
-    IFCONFIG_PATTERN = /[^:\-](?:[0-9A-Za-z][0-9A-Za-z][:\-]){5}[0-9A-Za-z][0-9A-Za-z][^:\-]/ #: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:
 
-    # Regular expression to identify a 36 character UUID. Can be used for a partial match.
-    REGEXP = /[[:xdigit:]]{8}[:-][[:xdigit:]]{4}[:-][[:xdigit:]]{4}[:-][[:xdigit:]]{4}[:-][[:xdigit:]]{12}/
-
-    # Regular expression to identify a 36 character UUID. Can only be used for a full match.
-    REGEXP_FULL = /^[[:xdigit:]]{8}[:-][[:xdigit:]]{4}[:-][[:xdigit:]]{4}[:-][[:xdigit:]]{4}[:-][[:xdigit:]]{12}$/
-  end
+  IFCONFIG_PATTERN = /[^:\-](?:[0-9A-Za-z][0-9A-Za-z][:\-]){5}[0-9A-Za-z][0-9A-Za-z][^:\-]/ #:nodoc:
 
+  class << self
 
-  @@mutex       = Mutex.new
-  @@last_clock  = nil
-  @@logger      = nil
-  @@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
+    # 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 config(options)
+      options ||= {}
+      @@mutex.synchronize do
+        @@logger = options[:logger]
+        next_sequence options
       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 = ""
-      Kernel.open "|ifconfig" do |input|
-        input.each_line { |line| config << line }
-      end rescue nil
-      Kernel.open "|ipconfig /all" do |input|
-        input.each_line { |line| config << line }
-      end rescue nil
-
-      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."
+    # 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
+    # current directory.
+    def setup()
+      file = File.expand_path(File.join(Dir.pwd, STATE_FILE))
+      if File.exist? file
+        puts "UUID: Found an existing UUID state file: #{file}"
       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))
+        puts "UUID: No UUID state file found, attempting to create one for you:"
+        # Run ifconfig for UNIX, or ipconfig for Windows.
+        config = ""
+        Kernel.open("|ifconfig") { |input| input.each_line { |line| config << line } } rescue nil
+        Kernel.open("|ipconfig /all") { |input| input.each_line { |line| config << line } } rescue nil
+
+        addresses = config.scan(IFCONFIG_PATTERN).map { |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
-        puts "Created a new UUID state file: #{file}"
       end
+      file
     end
-    file
-  end
-
 
-private
+  private
 
-    def self.next_sequence(config = nil)
+    def 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
@@ -299,9 +226,7 @@ private
         if File.exist?(STATE_FILE)
           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)
-          file = File.expand_path(file)
+          file = File.expand_path(File.join(Dir.pwd, STATE_FILE))
           state_file = File.exist?(file) ? file : setup
         end
       end
@@ -314,8 +239,7 @@ private
           # 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}/
+            raise RuntimeError, format(ERROR_INVALID_SEQUENCE, sequence) unless sequence.is_a?(String) && sequence =~ /[0-9a-fA-F]{4}/
             sequence = sequence.hex & 0xFFFF
           else
             sequence = rand(0x10000)
@@ -324,7 +248,7 @@ private
           # 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_addr.is_a?(String) && 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
@@ -338,7 +262,7 @@ private
         if @@logger
           @@logger.info format(INFO_INITIALIZED, @@sequence, @@mac_addr)
         else
-          warn "#{PACKAGE}: " + format(INFO_INITIALIZED, @@sequence, @@mac_addr)
+          warn "UUID: " + format(INFO_INITIALIZED, @@sequence, @@mac_addr)
         end
         @@last_clock, @@drift = (Time.new.to_f * CLOCK_MULTIPLIER).to_i, 0
       rescue Errno::ENOENT=>error
@@ -350,8 +274,8 @@ private
             @@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
+            warn "UUID: " + ERROR_INITIALIZED_RANDOM_1
+            warn "UUID: " + ERROR_INITIALIZED_RANDOM_2
           end
           @@last_clock, @@drift = (Time.new.to_f * CLOCK_MULTIPLIER).to_i, 0
         else
@@ -362,7 +286,7 @@ private
           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_addr.is_a?(String) && 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)
@@ -375,7 +299,7 @@ private
           if @@logger
             @@logger.info format(INFO_INITIALIZED, @@sequence, @@mac_addr)
           else
-            warn "#{PACKAGE}: " + format(INFO_INITIALIZED, @@sequence, @@mac_addr)
+            warn "UUID: " + format(INFO_INITIALIZED, @@sequence, @@mac_addr)
           end
           @@last_clock, @@drift = (Time.new.to_f * CLOCK_MULTIPLIER).to_i, 0
         end
@@ -385,7 +309,7 @@ private
       end
     end
 
-    def self.dump(file, plus_one)
+    def dump(file, plus_one)
       # Gets around YAML weirdness, like ont storing the MAC address as a string.
       if @@sequence && @@mac_addr
         file.puts "mac_addr: \"#{@@mac_addr}\""
@@ -393,21 +317,79 @@ private
         file.puts "last_clock: \"0x%x\"" % (@@last_clock || (Time.new.to_f * CLOCK_MULTIPLIER).to_i)
       end
     end
+  end
 
-end
-
+  @@mutex       = Mutex.new
+  @@last_clock  = nil
+  @@logger      = nil
+  @@state_file  = nil
 
-if defined?(ActiveRecord)
-  class ActiveRecord::Base
+  # 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}'"
 
-      def self.uuid_primary_key()
-        before_create { |record| record.id = UUID.new unless record.id }
+    # 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
+
 end
 
 
+class ActiveRecord::Base
+  class << self
+    def uuid_primary_key()
+      before_create { |record| record.id = UUID.new unless record.id }
+    end
+  end
+end if defined?(ActiveRecord)
+
+
 if __FILE__ == $0
   UUID.setup
 end

data/test/test-uuid.rb

@@ -3,7 +3,7 @@
 #
 # Author:: Assaf Arkin  assaf@labnotes.org
 # Documentation:: http://trac.labnotes.org/cgi-bin/trac.cgi/wiki/Ruby/UuidGenerator
-# Copyright:: Copyright (c) 2005 Assaf Arkin
+# Copyright:: Copyright (c) 2005,2007 Assaf Arkin
 # License:: MIT and/or Creative Commons Attribution-ShareAlike
 #
 #--
@@ -25,10 +25,14 @@ class TestUUID < Test::Unit::TestCase
     10.times do
       uuid = UUID.new :compact
       assert uuid =~ /^[0-9a-fA-F]{32}$/, "UUID does not conform to :compact format"
+      assert uuid =~ UUID::REGEXP_COMPACT, "UUID does not conform to :compact format"
       uuid = UUID.new :default
       assert uuid =~ /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/, "UUID does not conform to :default format"
+      assert uuid =~ UUID::REGEXP, "UUID does not conform to :compact format"
+      assert uuid =~ UUID::REGEXP_FULL, "UUID does not conform to :compact format"
       uuid = UUID.new :urn
       assert uuid =~ /^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/i, "UUID does not conform to :urn format"
+      assert uuid =~ UUID::REGEXP, "UUID does not conform to :compact format"
     end
   end
 

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
+rubygems_version: 0.9.4
 specification_version: 1
 name: uuid
 version: !ruby/object:Gem::Version 
-  version: 1.0.3
-date: 2006-11-08 00:00:00 -08:00
+  version: 1.0.4
+date: 2007-08-28 00:00:00 -07:00
 summary: UUID generator
 require_paths: 
 - lib