encoded_id-rails 1.0.0.rc1 → 1.0.0.rc6

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"
@@ -15,24 +16,26 @@ 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/templates/encoded_id.rb

@@ -68,11 +68,31 @@ EncodedId::Rails.configure do |config|
   #
   # config.annotated_id_separator = "_"
 
-  # When true, models that include EncodedId::Model will automatically have their to_param method
+  # 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::Model automatically use encoded IDs in URLs.
+  # 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,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: encoded_id-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.0.0.rc6
 platform: ruby
 authors:
 - Stephen Ierodiaconou
 bindir: exe
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2025-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -55,14 +55,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc5
+        version: 1.0.0.rc6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc5
+        version: 1.0.0.rc6
 description: ActiveRecord concern to use EncodedID to turn IDs into reversible and
   human friendly obfuscated strings.
 email:
@@ -71,21 +71,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".devcontainer/Dockerfile"
-- ".devcontainer/compose.yml"
-- ".devcontainer/devcontainer.json"
-- ".standard.yml"
-- Appraisals
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- Steepfile
-- gemfiles/.bundle/config
-- gemfiles/rails_7.2.gemfile
-- gemfiles/rails_8.0.gemfile
+- 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
@@ -96,25 +88,23 @@ files:
 - 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
+  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
@@ -129,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Use `encoded_id` with ActiveRecord models
 test_files: []

data/.devcontainer/Dockerfile

@@ -1,17 +0,0 @@
-# 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

@@ -1,10 +0,0 @@
-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

