Class: UUIDTools::UUID

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/ext/uuidtools-2.1.1/lib/uuidtools.rb

Overview

uuidtools.rb

UUIDTools was designed to be a simple library for generating any of the various types of UUIDs. It conforms to RFC 4122 whenever possible.

Example

UUID.md5_create(UUID_DNS_NAMESPACE, "www.widgets.com")
=> #<UUID:0x287576 UUID:3d813cbb-47fb-32ba-91df-831e1593ac29>
UUID.sha1_create(UUID_DNS_NAMESPACE, "www.widgets.com")
=> #<UUID:0x2a0116 UUID:21f7f8de-8051-5b89-8680-0195ef798b6a>
UUID.timestamp_create
=> #<UUID:0x2adfdc UUID:64a5189c-25b3-11da-a97b-00c04fd430c8>
UUID.random_create
=> #<UUID:0x19013a UUID:984265dc-4200-4f02-ae70-fe4f48964159>

Constant Summary collapse

@@last_timestamp = 
nil
@@last_node_id = 
nil
@@last_clock_sequence = 
nil
@@state_file = 
nil
@@mutex = 
Mutex.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(time_low, time_mid, time_hi_and_version, clock_seq_hi_and_reserved, clock_seq_low, nodes) ⇒ UUID

Returns a new instance of UUID.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 65

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
    raise ArgumentError,
      "Expected unsigned 32-bit number for time_low, got #{time_low}."
  end
  unless time_mid >= 0 && time_mid < 65536
    raise ArgumentError,
      "Expected unsigned 16-bit number for time_mid, got #{time_mid}."
  end
  unless time_hi_and_version >= 0 && time_hi_and_version < 65536
    raise ArgumentError,
      "Expected unsigned 16-bit number for time_hi_and_version, " +
      "got #{time_hi_and_version}."
  end
  unless clock_seq_hi_and_reserved >= 0 && clock_seq_hi_and_reserved < 256
    raise ArgumentError,
      "Expected unsigned 8-bit number for clock_seq_hi_and_reserved, " +
      "got #{clock_seq_hi_and_reserved}."
  end
  unless clock_seq_low >= 0 && clock_seq_low < 256
    raise ArgumentError,
      "Expected unsigned 8-bit number for clock_seq_low, " +
      "got #{clock_seq_low}."
  end
  unless nodes.kind_of?(Enumerable)
    raise TypeError,
      "Expected Enumerable, got #{nodes.class.name}."
  end
  unless nodes.size == 6
    raise ArgumentError,
      "Expected nodes to have size of 6."
  end
  for node in nodes
    unless node >= 0 && node < 256
      raise ArgumentError,
        "Expected unsigned 8-bit number for each node, " +
        "got #{node}."
    end
  end
  @time_low = time_low
  @time_mid = time_mid
  @time_hi_and_version = time_hi_and_version
  @clock_seq_hi_and_reserved = clock_seq_hi_and_reserved
  @clock_seq_low = clock_seq_low
  @nodes = nodes
end

Instance Attribute Details

#clock_seq_hi_and_reserved ⇒ Object

Returns the value of attribute clock_seq_hi_and_reserved.



116
117
118
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 116

def clock_seq_hi_and_reserved
  @clock_seq_hi_and_reserved
end

#clock_seq_low ⇒ Object

Returns the value of attribute clock_seq_low.



117
118
119
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 117

def clock_seq_low
  @clock_seq_low
end

#nodes ⇒ Object

Returns the value of attribute nodes.



118
119
120
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 118

def nodes
  @nodes
end

#time_hi_and_version ⇒ Object

Returns the value of attribute time_hi_and_version.



115
116
117
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 115

def time_hi_and_version
  @time_hi_and_version
end

#time_low ⇒ Object

Returns the value of attribute time_low.



113
114
115
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 113

def time_low
  @time_low
end

#time_mid ⇒ Object

Returns the value of attribute time_mid.



114
115
116
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 114

def time_mid
  @time_mid
end

Class Method Details

.convert_byte_string_to_int(byte_string) ⇒ Object

:nodoc:



599
600
601
602
603
604
605
606
607
608
609
610
611
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 599

