prefixed_ids 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab4ea5b61773281d37a10dc9f1dc429f0da2d0f7ed10240c4ae4a17fe3219df9
-  data.tar.gz: 4a37b8721a3e34cdf4446b5a83ab8a899c2d6f0bf20c6b72b9d37fa884d04e35
+  metadata.gz: 3bad6535e46cad00a977806102164ad2f8d79dae1f9d24beb50c12888829c5d6
+  data.tar.gz: a50ee9b602318c9a412887ddfd28274848eb5cdd2e5465e40ef7357bb11b2bd1
 SHA512:
-  metadata.gz: ce60408ac4ea95916a8915f82b11ecf52ad51e01f9af1cbc626891457e3318fcf006eca7bb87bc02d36804b1b20e4d1fbbfa2d761a4ec1a073f75c8c4a29a0d3
-  data.tar.gz: '06825f2e2d69c3576b842235ef1faf584b7f371fa75b7e82638d7d9ced3d649b3b0f1bd96b56126d13170a1f46ec410576ba5370e23df871ae3af17796d56a29'
+  metadata.gz: 6b0f42366a454e83682535538d072ae2bd1bf166386dcdfe767d75f40046cdfa466c0b763b86d6a1e5475fcff9c5b42970a5e1f5ae876ba56b1d55ca034713b5
+  data.tar.gz: 66d904378b4db97609cdd8db76c23fe765a30699c8e4f65b0cb85c656eaff486ab3efa05f74908e7694b7840000682c58e8bd1a96ff6da4437b1f6566c29ada7

data/README.md

@@ -24,27 +24,43 @@ gem 'prefixed_ids'
 
 ## 📝 Usage
 
-First, you'll need to generate a migration to add the prefix_id column to your model(s).
+Add `has_prefix_id :my_prefix` to your models to autogenerate prefixed IDs.
 
 ```ruby
-class AddPrefixIdToUsers< ActiveRecord::Migration
-  def change
-    add_index :users, :prefix_id, unique: true
-  end
+class User < ApplicationRecord
+  has_prefix_id :user
 end
 ```
 
-It's important the `prefix_id` column is indexed and unique.
+This will generate a value like `user_1234abcd`.
+
+To query using the prefixed ID, simply you can use either `find` or `find_by_prefixed_id`:
+
+```ruby
+User.find("user_5vJjbzXq9KrLEMm32iAnOP0xGDYk6dpe")
+User.find_by_prefix_id("user_5vJjbzXq9KrLEMm32iAnOP0xGDYk6dpe")
+```
+
+We also override `to_param` by default so it'll be used in URLs automatically.
 
-Then you can add `has_prefix_id :my_prefix` to your models to autogenerate prefixed IDs.
+To disable find and to_param overrides, simply pass in the options:
 
 ```ruby
 class User < ApplicationRecord
-  has_prefix_id :user
+  has_prefix_id :user, override_find: false, override_param: false
 end
 ```
 
-This will generate a value like `user_1234abcd` in the User's `prefix_id` column.
+### Generic lookup
+
+Imagine you have a prefixed ID but you don't know which model it belongs to.
+
+```ruby
+PrefixedIds.find("user_5vJjbzXq9KrLEMm3")
+#=> #<User>
+PrefixedIds.find("acct_2iAnOP0xGDYk6dpe")
+#=> #<Account>
+```
 
 ### Customizing
 
@@ -52,7 +68,7 @@ You can customize the prefix, length, and attribute name for PrefixedIds.
 
 ```ruby
 class Account < ApplicationRecord
-  has_prefix_id :acct, attribute: :my_id, length: 32
+  has_prefix_id :acct, minimum_length: 32, override_find: false, to_param: false
 end
 ```
 

data/lib/prefixed_ids.rb

@@ -1,29 +1,89 @@
 require "prefixed_ids/version"
 require "prefixed_ids/engine"
 
+require "hashids"
+
 module PrefixedIds
-  MINIMUM_TOKEN_LENGTH = 24
+  class Error < StandardError; end
+
+  autoload :PrefixId, "prefixed_ids/prefix_id"
+
+  TOKEN = 123
+  DELIMITER = "_"
+
+  mattr_accessor :alphabet, default: "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890"
+  mattr_accessor :minimum_length, default: 24
 
-  class MinimumLengthError < StandardError; end
+  mattr_accessor :models, default: {}
+
+  def self.find(prefix_id)
+    prefix, _ = split_id(prefix_id)
+    models.fetch(prefix).find_by_prefix_id(prefix_id)
+  rescue KeyError
+    raise Error, "Unable to find model with prefix `#{prefix}`. Available prefixes are: #{models.keys.join(", ")}"
+  end
+
+  # Splits a prefixed ID into its prefix and ID
+  def self.split_id(prefix_id)
+    prefix, _, id = prefix_id.to_s.rpartition(DELIMITER)
+    [prefix, id]
+  end
 
+  # Adds `has_prefix_id` method
+  module Rails
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_prefix_id
+    end
+
+    class_methods do
+      def has_prefix_id(prefix, override_find: true, override_param: true, **options)
+        include Attribute
+        include Finder if override_find
+        include ToParam if override_param
+        self._prefix_id = PrefixId.new(self, prefix, **options)
+
+        # Register with PrefixedIds to support PrefixedIds#find
+        PrefixedIds.models[prefix.to_s] = self
+      end
+    end
+  end
+
+  # Included when a module uses `has_prefix_id`
   module Attribute
     extend ActiveSupport::Concern
 
-    module ClassMethods
-      def has_prefix_id(prefix, attribute: :prefix_id, length: MINIMUM_TOKEN_LENGTH)
-        if length < MINIMUM_TOKEN_LENGTH
-          raise MinimumLengthError, "Token requires a minimum length of #{MINIMUM_TOKEN_LENGTH} characters."
-        end
+    class_methods do
+      def find_by_prefix_id(id)
+        find_by(id: _prefix_id.decode(id))
+      end
 
-        # Load securerandom only when has_secure_token is used.
-        require "active_support/core_ext/securerandom"
-        define_method("regenerate_#{attribute}") { update! attribute => self.class.generate_unique_prefix_id(prefix, length: length) }
-        before_create { send("#{attribute}=", self.class.generate_unique_prefix_id(prefix, length: length)) unless send("#{attribute}?") }
+      def find_by_prefix_id!(id)
+        find_by!(id: _prefix_id.decode(id))
       end
+    end
+
+    def prefix_id
+      self.class._prefix_id.encode(id)
+    end
+  end
 
-      def generate_unique_prefix_id(prefix, length: MINIMUM_TOKEN_LENGTH)
-        prefix.to_s + "_" + SecureRandom.base58(length)
+  module Finder
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def find(*ids)
+        super(*ids.map { |id| _prefix_id.decode(id) })
       end
     end
   end
+
+  module ToParam
+    extend ActiveSupport::Concern
+
+    def to_param
+      _prefix_id.encode(id)
+    end
+  end
 end

data/lib/prefixed_ids/engine.rb

@@ -2,7 +2,7 @@ module PrefixedIds
   class Engine < ::Rails::Engine
     initializer "prefixed_ids.model" do
       ActiveSupport.on_load(:active_record) do
-        include PrefixedIds::Attribute
+        include PrefixedIds::Rails
       end
     end
   end

data/lib/prefixed_ids/prefix_id.rb

@@ -0,0 +1,24 @@
+module PrefixedIds
+  class PrefixId
+    attr_reader :hashids, :model, :prefix
+
+    def initialize(model, prefix, minimum_length: PrefixedIds.minimum_length, alphabet: PrefixedIds.alphabet, **options)
+      @alphabet = alphabet
+      @model = model
+      @prefix = prefix.to_s
+      @hashids = Hashids.new(model.table_name, minimum_length)
+    end
+
+    def encode(id)
+      prefix + "_" + @hashids.encode(TOKEN, id)
+    end
+
+    # decode returns an array
+    def decode(id, fallback: false)
+      fallback_value = fallback ? id : nil
+      _, id_without_prefix = PrefixedIds.split_id(id)
+      decoded_id = @hashids.decode(id_without_prefix).last
+      decoded_id || fallback_value
+    end
+  end
+end

data/lib/prefixed_ids/version.rb

@@ -1,3 +1,3 @@
 module PrefixedIds
-  VERSION = "1.0.1"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prefixed_ids
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Chris Oliver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-17 00:00:00.000000000 Z
+date: 2021-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: hashids
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: standardrb
   requirement: !ruby/object:Gem::Requirement
@@ -64,6 +84,7 @@ files:
 - Rakefile
 - lib/prefixed_ids.rb
 - lib/prefixed_ids/engine.rb
+- lib/prefixed_ids/prefix_id.rb
 - lib/prefixed_ids/version.rb
 - lib/tasks/prefixed_ids_tasks.rake
 homepage: https://github.com/excid3/prefixed_ids