@@ -1,12 +0,0 @@
-{
-  "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/.standard.yml

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

data/Appraisals

@@ -1,9 +0,0 @@
-appraise "rails-7.2" do
-  gem "activesupport", "~> 7.2.0"
-  gem "activerecord", "~> 7.2.0"
-end
-
-appraise "rails-8.0" do
-  gem "activesupport", "~> 8.0.0"
-  gem "activerecord", "~> 8.0.0"
-end

data/Gemfile

@@ -1,24 +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 "rails"
-
-  gem "sqlite3"
-
-  gem "appraisal"
-
-  gem "simplecov"
-end

data/Rakefile

@@ -1,20 +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
-
-desc "Run tests with coverage"
-task :coverage do
-  ENV["COVERAGE"] = "true"
-  Rake::Task["test"].invoke
-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_7.2.gemfile

@@ -1,19 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-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 "rails"
-  gem "sqlite3"
-  gem "appraisal"
-  gem "simplecov"
-end
-
-gemspec path: "../"

data/gemfiles/rails_8.0.gemfile

@@ -1,19 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-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 "rails"
-  gem "sqlite3"
-  gem "appraisal"
-  gem "simplecov"
-end
-
-gemspec path: "../"

data/lib/encoded_id/rails/version.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module EncodedId
-  module Rails
-    VERSION = "1.0.0.rc1"
-  end
-end

data/rbs_collection.yaml

@@ -1,24 +0,0 @@
-# Download sources
-sources:
-  - name: ruby/gem_rbs_collection
-    remote: https://github.com/ruby/gem_rbs_collection.git
-    revision: main
-    repo_dir: gems
-
-# A directory to install the downloaded RBSs
-path: .gem_rbs_collection
-
-gems:
-  - name: cgi
-  # Skip loading rbs gem's RBS.
-  # It's unnecessary if you don't use rbs as a library.
-  - name: rbs
-    ignore: true
-  - name: rake
-    ignore: true
-  - name: minitest
-    ignore: true
-  - name: standard
-    ignore: true
-  - name: steep
-    ignore: true

data/sig/encoded_id/rails.rbs

@@ -1,141 +0,0 @@
-module EncodedId
-  module Rails
-    VERSION: ::String
-
-    class Configuration
-      attr_accessor salt: ::String
-      attr_accessor group_separator: ::String
-      attr_accessor character_group_size: ::Integer
-      attr_accessor alphabet: ::EncodedId::Alphabet
-      attr_accessor id_length: ::Integer
-      attr_accessor slug_method_name: ::Symbol
-      attr_accessor slugged_id_separator: ::String
-      attr_accessor annotation_method_name: ::Symbol
-      attr_accessor annotated_id_separator: ::String
-
-      def initialize: () -> void
-    end
-
-    attr_reader self.configuration: Configuration
-
-    def self.configure: () { (Configuration config) -> void } -> void
-
-    class Coder
-      def initialize: (salt: ::String, id_length: ::Integer, character_group_size: ::Integer, separator: ::String, alphabet: ::EncodedId::Alphabet) -> void
-      def encode: (::Integer | ::Array[::Integer]) -> String
-      def decode: (::String) -> ::Array[::Integer]?
-
-      @salt: ::String
-      @id_length: ::Integer
-      @character_group_size: ::Integer
-      @separator: ::String
-      @alphabet: ::EncodedId::Alphabet
-
-      private
-
-      def coder: -> ::EncodedId::ReversibleId
-    end
-
-    class Salt
-      def initialize: (Class klass, ::String salt) -> void
-
-      @klass: Class
-      @salt: ::String
-
-      def generate!: -> ::String
-    end
-
-    class SluggedId
-      def initialize: (slug_part: ::String, id_part: ::String, ?separator: ::String)-> void
-      @slug_part: ::String
-      @id_part: ::String
-      @separator: ::String
-
-      def slugged_id: -> ::String
-    end
-
-    class AnnotatedId
-      def initialize: (annotation: ::String, id_part: ::String, ?separator: ::String)-> void
-      @annotation: ::String
-      @id_part: ::String
-      @separator: ::String
-
-      def annotated_id: -> ::String
-    end
-
-    class SluggedIdParser
-      def initialize: (::String slugged_id, ?separator: ::String) -> void
-
-      attr_reader slug: ::String?
-      attr_reader id: ::String
-    end
-
-    class AnnotatedIdParser
-      def initialize: (::String annotated_id, ?separator: ::String) -> void
-
-      attr_reader annotation: ::String?
-      attr_reader id: ::String
-    end
-
-    module EncoderMethods
-      def encode_encoded_id: (::Array[::Integer] | ::Integer id, ?::Hash[::Symbol, untyped] options) -> ::String
-      def decode_encoded_id: (::String slugged_encoded_id, ?::Hash[::Symbol, untyped] options) -> ::Array[::Integer]?
-      def encoded_id_salt: () -> ::String
-      def encoded_id_coder: (?::Hash[::Symbol, untyped] options) -> ::EncodedId::Rails::Coder
-    end
-
-    interface _ActiveRecordFinderMethod
-      def find_by: (*untyped) -> (nil | untyped)
-    end
-
-    module FinderMethods : EncoderMethods, _ActiveRecordFinderMethod, _ActiveRecordQueryMethod
-      def find_by_encoded_id: (::String encoded_id, ?with_id: ::Symbol?) -> untyped?
-      def find_by_encoded_id!: (::String encoded_id, ?with_id: ::Symbol?) -> untyped
-      def find_all_by_encoded_id: (::String encoded_id) -> untyped?
-      def find_all_by_encoded_id!: (::String encoded_id) -> untyped
-    end
-
-    interface _ActiveRecordQueryMethod
-      def where: (*untyped) -> untyped
-    end
-
-    module QueryMethods : EncoderMethods, _ActiveRecordQueryMethod
-      def where_encoded_id: (::String slugged_encoded_id) -> untyped
-    end
-
-    module Model : ActiveRecord::Base
-      # From ActiveRecord
-      extend ActiveRecord::FinderMethods
-      extend ActiveRecord::QueryMethods
-      def id_changed?: -> bool
-
-      # From EncodedId::Rails::Model
-      extend EncoderMethods
-      extend FinderMethods
-      extend QueryMethods
-
-      @encoded_id: ::String
-      @slugged_encoded_id: ::String
-
-      def encoded_id_hash: -> ::String?
-      def encoded_id: -> ::String?
-      def slugged_encoded_id: -> ::String?
-      def name_for_encoded_id_slug: -> ::String
-      def annotation_for_encoded_id: -> ::String
-    end
-
-    interface _ActiveRecordToParam
-      def to_param: -> ::String
-    end
-
-    module PathParam : Model, _ActiveRecordToParam
-    end
-
-    module SluggedPathParam : Model, _ActiveRecordToParam
-    end
-  end
-
-  Model: singleton(Rails::Model)
-  PathParam: singleton(Rails::PathParam)
-  SluggedPathParam: singleton(Rails::SluggedPathParam)
-end