encoded_id-rails 1.0.0.beta1 → 1.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6279bf9520a50983edc402bdc6a94fd4888c7c77f3c50484841535962ce50cc0
-  data.tar.gz: 4fdbddfc863dbe9acd25c4ad51551aef70c0c4972a5d18d29a134a848d73e5e7
+  metadata.gz: 3a38e6af88bf9343e2e4d22a82eb4c4d87766e962f3a8d330bf6aad1ad374639
+  data.tar.gz: 3ea6b28d604d3f728da545d324f50b12845f2feb9b7ed83c32349e002cdb6c93
 SHA512:
-  metadata.gz: '0784b0541785da4f291f8a303674c72598622016693efb060adc3a8cd75fd68b1299b755e381777ecf45616e3217e05f9fe9eefccf53dce2d6fb3e118bd1313e'
-  data.tar.gz: 01fba9fb0fb764cfac1953997da5637915b55badd90e586f01c60eda9ab4182d4a2fe9be531e420fbe95172442d4e2e12346c8422e06f26c86541a9000648ab2
+  metadata.gz: b03bc14efe460f8f479f109d32a4197c88cc85b72d87b7aa348e40057c4ae540728f5f3c383b943460ebbfdcfdd7e3173c363dbb423026386331fe17ea7e50e8
+  data.tar.gz: 5a6f16dc29c1c43450f278e08b7c82e597e13a70b4ea5183cbcc97d690307c6b847b5fef8cd594cb0f1396aca685beac78a8c427826b2003a1b2820b319793a3

data/Appraisals

@@ -0,0 +1,14 @@
+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/CHANGELOG.md

@@ -1,9 +1,10 @@
 ## [Unreleased]
 
-## [1.0.0.beta1] - 2023-08-07
+## [1.0.0] - (in beta)
 
 ### 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 
@@ -22,6 +23,9 @@
 - `.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.
 
+### Fixed
+
+- `#decode_encoded_id` now raises if the encoded ID is not a string.
 
 ## [0.6.2] - 2023-02-09
 

data/README.md

@@ -1,8 +1,29 @@
 # EncodedId::Rails (`encoded_id-rails`)
 
