rails-uuid-pk 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 615c351b860e9cf6b5cc663f8f1a8d4c5781bb6f7f12d658440f42a3173d8fc0
-  data.tar.gz: 5973fbaed1fb21337bd3e3377c59f7ba410dd50d8837eb444e0c15ead96ddaaf
+  metadata.gz: 93efad36dbc0fb3ab34a2a348a5dad4ae0cb75c3f6f62bf7da4580146fbcccb3
+  data.tar.gz: df2a8e217103e1c732c894fd4ab48333e149e8a42a1a92a08bb023d72673ffa3
 SHA512:
-  metadata.gz: b9a9adf355b72109ed26fa08586983581aa0b4005bbbbc504782a6f5297198b4852f6b664138b24976f2405c464adeba017d177143b15f95761b2901f2aee336
-  data.tar.gz: bde5e20373b9d07a9013194f3b90faa01cdad6a63de4598b1d1925c0b80694c8416256290f4410d4c4821c1e7ff51e5bcb9281753bcc12f0ec31fa56c06790be
+  metadata.gz: '09577137b7dbdd2b488260130f6afd4473292d06fb6646e141176de11a425f243b95ae3c43b8e69e89a7fcf3cb6b72d3f6cdb3b9794b56bf884c05895e4822de'
+  data.tar.gz: 9a5818221c1251cb137e61a30045fb98a0957af248f9f3e5908e5e9fb6f8d74d4de84dfb60d40135d60028d4d679070c8d295174990f8cc990f58752841a33f0

data/CHANGELOG.md

@@ -5,6 +5,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v1.0.0.html).
 
+## [0.6.0] - 2026-01-12
+
+### Added
+- **Support for `add_reference` and `add_belongs_to`**: Migration helpers now automatically handle foreign key types for these methods as well.
+- **Performance Caching**: Added primary key lookup caching during migrations to improve performance.
+
+### Changed
+- **Improved Migration Helpers**: Enhanced robustness of foreign key type detection by handling more default types (`:bigint`, `:integer`, `nil`).
+- **Refactored Railtie**: Unified UUID type registration for SQLite and MySQL, improving code maintainability.
+- **Better Initialization**: Improved timing of adapter extensions using `ActiveSupport.on_load`.
+
 ## [0.5.0] - 2026-01-10
 
 ### Changed

data/README.md

@@ -1,7 +1,8 @@
 # rails-uuid-pk
 
