uuidtools 1.0.3 → 1.0.4

data/CHANGELOG

@@ -1,5 +1,13 @@
+== UUIDTools 1.0.4
+ * calculates random node id with multicast bit if there is no MAC address
+ * uses RSpec instead of Test::Unit
+ * works in Ruby 1.9
+ * cleaned up some code
+ * removed deprecated methods
+ * changed version constant
+ * new gem file structure
 == UUIDTools 1.0.3
- * imrpoved code for obtaining a MAC address within JRuby
+ * improved code for obtaining a MAC address within JRuby
 == UUIDTools 1.0.2
  * improved code for obtaining a MAC address for Solaris and OpenBSD
  * added hash and eql? methods

data/LICENSE

@@ -0,0 +1,20 @@
+UUIDTools, Copyright (c) 2005-2008 Bob Aman
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,44 @@
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), "lib"))
+$:.unshift(lib_dir)
+$:.uniq!
+
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/contrib/rubyforgepublisher'
+require 'spec/rake/spectask'
+
+require File.join(File.dirname(__FILE__), 'lib/uuidtools', 'version')
+
+PKG_DISPLAY_NAME   = 'UUIDTools'
+PKG_NAME           = PKG_DISPLAY_NAME.downcase
+PKG_VERSION        = UUID::VERSION::STRING
+PKG_FILE_NAME      = "#{PKG_NAME}-#{PKG_VERSION}"
+
+RELEASE_NAME       = "REL #{PKG_VERSION}"
+
+RUBY_FORGE_PROJECT = PKG_NAME
+RUBY_FORGE_USER    = "sporkmonger"
+RUBY_FORGE_PATH    = "/var/www/gforge-projects/#{RUBY_FORGE_PROJECT}"
+RUBY_FORGE_URL     = "http://#{RUBY_FORGE_PROJECT}.rubyforge.org/"
+
+PKG_SUMMARY        = "UUID generator"
+PKG_DESCRIPTION    = <<-TEXT
+A simple universally unique ID generation library.
+TEXT
+
+PKG_FILES = FileList[
+    "lib/**/*", "spec/**/*", "vendor/**/*",
+    "tasks/**/*", "website/**/*",
+    "[A-Z]*", "Rakefile"
+].exclude(/database\.yml/).exclude(/[_\.]git$/)
+
+task :default => "spec:verify"
+
+WINDOWS = (RUBY_PLATFORM =~ /mswin|win32|mingw|bccwin|cygwin/) rescue false
+SUDO = WINDOWS ? '' : ('sudo' unless ENV['SUDOLESS'])
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/lib/uuidtools.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2008 Robert Aman
+# UUIDTools, Copyright (c) 2005-2008 Bob Aman
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -31,65 +31,6 @@ require 'digest/md5'
 
 require 'uuidtools/version'
 
-# Backwards compatibility with old method of versioning.
-UUID_TOOLS_VERSION = UUID::UUID_TOOLS_VERSION::STRING
-
-#  Because it's impossible to hype a UUID generator on its genuine merits,
-#  I give you... Really bad ASCII art in the comments:
-#
-#                                                                  
-#                \                                                 
-#                /                                                   
-#               +                                                  
-#              ]                                                   
-#              ]                                                   
-#              |                                                    
-#             /                                                     
-#           Mp___                                                  
-#              `~0NNp,                                             
-#               __ggM'                                             
-#             g0M~"`                                               
-#            ]0M*-                                                 
-#                                                                  
-#                    ___                                           
-#                _g000M00g,                                        
-#              j0M~      ~M&                                       
-#            j0M"          ~N,                                     
-#           j0P              M&                                    
-#          jM                  1                                   
-#         j0                   ]1                                  
-#        .0P                    0,                                 
-#        00'                    M&                                 
-#        0M                     ]0L                                
-#       ]0f         ___          M0                                
-#        M0NN0M00MMM~"'M          0&                               
-#          `~          ~0         ]0,                              
-#                       ]M        ]0&                              
-#                        M&        M0,                             
-#               ____gp_   M&        M0_                            
-#            __p0MPM8MM&_  M/        ^0&_                          
-#           gN"`       M0N_j0,         MM&__                       
-#         _gF           `~M0P`   __      M00g                      
-#        g0'                    gM0&,     ~M0&                     
-#      _pM`                     0, ]M1     "00&                    
-#     _00                    /g1MMgj01      ]0MI                   
-#    _0F                     t"M,7MMM        00I                   
-#   g0'                  _   N&j&            40'                   
-#  g0'                _p0Mq_   '             N0QQNM#g,             
-#  0'              _g0000000g__              ~M@MMM000g            
-#  f             _jM00@`  ~M0000Mgppg,             "P00&           
-# |             g000~       `~M000000&_               ~0&          
-# ]M          _M00F              "00MM`                ~#&         
-# `0L        m000F                #E                    "0f        
-#   9r     j000M`                 40,                    00        
-#    ]0g_ j00M`                   ^M0MNggp#gqpg          M0&       
-#     ~MPM0f                         ~M000000000g_ ,_ygg&M00f      
-#                                        `~~~M00000000000000       
-#                                              `M0000000000f       
-#                                                  ~@@@MF~`        
-#                                                                  
-#                                                                  
-
 #= uuidtools.rb
 #
 # UUIDTools was designed to be a simple library for generating any
