rails_type_id 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b002a4e9136bfe9b886e13b8aaea8962f98b6ccf94e64dc875423c985fab6f8c
-  data.tar.gz: 7e245dcb3726845ddc8617cb91f2b6e79510baff72348d27124255855d79b3e6
+  metadata.gz: c0781fbf1b175f2edfe7b66fc82d03d09f08762d084cfc4e0681831d39d6f90b
+  data.tar.gz: 162be97b603d6b6480dcf27461bcf19541f43b30a5c65fcab5b1b46de1c04bd4
 SHA512:
-  metadata.gz: eb7fb1c5a1953d4b6ce56aa3771b18001220bcb383413abf17157d4cd7644cc505ac6c8cefe30902d246cf15b297fffa631db674ef33a07852c9189d3a08ac19
-  data.tar.gz: d534f95fbbec9934890497da6b2c9b0a4e0d82189b66c8e176a57758d5c9353336147b6136343b1cd8ee18388be655b631d336452e9a0fd5528b8dd9100178df
+  metadata.gz: 7a2d68e71437f6c62f2c183aaf749a4fddfba9ea61c6708f66c433dfa708ebfd2218ea2bfc74d05b1349cf2f65bbe1cc55b6434688cb5a6d2cb4c7defe823b94
+  data.tar.gz: bbd6f63fd939e57f0dbb46280e249f1d2ed8a929aeb9f1541e49c732bd742b7f81f624a4bf6ed51ca399fe733064a2d58e1a8fbc4778796e1f89915fdeb4c59f

data/README.md

@@ -12,8 +12,13 @@ bundle add rails_type_id
 
 ## Usage
 
+### Database requirements
+
+- ActiveRecord models should have an `id` field that is either a string-like type (`TEXT`, `VARCHAR`) .
+  See [Migration](#migrating-existing-ids) if you have an existing `id` field.
+
 ### Declaring on models
-Add `RailsTypeId::Concern` to the model. This model's `id` field should have either a String or UUID database column type.
+Add `RailsTypeId::Concern` to the model. This model's `id` field should have a string-like database column type.
 
 ```ruby
 # app/models/my_model.rb
@@ -33,9 +38,54 @@ Model instances will have a `type_id` field of type `TypeID`.
 
 ```ruby
 my_model = MyModel.create!(..)
-my_model.id             #=> "019867fe-560f-7941-a7ed-8472639c7ace"
+my_model.id             #=> "mm_01k1kzwngff50tfvc4e9hsrype"
 my_model.type_id        #=> #<TypeID mm_01k1kzwngff50tfvc4e9hsrype>
-my_model.type_id.to_s   #=> mm_01k1kzwngff50tfvc4e9hsrype
+```
+
+### Testing
+
+`lib/rails_type_id/test_helpers.rb` contains some helper methods for writing wholesome tests.
+
+### Migrating existing IDs
+
+For models with an existing Rails `id` field (usually an auto-incrementing integer), you'll need to
+migrate these to either a string-like column type. Below is an example migration for SQLite
+using a `text` type for a Users model that has an associated Session.
+
+```ruby
+class MigrateUserToUUID < ActiveRecord::Migration[8.0]
+    def change
+        add_column :users, :uuid, :text, null: true
+        add_column :sessions, :user_uuid, :text, null: true
+
+        Users.find_each do |u|
+            u.update(uuid: SecureRandom.uuid_v7)
+        end
+        Session.find_each do |s|
+            s.update(user_uuid: s.user.uuid)
+        end
+        change_column_null :users, :uuid, false
+        change_column_null :sessions, :user_uuid, false
+
+        remove_foreign_key :sessions, :users
+
+        rename_column :users, :id, :integer_id
+        rename_column :users, :uuid, :id
+
+        rename_column :sessions, :user_id, :integer_user_id
+        rename_column :sessions, :user_uuid, :user_id
+        change_column_null :session, :integer_user_id, true
+
+        execute "ALTER TABLE users DROP CONSTRAINT users_pkey;"
+        execute "ALTER_TABLE users ADD PRIMARY KEY (id);"
+
+        execute "ALTER TABLE ONLY users ALTER COLUMN integer_id DROP DEFAULT"
+        change_column_null :users, :integer_id, true
+        execute "DROP SEQUENCE IF EXISTS users_id_seq"
+
+        add_foreign_key :sessions, :users
+    end
+end
 ```
 
 ## Development

data/lib/rails_type_id/concern.rb

@@ -42,27 +42,21 @@ module RailsTypeId
     included do
       attribute :id # Postgres UUID field
 
-      before_create :generate_uuid_v7
+      before_create :generate_type_id
       validates_with Validator
 
       # Returns the TypeID for the model
       # @return [TypeID]
       define_method :type_id do
         Helpers.validate_type_id_prefix!(self.class.type_id_prefix)
-        TypeID.from_uuid(self.class.type_id_prefix, id)
+        TypeID.from_string(id)
       end
 
-      # If `id` is unset, generates a new UUID v7 and sets it
+      # If `id` is unset, generates a new UUID v7 TypeID and sets the `id` field
       # @return [void]
-      define_method :generate_uuid_v7 do
-        case self.class.attribute_types["id"].type
-        when :uuid, :string
-          self.id ||= SecureRandom.uuid_v7
-        end
-      end
-
-      define_method :to_param do
-        type_id.to_s
+      define_method :generate_type_id do
+        Helpers.validate_type_id_prefix!(self.class.type_id_prefix)
+        self.id ||= TypeID.from_uuid(self.class.type_id_prefix, SecureRandom.uuid_v7).to_s
       end
     end
 
@@ -88,9 +82,8 @@ module RailsTypeId
           klasses = lookup_model(type_id)
           return if klasses.nil?
 
-          id = type_id # TODO: parse out the uuid part
           klasses.each do |klass|
-            result = klass.find_by(id: id)
+            result = klass.find_by(id: type_id)
             return result unless result.nil?
           end
 
@@ -98,23 +91,14 @@ module RailsTypeId
         end
 
         def lookup_model(type_id)
-          prefix = get_prefix(type_id)
+          prefix = TypeID.from_string(type_id).prefix
           return if prefix.nil?
 
           prefix_map[prefix]
         end
 
-        def get_prefix(id)
-          prefix, = parse_id(id)
-          prefix
-        end
-
         private
 
-        def parse_id(id)
-          id.split("_")
-        end
-
         def prefix_map
           Rails.application.eager_load!
           # This has to be group_by and not index_by because we can have multiple

data/lib/rails_type_id/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module RailsTypeId
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/tapioca/dsl/compilers/rails_type_id_compiler.rb

@@ -34,11 +34,6 @@ module Tapioca
                 "type_id",
                 return_type: "TypeID"
               )
-
-              methods_mod.create_method(
-                "to_param",
-                return_type: "String"
-              )
             end
             klass.create_include(RBI_MODULE_NAME)
           end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_type_id
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Franklin Hu