def self.convert_byte_string_to_int(byte_string) #:nodoc:
  if byte_string.respond_to?(:force_encoding)
    byte_string.force_encoding(Encoding::ASCII_8BIT)
  end
  integer = 0
  size = byte_string.size
  for i in 0..(size - 1)
    ordinal = (byte_string[i].respond_to?(:ord) ?
      byte_string[i].ord : byte_string[i])
    integer += (ordinal << (((size - 1) - i) * 8))
  end
  return integer
end

.convert_int_to_byte_string(integer, size) ⇒ Object

:nodoc:



588
589
590
591
592
593
594
595
596
597
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 588

def self.convert_int_to_byte_string(integer, size) #:nodoc:
  byte_string = ""
  if byte_string.respond_to?(:force_encoding)
    byte_string.force_encoding(Encoding::ASCII_8BIT)
  end
  for i in 0..(size - 1)
    byte_string << ((integer >> (((size - 1) - i) * 8)) & 0xFF)
  end
  return byte_string
end

.create_from_hash(hash_class, namespace, name) ⇒ Object

Creates a new UUID from a SHA1 or MD5 hash



565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 565

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

.mac_address ⇒ Object

Returns the MAC address of the current computer’s network card. Returns nil if a MAC address could not be found.



428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 428

def self.mac_address #:nodoc:
  if !defined?(@@mac_address)
    require 'rbconfig'
    os_platform = Config::CONFIG['target_os']
    os_class = nil
    if (os_platform =~ /win/i && !(os_platform =~ /darwin/i)) ||
        os_platform =~ /w32/i
      os_class = :windows
    elsif os_platform =~ /solaris/i
      os_class = :solaris
    elsif os_platform =~ /netbsd/i
      os_class = :netbsd
    elsif os_platform =~ /openbsd/i
      os_class = :openbsd
    end
    mac_regexps = [
      Regexp.new("address:? (#{(["[0-9a-fA-F]{2}"] * 6).join(":")})"),
      Regexp.new("addr:? (#{(["[0-9a-fA-F]{2}"] * 6).join(":")})"),
      Regexp.new("ether:? (#{(["[0-9a-fA-F]{2}"] * 6).join(":")})"),
      Regexp.new("(#{(["[0-9a-fA-F]{2}"] * 6).join(":")})"),
      Regexp.new("(#{(["[0-9a-fA-F]{2}"] * 6).join("-")})")
    ]
    parse_mac = lambda do |output|
      (mac_regexps.map do |regexp|
        result = output[regexp, 1]
        result.downcase.gsub(/-/, ":") if result != nil
      end).compact.first
    end
    if os_class == :windows
      script_in_path = true
    else
      script_in_path = Kernel.system("which ifconfig 2>&1 > /dev/null")
    end
    if os_class == :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]
      rescue Exception
      end
      if @@mac_address == "" || @@mac_address == nil
        begin
          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]
        rescue Exception
        end
      end
    elsif os_class == :windows
      begin
        @@mac_address = parse_mac.call(`ipconfig /all`)
      rescue
      end
    else
      begin
        if os_class == :netbsd
          @@mac_address = parse_mac.call(
            script_in_path ? `ifconfig -a 2>&1` : `/sbin/ifconfig -a 2>&1`
          )
        elsif os_class == :openbsd
          @@mac_address = parse_mac.call(
            script_in_path ? `ifconfig -a 2>&1` : `/sbin/ifconfig -a 2>&1`
          )
        elsif File.exists?('/sbin/ifconfig')
          @@mac_address = parse_mac.call(
            script_in_path ? `ifconfig 2>&1` : `/sbin/ifconfig 2>&1`
          )
          if @@mac_address == nil
            @@mac_address = parse_mac.call(
              script_in_path ?
                `ifconfig -a 2>&1` : `/sbin/ifconfig -a 2>&1`
            )
          end
          if @@mac_address == nil
            @@mac_address = parse_mac.call(
              script_in_path ?
                `ifconfig | grep HWaddr | cut -c39- 2>&1` :
                `/sbin/ifconfig | grep HWaddr | cut -c39- 2>&1`
            )
          end
        else
          @@mac_address = parse_mac.call(
            script_in_path ? `ifconfig 2>&1` : `/sbin/ifconfig 2>&1`
          )
          if @@mac_address == nil
            @@mac_address = parse_mac.call(
              script_in_path ?
                `ifconfig -a 2>&1` : `/sbin/ifconfig -a 2>&1`
            )
          end
          if @@mac_address == nil
            @@mac_address = parse_mac.call(
              script_in_path ?
                `ifconfig | grep HWaddr | cut -c39- 2>&1` :
                `/sbin/ifconfig | grep HWaddr | cut -c39- 2>&1`
            )
          end
        end
      rescue
      end
    end
    if @@mac_address != nil
      if @@mac_address.respond_to?(:to_str)
        @@mac_address = @@mac_address.to_str
      else
        @@mac_address = @@mac_address.to_s
      end
      @@mac_address.downcase!
      @@mac_address.strip!
    end

    # Verify that the MAC address is in the right format.
    # Nil it out if it isn't.
    unless @@mac_address.respond_to?(:scan) &&
        @@mac_address.scan(/#{(["[0-9a-f]{2}"] * 6).join(":")}/)
      @@mac_address = nil
    end
  end
  return @@mac_address
end

.mac_address=(new_mac_address) ⇒ Object

Allows users to set the MAC address manually in cases where the MAC address cannot be obtained programatically.



557
558
559
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 557

def self.mac_address=(new_mac_address)
  @@mac_address = new_mac_address
end

.md5_create(namespace, name) ⇒ Object

Creates a UUID using the MD5 hash. (Version 3)



252
253
254
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 252

def self.md5_create(namespace, name)
  return self.create_from_hash(Digest::MD5, namespace, name)
end

.parse(uuid_string) ⇒ Object

Parses a UUID from a string.

Raises:

  • (ArgumentError) 


121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 121

def self.parse(uuid_string)
  unless uuid_string.kind_of? String
    raise TypeError,
      "Expected String, got #{uuid_string.class.name} instead."
  end
  uuid_components = uuid_string.downcase.scan(
    Regexp.new("^([0-9a-f]{8})-([0-9a-f]{4})-([0-9a-f]{4})-" +
      "([0-9a-f]{2})([0-9a-f]{2})-([0-9a-f]{12})$")).first
  raise ArgumentError, "Invalid UUID format." if uuid_components.nil?
  time_low = uuid_components[0].to_i(16)
  time_mid = uuid_components[1].to_i(16)
  time_hi_and_version = uuid_components[2].to_i(16)
  clock_seq_hi_and_reserved = uuid_components[3].to_i(16)
  clock_seq_low = uuid_components[4].to_i(16)
  nodes = []
  for i in 0..5
    nodes << uuid_components[5][(i * 2)..(i * 2) + 1].to_i(16)
  end
  return self.new(time_low, time_mid, time_hi_and_version,
    clock_seq_hi_and_reserved, clock_seq_low, nodes)
end

.parse_hexdigest(uuid_hexdigest) ⇒ Object

Parse a UUID from a hexdigest String.



174
175
176
177
178
179
180
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 174

def self.parse_hexdigest(uuid_hexdigest)
  unless uuid_hexdigest.kind_of?(String)
    raise ArgumentError,
      "Expected String, got #{uuid_hexdigest.class.name} instead."
  end
  return self.parse_int(uuid_hexdigest.to_i(16))
end

.parse_int(uuid_int) ⇒ Object

Parses a UUID from an Integer.



165
166
167
168
169
170
171
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 165

def self.parse_int(uuid_int)
  unless uuid_int.kind_of?(Integer)
    raise ArgumentError,
      "Expected Integer, got #{uuid_int.class.name} instead."
  end
  return self.parse_raw(self.convert_int_to_byte_string(uuid_int, 16))
end

.parse_raw(raw_string) ⇒ Object

Parses a UUID from a raw byte string.



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 144

def self.parse_raw(raw_string)
  unless raw_string.kind_of? String
    raise TypeError,
      "Expected String, got #{raw_string.class.name} instead."
  end
  integer = self.convert_byte_string_to_int(raw_string)

  time_low = (integer >> 96) & 0xFFFFFFFF
  time_mid = (integer >> 80) & 0xFFFF
  time_hi_and_version = (integer >> 64) & 0xFFFF
  clock_seq_hi_and_reserved = (integer >> 56) & 0xFF
  clock_seq_low = (integer >> 48) & 0xFF
  nodes = []
  for i in 0..5
    nodes << ((integer >> (40 - (i * 8))) & 0xFF)
  end
  return self.new(time_low, time_mid, time_hi_and_version,
    clock_seq_hi_and_reserved, clock_seq_low, nodes)
end

.random_create ⇒ Object

Creates a UUID from a random value.



183
184
185
186
187
188
189
190
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 183

def self.random_create()
  new_uuid = self.parse_raw(SecureRandom.random_bytes(16))
  new_uuid.time_hi_and_version &= 0x0FFF
  new_uuid.time_hi_and_version |= (4 << 12)
  new_uuid.clock_seq_hi_and_reserved &= 0x3F
  new_uuid.clock_seq_hi_and_reserved |= 0x80
  return new_uuid
end

.sha1_create(namespace, name) ⇒ Object

Creates a UUID using the SHA1 hash. (Version 5)



257
258
259
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 257

def self.sha1_create(namespace, name)
  return self.create_from_hash(Digest::SHA1, namespace, name)
end

.timestamp_create(timestamp = nil) ⇒ Object

Creates a UUID from a timestamp.



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 193

def self.timestamp_create(timestamp=nil)
  # We need a lock here to prevent two threads from ever
  # getting the same timestamp.
  @@mutex.synchronize do
    # Always use GMT to generate UUIDs.
    if timestamp.nil?
      gmt_timestamp = Time.now.gmtime
    else
      gmt_timestamp = timestamp.gmtime
    end
    # Convert to 100 nanosecond blocks
    gmt_timestamp_100_nanoseconds = (gmt_timestamp.tv_sec * 10000000) +
      (gmt_timestamp.tv_usec * 10) + 0x01B21DD213814000
    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 = SecureRandom.random_bytes(6).unpack("C*")
      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(
        SecureRandom.random_bytes(16)
      )
    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(
        SecureRandom.random_bytes(16)
      )
    elsif @@last_timestamp != nil &&
        gmt_timestamp_100_nanoseconds <= @@last_timestamp
      clock_sequence = clock_sequence + 1
    end
    @@last_timestamp = gmt_timestamp_100_nanoseconds
    @@last_node_id = node_id
    @@last_clock_sequence = clock_sequence

    time_low = gmt_timestamp_100_nanoseconds & 0xFFFFFFFF
    time_mid = ((gmt_timestamp_100_nanoseconds >> 32) & 0xFFFF)
    time_hi_and_version = ((gmt_timestamp_100_nanoseconds >> 48) & 0x0FFF)
    time_hi_and_version |= (1 << 12)
    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
end

Instance Method Details

#<=>(other_uuid) ⇒ Object

Compares two UUIDs lexically



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 349

def <=>(other_uuid)
  check = self.time_low <=> other_uuid.time_low
  return check if check != 0
  check = self.time_mid <=> other_uuid.time_mid
  return check if check != 0
  check = self.time_hi_and_version <=> other_uuid.time_hi_and_version
  return check if check != 0
  check = self.clock_seq_hi_and_reserved <=>
    other_uuid.clock_seq_hi_and_reserved
  return check if check != 0
  check = self.clock_seq_low <=> other_uuid.clock_seq_low
  return check if check != 0
  for i in 0..5
    if (self.nodes[i] < other_uuid.nodes[i])
      return -1
    end
    if (self.nodes[i] > other_uuid.nodes[i])
      return 1
    end
  end
  return 0
end

#eql?(other) ⇒ Boolean

Returns true if this UUID is exactly equal to the other UUID.

Returns:

  • (Boolean) 


422
423
424
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 422

def eql?(other)
  return self == other
end

#hash ⇒ Object

Returns an integer hash value.



417
418
419
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 417

def hash
  @hash ||= self.to_i % 0x3fffffff
end

#hexdigest ⇒ Object

Returns the hex digest of the UUID object.



378
379
380
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 378

def hexdigest
  return self.to_i.to_s(16).rjust(32, "0")
end

#inspect ⇒ Object

Returns a representation of the object’s state



373
374
375
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 373

def inspect
  return "#<UUID:0x#{self.object_id.to_s(16)} UUID:#{self.to_s}>"
end

#mac_address ⇒ Object

Returns the IEEE 802 address used to generate this UUID or nil if a MAC address was not used.



328
329
330
331
332
333
334
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 328

def mac_address
  return nil if self.version != 1
  return nil if self.random_node_id?
  return (self.nodes.collect do |node|
    sprintf("%2.2x", node)
  end).join(":")
end

#nil_uuid? ⇒ Boolean

Returns true if this UUID is the nil UUID (00000000-0000-0000-0000-000000000000).

Returns:

  • (Boolean) 


274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 274

def nil_uuid?
  return false if self.time_low != 0
  return false if self.time_mid != 0
  return false if self.time_hi_and_version != 0
  return false if self.clock_seq_hi_and_reserved != 0
  return false if self.clock_seq_low != 0
  self.nodes.each do |node|
    return false if node != 0
  end
  return true
end

#random_node_id? ⇒ Boolean

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). Always returns false for UUIDs that aren’t version 1. This should not be confused with version 4 UUIDs where more than just the node id is random.