@@ -106,13 +47,12 @@ UUID_TOOLS_VERSION = UUID::UUID_TOOLS_VERSION::STRING
 #  UUID.random_create
 #  => #<UUID:0x19013a UUID:984265dc-4200-4f02-ae70-fe4f48964159>
 class UUID
-  @@mac_address = nil
   @@last_timestamp = nil
   @@last_node_id = nil
   @@last_clock_sequence = nil
   @@state_file = nil
   @@mutex = Mutex.new
-  
+
   def initialize(time_low, time_mid, time_hi_and_version,
       clock_seq_hi_and_reserved, clock_seq_low, nodes)
     unless time_low >= 0 && time_low < 4294967296
@@ -141,7 +81,7 @@ class UUID
     unless nodes.respond_to? :size
       raise ArgumentError,
         "Expected nodes to respond to :size."
-    end  
+    end
     unless nodes.size == 6
       raise ArgumentError,
         "Expected nodes to have size of 6."
@@ -160,14 +100,14 @@ class UUID
     @clock_seq_low = clock_seq_low
     @nodes = nodes
   end
-  
+
   attr_accessor :time_low
   attr_accessor :time_mid
   attr_accessor :time_hi_and_version
   attr_accessor :clock_seq_hi_and_reserved
   attr_accessor :clock_seq_low
   attr_accessor :nodes
-  
+
   # Parses a UUID from a string.
   def self.parse(uuid_string)
     unless uuid_string.kind_of? String
@@ -214,7 +154,7 @@ class UUID
 
   # Creates a UUID from a random value.
   def self.random_create()
-    new_uuid = self.parse_raw(self.random_128)
+    new_uuid = self.parse_raw(self.random_bits)
     new_uuid.time_hi_and_version &= 0x0FFF
     new_uuid.time_hi_and_version |= (4 << 12)
     new_uuid.clock_seq_hi_and_reserved &= 0x3F
@@ -236,26 +176,34 @@ class UUID
       # Convert to 100 nanosecond blocks
       gmt_timestamp_100_nanoseconds = (gmt_timestamp.tv_sec * 10000000) +
         (gmt_timestamp.tv_usec * 10) + 0x01B21DD213814000
-      mac_address = self.get_mac_address
-      if mac_address == nil || mac_address == ""
-        raise StandardError,
-          "MAC address could not be autodetected.  " +
-          "Set the MAC address manually."
-      end
-      nodes = mac_address.split(":").collect do |octet|
-        octet.to_i(16)
-      end
+      mac_address = self.mac_address
       node_id = 0
+      if mac_address != nil
+        nodes = mac_address.split(":").collect do |octet|
+          octet.to_i(16)
+        end
+      else
+        nodes = self.random_bits(48).split("").map do |chr|
+          if chr.respond_to?(:ord)
+            # Ruby 1.9
+            chr.ord
+          else
+            # Ruby 1.8
+            chr.sum(8)
+          end
+        end
+        nodes[0] |= 0b00000001
+      end
       for i in 0..5
         node_id += (nodes[i] << (40 - (i * 8)))
       end
       clock_sequence = @@last_clock_sequence
       if clock_sequence.nil?
-        clock_sequence = self.convert_byte_string_to_int(self.random_128)
+        clock_sequence = self.convert_byte_string_to_int(self.random_bits)
       end
       if @@last_node_id != nil && @@last_node_id != node_id
         # The node id has changed.  Change the clock id.
-        clock_sequence = self.convert_byte_string_to_int(self.random_128)
+        clock_sequence = self.convert_byte_string_to_int(self.random_bits)
       elsif @@last_timestamp != nil &&
           gmt_timestamp_100_nanoseconds <= @@last_timestamp
         clock_sequence = clock_sequence + 1
