prefixed_ids 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5a5f802c0838ffb2538b43212061d569d0920356aed91e313865799c570d573
-  data.tar.gz: 6488ec773ddb3f15dfb48a9bc07ce4d39262feabb89eb8d3a5168e5ffdf52017
+  metadata.gz: 31ec2b1bba4416445bc96d1009fb7d982a04ad2283e26450126ce526f1fceb44
+  data.tar.gz: ad94e3f32b9748ababe2cfe8b6e91e4b3a8ecf6e28e89dab4405bea461db5c47
 SHA512:
-  metadata.gz: 8b62b64c158bd670e814fbe92b7306a046b9f4e7933f494e5312ddb44f7a068fe9baaa579a11ad45b635aed0ec1dc83bec5b1699471ad550ed5e846a9125e446
-  data.tar.gz: a5233cee0e3fb432b1ff4e01bc60f6c33cc670df756bb09e315f26fd5d22c6b7325bc2fde0eb1369be21196d4b23e65850dadf10f0fc2ee927aa636b8067670b
+  metadata.gz: 6f281373868530a41f7cadf8fd78179cad3a1be85941a1734f3eef2fb568aef6b80702b9506bb2873989ee9b3fd2137839d4f79d328e4c0f4d92394b370c508f
+  data.tar.gz: b3d9c9fe54b7df878d122be69f591eb4ef58969804ac3af27705a5f7dc2b56a37a73ad77345b823a5d58bbd3ddbb2ef746d7802a074fa6fd2cfe1740163b4e09

data/README.md

@@ -59,7 +59,7 @@ User.find("user_5vJjbzXq9KrLEMm32iAnOP0xGDYk6dpe")
 User.find_by_prefix_id("user_5vJjbzXq9KrLEMm32iAnOP0xGDYk6dpe")
 ```
 
-⚠️ Note that `find` still finds records by the primary key. Eg. `localhost/users/1` still works. 
+⚠️ Note that `find` still finds records by the primary key. Eg. `localhost/users/1` still works.
 If you're targeting security issues by masking the ID, make sure to use `find_by_prefix_id` and [add a salt](#salt).
 
 We also override `to_param` by default so it'll be used in URLs automatically.
@@ -108,10 +108,12 @@ You can customize the prefix, length, and attribute name for PrefixedIds.
 
 ```ruby
 class Account < ApplicationRecord
-  has_prefix_id :acct, minimum_length: 32, override_find: false, override_param: false, salt: ""
+  has_prefix_id :acct, minimum_length: 32, override_find: false, override_param: false, salt: "", fallback: false
 end
 ```
 
+By default, `find` will accept both Prefix IDs and regular IDs. Setting `fallback: false` will disable finding by regular IDs and will only allow Prefix IDs.
+
 ## 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/lib/prefixed_ids/prefix_id.rb

@@ -19,9 +19,11 @@ module PrefixedIds
       fallback_value = fallback ? id : nil
       _, id_without_prefix = PrefixedIds.split_id(id, @delimiter)
       decoded_hashid = @hashids.decode(id_without_prefix)
-      return fallback_value unless valid?(decoded_hashid)
-
-      decoded_hashid.last || fallback_value
+      if fallback && !valid?(decoded_hashid)
+        fallback_value
+      else
+        decoded_hashid.last
+      end
     end
 
     private

data/lib/prefixed_ids/version.rb

@@ -1,3 +1,3 @@
 module PrefixedIds
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

data/lib/prefixed_ids.rb

@@ -34,14 +34,16 @@ module PrefixedIds
 
     included do
       class_attribute :_prefix_id
+      class_attribute :_prefix_id_fallback
     end
 
     class_methods do
-      def has_prefix_id(prefix, override_find: true, override_param: true, **options)
+      def has_prefix_id(prefix, override_find: true, override_param: true, fallback: true, **options)
         include Attribute
         include Finder if override_find
         include ToParam if override_param
         self._prefix_id = PrefixId.new(self, prefix, **options)
+        self._prefix_id_fallback = fallback
 
         # Register with PrefixedIds to support PrefixedIds#find
         PrefixedIds.models[prefix.to_s] = self
@@ -72,7 +74,7 @@ module PrefixedIds
     end
 
     def prefix_id
-      self.class._prefix_id.encode(id)
+      _prefix_id.encode(id)
     end
   end
 
@@ -81,7 +83,12 @@ module PrefixedIds
 
     class_methods do
       def find(*ids)
-        super(*ids.map { |id| _prefix_id.decode(id, fallback: true) })
+        prefix_ids = *ids.map do |id|
+          prefix_id = _prefix_id.decode(id, fallback: _prefix_id_fallback)
+          raise Error, "#{id} is not a valid prefix_id" if !_prefix_id_fallback && prefix_id.nil?
+          prefix_id
+        end
+        super(*prefix_ids)
       end
 
       def relation

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prefixed_ids
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Chris Oliver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-03 00:00:00.000000000 Z
+date: 2023-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.4.9
 signing_key:
 specification_version: 4
 summary: Prefixed IDs generates IDs with friendly prefixes for your models