encoded_id-rails 1.0.0.rc6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45d2f2c1637f43c14a714d4051ec7a1692a8267234ea90c302da97872b2da7b0
-  data.tar.gz: 26030ffcef1dc8798d0919a68faf4ec5bb6d17c3a28730eee0d2bb1e9ecb8e3e
+  metadata.gz: 7e99068282cd5784294cc5d14e2c9b9d0a80604c1a2f585438e547fb0dd83bd4
+  data.tar.gz: e089cc0f30a7e18bc4034fa80ec11c9a48e69b89133fc6e283a912ca143c3bc8
 SHA512:
-  metadata.gz: 05ca59de2b281917cb214cfaeb9a94c7453aba4a64d8e89ac484a583030839a192d5242a774bc511e78d6667c47d11bca27bb3a0b096aefa6c2aad3e3c39ad84
-  data.tar.gz: e3cc3563234d3c13d10f34c55cc77b14f3a7c55e3b391d679d5c2239f39b272cd3e4a02c614f0638a20db815d1c425fd58c334a3b842d0cdb8c88a2c26e6e655
+  metadata.gz: 0156bd7504114ab4857e34851ec615511c5100f8d86a580078573e3d761e5475405a5399dbc089a26f34dcb234e92bd2685db693db509187f148658f6b56920d
+  data.tar.gz: 72d5b551086ac2e979cbde77bac313586d5c5e02f3f0f7c2e041eacfe5b44210ad6327f78da65a917b4ad97be28606548aadffd217528b6a067257e19a41534d

data/CHANGELOG.md

@@ -1,14 +1,39 @@
 ## [Unreleased]
 
-## [2.0.0.alpha1] - unreleased
+- nothing yet
+
+## [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
 
