typed_uuid 4.0.rc2 → 4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 581721d0683d1e3bf4bfa2c4bc29d4a7f5079854c85d98d8672e2f9bec6934e9
-  data.tar.gz: cb660ea624b3be55d02084ca8175035ade7774604a7428cb4555fa00e95460e6
+  metadata.gz: eb375ca568f121a2a996b9afd41123e18b820621e4417b2bce05024364eef414
+  data.tar.gz: 15d885d11a1dbcb19ca60733312ad0b21bcf77a0f9ce165ce8b25fa24f43cecf
 SHA512:
-  metadata.gz: 25835d74e2cf54a76f4be490f95fa98e5b0cbde8ddec6bafdd990a17d9a900fa7033f15f63a4be23609ae1164d686132a0472bec2e168d93f19e6204af1ab315
-  data.tar.gz: 8dcd77488ddd9f45bba84db7faec4b3e1f37c4258df3dc6273bee7eef1b620799cd725d56338759dc1d488aece3c32102a7364232e03183fa123cef481aa0543
+  metadata.gz: 38c295658ce41fac5b51c27fdb4df1922ef426e71c2bb234e7af0e0b87abdb11e8110c3e4604e84909f30aa4a3fd2782b740b443aae9ee926fc7ad567a31a8f6
+  data.tar.gz: 42139374aa96e9a43b5f0f7d749a410617fa14c1affd0fa334e1fe59661189fb58d911b26056aa9e5cc6092709db6ab62541c88f788be54cfe946f45bca5868c

data/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    name: TypedUUID Test
+    runs-on: ubuntu-20.04
+
+    steps:
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+
+      - uses: actions/checkout@v2
+
+      - run: |
+          sudo systemctl start postgresql.service
+          sudo -u postgres createuser runner --superuser
+          sudo -u postgres createdb uuid-types-test
+
+      - run: bundle
+
+      - run: bundle exec rake test

data/README.md

@@ -35,9 +35,17 @@ As with regular UUID Typed UUIDs come in multiple version. The current versions
              bits or a sequence counter. Then 8 random bits followed by 16 bits
              which are the UUID type.
 
+- Version 3: A name-based UUID where the first 112 bits are based off the MD5
+             digest of the namespace and name. The following 16 bits are the
+             UUID type.
+
 - Version 4: A random UUID where the first 112 bits are random. The following
              16 bits are the UUID type.
 
+- Version 5: A name-based UUID where the first 112 bits are based off the SHA1
+             digest of the namespace and name. The following 16 bits are the
+             UUID type.
+
 ## Install
 
 Add this to your Gemfile:
