gold-record 0.2.0 → 0.2.1

data/HISTORY.rdoc

@@ -1,3 +1,7 @@
+=== Version 0.2.1 (2009-12-06)
+
+* Sets version nibble and reserved bits in generated UUID values (per RFC 4122), leaving 122 bits for random data. This restores behavior present in version 0.1.0.
+
 === Version 0.2.0 (2009-12-06)
 
 This version replaces ID generation and parsing code from UUIDTools with smaller/faster implementation using pack and SecureRandom directly.

data/README.rdoc

@@ -1,5 +1,7 @@
 = GoldRecord
 
+Unobtrusive binary UUIDs for ActiveRecord.
+
 * http://github.com/ydnar/gold-record
 * http://gemcutter.org/gems/gold-record
 * mailto:randy@shaderlab.com
@@ -10,11 +12,12 @@ GoldRecord is an extension for ActiveRecord that implements unobtrusive binary U
 
 == FEATURES
 
+GoldRecord supports SchemaDumper by not declaring the <tt>id</tt> column a <tt>PRIMARY KEY</tt>. The odds of a random UUID collision are documented here[http://en.wikipedia.org/wiki/Universally_Unique_Identifier#Random_UUID_probability_of_duplicates].
+
 * Uses space-efficient 16-byte binary representation for UUIDs.
 * Works with associations, migrations and ActiveRecord::SchemaDumper.
-* Transparently converts to/from hex-encoded UUIDs in #to_param and #find.
-
-GoldRecord supports SchemaDumper by not declaring the <tt>id</tt> column a <tt>PRIMARY KEY</tt>. The odds of a random UUID collision are documented here[http://en.wikipedia.org/wiki/Universally_Unique_Identifier#Random_UUID_probability_of_duplicates].
+* Transparently converts to hex-encoded UUIDs in #to_param.
+* Transparently handles binary, hex-encoded and URL-safe Base64 UUIDs in #find.
 
 == SYNOPSIS
 
@@ -35,24 +38,33 @@ GoldRecord supports SchemaDumper by not declaring the <tt>id</tt> column a <tt>P
     validates_uniqueness_of :lottery_number, :on => :create
   end
 
+== FIXTURES
+
+  # In test/helper.rb or spec_helper.rb:
+  require 'active_record/fixtures'
+  Fixtures.send :include, GoldRecord::Fixtures
+
 == MIGRATIONS
 
   class MakeGoldRecords < ActiveRecord::Migration
+    TABLES = [:labels, :record_stores]
+    ASSOCIATIONS = [
+      [:artists, :label_id, :id],
+      [:labels_record_stores, :label_id, false],
+      [:labels_record_stores, :record_store_id, false],
+      [:artists_record_stores, :record_store_id, false],
+    ]
+
     def self.up
       # Change each int(11) id column to binary(16).
       # This preserves the column’s original value as a right-padded 16-byte string.
-      [:labels, :record_stores].each do |table|
+      TABLES.each do |table|
         change_integer_primary_key_to_uuid(table)
         add_index table, :id
       end
 
       # Change association columns to binary(16).
-      [
-        [:artists, :label_id, :id],
-        [:labels_record_stores, :label_id, false],
-        [:labels_record_stores, :record_store_id, false],
-        [:artists_record_stores, :record_store_id, false],
-      ].each do |table, column, primary_key|
+      ASSOCIATIONS.each do |table, column, primary_key|
         change_integer_to_uuid(table, column, primary_key)
       end
     end
@@ -65,18 +77,13 @@ GoldRecord supports SchemaDumper by not declaring the <tt>id</tt> column a <tt>P
     def self.down
       # Change each binary(16) id column to int(11).
       # MySQL casts the string value to an integer.
-      [:labels, :record_stores].each do |table|
+      TABLES.each do |table|
         remove_index table, :id
         change_uuid_to_integer_primary_key(table)
       end
 
       # Change association columns to int(11).
-      [
-        [:artists, :label_id, :id],
-        [:labels_record_stores, :label_id, false],
-        [:labels_record_stores, :record_store_id, false],
-        [:artists_record_stores, :record_store_id, false],
-      ].each do |table, column|
+      ASSOCIATIONS.each do |table, column|
         change_uuid_to_integer(table, column, primary_key)
       end
     end

data/lib/gold_record/uuid.rb

@@ -3,7 +3,14 @@ require 'securerandom'
 module GoldRecord
   module UUID
     def self.random_generate
-      SecureRandom.random_bytes(16)
+      bin = SecureRandom.random_bytes(16)
+      # Set version 4
+      bin[6] &= 0b01001111
+      bin[6] |= 0b01000000
+      # Set reserved bits
+      bin[8] &= 0b10111111
+      bin[8] |= 0b10000000
+      bin
     end
   
     def self.coerce(value)

data/lib/gold_record/version.rb

@@ -2,7 +2,7 @@ module GoldRecord
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 2
-    TINY  = 0
+    TINY  = 1
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/test/cases/random_generate_test.rb

@@ -2,12 +2,32 @@ require 'cases/helper'
 
 class RandomGenerateTest < ActiveRecord::TestCase
   def test_size_of_generated_string
-    assert_equal 16, GoldRecord::UUID.random_generate.size
+    1000.times do
+      assert_equal 16, GoldRecord::UUID.random_generate.size
+    end
+  end
+  
+  # 00000000-0000-4000-8000-000000000000
+  # ffffffff-ffff-4fff-bfff-ffffffffffff
+  
+  def test_version_nibble
+    1000.times do
+      value = GoldRecord::UUID.random_generate
+      assert_equal (value[6] & 0xf0), 0x40
+    end
+  end
+
+  def test_reserved_bits
+    1000.times do
+      value = GoldRecord::UUID.random_generate
+      assert_equal (value[8] & 0x80), 0x80
+      assert_equal (value[8] & 0x40), 0x00
+    end
   end
   
   def test_randomness # This is kind of weak.
     cache = {}
-    10000.times do
+    1000.times do
       value = GoldRecord::UUID.random_generate
       assert !cache.has_key?(value)
       cache[value] = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gold-record
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Randy Reddig
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-06 00:00:00 +00:00
+date: 2009-12-07 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency