rails-uuid-pk 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9552cdab44f5a5a6a4b699e12dc31ee13917ff74f0752f32e823dffed24e2e0
-  data.tar.gz: 6ddd7862945d8b13939be92990241539d93eaf754d6c47f2733d66eb2e29597e
+  metadata.gz: 615c351b860e9cf6b5cc663f8f1a8d4c5781bb6f7f12d658440f42a3173d8fc0
+  data.tar.gz: 5973fbaed1fb21337bd3e3377c59f7ba410dd50d8837eb444e0c15ead96ddaaf
 SHA512:
-  metadata.gz: 72fb9c050567562c0d01793d801d7633d45b26851734cb069b2e70ee74d8bf3387e515f50cb771fdbb46f8ad9b4cb767058739bad45050134ba710a8f6290201
-  data.tar.gz: ed3b396026fe6edc6485720d6d80af4d5fd11138652fea133515fcb8d931d9d38cf981553a46689121201922ee41b6fad5829c42c06783109b930b06acf41fda
+  metadata.gz: b9a9adf355b72109ed26fa08586983581aa0b4005bbbbc504782a6f5297198b4852f6b664138b24976f2405c464adeba017d177143b15f95761b2901f2aee336
+  data.tar.gz: bde5e20373b9d07a9013194f3b90faa01cdad6a63de4598b1d1925c0b80694c8416256290f4410d4c4821c1e7ff51e5bcb9281753bcc12f0ec31fa56c06790be

data/CHANGELOG.md

@@ -5,6 +5,51 @@ 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.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
+- **MySQL 8.0+ support**: Full MySQL compatibility with VARCHAR(36) UUID storage
+- MySQL2 adapter extension for native database type mappings
+- MySQL-specific type handling and schema dumping support
+- Comprehensive MySQL test suite with performance and edge case testing
+- CI pipeline support for MySQL 8.0 testing
+- Updated documentation to include MySQL setup and compatibility notes
+
+### Changed
+- Updated project description to reflect support for PostgreSQL, MySQL, and SQLite
+- Enhanced test runner to support all three database adapters
+- Updated development environment setup to include MySQL configuration
+- Expanded database coverage from 2 to 3 major Rails database adapters
+
+### Technical Details
+- Added `lib/rails_uuid_pk/mysql2_adapter_extension.rb` for MySQL adapter integration
+- Extended Railtie with MySQL-specific type mappings and adapter detection
+- Enhanced migration helpers compatibility with MySQL VARCHAR(36) column detection
+- Added MySQL performance testing (bulk operations, concurrent access, memory efficiency)
+- Implemented MySQL edge case testing (long table names, special characters)
+- Updated CI workflow with MySQL 8.0 service configuration
+
 ## [0.3.0] - 2026-01-09
 
 ### Added

data/README.md

@@ -1,7 +1,7 @@
 # rails-uuid-pk
 
 **Dead-simple UUIDv7 primary keys for modern Rails apps**  
