ksuid 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a25a1c0246464a41b5b419ad0fffbd8c5b08b7dfb882ccb31a29a0a6fbbc0fe1
-  data.tar.gz: 70a978445c93cc062cb704a5156fd919c623677fc1666723ba1f828067978fcd
+  metadata.gz: c97a36378134ab6cdd674866a6744e5b84ff5976db6575d5364cc844cc9dbf4f
+  data.tar.gz: c5ebfa42d22044e518a63f9508924517a5b7ec83a9e3059c64ecb8075ee88e07
 SHA512:
-  metadata.gz: 7ed9fde240ebee2cdffcb81877548b780286844d2ccfa6a4200f4a0c36161e1d53f073b761e22d7b3fb0d857a31b2fae50fdb30a6ca3571b1cc933ea09281363
-  data.tar.gz: 946ad6b51f84fca3b1a0230c4892fc3afd862baabe232efac3b0f9d196d16e2c16702e645faf12bcb9e2614c15a504f007c9cc44383c5ac6e87b8feeb5554d7f
+  metadata.gz: 6743031c8702c60e3be6d58f2bde58b1290abc1943afb110adf3a9a2066017d24a453a826373312539175629b2ed9a612ed257abdad22e0cef74a88e045a12e5
+  data.tar.gz: c2c504f17a31fe7d0c25475b606045424868aca2aa0015e78ff41da89828a7e1eb5b88bcf88a8e0da34a81945d5c68b3cbfb1d4acead1d9227c423cc89ece0ae

