cool_id 0.1.7 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd52ffe11cf7b25bf473b06e879a7df67eb4aea3b9169b0961342fef30a6fce7
-  data.tar.gz: b92c14dd88880ad52de1884f8a1e2720915b5ee24b742c0db8a966071bd07196
+  metadata.gz: 07011e094fb16385d448b80b4461b0e579d29efc0b4273fff4b41dd1df350a64
+  data.tar.gz: 11d8a83f95a7fce11598df98d1b7175c26b00f8a0d19d6af18ebaa35b8ddfa0b
 SHA512:
-  metadata.gz: f41bf3c022796fdaf4e8f53af035b6515c6a6b5ac59b749c52a17247bb6710b7296424d2a86c20f484500cae15f7daec32ec1a3980717441a0fec186ad528945
-  data.tar.gz: c81557d5b123b122be77208ef6c74421d81c048dd409f289421ee1bfbaea075550621c77d0c6d92f5b11df393b4fd3be820e62cf2ef491a8e48958705e218d5c
+  metadata.gz: f98ab9a494119599b383cc41bc9fdb797f68e793f626b07759899fee06ded282b6b8fe4f98d8ab82425127c64f4daac2511b8645f61458625e8356c8a428efe0
+  data.tar.gz: 6002ff50f083a330ad2fcdb582df9e12d9aea31d26e1d7f737dcd20650c0fa7454e2eb43a7f88c84e47bcdb5f9965557433d97acfca13b0afa854032c4de28fa

data/.aider.conf.yml

@@ -0,0 +1,9 @@
+# https://aider.chat/docs/config/aider_conf.html
+
+lint-cmd: bundle exec standardrb --fix
+auto-lint: true
+
+test-cmd: bundle exec rspec --format progress --no-profile --no-color --fail-fast
+auto-test: true
+
+read: cool_id.gemspec

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.7"
+  VERSION = "0.1.9"
 end

data/lib/cool_id.rb

@@ -7,15 +7,18 @@ require "active_support/concern"
 module CoolId
   class NotConfiguredError < StandardError; end
 
+  class MaxRetriesExceededError < StandardError; end
+
   # defaults based on https://planetscale.com/blog/why-we-chose-nanoids-for-planetscales-api
   DEFAULT_SEPARATOR = "_"
   DEFAULT_ALPHABET = "0123456789abcdefghijklmnopqrstuvwxyz"
   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
+    attr_accessor :separator, :alphabet, :length, :max_retries, :id_field
 
     def configure
       yield self
@@ -25,6 +28,8 @@ module CoolId
       self.separator = DEFAULT_SEPARATOR
       self.alphabet = DEFAULT_ALPHABET
       self.length = DEFAULT_LENGTH
+      self.max_retries = DEFAULT_MAX_RETRIES
+      self.id_field = nil
     end
 
     def registry
@@ -34,15 +39,32 @@ module CoolId
     def generate_id(config)
       alphabet = config.alphabet || @alphabet
       length = config.length || @length
-      id = Nanoid.generate(size: length, alphabet: alphabet)
+      max_retries = config.max_retries || @max_retries
+
+      retries = 0
+      loop do
+        nano_id = Nanoid.generate(size: length, alphabet: alphabet)
+        full_id = "#{config.prefix}#{separator}#{nano_id}"
+        if !config.model_class.exists?(id: full_id)
+          return full_id
+        end
 
-      "#{config.prefix}#{separator}#{id}"
+        retries += 1
+        if retries >= max_retries
+          raise MaxRetriesExceededError, "Failed to generate a unique ID after #{max_retries} attempts"
+        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
   self.alphabet = DEFAULT_ALPHABET
   self.length = DEFAULT_LENGTH
+  self.max_retries = DEFAULT_MAX_RETRIES
 
   class Registry
     def initialize
@@ -55,24 +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
+    attr_reader :prefix, :length, :alphabet, :max_retries, :model_class, :id_field
 
-    def initialize(prefix:, length: nil, alphabet: 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
@@ -98,7 +127,7 @@ module CoolId
       attr_accessor :cool_id_setup_required
 
       def cool_id(options)
-        @cool_id_config = Config.new(**options)
+        @cool_id_config = Config.new(**options, model_class: self)
         CoolId.registry.register(options[:prefix], self)
       end
 
@@ -129,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.7
+  version: 0.1.9
 platform: ruby
 authors:
 - Peter Schilling
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-20 00:00:00.000000000 Z
+date: 2024-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nanoid
@@ -73,6 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".aider.conf.yml"
 - ".rspec"
 - ".standard.yml"
 - CHANGELOG.md