@@ -74,7 +82,7 @@ a table.
 
 ```ruby
 class CreateProperties < ActiveRecord::Migration[5.2]
-  def change	
+  def change
 	create_table :properties, id: :typed_uuid do |t|
       t.string "name", limit: 255
     end
@@ -88,19 +96,19 @@ To add a typed UUID to an existing table:
 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

data/lib/typed_uuid.rb

@@ -1,52 +1,69 @@
+require 'digest/sha1'
+
 module TypedUUID
   autoload :ActiveRecord, 'typed_uuid/active_record'
   autoload :PsqlColumnMethods, 'typed_uuid/psql_column_methods'
   autoload :PsqlSchemaDumper, 'typed_uuid/psql_schema_dumper'
-  
-  def self.uuid(enum, version = 4, **options)
-    if enum < 0 || enum > 8_191
-      raise ArgumentError, "UUID type must be between 0 and 8,191"
+
+  class << self
+
+    def uuid(enum, version = 4, **options)
+      if enum < 0 || enum > 8_191
+        raise ArgumentError, "UUID type must be between 0 and 8,191"
+      end
+
+      case version
+      when 1
+        timestamp_uuid(enum, **options)
+      when 3
+        namebased_uuid(enum, digester: Digest::MD5, **options)
+      when 4
+        random_uuid(enum, **options)
+      when 5
+        namebased_uuid(enum, digester: Digest::SHA1, **options)
+      end
     end
-    
-    if version == 1
-      timestamp_uuid(enum, **options)
-    elsif version == 4
-      random_uuid(enum, **options)
+
+    def random_uuid(enum)
+      uuid = SecureRandom.random_bytes(16).unpack("nnnnnnnn")
+
+      uuid[7] = (uuid[2] ^ uuid[6]) ^ ((enum << 3) | 4)
+      "%04x%04x-%04x-%04x-%04x-%04x%04x%04x" % uuid
     end
-  end
-  
-  def self.random_uuid(enum)
-    uuid = SecureRandom.random_bytes(16).unpack("nnnnnnnn")
-    
-    uuid[7] = (uuid[2] ^ uuid[6]) ^ ((enum << 3) | 4)
-    "%04x%04x-%04x-%04x-%04x-%04x%04x%04x" % uuid
-  end
-  
-  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[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[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[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..13].to_i(16).divmod(1_000_000), :usec)
+
+    def 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[7] = (uuid[2] ^ uuid[6]) ^ ((enum << 3) | 1)
+      "%04x%04x-%04x-%04x-%04x-%04x%04x%04x" % uuid
+    end
+
+    def namebased_uuid(enum, digester:, name:, namespace: "")
+      uuid = digester.digest(name + namespace).unpack("nnnnnnnn")
+      uuid[7] = (uuid[2] ^ uuid[6]) ^ ((enum << 3) | 5)
+      "%04x%04x-%04x-%04x-%04x-%04x%04x%04x" % uuid
+    end
+
+    def enum(uuid)
+      uuid = uuid.gsub('-', '')
+      ((uuid[8..11].to_i(16) ^ uuid[24..27].to_i(16)) ^ uuid[28..31].to_i(16)) >> 3
+    end
+
+    def version(uuid)
+      uuid = uuid.gsub('-', '')
+      ((uuid[8..11].to_i(16) ^ uuid[24..27].to_i(16)) ^ uuid[28..31].to_i(16)) & 0b0000000000000111
+    end
+
+    def timestamp(uuid)
+      uuid = uuid.gsub('-', '')
+      Time.at(*uuid[0..13].to_i(16).divmod(1_000_000), :usec)
+    end
+
   end
 end
 
-require 'typed_uuid/railtie' if defined? Rails
+require 'typed_uuid/railtie' if defined? Rails

data/lib/typed_uuid/railtie.rb

@@ -2,16 +2,17 @@ class TypedUUID::Railtie < Rails::Railtie
 
   initializer :typed_uuid do |app|
     ActiveRecord::Tasks::DatabaseTasks.migrations_paths << File.expand_path('../../../db/migrate', __FILE__)
-    
+
     ActiveSupport.on_load(:active_record) do
       ActiveRecord::Base.include TypedUUID::ActiveRecord
     end
-    
+
     require 'active_record/connection_adapters/postgresql/schema_definitions'
     ActiveRecord::ConnectionAdapters::PostgreSQL::TableDefinition.include(TypedUUID::PsqlColumnMethods)
-    
+
+    require 'active_record/connection_adapters/abstract/schema_dumper'
     require 'active_record/connection_adapters/postgresql/schema_dumper'
     ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaDumper.prepend(TypedUUID::PsqlSchemaDumper)
   end
 
-end
+end

data/lib/typed_uuid/version.rb

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

data/test/test_helper.rb

@@ -32,7 +32,7 @@ def MiniTest.filter_backtrace(bt)
   bt
 end
 class ActiveSupport::TestCase
-  
+
   # File 'lib/active_support/testing/declarative.rb'
   def self.test(name, &block)
     test_name = "test_#{name.gsub(/\s+/, '_')}".to_sym
@@ -46,31 +46,32 @@ class ActiveSupport::TestCase
       end
     end
   end
-  
+
   def self.schema(&block)
     self.class_variable_set(:@@schema, block)
   end
-  
+
   set_callback(:setup, :before) do
     Rails.stubs(:application).returns(stub(config: stub(eager_load: true)))
     if !self.class.class_variable_defined?(:@@suite_setup_run)
       ActiveRecord::Base.defined_uuid_types.clear
       ActiveRecord::Base.uuid_enum_to_class_cache.clear
       ActiveRecord::Base.class_to_uuid_type_cache.clear
-      
+
       configuration = {
         adapter:  "postgresql",
         database: "uuid-types-test",
         encoding: "utf8"
       }.stringify_keys
-  
-      db_tasks = ActiveRecord::Tasks::PostgreSQLDatabaseTasks.new(configuration)
-      db_tasks.purge
-    
+
       ActiveRecord::Base.establish_connection(configuration)
+
+      db_tasks = ActiveRecord::Tasks::PostgreSQLDatabaseTasks.new(ActiveRecord::Base.connection_db_config)
+      db_tasks.purge
+
       ActiveRecord::Migration.suppress_messages do
         AddTypedUuidFunction.migrate :up
-        
+
         if self.class.class_variable_defined?(:@@schema)
           ActiveRecord::Schema.define(&self.class.class_variable_get(:@@schema))
           ActiveRecord::Migration.execute("SELECT c.relname FROM pg_class c WHERE c.relkind = 'S'").each_row do |row|
@@ -134,7 +135,7 @@ class ActiveSupport::TestCase
       end
     end
   end
-  
+
   class SQLLogger
     class << self
       attr_accessor :ignored_sql, :log, :log_all
@@ -197,5 +198,5 @@ class ActiveSupport::TestCase
   alias :assert_not_predicate :refute_predicate
   alias :assert_not_respond_to :refute_respond_to
   alias :assert_not_same :refute_same
-  
-end
+
+end

data/test/typed_uuid_test.rb

@@ -1,45 +1,45 @@
 require 'test_helper'
 
-class FilterTest < ActiveSupport::TestCase
+class UUIDTest < ActiveSupport::TestCase
 
   schema do
     ActiveRecord::Base.register_uuid_types({
-      'FilterTest::Listing'  => {enum: 0, version: 1},
-      'FilterTest::Building' => 592,
-      'FilterTest::SkyScraper' => {enum: 1_952}
+      'UUIDTest::Listing'  => {enum: 0, version: 1},
+      'UUIDTest::Building' => 592,
+      'UUIDTest::SkyScraper' => {enum: 1_952}
     })
-    
+
     create_table :listings, id: :typed_uuid do |t|
       t.string   "name", limit: 255
     end
-    
+
     create_table :buildings, id: :typed_uuid do |t|
       t.string   "name", limit: 255
       t.string   "type", limit: 255
     end
   end
-  
+
   class Listing < ActiveRecord::Base
   end
-  
+
   class Building < ActiveRecord::Base
   end
-  
+
   class SkyScraper < Building
   end
 
   class SingleFamilyHome < Building
   end
-  
+
   class Property < ActiveRecord::Base
   end
-  
+
   class Lot < ActiveRecord::Base
   end
-  
+
   test 'adding primary key as a typed_uuid in a migration' do
     ActiveRecord::Base.register_uuid_types({
-      1 => 'FilterTest::Property'
+      1 => 'UUIDTest::Property'
     })
 
     exprexted_sql = <<-SQL
@@ -57,7 +57,7 @@ class FilterTest < ActiveSupport::TestCase
 
   test 'adding primary key as a typed_uuid in a migration with a version' do
     ActiveRecord::Base.register_uuid_types({
-      'FilterTest::Lot' => {version: 1, enum: 512}
+      'UUIDTest::Lot' => {version: 1, enum: 512}
     })
 
     exprexted_sql = <<-SQL
@@ -75,58 +75,61 @@ class FilterTest < ActiveSupport::TestCase
 
   test 'typed_uuid' do
     assert_equal 512, TypedUUID.enum(TypedUUID.uuid(512))
-    assert_equal FilterTest::Listing,    ::ActiveRecord::Base.class_from_uuid(Listing.typed_uuid)
-    assert_equal FilterTest::Building,   ::ActiveRecord::Base.class_from_uuid(Building.typed_uuid)
-    assert_equal FilterTest::SkyScraper, ::ActiveRecord::Base.class_from_uuid(SkyScraper.typed_uuid)
-    
+    assert_equal 512, TypedUUID.enum(TypedUUID.uuid(512, 1))
+    assert_equal 512, TypedUUID.enum(TypedUUID.uuid(512, 3, name: "test"))
+    assert_equal 512, TypedUUID.enum(TypedUUID.uuid(512, 5, name: "test"))
+    assert_equal UUIDTest::Listing,    ::ActiveRecord::Base.class_from_uuid(Listing.typed_uuid)
+    assert_equal UUIDTest::Building,   ::ActiveRecord::Base.class_from_uuid(Building.typed_uuid)
+    assert_equal UUIDTest::SkyScraper, ::ActiveRecord::Base.class_from_uuid(SkyScraper.typed_uuid)
+
     assert_raises ArgumentError do
       ::ActiveRecord::Base.class_from_uuid(SingleFamilyHome.typed_uuid)
     end
   end
-  
+
   test 'typed_uuid v1' do
     time = Time.at(1606612254, 370979, :usec)
     Time.stubs(:now).returns(time)
 
     uuid = TypedUUID.uuid(592, 1)
-    
+
     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 'class_from uuid generated bye PostgresQL' do
     listing = Listing.create
     building = Building.create
     skyscraper = SkyScraper.create
-    
-    assert_equal FilterTest::Listing, ::ActiveRecord::Base.class_from_uuid(listing.id)
-    assert_equal FilterTest::Building, ::ActiveRecord::Base.class_from_uuid(building.id)
-    assert_equal FilterTest::SkyScraper, ::ActiveRecord::Base.class_from_uuid(skyscraper.id)
+
+    assert_equal UUIDTest::Listing, ::ActiveRecord::Base.class_from_uuid(listing.id)
+    assert_equal UUIDTest::Building, ::ActiveRecord::Base.class_from_uuid(building.id)
+    assert_equal UUIDTest::SkyScraper, ::ActiveRecord::Base.class_from_uuid(skyscraper.id)
 
     assert_raises ArgumentError do
       SingleFamilyHome.create
     end
   end
-  
+
   test 'class_from v1 uuid generated bye PostgresQL' do
     listing = Listing.create
-    
+
     assert_equal Listing, ::ActiveRecord::Base.class_from_uuid(listing.id)
   end
-  
+
   test 'uuid_enum from table_name' do
     assert_equal 0, ::ActiveRecord::Base.uuid_enum_from_table_name(:listings)
     assert_equal 0, ::ActiveRecord::Base.uuid_enum_from_table_name('listings')
-    
+
     assert_equal 592, ::ActiveRecord::Base.uuid_enum_from_table_name(:buildings)
   end
-  
+
   test 'uuid_version from table_name' do
     assert_equal 1, ::ActiveRecord::Base.uuid_version_from_table_name(:listings)
     assert_equal 1, ::ActiveRecord::Base.uuid_version_from_table_name('listings')
@@ -144,11 +147,11 @@ class FilterTest < ActiveSupport::TestCase
     assert_equal 4, ::ActiveRecord::Base.uuid_version_from_class(Building)
     assert_equal 4, ::ActiveRecord::Base.uuid_version_from_class(SkyScraper)
   end
-  
+
   test 'class from uuid_enum' do
-    assert_equal FilterTest::Listing, ::ActiveRecord::Base.class_from_uuid_enum(0)
-    assert_equal FilterTest::Building, ::ActiveRecord::Base.class_from_uuid_enum(592)
-    assert_equal FilterTest::SkyScraper, ::ActiveRecord::Base.class_from_uuid_enum(1_952)
+    assert_equal UUIDTest::Listing, ::ActiveRecord::Base.class_from_uuid_enum(0)
+    assert_equal UUIDTest::Building, ::ActiveRecord::Base.class_from_uuid_enum(592)
+    assert_equal UUIDTest::SkyScraper, ::ActiveRecord::Base.class_from_uuid_enum(1_952)
   end
-  
-end
+
+end

data/typed_uuid.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  # Developoment 
+  # Developoment
   s.add_development_dependency 'rake'
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'minitest'
@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'activesupport', '>= 6.0.0'
   s.add_development_dependency 'rails', '>= 6.0.0'
   s.add_development_dependency 'pg'
-  
+
   # Runtime
   s.add_runtime_dependency 'activerecord', '>= 6.0.0'
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typed_uuid
 version: !ruby/object:Gem::Version
-  version: 4.0.rc2
+  version: '4.0'
 platform: ruby
 authors:
 - Jon Bracy
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-21 00:00:00.000000000 Z
+date: 2021-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -171,6 +171,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".tm_properties"
 - Gemfile
@@ -201,9 +202,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.2.3
 signing_key: