encoded_id-rails 1.0.0.beta3 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a38e6af88bf9343e2e4d22a82eb4c4d87766e962f3a8d330bf6aad1ad374639
-  data.tar.gz: 3ea6b28d604d3f728da545d324f50b12845f2feb9b7ed83c32349e002cdb6c93
+  metadata.gz: 67437c2f5ede5d3d8a7ff14079ce9518b1e63a48812fd37a88d61772fa1d0ea3
+  data.tar.gz: 59f73a3eb40b421bdf50115f806cbf5cd41b09213ebe87ce4d1842b098530f47
 SHA512:
-  metadata.gz: b03bc14efe460f8f479f109d32a4197c88cc85b72d87b7aa348e40057c4ae540728f5f3c383b943460ebbfdcfdd7e3173c363dbb423026386331fe17ea7e50e8
-  data.tar.gz: 5a6f16dc29c1c43450f278e08b7c82e597e13a70b4ea5183cbcc97d690307c6b847b5fef8cd594cb0f1396aca685beac78a8c427826b2003a1b2820b319793a3
+  metadata.gz: c8f03e548c344e45343ad831b568eedf705c02db9da876445a67d8814d9d4efd37d0ae639bf7eb6a1fd33685d68bc01077a523addffa319c9022cfd534771de7
+  data.tar.gz: 0037b79f44ce1ddeb97bc142e11c35b045c446db1b87e7122eeceb06bb606499a60764c3ab85593d352f0be39b074cf72805078d511bce80c53cd3ba745372b5

data/.devcontainer/Dockerfile

