typed_uuid 4.0.rc1 → 4.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 956d3f40e94a40968f9e66ae955a0eb4ca0a0d5e7c0a307e846a6bc329970108
-  data.tar.gz: 49844d2082da751bc4d36dede69bdd927bb93269a8caadcaee20916a66e56c4f
+  metadata.gz: 581721d0683d1e3bf4bfa2c4bc29d4a7f5079854c85d98d8672e2f9bec6934e9
+  data.tar.gz: cb660ea624b3be55d02084ca8175035ade7774604a7428cb4555fa00e95460e6
 SHA512:
-  metadata.gz: 5e4792f1bf817f6d3edf9b958ce843ddbda5d9fbb1286629a4cd91acdc56581d239e167b1808d580d5139233c1a74cc0aae3f88adc5585542413196735f6c7ea
-  data.tar.gz: 143e55145e97eb7dd177d2d2785c03f8267cdad624a40cd52ce628c66194ae155c6d852b564eecdf991399e62c05ae1b48837698f362239aff6e2774a5b9ef1c
+  metadata.gz: 25835d74e2cf54a76f4be490f95fa98e5b0cbde8ddec6bafdd990a17d9a900fa7033f15f63a4be23609ae1164d686132a0472bec2e168d93f19e6204af1ab315
+  data.tar.gz: 8dcd77488ddd9f45bba84db7faec4b3e1f37c4258df3dc6273bee7eef1b620799cd725d56338759dc1d488aece3c32102a7364232e03183fa123cef481aa0543

data/README.md

@@ -10,10 +10,10 @@ a hex representation of 4 bits.
 - M is 4 bits and is the Version
 - N is 3 bits and is the Variant of the Version followed a bit
 
-We modify this and use the following structure where the 9th & 10th bytes in the
-UUID are the enum XORed with the result of XORing bytes 7 & 8 with bytes 11 & 12.
+We modify this and use the following structure where the 15th & 16th bytes in the
+UUID are the enum XORed with the result of XORing bytes 5 & 6 with bytes 13 & 14.
 
-`xxxxxxxx-xxxx-YYYY-TTTT-ZZZZxxxxxxxx`
+`xxxxxxxx-YYYY-xxxx-xxxx-xxxxZZZZTTTT`
 
 Where:
 
@@ -23,19 +23,20 @@ Where:
 - YYYY bytes XORed with ZZZZ and the Type ENUM to produce the identifying bytes
 - ZZZZ bytes XORed with YYYY and the Type ENUM to produce the identifying bytes
 
-XORing bytes 7 & 8 with 11 & 12 and XORing again with bytes 9 & 10 of the
+XORing bytes 5 & 6 with 13 & 14 and XORing again with bytes 15 & 16 of the
 Typed UUID will give us back the ENUM and Version of the Type using soley the UUID.
 
 ## Versions
 
 As with regular UUID Typed UUIDs come in multiple version. The current versions are:
 
-- Version 1: A timebased UUID where the first 64 bits are an unsigned integer
-             representing the nanoseconds since epoch. The following 16 bits are
-             the UUID type folled by 48 random bits.
+- Version 1: A timebased UUID where the first 56 bits are an unsigned integer
+             representing the microseconds since epoch. Followed by 48 random
+             bits or a sequence counter. Then 8 random bits followed by 16 bits
+             which are the UUID type.
 
-- Version 4: A random UUID where the first 64 bits are random. The following
-             16 bits are the UUID type folled by another 48 random bits.
+- Version 4: A random UUID where the first 112 bits are random. The following
+             16 bits are the UUID type.
 
 ## Install
 