@@ -271,7 +219,7 @@ class UUID
       clock_seq_low = clock_sequence & 0xFF;
       clock_seq_hi_and_reserved = (clock_sequence & 0x3F00) >> 8
       clock_seq_hi_and_reserved |= 0x80
-      
+
       return self.new(time_low, time_mid, time_hi_and_version,
         clock_seq_hi_and_reserved, clock_seq_low, nodes)
     end
@@ -281,12 +229,12 @@ class UUID
   def self.md5_create(namespace, name)
     return self.create_from_hash(Digest::MD5, namespace, name)
   end
-  
+
   # Creates a UUID using the SHA1 hash.  (Version 5)
   def self.sha1_create(namespace, name)
     return self.create_from_hash(Digest::SHA1, namespace, name)
   end
-  
+
   # This method applies only to version 1 UUIDs.
   # Checks if the node ID was generated from a random number
   # or from an IEEE 802 address (MAC address).
@@ -297,7 +245,7 @@ class UUID
     return false if self.version != 1
     return ((self.nodes.first & 0x01) == 1)
   end
-  
+
   # Returns true if this UUID is the
   # nil UUID (00000000-0000-0000-0000-000000000000).
   def nil_uuid?
@@ -311,7 +259,7 @@ class UUID
     end
     return true
   end
-  
+
   # Returns the UUID version type.
   # Possible values:
   # 1 - Time-based with unique or random host identifier
@@ -341,7 +289,7 @@ class UUID
     end
     return (result >> 6)
   end
-  
+
   # Returns true if this UUID is valid.
   def valid?
     if [0b000, 0b100, 0b110, 0b111].include?(self.variant) &&
@@ -351,7 +299,7 @@ class UUID
       return false
     end
   end
-  
+
   # Returns the IEEE 802 address used to generate this UUID or
   # nil if a MAC address was not used.
   def mac_address
@@ -361,7 +309,7 @@ class UUID
       sprintf("%2.2x", node)
     end).join(":")
   end
-  
+
   # Returns the timestamp used to generate this UUID
   def timestamp
     return nil if self.version != 1
@@ -373,7 +321,7 @@ class UUID
     return Time.at(
       (gmt_timestamp_100_nanoseconds - 0x01B21DD213814000) / 10000000.0)
   end
-  
+
   # Compares two UUIDs lexically
   def <=>(other_uuid)
     check = self.time_low <=> other_uuid.time_low
@@ -397,22 +345,22 @@ class UUID
     end
     return 0
   end
-  
+
   # Returns a representation of the object's state
   def inspect
     return "#<UUID:0x#{self.object_id.to_s(16)} UUID:#{self.to_s}>"
   end
-  
+
   # Returns the hex digest of the UUID object.
   def hexdigest
     return self.to_i.to_s(16)
   end
-  
+
   # Returns the raw bytes that represent this UUID.
   def raw
     return self.class.convert_int_to_byte_string(self.to_i, 16)
   end
-  
+
   # Returns a string representation for this UUID.
   def to_s
     result = sprintf("%8.8x-%4.4x-%4.4x-%2.2x%2.2x-", @time_low, @time_mid,
@@ -422,7 +370,7 @@ class UUID
     end
     return result.downcase
   end
-  
+
   # Returns an integer representation for this UUID.
   def to_i
     bytes = (time_low << 96) + (time_mid << 80) +
@@ -448,34 +396,11 @@ class UUID
   def eql?(other)
     return (self <=> other) == 0
   end
-  
-  def self.create_from_hash(hash_class, namespace, name) #:nodoc:
-    if hash_class == Digest::MD5
-      version = 3
-    elsif hash_class == Digest::SHA1
-      version = 5
-    else
-      raise ArgumentError,
-        "Expected Digest::SHA1 or Digest::MD5, got #{hash_class.name}."
-    end
-    hash = hash_class.new
-    hash.update(namespace.raw)
-    hash.update(name)
-    hash_string = hash.to_s[0..31]
-    new_uuid = self.parse("#{hash_string[0..7]}-#{hash_string[8..11]}-" +
-      "#{hash_string[12..15]}-#{hash_string[16..19]}-#{hash_string[20..31]}")
-    
-    new_uuid.time_hi_and_version &= 0x0FFF
-    new_uuid.time_hi_and_version |= (version << 12)
-    new_uuid.clock_seq_hi_and_reserved &= 0x3F
-    new_uuid.clock_seq_hi_and_reserved |= 0x80
-    return new_uuid
-  end
 
   # Returns the MAC address of the current computer's network card.
   # Returns nil if a MAC address could not be found.
   def self.mac_address #:nodoc:
-    if @@mac_address.nil?
+    if !defined?(@@mac_address)
       require 'rbconfig'
       os_platform = Config::CONFIG['target_os']
       if os_platform =~ /win/ && !(os_platform =~ /darwin/)
@@ -485,19 +410,19 @@ class UUID
       end
       if os_platform =~ /solaris/
         begin
-        	ifconfig_output =
-        	  (script_in_path ? `ifconfig -a` : `/sbin/ifconfig -a`)
-        	ip_addresses = ifconfig_output.scan(
-        	  /inet\s?(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})/)
-        	ip = ip_addresses.find {|addr| addr[0] != '127.0.0.1'}[0]
-        	@@mac_address = `/usr/sbin/arp #{ip}`.split(' ')[3]
+          ifconfig_output =
+            (script_in_path ? `ifconfig -a` : `/sbin/ifconfig -a`)
+          ip_addresses = ifconfig_output.scan(
+            /inet\s?(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})/)
+          ip = ip_addresses.find {|addr| addr[0] != '127.0.0.1'}[0]
+          @@mac_address = `/usr/sbin/arp #{ip}`.split(' ')[3]
         rescue Exception
         end
         if @@mac_address == "" || @@mac_address == nil
           begin