Returns:

  • (Boolean) 


267
268
269
270
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 267

def random_node_id?
  return false if self.version != 1
  return ((self.nodes.first & 0x01) == 1)
end

#raw ⇒ Object

Returns the raw bytes that represent this UUID.



383
384
385
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 383

def raw
  return self.class.convert_int_to_byte_string(self.to_i, 16)
end

#timestamp ⇒ Object

Returns the timestamp used to generate this UUID



337
338
339
340
341
342
343
344
345
346
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 337

def timestamp
  return nil if self.version != 1
  gmt_timestamp_100_nanoseconds = 0
  gmt_timestamp_100_nanoseconds +=
    ((self.time_hi_and_version  & 0x0FFF) << 48)
  gmt_timestamp_100_nanoseconds += (self.time_mid << 32)
  gmt_timestamp_100_nanoseconds += self.time_low
  return Time.at(
    (gmt_timestamp_100_nanoseconds - 0x01B21DD213814000) / 10000000.0)
end

#to_i ⇒ Object

Returns an integer representation for this UUID.



399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 399

def to_i
  @integer ||= (begin
    bytes = (time_low << 96) + (time_mid << 80) +
      (time_hi_and_version << 64) + (clock_seq_hi_and_reserved << 56) +
      (clock_seq_low << 48)
    for i in 0..5
      bytes += (nodes[i] << (40 - (i * 8)))
    end
    bytes
  end)
