typed_uuid 2.3 → 3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42ecd88d5a86ad89fe9a8c0cd8ec275bfded2d66ce7a7bd240f43184d0fe65ab
-  data.tar.gz: 2b32e8528b4d5dc750c54b8818ccb0fcbb99ea4d5276ece385d8af8f2f70c259
+  metadata.gz: 43aee2470b269097c2a79848c41aaa7e2dc490b097ed0ec38e5c5dba2cc46fb1
+  data.tar.gz: de4d70c9c051f43d14acf0f1c32b4f5e9428038e68c28e63cf41593a38294f7f
 SHA512:
-  metadata.gz: 2bacb4da4092347b9a483711e7e4530979bf2b135d03bc77f03599851463c21041dbef6b566c0ba6d151c1d2c516a4ca98caa150592888f2a3c85ec941dd060d
-  data.tar.gz: 7e4dd50dbd81e87934f04daf4bf94ed89f7bac9f024e23886bc3c401d626137de664aa8a8e087d02cb57f1193309159a5c6a97ac5b9258ab326c787669f427dc
+  metadata.gz: df59f77e9cad353ade579c091532197fcc4363dba10ab2c4914c3379d839648a0c1d56bea3f42925189e6bbc9996bb98894dbe625749950a817e099c2503db37
+  data.tar.gz: 0a047a6fed326adb9880d92138cc390faf7670fa60319b219725998fec3a15b42be239f05934e2d4a4bfd3ad0dfea43aa33c24a01030df79a62130c9ac04d81c

data/README.md

@@ -33,24 +33,27 @@ Add this to your Gemfile:
 `gem 'typed_uuid'`
 
 Once bundled you can add an initializer to Rails to register your types as shown
-below. This maps the __table_names__ of the models to an integer between 0 and 255.
+below. This maps the __Model Classes__ to an integer between 0 and 65,535.
 
 ```ruby
 # config/initializers/uuid_types.rb
 
 ActiveRecord::Base.register_uuid_types({
-  listings: 	0,
-  buildings: 	65_535
+  Listing: 	                0,
+  Building:                 512,
+  'Building::SkyScrpaer' => 65_535
 })
 
 # Or:
 
 ActiveRecord::Base.register_uuid_types({
-  0 		=> :listings,
-  65_535 	=> :buildings
+  0         => :Listing,
+  512       => :Building,
+  65_535    => 'Building::SkyScrpaer'
 })
 ```
 
+
 ## Usage
 
 In your migrations simply replace `id: :uuid` with `id: :typed_uuid` when creating
@@ -64,4 +67,12 @@ class CreateProperties < ActiveRecord::Migration[5.2]
     end
   end
 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.

data/lib/typed_uuid/active_record.rb

@@ -1,79 +1,105 @@
+require 'active_support/concern'
+
 module TypedUUID::ActiveRecord
+  extend ActiveSupport::Concern
   
   UUID_TYPE_CONFLICT_MESSAGE = \
-    "You tried to define an UUID type %{int} for \"%{table}\", but " \
+    "You tried to define an UUID type %{int} for \"%{class_name}\", but " \
     " %{int} is already defined as the type for %{other}"
-  
-  def self.extended(base) # :nodoc:
-    base.class_attribute(:defined_uuid_types, instance_writer: false, default: {})
-    base.class_attribute(:uuid_type_cache, instance_writer: false, default: {})
+
+  included do
+    class_attribute(:defined_uuid_types, instance_writer: false, default: {})
+    class_attribute(:uuid_type_cache, instance_writer: false, default: {})
   end
   
-  def register_uuid_type(table, int)
-    if int < 0 || int > 65_535
-      raise ArgumentError, "UUID type must be between 0 and 65,535"
-    elsif defined_uuid_types.has_key?(int)
-      raise ArgumentError, UUID_TYPE_CONFLICT_MESSAGE % {
-        int: int,
-        table: table,
-        other: defined_uuid_types[int]
-      }
-    else
-      defined_uuid_types[int] = table.to_s
+  def _create_record
+    klass = self.class
+    if !klass.descends_from_active_record? && klass.typed?
+      pk = klass.primary_key
+      write_attribute(pk, klass.typed_uuid) if pk && read_attribute(pk).nil?
     end