-- `ReversibleId` now no longer downcases the encodedid input string by default on decode, ie the `decode` option `downcase` is now `false`. In a future release the `downcase` option will be removed.
-- The default encoding engine is now `:sqids` to reflect the official "deprecated" status of `Hashid`s (see https://sqids.org/faq#why-hashids) 
+- `ReversibleId` now no longer downcases the encodedid input string by default on decode, ie the `decode` option `downcase` is now `false`. This can be configured via the Rails configuration `downcase_on_decode` option.  In a future release the `downcase` option will be removed.
+- The default encoding engine is now `:sqids` to reflect the official "deprecated" status of `Hashid`s (see https://sqids.org/faq#why-hashids)
 - Ruby < 3.2 support dropped. The minimum supported Ruby version is now 3.2.0
+- `Encoders` classes no longer expose `encode_hex` and `decode_hex` as they worked differently to the similarly named methods on ReversibleId
+- Rails generator now needs you to specify which encoding algorithm you are using
 
-**Important!!: `:sqids` are not compatible with `:hashids`, DO NOT CHANGE FROM ONE TO THE OTHER AFTER GOING LIVE.**
+### Added (Rails integration)
+
+- `encoded_id_options` class method to override `encoded_id` configuration on a model by model basis
+- Blocklist application "modes". User can decide if the blocklist checks should be applied in situations 
+  where very long encoded IDs are likely and hence block word collisions are undesirably likely.
+
+### Changed
+
+- Blocklists are now pre-filtered to the encoder alphabet to avoid testing words which cannot be created by that alphabet anyway.
+- Updates to inline RBS type signatures
+- Documentation updates
 
 ## [1.0.0.rc6] - 2025-11-17
 

data/README.md

@@ -7,28 +7,58 @@
 
 `encoded_id-rails` is a Rails integration that provides additional features for using `encoded_id` with ActiveRecord models.
 
+It's one of the most, if not _the_ most, feature complete gem of its kind!
+
 👉 **Full documentation available at [encoded-id.onrender.com](https://encoded-id.onrender.com)**
 
+## Key Features
+
+* 🔄 **Reversible** - Encoded IDs can be decoded back to the original values
+* 👥 **Multiple IDs** - Encode multiple numeric IDs in one string
+* 🚀 **Choose your encoding** - Supports `Sqids` (default) and `Hashids`, or use your own custom encoder
+* 👓 **Human-readable** - Character grouping & character mappings of easily confused characters for better readability
+* 🔡 **Custom alphabets** - Use your preferred character set, or a provided default
+* 🚗 **Performance** - Uses an optimized `Hashids` encoder (compared to `hashids` gem) for better performance and less memory usage, and have pushed performance improvements to `Sqids` as well
+* 🤬 **Blocklist filtering** - Built-in word blocklist support with configurable modes and optional default lists
+
+### Rails Integration Features
+
+* 🏷️ **ActiveRecord integration** - Use with ActiveRecord models
+* 🔑 **Per-model configuration** - Use custom salt and encoding settings per model
+* 💅 **Slugged IDs** - URL-friendly slugs like `my-product--p5w9-z27j`
+* 🔖 **Annotated IDs** - Model type indicators like `user_p5w9-z27j` (default behavior)
+* 🔍 **Finder methods** - `find_by_encoded_id`, `find_by_encoded_id!`, `find_all_by_encoded_id`, `where_encoded_id`
+* 🛣️ **URL params** - `to_param` automatically uses encoded IDs
+* 🔒 **Safe defaults** - Limits on encoded ID lengths to prevent CPU and memory-intensive encode/decodes when used in URLs
+* 💾 **Persistence** - Optional database persistence for efficient lookups
+
+
 ## Quick Example
 
 ```ruby
-coder = ::EncodedId::ReversibleId.new(salt: "my-salt")
+# Using Hashids encoder (requires salt)
+coder = ::EncodedId::ReversibleId.hashid(salt: "my-salt")
 coder.encode(123)
-# => "p5w9-z27j"
+# => "m3pm-8anj"
 
 # The encoded strings are reversible
-coder.decode("p5w9-z27j")
+coder.decode("m3pm-8anj")
 # => [123]
 
 # Supports encoding multiple IDs at once
 coder.encode([78, 45])
-# => "z2j7-0dmw"
+# => "ny9y-sd7p"
+
+# Using Sqids encoder (default, no salt required)
+sqids_coder = ::EncodedId::ReversibleId.sqids
+sqids_coder.encode(123)
+# => (encoded value varies)
 
 # Can also be used with ActiveRecord models
 class User < ApplicationRecord
   include EncodedId::Rails::Model
-  
-  # Optional slug for the encoded ID
+
+  # Optional: define method to provide slug for encoded ID
   def name_for_encoded_id_slug
     full_name
   end
@@ -40,28 +70,6 @@ user.encoded_id                             # => "user_p5w9-z27j"
 user.slugged_encoded_id                     # => "bob-smith--user_p5w9-z27j"
 ```
 
-## Key Features
-
-* 🔄 **Reversible** - Encoded IDs can be decoded back to the original values
-* 👥 **Multiple IDs** - Encode multiple numeric IDs in one string
-* 🚀 **Choose your encoding** - Supports `Hashids` and `Sqids` out of the box, or use your own custom encoder
-* 👓 **Human-readable** - Character grouping & character mappings of easily confused characters for better readability
-* 🔡 **Custom alphabets** - Use your preferred character set, or a provided default
-* 🚗 **Performance** - Uses an optimized `Hashids` encoder (compared to `hashids` gem) for better performance and less memory usage, and have pushed performance improvements to `Sqids` as well
-* 🤬 **Profanity blocking** - Built-in word blocklist support and optional default lists
-
-### Rails Integration Features
-
-* 🏷️ **ActiveRecord integration** - Use with ActiveRecord models
-* 🔑 **Per-model salt** - Use a custom salt for encoding per model
-* 💅 **Slugged IDs** - URL-friendly slugs like `my-product--p5w9-z27j`
-* 🔖 **Annotated IDs** - Model type indicators like `user_p5w9-z27j`
-* 🔍 **Finder methods** - Find records using encoded IDs
-* 🛣️ **URL params** - `to_param` with encoded IDs
-* 🔒 **Safe defaults**: Limits on encoded ID lengths to prevent CPU and memory-intensive encode/decodes eg when used in URLs
-* 💾 **Persistence** - Optional database persistence for efficient lookups
-
-
 ## Standalone Gem
 
 
@@ -91,6 +99,10 @@ See the [Rails Integration](https://encoded-id.onrender.com/docs/encoded_id_rail
 
 **Encoded IDs are not secure**. They are meant to provide obfuscation, not encryption. Do not use them as a security mechanism.
 
+As of version 1.0.0, `Sqids` is the default encoder. `Hashids` is still supported but is officially deprecated by the Hashids project in favor of Sqids.
+
+Read more about the security implications: [Hashids expose salt value](https://www.sjoerdlangkemper.nl/2023/11/25/hashids-expose-salt-value/) (note: this specifically applies to Hashids encoder)
+
 ## Compare to Alternate Gems
 
 - [prefixed_ids](https://github.com/excid3/prefixed_ids)
@@ -105,11 +117,10 @@ For a detailed comparison, see the [Compared to Other Gems](https://encoded-id.o
 
 Visit [encoded-id.onrender.com](https://encoded-id.onrender.com) for comprehensive documentation including:
 
-- [EncodedId Core API](https://encoded-id.onrender.com/docs/encoded_id/api)
-- [Rails Integration API](https://encoded-id.onrender.com/docs/encoded_id_rails/api)
-- [Configuration Options](https://encoded-id.onrender.com/docs/encoded_id/configuration)
-- [Examples](https://encoded-id.onrender.com/docs/encoded_id/examples)
-- [Advanced Topics](https://encoded-id.onrender.com/docs/advanced-topics)
+- [EncodedId Core Guide](https://encoded-id.onrender.com/docs/encoded_id/) - Installation, configuration, examples, and advanced topics
+- [EncodedId Rails Guide](https://encoded-id.onrender.com/docs/encoded_id_rails/) - Rails integration, configuration, and examples
+- [EncodedId Core API Reference](https://encoded-id.onrender.com/docs/encoded_id/api)
+- [Rails Integration API Reference](https://encoded-id.onrender.com/docs/encoded_id_rails/api)
 
 ## Development