@@ -0,0 +1,17 @@
+# Make sure RUBY_VERSION matches the Ruby version in .ruby-version or gemspec
+ARG RUBY_VERSION=3.4.2
+FROM ghcr.io/rails/devcontainer/images/ruby:$RUBY_VERSION
+
+USER root
+
+# Install pkg-config and SQLite development libraries
+RUN apt-get update -qq && \
+    apt-get install -y pkg-config libsqlite3-dev && \
+    apt-get clean && \
+    rm -rf /var/lib/apt/lists/*
+
+USER vscode
+
+# Ensure binding is always 0.0.0.0
+# Binds the server to all IP addresses of the container, so it can be accessed from outside the container.
+ENV BINDING="0.0.0.0"

data/.devcontainer/compose.yml

@@ -0,0 +1,10 @@
+name: "encoded_id-rails"
+
+services:
+  encoded-id-rails-dev-env:
+    container_name: encoded-id-rails-dev-env
+    build:
+      context: ..
+      dockerfile: .devcontainer/Dockerfile
+    ports:
+      - "3000"

data/.devcontainer/devcontainer.json

@@ -0,0 +1,12 @@
+{
+  "name": "Encoded ID Rails Gem Development",
+  "dockerComposeFile": "compose.yml",
+  "service": "encoded-id-rails-dev-env",
+  "containerEnv": {
+    "RAILS_ENV": "development"
+  },
+  "forwardPorts": [3000],
+  "postCreateCommand": "bundle install && bundle exec appraisal install",
+  "postStartCommand": "bundle exec rake test",
+  "remoteUser": "vscode"
+}

data/Appraisals

@@ -1,14 +1,9 @@
-appraise "rails-6.1" do
-  gem "activesupport", "~> 6.1.7", ">= 6.1.0"
-  gem "activerecord", "~> 6.1.7", ">= 6.1.0"
+appraise "rails-7.2" do
+  gem "activesupport", "~> 7.2.0"
+  gem "activerecord", "~> 7.2.0"
 end
 
-appraise "rails-7.0" do
-  gem "activesupport", "~> 7.0.4"
-  gem "activerecord", "~> 7.0.4"
-end
-
-appraise "rails-7.1" do
-  gem "activesupport", "~> 7.1"
-  gem "activerecord", "~> 7.1"
+appraise "rails-8.0" do
+  gem "activesupport", "~> 8.0.0"
+  gem "activerecord", "~> 8.0.0"
 end

data/Gemfile

@@ -14,5 +14,11 @@ group :development, :test do
 
   gem "steep", "~> 1.5"
 
-  gem "sqlite3", "~> 1.5"
+  gem "rails"
+
+  gem "sqlite3"
+
+  gem "appraisal"
+
+  gem "simplecov"
 end

data/README.md

@@ -2,7 +2,7 @@
 
 `EncodedId::Rails` lets you turn numeric or hex **IDs into reversible and human friendly obfuscated strings**. The gem brings [EncodedId](https://github.com/stevegeek/encoded_id) to Rails and `ActiveRecord` models.
 
-You can use it in routes for example, to go from something like `/users/725` to `/users/bob-smith--usr_p5w9-z27j` with miminal effort.
+You can use it in routes for example, to go from something like `/users/725` to `/users/bob-smith--usr_p5w9-z27j` with minimal effort.
 
 ## Features
 
@@ -17,7 +17,7 @@ Under the hood it uses hashIds, but it offers more features.
   - by default uses a variation of the Crockford reduced character set (https://www.crockford.com/base32.html) 
   - easily confused characters (eg i and j, 0 and O, 1 and I etc) are mapped to counterpart characters, to 
     help avoid common readability mistakes when reading/sharing
-  - build in profanity limitation
+  - built-in profanity limitation
 
 The gem provides:
 
@@ -69,7 +69,6 @@ when sharing encoded IDs with other people.
 * the gem is configurable
 * encoded IDs can be stable across environments, or not (you can set the salt to different values per environment)
 
-
 ## Coming in future (?)
 
 - support for UUIDs for IDs (which will be encoded as an array of integers)
@@ -87,6 +86,12 @@ If bundler is not being used to manage dependencies, install the gem by executin
 Then run the generator to add the initializer:
 
     rails g encoded_id:rails:install
+    
+If you plan to use the `EncodedId::Rails::Persists` module to persist encoded IDs, you can generate the necessary migration:
+
+    rails g encoded_id:rails:add_columns User Product  # Add to multiple models
+    
+This will create a migration that adds the required columns and indexes to the specified models.
 
 ## Usage
 
@@ -102,6 +107,7 @@ You can configure:
 - the separator between the character groups (default is '-')
 - the alphabet used to generate the encoded string (default is a variation of the Crockford reduced character set)
 - the minimum length of the encoded ID string (default is 8 characters)
+- whether models automatically override `to_param` to return the encoded ID (default is false)
 
 ### ActiveRecord model setup
 
@@ -124,8 +130,8 @@ end
 
 You can optionally include one of the following mixins to add default overrides to `#to_param`.
 
-- `EncodedId::PathParam`
-- `EncodedId::SluggedPathParam`
+- `EncodedId::PathParam` - Makes `to_param` return the encoded ID
+- `EncodedId::SluggedPathParam` - Makes `to_param` return the slugged encoded ID
 
 This is so that an instance of the model can be used in path helpers and 
 return the encoded ID string instead of the record ID by default.
@@ -144,6 +150,89 @@ user = User.create(full_name: "Bob Smith")
 Rails.application.routes.url_helpers.user_path(user) # => "/users/bob-smith--p5w9-z27j"
 ```
 
+Alternatively, you can configure the gem to automatically override `to_param` for all models that include `EncodedId::Model` by setting the `model_to_param_returns_encoded_id` configuration option to `true`:
+
+```ruby
+# In config/initializers/encoded_id.rb
+EncodedId::Rails.configure do |config|
+  # ... other configuration options
+  config.model_to_param_returns_encoded_id = true
+end
+
+# Then in your model
+class User < ApplicationRecord
+  include EncodedId::Model  # to_param will automatically return encoded_id
+end
+
+user = User.create(name: "Bob Smith")
+Rails.application.routes.url_helpers.user_path(user) # => "/users/user_p5w9-z27j"
+```
+
+With this configuration, all models will behave as if they included `EncodedId::PathParam`.
+
+### Persisting encoded IDs
+
+You can optionally include the `EncodedId::Rails::Persists` mixin to persist the encoded ID in the database. This allows you to query directly by encoded ID in the database and enables more efficient lookups.
+
+To use this feature, you can either:
+
+1. Use the generator to create a migration for your models:
+
+```bash
+rails g encoded_id:rails:add_columns User Product
+```
+
+2. Or manually add the following columns to your model's table:
+
+```ruby
+add_column :users, :normalized_encoded_id, :string
+add_column :users, :prefixed_encoded_id, :string
+add_index :users, :normalized_encoded_id, unique: true
+add_index :users, :prefixed_encoded_id, unique: true
+```
+
+Then include the mixin in your model:
+
+```ruby
+class User < ApplicationRecord
+  include EncodedId::Model
+  include EncodedId::Rails::Persists
+end
+```
+
+The mixin will:
+
+1. Store the encoded ID hash (without character grouping) in the `normalized_encoded_id` column
+2. Store the complete encoded ID (with prefix if any) in the `prefixed_encoded_id` column
+3. Add validations to ensure these columns are unique
+4. Make these columns readonly after creation
+5. Automatically update the persisted encoded IDs when the record is created
+6. Ensure encoded IDs are reset when a record is duplicated
+7. Provide safeguards to prevent inconsistencies
+
+This enables direct database queries by encoded ID without having to decode them first. It also allows you to create database indexes on these columns for more efficient lookups.
+
+#### Example Usage of Persisted Encoded IDs
+
+Once you've set up the necessary database columns and included the `Persists` module, you can use the persisted encoded IDs:
+
+```ruby
+# Creating a record automatically sets the encoded IDs
+user = User.create(name: "Bob Smith")
+user.normalized_encoded_id  # => "p5w9z27j" (encoded ID without character grouping)
+user.prefixed_encoded_id    # => "user_p5w9-z27j" (complete encoded ID with prefix)
+
+# You can use these in ActiveRecord queries now of course, eg
+User.where(normalized_encoded_id: ["p5w9z27j", "7aq60zqw"])
+
+# If you need to refresh the encoded ID (e.g., you changed the salt)
+user.set_normalized_encoded_id!
+
+# The module protects against direct changes to these attributes
+user.normalized_encoded_id = "something-else"
+user.save  # This will raise ActiveRecord::ReadonlyAttributeError
+```
+
 ## Documentation
 
 ### `.find_by_encoded_id`
@@ -185,7 +274,7 @@ this method will return an array of records.
 A helper for creating relations. Decodes the encoded ID string before passing it to `.where`.
 
 ```ruby
-encoded_id = User.encode_encoded_id([user1.id, user2.id])  # => "p5w9-z27j"
+encoded_id = User.encode_encoded_id([user1.id, user2.id])  # => "7aq6-0zqw"
 User.where(active: true)
   .where_encoded_id(encoded_id)
   .map(&:name) # => ["Bob Smith", "Jane Doe"]
@@ -234,11 +323,11 @@ User.encoded_id_salt  # => "my-user-model-salt"
 
 ### `#encoded_id_hash`
 
-Returns only the encoded 'hashId' part of the encoded ID for the record:
+Returns only the encoded 'hashId' part of the encoded ID for the record (without any annotation):
 
 ```ruby
 user = User.create(name: "Bob Smith")
-user.encoded_id  # => "p5w9-z27j"
+user.encoded_id_hash  # => "p5w9-z27j"
 ```
 
 
@@ -344,8 +433,8 @@ Note that you can also configure the slug separator via the `slugged_id_separato
 but it must be set to a string that only contains character that are not part of the alphabet used to encode the ID.
 
 ```ruby
-EncodedId::Rails.configuration.annotated_id_separator = "***"
-user.encoded_id  # => "bob-smith***p5w9-z27j"
+EncodedId::Rails.configuration.slugged_id_separator = "***"
+user.slugged_encoded_id  # => "bob-smith***p5w9-z27j"
 ```
 
 ## To use on all models
@@ -391,10 +480,33 @@ end
 <%= link_to "User", user_path %>
 ```
 
+## Performance Considerations
+
+The performance of encoding and decoding IDs depends on several factors:
+
+1. **ID Length**: The longer the minimum ID length specified in configuration (`id_length`), the slower the encoding and decoding process will be. This is because the underlying Hashids algorithm has to do more work to generate longer IDs. If performance is critical, consider using shorter ID lengths, but be aware of the security tradeoffs.
+
+2. **Encoding Multiple IDs**: Encoding multiple IDs in a single string is more computationally expensive than encoding a single ID.
+
+3. **Database Queries**: When using `find_by_encoded_id` or `where_encoded_id`, each lookup requires decoding first. Consider using the `Persists` module to store encoded IDs if this is an issue.
+
+4. **Character Grouping**: Using character grouping with separators adds a small overhead to encoding and decoding.
+
+For detailed performance metrics and benchmarks, refer to the [EncodedId gem documentation](https://github.com/stevegeek/encoded_id).
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
+To run tests with code coverage:
+
+```bash
+bundle exec rake coverage
+```
+
+This will generate a coverage report in the `coverage` directory that you can open in your browser.
+
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ### Type check

data/Rakefile

@@ -6,7 +6,13 @@ require "rake/testtask"
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList["test/**/test_*.rb"]
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+desc "Run tests with coverage"
+task :coverage do
+  ENV["COVERAGE"] = "true"
+  Rake::Task["test"].invoke
 end
 
 require "standard/rake"