data/CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [1.0.0](https://github.com/michaelherold/ksuid/compare/v0.5.0...v1.0.0) - 2023-02-25
+
+### Removed
+
+- Extracted the ActiveRecord functionality into its own gem, `activerecord-ksuid`. It is API-compatible with v0.5.0 so to restore functionality, you should only need to add the new gem to your application. See [the upgrading notice](./UPGRADING.md) for more information.
+
 ## [0.5.0](https://github.com/michaelherold/ksuid/compare/v0.4.0...v0.5.0) - 2022-08-18
 
 ### Added

data/CONTRIBUTING.md

@@ -28,9 +28,9 @@ Ideally, a bug report should include a pull request with failing specs.
 1. [Fork the repository].
 2. [Create a topic branch].
 3. Add specs for your unimplemented feature or bug fix.
-4. Run `appraisal rake spec`. If your specs pass, return to step 3.
+4. Run `bundle exec rake spec`. If your specs pass, return to step 3.
 5. Implement your feature or bug fix.
-6. Run `appraisal rake`. If your specs or any of the linters fail, return to step 5.
+6. Run `bundle exec rake`. If your specs or any of the linters fail, return to step 5.
 7. Open `coverage/index.html`. If your changes are not completely covered by your tests, return to step 3.
 8. Add documentation for your feature or bug fix.
 9. Commit and push your changes.

data/LICENSE.md

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 
-Copyright © 2017 Michael Herold
+Copyright © 2017-2022 Michael Herold
 
 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

data/README.md

@@ -122,138 +122,21 @@ ksuid = KSUID::Prefixed.from_base62(base62_string, prefix: 'evt_')
 
 Prefixed KSUIDs order themselves with non-prefixed KSUIDs as if their prefix did not exist. With other prefixed KSUIDs, they order first by their prefix, then their timestamp.
 
-### ActiveRecord
+### Integrations
 
-Whether you are using ActiveRecord inside an existing project or in a new project, usage is simple. Additionally, you can use it with or without Rails.
+KSUID for Ruby can integrate with other systems through adapter gems. Below is a sample of these adapter gems.
 
-_Note: In v1.0.0 of KSUID for Ruby, we will extract this behavior into a separate gem, `activerecord-ksuid`. It will be API-compatible with the implementation in v0.5.0+ of KSUID for Ruby. There will be upgrade instructions for v1.0.0 once we release it._
+#### ActiveRecord
 
-#### Adding to an existing model
+If you want to include KSUID columns in your ActiveRecord models, install the `activerecord-ksuid` gem. If you are using it within a Rails app, run the following:
 
-Within a Rails project, it is very easy to get started using KSUIDs within your models. You can use the `ksuid` column type in a Rails migration to add a column to an existing model:
+    bundle add activerecord-ksuid --require active_record/ksuid/railtie
+    
+If you are using it outside of Rails, add this to your Gemfile:
 
-    rails generate migration add_ksuid_to_events ksuid:ksuid
+    gem 'activerecord-ksuid', require: ['ksuid', 'active_record/ksuid', 'active_record/ksuid/table_definition']
 
-This will generate a migration like the following:
-
-```ruby
-class AddKsuidToEvents < ActiveRecord::Migration[5.2]
-  def change
-    add_column :events, :unique_id, :ksuid
-  end
-end
-```
-
-Then, to add proper handling to the field, you will want to mix a module into the model:
-
-```ruby
-class Event < ApplicationRecord
-  include ActiveRecord::KSUID[:unique_id]
-end
-```
-
-#### Creating a new model
-
-To create a new model with a `ksuid` field that is stored as a KSUID, use the `ksuid` column type. Using the Rails generators, this looks like:
-
-    rails generate model Event my_field_name:ksuid
-
-If you would like to add a KSUID to an existing model, you can do so with the following:
-
-```ruby
-class AddKsuidToEvents < ActiveRecord::Migration[5.2]
-  change_table :events do |table|
-    table.ksuid :my_field_name
-  end
-end
-```
-
-Once you have generated the table that you will use for your model, you will need to include a module into the model class, as follows:
-
-```ruby
-class Event < ApplicationRecord
-  include ActiveRecord::KSUID[:my_field_name]
-end
-```
-
-##### With a KSUID primary key
-
-You can also use a KSUID as the primary key on a table, much like you can use a UUID in vanilla Rails. To do so requires a little more finagling than you can manage through the generators. When hand-writing the migration, it will look like this:
-
-```ruby
-class CreateEvents < ActiveRecord::Migration[5.2]
-  create_table :events, id: false do |table|
-    table.ksuid :id, primary_key: true
-  end
-end
-```
-
-You will need to mix in the module into your model as well:
-
-```ruby
-class Event < ApplicationRecord
-  include ActiveRecord::KSUID[:id]
-end
-```
-
-#### Outside of Rails
-
-Outside of Rails, you cannot rely on the Railtie to load the appropriate files for you automatically. Toward the start of your application's boot process, you will want to require the following:
-
-```ruby
-require 'active_record/ksuid'
-
-# If you will be using the ksuid column type in a migration
-require 'active_record/ksuid/table_definition'
-```
-
-Once you have required the file(s) that you need, everything else will work as it does above.
-
-#### Binary vs. String KSUIDs
-
-These examples all store your identifier as a string-based KSUID. If you would like to use binary KSUIDs instead, use the `ksuid_binary` column type. Unless you need to be super-efficient with your database, we recommend using string-based KSUIDs because it makes looking at the data while in the database a little easier to understand.
-
-When you include the KSUID module into your model, you will want to pass the `:binary` option as well:
-
-```ruby
-class Event < ApplicationRecord
-  include ActiveRecord::KSUID[:my_field_name, binary: true]
-end
-```
-
-#### Using a prefix on your KSUID field
-
-For prefixed KSUIDs in ActiveRecord, you must pass the intended prefix during table definition so that the field is of appropriate size.
-
-```ruby
-class CreateEvents < ActiveRecord::Migration[5.2]
-  create_table :events do |table|
-    table.ksuid :ksuid, prefix: 'evt_'
-  end
-end
-```
-
-You also must pass it in the module builder that you include in your model:
-
-```ruby
-class Event < ApplicationRecord
-  include ActiveRecord::KSUID[:ksuid, prefix: 'evt_']
-end
-```
-
-You cannot use a prefix with a binary-encoded KSUID.
-
-#### Use the KSUID as your `created_at` timestamp
-
-Since KSUIDs include a timestamp as well, you can infer the `#created_at` timestamp from the KSUID. The module builder enables that option automatically with the `:created_at` option, like so:
-
-```ruby
-class Event < ApplicationRecord
-  include ActiveRecord::KSUID[:my_field_name, created_at: true]
-end
-```
-
-This allows you to be efficient in your database design if that is a constraint you need to satisfy.
+See [the readme for the integration](https://github.com/michaelherold/ksuid-ruby/blob/main/activerecord-ksuid/README.md) for more information.
 
 ## Contributing
 

data/UPGRADING.md

@@ -1,5 +1,20 @@
 # Upgrading instructions for KSUID for Ruby
 
+## v1.0.0
+
+### Extracted `ActiveRecord::KSUID` into its own gem
+
+That KSUID for Ruby included ActiveRecord support directly in its gem has always been a regret of mine. It adds ActiveRecord and Rails concerns to a gem that you can use in any context. It makes running the test suite more complicated for no real gain. And it makes it kludgy to add support for more systems, like Sequel, since you have conflicting concerns in the same gem.
+
+To remove this problem, v1.0.0 extracts the ActiveRecord behavior into its own gem, `activerecord-ksuid`. This version is a straight extraction with an improved test suite so it _should_ mean that the only change you have to make when upgrading from v0.5.0 is to do the following in your Gemfile:
+
+```diff
+- gem 'ksuid'
++ gem 'activerecord-ksuid'
+```
+
+If you are still on a version prior to v0.5.0, upgrade to that version first, solve the deprecation notice below, ensure your app still works, and then upgrade to v1.0.0.
+
 ## v0.5.0
 
 ### Deprecated `KSUID::ActiveRecord` in favor of `ActiveRecord::KSUID`

data/lib/ksuid/version.rb

@@ -4,5 +4,5 @@ module KSUID
   # The version of the KSUID gem
   #
   # @return [String]
-  VERSION = '0.5.0'
+  VERSION = '1.0.0'
 end

data/lib/ksuid.rb

@@ -250,5 +250,3 @@ module KSUID
   end
   private_class_method :cast_string
 end
-
-require 'active_record/ksuid/railtie' if defined?(Rails)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ksuid
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Michael Herold
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-18 00:00:00.000000000 Z
+date: 2023-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -37,14 +37,7 @@ files:
 - README.md
 - UPGRADING.md
 - ksuid.gemspec
-- lib/active_record/ksuid.rb
-- lib/active_record/ksuid/binary_type.rb
-- lib/active_record/ksuid/prefixed_type.rb
-- lib/active_record/ksuid/railtie.rb
-- lib/active_record/ksuid/table_definition.rb
-- lib/active_record/ksuid/type.rb
 - lib/ksuid.rb
-- lib/ksuid/activerecord.rb
 - lib/ksuid/base62.rb
 - lib/ksuid/configuration.rb
 - lib/ksuid/prefixed.rb
@@ -71,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Ruby implementation of the K-Sortable Unique IDentifier

data/lib/active_record/ksuid/binary_type.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-module ActiveRecord
-  module KSUID
-    # A binary-serialized KSUID for storage within an ActiveRecord database
-    #
-    # @api private
-    #
-    # @example Set an attribute as a KSUID using the verbose syntax
-    #   class EventWithBareBinaryType < ActiveRecord::Base
-    #     attribute :ksuid, ActiveRecord::KSUID::BinaryType.new, default: -> { KSUID.new }
-    #   end
-    #
-    # @example Set an attribute as a KSUID using the pre-registered type
-    #   class EventWithRegisteredBinaryType < ActiveRecord::Base
-    #     attribute :ksuid, :ksuid_binary, default: -> { KSUID.new }
-    #   end
-    class BinaryType < ::ActiveRecord::Type::Binary
-      # Casts a value from user input into a KSUID
-      #
-      # Type casting happens via the attribute setter and can take input from
-      # many places, including:
-      #
-      #   1. The Rails form builder
-      #   2. Directly from the attribute setter
-      #   3. From the model initializer
-      #
-      # @param value [String, Array<Integer>, KSUID::Type] the value to cast into a KSUID
-      # @return [KSUID::Type] the type-casted value
-      def cast(value)
-        ::KSUID.call(value)
-      end
-
-      # Converts a value from database input to a KSUID
-      #
-      # @param value [String, nil] the database-serialized KSUID to convert
-      # @return [KSUID::Type] the deserialized KSUID
-      def deserialize(value)
-        return unless value
-
-        value = value.to_s if value.is_a?(::ActiveRecord::Type::Binary::Data)
-        ::KSUID.call(value)
-      end
-
-      # Casts the value from a KSUID into a database-understandable format
-      #
-      # @param value [KSUID::Type, nil] the KSUID in Ruby format
-      # @return [String, nil] the base 62-encoded KSUID for storage in the database
-      def serialize(value)
-        return unless value
-
-        super(::KSUID.call(value).to_bytes)
-      end
-    end
-  end
-end
-
-ActiveRecord::Type.register(:ksuid_binary, ActiveRecord::KSUID::BinaryType)

data/lib/active_record/ksuid/prefixed_type.rb

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-module ActiveRecord
-  module KSUID
-    # A string-serialized, prefixed KSUID for storage within an ActiveRecord database
-    #
-    # @api private
-    # @since 0.5.0
-    #
-    # @example Set an attribute as a prefixed KSUID using the verbose syntax
-    #   class EventWithBarePrefixedType < ActiveRecord::Base
-    #     attribute(
-    #       :ksuid,
-    #       ActiveRecord::KSUID::PrefixedType.new(prefix: 'evt_'),
-    #       default: -> { KSUID.prefixed('evt_') }
-    #     )
-    #   end
-    #
-    # @example Set an attribute as a prefixed KSUID using the pre-registered type
-    #   class EventWithRegisteredPrefixedType < ActiveRecord::Base
-    #     attribute :ksuid, :ksuid_prefixed, prefix: 'evt_', default: -> { KSUID.prefixed('evt_') }
-    #   end
-    class PrefixedType < ::ActiveRecord::Type::String
-      # Instantiates an ActiveRecord::Type for handling prefixed KSUIDs
-      #
-      # @param prefix [String] the prefix to add to the KSUID
-      def initialize(prefix: '')
-        @prefix = prefix
-        super()
-      end
-
-      # Casts a value from user input into a {KSUID::Prefixed}
-      #
-      # Type casting happens via the attribute setter and can take input from
-      # many places, including:
-      #
-      #   1. The Rails form builder
-      #   2. Directly from the attribute setter
-      #   3. From the model initializer
-      #
-      # @param value [String, Array<Integer>, KSUID::Prefixed] the value to cast into a KSUID
-      # @return [KSUID::Prefixed] the type-casted value
-      def cast(value)
-        ::KSUID::Prefixed.call(value, prefix: @prefix)
-      end
-
-      # Converts a value from database input to a {KSUID::Prefixed}
-      #
-      # @param value [String, nil] the database-serialized, prefixed KSUID to convert
-      # @return [KSUID::Prefixed] the deserialized, prefixed KSUID
-      def deserialize(value)
-        return unless value
-
-        ::KSUID::Prefixed.from_base62(value, prefix: @prefix)
-      end
-
-      # Casts the value from a KSUID into a database-understandable format
-      #
-      # @param value [KSUID::Prefixed, nil] the prefixed KSUID in Ruby format
-      # @return [String, nil] the base 62-encoded, prefixed KSUID for storage in the database
-      def serialize(value)
-        return unless value
-
-        ::KSUID::Prefixed.call(value, prefix: @prefix).to_s
-      end
-    end
-  end
-end
-
-ActiveRecord::Type.register(:ksuid_prefixed, ActiveRecord::KSUID::PrefixedType)

data/lib/active_record/ksuid/railtie.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module ActiveRecord
-  module KSUID
-    # Enables the usage of KSUID types within ActiveRecord when Rails is loaded
-    #
-    # @api private
-    class Railtie < ::Rails::Railtie
-      initializer 'ksuid' do
-        ActiveSupport.on_load :active_record do
-          require 'active_record/ksuid'
-          require 'ksuid/activerecord'
-        end
-      end
-
-      initializer 'ksuid.table_definition' do
-        ActiveSupport.on_load :active_record do
-          require 'active_record/ksuid/table_definition'
-
-          ActiveRecord::ConnectionAdapters::TableDefinition.include(
-            ActiveRecord::KSUID::TableDefinition
-          )
-        end
-      end
-    end
-  end
-end

data/lib/active_record/ksuid/table_definition.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-module ActiveRecord
-  module KSUID
-    # Extends ActiveRecord's table definition language for KSUIDs
-    module TableDefinition
-      # Defines a field as a string-based KSUID
-      #
-      # @example Define a KSUID field as a non-primary key
-      #   ActiveRecord::Schema.define do
-      #     create_table :events, force: true do |table|
-      #       table.ksuid :ksuid, index: true, unique: true
-      #     end
-      #   end
-      #
-      # @example Define a KSUID field as a primary key
-      #   ActiveRecord::Schema.define do
-      #     create_table :events, force: true, id: false do |table|
-      #       table.ksuid :id, primary_key: true
-      #     end
-      #   end
-      #
-      # @param args [Array<Symbol>] the list of fields to define as KSUIDs
-      # @param options [Hash] see {ActiveRecord::ConnectionAdapters::TableDefinition}
-      # @option options [String] :prefix the prefix expected in front of the KSUID
-      # @return [void]
-      def ksuid(*args, **options)
-        prefix_length = options.delete(:prefix)&.length || 0
-
-        args.each { |name| column(name, :string, **options.merge(limit: 27 + prefix_length)) }
-      end
-
-      # Defines a field as a binary-based KSUID
-      #
-      # @example Define a KSUID field as a non-primary key
-      #   ActiveRecord::Schema.define do
-      #     create_table :events, force: true do |table|
-      #       table.ksuid_binary :ksuid, index: true, unique: true
-      #     end
-      #   end
-      #
-      # @example Define a KSUID field as a primary key
-      #   ActiveRecord::Schema.define do
-      #     create_table :events, force: true, id: false do |table|
-      #       table.ksuid_binary :id, primary_key: true
-      #     end
-      #   end
-      #
-      # @param args [Array<Symbol>] the list of fields to define as KSUIDs
-      # @param options [Hash] see {ActiveRecord::ConnectionAdapters::TableDefinition}
-      # @return [void]
-      def ksuid_binary(*args, **options)
-        args.each { |name| column(name, :binary, **options.merge(limit: 20)) }
-      end
-    end
-  end
-end

data/lib/active_record/ksuid/type.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-module ActiveRecord
-  module KSUID
-    # A string-serialized KSUID for storage within an ActiveRecord database
-    #
-    # @api private
-    #
-    # @example Set an attribute as a KSUID using the verbose syntax
-    #   class EventWithBareType < ActiveRecord::Base
-    #     attribute :ksuid, ActiveRecord::KSUID::Type.new, default: -> { KSUID.new }
-    #   end
-    #
-    # @example Set an attribute as a KSUID using the pre-registered type
-    #   class EventWithRegisteredType < ActiveRecord::Base
-    #     attribute :ksuid, :ksuid, default: -> { KSUID.new }
-    #   end
-    class Type < ::ActiveRecord::Type::String
-      # Casts a value from user input into a KSUID
-      #
-      # Type casting happens via the attribute setter and can take input from
-      # many places, including:
-      #
-      #   1. The Rails form builder
-      #   2. Directly from the attribute setter
-      #   3. From the model initializer
-      #
-      # @param value [String, Array<Integer>, KSUID::Type] the value to cast into a KSUID
-      # @return [KSUID::Type] the type-casted value
-      def cast(value)
-        ::KSUID.call(value)
-      end
-
-      # Converts a value from database input to a KSUID
-      #
-      # @param value [String, nil] the database-serialized KSUID to convert
-      # @return [KSUID::Type] the deserialized KSUID
-      def deserialize(value)
-        return unless value
-
-        ::KSUID.from_base62(value)
-      end
-
-      # Casts the value from a KSUID into a database-understandable format
-      #
-      # @param value [KSUID::Type, nil] the KSUID in Ruby format
-      # @return [String, nil] the base 62-encoded KSUID for storage in the database
-      def serialize(value)
-        return unless value
-
-        ::KSUID.call(value).to_s
-      end
-    end
-  end
-end
-
-ActiveRecord::Type.register(:ksuid, ActiveRecord::KSUID::Type)

data/lib/active_record/ksuid.rb

@@ -1,119 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_record/ksuid/binary_type'
-require 'active_record/ksuid/prefixed_type'
-require 'active_record/ksuid/type'
-
-# The Ruby on Rails object-relational mapper
-#
-# @see https://guides.rubyonrails.org/ Ruby on Rails documentation
-module ActiveRecord
-  # Enables an Active Record model to have a KSUID attribute
-  #
-  # @api public
-  # @since 0.5.0
-  module KSUID
-    # Builds a module to include into the model
-    #
-    # @api public
-    #
-    # @example Add a `#ksuid` attribute to a model
-    #   class Event < ActiveRecord::Base
-    #     include ActiveRecord::KSUID[:ksuid]
-    #   end
-    #
-    # @example Add a `#remote_id` attribute to a model and overrides `#created_at` to use the KSUID
-    #   class Event < ActiveRecord::Base
-    #     include ActiveRecord::KSUID[:remote_id, created_at: true]
-    #   end
-    #
-    # @example Add a prefixed `#ksuid` attribute to a model
-    #   class Event < ActiveRecord::Base
-    #     include ActiveRecord::KSUID[:ksuid, prefix: 'evt_']
-    #   end
-    #
-    # @param field [String, Symbol] the name of the field to use as a KSUID
-    # @param created_at [Boolean] whether to override the `#created_at` method
-    # @param binary [Boolean] whether to store the KSUID as a binary or a string
-    # @param prefix [String, nil] a prefix to prepend to the KSUID attribute
-    # @return [Module] the module to include into the model
-    def self.[](field, created_at: false, binary: false, prefix: nil)
-      raise ArgumentError, 'cannot include a prefix on a binary KSUID' if binary && prefix
-
-      Module.new.tap do |mod|
-        if prefix
-          define_prefixed_attribute(field, mod, prefix)
-        else
-          define_attribute(field, mod, binary)
-        end
-        define_created_at(field, mod) if created_at
-      end
-    end
-
-    # Defines the attribute method that will be written in the module
-    #
-    # @api private
-    #
-    # @param field [String, Symbol] the name of the field to set as an attribute
-    # @param mod [Module] the module to extend
-    # @param binary [Boolean] whether to store the KSUID as a binary or a string
-    # @return [void]
-    def self.define_attribute(field, mod, binary)
-      type = 'ksuid'
-      type = 'ksuid_binary' if binary
-
-      mod.module_eval <<-RUBY, __FILE__, __LINE__ + 1
-        def self.included(base)         # def self.included(base)
-          base.__send__(                #   base.__send__(
-            :attribute,                 #     :attribute,
-            :#{field},                  #     :id,
-            :#{type},                   #     :ksuid,
-            default: -> { ::KSUID.new } #     default: -> { ::KSUID.new }
-          )                             #   )
-        end                             # end
-      RUBY
-    end
-    private_class_method :define_attribute
-
-    # Defines the attribute method that will be written in the module for a field
-    #
-    # @api private
-    #
-    # @param field [String, Symbol] the name of the field to set as an attribute
-    # @param mod [Module] the module to extend
-    # @param prefix [String] the prefix to add to the KSUID
-    # @return [void]
-    def self.define_prefixed_attribute(field, mod, prefix)
-      mod.module_eval <<-RUBY, __FILE__, __LINE__ + 1
-        def self.included(base)                                 # def self.included(base)
-          base.__send__(                                        #   base.__send__(
-            :attribute,                                         #     :attribute,
-            :#{field},                                          #     :id,
-            :ksuid_prefixed,                                    #     :ksuid_prefixed,
-            prefix: #{prefix.inspect},                          #     prefix: 'evt_'
-            default: -> { ::KSUID.prefixed(#{prefix.inspect}) } #     default: -> { ::KSUID.prefixed('evt_') }
-          )                                                     #   )
-        end                                                     # end
-      RUBY
-    end
-    private_class_method :define_prefixed_attribute
-
-    # Defines the `#created_at` method that will be written in the module
-    #
-    # @api private
-    #
-    # @param field [String, Symbol] the name of the KSUID attribute field
-    # @param mod [Module] the module to extend
-    # @return [void]
-    def self.define_created_at(field, mod)
-      mod.module_eval <<-RUBY, __FILE__, __LINE__ + 1
-        def created_at           # def created_at
-          return unless #{field} #   return unless ksuid
-
-          #{field}.to_time       #   ksuid.to_time
-        end                      # end
-      RUBY
-    end
-    private_class_method :define_created_at
-  end
-end

data/lib/ksuid/activerecord.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_record/ksuid'
-
-module KSUID
-  # Enables an Active Record model to have a KSUID attribute
-  #
-  # @api public
-  # @deprecated Use {ActiveRecord::KSUID} instead.
-  module ActiveRecord
-    # Builds a module to include into the model
-    #
-    # @api public
-    # @deprecated Use {::ActiveRecord::KSUID.[]} instead.
-    #
-    # @example Add a `#ksuid` attribute to a model
-    #   class Event < ActiveRecord::Base
-    #     include KSUID::ActiveRecord[:ksuid]
-    #   end
-    #
-    # @example Add a `#remote_id` attribute to a model and overrides `#created_at` to use the KSUID
-    #   class Event < ActiveRecord::Base
-    #     include KSUID::ActiveRecord[:remote_id, created_at: true]
-    #   end
-    #
-    # @param (see ::ActiveRecord::KSUID.[])
-    # @return  (see ::ActiveRecord::KSUID.[])
-    def self.[](field, created_at: false, binary: false, prefix: nil)
-      ActiveSupport::Deprecation.instance.warn(
-        'KSUID::ActiveRecord is deprecated! Use ActiveRecord::KSUID instead.',
-        caller_locations
-      )
-
-      ::ActiveRecord::KSUID[field, created_at: created_at, binary: binary, prefix: prefix]
-    end
-  end
-end