@@ -81,10 +82,36 @@ class CreateProperties < ActiveRecord::Migration[5.2]
 end
 ```
 
+To add a typed UUID to an existing table:
+
+```ruby
+class UpdateProperties < ActiveRecord::Migration[6.1]
+  def change
+    klass_enum = ::ActiveRecord::Base.uuid_type_from_table_name(:properties)
+    
+    # Add the column
+    add_column :properties, :typed_uuid, :uuid, default: -> { "typed_uuid('\\x#{klass_enum.to_s(16).rjust(4, '0')}')" }
+    
+    # Update existing properties with a new typed UUID
+    execute "UPDATE properties SET id = typed_uuid('\\x#{klass_enum.to_s(16).rjust(4, '0')}');"
+    
+    # Add null constraint since we'll swap these out for the primary key
+    change_column_null :properties, :typed_uuid, false
+    
+    # TODO: Here you will want to update any reference to the old primary key
+    # with the new typed_uuid that will be the new primary key.
+    
+    # Replace the old primary key with the typed_uuid
+    execute "ALTER TABLE properties DROP CONSTRAINT properties_pkey;"
+    rename_column :properties, :typed_uuid, :id
+    execute "ALTER TABLE properties ADD PRIMARY KEY (id);"
+  end
+```
+
 ## STI Models
 When using STI Model Rails will generate the UUID to be inserted. This UUID will
 be calculated of the STI Model class and not the base class.
 
 In the migration you can still used `id: :typed_uuid`, this will use the base
 class to calculated the default type for the UUID. You could also set the
-`id` to `:uuid` and the `default` to `false` so when no ID is given it will error.
+`id` to `:uuid` and the `default` to `false` so when no ID is given it will error.

data/db/migrate/20191222234546_add_typed_uuid_function.rb

@@ -12,17 +12,16 @@ class AddTypedUuidFunction < ActiveRecord::Migration[6.0]
         BEGIN
           IF version = 1 THEN
             bytes := decode(concat(
-                to_hex((extract(epoch from clock_timestamp())*1000000000)::bigint),
-                encode(gen_random_bytes(8), 'hex')
+                lpad(right(to_hex((extract(epoch from clock_timestamp())*1000000)::bigint), 12), 12, '0'),
+                encode(gen_random_bytes(10), 'hex')
             ), 'hex');
           ELSE
             bytes := gen_random_bytes(16);
-            version := 4;
           END IF;
 
           type := decode( lpad(to_hex(((enum << 3) | version)), 4, '0'), 'hex');
-          bytes := set_byte(bytes, 8, (get_byte(bytes, 6) # get_byte(bytes, 10)) # get_byte(type, 0));
-          bytes := set_byte(bytes, 9, (get_byte(bytes, 7) # get_byte(bytes, 11)) # get_byte(type, 1));
+          bytes := set_byte(bytes, 14, (get_byte(bytes, 4) # get_byte(bytes, 12)) # get_byte(type, 0));
+          bytes := set_byte(bytes, 15, (get_byte(bytes, 5) # get_byte(bytes, 13)) # get_byte(type, 1));
           
           RETURN encode( bytes, 'hex') :: uuid;
         END;

data/lib/typed_uuid.rb

@@ -3,49 +3,50 @@ module TypedUUID
   autoload :PsqlColumnMethods, 'typed_uuid/psql_column_methods'
   autoload :PsqlSchemaDumper, 'typed_uuid/psql_schema_dumper'
   
-  def self.uuid(enum, version = 4)
+  def self.uuid(enum, version = 4, **options)
     if enum < 0 || enum > 8_191
       raise ArgumentError, "UUID type must be between 0 and 8,191"
     end
     
     if version == 1
-      timestamp_uuid(enum)
+      timestamp_uuid(enum, **options)
     elsif version == 4
-      random_uuid(enum)
+      random_uuid(enum, **options)
     end
   end
   
   def self.random_uuid(enum)
     uuid = SecureRandom.random_bytes(16).unpack("nnnnnnnn")
     
-    uuid[4] = (uuid[3] ^ uuid[5]) ^ ((enum << 3) | 4)
+    uuid[7] = (uuid[2] ^ uuid[6]) ^ ((enum << 3) | 4)
     "%04x%04x-%04x-%04x-%04x-%04x%04x%04x" % uuid
   end
-
-  def self.timestamp_uuid(enum)
-    time = Time.now
-    uuid = [time.to_i * 1_000_000_000 + time.nsec].pack('Q>')
-    uuid << SecureRandom.random_bytes(8)
-
+  
+  def self.timestamp_uuid(enum, timestamp: nil, sequence: nil)
+    timestamp  ||= Time.now
+    
+    uuid = [timestamp.to_i * 1_000_000 + timestamp.usec].pack('Q>')[1..-1]
+    uuid << (sequence&.pack('Q>') || SecureRandom.random_bytes(10))
+    
     uuid = uuid.unpack("nnnnnnnn")
-    uuid[4] = (uuid[3] ^ uuid[5]) ^ ((enum << 3) | 1)
+    uuid[7] = (uuid[2] ^ uuid[6]) ^ ((enum << 3) | 1)
     "%04x%04x-%04x-%04x-%04x-%04x%04x%04x" % uuid
   end
   
   def self.enum(uuid)
     uuid = uuid.gsub('-', '')
-    ((uuid[12..15].to_i(16) ^ uuid[20..23].to_i(16)) ^ uuid[16..19].to_i(16)) >> 3
+    ((uuid[8..11].to_i(16) ^ uuid[24..27].to_i(16)) ^ uuid[28..31].to_i(16)) >> 3
   end
   
   def self.version(uuid)
     uuid = uuid.gsub('-', '')
-    ((uuid[12..15].to_i(16) ^ uuid[20..23].to_i(16)) ^ uuid[16..19].to_i(16)) & 0b0000000000000111
+    ((uuid[8..11].to_i(16) ^ uuid[24..27].to_i(16)) ^ uuid[28..31].to_i(16)) & 0b0000000000000111
   end
   
   def self.timestamp(uuid)
     uuid = uuid.gsub('-', '')
-    Time.at(*uuid[0..15].to_i(16).divmod(1_000_000_000), :nsec)
+    Time.at(*uuid[0..13].to_i(16).divmod(1_000_000), :usec)
   end
 end
 
-require 'typed_uuid/railtie' if defined? Rails
+require 'typed_uuid/railtie' if defined? Rails

data/lib/typed_uuid/active_record.rb

@@ -64,8 +64,8 @@ module TypedUUID::ActiveRecord
       !!class_to_uuid_type_cache[self.base_class]
     end
     
-    def typed_uuid
-      TypedUUID.uuid(uuid_enum_from_class(self), uuid_version_from_class(self))
+    def typed_uuid(**options)
+      TypedUUID.uuid(uuid_enum_from_class(self), uuid_version_from_class(self), **options)
     end
     
     def uuid_enum_from_table_name(table)

data/lib/typed_uuid/psql_schema_dumper.rb

@@ -6,15 +6,27 @@ module TypedUUID::PsqlSchemaDumper
   ## These are functions that must be enabled in order to support typed_uuids
   ## in this database
   execute <<-SQL
-    CREATE OR REPLACE FUNCTION typed_uuid(t bytea) RETURNS uuid AS $$
-      DECLARE
-        bytes bytea := gen_random_bytes(16);
-        uuid bytea;
-      BEGIN
-        bytes := set_byte(bytes, 6, (get_byte(bytes, 4) # get_byte(bytes, 8)) # get_byte(t, 0));
-        bytes := set_byte(bytes, 7, (get_byte(bytes, 5) # get_byte(bytes, 9)) # get_byte(t, 1));
-        RETURN encode( bytes, 'hex') :: uuid;
-      END;
+    CREATE OR REPLACE FUNCTION typed_uuid(enum int, version int default 4)
+    RETURNS uuid AS $$
+    DECLARE
+      bytes bytea;
+      type bytea;
+    BEGIN
+      IF version = 1 THEN
+        bytes := decode(concat(
+            lpad(right(to_hex((extract(epoch from clock_timestamp())*1000000)::bigint), 12), 12, '0'),
+            encode(gen_random_bytes(10), 'hex')
+        ), 'hex');
+      ELSE
+        bytes := gen_random_bytes(16);
+      END IF;
+
+      type := decode( lpad(to_hex(((enum << 3) | version)), 4, '0'), 'hex');
+      bytes := set_byte(bytes, 14, (get_byte(bytes, 4) # get_byte(bytes, 12)) # get_byte(type, 0));
+      bytes := set_byte(bytes, 15, (get_byte(bytes, 5) # get_byte(bytes, 13)) # get_byte(type, 1));
+    
+      RETURN encode( bytes, 'hex') :: uuid;
+    END;
     $$ LANGUAGE plpgsql;
   SQL
 

data/lib/typed_uuid/version.rb

@@ -1,3 +1,3 @@
 module TypedUUID
-  VERSION = '4.0.rc1'
+  VERSION = '4.0.rc2'
 end

data/test/test_helper.rb

@@ -28,7 +28,9 @@ module ActiveRecord::Tasks::DatabaseTasks
 end
 TypedUUID::Railtie.initializers.each(&:run)
 Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
-
+def MiniTest.filter_backtrace(bt)
+  bt
+end
 class ActiveSupport::TestCase
   
   # File 'lib/active_support/testing/declarative.rb'

data/test/typed_uuid_test.rb

@@ -85,7 +85,7 @@ class FilterTest < ActiveSupport::TestCase
   end
   
   test 'typed_uuid v1' do
-    time = Time.at(1606612254, 370979123, :nsec)
+    time = Time.at(1606612254, 370979, :usec)
     Time.stubs(:now).returns(time)
 
     uuid = TypedUUID.uuid(592, 1)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typed_uuid
 version: !ruby/object:Gem::Version
-  version: 4.0.rc1
+  version: 4.0.rc2
 platform: ruby
 authors:
 - Jon Bracy
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-30 00:00:00.000000000 Z
+date: 2021-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -205,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Typed UUIDs for ActiveRecord