data/gemfiles/{rails_6.1.gemfile → rails_7.2.gemfile}

@@ -2,15 +2,18 @@
 
 source "https://rubygems.org"
 
-gem "activesupport", "~> 6.1.7", ">= 6.1.0"
-gem "activerecord", "~> 6.1.7", ">= 6.1.0"
+gem "activesupport", "~> 7.2.0"
+gem "activerecord", "~> 7.2.0"
 
 group :development, :test do
   gem "rake", "~> 13.0"
   gem "minitest", "~> 5.0"
   gem "standard", "~> 1.30"
   gem "steep", "~> 1.5"
-  gem "sqlite3", "~> 1.5"
+  gem "rails"
+  gem "sqlite3"
+  gem "appraisal"
+  gem "simplecov"
 end
 
 gemspec path: "../"

data/gemfiles/{rails_7.1.gemfile → rails_8.0.gemfile}

@@ -2,15 +2,18 @@
 
 source "https://rubygems.org"
 
-gem "activesupport", "~> 7.1"
-gem "activerecord", "~> 7.1"
+gem "activesupport", "~> 8.0.0"
+gem "activerecord", "~> 8.0.0"
 
 group :development, :test do
   gem "rake", "~> 13.0"
   gem "minitest", "~> 5.0"
   gem "standard", "~> 1.30"
   gem "steep", "~> 1.5"
-  gem "sqlite3", "~> 1.5"
+  gem "rails"
+  gem "sqlite3"
+  gem "appraisal"
+  gem "simplecov"
 end
 
 gemspec path: "../"

data/lib/encoded_id/rails/configuration.rb

@@ -6,6 +6,7 @@ module EncodedId
     class Configuration
       attr_accessor :salt, :character_group_size, :alphabet, :id_length
       attr_accessor :slug_value_method_name, :annotation_method_name
+      attr_accessor :model_to_param_returns_encoded_id
       attr_reader :group_separator, :slugged_id_separator, :annotated_id_separator
 
       def initialize
@@ -17,6 +18,7 @@ module EncodedId
         @slugged_id_separator = "--"
         @annotation_method_name = :annotation_for_encoded_id
         @annotated_id_separator = "_"
+        @model_to_param_returns_encoded_id = false
       end
 
       # Perform validation vs alphabet on these assignments

data/lib/encoded_id/rails/model.rb