-**Dead-simple UUIDv7 primary keys for modern Rails apps**  
-Works great with **PostgreSQL 18+**, **MySQL 8.0+**, and **SQLite 3.51+** — zero extra extensions required.
+**Dead-simple UUIDv7 primary keys for modern Rails apps**
+
+Automatically use UUID v7 for **all primary keys** in Rails applications. Works with PostgreSQL, MySQL, and SQLite — **zero configuration required**. Just add the gem and you're done!
 
 [![Gem Version](https://img.shields.io/gem/v/rails-uuid-pk.svg?style=flat-square)](https://rubygems.org/gems/rails-uuid-pk)
 [![Ruby](https://img.shields.io/badge/ruby-≥3.3-red.svg?style=flat-square)](https://www.ruby-lang.org)
@@ -24,7 +25,7 @@ Works great with **PostgreSQL 18+**, **MySQL 8.0+**, and **SQLite 3.51+** — ze
 Add to your `Gemfile`:
 
 ```ruby
-gem "rails-uuid-pk", "~> 0.5"
+gem "rails-uuid-pk", "~> 0.6"
 ```
 
 Then run:

data/lib/rails_uuid_pk/migration_helpers.rb

@@ -6,32 +6,51 @@ module RailsUuidPk
         ref_table = options.delete(:to_table) || ref_name.to_s.pluralize
 
         # Only set UUID type if not already explicitly set by user
-        # Rails sets type: :integer by default, so we override that
-        # But if user explicitly set a different type, we respect it
-        if (uuid_primary_key?(ref_table) || (options[:polymorphic] && application_uses_uuid_primary_keys?)) && options[:type] == :integer
+        # In Rails, default type is often passed as :integer or :bigint in the options hash
+        # depending on the Rails version and whether it is a migration or a table definition.
+        # We want to override it to :uuid if the target table uses UUID primary keys.
+        current_type = options[:type]
+        if (current_type.nil? || current_type == :integer || current_type == :bigint) &&
+           (uuid_primary_key?(ref_table) || (options[:polymorphic] && application_uses_uuid_primary_keys?))
           options[:type] = :uuid
         end
 
-        super
+        super(*args, **options)
+      end
+
+      def add_reference(table_name, ref_name, **options)
+        ref_table = options.delete(:to_table) || ref_name.to_s.pluralize
+
+        current_type = options[:type]
+        if (current_type.nil? || current_type == :integer || current_type == :bigint) &&
+           (uuid_primary_key?(ref_table) || (options[:polymorphic] && application_uses_uuid_primary_keys?))
+          options[:type] = :uuid
+        end
+
+        super(table_name, ref_name, **options)
       end
 
       def application_uses_uuid_primary_keys?
         # Check if the application is configured to use UUID primary keys globally
-        Rails.application.config.generators.options[:active_record]&.[](:primary_key_type) == :uuid
+        defined?(Rails) && Rails.application.config.generators.options[:active_record]&.[](:primary_key_type) == :uuid
       end
 
       alias_method :belongs_to, :references
+      alias_method :add_belongs_to, :add_reference
 
       private
 
       def uuid_primary_key?(table_name)
-        conn = @conn || @base || (respond_to?(:connection) ? connection : nil)
-        return false unless conn&.table_exists?(table_name)
+        # Cache results for the duration of the migration process to improve performance
+        @uuid_pk_cache ||= {}
+        return @uuid_pk_cache[table_name] if @uuid_pk_cache.key?(table_name)
 
-        pk_column = find_primary_key_column(table_name, conn)
-        return false unless pk_column
+        conn = @conn || @base || (respond_to?(:connection) ? connection : self)
+        # Ensure we have a connection-like object that can check for table existence
+        return false unless conn.respond_to?(:table_exists?) && conn.table_exists?(table_name)
 
-        pk_column.sql_type.downcase.match?(/\A(uuid|varchar\(36\))\z/)
+        pk_column = find_primary_key_column(table_name, conn)
+        @uuid_pk_cache[table_name] = !!(pk_column && pk_column.sql_type.downcase.match?(/\A(uuid|varchar\(36\))\z/))
       end
 
       def find_primary_key_column(table_name, conn)

data/lib/rails_uuid_pk/railtie.rb

@@ -8,54 +8,31 @@ module RailsUuidPk
 
     initializer "rails-uuid-pk.configure_type_map", after: "active_record.initialize_database" do
       ActiveSupport.on_load(:active_record) do
-        if ActiveRecord::Base.connection.adapter_name == "SQLite"
-          # Register the UUID type with ActiveRecord
-          ActiveRecord::Type.register(:uuid, RailsUuidPk::Type::Uuid, adapter: :sqlite3)
-
-          # Map varchar SQL type to our custom UUID type (since that's how UUID columns are stored in SQLite)
-          ActiveRecord::Base.connection.send(:type_map).register_type(/varchar/i) do |sql_type|
-            RailsUuidPk::Type::Uuid.new
-          end
-
-          # Also map "uuid" SQL type to our custom UUID type for direct lookups
-          ActiveRecord::Base.connection.send(:type_map).register_type "uuid" do |sql_type|
-            RailsUuidPk::Type::Uuid.new
-          end
-        elsif ActiveRecord::Base.connection.adapter_name == "MySQL"
-          # Register the UUID type with ActiveRecord for MySQL
-          ActiveRecord::Type.register(:uuid, RailsUuidPk::Type::Uuid, adapter: :mysql2)
-
-          # Map varchar SQL type to our custom UUID type (since that's how UUID columns are stored in MySQL)
-          ActiveRecord::Base.connection.send(:type_map).register_type(/varchar/i) do |sql_type|
-            RailsUuidPk::Type::Uuid.new
-          end
-
-          # Also map "uuid" SQL type to our custom UUID type for direct lookups
-          ActiveRecord::Base.connection.send(:type_map).register_type "uuid" do |sql_type|
-            RailsUuidPk::Type::Uuid.new
-          end
+        adapter_name = ActiveRecord::Base.connection.adapter_name
+        if %w[SQLite MySQL].include?(adapter_name)
+          RailsUuidPk::Railtie.register_uuid_type(adapter_name.downcase.to_sym)
         end
       end
     end
 
     initializer "rails-uuid-pk.native_types" do
-      require "active_record/connection_adapters/sqlite3_adapter"
-      ActiveRecord::ConnectionAdapters::SQLite3Adapter.prepend(RailsUuidPk::Sqlite3AdapterExtension)
-    end
-
-    initializer "rails-uuid-pk.mysql_native_types" do
-      begin
-        require "active_record/connection_adapters/mysql2_adapter"
-        ActiveRecord::ConnectionAdapters::Mysql2Adapter.prepend(RailsUuidPk::Mysql2AdapterExtension)
-      rescue LoadError
-        # MySQL adapter not available, skip MySQL-specific initialization
+      ActiveSupport.on_load(:active_record) do
+        case ActiveRecord::Base.connection.adapter_name
+        when "SQLite"
+          require "active_record/connection_adapters/sqlite3_adapter"
+          ActiveRecord::ConnectionAdapters::SQLite3Adapter.prepend(RailsUuidPk::Sqlite3AdapterExtension)
+        when "MySQL"
+          begin
+            require "active_record/connection_adapters/mysql2_adapter"
+            ActiveRecord::ConnectionAdapters::Mysql2Adapter.prepend(RailsUuidPk::Mysql2AdapterExtension)
+          rescue LoadError
+            # MySQL adapter not available
+          end
+        end
       end
     end
 
-
-
     initializer "rails-uuid-pk.schema_format" do |app|
-      # Ensure schema_format is set to :ruby for SQLite (default in Rails)
       app.config.active_record.schema_format ||= :ruby
     end
 
@@ -69,10 +46,21 @@ module RailsUuidPk
       ActiveSupport.on_load(:active_record) do
         require "rails_uuid_pk/migration_helpers"
 
-        # Include migration helpers for all database adapters
         ActiveRecord::ConnectionAdapters::TableDefinition.prepend(RailsUuidPk::MigrationHelpers::References)
         ActiveRecord::ConnectionAdapters::Table.prepend(RailsUuidPk::MigrationHelpers::References)
+        ActiveRecord::ConnectionAdapters::AbstractAdapter.prepend(RailsUuidPk::MigrationHelpers::References)
       end
     end
+
+    def self.register_uuid_type(adapter)
+      ActiveRecord::Type.register(:uuid, RailsUuidPk::Type::Uuid, adapter: adapter)
+
+      # Get the connection-specific type map
+      type_map = ActiveRecord::Base.connection.send(:type_map)
+      # Map varchar(36) or varchar SQL type to our custom UUID type
+      type_map.register_type(/varchar/i) { RailsUuidPk::Type::Uuid.new }
+      # Also map "uuid" SQL type for direct lookups
+      type_map.register_type("uuid") { RailsUuidPk::Type::Uuid.new }
+    end
   end
 end

data/lib/rails_uuid_pk/version.rb

@@ -1,3 +1,3 @@
 module RailsUuidPk
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-uuid-pk
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Joon Lee