cool_id 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a13030502ed2121afaaa78cd0443dc8c199c8ac0608080400ad5624947ed4a5a
-  data.tar.gz: a626eeead1ca380bebf7a172eb46bc2e683073f8fd353c5ad9ecfe6721589e46
+  metadata.gz: 07011e094fb16385d448b80b4461b0e579d29efc0b4273fff4b41dd1df350a64
+  data.tar.gz: 11d8a83f95a7fce11598df98d1b7175c26b00f8a0d19d6af18ebaa35b8ddfa0b
 SHA512:
-  metadata.gz: b22b2cd792877343af3f1e9b3aa51fcf8e5f6920fc1fa79407e9149c4b43acbea3c9bbd10959c46810f2cb4fc0a25c5d538211d274f10adc18ee8c5583f1040e
-  data.tar.gz: 44d27992a9c89ba415db43cc31ee3c590037107135a5bc58dcf542f0b7fda702ae965798c39b01448c8a74fad3b43618b64ae1545a53ad85c85386770ce954fd
+  metadata.gz: f98ab9a494119599b383cc41bc9fdb797f68e793f626b07759899fee06ded282b6b8fe4f98d8ab82425127c64f4daac2511b8645f61458625e8356c8a428efe0
+  data.tar.gz: 6002ff50f083a330ad2fcdb582df9e12d9aea31d26e1d7f737dcd20650c0fa7454e2eb43a7f88c84e47bcdb5f9965557433d97acfca13b0afa854032c4de28fa

data/README.md

@@ -35,9 +35,26 @@ and generate ids without creating a record
 # generate an id, e.g. for batch inserts or upserts
 User.generate_cool_id
 # => "usr_vktd1b5v84lr"
+```
+
+you can use cool_id with a separate field, keeping the default primary key:
+
+```ruby
+class Product < ActiveRecord::Base
+  include CoolId::Model
+  cool_id prefix: "prd", id_field: :public_id
+end
 
+product = Product.create!(name: "Cool Product")
+product.id  # => 1 (or another integer)
+product.public_id  # => "prd_vktd1b5v84lr"
+
+# You can still use CoolId.locate with the public_id
+CoolId.locate("prd_vktd1b5v84lr")  # => #<Product id: 1, public_id: "prd_vktd1b5v84lr", name: "Cool Product">
 ```
 
+this approach allows you to keep your primary key as an auto-incrementing integer while still benefiting from CoolId's functionality. it's particularly useful when you want to expose a public identifier that's separate from your internal primary key.
+
 it takes parameters to change the alphabet or length
 
 ```ruby

data/lib/cool_id/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CoolId
-  VERSION = "0.1.8"
+  VERSION = "0.1.9"
 end

data/lib/cool_id.rb

@@ -15,10 +15,10 @@ module CoolId
   DEFAULT_LENGTH = 12
   DEFAULT_MAX_RETRIES = 1000
 
-  Id = Struct.new(:key, :prefix, :id, :model_class)
+  Id = Struct.new(:key, :prefix, :id, :model_class, :id_field)
 
   class << self
-    attr_accessor :separator, :alphabet, :length, :max_retries
+    attr_accessor :separator, :alphabet, :length, :max_retries, :id_field
 
     def configure
       yield self
@@ -29,6 +29,7 @@ module CoolId
       self.alphabet = DEFAULT_ALPHABET
       self.length = DEFAULT_LENGTH
       self.max_retries = DEFAULT_MAX_RETRIES
+      self.id_field = nil
     end
 
     def registry
@@ -54,6 +55,10 @@ module CoolId
         end
       end
     end
+
+    def resolve_cool_id_field(model_class)
+      model_class.cool_id_config&.id_field || CoolId.id_field || model_class.primary_key
+    end
   end
 
   self.separator = DEFAULT_SEPARATOR
@@ -72,26 +77,31 @@ module CoolId
 
     def locate(id)
       parsed = parse(id)
-      parsed&.model_class&.find_by(id: id)
+      return nil unless parsed
+
+      id_field = CoolId.resolve_cool_id_field(parsed.model_class)
+      parsed.model_class.find_by(id_field => id)
     end
 
     def parse(id)
       prefix, key = id.split(CoolId.separator, 2)
       model_class = @prefix_map[prefix]
       return nil unless model_class
-      Id.new(key, prefix, id, model_class)
+      id_field = CoolId.resolve_cool_id_field(model_class)
+      Id.new(key, prefix, id, model_class, id_field)
     end
   end
 
   class Config
-    attr_reader :prefix, :length, :alphabet, :max_retries, :model_class
+    attr_reader :prefix, :length, :alphabet, :max_retries, :model_class, :id_field
 
-    def initialize(prefix:, model_class:, length: nil, alphabet: nil, max_retries: nil)
+    def initialize(prefix:, model_class:, length: nil, alphabet: nil, max_retries: nil, id_field: nil)
       @length = length
       @prefix = validate_prefix(prefix)
       @alphabet = validate_alphabet(alphabet)
       @max_retries = max_retries
       @model_class = model_class
+      @id_field = id_field
     end
 
     private
@@ -148,7 +158,8 @@ module CoolId
       private
 
       def set_cool_id
-        self.id = self.class.generate_cool_id if id.blank?
+        id_field = CoolId.resolve_cool_id_field(self.class)
+        self[id_field] = self.class.generate_cool_id if self[id_field].blank?
       end
 
       def ensure_cool_id_configured

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cool_id
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Peter Schilling
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-23 00:00:00.000000000 Z
+date: 2024-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nanoid