cool_id 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d44c3207248595af232a200cf0e809224d74033d97d3cac52c6d06d5416b682
-  data.tar.gz: d221baeb8e79ea8ea8ca2b9503685e4bfa7cb8d57b53a3ba0e4d301138a08300
+  metadata.gz: a13030502ed2121afaaa78cd0443dc8c199c8ac0608080400ad5624947ed4a5a
+  data.tar.gz: a626eeead1ca380bebf7a172eb46bc2e683073f8fd353c5ad9ecfe6721589e46
 SHA512:
-  metadata.gz: 9ed700560671d811b0678c4fbe8f9e086c3ca0c9e8d04a54b7d40d586b20864e2add65adb9e5e53feb7915e472974dbfa6b31313dd6a64f4008aaf3f31503f70
-  data.tar.gz: df1cdc3098d9b4761a220fedeca362eeaeb5677d92ca7da594dc946223d814c81bb59db757ff08292fe72e3ce499dd95e1cc002ccf27c436aa097617bd14f2a9
+  metadata.gz: b22b2cd792877343af3f1e9b3aa51fcf8e5f6920fc1fa79407e9149c4b43acbea3c9bbd10959c46810f2cb4fc0a25c5d538211d274f10adc18ee8c5583f1040e
+  data.tar.gz: 44d27992a9c89ba415db43cc31ee3c590037107135a5bc58dcf542f0b7fda702ae965798c39b01448c8a74fad3b43618b64ae1545a53ad85c85386770ce954fd

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

@@ -1,6 +1,6 @@
-# cool_id
+# cool id
 
-a gem for rails that generates string primary key ids for active record models with a per-model prefix followed by a nanoid. this lets you create stripe style ids in your own rails app, and they'll be the same ids you see in your database.
+gem for rails apps to generates string ids with a prefix, followed by a [nanoid](https://zelark.github.io/nano-id-cc/). similar to the ids you see in stripe's api. also able to lookup any record by id, similar to rails' globalid.
 
 ```ruby
 class User < ActiveRecord::Base
@@ -12,7 +12,7 @@ User.create!(name: "...").id
 # => "usr_vktd1b5v84lr"
 ```
 
-it can also lookup records similar to global id:
+lookup any record by its id
 
 ```ruby
 CoolId.locate("usr_vktd1b5v84lr")
@@ -72,7 +72,7 @@ bundle add cool_id
 gem "cool_id"
 ```
 
-### using cool_id in one model
+### adding cool_id to a single model
 
 use string ids when creating a table
 

data/lib/cool_id/version.rb

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

data/lib/cool_id.rb

@@ -5,17 +5,20 @@ require "nanoid"
 require "active_support/concern"
 
 module CoolId
-  class Error < StandardError; end
+  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)
 
   class << self
-    attr_accessor :separator, :alphabet, :length
+    attr_accessor :separator, :alphabet, :length, :max_retries
 
     def configure
       yield self
@@ -25,6 +28,7 @@ module CoolId
       self.separator = DEFAULT_SEPARATOR
       self.alphabet = DEFAULT_ALPHABET
       self.length = DEFAULT_LENGTH
+      self.max_retries = DEFAULT_MAX_RETRIES
     end
 
     def registry
@@ -34,15 +38,28 @@ 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
   end
 
   self.separator = DEFAULT_SEPARATOR
   self.alphabet = DEFAULT_ALPHABET
   self.length = DEFAULT_LENGTH
+  self.max_retries = DEFAULT_MAX_RETRIES
 
   class Registry
     def initialize
@@ -67,12 +84,14 @@ module CoolId
   end
 
   class Config
-    attr_reader :prefix, :length, :alphabet
+    attr_reader :prefix, :length, :alphabet, :max_retries, :model_class
 
-    def initialize(prefix:, length: nil, alphabet: nil)
+    def initialize(prefix:, model_class:, length: nil, alphabet: nil, max_retries: nil)
       @length = length
       @prefix = validate_prefix(prefix)
       @alphabet = validate_alphabet(alphabet)
+      @max_retries = max_retries
+      @model_class = model_class
     end
 
     private
@@ -98,7 +117,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
 
@@ -110,7 +129,7 @@ module CoolId
         @cool_id_setup_required = true
       end
 
-      def skip_enforce_cool_id_for_descendants
+      def skip_enforce_cool_id
         @cool_id_setup_required = false
       end
 
@@ -134,7 +153,8 @@ module CoolId
 
       def ensure_cool_id_configured
         if self.class.cool_id_setup_required && self.class.cool_id_config.nil?
-          raise Error, "CoolId not configured for #{self.class}. Use 'cool_id' to configure or 'skip_enforce_cool_id_for_descendants' to opt out."
+          suggested_prefix = self.class.name.downcase[0..2]
+          raise NotConfiguredError, "CoolId not configured for #{self.class}. Use 'cool_id' to configure or 'skip_enforce_cool_id' to opt out.\n\ne.g.\n\nclass #{self.class} < ApplicationRecord\n  cool_id prefix: \"#{suggested_prefix}\"\nend"
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cool_id
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.8
 platform: ruby
 authors:
 - Peter Schilling
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-18 00:00:00.000000000 Z
+date: 2024-08-23 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