+    
+    super
   end
   
-  def register_uuid_types(mapping)
-    mapping.each do |k, v|
-      if k.is_a?(Integer)
-        register_uuid_type(v, k)
+  class_methods do
+    def register_uuid_type(class_name, int)
+      if int < 0 || int > 65_535
+        raise ArgumentError, "UUID type must be between 0 and 65,535"
+      elsif defined_uuid_types.has_key?(int)
+        raise ArgumentError, UUID_TYPE_CONFLICT_MESSAGE % {
+          int: int,
+          class_name: class_name,
+          other: defined_uuid_types[int]
+        }
       else
-        register_uuid_type(k, v)
+        defined_uuid_types[int] = class_name.to_s
+      end
+    end
+  
+    def register_uuid_types(mapping)
+      mapping.each do |k, v|
+        if k.is_a?(Integer)
+          register_uuid_type(v, k)
+        else
+          register_uuid_type(k, v)
+        end
       end
     end
-  end
 
-  def typed_uuid
-    TypedUUID.uuid(uuid_type_from_class(self))
-  end
+    def typed?
+      !!defined_uuid_types.key(self.base_class.name)
+    end
+    
+    def typed_uuid
+      TypedUUID.uuid(uuid_type_from_class(self))
+    end
   
-  def uuid_type_from_table_name(table)
-    type = defined_uuid_types.key(table.to_s)
-    if type.nil?
-      raise ArgumentError, "UUID Type for \"#{table}\" not defined"
+    def uuid_type_from_table_name(table)
+      uuid_type_from_class(class_from_table_name(table))
     end
+
+    def uuid_type_from_class(klass)
+      type = defined_uuid_types.key(klass.name)
+      
+      if type.nil?
+        raise ArgumentError, "UUID Type for \"#{klass.name}\" not defined"
+      end
     
-    type
-  end
+      type
+    end
+  
+    def class_from_uuid_type(type)
+      if klass = uuid_type_cache[type]
+        return klass 
+      else
+        Rails.application.eager_load! if !Rails.application.config.eager_load
 
-  def uuid_type_from_class(klass)
-    type = defined_uuid_types.key(klass.table_name)
-    if type.nil?
-      raise ArgumentError, "UUID Type for \"#{table}\" not defined"
+        ::ActiveRecord::Base.descendants.each do |klass|
+          next if klass.table_name.nil?
+        
+          uuid_type_cache[defined_uuid_types.key(klass.name)] = klass
+        end
+      
+        uuid_type_cache[type]
+      end
     end
-    
-    type
-  end
   
-  def class_from_uuid_type(type)
-    if klass = uuid_type_cache[type]
-      return klass 
-    else
+    def class_from_table_name(table)
+      table = table.to_s
       Rails.application.eager_load! if !Rails.application.config.eager_load
-
-      ::ActiveRecord::Base.descendants.select do |klass|
+    
+      ::ActiveRecord::Base.descendants.find do |klass|
         next unless ( klass.superclass == ::ActiveRecord::Base || klass.superclass.abstract_class? )
         next if klass.table_name.nil?
-        
-        uuid_type_cache[defined_uuid_types.key(klass.table_name)] = klass
+
+        klass.table_name == table
       end
-      
-      uuid_type_cache[type]
     end
-  end
   
-  def class_from_uuid(uuid)
-    class_from_uuid_type(TypedUUID.enum(uuid))
+    def class_from_uuid(uuid)
+      class_from_uuid_type(TypedUUID.enum(uuid))
+    end
   end
   
 end

data/lib/typed_uuid/railtie.rb

@@ -4,7 +4,7 @@ class TypedUUID::Railtie < Rails::Railtie
     ActiveRecord::Tasks::DatabaseTasks.migrations_paths << File.expand_path('../../../db/migrate', __FILE__)
     
     ActiveSupport.on_load(:active_record) do
-      ActiveRecord::Base.extend TypedUUID::ActiveRecord
+      ActiveRecord::Base.include TypedUUID::ActiveRecord
     end
     
     require 'active_record/connection_adapters/postgresql/schema_definitions'

