rails-uuid-pk 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3eb01e2f1dc8ef76a90110c9d6ef882f79cfc6584395129046d404f116be94e3
-  data.tar.gz: 7aa3b43c50beb54b037428f0abf36f4df642968eb0ba368bfe57328bcea2f8cf
+  metadata.gz: 93efad36dbc0fb3ab34a2a348a5dad4ae0cb75c3f6f62bf7da4580146fbcccb3
+  data.tar.gz: df2a8e217103e1c732c894fd4ab48333e149e8a42a1a92a08bb023d72673ffa3
 SHA512:
-  metadata.gz: '09b2676618355ede8b113e7693e8c1673e1f8c32888f0027ab97fd82c81713af5b2f55b995d565f4445465c8c27ce53c4a42fe4f2247017e6c2cf4a0083af9e7'
-  data.tar.gz: 967f36d838dfd8e649a8674cce0a29642f39ee0e1a45dc70c4f66a1597abf65591c71cb434d97fb21affccf337337a04f2602e9fe470d43a464f3b5c2eca2298
+  metadata.gz: '09577137b7dbdd2b488260130f6afd4473292d06fb6646e141176de11a425f243b95ae3c43b8e69e89a7fcf3cb6b72d3f6cdb3b9794b56bf884c05895e4822de'
+  data.tar.gz: 9a5818221c1251cb137e61a30045fb98a0957af248f9f3e5908e5e9fb6f8d74d4de84dfb60d40135d60028d4d679070c8d295174990f8cc990f58752841a33f0

data/CHANGELOG.md

@@ -5,6 +5,38 @@ 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
+- **Made gem truly zero-configuration**: Removed install generator and concern file
+- Simplified installation to just `bundle install` - no generator command needed
+- Removed `app/models/concerns/has_uuidv7_primary_key.rb` template and explicit inclusion option
+- Updated documentation to reflect simplified zero-config approach
+- All functionality now works automatically through Railtie inclusion
+
+### Removed
+- Install generator (`rails g rails_uuid_pk:install`)
+- Optional concern file for explicit inclusion
+- Generator template and associated test cases
+- Manual installation steps and configuration options
+
+### Technical Details
+- Eliminated generator complexity while maintaining all core functionality
+- Streamlined user experience - just add gem to Gemfile and it works
+- Removed optional explicit concern inclusion in favor of automatic Railtie-based inclusion
+- Updated AGENTS.md and README.md to reflect simplified architecture
+
 ## [0.4.0] - 2026-01-10
 
 ### Added

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,21 +25,16 @@ Works great with **PostgreSQL 18+**, **MySQL 8.0+**, and **SQLite 3.51+** — ze
 Add to your `Gemfile`:
 
 ```ruby
-gem "rails-uuid-pk", "~> 0.3"
+gem "rails-uuid-pk", "~> 0.6"
 ```
 
 Then run:
 
 ```bash
 bundle install
-rails generate rails_uuid_pk:install
 ```
 
-The generator will:
-
-- Set `primary_key_type: :uuid` in your generators config
-- Create `app/models/concerns/has_uuidv7_primary_key.rb` (optional explicit include)
-- Show important compatibility notes
+That's it! The gem automatically enables UUIDv7 primary keys for all your models.
 
 ## Usage
 
@@ -60,32 +56,27 @@ User.create!(name: "Alice")  # ← id is automatically a proper UUIDv7
 
 ### Action Text & Active Storage
 
-When you run:
+When you install Action Text or Active Storage:
 
 ```bash
 rails action_text:install
 rails active_storage:install
 ```
 
-The generated migrations will **automatically use the correct foreign key types** when referencing tables with UUID primary keys. No manual editing required!
-
-This works because rails-uuid-pk includes smart migration helpers that detect the primary key type of referenced tables and automatically set `type: :uuid` for foreign keys.
+The generated migrations seamlessly integrate with UUID primary keys. Rails-uuid-pk's smart migration helpers automatically detect UUID primary keys in referenced tables and set the appropriate `type: :uuid` for foreign keys.
 
 ### Polymorphic associations
 
