encoded_id-rails 1.0.0.rc1 → 1.0.0.rc7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67437c2f5ede5d3d8a7ff14079ce9518b1e63a48812fd37a88d61772fa1d0ea3
-  data.tar.gz: 59f73a3eb40b421bdf50115f806cbf5cd41b09213ebe87ce4d1842b098530f47
+  metadata.gz: 1ef8577374a192378855b9f20acd2885770b3e49d379e3051a187db83f7de497
+  data.tar.gz: 9f574a5e8336f3588bf55c1cb9f69f8b47bcfd46a689bc007abd6f7e0143b8e6
 SHA512:
-  metadata.gz: c8f03e548c344e45343ad831b568eedf705c02db9da876445a67d8814d9d4efd37d0ae639bf7eb6a1fd33685d68bc01077a523addffa319c9022cfd534771de7
-  data.tar.gz: 0037b79f44ce1ddeb97bc142e11c35b045c446db1b87e7122eeceb06bb606499a60764c3ab85593d352f0be39b074cf72805078d511bce80c53cd3ba745372b5
+  metadata.gz: 33157300365c009da10a1a035d88aeeff2e021cace89194ab779a0ec598dd8acb6614444143f01efc3982ff68f320ce1cc2511909ca57ff1a18c712569510256
+  data.tar.gz: '08879af617396021978d6b5a46833841a8362eca06a74d151cc36934200188526c5bacac5c57cd5abf84ee8e8816e31d7ae50277a5dae756608dca1c0c5f141c'

data/CHANGELOG.md

@@ -1,31 +1,110 @@
 ## [Unreleased]
 
-## [1.0.0] - (in beta)
+- nothing yet
+
+## [1.0.0] - unreleased
+
+- First stable release!
+
+**Important!!: `:sqids` are not compatible with `:hashids`, DO NOT CHANGE FROM ONE TO THE OTHER AFTER GOING LIVE.**
+
+## [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`. 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
+
+### 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
 
 ### Breaking changes
 
-- Ruby 2.7.x support dropped. The minimum supported Ruby version is now 3.0.0.
-- `#encoded_id` now defaults to returning an 'annotated' ID, one in which a prefix is added to the encoded ID to indicate 
-  the 'type' of the record the ID represents. This can be disabled. IDs generated by older versions of this gem will 
-  decode correctly. But not that IDs generated by this version onwards will not decode correctly by older versions of this 
-  gem so make sure to disable annotation if you need to support older versions of this gem.
-- `#name_for_encoded_id_slug` no longer provides a default implementation, it is up to the user to define this method,
-  or configure the gem to use a different method name.
-- `#slugged_encoded_id` no longer takes a `with:` parameter. To specify the name of the method to call to generate the
-  slug, use the `slug_value_method_name` configuration option.
+- Empty array inputs will now raise `InvalidInputError`
 
 ### Added
 
