uuid_v7 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7f2e1977f048847c67027e4d8b3198694649c1f133c2aaa67860f9e4ac2d88f6
+  data.tar.gz: fc53aad1bee9794d09625d9dacde902740bb64c37cac35880d22303d06ca7c99
+SHA512:
+  metadata.gz: 4d190d6665642ad22858d65fb97456eb79de4cce1ac73fc1f93af0fe675685087dfa01d68457f42a21152c816c48bb7393a6bf80df6869d58ac8b305482471ef
+  data.tar.gz: 4795012dfad57805620ec1527f2226daab4ffea576efc91bcb507467d0f3d5a9fec3542defeae0405b7070844efd431d8443400a6331e8070c1c52ce1d528161

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,24 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.2.1
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Lint/SuppressedException:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,50 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2023-12-06 07:57:17 UTC using RuboCop version 1.57.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 64
+
+# Offense count: 2
+# Configuration parameters: IgnoredMetadata.
+RSpec/DescribeClass:
+  Exclude:
+    - '**/spec/features/**/*'
+    - '**/spec/requests/**/*'
+    - '**/spec/routing/**/*'
+    - '**/spec/system/**/*'
+    - '**/spec/views/**/*'
+    - 'spec/integrations/crud_ar_spec.rb'
+    - 'spec/integrations/migrations/mysql/fx_migration_spec.rb'
+
+# Offense count: 2
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 12
+
+# Offense count: 2
+RSpec/MultipleExpectations:
+  Max: 2
+
+# Offense count: 2
+# Configuration parameters: AllowedGroups.
+RSpec/NestedGroups:
+  Max: 5
+
+# Offense count: 2
+RSpec/SubjectStub:
+  Exclude:
+    - 'spec/integrations/migrations/mysql/fx_migration_spec.rb'
+
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 155

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-11-28
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at joel.azemar@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Joel Azemar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,143 @@
+# UUID V7 for Ruby on Rails
+
+## Introduction
+`uuid_v7` is a RubyGem specifically designed to provide UUID V7 support for Mysql and Sqlite databases in Ruby on Rails applications. This gem is particularly useful because these databases lack a native type for supporting UUIDs.
+
+**Note:** PostgreSQL users do not require this gem as PostgreSQL supports UUID natively.
+
+## Features
+- Converts UUID V7 CHAR(36) to a more efficient CHAR(32) and stores it in BINARY(16) for performance enhancement.
+- Integrates seamlessly with `ActiveRecord::Base`, enabling UUID as the primary key for models.
+- Migration helper for easy transition to UUIDs in existing Rails applications, specifically tailored for Mysql.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'uuid_v7'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install uuid_v7
+```
+
+## Usage
+
+### Basic Setup
+
+Once installed, `uuid_v7` extends `ActiveRecord::Base` to use UUID as the primary key.
+
+### Foreign Keys
+
+Declare foreign key associations in your models as follows:
+
+```ruby
+class Author < ActiveRecord::Base
+  has_many :books
+end
+
+class Book < ActiveRecord::Base
+  attribute :author_id, :uuid_v7
+  belongs_to :author
+end
+```
+
+## Configuration
+
+### Custom Primary Key
+
+If your primary key is not `:id`, run:
+
+```bash
+rails generate uuid_v7:install
+```
+
+And configure:
+
+```ruby
+UuidV7.configure do |config|
+  config.field_name = :uuid
+end
+```
+
+### Implicit Inclusion Strategy
+
+By defaut the primary key type is overrided, if you want to prevent that behaviour toogle the strategy.
+
+in `config/initializers/uuid_v7.rb``
+
+```ruby
+UuidV7.configure do |config|
+  config.implicit_inclusion_strategy = false
+end
+```
+
+Then add manually to the model you want.
+
+```ruby
+class Author < ActiveRecord::Base
+  attribute :id, :uuid_v7, default: -> { SecureRandom.uuid_v7 }
+
+  has_many :books
+end
+```
+
+**Recommendation:** It's advised to use `:id` as the primary key with Rails for compatibility and convention.
+
+### Migrations
+
+#### Helper for Mysql
+
+`uuid_v7` provides a migration helper for Mysql. To add a UUID field to a model, run:
+
+```bash
+rails generate migration AddUuidToUser uuid:binary
+```
+
+Then use the helper in your migration file:
+
+```ruby
+class AddUuidToUser < ActiveRecord::Migration[7.1]
+  def change
+    # Add the field :uuid
+    populate_uuid_field(table_name: :users, column_name: :uuid)
+  end
+end
+```
+
+#### Custom Migration Template
+
+To override the default `:id` implementation in new migrations:
+
+```bash
+rails generate uuid_v7:migrations
+```
+
+A modified migration template will be available under `lib/templates/active_record/migration/create_table_migration.rb`.
+
+Example of a generated model migration:
+
+```ruby
+class AddAuthor < ActiveRecord::Migration[7.1]
+  def change
+    create_table :authors, id: false do |t|
+      t.binary :id, limit: 16, null: false, index: { unique: true }, primary_key: true
+      t.string :name
+      t.timestamps
+    end
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/alliantist/uuid_v7].

data/Rakefile

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+ENV["DATABASE"] ||= "sqlite3"
+
+case ENV.fetch("DATABASE", nil)
+when "mysql"
+  RSpec::Core::RakeTask.new(:spec) do |task|
+    task.exclude_pattern = "spec/integrations/migrations/sqlite3/*_spec.rb"
+  end
+when "sqlite3"
+  RSpec::Core::RakeTask.new(:spec) do |task|
+    task.exclude_pattern = "spec/integrations/migrations/mysql/*_spec.rb"
+  end
+else
+  raise "Unsupported database: #{ENV.fetch("DATABASE", nil)}"
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.options = ["-A"] # auto_correct
+end
+
+task default: %i[spec rubocop]

data/lib/generators/uuid_v7/install/templates/uuid_v7.rb.tt

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "uuid_v7"
+
+UuidV7.configure do |config|
+  # config.field_name = :id # default :id
+  # config.implicit_inclusion_strategy = true # default true
+end

data/lib/generators/uuid_v7/install_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module UuidV7
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("install/templates", __dir__)
+
+      desc "rails generate uuid_v7:install"
+      def copy_initializer_file
+        template "uuid_v7.rb.tt", "config/initializers/uuid_v7.rb"
+      end
+    end
+  end
+end

data/lib/generators/uuid_v7/migrations/templates/create_table_migration.rb.tt

@@ -0,0 +1,46 @@
+# Source: https://github.com/rails/rails/blob/v7.1.2/activerecord/lib/rails/generators/active_record/migration/templates/create_table_migration.rb.tt
+#
+# This template comes from your local project under lib/rails/generators/active_record/migration/templates/create_table_migration.rb.tt.
+# It is based on Rails 7.1. If your Rails version diverges, please note that the generator is outdated, and changes might be made.
+#
+class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+<% if ["SQLite", "Mysql2"].include?(ActiveRecord::Base.connection.adapter_name) -%>
+    create_table :<%= table_name %>, id: false do |t|
+      t.binary :<%= UuidV7.configuration.field_name %>, limit: 16, null: false, index: { unique: true }, primary_key: true
+<% else -%>
+    create_table :<%= table_name %><%= primary_key_type %> do |t|
+<% end -%>
+<% attributes.each do |attribute| -%>
+<% if attribute.password_digest? -%>
+      t.string :password_digest<%= attribute.inject_options %>
+<% elsif attribute.token? -%>
+      t.string :<%= attribute.name %><%= attribute.inject_options %>
+<% elsif attribute.reference? -%>
+<% if ["SQLite", "Mysql2"].include?(ActiveRecord::Base.connection.adapter_name) -%>
+<% if UuidV7.configuration.field_name == :id -%>
+      t.references :<%= attribute.name %>, foreign_key: true, index: true, type: :binary, limit: 16, null: false
+<% else -%>
+      t.binary :<%= attribute.name %>_id, null: false, limit: 16
+      t.foreign_key :<%= attribute.name %>s, column: :<%= attribute.name %>_id, primary_key: :<%= UuidV7.configuration.field_name %>
+      t.index :<%= attribute.name %>_id
+<% end -%>
+<% else -%>
+      t.<%= attribute.type %> :<%= attribute.name %><%= attribute.inject_options %><%= foreign_key_type %>
+<% end -%>
+<% elsif !attribute.virtual? -%>
+      t.<%= attribute.type %> :<%= attribute.name %><%= attribute.inject_options %>
+<% end -%>
+<% end -%>
+<% if options[:timestamps] %>
+      t.timestamps
+<% end -%>
+    end
+<% attributes.select(&:token?).each do |attribute| -%>
+    add_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>, unique: true
+<% end -%>
+<% attributes_with_index.each do |attribute| -%>
+    add_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>
+<% end -%>
+  end
+end

data/lib/generators/uuid_v7/migrations_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module UuidV7
+  module Generators
+    class MigrationsGenerator < Rails::Generators::Base
+      source_root File.expand_path("migrations/templates", __dir__)
+
+      desc "rails generate uuid_v7:migrations"
+      def copy_initializer_file
+        copy_file "create_table_migration.rb.tt", "lib/templates/active_record/migration/create_table_migration.rb.tt"
+      end
+    end
+  end
+end

data/lib/uuid_v7/base.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module UuidV7
+  module Base
+    extend ActiveSupport::Concern
+
+    included do
+      attribute UuidV7.configuration.field_name, :uuid_v7, default: -> { SecureRandom.uuid_v7 }
+    end
+  end
+end

data/lib/uuid_v7/configuration.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module UuidV7
+  class Configuration
+    attr_accessor :field_name, :implicit_inclusion_strategy
+
+    def initialize
+      self.field_name = :uuid
+      self.implicit_inclusion_strategy = true
+    end
+  end
+end

data/lib/uuid_v7/configure.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module UuidV7
+  module Configure
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/lib/uuid_v7/patches/mysql/fx_migration.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module UuidV7
+  module Patches
+    module Mysql
+      module FxMigration
+        def populate_uuid_field(table_name:, column_name:)
+          table_name  = table_name.to_s.to_sym
+          column_name = column_name.to_s.to_sym
+
+          raise ArgumentError, "Column #{column_name} does not exist on table #{table_name}" unless column_exists?(table_name, column_name)
+
+          connection.execute <<~SQL
+            DROP FUNCTION IF EXISTS uuid_v7;
+          SQL
+
+          connection.exec_query <<~SQL.squish
+            CREATE FUNCTION uuid_v7 ()
+            RETURNS BINARY(16)
+            LANGUAGE SQL
+            NOT DETERMINISTIC
+            NO SQL
+            SQL SECURITY DEFINER
+            BEGIN
+              DECLARE uuid          CHAR(36);
+              DECLARE undashed_uuid CHAR(32);
+              DECLARE currentTime   BIGINT;
+              DECLARE buuid         BINARY(16);
+
+              SET currentTime = UNIX_TIMESTAMP() * 1000 + FLOOR(MICROSECOND(NOW(6)) / 1000);
+
+              SET uuid = LOWER(
+                CONCAT(
+                  LPAD(HEX(currentTime), 12, '0'), '-7',
+                  LPAD(HEX(FLOOR(RAND() * 0x1000)), 3, '0'), '-',
+                  HEX(0x8000 | FLOOR(RAND() * 0x4000)), '-',
+                  LPAD(HEX(FLOOR(RAND() * 0x1000000000000)), 12, '0')
+                )
+              );
+
+              SET undashed_uuid = REPLACE(uuid, '-', '');
+              SET buuid = UNHEX(undashed_uuid);
+
+              RETURN buuid;
+            END
+          SQL
+
+          connection.execute <<~SQL
+            UPDATE #{table_name} SET #{column_name} = uuid_v7() WHERE #{column_name} IS NULL;
+          SQL
+
+          connection.execute <<~SQL
+            DROP FUNCTION IF EXISTS uuid_v7;
+          SQL
+        end
+      end
+    end
+  end
+end

data/lib/uuid_v7/railtie.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+require "active_support"
+
+module UuidV7
+  class Railtie < Rails::Railtie
+    initializer "uuid_v7.initialize" do
+      case ActiveRecord::Base.connection.adapter_name
+      when "SQLite"
+        require_relative "types/sqlite_type"
+        ActiveRecord::Type.register(:uuid_v7, UuidV7::Types::SqliteType, adapter: :sqlite3)
+      when "Mysql2"
+        require_relative "types/mysql_type"
+        ActiveRecord::Type.register(:uuid_v7, UuidV7::Types::MysqlType, adapter: :mysql2)
+
+        ActiveSupport.on_load(:active_record) do
+          ActiveRecord::Migration.include(Patches::Mysql::FxMigration) unless ActiveRecord::Migration.include?(Patches::Mysql::FxMigration)
+        end
+      when "PostgreSQL"
+        raise NotImplementedError, "PostgreSQL support native UUID type, no need for this gem."
+      else
+        raise NotImplementedError, "Adapter #{ActiveRecord::Base.connection.adapter_name} not supported"
+      end
+
+      Rails.application.config.after_initialize do
+        if UuidV7.configuration.implicit_inclusion_strategy
+          ActiveSupport.on_load(:active_record) do
+            include UuidV7::Base unless include?(UuidV7::Base)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/uuid_v7/types/base.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require "active_model/type"
+
+module UuidV7
+  module Types
+    class InvalidUUID < StandardError; end
+
+    class Base < ActiveModel::Type::Binary
+      def type
+        :uuid_v7
+      end
+
+      # Type casts a value from user input (e.g. from a setter). This value may
+      # be a string from the form builder, or a ruby object passed to a setter.
+      # There is currently no way to differentiate between which source it came
+      # from.
+      #
+      # The return value of this method will be returned from
+      # ActiveRecord::AttributeMethods::Read#read_attribute. See also:
+      # Value#cast_value.
+      #
+      # +value+ The raw input, as provided to the attribute setter.
+      def cast(value)
+        return unless value
+
+        super(add_dashes(value.to_s)) # super will encode the value as binary (Encoding::BINARY)
+      end
+
+      # Casts a value from the ruby type to a type that the database knows how
+      # to understand. The returned value from this method should be a
+      # +String+, +Numeric+, +Date+, +Time+, +Symbol+, +true+, +false+, or
+      # +nil+.
+      def serialize(value)
+        return unless value
+
+        # To avoid SQL injection, verify that it looks like a UUID. ActiveRecord
+        # does not explicity escape the Binary data type. escaping is implicit as
+        # the Binary data type always converts its value to a hex string.
+        raise InvalidUUID, "#{value} is not a valid UUID" unless value.match?(/\A\h{8}-\h{4}-\h{4}-\h{4}-\h{12}\z/)
+
+        return value if value.is_a?(Data)
+
+        Data.new(strip_dashes(value))
+      end
+
+      # Converts a value from database input to the appropriate ruby type. The
+      # return value of this method will be returned from
+      # ActiveRecord::AttributeMethods::Read#read_attribute. The default
+      # implementation just calls Value#cast.
+      #
+      # +value+ The raw input, as provided from the database.
+
+      # ActiveModel::Type::Binary implements this method as:
+      # def deserialize(value)
+      #   cast(value)
+      # end
+      def deserialize(value)
+        return unless value
+
+        # If the value is a binary data, convert it to a hex string, and call cast(value)
+        if value.is_a?(String) && value.encoding == Encoding::ASCII_8BIT
+          super(value.unpack1("H*"))
+        else
+          super # foward to cast(value)
+        end
+      end
+
+      # We need to override the hex method to avoid unpacking when quoting
+      # ActiveRecord calls hex method when quoting a value.
+      # https://github.com/rails/rails/blob/7-1-stable/activerecord/lib/active_record/connection_adapters/mysql/quoting.rb#L57
+      class Data < ActiveModel::Type::Binary::Data
+        def initialize(value)
+          @value = value
+
+          super(value)
+        end
+
+        def hex
+          @value
+        end
+      end
+
+      private
+
+      # A UUID consists of 5 groups of characters.
+      #   8 chars - 4 chars - 4 chars - 4 chars - 12 characters
+      #
+      # This function re-introduces the dashes since we removed them during
+      # serialization, so:
+      #
+      #   add_dashes("2b4a233152694c6e9d1e098804ab812b")
+      #     => "2b4a2331-5269-4c6e-9d1e-098804ab812b"
+      #
+      def add_dashes(uuid)
+        return uuid if uuid.include?("-")
+
+        [uuid[0..7], uuid[8..11], uuid[12..15], uuid[16..19], uuid[20..]].join("-")
+      end
+
+      # A UUID has 4 dashes is displayed with 4 dashes at the same place all
+      # the time. So they don't add anything semantically. We can safely remove
+      # them before storing to the database, and re-add them whenever we
+      # retrieved a value from the database.
+      #
+      #   strip_dashes("2b4a2331-5269-4c6e-9d1e-098804ab812b")
+      #     => "2b4a233152694c6e9d1e098804ab812b"
+      #
+      def strip_dashes(uuid)
+        uuid.delete("-")
+      end
+    end
+  end
+end

data/lib/uuid_v7/types/mysql_type.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module UuidV7
+  module Types
+    class MysqlType < Base
+    end
+  end
+end

data/lib/uuid_v7/types/sqlite_type.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module UuidV7
+  module Types
+    class SqliteType < Base
+      # SQLite does not return binary data, it returns a String, no need to unpack it.
+      def deserialize(value)
+        return unless value
+
+        cast(value)
+      end
+    end
+  end
+end

data/lib/uuid_v7/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module UuidV7
+  VERSION = "0.1.0"
+end

data/lib/uuid_v7.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/generators")
+loader.ignore("#{__dir__}/uuid_v7/railtie.rb")
+loader.setup
+
+require "uuid_v7/railtie" if defined?(Rails)
+
+module UuidV7
+  extend Configure
+  class Error < StandardError; end
+end

data/sig/uuid_v7.rbs

@@ -0,0 +1,4 @@
+module UuidV7
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/uuid_v7.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "lib/uuid_v7/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "uuid_v7"
+  spec.version = UuidV7::VERSION
+  spec.authors = ["Joel Azemar"]
+  spec.email = ["joel.azemar@gmail.com"]
+
+  spec.summary = "Provides UUID V7 support for Ruby on Rails applications using Mysql and Sqlite."
+  spec.description = "uuid_v7 enables UUID V7 as primary keys in Rails, optimized for Mysql and Sqlite, with efficient migration and integration features."
+
+  spec.homepage = "https://github.com/alliantist/uuid_v7"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.2.1"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+
+  spec.add_dependency "activemodel", "~> 7.0"
+  spec.add_dependency "activesupport", "~> 7.0"
+  spec.add_dependency "base58", "~> 0.2.3" # Used to convert between integers and base58 strings.
+  spec.add_dependency "securerandom", "~> 0.3.0" # Needed for SecureRandom.uuid_v7 until we upgrade to Ruby 3.3
+  spec.add_dependency "zeitwerk", "~> 2.5" # Used to autoload classes
+
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: uuid_v7
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joel Azemar
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: base58
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+- !ruby/object:Gem::Dependency
+  name: securerandom
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+description: uuid_v7 enables UUID V7 as primary keys in Rails, optimized for Mysql
+  and Sqlite, with efficient migration and integration features.
+email:
+- joel.azemar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/uuid_v7/install/templates/uuid_v7.rb.tt
+- lib/generators/uuid_v7/install_generator.rb
+- lib/generators/uuid_v7/migrations/templates/create_table_migration.rb.tt
+- lib/generators/uuid_v7/migrations_generator.rb
+- lib/uuid_v7.rb
+- lib/uuid_v7/base.rb
+- lib/uuid_v7/configuration.rb
+- lib/uuid_v7/configure.rb
+- lib/uuid_v7/patches/mysql/fx_migration.rb
+- lib/uuid_v7/railtie.rb
+- lib/uuid_v7/types/base.rb
+- lib/uuid_v7/types/mysql_type.rb
+- lib/uuid_v7/types/sqlite_type.rb
+- lib/uuid_v7/version.rb
+- sig/uuid_v7.rbs
+- uuid_v7.gemspec
+homepage: https://github.com/alliantist/uuid_v7
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.0.dev
+signing_key:
+specification_version: 4
+summary: Provides UUID V7 support for Ruby on Rails applications using Mysql and Sqlite.
+test_files: []