typed_uuid 4.0 → 4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb375ca568f121a2a996b9afd41123e18b820621e4417b2bce05024364eef414
-  data.tar.gz: 15d885d11a1dbcb19ca60733312ad0b21bcf77a0f9ce165ce8b25fa24f43cecf
+  metadata.gz: 9dd0a928d842b001570b023cace562666b6f391623fd27ca1c6b88cebd58ed3a
+  data.tar.gz: '09ea1aee57794d976b79c8bd221e1894519994603f8112bd4ffb55966b3082c6'
 SHA512:
-  metadata.gz: 38c295658ce41fac5b51c27fdb4df1922ef426e71c2bb234e7af0e0b87abdb11e8110c3e4604e84909f30aa4a3fd2782b740b443aae9ee926fc7ad567a31a8f6
-  data.tar.gz: 42139374aa96e9a43b5f0f7d749a410617fa14c1affd0fa334e1fe59661189fb58d911b26056aa9e5cc6092709db6ab62541c88f788be54cfe946f45bca5868c
+  metadata.gz: 5123b6d3291005d87ae8ed4fd1fefe9b55f10d83cde474367d9e136ff625a80a7bae221584a92c297f3a32e2b33e5a0c81bb3124b7acacb4bd82a28df94e4e82
+  data.tar.gz: 7e96e3a5376fdcd87ba3a0c89e0e1511707000d280aa17c52d618d6f7c150eb3ff33bf23102c6dfdbfe04b6b91dccf94f984d94d66e38b3830c89c23516ce805

data/README.md

@@ -70,7 +70,7 @@ ActiveRecord::Base.register_uuid_types({
 ActiveRecord::Base.register_uuid_types({
   0         => :Listing,
   512       => :Building,
-  8_191    => 'Building::SkyScrpaer'
+  8_191     => 'Building::SkyScrpaer'
 })
 ```
 
@@ -83,7 +83,7 @@ a table.
 ```ruby
 class CreateProperties < ActiveRecord::Migration[5.2]
   def change
-	create_table :properties, id: :typed_uuid do |t|
+    create_table :properties, id: :typed_uuid do |t|
       t.string "name", limit: 255
     end
   end
@@ -116,6 +116,12 @@ class UpdateProperties < ActiveRecord::Migration[6.1]
   end
 ```
 
+When you need to lookup they class of a TypedUUID:
+
+```ruby
+ActiveRecord::Base.class_from_uuid(my_uuid) #=> MyClass
+```
+
 ## 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.

data/lib/typed_uuid/version.rb

@@ -1,3 +1,3 @@
 module TypedUUID
-  VERSION = '4.0'
+  VERSION = '4.1'
 end

data/lib/typed_uuid.rb

@@ -35,7 +35,22 @@ module TypedUUID
       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 << if sequence.nil?
+        SecureRandom.random_bytes(8)
+      elsif sequence.is_a?(Integer)
+        sequence = [sequence].pack("Q>")
+        if sequence.bytesize == 8 && sequence[0..1] == "\x00\x00"
+          sequence[2..]
+        else
+          raise ArgumentError, 'Sequence is more than 6 bytes'
+        end
+      elsif sequence.is_a?(String)
+        raise ArgumentError, 'Sequence is more than 6 bytes' if sequence.bytesize > 6
+        sequence.b
+      else
+        raise ArgumentError, 'Unable to convert sequence to binary'
+      end
+      uuid << SecureRandom.random_bytes(4)
 
       uuid = uuid.unpack("nnnnnnnn")
       uuid[7] = (uuid[2] ^ uuid[6]) ^ ((enum << 3) | 1)
@@ -63,6 +78,15 @@ module TypedUUID
       Time.at(*uuid[0..13].to_i(16).divmod(1_000_000), :usec)
     end
 
+    def sequence_b(uuid)
+      uuid = uuid.gsub('-', '')
+      uuid[14..25].scan(/.{4}/).map{|i| i.to_i(16) }.pack('n*').b
+    end
+    
+    def sequence(uuid)
+      ("\x00\x00" + sequence_b(uuid)).unpack1('Q>')
+    end
+
   end
 end
 

data/test/typed_uuid_test.rb

@@ -102,6 +102,42 @@ class UUIDTest < ActiveSupport::TestCase
 
     assert_equal Listing, ::ActiveRecord::Base.class_from_uuid(Listing.typed_uuid)
   end
+  
+  test 'typed_uuid v1 with a timestamp' do
+    time = Time.at(1606612254, 370979, :usec)
+    uuid = TypedUUID.uuid(592, 1, timestamp: time)
+
+    assert_equal 1,   TypedUUID.version(uuid)
+    assert_equal 592, TypedUUID.enum(uuid)
+
+    assert_equal time,      TypedUUID.timestamp(uuid)
+    assert_equal time.to_i, TypedUUID.timestamp(uuid).to_i
+    assert_equal time.nsec, TypedUUID.timestamp(uuid).nsec
+
+    assert_equal Listing, ::ActiveRecord::Base.class_from_uuid(Listing.typed_uuid)
+  end
+  
+  test 'typed_uuid v1 with sequence as a string' do
+    uuid = TypedUUID.uuid(592, 1, sequence: '123456')
+
+    assert_equal 1,               TypedUUID.version(uuid)
+    assert_equal 592,             TypedUUID.enum(uuid)
+    assert_equal 54091677185334,  TypedUUID.sequence(uuid)
+    assert_equal '123456',        TypedUUID.sequence_b(uuid)
+
+    assert_equal Listing, ::ActiveRecord::Base.class_from_uuid(Listing.typed_uuid)
+  end
+  
+  test 'typed_uuid v1 with sequence as a integer' do
+    uuid = TypedUUID.uuid(592, 1, sequence: 123456)
+
+    assert_equal 1,                         TypedUUID.version(uuid)
+    assert_equal 592,                       TypedUUID.enum(uuid)
+    assert_equal 123456,                    TypedUUID.sequence(uuid)
+    assert_equal "\x00\x00\x00\x01\xE2@".b, TypedUUID.sequence_b(uuid)
+
+    assert_equal Listing, ::ActiveRecord::Base.class_from_uuid(Listing.typed_uuid)
+  end
 
   test 'class_from uuid generated bye PostgresQL' do
     listing = Listing.create

data/typed_uuid.gemspec

@@ -23,9 +23,9 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'mocha'
   s.add_development_dependency 'byebug'
   s.add_development_dependency 'activesupport', '>= 6.0.0'
-  s.add_development_dependency 'rails', '>= 6.0.0'
+  s.add_development_dependency 'rails', '>= 6.1.0'
   s.add_development_dependency 'pg'
 
   # Runtime
-  s.add_runtime_dependency 'activerecord', '>= 6.0.0'
+  s.add_runtime_dependency 'activerecord', '>= 6.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typed_uuid
 version: !ruby/object:Gem::Version
-  version: '4.0'
+  version: '4.1'
 platform: ruby
 authors:
 - Jon Bracy
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-02 00:00:00.000000000 Z
+date: 2021-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 6.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 6.1.0
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 6.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 6.1.0
 description: Typed UUIDs 2 bytes are reserved in the UUID for the class enum
 email:
 - jonbracy@gmail.com