-Works great with **PostgreSQL 18+** and **SQLite 3.51+** — zero extra extensions required.
+Works great with **PostgreSQL 18+**, **MySQL 8.0+**, and **SQLite 3.51+** — zero extra extensions required.
 
 [![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)
@@ -12,8 +12,9 @@ Works great with **PostgreSQL 18+** and **SQLite 3.51+** — zero extra extensio
 - Uses **native** `SecureRandom.uuid_v7` (Ruby 3.3+)
 - Automatically sets `:uuid` as default primary key type
 - Adds reliable `before_create` callback for UUIDv7 generation
-- Works perfectly on **both PostgreSQL 18+** and **SQLite** (and older PostgreSQL versions too)
+- Works perfectly on **PostgreSQL 18+**, **MySQL 8.0+**, and **SQLite** (and older versions too)
 - **PostgreSQL**: Uses native `UUID` column types with full database support
+- **MySQL**: Uses `VARCHAR(36)` with custom ActiveRecord type handling
 - **SQLite**: Uses `VARCHAR(36)` with custom ActiveRecord type handling
 - Zero database extensions needed
 - Minimal and maintainable — no monkey-patching hell
@@ -23,21 +24,16 @@ Works great with **PostgreSQL 18+** and **SQLite 3.51+** — zero extra extensio
 Add to your `Gemfile`:
 
 ```ruby
-gem "rails-uuid-pk", "~> 0.3"
+gem "rails-uuid-pk", "~> 0.5"
 ```
 
 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
 
@@ -59,39 +55,36 @@ 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                                                                 |
 |--------------------------------------|-----------------|-----------------------------------------------------------------------|
 | UUIDv7 generation                    | Automatic       | Uses `SecureRandom.uuid_v7` (very good randomness + monotonicity)     |
 | PostgreSQL 18+ native `uuidv7()`     | Not used        | Fallback approach — more universal, no extensions needed             |
-| SQLite support                       | Full            | No native function → app-side generation works great                  |
+| PostgreSQL support                   | Full            | Native `UUID` column types with full database support                |
+| MySQL 8.0+ support                   | Full            | Uses `VARCHAR(36)` with custom ActiveRecord type handling            |
+| SQLite support                       | Full            | Uses `VARCHAR(36)` with custom ActiveRecord type handling            |
 | Index locality / performance         | Very good       | UUIDv7 is monotonic → almost as good as sequential IDs                |
 | 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+                                  |
@@ -119,15 +112,16 @@ This project includes a devcontainer configuration for VS Code. To get started:
 
 ### Running Tests
 
-The project includes a comprehensive test suite that runs against both SQLite and PostgreSQL.
+The project includes a comprehensive test suite that runs against SQLite, PostgreSQL, and MySQL.
 
 ```bash
-# Run all tests (SQLite + PostgreSQL)
+# Run all tests (SQLite + PostgreSQL + MySQL)
 ./bin/test
 
 # Run tests for specific database
 DB=sqlite ./bin/test      # SQLite only
 DB=postgres ./bin/test    # PostgreSQL only
+DB=mysql ./bin/test       # MySQL only
 ```
 
 ### Code Quality
@@ -152,9 +146,10 @@ gem install rails-uuid-pk-0.1.0.gem
 
 ### Database Setup
 
-For PostgreSQL testing, ensure PostgreSQL is running and accessible. The test suite uses these environment variables:
+For database testing, ensure the respective databases are running and accessible. The test suite uses these environment variables:
 - `DB_HOST` (defaults to localhost)
 - `RAILS_ENV=test_postgresql` for PostgreSQL tests
+- `RAILS_ENV=test_mysql` for MySQL tests
 
 ## Contributing
 

data/lib/rails_uuid_pk/mysql2_adapter_extension.rb

@@ -0,0 +1,9 @@
+module RailsUuidPk
+  module Mysql2AdapterExtension
+    def native_database_types
+      super.merge(
+        uuid: { name: "varchar", limit: 36 }
+      )
+    end
+  end
+end

data/lib/rails_uuid_pk/railtie.rb

@@ -17,6 +17,19 @@ module RailsUuidPk
             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
@@ -30,6 +43,15 @@ module RailsUuidPk
       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
+      end
+    end
+
 
 
     initializer "rails-uuid-pk.schema_format" do |app|

data/lib/rails_uuid_pk/version.rb

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

data/lib/rails_uuid_pk.rb

@@ -2,6 +2,7 @@ require "rails_uuid_pk/version"
 require "rails_uuid_pk/concern"
 require "rails_uuid_pk/type"
 require "rails_uuid_pk/sqlite3_adapter_extension"
+require "rails_uuid_pk/mysql2_adapter_extension"
 require "rails_uuid_pk/railtie"
 
 module RailsUuidPk

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-uuid-pk
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Joon Lee
@@ -23,6 +23,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.7
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -51,8 +65,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.9.0
-description: Automatically use UUIDv7 for all primary keys in Rails applications.
-  Works with PostgreSQL and SQLite, zero configuration required.
+description: Automatically use UUID v7 for all primary keys in Rails applications.
+  Works with PostgreSQL, MySQL, and SQLite, zero configuration required.
 email:
 - seouri@gmail.com
 executables: []
@@ -63,12 +77,10 @@ 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
+- lib/rails_uuid_pk/mysql2_adapter_extension.rb
 - lib/rails_uuid_pk/railtie.rb
 - lib/rails_uuid_pk/sqlite3_adapter_extension.rb
 - lib/rails_uuid_pk/type.rb
@@ -97,5 +109,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.3
 specification_version: 4
-summary: Dead-simple UUIDv7 primary keys for Rails apps
+summary: Dead-simple UUID v7 primary keys for Rails apps
 test_files: []

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