-**Polymorphic associations** (like Action Text's `record` references) will automatically use the correct foreign key type based on the referenced table's primary key. If the parent model uses UUID primary keys, the foreign key will be UUID type.
+Polymorphic associations work seamlessly with UUID primary keys. Whether you're using Action Text's `record` references or custom polymorphic associations, the migration helpers automatically detect the parent table's primary key type and set the correct foreign key type.
 
-For **custom polymorphic associations**, the migration helpers will also automatically detect and set the correct type:
+For example, this migration will automatically use `type: :uuid` when the parent models have UUID primary keys:
 
 ```ruby
-# This will automatically use type: :uuid if the parent models have UUID primary keys
 create_table :comments do |t|
   t.references :commentable, polymorphic: true
 end
 ```
 
-No manual `type: :uuid` specification needed!
-
 ## Features / Trade-offs
 
 | Feature                              | Status          | Notes                                                                 |

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.4.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.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Joon Lee
@@ -77,9 +77,6 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/models/concerns/has_uuidv7_primary_key.rb
-- lib/generators/rails_uuid_pk/install/install_generator.rb
-- lib/generators/rails_uuid_pk/install/templates/has_uuidv7_primary_key.rb
 - lib/rails_uuid_pk.rb
 - lib/rails_uuid_pk/concern.rb
 - lib/rails_uuid_pk/migration_helpers.rb

data/app/models/concerns/has_uuidv7_primary_key.rb

@@ -1,17 +0,0 @@
-# app/models/concerns/has_uuidv7_primary_key.rb
-# (this file is copied by the generator - you can modify it later if needed)
-
-module HasUuidv7PrimaryKey
-  extend ActiveSupport::Concern
-
-  included do
-    before_create :assign_uuidv7_if_needed, if: -> { id.nil? }
-  end
-
-  private
-
-  def assign_uuidv7_if_needed
-    return if id.present?
-    self.id = SecureRandom.uuid_v7
-  end
-end

data/lib/generators/rails_uuid_pk/install/install_generator.rb

@@ -1,42 +0,0 @@
-module RailsUuidPk
-  module Generators
-    class InstallGenerator < Rails::Generators::Base
-      source_root File.expand_path("templates", __dir__)
-
-      desc "Installs rails-uuid-pk: sets uuid primary key + includes UUIDv7 concern"
-
-      def add_concern_file
-        copy_file "has_uuidv7_primary_key.rb",
-                  "app/models/concerns/has_uuidv7_primary_key.rb"
-      end
-
-      def show_next_steps
-        say "\nrails-uuid-pk was successfully installed!", :green
-
-        say "\n✅ Action Text & Active Storage compatibility", :green
-        say "─────────────────────────────────────────────────────────────"
-        say "Migration helpers now automatically handle foreign key types!"
-        say "When you run:"
-        say "  rails action_text:install"
-        say "  rails active_storage:install"
-        say ""
-        say "The generated migrations will automatically use the correct UUID types"
-        say "for foreign keys. No manual editing required!"
-        say "─────────────────────────────────────────────────────────────\n"
-
-        say "\nRecommended next steps:", :yellow
-        say "  1. Add to ApplicationRecord (if you prefer explicit include):"
-        say "     class ApplicationRecord < ActiveRecord::Base"
-        say "       primary_abstract_class"
-        say "       include HasUuidv7PrimaryKey"
-        say "     end\n"
-
-        say "  2. Or keep relying on Railtie automatic include (recommended for most cases)\n"
-
-        say "  3. Now you can run:", :cyan
-        say "     rails g model User name:string email:string\n"
-        say "     → will create table with uuid primary key + automatic uuidv7\n"
-      end
-    end
-  end
-end

data/lib/generators/rails_uuid_pk/install/templates/has_uuidv7_primary_key.rb

@@ -1,17 +0,0 @@
-# app/models/concerns/has_uuidv7_primary_key.rb
-# (this file is copied by the generator - you can modify it later if needed)
-
-module HasUuidv7PrimaryKey
-  extend ActiveSupport::Concern
-
-  included do
-    before_create :assign_uuidv7_if_needed, if: -> { id.nil? }
-  end
-
-  private
-
-  def assign_uuidv7_if_needed
-    return if id.present?
-    self.id = SecureRandom.uuid_v7
-  end
-end