-- `#encoded_id_hash` has been added to return only the encoded ID without an annotation prefix. If annotation is disabled, 
-  this method is basically an alias to `#encoded_id`.
-- `.find_all_by_encoded_id` has been added to return all records matching the given encoded ID. This will return all
-  matching records whose IDs are encoded in the encoded_id. Missing records are ignored.
-- `.find_all_by_encoded_id!` like `.find_all_by_encoded_id` but raises an `ActiveRecord::RecordNotFound` exception if
-  *any* of the records are not found.
+- Added support for [Sqids](https://sqids.org) as an alternative ID encoding engine. The default remains HashIds for backward compatibility. 
+- New encoder abstraction layer allows switching between HashIds and Sqids via the `encoder: :sqids` or `encoder: :hashids` parameter to `ReversibleId.new`.
+- Support for blocklists in both HashIds and Sqids encoders to prevent generating IDs containing specific words. Use the `blocklist` parameter with a `Set` or `Array` of strings to `ReversibleId.new`. For Hashids encodings, an error will be raised if a generated ID contains a blocklisted word. For Sqids a new ID is generated that does not contain the block word.
+
+### Added (Rails integration)
+
+- Merged `encoded_id-rails` gem into the monorepo
+- Support for configuring the encoder and blocklist options in Rails through the configuration class
+- `#encoded_id` now defaults to returning an 'annotated' ID, one in which a prefix is added to the encoded ID to indicate the 'type' of the record the ID represents. This can be disabled. IDs generated by older versions of this gem will decode correctly. But note that IDs generated by this version onwards will not decode correctly by older versions of this gem so make sure to disable annotation if you need to support older versions of this gem.
+- New `EncodedId::Rails::Persists` module which adds hooks to the model to persist the encoded ID to the DB (see docs).
+- `#encoded_id_hash` has been added to return only the encoded ID without an annotation prefix. If annotation is disabled, this method is basically an alias to `#encoded_id`.
+- `.find_all_by_encoded_id` has been added to return all records matching the given encoded ID. This will return all matching records whose IDs are encoded in the encoded_id. Missing records are ignored.
+- `.find_all_by_encoded_id!` like `.find_all_by_encoded_id` but raises an `ActiveRecord::RecordNotFound` exception if *any* of the records are not found.
+- `Configuration#model_to_param_returns_encoded_id` to allow `EncodedId::Rails::Model` inclusion to also bring in `EncodedId::Rails::PathParam` automatically.
 
-### Fixed
+### Changed (Rails integration)
+
+- `#name_for_encoded_id_slug` no longer provides a default implementation, it is up to the user to define this method, or configure the gem to use a different method name.
+- `#slugged_encoded_id` no longer takes a `with:` parameter. To specify the name of the method to call to generate the slug, use the `slug_value_method_name` configuration option.
+
+### Fixed (Rails integration)
 
 - `#decode_encoded_id` now raises if the encoded ID is not a string.
+- Handle more cases where a record held onto a memoized `encoded_id` even though its `id` had changed
+
+## [1.0.0.rc5] - 2025-04-09
+
+- `encoded_id` now uses its own implementation of `hashids` which is more efficient and has a smaller memory footprint. This massively reduces the GC churn in high-throughput applications. This is an implementation based on the original `hashids` gem but with many optimisations and improvements. Functionally it is identical to the original `hashids` gem.
+
+## [1.0.0.rc4] - 2024-04-29
+
+- Add an optional `max_inputs_per_id` argument to `ReversibleId`, thanks to [@avcwisesa](https://github.com/avcwisesa)
+- The option `split_with:` can also now be set to nil to disable splitting of the encoded ID string
+
+## [1.0.0.rc3] - 2023-10-23
+
+- Add an optional `max_length` argument to `ReversibleId`, thanks to [@jugglebird](https://github.com/jugglebird)
+- Alphabet validations to prevent whitespace and null chars
+- Add `Alphabet#to_a`, `Alphabet#to_s`, `Alphabet#size` and a custom `Alphabet#inspect`
+- Fixes to input validations
+- hashids are case-sensitive, as are `Alphabet`s, however `ReversibleId` was always `downcase`ing the encodedid input string on decode. A new option has been added to `decode` and `decode_hex`, `downcase`, which defaults to `true`. Thus, the default behaviour is unchanged, but you can opt out to allow mixed case encodedid decode. *Note:* In V2 this will default to `false`.
+
+## [1.0.0.rc2] - 2023-08-07
+
+- `Alphabet` now has `#include?` and `#unique_charaters` methods
+
+## [1.0.0.rc1] - 2023-08-06
+
+- Improved RBS definitions
+- Improved test coverage
+
+## [0.4.0] - 2022-12-04
+
+- Support custom 'split' character which must not be in the alphabet
+- Ability to provide a custom character equivalence mapping
+
+## [0.3.0] - 2022-10-12
+
+- Fix splitting of encoded ID string
+- Checks that integer values to be encoded are positive
+- Experimental support for encoding hex strings
+
+## [0.1.0] - 2022-10-11
+
+- Initial release
+
+## Rails Integration History
 
 ## [0.6.2] - 2023-02-09
 
@@ -64,4 +143,4 @@
 
 ## [0.1.0] - 2022-11-17
 
-- Initial release
+- Initial release of Rails integration

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Stephen Ierodiaconou
+Copyright (c) 2022-2024 Stephen Ierodiaconou
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal