encoded_id-rails 1.0.0.beta3 → 1.0.0.rc6

data/lib/encoded_id/rails/slugged_id.rb

@@ -1,16 +1,24 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 require "cgi"
 
 module EncodedId
   module Rails
     class SluggedId
+      # @rbs @slug_part: String
+      # @rbs @id_part: String
+      # @rbs @separator: String
+
+      # @rbs (slug_part: String, id_part: String, ?separator: String) -> void
       def initialize(slug_part:, id_part:, separator: "--")
         @slug_part = slug_part
         @id_part = id_part
         @separator = separator
       end
 
+      # @rbs return: String
       def slugged_id
         unless @id_part.present? && @slug_part.present?
           raise ::StandardError, "The model does not return a valid ID and/or slug"

data/lib/encoded_id/rails/slugged_id_parser.rb

@@ -1,8 +1,14 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 module EncodedId
   module Rails
     class SluggedIdParser
+      # @rbs @slug: String?
+      # @rbs @id: String
+
+      # @rbs (String slugged_id, ?separator: String) -> void
       def initialize(slugged_id, separator: "--")
         if separator && slugged_id.include?(separator)
           parts = slugged_id.split(separator)
@@ -13,7 +19,8 @@ module EncodedId
         end
       end
 
-      attr_reader :slug, :id
+      attr_reader :slug #: String?
+      attr_reader :id #: String
     end
   end
 end

data/lib/encoded_id/rails/slugged_path_param.rb

@@ -1,11 +1,18 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 require "active_record"
 require "encoded_id"
 
 module EncodedId
   module Rails
     module SluggedPathParam
+      # Method provided by model
+      # @rbs!
+      #   def slugged_encoded_id: () -> String?
+
+      # @rbs () -> String
       def to_param
         slugged_encoded_id || raise(StandardError, "Cannot create path param for #{self.class.name} without an encoded id")
       end

data/lib/encoded_id/rails.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require_relative "rails/version"
+# rbs_inline: enabled
+
 require_relative "rails/configuration"
 require_relative "rails/coder"
 require_relative "rails/slugged_id"
@@ -14,24 +15,27 @@ require_relative "rails/finder_methods"
 require_relative "rails/path_param"
 require_relative "rails/slugged_path_param"
 require_relative "rails/model"
+require_relative "rails/persists"
+require_relative "rails/active_record_finders"
+require_relative "rails/railtie"
 
 module EncodedId
   module Rails
     # Configuration
+    # @rbs self.@configuration: EncodedId::Rails::Configuration?
+
     class << self
+      # @rbs return: EncodedId::Rails::Configuration
       def configuration
         @configuration ||= Configuration.new
       end
 
+      # @rbs () -> EncodedId::Rails::Configuration
+      #    | () { (EncodedId::Rails::Configuration) -> void } -> EncodedId::Rails::Configuration
       def configure
         yield(configuration) if block_given?
         configuration
       end
     end
   end
-
-  # Expose directly on EncodedId
-  Model = Rails::Model
-  PathParam = Rails::PathParam
-  SluggedPathParam = Rails::SluggedPathParam
 end

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,32 @@ EncodedId::Rails.configure do |config|
   # Default: "_"
   #
   # config.annotated_id_separator = "_"
+
+  # When true, models that include EncodedId::Rails::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::Rails::Model automatically use encoded IDs in URLs.
+  #
+  # Default: false
+  #
+  # config.model_to_param_returns_encoded_id = true
+
+  # The encoder to use for generating encoded IDs. Valid options are :hashids and :sqids.
+  # To use :sqids, you must add 'gem "sqids"' to your Gemfile.
+  #
+  # Default: :hashids
+  #
+  # config.encoder = :hashids
+
+  # A list of words that should not appear in generated encoded IDs.
+  # For the HashIds encoder, IDs containing blocklisted words will raise an error when generated.
+  # For the Sqids encoder, the algorithm will automatically avoid generating IDs containing these words.
+  # Should be an instance of EncodedId::Blocklist, or an Array or Set of strings.
+  #
+  # Default: EncodedId::Blocklist.empty
+  # Available built-in blocklists:
+  # - EncodedId::Blocklist.empty - no blocked words
+  # - EncodedId::Blocklist.minimal - common English profanity
+  # - EncodedId::Blocklist.sqids_blocklist - the default blocklist from the Sqids gem
+  #
+  # config.blocklist = EncodedId::Blocklist.minimal
 end

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.rc6
 platform: ruby
 authors:
 - Stephen Ierodiaconou
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-29 00:00:00.000000000 Z
+date: 2025-11-17 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.rc6
   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.rc6
 description: ActiveRecord concern to use EncodedID to turn IDs into reversible and
   human friendly obfuscated strings.
 email:
@@ -86,22 +71,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".standard.yml"
-- Appraisals
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- 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
+- context/encoded_id-rails.md
+- context/encoded_id.md
 - lib/encoded_id/rails.rb
+- lib/encoded_id/rails/active_record_finders.rb
 - lib/encoded_id/rails/annotated_id.rb
 - lib/encoded_id/rails/annotated_id_parser.rb
 - lib/encoded_id/rails/coder.rb
@@ -110,25 +86,25 @@ 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/railtie.rb
 - lib/encoded_id/rails/salt.rb
 - lib/encoded_id/rails/slugged_id.rb
 - lib/encoded_id/rails/slugged_id_parser.rb
 - 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
-homepage: https://github.com/stevegeek/encoded_id-rails
+homepage: https://github.com/stevegeek/encoded_id
 licenses:
 - MIT
 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:
+  homepage_uri: https://github.com/stevegeek/encoded_id
+  source_code_uri: https://github.com/stevegeek/encoded_id
+  changelog_uri: https://github.com/stevegeek/encoded_id/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -136,15 +112,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.2
 specification_version: 4
 summary: Use `encoded_id` with ActiveRecord models
 test_files: []

data/.standard.yml

@@ -1,3 +0,0 @@
-# For available configuration options, see:
-#   https://github.com/testdouble/standard
-ruby_version: 2.6

data/Appraisals

@@ -1,14 +0,0 @@
-appraise "rails-6.1" do
-  gem "activesupport", "~> 6.1.7", ">= 6.1.0"
-  gem "activerecord", "~> 6.1.7", ">= 6.1.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"
-end

data/Gemfile

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in encoded_id-rails.gemspec
-gemspec
-
-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

data/Rakefile

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/test_*.rb"]
-end
-
-require "standard/rake"
-
-task default: %i[test standard]

data/Steepfile

@@ -1,4 +0,0 @@
-target :lib do
-  check "lib/encoded_id"
-  signature "sig"
-end

data/gemfiles/.bundle/config

@@ -1,2 +0,0 @@
----
-BUNDLE_RETRY: "1"

data/gemfiles/rails_6.1.gemfile

@@ -1,16 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activesupport", "~> 6.1.7", ">= 6.1.0"
-gem "activerecord", "~> 6.1.7", ">= 6.1.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"
-end
-
-gemspec path: "../"

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: "../"