-  	        ifconfig_output =
-  	          (script_in_path ?
-  	            `ifconfig -a` : `/sbin/ifconfig -a`).split(' ')
+            ifconfig_output =
+              (script_in_path ?
+                `ifconfig -a` : `/sbin/ifconfig -a`).split(' ')
             index = ifconfig_output.index("inet") + 1
             ip = ifconfig_output[index]
             @@mac_address = `arp #{ip}`.split(' ')[3]
@@ -594,18 +519,43 @@ class UUID
     end
     return @@mac_address
   end
-  class <<self
-    alias_method :get_mac_address, :mac_address
-  end
-  
+
   # Allows users to set the MAC address manually in cases where the MAC
   # address cannot be obtained programatically.
   def self.mac_address=(new_mac_address)
     @@mac_address = new_mac_address
   end
-  
-  # 128 bits of unpredictable data.
-  def self.random_128 #:nodoc:
+
+protected
+  # Creates a new UUID from a SHA1 or MD5 hash
+  def self.create_from_hash(hash_class, namespace, name) #:nodoc:
+    if hash_class == Digest::MD5
+      version = 3
+    elsif hash_class == Digest::SHA1
+      version = 5
+    else
+      raise ArgumentError,
+        "Expected Digest::SHA1 or Digest::MD5, got #{hash_class.name}."
+    end
+    hash = hash_class.new
+    hash.update(namespace.raw)
+    hash.update(name)
+    hash_string = hash.to_s[0..31]
+    new_uuid = self.parse("#{hash_string[0..7]}-#{hash_string[8..11]}-" +
+      "#{hash_string[12..15]}-#{hash_string[16..19]}-#{hash_string[20..31]}")
+
+    new_uuid.time_hi_and_version &= 0x0FFF
+    new_uuid.time_hi_and_version |= (version << 12)
+    new_uuid.clock_seq_hi_and_reserved &= 0x3F
+    new_uuid.clock_seq_hi_and_reserved |= 0x80
+    return new_uuid
+  end
+
+  # N bits of unpredictable data.
+  def self.random_bits(size=128) #:nodoc:
+    if 128 % 16 != 0
+      raise ArgumentError, "Value must be divisible by 16."
+    end
     if !defined?(@random_device) || @random_device == nil
       begin
         @random_device = nil
@@ -618,12 +568,12 @@ class UUID
       end
     end
     begin
-      return @random_device.read(16) if @random_device != nil
+      return @random_device.read(size / 8) if @random_device != nil
     rescue Exception
     end
-    return (1..8).to_a.map { rand(0x10000) }.pack("n8")
+    return (1..(size / 16)).to_a.map { rand(0x10000) }.pack("n#{size / 16}")
   end
-  
+
   def self.convert_int_to_byte_string(integer, size) #:nodoc:
     byte_string = ""
     for i in 0..(size - 1)
@@ -636,7 +586,13 @@ class UUID
     integer = 0
     size = byte_string.size
     for i in 0..(size - 1)
-      integer += (byte_string[i] << (((size - 1) - i) * 8))
+      if byte_string[i].respond_to?(:ord)
+        # Ruby 1.9
+        integer += (byte_string[i].ord << (((size - 1) - i) * 8))
+      else
+        # Ruby 1.8
+        integer += (byte_string[i] << (((size - 1) - i) * 8))
+      end
     end
     return integer
   end