@@ -10,34 +10,69 @@ module EncodedId
         base.extend(EncoderMethods)
         base.extend(FinderMethods)
         base.extend(QueryMethods)
+
+        # Automatically include PathParam if configured to do so
+        if EncodedId::Rails.configuration.model_to_param_returns_encoded_id
+          base.include(EncodedId::Rails::PathParam)
+        end
+      end
+
+      attr_accessor :encoded_id_memoized_with_id
+
+      def clear_encoded_id_cache!
+        [:@encoded_id_hash, :@encoded_id, :@slugged_encoded_id].each do |var|
+          remove_instance_variable(var) if instance_variable_defined?(var)
+        end
+        self.encoded_id_memoized_with_id = nil
+      end
+
+      def check_and_clear_memoization
+        clear_encoded_id_cache! if encoded_id_memoized_with_id && encoded_id_memoized_with_id != id
       end
 
       def encoded_id_hash
         return unless id
-        return @encoded_id_hash if defined?(@encoded_id_hash) && !id_changed?
-        self.class.encode_encoded_id(id)
+        check_and_clear_memoization
+        return @encoded_id_hash if defined?(@encoded_id_hash)
+
+        self.encoded_id_memoized_with_id = id
+        @encoded_id_hash = self.class.encode_encoded_id(id)
       end
 
       def encoded_id
         return unless id
-        return @encoded_id if defined?(@encoded_id) && !id_changed?
+        check_and_clear_memoization
+        return @encoded_id if defined?(@encoded_id)
+
         encoded = encoded_id_hash
         annotated_by = EncodedId::Rails.configuration.annotation_method_name
         return @encoded_id = encoded unless annotated_by && encoded
+
         separator = EncodedId::Rails.configuration.annotated_id_separator
+        self.encoded_id_memoized_with_id = id
         @encoded_id = EncodedId::Rails::AnnotatedId.new(id_part: encoded, annotation: send(annotated_by.to_s), separator: separator).annotated_id
       end
 
       def slugged_encoded_id
         return unless id
-        return @slugged_encoded_id if defined?(@slugged_encoded_id) && !id_changed?
+        check_and_clear_memoization
+        return @slugged_encoded_id if defined?(@slugged_encoded_id)
+
         with = EncodedId::Rails.configuration.slug_value_method_name
         separator = EncodedId::Rails.configuration.slugged_id_separator
         encoded = encoded_id
         return unless encoded
+
+        self.encoded_id_memoized_with_id = id
         @slugged_encoded_id = EncodedId::Rails::SluggedId.new(id_part: encoded, slug_part: send(with.to_s), separator: separator).slugged_id
       end
 
+      def reload(options = nil)
+        result = super
+        clear_encoded_id_cache!
+        result
+      end
+
       # By default the annotation is the model name (it will be parameterized)
       def annotation_for_encoded_id
         name = self.class.name
@@ -52,11 +87,10 @@ module EncodedId
         raise StandardError, "You must define a method to generate the slug for the encoded ID of #{self.class.name}"
       end
 
-      # When duplicating an ActiveRecord object, we want to reset the memoized encoded_id
+      # When duplicating an ActiveRecord object, we want to reset the memoized encoded IDs
       def dup
         super.tap do |new_record|
-          new_record.send(:remove_instance_variable, :@encoded_id) if new_record.instance_variable_defined?(:@encoded_id)
-          new_record.send(:remove_instance_variable, :@slugged_encoded_id) if new_record.instance_variable_defined?(:@slugged_encoded_id)
+          new_record.clear_encoded_id_cache!
         end
       end
     end

data/lib/encoded_id/rails/persists.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module EncodedId
+  module Rails
+    module Persists
+      def self.included(base)
+        base.extend ClassMethods
+
+        base.validates :normalized_encoded_id, uniqueness: true, allow_nil: true
+        base.validates :prefixed_encoded_id, uniqueness: true, allow_nil: true
+
+        base.before_validation :prevent_update_of_normalized_encoded_id!, if: :normalized_encoded_id_changed?
+        base.before_validation :prevent_update_of_prefixed_encoded_id!, if: :prefixed_encoded_id_changed?
+
+        base.after_create :set_normalized_encoded_id!
+        base.before_save :update_normalized_encoded_id!, if: :should_update_normalized_encoded_id?
+
+        base.after_commit :check_encoded_id_persisted!, on: [:create, :update]
+      end
+
+      module ClassMethods
+        def encode_normalized_encoded_id(id)
+          encode_encoded_id(id, character_group_size: nil)
+        end
+      end
+
+      # On duplication we need to reset the encoded ID to nil as this new record will have a new ID.
+      # We need to also prevent these changes from marking the record as dirty.
+      def dup
+        copy = super
+        copy.prefixed_encoded_id = nil
+        copy.clear_prefixed_encoded_id_change
+        copy.normalized_encoded_id = nil
+        copy.clear_normalized_encoded_id_change
+        copy
+      end
+
+      def set_normalized_encoded_id!
+        validate_id_for_encoded_id!
+
+        update_columns(normalized_encoded_id: self.class.encode_normalized_encoded_id(id), prefixed_encoded_id: encoded_id)
+      end
+
+      def update_normalized_encoded_id!
+        validate_id_for_encoded_id!
+
+        self.normalized_encoded_id = self.class.encode_normalized_encoded_id(id)
+        self.prefixed_encoded_id = encoded_id
+      end
+
+      def check_encoded_id_persisted!
+        if normalized_encoded_id != self.class.encode_normalized_encoded_id(id)
+          raise StandardError, "The persisted encoded ID #{normalized_encoded_id} for #{self.class.name} is not the same as currently computing #{self.class.encode_normalized_encoded_id(id)}"
+        end
+
+        raise StandardError, "The persisted prefixed encoded ID (for #{self.class.name} with id: #{id}, normalized_encoded_id: #{normalized_encoded_id}) is not correct: it is #{prefixed_encoded_id} instead of #{encoded_id}" if prefixed_encoded_id != encoded_id
+      end
+
+      def should_update_normalized_encoded_id?
+        id_changed? || (normalized_encoded_id.blank? && persisted?)
+      end
+
+      def validate_id_for_encoded_id!
+        raise StandardError, "You cannot set the normalized ID of a record which is not persisted" if id.blank?
+      end
+
+      def prevent_update_of_normalized_encoded_id!
+        raise ActiveRecord::ReadonlyAttributeError, "You cannot update the normalized encoded ID '#{normalized_encoded_id}' of a record #{self.class.name} #{id}, if you need to refresh it use set_normalized_encoded_id!"
+      end
+
+      def prevent_update_of_prefixed_encoded_id!
+        raise ActiveRecord::ReadonlyAttributeError, "You cannot update the prefixed encoded ID '#{prefixed_encoded_id}' of a record #{self.class.name} #{id}, if you need to refresh it use set_normalized_encoded_id!"
+      end
+    end
+  end
+end

data/lib/encoded_id/rails/version.rb

@@ -2,6 +2,6 @@
 
 module EncodedId
   module Rails
-    VERSION = "1.0.0.beta3"
+    VERSION = "1.0.0.rc1"
   end
 end

data/lib/encoded_id/rails.rb

@@ -14,6 +14,7 @@ require_relative "rails/finder_methods"
 require_relative "rails/path_param"
 require_relative "rails/slugged_path_param"
 require_relative "rails/model"
+require_relative "rails/persists"
 
 module EncodedId
   module Rails

data/lib/generators/encoded_id/rails/USAGE

@@ -1,3 +1,7 @@
 Creates an initialiser:
 
     rails generate encoded_id:rails:install
+
+Creates migrations for persisting encoded IDs:
+
+    rails generate encoded_id:rails:add_columns Model [Model2 Model3 ...]

data/lib/generators/encoded_id/rails/add_columns_generator.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "rails/generators/active_record/migration"
+
+module EncodedId
+  module Rails
+    module Generators
+      # Generator for adding encoded ID columns to models
+      # Usage: rails generate encoded_id:rails:add_columns Model [Model2 Model3 ...]
+      class AddColumnsGenerator < ::Rails::Generators::Base
+        include ::ActiveRecord::Generators::Migration
+
+        source_root File.expand_path(__dir__)
+
+        argument :model_names, type: :array, desc: "Model name or names to add columns to"
+
+        desc "Adds encoded_id persistence columns to the specified models"
+
+        def create_migration_file
+          migration_template(
+            "templates/add_encoded_id_columns_migration.rb.erb",
+            "db/migrate/add_encoded_id_columns_to_#{table_names}.rb",
+            migration_version: migration_version
+          )
+        end
+
+        private
+
+        def table_names
+          @table_names ||= model_names.map do |model_name|
+            model_name.underscore.pluralize
+          end.join("_and_")
+        end
+
+        def migration_version
+          "[#{::ActiveRecord::VERSION::MAJOR}.#{::ActiveRecord::VERSION::MINOR}]"
+        end
+
+        def migration_class_name
+          "AddEncodedIdColumnsTo#{table_names.camelize}"
+        end
+      end
+    end
+  end
+end

data/lib/generators/encoded_id/rails/templates/add_encoded_id_columns_migration.rb.erb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+<% model_names.each do |model_name| %>
+    # Get table name from the model or infer from model name
+    table_name = :<%= model_name.underscore.pluralize %>
+    
+    add_column table_name, :normalized_encoded_id, :string
+    add_column table_name, :prefixed_encoded_id, :string
+    
+    add_index table_name, :normalized_encoded_id, unique: true
+    add_index table_name, :prefixed_encoded_id, unique: true
+<% end %>
+  end
+end

data/lib/generators/encoded_id/rails/templates/encoded_id.rb

@@ -67,4 +67,12 @@ EncodedId::Rails.configure do |config|
   # Default: "_"
   #
   # config.annotated_id_separator = "_"
+
+  # When true, models that include EncodedId::Model will automatically have their to_param method
+  # return the encoded ID (equivalent to also including EncodedId::Rails::PathParam).
+  # This makes any model with EncodedId::Model automatically use encoded IDs in URLs.
+  #
+  # Default: false
+  #
+  # config.model_to_param_returns_encoded_id = true
 end

data/sig/encoded_id/rails.rbs

@@ -8,7 +8,7 @@ module EncodedId
       attr_accessor character_group_size: ::Integer
       attr_accessor alphabet: ::EncodedId::Alphabet
       attr_accessor id_length: ::Integer