end

#to_s ⇒ Object Also known as: to_str

Returns a string representation for this UUID.



388
389
390
391
392
393
394
395
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 388

def to_s
  result = sprintf("%8.8x-%4.4x-%4.4x-%2.2x%2.2x-", @time_low, @time_mid,
    @time_hi_and_version, @clock_seq_hi_and_reserved, @clock_seq_low);
  for i in 0..5
    result << sprintf("%2.2x", @nodes[i])
  end
  return result.downcase
end

#to_uri ⇒ Object

Returns a URI string for this UUID.



412
413
414
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 412

def to_uri
  return "urn:uuid:#{self.to_s}"
end

#valid? ⇒ Boolean

Returns true if this UUID is valid.

Returns:

  • (Boolean) 


317
318
319
320
321
322
323
324
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 317

def valid?
  if [0b000, 0b100, 0b110, 0b111].include?(self.variant) &&
    (1..5).include?(self.version)
    return true
  else
    return false
  end
end

#variant ⇒ Object

Returns the UUID variant. Possible values: 0b000 - Reserved, NCS backward compatibility. 0b100 - The variant specified in this document. 0b110 - Reserved, Microsoft Corporation backward compatibility. 0b111 - Reserved for future definition.



303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 303

def variant
  variant_raw = (clock_seq_hi_and_reserved >> 5)
  result = nil
  if (variant_raw >> 2) == 0
    result = 0x000
  elsif (variant_raw >> 1) == 2
    result = 0x100
  else
    result = variant_raw
  end
  return (result >> 6)
end

#version ⇒ Object

Returns the UUID version type. Possible values: 1 - Time-based with unique or random host identifier 2 - DCE Security version (with POSIX UIDs) 3 - Name-based (MD5 hash) 4 - Random 5 - Name-based (SHA-1 hash)



293
294
295
 
# File 'lib/ext/uuidtools-2.1.1/lib/uuidtools.rb', line 293

def version
  return (time_hi_and_version >> 12)
end