data/lib/typed_uuid/version.rb

@@ -1,3 +1,3 @@
 module TypedUUID
-  VERSION = '2.3'
+  VERSION = '3.0'
 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'
@@ -52,6 +54,9 @@ class ActiveSupport::TestCase
   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 = {}
+      ActiveRecord::Base.uuid_type_cache = {}
+      
       configuration = {
         adapter:  "postgresql",
         database: "uuid-types-test",
@@ -76,14 +81,14 @@ class ActiveSupport::TestCase
     self.class.class_variable_set(:@@suite_setup_run, true)
   end
 
-  # def debug
-  #   ActiveRecord::Base.logger = Logger.new(STDOUT)
-  #   $debugging = true
-  #   yield
-  # ensure
-  #   ActiveRecord::Base.logger = nil
-  #   $debugging = false
-  # end
+  def debug
+    ActiveRecord::Base.logger = Logger.new(STDOUT)
+    $debugging = true
+    yield
+  ensure
+    ActiveRecord::Base.logger = nil
+    $debugging = false
+  end
 
   def capture_sql
     # ActiveRecord::Base.connection.materialize_transactions

data/test/typed_uuid_test.rb

@@ -4,8 +4,9 @@ class FilterTest < ActiveSupport::TestCase
 
   schema do
     ActiveRecord::Base.register_uuid_types({
-      listings: 0,
-      buildings: 592
+      'FilterTest::Listing'  => 0,
+      'FilterTest::Building' => 592,
+      'FilterTest::SkyScraper' => 1_952
     })
     
     create_table :listings, id: :typed_uuid do |t|
@@ -14,6 +15,7 @@ class FilterTest < ActiveSupport::TestCase
     
     create_table :buildings, id: :typed_uuid do |t|
       t.string   "name", limit: 255
+      t.string   "type", limit: 255
     end
   end
   
@@ -22,10 +24,19 @@ class FilterTest < ActiveSupport::TestCase
   
   class Building < ActiveRecord::Base
   end
+  
+  class SkyScraper < Building
+  end
 
+  class SingleFamilyHome < Building
+  end
+  
+  class Property < ActiveRecord::Base
+  end
+  
   test 'adding primary key as a typed_uuid in a migration' do
     ActiveRecord::Base.register_uuid_types({
-      properties: 1
+      1 => 'FilterTest::Property'
     })
 
     exprexted_sql = <<-SQL
@@ -43,16 +54,27 @@ 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::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_raises ArgumentError do
+      ::ActiveRecord::Base.class_from_uuid(SingleFamilyHome.typed_uuid)
+    end
   end
   
   test 'class_from uuid' 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_raises ArgumentError do
+      SingleFamilyHome.create
+    end
   end
   
   test 'uuid_type from table_name' do
@@ -61,9 +83,17 @@ class FilterTest < ActiveSupport::TestCase
     assert_equal 592, ::ActiveRecord::Base.uuid_type_from_table_name(:buildings)
   end
   
+  test 'uuid_type from class' do
+    assert_equal 0, ::ActiveRecord::Base.uuid_type_from_class(Listing)
+    assert_equal 0, ::ActiveRecord::Base.uuid_type_from_class(Listing)
+    assert_equal 592, ::ActiveRecord::Base.uuid_type_from_class(Building)
+    assert_equal 1_952, ::ActiveRecord::Base.uuid_type_from_class(SkyScraper)
+  end
+  
   test 'class from uuid_type' do
     assert_equal FilterTest::Listing, ::ActiveRecord::Base.class_from_uuid_type(0)
     assert_equal FilterTest::Building, ::ActiveRecord::Base.class_from_uuid_type(592)
+    assert_equal FilterTest::SkyScraper, ::ActiveRecord::Base.class_from_uuid_type(1_952)
   end
   
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typed_uuid
 version: !ruby/object:Gem::Version
-  version: '2.3'
+  version: '3.0'
 platform: ruby
 authors:
 - Jon Bracy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-25 00:00:00.000000000 Z
+date: 2020-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake