rails-uuid-pk 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 615c351b860e9cf6b5cc663f8f1a8d4c5781bb6f7f12d658440f42a3173d8fc0
-  data.tar.gz: 5973fbaed1fb21337bd3e3377c59f7ba410dd50d8837eb444e0c15ead96ddaaf
+  metadata.gz: 44071099c05c09c2bd83cf2c82eac2cd7794990d288d68d8ef775e2ecaa410e2
+  data.tar.gz: ba6ad1a7f1a00c2d5201122215c9fcfbd39142088775b24234f2a01c9e25dc05
 SHA512:
-  metadata.gz: b9a9adf355b72109ed26fa08586983581aa0b4005bbbbc504782a6f5297198b4852f6b664138b24976f2405c464adeba017d177143b15f95761b2901f2aee336
-  data.tar.gz: bde5e20373b9d07a9013194f3b90faa01cdad6a63de4598b1d1925c0b80694c8416256290f4410d4c4821c1e7ff51e5bcb9281753bcc12f0ec31fa56c06790be
+  metadata.gz: caf06da62bc4a35bd6eb8fc578e298d3a1652e89a1ea0bf74118aeb325b780e3f0dc8b7a1b37828967a6ca9287d164631ac4355a2817c9c483a4e4934396adef
+  data.tar.gz: 0b6a0d2920550d3d0eb385f4f42dcafd55877a6a603d6347d1d13b6a9171ddd4a74c8f14439125666455e91f2481d57b688bf8e6a18e9dde439c7daaa3918db3

data/CHANGELOG.md

@@ -5,6 +5,69 @@ 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.7.0] - 2026-01-12
+
+### Added
+- **SECURITY.md**: Comprehensive security documentation covering UUIDv7-specific security considerations
+  - Cryptographic security analysis with timestamp exposure details
+  - Database security implications and foreign key considerations
+  - Performance-security trade-offs analysis
+  - Security vulnerability reporting process
+  - Side-channel attack vectors and mitigation strategies
+  - Compliance considerations (GDPR, HIPAA, etc.)
+  - Security testing recommendations and monitoring guidelines
+- **ARCHITECTURE.md**: Comprehensive architecture documentation
+  - Core design principles and architectural decisions
+  - App-level vs database-level UUID generation analysis
+  - Database compatibility rationale and trade-offs
+  - Migration performance implications and caching strategies
+  - Database replication and backup considerations
+  - ORM and query builder integration details
+  - Error handling and resilience patterns
+  - Future evolution and extensibility points
+- **PERFORMANCE.md**: Comprehensive performance documentation in dedicated file
+  - UUID generation throughput metrics and cryptographic security details
+  - Database-specific performance characteristics (PostgreSQL, MySQL, SQLite)
+  - Index performance analysis comparing 36-byte UUIDs vs 4-byte integers
+  - Scaling recommendations for tables of different sizes (<1M, 1M-10M, >10M records)
+  - UUIDv7 vs UUIDv4 performance trade-offs with detailed comparison tables
+  - Index fragmentation and cache locality analysis
+  - Production monitoring and optimization guidelines
+- **README.md**: Streamlined with concise performance overview and link to PERFORMANCE.md
+- **Comprehensive UUIDv7 Correctness Testing**: Added extensive test suite validating UUIDv7 compliance
+  - RFC 9562 version and variant bits validation
+  - Timestamp monotonicity and collision resistance testing
+  - Format consistency and edge case handling
+  - Statistical randomness quality analysis
+  - Cross-database compatibility verification
+
+### Changed
+- **Schema Dumper Compatibility**: Replaced fragile `caller` detection with Rails version-aware schema type handling
+  - Rails 8.1+: Uses `:uuid` type in schema dumps for native UUID support
+  - Rails 8.0.x: Uses `:string` type to avoid "Unknown type 'uuid'" errors
+  - Future-proof design that adapts to Rails version changes
+  - Added comprehensive test coverage for schema dumping behavior
+
+### Fixed
+- **Schema Dumping Fragility**: Eliminated dependency on Rails internal `caller` stack inspection
+- **Rails Version Compatibility**: Robust handling of UUID types across different Rails versions
+
+### Security
+- Enhanced security posture with professional security documentation
+- Clear vulnerability disclosure process for responsible reporting
+- UUID-specific security guidance for enterprise adoption
+
+## [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:
@@ -89,6 +90,24 @@ end
 | Zero config after install            | Yes             | Migration helpers automatically handle foreign key types             |
 | Works with Rails 7.1 – 8+            | Yes             | Tested conceptually up to Rails 8.1+                                  |
 
+## Performance Overview
+
+**Generation**: ~10,000 UUIDs/second with cryptographic security and monotonic ordering
+
+| Database | Storage | Index Performance | Notes |
+|----------|---------|-------------------|--------|
+| **PostgreSQL** | Native UUID (16B) | Excellent | Optimal performance |
+| **MySQL** | VARCHAR(36) (36B) | Good | 2.25x storage overhead |
+| **SQLite** | VARCHAR(36) (36B) | Good | Good for development |
+
+**Key Advantages**:
+- **UUIDv7 outperforms UUIDv4** in most scenarios due to monotonic ordering
+- **Better index locality** than random UUIDs with reduced fragmentation
+- **Efficient range queries** for time-based data access
+- **Production-ready scaling** with proper indexing and monitoring
+
+For comprehensive performance analysis, scaling strategies, and optimization guides, see [PERFORMANCE.md](PERFORMANCE.md).
+
 ## Why not use native PostgreSQL `uuidv7()`?
 
 While PostgreSQL 18+ has excellent native `uuidv7()` support, the **fallback approach** was chosen for maximum compatibility:
@@ -104,12 +123,39 @@ You can still add native PostgreSQL defaults manually if you want maximum perfor
 
 ### Devcontainer Setup
 
-This project includes a devcontainer configuration for VS Code. To get started:
+This project includes a devcontainer configuration for VS Code (highly recommended, as it automatically sets up Ruby 3.3, Rails, PostgreSQL, MySQL, and SQLite in an isolated environment). To get started:
 
 1. Open the project in VS Code
 2. When prompted, click "Reopen in Container" (or run `Dev Containers: Reopen in Container` from the command palette)
 3. The devcontainer will set up Ruby 3.3, Rails, and all dependencies automatically
 
+#### Devcontainer CLI
+
+For terminal-based development or automation, you can use the Devcontainer CLI. The devcontainer will be built and started automatically when you run the exec commands.
+
+##### Installation
+
+- **MacOS**: `brew install devcontainer`
+- **Other systems**: `npm install -g @devcontainers/cli`
+
+##### Usage
+
+Run commands inside the devcontainer:
+
+```bash
+# Install dependencies
+devcontainer exec --workspace-folder . bundle install
+
+# Run tests
+devcontainer exec --workspace-folder . ./bin/test
+
+# Run code quality checks
+devcontainer exec --workspace-folder . ./bin/rubocop
+
+# Interactive shell
+devcontainer exec --workspace-folder . bash
+```
+
 ### Running Tests
 
 The project includes a comprehensive test suite that runs against SQLite, PostgreSQL, and MySQL.
@@ -155,6 +201,10 @@ For database testing, ensure the respective databases are running and accessible
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/seouri/rails-uuid-pk.
 
+Please see our [Security Policy](SECURITY.md) for information about reporting security vulnerabilities.
+
+For detailed architecture documentation, design decisions, and technical rationale, see [ARCHITECTURE.md](ARCHITECTURE.md).
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](MIT-LICENSE).

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/type.rb

@@ -2,12 +2,12 @@ module RailsUuidPk
   module Type
     class Uuid < ActiveRecord::Type::String
       def type
-        # Return :string during schema dumping to avoid "Unknown type 'uuid'" errors
-        # Return :uuid for normal operation and tests
-        if caller.any? { |c| c.include?("schema_dumper") }
-          :string
-        else
+        # Rails 8.1+ supports UUID types in schema dumping
+        # Earlier versions need :string to avoid "Unknown type 'uuid'" errors
+        if rails_supports_uuid_in_schema?
           :uuid
+        else
+          :string
         end
       end
 
@@ -42,6 +42,13 @@ module RailsUuidPk
       def valid?(value)
         value.match?(/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i)
       end
+
+      def rails_supports_uuid_in_schema?
+        # Rails 8.1+ supports UUID types in schema dumping
+        # Earlier versions (8.0.x) need :string to avoid "Unknown type 'uuid'" errors
+        rails_version = Gem::Version.new(Rails::VERSION::STRING)
+        rails_version >= Gem::Version.new("8.1.0")
+      end
     end
   end
 end

data/lib/rails_uuid_pk/version.rb

@@ -1,3 +1,3 @@
 module RailsUuidPk
-  VERSION = "0.5.0"
+  VERSION = "0.7.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.7.0
 platform: ruby
 authors:
 - Joon Lee