-      attr_accessor slug_value_method_name: ::Symbol
+      attr_accessor slug_method_name: ::Symbol
       attr_accessor slugged_id_separator: ::String
       attr_accessor annotation_method_name: ::Symbol
       attr_accessor annotated_id_separator: ::String

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: encoded_id-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta3
+  version: 1.0.0.rc1
 platform: ruby
 authors:
 - Stephen Ierodiaconou
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-29 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,68 +15,54 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: encoded_id
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc4
+        version: 1.0.0.rc5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc4
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0.rc5
 description: ActiveRecord concern to use EncodedID to turn IDs into reversible and
   human friendly obfuscated strings.
 email:
@@ -86,6 +71,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".devcontainer/Dockerfile"
+- ".devcontainer/compose.yml"
+- ".devcontainer/devcontainer.json"
 - ".standard.yml"
 - Appraisals
 - CHANGELOG.md
@@ -95,12 +83,8 @@ files:
 - Rakefile
 - Steepfile
 - gemfiles/.bundle/config
-- gemfiles/rails_6.1.gemfile
-- gemfiles/rails_6.1.gemfile.lock
-- gemfiles/rails_7.0.gemfile
-- gemfiles/rails_7.0.gemfile.lock
-- gemfiles/rails_7.1.gemfile
-- gemfiles/rails_7.1.gemfile.lock
+- gemfiles/rails_7.2.gemfile
+- gemfiles/rails_8.0.gemfile
 - lib/encoded_id/rails.rb
 - lib/encoded_id/rails/annotated_id.rb
 - lib/encoded_id/rails/annotated_id_parser.rb
@@ -110,6 +94,7 @@ files:
 - lib/encoded_id/rails/finder_methods.rb
 - lib/encoded_id/rails/model.rb
 - lib/encoded_id/rails/path_param.rb
+- lib/encoded_id/rails/persists.rb
 - lib/encoded_id/rails/query_methods.rb
 - lib/encoded_id/rails/salt.rb
 - lib/encoded_id/rails/slugged_id.rb
@@ -117,7 +102,9 @@ files:
 - lib/encoded_id/rails/slugged_path_param.rb
 - lib/encoded_id/rails/version.rb
 - lib/generators/encoded_id/rails/USAGE
+- lib/generators/encoded_id/rails/add_columns_generator.rb
 - lib/generators/encoded_id/rails/install_generator.rb
+- lib/generators/encoded_id/rails/templates/add_encoded_id_columns_migration.rb.erb
 - lib/generators/encoded_id/rails/templates/encoded_id.rb
 - rbs_collection.yaml
 - sig/encoded_id/rails.rbs
@@ -128,7 +115,6 @@ metadata:
   homepage_uri: https://github.com/stevegeek/encoded_id-rails
   source_code_uri: https://github.com/stevegeek/encoded_id-rails
   changelog_uri: https://github.com/stevegeek/encoded_id-rails/blob/master/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -136,15 +122,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Use `encoded_id` with ActiveRecord models
 test_files: []

data/gemfiles/rails_6.1.gemfile.lock

@@ -1,130 +0,0 @@
-PATH
-  remote: ..
-  specs:
-    encoded_id-rails (1.0.0.beta2)
-      activerecord (>= 6.0, < 8.0)
-      activesupport (>= 6.0, < 8.0)
-      encoded_id (~> 1.0.0.rc4)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    abbrev (0.1.2)
-    activemodel (6.1.7.7)
-      activesupport (= 6.1.7.7)
-    activerecord (6.1.7.7)
-      activemodel (= 6.1.7.7)
-      activesupport (= 6.1.7.7)
-    activesupport (6.1.7.7)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    appraisal (2.5.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
-    ast (2.4.2)
-    concurrent-ruby (1.2.3)
-    csv (3.3.0)
-    encoded_id (1.0.0.rc4)
-      hashids (~> 1.0)
-    ffi (1.16.3)
-    fileutils (1.7.2)
-    hashids (1.0.6)
-    i18n (1.14.4)
-      concurrent-ruby (~> 1.0)
-    json (2.7.2)
-    language_server-protocol (3.17.0.3)
-    lint_roller (1.1.0)
-    listen (3.9.0)
-      rb-fsevent (~> 0.10, >= 0.10.3)
-      rb-inotify (~> 0.9, >= 0.9.10)
-    logger (1.6.0)
-    minitest (5.22.3)
-    parallel (1.24.0)
-    parser (3.3.1.0)
-      ast (~> 2.4.1)
-      racc
-    racc (1.7.3)
-    rainbow (3.1.1)
-    rake (13.2.1)
-    rb-fsevent (0.11.2)
-    rb-inotify (0.10.1)
-      ffi (~> 1.0)
-    rbs (3.4.4)
-      abbrev
-    regexp_parser (2.9.0)
-    rexml (3.2.6)
-    rubocop (1.62.1)
-      json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
-      parallel (~> 1.10)
-      parser (>= 3.3.0.2)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.3)
-      parser (>= 3.3.1.0)
-    rubocop-performance (1.20.2)
-      rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
-    ruby-progressbar (1.13.0)
-    securerandom (0.3.1)
-    sqlite3 (1.7.3-arm64-darwin)
-    standard (1.35.1)
-      language_server-protocol (~> 3.17.0.2)
-      lint_roller (~> 1.0)
-      rubocop (~> 1.62.0)
-      standard-custom (~> 1.0.0)
-      standard-performance (~> 1.3)
-    standard-custom (1.0.2)
-      lint_roller (~> 1.0)
-      rubocop (~> 1.50)
-    standard-performance (1.3.1)
-      lint_roller (~> 1.1)
-      rubocop-performance (~> 1.20.2)
-    steep (1.6.0)
-      activesupport (>= 5.1)
-      concurrent-ruby (>= 1.1.10)
-      csv (>= 3.0.9)
-      fileutils (>= 1.1.0)
-      json (>= 2.1.0)
-      language_server-protocol (>= 3.15, < 4.0)
-      listen (~> 3.0)
-      logger (>= 1.3.0)
-      parser (>= 3.1)
-      rainbow (>= 2.2.2, < 4.0)
-      rbs (>= 3.1.0)
-      securerandom (>= 0.1)
-      strscan (>= 1.0.0)
-      terminal-table (>= 2, < 4)
-    strscan (3.1.0)
-    terminal-table (3.0.2)
-      unicode-display_width (>= 1.1.1, < 3)
-    thor (1.3.1)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.5.0)
-    zeitwerk (2.6.13)
-
-PLATFORMS
-  arm64-darwin-23
-
-DEPENDENCIES
-  activerecord (~> 6.1.7, >= 6.1.0)
-  activesupport (~> 6.1.7, >= 6.1.0)
-  appraisal
-  encoded_id-rails!
-  minitest (~> 5.0)
-  rake (~> 13.0)
-  sqlite3 (~> 1.5)
-  standard (~> 1.30)
-  steep (~> 1.5)
-
-BUNDLED WITH
-   2.3.26