-[EncodedId](https://github.com/stevegeek/encoded_id) for Rails and `ActiveRecord` models.
+`EncodedId::Rails` lets you turn numeric or hex **IDs into reversible and human friendly obfuscated strings**. The gem brings [EncodedId](https://github.com/stevegeek/encoded_id) to Rails and `ActiveRecord` models.
 
-EncodedID lets you turn numeric or hex IDs into reversible and human friendly obfuscated strings.
+You can use it in routes for example, to go from something like `/users/725` to `/users/bob-smith--usr_p5w9-z27j` with miminal effort.
+
+## Features
+
+Under the hood it uses hashIds, but it offers more features.
+
+- 🔄 encoded IDs are reversible (see [`encoded_id`](https://github.com/stevegeek/encoded_id))
+- 💅 supports slugged IDs (eg `my-cool-product-name--p5w9-z27j`) that are URL friendly (assuming your alphabet is too)
+- 🔖 supports annotated IDs to help identify the model the encoded ID belongs to (eg for a `User` the encoded ID might be `user_p5w9-z27j`) 
+- 👓 encoded string can be split into groups of letters to improve human-readability (eg `abcd-efgh`)
+- 👥 supports multiple IDs encoded in one encoded string (eg imagine the encoded ID `7aq60zqw` might decode to two IDs `[78, 45]`)
+- 🔡 supports custom alphabets for the encoded string (at least 16 characters needed)
+  - by default uses a variation of the Crockford reduced character set (https://www.crockford.com/base32.html) 
+  - easily confused characters (eg i and j, 0 and O, 1 and I etc) are mapped to counterpart characters, to 
+    help avoid common readability mistakes when reading/sharing
+  - build in profanity limitation
+
+The gem provides:
+
+- methods to mixin to ActiveRecord models which will allow you to encode and decode IDs, and find
+  or query by encoded IDs
+- sensible defaults to allow you to get started out of the box
 
 ```ruby
 class User < ApplicationRecord
@@ -34,43 +55,25 @@ user == User.find_by_encoded_id("bob-smith--usr_p5w9-z27j") # => true
 users = User.find_all_by_encoded_id("7aq60zqw") # => [#<User id: 78>, #<User id: 45>]
 ```
 
-# Features
-
-- encoded IDs are reversible (see [`encoded_id`](https://github.com/stevegeek/encoded_id))
-- supports slugged IDs (eg `my-cool-product-name--p5w9-z27j`) that are URL friendly (assuming your alphabet is too)
-- supports annotated IDs to help identify the model the encoded ID belongs to (eg for a `User` the encoded ID might be `user_p5w9-z27j`) 
-- encoded string can be split into groups of letters to improve human-readability (eg `abcd-efgh`)
-- supports multiple IDs encoded in one encoded string (eg imagine the encoded ID `7aq60zqw` might decode to two IDs `[78, 45]`)
-- supports custom alphabets for the encoded string (at least 16 characters needed)
-  - by default uses a variation of the Crockford reduced character set (https://www.crockford.com/base32.html) 
-  - easily confused characters (eg i and j, 0 and O, 1 and I etc) are mapped to counterpart characters, to 
-    help avoid common readability mistakes when reading/sharing
-  - build in profanity limitation
-
-The gem provides:
-
-- methods to mixin to ActiveRecord models which will allow you to encode and decode IDs, and find
-  or query by encoded IDs
-- sensible defaults to allow you to get started out of the box
-
-### Coming in future (?)
-
-- support for UUIDs for IDs (which will be encoded as an array of integers)
-
-# Why this gem?
+## Why this gem?
 
 With this gem you can easily obfuscate your IDs in your URLs, and still be able to find records by using
 the encoded IDs. The encoded IDs are meant to be somewhat human friendly, to make communication easier
 when sharing encoded IDs with other people. 
 
 * Hashids are reversible, no need to persist the generated Id
-* we don't override any AR methods. `encoded_id`s are intentionally not interchangeable with normal record `id`s 
+* we don't override any AR methods. `encoded_id`s are intentionally **not interchangeable** with normal record `id`s 
   (ie you can't use `.find` to find by encoded ID or record ID, you must be explicit)
 * we support slugged IDs (eg `my-amazing-product--p5w9-z27j`)
 * we support multiple model IDs encoded in one `EncodedId` (eg `7aq6-0zqw` might decode to `[78, 45]`)
 * the gem is configurable
 * encoded IDs can be stable across environments, or not (you can set the salt to different values per environment)
 
+
+## Coming in future (?)
+
+- support for UUIDs for IDs (which will be encoded as an array of integers)
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -360,6 +363,34 @@ end
 
 However, I recommend you only use it on the models that need it.
 
+## Example usage for a route and controller
+
+```ruby
+# Route
+resources :users, param: :encoded_id, only: [:show]
+```
+
+```ruby
+# Model
+class User < ApplicationRecord
+  include EncodedId::Model
+  include EncodedId::PathParam
+end
+```
+
+```ruby
+# Controller
+class UsersController < ApplicationController
+  def show
+    @user = User.find_by_encoded_id!(params[:encoded_id])
+  end
+end
+```
+
+```erb 
+<%= link_to "User", user_path %>
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/gemfiles/.bundle/config

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

data/gemfiles/rails_6.1.gemfile

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

@@ -0,0 +1,130 @@
+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,11 +1,16 @@
+# This file was generated by Appraisal
+
 source "https://rubygems.org"
 
-gem "sqlite3"
 gem "activesupport", "~> 7.0.4"
 gem "activerecord", "~> 7.0.4"
-gem "rake", "~> 13.0"
-gem "minitest", "~> 5.0"
-gem "standard", "~> 1.3"
-gem "steep", "~> 1.2"
+
+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_7.0.gemfile.lock

@@ -0,0 +1,128 @@
+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 (7.0.8.1)
+      activesupport (= 7.0.8.1)
+    activerecord (7.0.8.1)
+      activemodel (= 7.0.8.1)
+      activesupport (= 7.0.8.1)
+    activesupport (7.0.8.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    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)
+
+PLATFORMS
+  arm64-darwin-23
+
+DEPENDENCIES
+  activerecord (~> 7.0.4)
+  activesupport (~> 7.0.4)
+  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.1.gemfile

@@ -0,0 +1,16 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 7.1"
+gem "activerecord", "~> 7.1"
+
+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_7.1.gemfile.lock

@@ -0,0 +1,140 @@
+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 (7.1.3.2)
+      activesupport (= 7.1.3.2)
+    activerecord (7.1.3.2)
+      activemodel (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      timeout (>= 0.4.0)
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    appraisal (2.5.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.7)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    csv (3.3.0)
+    drb (2.2.1)
+    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)
+    mutex_m (0.2.0)
+    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)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  arm64-darwin-23
+
+DEPENDENCIES
+  activerecord (~> 7.1)
+  activesupport (~> 7.1)
+  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/lib/encoded_id/rails/coder.rb

@@ -17,7 +17,7 @@ module EncodedId
 
       def decode(encoded_id)
         coder.decode(encoded_id)
-      rescue EncodedId::EncodedIdFormatError
+      rescue EncodedId::EncodedIdFormatError, EncodedId::InvalidInputError
         nil
       end
 

data/lib/encoded_id/rails/configuration.rb

@@ -4,15 +4,9 @@ module EncodedId
   module Rails
     # Configuration class for initializer
     class Configuration
-      attr_accessor :salt,
-        :character_group_size,
-        :group_separator,
-        :alphabet,
-        :id_length,
-        :slug_value_method_name,
-        :slugged_id_separator,
-        :annotation_method_name, # Set to nil to disable annotated IDs
-        :annotated_id_separator
+      attr_accessor :salt, :character_group_size, :alphabet, :id_length
+      attr_accessor :slug_value_method_name, :annotation_method_name
+      attr_reader :group_separator, :slugged_id_separator, :annotated_id_separator
 
       def initialize
         @character_group_size = 4
@@ -24,6 +18,33 @@ module EncodedId
         @annotation_method_name = :annotation_for_encoded_id
         @annotated_id_separator = "_"
       end
+
+      # Perform validation vs alphabet on these assignments
+
+      def group_separator=(value)
+        unless valid_separator?(value, alphabet)
+          raise ArgumentError, "Group separator characters must not be part of the alphabet"
+        end
+        @group_separator = value
+      end
+
+      def slugged_id_separator=(value)
+        if value.blank? || value == group_separator || !valid_separator?(value, alphabet)
+          raise ArgumentError, "Slugged ID separator characters must not be part of the alphabet or the same as the group separator"
+        end
+        @slugged_id_separator = value
+      end
+
+      def annotated_id_separator=(value)
+        if value.blank? || value == group_separator || !valid_separator?(value, alphabet)
+          raise ArgumentError, "Annotated ID separator characters must not be part of the alphabet or the same as the group separator"
+        end
+        @annotated_id_separator = value
+      end
+
+      def valid_separator?(separator, characters)
+        separator.chars.none? { |v| characters.include?(v) }
+      end
     end
   end
 end

data/lib/encoded_id/rails/encoder_methods.rb

@@ -10,6 +10,7 @@ module EncodedId
 
       def decode_encoded_id(slugged_encoded_id, options = {})
         return if slugged_encoded_id.blank?
+        raise StandardError, "You must pass a string encoded ID" unless slugged_encoded_id.is_a?(String)
         annotated_encoded_id = SluggedIdParser.new(slugged_encoded_id, separator: EncodedId::Rails.configuration.slugged_id_separator).id
         encoded_id = AnnotatedIdParser.new(annotated_encoded_id, separator: EncodedId::Rails.configuration.annotated_id_separator).id
         return if !encoded_id || encoded_id.blank?
@@ -27,9 +28,9 @@ module EncodedId
         EncodedId::Rails::Coder.new(
           salt: options[:salt] || encoded_id_salt,
           id_length: options[:id_length] || config.id_length,
-          character_group_size: options[:character_group_size] || config.character_group_size,
+          character_group_size: options.key?(:character_group_size) ? options[:character_group_size] : config.character_group_size,
           alphabet: options[:alphabet] || config.alphabet,
-          separator: options[:separator] || config.group_separator
+          separator: options.key?(:separator) ? options[:separator] : config.group_separator
         )
       end
     end

data/lib/encoded_id/rails/version.rb

@@ -2,6 +2,6 @@
 
 module EncodedId
   module Rails
-    VERSION = "1.0.0.beta1"
+    VERSION = "1.0.0.beta3"
   end
 end

data/lib/generators/encoded_id/rails/templates/encoded_id.rb

@@ -41,4 +41,30 @@ EncodedId::Rails.configure do |config|
   # Default: 8
   #
   # config.id_length = 8
+
+  # The name of the method that returns the value to be used in the slug.
+  #
+  # Default: :name_for_encoded_id_slug
+  #
+  # config.slug_value_method_name = :name_for_encoded_id_slug
+
+  # The separator used between the slug and the encoded ID.
+  # `nil` disables grouping.
+  #
+  # Default: "--"
+  #
+  # config.slugged_id_separator = "--"
+
+  # The name of the method that returns the annotation to be used in the annotated ID.
+  #
+  # Default: :annotation_for_encoded_id
+  #
+  # config.annotation_method_name = :annotation_for_encoded_id
+
+  # The separator used between the annotation and the encoded ID.
+  # `nil` disables annotation.
+  #
+  # Default: "_"
+  #
+  # config.annotated_id_separator = "_"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: encoded_id-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta1
+  version: 1.0.0.beta3
 platform: ruby
 authors:
 - Stephen Ierodiaconou
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-07 00:00:00.000000000 Z
+date: 2024-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -56,14 +56,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: 1.0.0.rc4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        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'
 description: ActiveRecord concern to use EncodedID to turn IDs into reversible and
   human friendly obfuscated strings.
 email:
@@ -73,14 +87,20 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".standard.yml"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - Steepfile
-- gemfiles/rails_6.0.gemfile
+- 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
 - lib/encoded_id/rails.rb
 - lib/encoded_id/rails/annotated_id.rb
 - lib/encoded_id/rails/annotated_id_parser.rb
@@ -119,11 +139,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Use `encoded_id` with ActiveRecord models

data/gemfiles/rails_6.0.gemfile

@@ -1,11 +0,0 @@
-source "https://rubygems.org"
-
-gem "sqlite3"
-gem "activesupport", "~> 6.1.7", ">= 6.1.0"
-gem "activerecord", "~> 6.1.7", ">= 6.1.0"
-gem "rake", "~> 13.0"
-gem "minitest", "~> 5.0"
-gem "standard", "~> 1.3"
-gem "steep", "~> 1.2"
-
-gemspec path: "../"