encoded_id-rails 1.0.0.rc7 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ef8577374a192378855b9f20acd2885770b3e49d379e3051a187db83f7de497
-  data.tar.gz: 9f574a5e8336f3588bf55c1cb9f69f8b47bcfd46a689bc007abd6f7e0143b8e6
+  metadata.gz: 4da003d36ccb45772078a30f7a28b6c65f1810ba057e538bc6e79c0156b4d5e5
+  data.tar.gz: f2944b9ef646adaebdba1379ae60ff84f2ac1250c8e09ce63964d78c04c723f6
 SHA512:
-  metadata.gz: 33157300365c009da10a1a035d88aeeff2e021cace89194ab779a0ec598dd8acb6614444143f01efc3982ff68f320ce1cc2511909ca57ff1a18c712569510256
-  data.tar.gz: '08879af617396021978d6b5a46833841a8362eca06a74d151cc36934200188526c5bacac5c57cd5abf84ee8e8816e31d7ae50277a5dae756608dca1c0c5f141c'
+  metadata.gz: f87ba716543874cad1edcf0c1fbd6259b0b4fde72134a200df9320533a37d36e3e776c9e78b76b4a694481d0987def973423ff48035301f5b3ebae1f61d50065
+  data.tar.gz: affff6f578bea25443d4aafd4b2ac64291f58ad25188c85251ff498fffa89ba250874dbd7fa03fb3afe8efe05df4a46bfaf3c379d9e45f69193a52d559f282e1

data/CHANGELOG.md

@@ -2,12 +2,23 @@
 
 - nothing yet
 
-## [1.0.0] - unreleased
+## [1.1.0] - 2026-01-23
+
+### Added (Rails integration)
+
+- Configuration in EncodedId Rails now supports all options from the core library
+
+## [1.0.0] - 2025-11-21
 
 - First stable release!
 
 **Important!!: `:sqids` are not compatible with `:hashids`, DO NOT CHANGE FROM ONE TO THE OTHER AFTER GOING LIVE.**
 
+### Fixed (Rails integration)
+
+- Ensure finder methods correctly override their ActiveRecord counterparts 
+- Warn when ActiveRecord integration used in model that doesn't use `id` as primary key
+
 ## [1.0.0.rc7] - 2025-11-19
 
 ### Breaking changes

data/README.md

@@ -111,7 +111,7 @@ Read more about the security implications: [Hashids expose salt value](https://w
 - [with_uid](https://github.com/SPBTV/with_uid)
 - [bullet_train-obfuscates_id](https://github.com/bullet-train-co/bullet_train-core/blob/main/bullet_train-obfuscates_id/app/models/concerns/obfuscates_id.rb)
 
-For a detailed comparison, see the [Compared to Other Gems](https://encoded-id.onrender.com/docs/compared-to) documentation page.
+For a detailed comparison, see the [Compared to Other Gems](https://encoded-id.onrender.com/docs/similar-gems/) documentation page.
 
 ## Documentation
 

data/lib/encoded_id/rails/active_record_finders.rb

@@ -18,10 +18,21 @@ module EncodedId
         if columns_hash["id"]&.type == :string
           ::Rails.logger.warn("EncodedId::Rails::ActiveRecordFinders has been included in #{name}, but this model uses string-based IDs. This may cause conflicts with encoded ID handling.")
         end
+
+        unless columns_hash.key?("id")
+          ::Rails.logger.warn("EncodedId::Rails::ActiveRecordFinders has been included in #{name}, but this model has no 'id' column. The finders will not work as expected.")
+        end
+
+        if primary_key && primary_key != "id" && columns_hash.key?("id")
+          ::Rails.logger.warn("EncodedId::Rails::ActiveRecordFinders has been included in #{name}, but the primary key is '#{primary_key}', not 'id'. This may cause unexpected behavior with find methods.")
+        end
+
+        # Use prepend so our methods take precedence over ActiveRecord's dynamic finders
+        singleton_class.prepend(ClassMethodsPrepend)
       end
 
       # Class methods for overriding ActiveRecord's finder methods to decode encoded IDs.
-      module ClassMethods
+      module ClassMethodsPrepend
         # @rbs (*untyped args) -> untyped
         def find(*args)
           first_arg = args.first

data/lib/encoded_id/rails/coder.rb

@@ -8,6 +8,9 @@ module EncodedId
     class Coder
       # @rbs @salt: String?
       # @rbs @id_length: Integer
+      # @rbs @max_length: Integer?
+      # @rbs @max_inputs_per_id: Integer
+      # @rbs @hex_digit_encoding_group_size: Integer
       # @rbs @character_group_size: Integer
       # @rbs @separator: String
       # @rbs @alphabet: ::EncodedId::Alphabet
@@ -17,14 +20,17 @@ module EncodedId
       # @rbs @blocklist_max_length: Integer
       # @rbs @downcase_on_decode: bool
 
-      # @rbs (salt: String?, id_length: Integer, character_group_size: Integer, separator: String, alphabet: ::EncodedId::Alphabet, ?encoder: Symbol?, ?blocklist: ::EncodedId::Blocklist?, ?blocklist_mode: Symbol?, ?blocklist_max_length: Integer?, ?downcase_on_decode: bool?) -> void
-      def initialize(salt:, id_length:, character_group_size:, separator:, alphabet:, encoder: nil, blocklist: nil, blocklist_mode: nil, blocklist_max_length: nil, downcase_on_decode: nil)
+      # @rbs (salt: String?, id_length: Integer, character_group_size: Integer, separator: String, alphabet: ::EncodedId::Alphabet, ?max_length: Integer?, ?max_inputs_per_id: Integer?, ?hex_digit_encoding_group_size: Integer?, ?encoder: Symbol?, ?blocklist: ::EncodedId::Blocklist?, ?blocklist_mode: Symbol?, ?blocklist_max_length: Integer?, ?downcase_on_decode: bool?) -> void
+      def initialize(salt:, id_length:, character_group_size:, separator:, alphabet:, max_length: nil, max_inputs_per_id: nil, hex_digit_encoding_group_size: nil, encoder: nil, blocklist: nil, blocklist_mode: nil, blocklist_max_length: nil, downcase_on_decode: nil)
         @salt = salt
         @id_length = id_length
         @character_group_size = character_group_size
         @separator = separator
         @alphabet = alphabet
         config = EncodedId::Rails.configuration
+        @max_length = max_length.nil? ? config.max_length : max_length
+        @max_inputs_per_id = max_inputs_per_id || config.max_inputs_per_id
+        @hex_digit_encoding_group_size = hex_digit_encoding_group_size || config.hex_digit_encoding_group_size
         @encoder = encoder || config.encoder
         @blocklist = blocklist || config.blocklist
         @blocklist_mode = blocklist_mode || config.blocklist_mode
@@ -54,6 +60,9 @@ module EncodedId
           ::EncodedId::Encoders::HashidConfiguration.new(
             salt: @salt || raise(ArgumentError, "Salt is required for hashids encoder"),
             min_length: @id_length,
+            max_length: @max_length,
+            max_inputs_per_id: @max_inputs_per_id,
+            hex_digit_encoding_group_size: @hex_digit_encoding_group_size,
             split_at: @character_group_size,
             split_with: @separator,
             alphabet: @alphabet,
@@ -64,6 +73,9 @@ module EncodedId
         when :sqids
           ::EncodedId::Encoders::SqidsConfiguration.new(
             min_length: @id_length,
+            max_length: @max_length,
+            max_inputs_per_id: @max_inputs_per_id,
+            hex_digit_encoding_group_size: @hex_digit_encoding_group_size,
             split_at: @character_group_size,
             split_with: @separator,
             alphabet: @alphabet,

data/lib/encoded_id/rails/configuration.rb

@@ -13,6 +13,9 @@ module EncodedId
       # @rbs @character_group_size: Integer
       # @rbs @alphabet: ::EncodedId::Alphabet
       # @rbs @id_length: Integer
+      # @rbs @max_length: Integer?
+      # @rbs @max_inputs_per_id: Integer
+      # @rbs @hex_digit_encoding_group_size: Integer
       # @rbs @slug_value_method_name: Symbol
       # @rbs @annotation_method_name: Symbol
       # @rbs @model_to_param_returns_encoded_id: bool
@@ -29,6 +32,9 @@ module EncodedId
       attr_accessor :character_group_size #: Integer
       attr_accessor :alphabet #: ::EncodedId::Alphabet
       attr_accessor :id_length #: Integer
+      attr_accessor :max_length #: Integer?
+      attr_accessor :max_inputs_per_id #: Integer
+      attr_accessor :hex_digit_encoding_group_size #: Integer
       attr_accessor :slug_value_method_name #: Symbol
       attr_accessor :annotation_method_name #: Symbol
       attr_accessor :model_to_param_returns_encoded_id #: bool
@@ -47,6 +53,9 @@ module EncodedId
         @group_separator = "-"
         @alphabet = ::EncodedId::Alphabet.modified_crockford
         @id_length = 8
+        @max_length = 128
+        @max_inputs_per_id = 32
+        @hex_digit_encoding_group_size = 4
         @slug_value_method_name = :name_for_encoded_id_slug
         @slugged_id_separator = "--"
         @annotation_method_name = :annotation_for_encoded_id

data/lib/encoded_id/rails/encoder_methods.rb

@@ -46,6 +46,9 @@ module EncodedId
         EncodedId::Rails::Coder.new(
           salt: merged_options[:salt] || encoded_id_salt,
           id_length: merged_options[:id_length] || config.id_length,
+          max_length: merged_options.key?(:max_length) ? merged_options[:max_length] : config.max_length,
+          max_inputs_per_id: merged_options[:max_inputs_per_id] || config.max_inputs_per_id,
+          hex_digit_encoding_group_size: merged_options[:hex_digit_encoding_group_size] || config.hex_digit_encoding_group_size,
           character_group_size: merged_options.key?(:character_group_size) ? merged_options[:character_group_size] : config.character_group_size,
           alphabet: merged_options[:alphabet] || config.alphabet,
           separator: merged_options.key?(:separator) ? merged_options[:separator] : config.group_separator,

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: encoded_id-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc7
+  version: 1.1.0
 platform: ruby
 authors:
 - Stephen Ierodiaconou
 bindir: exe
 cert_chain: []
-date: 2025-11-20 00:00:00.000000000 Z
+date: 1980-01-02 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.rc7
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc7
+        version: 1.1.0
 description: ActiveRecord concern to use EncodedID to turn IDs into reversible and
   human friendly obfuscated strings.
 email:
@@ -121,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Use `encoded_id` with ActiveRecord models
 test_files: []