data/gemfiles/rails_7.0.gemfile

@@ -1,16 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activesupport", "~> 7.0.4"
-gem "activerecord", "~> 7.0.4"
-
-group :development, :test do
-  gem "rake", "~> 13.0"
-  gem "minitest", "~> 5.0"
-  gem "standard", "~> 1.30"
-  gem "steep", "~> 1.5"
-  gem "sqlite3", "~> 1.5"
-end
-
-gemspec path: "../"

data/gemfiles/rails_7.0.gemfile.lock

@@ -1,128 +0,0 @@
-PATH
-  remote: ..
-  specs:
-    encoded_id-rails (1.0.0.beta2)
-      activerecord (>= 6.0, < 8.0)
-      activesupport (>= 6.0, < 8.0)
-      encoded_id (~> 1.0.0.rc4)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    abbrev (0.1.2)
-    activemodel (7.0.8.1)
-      activesupport (= 7.0.8.1)
-    activerecord (7.0.8.1)
-      activemodel (= 7.0.8.1)
-      activesupport (= 7.0.8.1)
-    activesupport (7.0.8.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    appraisal (2.5.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
-    ast (2.4.2)
-    concurrent-ruby (1.2.3)
-    csv (3.3.0)
-    encoded_id (1.0.0.rc4)
-      hashids (~> 1.0)
-    ffi (1.16.3)
-    fileutils (1.7.2)
-    hashids (1.0.6)
-    i18n (1.14.4)
-      concurrent-ruby (~> 1.0)
-    json (2.7.2)
-    language_server-protocol (3.17.0.3)
-    lint_roller (1.1.0)
-    listen (3.9.0)
-      rb-fsevent (~> 0.10, >= 0.10.3)
-      rb-inotify (~> 0.9, >= 0.9.10)
-    logger (1.6.0)
-    minitest (5.22.3)
-    parallel (1.24.0)
-    parser (3.3.1.0)
-      ast (~> 2.4.1)
-      racc
-    racc (1.7.3)
-    rainbow (3.1.1)
-    rake (13.2.1)
-    rb-fsevent (0.11.2)
-    rb-inotify (0.10.1)
-      ffi (~> 1.0)
-    rbs (3.4.4)
-      abbrev
-    regexp_parser (2.9.0)
-    rexml (3.2.6)
-    rubocop (1.62.1)
-      json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
-      parallel (~> 1.10)
-      parser (>= 3.3.0.2)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.3)
-      parser (>= 3.3.1.0)
-    rubocop-performance (1.20.2)
-      rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
-    ruby-progressbar (1.13.0)
-    securerandom (0.3.1)
-    sqlite3 (1.7.3-arm64-darwin)
-    standard (1.35.1)
-      language_server-protocol (~> 3.17.0.2)
-      lint_roller (~> 1.0)
-      rubocop (~> 1.62.0)
-      standard-custom (~> 1.0.0)
-      standard-performance (~> 1.3)
-    standard-custom (1.0.2)
-      lint_roller (~> 1.0)
-      rubocop (~> 1.50)
-    standard-performance (1.3.1)
-      lint_roller (~> 1.1)
-      rubocop-performance (~> 1.20.2)
-    steep (1.6.0)
-      activesupport (>= 5.1)
-      concurrent-ruby (>= 1.1.10)
-      csv (>= 3.0.9)
-      fileutils (>= 1.1.0)
-      json (>= 2.1.0)
-      language_server-protocol (>= 3.15, < 4.0)
-      listen (~> 3.0)
-      logger (>= 1.3.0)
-      parser (>= 3.1)
-      rainbow (>= 2.2.2, < 4.0)
-      rbs (>= 3.1.0)
-      securerandom (>= 0.1)
-      strscan (>= 1.0.0)
-      terminal-table (>= 2, < 4)
-    strscan (3.1.0)
-    terminal-table (3.0.2)
-      unicode-display_width (>= 1.1.1, < 3)
-    thor (1.3.1)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.5.0)
-
-PLATFORMS
-  arm64-darwin-23
-
-DEPENDENCIES
-  activerecord (~> 7.0.4)
-  activesupport (~> 7.0.4)
-  appraisal
-  encoded_id-rails!
-  minitest (~> 5.0)
-  rake (~> 13.0)
-  sqlite3 (~> 1.5)
-  standard (~> 1.30)
-  steep (~> 1.5)
-
-BUNDLED WITH
-   2.3.26

data/gemfiles/rails_7.1.gemfile.lock

@@ -1,140 +0,0 @@
-PATH
-  remote: ..
-  specs:
-    encoded_id-rails (1.0.0.beta2)
-      activerecord (>= 6.0, < 8.0)
-      activesupport (>= 6.0, < 8.0)
-      encoded_id (~> 1.0.0.rc4)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    abbrev (0.1.2)
-    activemodel (7.1.3.2)
-      activesupport (= 7.1.3.2)
-    activerecord (7.1.3.2)
-      activemodel (= 7.1.3.2)
-      activesupport (= 7.1.3.2)
-      timeout (>= 0.4.0)
-    activesupport (7.1.3.2)
-      base64
-      bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      connection_pool (>= 2.2.5)
-      drb
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
-    appraisal (2.5.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
-    ast (2.4.2)
-    base64 (0.2.0)
-    bigdecimal (3.1.7)
-    concurrent-ruby (1.2.3)
-    connection_pool (2.4.1)
-    csv (3.3.0)
-    drb (2.2.1)
-    encoded_id (1.0.0.rc4)
-      hashids (~> 1.0)
-    ffi (1.16.3)
-    fileutils (1.7.2)
-    hashids (1.0.6)
-    i18n (1.14.4)
-      concurrent-ruby (~> 1.0)
-    json (2.7.2)
-    language_server-protocol (3.17.0.3)
-    lint_roller (1.1.0)
-    listen (3.9.0)
-      rb-fsevent (~> 0.10, >= 0.10.3)
-      rb-inotify (~> 0.9, >= 0.9.10)
-    logger (1.6.0)
-    minitest (5.22.3)
-    mutex_m (0.2.0)
-    parallel (1.24.0)
-    parser (3.3.1.0)
-      ast (~> 2.4.1)
-      racc
-    racc (1.7.3)
-    rainbow (3.1.1)
-    rake (13.2.1)
-    rb-fsevent (0.11.2)
-    rb-inotify (0.10.1)
-      ffi (~> 1.0)
-    rbs (3.4.4)
-      abbrev
-    regexp_parser (2.9.0)
-    rexml (3.2.6)
-    rubocop (1.62.1)
-      json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
-      parallel (~> 1.10)
-      parser (>= 3.3.0.2)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.3)
-      parser (>= 3.3.1.0)
-    rubocop-performance (1.20.2)
-      rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
-    ruby-progressbar (1.13.0)
-    securerandom (0.3.1)
-    sqlite3 (1.7.3-arm64-darwin)
-    standard (1.35.1)
-      language_server-protocol (~> 3.17.0.2)
-      lint_roller (~> 1.0)
-      rubocop (~> 1.62.0)
-      standard-custom (~> 1.0.0)
-      standard-performance (~> 1.3)
-    standard-custom (1.0.2)
-      lint_roller (~> 1.0)
-      rubocop (~> 1.50)
-    standard-performance (1.3.1)
-      lint_roller (~> 1.1)
-      rubocop-performance (~> 1.20.2)
-    steep (1.6.0)
-      activesupport (>= 5.1)
-      concurrent-ruby (>= 1.1.10)
-      csv (>= 3.0.9)
-      fileutils (>= 1.1.0)
-      json (>= 2.1.0)
-      language_server-protocol (>= 3.15, < 4.0)
-      listen (~> 3.0)
-      logger (>= 1.3.0)
-      parser (>= 3.1)
-      rainbow (>= 2.2.2, < 4.0)
-      rbs (>= 3.1.0)
-      securerandom (>= 0.1)
-      strscan (>= 1.0.0)
-      terminal-table (>= 2, < 4)
-    strscan (3.1.0)
-    terminal-table (3.0.2)
-      unicode-display_width (>= 1.1.1, < 3)
-    thor (1.3.1)
-    timeout (0.4.1)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.5.0)
-
-PLATFORMS
-  arm64-darwin-23
-
-DEPENDENCIES
-  activerecord (~> 7.1)
-  activesupport (~> 7.1)
-  appraisal
-  encoded_id-rails!
-  minitest (~> 5.0)
-  rake (~> 13.0)
-  sqlite3 (~> 1.5)
-  standard (~> 1.30)
-  steep (~> 1.5)
-
-BUNDLED WITH
-   2.3.26